[Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests by asheshvidyut · Pull Request #40217 · grpc/grpc

asheshvidyut · 2025-07-15T17:56:25Z

Description

Part 3 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for grpc.aio._utils and grpc.aio._call

Fixes -

Changed serializer parameters to Optional:

BEFORE

def __init__(
    self,
    # ...
    request_serializer: SerializingFunction,
    response_deserializer: DeserializingFunction,
    # ...
) -> None:

AFTER

def __init__(
    self,
    # ...
    request_serializer: Optional[SerializingFunction],
    response_deserializer: Optional[DeserializingFunction],
    # ...
) -> None:

Enhanced Metadata Type Checking in _channel.py -> Improved metadata type validation: This is a bug fix as the per stack trace mentioned in the comment below - [Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests #40217 (comment)

BEFORE

if not isinstance(metadata, Metadata) and isinstance(metadata, tuple):
    metadata = Metadata.from_tuple(metadata)

AFTER

if not isinstance(metadata, Metadata) and isinstance(
    metadata, Sequence
):
    metadata = Metadata.from_tuple(tuple(metadata))

Testing

CI

Related work

sreenithi · 2025-07-21T10:06:39Z

bazel/_run_time_type_check_main.py

@@ -24,27 +24,14 @@
 # Temporarily disable most hooks due to type annotation issues
 # install_import_hook('grpc.aio')
 # install_import_hook('grpc.aio._channel')


shouldn't this also be uncommented now since you're adding type annotations to _channel.py?

Its done in next PR - https://github.com/grpc/grpc/pull/40226/files

sreenithi · 2025-07-21T11:01:24Z

src/python/grpcio/grpc/aio/_call.py


 def _create_rpc_error(
-    initial_metadata: Metadata, status: cygrpc.AioRpcStatus
+    initial_metadata: Union[Metadata, Tuple[MetadatumType, ...]],


Have you tried using MetadataType instead of this: https://github.com/grpc/grpc/blob/master/src/python/grpcio/grpc/aio/_typing.py#L38

It's something we already have predefined and is almost the same as this Union type you are using here, so might be good to check using that

Thanks for this. Good thought.

src/python/grpcio/grpc/aio/_call.py

sreenithi · 2025-07-21T11:21:46Z

src/python/grpcio/grpc/aio/_channel.py

-        if not isinstance(metadata, Metadata) and isinstance(metadata, tuple):
-            metadata = Metadata.from_tuple(metadata)
+        if not isinstance(metadata, Metadata) and isinstance(
+            metadata, (tuple, list)


I thought Metadata was expected to be of tuple format. Is there any test or function in our codebase where we see a list?

ERROR: test_from_client_to_server_with_list (src.python.grpcio_tests.tests_aio.unit.metadata_test.TestMetadata) ---------------------------------------------------------------------- Traceback (most recent call last): File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/com_github_grpc_grpc/src/python/grpcio_tests/tests_aio/unit/_test_base.py", line 31, in wrapper return loop.run_until_complete(f(*args, **kwargs)) File "/usr/local/google/home/asheshvidyut/.pyenv/versions/3.8.20/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete return future.result() File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/com_github_grpc_grpc/src/python/grpcio_tests/tests_aio/unit/metadata_test.py", line 259, in test_from_client_to_server_with_list call = multicallable( File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/com_github_grpc_grpc/src/python/grpcio/grpc/aio/_channel.py", line 152, in __call__ call = UnaryUnaryCall( File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/com_github_grpc_grpc/src/python/grpcio/grpc/aio/_call.py", line 555, in __init__ def __init__( File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/grpc_python_dependencies_typeguard/site-packages/typeguard/_functions.py", line 135, in check_argument_types check_type_internal(value, annotation, memo) File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/123/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/metadata_test.runfiles/grpc_python_dependencies_typeguard/site-packages/typeguard/_checkers.py", line 779, in check_type_internal raise TypeCheckError(f"is not an instance of {qualified_name(origin_type)}") typeguard.TypeCheckError: argument "metadata" (list) is not an instance of grpc.aio._metadata.Metadata

^ This is the test which is failing because of list.

Since MetadataType can be a Sequence[MetadatumType], should we do isinstance(metadata, Sequence) check instead?

grpc/src/python/grpcio/grpc/aio/_typing.py

Line 38 in 9772d15

MetadataType = Union[Metadata, Sequence[MetadatumType]]

On one hand, this is closer to what we declare to support and will add support for any Sequence-based custom classes.
On another hand, str is technically a Sequence too.

sergiitk

LGTM overall, as long as remaining comments are addressed.

Also, if we're fixing typing errors in public API, please update the description to make clear for users that will refer to it later.

sergiitk · 2025-07-23T02:25:38Z

src/python/grpcio/grpc/aio/_channel.py

-        if not isinstance(metadata, Metadata) and isinstance(metadata, tuple):
-            metadata = Metadata.from_tuple(metadata)
+        if not isinstance(metadata, Metadata) and isinstance(
+            metadata, (tuple, list)


Since MetadataType can be a Sequence[MetadatumType], should we do isinstance(metadata, Sequence) check instead?

grpc/src/python/grpcio/grpc/aio/_typing.py

Line 38 in 9772d15

MetadataType = Union[Metadata, Sequence[MetadatumType]]

On one hand, this is closer to what we declare to support and will add support for any Sequence-based custom classes.
On another hand, str is technically a Sequence too.

src/python/grpcio/grpc/aio/_call.py

linux-foundation-easycla · 2025-07-23T11:27:56Z

The committers listed above are authorized under a signed CLA.

✅ login: asheshvidyut / name: Ashesh Vidyut (fcb4b7d, 2f193a4, 03e4bb4, 16db703, e71425e, 16c7123, 04b9f74, 6ba1241, 5151ed7, 6749b72, 0f26d36, f8a645b, cd82052)

) ### Description Part 2 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._interceptor` and `grpc.aio._utils` ### Type hint for Public API change for Experimental API **Fixing the error in public API** - `ClientCallDetails` where `method` was `str` but actually it should be `bytes`. It was detected by `typeguard` as well. ### Testing CI ### Related Work - Part 1: #40201 - Part 3: #40217 - b/423755915 Closes #40215 This CL has changes from https://github.com/grpc/grpc/pull/40286/files because it was merged to master on Github without copybara. COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d PiperOrigin-RevId: 786606656

…c#40215) Part 2 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._interceptor` and `grpc.aio._utils` **Fixing the error in public API** - `ClientCallDetails` where `method` was `str` but actually it should be `bytes`. It was detected by `typeguard` as well. CI - Part 1: grpc#40201 - Part 3: grpc#40217 - b/423755915 Closes grpc#40215 This CL has changes from https://github.com/grpc/grpc/pull/40286/files because it was merged to master on Github without copybara. COPYBARA_INTEGRATE_REVIEW=grpc#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d PiperOrigin-RevId: 786606656

…c#40217) Part 3 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._utils` and `grpc.aio._call` CI * Part1: grpc#40201 * Part2: grpc#40215 Closes grpc#40217 This CL also has changes from https://github.com/grpc/grpc/pull/40286/files, because it was merged on Github without copybara. COPYBARA_INTEGRATE_REVIEW=grpc#40217 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-3 cd82052 PiperOrigin-RevId: 786961247

…c#40217) ### Description Part 3 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._utils` and `grpc.aio._call` ### Testing CI ### Related work * Part1: grpc#40201 * Part2: grpc#40215 Closes grpc#40217 This CL also has changes from https://github.com/grpc/grpc/pull/40286/files, because it was merged on Github without copybara. COPYBARA_INTEGRATE_REVIEW=grpc#40217 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-3 cd82052 PiperOrigin-RevId: 786961247

…c#40215) ### Description Part 2 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._interceptor` and `grpc.aio._utils` ### Type hint for Public API change for Experimental API **Fixing the error in public API** - `ClientCallDetails` where `method` was `str` but actually it should be `bytes`. It was detected by `typeguard` as well. ### Testing CI ### Related Work - Part 1: grpc#40201 - Part 3: grpc#40217 - b/423755915 Closes grpc#40215 This CL has changes from https://github.com/grpc/grpc/pull/40286/files because it was merged to master on Github without copybara. COPYBARA_INTEGRATE_REVIEW=grpc#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d PiperOrigin-RevId: 786606656

…c#40217) ### Description Part 3 of Add Typeguard to AIO stack - runs only in tests, fixes type hints for `grpc.aio._utils` and `grpc.aio._call` ### Testing CI ### Related work * Part1: grpc#40201 * Part2: grpc#40215 Closes grpc#40217 This CL also has changes from https://github.com/grpc/grpc/pull/40286/files, because it was merged on Github without copybara. COPYBARA_INTEGRATE_REVIEW=grpc#40217 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-3 cd82052 PiperOrigin-RevId: 786961247

…0226) ### Description Last Part of Add Typeguard to AIO stack - runs only in tests, fixes type hints for AIO Stack Change - #### Type Annotation Update in Channel Constructor File: _channel.py (line 330) Before: credentials: `Optional[grpc.ChannelCredentials]`, After: credentials: `Optional[cygrpc.ChannelCredentials]`, Change: Updated type hint from `grpc.ChannelCredentials` to `cygrpc.ChannelCredentials` #### Metadata Class Method Enhancement File: _metadata.py (around line 100-102) Before: `def from_tuple(cls, raw_metadata: tuple):` After: `def from_tuple(cls, raw_metadata: Union[tuple, Self]):` #### `GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY`decode at Cython layer. File: src/python/grpcio/grpc/_cython/_cygrpc/records.pyx.pxi Before: `GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY = ( _GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY)` After: `GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY = ( _GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY).decode()` ### Testing CI ### Related Work - Part 1: #40201 - Part 2: #40215 - Part 3: #40217 - Part 5: #40278 - b/423755915 Closes #40226 COPYBARA_INTEGRATE_REVIEW=#40226 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-4 70db2d6 PiperOrigin-RevId: 871724432

github-actions bot added the lang/Python label Jul 15, 2025

asheshvidyut added the release notes: no Indicates if PR should not be in release notes label Jul 15, 2025

asheshvidyut requested review from sergiitk and sreenithi July 15, 2025 17:58

grpc-checks bot added per-call-memory/neutral per-channel-memory/neutral bloat/none labels Jul 15, 2025

sergiitk mentioned this pull request Jul 15, 2025

[Python][Typeguard] Part 2 - Add Typeguard to AIO stack in tests #40215

Closed

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-3 branch from be6c3c8 to a7695de Compare July 16, 2025 01:49

asheshvidyut marked this pull request as ready for review July 16, 2025 04:41

asheshvidyut requested a review from veblush as a code owner July 16, 2025 04:41

asheshvidyut mentioned this pull request Jul 16, 2025

[Python] [Typeguard] Part 4 - Add Typeguard to AIO stack in tests #40226

Closed

sreenithi reviewed Jul 21, 2025

View reviewed changes

asheshvidyut requested a review from sreenithi July 22, 2025 05:53

asheshvidyut requested a review from eugeneo as a code owner July 22, 2025 05:56

asheshvidyut removed request for eugeneo and veblush July 22, 2025 08:09

asheshvidyut added release notes: yes Indicates if PR needs to be in release notes and removed release notes: no Indicates if PR should not be in release notes labels Jul 22, 2025

sergiitk approved these changes Jul 23, 2025

View reviewed changes

asheshvidyut requested review from apolcyn, ctiller, drfloob and markdroth as code owners July 23, 2025 11:27

github-actions bot added lang/c++ lang/core area/infra labels Jul 23, 2025

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-3 branch from fb4b8bf to 2ebdfca Compare July 23, 2025 11:28

grpc-checks bot removed the per-call-memory/neutral label Jul 23, 2025

asheshvidyut removed the request for review from ctiller July 23, 2025 15:22

sergiitk changed the title ~~[Python] [Typeguard] Part 3 - Add Typeguard to AIO stack in tests~~ [Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests Jul 24, 2025

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-3 branch from 641b18a to c4bf510 Compare July 24, 2025 09:20

asheshvidyut added 11 commits July 24, 2025 18:01

uncomment import hook

04b9f74

init

e71425e

black code

6ba1241

uncomment only _call:

fcb4b7d

fix proper way

16c7123

fix type hint

0f26d36

revert some codeg

03e4bb4

using MetadataType

f8a645b

fix isort

2f193a4

using Sequence as instance

5151ed7

black

16db703

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-3 branch from c4bf510 to 16db703 Compare July 24, 2025 18:18

asheshvidyut added 2 commits July 24, 2025 18:19

merge conf resolved

6749b72

remove redundant

cd82052

copybara-service bot closed this in 2ca9ac6 Jul 25, 2025

This was referenced Jul 30, 2025

[Python] [Typeguard] Part 5 - Add Typeguard SYNC Stack in tests #40278

Open

[Python] [Typeguard] Part 6 - Add Typeguard SYNC Stack in tests #40353

Open

asheshvidyut added this to the Python Type Hints Support milestone Aug 7, 2025

anniefrchz mentioned this pull request Aug 22, 2025

ALTS Integrity-only Negotiation anniefrchz/grpc#24

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests#40217

[Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests#40217
asheshvidyut wants to merge 13 commits intogrpc:masterfrom
asheshvidyut:feature/type-hints/typeguard-aio-stack-part-3

asheshvidyut commented Jul 15, 2025 •

edited

Loading

Uh oh!

sreenithi Jul 21, 2025

Uh oh!

asheshvidyut Jul 21, 2025

Uh oh!

sreenithi Jul 21, 2025

Uh oh!

asheshvidyut Jul 21, 2025

Uh oh!

Uh oh!

sreenithi Jul 21, 2025

Uh oh!

asheshvidyut Jul 22, 2025

Uh oh!

asheshvidyut Jul 22, 2025

Uh oh!

sergiitk Jul 23, 2025

Uh oh!

sergiitk left a comment

Uh oh!

sergiitk Jul 23, 2025

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Jul 23, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

asheshvidyut commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

BEFORE

AFTER

BEFORE

AFTER

Testing

Related work

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sergiitk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

asheshvidyut commented Jul 15, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jul 23, 2025 •

edited

Loading