Navigation Menu

Skip to content
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

feat: Add py.typed for PEP 561 compliance #976

Merged
merged 1 commit into from Sep 20, 2021
Merged

feat: Add py.typed for PEP 561 compliance #976

merged 1 commit into from Sep 20, 2021

Conversation

jdufresne
Copy link
Contributor

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

@jdufresne jdufresne requested a review from a team September 19, 2021 19:03
@jdufresne jdufresne requested a review from a team as a code owner September 19, 2021 19:03
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Sep 19, 2021
@google-cla
Copy link

google-cla bot commented Sep 19, 2021

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 @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no This human has *not* signed the Contributor License Agreement. label Sep 19, 2021
@jdufresne
Copy link
Contributor Author

Is the CLA required for something so trivial?

@plamut
Copy link
Contributor

plamut commented Sep 19, 2021

@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.

@jdufresne
Copy link
Contributor Author

@googlebot I signed it!

@google-cla google-cla bot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Sep 19, 2021
@jdufresne jdufresne changed the title Add py.typed for PEP 561 compliance feat: Add py.typed for PEP 561 compliance Sep 19, 2021
@dandhlee dandhlee added the kokoro:run Add this label to force Kokoro to re-run the tests. label Sep 19, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Sep 19, 2021
@plamut
Copy link
Contributor

plamut commented Sep 20, 2021

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.

@plamut plamut added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 20, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 20, 2021
Copy link
Contributor

@plamut plamut left a 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
@jdufresne
Copy link
Contributor Author

@plamut Thanks for the review. I've applied the suggestion to the latest revision.

Copy link
Contributor

@plamut plamut left a 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!

@tswast tswast added kokoro:force-run Add this label to force Kokoro to re-run the tests. automerge Merge the pull request once unit tests and other checks pass. labels Sep 20, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 20, 2021
@tswast tswast merged commit 96e6bee into googleapis:main Sep 20, 2021
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Sep 20, 2021
tswast added a commit that referenced this pull request Sep 27, 2021
abdelmegahedgoogle pushed a commit to abdelmegahedgoogle/python-bigquery that referenced this pull request Apr 17, 2023
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants