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 Extending and Embedding the Python Interpreter, which describes the general principles of extension writing but does not document the API functions in detail.

• Introduction
  • Coding standards
  • Include Files
  • Useful macros
  • Objects, Types and Reference Counts
  • Exceptions
  • Embedding Python
  • Debugging Builds
• C API Stability
  • Stable Application Binary Interface
  • Platform Considerations
  • Contents of Limited API
• The Very High Level Layer
  • Py_Main()
  • Py_BytesMain()
  • PyRun_AnyFile()
  • PyRun_AnyFileFlags()
  • PyRun_AnyFileEx()
  • PyRun_AnyFileExFlags()
  • PyRun_SimpleString()
  • PyRun_SimpleStringFlags()
  • PyRun_SimpleFile()
  • PyRun_SimpleFileEx()
  • PyRun_SimpleFileExFlags()
  • PyRun_InteractiveOne()
  • PyRun_InteractiveOneFlags()
  • PyRun_InteractiveLoop()
  • PyRun_InteractiveLoopFlags()
  • PyOS_InputHook
  • PyOS_ReadlineFunctionPointer
  • PyRun_String()
  • PyRun_StringFlags()
  • PyRun_File()
  • PyRun_FileEx()
  • PyRun_FileFlags()
  • PyRun_FileExFlags()
  • Py_CompileString()
  • Py_CompileStringFlags()
  • Py_CompileStringObject()
  • Py_CompileStringExFlags()
  • PyEval_EvalCode()
  • PyEval_EvalCodeEx()
  • PyFrameObject
  • PyEval_EvalFrame()
  • PyEval_EvalFrameEx()
  • PyEval_MergeCompilerFlags()
  • Py_eval_input
  • Py_file_input
  • Py_single_input
  • PyCompilerFlags
  • CO_FUTURE_DIVISION
• Reference Counting
  • Py_INCREF()
  • Py_XINCREF()
  • Py_NewRef()
  • Py_XNewRef()
  • Py_DECREF()
  • Py_XDECREF()
  • Py_CLEAR()
  • Py_IncRef()
  • Py_DecRef()
• Exception Handling
  • Printing and clearing
  • Raising exceptions
  • Issuing warnings
  • Querying the error indicator
  • Signal Handling
  • Exception Classes
  • Exception Objects
  • Unicode Exception Objects
  • Recursion Control
  • Standard Exceptions
  • Standard Warning Categories
• Utilities
  • Operating System Utilities
  • System Functions
  • Process Control
  • Importing Modules
  • Data marshalling support
  • Parsing arguments and building values
  • String conversion and formatting
  • Reflection
  • Codec registry and support functions
• Abstract Objects Layer
  • Object Protocol
  • Call Protocol
  • Number Protocol
  • Sequence Protocol
  • Mapping Protocol
  • Iterator Protocol
  • Buffer Protocol
  • Old Buffer Protocol
• Concrete Objects Layer
  • Fundamental Objects
  • Numeric Objects
  • Sequence Objects
  • Container Objects
  • Function Objects
  • Other Objects
• Initialization, Finalization, and Threads
  • Before Python Initialization
  • Global configuration variables
  • Initializing and finalizing the interpreter
  • Process-wide parameters
  • Thread State and the Global Interpreter Lock
  • Sub-interpreter support
  • Asynchronous Notifications
  • Profiling and Tracing
  • Advanced Debugger Support
  • Thread Local Storage Support
• Python Initialization Configuration
  • Example
  • PyWideStringList
  • PyStatus
  • PyPreConfig
  • Preinitialize Python with PyPreConfig
  • PyConfig
  • Initialization with PyConfig
  • Isolated Configuration
  • Python Configuration
  • Python Path Configuration
  • Py_RunMain()
  • Py_GetArgcArgv()
  • Multi-Phase Initialization Private Provisional API
• Memory Management
  • Overview
  • Allocator Domains
  • Raw Memory Interface
  • Memory Interface
  • Object allocators
  • Default Memory Allocators
  • Customize Memory Allocators
  • Debug hooks on the Python memory allocators
  • The pymalloc allocator
  • tracemalloc C API
  • Examples
• Object Implementation Support
  • Allocating Objects on the Heap
  • Common Object Structures
  • Type Objects
  • Number Object Structures
  • Mapping Object Structures
  • Sequence Object Structures
  • Buffer Object Structures
  • Async Object Structures
  • Slot Type typedefs
  • Examples
  • Supporting Cyclic Garbage Collection
• API and ABI Versioning
  • PY_MAJOR_VERSION
  • PY_MINOR_VERSION
  • PY_MICRO_VERSION
  • PY_RELEASE_LEVEL
  • PY_RELEASE_SERIAL
  • PY_VERSION_HEX