-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
gh-121028: Soft-deprecate sys.api_version #136463
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
Conversation
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.
Is this really "deprecation" if it is not explicitly said it is? To me, it currently reads as: this serves no purpose, but something (e.g. it may be used) in the future may change.
If this is to be soft-deprecated, then it should it not be stated as so (less soft-), and added to the pending removal in a future version file?
Please see PEP 387, especially the definition of soft deprecation and the part that says “If the expected maintenance overhead and security risk of the deprecated behavior is small [, deprecated API] can stay indefinitely”. I admit that is not a typical soft-deprecation: it doesn't promise that the API “will not be developed further”. That's intentional: if we ever need an API version number we might as well pick up this one again, so I don't want people to rely on it being constant forever. Also see typical usage (more in the issue):
There's no value in bothering users with deprecation warnings and removals. |
Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14. |
(cherry picked from commit 658599c) Co-authored-by: Petr Viktorin <[email protected]>
GH-136928 is a backport of this pull request to the 3.14 branch. |
(cherry picked from commit 658599c) Co-authored-by: Petr Viktorin <[email protected]>
This copies the note from the corresponding C API.
I added that note in GH-135126.
sys.api_version
and the C API'sPYTHON_API_VERSION
#121028📚 Documentation preview 📚: https://cpython-previews--136463.org.readthedocs.build/