c++ - 有选择地将函数定义添加到 python 命名空间

Question

我想控制允许从 python 代码访问哪个函数。

这里是结构，我在其中定义了一些 Python 扩展的函数：

struct Worldb
{
    void messagewindow(std::string msg) { functions.Messagewindow(msg); }
    void setnumber(int value) { publicnumber=value; }
    string getnumber() { return functions.converttostring(publicnumber); }
    int publicnumber;
};

这是代码，我将定义添加到代码中并将 Python 代码发送到编译器：

Py_Initialize();

worldb.publicnumber = 1;

bp::object main_module = bp::import("__main__");
bp::object main_namespace = main_module.attr("__dict__");


main_namespace["Worldb"] = bp::class_<Worldb>("Worldb")
    .def("messagewindow", &Worldb::messagewindow)
    .def("setnumber", &Worldb::setnumber)
    .def("getnumber", &Worldb::getnumber);

main_namespace["cpp"] = bp::ptr(&worldb);//to prevent the worldb object copied 

bp::object compileit;
try
{
     compileit = exec(
         "cpp.messagewindow(cpp.getnumber())\n"
        "cpp.setnumber(8)\n",
        main_namespace);

}
catch(bp::error_already_set &)

我可以使用 .def 轻松地将函数手动扩展到 Python 中，但我找不到任何解决方案将其放入某种“if”语句中，以检查是否允许将其添加到 Python 中。当然，我可以将每个函数放入一个唯一的命名空间中，但这远非优雅，而且我认为这也可能会浪费一些内存。

对不起我的英语不好，感谢您提供的任何建议。

标签： c++python-2.7boost-python

Answer 1

没有必要在一个语句中包含所有内容 - 链接调用的能力只是为了方便（def并且其他成员函数返回对它们被调用的实例的引用以让这种情况发生）。

如果我们分析语句

main_namespace["Worldb"] = bp::class_<Worldb>("Worldb")
    .def("messagewindow", &Worldb::messagewindow)
    .def("setnumber", &Worldb::setnumber)
    .def("getnumber", &Worldb::getnumber);

我们将看到它依次执行以下功能：

• 创建一个新的实例class_<Worldb>
• 调用它的成员函数def来暴露messagewindow
• 调用它的成员函数def来暴露setnumber
• 调用它的成员函数def来暴露getnumber
• 将其分配给main_namespace["Worldb"]。

我们可以通过以下方式将其重写为将每个部分作为单独的语句：

{
    bp::class_<Worldb> test_binding = bp::class_<Worldb>("Worldb");
    test_binding.def("messagewindow", &Worldb::messagewindow);
    test_binding.def("setnumber", &Worldb::setnumber);
    test_binding.def("getnumber", &Worldb::getnumber);

    main_namespace["Worldb"] = test_binding;
}

注意：我们引入了一个新的作用域来限制 的生命周期test_binding，分配后不再需要它。

这样做之后，有条件地公开各个方法是微不足道的。

示例代码

#include <boost/python.hpp>

namespace bp = boost::python;

struct test
{
    void one() {}
    void two() {}
    void three() {}
};

int main()
{
    Py_Initialize();

    try {
        bp::object main_module = bp::import("__main__");
        bp::object main_namespace = main_module.attr("__dict__");

        // Simple bitmap of methods to expose:
        // * bit 0 -> one()
        // * bit 1 -> two()
        // * bit 2 -> three()
        uint32_t method_mask(5);

        {
            // Limit the scope of `test_binding` variable
            bp::class_<test> test_binding = bp::class_<test>("test");
            if ((method_mask & 1) == 1) {
                test_binding.def("one", &test::one);
            }
            if ((method_mask & 2) == 2) {
                test_binding.def("two", &test::two);
            }
            if ((method_mask & 4) == 4) {
                test_binding.def("three", &test::three);
            }

            main_namespace["test"] = test_binding;
        }

        exec("print dir(test)\n", main_namespace);
    } catch (bp::error_already_set &) {
        PyErr_Print();
    }

    Py_Finalize();

    return 0;
}

控制台输出

注意：我们预计one()并three()会被曝光。我重新格式化了输出以获得更好的可读性。

['__class__', '__delattr__', '__dict__', '__doc__', '__format__'
    , '__getattribute__', '__hash__', '__init__', '__instance_size__'
    , '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__'
    , '__sizeof__', '__str__', '__subclasshook__', '__weakref__'
    , 'one', 'three']

参考

• 的文件boost::python::class_