googleapis / googleapis/google-cloud-python

Include mypy types / add py.typed

Open
#13,362 3 comments 0 reactions 0 assignees View on GitHub
priority: p3 type: feature request
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

**Is your feature request related to a problem? Please describe.**

Modern python can be type-checked using mypy, but the python distribution of this package does not include the type specs, nor is there a companion type package.

**Describe the solution you'd like**

Types generated using e.g. https://pypi.org/project/mypy-protobuf/ included either directly in the python googleapis-common-protos package or a separate googleapis-common-protos-stubs package. A separate stubs package might help with avoiding accidental breakage.

**Describe alternatives you've considered**

I could check in the googleapi protos into the repository where I'm using them and add codegen from that.

**Additional context**
For the grpcio packages, there's stubs maintained by a third-party, https://pypi.org/project/grpc-stubs/. The protoc plugin https://pypi.org/project/mypy-protobuf/ codegens stubs for proto files (messages and grpc clients/handlers).

These packages need py.typed

- [ ] google-cloud-access-context-manager
- [ ] google-cloud-audit-log
- [ ] googleapis-common-protos
- [ ] grpc-google-iam-v1

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.