Allow None return from grpc.aio.ServerInterceptor.intercept_service#15783
Open
Rhadamanthus1 wants to merge 2 commits into
Open
Allow None return from grpc.aio.ServerInterceptor.intercept_service#15783Rhadamanthus1 wants to merge 2 commits into
Rhadamanthus1 wants to merge 2 commits into
Conversation
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update the type hints for
grpc.aio.ServerInterceptor.intercept_serviceand itscontinuationparameter to allow returningNone. Specifically, the return type and the innerAwaitableare widened toRpcMethodHandler[_TRequest, _TResponse] | None.Motivation
The runtime docstring for
grpc.aio.ServerInterceptor.intercept_serviceexplicitly documentsNoneas a valid return value to signal that an RPC is not being serviced:Because the interceptor chain propagates
Noneend-to-end (each link'scontinuationreturns whatever the next interceptor returned), the innerAwaitablemust also admitNone. With the current stubs, subclasses that honour the documented contract are forced to use# type: ignore[override]to widen the override. This PR eliminates that friction.Precedent
This change aligns the async stubs with their synchronous counterpart. The sync stub (
stubs/grpcio/grpc/__init__.pyi, lines 506-510, see here) already correctly declares both positions asRpcMethodHandler[_TRequest, _TResponse] | None:Changes
stubs/grpcio/grpc/aio/__init__.pyi:Awaitable[...]and the return type ofServerInterceptor.intercept_serviceto includeNone.