@encukou has done great work getting us to document newly added C API in recent versions (#135755 , #118915 ), but unfortunately, we still have plenty of undocumented APIs. I'd like to begin working towards a future where the C API documentation is extensive, up-to-date, and most importantly, helpful to users.
Here's my plan:
Document all remaining C APIs (macros, static inline functions, and exported symbols) that are prefixed with Py.
Add a CI job that prevents new C APIs from being added to public headers without documentation.
Improve our "Extending and Embedding" tutorial. I started on this a little while ago, but I think it would be better to get the full C API documented before we do that.
I'm going to work on this myself, but others are welcome to send PRs where necessary. I've applied the easy label to this for any newcomers who are interested in helping.
Below is a list of CPython's undocumented C API. I'm sure many of these aren't documented intentionally, so we should either deprecate them or keep a canonical list of "public but undocumented" somewhere.
bltinmodule.henumobject.hbytearrayobject.hbytesobject.hcodecs.hcompile.hdatetime.hThese are under #83785 .
descrobject.hdictobject.h
PyDictItems_Check (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictItems_Type (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictKeys_Check (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictKeys_Type (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictValues_Check (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictValues_Type (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictViewSet_Check (gh-141004: Document C APIs for dictionary keys, values, and items #141009 PyDictIterItem_Type (gh-141004: Document remaining iterator types #141010 PyDictIterKey_Type (gh-141004: Document remaining iterator types #141010 PyDictIterValue_Type (gh-141004: Document remaining iterator types #141010 PyDictRevIterItem_Type (gh-141004: Document remaining iterator types #141010 PyDictRevIterKey_Type (gh-141004: Document remaining iterator types #141010 PyDictRevIterValue_Type (gh-141004: Document remaining iterator types #141010
fileobject.hlistobject.hmemoryobject.hobjimpl.h(All covered by #141146 )
pybuffer.hpycapsule.hpydtrace.hpyerrors.hpyhash.h(covered in #141205 and #141233 )
pystrtod.hrangeobject.hsetobject.htraceback.htupleobject.hexports.h
PyAPI_DATA (gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508 PyMODEXPORT_FUNC (PEP-793 : gh-140550: PEP 793 reference documentation #141197 Py_EXPORTED_SYMBOL (gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508 Py_IMPORTED_SYMBOL (gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508 Py_LOCAL_SYMBOL (gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508 PyAPI_FUNC (gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508
floatobject.hlongobject.hmethodobject.hmodsupport.hmoduleobject.hpy_curses.h(covered by #141254 )
pymacro.hpymath.htypeslots.h(Covered in #138190 )
unicodeobject.hobject.hpyexpat.h(covered in #141259 )
pyport.hweakrefobject.hcpython/pyctype.hcpython/compile.hcpython/descrobject.hcpython/fileobject.hcpython/methodobject.hcpython/odictobject.h(All covered by #141136 )
cpython/picklebufobject.hcpython/setobject.hcpython/dictobject.hcpython/genobject.hcpython/import.hcpython/longintrepr.hcpython/pyerrors.hcpython/pyframe.hcpython/funcobject.hcpython/unicodeobject.hpystrcmp.hintrcheck.hceval.hpythread.hcpython/frameobject.hcpython/objimpl.hcpython/pythonrun.hcpython/ceval.hcpython/pylifecycle.hcpython/warnings.hcpython/code.hcpython/object.hpymem.hpystrtod.h(all in #143867 )
structmember.hobject.hLinked PRs
gh-141004: Document missing built-in iterator types in the C API #141006 gh-141004: Document C APIs for dictionary keys, values, and items #141009 gh-141004: Document remaining iterator types #141010 gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions #141019 [3.13] gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) #141026 [3.14] gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) #141027 gh-141004: Document PyLong_FromPid and PyLong_AsPid #141028 gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF #141029 gh-141004: soft-deprecate Py_INFINITY macro #141033 gh-141004: Document PyMemoryView_Type #141034 gh-141004: deprecate Py_MATH_El and Py_MATH_PIl macros #141035 [3.14] gh-141004: Document missing iterator types in the C API (GH-141010) #141046 [3.13] gh-141004: Document missing iterator types in the C API (GH-141010) #141047 [3.14] gh-141004: Document PyMemoryView_Type (GH-141034) #141054 [3.13] gh-141004: Document PyMemoryView_Type (GH-141034) #141055 gh-141004: Document Py_hexdigits #141059 [3.14] gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF (GH-141029) #141074 [3.13] gh-141004: Document Py_RETURN_NAN and Py_RETURN_INF (GH-141029) #141075 gh-141004: Document PyDict_GET_SIZE #141078 gh-141004: Document PyCapsule_Type #141079 [3.14] gh-141004: Document PyDict_GET_SIZE (GH-141078) #141082 [3.13] gh-141004: Document PyDict_GET_SIZE (GH-141078) #141083 [3.14] gh-141004: Document built-in iterator types in the C API (GH-141006) #141134 [3.13] gh-141004: Document built-in iterator types in the C API (GH-141006) #141135 gh-141004: Document PyODict* APIs #141136 gh-141004: Document Py_MakePendingCalls #141137 [3.14] gh-141004: Document Py_hexdigits (GH-141059) #141138 [3.13] gh-141004: Document Py_hexdigits (GH-141059) #141139 [3.14] gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028) #141142 [3.13] gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028) #141143 gh-141004: document Py_INFINITY and Py_NAN macros #141145 gh-141004: Document deprecated aliases for memory allocation #141146 gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit #141151 [3.14] gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151) #141156 [3.13] gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151) #141157 gh-141004: Document PyErr_WarnExplicitFormat #141187 gh-141004: Document missing frame APIs #141189 gh-141004: Document PyTraceBack* APIs #141192 [3.13] gh-141004: Document PyCapsule_Type (GH-141079) #141198 [3.14] gh-141004: Document PyCapsule_Type (GH-141079) #141199 [3.14] gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) #141202 [3.13] gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) #141203 gh-141004: Document Py_HASH_* macros #141205 [3.14] gh-141004: Document PyTraceBack* APIs (GH-141192) #141210 [3.13] gh-141004: Document PyTraceBack* APIs (GH-141192) #141211 gh-141004: fix versionadded typo for Py_HASH_SIPHASH13 #141223 [3.13] gh-141004: Document Py_HASH_* macros (GH-141205) #141224 [3.14] gh-141004: Document Py_HASH_* macros (GH-141205) #141225 gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes #141233 [3.14] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) #141234 [3.13] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) #141235 gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText #141250 gh-141004: Document missing PyCFunction* and PyCMethod* APIs #141253 gh-141004: document curses C API #141254 gh-141004: Document PyBUF_WRITEABLE #141255 [3.14] gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250) #141256 [3.13] gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250) #141257 gh-141004: document pyexpat C API #141259 [3.13] gh-141004: Document PyBUF_WRITEABLE (GH-141255) #141260 [3.14] gh-141004: Document PyBUF_WRITEABLE (GH-141255) #141261 gh-141004: Document the PyDoc_VAR macro #141263 [3.14] gh-141004: Document the PyDoc_VAR macro (GH-141263) #141264 [3.13] gh-141004: Document the PyDoc_VAR macro (GH-141263) #141265 gh-141004: Document Py_BUILD_ASSERT* macros #141266 [3.14] gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) #141269 [3.13] gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) #141270 gh-141004: Document pyctype.h macros #141272 gh-141004: Document Py_func_type_input #141273 gh-141004: Document PyWeakref_CheckRefExact #141279 [3.14] gh-141004: Document deprecated aliases for memory allocation (GH-141146) #141288 [3.13] gh-141004: Document deprecated aliases for memory allocation (GH-141146) #141289 [3.14] gh-141004: Document PyWeakref_CheckRefExact (GH-141279) #141290 [3.14] gh-141004: document curses C API (GH-141254) #141292 [3.13] gh-141004: document curses C API (GH-141254) #141293 gh-141004: Document PyFunction_SetKwDefaults #141294 gh-141004: Document PyClassMethod* and PyStaticMethod* APIs #141296 [3.14] gh-141004: Document Py_func_type_input (GH-141273) #141298 [3.13] gh-141004: Document Py_func_type_input (GH-141273) #141299 gh-141004: Document PyExceptionInstance* APIs #141301 [3.14] gh-141004: Document PyExceptionInstance* APIs (GH-141301) #141302 [3.13] gh-141004: Document PyExceptionInstance* APIs (GH-141301) #141303 [3.14] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) #141304 [3.13] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) #141305 [3.14] gh-141004: Document PyClassMethod* and PyStaticMethod* APIs (GH-141296) #141308 [3.13] gh-141004: Document PyClassMethod* and PyStaticMethod* APIs (GH-141296) #141309 gh-141004: Document Py_DTSF_* macros #141310 gh-141004: Document PyType_FastSubclass #141313 gh-141004: Document PySuper_Type #141315 [3.14] gh-141004: Document PySuper_Type (GH-141315) #141318 [3.13] gh-141004: Document PySuper_Type (GH-141315) #141319 [3.14] gh-141004: Document Py_DTSF_* macros (GH-141310) #141329 [3.13] gh-141004: Document Py_DTSF_* macros (GH-141310) #141330 [3.13] gh-141004: Document pyctype.h macros (GH-141272) #141339 [3.14] gh-141004: Document pyctype.h macros (GH-141272) #141340 [3.14] gh-141004: Document PyType_FastSubclass (GH-141313) #141368 [3.13] gh-141004: Document PyType_FastSubclass (GH-141313) #141369 gh-141004: Document PyCode_Optimize #141378 [3.14] gh-141004: Document missing frame APIs (GH-141189) #141379 [3.13] gh-141004: Document missing frame APIs (GH-141189) #141380 [3.14] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) #141399 [3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) #141400 gh-141004: Document PyRun_InteractiveOneObject #141405 gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape #141407 gh-141004: Document PyType_SUPPORTS_WEAKREFS #141408 gh-141004: Document missing generator APIs #141409 gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject #141413 gh-141004: Document PyType_Unwatch #141414 [3.14] gh-141004: Document PyType_Unwatch (GH-141414) #141418 [3.13] gh-141004: Document PyType_Unwatch (GH-141414) #141419 gh-141004: Document Py_MATH_{E, PI, TAU} constants #141373 [3.14] gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject (GH-141413) #141425 [3.13] gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject (GH-141413) #141426 [3.14] gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407) #141440 [3.13] gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407) #141441 [3.14] gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408) #141470 [3.14] gh-141004: Document Py_MATH_{E, PI, TAU} constants (GH-141373) #141471 [3.13] gh-141004: Document Py_MATH_{E, PI, TAU} constants (GH-141373) #141472 [3.14] gh-141004: Document PyRun_InteractiveOneObject (GH-141405) #141485 [3.13] gh-141004: Document PyRun_InteractiveOneObject (GH-141405) #141486 [3.13] gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408) #141487 [3.14] gh-141004: Document C APIs for dictionary keys, values, and items (GH-141009) #141512 [3.13] gh-141004: Document C APIs for dictionary keys, values, and items (GH-141009) #141513 [3.14] gh-141004: Document PyCode_Optimize (GH-141378) #141514 [3.13] gh-141004: Document PyCode_Optimize (GH-141378) #141515 gh-141004: Document PyException_HEAD #141522 [3.13] gh-141004: Document PyErr_RangedSyntaxLocationObject (GH-141521) #141524 [3.14] gh-141004: Document PyErr_RangedSyntaxLocationObject (GH-141521) #141525 gh-141004: Document PyOS_InterruptOccurred #141526 gh-141004: Document missing PyDateTime* APIs. #141543 gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544 [3.14] gh-141004: Document PyOS_InterruptOccurred (GH-141526) #141549 [3.13] gh-141004: Document PyOS_InterruptOccurred (GH-141526) #141550 gh-141004: Document Py_ARRAY_LENGTH macro #141598 gh-141004: Document Py_ARRAY_LENGTH macro #141601 gh-141004: Document the PyPickleBuffer_* C API #141630 [3.14] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) #141632 [3.13] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) #141633 gh-141004: Document soft-deprecated symbols #141634 [3.14] gh-141004: Document missing PyCFunction* and PyCMethod* APIs (GH-141253) #141637 [3.13] gh-141004: Document missing PyCFunction* and PyCMethod* APIs (GH-141253) #141638 [3.14] gh-141004: Document PyODict* APIs (GH-141136) #141677 [3.13] gh-141004: Document PyODict* APIs (GH-141136) #141678 [3.14] gh-141004: Document Py_MEMCPY (GH-141676) #141685 [3.14] gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (GH-141544) #141698 [3.13] gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (GH-141544) #141700 gh-141004: Document Py_LOCAL* #141725 gh-141004: Document PyOS_mystr(n)icmp #141760 [3.14] gh-141004: Document Py_LOCAL and Py_LOCAL_INLINE (GH-141725) #141761 [3.13] gh-141004: Document Py_LOCAL and Py_LOCAL_INLINE (GH-141725) #141762 [3.14] gh-141004: Document Py_MakePendingCalls (GH-141137) #141787 [3.13] gh-141004: Document Py_MakePendingCalls (GH-141137) #141788 [3.14] gh-141004: Document missing generator APIs (GH-141409) #141789 [3.13] gh-141004: Document missing generator APIs (GH-141409) #141790 [3.14] gh-141004: Document missing PyDateTime* APIs (GH-141543) #141791 [3.13] gh-141004: Document missing PyDateTime* APIs (GH-141543) #141792 gh-141004: Document descriptor and dict proxy type objects #141803 gh-141004: Document missing PyThread* APIs #141810 gh-141004: Document stack effect APIs #141843 gh-141004: Document PyImport_Inittab #141844 gh-141004: Document PyDTrace* #141856 [3.14] gh-141004: Document Py_ARRAY_LENGTH (GH-141601) #141895 [3.13] gh-141004: Document Py_ARRAY_LENGTH (GH-141601) #141896 [3.14] gh-141004: Document PyImport_Inittab (GH-141844) #141915 [3.14] gh-141004: Document stack effect C APIs (GH-141843) #141916 [3.13] gh-141004: Document stack effect C APIs (GH-141843) #141917 [3.14] gh-141004: Document PyOS_mystr(n)icmp (GH-141760) #141947 [3.13] gh-141004: Document PyOS_mystr(n)icmp (GH-141760) #141948 [3.14] gh-141004: Document missing PyThread* APIs (GH-141810) #141954 [3.13] gh-141004: Document missing PyThread* APIs (GH-141810) #141955 [3.13] gh-141004: Document PyImport_Inittab (GH-141844) #142016 gh-141004: Add a CI job ensuring that new C APIs include documentation #142102 [3.14] gh-141004: Document descriptor and dict proxy type objects (GH-141803) #142147 [3.13] gh-141004: Document descriptor and dict proxy type objects (GH-141803) #142148 [3.14] gh-141004: Add a CI job ensuring that new C APIs include documentation (GH-142102) #142247 [3.13] gh-141004: Add a CI job ensuring that new C APIs include documentation (GH-142102) #142248 gh-141004: Document unstable executable kind macros in pyframe.h #143490 gh-141004: Document unstable perf map functions in ceval.h #143492 gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros #143494 gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508 gh-141004: Improve make check-c-api-docs #143564 gh-141004: Document old provisional names for vectorcall/code API #143568 gh-141004: GHA: Run check-c-api-docs check on docs-only PRs #143573 gh-141004: Don't trigger run-tests when Tools/check-c-api-docs/ignored_c_api.txt is changed #143583 [3.14] gh-141004: Improve make check-c-api-docs (GH-143564) #143593 [3.13] gh-141004: Improve make check-c-api-docs (GH-143564) #143594 gh-141004: Document remaining constants from patchlevel.h #143598 gh-141004: Mark up docs of old PyMem macros #143783 [3.14] gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros (GH-143494) #143785 [3.14] gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) (GH-143508) #143786 [3.13] gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) (GH-143508) #143787 [3.14] gh-141004: Don't trigger run-tests when Tools/check-c-api-docs/ignored_c_api.txt is changed (GH-143583) #143793 [3.13] gh-141004: Don't trigger run-tests when Tools/check-c-api-docs/ignored_c_api.txt is changed (GH-143583) #143794 [3.14] gh-141004: Document old provisional names for vectorcall/code API (GH-143568) #143828 [3.13] gh-141004: Document old provisional names for vectorcall/code API (GH-143568) #143829 [3.14] gh-141004: Document several soft-deprecated C APIs (GH-141634) #143837 [3.14] gh-141004: Mark up docs of old PyMem macros (GH-143783) #143864 [3.13] gh-141004: Mark up docs of old PyMem macros (GH-143783) #143865 gh-141004: Mark up constants for PyOS_double_to_string #143867 gh-141004: Document PyException_HEAD and PyDescr_COMMON #143896 [3.14] gh-141004: Mark up constants for PyOS_double_to_string (GH-143867) #144146 [3.13] gh-141004: Mark up constants for PyOS_double_to_string (GH-143867) #144147 gh-141004: Document remaining pyport.h utility macros #144279 gh-141004: Reorganize and reword the 'Useful macros' section #144471 [3.14] gh-141004: Document remaining pyport.h utility macros (GH-144279) #144477 [3.13] gh-141004: Document remaining pyport.h utility macros (GH-144279) #144478 [3.14] gh-141004: Reorganize and reword the 'Useful macros' section (GH-144471) #144541 gh-141004: Document PyModuleDef_Type #145043 gh-141004: Document missing type flags #145127 [3.14] gh-141004: Document PyModuleDef_Type (GH-145043) #145146 [3.13] gh-141004: Document PyModuleDef_Type (GH-145043) #145147 [3.14] gh-141004: Document missing type flags (GH-145127) #145316 [3.13] gh-141004: Document missing type flags (GH-145127) #145317 [3.13] gh-141004: Document PyDTrace* (GH-141856) #145958 [3.14] gh-141004: Document PyDTrace* (GH-141856) #145959 [3.15] gh-141004: Document unstable perf map functions in ceval.h (GH-143492) #150849 gh-141004: Document remaining PyCF compiler flag macros #153958 [3.15] gh-141004: Document remaining PyCF_* compiler flag macros (GH-153958) #153984 [3.14] gh-141004: Document remaining PyCF_* compiler flag macros (GH-153958) #153985 [3.13] gh-141004: Document remaining PyCF_* compiler flag macros (GH-153958) #153986 [3.15] gh-141004: Document unstable executable kind macros from pyframe.h (GH-143490) #153988 [3.14] gh-141004: Document unstable executable kind macros from pyframe.h (GH-143490) #153991 [3.13] gh-141004: Document unstable executable kind macros from pyframe.h (GH-143490) #153993 [3.14] gh-141004: Document unstable perf map functions in ceval.h (GH-143492) #153994 [3.13] gh-141004: Document unstable perf map functions in ceval.h (GH-143492) #153996 [3.14] gh-141004: GHA: Run check-c-api-docs check on docs-only PRs (GH-143573) #154464 [3.13] gh-141004: GHA: Run check-c-api-docs check on docs-only PRs (GH-143573) (GH-154464) #154640
@encukou has done great work getting us to document newly added C API in recent versions (#135755, #118915), but unfortunately, we still have plenty of undocumented APIs. I'd like to begin working towards a future where the C API documentation is extensive, up-to-date, and most importantly, helpful to users.
Here's my plan:
static inlinefunctions, and exported symbols) that are prefixed withPy.I'm going to work on this myself, but others are welcome to send PRs where necessary.
I've applied theeasylabel to this for any newcomers who are interested in helping.Below is a list of CPython's undocumented C API. I'm sure many of these aren't documented intentionally, so we should either deprecate them or keep a canonical list of "public but undocumented" somewhere.
bltinmodule.hPyFilter_Type(gh-141004: Document missing built-in iterator types in the C API #141006)PyMap_Type(gh-141004: Document missing built-in iterator types in the C API #141006)PyZip_Type(gh-141004: Document missing built-in iterator types in the C API #141006)enumobject.hPyEnum_Type(gh-141004: Document missing built-in iterator types in the C API #141006)PyReversed_Type(gh-141004: Document missing built-in iterator types in the C API #141006)bytearrayobject.hPyByteArrayIter_Type(gh-141004: Document remaining iterator types #141010)bytesobject.hPyBytes_DecodeEscape(gh-141004: DocumentPyBytes_ReprandPyBytes_DecodeEscape#141407)PyBytes_Repr(gh-141004: DocumentPyBytes_ReprandPyBytes_DecodeEscape#141407)PyBytesIter_Type(gh-141004: Document remaining iterator types #141010)codecs.hPy_hexdigits(gh-141004: DocumentPy_hexdigits#141059)compile.hPy_func_type_input(gh-141004: DocumentPy_func_type_input#141273)datetime.hThese are under #83785.
PyDateTime_CAPSULE_NAME(gh-141004: Document missingPyDateTime*APIs. #141543)descrobject.hPyClassMethodDescr_Type(gh-141004: Document descriptor and dict proxy type objects #141803)PyDictProxy_Type(gh-141004: Document descriptor and dict proxy type objects #141803)PyGetSetDescr_Type(gh-141004: Document descriptor and dict proxy type objects #141803)PyMemberDescr_Type(gh-141004: Document descriptor and dict proxy type objects #141803)PyMethodDescr_Type(gh-141004: Document descriptor and dict proxy type objects #141803)PyWrapperDescr_Type(gh-141004: Document descriptor and dict proxy type objects #141803)dictobject.hPyDictItems_Check(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictItems_Type(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictKeys_Check(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictKeys_Type(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictValues_Check(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictValues_Type(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictViewSet_Check(gh-141004: Document C APIs for dictionary keys, values, and items #141009)PyDictIterItem_Type(gh-141004: Document remaining iterator types #141010)PyDictIterKey_Type(gh-141004: Document remaining iterator types #141010)PyDictIterValue_Type(gh-141004: Document remaining iterator types #141010)PyDictRevIterItem_Type(gh-141004: Document remaining iterator types #141010)PyDictRevIterKey_Type(gh-141004: Document remaining iterator types #141010)PyDictRevIterValue_Type(gh-141004: Document remaining iterator types #141010)fileobject.hPy_FileSystemDefaultEncodeErrors(Pending removal in 3.15)Py_FileSystemDefaultEncoding(Pending removal in 3.15)Py_HasFileSystemDefaultEncoding(Pending removal in 3.15)Py_UTF8Mode(Pending removal in 3.15)listobject.hPyListIter_Type(gh-141004: Document remaining iterator types #141010)PyListRevIter_Type(gh-141004: Document remaining iterator types #141010)memoryobject.hPyMemoryView_Type(gh-141004: DocumentPyMemoryView_Type#141034)objimpl.h(All covered by #141146)
PyObject_DELPyObject_FREEPyObject_INIT_VARPyObject_INITPyObject_MALLOCPyObject_NEW_VARPyObject_NEWPyObject_REALLOCpybuffer.hPyBUF_WRITEABLE(gh-141004: DocumentPyBUF_WRITEABLE#141255)pycapsule.hPyCapsule_Type(gh-141004: DocumentPyCapsule_Type#141079)pydtrace.hPyDTrace_AUDIT_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_AUDIT(gh-141004: DocumentPyDTrace*#141856)PyDTrace_FUNCTION_ENTRY_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_FUNCTION_ENTRY(gh-141004: DocumentPyDTrace*#141856)PyDTrace_FUNCTION_RETURN_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_FUNCTION_RETURN(gh-141004: DocumentPyDTrace*#141856)PyDTrace_GC_DONE_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_GC_DONE(gh-141004: DocumentPyDTrace*#141856)PyDTrace_GC_START_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_GC_START(gh-141004: DocumentPyDTrace*#141856)PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_IMPORT_FIND_LOAD_DONE(gh-141004: DocumentPyDTrace*#141856)PyDTrace_IMPORT_FIND_LOAD_START_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_IMPORT_FIND_LOAD_START(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_DELETE_DONE_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_DELETE_DONE(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_DELETE_START_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_DELETE_START(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_NEW_DONE_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_NEW_DONE(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_NEW_START_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_INSTANCE_NEW_START(gh-141004: DocumentPyDTrace*#141856)PyDTrace_LINE_ENABLED(gh-141004: DocumentPyDTrace*#141856)PyDTrace_LINE(gh-141004: DocumentPyDTrace*#141856)pyerrors.hPyErr_ProgramText(gh-141004: DocumentPyErr_ProgramTextObjectandPyErr_ProgramText#141250)PyExceptionInstance_Check(gh-141004: DocumentPyExceptionInstance*APIs #141301)PyExceptionInstance_Class(gh-141004: DocumentPyExceptionInstance*APIs #141301)pyhash.h(covered in #141205 and #141233)
Py_HASH_ALGORITHMPy_HASH_CUTOFFPy_HASH_EXTERNAL(addressed in Deprecate Py_HASH_EXTERNAL as it cannot be used for--with-hash-algorithm#141226)Py_HASH_FNVPy_HASH_SIPHASH13Py_HASH_SIPHASH24pystrtod.hPy_DTSF_NO_NEG_0(gh-141004: DocumentPy_DTSF_*macros #141310)rangeobject.hPyLongRangeIter_Type(gh-141004: Document remaining iterator types #141010)PyRangeIter_Type(gh-141004: Document remaining iterator types #141010)PyRange_Check(gh-141004: Document missing built-in iterator types in the C API #141006)PyRange_Type(gh-141004: Document missing built-in iterator types in the C API #141006)setobject.hPySetIter_Type(gh-141004: Document remaining iterator types #141010)traceback.hPyTraceBack_Check(gh-141004: DocumentPyTraceBack*APIs #141192)PyTraceBack_Here(gh-141004: DocumentPyTraceBack*APIs #141192)PyTraceBack_Print(gh-141004: DocumentPyTraceBack*APIs #141192)PyTraceBack_Type(gh-141004: DocumentPyTraceBack*APIs #141192)tupleobject.hPyTupleIter_Type(gh-141004: Document remaining iterator types #141010)exports.hPyAPI_DATA(gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508)PyMODEXPORT_FUNC(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_EXPORTED_SYMBOL(gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508)Py_IMPORTED_SYMBOL(gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508)Py_LOCAL_SYMBOL(gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508)PyAPI_FUNC(gh-141004: Document symbol visibility macros (PyAPI_DATA, Py_EXPORTED_SYMBOL, Py_LOCAL_SYMBOL,Py_IMPORTED_SYMBOL) #143508)floatobject.hPy_RETURN_INF(gh-141004: DocumentPy_RETURN_NANandPy_RETURN_INF#141029)Py_RETURN_NAN(gh-141004: DocumentPy_RETURN_NANandPy_RETURN_INF#141029)longobject.hPyLong_AsPid(gh-141004: DocumentPyLong_FromPidandPyLong_AsPid#141028)PyLong_FromPid(gh-141004: DocumentPyLong_FromPidandPyLong_AsPid#141028)methodobject.hPyCFunction_CheckExact(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_Check(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GetFlags(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GetFunction(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GetSelf(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_Type(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)modsupport.hPyABIInfo_FREETHREADING_AGNOSTIC(to be done by PEP-803: gh-146636: PEP 803: Reference documentation #148013)moduleobject.hPyModuleDef_Type(gh-141004: DocumentPyModuleDef_Type#145043)PyModule_FromSlotsAndSpec(PEP-793: gh-140550: PEP 793 reference documentation #141197)PyModule_GetStateSize(PEP-793: gh-140550: PEP 793 reference documentation #141197)PyModule_GetToken(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_doc(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_methods(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_name(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_state_clear(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_state_free(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_state_size(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_state_traverse(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_mod_token(PEP-793: gh-140550: PEP 793 reference documentation #141197)py_curses.h(covered by #141254)
PyCursesInitialisedColorPyCursesInitialisedPyCursesSetupTermCalledPyCursesWindow_CheckPyCursesWindow_TypePyCurses_API_pointersPyCurses_CAPSULE_NAMEpymacro.hPyDoc_VAR(gh-141004: Document thePyDoc_VARmacro #141263)Py_ARRAY_LENGTH(gh-141004: Document Py_ARRAY_LENGTH macro #141601)Py_BUILD_ASSERT_EXPR(gh-141004: DocumentPy_BUILD_ASSERT*macros #141266)Py_BUILD_ASSERT(gh-141004: DocumentPy_BUILD_ASSERT*macros #141266)pymath.hPy_HUGE_VAL(gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544)Py_IS_FINITE(gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544)Py_IS_INFINITY(gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544)Py_IS_NAN(gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544)Py_MATH_E(gh-141004: DocumentPy_MATH_{E, PI, TAU}constants #141373)Py_MATH_El(deprecated in gh-141004: deprecate Py_MATH_El and Py_MATH_PIl macros #141035)Py_MATH_PI(gh-141004: DocumentPy_MATH_{E, PI, TAU}constants #141373)Py_MATH_PIl(deprecated in gh-141004: deprecate Py_MATH_El and Py_MATH_PIl macros #141035)Py_MATH_TAU(gh-141004: DocumentPy_MATH_{E, PI, TAU}constants #141373)Py_NAN(d694474)typeslots.h(Covered in #138190)
unicodeobject.hPy_UNICODE_SIZE(Pending removal in 3.15)object.hPySuper_Type(gh-141004: DocumentPySuper_Type#141315)PyType_FastSubclass(gh-141004: DocumentPyType_FastSubclass#141313)PyType_GetModuleByToken(PEP-793: gh-140550: PEP 793 reference documentation #141197)Py_INVALID_SIZE(gh-146175: Soft-deprecate outdated macros; convert internal usage #146178)Py_TPFLAGS_HAVE_VERSION_TAG(gh-141004: Document missing type flags #145127)Py_TPFLAGS_INLINE_VALUES(gh-141004: Document missing type flags #145127)Py_TPFLAGS_IS_ABSTRACT(gh-141004: Document missing type flags #145127)pyexpat.h(covered in #141259)
PyExpat_CAPI_MAGICPyExpat_CAPSULE_NAMEpyport.hPy_ALIGNED(gh-141004: Document remainingpyport.hutility macros #144279)Py_ARITHMETIC_RIGHT_SHIFT(gh-141004: Document remainingpyport.hutility macros #144279)Py_CAN_START_THREADS(gh-141004: Document remainingpyport.hutility macros #144279)Py_FORCE_EXPANSION(gh-141004: Document remainingpyport.hutility macros #144279)Py_GCC_ATTRIBUTE(gh-141004: Document remainingpyport.hutility macros #144279)Py_LL(gh-141004: Document remainingpyport.hutility macros #144279)Py_LOCAL_INLINE(gh-141004: DocumentPy_LOCAL*#141725)Py_LOCAL(gh-141004: DocumentPy_LOCAL*#141725)Py_MEMCPY(Soft deprecated in 3.14: 26e5c6e; documented in gh-141004: DocumentPy_MEMCPY#141676)Py_SAFE_DOWNCAST(gh-141004: Document remainingpyport.hutility macros #144279)Py_ULL(gh-141004: Document remainingpyport.hutility macros #144279)Py_VA_COPY(gh-141004: Document remainingpyport.hutility macros #144279)PY_BIG_ENDIANPY_SSIZE_T_MAXPY_SSIZE_T_MINweakrefobject.hPyWeakref_CheckRefExact(gh-141004: DocumentPyWeakref_CheckRefExact#141279)cpython/pyctype.hPy_ISALNUM(gh-141004: Documentpyctype.hmacros #141272)Py_ISALPHA(gh-141004: Documentpyctype.hmacros #141272)Py_ISDIGIT(gh-141004: Documentpyctype.hmacros #141272)Py_ISLOWER(gh-141004: Documentpyctype.hmacros #141272)Py_ISSPACE(gh-141004: Documentpyctype.hmacros #141272)Py_ISUPPER(gh-141004: Documentpyctype.hmacros #141272)Py_ISXDIGIT(gh-141004: Documentpyctype.hmacros #141272)Py_TOLOWER(gh-141004: Documentpyctype.hmacros #141272)Py_TOUPPER(gh-141004: Documentpyctype.hmacros #141272)cpython/compile.hPyCF_ALLOW_INCOMPLETE_INPUT(Discussion in DocumentPyCF_ALLOW_INCOMPLETE_INPUT#142372) (gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_COMPILE_MASK(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_DONT_IMPLY_DEDENT(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_IGNORE_COOKIE(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_MASK_OBSOLETE(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_MASK(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCF_SOURCE_IS_UTF8(gh-141004: Document remaining PyCF compiler flag macros #153958)PyCompile_OpcodeStackEffectWithJump(gh-141004: Document stack effect APIs #141843)PyCompile_OpcodeStackEffect(gh-141004: Document stack effect APIs #141843)cpython/descrobject.hPyDescr_COMMON(gh-141004: DocumentPyException_HEADandPyDescr_COMMON#143896)PyDescr_NAMEPyDescr_TYPEPyWrapperFlag_KEYWORDS(marked for deprecation)cpython/fileobject.hPyFile_NewStdPrinter(gh-141004: Document soft-deprecated symbols #141634)PyFile_OpenCodeObject(gh-141004: DocumentPyFile_OpenCodeandPyFile_OpenCodeObject#141413)PyFile_OpenCode(gh-141004: DocumentPyFile_OpenCodeandPyFile_OpenCodeObject#141413)PyStdPrinter_Type(gh-141004: Document soft-deprecated symbols #141634)Py_UniversalNewlineFgetscpython/methodobject.hPyCFunction_GET_CLASS(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GET_FLAGS(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GET_FUNCTION(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCFunction_GET_SELF(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCMethod_CheckExact(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCMethod_Check(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)PyCMethod_Type(gh-141004: Document missingPyCFunction*andPyCMethod*APIs #141253)cpython/odictobject.h(All covered by #141136)
PyODictItems_TypePyODictIter_TypePyODictKeys_TypePyODictValues_TypePyODict_CheckExactPyODict_CheckPyODict_ContainsPyODict_DelItemPyODict_GetItemStringPyODict_GetItemWithErrorPyODict_GetItemPyODict_NewPyODict_SIZEPyODict_SetItemPyODict_SizePyODict_Typecpython/picklebufobject.hPyPickleBuffer_Check(gh-141004: Document thePyPickleBuffer_*C API #141630)PyPickleBuffer_FromObject(gh-141004: Document thePyPickleBuffer_*C API #141630)PyPickleBuffer_GetBuffer(gh-141004: Document thePyPickleBuffer_*C API #141630)PyPickleBuffer_Release(gh-141004: Document thePyPickleBuffer_*C API #141630)PyPickleBuffer_Type(gh-141004: Document thePyPickleBuffer_*C API #141630)cpython/setobject.hPySet_MINSIZE(gh-141004: Document soft-deprecated symbols #141634)cpython/dictobject.hPyDict_GET_SIZE(gh-141004: DocumentPyDict_GET_SIZE#141078)cpython/genobject.hPyAsyncGenASend_CheckExact(gh-141004: Document soft-deprecated symbols #141634)PyAsyncGen_CheckExact(gh-141004: Document missing generator APIs #141409)PyAsyncGen_New(gh-141004: Document missing generator APIs #141409)PyAsyncGen_Type(gh-141004: Document missing generator APIs #141409)PyGen_GetCode(gh-141004: Document missing generator APIs #141409)cpython/import.hPyImport_Inittab(gh-141004: DocumentPyImport_Inittab#141844)cpython/longintrepr.hPyLong_BASE(gh-141004: Document soft-deprecated symbols #141634)PyLong_MASK(gh-141004: Document soft-deprecated symbols #141634)PyLong_SHIFT(gh-141004: Document soft-deprecated symbols #141634)cpython/pyerrors.hPyErr_ProgramTextObject(gh-141004: DocumentPyErr_ProgramTextObjectandPyErr_ProgramText#141250)PyErr_RangedSyntaxLocationObject(gh-141004: DocumentPyErr_RangedSyntaxLocationObject#141521)PyException_HEAD(gh-141004: DocumentPyException_HEADandPyDescr_COMMON#143896)cpython/pyframe.hPyUnstable_EXECUTABLE_KINDS(gh-141004: Document unstable executable kind macros inpyframe.h#143490)PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION(gh-141004: Document unstable executable kind macros inpyframe.h#143490)PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR(gh-141004: Document unstable executable kind macros inpyframe.h#143490)PyUnstable_EXECUTABLE_KIND_PY_FUNCTION(gh-141004: Document unstable executable kind macros inpyframe.h#143490)PyUnstable_EXECUTABLE_KIND_SKIP(gh-141004: Document unstable executable kind macros inpyframe.h#143490)cpython/funcobject.hPyClassMethod_New(gh-141004: DocumentPyClassMethod*andPyStaticMethod*APIs #141296)PyClassMethod_Type(gh-141004: DocumentPyClassMethod*andPyStaticMethod*APIs #141296)PyFunction_SetKwDefaults(gh-141004: DocumentPyFunction_SetKwDefaults#141294)PyStaticMethod_New(gh-141004: DocumentPyClassMethod*andPyStaticMethod*APIs #141296)PyStaticMethod_Type(gh-141004: DocumentPyClassMethod*andPyStaticMethod*APIs #141296)cpython/unicodeobject.hPyUnicode_IS_COMPACT_ASCII(gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros #143494)PyUnicode_IS_COMPACT(gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros #143494)Py_UNICODE_HIGH_SURROGATE(gh-141004: DocumentPy_UNICODE_{HIGH, LOW}_SURROGATEfunctions #141019)Py_UNICODE_LOW_SURROGATE(gh-141004: DocumentPy_UNICODE_{HIGH, LOW}_SURROGATEfunctions #141019)pystrcmp.hPyOS_mystricmp(gh-141004: DocumentPyOS_mystr(n)icmp#141760)PyOS_mystrnicmp(gh-141004: DocumentPyOS_mystr(n)icmp#141760)intrcheck.hPyOS_InterruptOccurred(gh-141004: DocumentPyOS_InterruptOccurred#141526)ceval.hPy_GetRecursionLimit(gh-141004: DocumentPy_GetRecursionLimitandPy_SetRecursionLimit#141151)Py_MakePendingCalls(gh-141004: DocumentPy_MakePendingCalls#141137)Py_SetRecursionLimit(gh-141004: DocumentPy_GetRecursionLimitandPy_SetRecursionLimit#141151)pythread.hPyThread_GetInfo(gh-141004: Document missingPyThread*APIs #141810)PyThread_acquire_lock_timed(gh-141004: Document missingPyThread*APIs #141810)PyThread_acquire_lock(gh-141004: Document missingPyThread*APIs #141810)PyThread_allocate_lock(gh-141004: Document missingPyThread*APIs #141810)PyThread_free_lock(gh-141004: Document missingPyThread*APIs #141810)PyThread_get_stacksize(gh-141004: Document missingPyThread*APIs #141810)PyThread_get_thread_ident(gh-141004: Document missingPyThread*APIs #141810)PyThread_get_thread_native_id(gh-141004: Document missingPyThread*APIs #141810)PyThread_init_thread(gh-141004: Document missingPyThread*APIs #141810)PyThread_release_lock(gh-141004: Document missingPyThread*APIs #141810)PyThread_set_stacksize(gh-141004: Document missingPyThread*APIs #141810)PyThread_start_new_thread(gh-141004: Document missingPyThread*APIs #141810)cpython/frameobject.hPyFrame_FastToLocalsWithError(gh-141004: Document missing frame APIs #141189)PyFrame_FastToLocals(gh-141004: Document missing frame APIs #141189)PyFrame_LocalsToFast(gh-141004: Document missing frame APIs #141189)PyFrame_New(gh-141004: Document missing frame APIs #141189)cpython/objimpl.hPyType_SUPPORTS_WEAKREFS(gh-141004: DocumentPyType_SUPPORTS_WEAKREFS#141408)cpython/pythonrun.hPyRun_InteractiveOneObject(gh-141004: DocumentPyRun_InteractiveOneObject#141405)cpython/ceval.hPyUnstable_CopyPerfMapFile(gh-141004: Document unstable perf map functions inceval.h#143492)PyUnstable_PerfTrampoline_CompileCode(gh-141004: Document unstable perf map functions inceval.h#143492)PyUnstable_PerfTrampoline_SetPersistAfterFork(gh-141004: Document unstable perf map functions inceval.h#143492)cpython/pylifecycle.hPy_FrozenMaincpython/warnings.hPyErr_WarnExplicitFormat(gh-141004: DocumentPyErr_WarnExplicitFormat#141187)cpython/code.hPyCode_Optimize(gh-141004: DocumentPyCode_Optimize#141378)PyCode_GetFirstFreePyCode_NewPyCode_NewWithPosOnlyArgscpython/object.hPyType_Unwatch(gh-141004: DocumentPyType_Unwatch#141414)pymem.hpystrtod.h(all in #143867)
Py_DTSF_ADD_DOT_0Py_DTSF_ALTPy_DTSF_NO_NEG_0Py_DTSF_SIGNPy_DTST_FINITEPy_DTST_INFINITEPy_DTST_NANstructmember.hPY_AUDIT_READobject.hPy_TPFLAGS_HAVE_STACKLESS_EXTENSION(gh-141004: Document missing type flags #145127)Linked PRs
Py_UNICODE_{HIGH, LOW}_SURROGATEfunctions #141019Py_UNICODE_{HIGH, LOW}_SURROGATEfunctions (GH-141019) #141026Py_UNICODE_{HIGH, LOW}_SURROGATEfunctions (GH-141019) #141027PyLong_FromPidandPyLong_AsPid#141028Py_RETURN_NANandPy_RETURN_INF#141029PyMemoryView_Type#141034PyMemoryView_Type(GH-141034) #141054PyMemoryView_Type(GH-141034) #141055Py_hexdigits#141059Py_RETURN_NANandPy_RETURN_INF(GH-141029) #141074Py_RETURN_NANandPy_RETURN_INF(GH-141029) #141075PyDict_GET_SIZE#141078PyCapsule_Type#141079PyDict_GET_SIZE(GH-141078) #141082PyDict_GET_SIZE(GH-141078) #141083PyODict*APIs #141136Py_MakePendingCalls#141137Py_hexdigits(GH-141059) #141138Py_hexdigits(GH-141059) #141139PyLong_FromPidandPyLong_AsPid(GH-141028) #141142PyLong_FromPidandPyLong_AsPid(GH-141028) #141143Py_GetRecursionLimitandPy_SetRecursionLimit#141151Py_GetRecursionLimitandPy_SetRecursionLimit(GH-141151) #141156Py_GetRecursionLimitandPy_SetRecursionLimit(GH-141151) #141157PyErr_WarnExplicitFormat#141187PyTraceBack*APIs #141192PyCapsule_Type(GH-141079) #141198PyCapsule_Type(GH-141079) #141199PyErr_WarnExplicitFormat(GH-141187) #141202PyErr_WarnExplicitFormat(GH-141187) #141203Py_HASH_*macros #141205PyTraceBack*APIs (GH-141192) #141210PyTraceBack*APIs (GH-141192) #141211versionaddedtypo forPy_HASH_SIPHASH13#141223Py_HASH_*macros (GH-141205) #141224Py_HASH_*macros (GH-141205) #141225Py_HASH_*andPyHASH_*ashash_infoattributes #141233Py_HASH_*andPyHASH_*ashash_infoattributes (GH-141233) #141234Py_HASH_*andPyHASH_*ashash_infoattributes (GH-141233) #141235PyErr_ProgramTextObjectandPyErr_ProgramText#141250PyCFunction*andPyCMethod*APIs #141253cursesC API #141254PyBUF_WRITEABLE#141255PyErr_ProgramTextObjectandPyErr_ProgramText(GH-141250) #141256PyErr_ProgramTextObjectandPyErr_ProgramText(GH-141250) #141257pyexpatC API #141259PyBUF_WRITEABLE(GH-141255) #141260PyBUF_WRITEABLE(GH-141255) #141261PyDoc_VARmacro #141263PyDoc_VARmacro (GH-141263) #141264PyDoc_VARmacro (GH-141263) #141265Py_BUILD_ASSERT*macros #141266Py_BUILD_ASSERT*macros (GH-141266) #141269Py_BUILD_ASSERT*macros (GH-141266) #141270pyctype.hmacros #141272Py_func_type_input#141273PyWeakref_CheckRefExact#141279PyWeakref_CheckRefExact(GH-141279) #141290cursesC API (GH-141254) #141292cursesC API (GH-141254) #141293PyFunction_SetKwDefaults#141294PyClassMethod*andPyStaticMethod*APIs #141296Py_func_type_input(GH-141273) #141298Py_func_type_input(GH-141273) #141299PyExceptionInstance*APIs #141301PyExceptionInstance*APIs (GH-141301) #141302PyExceptionInstance*APIs (GH-141301) #141303PyFunction_SetKwDefaults(GH-141294) #141304PyFunction_SetKwDefaults(GH-141294) #141305PyClassMethod*andPyStaticMethod*APIs (GH-141296) #141308PyClassMethod*andPyStaticMethod*APIs (GH-141296) #141309Py_DTSF_*macros #141310PyType_FastSubclass#141313PySuper_Type#141315PySuper_Type(GH-141315) #141318PySuper_Type(GH-141315) #141319Py_DTSF_*macros (GH-141310) #141329Py_DTSF_*macros (GH-141310) #141330pyctype.hmacros (GH-141272) #141339pyctype.hmacros (GH-141272) #141340PyType_FastSubclass(GH-141313) #141368PyType_FastSubclass(GH-141313) #141369PyCode_Optimize#141378PyRun_InteractiveOneObject#141405PyBytes_ReprandPyBytes_DecodeEscape#141407PyType_SUPPORTS_WEAKREFS#141408PyFile_OpenCodeandPyFile_OpenCodeObject#141413PyType_Unwatch#141414PyType_Unwatch(GH-141414) #141418PyType_Unwatch(GH-141414) #141419Py_MATH_{E, PI, TAU}constants #141373PyFile_OpenCodeandPyFile_OpenCodeObject(GH-141413) #141425PyFile_OpenCodeandPyFile_OpenCodeObject(GH-141413) #141426PyBytes_ReprandPyBytes_DecodeEscape(GH-141407) #141440PyBytes_ReprandPyBytes_DecodeEscape(GH-141407) #141441PyType_SUPPORTS_WEAKREFS(GH-141408) #141470Py_MATH_{E, PI, TAU}constants (GH-141373) #141471Py_MATH_{E, PI, TAU}constants (GH-141373) #141472PyRun_InteractiveOneObject(GH-141405) #141485PyRun_InteractiveOneObject(GH-141405) #141486PyType_SUPPORTS_WEAKREFS(GH-141408) #141487PyCode_Optimize(GH-141378) #141514PyCode_Optimize(GH-141378) #141515PyException_HEAD#141522PyErr_RangedSyntaxLocationObject(GH-141521) #141524PyErr_RangedSyntaxLocationObject(GH-141521) #141525PyOS_InterruptOccurred#141526PyDateTime*APIs. #141543PyOS_InterruptOccurred(GH-141526) #141549PyOS_InterruptOccurred(GH-141526) #141550PyPickleBuffer_*C API #141630PyPickleBuffer_*C API (GH-141630) #141632PyPickleBuffer_*C API (GH-141630) #141633PyCFunction*andPyCMethod*APIs (GH-141253) #141637PyCFunction*andPyCMethod*APIs (GH-141253) #141638PyODict*APIs (GH-141136) #141677PyODict*APIs (GH-141136) #141678Py_MEMCPY(GH-141676) #141685Py_LOCAL*#141725PyOS_mystr(n)icmp#141760Py_LOCALandPy_LOCAL_INLINE(GH-141725) #141761Py_LOCALandPy_LOCAL_INLINE(GH-141725) #141762Py_MakePendingCalls(GH-141137) #141787Py_MakePendingCalls(GH-141137) #141788PyDateTime*APIs (GH-141543) #141791PyDateTime*APIs (GH-141543) #141792PyThread*APIs #141810PyImport_Inittab#141844PyDTrace*#141856Py_ARRAY_LENGTH(GH-141601) #141895Py_ARRAY_LENGTH(GH-141601) #141896PyImport_Inittab(GH-141844) #141915PyOS_mystr(n)icmp(GH-141760) #141947PyOS_mystr(n)icmp(GH-141760) #141948PyThread*APIs (GH-141810) #141954PyThread*APIs (GH-141810) #141955PyImport_Inittab(GH-141844) #142016pyframe.h#143490ceval.h#143492make check-c-api-docs#143564check-c-api-docscheck on docs-only PRs #143573run-testswhenTools/check-c-api-docs/ignored_c_api.txtis changed #143583make check-c-api-docs(GH-143564) #143593make check-c-api-docs(GH-143564) #143594run-testswhenTools/check-c-api-docs/ignored_c_api.txtis changed (GH-143583) #143793run-testswhenTools/check-c-api-docs/ignored_c_api.txtis changed (GH-143583) #143794PyOS_double_to_string#143867PyException_HEADandPyDescr_COMMON#143896PyOS_double_to_string(GH-143867) #144146PyOS_double_to_string(GH-143867) #144147pyport.hutility macros #144279pyport.hutility macros (GH-144279) #144477pyport.hutility macros (GH-144279) #144478PyModuleDef_Type#145043PyModuleDef_Type(GH-145043) #145146PyModuleDef_Type(GH-145043) #145147PyDTrace*(GH-141856) #145958PyDTrace*(GH-141856) #145959ceval.h(GH-143492) #150849PyCF_*compiler flag macros (GH-153958) #153984PyCF_*compiler flag macros (GH-153958) #153985PyCF_*compiler flag macros (GH-153958) #153986pyframe.h(GH-143490) #153988pyframe.h(GH-143490) #153991pyframe.h(GH-143490) #153993ceval.h(GH-143492) #153994ceval.h(GH-143492) #153996check-c-api-docscheck on docs-only PRs (GH-143573) #154464check-c-api-docscheck on docs-only PRs (GH-143573) (GH-154464) #154640