-
Notifications
You must be signed in to change notification settings - Fork 314
feat: Add py.typed for PEP 561 compliance #976
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.
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
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
Is the CLA required for something so trivial? |
@jdufresne Thank you for your contribution! CLA is required, yes, regardless of the contribution size, otherwise the bot will not allow to merge a PR. |
@googlebot I signed it! |
FWIW, that failed system test is known flakiness. @tswast We now actually have the job ID in the logs to investigate, I have shared it with you privately. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just suggest putting the following content in the py.typed
file for consistency, similarly to bigquery_v2/py.typed and py.typed
files in other Python client libraries:
# Marker file for PEP 561.
# The google-cloud-bigquery package uses inline types.
Type annotations were added in commit f8d4aaa. For these annotations to be useful by library users, the package should install a py.typed file. This tells mypy and other tools to consume and use these types. For more details, see: https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages
@plamut Thanks for the review. I've applied the suggestion to the latest revision. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good as far as I'm concerned. And thanks again!
Type annotations were added in commit f8d4aaa. For these annotations to be useful by library users, the package should install a py.typed file. This tells mypy and other tools to consume and use these types. For more details, see: https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages
Type annotations were added in commit
f8d4aaa. For these annotations to be
useful by library users, the package should install a py.typed file.
This tells mypy and other tools to consume and use these types.
For more details, see:
https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages