如何使用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绑定。 对于do_something绑定，如果它失败，我希望它返回基于errno的异常，如果成功，则返回Python None对象。 对于get_something绑定，我希望它在失败时返回基于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);
    }
}

我可以做这样的事情吗？ 如果我有这样的事情，那将解决例外情况。 而且我相信我的get_something绑定将是完美的。

如果我使用%typemap我的do_something绑定仍然需要这样的东西才能使其返回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 ，因为您想要的行为是由返回类型而不是所调用函数的名称确定的。 您还关心收益的事实进一步证明了这一点。 您可以在某种程度上避免重复使用$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解决方案，但在我看来，它们都不是对上述内容的真正改进。