Skip to content

Add grpc.experimental.gevent stubs #15839

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
wangting0128 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

Add grpc.experimental.gevent stubs #15839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions stubs/grpcio/@tests/test_cases/check_experimental.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
from typing_extensions import assert_type

import grpc.experimental.gevent as grpc_gevent

assert_type(grpc_gevent.init_gevent(), None)
Comment on lines +1 to +5
Copy link
Copy Markdown
Collaborator

@brianschubert brianschubert May 31, 2026

Choose a reason for hiding this comment

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

You can remove this file - test cases are only needed for weird and/or complicated cases that might regress in the future. This test basically repeats the signature (and a particularly trivial one at that :-)), so it isn't really necessary

1 change: 1 addition & 0 deletions stubs/grpcio/grpc/experimental/__init__.pyi
View file
Open in desktop
Copy link
Copy Markdown
Collaborator

@brianschubert brianschubert May 31, 2026

Choose a reason for hiding this comment

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

I think you can just delete this file, since partial-stub = true, and no direct members of this module are being stubbed. But if that ends up not being the case, you need to add the following to account for the fact that not all public functions are part of the stub file:

def __getattr__(name: str): ...  # incomplete module

The partial-stub marker in METADATA.toml only tells type checkers that whole modules are missing, not that modules that do exist might be incomplete. That's what the __getattr__ does. You may also need to add this module to pyrightconfig.stricter.json if not already covered

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import gevent as gevent
Copy link
Copy Markdown
Collaborator

@brianschubert brianschubert May 31, 2026

Choose a reason for hiding this comment

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

The runtime doesn't actually re-export gevent, so e.g. this fails:

$ uv run -w grpcio python3 -c 'import grpc.experimental; grpc.experimental.gevent'
Traceback (most recent call last):
  File "<string>", line 1, in <module>
    import grpc.experimental; grpc.experimental.gevent
                              ^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: module 'grpc.experimental' has no attribute 'gevent'

Type checkers understand submodule relationships, so we don't need to add anything here in order for them to understand that the gevent submodule exists.

Suggested change
from . import gevent as gevent

1 change: 1 addition & 0 deletions stubs/grpcio/grpc/experimental/gevent.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
def init_gevent() -> None: ...
Loading