pybind11模拟python枚举行为

时间:2018-09-22 18:13:55

标签: python c++ enums pybind11

我正在使用pybind11为我的C ++库提供Python接口。我的库中包含一些枚举,为此我提供了一些便利功能,以允许遍历枚举值并将其转换为字符串。例如

template <typename Enum>
struct iter_enum
{
    struct iterator
    {
        using value_type = Enum;
        using difference_type = ptrdiff_t;
        using reference = const Enum&;
        using pointer = const Enum*;
        using iterator_category = std::input_iterator_tag;

        iterator(Enum value) : cur(value) {}

        reference operator * () { return cur; }
        pointer operator -> () { return &cur; }
        bool operator == (const iterator& other) { return cur == other.cur; }
        bool operator != (const iterator&other) { return!(*this == other); }
        iterator& operator ++ () { if (cur != Enum::Unknown) cur = static_cast<Enum>(static_cast<std::underlying_type_t<Enum>>(cur) + 1); return *this; }
        iterator operator ++ (int) { iterator other = *this; ++(*this); return other; }
    private:
        Enum cur;
    };

    iterator begin()
    {
        return iterator(static_cast<Enum>(0));
    }

    iterator end()
    {
        return iterator(Enum::Unknown);
    }
};

enum class Colour : char
{
    Black = 0,
    Blue,
    Red,
    Yellow,
    Unknown
};

const char* to_string(Colour colour)
{
    switch (colour) {
    case Colour::Black: return "Black";
    case Colour::Blue: return "Blue";
    case Colour::Red: return "Red";
    case Colour::Yellow: return "Yellow";
    default: return "Unknown";
    }
}

int main()
{
    for (auto colour : iter_enum<Colour>())
        std::cout << to_string(colour) << '\n';
}

当使用pybind11移植此类代码时,我当前将迭代器定义为静态成员函数,

 pybind11::enum_<Colour>(m, "Colour")
    .value("Black", Colour::Black)
    // add other values and __str__
    .def_static("iter", []() { 
        iter_enum<Colour> i; 
        return pybind11::make_iterator(i.begin(), i.end(); 
    });

但是我希望能够在Python方面写出类似

for c in Colour:
    print("Colour")

就像我使用Python的enum.Enum定义的枚举一样。我知道我可以使用元类在Python中实现此功能,但是我无法从在元类here和示例on github(第334行)中可以找到的pybind11文档中解决如何编写这样一个C ++端的元类。据我所知,看起来必须使用C API PyObject类型公开元类。

任何有关我是否处在正确轨道上的信息,以及如果这样的话,如何编写使用我的iter_enum类的元类的信息,将不胜感激。

1 个答案:

答案 0 :(得分:1)

您也许可以使用如下所示的内容迭代 pybind11 公开的 C++ 枚举。

for name, enum_value in Color.__members__.items():
    print(name, enum_value)

我发现这种方法可行的方法是运行 dir(EnumClass) 并查看所有可用的私有属性,其中 __members__ 就是其中之一。