client: add Kubernetes-aware retry helpers by sttts · Pull Request #2634 · kubernetes-client/python

sttts · 2026-07-15T14:52:39Z

Summary

Add client-go-style retry helper APIs for the sync and AIO Python clients.

Shared primitives live in kubernetes/base/retry.py.
Public sync helpers live in kubernetes.utils.retry.
Public AIO helpers live in kubernetes.aio.utils.retry.
Helpers cover 409 conflict retries for writes and Retry-After/backoff behavior for later generated read retry wiring.
AIO utils are included in both setup-asyncio.py and the combined setup-release.py package list.

The generated REST/Configuration wiring is intentionally separate and follows in kubernetes-client/gen#304.

Validation

.venv/bin/python -m unittest kubernetes.utils.retry_test kubernetes.aio.utils.retry_test
.venv/bin/python -m pytest -q kubernetes/utils/retry_test.py kubernetes/aio/utils/retry_test.py
.venv/bin/python -m pycodestyle ... for retry helpers, exports, and setup-release.py
setup.py, setup-asyncio.py, and setup-release.py build_py checks confirmed symlinked helper files are copied as regular files
git diff --check

Add Kubernetes-aware retry helper APIs for Python clients, modeled on client-go retry behavior.

kubernetes-prow · 2026-07-15T14:52:49Z

Welcome @sttts!

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

yliaog · 2026-07-16T03:19:53Z

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import asyncio


kuberentes/utils/ is for synchronous version of the client

kubernetes/aio/utils is for asynchronous version of the client

this file should not use asyncio, i think.

it's for the default of the sleep func. But yes, I agree it should be the inverse.

updated. Looks a lot better now: shared backoffs in base, linked into the sync and async variants. The aio helper implemented on-top. I.e. no duplicated code.

roycaihw · 2026-07-16T21:36:55Z

/assign @yliaog

kubernetes-prow · 2026-07-17T07:00:34Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sttts
Once this PR has been reviewed and has the lgtm label, please ask for approval from yliaog. 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:

OWNERS

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

Signed-off-by: Dr. Stefan Schimanski <stefan.schimanski@gmail.com>

sttts · 2026-07-21T12:23:34Z

Fixed in the latest push: setup-release.py now includes kubernetes.aio.utils, so the combined release package includes the new AIO retry helpers.

I also verified setup-release.py build_py copies kubernetes/aio/utils/retry.py, kubernetes/aio/utils/_retry_base.py, and kubernetes/aio/utils/retry_test.py into the combined release build output, and updated the PR description with that validation.

yliaog · 2026-07-21T16:05:30Z

+# Kubernetes Go retry algorithms used by client-go:
+# - https://github.com/kubernetes/client-go/blob/master/util/retry/util.go
+# - https://github.com/kubernetes/client-go/blob/master/rest/with_retry.go
+async def async_on_error(


do we need async_ prefix in the function name? the function is under aio/utils, so it should be async to users. WDYT?

yliaog · 2026-07-21T16:05:37Z

+    raise last_error
+
+
+async def async_retry_on_conflict(


yliaog · 2026-07-21T16:05:47Z

+        backoff, is_conflict, fn, sleep_func, random_func)
+
+
+async def async_on_retry_after_error(


kubernetes-prow Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 15, 2026

kubernetes-prow Bot requested review from roycaihw and yliaog July 15, 2026 14:53

sttts changed the title ~~utils: add Kubernetes retry helpers~~ client: add Kubernetes-aware retry helpers Jul 15, 2026

kubernetes-prow Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 15, 2026

sttts marked this pull request as ready for review July 15, 2026 15:09

kubernetes-prow Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 15, 2026

sttts marked this pull request as draft July 15, 2026 15:16

kubernetes-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 15, 2026

sttts marked this pull request as ready for review July 15, 2026 15:18

kubernetes-prow Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 15, 2026

sttts marked this pull request as draft July 15, 2026 15:25

kubernetes-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 15, 2026

sttts marked this pull request as ready for review July 15, 2026 15:57

kubernetes-prow Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 15, 2026

sttts mentioned this pull request Jul 15, 2026

Generate Python client-go retry wiring kubernetes-client/gen#304

Open

kubernetes-prow Bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 15, 2026

sttts force-pushed the agent/kubernetes-retry-utils branch from ee00eac to ec56a76 Compare July 15, 2026 16:58

yliaog reviewed Jul 16, 2026

View reviewed changes

kubernetes-prow Bot assigned yliaog Jul 16, 2026

sttts force-pushed the agent/kubernetes-retry-utils branch from ec56a76 to 50d8aed Compare July 17, 2026 07:00

kubernetes-prow Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 17, 2026

utils: add Kubernetes retry helpers

3e89602

Signed-off-by: Dr. Stefan Schimanski <stefan.schimanski@gmail.com>

sttts force-pushed the agent/kubernetes-retry-utils branch from 50d8aed to 3e89602 Compare July 17, 2026 07:20

sttts added 2 commits July 17, 2026 14:08

utils: split sync retry wrapper

5ef02fb

Signed-off-by: Dr. Stefan Schimanski <stefan.schimanski@gmail.com>

utils: package aio retry helpers in release

48bdc29

Signed-off-by: Dr. Stefan Schimanski <stefan.schimanski@gmail.com>

kubernetes-prow Bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jul 21, 2026

yliaog reviewed Jul 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

client: add Kubernetes-aware retry helpers#2634

client: add Kubernetes-aware retry helpers#2634
sttts wants to merge 3 commits into
kubernetes-client:masterfrom
sttts:agent/kubernetes-retry-utils

sttts commented Jul 15, 2026 •

edited

Loading

Uh oh!

kubernetes-prow Bot commented Jul 15, 2026

Uh oh!

yliaog Jul 16, 2026

Uh oh!

sttts Jul 17, 2026

Uh oh!

sttts Jul 17, 2026

Uh oh!

roycaihw commented Jul 16, 2026

Uh oh!

kubernetes-prow Bot commented Jul 17, 2026

Uh oh!

sttts commented Jul 21, 2026

Uh oh!

yliaog Jul 21, 2026

Uh oh!

yliaog Jul 21, 2026

Uh oh!

yliaog Jul 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		backoff, is_conflict, fn, sleep_func, random_func)


		async def async_on_retry_after_error(

Uh oh!

Conversation

sttts commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

kubernetes-prow Bot commented Jul 15, 2026

Uh oh!

yliaog Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

sttts Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

sttts Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw commented Jul 16, 2026

Uh oh!

kubernetes-prow Bot commented Jul 17, 2026

Uh oh!

sttts commented Jul 21, 2026

Uh oh!

yliaog Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

yliaog Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

yliaog Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sttts commented Jul 15, 2026 •

edited

Loading