python - 如何使用 SWIG 根据 C 函数返回类型返回特定异常？

Question

以下是我的 C API 中的函数示例:

int do_something(struct object *with_this)
struct object *get_something(struct object *from_this)

do_something 将返回 0 表示成功，或返回 -1 并设置 errno 表示失败。 get_something 将在成功时返回有效指针，或在失败时返回 NULL 并设置 errno。

我正在使用 SWIG 2.0 生成 python 绑定(bind)。对于 do_something 绑定(bind)，我希望它在失败时返回基于 errno 的异常，如果成功则返回 Python None 对象。对于 get_something 绑定(bind)，我希望它在失败时返回基于 errno 的异常，如果成功则返回不透明对象。

问题是如何让 SWIG 为我实现所有这些魔力？

目前我正在使用 SWIG 2.0。

我可以使用 %exception 并为每个符号定义不同的异常，但我希望它基于返回类型。我会有很多 API 函数，我不想把它们列出来。所以我可以对每个符号执行此操作:

%exception do_something {
    $action
    if (result < 0) {
        return PyErr_SetFromErrno(PyExc_RuntimeError);
    }
}

%exception get_something {
    $action
    if (result == NULL) {
        return PyErr_SetFromErrno(PyExc_RuntimeError);
    }
}

如果我能做这样的事情会更好(就像你可以用 %typemap 做的那样):

%exception int {
    $action
    if (result < 0) {
        return PyErr_SetFromErrno(PyExc_RuntimeError);
    }
}

%exception struct object * {
    $action
    if (result == NULL) {
        return PyErr_SetFromErrno(PyExc_RuntimeError);
    }
}

我可以做这样的事情吗？如果我有这样的东西，那就可以解决异常(exception)情况。我相信我的 get_something 绑定(bind)将是完美的。

如果我使用 %typemap，我的 do_something 绑定(bind)仍然需要这样的东西才能返回 Python None 对象:

%typemap(out) int {
    $result = Py_BuildValue("");
}

我正在寻找的魔法是否存在，或者我的做法是否完全错误？有更好的方法吗？

Answer 1

为了帮助回答这个问题，我采用了您的函数并创建了以下 test.h 文件，其中包含足够的真实代码来实际说明问题:

struct object { int bar; };

static int do_something(struct object *with_this) { 
  errno = EACCES;
  return -1; 
}

static struct object *get_something(struct object *from_this) {
  errno = EAGAIN;
  return NULL;
}

我相当确定 %typemap(out) 是写入此代码的位置，而不是 %exception，因为您想要的行为由返回类型，而不是调用的函数的名称。事实上，您也关心返回的值(value)，这一事实进一步支持了这一点。您可以在某种程度上避免重复使用 $typemap 来引用您的其他类型映射。

所以我写了一个小 SWIG 界面来说明这一点:

%module test

%{
#include <errno.h>
#include "test.h"
%}

%typemap(out) int do_something %{
  if ($1 < 0) {
    PyErr_SetFromErrno(PyExc_RuntimeError);
    SWIG_fail;    
  }
  $result = Py_None; // Return only controls exception
  Py_INCREF($result);
%}

%typemap(out) struct object *get_something %{
  if (!$1) {
    PyErr_SetFromErrno(PyExc_RuntimeError);
    SWIG_fail; 
  }

  // Return passed through unless NULL
  $typemap(out,$1_ltype);
%}

%include "test.h"

测试时有效:

Python 2.7.6 (default, Jun 22 2015, 17:58:13) 
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import test
>>> test.do_something(None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: (13, 'Permission denied')
>>> test.get_something(None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: (11, 'Resource temporarily unavailable')
>>> 

这只有效，因为我在匹配类型映射时显式命名了do_something，因此没有命名函数的回退是可以的。如果您只是尝试删除该限制，您将收到有关递归类型映射的错误。您可以使用 %apply 解决这个问题，例如

%typemap(out) struct object * MY_NULL_OR_ERRNO %{
  if (!$1) {
    PyErr_SetFromErrno(PyExc_RuntimeError);
    SWIG_fail;
  }

  $typemap(out,$1_ltype);
%}

%apply struct object * MY_NULL_OR_ERRNO { struct object *get_something, struct object *some_other_function };

如果这太痛苦了，您当然可以手动编写类型映射:

%typemap(out) struct object * %{
  if (!$1) {
    PyErr_SetFromErrno(PyExc_RuntimeError);
    SWIG_fail;
  }

  $result = SWIG_NewPointerObj(SWIG_as_voidptr($1), $1_descriptor, $owner);
%}

如果您确实希望到处都返回一个struct object*，那么这似乎是最简单的选择。

还有其他可能的使用 %pythoncode 或 %pythonappend 的解决方案，但在我看来，它们都没有真正比上述解决方案有所改进。