python - 如何在 SWIG/Python 中将结构列表传递给 C

Question

我有一个通过 swig 导出的 C++ 类，以及一个接受 Foo 数组的函数小号:

typedef class Foo {
  int i;
} Foo;

void func(Foo *all_foos);

现在我希望能够将包含这些的 python 列表传递给 all_foos:

afoo = mymod.Foo()
bfoo = mymod.Foo()
mymod.func([afoo, bfoo])

我有一个不起作用的类型映射。有关我需要帮助的地方，请参阅 FIXME 行。

%typemap(in) Foo ** {
  /* Check if it's a list */
  if (PyList_Check($input)) {
    int size = PyList_Size($input);
    int i = 0;
    $1 = (Foo **) malloc((size+1)*sizeof(Foo *));
    for (i = 0; i < size; i++) {
      PyObject *o = PyList_GetItem($input,i);
      // here o->ob_type->tp_name is "Foo"; could check that
      // FIXME: HOW DO I GO FROM o -> SwigPyObject -> Foo *?  THIS IS WRONG
      $1[i] = (Foo *)(reinterpret_cast<SwigPyObject *>(o))->ptr;
    }
  } else {
    PyErr_SetString(PyExc_TypeError,"not a list");
    return NULL;
  }
}

基本上，我有一个 PyObject Ø;我需要得到 SwigPyObject从它(我只是施放它吗？还是它是成员(member)？)然后得到我的 Foo来自 SwigPyObject 的指针不知何故。

Answer 1

您的示例有点困惑，因为您的 C++ 函数采用 Foo*，但您的类型映射采用 Foo**(即 Foos 数组与指向 Foos 的指针数组) .我假设你指的是后者，因为这是从你给出的函数声明中判断数组有多长的唯一明智的方法。

关于直接问题“如何将 Python 对象转换为给定类型的 C++ 指针？”我通常通过让 SWIG 为我生成一些代码然后检查它来解决这个问题。因此，例如，如果您有一个函数 void bar(Foo*);，那么 SWIG 将在包装器中生成一些代码:

SWIGINTERN PyObject *_wrap_bar(PyObject *SWIGUNUSEDPARM(self), PyObject *args) {
  PyObject *resultobj = 0;
  Foo *arg1 = (Foo *) 0 ;
  void *argp1 = 0 ;
  int res1 = 0 ;
  PyObject * obj0 = 0 ;

  if (!PyArg_ParseTuple(args,(char *)"O:bar",&obj0)) SWIG_fail;
  res1 = SWIG_ConvertPtr(obj0, &argp1,SWIGTYPE_p_Foo, 0 |  0 );
  if (!SWIG_IsOK(res1)) {
    SWIG_exception_fail(SWIG_ArgError(res1), "in method '" "bar" "', argument " "1"" of type '" "Foo *""'");
  }
  arg1 = reinterpret_cast< Foo * >(argp1);
  bar(arg1);
  resultobj = SWIG_Py_Void();
  return resultobj;
fail:
  return NULL;
}

其中有趣的一点是对 SWIG_ConvertPtr 的调用，它正在执行您想要的操作。有了这些知识，我们只需要将它放在您已经为类型映射编写的循环中，这样您的“in”类型映射就变成了:

%typemap(in) Foo ** {
  $1 = NULL;
  if (PyList_Check($input)) {
    const size_t size = PyList_Size($input);
    $1 = (Foo**)malloc((size+1) * sizeof(Foo*));
    for (int i = 0; i < size; ++i) {
      void *argp = 0 ;
      const int res = SWIG_ConvertPtr(PyList_GetItem($input, i), &argp, $*1_descriptor, 0);
      if (!SWIG_IsOK(res)) {
        SWIG_exception_fail(SWIG_ArgError(res), "in method '" "$symname" "', argument " "$argnum"" of type '" "$1_type""'");
      }
      $1[i] = reinterpret_cast<Foo*>(argp);
    }
    $1[size] = NULL;
  }
  else {
    // Raise exception
    SWIG_exception_fail(SWIG_TypeError, "Expected list in $symname");
  }
}

请注意，为了使类型映射通用且可重用，我已将其部分替换为 special typemap variables - 生成的代码与我们看到的单个示例相同，但您可以稍微重复使用它。

这足以编译和运行您提供的示例代码(按照说明进行了一次更改)，但是仍然存在内存泄漏。你调用了malloc()，但从来没有调用过free()，所以我们需要添加一个相应的'freearg' typemap :

%typemap(freearg) Foo ** {
  free($1);
}

这在成功和错误时都会被调用，但这很好，因为 $1 被初始化为 NULL，所以无论我们是否成功 malloc，行为都是正确的。

---

作为一般点，因为这是 C++，我认为你的界面设计错误 - 没有充分的理由不使用 std::vector、std::list 或similar 这也使包装更简单。像在头文件中那样使用 typedef 也是一种奇怪的风格。

如果是我写的，我会希望在包装器中使用 RAII，即使我无法更改接口(interface)以使用容器。所以这意味着我会将我的“输入”类型映射写为:

%typemap(in) Foo ** (std::vector<Foo*> temp) {
  if (PyList_Check($input)) {
    const size_t size = PyList_Size($input);
    temp.resize(size+1);
    for (int i = 0; i < size; ++i) {
      void *argp = 0 ;
      const int res = SWIG_ConvertPtr(PyList_GetItem($input, i), &argp, $*1_descriptor, 0);
      if (!SWIG_IsOK(res)) {
        SWIG_exception_fail(SWIG_ArgError(res), "in method '" "$symname" "', argument " "$argnum"" of type '" "$1_type""'");
      }
      temp[i] = reinterpret_cast<Foo*>(argp);
    }
    temp[size] = NULL;
    $1 = &temp[0]; // Always valid since we +1
  }
  else {
    // Raise exception
    SWIG_exception_fail(SWIG_TypeError, "Expected list in $symname");
  }
}

然后消除了对“freearg”类型映射的需要并且永远不会泄漏。

---

如果出于某种原因您不想编写自定义类型映射，或者更改接口(interface)以使用 SWIG 库中已有良好类型映射的类型，您仍然可以通过使用 %rename 以“隐藏”默认实现和 %pythoncode 以注入(inject)一些额外的 Python，这些 Python 具有相同的名称，将 Python 输入“按摩”到对 Python 用户透明的 carrays 接口(interface)。