diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/python~3.12/c-api%2Findex.html | |
new repository
Diffstat (limited to 'devdocs/python~3.12/c-api%2Findex.html')
| -rw-r--r-- | devdocs/python~3.12/c-api%2Findex.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/devdocs/python~3.12/c-api%2Findex.html b/devdocs/python~3.12/c-api%2Findex.html new file mode 100644 index 00000000..e894c006 --- /dev/null +++ b/devdocs/python~3.12/c-api%2Findex.html @@ -0,0 +1,16 @@ + <span id="c-api-index"></span><h1>Python/C API Reference Manual</h1> <p>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 <a class="reference internal" href="../extending/index#extending-index"><span class="std std-ref">Extending and Embedding the Python Interpreter</span></a>, which describes the general principles of extension writing but does not document the API functions in detail.</p> <ul> <li class="toctree-l1"> +<a class="reference internal" href="intro">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="intro#coding-standards">Coding standards</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#include-files">Include Files</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#useful-macros">Useful macros</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#objects-types-and-reference-counts">Objects, Types and Reference Counts</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#exceptions">Exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#embedding-python">Embedding Python</a></li> <li class="toctree-l2"><a class="reference internal" href="intro#debugging-builds">Debugging Builds</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="stable">C API Stability</a><ul> <li class="toctree-l2"><a class="reference internal" href="stable#unstable-c-api">Unstable C API</a></li> <li class="toctree-l2"><a class="reference internal" href="stable#stable-application-binary-interface">Stable Application Binary Interface</a></li> <li class="toctree-l2"><a class="reference internal" href="stable#platform-considerations">Platform Considerations</a></li> <li class="toctree-l2"><a class="reference internal" href="stable#contents-of-limited-api">Contents of Limited API</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="veryhigh">The Very High Level Layer</a></li> <li class="toctree-l1"><a class="reference internal" href="refcounting">Reference Counting</a></li> <li class="toctree-l1"> +<a class="reference internal" href="exceptions">Exception Handling</a><ul> <li class="toctree-l2"><a class="reference internal" href="exceptions#printing-and-clearing">Printing and clearing</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#raising-exceptions">Raising exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#issuing-warnings">Issuing warnings</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#querying-the-error-indicator">Querying the error indicator</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#signal-handling">Signal Handling</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#exception-classes">Exception Classes</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#exception-objects">Exception Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#unicode-exception-objects">Unicode Exception Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#recursion-control">Recursion Control</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#standard-exceptions">Standard Exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="exceptions#standard-warning-categories">Standard Warning Categories</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="utilities">Utilities</a><ul> <li class="toctree-l2"><a class="reference internal" href="sys">Operating System Utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="sys#system-functions">System Functions</a></li> <li class="toctree-l2"><a class="reference internal" href="sys#process-control">Process Control</a></li> <li class="toctree-l2"><a class="reference internal" href="import">Importing Modules</a></li> <li class="toctree-l2"><a class="reference internal" href="marshal">Data marshalling support</a></li> <li class="toctree-l2"><a class="reference internal" href="arg">Parsing arguments and building values</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion">String conversion and formatting</a></li> <li class="toctree-l2"><a class="reference internal" href="reflection">Reflection</a></li> <li class="toctree-l2"><a class="reference internal" href="codec">Codec registry and support functions</a></li> <li class="toctree-l2"><a class="reference internal" href="perfmaps">Support for Perf Maps</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="abstract">Abstract Objects Layer</a><ul> <li class="toctree-l2"><a class="reference internal" href="object">Object Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="call">Call Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="number">Number Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="sequence">Sequence Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="mapping">Mapping Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="iter">Iterator Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="buffer">Buffer Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="objbuffer">Old Buffer Protocol</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="concrete">Concrete Objects Layer</a><ul> <li class="toctree-l2"><a class="reference internal" href="concrete#fundamental-objects">Fundamental Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="concrete#numeric-objects">Numeric Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="concrete#sequence-objects">Sequence Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="concrete#container-objects">Container Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="concrete#function-objects">Function Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="concrete#other-objects">Other Objects</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="init">Initialization, Finalization, and Threads</a><ul> <li class="toctree-l2"><a class="reference internal" href="init#before-python-initialization">Before Python Initialization</a></li> <li class="toctree-l2"><a class="reference internal" href="init#global-configuration-variables">Global configuration variables</a></li> <li class="toctree-l2"><a class="reference internal" href="init#initializing-and-finalizing-the-interpreter">Initializing and finalizing the interpreter</a></li> <li class="toctree-l2"><a class="reference internal" href="init#process-wide-parameters">Process-wide parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="init#thread-state-and-the-global-interpreter-lock">Thread State and the Global Interpreter Lock</a></li> <li class="toctree-l2"><a class="reference internal" href="init#sub-interpreter-support">Sub-interpreter support</a></li> <li class="toctree-l2"><a class="reference internal" href="init#asynchronous-notifications">Asynchronous Notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="init#profiling-and-tracing">Profiling and Tracing</a></li> <li class="toctree-l2"><a class="reference internal" href="init#advanced-debugger-support">Advanced Debugger Support</a></li> <li class="toctree-l2"><a class="reference internal" href="init#thread-local-storage-support">Thread Local Storage Support</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="init_config">Python Initialization Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="init_config#example">Example</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#pywidestringlist">PyWideStringList</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#pystatus">PyStatus</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#pypreconfig">PyPreConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#preinitialize-python-with-pypreconfig">Preinitialize Python with PyPreConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#pyconfig">PyConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#initialization-with-pyconfig">Initialization with PyConfig</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#isolated-configuration">Isolated Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#python-configuration">Python Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#python-path-configuration">Python Path Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#py-runmain">Py_RunMain()</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#py-getargcargv">Py_GetArgcArgv()</a></li> <li class="toctree-l2"><a class="reference internal" href="init_config#multi-phase-initialization-private-provisional-api">Multi-Phase Initialization Private Provisional API</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="memory">Memory Management</a><ul> <li class="toctree-l2"><a class="reference internal" href="memory#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#allocator-domains">Allocator Domains</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#raw-memory-interface">Raw Memory Interface</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#memory-interface">Memory Interface</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#object-allocators">Object allocators</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#default-memory-allocators">Default Memory Allocators</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#customize-memory-allocators">Customize Memory Allocators</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#debug-hooks-on-the-python-memory-allocators">Debug hooks on the Python memory allocators</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#the-pymalloc-allocator">The pymalloc allocator</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#tracemalloc-c-api">tracemalloc C API</a></li> <li class="toctree-l2"><a class="reference internal" href="memory#examples">Examples</a></li> </ul> </li> <li class="toctree-l1"> +<a class="reference internal" href="objimpl">Object Implementation Support</a><ul> <li class="toctree-l2"><a class="reference internal" href="allocation">Allocating Objects on the Heap</a></li> <li class="toctree-l2"><a class="reference internal" href="structures">Common Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj">Type Objects</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#number-object-structures">Number Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#mapping-object-structures">Mapping Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#sequence-object-structures">Sequence Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#buffer-object-structures">Buffer Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#async-object-structures">Async Object Structures</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#slot-type-typedefs">Slot Type typedefs</a></li> <li class="toctree-l2"><a class="reference internal" href="typeobj#examples">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="gcsupport">Supporting Cyclic Garbage Collection</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="apiabiversion">API and ABI Versioning</a></li> </ul> <div class="_attribution"> + <p class="_attribution-p"> + © 2001–2023 Python Software Foundation<br>Licensed under the PSF License.<br> + <a href="https://docs.python.org/3.12/c-api/index.html" class="_attribution-link">https://docs.python.org/3.12/c-api/index.html</a> + </p> +</div> |
