我已经为 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<​​ m=""> 元素(最好在无效索引上抛出 IndexError)
3. 对于 py_ctsruct 中的元素:枚举的能力

根据 PEP234 , 一个对象可以用“for”迭代，如果它实现 _iter_() 或 _getitem_()。然后使用该逻辑，我认为通过将以下属性(通过 rename )添加到我的 SWIG 接口(interface)文件中，我将获得所需的行为(除了上面的要求。#1 - 我仍然不知道如何实现):

__len__
__getitem__
__setitem__

我现在可以在 python 中索引 C 对象。我还没有实现 Python 异常抛出，但是如果超出数组边界，将返回一个魔数(Magic Number)(错误代码)。

有趣的是，当我尝试使用“for x in”语法遍历结构时:

for i in py_cstruct:
    print i

Python 进入一个无限循环，它只是在控制台上打印上面提到的魔数(Magic Number)(错误)。这向我表明索引有问题。

最后但并非最不重要的一点是，我该如何实现要求 1？这涉及(据我了解):

• 处理'来自python的函数调用list()
• 从 C 代码返回 Python(列表)数据类型

[[更新]]

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

最佳答案

最简单的解决方案是实现 __getitem__并抛出 IndexError无效索引的异常。

我举了一个例子，在 SWIG 中使用 %extend 和 %exception 来实现 __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 直接映射到 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，其中包含任何返回 MyStruct * 的函数的返回值。我测试了这个 %typemap(out)，其功能与之前的方法完全相同。

你也可以写一个相应的 %typemap(in) 和 %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);
}

使用迭代器对于像链表这样的容器更有意义，但为了完整起见，您可能会如何使用 __iter__ 为 MyStruct 执行此操作。关键是让 SWIG 为您包装另一种类型，它提供了所需的 __iter__() 和 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;
  }
}

iteration over containers 的要求容器需要实现 __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__()和一个类似于第一种类型的 next()。我在原来的答案中没有这样做，因为我认为这比有两种不同的类型更不清晰——容器和该容器的迭代器)

关于python - SWIG 将 C 库连接到 Python(从 C 'iterable' 结构创建 'sequence' Python 数据类型)，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8776328/