如何从C扩展中引发Python异常？

在许多情况下，我们需要在Python环境中使用C或C++库。Python提供了C API来支持这个需求。然而，在使用C API时，如何从C扩展中引发Python异常是一个需要注意的问题。

C API中的异常处理

在Python中，我们使用raise语句来引发异常。在C API中，PyErr_SetString函数可以用于引发Python异常。

#include <Python.h>

static PyObject *spam(PyObject *self, PyObject *args) {
    char *msg;
    if (!PyArg_ParseTuple(args, "s", &msg)) {
        return NULL;
    }
    if (strcmp(msg, "foo") == 0) {
        PyErr_SetString(PyExc_ValueError, "foo is not valid input!");
        return NULL;
    }
    Py_RETURN_NONE;
}

static PyMethodDef spam_methods[] = {
    {"spam", spam, METH_VARARGS, "My sample function"},
    {NULL, NULL, 0, NULL}
};

static struct PyModuleDef spam_definition = { 
    PyModuleDef_HEAD_INIT,
    "spam",
    "A sample module",
    -1, 
    spam_methods
};

PyMODINIT_FUNC PyInit_spam(void) {
    Py_Initialize();
    return PyModule_Create(&spam_definition);
}

在这个示例代码中，我们定义了spam函数，它会检查传入的参数是否是“foo”，如果是则引发ValueError异常。我们使用PyErr_SetString函数来实现这个异常的引发。

宏和函数

PyCFunction对象是C API中最常用的类型之一。它作为一个C函数和Python解释器之间的桥梁，允许我们通过Python解释器从C代码中调用函数。

C API提供了一些有用的宏和函数，来方便我们在PyCFunction中引发Python异常。

PyErr_Format函数

PyErr_Format函数格式化一个字符串，并将其作为异常信息引发。与Python的raise语句不同，PyErr_Format可以使用C语言中的%提供的占位符格式化异常信息。

PyErr_Format(PyExc_valueError, "Invalid input: %s", msg);

PyErr_SetFromErrno函数

PyErr_SetFromErrno函数引发一个OSError异常，并将errno与相关消息的描述信息连接。这个函数比较有用，因为它可以减少C代码中的重复性，并且它可以更好地处理特定的操作系统错误。

if (fd == -1) {
    PyErr_SetFromErrno(PyExc_OSError);
    return NULL;
}

PyErr_SetObject函数

PyErr_SetObject函数引发一个由PyObject类别和对象提供的异常。与PyErr_SetString不同，它接受一个表示异常类别的PyObject对象，而不只是一个字符串。

if (ptr == NULL) {
    PyErr_SetObject(PyExc_RuntimeError, PyUnicode_FromString("Failed to allocate memory"));
    return NULL;
}

自定义异常

我们也可以在C代码中定义Python异常。有时候，这对于特定的任务非常有用。

我们可以使用PyExc_类别或者PyErr_NewException来定义异常类。我们可以将这个异常类的名称传给PyExc_NewException函数，它将创建一个Python异常类对象。我们还可以用PyExc_Exception生成一个通用的异常类。

static PyObject* MyException_error = NULL;

static PyObject* MyException_raise(PyObject *self, PyObject *args) {
    PyErr_SetString(MyException_error, "Something went wrong");
    return NULL;
}

static PyMethodDef MyException_methods[] = {
    { "raise", (PyCFunction)MyException_raise, METH_NOARGS, "Raise an exception" },
    { NULL }
};

static struct PyModuleDef MyException_definition = { 
    PyModuleDef_HEAD_INIT,
    "MyException",
    "A sample module for custom exception",
    -1, 
    MyException_methods
};

PyMODINIT_FUNC PyInit_MyException(void) {
    PyObject *module = PyModule_Create(&MyException_definition);
    if (module == NULL) {
        return NULL;
    }
    MyException_error = PyErr_NewException("MyException.Error", PyExc_Exception, NULL);
    PyModule_AddObject(module, "Error", MyException_error);
    return module;
}

在这个示例代码中，我们定义了一个叫做MyException的Python模块，它包含一个自定义异常类。该异常类的名称是“MyException.Error”。