Вступ — Python 3.15.2 documentation
Навігація індекс модулі | наступний | попередній | Python » 3.15.2 documentation » Python/C API reference manual » Вступ | Theme | Вступ ¶ Інтерфейс прикладного програміста для Python надає програмістам C і C++ доступ до інтерпретатора Python на різних рівнях. API так само можна використовувати з C++, але для стислості його зазвичай називають Python/C API.
Є дві принципово різні причини використання Python/C API. Перша причина полягає в написанні модулів розширення для певних цілей; це модулі C, які розширюють інтерпретатор Python. Мабуть, це найпоширеніше використання. Друга причина полягає в тому, щоб використовувати Python як компонент у більшій програмі; цей прийом зазвичай називають embedding Python у програму.
Написання модуля розширення є відносно добре зрозумілим процесом, де добре працює підхід «кулінарної книги». Є кілька інструментів, які певною мірою автоматизують процес. Хоча люди вбудовували Python в інші програми з самого початку його існування, процес вбудовування Python менш простий, ніж написання розширення.
Багато функцій API корисні незалежно від того, чи ви вбудовуєте чи розширюєте Python; крім того, більшість програм, які вбудовують Python, потребуватимуть також надати спеціальне розширення, тому, мабуть, доцільно ознайомитися з написанням розширення перед тим, як намагатися вставити Python у реальну програму.
Language version compatibility ¶ Python’s C API is compatible with C11 and C++11 versions of C and C++. This is a lower limit: the C API does not require features from later C/C++ versions. You do not need to enable your compiler’s «c11 mode». Стандарти кодування ¶ Якщо ви пишете код C для включення в CPython, ви повинні дотримуватися вказівок і стандартів, визначених у PEP 7 .
Ці вказівки застосовуються незалежно від версії Python, до якої ви робите внесок. Дотримання цих умов не є обов’язковим для ваших власних модулів розширення сторонніх розробників, якщо тільки ви не плануєте додати їх до Python. Включати файли ¶ Усі визначення функцій, типів і макросів, необхідні для використання API Python/C, включено у ваш код у такий рядок: #define PY_SSIZE_T_CLEAN #include <Python.h> This implies inclusion of the following standard headers: <stdio.h> , <string.h> , <errno.h> , <limits.h> , <assert.h> and <stdlib.h> (if available).
Примітка Оскільки Python може визначати деякі визначення попереднього процесора, які впливають на стандартні заголовки в деяких системах, ви мусите включити Python.h перед тим, як включити будь-які стандартні заголовки. Рекомендується завжди визначати PY_SSIZE_T_CLEAN перед включенням Python.h .
Перегляньте Розбір аргументів і створення значень для опису цього макросу. Усі видимі для користувача імена, визначені Python.h (крім тих, що визначені включеними стандартними заголовками), мають один із префіксів Py або _Py . Імена, що починаються з _Py призначені для внутрішнього використання реалізацією Python і не повинні використовуватися розробниками розширень.
Імена членів структури не мають зарезервованого префікса. Примітка Код користувача ніколи не повинен визначати імена, які починаються з Py або _Py . Це заплутує читача та ставить під загрозу перенесення коду користувача на майбутні версії Python, які можуть визначати додаткові імена, що починаються з одного з цих префіксів.
The header files are typically installed with Python. On Unix, these are located in the directories prefix /include/pythonversion/ and exec_prefix /include/pythonversion/ , where prefix and exec_prefix are defined by the corresponding parameters to Python’s configure script and version is '%d.%d' % sys.version_info[:2] . On Windows, the headers are installed in prefix /include , where prefix is the installation directory specified to the installer.
To include the headers, place both directories (if different) on your compiler’s search path for includes. Do not place the parent directories on the search path and then use #include <pythonX.Y/Python.h> ; this will break on multi-platform builds since the platform independent headers under prefix include the platform specific headers from exec_prefix . Користувачі C++ повинні мати на увазі, що хоча API повністю визначено за допомогою C, файли заголовків належним чином оголошують точки входу як extern "C" .
Як наслідок, немає потреби робити щось особливе для використання API із C++. System includes ¶ Python.h includes several standard header files. C extensions should include the standard headers that they use, and should not rely on these implicit includes. The implicit includes are: <assert.h> <intrin.h> (on Windows) <inttypes.h> <limits.h> <math.h> <stdarg.h> <string.h> <wchar.h> <sys/types.h> (if present) The following are included for backwards compatibility, unless using Limited API 3.13 or newer: <ctype.h> <unistd.h> (on POSIX) The following are included for backwards compatibility, unless using Limited API 3.11 or newer: <errno.h> <stdio.h> <stdlib.h> Примітка Оскільки Python може визначати деякі визначення попереднього процесора, які впливають на стандартні заголовки в деяких системах, ви мусите включити Python.h перед тим, як включити будь-які стандартні заголовки.
Корисні макроси ¶ Several useful macros are defined in the Python header files. Many are defined closer to where they are useful (for example, Py_RETURN_NONE , PyMODINIT_FUNC ). Others of a more general utility are defined here. This is not necessarily a complete listing. Py_CAN_START_THREADS ¶ If this macro is defined, then the current system is able to start threads. Curren
The rest of this page is on the live site.