Question

我正在包装一个C库，该库在失败时将返回有限数量的错误代码之一。当发生错误时，我想将错误代码添加为C异常的属性，以便Python代码可以检索它并将错误代码映射到人类可读的异常。这可能吗？

例如，我想在Python层中执行此操作：

try:
    call_my_library_func()
except MyLibraryError as ex:
    print("Error code was %s" % ex.code)

我不喜欢的最接近的方法是使用PyErr_SetObject

PyObject *tuple = PyTuple_New(2);
PyTuple_SetItem(tuple, 0, PyUnicode_FromString("Helpful error message"));
PyTuple_SetItem(tuple, 1, PyLong_FromLong(257));
//PyErr_SetString(MyLibraryError, "Helpful error message\n");
PyErr_SetObject(MyLibraryError, tuple);

然后我可以这样做：

try:
    call_my_library_func()
except MyLibraryError as ex:
    message, code = ex.args[0], -1
    if len(ex.args > 1):
        code = ex.args[1]

Answer 1

C API异常处理的编写方式主要是通过其类，其参数（传递给构造函数）和其追溯来引发异常，因此，最好遵循该方案。将元组作为参数传递的基本方法可能是最好的选择。

不过，有两种方法可以使您的异常类在Python方面更易于使用：

您可以在自定义__init__方法中处理参数，以在类上设置code属性。
您将code定义为访问args[1]的异常类的属性。

我已经说明了选项2，但是我认为没有理由偏爱其中一个。

为简要说明以下示例代码：使用C API定义异常，您可以使用PyErr_NewException，它将一个可选的基类和字典作为其第二和第三个参数。使用的函数（__init__或属性定义）应该是字典的一部分。

要定义属性定义，我已经用Python编写了代码，并使用了PyRun_String，因为用Python编写的代码比使用C编写的代码更容易，而且我怀疑这段代码对性能至关重要。这些函数最终注入到传递给PyRun_String的全局字典中。

C代码：

#include <Python.h>

PyObject* make_getter_code() {
    const char* code = 
    "def code(self):\n"
    "  try:\n"
    "    return self.args[1]\n"
    "  except IndexError:\n"
    "    return -1\n"
    "code = property(code)\n"
    "def message(self):\n"
    "  try:\n"
    "    return self.args[0]\n"
    "  except IndexError:\n"
    "    return ''\n"
    "\n";

    PyObject* d = PyDict_New();
    PyDict_SetItemString(d, "__builtins__", PyEval_GetBuiltins());
    PyObject* output = PyRun_String(code,Py_file_input,d,d);
    if (output==NULL) {
        Py_DECREF(d);
        return NULL;
    }
    Py_DECREF(output);
    PyDict_DelItemString(d,"__builtins__"); /* __builtins__ should not be an attribute of the exception */
    return d;
}

static PyObject* MyLibraryError;

static PyObject* my_library_function(PyObject* self) {
    /* something's gone wrong */
    PyObject *tuple = PyTuple_New(2);
    PyTuple_SetItem(tuple, 0, PyUnicode_FromString("Helpful error message"));
    PyTuple_SetItem(tuple, 1, PyLong_FromLong(257));
    PyErr_SetObject(MyLibraryError, tuple);
    return NULL;
}

static PyMethodDef methods[] = {
    {"my_library_function",  my_library_function,  METH_NOARGS,
     "raise an error."},
    {NULL, NULL, 0, NULL}        /* Sentinel */
};

static struct PyModuleDef librarymodule = {
    PyModuleDef_HEAD_INIT,
    "library",   /* name of module */
    NULL, /* module documentation, may be NULL */
    -1,       /* size of per-interpreter state of the module,
                 or -1 if the module keeps state in global variables. */
    methods
};

PyMODINIT_FUNC
PyInit_library(void) {
    PyObject *m;
    m = PyModule_Create(&librarymodule);
    if (m == NULL)
        return NULL;

    PyObject* exc_dict = make_getter_code();
    if (exc_dict == NULL) {
        return NULL;
    }

    MyLibraryError = PyErr_NewException("library.MyLibraryError", 
                                        NULL, // use to pick base class
                                        exc_dict);
    PyModule_AddObject(m,"MyLibraryError",MyLibraryError);
    return m;
}

作为更优雅的Python界面的示例，您的Python代码更改为：

try:
    my_library_func()
except MyLibraryError as ex:
    message, code = ex.message, ex.code

附录：可以对当前设置的例外设置属性。基本方案如下：

PyErr_SetString(...) /* raise the exception with an error message */
PyObject *type, *value, *traceback;
PyErr_Fetch(&type, &value, &traceback); /* gets the values of the currently
   set exception and clears it */
PyObject_SetAttrString(value, "code", number);
PyErr_Restore(type,value,traceback); /* Re-sets the exception now including
   the error code */

这缺少任何错误检查。我想我仍然更喜欢将逻辑放入异常类的方法，但这就是您要执行的操作的方式。

Python C扩展将属性添加到异常

1 个答案: