Merge pull request #2631 from tamird/prototype/modern-openapi-generator

Regenerate the synchronous client with the modern Python generator

Author: kubernetes-prow[bot]

CHANGELOG.md

@@ -1,3 +1,37 @@
+# Breaking Change from upgrading OpenAPI Generator to v7.24.0
+
+The synchronous client now uses the modern Python generator instead of
+`python-legacy`. Existing endpoint names, model names, and wire aliases
+are preserved, but applications may need the following updates:
+
+- Synchronous runtime dependencies now require `urllib3>=2.6.3,<3`,
+  `pydantic>=2.11`, `lazy-imports>=1,<2`,
+  `typing-extensions>=4.7.1`, and `python-dateutil>=2.8.2`. Python 3.10
+  remains the minimum supported version. Async generation is unchanged.
+- Models and API-call arguments now use Pydantic validation. Invalid,
+  unknown, or previously coerced values can raise
+  `pydantic.ValidationError` before a request is sent; models are
+  keyword-only, reject unknown fields during construction, and validate
+  assignments. The model `local_vars_configuration` argument and
+  Configuration's `discard_unknown_keys` and
+  `disabled_client_side_validations` arguments are removed.
+  `client_side_validation=False` no longer disables generated
+  validation.
+- Low-level synchronous transport interfaces changed. Direct callers of
+  `ApiClient.request`, `ApiClient.call_api`, `ApiClient.deserialize`, or
+  the `RESTClientObject` HTTP-verb helpers must migrate to the modern
+  request/response interface. `ApiException.body` is now decoded text
+  instead of bytes.
+- `CoreV1Api.delete_namespace` now returns a decoded dictionary rather
+  than `V1Status`, since a successful deletion can return either a
+  terminating Namespace or a Status.
+
+See [kubernetes-client/python#2631][python-pr] and
+[kubernetes-client/gen#305][gen-pr].
+
+[python-pr]: https://github.com/kubernetes-client/python/pull/2631
+[gen-pr]: https://github.com/kubernetes-client/gen/pull/305
+
 # v36.0.3
 
 Kubernetes API Version: v1.36.2

MANIFEST.in

@@ -3,6 +3,7 @@ include OWNERS
 include *.md
 include *.txt
 include *.ini
+include kubernetes/client/py.typed
 exclude .gitignore
 exclude .gitreview
 

devel/release.md

@@ -104,62 +104,29 @@ command:
 scripts/update-client.sh
 ```
 
-**NOTE**: If you see a lot of new or modified files under the `kubernetes/test/`
-directory, delete everything except `kubernetes/test/test_api_client.py` and
-`kubernetes/test/test_configuration.py`.
-
 Commit changes (should be only version number changes) to the release branch.
 Name the commit something like "Update version constants for XXX release".
 
-***After you finished the steps above, refer to the section, "Hot issues", and
-apply the manual fixes.***
-
 ```bash
 git push upstream $RELEASE_BRANCH
 ```
 
-### 3. Hot issues
-
-Use the `scripts/apply-hotfixes.sh` script to apply the fixes below in one step.
-**As mentioned above, the script should be run after finishing the section "Update release tags". Also, ensure a clean working directory before applying the script.**
-
-Commit the manual changes like this [PR](https://github.com/kubernetes-client/python/pull/995/commits) does.
-
-There are some hot issues with the client generation that require manual fixes.
-**The steps below are deprecated and only exist for documentation purposess. They should be performed using the `scripts/apply-hotfixes.sh` script mentioned above.**
-
-1. Restore custom object patch behavior. You should apply [this commit](https://github.com/kubernetes-client/python/pull/995/commits/9959273625b999ae9a8f0679c4def2ee7d699ede)
-to ensure custom object patch behavior is backwards compatible. For more
-details, see [#866](https://github.com/kubernetes-client/python/issues/866) and
-[#959](https://github.com/kubernetes-client/python/pull/959).
-
-2. Add alias package kubernetes.client.apis with deprecation warning. You need
-to add [this file](https://github.com/kubernetes-client/python/blob/0976d59d6ff206f2f428cabc7a6b7b1144843b2a/kubernetes/client/apis/__init__.py)
-under `kubernetes/client/apis/` to ensure the package is backwards compatible.
-For more details, see [#974](https://github.com/kubernetes-client/python/issues/974)
-
-3. Add ability to the client to be used as Context Manager [kubernetes-client/python#1073](https://github.com/kubernetes-client/python/pull/1073)
-
-4. Remove the tests directory (ref: https://github.com/kubernetes-client/python/commit/ec9c944f076999543cd2122aff2d86f969d82548). See the [upstream issue](https://github.com/OpenAPITools/openapi-generator/issues/5377) for more information.
-
-5. Add tests for the default `Configuration` behavior (ref: https://github.com/kubernetes-client/python/pull/1303 and https://github.com/kubernetes-client/python/pull/1285). The commit [1ffa61d0650e4c93e0d7f0becd2c54797eafd407](https://github.com/kubernetes-client/python/pull/1285/commits/1ffa61d0650e4c93e0d7f0becd2c54797eafd407) should be cherry-picked.
-
-### 4. CHANGELOG
+### 3. CHANGELOG
 
 Make sure the change logs are up to date [here](https://github.com/kubernetes-client/python/blob/master/CHANGELOG.md).
 If they are not, follow commits added after the last release and update/commit
 the change logs to master.
 
 Then based on the release, follow one of next two steps.
 
-### 5. README
+### 4. README
 
 Update the compatibility matrix and maintenance status in the README file.
 
 ### Submit pull request
 
-Typically after the you've completed steps 2-6 above you can push your changes
-open a pull request against `kubernetes-client:release-x.y`
+After completing the steps above, push your changes and open a pull request
+against `kubernetes-client:release-x.y`.
 
 ## Patch a release branch
 

doc/source/kubernetes.client.api_response.rst

@@ -0,0 +1,7 @@
+kubernetes.client.api\_response module
+======================================
+
+.. automodule:: kubernetes.client.api_response
+   :members:
+   :show-inheritance:
+   :undoc-members:

doc/source/kubernetes.client.models.rst

@@ -206,6 +206,7 @@ Submodules
    kubernetes.client.models.v1_group_resource
    kubernetes.client.models.v1_group_subject
    kubernetes.client.models.v1_group_version_for_discovery
+   kubernetes.client.models.v1_group_version_kind
    kubernetes.client.models.v1_grpc_action
    kubernetes.client.models.v1_horizontal_pod_autoscaler
    kubernetes.client.models.v1_horizontal_pod_autoscaler_list

doc/source/kubernetes.client.models.v1_group_version_kind.rst

@@ -0,0 +1,7 @@
+kubernetes.client.models.v1\_group\_version\_kind module
+========================================================
+
+.. automodule:: kubernetes.client.models.v1_group_version_kind
+   :members:
+   :show-inheritance:
+   :undoc-members:

doc/source/kubernetes.client.rst

@@ -18,6 +18,7 @@ Submodules
    :maxdepth: 4
 
    kubernetes.client.api_client
+   kubernetes.client.api_response
    kubernetes.client.configuration
    kubernetes.client.exceptions
    kubernetes.client.rest

examples/cronjob_crud.py

@@ -18,8 +18,9 @@ def create_namespaced_cron_job(namespace='default', body=None):
         print(f'{name} exists, please do not repeat!')
     else:
         v1 = client.BatchV1Api()
-        ret = v1.create_namespaced_cron_job(namespace=namespace, body=cronjob_json, pretty=True,
-                                            _preload_content=False, async_req=False)
+        ret = v1.create_namespaced_cron_job(
+            namespace=namespace, body=cronjob_json, pretty='true',
+            _preload_content=False)
         ret_dict = json.loads(ret.data)
         print(f'create succeed\n{json.dumps(ret_dict)}')
 
@@ -32,7 +33,8 @@ def delete_namespaced_cron_job(namespace='default', name=None):
         print(f"{name} doesn't exists, please enter a new one!")
     else:
         v1 = client.BatchV1Api()
-        ret = v1.delete_namespaced_cron_job(name=name, namespace=namespace, _preload_content=False, async_req=False)
+        ret = v1.delete_namespaced_cron_job(
+            name=name, namespace=namespace, _preload_content=False)
         ret_dict = json.loads(ret.data)
         print(f'delete succeed\n{json.dumps(ret_dict)}')
 
@@ -45,8 +47,9 @@ def patch_namespaced_cron_job(namespace='default', body=None):
     name = body['metadata']['name']
     if judge_crontab_exists(namespace, name):
         v1 = client.BatchV1Api()
-        ret = v1.patch_namespaced_cron_job(name=name, namespace=namespace, body=cronjob_json,
-                                           _preload_content=False, async_req=False)
+        ret = v1.patch_namespaced_cron_job(
+            name=name, namespace=namespace, body=cronjob_json,
+            _preload_content=False)
         ret_dict = json.loads(ret.data)
         print(f'patch succeed\n{json.dumps(ret_dict)}')
     else:
@@ -55,7 +58,8 @@ def patch_namespaced_cron_job(namespace='default', body=None):
 
 def get_cronjob_list(namespace='default'):
     v1 = client.BatchV1Api()
-    ret = v1.list_namespaced_cron_job(namespace=namespace, pretty=True, _preload_content=False)
+    ret = v1.list_namespaced_cron_job(
+        namespace=namespace, pretty='true', _preload_content=False)
     cron_job_list = json.loads(ret.data)
     print(f'cronjob number={len(cron_job_list["items"])}')
     return cron_job_list["items"]

examples/dynamic-client/namespaced_custom_resource.py

@@ -52,7 +52,7 @@ def create_namespace(namespace_api, name):
     namespace_manifest = {
         "apiVersion": "v1",
         "kind": "Namespace",
-        "metadata": {"name": name, "resourceversion": "v1"},
+        "metadata": {"name": name},
     }
     namespace_api.create(body=namespace_manifest)
 

examples/dynamic-client/service.py

@@ -36,7 +36,7 @@ def main():
     service_manifest = {
         "apiVersion": "v1",
         "kind": "Service",
-        "metadata": {"labels": {"name": name}, "name": name, "resourceversion": "v1"},
+        "metadata": {"labels": {"name": name}, "name": name},
         "spec": {
             "ports": [
                 {"name": "port", "port": 80, "protocol": "TCP", "targetPort": 80}