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.

Sign up for GitHub

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

Jump to bottom

docs: add type annotations to codebase #509

Merged
merged 10 commits into from
Oct 1, 2021
Merged

docs: add type annotations to codebase #509

merged 10 commits into from
Oct 1, 2021

Conversation

plamut
Copy link
Contributor

@plamut plamut commented Sep 28, 2021

Closes #500.

PR checklist:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@plamut plamut requested review from a team as code owners September 28, 2021 13:50
@product-auto-label product-auto-label bot added the api: pubsub Issues related to the googleapis/python-pubsub API. label Sep 28, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Sep 28, 2021
@plamut
Copy link
Contributor Author

plamut commented Sep 28, 2021

NOTE: py.typed file (PEP 561) marker was intentionally not added, as this could break the workflows of users that use mypy for type checks. This happened in BigQuery, for example.

We will thus likely add py.typed once we know for sure that mypy is happy with our type annotations.

anguillanneuf
anguillanneuf approved these changes Oct 1, 2021
View reviewed changes
Copy link
Contributor

@anguillanneuf anguillanneuf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Thanks a lot!

pradn
pradn approved these changes Oct 1, 2021
View reviewed changes
Copy link
Contributor

@pradn pradn 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, thanks!

@plamut
Copy link
Contributor Author

plamut commented Oct 1, 2021

Thank you both for the reviews!

@plamut plamut added the automerge Merge the pull request once unit tests and other checks pass. label Oct 1, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit 093cabf into googleapis:main Oct 1, 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 Oct 1, 2021
@plamut plamut deleted the iss-500 branch October 1, 2021 19:28
gcf-merge-on-green bot pushed a commit that referenced this pull request Nov 10, 2021
@release-please
chore: release 2.9.0 (#522)
5c8e9db 
🤖 I have created a release \*beep\* \*boop\*
---
## [2.9.0](https://github.com/googleapis/python-pubsub/compare/v2.8.0...v2.9.0) (2021-11-10)


### Features

* add context manager support in client ([#516](https://github.com/googleapis/python-pubsub/issues/516)) ([51eae67](https://github.com/googleapis/python-pubsub/commit/51eae67c47e2ce7d2f7620209e98df4a129801b5))
* add support for Python 3.10 ([#518](https://github.com/googleapis/python-pubsub/issues/518)) ([bb25d75](https://github.com/googleapis/python-pubsub/commit/bb25d755d70ba19e69d8a281be65f13eb994967d))


### Bug Fixes

* add 'dict' annotation type to 'request' ([b72522a](https://github.com/googleapis/python-pubsub/commit/b72522a4617c4b2773fb6a5a631038791aa08300))
* **deps:** drop packaging dependency ([290b9c5](https://github.com/googleapis/python-pubsub/commit/290b9c5615eaa03674b773a27b756483abd76195))
* **deps:** require google-api-core >= 1.28.0 ([290b9c5](https://github.com/googleapis/python-pubsub/commit/290b9c5615eaa03674b773a27b756483abd76195))
* improper types in pagers generation ([2ad639d](https://github.com/googleapis/python-pubsub/commit/2ad639d6370c7a085498595d7bd0d7eaadfff3c1))


### Documentation

* add type annotations to codebase ([#509](https://github.com/googleapis/python-pubsub/issues/509)) ([093cabf](https://github.com/googleapis/python-pubsub/commit/093cabff9f0464b1dfaa8f373b6fffbc439518de))
* list oneofs in docstring ([290b9c5](https://github.com/googleapis/python-pubsub/commit/290b9c5615eaa03674b773a27b756483abd76195))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@release-please release-please bot mentioned this pull request Aug 11, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anguillanneuf anguillanneuf anguillanneuf approved these changes

@pradn pradn pradn approved these changes

Assignees
No one assigned
Labels
api: pubsub Issues related to the googleapis/python-pubsub API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add type annotations to the codebase
3 participants
@plamut @pradn @anguillanneuf