如何使用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解決方案，但在我看來，它們都不是對上述內容的真正改進。