embedding.md
1> **Источник:** https://python-all.ru/3.6/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.6/c-api/init.html#c.Py_Initialize). Существуют необязательные вызовы для передачи аргументов командной строки Python. Затем позже можно вызывать интерпретатор из любой части приложения.1415Существует несколько различных способов вызова интерпретатора: можно передать строку содержащую операторы Python в [`PyRun_SimpleString()`](https://python-all.ru/3.6/c-api/veryhigh.html#c.PyRun_SimpleString), или можно передать указатель файла stdio и имя файла (только для идентификации в сообщениях об ошибках) в [`PyRun_SimpleFile()`](https://python-all.ru/3.6/c-api/veryhigh.html#c.PyRun_SimpleFile). Также можно вызывать низкоуровневые операции, описанные в предыдущих главах, для создания и использования объектов Python.1617> **См. также**18>19> **[Справочное руководство по Python/C API](https://python-all.ru/3.6/c-api/index.html#c-api-index)**20>21> Подробности C-интерфейса Python приведены в этом руководстве. Много необходимой информации можно найти здесь.2223## 1.1. Встраивание на очень высоком уровне2425Простейшая форма встраивания Python – использование интерфейса сверхвысокого уровня. Этот интерфейс предназначен для выполнения Python-скрипта без необходимости взаимодействовать с приложением напрямую. Его можно использовать, например, для выполнения некоторой операции над файлом.2627```c28#include <Python.h>2930int31main(int argc, char *argv[])32{33 wchar_t *program = Py_DecodeLocale(argv[0], NULL);34 if (program == NULL) {35 fprintf(stderr, "Fatal error: cannot decode argv[0]\n");36 exit(1);37 }38 Py_SetProgramName(program); /* опционально, но рекомендуется */39 Py_Initialize();40 PyRun_SimpleString("from time import time,ctime\n"41 "print('Today is', ctime(time()))\n");42 if (Py_FinalizeEx() < 0) {43 exit(120);44 }45 PyMem_RawFree(program);46 return 0;47}48```4950Функция [`Py_SetProgramName()`](https://python-all.ru/3.6/c-api/init.html#c.Py_SetProgramName) должна вызываться до [`Py_Initialize()`](https://python-all.ru/3.6/c-api/init.html#c.Py_Initialize), чтобы сообщить интерпретатору пути к библиотекам времени выполнения Python. Затем инициализируется интерпретатор Python с помощью [`Py_Initialize()`](https://python-all.ru/3.6/c-api/init.html#c.Py_Initialize), после чего выполняется жёстко заданный скрипт Python, который выводит дату и время. После этого вызов [`Py_FinalizeEx()`](https://python-all.ru/3.6/c-api/init.html#c.Py_FinalizeEx) завершает работу интерпретатора, и программа заканчивается. В реальной программе можно получать скрипт Python из другого источника, например, из редактора текста, файла или базы данных. Получение кода Python из файла лучше выполнять с помощью функции [`PyRun_SimpleFile()`](https://python-all.ru/3.6/c-api/veryhigh.html#c.PyRun_SimpleFile), которая избавляет от необходимости выделять память и загружать содержимое файла.5152## 1.2. За пределами очень высокого уровня: обзор5354Высокоуровневый интерфейс позволяет выполнять произвольные фрагменты Python-кода из вашего приложения, но обмен значениями данных – как минимум весьма затруднителен. Если это необходимо, следует использовать низкоуровневые вызовы. Ценой написания большего количества кода на C можно достичь почти всего.5556Следует отметить, что расширение Python и встраивание Python – по сути одно и то же действие, несмотря на разные цели. Большинство тем, рассмотренных в предыдущих главах, остаются актуальными. Чтобы показать это, рассмотрим, что на самом деле делает код расширения от Python к C:57581. Преобразование значений данных из Python в C,592. Вызов функции C с использованием преобразованных значений и603. Преобразование значений данных из вызова из C в Python.6162При встраивании Python код интерфейса делает:63641. Преобразование значений данных из C в Python,652. Вызов функции интерфейса Python с использованием преобразованных значений и663. Преобразование значений данных из вызова из Python в C.6768Как видите, шаги преобразования данных просто меняются местами для соответствия разному направлению межъязыковой передачи. Единственное отличие – это функция, которую вызывают между двумя преобразованиями данных. При расширении вызывается C-функция, при встраивании – Python-функция.6970В этой главе не будет обсуждаться преобразование данных из Python в C и обратно. Также предполагается, что правильное использование ссылок и обработка ошибок понятны. Поскольку эти аспекты не отличаются от расширения интерпретатора, необходимые сведения можно найти в предыдущих главах.7172## 1.3. Чистое встраивание7374Первая программа предназначена для выполнения функции из скрипта Python. Как и в разделе об интерфейсе очень высокого уровня, интерпретатор Python не взаимодействует напрямую с приложением (но это изменится в следующем разделе).7576Код для выполнения функции, определённой в скрипте Python:7778```c79#include <Python.h>8081int82main(int argc, char *argv[])83{84 PyObject *pName, *pModule, *pFunc;85 PyObject *pArgs, *pValue;86 int i;8788 if (argc < 3) {89 fprintf(stderr,"Usage: call pythonfile funcname [args]\n");90 return 1;91 }9293 Py_Initialize();94 pName = PyUnicode_DecodeFSDefault(argv[1]);95 /* Проверка ошибок pName опущена */9697 pModule = PyImport_Import(pName);98 Py_DECREF(pName);99100 if (pModule != NULL) {101 pFunc = PyObject_GetAttrString(pModule, argv[2]);102 /* pFunc – новая ссылка */103104 if (pFunc && PyCallable_Check(pFunc)) {105 pArgs = PyTuple_New(argc - 3);106 for (i = 0; i < argc - 3; ++i) {107 pValue = PyLong_FromLong(atoi(argv[i + 3]));108 if (!pValue) {109 Py_DECREF(pArgs);110 Py_DECREF(pModule);111 fprintf(stderr, "Cannot convert argument\n");112 return 1;113 }114 /* Ссылка pValue перехвачена здесь: */115 PyTuple_SetItem(pArgs, i, pValue);116 }117 pValue = PyObject_CallObject(pFunc, pArgs);118 Py_DECREF(pArgs);119 if (pValue != NULL) {120 printf("Result of call: %ld\n", PyLong_AsLong(pValue));121 Py_DECREF(pValue);122 }123 else {124 Py_DECREF(pFunc);125 Py_DECREF(pModule);126 PyErr_Print();127 fprintf(stderr,"Call failed\n");128 return 1;129 }130 }131 else {132 if (PyErr_Occurred())133 PyErr_Print();134 fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);135 }136 Py_XDECREF(pFunc);137 Py_DECREF(pModule);138 }139 else {140 PyErr_Print();141 fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);142 return 1;143 }144 if (Py_FinalizeEx() < 0) {145 return 120;146 }147 return 0;148}149```150151Этот код загружает скрипт Python с помощью `argv[1]` и вызывает функцию с именем из `argv[2]`. Его целочисленные аргументы – это остальные значения массива `argv`. Если [скомпилировать и собрать](https://python-all.ru/3.6/extending/embedding.html#compiling) эту программу (назовём готовый исполняемый файл **call**) и использовать её для выполнения скрипта Python, например:152153```python154def multiply(a,b):155 print("Will compute", a, "times", b)156 c = 0157 for i in range(0, a):158 c = c + b159 return c160```161162то результат будет следующим:163164```console165$ call multiply multiply 3 2166Will compute 3 times 2167Result of call: 6168```169170Хотя программа довольно велика для своей функциональности, большая часть кода отвечает за преобразование данных между Python и C и за сообщения об ошибках. Интересная часть, касающаяся встраивания Python, начинается с171172```c173Py_Initialize();174pName = PyUnicode_DecodeFSDefault(argv[1]);175/* Проверка ошибок pName опущена */176pModule = PyImport_Import(pName);177```178179После инициализации интерпретатора скрипт загружается с помощью [`PyImport_Import()`](https://python-all.ru/3.6/c-api/import.html#c.PyImport_Import). Эта функция требует в качестве аргумента строку Python, которая создаётся с помощью подпрограммы преобразования данных [`PyUnicode_FromString()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_FromString).180181```c182pFunc = PyObject_GetAttrString(pModule, argv[2]);183/* pFunc – новая ссылка */184185if (pFunc && PyCallable_Check(pFunc)) {186 ...187}188Py_XDECREF(pFunc);189```190191После загрузки скрипта искомое имя извлекается с помощью [`PyObject_GetAttrString()`](https://python-all.ru/3.6/c-api/object.html#c.PyObject_GetAttrString). Если имя существует и возвращённый объект является вызываемым, можно с уверенностью считать, что это функция. Затем программа обычным образом создаёт кортеж аргументов. После этого выполняется вызов функции Python с помощью:192193```c194pValue = PyObject_CallObject(pFunc, pArgs);195```196197После возврата функции `pValue` либо равен *NULL*, либо содержит ссылку на возвращаемое значение функции. Не забудьте освободить ссылку после проверки значения.198199## 1.4. Расширение встроенного Python200201До сих пор встроенный интерпретатор Python не имел доступа к функциональности самого приложения. API Python позволяет это сделать, расширяя встроенный интерпретатор. То есть встроенный интерпретатор дополняется процедурами, предоставляемыми приложением. Хотя это звучит сложно, на самом деле всё не так плохо. Просто нужно на время забыть, что приложение запускает интерпретатор Python. Вместо этого следует рассматривать приложение как набор подпрограмм и написать связующий код, который даёт Python доступ к этим подпрограммам, точно так же, как пишется обычное расширение Python. Например:202203```c204static int numargs=0;205206/* Возвращает количество аргументов командной строки приложения */207static PyObject*208emb_numargs(PyObject *self, PyObject *args)209{210 if(!PyArg_ParseTuple(args, ":numargs"))211 return NULL;212 return PyLong_FromLong(numargs);213}214215static PyMethodDef EmbMethods[] = {216 {"numargs", emb_numargs, METH_VARARGS,217 "Return the number of arguments received by the process."},218 {NULL, NULL, 0, NULL}219};220221static PyModuleDef EmbModule = {222 PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,223 NULL, NULL, NULL, NULL224};225226static PyObject*227PyInit_emb(void)228{229 return PyModule_Create(&EmbModule);230}231```232233Вставьте приведённый выше код непосредственно перед функцией `main()`. Также вставьте следующие два оператора перед вызовом [`Py_Initialize()`](https://python-all.ru/3.6/c-api/init.html#c.Py_Initialize):234235```c236numargs = argc;237PyImport_AppendInittab("emb", &PyInit_emb);238```239240Эти две строки инициализируют переменную `numargs` и делают функцию `emb.numargs()` доступной для встроенного интерпретатора Python. С такими расширениями скрипт Python может делать следующее:241242```python243import emb244print("Number of arguments", emb.numargs())245```246247В реальном приложении методы будут предоставлять Python API приложения.248249## 1.5. Встраивание Python в C++250251Также возможно встроить Python в программу на C++; точный способ зависит от деталей используемой системы C++; в общем случае нужно написать основную программу на C++ и использовать компилятор C++ для компиляции и сборки программы. Нет необходимости перекомпилировать сам Python с помощью C++.252253## 1.6. Компиляция и компоновка в Unix-подобных системах254255Найти правильные флаги для передачи компилятору (и компоновщику) для встраивания интерпретатора Python в приложение – задача не всегда тривиальная, особенно потому что Python должен загружать библиотечные модули, реализованные в виде динамических расширений C (файлы `.so`), слинкованных с ним.256257Чтобы узнать необходимые флаги компилятора и компоновщика, можно выполнить скрипт `pythonX.Y-config`, который создаётся в процессе установки (также может быть доступен скрипт `python3-config`). У этого скрипта есть несколько опций, из которых следующие будут непосредственно полезны:258259- `pythonX.Y-config --cflags` выдаст рекомендуемые флаги при компиляции:260261 ```console262 $ /opt/bin/python3.4-config --cflags263 -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes264 ```265- `pythonX.Y-config --ldflags` выдаст рекомендуемые флаги при компоновке:266267 ```console268 $ /opt/bin/python3.4-config --ldflags269 -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic270 ```271272> **Примечание**273>274> Чтобы избежать путаницы между несколькими установками Python (и особенно между системным Python и собственноручно скомпилированным Python), рекомендуется использовать абсолютный путь к `pythonX.Y-config`, как в примере выше.275276Если эта процедура не работает (она не гарантирует работу на всех Unix-подобных платформах; однако мы [приветствуем сообщения об ошибках](https://python-all.ru/3.6/bugs.html#reporting-bugs)), то придётся прочитать документацию вашей системы о динамической компоновке и/или изучить файл `Makefile` Python (используйте [`sysconfig.get_makefile_filename()`](https://python-all.ru/3.6/library/sysconfig.html#sysconfig.get_makefile_filename), чтобы найти его расположение) и параметры компиляции. В этом случае модуль [`sysconfig`](https://python-all.ru/3.6/library/sysconfig.html#module-sysconfig) – полезный инструмент для программного извлечения значений конфигурации, которые нужно скомбинировать. Например:277278```pycon279>>> import sysconfig280>>> sysconfig.get_config_var('LIBS')281'-lpthread -ldl -lutil'282>>> sysconfig.get_config_var('LINKFORSHARED')283'-Xlinker -export-dynamic'284```285