是否有用于标志/位掩码操作的 Python 类/枚举？

Question

我知道基类Enum 和IntEnum。两者都非常有帮助，但我错过了标志操作的功能。我不希望这两个类实现我想要的功能。

让我们构造一个例子：

class NetlistKind(IntEnum):
  Unknown = 0
  LatticeNetlist = 1
  QuartusNetlist = 2
  XSTNetlist = 4
  CoreGenNetlist = 8
  All = 15

如您所见，我已经在使用IntEnum 来获取此枚举的算术功能。最好有类似@unique 的东西来确保所有值都是2 的幂。我可以通过根据我的需要分叉 enum.unique 来做到这一点。 （我知道All 是该规则的一个例外。）

这样的枚举是如何使用的？

filter = NetlistKind.LatticeNetlist | NetlistKind.QuartusNetlist

由于底层的 int 位操作是可能的，并且过滤器的内部值为 3。

如果有一个“在过滤器 Y 中设置标志 X”功能甚至更好的运算符会很好。我为x in y添加了一个魔术函数：

@unique
class NetlistKind(IntEnum):
  Unknown = 0
  LatticeNetlist = 1
  QuartusNetlist = 2
  XSTNetlist = 4
  CoreGenNetlist = 8
  All = 15

  def __contains__(self, item):
    return  (self.value & item.value) == item.value

使用示例：

....
  def GetNetlists(self, filter=NetlistKind.All):
    for entity in self._entities:
      for nl in entity.GetNetlists():
        if (nl.kind in filter):
          yield nl

  def GetXilinxNetlists(self):
    return self.GetNetlists(NetlistKind.XSTNetlist | NetlistKind.CoreGenNetlist)

所以问题是：

• 有没有更好的方法来实现位域？
• 有没有更好的方法来实现这样的一维滤波器？我不想将 lamdas 用于如此简单的过滤条件？
• Python 标准库中是否已包含此类解决方案？
• 如何将此枚举扩展添加到下一个 Python 版本？ :)

开放功能：

• 返回__str__ 中所有活动标志的列表
• ...?

Answer 1

Python 3.6 添加了Flag 和IntFlag，它们支持通常的按位操作。作为奖励，按位运算的结果值仍然是原始标志类的成员，并且是单例 [1]。

aenum 库也有这个附加功能，并且可以在 Python 2.7 中使用。

[1] 3.6.0 中存在一个错误：如果伪标志成员是在线程中创建的，那么最终可能会出现重复；这在 3.6.1 中已修复（在 aenum 中从未存在过）。

Answer 2

我最近发布了一个针对这个问题的开源包py-flags。该库正是具有此功能，其设计深受 python3 枚举模块的影响。

关于实现这样一个标志类是否足够pythonic存在争议，因为它的功能与该语言提供的其他方法（布尔变量的集合、集合、具有布尔属性的对象或具有布尔项的字典、. ..)。出于这个原因，我觉得标志类的目的太窄和/或多余，无法进入标准库，但在某些情况下，它比之前列出的解决方案要好得多，因此可以使用“pip install”库好用。

使用 py-flags 模块，您的示例将如下所示：

from flags import Flags

class NetlistKind(Flags):
    Unknown = 0
    LatticeNetlist = 1
    QuartusNetlist = 2
    XSTNetlist = 4
    CoreGenNetlist = 8
    All = 15

上述内容可以进一步调整，因为使用库声明的标志类会自动提供两个“虚拟”标志：NetlistKind.no_flags 和NetlistKind.all_flags。这些使已经声明的NetlistKind.Unknown 和NetlistKind.All 变得多余，因此我们可以将它们从声明中排除，但问题是no_flags 和all_flags 不符合您的命名约定。为了帮助实现这一点，我们在您的项目中声明了一个标志基类，而不是 flags.Flags，您必须在项目的其余部分中使用它：

from flags import Flags

class BaseFlags(Flags):
    __no_flags_name__ = 'Unknown'
    __all_flags_name__ = 'All'

基于之前声明的基类，可以由您项目中的任何标志子类化，我们可以将您的标志声明更改为：

class NetlistKind(BaseFlags):
    LatticeNetlist = 1
    QuartusNetlist = 2
    XSTNetlist = 4
    CoreGenNetlist = 8

这样NetlistKind.Unknown 会自动声明为零值。 NetlistKind.All 也在那里，它自动组合了所有声明的标志。可以使用/不使用这些虚拟标志来迭代枚举成员。您还可以声明别名（与另一个先前声明的标志具有相同值的标志）。

作为使用“函数调用样式”的替代声明（也由标准枚举模块提供）：

NetlistKind = BaseFlags('NetlistKind', ['LatticeNetlist', 'QuartusNetlist',
                                        'XSTNetlist', 'CoreGenNetlist'])

如果一个标志类声明了一些成员，那么它被认为是最终的。尝试对其进行子类化将导致错误。出于添加新成员或更改功能的目的，允许子类化标志类在语义上是不希望的。

除此之外，flags 类以类型安全的方式提供您列出的运算符（布尔运算符、in、迭代等）。在接下来的几天里，我将完成 README.rst 并在包界面上进行一些尝试，但基本功能已经存在，并且经过了很好的测试。