SWIG 将 C 库连接到 Python（从 C“序列”结构创建“可迭代”Python 数据类型）

我已经为 C 库编写了 Python 扩展。我有一个如下所示的数据结构：

typedef struct _mystruct{
   double * clientdata;
   size_t   len;
} MyStruct;

此数据类型的用途直接映射到 Python 中的列表数据类型。因此，我想为导出的结构创建“类似列表”的行为，以便使用我的 C 扩展编写的代码更加“Pythonic”。

特别是，这就是我想要做的（来自 python 代码） 注意：py_ctsruct 是在 python 中访问的 ctsruct 数据类型。

我的要求可以概括为：

1. list(py_ctsruct) 返回一个 python 列表，其中所有内容都从 c 结构中复制出来
2. py_cstruct[i] 返回ith元素（最好在无效索引上抛出 IndexError ）
3. 对于 py_ctsruct 中的 elem：枚举能力

根据PEP234 http://www.python.org/dev/peps/pep-0234/, 如果对象实现了，则可以使用“for”对其进行迭代 _iter_() or _getitem_()。然后使用该逻辑，我认为通过添加以下属性（通过rename http://www.swig.org/Doc1.3/SWIG.html#SWIG_rename_ignore）到我的 SWIG 接口文件，我将具有所需的行为（除了上面的 req.#1 - 我仍然不知道如何实现）：

__len__
__getitem__
__setitem__

我现在可以在 python 中索引 C 对象。我还没有实现 Python 异常抛出，但是如果超出数组范围，则会返回一个幻数（错误代码）。

有趣的是，当我尝试使用“for x in”语法迭代结构时，例如：

for i in py_cstruct:
    print i

Python 进入一个无限循环，仅在控制台上打印上面提到的幻数（错误）。这对我来说表明索引有问题。

最后但并非最不重要的一点是，如何实现要求 1？这涉及（据我了解）：

• 处理函数调用list()来自蟒蛇
• 从 C 代码返回 Python（列表）数据类型

[[更新]]

我有兴趣查看一些关于我需要在接口文件中放入哪些（如果有）声明的代码片段，以便我可以从 Python 迭代 c 结构的元素。

最简单的解决方案是实施__getitem__ http://docs.python.org/reference/datamodel.html#object.__getitem__并抛出一个IndexError http://docs.python.org/library/exceptions.html#exceptions.IndexError无效索引的异常。

我整理了一个例子，使用%extend and %exception在 SWIG 中实施__getitem__并分别引发异常：

%module test

%include "exception.i"

%{
#include <assert.h>
#include "test.h"
static int myErr = 0; // flag to save error state
%}

%exception MyStruct::__getitem__ {
  assert(!myErr);
  $action
  if (myErr) {
    myErr = 0; // clear flag for next time
    // You could also check the value in $result, but it's a PyObject here
    SWIG_exception(SWIG_IndexError, "Index out of bounds");
  }
}

%include "test.h"

%extend MyStruct {
  double __getitem__(size_t i) {
    if (i >= $self->len) {
      myErr = 1;
      return 0;
    }
    return $self->clientdata[i];
  }
}

我通过添加到 test.h 来测试它：

static MyStruct *test() {
  static MyStruct inst = {0,0};
  if (!inst.clientdata) {
    inst.len = 10;
    inst.clientdata = malloc(sizeof(double)*inst.len);
    for (size_t i = 0; i < inst.len; ++i) {
      inst.clientdata[i] = i;
    }
  }
  return &inst;
}

并运行以下 Python：

import test

for i in test.test():
  print i

哪个打印：

python run.py
0.0
1.0
2.0
3.0
4.0
5.0
6.0
7.0
8.0
9.0

然后完成。

另一种方法，使用类型映射来映射MyStruct onto a PyList直接也可以：

%module test

%{
#include "test.h"
%}

