编程语言
首页 > 编程语言> > 在C中嵌入Python并从C代码调用方法

在C中嵌入Python并从C代码调用方法

作者:互联网

我尝试将Python脚本嵌入到我的C程序中.在阅读了有关嵌入和扩展的一些内容之后,我了解了如何打开自己的python脚本以及如何将一些整数传递给它.但现在我有点不明白如何解决我的问题.我必须做两件事,从C调用Python函数并从我的嵌入式Python脚本调用C函数.但我不知道从哪里开始.我知道我必须编译一个.so文件来将我的C函数暴露给Python,但这不是我能做的,因为我必须嵌入我的Python文件并使用C代码控制它(我必须用一个扩展一个大的软件脚本语言,使一些逻辑易于编辑).

那么,有什么方法可以做这两件事吗?从C调用Python函数并从Python调用C函数?

这是我的C代码

#include <Python.h>
#include <boost/python.hpp>
using namespace boost::python;


// <----------I want to use this struct in my python file---------
struct World
{
    void set(std::string msg) { this->msg = msg; }
    std::string greet() { return msg; }
    std::string msg;
};


// Exposing the function like its explained in the boost.python manual
// but this needs to be compiled to a .so to be read from the multiply.py
BOOST_PYTHON_MODULE(hello)
{
    class_<World>("World")
        .def("greet", &World::greet)
        .def("set", &World::set)
    ;
}
// <---------------------------------------------------------------


int
main(int argc, char *argv[]) // in the main function is only code for embedding the python file, its not relevant to this question
{
    setenv("PYTHONPATH",".",1);
    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;
}

这是我的Python文件

import hello_ext #importing the C++ file works only if its compiled as a .so
planet = hello.World() #this class should be exposed to python
planet.set('foo')

def multiply(a,b):
    planet.greet()
    print "Will compute", a, "times", b
    c = 0
    for i in range(0, a):
        c = c + b
    return c

解决方法:

简而言之,与嵌入式Python静态链接的Python扩展需要在初始化解释器之前将其模块初始化函数显式添加到初始化表中.

PyImport_AppendInittab("hello", &inithello);
Py_Initialize();

Boost.Python使用BOOST_PYTHON_MODULE宏来定义Python模块初始化程序.生成的函数不是模块导入程序.这种差异类似于创建example.py模块和调用导入示例的差异.

导入模块时,Python将首先检查模块是否为内置模块.如果模块不存在,则Python将搜索module search path,尝试根据模块名称查找python文件或库.如果找到了库,那么Python期望库提供一个初始化模块的函数.找到后,导入将在模块表中创建一个空模块,然后对其进行初始化.对于静态链接的模块,例如原始代码中的hello,模块搜索路径将没有用,因为没有库可供查找.

对于嵌入,module table and initialization function文档声明对于静态模块,除非初始化表中有条目,否则不会自动调用模块初始化函数.对于Python 2和Python 3,可以通过在Py_Initialize()之前调用PyImport_AppendInittab()来实现此目的:

BOOST_PYTHON_MODULE(hello)
{
  // ...
}

PyImport_AppendInittab("hello", &inithello);
Py_Initialize();
// ...
boost::python::object hello = boost::python::import("hello");

另请注意,Python的C API用于在Python 2和3之间嵌入模块初始化函数的更改命名约定,因此对于BOOST_PYTHON_MODULE(hello),可能需要使用& inithello用于Python 2和& PyInit_hello用于Python 3.

这是一个完整的示例demonstrating,其中嵌入了Python导入演示用户模块,然后将导入静态链接的hello模块.它还在用户模块demo.multiply中调用一个函数,然后调用通过静态链接模块公开的方法.

#include <cstdlib>  // setenv, atoi
#include <iostream> // cerr, cout, endl
#include <boost/python.hpp>

struct World
{
  void set(std::string msg) { this->msg = msg; }
  std::string greet()       { return msg;      }
  std::string msg;
};

/// Staticly linking a Python extension for embedded Python.
BOOST_PYTHON_MODULE(hello)
{
  namespace python = boost::python;
  python::class_<World>("World")
    .def("greet", &World::greet)
    .def("set", &World::set)
    ;
}

int main(int argc, char *argv[])
{
  if (argc < 3)
  {
    std::cerr << "Usage: call pythonfile funcname [args]" << std::endl;
    return 1;
  }
  char* module_name   = argv[1];
  char* function_name = argv[2];

  // Explicitly add initializers for staticly linked modules.
  PyImport_AppendInittab("hello", &inithello);

  // Initialize Python.
  setenv("PYTHONPATH", ".", 1);
  Py_Initialize();

  namespace python = boost::python;
  try
  {
    // Convert remaining args into a Python list of integers.
    python::list args;
    for (int i=3; i < argc; ++i)
    {
      args.append(std::atoi(argv[i]));
    }

    // Import the user requested module.
    // >>> import module
    python::object module = python::import(module_name);

    // Invoke the user requested function with the provided arguments.
    // >>> result = module.fn(*args)
    python::object result = module.attr(function_name)(*python::tuple(args));

    // Print the result.
    std::cout << python::extract<int>(result)() << std::endl;
  }
  catch (const python::error_already_set&)
  {
    PyErr_Print();
    return 1;
  }

  // Do not call Py_Finalize() with Boost.Python.
}

demo.py的内容:

import hello
planet = hello.World()
planet.set('foo')

def multiply(a,b):
    print planet.greet()
    print "Will compute", a, "times", b
    c = 0
    for i in range(0, a):
        c = c + b
    return c

用法:

$./a.out demo multiply 21 2
foo
Will compute 21 times 2
42

在上面的代码中,我选择使用Boost.Python而不是Python / C API,使用等效的Python代码注释C注释.我发现它更简洁,更不容易出错.如果发生Python错误,Boost.Python将抛出异常,并且将适当地处理所有引用计数.

此外,使用Boost.Python时,请不要调用Py_Finalize().根据Embedding – Getting started部分:

Note that at this time you must not call Py_Finalize() to stop the interpreter. This may be fixed in a future version of boost.python.

标签:boost-python,python,c
来源: https://codeday.me/bug/20191001/1838386.html