Skip to content

gh-121028: Soft-deprecate sys.api_version - #136463

Merged
encukou merged 1 commit into
python:mainfrom
encukou:sys-api-version-deprecate
Jul 21, 2025
Merged

gh-121028: Soft-deprecate sys.api_version#136463
encukou merged 1 commit into
python:mainfrom
encukou:sys-api-version-deprecate

Conversation

@encukou

@encukouencukou commented Jul 9, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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/

@bedevere-appbedevere-appBot added awaiting core review docs Documentation in the Doc dir skip news labels Jul 9, 2025
@bedevere-appbedevere-appBot mentioned this pull request Jul 9, 2025
Closed
StanFromIreland
StanFromIreland reviewed Jul 9, 2025
View reviewed changes

@StanFromIrelandStanFromIreland left a comment •
edited
Loading

Copy link
Copy Markdown
Member

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

encukou commented Jul 10, 2025

Copy link
Copy Markdown
MemberAuthor

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.

@encukouencukou added the needs backport to 3.14 bugs and security fixes label Jul 21, 2025
@encukou
encukou merged commit 658599c into python:mainJul 21, 2025
34 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsJul 21, 2025
@miss-islington-app

miss-islington-appBot commented Jul 21, 2025

Copy link
Copy Markdown

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
@encukou@miss-islington
pythongh-121028: Soft-deprecate sys.api_version (pythonGH-136463)
1847882
(cherry picked from commit 658599c)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@encukou
encukou deleted the sys-api-version-deprecate branch July 21, 2025 12:22
@bedevere-app

bedevere-appBot commented Jul 21, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot 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
@miss-islington@encukou
[3.14]gh-121028: Soft-deprecate sys.api_version (GH-136463) (GH-136928)
0d87bb6
(cherry picked from commit 658599c)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@encukou@taegyunkim
pythongh-121028: Soft-deprecate sys.api_version (pythonGH-136463)
ad25fce
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@encukou@Agent-Hellboy
pythongh-121028: Soft-deprecate sys.api_version (pythonGH-136463)
04e65b7
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington@encukou@kumaraditya303
[3.14]pythongh-121028: Soft-deprecate sys.api_version (pythonGH-136463…
d18396d
…) (pythonGH-136928)
(cherry picked from commit 658599c)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIrelandStanFromIrelandStanFromIreland left review comments

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@encukou@StanFromIreland