%typemap(out) (MyStruct *) {
  PyObject *list = PyList_New($1->len);
  for (size_t i = 0; i < $1->len; ++i) {
    PyList_SetItem(list, i, PyFloat_FromDouble($1->clientdata[i]));
  }

  $result = list;
}

%include "test.h"

这将创建一个PyList与任何返回 a 的函数的返回值MyStruct *。我测试了这个%typemap(out)与之前的方法具有完全相同的功能。

也可以写一个对应的%typemap(in) and %typemap(freearg)相反，类似这样未经测试的代码：

%typemap(in) (MyStruct *) {
  if (!PyList_Check($input)) {
    SWIG_exception(SWIG_TypeError, "Expecting a PyList");
    return NULL;
  }
  MyStruct *tmp = malloc(sizeof(MyStruct));
  tmp->len = PyList_Size($input);
  tmp->clientdata = malloc(sizeof(double) * tmp->len);
  for (size_t i = 0; i < tmp->len; ++i) {
    tmp->clientdata[i] = PyFloat_AsDouble(PyList_GetItem($input, i));
    if (PyErr_Occured()) {
      free(tmp->clientdata);
      free(tmp);
      SWIG_exception(SWIG_TypeError, "Expecting a double");
      return NULL;
    }
  }
  $1 = tmp;
}

%typemap(freearg) (MyStruct *) {
  free($1->clientdata);
  free($1);
}

使用迭代器对于像链表这样的容器来说更有意义，但为了完整性起见，您可能会这样做MyStruct with __iter__。关键是你让 SWIG 为你包装另一种类型，它提供了__iter__() and next()在这种情况下需要MyStructIter使用以下方法同时定义和包装%inline因为它不是普通 C API 的一部分：

%module test

%include "exception.i"

%{
#include <assert.h>
#include "test.h"
static int myErr = 0;
%}

%exception MyStructIter::next {
  assert(!myErr);
  $action
  if (myErr) {
    myErr = 0; // clear flag for next time
    PyErr_SetString(PyExc_StopIteration, "End of iterator");
    return NULL;
  }
}

%inline %{
  struct MyStructIter {
    double *ptr;
    size_t len;
  };
%}

%include "test.h"

%extend MyStructIter {
  struct MyStructIter *__iter__() {
    return $self;
  }

  double next() {
    if ($self->len--) {
      return *$self->ptr++;
    }
    myErr = 1;
    return 0;
  }
}

%extend MyStruct {
  struct MyStructIter __iter__() {
    struct MyStructIter ret = { $self->clientdata, $self->len };
    return ret;
  }
}

要求容器迭代 http://docs.python.org/library/stdtypes.html#iterator-types是这样的容器需要实现__iter__()并返回一个新的迭代器，但除了next()它返回下一个项目并递增迭代器，迭代器本身还必须提供__iter__()方法。这意味着容器或迭代器可以相同地使用。

MyStructIter需要跟踪迭代的当前状态——我们在哪里以及还剩下多少。在这个例子中，我通过保留一个指向下一个项目的指针和一个计数器来实现这一点，我们用它来告诉我们何时到达末尾。您还可以通过保留指向的指针来跟踪状态MyStruct迭代器正在使用一个计数器来表示其中的位置，例如：

%inline %{
  struct MyStructIter {
    MyStruct *list;
    size_t pos;
  };
%}

%include "test.h"

%extend MyStructIter {
  struct MyStructIter *__iter__() {
    return $self;
  }

  double next() {
    if ($self->pos < $self->list->len) {
      return $self->list->clientdata[$self->pos++];
    }
    myErr = 1;
    return 0;
  }
}

%extend MyStruct {
  struct MyStructIter __iter__() {
    struct MyStructIter ret = { $self, 0 };
    return ret;
  }
}

（在这种情况下，我们实际上可以将容器本身用作迭代器，通过提供__iter__()返回了一个copy容器和一个next()与第一种类似。我在最初的答案中没有这样做，因为我认为这比两种不同的类型更不清楚 - 容器和该容器的迭代器）