embedding.md
1> **Источник:** https://python-all.ru/3.9/extending/embedding.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 1. Встраивание Python в другое приложение89В предыдущих главах обсуждалось, как расширять Python, то есть как расширить функциональность Python, подключая к нему библиотеку на C. Также можно сделать наоборот: обогатить своё приложение на C/C++ путём встраивания в него Python. Встраивание даёт вашему приложению возможность реализовать часть функциональности приложения на Python, а не на C или C++. Это можно использовать для многих целей; один из примеров – позволить пользователям настраивать приложение под свои нужды, написав несколько скриптов на Python. Вы также можете использовать это сами, если какую-то функциональность проще написать на Python более легко.1011Разница в том, что при расширении Python главная программа приложения остаётся интерпретатором Python, тогда как при встраивании Python главная программа может не иметь ничего общего с Python – вместо этого некоторые части приложения время от времени вызывают интерпретатор Python для выполнения некоторого кода на Python.1213Итак, если вы встраиваете Python, вы предоставляете собственную главную программу. Одна из задач этой главной программы – инициализировать интерпретатор Python. Как минимум, необходимо вызвать функцию [`Py_Initialize()`](https://python-all.ru/3.9/c-api/init.html#c.Py_Initialize). Существуют необязательные вызовы для передачи аргументов командной строки Python. Затем позже можно вызывать интерпретатор из любой части приложения.1415Существует несколько различных способов вызова интерпретатора: можно передать строку содержащую операторы Python в [`PyRun_SimpleString()`](https://python-all.ru/3.9/c-api/veryhigh.html#c.PyRun_SimpleString), или можно передать указатель файла stdio и имя файла (только для идентификации в сообщениях об ошибках) в [`PyRun_SimpleFile()`](https://python-all.ru/3.9/c-api/veryhigh.html#c.PyRun_SimpleFile). Также можно вызывать низкоуровневые операции, описанные в предыдущих главах, для создания и использования объектов Python.1617> **См. также**18>19> **[Справочное руководство по Python/C API](https://python-all.ru/3.9/c-api/index.html#c-api-index)**20>21> Подробности C-интерфейса Python приведены в этом руководстве. Много необходимой информации можно найти здесь.2223## 1.1. Встраивание на очень высоком уровне2425Простейшая форма встраивания Python – использование интерфейса сверхвысокого уровня. Этот интерфейс предназначен для выполнения Python-скрипта без необходимости взаимодействовать с приложением напрямую. Его можно использовать, например, для выполнения некоторой операции над файлом.2627```c28#define PY_SSIZE_T_CLEAN29#include <Python.h>3031int32main(int argc, char *argv[])33{34 wchar_t *program = Py_DecodeLocale(argv[0], NULL);35 if (program == NULL) {36 fprintf(stderr, "Fatal error: cannot decode argv[0]\n");37 exit(1);38 }39 Py_SetProgramName(program); /* опционально, но рекомендуется */40 Py_Initialize();41 PyRun_SimpleString("from time import time,ctime\n"42 "print('Today is', ctime(time()))\n");43 if (Py_FinalizeEx() < 0) {44 exit(120);45 }46 PyMem_RawFree(program);47 return 0;48}49```5051Функция [`Py_SetProgramName()`](https://python-all.ru/3.9/c-api/init.html#c.Py_SetProgramName) должна вызываться до [`Py_Initialize()`](https://python-all.ru/3.9/c-api/init.html#c.Py_Initialize), чтобы сообщить интерпретатору пути к библиотекам времени выполнения Python. Затем инициализируется интерпретатор Python с помощью [`Py_Initialize()`](https://python-all.ru/3.9/c-api/init.html#c.Py_Initialize), после чего выполняется жёстко заданный скрипт Python, который выводит дату и время. После этого вызов [`Py_FinalizeEx()`](https://python-all.ru/3.9/c-api/init.html#c.Py_FinalizeEx) завершает работу интерпретатора, и программа заканчивается. В реальной программе можно получать скрипт Python из другого источника, например, из редактора текста, файла или базы данных. Получение кода Python из файла лучше выполнять с помощью функции [`PyRun_SimpleFile()`](https://python-all.ru/3.9/c-api/veryhigh.html#c.PyRun_SimpleFile), которая избавляет от необходимости выделять память и загружать содержимое файла.5253## 1.2. За пределами очень высокого уровня: обзор5455Высокоуровневый интерфейс позволяет выполнять произвольные фрагменты Python-кода из вашего приложения, но обмен значениями данных – как минимум весьма затруднителен. Если это необходимо, следует использовать низкоуровневые вызовы. Ценой написания большего количества кода на C можно достичь почти всего.5657Следует отметить, что расширение Python и встраивание Python – по сути одно и то же действие, несмотря на разные цели. Большинство тем, рассмотренных в предыдущих главах, остаются актуальными. Чтобы показать это, рассмотрим, что на самом деле делает код расширения от Python к C:58591. Преобразование значений данных из Python в C,602. Вызов функции C с использованием преобразованных значений и613. Преобразование значений данных из вызова из C в Python.6263При встраивании Python код интерфейса делает:64651. Преобразование значений данных из C в Python,662. Вызов функции интерфейса Python с использованием преобразованных значений и673. Преобразование значений данных из вызова из Python в C.6869Как видите, шаги преобразования данных просто меняются местами для соответствия разному направлению межъязыковой передачи. Единственное отличие – это функция, которую вызывают между двумя преобразованиями данных. При расширении вызывается C-функция, при встраивании – Python-функция.7071В этой главе не будет обсуждаться преобразование данных из Python в C и обратно. Также предполагается, что правильное использование ссылок и обработка ошибок понятны. Поскольку эти аспекты не отличаются от расширения интерпретатора, необходимые сведения можно найти в предыдущих главах.7273## 1.3. Чистое встраивание7475Первая программа предназначена для выполнения функции из скрипта Python. Как и в разделе об интерфейсе очень высокого уровня, интерпретатор Python не взаимодействует напрямую с приложением (но это изменится в следующем разделе).7677Код для выполнения функции, определённой в скрипте Python:7879```c80#define PY_SSIZE_T_CLEAN81#include <Python.h>8283int84main(int argc, char *argv[])85{86 PyObject *pName, *pModule, *pFunc;87 PyObject *pArgs, *pValue;88 int i;8990 if (argc < 3) {91 fprintf(stderr,"Usage: call pythonfile funcname [args]\n");92 return 1;93 }9495 Py_Initialize();96 pName = PyUnicode_DecodeFSDefault(argv[1]);97 /* Проверка ошибок pName опущена */9899 pModule = PyImport_Import(pName);100 Py_DECREF(pName);101102 if (pModule != NULL) {103 pFunc = PyObject_GetAttrString(pModule, argv[2]);104 /* pFunc – новая ссылка */105106 if (pFunc && PyCallable_Check(pFunc)) {107 pArgs = PyTuple_New(argc - 3);108 for (i = 0; i < argc - 3; ++i) {109 pValue = PyLong_FromLong(atoi(argv[i + 3]));110 if (!pValue) {111 Py_DECREF(pArgs);112 Py_DECREF(pModule);113 fprintf(stderr, "Cannot convert argument\n");114 return 1;115 }116 /* Ссылка pValue перехвачена здесь: */117 PyTuple_SetItem(pArgs, i, pValue);118 }119 pValue = PyObject_CallObject(pFunc, pArgs);120 Py_DECREF(pArgs);121 if (pValue != NULL) {122 printf("Result of call: %ld\n", PyLong_AsLong(pValue));123 Py_DECREF(pValue);124 }125 else {126 Py_DECREF(pFunc);127 Py_DECREF(pModule);128 PyErr_Print();129 fprintf(stderr,"Call failed\n");130 return 1;131 }132 }133 else {134 if (PyErr_Occurred())135 PyErr_Print();136 fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);137 }138 Py_XDECREF(pFunc);139 Py_DECREF(pModule);140 }141 else {142 PyErr_Print();143 fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);144 return 1;145 }146 if (Py_FinalizeEx() < 0) {147 return 120;148 }149 return 0;150}151```152153Этот код загружает скрипт Python с помощью `argv[1]` и вызывает функцию с именем из `argv[2]`. Его целочисленные аргументы – это остальные значения массива `argv`. Если [скомпилировать и собрать](https://python-all.ru/3.9/extending/embedding.html#compiling) эту программу (назовём готовый исполняемый файл **call**) и использовать её для выполнения скрипта Python, например:154155```python156def multiply(a,b):157 print("Will compute", a, "times", b)158 c = 0159 for i in range(0, a):160 c = c + b161 return c162```163164то результат будет следующим:165166```console167$ call multiply multiply 3 2168Will compute 3 times 2169Result of call: 6170```171172Хотя программа довольно велика для своей функциональности, большая часть кода отвечает за преобразование данных между Python и C и за сообщения об ошибках. Интересная часть, касающаяся встраивания Python, начинается с173174```c175Py_Initialize();176pName = PyUnicode_DecodeFSDefault(argv[1]);177/* Проверка ошибок pName опущена */178pModule = PyImport_Import(pName);179```180181После инициализации интерпретатора скрипт загружается с помощью [`PyImport_Import()`](https://python-all.ru/3.9/c-api/import.html#c.PyImport_Import). Эта функция требует в качестве аргумента строку Python, которая создаётся с помощью подпрограммы преобразования данных [`PyUnicode_FromString()`](https://python-all.ru/3.9/c-api/unicode.html#c.PyUnicode_FromString).182183```c184pFunc = PyObject_GetAttrString(pModule, argv[2]);185/* pFunc – новая ссылка */186187if (pFunc && PyCallable_Check(pFunc)) {188 ...189}190Py_XDECREF(pFunc);191```192193После загрузки скрипта искомое имя извлекается с помощью [`PyObject_GetAttrString()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_GetAttrString). Если имя существует и возвращённый объект является вызываемым, можно с уверенностью считать, что это функция. Затем программа обычным образом создаёт кортеж аргументов. После этого выполняется вызов функции Python с помощью:194195```c196pValue = PyObject_CallObject(pFunc, pArgs);197```198199После возврата из функции `pValue` либо равен `NULL`, либо содержит ссылку на возвращаемое значение функции. После проверки значения ссылку необходимо освободить.200201## 1.4. Расширение встроенного Python202203До сих пор встроенный интерпретатор Python не имел доступа к функциональности самого приложения. API Python позволяет это сделать, расширяя встроенный интерпретатор. То есть встроенный интерпретатор дополняется процедурами, предоставляемыми приложением. Хотя это звучит сложно, на самом деле всё не так плохо. Просто нужно на время забыть, что приложение запускает интерпретатор Python. Вместо этого следует рассматривать приложение как набор подпрограмм и написать связующий код, который даёт Python доступ к этим подпрограммам, точно так же, как пишется обычное расширение Python. Например:204205```c206static int numargs=0;207208/* Возвращает количество аргументов командной строки приложения */209static PyObject*210emb_numargs(PyObject *self, PyObject *args)211{212 if(!PyArg_ParseTuple(args, ":numargs"))213 return NULL;214 return PyLong_FromLong(numargs);215}216217static PyMethodDef EmbMethods[] = {218 {"numargs", emb_numargs, METH_VARARGS,219 "Return the number of arguments received by the process."},220 {NULL, NULL, 0, NULL}221};222223static PyModuleDef EmbModule = {224 PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,225 NULL, NULL, NULL, NULL226};227228static PyObject*229PyInit_emb(void)230{231 return PyModule_Create(&EmbModule);232}233```234235Вставьте приведённый выше код непосредственно перед функцией `main()`. Также вставьте следующие два оператора перед вызовом [`Py_Initialize()`](https://python-all.ru/3.9/c-api/init.html#c.Py_Initialize):236237```c238numargs = argc;239PyImport_AppendInittab("emb", &PyInit_emb);240```241242Эти две строки инициализируют переменную `numargs` и делают функцию `emb.numargs()` доступной для встроенного интерпретатора Python. С такими расширениями скрипт Python может делать следующее:243244```python245import emb246print("Number of arguments", emb.numargs())247```248249В реальном приложении методы будут предоставлять Python API приложения.250251## 1.5. Встраивание Python в C++252253Также возможно встроить Python в программу на C++; точный способ зависит от деталей используемой системы C++; в общем случае нужно написать основную программу на C++ и использовать компилятор C++ для компиляции и сборки программы. Нет необходимости перекомпилировать сам Python с помощью C++.254255## 1.6. Компиляция и компоновка в Unix-подобных системах256257Найти правильные флаги для передачи компилятору (и компоновщику) для встраивания интерпретатора Python в приложение – задача не всегда тривиальная, особенно потому что Python должен загружать библиотечные модули, реализованные в виде динамических расширений C (файлы `.so`), слинкованных с ним.258259Чтобы узнать необходимые флаги компилятора и компоновщика, можно выполнить скрипт `pythonX.Y-config`, который создаётся в процессе установки (также может быть доступен скрипт `python3-config`). У этого скрипта есть несколько опций, из которых следующие будут непосредственно полезны:260261- `pythonX.Y-config --cflags` выдаст рекомендуемые флаги при компиляции:262263 ```console264 $ /opt/bin/python3.4-config --cflags265 -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes266 ```267- `pythonX.Y-config --ldflags` выдаст рекомендуемые флаги при компоновке:268269 ```console270 $ /opt/bin/python3.4-config --ldflags271 -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic272 ```273274> **Примечание**275>276> Чтобы избежать путаницы между несколькими установками Python (и особенно между системным Python и собственноручно скомпилированным Python), рекомендуется использовать абсолютный путь к `pythonX.Y-config`, как в примере выше.277278Если эта процедура не работает (она не гарантирует работу на всех Unix-подобных платформах; однако мы [приветствуем сообщения об ошибках](https://python-all.ru/3.9/bugs.html#reporting-bugs)), то придётся прочитать документацию вашей системы о динамической компоновке и/или изучить файл `Makefile` Python (используйте [`sysconfig.get_makefile_filename()`](https://python-all.ru/3.9/library/sysconfig.html#sysconfig.get_makefile_filename), чтобы найти его расположение) и параметры компиляции. В этом случае модуль [`sysconfig`](https://python-all.ru/3.9/library/sysconfig.html#module-sysconfig) – полезный инструмент для программного извлечения значений конфигурации, которые нужно скомбинировать. Например:279280```pycon281>>> import sysconfig282>>> sysconfig.get_config_var('LIBS')283'-lpthread -ldl -lutil'284>>> sysconfig.get_config_var('LINKFORSHARED')285'-Xlinker -export-dynamic'286```287