Skip to content

Fix pod log stream follow detection#2612

Open
goutamadwant wants to merge 1 commit into
kubernetes-client:masterfrom
goutamadwant:fix-watch-stream-pod-log-follow
Open

Fix pod log stream follow detection#2612
goutamadwant wants to merge 1 commit into
kubernetes-client:masterfrom
goutamadwant:fix-watch-stream-pod-log-follow

Conversation

@goutamadwant
Copy link
Copy Markdown

What type of PR is this?
/kind bug
/kind regression

What this PR does / why we need it:
Watch.stream decides whether to pass watch= or follow= by looking at the wrapped API method docstring.

The generated pod log method now documents follow as split :param follow: and :type follow: bool lines instead of the older :param bool follow: form. Because the watch code only recognized the older form, it passed watch=True to read_namespaced_pod_log, and the generated client rejected that kwarg.

This keeps the existing old-format check and also recognizes the generated split follow docstring, so pod log streaming uses follow=True while normal watch APIs continue to use watch=True.

Which issue(s) this PR fixes:
Fixes #2610

Special notes for your reviewer:
Added a regression test for the generated pod log docstring format. This is scoped to the Watch.stream argument selection path and does not change generated client files.

Checked locally with:

python3 -m unittest kubernetes.watch.watch_test.WatchTests.test_watch_for_follow kubernetes.watch.watch_test.WatchTests.test_watch_for_follow_with_split_param_type_docstring
python3 -m unittest kubernetes.base.watch.watch_test
python3 -m pytest -q kubernetes/base/watch/watch_test.py
python3 -m unittest discover
git diff --check

Does this PR introduce a user-facing change?
Yes - Watch.stream(v1.read_namespaced_pod_log, ...) now uses follow=True for pod log streaming with the current generated docstring format, instead of failing with an unexpected watch argument.

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

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/regression Categorizes issue or PR as related to a regression from a prior release. labels Jun 7, 2026
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Jun 7, 2026

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: goutamadwant / name: Goutam Adwant (5367344)

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @goutamadwant!

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

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: goutamadwant
Once this PR has been reviewed and has the lgtm label, please assign yliaog for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@k8s-ci-robot k8s-ci-robot requested review from fabianvf and yliaog June 7, 2026 15:44
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/bug Categorizes issue or PR as related to a bug. kind/regression Categorizes issue or PR as related to a regression from a prior release. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cannot use Watch().stream with read_namespaced_pod_log

2 participants