将C ++类实例暴露给python嵌入式解释器

时间:2011-11-22 11:19:51

标签: c++ python boost swig boost-python

我正在寻找一种将C ++类实例暴露给python嵌入式解释器的简单方法。

  • 我有一个C ++库。这个库被包装(暂时使用swig),我可以从python解释器中使用它
  • 我有一个C ++主程序,它从我的库中实现了一个Foo类并嵌入了一个python解释器

我想将我的Coo Coo世界实例暴露给python世界(并被视为Foo类)。

这是可能的,如果是这样,怎么办?

我认为这几乎与第一个答案相符: boost::python::ptr or PyInstance_New usage

我想这意味着我应该使用boost.Python来包装我的库?

我唯一的目标是在嵌入式python解释器中操作我的Coo Coo实例(不确定它是否可以使用前面的方法完成)。

希望我很清楚,谢谢你的帮助。

更新

感谢您的回答。事实上,我已经将我的Foo类暴露给python(使用swig)。

我有什么:

我的Foo课程:

class Foo{...};

我的包装库(包括Foo类)暴露给python:所以我可以启动python解释器并执行以下操作:

import my_module
foo=my_modulde.Foo()

我想要的是什么:

有一个嵌入python解释器并操纵C ++世界变量的C ++主程序。

int main(int argc, char **argv)
{
    Foo  foo;   // instanciates foo

    Py_Initialize();

    Py_Main(argc, argv); // starts the python interpreter
                         // and manipulates THE foo instance in it

    Py_Finalize();

    return 0;
}

现在更清楚了吗? :)

3 个答案:

答案 0 :(得分:17)

Boost python允许您以非常紧密集成的方式将c ++类暴露给python - 您甚至可以将它们包装起来,以便您可以从c ++派生python类,并将虚拟方法解析为python覆盖。

boost python tutorial是一个很好的起点。


<子>编辑:

您可以创建一个c ++对象并将对它的引用传递给内部python解释器,如下所示:

#include <boost/shared_ptr.hpp>
#include <boost/make_shared.hpp>
#include <boost/python.hpp>
#include <string>
#include <iostream>

namespace bp = boost::python;

struct Foo{
    Foo(){}
    Foo(std::string const& s) : m_string(s){}
    void doSomething() {
        std::cout << "Foo:" << m_string << std::endl;
    }
    std::string m_string;
};

typedef boost::shared_ptr<Foo> foo_ptr;

BOOST_PYTHON_MODULE(hello)
{
    bp::class_<Foo, foo_ptr>("Foo")
        .def("doSomething", &Foo::doSomething)
    ;
};

int main(int argc, char **argv)
{
    Py_Initialize();
    try {
        PyRun_SimpleString(
            "a_foo = None\n"
            "\n"
            "def setup(a_foo_from_cxx):\n"
            "    print 'setup called with', a_foo_from_cxx\n"
            "    global a_foo\n"
            "    a_foo = a_foo_from_cxx\n"
            "\n"
            "def run():\n"
            "    a_foo.doSomething()\n"
            "\n"
            "print 'main module loaded'\n"
        );

        foo_ptr a_cxx_foo = boost::make_shared<Foo>("c++");

        inithello();
        bp::object main = bp::object(bp::handle<>(bp::borrowed(
            PyImport_AddModule("__main__")
        )));

        // pass the reference to a_cxx_foo into python:
        bp::object setup_func = main.attr("setup");
        setup_func(a_cxx_foo);

        // now run the python 'main' function
        bp::object run_func = main.attr("run");
        run_func();
    }
    catch (bp::error_already_set) {
        PyErr_Print();
    }

    Py_Finalize();

    return 0;
}

答案 1 :(得分:2)

供参考,以下是使用pybind11

实现此目的的方法
#include <pybind11/pybind11.h>
#include <iostream>

namespace py = pybind11;

class Foo
{
public:
    Foo(const std::string &s) : s_(s) {}
    void doSomething() { std::cout << s_ << std::endl; }

private:
    std::string s_;
};

typedef std::shared_ptr<Foo> FooPtr;

