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

asheshvidyut · 2025-07-15T11:29:37Z

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.
The change is done because the code flow actually sends bytes instead of str see - https://github.com/grpc/grpc/blob/master/src/python/grpcio/grpc/aio/_interceptor.py#L655

It was detected by typeguard as well.

Testing

CI

Related Work

Part 1: [Python][Typeguard] Part 1: Add Typeguard to AIO stack in tests #40201
Part 3: [Python][Typeguard] Part 3 - Add Typeguard to AIO stack in tests #40217
b/423755915

asheshvidyut · 2025-07-15T13:25:50Z

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

+        raise NotImplementedError()
+
+
+class StreamStreamCallResponseIterator(


This class and 3 classes above are cut - paste from the file below, because the class was needed for type hints.

I'm OK with this, just be aware that your name will be on git blame for this lines. Internal Google java style guide calls it "You change it, you own it".

This may be solvable with from __future__ import annotations. Apparently type deferred evaluation will be the default behavior in Python 3.14 anyway: https://docs.python.org/3.14/whatsnew/3.14.html#pep-649-and-749-deferred-evaluation-of-annotations

With typeguard version bump - this works. Thanks.

sergiitk · 2025-07-18T02:50:03Z

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

+        raise NotImplementedError()
+
+
+class StreamStreamCallResponseIterator(


I'm OK with this, just be aware that your name will be on git blame for this lines. Internal Google java style guide calls it "You change it, you own it".

This may be solvable with from __future__ import annotations. Apparently type deferred evaluation will be the default behavior in Python 3.14 anyway: https://docs.python.org/3.14/whatsnew/3.14.html#pep-649-and-749-deferred-evaluation-of-annotations

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

bazel/_run_time_type_check_main.py

sergiitk · 2025-07-18T06:01:01Z

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

        client_call_details: ClientCallDetails,
        request: RequestType,
-    ) -> Union[UnaryUnaryCall, ResponseType]:
+    ) -> UnaryUnaryCall:


We should globally disable this check in typeguard. If our tests don't have coverage for returning ResponseType that we claim is a valid return type, it's on us to add the missing coverage.

This will be reverted.

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

bazel/_run_time_type_check_main.py

sreenithi · 2025-07-18T10:01:32Z

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

-        self, request: RequestType, call: InterceptedCall
+        self,
+        request: RequestType,
+        call: Union[InterceptedCall, _base_call.Call],


This is not a public function, but looks like we're changing the allowed inputs to both an InterceptedCall and a general Call object. Is this an intended behaviour?

On reverting this change, typeguard fails with error

File "/usr/local/google/home/asheshvidyut/.cache/bazel/_bazel_asheshvidyut/37ab11cdf3f320a86e32407534188cd9/sandbox/linux-sandbox/2564/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/client_stream_stream_interceptor_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/2564/execroot/com_github_grpc_grpc/bazel-out/k8-fastbuild/bin/src/python/grpcio_tests/tests_aio/unit/client_stream_stream_interceptor_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 "call" (grpc.aio._interceptor.StreamStreamCallResponseIterator) is not an instance of grpc.aio._interceptor.InterceptedCall

I see the log lines like these

typeguard.TypeCheckError: argument "call" (grpc.aio._call.StreamUnaryCall) is not an instance of grpc.aio._interceptor.InterceptedCall

typeguard.TypeCheckError: argument "call" (grpc.aio._interceptor.StreamStreamCallResponseIterator) is not an instance of grpc.aio._interceptor.InterceptedCal

So keeping it only _base_calll.Call

linux-foundation-easycla · 2025-07-22T15:38:15Z

The committers listed above are authorized under a signed CLA.

✅ login: asheshvidyut / name: Ashesh Vidyut (51c5b0d, e990aad, 943bcb3, 22aed6c, 0fb85b8, 0584e92, 2b2df94, ec590cc, 24536e2, 0d7d90d, 15c1447, cc434a6, 0a6ec61, ce02cba, 313dbf9)

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

asheshvidyut · 2025-07-23T16:52:25Z

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

-    ) -> UnaryStreamCall:
+        request_serializer: Optional[SerializingFunction],
+        response_deserializer: Optional[DeserializingFunction],
+    ) -> Union[UnaryStreamCall, UnaryStreamCallResponseIterator]:


Typeguard stack trace after reverting this.

