Skip to content

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

Merged
merged 1 commit into from
Jul 21, 2025

Conversation

encukou
Copy link
Member

@encukou encukou commented Jul 9, 2025

This copies the note from the corresponding C API.
I added that note in GH-135126.


📚 Documentation preview 📚: https://cpython-previews--136463.org.readthedocs.build/

Copy link
Member

@StanFromIreland StanFromIreland left a 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?

@encukou
Copy link
Member Author

encukou commented Jul 10, 2025

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):

kivy/tools/report.py: report.append('Python API      : %s' % sys.api_version)

There's no value in bothering users with deprecation warnings and removals.

@encukou encukou added the needs backport to 3.14 bugs and security fixes label Jul 21, 2025
@encukou encukou merged commit 658599c into python:main Jul 21, 2025
34 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 21, 2025
@miss-islington-app
Copy link

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 21, 2025
(cherry picked from commit 658599c)

Co-authored-by: Petr Viktorin <[email protected]>
@encukou encukou deleted the sys-api-version-deprecate branch July 21, 2025 12:22
@bedevere-app
Copy link

bedevere-app bot commented Jul 21, 2025

GH-136928 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 21, 2025
encukou added a commit that referenced this pull request Jul 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants