swig：如何制作QList <T> 可迭代的，就像std :: vector一样

Question

我正在使用SWIG为我的qt应用程序生成Python绑定。 我有几个地方使用QList ，我想整合来自SWIG库的std :: vector等QLists（参见http://www.swig.org/Doc1.3/Library.html#Library_nn15 ）。
这意味着：

• QList对象应该可以从python迭代（=它们必须是可迭代的python对象）
• 应该可以将python列表传递给带有qlist的函数
• ...以及SWIG库中为std :: vector列出的所有其他功能

为此，我使用以下代码： https ： //github.com/osmandapp/OsmAnd-core/blob/master/swig/java/QList.i
后来在我使用QLists的课程中，我添加了如下代码：

%import "qlist.i"
%template(listfilter) QList<Interface_Filter*>;

class A {
    public:
    //.....
    QList<Interface_Filter*> get_filters();
};

这个工作到目前为止，但它没有给我与std :: vector的集成。 我无法找到std_vector.i，std_container.i的哪些部分，...使对象可迭代。
我如何扩展QList接口文件以使我的QList可迭代？

Answer 1

您要求的是 - 一个qlist.i swig文件，它在python中实现与QList相同的集成级别，就像std_vector.i对std::vector - 是一项非常重要的任务。

我提供了一个非常基本的扩展qlist.i文件（和qlisttest.i来向您展示如何使用它），并将尝试解释所需的步骤。

qlist.i ：

%{
#include <QList>
%}

%pythoncode %{
class QListIterator:
    def __init__(self, qlist):
        self.index = 0
        self.qlist = qlist
    def __iter__(self):
        return self
    def next(self):
        if self.index >= self.qlist.size():
            raise StopIteration;
        ret = self.qlist.get(self.index)
        self.index += 1
        return ret
    __next__ = next
%}

template<class T> class QList {
public:
class iterator;
typedef size_t size_type;
typedef T value_type;
typedef const value_type& const_reference;
QList();
size_type size() const;
void reserve(size_type n);
%rename(isEmpty) empty;
bool empty() const;
void clear();
%rename(add) push_back;
void push_back(const value_type& x);
%extend {
    const_reference get(int i) throw (std::out_of_range) {
    int size = int(self->size());
    if (i>=0 && i<size)
        return (*self)[i];
    else
        throw std::out_of_range("QList index out of range");
    }
    void set(int i, const value_type& val) throw (std::out_of_range) {
    int size = int(self->size());
    if (i>=0 && i<size)
        (*self)[i] = val;
    else
        throw std::out_of_range("QList index out of range");
    }
    int __len__() {
    return self->size();
    }
    const_reference __getitem__(int i) throw (std::out_of_range) {
    int size = int(self->size());
    if (i>=0 && i<size)
        return (*self)[i];
    else
        throw std::out_of_range("QList index out of range");
    }
    %pythoncode %{
    def __iter__(self):
        return QListIterator(self)
    %}
}
};

%define %qlist_conversions(Type...)
%typemap(in) const QList< Type > & (bool free_qlist)
{
free_qlist = false;
if ((SWIG_ConvertPtr($input, (void **) &$1, $1_descriptor, 0)) == -1) {
    if (!PyList_Check($input)) {
    PyErr_Format(PyExc_TypeError, "QList or python list required.");
    SWIG_fail;
    }
    Py_ssize_t len = PyList_Size($input);
    QList< Type > * qlist = new QList< Type >();
    free_qlist = true;
    qlist->reserve(len);
    for (Py_ssize_t index = 0; index < len; ++index) {
    PyObject *item = PyList_GetItem($input,index);
    Type* c_item;
    if ((SWIG_ConvertPtr(item, (void **) &c_item, $descriptor(Type *),0)) == -1) {
        delete qlist;
        free_qlist = false;
        PyErr_Format(PyExc_TypeError, "List element of wrong type encountered.");
        SWIG_fail;
    }
    qlist->append(*c_item);
    }
    $1 = qlist;
}
}
%typemap(freearg) const QList< Type > &
{ if (free_qlist$argnum and $1) delete $1; }    
%enddef

qlisttest.i ：

%module qlist;
%include "qlist.i"

%inline %{
class Foo {
public:
    int foo;
};
%}

%template(QList_Foo) QList<Foo>;
%qlist_conversions(Foo);

%inline %{  
int sumList(const QList<Foo> & list) {
    int sum = 0;
    for (int i = 0; i < list.size(); ++i) {
        sum += list[i].foo;
    }
    return sum;
}
%}

1. 包装QList以使其及其方法可从python访问
   这是通过使（部分）类定义可用于swig来实现的。 这就是你当前的qlist.i所做的。
   注意：您可能需要为QList<T*>添加“模板特化”，因为您使用的是指针QList ，因此将const_reference作为const T* 。 否则， QList<T*>::const_reference将是const T*& ，这显然可能会混淆swig。 （见swig / lib / std / std_vector.i ）

2. python列表和QList之间的自动转换
   这通常通过使用swig类型映射来实现。 例如，如果您希望函数f(const QList<int>& list)能够接受python列表，则需要指定一个输入typemap，它执行从python列表到QList<int> ：

    %typemap(in) const QList<int> & { PyObject * py_list = $input; [check if py_list is really a python list of integers] QList<int>* qlist = new QList<int>(); [copy the data from the py_list to the qlist] $1 = qlist; } %typemap(freearg) const QList<int> & { if ($1) delete $1; } 

   在这方面，情况在几个方面更加困难：

   • 您希望能够传递python列表或包装的QList ：为此，您需要在typemap中处理这两种情况。
   • 您想要将包装类型T的python列表转换为QList<T> ：
     这还涉及从包装类型T到普通T的列表的每个元素的转换。 这是通过swig函数SWIG_ConvertPtr实现的。
   • 我不确定您是否可以使用模板参数指定类型映射。 因此，我编写了一个swig宏%qlist_conversions(Type) ，您可以使用它将typemap附加到特定Type的QList<Type> 。

   对于其他转换方向（ QList - > python list），您应该首先考虑您想要的内容。 考虑一个返回QList<int>的C ++函数。 从python调用它，它应该返回一个包装的QList对象，还是应该自动将QList转换为python列表？

3. 将包装的QList作为python序列访问，即使用python使len和[]工作
   为此，您需要使用%extend { ... } qlist.i文件中的QList类，并实现__len__和__getitem__方法。

   如果切片也应该有效，则需要为__getitem__(PySliceObject *slice)__提供__getitem__(PySliceObject *slice)__成员方法和输入以及“类型检查”类型PySliceObject 。

   如果您希望能够使用python中的[]修改包装QList值，则需要实现__setitem__ 。

   有关可以实现以实现更好集成的所有有用方法的列表，请参阅有关“内置类型”和“容器的抽象基类”的python文档。

   注意：如果您使用swig -builtin功能，则需要使用例如将上述功能注册到相应的“插槽”

    %feature("python:slot", "sq_length", functype="lenfunc") __len__; 

4. 使包装的QList从python中迭代
   为此，您需要扩展QList类并实现一个返回python迭代器对象的__iter__()方法。

   python迭代器对象是一个对象，它提供方法__iter__()和__next__() （ next()用于较旧的python），其中__next__()返回下一个值并引发python异常StopIteration以指示结束。

   如前所述，您可以在python或C ++中实现迭代器对象。 我展示了在python中执行此操作的示例。

我希望这有助于您调整所需的功能。

Answer 2

如文档中所述，您需要以下内容：

• QList应该在python __iter__()中有一个方法，它返回一个迭代器对象（如果你在C中实现它， tp_iter ）。
• 迭代器对象应该实现__iter__()并返回自身
• 迭代器对象应该实现next() ，它返回下一个项目或者在完成时引发StopIteration 。

这在python中可能最简单，但您也可以在C中实现它。

另一种选择是使用python生成器来避免实现迭代器类型。 要做到这一点，你需要实现__iter__()而不是返回一个迭代器，你只需要yield值。

提到的方法只需要对python可见。 您不必在C / Java中使它们可用。

另请参见SWIG将C库连接到Python（从C'sequence'struct创建'iterable'Python数据类型）

Answer 3

您提供了“如何使python对象可迭代”这一问题的答案，但我问“我如何扩展QList接口文件以使我的QList可迭代？” 这更像是SWIG，而不是与python相关的问题。

我使用Java，C＃和Python测试了http://www.swig.org/Doc1.3/Library.html#Library_nn15中的示例。 只有Python和C＃提供迭代器。 生成的Java接口不实现Iterable或类似的东西。 据我所知，你的问题与目标语言有关。

也许扩展MutableSequence是你的选择。 您必须实现的唯一方法是__getitem__ __setitem__ ， __delitem__ ， __len__ __delitem__ ， __len__并通过将它们委托给QList的相应方法来insert 。 之后生成的类是可迭代的。