raise TypeCheckError(f"is not an instance of {qualified_name(origin_type)}") typeguard.TypeCheckError: the return value (grpc.aio._interceptor.UnaryStreamCallResponseIterator) is not an instance of grpc.aio._call.UnaryStreamCall

One thing I considered is that UnaryStreamCallResponseIterator is not in the public API. But neither are any of these methods we're changing.

asheshvidyut · 2025-07-23T16:55:18Z

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

-    ) -> StreamStreamCall:
+        request_serializer: Optional[SerializingFunction],
+        response_deserializer: Optional[DeserializingFunction],
+    ) -> Union[StreamStreamCall, StreamStreamCallResponseIterator]:


Typeguard stack trace

raise TypeCheckError(f"is not an instance of {qualified_name(origin_type)}") typeguard.TypeCheckError: the return value (grpc.aio._interceptor.StreamStreamCallResponseIterator) is not an instance of grpc.aio._call.StreamStreamCall

also we have return StreamStreamCallResponseIterator in the method below.

Thanks - same as above. LGTM.

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/786620461](http://cl/786620461) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 786620461

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/785301169](http://cl/785301169) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 785301169

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/786620461](http://cl/786620461) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 786620461

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/785301169](http://cl/785301169) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 785301169

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/786620461](http://cl/786620461) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 786620461

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/785301169](http://cl/785301169) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 785301169

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/786620461](http://cl/786620461) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 786620461

COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d FUTURE_COPYBARA_INTEGRATE_REVIEW=#40215 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-2 3fc7a9d ---- DO NOT SUBMIT. This PR is for testing purposes only. [cl/786690273](http://cl/786690273) [cl/786606656](http://cl/786606656) [cl/786572880](http://cl/786572880) [cl/786529063](http://cl/786529063) [cl/786454401](http://cl/786454401) PiperOrigin-RevId: 786690273

) ### 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: #40201 * Part2: #40215 Closes #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=#40217 from asheshvidyut:feature/type-hints/typeguard-aio-stack-part-3 cd82052 PiperOrigin-RevId: 786961247

…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

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

asheshvidyut requested review from sergiitk and sreenithi July 15, 2025 12:51

asheshvidyut commented Jul 15, 2025

View reviewed changes

asheshvidyut marked this pull request as ready for review July 15, 2025 13:51

asheshvidyut requested a review from veblush as a code owner July 15, 2025 13:51

asheshvidyut changed the title ~~[Python] [Part 2] - Add Typeguard to AIO stack in tests~~ [Python] [Typeguard] Part 2 - Add Typeguard to AIO stack in tests Jul 15, 2025

asheshvidyut mentioned this pull request Jul 15, 2025

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

Closed

sergiitk mentioned this pull request Jul 15, 2025

[Python][Typeguard] Part 1: Add Typeguard to AIO stack in tests #40201

Closed

asheshvidyut mentioned this pull request Jul 16, 2025

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

Closed

sergiitk requested changes Jul 18, 2025

View reviewed changes

sreenithi reviewed Jul 18, 2025

View reviewed changes

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

asheshvidyut requested review from sergiitk and sreenithi and removed request for eugeneo and veblush July 22, 2025 05:43

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-2 branch from f4abeef to eb3f14c Compare July 22, 2025 15:38

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

asheshvidyut force-pushed the feature/type-hints/typeguard-aio-stack-part-2 branch from 935d65b to e0af9a8 Compare July 23, 2025 10:58

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

asheshvidyut commented Jul 23, 2025

View reviewed changes

src/python/grpcio/grpc/aio/_interceptor.py Show resolved Hide resolved

asheshvidyut commented Jul 23, 2025

View reviewed changes

copybara-service bot mentioned this pull request Jul 24, 2025

[export] Internal change #40318

Open

ctiller closed this in 4499b46 Jul 24, 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

This was referenced Sep 23, 2025

grpc.aio.ClientCallDetails method attribute typed as str but is bytes #31092

Closed

Type annotation incorrect on grpc.aio.ClientCallDetails.method #39405

Closed

asheshvidyut mentioned this pull request Jan 30, 2026

Type annotations incorrect on aio client interceptor #39370

Closed

		raise NotImplementedError()


		class StreamStreamCallResponseIterator(

Conversation

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

Uh oh!

Description

Type hint for Public API change for Experimental API

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

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

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

asheshvidyut commented Jul 15, 2025 •

edited

Loading

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

edited

Loading

sergiitk Jul 24, 2025 •

edited

Loading