Skip to content

Fix grpc aio handler typing #15497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XiaXia009 wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix grpc aio handler typing #15497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2626c88
Fix grpc aio handler typing
XiaXia009 Mar 9, 2026
ef1a1a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 9, 2026
4577db6
Fix grpc aio handler typing
XiaXia009 Mar 9, 2026
357a7fb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 9, 2026
394c422
fix-grpc-aio-handler
XiaXia009 Mar 9, 2026
855e1a3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 9, 2026
d81eaf7
fix @type_check_only check
XiaXia009 Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions stubs/grpcio/@tests/test_cases/check_server_interceptor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
from __future__ import annotations

from collections.abc import Callable
from collections.abc import AsyncIterator, Callable
from concurrent.futures.thread import ThreadPoolExecutor
from typing import Awaitable, TypeVar
from typing import Awaitable, TypeVar, cast

import grpc
import grpc.aio
Expand All @@ -26,10 +26,18 @@ def intercept_service(
class NoopAioInterceptor(grpc.aio.ServerInterceptor):
async def intercept_service(
self,
continuation: Callable[[grpc.HandlerCallDetails], Awaitable[grpc.RpcMethodHandler[RequestT, ResponseT]]],
continuation: Callable[[grpc.HandlerCallDetails], Awaitable[grpc.aio.RpcMethodHandler[RequestT, ResponseT]]],
handler_call_details: grpc.HandlerCallDetails,
) -> grpc.RpcMethodHandler[RequestT, ResponseT]:
) -> grpc.aio.RpcMethodHandler[RequestT, ResponseT]:
return await continuation(handler_call_details)


grpc.aio.server(interceptors=[NoopAioInterceptor()])

aio_handler = cast(grpc.aio.RpcMethodHandler[bytes, bytes], object())
aio_handler.unary_unary = cast(Callable[[bytes, grpc.aio.ServicerContext[bytes, bytes]], Awaitable[bytes]], None)
aio_handler.unary_stream = cast(Callable[[bytes, grpc.aio.ServicerContext[bytes, bytes]], AsyncIterator[bytes]], None)
aio_handler.stream_unary = cast(Callable[[AsyncIterator[bytes], grpc.aio.ServicerContext[bytes, bytes]], Awaitable[bytes]], None)
aio_handler.stream_stream = cast(
Callable[[AsyncIterator[bytes], grpc.aio.ServicerContext[bytes, bytes]], AsyncIterator[bytes]], None
)
Comment on lines +37 to +43
Copy link
Collaborator

@srittau srittau Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About tests: We only use tests for complex annotations. In this case, the tests basically replicate the type annotations, so we don't need them.

16 changes: 15 additions & 1 deletion stubs/grpcio/grpc/aio/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ from grpc import (
GenericRpcHandler,
HandlerCallDetails,
RpcError,
RpcMethodHandler,
ServerCredentials,
StatusCode,
_Options,
Expand Down Expand Up @@ -369,6 +368,21 @@ class StreamStreamClientInterceptor(ClientInterceptor, metaclass=abc.ABCMeta):
request_iterator: AsyncIterable[_TRequest] | Iterable[_TRequest],
) -> AsyncIterator[_TResponse] | StreamStreamCall[_TRequest, _TResponse]: ...

# Service-Side Handler:

@type_check_only
class RpcMethodHandler(Generic[_TRequest, _TResponse]):
Comment on lines +373 to +374
Copy link
Collaborator

@srittau srittau Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from marking non-existing runtime types with @type_check_only, we also prefix them with an underscore to make it very obvious that something is "wrong" with this type to users. I would also like to add some explanation for why this type is here, and add Async to the name to clearly distinguish it from the "regular" RpcMethodHandler:

Suggested change
@type_check_only
class RpcMethodHandler(Generic[_TRequest, _TResponse]):
# Async version of gprc.RpcMethodHandler. As opposed to the former, this type
# does not exist at runtime.
@type_check_only
class _AsyncRpcMethodHandler(Generic[_TRequest, _TResponse]):

request_streaming: bool
response_streaming: bool

request_deserializer: _Deserializer[_TRequest] | None
response_serializer: _Serializer[_TResponse] | None

unary_unary: Callable[[_TRequest, ServicerContext[_TRequest, _TResponse]], Awaitable[_TResponse]] | None
unary_stream: Callable[[_TRequest, ServicerContext[_TRequest, _TResponse]], AsyncIterator[_TResponse]] | None
stream_unary: Callable[[AsyncIterator[_TRequest], ServicerContext[_TRequest, _TResponse]], Awaitable[_TResponse]] | None
stream_stream: Callable[[AsyncIterator[_TRequest], ServicerContext[_TRequest, _TResponse]], AsyncIterator[_TResponse]] | None

# Server-Side Interceptor:

class ServerInterceptor(metaclass=abc.ABCMeta):
Expand Down