`extending.md`

186 строк · 22.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.11/faq/extending.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [FAQ по расширению и встраиванию](https://python-all.ru/3.11/faq/extending.html#id2)89Содержание [FAQ по расширению и встраиванию](https://python-all.ru/3.11/faq/extending.html#extending-embedding-faq) [Можно ли создавать собственные функции на C?](https://python-all.ru/3.11/faq/extending.html#can-i-create-my-own-functions-in-c) [Можно ли создавать собственные функции на C++?](https://python-all.ru/3.11/faq/extending.html#id1) [Писать на C сложно; есть ли альтернативы?](https://python-all.ru/3.11/faq/extending.html#writing-c-is-hard-are-there-any-alternatives) [Как выполнить произвольные инструкции Python из C?](https://python-all.ru/3.11/faq/extending.html#how-can-i-execute-arbitrary-python-statements-from-c) [Как вычислить произвольное выражение Python из C?](https://python-all.ru/3.11/faq/extending.html#how-can-i-evaluate-an-arbitrary-python-expression-from-c) [Как извлечь значения C из объекта Python?](https://python-all.ru/3.11/faq/extending.html#how-do-i-extract-c-values-from-a-python-object) [Как использовать Py\_BuildValue() для создания кортежа произвольной длины?](https://python-all.ru/3.11/faq/extending.html#how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length) [Как вызвать метод объекта из C?](https://python-all.ru/3.11/faq/extending.html#how-do-i-call-an-object-s-method-from-c) [Как перехватить вывод PyErr\_Print() (или любого другого вывода в stdout/stderr)?](https://python-all.ru/3.11/faq/extending.html#how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr) [Как получить доступ к модулю, написанному на Python, из C?](https://python-all.ru/3.11/faq/extending.html#how-do-i-access-a-module-written-in-python-from-c) [Как организовать взаимодействие с объектами C++ из Python?](https://python-all.ru/3.11/faq/extending.html#how-do-i-interface-to-c-objects-from-python) [Почему make завершается ошибкой после добавления модуля через файл Setup?](https://python-all.ru/3.11/faq/extending.html#i-added-a-module-using-the-setup-file-and-the-make-fails-why) [Как отлаживать расширение?](https://python-all.ru/3.11/faq/extending.html#how-do-i-debug-an-extension) [Почему при компиляции модуля Python в Linux отсутствуют некоторые файлы?](https://python-all.ru/3.11/faq/extending.html#i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why) [Как отличить «неполный ввод» от «неверного ввода»?](https://python-all.ru/3.11/faq/extending.html#how-do-i-tell-incomplete-input-from-invalid-input) [Как найти неопределённые символы g++ \_\_builtin\_new или \_\_pure\_virtual?](https://python-all.ru/3.11/faq/extending.html#how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual) [Можно ли создать класс объекта, в котором часть методов реализована на C, а часть – на Python (например, через наследование)?](https://python-all.ru/3.11/faq/extending.html#can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance)1011## [Могу ли я создавать собственные функции на C?](https://python-all.ru/3.11/faq/extending.html#id3)1213Да, можно создавать встроенные модули, содержащие функции, переменные, исключения и даже новые типы на C. Это описано в документе [Extending and Embedding the Python Interpreter](https://python-all.ru/3.11/extending/index.html#extending-index).1415Эта тема также освещается в большинстве книг по Python для среднего и продвинутого уровня.1617## [Могу ли я создавать собственные функции на C++?](https://python-all.ru/3.11/faq/extending.html#id4)1819Да, это возможно благодаря средствам совместимости с C в C++. Следует поместить `extern "C" { ... }` вокруг включаемых файлов Python и добавить `extern "C"` перед каждой функцией, которая будет вызываться интерпретатором Python. Глобальные или статические объекты C++ с конструкторами, вероятно, лучше не использовать.2021## [Писать на C сложно; есть ли альтернативы?](https://python-all.ru/3.11/faq/extending.html#id5)2223Существует ряд альтернатив написанию собственных расширений на C – в зависимости от решаемой задачи.2425[Cython](https://python-all.ru/3.11/faq/extending.html) и его родственник [Pyrex](https://python-all.ru/3.11/faq/extending.html) – это компиляторы, которые принимают слегка изменённую форму Python и генерируют соответствующий код на C. Cython и Pyrex позволяют писать расширения, не изучая C API Python.2627Если требуется взаимодействие с библиотекой на C или C++, для которой в настоящее время нет расширения Python, можно попробовать обернуть типы данных и функции библиотеки с помощью такого инструмента, как [SWIG](https://python-all.ru/3.11/faq/extending.html). [SIP](https://python-all.ru/3.11/faq/extending.html), [CXX](https://python-all.ru/3.11/faq/extending.html), [Boost](https://python-all.ru/3.11/faq/extending.html) или [Weave](https://python-all.ru/3.11/faq/extending.html) также являются альтернативами для обёртывания библиотек C++.2829## [Как выполнить произвольные операторы Python из C?](https://python-all.ru/3.11/faq/extending.html#id6)3031Функция самого высокого уровня для этого – [`PyRun_SimpleString()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyRun_SimpleString), принимающая один строковый аргумент, который выполняется в контексте модуля `__main__`, и возвращающая `0` в случае успеха и `-1` при возникновении исключения (включая [`SyntaxError`](https://python-all.ru/3.11/library/exceptions.html#SyntaxError)). Если требуется более тонкий контроль, используйте [`PyRun_String()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyRun_String); см. исходный код [`PyRun_SimpleString()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyRun_SimpleString) в `Python/pythonrun.c`.3233## [Как вычислить произвольное выражение Python из C?](https://python-all.ru/3.11/faq/extending.html#id7)3435Вызовите функцию [`PyRun_String()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyRun_String) из предыдущего вопроса с начальным символом [`Py_eval_input`](https://python-all.ru/3.11/c-api/veryhigh.html#c.Py_eval_input); она разбирает выражение, вычисляет его и возвращает его значение.3637## [Как извлечь значения C из объекта Python?](https://python-all.ru/3.11/faq/extending.html#id8)3839Это зависит от типа объекта. Если это кортеж, [`PyTuple_Size()`](https://python-all.ru/3.11/c-api/tuple.html#c.PyTuple_Size) возвращает его длину, а [`PyTuple_GetItem()`](https://python-all.ru/3.11/c-api/tuple.html#c.PyTuple_GetItem) возвращает элемент по указанному индексу. У списков есть аналогичные функции: [`PyList_Size()`](https://python-all.ru/3.11/c-api/list.html#c.PyList_Size) и [`PyList_GetItem()`](https://python-all.ru/3.11/c-api/list.html#c.PyList_GetItem).4041Для bytes [`PyBytes_Size()`](https://python-all.ru/3.11/c-api/bytes.html#c.PyBytes_Size) возвращает его длину, а [`PyBytes_AsStringAndSize()`](https://python-all.ru/3.11/c-api/bytes.html#c.PyBytes_AsStringAndSize) предоставляет указатель на его значение и его длину. Обратите внимание, что объекты Python bytes могут содержать нулевые байты, поэтому C'шный `strlen()` использовать не следует.4243Чтобы проверить тип объекта, сначала убедитесь, что он не `NULL`, а затем используйте [`PyBytes_Check()`](https://python-all.ru/3.11/c-api/bytes.html#c.PyBytes_Check), [`PyTuple_Check()`](https://python-all.ru/3.11/c-api/tuple.html#c.PyTuple_Check), [`PyList_Check()`](https://python-all.ru/3.11/c-api/list.html#c.PyList_Check) и т.д.4445Существует также высокоуровневый API для объектов Python, предоставляемый так называемым «абстрактным» интерфейсом – читайте `Include/abstract.h` для получения дополнительных сведений. Он позволяет взаимодействовать с любыми последовательностями Python с помощью вызовов вроде [`PySequence_Length()`](https://python-all.ru/3.11/c-api/sequence.html#c.PySequence_Length), [`PySequence_GetItem()`](https://python-all.ru/3.11/c-api/sequence.html#c.PySequence_GetItem) и т.д., а также многих других полезных протоколов, таких как числа ([`PyNumber_Index()`](https://python-all.ru/3.11/c-api/number.html#c.PyNumber_Index) и др.) и отображения в API PyMapping.4647## [Как использовать Py\_BuildValue() для создания кортежа произвольной длины?](https://python-all.ru/3.11/faq/extending.html#id9)4849Никак. Вместо этого используйте [`PyTuple_Pack()`](https://python-all.ru/3.11/c-api/tuple.html#c.PyTuple_Pack).5051## [Как вызвать метод объекта из C?](https://python-all.ru/3.11/faq/extending.html#id10)5253Функцию [`PyObject_CallMethod()`](https://python-all.ru/3.11/c-api/call.html#c.PyObject_CallMethod) можно использовать для вызова произвольного метода объекта. Параметры: объект, имя вызываемого метода, строка форматирования, подобная используемой с [`Py_BuildValue()`](https://python-all.ru/3.11/c-api/arg.html#c.Py_BuildValue), и значения аргументов:5455```c56PyObject *57PyObject_CallMethod(PyObject *object, const char *method_name,58                    const char *arg_format, ...);59```6061Это работает для любого объекта, имеющего методы – как встроенные, так и определённые пользователем. Ответственность за последующий [`Py_DECREF()`](https://python-all.ru/3.11/c-api/refcounting.html#c.Py_DECREF) возвращаемого значения лежит на вас.6263Например, чтобы вызвать метод “seek” файлового объекта с аргументами 10, 0 (предполагая, что указатель на файловый объект – “f”):6465```c66res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);67if (res == NULL) {68        ... an exception occurred ...69}70else {71        Py_DECREF(res);72}73```7475Обратите внимание, что [`PyObject_CallObject()`](https://python-all.ru/3.11/c-api/call.html#c.PyObject_CallObject) *всегда* ожидает кортеж в качестве списка аргументов; чтобы вызвать функцию без аргументов, передайте “()” в качестве формата, а чтобы вызвать функцию с одним аргументом, заключите аргумент в круглые скобки, например “(i)”.7677## [Как перехватить вывод PyErr\_Print() (или всего, что печатает в stdout/stderr)?](https://python-all.ru/3.11/faq/extending.html#id11)7879В коде Python определите объект, поддерживающий метод `write()`. Назначьте этот объект на [`sys.stdout`](https://python-all.ru/3.11/library/sys.html#sys.stdout) и [`sys.stderr`](https://python-all.ru/3.11/library/sys.html#sys.stderr). Вызовите print\_error или просто позвольте стандартному механизму трассировки сработать. Тогда вывод будет направлен туда, куда его отправляет метод `write()`.8081Проще всего это сделать с помощью класса [`io.StringIO`](https://python-all.ru/3.11/library/io.html#io.StringIO):8283```pycon84>>> import io, sys85>>> sys.stdout = io.StringIO()86>>> print('foo')87>>> print('hello world!')88>>> sys.stderr.write(sys.stdout.getvalue())89foo90hello world!91```9293Пользовательский объект для того же самого мог бы выглядеть так:9495```pycon96>>> import io, sys97>>> class StdoutCatcher(io.TextIOBase):98...     def __init__(self):99...         self.data = []100...     def write(self, stuff):101...         self.data.append(stuff)102...103>>> import sys104>>> sys.stdout = StdoutCatcher()105>>> print('foo')106>>> print('hello world!')107>>> sys.stderr.write(''.join(sys.stdout.data))108foo109hello world!110```111112## [Как получить доступ к модулю, написанному на Python, из C?](https://python-all.ru/3.11/faq/extending.html#id12)113114Указатель на объект модуля можно получить следующим образом:115116```c117module = PyImport_ImportModule("<modulename>");118```119120Если модуль ещё не был импортирован (т.е. его ещё нет в [`sys.modules`](https://python-all.ru/3.11/library/sys.html#sys.modules)), то выполняется его инициализация; в противном случае просто возвращается значение `sys.modules["<modulename>"]`. Обратите внимание: модуль не добавляется ни в одно пространство имён – гарантируется только его инициализация и сохранение в [`sys.modules`](https://python-all.ru/3.11/library/sys.html#sys.modules).121122Затем можно обратиться к атрибутам модуля (т.е. к любым именам, определённым в модуле) следующим образом:123124```c125attr = PyObject_GetAttrString(module, "<attrname>");126```127128Вызов [`PyObject_SetAttrString()`](https://python-all.ru/3.11/c-api/object.html#c.PyObject_SetAttrString) для присваивания переменным в модуле также работает.129130## [Как организовать взаимодействие с объектами C++ из Python?](https://python-all.ru/3.11/faq/extending.html#id13)131132В зависимости от требований существует множество подходов. Для ручного выполнения начните с чтения [документа «Extending and Embedding»](https://python-all.ru/3.11/extending/index.html#extending-index). Следует понимать, что для системы времени выполнения Python нет большой разницы между C и C++ – поэтому стратегия создания нового типа Python на основе C-структуры (указателя) будет работать и для объектов C++.133134Для библиотек C++ см. [Писать на C сложно; есть ли альтернативы?](https://python-all.ru/3.11/faq/extending.html#c-wrapper-software).135136## [Я добавил модуль через файл Setup, но make завершается ошибкой; почему?](https://python-all.ru/3.11/faq/extending.html#id14)137138Файл Setup должен заканчиваться символом новой строки; если его нет, сборка завершается ошибкой. (Исправление требует уродливых ухищрений в shell-скриптах, и этот баг настолько незначителен, что не стоит затраченных усилий.)139140## [Как отлаживать расширение?](https://python-all.ru/3.11/faq/extending.html#id15)141142При использовании GDB с динамически загружаемыми расширениями невозможно установить точку останова в расширении до его загрузки.143144В файле `.gdbinit` (или интерактивно) добавьте команду:145146```text147br _PyImport_LoadDynamicModule148```149150Затем при запуске GDB:151152```console153$ gdb /local/bin/python154gdb) run myscript.py155gdb) continue # repeat until your extension is loaded156gdb) finish   # so that your extension is loaded157gdb) br myfunction.c:50158gdb) continue159```160161## [Хочу скомпилировать модуль Python в своей системе Linux, но не хватает некоторых файлов. Почему?](https://python-all.ru/3.11/faq/extending.html#id16)162163Большинство собранных версий Python не включают каталог `/usr/lib/python2.x/config/`, который содержит различные файлы необходимые для компиляции расширений Python.164165Для Red Hat установите пакет python-devel RPM, чтобы получить необходимые файлы.166167Для Debian выполните `apt-get install python-dev`.168169## [Как отличить «неполный ввод» от «недопустимого ввода»?](https://python-all.ru/3.11/faq/extending.html#id17)170171Иногда требуется эмулировать поведение интерактивного интерпретатора Python, где выдаётся приглашение продолжения ввода, когда ввод неполон (например, напечатано начало инструкции «if» или не закрыты скобки или тройные кавычки), но при недопустимом вводе сразу выдаётся сообщение об ошибке синтаксиса.172173В Python можно использовать модуль [`codeop`](https://python-all.ru/3.11/library/codeop.html#module-codeop), который достаточно точно воспроизводит поведение парсера. Например, так делает IDLE.174175Самый простой способ сделать это в C – вызвать [`PyRun_InteractiveLoop()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyRun_InteractiveLoop) (возможно, в отдельном потоке) и позволить интерпретатору Python обработать ввод за вас. Также можно установить [`PyOS_ReadlineFunctionPointer()`](https://python-all.ru/3.11/c-api/veryhigh.html#c.PyOS_ReadlineFunctionPointer) так, чтобы он указывал на вашу пользовательскую функцию ввода. Дополнительные подсказки см. в `Modules/readline.c` и `Parser/myreadline.c`.176177## [Как найти неопределённые символы g++ \_\_builtin\_new или \_\_pure\_virtual?](https://python-all.ru/3.11/faq/extending.html#id18)178179Для динамической загрузки модулей расширения g++ необходимо перекомпилировать Python, перекомпоновать его с помощью g++ (измените LINKCC в Makefile модулей Python) и скомпоновать модуль расширения с помощью g++ (например, `g++ -shared -o mymodule.so mymodule.o`).180181## [Можно ли создать класс объектов, в котором одни методы реализованы на C, а другие – на Python (например, через наследование)?](https://python-all.ru/3.11/faq/extending.html#id19)182183Да, можно наследовать от встроенных классов, таких как [`int`](https://python-all.ru/3.11/library/functions.html#int), [`list`](https://python-all.ru/3.11/library/stdtypes.html#list), [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict) и т.д.184185Библиотека Boost Python (BPL, [https://www.boost.org/libs/python/doc/index.html](https://python-all.ru/3.11/faq/extending.html)) предоставляет способ сделать это из C++ (т.е. можно наследовать от класса расширения, написанного на C++, с помощью BPL).186