Вызов метода python из C/C++ и извлечение его возвращаемого значения
Я хотел бы вызвать пользовательскую функцию, которая определена в модуле Python из C. У меня есть некоторый предварительный код, чтобы сделать это, но он просто печатает вывод в stdout.
mytest.py
import math
def myabs(x):
return math.fabs(x)
test.cpp
#include <Python.h>
int main() {
Py_Initialize();
PyRun_SimpleString("import sys; sys.path.append('.')");
PyRun_SimpleString("import mytest;");
PyRun_SimpleString("print mytest.myabs(2.0)");
Py_Finalize();
return 0;
}
Как я могу извлечь возвращаемое значение в C двойной и использовать его в C?
10 ответов
Как объяснялось ранее, использование PyRun_SimpleString кажется плохой идеей.
Вам определенно следует использовать методы, предоставляемые C-API ( http://docs.python.org/c-api/).
Чтение введения - это первое, что нужно сделать, чтобы понять, как это работает.
Во-первых, вы должны узнать о PyObject, который является базовым объектом для C API. Он может представлять любые базовые типы Python (string, float, int,...).
Существует множество функций для преобразования, например, строки python в char * или PyFloat в double.
Сначала импортируйте ваш модуль:
PyObject* myModuleString = PyString_FromString((char*)"mytest");
PyObject* myModule = PyImport_Import(myModuleString);
Затем получите ссылку на вашу функцию:
PyObject* myFunction = PyObject_GetAttrString(myModule,(char*)"myabs");
PyObject* args = PyTuple_Pack(1,PyFloat_FromDouble(2.0));
Тогда получите свой результат:
PyObject* myResult = PyObject_CallObject(myFunction, args)
И возвращаясь к двойному:
double result = PyFloat_AsDouble(myResult);
Очевидно, вы должны проверить ошибки (см. Ссылку, предоставленную Марком Толоненом).
Если у вас есть какие-либо вопросы, не стесняйтесь. Удачи.
Вот пример кода, который я написал (с помощью различных онлайн-источников), чтобы отправить строку в код Python, а затем вернуть значение.
Вот код C call_function.c
:
#include <Python.h>
#include <stdlib.h>
int main()
{
// Set PYTHONPATH TO working directory
setenv("PYTHONPATH",".",1);
PyObject *pName, *pModule, *pDict, *pFunc, *pValue, *presult;
// Initialize the Python Interpreter
Py_Initialize();
// Build the name object
pName = PyString_FromString((char*)"arbName");
// Load the module object
pModule = PyImport_Import(pName);
// pDict is a borrowed reference
pDict = PyModule_GetDict(pModule);
// pFunc is also a borrowed reference
pFunc = PyDict_GetItemString(pDict, (char*)"someFunction");
if (PyCallable_Check(pFunc))
{
pValue=Py_BuildValue("(z)",(char*)"something");
PyErr_Print();
printf("Let's give this a shot!\n");
presult=PyObject_CallObject(pFunc,pValue);
PyErr_Print();
} else
{
PyErr_Print();
}
printf("Result is %d\n",PyInt_AsLong(presult));
Py_DECREF(pValue);
// Clean up
Py_DECREF(pModule);
Py_DECREF(pName);
// Finish the Python Interpreter
Py_Finalize();
return 0;
}
Вот код Python, в файле arbName.py
:
def someFunction(text):
print 'You passed this Python program '+text+' from C! Congratulations!'
return 12345
Я использую команду gcc call_function.c -I/usr/include/python2.6 -lpython2.6 ; ./a.out
запустить этот процесс. Я на Redhat. Я рекомендую использовать PyErr_Print(); для проверки ошибок.
Полный пример вызова функции Python и получения результата находится по адресу http://docs.python.org/release/2.6.5/extending/embedding.html:
#include <Python.h>
int
main(int argc, char *argv[])
{
PyObject *pName, *pModule, *pDict, *pFunc;
PyObject *pArgs, *pValue;
int i;
if (argc < 3) {
fprintf(stderr,"Usage: call pythonfile funcname [args]\n");
return 1;
}
Py_Initialize();
pName = PyString_FromString(argv[1]);
/* Error checking of pName left out */
pModule = PyImport_Import(pName);
Py_DECREF(pName);
if (pModule != NULL) {
pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc is a new reference */
if (pFunc && PyCallable_Check(pFunc)) {
pArgs = PyTuple_New(argc - 3);
for (i = 0; i < argc - 3; ++i) {
pValue = PyInt_FromLong(atoi(argv[i + 3]));
if (!pValue) {
Py_DECREF(pArgs);
Py_DECREF(pModule);
fprintf(stderr, "Cannot convert argument\n");
return 1;
}
/* pValue reference stolen here: */
PyTuple_SetItem(pArgs, i, pValue);
}
pValue = PyObject_CallObject(pFunc, pArgs);
Py_DECREF(pArgs);
if (pValue != NULL) {
printf("Result of call: %ld\n", PyInt_AsLong(pValue));
Py_DECREF(pValue);
}
else {
Py_DECREF(pFunc);
Py_DECREF(pModule);
PyErr_Print();
fprintf(stderr,"Call failed\n");
return 1;
}
}
else {
if (PyErr_Occurred())
PyErr_Print();
fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
}
Py_XDECREF(pFunc);
Py_DECREF(pModule);
}
else {
PyErr_Print();
fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
return 1;
}
Py_Finalize();
return 0;
}
Чтобы предотвратить лишний.py файл, как в других ответах, вы можете просто получить __main__
модуль, который создается при первом вызове PyRun_SimpleString
:
PyObject *moduleMainString = PyString_FromString("__main__");
PyObject *moduleMain = PyImport_Import(moduleMainString);
PyRun_SimpleString(
"def mul(a, b): \n"\
" return a * b \n"\
);
PyObject *func = PyObject_GetAttrString(moduleMain, "mul");
PyObject *args = PyTuple_Pack(2, PyFloat_FromDouble(3.0), PyFloat_FromDouble(4.0));
PyObject *result = PyObject_CallObject(func, args);
printf("mul(3,4): %.2f\n", PyFloat_AsDouble(result)); // 12
Как уже упоминалось, на это есть ответ в документации по Python. Однако, поскольку я пришел из Python и не имею такого большого опыта использования C/C++, у меня были некоторые проблемы с его запуском с Python 3. Итак, вот мой полный рабочий пример, чтобы запустить документы Python после того, как я потратил некоторое время на другие сообщения. переполнения стека:
Файл
c_function.c
#define PY_SSIZE_T_CLEAN
#include <Python.h>
int main(int argc, char *argv[])
{
PyObject *pName, *pModule, *pFunc;
PyObject *pArgs, *pValue;
int i;
if (argc < 3) {
fprintf(stderr,"Usage: call pythonfile funcname [args]\n");
return 1;
}
Py_Initialize();
// I had to add the following two lines to make it work
PyRun_SimpleString("import sys");
PyRun_SimpleString("sys.path.append(\".\")");
pName = PyUnicode_DecodeFSDefault(argv[1]);
/* Error checking of pName left out */
pModule = PyImport_Import(pName);
Py_DECREF(pName);
if (pModule != NULL) {
pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc is a new reference */
if (pFunc && PyCallable_Check(pFunc)) {
pArgs = PyTuple_New(argc - 3);
for (i = 0; i < argc - 3; ++i) {
pValue = PyLong_FromLong(atoi(argv[i + 3]));
if (!pValue) {
Py_DECREF(pArgs);
Py_DECREF(pModule);
fprintf(stderr, "Cannot convert argument\n");
return 1;
}
/* pValue reference stolen here: */
PyTuple_SetItem(pArgs, i, pValue);
}
pValue = PyObject_CallObject(pFunc, pArgs);
Py_DECREF(pArgs);
if (pValue != NULL) {
printf("Result of call: %ld\n", PyLong_AsLong(pValue));
Py_DECREF(pValue);
}
else {
Py_DECREF(pFunc);
Py_DECREF(pModule);
PyErr_Print();
fprintf(stderr,"Call failed\n");
return 1;
}
}
else {
if (PyErr_Occurred())
PyErr_Print();
fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
}
Py_XDECREF(pFunc);
Py_DECREF(pModule);
}
else {
PyErr_Print();
fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
return 1;
}
if (Py_FinalizeEx() < 0) {
return 120;
}
return 0;
}
Файл
multiply.py
def multiply(a,b):
print("Will compute", a, "times", b)
c = 0
for i in range(0, a):
c = c + b
return c
Нам нужно скомпилировать и связать его. Это можно сделать с помощью команды:
gcc c_function.c -c $(python3.6-config --cflags) -fPIC
с последующим
gcc c_function.o $(python3.6-config --ldflags) -o call
на примере Python 3.6. После этого пример из документов Python можно просто выполнить с помощью
./call multiply multiply 3 2
Я сделал это, используя BOOST для встраивания Python в C++ [Этот рабочий модуль C должен помочь]
#include <boost/python.hpp>
void main()
{
using namespace boost::python;
Py_Initialize();
PyObject* filename = PyString_FromString((char*)"memory_leak_test");
PyObject* imp = PyImport_Import(filename);
PyObject* func = PyObject_GetAttrString(imp,(char*)"begin");
PyObject* args = PyTuple_Pack(1,PyString_FromString("CacheSetup"));
PyObject* retured_value = PyObject_CallObject(func, args); // if you have arg
double retured_value = PyFloat_AsDouble(myResult);
std::cout << result << std::endl;
Py_Finalize();
}
Вы должны как-то извлечь метод python и запустить его с PyObject_CallObject()
, Чтобы сделать это, вы можете предоставить Python способ установки функции, как в примере с учебником по расширению и встраиванию Python.
Если вы присваиваете возвращаемое значение переменной, то вы можете использовать что-то вроде PyEval_GetGlobals() и PyDict_GetItemString() для получения PyObject. Оттуда PyNumber_Float может получить желаемое значение.
Я предлагаю просмотреть весь API -интерфейс - некоторые вещи становятся очевидными, когда вы видите различные доступные вам методы, и вполне может оказаться, что метод лучше, чем тот, который я описал.
Вот минимальная исполняемая версия, которая также работает с Python 3 (протестирована с Python 2.7 и 3.9).
Ссылки на документы включены в комментарии, но все они доступны по адресу https://docs.python.org/3/c-api/.
#include <Python.h>
#include <stdio.h>
int main()
{
// Initialize the Python Interpreter
Py_Initialize();
// see https://docs.python.org/3/c-api/structures.html
// NULL objects are special and Py_CLEAR knows this
PyObject *module = NULL, *result = NULL;
// https://docs.python.org/3/c-api/import.html
module = PyImport_ImportModule("mytest");
if (!module) {
// Python generally uses exceptions to indicate an error state which
// gets flagged in the C-API (a NULL pointer in this case) indicating
// "something" failed. the PyErr_* API should be used to get more
// details
goto done;
}
// see https://docs.python.org/3/c-api/call.html#c.PyObject_CallMethod
// and https://docs.python.org/3/c-api/arg.html#building-values
result = PyObject_CallMethod(module, "myabs", "f", 3.14);
if (!result) {
goto done;
}
// make sure we got our number back
if (PyFloat_Check(result)) {
printf("Successfully got a float: %f\n", PyFloat_AsDouble(result));
} else {
printf("Successfully got something unexpected!\n");
}
done:
// see https://docs.python.org/3/c-api/exceptions.html
PyErr_Print();
// see https://docs.python.org/3/c-api/refcounting.html
Py_CLEAR(result);
Py_CLEAR(module);
// Optionally release Python Interpreter
Py_Finalize();
return 0;
}
Это использует код Python OP
mytest.py
, или этот однострочный эквивалент:
from math import fabs as myabs
Сборка будет зависеть от версии ОС / Python, но для меня работает следующее:
cc -o test -I/usr/include/python3.9 /usr/lib/libpython3.9.so test.c
Вот простой и прямой ответ на ваш вопрос:
#include <iostream>
#include <Python.h>
using namespace std;
int main()
{
const char *scriptDirectoryName = "/yourDir";
Py_Initialize();
PyObject *sysPath = PySys_GetObject("path");
PyObject *path = PyString_FromString(scriptDirectoryName);
int result = PyList_Insert(sysPath, 0, path);
PyObject *pModule = PyImport_ImportModule("mytest");
PyObject* myFunction = PyObject_GetAttrString(pModule,(char*)"myabs");
PyObject* args = PyTuple_Pack(1,PyFloat_FromDouble(-2.0));
PyObject* myResult = PyObject_CallObject(myFunction, args);
double getResult = PyFloat_AsDouble(myResult);
return 0;
}