54

Python 3.4 引入了一个新模块enum，它为语言添加了枚举类型。的文档enum.Enum提供了一个示例来演示如何扩展它：

>>> class Planet(Enum):
...     MERCURY = (3.303e+23, 2.4397e6)
...     VENUS   = (4.869e+24, 6.0518e6)
...     EARTH   = (5.976e+24, 6.37814e6)
...     MARS    = (6.421e+23, 3.3972e6)
...     JUPITER = (1.9e+27,   7.1492e7)
...     SATURN  = (5.688e+26, 6.0268e7)
...     URANUS  = (8.686e+25, 2.5559e7)
...     NEPTUNE = (1.024e+26, 2.4746e7)
...     def __init__(self, mass, radius):
...         self.mass = mass       # in kilograms
...         self.radius = radius   # in meters
...     @property
...     def surface_gravity(self):
...         # universal gravitational constant  (m3 kg-1 s-2)
...         G = 6.67300E-11
...         return G * self.mass / (self.radius * self.radius)
...
>>> Planet.EARTH.value
(5.976e+24, 6378140.0)
>>> Planet.EARTH.surface_gravity
9.802652743337129

此示例还演示了一个问题Enum：在属性方法中，定义了一个通常在类级别定义surface_gravity()的常量- 但尝试在 an 内部这样做只会将其添加为枚举的成员之一，因此它一直是在方法内部定义。GEnum

如果类想在其他方法中使用这个常量，它也必须在那里定义，这显然是不理想的。

有没有办法在 中定义一个类常量Enum，或者一些解决方法来达到相同的效果？

4

5 回答 5

48

这是一种高级行为，90% 以上的枚举都不需要。

根据文档：

允许的规则如下：_sunder_名称（以单个下划线开头和结尾）由枚举保留，不能使用；枚举中定义的所有其他属性都将成为该枚举的成员，除了__dunder__名称和descriptors（方法也是描述符）。

所以如果你想要一个类常量，你有几个选择：

  • 创建它__init__
  • 在创建类后添加它
  • 使用混合
  • 创建你自己的descriptor

创建常量__init__并在创建类后添加它都受到没有将所有类信息收集在一个地方的困扰。

在适当的时候当然可以使用 Mixins（参见 dnozay 的回答以获得一个很好的例子），但这种情况也可以通过使用Enum内置实际常量的基类来简化。

首先，将在以下示例中使用的常量：

class Constant:  # use Constant(object) if in Python 2
    def __init__(self, value):
        self.value = value
    def __get__(self, *args):
        return self.value
    def __repr__(self):
        return '%s(%r)' % (self.__class__.__name__, self.value)

以及一次性使用的枚举示例：

from enum import Enum

class Planet(Enum):
    MERCURY = (3.303e+23, 2.4397e6)
    VENUS   = (4.869e+24, 6.0518e6)
    EARTH   = (5.976e+24, 6.37814e6)
    MARS    = (6.421e+23, 3.3972e6)
    JUPITER = (1.9e+27,   7.1492e7)
    SATURN  = (5.688e+26, 6.0268e7)
    URANUS  = (8.686e+25, 2.5559e7)
    NEPTUNE = (1.024e+26, 2.4746e7)

    # universal gravitational constant
    G = Constant(6.67300E-11)

    def __init__(self, mass, radius):
        self.mass = mass       # in kilograms
        self.radius = radius   # in meters
    @property
    def surface_gravity(self):
        return self.G * self.mass / (self.radius * self.radius)

print(Planet.__dict__['G'])             # Constant(6.673e-11)
print(Planet.G)                         # 6.673e-11
print(Planet.NEPTUNE.G)                 # 6.673e-11
print(Planet.SATURN.surface_gravity)    # 10.44978014597121

最后，多用途枚举示例：

from enum import Enum

class AstronomicalObject(Enum):

    # universal gravitational constant
    G = Constant(6.67300E-11)

    def __init__(self, mass, radius):
        self.mass = mass
        self.radius = radius
    @property
    def surface_gravity(self):
        return self.G * self.mass / (self.radius * self.radius)

class Planet(AstronomicalObject):
    MERCURY = (3.303e+23, 2.4397e6)
    VENUS   = (4.869e+24, 6.0518e6)
    EARTH   = (5.976e+24, 6.37814e6)
    MARS    = (6.421e+23, 3.3972e6)
    JUPITER = (1.9e+27,   7.1492e7)
    SATURN  = (5.688e+26, 6.0268e7)
    URANUS  = (8.686e+25, 2.5559e7)
    NEPTUNE = (1.024e+26, 2.4746e7)

