cpython/Doc/c-api/index.rst

.. _c-api-index:

##################################
  Python/C API Reference Manual
##################################

This manual documents the API used by C and C++ programmers who want to write
extension modules or embed Python.  It is a companion to :ref:`extending-index`,
which describes the general principles of extension writing but does not
document the API functions in detail.

.. toctree::
   :maxdepth: 2

   intro.rst
   stable.rst
   veryhigh.rst
   refcounting.rst
   exceptions.rst
   utilities.rst
   abstract.rst
   concrete.rst
   init.rst
   init_config.rst
   memory.rst
   objimpl.rst
   apiabiversion.rst
   monitoring.rst
Move the 3k reST doc tree in place. 2007-08-15 14:28:22 +00:00			`.. _c-api-index:`

			`##################################`
			`Python/C API Reference Manual`
			`##################################`

			`This manual documents the API used by C and C++ programmers who want to write`
			extension modules or embed Python. It is a companion to :ref:`extending-index`,
			`which describes the general principles of extension writing but does not`
			`document the API functions in detail.`

			`.. toctree::`
			`:maxdepth: 2`

			`intro.rst`
Introduce support for documenting which C API elements are not part of the stable/limited API. 2013-10-12 19:54:30 +02:00			`stable.rst`
Move the 3k reST doc tree in place. 2007-08-15 14:28:22 +00:00			`veryhigh.rst`
			`refcounting.rst`
			`exceptions.rst`
			`utilities.rst`
			`abstract.rst`
			`concrete.rst`
			`init.rst`
bpo-36763: Implement the PEP 587 (GH-13592) * Add a whole new documentation page: "Python Initialization Configuration" * PyWideStringList_Append() return type is now PyStatus, instead of int * PyInterpreterState_New() now calls PyConfig_Clear() if PyConfig_InitPythonConfig() fails. * Rename files: * Python/coreconfig.c => Python/initconfig.c * Include/cpython/coreconfig.h => Include/cpython/initconfig.h * Include/internal/: pycore_coreconfig.h => pycore_initconfig.h * Rename structures * _PyCoreConfig => PyConfig * _PyPreConfig => PyPreConfig * _PyInitError => PyStatus * _PyWstrList => PyWideStringList * Rename PyConfig fields: * use_module_search_paths => module_search_paths_set * module_search_path_env => pythonpath_env * Rename PyStatus field: _func => func * PyInterpreterState: rename core_config field to config * Rename macros and functions: * _PyCoreConfig_SetArgv() => PyConfig_SetBytesArgv() * _PyCoreConfig_SetWideArgv() => PyConfig_SetArgv() * _PyCoreConfig_DecodeLocale() => PyConfig_SetBytesString() * _PyInitError_Failed() => PyStatus_Exception() * _Py_INIT_ERROR_TYPE_xxx enums => _PyStatus_TYPE_xxx * _Py_UnixMain() => Py_BytesMain() * _Py_ExitInitError() => Py_ExitStatusException() * _Py_PreInitializeFromArgs() => Py_PreInitializeFromBytesArgs() * _Py_PreInitializeFromWideArgs() => Py_PreInitializeFromArgs() * _Py_PreInitialize() => Py_PreInitialize() * _Py_RunMain() => Py_RunMain() * _Py_InitializeFromConfig() => Py_InitializeFromConfig() * _Py_INIT_XXX() => _PyStatus_XXX() * _Py_INIT_FAILED() => _PyStatus_EXCEPTION() * Rename 'err' PyStatus variables to 'status' * Convert RUN_CODE() macro to config_run_code() static inline function * Remove functions: * _Py_InitializeFromArgs() * _Py_InitializeFromWideArgs() * _PyInterpreterState_GetCoreConfig() 2019-05-27 16:39:22 +02:00			`init_config.rst`
Move the 3k reST doc tree in place. 2007-08-15 14:28:22 +00:00			`memory.rst`
Fix two oversights in C API split. 2008-01-20 11:00:14 +00:00			`objimpl.rst`
Close #15465: Document C API version macros Mostly moving the existing macro docs over from the standard library docs to the C API docs where they belong. Patch by Kushal Das. 2013-03-07 23:14:44 +10:00			`apiabiversion.rst`
gh-111997: C-API for signalling monitoring events (#116413) 2024-05-04 09:23:50 +01:00			`monitoring.rst`