gh-121028: Soft-deprecate sys.api_version #136463
Conversation
There was a problem hiding this comment.
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. |
This copies the note from the corresponding C API.
I added that note in GH-135126.
sys.api_versionand the C API'sPYTHON_API_VERSION#121028📚 Documentation preview 📚: https://cpython-previews--136463.org.readthedocs.build/