class Asteroid(AstronomicalObject):
    CERES = (9.4e+20 , 4.75e+5)
    PALLAS = (2.068e+20, 2.72e+5)
    JUNOS = (2.82e+19, 2.29e+5)
    VESTA = (2.632e+20 ,2.62e+5

Planet.MERCURY.surface_gravity    # 3.7030267229659395
Asteroid.CERES.surface_gravity    # 0.27801085872576176

注意：

Constant G真的不是。一个人可以重新绑定G到别的东西：

Planet.G = 1

如果你真的需要它保持不变（也就是不可重新绑定），那么使用新的 aenum 库[1] 它将阻止重新分配constants 以及Enum成员的尝试。

1披露：我是Python stdlibEnum、enum34backport和Advanced Enumeration ( aenum) 库的作者。

于 2013-08-03T16:49:40.837 回答
15

最优雅的解决方案（恕我直言）是使用 mixins / 基类来提供正确的行为。

  • 基类来提供所有实现所需的行为，例如Satellite和Planet.
  • 如果您决定提供可选行为（例如Satellite并且Planet可能必须提供不同的行为），mixin 会很有趣

这是一个示例，您首先在其中定义您的行为：

#
# business as usual, define your class, methods, constants...
#
class AstronomicalObject:
    # universal gravitational constant
    G = 6.67300E-11
    def __init__(self, mass, radius):
        self.mass = mass       # in kilograms
        self.radius = radius   # in meters

class PlanetModel(AstronomicalObject):
    @property
    def surface_gravity(self):
        return self.G * self.mass / (self.radius * self.radius)

class SatelliteModel(AstronomicalObject):
    FUEL_PRICE_PER_KG = 20000
    @property
    def fuel_cost(self):
        return self.FUEL_PRICE_PER_KG * self.mass
    def falling_rate(self, destination):
        return complicated_formula(self.G, self.mass, destination)

然后Enum使用正确的基类/mixin 创建你的。

#
# then create your Enum with the correct model.
#
class Planet(PlanetModel, Enum):
    MERCURY = (3.303e+23, 2.4397e6)
    VENUS   = (4.869e+24, 6.0518e6)
    EARTH   = (5.976e+24, 6.37814e6)
    MARS    = (6.421e+23, 3.3972e6)
    JUPITER = (1.9e+27,   7.1492e7)
    SATURN  = (5.688e+26, 6.0268e7)
    URANUS  = (8.686e+25, 2.5559e7)
    NEPTUNE = (1.024e+26, 2.4746e7)

class Satellite(SatelliteModel, Enum):
    GPS1 = (12.0, 1.7)
    GPS2 = (22.0, 1.5)
于 2013-08-06T08:33:26.800 回答
9 
from enum import Enum


class classproperty(object):
    """A class property decorator"""

    def __init__(self, getter):
        self.getter = getter

    def __get__(self, instance, owner):
        return self.getter(owner)


class classconstant(object):
    """A constant property from given value,
       visible in class and instances"""

    def __init__(self, value):
        self.value = value

    def __get__(self, instance, owner):
        return self.value


class strictclassconstant(classconstant):
    """A constant property that is
       callable only from the class """

    def __get__(self, instance, owner):
        if instance:
            raise AttributeError(
                "Strict class constants are not available in instances")

        return self.value


class Planet(Enum):
    MERCURY = (3.303e+23, 2.4397e6)
    VENUS   = (4.869e+24, 6.0518e6)
    EARTH   = (5.976e+24, 6.37814e6)
    MARS    = (6.421e+23, 3.3972e6)
    JUPITER = (1.9e+27,   7.1492e7)
    SATURN  = (5.688e+26, 6.0268e7)
    URANUS  = (8.686e+25, 2.5559e7)
    NEPTUNE = (1.024e+26, 2.4746e7)
    def __init__(self, mass, radius):
        self.mass = mass       # in kilograms
        self.radius = radius   # in meters

    G = classconstant(6.67300E-11)

    @property
    def surface_gravity(self):
        # universal gravitational constant  (m3 kg-1 s-2)
        return Planet.G * self.mass / (self.radius * self.radius)


print(Planet.MERCURY.surface_gravity)
print(Planet.G)
print(Planet.MERCURY.G)

class ConstantExample(Enum):
    HAM  = 1
    SPAM = 2


    @classproperty
    def c1(cls):
        return 1

    c2 = classconstant(2)

    c3 = strictclassconstant(3)

print(ConstantExample.c1, ConstantExample.HAM.c1)
print(ConstantExample.c2, ConstantExample.SPAM.c2)
print(ConstantExample.c3)


# This should fail:
print(ConstantExample.HAM.c3)

@property 不起作用而 classconstant 起作用的原因很简单，并在此处的答案中进行了解释

通过类 Hello.foo 访问它时返回实际属性对象的原因在于该属性如何实现 __get__(self, instance, owner)特殊方法。如果在实例上访问描述符，则将该实例作为适当的参数传递，并且所有者是该实例的类。

另一方面，如果通过类访问它，则实例为 None 并且仅传递所有者。属性对象识别这一点并返回 self。

因此，中的代码classproperty实际上是对 的概括property，缺少if instance is None部分。

于 2013-07-31T02:12:27.153 回答
4

Aproperty可用于提供类常量的大部分行为：

class Planet(Enum):

    # ...

    @property
    def G(self):
        return 6.67300E-11

    # ...

    @property
    def surface_gravity(self):
        return self.G * self.mass / (self.radius * self.radius)

如果您想定义大量常量，这将有点笨拙，因此您可以在类之外定义一个辅助函数：

def constant(c):
    """Return a class property that returns `c`."""
    return property(lambda self: c)

...并按如下方式使用它：

class Planet(Enum):

    # ...

    G = constant(6.67300E-11)

这种方法的一个限制是它只适用于类的实例，而不是类本身：

>>> Planet.EARTH.G
6.673e-11
>>> Planet.G
<property object at 0x7f665921ce58>
于 2013-07-28T18:05:21.987 回答
-3

TLDR；不，它不能在 Enum 类中完成。

这就是说，正如其他答案所示，有一些方法可以获得与枚举相关联的此类拥有的值（即通过类继承/混合），但此类值不是“在枚举中定义的……”。

于 2017-04-05T16:59:15.983 回答