首页 > 解决方案 > 当 C++ 方法返回 std::map 时的 boost-python

问题描述

我正在使用 Boost Python 向 Python 公开一个 API,该 API 是用 C++ 编写的,我无法更改。

我已经成功地公开了返回对 std:map 的引用的方法,其中键、值对是值类型 - 例如:

class_< std::map<std::string, std::string> >("StringMap")
    .def(map_indexing_suite< std::map<std::string, std::string>, true >());

这无缝地工作。但是,当尝试实现类似的结果时,其中映射值是指向我在 API 中公开的类的指针不起作用:

struct X_wrap : X, wrapper<X>
{
     X_wrap(int i): X(i) {}
    // virtual methods here, omitted for brevity - as unlikely to be the issue
}

BOOST_PYTHON_MODULE(my_py_extension)
{

    class_< std::map<std::string, X*> >("XPtrMap")
        .def(map_indexing_suite< std::map<std::string, X*> >());

    class_<X_wrap, boost::noncopyable, bases<XBase> >("X", init<int>())

   // other definitions omitted
}

g++ 7.3.0 中出现的错误:

/usr/include/boost/python/detail/caller.hpp:100:98: error: ‘struct boost::python::detail::specify_a_return_value_policy_to_wrap_functions_returning<X*>’ has no member named ‘get_pytype’

我理解编译器抱怨的原因 -X*映射中的 in 需要包含在调用策略中,以便它可以返回给 Python,就像返回原始指针的基本方法一样。

我的问题是最好的方法是什么?

从谷歌搜索中可以看出,我也许可以指定一个DerivedPolicies子类map_indexing_suite,它将重载必要的部分以将 X* 包装在适当的return_value_policy. 然而,到目前为止,我没有成功地将编译器不会嘲笑的任何东西放在一起!

我还怀疑我可以从字面上复制并粘贴整个文件map_indexing_suite并重命名它,并在其中进行更改以生成一个新indexing_suite的 right return_value_policy,但与使用的解决方案相比,这似乎很难看DerviedPolicies- 假设我是对的,DeriviedPolicies可以用于全部!

感激地收到任何帮助、指示或示例!

编辑

我已经证明,剪切和粘贴选项只需对 to 进行一次简单的更改is_class即可is_pointer。奇怪的is_pointer是,由于目标策略可以处理指针,所以原始策略中不允许这样做。我还没有说服自己这是一个对象生命周期限制,这意味着原始文件中不允许使用指针?

整个班级都是公开的,所以我怀疑可以通过简单地继承map_indexing_suite或使用神秘DerivedPolicies参数来避免完整的剪切和粘贴?

    extension_def(Class& cl)
    {
        //  Wrap the map's element (value_type)
        std::string elem_name = "mapptr_indexing_suite_";
        object class_name(cl.attr("__name__"));
        extract<std::string> class_name_extractor(class_name);
        elem_name += class_name_extractor();
        elem_name += "_entry";

        typedef typename mpl::if_<
            mpl::and_<is_pointer<data_type>, mpl::bool_<!NoProxy> >
          , return_internal_reference<>
          , default_call_policies
        >::type get_data_return_policy;

        class_<value_type>(elem_name.c_str())
            .def("__repr__", &DerivedPolicies::print_elem)
            .def("data", &DerivedPolicies::get_data, get_data_return_policy())
            .def("key", &DerivedPolicies::get_key)
        ;
    }

编辑 2

现在看答案

标签: pythonc++boostboost-python

解决方案


剪切和粘贴中稍微干净的实现是继承 map_indexing_suite - 需要进行一些调整才能使其工作。

这似乎是相当明智的——如果有人提出一个更简洁的解决方案或者可以更好地解释DerivedPolicies那就太好了,否则我会在几天左右接受以下作为答案......

using namespace boost;
using namespace boost::python;

//Forward declaration
template <class Container, bool NoProxy, class DerivedPolicies>
class mapptr_indexing_suite;

template <class Container, bool NoProxy>
class final_mapptr_derived_policies
    : public mapptr_indexing_suite<Container,
        NoProxy, final_mapptr_derived_policies<Container, NoProxy> > {};

template <
    class Container,
    bool NoProxy = false,
    class DerivedPolicies
        = final_mapptr_derived_policies<Container, NoProxy> >
class mapptr_indexing_suite
    : public map_indexing_suite<
    Container,
    NoProxy,
    DerivedPolicies
    >
{
public:
    // Must be explicit if the compiler is
    // going to take from the base class
    using typename map_indexing_suite<
        Container,NoProxy,DerivedPolicies>::data_type;
    using typename map_indexing_suite<
        Container,NoProxy,DerivedPolicies>::value_type;

    // Only one class needs to be overridden from the base
    template <class Class>
    static void
    extension_def(Class& cl)
    {
        //  Wrap the map's element (value_type)
        std::string elem_name = "mapptr_indexing_suite_";
        object class_name(cl.attr("__name__"));
        extract<std::string> class_name_extractor(class_name);
        elem_name += class_name_extractor();
        elem_name += "_entry";

        // use of is_pointer here is the only
        // difference to the base map_indexing_suite
        typedef typename mpl::if_<
            mpl::and_<std::is_pointer<data_type>, mpl::bool_<!NoProxy> >
            , return_internal_reference<>
            , default_call_policies
            >::type get_data_return_policy;

        class_<value_type>(elem_name.c_str())
            .def("__repr__", &DerivedPolicies::print_elem)
            .def("data", &DerivedPolicies::get_data, get_data_return_policy())
            .def("key", &DerivedPolicies::get_key)
            ;
    }
};

推荐阅读