Add SharedInformer implementation to python-client by Copilot · Pull Request #2515 · kubernetes-client/python

Copilot · 2026-02-20T18:34:38Z

Python clients wanting a local cache of Kubernetes resources had to implement their own watch loops, reconnection logic, and thread management. This adds a SharedInformer analogous to the Java and JavaScript client implementations.

New package: `kubernetes.informer`

ObjectCache (cache.py) — thread-safe in-memory store keyed by namespace/name; exposes list(), get(), get_by_key(), list_keys()
SharedInformer (informer.py) — daemon thread running list-then-watch loop with:
- Automatic reconnect on ApiException or other errors
- Event handler callbacks for ADDED, MODIFIED, DELETED, BOOKMARK, and ERROR
- resourceVersion tracking: reused on reconnect; reset on 410 Gone for a fresh re-list
- Periodic resync: fires a full list_func call every resync_period seconds even when the cluster is quiet (via timeout_seconds on the watch); resync fires ADDED/MODIFIED/DELETED by diffing old vs new state
- Namespace, label selector, and field selector pass-through

Testing

41 unit tests in kubernetes/test/test_informer.py, covering cache behaviour, event handlers, watch loop, BOOKMARK handling, resourceVersion tracking, 410 Gone recovery, periodic resync, and scenarios analogous to the JavaScript, Java, and client-go reference tests. BOOKMARK-specific tests include:
- Handler is called with the raw BOOKMARK dict (Watch intentionally skips deserialization for BOOKMARK events)
- Cache is not modified by BOOKMARK events
- BOOKMARK advances _resource_version on the informer (exercising Watch's BOOKMARK-aware resource_version extraction)
- Multiple BOOKMARK events advance _resource_version to the latest one
6 end-to-end tests in kubernetes/e2e_test/test_informer.py (auto-skipped when no cluster is available):
- Pre-existing objects appearing in the cache after start()
- ADDED event firing and cache population when a ConfigMap is created
- MODIFIED event firing and updated data verified when a ConfigMap is patched
- DELETED event firing and cache removal when a ConfigMap is deleted
- resourceVersion advancing after real watch events are received
- Periodic resync firing MODIFIED for existing cached objects (test_resync_fires_modified_for_existing_objects)

Add `SharedInformer` to `kubernetes.informer`: a background thread that maintains a thread-safe local cache of Kubernetes objects by running a list-then-watch loop. Fires registered callbacks for ADDED/MODIFIED/DELETED/BOOKMARK/ERROR events, handles reconnects (with 410-Gone re-list), and supports periodic resync. Analogous to the Java and JavaScript client informer implementations.

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…example Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

brendandburns · 2026-02-20T18:50:34Z

@copilot can you add support for BOOKMARK events?

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-20T18:52:57Z

@copilot can you add support for BOOKMARK events?

Done in 9c708ad. Added a BOOKMARK constant and registered it in the handlers dict so consumers can call add_event_handler(BOOKMARK, fn). When a BOOKMARK event arrives in the watch stream the informer fires the handler with the raw BOOKMARK object (which carries the updated resourceVersion). The cache is not modified — BOOKMARK events carry no object state change. Two new tests cover this: one verifies the handler is called with the bookmark object, the other confirms the cache is unaffected.

brendandburns · 2026-02-20T18:56:02Z

@copilot can you implement it so that the most recent resourceVersion is stored and used for the re-list operation?

… on 410 Gone Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-20T18:59:14Z

@copilot can you implement it so that the most recent resourceVersion is stored and used for the re-list operation?

Done in d21aa1b. SharedInformer now tracks _resource_version internally. After the initial list the RV is stored, and after each watch stream ends the Watch's latest RV (updated by every event including BOOKMARKs) is captured in finally. On reconnect the stored RV is passed directly to the next watch call — no full re-list is performed. The only exception is a 410 Gone response, which resets _resource_version to None so the next loop iteration triggers a fresh re-list. Three new tests cover: RV stored from Watch, reconnect skips re-list when RV is known, and 410 triggers re-list.

brendandburns · 2026-02-21T02:36:26Z

@copilot can you add end-to-end tests against a real cluster

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-21T02:39:22Z

@copilot can you add end-to-end tests against a real cluster

Done in 63bd3d5. Added kubernetes/e2e_test/test_informer.py with five tests that run against a real cluster (skipped automatically via base.get_e2e_configuration() when no cluster is reachable):

test_cache_populated_after_start — pre-existing ConfigMaps appear in the cache after start()
test_added_event_and_cache_entry — creating a ConfigMap fires ADDED and the object appears in the cache
test_modified_event_and_cache_refresh — patching a ConfigMap fires MODIFIED
test_deleted_event_removes_from_cache — deleting a ConfigMap fires DELETED and removes the object from the cache
test_resource_version_advances — the stored resourceVersion advances after receiving watch events

Each test uses a unique name (UUID suffix) and registers addCleanup to delete created ConfigMaps, so they are safe to run in parallel with other e2e tests.

Copilot · 2026-03-18T15:03:35Z

@copilot i don't think the release note has been updated properly, could you double check?

The PR description has been updated in 1d10150 with a properly-formatted standalone release-note code block.

@copilot please address comments related to the copyright year, for newly created files, it should be updated to 2026 (the current year) instead of 2024. For existing files, the old...

Done in 1d10150. Copyright year updated to 2026 in all 6 new files (existing files untouched). Added test_resync_fires_modified_for_existing_objects to kubernetes/e2e_test/test_informer.py: starts the informer with resync_period=5, waits for the initial ADDED event, then waits up to 15 s for a MODIFIED event fired by the resync, and verifies the cached object's data is still correct.

brendandburns · 2026-03-19T18:09:39Z

@roycaihw @yliaog I think all comments are addressed and an e2e test is added to validate that the resync logic works correctly, I think this is good to merge.

yliaog · 2026-03-22T01:39:38Z

+                    elif evt_type == BOOKMARK:
+                        # BOOKMARK events carry an updated resource version but
+                        # no object state change; the Watch instance already
+                        # records the new resource_version internally.


Watch added the support for BOOKMARK event handling a couple of months ago in #2505, wondering if copilot could add a test for BOOKMARK ?

yliaog · 2026-03-22T01:41:42Z

/lgtm

I'll leave it to @roycaihw to further review and approve

yliaog · 2026-03-22T01:46:19Z

@brendandburns what is your initial / first prompt to copilot that created this PR?

brendandburns · 2026-03-22T03:51:41Z

@copilot please add unit tests for BOOKMARK events.

brendandburns · 2026-03-22T03:52:07Z

@yliaog the first prompt was assigning it this issue: #868 and telling it to look at the Java and Javascript implementations of the informer.

…kmarks Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com> Agent-Logs-Url: https://github.com/kubernetes-client/python/sessions/d5256bd7-1cab-4399-97a0-9c115a2f97cb

Copilot · 2026-03-22T03:54:18Z

@copilot please add unit tests for BOOKMARK events.

Done in 6425bab. Added 3 new BOOKMARK unit tests targeting the behavior introduced in PR #2505:

test_bookmark_advances_resource_version — verifies that after a BOOKMARK event the informer's _resource_version reflects the RV carried by the BOOKMARK (Watch sets self.resource_version from the raw dict without deserializing)
test_bookmark_handler_receives_raw_dict — verifies the handler receives a plain dict, not a deserialized model (Watch intentionally skips deserialization for incomplete BOOKMARK objects)
test_multiple_bookmarks_advance_resource_version_to_latest — verifies that after a sequence of BOOKMARK events _resource_version equals the last one received

Total BOOKMARK test count is now 5 (2 existing + 3 new); all 41 unit tests pass.

yliaog · 2026-03-23T17:24:50Z

+            mock_w.resource_version = "100"
+
+            def fake_stream(func, **kw):
+                yield {"type": "BOOKMARK", "object": bookmark_obj, "raw_object": bookmark_obj}


this fake_stream is NOT really used, if we change bookmark_obj's resourceVersion to "200" (from the current "100"), the test still passes.

Fixed in a858453. mock_w.resource_version now starts at "5" (the initial-list RV), and fake_stream updates it to "100" before yielding the BOOKMARK event — mirroring how Watch.unmarshal_event sets resource_version before yielding. The test now fails if BOOKMARK handling is broken, because the informer has to actually read the updated value from the watch rather than finding "100" already set before the stream runs.

brendandburns · 2026-03-25T17:00:06Z

@copilot please address the comment on the bookmark test

…rce_version to list RV and update in fake_stream Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com> Agent-Logs-Url: https://github.com/kubernetes-client/python/sessions/eed1f863-e80c-4b7a-9901-26288418183e

brendandburns · 2026-04-02T18:27:42Z

@yliaog @roycaihw anything more needed on this PR?

yliaog · 2026-04-02T18:45:13Z

It looks good to me, I'll have @roycaihw take a look.

yliaog · 2026-04-20T00:57:39Z

/approve

k8s-ci-robot · 2026-04-20T00:57:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, Copilot, 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:

~~OWNERS~~ [yliaog]

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

yliaog · 2026-04-20T00:58:07Z

/lgtm

Initial plan

ab86645

Copilot AI assigned Copilot and brendandburns Feb 20, 2026

Copilot started work on behalf of brendandburns February 20, 2026 18:34 View session

Add informer implementation: SharedInformer, ObjectCache, tests, and …

ef3f21c

…example Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 20, 2026

Copilot AI changed the title ~~[WIP] Add informer implementation to python-client~~ Add SharedInformer implementation to python-client Feb 20, 2026

Copilot AI requested a review from brendandburns February 20, 2026 18:42

Copilot finished work on behalf of brendandburns February 20, 2026 18:42

Copilot started work on behalf of brendandburns February 20, 2026 18:50 View session

Add BOOKMARK event support to SharedInformer

9c708ad

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot finished work on behalf of brendandburns February 20, 2026 18:53

Copilot started work on behalf of brendandburns February 20, 2026 18:56 View session

Track and reuse resourceVersion across watch reconnects; re-list only…

d21aa1b

… on 410 Gone Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot finished work on behalf of brendandburns February 20, 2026 19:00

Copilot started work on behalf of brendandburns February 21, 2026 02:36 View session

Add e2e tests for SharedInformer against a real cluster

63bd3d5

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

k8s-ci-robot removed the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 21, 2026

k8s-ci-robot 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 Mar 18, 2026

Copilot finished work on behalf of brendandburns March 18, 2026 15:04

yliaog reviewed Mar 22, 2026

View reviewed changes

k8s-ci-robot assigned yliaog Mar 22, 2026

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 22, 2026

Copilot started work on behalf of brendandburns March 22, 2026 03:52 View session

Add 3 BOOKMARK unit tests: RV advance, raw-dict handler, multiple boo…

6425bab

…kmarks Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com> Agent-Logs-Url: https://github.com/kubernetes-client/python/sessions/d5256bd7-1cab-4399-97a0-9c115a2f97cb

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 22, 2026

Copilot finished work on behalf of brendandburns March 22, 2026 03:55

yliaog reviewed Mar 23, 2026

View reviewed changes

brendandburns approved these changes Apr 3, 2026

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 20, 2026

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 20, 2026

k8s-ci-robot merged commit 8c1a954 into master Apr 20, 2026
16 checks passed

brendandburns mentioned this pull request Apr 24, 2026

Implement an Informer in python-client #868

Open

Conversation

Copilot AI commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New package: kubernetes.informer

Testing

Uh oh!

brendandburns commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

brendandburns commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

brendandburns commented Feb 21, 2026

Uh oh!

Copilot AI commented Feb 21, 2026

Uh oh!

Copilot AI commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brendandburns commented Mar 19, 2026

Uh oh!

yliaog Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

yliaog commented Mar 22, 2026

Uh oh!

yliaog commented Mar 22, 2026

Uh oh!

brendandburns commented Mar 22, 2026

Uh oh!

brendandburns commented Mar 22, 2026

Uh oh!

Copilot AI commented Mar 22, 2026

Uh oh!

yliaog Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

brendandburns commented Mar 25, 2026

Uh oh!

brendandburns commented Apr 2, 2026

Uh oh!

yliaog commented Apr 2, 2026

Uh oh!

yliaog commented Apr 20, 2026

Uh oh!

k8s-ci-robot commented Apr 20, 2026

Uh oh!

yliaog commented Apr 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Copilot AI commented Feb 20, 2026 •

edited

Loading

New package: `kubernetes.informer`

Copilot AI commented Mar 18, 2026 •

edited

Loading