pybind如何操作py :: list对象

时间:2018-06-15 23:13:41

标签: python c++ pybind11

为了更好地理解如何使用pybind库将参数从Python传递到C ++函数,我想构建一个小的虚拟/演示代码,我可以在C ++端接收Python列表,将其转换为浮点指针对象,然后打印它。

虽然我知道我可以使用py::list类,但我还没有想出这个类可用的方法。我查看了文档参考,然后在代码(list.h,stl.h)中查找并且无法确定哪些方法可用。

__getitem__的等价物是什么?我是否有py::list可用的所有python方法?

1 个答案:

答案 0 :(得分:5)

您要查找的代码是here

class list : public object {
public:
    PYBIND11_OBJECT_CVT(list, object, PyList_Check, PySequence_List)
    explicit list(size_t size = 0) : object(PyList_New((ssize_t) size), stolen_t{}) {
        if (!m_ptr) pybind11_fail("Could not allocate list object!");
    }
    size_t size() const { return (size_t) PyList_Size(m_ptr); }
    detail::list_accessor operator[](size_t index) const { return {*this, index}; }
    detail::list_iterator begin() const { return {*this, 0}; }
    detail::list_iterator end() const { return {*this, PyList_GET_SIZE(m_ptr)}; }
    template <typename T> void append(T &&val) const {
        PyList_Append(m_ptr, detail::object_or_cast(std::forward<T>(val)).ptr());
    }
};

还请记住,py::list继承自py::object,而py::handle继承自size(这也意味着您正在通过引用传递)。以我的经验,很少有这种用法的文档,阅读代码是最好的选择。

从类定义中我们可以使用成员函数operator[]beginendappend(C ++迭代器!)和{{1} }(模板化!)。如果这还不够,则可以使用attr to access python attributes(包括方法)。这是一个示例:

Python代码(some_python.py):

import cppimport
cpp = cppimport.imp("some_cpp")

l = [1,2,3,4,5]
cpp.test(l)
print('after C++', l)

cpp.float_cast(l)

C ++代码(some_cpp.cpp):

/* <%
setup_pybind11(cfg)
%> */

#include <pybind11/pybind11.h>
#include <iostream>
#include <string>

namespace py = pybind11;

void test(py::list l) {
    l.attr("pop")();
    std::cout << "List has length " << l.size() << std::endl;
    for (py::handle obj : l) {  // iterators!
        std::cout << "  - " << obj.attr("__str__")().cast<std::string>() << std::endl;
    }
    l.append(10);  // automatic casting (through templating)!
}

void float_cast(py::list l) {
    float f = l.cast<float>();
}

PYBIND11_MODULE(some_cpp, m) {
    m.def("test", &test);
    m.def("float_cast", &float_cast);
}

输出:

List has length 4
  - 1
  - 2
  - 3
  - 4
after C++ [1, 2, 3, 4, 10]
Traceback (most recent call last):
  File "some_python.py", line 9, in <module>
    cpp.float_cast(l)
RuntimeError: Unable to cast Python instance to C++ type (compile in debug mode for details)

如您所见,我还包括了有关转换为浮点数的具体问题。在这里,我使用了cast的{​​{1}}方法,它给出了一个很好的例外。您可以尝试“直接”投射对象(类似py::handle),但这会给您带来垃圾,我想这不是您想要的。

更多说明:float* f = (float*) &l;允许在Python的标准类型和C ++版本之间进行转换。例如,pybind/stl.h可以转换为list,包括类型检查。这样做的重要作用是,数据作为副本而不是作为引用传递。