Skip to content

Commit deb6f40

Browse files
committed
API: document not supported functions
1 parent 4678af4 commit deb6f40

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

docs/api.rst

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,11 @@ Python 3.13
141141
142142
See `Py_HashPointer() documentation <https://docs.python.org/dev/c-api/hash.html#c.Py_HashPointer>`__.
143143
144+
Not supported:
145+
146+
* ``PySys_Audit()``.
147+
* ``PyErr_FormatUnraisable()``.
148+
144149
145150
Python 3.12
146151
-----------
@@ -157,6 +162,20 @@ Python 3.12
157162
158163
Not available on PyPy.
159164
165+
Not supported:
166+
167+
* ``PyDict_AddWatcher()``, ``PyDict_Watch()``.
168+
* ``PyCode_AddWatcher()``, ``PyCode_ClearWatcher()``.
169+
* ``PyErr_GetRaisedException()``, ``PyErr_SetRaisedException()``.
170+
* ``_PyErr_ChainExceptions1()``.
171+
* ``PyErr_DisplayException()``.
172+
* ``_Py_IsImmortal()``.
173+
* ``Py_NewInterpreterFromConfig()``.
174+
* ``PyException_GetArgs()``, ``PyException_SetArgs()``.
175+
* ``PyEval_SetProfileAllThreads()``, ``PyEval_SetTraceAllThreads()``.
176+
* ``PyFunction_SetVectorcall()``.
177+
* ``PyType_FromMetaclass()``: implementation too big to be backported.
178+
* ``PyVectorcall_Call()``.
160179
161180
Python 3.11
162181
-----------
@@ -257,6 +276,15 @@ Python 3.11
257276
258277
Not available on PyPy
259278
279+
Not supported:
280+
281+
* ``PyType_GetModuleByDef()``.
282+
* ``PyType_GetName()``.
283+
* ``PyType_GetQualName()``.
284+
* ``Py_Version`` constant.
285+
* ``PyErr_GetHandledException()``, ``PyErr_SetHandledException()``.
286+
* ``PyFrame_GetGenerator()``.
287+
260288
Python 3.10
261289
-----------
262290
@@ -288,6 +316,17 @@ Python 3.10
288316
289317
See `PyModule_AddObjectRef() documentation <https://docs.python.org/dev/c-api/module.html#c.PyModule_AddObjectRef>`__.
290318
319+
Not supported:
320+
321+
* ``PyCodec_Unregister()``.
322+
* ``PyDateTime_DATE_GET_TZINFO()``, ``PyDateTime_TIME_GET_TZINFO()``.
323+
* ``PyErr_SetInterruptEx()``.
324+
* ``PyGC_Enable()``, ``PyGC_Disable()`` and ``PyGC_IsEnabled()``.
325+
* ``PyIter_Send()``.
326+
* ``PySet_CheckExact()``.
327+
* ``Py_TPFLAGS_DISALLOW_INSTANTIATION`` constant.
328+
* ``Py_TPFLAGS_IMMUTABLETYPE`` constant.
329+
291330
Python 3.9
292331
----------
293332
@@ -330,6 +369,12 @@ PyObject
330369
331370
See `PY_VECTORCALL_ARGUMENTS_OFFSET documentation <https://docs.python.org/dev/c-api/call.html#PY_VECTORCALL_ARGUMENTS_OFFSET>`__.
332371
372+
Not supported:
373+
374+
* ``PyVectorcall_CallMethod()``.
375+
* ``PyType_FromModuleAndSpec()``
376+
377+
333378
334379
PyFrameObject
335380
^^^^^^^^^^^^^
@@ -394,20 +439,76 @@ Module helper
394439
395440
See `PyModule_AddType() documentation <https://docs.python.org/dev/c-api/module.html#c.PyModule_AddType>`__.
396441
442+
Python 3.8
443+
----------
444+
445+
Not supported:
446+
447+
* ``PyCode_NewWithPosOnlyArgs()``.
448+
449+
Python 3.7
450+
----------
451+
452+
Not supported:
453+
454+
* ``PyImport_GetModule()``.
455+
* ``PyInterpreterState_GetID()``.
456+
* ``PySlice_Unpack()``, ``PySlice_AdjustIndices()``.
457+
* ``PyTimeZone_FromOffset()``, ``PyTimeZone_FromOffsetAndName()``.
458+
* ``Py_RETURN_RICHCOMPARE()``.
459+
* ``Py_UNREACHABLE`` macro.
460+
461+
Python 3.6
462+
----------
463+
464+
Not supported:
465+
466+
* ``PyErr_ResourceWarning()``.
467+
* ``PyErr_SetImportErrorSubclass()``.
468+
* ``PyOS_FSPath()``.
469+
* ``Py_FinalizeEx()``.
470+
397471
Python 3.5.2
398472
------------
399473
400474
.. c:macro:: Py_SETREF(op, op2)
401475
402476
.. c:macro:: Py_XSETREF(op, op2)
403477
478+
Not supported:
479+
480+
* ``PyCodec_NameReplaceErrors()``.
481+
* ``PyErr_FormatV()``.
482+
* ``PyExc_RecursionError``.
483+
* ``PyModule_FromDefAndSpec()``, ``PyModule_FromDefAndSpec2()``,
484+
and ``PyModule_ExecDef()``.
485+
* ``PyNumber_MatrixMultiply()`` and ``PyNumber_InPlaceMatrixMultiply()``.
486+
404487
Python 3.4
405488
----------
406489
407490
.. c:macro:: Py_UNUSED(name)
408491
409492
See `Py_UNUSED() documentation <https://docs.python.org/dev/c-api/intro.html#c.Py_UNUSED>`__.
410493
494+
Python 3.2
495+
----------
496+
497+
Not supported:
498+
499+
* ``Py_VA_COPY``.
500+
* ``PySys_SetArgvEx()``.
501+
* ``PyLong_AsLongLongAndOverflow()``.
502+
* ``PyErr_NewExceptionWithDoc()``.
503+
504+
Python 3.1
505+
----------
506+
507+
Not supported:
508+
509+
* ``PyOS_string_to_double()``.
510+
* ``PyCapsule`` API.
511+
411512
Borrow variant
412513
--------------
413514

0 commit comments

Comments
 (0)