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.

Install using pip:

pip install grpc-stubs

Tests (courtesy of pytest-mypy-plugins):

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

## Contributing

### Minimum Reproducible Examples (MRE)

Due to a series of incomplete PRs, 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, and a soft requirement for issues. Incomplete PRs simply transfer the burden from the contributor to the maintainer, and I simply don’t have time to do the deep-dives required to rebuild MREs from scratch when the issues from incomplete PRs inevitably crop up.

### 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

### 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 in the form of some MREs; I’m not sufficiently involved with grpc on a daily basis any more to be able to confidently integrate it myself without assistance.

### 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.10.tar.gz (10.7 kB view hashes)

Uploaded source

Built Distribution

grpc_stubs-1.24.10-py3-none-any.whl (13.8 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