Skip to main content

Mypy stubs for gRPC

Project description

This is a PEP-561-compliant stub-only package which provides type information of [gRPC](https://grpc.io>).

Install using pip:

pip install grpc-stubs

Tests (courtesy of [pytest-mypy-plugins](https://github.com/typeddjango/pytest-mypy-plugins>):

pip install -r requirements-dev.txt ./tools.sh test

## Contributing

### Minimum Reproducible Examples (MRE)

Unfortunately, due to the fussy nature of grpc and its dependencies, and the huge amount of time required to construct a context in which to verify and debug issues, starting from 2022-04-16, fairly strict issue and pull request templates have been added.

Minimum Reproducible Examples are now a hard requirement for pull requests that touch the typing surface, and a soft requirement for issues. PRs without a functioning MRE transfer the burden entirely from the contributor to the maintainer, and I simply don’t have time to do the deep-dives required to build out MREs from scratch when issues inevitably crop up. PRs without a trivially executable MRE will be closed without further consideration; of course you are always welcome to reopen once you have added a verified MRE!

### Tests

This project uses a slightly old version of https://github.com/TypedDjango/pytest-mypy-plugins for testing. All new contributions will be required to include at least one, but probably multiple tests. See typesafety/test_*.yml.

### Code-generated stubs

PRs containing auto-generated stubs have had to be reverted several times due to issues. Starting from 2022-04-16, autogenerated stubs from mypy-protobuf will not be accepted without extensive tests, and will not be accepted with edit warnings left in. It’s ok to use this tool to seed stubs, but not to refresh stubs - once contributed to this repo, the stubs should be presumed to have been written by hand.

## Calls for assistance

There are several areas where grpc-stubs could use some TLC. If you’d like to help with any of this, please reach out!

### API refresh

The last GRPC version I did an API sweep against was the 1.24 series. As at 2022-04-16, we are now up to 1.45 (and counting). These stubs are in need of another sweep.

### Stubs for aio packages

Several attempts have been made to contribute stubs for the aio packages, but have had to be reverted. A more substantive contribution would be very welcome, even if that is just in the form of some complete Minimal Reproducible Examples; I’m not sufficiently involved with grpc on a daily basis any more to be able to confidently integrate it myself without assistance, but a decent set of MREs would make a big difference.

### Maintainers

It’s unlikely I’ll be returning to grpc full-time for the foreseeable future, and my knowledge of the minutiae fades with each passing year. If anyone wishes to assume maintainership of this project ongoing, please reach out.

## Other Very Useful Typed Python Stuff

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grpc-stubs-1.24.11.tar.gz (11.6 kB view hashes)

Uploaded source

Built Distribution

grpc_stubs-1.24.11-py3-none-any.whl (12.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page