-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Mark the Kubernetes package as typed #2657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kubernetes-prow
merged 2 commits into
kubernetes-client:master
from
tamird:prototype/mark-kubernetes-package-typed
Jul 30, 2026
+88
−2
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Copyright 2026 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from importlib.resources import files | ||
| import unittest | ||
|
|
||
| from typing_extensions import assert_type | ||
|
|
||
| from kubernetes import client | ||
| from kubernetes.aio import client as aio_client | ||
|
|
||
|
|
||
| class TestPackageTyping(unittest.TestCase): | ||
| def test_root_package_is_marked_as_typed(self): | ||
| self.assertTrue(files('kubernetes').joinpath('py.typed').is_file()) | ||
|
|
||
| def test_synchronous_nested_model_types(self): | ||
| pod = client.V1Pod(status=client.V1PodStatus(container_statuses=[ | ||
| client.V1ContainerStatus( | ||
| image='image', | ||
| image_id='image-id', | ||
| name='container', | ||
| ready=True, | ||
| restart_count=0, | ||
| state=client.V1ContainerState(), | ||
| ), | ||
| ])) | ||
|
|
||
| status = assert_type(pod.status, client.V1PodStatus | None) | ||
| assert status is not None | ||
| containers = assert_type( | ||
| status.container_statuses, | ||
| list[client.V1ContainerStatus] | None, | ||
| ) | ||
| assert containers is not None | ||
| state = assert_type( | ||
| containers[0].state, | ||
| client.V1ContainerState | None, | ||
| ) | ||
| self.assertIsInstance(state, client.V1ContainerState) | ||
|
|
||
| def test_asynchronous_nested_model_types(self): | ||
| pod = aio_client.V1Pod( | ||
| status=aio_client.V1PodStatus(container_statuses=[ | ||
| aio_client.V1ContainerStatus( | ||
| image='image', | ||
| image_id='image-id', | ||
| name='container', | ||
| ready=True, | ||
| restart_count=0, | ||
| state=aio_client.V1ContainerState(), | ||
| ), | ||
| ]), | ||
| ) | ||
|
|
||
| status = assert_type(pod.status, aio_client.V1PodStatus | None) | ||
| assert status is not None | ||
| containers = assert_type( | ||
| status.container_statuses, | ||
| list[aio_client.V1ContainerStatus] | None, | ||
| ) | ||
| assert containers is not None | ||
| state = assert_type( | ||
| containers[0].state, | ||
| aio_client.V1ContainerState | None, | ||
| ) | ||
| self.assertIsInstance(state, aio_client.V1ContainerState) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
setup-release.py also need this ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yliaog Yes—good catch.
setup-release.pybuilds the combined synchronous and asyncio distribution, so updating onlysetup.pywould leave published releases untyped.Fixed in ca7fa34. I built the release wheel and source distribution and confirmed that both include
kubernetes/py.typedas well as the existing synchronous and asyncio client markers. The nested-type regressions pass for both clients.[tamirdex]