enum.py 77 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040
  1. import sys
  2. import builtins as bltns
  3. from types import MappingProxyType, DynamicClassAttribute
  4. from operator import or_ as _or_
  5. from functools import reduce
  6. __all__ = [
  7. 'EnumType', 'EnumMeta',
  8. 'Enum', 'IntEnum', 'StrEnum', 'Flag', 'IntFlag', 'ReprEnum',
  9. 'auto', 'unique', 'property', 'verify', 'member', 'nonmember',
  10. 'FlagBoundary', 'STRICT', 'CONFORM', 'EJECT', 'KEEP',
  11. 'global_flag_repr', 'global_enum_repr', 'global_str', 'global_enum',
  12. 'EnumCheck', 'CONTINUOUS', 'NAMED_FLAGS', 'UNIQUE',
  13. ]
  14. # Dummy value for Enum and Flag as there are explicit checks for them
  15. # before they have been created.
  16. # This is also why there are checks in EnumType like `if Enum is not None`
  17. Enum = Flag = EJECT = _stdlib_enums = ReprEnum = None
  18. class nonmember(object):
  19. """
  20. Protects item from becoming an Enum member during class creation.
  21. """
  22. def __init__(self, value):
  23. self.value = value
  24. class member(object):
  25. """
  26. Forces item to become an Enum member during class creation.
  27. """
  28. def __init__(self, value):
  29. self.value = value
  30. def _is_descriptor(obj):
  31. """
  32. Returns True if obj is a descriptor, False otherwise.
  33. """
  34. return (
  35. hasattr(obj, '__get__') or
  36. hasattr(obj, '__set__') or
  37. hasattr(obj, '__delete__')
  38. )
  39. def _is_dunder(name):
  40. """
  41. Returns True if a __dunder__ name, False otherwise.
  42. """
  43. return (
  44. len(name) > 4 and
  45. name[:2] == name[-2:] == '__' and
  46. name[2] != '_' and
  47. name[-3] != '_'
  48. )
  49. def _is_sunder(name):
  50. """
  51. Returns True if a _sunder_ name, False otherwise.
  52. """
  53. return (
  54. len(name) > 2 and
  55. name[0] == name[-1] == '_' and
  56. name[1:2] != '_' and
  57. name[-2:-1] != '_'
  58. )
  59. def _is_internal_class(cls_name, obj):
  60. # do not use `re` as `re` imports `enum`
  61. if not isinstance(obj, type):
  62. return False
  63. qualname = getattr(obj, '__qualname__', '')
  64. s_pattern = cls_name + '.' + getattr(obj, '__name__', '')
  65. e_pattern = '.' + s_pattern
  66. return qualname == s_pattern or qualname.endswith(e_pattern)
  67. def _is_private(cls_name, name):
  68. # do not use `re` as `re` imports `enum`
  69. pattern = '_%s__' % (cls_name, )
  70. pat_len = len(pattern)
  71. if (
  72. len(name) > pat_len
  73. and name.startswith(pattern)
  74. and name[pat_len:pat_len+1] != ['_']
  75. and (name[-1] != '_' or name[-2] != '_')
  76. ):
  77. return True
  78. else:
  79. return False
  80. def _is_single_bit(num):
  81. """
  82. True if only one bit set in num (should be an int)
  83. """
  84. if num == 0:
  85. return False
  86. num &= num - 1
  87. return num == 0
  88. def _make_class_unpicklable(obj):
  89. """
  90. Make the given obj un-picklable.
  91. obj should be either a dictionary, or an Enum
  92. """
  93. def _break_on_call_reduce(self, proto):
  94. raise TypeError('%r cannot be pickled' % self)
  95. if isinstance(obj, dict):
  96. obj['__reduce_ex__'] = _break_on_call_reduce
  97. obj['__module__'] = '<unknown>'
  98. else:
  99. setattr(obj, '__reduce_ex__', _break_on_call_reduce)
  100. setattr(obj, '__module__', '<unknown>')
  101. def _iter_bits_lsb(num):
  102. # num must be a positive integer
  103. original = num
  104. if isinstance(num, Enum):
  105. num = num.value
  106. if num < 0:
  107. raise ValueError('%r is not a positive integer' % original)
  108. while num:
  109. b = num & (~num + 1)
  110. yield b
  111. num ^= b
  112. def show_flag_values(value):
  113. return list(_iter_bits_lsb(value))
  114. def bin(num, max_bits=None):
  115. """
  116. Like built-in bin(), except negative values are represented in
  117. twos-compliment, and the leading bit always indicates sign
  118. (0=positive, 1=negative).
  119. >>> bin(10)
  120. '0b0 1010'
  121. >>> bin(~10) # ~10 is -11
  122. '0b1 0101'
  123. """
  124. ceiling = 2 ** (num).bit_length()
  125. if num >= 0:
  126. s = bltns.bin(num + ceiling).replace('1', '0', 1)
  127. else:
  128. s = bltns.bin(~num ^ (ceiling - 1) + ceiling)
  129. sign = s[:3]
  130. digits = s[3:]
  131. if max_bits is not None:
  132. if len(digits) < max_bits:
  133. digits = (sign[-1] * max_bits + digits)[-max_bits:]
  134. return "%s %s" % (sign, digits)
  135. def _dedent(text):
  136. """
  137. Like textwrap.dedent. Rewritten because we cannot import textwrap.
  138. """
  139. lines = text.split('\n')
  140. blanks = 0
  141. for i, ch in enumerate(lines[0]):
  142. if ch != ' ':
  143. break
  144. for j, l in enumerate(lines):
  145. lines[j] = l[i:]
  146. return '\n'.join(lines)
  147. class _auto_null:
  148. def __repr__(self):
  149. return '_auto_null'
  150. _auto_null = _auto_null()
  151. class auto:
  152. """
  153. Instances are replaced with an appropriate value in Enum class suites.
  154. """
  155. def __init__(self, value=_auto_null):
  156. self.value = value
  157. def __repr__(self):
  158. return "auto(%r)" % self.value
  159. class property(DynamicClassAttribute):
  160. """
  161. This is a descriptor, used to define attributes that act differently
  162. when accessed through an enum member and through an enum class.
  163. Instance access is the same as property(), but access to an attribute
  164. through the enum class will instead look in the class' _member_map_ for
  165. a corresponding enum member.
  166. """
  167. def __get__(self, instance, ownerclass=None):
  168. if instance is None:
  169. try:
  170. return ownerclass._member_map_[self.name]
  171. except KeyError:
  172. raise AttributeError(
  173. '%r has no attribute %r' % (ownerclass, self.name)
  174. )
  175. else:
  176. if self.fget is None:
  177. raise AttributeError(
  178. '%r member has no attribute %r' % (ownerclass, self.name)
  179. )
  180. else:
  181. return self.fget(instance)
  182. def __set__(self, instance, value):
  183. if self.fset is None:
  184. raise AttributeError(
  185. "<enum %r> cannot set attribute %r" % (self.clsname, self.name)
  186. )
  187. else:
  188. return self.fset(instance, value)
  189. def __delete__(self, instance):
  190. if self.fdel is None:
  191. raise AttributeError(
  192. "<enum %r> cannot delete attribute %r" % (self.clsname, self.name)
  193. )
  194. else:
  195. return self.fdel(instance)
  196. def __set_name__(self, ownerclass, name):
  197. self.name = name
  198. self.clsname = ownerclass.__name__
  199. class _proto_member:
  200. """
  201. intermediate step for enum members between class execution and final creation
  202. """
  203. def __init__(self, value):
  204. self.value = value
  205. def __set_name__(self, enum_class, member_name):
  206. """
  207. convert each quasi-member into an instance of the new enum class
  208. """
  209. # first step: remove ourself from enum_class
  210. delattr(enum_class, member_name)
  211. # second step: create member based on enum_class
  212. value = self.value
  213. if not isinstance(value, tuple):
  214. args = (value, )
  215. else:
  216. args = value
  217. if enum_class._member_type_ is tuple: # special case for tuple enums
  218. args = (args, ) # wrap it one more time
  219. if not enum_class._use_args_:
  220. enum_member = enum_class._new_member_(enum_class)
  221. if not hasattr(enum_member, '_value_'):
  222. try:
  223. enum_member._value_ = enum_class._member_type_(*args)
  224. except Exception as exc:
  225. enum_member._value_ = value
  226. else:
  227. enum_member = enum_class._new_member_(enum_class, *args)
  228. if not hasattr(enum_member, '_value_'):
  229. if enum_class._member_type_ is object:
  230. enum_member._value_ = value
  231. else:
  232. try:
  233. enum_member._value_ = enum_class._member_type_(*args)
  234. except Exception as exc:
  235. raise TypeError(
  236. '_value_ not set in __new__, unable to create it'
  237. ) from None
  238. value = enum_member._value_
  239. enum_member._name_ = member_name
  240. enum_member.__objclass__ = enum_class
  241. enum_member.__init__(*args)
  242. enum_member._sort_order_ = len(enum_class._member_names_)
  243. # If another member with the same value was already defined, the
  244. # new member becomes an alias to the existing one.
  245. try:
  246. try:
  247. # try to do a fast lookup to avoid the quadratic loop
  248. enum_member = enum_class._value2member_map_[value]
  249. except TypeError:
  250. for name, canonical_member in enum_class._member_map_.items():
  251. if canonical_member._value_ == value:
  252. enum_member = canonical_member
  253. break
  254. else:
  255. raise KeyError
  256. except KeyError:
  257. # this could still be an alias if the value is multi-bit and the
  258. # class is a flag class
  259. if (
  260. Flag is None
  261. or not issubclass(enum_class, Flag)
  262. ):
  263. # no other instances found, record this member in _member_names_
  264. enum_class._member_names_.append(member_name)
  265. elif (
  266. Flag is not None
  267. and issubclass(enum_class, Flag)
  268. and _is_single_bit(value)
  269. ):
  270. # no other instances found, record this member in _member_names_
  271. enum_class._member_names_.append(member_name)
  272. # get redirect in place before adding to _member_map_
  273. # but check for other instances in parent classes first
  274. need_override = False
  275. descriptor = None
  276. for base in enum_class.__mro__[1:]:
  277. descriptor = base.__dict__.get(member_name)
  278. if descriptor is not None:
  279. if isinstance(descriptor, (property, DynamicClassAttribute)):
  280. break
  281. else:
  282. need_override = True
  283. # keep looking for an enum.property
  284. if descriptor and not need_override:
  285. # previous enum.property found, no further action needed
  286. pass
  287. elif descriptor and need_override:
  288. redirect = property()
  289. redirect.__set_name__(enum_class, member_name)
  290. # Previous enum.property found, but some other inherited attribute
  291. # is in the way; copy fget, fset, fdel to this one.
  292. redirect.fget = descriptor.fget
  293. redirect.fset = descriptor.fset
  294. redirect.fdel = descriptor.fdel
  295. setattr(enum_class, member_name, redirect)
  296. else:
  297. setattr(enum_class, member_name, enum_member)
  298. # now add to _member_map_ (even aliases)
  299. enum_class._member_map_[member_name] = enum_member
  300. try:
  301. # This may fail if value is not hashable. We can't add the value
  302. # to the map, and by-value lookups for this value will be
  303. # linear.
  304. enum_class._value2member_map_.setdefault(value, enum_member)
  305. except TypeError:
  306. # keep track of the value in a list so containment checks are quick
  307. enum_class._unhashable_values_.append(value)
  308. class _EnumDict(dict):
  309. """
  310. Track enum member order and ensure member names are not reused.
  311. EnumType will use the names found in self._member_names as the
  312. enumeration member names.
  313. """
  314. def __init__(self):
  315. super().__init__()
  316. self._member_names = {} # use a dict to keep insertion order
  317. self._last_values = []
  318. self._ignore = []
  319. self._auto_called = False
  320. def __setitem__(self, key, value):
  321. """
  322. Changes anything not dundered or not a descriptor.
  323. If an enum member name is used twice, an error is raised; duplicate
  324. values are not checked for.
  325. Single underscore (sunder) names are reserved.
  326. """
  327. if _is_internal_class(self._cls_name, value):
  328. import warnings
  329. warnings.warn(
  330. "In 3.13 classes created inside an enum will not become a member. "
  331. "Use the `member` decorator to keep the current behavior.",
  332. DeprecationWarning,
  333. stacklevel=2,
  334. )
  335. if _is_private(self._cls_name, key):
  336. # also do nothing, name will be a normal attribute
  337. pass
  338. elif _is_sunder(key):
  339. if key not in (
  340. '_order_',
  341. '_generate_next_value_', '_numeric_repr_', '_missing_', '_ignore_',
  342. '_iter_member_', '_iter_member_by_value_', '_iter_member_by_def_',
  343. ):
  344. raise ValueError(
  345. '_sunder_ names, such as %r, are reserved for future Enum use'
  346. % (key, )
  347. )
  348. if key == '_generate_next_value_':
  349. # check if members already defined as auto()
  350. if self._auto_called:
  351. raise TypeError("_generate_next_value_ must be defined before members")
  352. _gnv = value.__func__ if isinstance(value, staticmethod) else value
  353. setattr(self, '_generate_next_value', _gnv)
  354. elif key == '_ignore_':
  355. if isinstance(value, str):
  356. value = value.replace(',',' ').split()
  357. else:
  358. value = list(value)
  359. self._ignore = value
  360. already = set(value) & set(self._member_names)
  361. if already:
  362. raise ValueError(
  363. '_ignore_ cannot specify already set names: %r'
  364. % (already, )
  365. )
  366. elif _is_dunder(key):
  367. if key == '__order__':
  368. key = '_order_'
  369. elif key in self._member_names:
  370. # descriptor overwriting an enum?
  371. raise TypeError('%r already defined as %r' % (key, self[key]))
  372. elif key in self._ignore:
  373. pass
  374. elif isinstance(value, nonmember):
  375. # unwrap value here; it won't be processed by the below `else`
  376. value = value.value
  377. elif _is_descriptor(value):
  378. pass
  379. # TODO: uncomment next three lines in 3.13
  380. # elif _is_internal_class(self._cls_name, value):
  381. # # do nothing, name will be a normal attribute
  382. # pass
  383. else:
  384. if key in self:
  385. # enum overwriting a descriptor?
  386. raise TypeError('%r already defined as %r' % (key, self[key]))
  387. elif isinstance(value, member):
  388. # unwrap value here -- it will become a member
  389. value = value.value
  390. non_auto_store = True
  391. single = False
  392. if isinstance(value, auto):
  393. single = True
  394. value = (value, )
  395. if type(value) is tuple and any(isinstance(v, auto) for v in value):
  396. # insist on an actual tuple, no subclasses, in keeping with only supporting
  397. # top-level auto() usage (not contained in any other data structure)
  398. auto_valued = []
  399. for v in value:
  400. if isinstance(v, auto):
  401. non_auto_store = False
  402. if v.value == _auto_null:
  403. v.value = self._generate_next_value(
  404. key, 1, len(self._member_names), self._last_values[:],
  405. )
  406. self._auto_called = True
  407. v = v.value
  408. self._last_values.append(v)
  409. auto_valued.append(v)
  410. if single:
  411. value = auto_valued[0]
  412. else:
  413. value = tuple(auto_valued)
  414. self._member_names[key] = None
  415. if non_auto_store:
  416. self._last_values.append(value)
  417. super().__setitem__(key, value)
  418. def update(self, members, **more_members):
  419. try:
  420. for name in members.keys():
  421. self[name] = members[name]
  422. except AttributeError:
  423. for name, value in members:
  424. self[name] = value
  425. for name, value in more_members.items():
  426. self[name] = value
  427. class EnumType(type):
  428. """
  429. Metaclass for Enum
  430. """
  431. @classmethod
  432. def __prepare__(metacls, cls, bases, **kwds):
  433. # check that previous enum members do not exist
  434. metacls._check_for_existing_members_(cls, bases)
  435. # create the namespace dict
  436. enum_dict = _EnumDict()
  437. enum_dict._cls_name = cls
  438. # inherit previous flags and _generate_next_value_ function
  439. member_type, first_enum = metacls._get_mixins_(cls, bases)
  440. if first_enum is not None:
  441. enum_dict['_generate_next_value_'] = getattr(
  442. first_enum, '_generate_next_value_', None,
  443. )
  444. return enum_dict
  445. def __new__(metacls, cls, bases, classdict, *, boundary=None, _simple=False, **kwds):
  446. # an Enum class is final once enumeration items have been defined; it
  447. # cannot be mixed with other types (int, float, etc.) if it has an
  448. # inherited __new__ unless a new __new__ is defined (or the resulting
  449. # class will fail).
  450. #
  451. if _simple:
  452. return super().__new__(metacls, cls, bases, classdict, **kwds)
  453. #
  454. # remove any keys listed in _ignore_
  455. classdict.setdefault('_ignore_', []).append('_ignore_')
  456. ignore = classdict['_ignore_']
  457. for key in ignore:
  458. classdict.pop(key, None)
  459. #
  460. # grab member names
  461. member_names = classdict._member_names
  462. #
  463. # check for illegal enum names (any others?)
  464. invalid_names = set(member_names) & {'mro', ''}
  465. if invalid_names:
  466. raise ValueError('invalid enum member name(s) %s' % (
  467. ','.join(repr(n) for n in invalid_names)
  468. ))
  469. #
  470. # adjust the sunders
  471. _order_ = classdict.pop('_order_', None)
  472. # convert to normal dict
  473. classdict = dict(classdict.items())
  474. #
  475. # data type of member and the controlling Enum class
  476. member_type, first_enum = metacls._get_mixins_(cls, bases)
  477. __new__, save_new, use_args = metacls._find_new_(
  478. classdict, member_type, first_enum,
  479. )
  480. classdict['_new_member_'] = __new__
  481. classdict['_use_args_'] = use_args
  482. #
  483. # convert future enum members into temporary _proto_members
  484. # and record integer values in case this will be a Flag
  485. flag_mask = 0
  486. for name in member_names:
  487. value = classdict[name]
  488. if isinstance(value, int):
  489. flag_mask |= value
  490. classdict[name] = _proto_member(value)
  491. #
  492. # house-keeping structures
  493. classdict['_member_names_'] = []
  494. classdict['_member_map_'] = {}
  495. classdict['_value2member_map_'] = {}
  496. classdict['_unhashable_values_'] = []
  497. classdict['_member_type_'] = member_type
  498. # now set the __repr__ for the value
  499. classdict['_value_repr_'] = metacls._find_data_repr_(cls, bases)
  500. #
  501. # Flag structures (will be removed if final class is not a Flag
  502. classdict['_boundary_'] = (
  503. boundary
  504. or getattr(first_enum, '_boundary_', None)
  505. )
  506. classdict['_flag_mask_'] = flag_mask
  507. classdict['_all_bits_'] = 2 ** ((flag_mask).bit_length()) - 1
  508. classdict['_inverted_'] = None
  509. try:
  510. exc = None
  511. enum_class = super().__new__(metacls, cls, bases, classdict, **kwds)
  512. except RuntimeError as e:
  513. # any exceptions raised by member.__new__ will get converted to a
  514. # RuntimeError, so get that original exception back and raise it instead
  515. exc = e.__cause__ or e
  516. if exc is not None:
  517. raise exc
  518. #
  519. # update classdict with any changes made by __init_subclass__
  520. classdict.update(enum_class.__dict__)
  521. #
  522. # double check that repr and friends are not the mixin's or various
  523. # things break (such as pickle)
  524. # however, if the method is defined in the Enum itself, don't replace
  525. # it
  526. #
  527. # Also, special handling for ReprEnum
  528. if ReprEnum is not None and ReprEnum in bases:
  529. if member_type is object:
  530. raise TypeError(
  531. 'ReprEnum subclasses must be mixed with a data type (i.e.'
  532. ' int, str, float, etc.)'
  533. )
  534. if '__format__' not in classdict:
  535. enum_class.__format__ = member_type.__format__
  536. classdict['__format__'] = enum_class.__format__
  537. if '__str__' not in classdict:
  538. method = member_type.__str__
  539. if method is object.__str__:
  540. # if member_type does not define __str__, object.__str__ will use
  541. # its __repr__ instead, so we'll also use its __repr__
  542. method = member_type.__repr__
  543. enum_class.__str__ = method
  544. classdict['__str__'] = enum_class.__str__
  545. for name in ('__repr__', '__str__', '__format__', '__reduce_ex__'):
  546. if name not in classdict:
  547. # check for mixin overrides before replacing
  548. enum_method = getattr(first_enum, name)
  549. found_method = getattr(enum_class, name)
  550. object_method = getattr(object, name)
  551. data_type_method = getattr(member_type, name)
  552. if found_method in (data_type_method, object_method):
  553. setattr(enum_class, name, enum_method)
  554. #
  555. # for Flag, add __or__, __and__, __xor__, and __invert__
  556. if Flag is not None and issubclass(enum_class, Flag):
  557. for name in (
  558. '__or__', '__and__', '__xor__',
  559. '__ror__', '__rand__', '__rxor__',
  560. '__invert__'
  561. ):
  562. if name not in classdict:
  563. enum_method = getattr(Flag, name)
  564. setattr(enum_class, name, enum_method)
  565. classdict[name] = enum_method
  566. #
  567. # replace any other __new__ with our own (as long as Enum is not None,
  568. # anyway) -- again, this is to support pickle
  569. if Enum is not None:
  570. # if the user defined their own __new__, save it before it gets
  571. # clobbered in case they subclass later
  572. if save_new:
  573. enum_class.__new_member__ = __new__
  574. enum_class.__new__ = Enum.__new__
  575. #
  576. # py3 support for definition order (helps keep py2/py3 code in sync)
  577. #
  578. # _order_ checking is spread out into three/four steps
  579. # - if enum_class is a Flag:
  580. # - remove any non-single-bit flags from _order_
  581. # - remove any aliases from _order_
  582. # - check that _order_ and _member_names_ match
  583. #
  584. # step 1: ensure we have a list
  585. if _order_ is not None:
  586. if isinstance(_order_, str):
  587. _order_ = _order_.replace(',', ' ').split()
  588. #
  589. # remove Flag structures if final class is not a Flag
  590. if (
  591. Flag is None and cls != 'Flag'
  592. or Flag is not None and not issubclass(enum_class, Flag)
  593. ):
  594. delattr(enum_class, '_boundary_')
  595. delattr(enum_class, '_flag_mask_')
  596. delattr(enum_class, '_all_bits_')
  597. delattr(enum_class, '_inverted_')
  598. elif Flag is not None and issubclass(enum_class, Flag):
  599. # ensure _all_bits_ is correct and there are no missing flags
  600. single_bit_total = 0
  601. multi_bit_total = 0
  602. for flag in enum_class._member_map_.values():
  603. flag_value = flag._value_
  604. if _is_single_bit(flag_value):
  605. single_bit_total |= flag_value
  606. else:
  607. # multi-bit flags are considered aliases
  608. multi_bit_total |= flag_value
  609. enum_class._flag_mask_ = single_bit_total
  610. #
  611. # set correct __iter__
  612. member_list = [m._value_ for m in enum_class]
  613. if member_list != sorted(member_list):
  614. enum_class._iter_member_ = enum_class._iter_member_by_def_
  615. if _order_:
  616. # _order_ step 2: remove any items from _order_ that are not single-bit
  617. _order_ = [
  618. o
  619. for o in _order_
  620. if o not in enum_class._member_map_ or _is_single_bit(enum_class[o]._value_)
  621. ]
  622. #
  623. if _order_:
  624. # _order_ step 3: remove aliases from _order_
  625. _order_ = [
  626. o
  627. for o in _order_
  628. if (
  629. o not in enum_class._member_map_
  630. or
  631. (o in enum_class._member_map_ and o in enum_class._member_names_)
  632. )]
  633. # _order_ step 4: verify that _order_ and _member_names_ match
  634. if _order_ != enum_class._member_names_:
  635. raise TypeError(
  636. 'member order does not match _order_:\n %r\n %r'
  637. % (enum_class._member_names_, _order_)
  638. )
  639. return enum_class
  640. def __bool__(cls):
  641. """
  642. classes/types should always be True.
  643. """
  644. return True
  645. def __call__(cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None):
  646. """
  647. Either returns an existing member, or creates a new enum class.
  648. This method is used both when an enum class is given a value to match
  649. to an enumeration member (i.e. Color(3)) and for the functional API
  650. (i.e. Color = Enum('Color', names='RED GREEN BLUE')).
  651. When used for the functional API:
  652. `value` will be the name of the new class.
  653. `names` should be either a string of white-space/comma delimited names
  654. (values will start at `start`), or an iterator/mapping of name, value pairs.
  655. `module` should be set to the module this class is being created in;
  656. if it is not set, an attempt to find that module will be made, but if
  657. it fails the class will not be picklable.
  658. `qualname` should be set to the actual location this class can be found
  659. at in its module; by default it is set to the global scope. If this is
  660. not correct, unpickling will fail in some circumstances.
  661. `type`, if set, will be mixed in as the first base class.
  662. """
  663. if names is None: # simple value lookup
  664. return cls.__new__(cls, value)
  665. # otherwise, functional API: we're creating a new Enum type
  666. return cls._create_(
  667. value,
  668. names,
  669. module=module,
  670. qualname=qualname,
  671. type=type,
  672. start=start,
  673. boundary=boundary,
  674. )
  675. def __contains__(cls, member):
  676. """
  677. Return True if member is a member of this enum
  678. raises TypeError if member is not an enum member
  679. note: in 3.12 TypeError will no longer be raised, and True will also be
  680. returned if member is the value of a member in this enum
  681. """
  682. if not isinstance(member, Enum):
  683. import warnings
  684. warnings.warn(
  685. "in 3.12 __contains__ will no longer raise TypeError, but will return True or\n"
  686. "False depending on whether the value is a member or the value of a member",
  687. DeprecationWarning,
  688. stacklevel=2,
  689. )
  690. raise TypeError(
  691. "unsupported operand type(s) for 'in': '%s' and '%s'" % (
  692. type(member).__qualname__, cls.__class__.__qualname__))
  693. return isinstance(member, cls) and member._name_ in cls._member_map_
  694. def __delattr__(cls, attr):
  695. # nicer error message when someone tries to delete an attribute
  696. # (see issue19025).
  697. if attr in cls._member_map_:
  698. raise AttributeError("%r cannot delete member %r." % (cls.__name__, attr))
  699. super().__delattr__(attr)
  700. def __dir__(cls):
  701. interesting = set([
  702. '__class__', '__contains__', '__doc__', '__getitem__',
  703. '__iter__', '__len__', '__members__', '__module__',
  704. '__name__', '__qualname__',
  705. ]
  706. + cls._member_names_
  707. )
  708. if cls._new_member_ is not object.__new__:
  709. interesting.add('__new__')
  710. if cls.__init_subclass__ is not object.__init_subclass__:
  711. interesting.add('__init_subclass__')
  712. if cls._member_type_ is object:
  713. return sorted(interesting)
  714. else:
  715. # return whatever mixed-in data type has
  716. return sorted(set(dir(cls._member_type_)) | interesting)
  717. def __getattr__(cls, name):
  718. """
  719. Return the enum member matching `name`
  720. We use __getattr__ instead of descriptors or inserting into the enum
  721. class' __dict__ in order to support `name` and `value` being both
  722. properties for enum members (which live in the class' __dict__) and
  723. enum members themselves.
  724. """
  725. if _is_dunder(name):
  726. raise AttributeError(name)
  727. try:
  728. return cls._member_map_[name]
  729. except KeyError:
  730. raise AttributeError(name) from None
  731. def __getitem__(cls, name):
  732. """
  733. Return the member matching `name`.
  734. """
  735. return cls._member_map_[name]
  736. def __iter__(cls):
  737. """
  738. Return members in definition order.
  739. """
  740. return (cls._member_map_[name] for name in cls._member_names_)
  741. def __len__(cls):
  742. """
  743. Return the number of members (no aliases)
  744. """
  745. return len(cls._member_names_)
  746. @bltns.property
  747. def __members__(cls):
  748. """
  749. Returns a mapping of member name->value.
  750. This mapping lists all enum members, including aliases. Note that this
  751. is a read-only view of the internal mapping.
  752. """
  753. return MappingProxyType(cls._member_map_)
  754. def __repr__(cls):
  755. if Flag is not None and issubclass(cls, Flag):
  756. return "<flag %r>" % cls.__name__
  757. else:
  758. return "<enum %r>" % cls.__name__
  759. def __reversed__(cls):
  760. """
  761. Return members in reverse definition order.
  762. """
  763. return (cls._member_map_[name] for name in reversed(cls._member_names_))
  764. def __setattr__(cls, name, value):
  765. """
  766. Block attempts to reassign Enum members.
  767. A simple assignment to the class namespace only changes one of the
  768. several possible ways to get an Enum member from the Enum class,
  769. resulting in an inconsistent Enumeration.
  770. """
  771. member_map = cls.__dict__.get('_member_map_', {})
  772. if name in member_map:
  773. raise AttributeError('cannot reassign member %r' % (name, ))
  774. super().__setattr__(name, value)
  775. def _create_(cls, class_name, names, *, module=None, qualname=None, type=None, start=1, boundary=None):
  776. """
  777. Convenience method to create a new Enum class.
  778. `names` can be:
  779. * A string containing member names, separated either with spaces or
  780. commas. Values are incremented by 1 from `start`.
  781. * An iterable of member names. Values are incremented by 1 from `start`.
  782. * An iterable of (member name, value) pairs.
  783. * A mapping of member name -> value pairs.
  784. """
  785. metacls = cls.__class__
  786. bases = (cls, ) if type is None else (type, cls)
  787. _, first_enum = cls._get_mixins_(class_name, bases)
  788. classdict = metacls.__prepare__(class_name, bases)
  789. # special processing needed for names?
  790. if isinstance(names, str):
  791. names = names.replace(',', ' ').split()
  792. if isinstance(names, (tuple, list)) and names and isinstance(names[0], str):
  793. original_names, names = names, []
  794. last_values = []
  795. for count, name in enumerate(original_names):
  796. value = first_enum._generate_next_value_(name, start, count, last_values[:])
  797. last_values.append(value)
  798. names.append((name, value))
  799. # Here, names is either an iterable of (name, value) or a mapping.
  800. for item in names:
  801. if isinstance(item, str):
  802. member_name, member_value = item, names[item]
  803. else:
  804. member_name, member_value = item
  805. classdict[member_name] = member_value
  806. # TODO: replace the frame hack if a blessed way to know the calling
  807. # module is ever developed
  808. if module is None:
  809. try:
  810. module = sys._getframe(2).f_globals['__name__']
  811. except (AttributeError, ValueError, KeyError):
  812. pass
  813. if module is None:
  814. _make_class_unpicklable(classdict)
  815. else:
  816. classdict['__module__'] = module
  817. if qualname is not None:
  818. classdict['__qualname__'] = qualname
  819. return metacls.__new__(metacls, class_name, bases, classdict, boundary=boundary)
  820. def _convert_(cls, name, module, filter, source=None, *, boundary=None, as_global=False):
  821. """
  822. Create a new Enum subclass that replaces a collection of global constants
  823. """
  824. # convert all constants from source (or module) that pass filter() to
  825. # a new Enum called name, and export the enum and its members back to
  826. # module;
  827. # also, replace the __reduce_ex__ method so unpickling works in
  828. # previous Python versions
  829. module_globals = sys.modules[module].__dict__
  830. if source:
  831. source = source.__dict__
  832. else:
  833. source = module_globals
  834. # _value2member_map_ is populated in the same order every time
  835. # for a consistent reverse mapping of number to name when there
  836. # are multiple names for the same number.
  837. members = [
  838. (name, value)
  839. for name, value in source.items()
  840. if filter(name)]
  841. try:
  842. # sort by value
  843. members.sort(key=lambda t: (t[1], t[0]))
  844. except TypeError:
  845. # unless some values aren't comparable, in which case sort by name
  846. members.sort(key=lambda t: t[0])
  847. body = {t[0]: t[1] for t in members}
  848. body['__module__'] = module
  849. tmp_cls = type(name, (object, ), body)
  850. cls = _simple_enum(etype=cls, boundary=boundary or KEEP)(tmp_cls)
  851. cls.__reduce_ex__ = _reduce_ex_by_global_name
  852. if as_global:
  853. global_enum(cls)
  854. else:
  855. sys.modules[cls.__module__].__dict__.update(cls.__members__)
  856. module_globals[name] = cls
  857. return cls
  858. @classmethod
  859. def _check_for_existing_members_(mcls, class_name, bases):
  860. for chain in bases:
  861. for base in chain.__mro__:
  862. if issubclass(base, Enum) and base._member_names_:
  863. raise TypeError(
  864. "<enum %r> cannot extend %r"
  865. % (class_name, base)
  866. )
  867. @classmethod
  868. def _get_mixins_(mcls, class_name, bases):
  869. """
  870. Returns the type for creating enum members, and the first inherited
  871. enum class.
  872. bases: the tuple of bases that was given to __new__
  873. """
  874. if not bases:
  875. return object, Enum
  876. mcls._check_for_existing_members_(class_name, bases)
  877. # ensure final parent class is an Enum derivative, find any concrete
  878. # data type, and check that Enum has no members
  879. first_enum = bases[-1]
  880. if not issubclass(first_enum, Enum):
  881. raise TypeError("new enumerations should be created as "
  882. "`EnumName([mixin_type, ...] [data_type,] enum_type)`")
  883. member_type = mcls._find_data_type_(class_name, bases) or object
  884. return member_type, first_enum
  885. @classmethod
  886. def _find_data_repr_(mcls, class_name, bases):
  887. for chain in bases:
  888. for base in chain.__mro__:
  889. if base is object:
  890. continue
  891. elif issubclass(base, Enum):
  892. # if we hit an Enum, use it's _value_repr_
  893. return base._value_repr_
  894. elif '__repr__' in base.__dict__:
  895. # this is our data repr
  896. return base.__dict__['__repr__']
  897. return None
  898. @classmethod
  899. def _find_data_type_(mcls, class_name, bases):
  900. data_types = set()
  901. base_chain = set()
  902. for chain in bases:
  903. candidate = None
  904. for base in chain.__mro__:
  905. base_chain.add(base)
  906. if base is object:
  907. continue
  908. elif issubclass(base, Enum):
  909. if base._member_type_ is not object:
  910. data_types.add(base._member_type_)
  911. break
  912. elif '__new__' in base.__dict__ or '__init__' in base.__dict__:
  913. if issubclass(base, Enum):
  914. continue
  915. data_types.add(candidate or base)
  916. break
  917. else:
  918. candidate = candidate or base
  919. if len(data_types) > 1:
  920. raise TypeError('too many data types for %r: %r' % (class_name, data_types))
  921. elif data_types:
  922. return data_types.pop()
  923. else:
  924. return None
  925. @classmethod
  926. def _find_new_(mcls, classdict, member_type, first_enum):
  927. """
  928. Returns the __new__ to be used for creating the enum members.
  929. classdict: the class dictionary given to __new__
  930. member_type: the data type whose __new__ will be used by default
  931. first_enum: enumeration to check for an overriding __new__
  932. """
  933. # now find the correct __new__, checking to see of one was defined
  934. # by the user; also check earlier enum classes in case a __new__ was
  935. # saved as __new_member__
  936. __new__ = classdict.get('__new__', None)
  937. # should __new__ be saved as __new_member__ later?
  938. save_new = first_enum is not None and __new__ is not None
  939. if __new__ is None:
  940. # check all possibles for __new_member__ before falling back to
  941. # __new__
  942. for method in ('__new_member__', '__new__'):
  943. for possible in (member_type, first_enum):
  944. target = getattr(possible, method, None)
  945. if target not in {
  946. None,
  947. None.__new__,
  948. object.__new__,
  949. Enum.__new__,
  950. }:
  951. __new__ = target
  952. break
  953. if __new__ is not None:
  954. break
  955. else:
  956. __new__ = object.__new__
  957. # if a non-object.__new__ is used then whatever value/tuple was
  958. # assigned to the enum member name will be passed to __new__ and to the
  959. # new enum member's __init__
  960. if first_enum is None or __new__ in (Enum.__new__, object.__new__):
  961. use_args = False
  962. else:
  963. use_args = True
  964. return __new__, save_new, use_args
  965. EnumMeta = EnumType
  966. class Enum(metaclass=EnumType):
  967. """
  968. Create a collection of name/value pairs.
  969. Example enumeration:
  970. >>> class Color(Enum):
  971. ... RED = 1
  972. ... BLUE = 2
  973. ... GREEN = 3
  974. Access them by:
  975. - attribute access::
  976. >>> Color.RED
  977. <Color.RED: 1>
  978. - value lookup:
  979. >>> Color(1)
  980. <Color.RED: 1>
  981. - name lookup:
  982. >>> Color['RED']
  983. <Color.RED: 1>
  984. Enumerations can be iterated over, and know how many members they have:
  985. >>> len(Color)
  986. 3
  987. >>> list(Color)
  988. [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
  989. Methods can be added to enumerations, and members can have their own
  990. attributes -- see the documentation for details.
  991. """
  992. def __new__(cls, value):
  993. # all enum instances are actually created during class construction
  994. # without calling this method; this method is called by the metaclass'
  995. # __call__ (i.e. Color(3) ), and by pickle
  996. if type(value) is cls:
  997. # For lookups like Color(Color.RED)
  998. return value
  999. # by-value search for a matching enum member
  1000. # see if it's in the reverse mapping (for hashable values)
  1001. try:
  1002. return cls._value2member_map_[value]
  1003. except KeyError:
  1004. # Not found, no need to do long O(n) search
  1005. pass
  1006. except TypeError:
  1007. # not there, now do long search -- O(n) behavior
  1008. for member in cls._member_map_.values():
  1009. if member._value_ == value:
  1010. return member
  1011. # still not found -- try _missing_ hook
  1012. try:
  1013. exc = None
  1014. result = cls._missing_(value)
  1015. except Exception as e:
  1016. exc = e
  1017. result = None
  1018. try:
  1019. if isinstance(result, cls):
  1020. return result
  1021. elif (
  1022. Flag is not None and issubclass(cls, Flag)
  1023. and cls._boundary_ is EJECT and isinstance(result, int)
  1024. ):
  1025. return result
  1026. else:
  1027. ve_exc = ValueError("%r is not a valid %s" % (value, cls.__qualname__))
  1028. if result is None and exc is None:
  1029. raise ve_exc
  1030. elif exc is None:
  1031. exc = TypeError(
  1032. 'error in %s._missing_: returned %r instead of None or a valid member'
  1033. % (cls.__name__, result)
  1034. )
  1035. if not isinstance(exc, ValueError):
  1036. exc.__context__ = ve_exc
  1037. raise exc
  1038. finally:
  1039. # ensure all variables that could hold an exception are destroyed
  1040. exc = None
  1041. ve_exc = None
  1042. def __init__(self, *args, **kwds):
  1043. pass
  1044. def _generate_next_value_(name, start, count, last_values):
  1045. """
  1046. Generate the next value when not given.
  1047. name: the name of the member
  1048. start: the initial start value or None
  1049. count: the number of existing members
  1050. last_values: the list of values assigned
  1051. """
  1052. if not last_values:
  1053. return start
  1054. try:
  1055. last = last_values[-1]
  1056. last_values.sort()
  1057. if last == last_values[-1]:
  1058. # no difference between old and new methods
  1059. return last + 1
  1060. else:
  1061. # trigger old method (with warning)
  1062. raise TypeError
  1063. except TypeError:
  1064. import warnings
  1065. warnings.warn(
  1066. "In 3.13 the default `auto()`/`_generate_next_value_` will require all values to be sortable and support adding +1\n"
  1067. "and the value returned will be the largest value in the enum incremented by 1",
  1068. DeprecationWarning,
  1069. stacklevel=3,
  1070. )
  1071. for v in last_values:
  1072. try:
  1073. return v + 1
  1074. except TypeError:
  1075. pass
  1076. return start
  1077. @classmethod
  1078. def _missing_(cls, value):
  1079. return None
  1080. def __repr__(self):
  1081. v_repr = self.__class__._value_repr_ or repr
  1082. return "<%s.%s: %s>" % (self.__class__.__name__, self._name_, v_repr(self._value_))
  1083. def __str__(self):
  1084. return "%s.%s" % (self.__class__.__name__, self._name_, )
  1085. def __dir__(self):
  1086. """
  1087. Returns all members and all public methods
  1088. """
  1089. if self.__class__._member_type_ is object:
  1090. interesting = set(['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'value'])
  1091. else:
  1092. interesting = set(object.__dir__(self))
  1093. for name in getattr(self, '__dict__', []):
  1094. if name[0] != '_':
  1095. interesting.add(name)
  1096. for cls in self.__class__.mro():
  1097. for name, obj in cls.__dict__.items():
  1098. if name[0] == '_':
  1099. continue
  1100. if isinstance(obj, property):
  1101. # that's an enum.property
  1102. if obj.fget is not None or name not in self._member_map_:
  1103. interesting.add(name)
  1104. else:
  1105. # in case it was added by `dir(self)`
  1106. interesting.discard(name)
  1107. else:
  1108. interesting.add(name)
  1109. names = sorted(
  1110. set(['__class__', '__doc__', '__eq__', '__hash__', '__module__'])
  1111. | interesting
  1112. )
  1113. return names
  1114. def __format__(self, format_spec):
  1115. return str.__format__(str(self), format_spec)
  1116. def __hash__(self):
  1117. return hash(self._name_)
  1118. def __reduce_ex__(self, proto):
  1119. return getattr, (self.__class__, self._name_)
  1120. # enum.property is used to provide access to the `name` and
  1121. # `value` attributes of enum members while keeping some measure of
  1122. # protection from modification, while still allowing for an enumeration
  1123. # to have members named `name` and `value`. This works because enumeration
  1124. # members are not set directly on the enum class; they are kept in a
  1125. # separate structure, _member_map_, which is where enum.property looks for
  1126. # them
  1127. @property
  1128. def name(self):
  1129. """The name of the Enum member."""
  1130. return self._name_
  1131. @property
  1132. def value(self):
  1133. """The value of the Enum member."""
  1134. return self._value_
  1135. class ReprEnum(Enum):
  1136. """
  1137. Only changes the repr(), leaving str() and format() to the mixed-in type.
  1138. """
  1139. class IntEnum(int, ReprEnum):
  1140. """
  1141. Enum where members are also (and must be) ints
  1142. """
  1143. class StrEnum(str, ReprEnum):
  1144. """
  1145. Enum where members are also (and must be) strings
  1146. """
  1147. def __new__(cls, *values):
  1148. "values must already be of type `str`"
  1149. if len(values) > 3:
  1150. raise TypeError('too many arguments for str(): %r' % (values, ))
  1151. if len(values) == 1:
  1152. # it must be a string
  1153. if not isinstance(values[0], str):
  1154. raise TypeError('%r is not a string' % (values[0], ))
  1155. if len(values) >= 2:
  1156. # check that encoding argument is a string
  1157. if not isinstance(values[1], str):
  1158. raise TypeError('encoding must be a string, not %r' % (values[1], ))
  1159. if len(values) == 3:
  1160. # check that errors argument is a string
  1161. if not isinstance(values[2], str):
  1162. raise TypeError('errors must be a string, not %r' % (values[2]))
  1163. value = str(*values)
  1164. member = str.__new__(cls, value)
  1165. member._value_ = value
  1166. return member
  1167. def _generate_next_value_(name, start, count, last_values):
  1168. """
  1169. Return the lower-cased version of the member name.
  1170. """
  1171. return name.lower()
  1172. def _reduce_ex_by_global_name(self, proto):
  1173. return self.name
  1174. class FlagBoundary(StrEnum):
  1175. """
  1176. control how out of range values are handled
  1177. "strict" -> error is raised [default for Flag]
  1178. "conform" -> extra bits are discarded
  1179. "eject" -> lose flag status [default for IntFlag]
  1180. "keep" -> keep flag status and all bits
  1181. """
  1182. STRICT = auto()
  1183. CONFORM = auto()
  1184. EJECT = auto()
  1185. KEEP = auto()
  1186. STRICT, CONFORM, EJECT, KEEP = FlagBoundary
  1187. class Flag(Enum, boundary=CONFORM):
  1188. """
  1189. Support for flags
  1190. """
  1191. def __reduce_ex__(self, proto):
  1192. cls = self.__class__
  1193. unknown = self._value_ & ~cls._flag_mask_
  1194. member_value = self._value_ & cls._flag_mask_
  1195. if unknown and member_value:
  1196. return _or_, (cls(member_value), unknown)
  1197. for val in _iter_bits_lsb(member_value):
  1198. rest = member_value & ~val
  1199. if rest:
  1200. return _or_, (cls(rest), cls._value2member_map_.get(val))
  1201. else:
  1202. break
  1203. if self._name_ is None:
  1204. return cls, (self._value_,)
  1205. else:
  1206. return getattr, (cls, self._name_)
  1207. _numeric_repr_ = repr
  1208. def _generate_next_value_(name, start, count, last_values):
  1209. """
  1210. Generate the next value when not given.
  1211. name: the name of the member
  1212. start: the initial start value or None
  1213. count: the number of existing members
  1214. last_values: the last value assigned or None
  1215. """
  1216. if not count:
  1217. return start if start is not None else 1
  1218. last_value = max(last_values)
  1219. try:
  1220. high_bit = _high_bit(last_value)
  1221. except Exception:
  1222. raise TypeError('invalid flag value %r' % last_value) from None
  1223. return 2 ** (high_bit+1)
  1224. @classmethod
  1225. def _iter_member_by_value_(cls, value):
  1226. """
  1227. Extract all members from the value in definition (i.e. increasing value) order.
  1228. """
  1229. for val in _iter_bits_lsb(value & cls._flag_mask_):
  1230. yield cls._value2member_map_.get(val)
  1231. _iter_member_ = _iter_member_by_value_
  1232. @classmethod
  1233. def _iter_member_by_def_(cls, value):
  1234. """
  1235. Extract all members from the value in definition order.
  1236. """
  1237. yield from sorted(
  1238. cls._iter_member_by_value_(value),
  1239. key=lambda m: m._sort_order_,
  1240. )
  1241. @classmethod
  1242. def _missing_(cls, value):
  1243. """
  1244. Create a composite member containing all canonical members present in `value`.
  1245. If non-member values are present, result depends on `_boundary_` setting.
  1246. """
  1247. if not isinstance(value, int):
  1248. raise ValueError(
  1249. "%r is not a valid %s" % (value, cls.__qualname__)
  1250. )
  1251. # check boundaries
  1252. # - value must be in range (e.g. -16 <-> +15, i.e. ~15 <-> 15)
  1253. # - value must not include any skipped flags (e.g. if bit 2 is not
  1254. # defined, then 0d10 is invalid)
  1255. flag_mask = cls._flag_mask_
  1256. all_bits = cls._all_bits_
  1257. neg_value = None
  1258. if (
  1259. not ~all_bits <= value <= all_bits
  1260. or value & (all_bits ^ flag_mask)
  1261. ):
  1262. if cls._boundary_ is STRICT:
  1263. max_bits = max(value.bit_length(), flag_mask.bit_length())
  1264. raise ValueError(
  1265. "%r invalid value %r\n given %s\n allowed %s" % (
  1266. cls, value, bin(value, max_bits), bin(flag_mask, max_bits),
  1267. ))
  1268. elif cls._boundary_ is CONFORM:
  1269. value = value & flag_mask
  1270. elif cls._boundary_ is EJECT:
  1271. return value
  1272. elif cls._boundary_ is KEEP:
  1273. if value < 0:
  1274. value = (
  1275. max(all_bits+1, 2**(value.bit_length()))
  1276. + value
  1277. )
  1278. else:
  1279. raise ValueError(
  1280. '%r unknown flag boundary %r' % (cls, cls._boundary_, )
  1281. )
  1282. if value < 0:
  1283. neg_value = value
  1284. value = all_bits + 1 + value
  1285. # get members and unknown
  1286. unknown = value & ~flag_mask
  1287. member_value = value & flag_mask
  1288. if unknown and cls._boundary_ is not KEEP:
  1289. raise ValueError(
  1290. '%s(%r) --> unknown values %r [%s]'
  1291. % (cls.__name__, value, unknown, bin(unknown))
  1292. )
  1293. # normal Flag?
  1294. if cls._member_type_ is object:
  1295. # construct a singleton enum pseudo-member
  1296. pseudo_member = object.__new__(cls)
  1297. else:
  1298. pseudo_member = cls._member_type_.__new__(cls, value)
  1299. if not hasattr(pseudo_member, '_value_'):
  1300. pseudo_member._value_ = value
  1301. if member_value:
  1302. pseudo_member._name_ = '|'.join([
  1303. m._name_ for m in cls._iter_member_(member_value)
  1304. ])
  1305. if unknown:
  1306. pseudo_member._name_ += '|%s' % cls._numeric_repr_(unknown)
  1307. else:
  1308. pseudo_member._name_ = None
  1309. # use setdefault in case another thread already created a composite
  1310. # with this value, but only if all members are known
  1311. # note: zero is a special case -- add it
  1312. if not unknown:
  1313. pseudo_member = cls._value2member_map_.setdefault(value, pseudo_member)
  1314. if neg_value is not None:
  1315. cls._value2member_map_[neg_value] = pseudo_member
  1316. return pseudo_member
  1317. def __contains__(self, other):
  1318. """
  1319. Returns True if self has at least the same flags set as other.
  1320. """
  1321. if not isinstance(other, self.__class__):
  1322. raise TypeError(
  1323. "unsupported operand type(s) for 'in': %r and %r" % (
  1324. type(other).__qualname__, self.__class__.__qualname__))
  1325. return other._value_ & self._value_ == other._value_
  1326. def __iter__(self):
  1327. """
  1328. Returns flags in definition order.
  1329. """
  1330. yield from self._iter_member_(self._value_)
  1331. def __len__(self):
  1332. return self._value_.bit_count()
  1333. def __repr__(self):
  1334. cls_name = self.__class__.__name__
  1335. v_repr = self.__class__._value_repr_ or repr
  1336. if self._name_ is None:
  1337. return "<%s: %s>" % (cls_name, v_repr(self._value_))
  1338. else:
  1339. return "<%s.%s: %s>" % (cls_name, self._name_, v_repr(self._value_))
  1340. def __str__(self):
  1341. cls_name = self.__class__.__name__
  1342. if self._name_ is None:
  1343. return '%s(%r)' % (cls_name, self._value_)
  1344. else:
  1345. return "%s.%s" % (cls_name, self._name_)
  1346. def __bool__(self):
  1347. return bool(self._value_)
  1348. def __or__(self, other):
  1349. if isinstance(other, self.__class__):
  1350. other = other._value_
  1351. elif self._member_type_ is not object and isinstance(other, self._member_type_):
  1352. other = other
  1353. else:
  1354. return NotImplemented
  1355. value = self._value_
  1356. return self.__class__(value | other)
  1357. def __and__(self, other):
  1358. if isinstance(other, self.__class__):
  1359. other = other._value_
  1360. elif self._member_type_ is not object and isinstance(other, self._member_type_):
  1361. other = other
  1362. else:
  1363. return NotImplemented
  1364. value = self._value_
  1365. return self.__class__(value & other)
  1366. def __xor__(self, other):
  1367. if isinstance(other, self.__class__):
  1368. other = other._value_
  1369. elif self._member_type_ is not object and isinstance(other, self._member_type_):
  1370. other = other
  1371. else:
  1372. return NotImplemented
  1373. value = self._value_
  1374. return self.__class__(value ^ other)
  1375. def __invert__(self):
  1376. if self._inverted_ is None:
  1377. if self._boundary_ is KEEP:
  1378. # use all bits
  1379. self._inverted_ = self.__class__(~self._value_)
  1380. else:
  1381. # calculate flags not in this member
  1382. self._inverted_ = self.__class__(self._flag_mask_ ^ self._value_)
  1383. if isinstance(self._inverted_, self.__class__):
  1384. self._inverted_._inverted_ = self
  1385. return self._inverted_
  1386. __rand__ = __and__
  1387. __ror__ = __or__
  1388. __rxor__ = __xor__
  1389. class IntFlag(int, ReprEnum, Flag, boundary=KEEP):
  1390. """
  1391. Support for integer-based Flags
  1392. """
  1393. def _high_bit(value):
  1394. """
  1395. returns index of highest bit, or -1 if value is zero or negative
  1396. """
  1397. return value.bit_length() - 1
  1398. def unique(enumeration):
  1399. """
  1400. Class decorator for enumerations ensuring unique member values.
  1401. """
  1402. duplicates = []
  1403. for name, member in enumeration.__members__.items():
  1404. if name != member.name:
  1405. duplicates.append((name, member.name))
  1406. if duplicates:
  1407. alias_details = ', '.join(
  1408. ["%s -> %s" % (alias, name) for (alias, name) in duplicates])
  1409. raise ValueError('duplicate values found in %r: %s' %
  1410. (enumeration, alias_details))
  1411. return enumeration
  1412. def _power_of_two(value):
  1413. if value < 1:
  1414. return False
  1415. return value == 2 ** _high_bit(value)
  1416. def global_enum_repr(self):
  1417. """
  1418. use module.enum_name instead of class.enum_name
  1419. the module is the last module in case of a multi-module name
  1420. """
  1421. module = self.__class__.__module__.split('.')[-1]
  1422. return '%s.%s' % (module, self._name_)
  1423. def global_flag_repr(self):
  1424. """
  1425. use module.flag_name instead of class.flag_name
  1426. the module is the last module in case of a multi-module name
  1427. """
  1428. module = self.__class__.__module__.split('.')[-1]
  1429. cls_name = self.__class__.__name__
  1430. if self._name_ is None:
  1431. return "%s.%s(%r)" % (module, cls_name, self._value_)
  1432. if _is_single_bit(self):
  1433. return '%s.%s' % (module, self._name_)
  1434. if self._boundary_ is not FlagBoundary.KEEP:
  1435. return '|'.join(['%s.%s' % (module, name) for name in self.name.split('|')])
  1436. else:
  1437. name = []
  1438. for n in self._name_.split('|'):
  1439. if n[0].isdigit():
  1440. name.append(n)
  1441. else:
  1442. name.append('%s.%s' % (module, n))
  1443. return '|'.join(name)
  1444. def global_str(self):
  1445. """
  1446. use enum_name instead of class.enum_name
  1447. """
  1448. if self._name_ is None:
  1449. cls_name = self.__class__.__name__
  1450. return "%s(%r)" % (cls_name, self._value_)
  1451. else:
  1452. return self._name_
  1453. def global_enum(cls, update_str=False):
  1454. """
  1455. decorator that makes the repr() of an enum member reference its module
  1456. instead of its class; also exports all members to the enum's module's
  1457. global namespace
  1458. """
  1459. if issubclass(cls, Flag):
  1460. cls.__repr__ = global_flag_repr
  1461. else:
  1462. cls.__repr__ = global_enum_repr
  1463. if not issubclass(cls, ReprEnum) or update_str:
  1464. cls.__str__ = global_str
  1465. sys.modules[cls.__module__].__dict__.update(cls.__members__)
  1466. return cls
  1467. def _simple_enum(etype=Enum, *, boundary=None, use_args=None):
  1468. """
  1469. Class decorator that converts a normal class into an :class:`Enum`. No
  1470. safety checks are done, and some advanced behavior (such as
  1471. :func:`__init_subclass__`) is not available. Enum creation can be faster
  1472. using :func:`simple_enum`.
  1473. >>> from enum import Enum, _simple_enum
  1474. >>> @_simple_enum(Enum)
  1475. ... class Color:
  1476. ... RED = auto()
  1477. ... GREEN = auto()
  1478. ... BLUE = auto()
  1479. >>> Color
  1480. <enum 'Color'>
  1481. """
  1482. def convert_class(cls):
  1483. nonlocal use_args
  1484. cls_name = cls.__name__
  1485. if use_args is None:
  1486. use_args = etype._use_args_
  1487. __new__ = cls.__dict__.get('__new__')
  1488. if __new__ is not None:
  1489. new_member = __new__.__func__
  1490. else:
  1491. new_member = etype._member_type_.__new__
  1492. attrs = {}
  1493. body = {}
  1494. if __new__ is not None:
  1495. body['__new_member__'] = new_member
  1496. body['_new_member_'] = new_member
  1497. body['_use_args_'] = use_args
  1498. body['_generate_next_value_'] = gnv = etype._generate_next_value_
  1499. body['_member_names_'] = member_names = []
  1500. body['_member_map_'] = member_map = {}
  1501. body['_value2member_map_'] = value2member_map = {}
  1502. body['_unhashable_values_'] = []
  1503. body['_member_type_'] = member_type = etype._member_type_
  1504. body['_value_repr_'] = etype._value_repr_
  1505. if issubclass(etype, Flag):
  1506. body['_boundary_'] = boundary or etype._boundary_
  1507. body['_flag_mask_'] = None
  1508. body['_all_bits_'] = None
  1509. body['_inverted_'] = None
  1510. body['__or__'] = Flag.__or__
  1511. body['__xor__'] = Flag.__xor__
  1512. body['__and__'] = Flag.__and__
  1513. body['__ror__'] = Flag.__ror__
  1514. body['__rxor__'] = Flag.__rxor__
  1515. body['__rand__'] = Flag.__rand__
  1516. body['__invert__'] = Flag.__invert__
  1517. for name, obj in cls.__dict__.items():
  1518. if name in ('__dict__', '__weakref__'):
  1519. continue
  1520. if _is_dunder(name) or _is_private(cls_name, name) or _is_sunder(name) or _is_descriptor(obj):
  1521. body[name] = obj
  1522. else:
  1523. attrs[name] = obj
  1524. if cls.__dict__.get('__doc__') is None:
  1525. body['__doc__'] = 'An enumeration.'
  1526. #
  1527. # double check that repr and friends are not the mixin's or various
  1528. # things break (such as pickle)
  1529. # however, if the method is defined in the Enum itself, don't replace
  1530. # it
  1531. enum_class = type(cls_name, (etype, ), body, boundary=boundary, _simple=True)
  1532. for name in ('__repr__', '__str__', '__format__', '__reduce_ex__'):
  1533. if name not in body:
  1534. # check for mixin overrides before replacing
  1535. enum_method = getattr(etype, name)
  1536. found_method = getattr(enum_class, name)
  1537. object_method = getattr(object, name)
  1538. data_type_method = getattr(member_type, name)
  1539. if found_method in (data_type_method, object_method):
  1540. setattr(enum_class, name, enum_method)
  1541. gnv_last_values = []
  1542. if issubclass(enum_class, Flag):
  1543. # Flag / IntFlag
  1544. single_bits = multi_bits = 0
  1545. for name, value in attrs.items():
  1546. if isinstance(value, auto) and auto.value is _auto_null:
  1547. value = gnv(name, 1, len(member_names), gnv_last_values)
  1548. if value in value2member_map:
  1549. # an alias to an existing member
  1550. redirect = property()
  1551. redirect.__set_name__(enum_class, name)
  1552. setattr(enum_class, name, redirect)
  1553. member_map[name] = value2member_map[value]
  1554. else:
  1555. # create the member
  1556. if use_args:
  1557. if not isinstance(value, tuple):
  1558. value = (value, )
  1559. member = new_member(enum_class, *value)
  1560. value = value[0]
  1561. else:
  1562. member = new_member(enum_class)
  1563. if __new__ is None:
  1564. member._value_ = value
  1565. member._name_ = name
  1566. member.__objclass__ = enum_class
  1567. member.__init__(value)
  1568. redirect = property()
  1569. redirect.__set_name__(enum_class, name)
  1570. setattr(enum_class, name, redirect)
  1571. member_map[name] = member
  1572. member._sort_order_ = len(member_names)
  1573. value2member_map[value] = member
  1574. if _is_single_bit(value):
  1575. # not a multi-bit alias, record in _member_names_ and _flag_mask_
  1576. member_names.append(name)
  1577. single_bits |= value
  1578. else:
  1579. multi_bits |= value
  1580. gnv_last_values.append(value)
  1581. enum_class._flag_mask_ = single_bits
  1582. enum_class._all_bits_ = 2 ** ((single_bits|multi_bits).bit_length()) - 1
  1583. # set correct __iter__
  1584. member_list = [m._value_ for m in enum_class]
  1585. if member_list != sorted(member_list):
  1586. enum_class._iter_member_ = enum_class._iter_member_by_def_
  1587. else:
  1588. # Enum / IntEnum / StrEnum
  1589. for name, value in attrs.items():
  1590. if isinstance(value, auto):
  1591. if value.value is _auto_null:
  1592. value.value = gnv(name, 1, len(member_names), gnv_last_values)
  1593. value = value.value
  1594. if value in value2member_map:
  1595. # an alias to an existing member
  1596. redirect = property()
  1597. redirect.__set_name__(enum_class, name)
  1598. setattr(enum_class, name, redirect)
  1599. member_map[name] = value2member_map[value]
  1600. else:
  1601. # create the member
  1602. if use_args:
  1603. if not isinstance(value, tuple):
  1604. value = (value, )
  1605. member = new_member(enum_class, *value)
  1606. value = value[0]
  1607. else:
  1608. member = new_member(enum_class)
  1609. if __new__ is None:
  1610. member._value_ = value
  1611. member._name_ = name
  1612. member.__objclass__ = enum_class
  1613. member.__init__(value)
  1614. member._sort_order_ = len(member_names)
  1615. redirect = property()
  1616. redirect.__set_name__(enum_class, name)
  1617. setattr(enum_class, name, redirect)
  1618. member_map[name] = member
  1619. value2member_map[value] = member
  1620. member_names.append(name)
  1621. gnv_last_values.append(value)
  1622. if '__new__' in body:
  1623. enum_class.__new_member__ = enum_class.__new__
  1624. enum_class.__new__ = Enum.__new__
  1625. return enum_class
  1626. return convert_class
  1627. @_simple_enum(StrEnum)
  1628. class EnumCheck:
  1629. """
  1630. various conditions to check an enumeration for
  1631. """
  1632. CONTINUOUS = "no skipped integer values"
  1633. NAMED_FLAGS = "multi-flag aliases may not contain unnamed flags"
  1634. UNIQUE = "one name per value"
  1635. CONTINUOUS, NAMED_FLAGS, UNIQUE = EnumCheck
  1636. class verify:
  1637. """
  1638. Check an enumeration for various constraints. (see EnumCheck)
  1639. """
  1640. def __init__(self, *checks):
  1641. self.checks = checks
  1642. def __call__(self, enumeration):
  1643. checks = self.checks
  1644. cls_name = enumeration.__name__
  1645. if Flag is not None and issubclass(enumeration, Flag):
  1646. enum_type = 'flag'
  1647. elif issubclass(enumeration, Enum):
  1648. enum_type = 'enum'
  1649. else:
  1650. raise TypeError("the 'verify' decorator only works with Enum and Flag")
  1651. for check in checks:
  1652. if check is UNIQUE:
  1653. # check for duplicate names
  1654. duplicates = []
  1655. for name, member in enumeration.__members__.items():
  1656. if name != member.name:
  1657. duplicates.append((name, member.name))
  1658. if duplicates:
  1659. alias_details = ', '.join(
  1660. ["%s -> %s" % (alias, name) for (alias, name) in duplicates])
  1661. raise ValueError('aliases found in %r: %s' %
  1662. (enumeration, alias_details))
  1663. elif check is CONTINUOUS:
  1664. values = set(e.value for e in enumeration)
  1665. if len(values) < 2:
  1666. continue
  1667. low, high = min(values), max(values)
  1668. missing = []
  1669. if enum_type == 'flag':
  1670. # check for powers of two
  1671. for i in range(_high_bit(low)+1, _high_bit(high)):
  1672. if 2**i not in values:
  1673. missing.append(2**i)
  1674. elif enum_type == 'enum':
  1675. # check for powers of one
  1676. for i in range(low+1, high):
  1677. if i not in values:
  1678. missing.append(i)
  1679. else:
  1680. raise Exception('verify: unknown type %r' % enum_type)
  1681. if missing:
  1682. raise ValueError(('invalid %s %r: missing values %s' % (
  1683. enum_type, cls_name, ', '.join((str(m) for m in missing)))
  1684. )[:256])
  1685. # limit max length to protect against DOS attacks
  1686. elif check is NAMED_FLAGS:
  1687. # examine each alias and check for unnamed flags
  1688. member_names = enumeration._member_names_
  1689. member_values = [m.value for m in enumeration]
  1690. missing_names = []
  1691. missing_value = 0
  1692. for name, alias in enumeration._member_map_.items():
  1693. if name in member_names:
  1694. # not an alias
  1695. continue
  1696. if alias.value < 0:
  1697. # negative numbers are not checked
  1698. continue
  1699. values = list(_iter_bits_lsb(alias.value))
  1700. missed = [v for v in values if v not in member_values]
  1701. if missed:
  1702. missing_names.append(name)
  1703. missing_value |= reduce(_or_, missed)
  1704. if missing_names:
  1705. if len(missing_names) == 1:
  1706. alias = 'alias %s is missing' % missing_names[0]
  1707. else:
  1708. alias = 'aliases %s and %s are missing' % (
  1709. ', '.join(missing_names[:-1]), missing_names[-1]
  1710. )
  1711. if _is_single_bit(missing_value):
  1712. value = 'value 0x%x' % missing_value
  1713. else:
  1714. value = 'combined values of 0x%x' % missing_value
  1715. raise ValueError(
  1716. 'invalid Flag %r: %s %s [use enum.show_flag_values(value) for details]'
  1717. % (cls_name, alias, value)
  1718. )
  1719. return enumeration
  1720. def _test_simple_enum(checked_enum, simple_enum):
  1721. """
  1722. A function that can be used to test an enum created with :func:`_simple_enum`
  1723. against the version created by subclassing :class:`Enum`::
  1724. >>> from enum import Enum, _simple_enum, _test_simple_enum
  1725. >>> @_simple_enum(Enum)
  1726. ... class Color:
  1727. ... RED = auto()
  1728. ... GREEN = auto()
  1729. ... BLUE = auto()
  1730. >>> class CheckedColor(Enum):
  1731. ... RED = auto()
  1732. ... GREEN = auto()
  1733. ... BLUE = auto()
  1734. >>> _test_simple_enum(CheckedColor, Color)
  1735. If differences are found, a :exc:`TypeError` is raised.
  1736. """
  1737. failed = []
  1738. if checked_enum.__dict__ != simple_enum.__dict__:
  1739. checked_dict = checked_enum.__dict__
  1740. checked_keys = list(checked_dict.keys())
  1741. simple_dict = simple_enum.__dict__
  1742. simple_keys = list(simple_dict.keys())
  1743. member_names = set(
  1744. list(checked_enum._member_map_.keys())
  1745. + list(simple_enum._member_map_.keys())
  1746. )
  1747. for key in set(checked_keys + simple_keys):
  1748. if key in ('__module__', '_member_map_', '_value2member_map_', '__doc__'):
  1749. # keys known to be different, or very long
  1750. continue
  1751. elif key in member_names:
  1752. # members are checked below
  1753. continue
  1754. elif key not in simple_keys:
  1755. failed.append("missing key: %r" % (key, ))
  1756. elif key not in checked_keys:
  1757. failed.append("extra key: %r" % (key, ))
  1758. else:
  1759. checked_value = checked_dict[key]
  1760. simple_value = simple_dict[key]
  1761. if callable(checked_value) or isinstance(checked_value, bltns.property):
  1762. continue
  1763. if key == '__doc__':
  1764. # remove all spaces/tabs
  1765. compressed_checked_value = checked_value.replace(' ','').replace('\t','')
  1766. compressed_simple_value = simple_value.replace(' ','').replace('\t','')
  1767. if compressed_checked_value != compressed_simple_value:
  1768. failed.append("%r:\n %s\n %s" % (
  1769. key,
  1770. "checked -> %r" % (checked_value, ),
  1771. "simple -> %r" % (simple_value, ),
  1772. ))
  1773. elif checked_value != simple_value:
  1774. failed.append("%r:\n %s\n %s" % (
  1775. key,
  1776. "checked -> %r" % (checked_value, ),
  1777. "simple -> %r" % (simple_value, ),
  1778. ))
  1779. failed.sort()
  1780. for name in member_names:
  1781. failed_member = []
  1782. if name not in simple_keys:
  1783. failed.append('missing member from simple enum: %r' % name)
  1784. elif name not in checked_keys:
  1785. failed.append('extra member in simple enum: %r' % name)
  1786. else:
  1787. checked_member_dict = checked_enum[name].__dict__
  1788. checked_member_keys = list(checked_member_dict.keys())
  1789. simple_member_dict = simple_enum[name].__dict__
  1790. simple_member_keys = list(simple_member_dict.keys())
  1791. for key in set(checked_member_keys + simple_member_keys):
  1792. if key in ('__module__', '__objclass__', '_inverted_'):
  1793. # keys known to be different or absent
  1794. continue
  1795. elif key not in simple_member_keys:
  1796. failed_member.append("missing key %r not in the simple enum member %r" % (key, name))
  1797. elif key not in checked_member_keys:
  1798. failed_member.append("extra key %r in simple enum member %r" % (key, name))
  1799. else:
  1800. checked_value = checked_member_dict[key]
  1801. simple_value = simple_member_dict[key]
  1802. if checked_value != simple_value:
  1803. failed_member.append("%r:\n %s\n %s" % (
  1804. key,
  1805. "checked member -> %r" % (checked_value, ),
  1806. "simple member -> %r" % (simple_value, ),
  1807. ))
  1808. if failed_member:
  1809. failed.append('%r member mismatch:\n %s' % (
  1810. name, '\n '.join(failed_member),
  1811. ))
  1812. for method in (
  1813. '__str__', '__repr__', '__reduce_ex__', '__format__',
  1814. '__getnewargs_ex__', '__getnewargs__', '__reduce_ex__', '__reduce__'
  1815. ):
  1816. if method in simple_keys and method in checked_keys:
  1817. # cannot compare functions, and it exists in both, so we're good
  1818. continue
  1819. elif method not in simple_keys and method not in checked_keys:
  1820. # method is inherited -- check it out
  1821. checked_method = getattr(checked_enum, method, None)
  1822. simple_method = getattr(simple_enum, method, None)
  1823. if hasattr(checked_method, '__func__'):
  1824. checked_method = checked_method.__func__
  1825. simple_method = simple_method.__func__
  1826. if checked_method != simple_method:
  1827. failed.append("%r: %-30s %s" % (
  1828. method,
  1829. "checked -> %r" % (checked_method, ),
  1830. "simple -> %r" % (simple_method, ),
  1831. ))
  1832. else:
  1833. # if the method existed in only one of the enums, it will have been caught
  1834. # in the first checks above
  1835. pass
  1836. if failed:
  1837. raise TypeError('enum mismatch:\n %s' % '\n '.join(failed))
  1838. def _old_convert_(etype, name, module, filter, source=None, *, boundary=None):
  1839. """
  1840. Create a new Enum subclass that replaces a collection of global constants
  1841. """
  1842. # convert all constants from source (or module) that pass filter() to
  1843. # a new Enum called name, and export the enum and its members back to
  1844. # module;
  1845. # also, replace the __reduce_ex__ method so unpickling works in
  1846. # previous Python versions
  1847. module_globals = sys.modules[module].__dict__
  1848. if source:
  1849. source = source.__dict__
  1850. else:
  1851. source = module_globals
  1852. # _value2member_map_ is populated in the same order every time
  1853. # for a consistent reverse mapping of number to name when there
  1854. # are multiple names for the same number.
  1855. members = [
  1856. (name, value)
  1857. for name, value in source.items()
  1858. if filter(name)]
  1859. try:
  1860. # sort by value
  1861. members.sort(key=lambda t: (t[1], t[0]))
  1862. except TypeError:
  1863. # unless some values aren't comparable, in which case sort by name
  1864. members.sort(key=lambda t: t[0])
  1865. cls = etype(name, members, module=module, boundary=boundary or KEEP)
  1866. cls.__reduce_ex__ = _reduce_ex_by_global_name
  1867. return cls
  1868. _stdlib_enums = IntEnum, StrEnum, IntFlag