Skip to content

Fix Watch follow parameter detection#2616

Merged
kubernetes-prow[bot] merged 1 commit into
kubernetes-client:masterfrom
tamird:tamird/fix-watch-follow-docstring
Jul 4, 2026
Merged

Fix Watch follow parameter detection#2616
kubernetes-prow[bot] merged 1 commit into
kubernetes-client:masterfrom
tamird:tamird/fix-watch-follow-docstring

Conversation

@tamird

@tamird tamird commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind bug

What this PR does / why we need it:

OpenAPI-generated methods now document parameter names and types on separate
lines. Watch still looked for the previous combined :param bool follow:
form, so it sent watch=True to pod log methods. Those methods reject the
unexpected keyword instead of streaming logs.

Match the generated :param follow: form and update the existing test fixture
to use the current generated docstring shape.

Which issue(s) this PR fixes:

Fixes #2615

Special notes for your reviewer:

None.

Does this PR introduce a user-facing change?

Fix Watch.stream selecting watch instead of follow when streaming pod logs.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


The generated client now emits parameter names and types on separate
lines. Watch still searches for the old combined line, so it sends
watch=True to pod log methods and the generated client rejects the
unexpected keyword.

Match the current generated format and update the fixture that covers
log streaming.
@kubernetes-prow kubernetes-prow Bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. labels Jun 20, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @tamird!

It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 20, 2026
@kubernetes-prow kubernetes-prow Bot requested review from roycaihw and yliaog June 20, 2026 19:33
@yliaog

yliaog commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

@goutamadwant could you review this PR?

@goutamadwant goutamadwant left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks, this looks good to me.

This covers the same regression I tried to address in #2612, but does it with the smaller change by updating the existing fixture to the current generated docstring shape. I agree this is the cleaner approach.

One small non-blocking note: this also addresses #2610, which was the original report linked from #2612. It may be worth linking that issue too, or marking it as a duplicate of #2615.

@opokornyy

Copy link
Copy Markdown

Hey @tamird, are you planning to move this PR forward, or should we implement a workaround instead?

@tamird

tamird commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Hey @tamird, are you planning to move this PR forward, or should we implement a workaround instead?

@opokornyy is there action required from me? Happy to make changes; were any requested?

@opokornyy

Copy link
Copy Markdown

Hey @tamird, are you planning to move this PR forward, or should we implement a workaround instead?

@opokornyy is there action required from me? Happy to make changes; were any requested?

No changes were requested on my end. @roycaihw, would you mind taking a look when you have a chance? Thanks!

@yliaog

yliaog commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

/lgtm
/approve

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 4, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: goutamadwant, tamird, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 4, 2026
@yliaog

yliaog commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

thanks for the PR

@kubernetes-prow kubernetes-prow Bot merged commit 587a1a1 into kubernetes-client:master Jul 4, 2026
10 checks passed
@tamird tamird deleted the tamird/fix-watch-follow-docstring branch July 4, 2026 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Watch misclassifies generated pod log methods

4 participants