如何从C扩展名返回Python枚举？

Question

我正在为Python编写一个C扩展，其中包含一个C库。 C库有一些枚举类型，我为此编写了相应的IntEnum，例如：

from enum import IntEnum
# _enum_consts is a C extension creating Python
# constants for the library's enum constants
from . import _enum_consts

class Align(IntEnum):
    DEFAULT = _enum_consts.MD_ALIGN_DEFAULT
    LEFT = _enum_consts.MD_ALIGN_LEFT
    CENTER = _enum_consts.MD_ALIGN_CENTER
    RIGHT = _enum_consts.MD_ALIGN_RIGHT

现在，在包装库的主要功能的C扩展中，一些库函数返回枚举类型，我想将它们转换为Python IntEnum值。 （我意识到我可以直接将int直接返回，并且它们可以成功地与IntEnum进行比较，但是这样做不能达到目的。）

问题是，如何创建要返回的IntEnum值？我能找到的所有示例都是使用PyModule_AddIntConstant()将C枚举常量转换为Python常量的方法（这正是_enum_consts扩展模块的作用）。

Answer 1

首先，需要将具有IntEnum的模块导入扩展模块（如果尚未执行此操作）。在模块初始化函数中：

PyMODINIT_FUNC PyInit_someextension(void)
{
    // ...

    PyObject *m;
    m = PyModule_Create(&someextension_module);
    if (m == NULL) {
        return NULL;
    }

    // ...

    // Import the enums module, where "somepackage.enums"
    // is the full name of the enums module
    PyObject *enums = PyImport_ImportModule("somepackage.enums");
    if (enums == NULL) {
        Py_DECREF(m);
        return NULL;
    }
    Py_DECREF(enums);

    return m;
}

然后，您要在其中实例化IntEnum值的位置，首先获取它再次插入的模块：

PyObject *enums = PyImport_AddModule("somepackage.enums");
if (enums == NULL) {
    // Return NULL, -1, etc. to signal an exception
}

紧接着，从模块中获取您的IntEnum类型（在这种情况下为Align）：

PyObject *align_enum = PyObject_GetAttrString(enums, "Align");
if (align_enum == NULL) {
    // Return NULL, -1, etc. to signal an exception
}

然后，您可以创建所需的实例（注意，align这里将是用于初始化它的值）。我们通过调用类型对象来做到这一点，就像在常规Python中一样（请注意PyObject_CallFunction实际上并不限于调用函数，它可以调用任何可调用对象）：

PyObject *align_instance = PyObject_CallFunction(align_enum, "(i)", align);
if (align_instance == NULL) {
    Py_DECREF(align_enum);
    // Return NULL, -1, etc. to signal an exception
}

现在，align_instance包含要返回的IntEnum实例。返回之前请务必先单击Py_DECREF(align_enum)。