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

Add a py.typed file for submodule #621

Closed
crwilcox opened this issue Oct 12, 2021 · 5 comments · Fixed by #716
Closed

Add a py.typed file for submodule #621

crwilcox opened this issue Oct 12, 2021 · 5 comments · Fixed by #716
Assignees
Labels
api: storage Issues related to the googleapis/python-storage API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@crwilcox
Copy link
Contributor

To be in accordance with PEP 561 we should add a py.typed file to google/cloud/storage/py.typed

The file can be empty but does need to be present for some type checkers.

@product-auto-label product-auto-label bot added the api: storage Issues related to the googleapis/python-storage API. label Oct 12, 2021
@crwilcox
Copy link
Contributor Author

Do note, you may need to run mypy, pyright, pytype against our samples before merging. It will ensure that we aren't exposing users to failing type checks.

Ideally we would add this to CI as well, to avoid future breakage.

@BrennaEpp BrennaEpp added the type: process A process-related concern. May include testing, release, or the like. label Oct 14, 2021
@cojenco cojenco assigned cojenco and unassigned cojenco Oct 14, 2021
@cojenco
Copy link
Contributor

cojenco commented Oct 14, 2021

Thanks @crwilcox for bringing this to our attention. We're planning to add the py.typed files after we finish deprecating Python 2 these coming weeks. Wanted to check if this is blocking anyone or any urgency for doing this sooner?

@crwilcox
Copy link
Contributor Author

This shouldn't be blocking anyone. Feel free to schedule it for then.

@danielduhh danielduhh added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. and removed type: process A process-related concern. May include testing, release, or the like. labels Feb 16, 2022
@alex-statsig
Copy link

This was removed due to #734 a month after, and its been two years now; is there any plan to re-open / re-add this?

@rmorshea
Copy link

see #393

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/python-storage API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
6 participants