PYBIND11_PLUGIN(FooModule)
{
    py::module m("FooModule");
    py::class_<Foo, FooPtr>(m, "Foo")
        .def("doSomething", &Foo::doSomething);
    return m.ptr();
}

int main(int argc, char **argv)
{
    // Create Foo instance in C++
    FooPtr foo = std::make_shared<Foo>("Hello, World!");

    // Initialize interpreter and import module defining Foo wrapper
    PyImport_AppendInittab("FooModule", PyInit_FooModule);
    Py_Initialize();
    PyRun_SimpleString("import FooModule");

    // Make Foo instance accessible in python
    py::module main = py::module::import("__main__");
    main.attr("foo") = foo;

    // Test that it works
    PyRun_SimpleString("foo.doSomething()");

    // Finalize
    Py_Finalize();
    return 0;
}

答案 2 :(得分:1)

我知道这是一个老问题,但这是一个使用SWIG的解决方案。

foo.h中:

#pragma once
#include <string>

struct Foo{
  Foo();
  Foo(std::string const& s);
  void doSomething();
  std::string m_string;
};

Foo.cpp中:

#include "foo.h"
#include <iostream>

Foo::Foo() {}

Foo::Foo(std::string const& s) : m_string(s) {}

void Foo::doSomething() {
  std::cout << "Foo:" << m_string << std::endl;
}

foo.i:

%module module
%{
  #include "foo.h"
%}

%include "std_string.i"
%include "foo.h"

生成通常的SWIG包装器和运行时

swig -python -c++ -Wall foo.i
swig -python -c++ -Wall -external-runtime runtime.h

生成包含struct Foo

的SWIG模块
g++ -fPIC -Wall -Wextra -shared -o _module.so foo_wrap.cxx foo.cpp -I/usr/include/python2.7 -lpython2.7

如果要跨多个模块共享类型信息,可以添加参数-DSWIG_TYPE_TABLE=SomeName

现在,这是如何将Foo的C ++实例传递给解释器

#include "foo.h"
#include <Python.h>
#include "runtime.h"

int main(int argc, char **argv) {
  Py_Initialize();

  PyObject* syspath = PySys_GetObject((char*)"path");
  PyObject* pName = PyString_FromString((char*) ".");
  int err = PyList_Insert(syspath, 0, pName);
  Py_DECREF(pName);

  err = PySys_SetObject((char*) "path", syspath);

  PyObject *main, *module, *pInstance, *run, *setup;

  try {
    main = PyImport_ImportModule("__main__");
    err = PyRun_SimpleString(
        "a_foo = None\n"
        "\n"
        "def setup(a_foo_from_cxx):\n"
        "    print 'setup called with', a_foo_from_cxx\n"
        "    global a_foo\n"
        "    a_foo = a_foo_from_cxx\n"
        "\n"
        "def run():\n"
        "    a_foo.doSomething()\n"
        "\n"
        "print 'main module loaded'\n");

    // Load Python module
    module = PyImport_ImportModule("module");

    swig_type_info *pTypeInfo = nullptr;
    pTypeInfo = SWIG_TypeQuery("Foo *");

    Foo* pFoo = new Foo("Hello");
    int owned = 1;
    pInstance =
        SWIG_NewPointerObj(reinterpret_cast<void*>(pFoo), pTypeInfo, owned);

    setup = PyObject_GetAttrString(main, "setup");

    PyObject* result = PyObject_CallFunctionObjArgs(setup, pInstance, NULL);
    Py_DECREF(result);

    run = PyObject_GetAttrString(main, "run");

    result = PyObject_CallFunctionObjArgs(run, NULL);
    Py_DECREF(result);
  }
  catch (...) {
    PyErr_Print();
  }

  Py_DECREF(run);
  Py_DECREF(setup);
  Py_DECREF(pInstance);
  Py_DECREF(module);
  Py_DECREF(main);

  Py_Finalize();
  return 0;
}

上述内容可以通过以下方式编译:

g++ -Wall -Wextra -I/usr/include/python2.7 main.cpp foo.cpp -o main -lpython2.7