Skip to content

Commit 596d4ec

Browse files
committed
Document soft-deprecated symbols
1 parent ed73c90 commit 596d4ec

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

Doc/c-api/stable.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,3 +364,32 @@ Contents of Limited API
364364
Currently, the :ref:`Limited API <limited-c-api>` includes the following items:
365365

366366
.. limited-api-list::
367+
368+
369+
Soft-deprecated Symbols
370+
=======================
371+
372+
There are a few symbols included in Python's C API are :term:`soft deprecated`.
373+
Soft deprecated symbols should not be used in new code, but have no planned
374+
removal for compatibility's sake.
375+
376+
The following is a list of soft deprecated symbols that were included in
377+
Python's public C API by mistake. They intentionally come with no additional
378+
documentation. In practice, very few extensions use these APIs.
379+
380+
.. c:function:: PyObject *PyFile_NewStdPrinter(void)
381+
382+
.. c:var:: PyTypeObject PyStdPrinter_Type
383+
384+
.. c:macro:: PyLong_BASE
385+
386+
.. c:macro:: PyLong_MASK
387+
388+
.. c:macro:: PyLong_SHIFT
389+
390+
.. c:macro:: PySet_MINSIZE
391+
392+
.. c:macro:: PyAsyncGenASend_CheckExact(op)
393+
394+
Do not use these APIs in your extension. They expose Python implementation
395+
details and attempts to use them will not be supported by Python maintainers.

0 commit comments

Comments
 (0)