正如评论中所建议的,该enum
模块在这里提供了一个很好的解决方案。通过混合str
with enum.Enum
,我们可以创建一个Enum
完全向后兼容的 with str
(即,可以在任何需要str
类型的地方使用。
from enum import Enum
# The mixin type has to come first if you're combining
# enum.Enum with other types
class Values(str, Enum):
N1 = 'One'
N2 = 'Two'
N3 = 'Three'
如果我们将此定义输入交互式控制台,我们将看到该类具有以下行为:
>>> Values['N1']
<Values.N1: 'One'>
>>> Values('One')
<Values.N1: 'One'>
>>> Values.N1
<Values.N1: 'One'>
>>> Values('One') is Values.N1 is Values['N1']
True
>>> Values.N1.name
'N1'
>>> Values.N1.value
'One'
>>> Values.N1 == 'One'
True
>>> Values.N1 is 'One'
False
>>> Values.N1.startswith('On')
True
>>> type(Values.N1)
<enum 'Values'>
>>> for key in Values:
... print(key)
...
Values.N1
Values.N2
Values.N3
>>> list(Values)
[Values.N1, Values.N2, Values.N3]
如您所见,我们定义了一个新类型:
- 提供对成员的动态字典式访问,以及更多类型安全的访问形式。
- 完全向后兼容
str
——它可以自由地与str
对象进行比较,并且str
可以在其成员上使用方法。
- 可以在类型提示中用作
typing.Literal
. 如果我有这样的功能:
def do_something(some_string):
if some_string not in ('One', 'Two', 'Three'):
raise Exception('NO.')
然后我可以像这样注释它:
from typing import Literal
def do_something(some_string: Literal['One', 'Two', 'Three']) -> None:
...
或像这样(在这种情况下,您必须传入Values
枚举成员而不是普通字符串,否则类型检查器将引发错误):
# Values enum as defined above
def do_something(some_string: Values) -> None:
...
这里有一个更详细的关于 python Enum
s的复杂性的指南。