Repository navigation
[RFC] Major breaking changes in the upcoming release #974
Description
Hi Kubernetes Python client developers, this is a request for comment issue. Please leave comments if you have any opinion/suggestion. Thanks!
What happened:
A majority of the code base is generated code. This repo is switching from using swagger-codegen to using openapi-generator. For more backgrounds:
- migrate from swagger-codegen to openapi-generator gen#93
- feat: switch python client to use openapi-generator gen#97
Major breaking changes were detected when we released 11.0.0a1 with openapi-generator:
The breaking changes are:
- [Major]
kubernetes.client.apispackage is renamed tokubernetes.client.api - [Major]
kubernetespackage code now uses absolute import instead of relative import - [Minor] The
swagger_typesattribute in all models is renamed toopenapi_types
the major breaking changes come from swagger-api/swagger-codegen#6839 (comment), which is also in latest swagger-codegen. This repo didn't have these changes because we were depending on a old version of swagger-codegen.
What versions are affected?:
- All
8.0.x,9.0.x,10.0.xversions are not affected 11.0.0a1(corresponding to Kubernetes 1.15) is the only version that's affected currently- The next release
11.0.0b1and future releases (corresponding to Kubernetes 1.15, 1.16+) will be affected.
Impact and fix:
- All clients that import
kubernetes.client.apismust change the import tokubernetes.client.apiwhen upgrading to 11.0.0b1+, to avoid import error. - Clients that use relative import and patch the
kubernetespackage locally may experience unexpected import error. Clients should installkubernetespackage properly following the instructions in the Readme or the release page.
Metadata
Metadata
Assignees
Labels
Categorizes an issue or PR as actively needing an API review.Categorizes issue or PR as related to a bug.Denotes an issue or PR that has aged beyond stale and will be auto-closed.Must be staffed and worked on either currently, or very soon, ideally in time for the next release.Denotes a PR that introduces potentially breaking changes that require user action.
Activity
roycaihw commentedon Oct 1, 2019
cc @dims @fabianvf @mbohlool @micw523 @oz123 @scottilee @tomplus @yliaog (apologies if i have missed anyone)
oz123 commentedon Oct 1, 2019
@roycaihw my 2 cents (appologies for being so scrooge, it's late here):
I consider this "impolite" to remove existing functionality without warnings. Maybe we can add an empty package called
apiwhich only imports everything fromapis.However, when one uses stuff from
apiwe can issue a deprecation warning. This package can stay along for 2 versions giving people enough time to update their code.I'm willing to work a PR for this.
If someone else feels the urgency to do this before me here is a reference:
https://www.lesinskis.com/python_deprecation_tutorial.html
tomplus commentedon Oct 2, 2019
@oz123 there are more changes than renaming modules so it'd be still important to watch out when upgrading to the proposed version.
oz123 commentedon Oct 2, 2019
@tomplus , thanks for the hint. I will definitely try to make aliases for all the breaking changes, so breaking isn't breaking, rather warning.
fejta-bot commentedon Dec 31, 2019
Issues go stale after 90d of inactivity.
Mark the issue as fresh with
/remove-lifecycle stale.Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with
/close.Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale
avarf commentedon Jan 17, 2020
Hi,
Any news regarding 1.16 support? Or the the estimated release time?
/remove-lifecycle stale
roycaihw commentedon Feb 20, 2020
Hi @avarf, we are actively working on 11.0.0 stable release. After that we will start 12.0.0a1 release, which corresponds to Kubernetes 1.16
avarf commentedon Feb 20, 2020
Hi @roycaihw and thanks for your works. Is there any rough timeline for these releases?
roycaihw commentedon Feb 20, 2020
@palnabarun Nabarun is working on the 11.0.0 release and I think a PR will be created in the next two weeks.
21 remaining items
Add kubernetes.client.apis as an alias to kubernetes.client.api
fejta-bot commentedon Nov 30, 2020
Issues go stale after 90d of inactivity.
Mark the issue as fresh with
/remove-lifecycle stale.Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with
/close.Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale
fejta-bot commentedon Dec 30, 2020
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with
/remove-lifecycle rotten.Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with
/close.Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
fejta-bot commentedon Jan 29, 2021
Rotten issues close after 30d of inactivity.
Reopen the issue with
/reopen.Mark the issue as fresh with
/remove-lifecycle rotten.Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close
k8s-ci-robot commentedon Jan 29, 2021
@fejta-bot: Closing this issue.
Details
In response to this:
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/test-infra repository.
Add kubernetes.client.apis as an alias to kubernetes.client.api
Add kubernetes.client.apis as an alias to kubernetes.client.api
Add kubernetes.client.apis as an alias to kubernetes.client.api
Add kubernetes.client.apis as an alias to kubernetes.client.api
Add kubernetes.client.apis as an alias to kubernetes.client.api
Add kubernetes.client.apis as an alias to kubernetes.client.api