vstinner
commented
11 months ago Issues asking to add public APIs for removed private APIs.
DONE:
- Py_HashPointer()
- Py_IsFinalizing()
- PyDict_Pop()
- PyDict_PopString()
- PyList_Extend()
- PyList_Clear()
- PyLong_AsInt()
- PyTime API
- PyLong_FromNativeBytes() and PyLong_AsNativeBytes()
- _PyHash constants
Private API restored:
Rejected:
- PyLong_GCD(), but
math.gcd(int, int)case was optimized. - _PyOS_ReadlineTState
- _Py_Identifier
- _PyArg_Parser
Note: I update this comment time to time.
encukou
gpshead
Many private functions were removed in issue #106320. My plan is to add public functions for removed private functions which are used by 3rd party extensions: see C API: My plan to clarify private vs public functions in Python 3.13.
I don't think that the fact that a private function was used must always justify to directly expose the exact same API to the public C API. Usually, private functions expose implementation details, use weaker or not check such as checking argument types, are not documented, and are not tested.
To make a function public, we should:
Follow new C API guidelines to avoid past design mistakes:
Document the API.
Write some basic unit tests (for non regression). The bare minimum is to make sure that the constant exists and call each function at least once.
I also would like to add new public functions to https://pythoncapi-compat.readthedocs.io/ to provide them to Python 3.12 and older (by calling the old private functions).
This work will take time. Depending on how it goes, we should consider reverting some removals if there is too much pressure, to unblock some critical dependencies.
The target is to make most C extensions compatible with Python 3.13 when Python 3.13 beta1 is released. Obviously, sooner the better.
C extensions which want to access implementation details can use the internal C API. By default, I modified the internal functions to no longer export internal functions, only make them usable by Python internals: they cannot be used by shared libraries such as stdlib C extensions. This part is unclear to me. Should we expose more internal functions. Which ones? How do you decide if a function should be exported or not?