Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[C API] Deprecate private functions which have a public replacement #128863

Open
vstinner opened this issue Jan 15, 2025 · 3 comments
Open

[C API] Deprecate private functions which have a public replacement #128863

vstinner opened this issue Jan 15, 2025 · 3 comments
Labels
topic-C-API type-feature A feature request or enhancement

Comments

@vstinner
Copy link
Member

vstinner commented Jan 15, 2025 •
edited by bedevere-app bot
Loading

Hi,

Python 3.13 and 3.14 added public functions to replace private functions. For example, a public function PyBytes_Join() was added to replace the private function _PyBytes_Join().

I propose to deprecate the private functions which have a public replacement, and remove them in Python 3.16.

Victor

Linked PRs
vstinner added a commit to vstinner/cpython that referenced this issue Jan 15, 2025
@vstinner
pythongh-128863: Deprecate private C API functions
873d8bd 
* _PyBytes_Join()
* _PyThreadState_UncheckedGet()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().
@bedevere-app bedevere-app bot mentioned this issue Jan 15, 2025
Merged
vstinner added a commit to vstinner/cpython that referenced this issue Jan 15, 2025
@vstinner
pythongh-128863: Deprecate private C API functions
814670d 
* _PyBytes_Join()
* _PyThreadState_UncheckedGet()
* _PyUnicode_AsString()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().

Remove references to deprecated functions.
@vstinner
Copy link
Member Author

Previous discussion: https://discuss.python.org/t/remove-again-private-apis-which-now-have-new-public-replacement/68081

vstinner added a commit to vstinner/cpython that referenced this issue Jan 15, 2025
@vstinner
pythongh-128863: Deprecate private C API functions
37869e2 
* _PyBytes_Join()
* _PyDict_GetItemStringWithError()
* _PyThreadState_UncheckedGet()
* _PyUnicode_AsString()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().

Remove references to deprecated functions.
vstinner added a commit to vstinner/cpython that referenced this issue Jan 15, 2025
@vstinner
pythongh-128863: Deprecate private C API functions
18f8581 
* _PyBytes_Join()
* _PyDict_GetItemStringWithError()
* _PyDict_Pop()
* _PyThreadState_UncheckedGet()
* _PyUnicode_AsString()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().

Remove references to deprecated functions.
vstinner added a commit to vstinner/cpython that referenced this issue Jan 15, 2025
@vstinner
pythongh-128863: Deprecate private C API functions
8140437 
* _PyBytes_Join()
* _PyDict_GetItemStringWithError()
* _PyDict_Pop()
* _PyThreadState_UncheckedGet()
* _PyUnicode_AsString()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().

Remove references to deprecated functions.
@vstinner
Copy link
Member Author

Other deprecations to consider:

  • _PyCode_GetExtra(): PyUnstable_Code_GetExtra()
  • _PyCode_SetExtra(): PyUnstable_Code_SetExtra()
  • _PyEval_RequestCodeExtraIndex(): PyUnstable_Eval_RequestCodeExtraIndex()
  • _PyLong_AsByteArray(): PyLong_AsNativeBytes()
  • _PyLong_FromByteArray(): PyLong_FromNativeBytes()
  • _PyLong_FromDigits(): PyLongWriter_Create()
  • _PyLong_New(): PyLongWriter_Create()
  • _PyLong_Sign(): PyLong_GetSign()
  • _PyUnicodeWriter_Init(): PyUnicodeWriter_Create() (and other _PyUnicodeWriter functions)

@picnixz picnixz added the type-feature A feature request or enhancement label Jan 17, 2025
vstinner added a commit that referenced this issue Jan 22, 2025
@vstinner
gh-128863: Deprecate private C API functions (#128864)
9012fa7 
Deprecate private C API functions:

* _PyBytes_Join()
* _PyDict_GetItemStringWithError()
* _PyDict_Pop()
* _PyThreadState_UncheckedGet()
* _PyUnicode_AsString()
* _Py_HashPointer()
* _Py_fopen_obj()

Replace _Py_HashPointer() with Py_HashPointer().

Remove references to deprecated functions.
vstinner added a commit to vstinner/cpython that referenced this issue Jan 22, 2025
@vstinner
pythongh-128863: Deprecate _PyLong_Sign() function
be36fc8 
Replace _PyLong_Sign() with PyLong_GetSign().
@bedevere-app bedevere-app bot mentioned this issue Jan 22, 2025
Merged
vstinner added a commit that referenced this issue Jan 23, 2025
@vstinner
gh-128863: Deprecate _PyLong_Sign() function (#129176)
1d485db 
Replace _PyLong_Sign() with PyLong_GetSign().
@skirpichev
Copy link
Member

I'm closing #127937 and #127936 in favor of this issue.

skirpichev added a commit to skirpichev/cpython that referenced this issue Jan 23, 2025
@skirpichev
pythongh-128863: deprecate _PyLong_New() function
2d4b969
This was referenced Jan 23, 2025
Merged
Merged
vstinner pushed a commit that referenced this issue Jan 23, 2025
@skirpichev
gh-128863: Deprecate _PyLong_New() function (#129212)
5c9a63f
vstinner added a commit to vstinner/cpython that referenced this issue Jan 23, 2025
@vstinner
pythongh-128863: Deprecate the private _PyUnicodeWriter API
e1fd675 
Deprecate private C API functions:

* _PyUnicodeWriter_Init()
* _PyUnicodeWriter_Finish()
* _PyUnicodeWriter_Dealloc()
* _PyUnicodeWriter_WriteChar()
* _PyUnicodeWriter_WriteStr()
* _PyUnicodeWriter_WriteSubstring()
* _PyUnicodeWriter_WriteASCIIString()
* _PyUnicodeWriter_WriteLatin1String()

These functions are not deprecated in the internal C API (if the
Py_BUILD_CORE macro is defined).
@bedevere-app bedevere-app bot mentioned this issue Jan 23, 2025
Open
vstinner pushed a commit that referenced this issue Jan 24, 2025
@skirpichev
gh-128863: Deprecate _PyLong_FromDigits() function (#127939)
233fd00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
topic-C-API type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vstinner @skirpichev @picnixz