Add type stub files to the Python package #135
Labels
priority: p2
Moderately-important priority. Fix may not be included in next release.
type: feature request
‘Nice-to-have’ improvement, new feature or different behavior or design.
Is your feature request related to a problem? Please describe.
Currently, the generated Python files are not accompanied by type stub files, which, in turn, forces users to disable type checking for some of their gRPC related code. The low-profile (and unmaintained?) package henribru/googleapis-common-protos-stubs provides stubs; however, it’s not been updated recently and its versioning does not lockstep with the actual Python package. It also requires users to take dependency on yet another third-party package that’s not officially maintained by gRPC/Google.
Describe the solution you'd like
I don’t see a problem to generate the type stub files as part of the official package. First, take a look at nipunn1313/mypy-protobuf which provides a
protoc
plugin to generate said type stub files alongside the Python files. The current proto compilation herehttps://github.com/googleapis/api-common-protos/blob/3332dec527759859840a3a2ff108c67a54708130/.circleci/config.yml#L51-L56
would need to be expanded:
Describe alternatives you've considered
The alternative is to either ignore missing imports, or use the aforementioned third-party package and bear the risks such a dependency brings.
Additional context
None.
The text was updated successfully, but these errors were encountered: