Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

process: add mypy session for samples - #551

Merged
dandhlee merged 11 commits into
googleapis:mainfrom
plamut:iss-536-samples
Jan 17, 2022
Merged

process: add mypy session for samples#551
dandhlee merged 11 commits into
googleapis:mainfrom
plamut:iss-536-samples

Conversation

@plamut

@plamutplamut commented Dec 17, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

Towards googleapis/google-cloud-python#15652.

This PR adds the mypy session for samples and cleans up their type annotations.

However, the PR does not address the errors caused by mypy not realizing that a lot of methods from the generated client are dynamically injected into the hand written class. It also does not deal with a few missing annotations in google-api-core (e.g. retry.Retry).

Additional thing to consider is that the client classes that the end users use now have many more methods on them that were previously stored on their client.api attribute (and the .api attribute has been removed). Caution is needed here.

@plamut
plamut requested review from a team and pradnDecember 17, 2021 15:33
@plamut
plamut requested a review from a team as a code ownerDecember 17, 2021 15:33
@plamut
plamut requested review from a team and dandhleeDecember 17, 2021 15:33
@product-auto-labelproduct-auto-labelBot added api: pubsub Issues related to the googleapis/python-pubsub API. samples Issues that are directly related to samples. labels Dec 17, 2021
@plamutplamut mentioned this pull request Feb 26, 2026
Open
6 tasks
@plamut

plamut commented Dec 17, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Hm... this will likely not be mergeable, because mypy_samples currently fails (as a part of the main Kokoro run). Probably best to temporarily disable that session until the clients are refactored to directly subclass generated classes instead of dynamically injecting methods from it.

@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@plamut
plamutforce-pushed the iss-536-samples branch 2 times, most recently from c80c04e to 5fe8d2bCompareDecember 17, 2021 15:48
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 17, 2021
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 20, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 20, 2021
@plamutplamut added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 20, 2021
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 20, 2021
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 20, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 20, 2021
@plamutplamut added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 20, 2021
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 20, 2021
@plamutplamut mentioned this pull request Dec 22, 2021
Merged
@plamut
Merge branch 'main' into iss-536-samples
625223f
@plamut
Move type-checked depepndency pins to noxfile
125eb37
The version pins that require recent enough depndencies for the sake
of static type analysis should be placed in the corresponding nox
session definition. They should not interfere with dependency versions
used for testing the code at runtime, i.e. when running the tests.
@plamutplamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 27, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 27, 2021
@plamutplamut added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 28, 2021
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 28, 2021
tswast
tswast approved these changes Jan 12, 2022
View reviewed changes

@tswasttswast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM except for a couple of nits.

Comment threadgoogle/cloud/pubsub_v1/publisher/futures.py Outdated
Comment threadnoxfile.py
@tswasttswast added the automerge Merge the pull request once unit tests and other checks pass. label Jan 12, 2022
@gcf-merge-on-green

gcf-merge-on-greenBot commented Jan 13, 2022

Copy link
Copy Markdown

Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot.

@gcf-merge-on-greengcf-merge-on-greenBot removed the automerge Merge the pull request once unit tests and other checks pass. label Jan 13, 2022
@anguillanneufanguillanneuf added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 15, 2022
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 15, 2022
@dandhlee
dandhlee merged commit a861848 into googleapis:mainJan 17, 2022
@plamut
plamut deleted the iss-536-samples branch January 18, 2022 07:08
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@pradnpradnAwaiting requested review from pradn
@dandhleedandhleeAwaiting requested review from dandhleedandhlee was automatically assigned from googleapis/python-samples-owners
1 more reviewer
@tswasttswasttswast approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@abbrowne126abbrowne126

Labels

api: pubsubIssues related to the googleapis/python-pubsub API.samplesIssues that are directly related to samples.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@plamut@tswast@anguillanneuf@yoshi-kokoro@dandhlee@abbrowne126@parthea