enum.py 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014
  1. import sys
  2. from types import MappingProxyType, DynamicClassAttribute
  3. __all__ = [
  4. 'EnumMeta',
  5. 'Enum', 'IntEnum', 'Flag', 'IntFlag',
  6. 'auto', 'unique',
  7. ]
  8. def _is_descriptor(obj):
  9. """
  10. Returns True if obj is a descriptor, False otherwise.
  11. """
  12. return (
  13. hasattr(obj, '__get__') or
  14. hasattr(obj, '__set__') or
  15. hasattr(obj, '__delete__')
  16. )
  17. def _is_dunder(name):
  18. """
  19. Returns True if a __dunder__ name, False otherwise.
  20. """
  21. return (
  22. len(name) > 4 and
  23. name[:2] == name[-2:] == '__' and
  24. name[2] != '_' and
  25. name[-3] != '_'
  26. )
  27. def _is_sunder(name):
  28. """
  29. Returns True if a _sunder_ name, False otherwise.
  30. """
  31. return (
  32. len(name) > 2 and
  33. name[0] == name[-1] == '_' and
  34. name[1:2] != '_' and
  35. name[-2:-1] != '_'
  36. )
  37. def _make_class_unpicklable(cls):
  38. """
  39. Make the given class un-picklable.
  40. """
  41. def _break_on_call_reduce(self, proto):
  42. raise TypeError('%r cannot be pickled' % self)
  43. cls.__reduce_ex__ = _break_on_call_reduce
  44. cls.__module__ = '<unknown>'
  45. _auto_null = object()
  46. class auto:
  47. """
  48. Instances are replaced with an appropriate value in Enum class suites.
  49. """
  50. value = _auto_null
  51. class _EnumDict(dict):
  52. """
  53. Track enum member order and ensure member names are not reused.
  54. EnumMeta will use the names found in self._member_names as the
  55. enumeration member names.
  56. """
  57. def __init__(self):
  58. super().__init__()
  59. self._member_names = []
  60. self._last_values = []
  61. self._ignore = []
  62. self._auto_called = False
  63. def __setitem__(self, key, value):
  64. """
  65. Changes anything not dundered or not a descriptor.
  66. If an enum member name is used twice, an error is raised; duplicate
  67. values are not checked for.
  68. Single underscore (sunder) names are reserved.
  69. """
  70. if _is_sunder(key):
  71. if key not in (
  72. '_order_', '_create_pseudo_member_',
  73. '_generate_next_value_', '_missing_', '_ignore_',
  74. ):
  75. raise ValueError('_names_ are reserved for future Enum use')
  76. if key == '_generate_next_value_':
  77. # check if members already defined as auto()
  78. if self._auto_called:
  79. raise TypeError("_generate_next_value_ must be defined before members")
  80. setattr(self, '_generate_next_value', value)
  81. elif key == '_ignore_':
  82. if isinstance(value, str):
  83. value = value.replace(',',' ').split()
  84. else:
  85. value = list(value)
  86. self._ignore = value
  87. already = set(value) & set(self._member_names)
  88. if already:
  89. raise ValueError(
  90. '_ignore_ cannot specify already set names: %r'
  91. % (already, )
  92. )
  93. elif _is_dunder(key):
  94. if key == '__order__':
  95. key = '_order_'
  96. elif key in self._member_names:
  97. # descriptor overwriting an enum?
  98. raise TypeError('Attempted to reuse key: %r' % key)
  99. elif key in self._ignore:
  100. pass
  101. elif not _is_descriptor(value):
  102. if key in self:
  103. # enum overwriting a descriptor?
  104. raise TypeError('%r already defined as: %r' % (key, self[key]))
  105. if isinstance(value, auto):
  106. if value.value == _auto_null:
  107. value.value = self._generate_next_value(
  108. key,
  109. 1,
  110. len(self._member_names),
  111. self._last_values[:],
  112. )
  113. self._auto_called = True
  114. value = value.value
  115. self._member_names.append(key)
  116. self._last_values.append(value)
  117. super().__setitem__(key, value)
  118. # Dummy value for Enum as EnumMeta explicitly checks for it, but of course
  119. # until EnumMeta finishes running the first time the Enum class doesn't exist.
  120. # This is also why there are checks in EnumMeta like `if Enum is not None`
  121. Enum = None
  122. class EnumMeta(type):
  123. """
  124. Metaclass for Enum
  125. """
  126. @classmethod
  127. def __prepare__(metacls, cls, bases):
  128. # check that previous enum members do not exist
  129. metacls._check_for_existing_members(cls, bases)
  130. # create the namespace dict
  131. enum_dict = _EnumDict()
  132. # inherit previous flags and _generate_next_value_ function
  133. member_type, first_enum = metacls._get_mixins_(cls, bases)
  134. if first_enum is not None:
  135. enum_dict['_generate_next_value_'] = getattr(
  136. first_enum, '_generate_next_value_', None,
  137. )
  138. return enum_dict
  139. def __new__(metacls, cls, bases, classdict):
  140. # an Enum class is final once enumeration items have been defined; it
  141. # cannot be mixed with other types (int, float, etc.) if it has an
  142. # inherited __new__ unless a new __new__ is defined (or the resulting
  143. # class will fail).
  144. #
  145. # remove any keys listed in _ignore_
  146. classdict.setdefault('_ignore_', []).append('_ignore_')
  147. ignore = classdict['_ignore_']
  148. for key in ignore:
  149. classdict.pop(key, None)
  150. member_type, first_enum = metacls._get_mixins_(cls, bases)
  151. __new__, save_new, use_args = metacls._find_new_(
  152. classdict, member_type, first_enum,
  153. )
  154. # save enum items into separate mapping so they don't get baked into
  155. # the new class
  156. enum_members = {k: classdict[k] for k in classdict._member_names}
  157. for name in classdict._member_names:
  158. del classdict[name]
  159. # adjust the sunders
  160. _order_ = classdict.pop('_order_', None)
  161. # check for illegal enum names (any others?)
  162. invalid_names = set(enum_members) & {'mro', ''}
  163. if invalid_names:
  164. raise ValueError('Invalid enum member name: {0}'.format(
  165. ','.join(invalid_names)))
  166. # create a default docstring if one has not been provided
  167. if '__doc__' not in classdict:
  168. classdict['__doc__'] = 'An enumeration.'
  169. # create our new Enum type
  170. enum_class = super().__new__(metacls, cls, bases, classdict)
  171. enum_class._member_names_ = [] # names in definition order
  172. enum_class._member_map_ = {} # name->value map
  173. enum_class._member_type_ = member_type
  174. # save DynamicClassAttribute attributes from super classes so we know
  175. # if we can take the shortcut of storing members in the class dict
  176. dynamic_attributes = {
  177. k for c in enum_class.mro()
  178. for k, v in c.__dict__.items()
  179. if isinstance(v, DynamicClassAttribute)
  180. }
  181. # Reverse value->name map for hashable values.
  182. enum_class._value2member_map_ = {}
  183. # If a custom type is mixed into the Enum, and it does not know how
  184. # to pickle itself, pickle.dumps will succeed but pickle.loads will
  185. # fail. Rather than have the error show up later and possibly far
  186. # from the source, sabotage the pickle protocol for this class so
  187. # that pickle.dumps also fails.
  188. #
  189. # However, if the new class implements its own __reduce_ex__, do not
  190. # sabotage -- it's on them to make sure it works correctly. We use
  191. # __reduce_ex__ instead of any of the others as it is preferred by
  192. # pickle over __reduce__, and it handles all pickle protocols.
  193. if '__reduce_ex__' not in classdict:
  194. if member_type is not object:
  195. methods = ('__getnewargs_ex__', '__getnewargs__',
  196. '__reduce_ex__', '__reduce__')
  197. if not any(m in member_type.__dict__ for m in methods):
  198. _make_class_unpicklable(enum_class)
  199. # instantiate them, checking for duplicates as we go
  200. # we instantiate first instead of checking for duplicates first in case
  201. # a custom __new__ is doing something funky with the values -- such as
  202. # auto-numbering ;)
  203. for member_name in classdict._member_names:
  204. value = enum_members[member_name]
  205. if not isinstance(value, tuple):
  206. args = (value, )
  207. else:
  208. args = value
  209. if member_type is tuple: # special case for tuple enums
  210. args = (args, ) # wrap it one more time
  211. if not use_args:
  212. enum_member = __new__(enum_class)
  213. if not hasattr(enum_member, '_value_'):
  214. enum_member._value_ = value
  215. else:
  216. enum_member = __new__(enum_class, *args)
  217. if not hasattr(enum_member, '_value_'):
  218. if member_type is object:
  219. enum_member._value_ = value
  220. else:
  221. enum_member._value_ = member_type(*args)
  222. value = enum_member._value_
  223. enum_member._name_ = member_name
  224. enum_member.__objclass__ = enum_class
  225. enum_member.__init__(*args)
  226. # If another member with the same value was already defined, the
  227. # new member becomes an alias to the existing one.
  228. for name, canonical_member in enum_class._member_map_.items():
  229. if canonical_member._value_ == enum_member._value_:
  230. enum_member = canonical_member
  231. break
  232. else:
  233. # Aliases don't appear in member names (only in __members__).
  234. enum_class._member_names_.append(member_name)
  235. # performance boost for any member that would not shadow
  236. # a DynamicClassAttribute
  237. if member_name not in dynamic_attributes:
  238. setattr(enum_class, member_name, enum_member)
  239. # now add to _member_map_
  240. enum_class._member_map_[member_name] = enum_member
  241. try:
  242. # This may fail if value is not hashable. We can't add the value
  243. # to the map, and by-value lookups for this value will be
  244. # linear.
  245. enum_class._value2member_map_[value] = enum_member
  246. except TypeError:
  247. pass
  248. # double check that repr and friends are not the mixin's or various
  249. # things break (such as pickle)
  250. # however, if the method is defined in the Enum itself, don't replace
  251. # it
  252. for name in ('__repr__', '__str__', '__format__', '__reduce_ex__'):
  253. if name in classdict:
  254. continue
  255. class_method = getattr(enum_class, name)
  256. obj_method = getattr(member_type, name, None)
  257. enum_method = getattr(first_enum, name, None)
  258. if obj_method is not None and obj_method is class_method:
  259. setattr(enum_class, name, enum_method)
  260. # replace any other __new__ with our own (as long as Enum is not None,
  261. # anyway) -- again, this is to support pickle
  262. if Enum is not None:
  263. # if the user defined their own __new__, save it before it gets
  264. # clobbered in case they subclass later
  265. if save_new:
  266. enum_class.__new_member__ = __new__
  267. enum_class.__new__ = Enum.__new__
  268. # py3 support for definition order (helps keep py2/py3 code in sync)
  269. if _order_ is not None:
  270. if isinstance(_order_, str):
  271. _order_ = _order_.replace(',', ' ').split()
  272. if _order_ != enum_class._member_names_:
  273. raise TypeError('member order does not match _order_')
  274. return enum_class
  275. def __bool__(self):
  276. """
  277. classes/types should always be True.
  278. """
  279. return True
  280. def __call__(cls, value, names=None, *, module=None, qualname=None, type=None, start=1):
  281. """
  282. Either returns an existing member, or creates a new enum class.
  283. This method is used both when an enum class is given a value to match
  284. to an enumeration member (i.e. Color(3)) and for the functional API
  285. (i.e. Color = Enum('Color', names='RED GREEN BLUE')).
  286. When used for the functional API:
  287. `value` will be the name of the new class.
  288. `names` should be either a string of white-space/comma delimited names
  289. (values will start at `start`), or an iterator/mapping of name, value pairs.
  290. `module` should be set to the module this class is being created in;
  291. if it is not set, an attempt to find that module will be made, but if
  292. it fails the class will not be picklable.
  293. `qualname` should be set to the actual location this class can be found
  294. at in its module; by default it is set to the global scope. If this is
  295. not correct, unpickling will fail in some circumstances.
  296. `type`, if set, will be mixed in as the first base class.
  297. """
  298. if names is None: # simple value lookup
  299. return cls.__new__(cls, value)
  300. # otherwise, functional API: we're creating a new Enum type
  301. return cls._create_(
  302. value,
  303. names,
  304. module=module,
  305. qualname=qualname,
  306. type=type,
  307. start=start,
  308. )
  309. def __contains__(cls, member):
  310. if not isinstance(member, Enum):
  311. raise TypeError(
  312. "unsupported operand type(s) for 'in': '%s' and '%s'" % (
  313. type(member).__qualname__, cls.__class__.__qualname__))
  314. return isinstance(member, cls) and member._name_ in cls._member_map_
  315. def __delattr__(cls, attr):
  316. # nicer error message when someone tries to delete an attribute
  317. # (see issue19025).
  318. if attr in cls._member_map_:
  319. raise AttributeError("%s: cannot delete Enum member." % cls.__name__)
  320. super().__delattr__(attr)
  321. def __dir__(self):
  322. return (
  323. ['__class__', '__doc__', '__members__', '__module__']
  324. + self._member_names_
  325. )
  326. def __getattr__(cls, name):
  327. """
  328. Return the enum member matching `name`
  329. We use __getattr__ instead of descriptors or inserting into the enum
  330. class' __dict__ in order to support `name` and `value` being both
  331. properties for enum members (which live in the class' __dict__) and
  332. enum members themselves.
  333. """
  334. if _is_dunder(name):
  335. raise AttributeError(name)
  336. try:
  337. return cls._member_map_[name]
  338. except KeyError:
  339. raise AttributeError(name) from None
  340. def __getitem__(cls, name):
  341. return cls._member_map_[name]
  342. def __iter__(cls):
  343. """
  344. Returns members in definition order.
  345. """
  346. return (cls._member_map_[name] for name in cls._member_names_)
  347. def __len__(cls):
  348. return len(cls._member_names_)
  349. @property
  350. def __members__(cls):
  351. """
  352. Returns a mapping of member name->value.
  353. This mapping lists all enum members, including aliases. Note that this
  354. is a read-only view of the internal mapping.
  355. """
  356. return MappingProxyType(cls._member_map_)
  357. def __repr__(cls):
  358. return "<enum %r>" % cls.__name__
  359. def __reversed__(cls):
  360. """
  361. Returns members in reverse definition order.
  362. """
  363. return (cls._member_map_[name] for name in reversed(cls._member_names_))
  364. def __setattr__(cls, name, value):
  365. """
  366. Block attempts to reassign Enum members.
  367. A simple assignment to the class namespace only changes one of the
  368. several possible ways to get an Enum member from the Enum class,
  369. resulting in an inconsistent Enumeration.
  370. """
  371. member_map = cls.__dict__.get('_member_map_', {})
  372. if name in member_map:
  373. raise AttributeError('Cannot reassign members.')
  374. super().__setattr__(name, value)
  375. def _create_(cls, class_name, names, *, module=None, qualname=None, type=None, start=1):
  376. """
  377. Convenience method to create a new Enum class.
  378. `names` can be:
  379. * A string containing member names, separated either with spaces or
  380. commas. Values are incremented by 1 from `start`.
  381. * An iterable of member names. Values are incremented by 1 from `start`.
  382. * An iterable of (member name, value) pairs.
  383. * A mapping of member name -> value pairs.
  384. """
  385. metacls = cls.__class__
  386. bases = (cls, ) if type is None else (type, cls)
  387. _, first_enum = cls._get_mixins_(cls, bases)
  388. classdict = metacls.__prepare__(class_name, bases)
  389. # special processing needed for names?
  390. if isinstance(names, str):
  391. names = names.replace(',', ' ').split()
  392. if isinstance(names, (tuple, list)) and names and isinstance(names[0], str):
  393. original_names, names = names, []
  394. last_values = []
  395. for count, name in enumerate(original_names):
  396. value = first_enum._generate_next_value_(name, start, count, last_values[:])
  397. last_values.append(value)
  398. names.append((name, value))
  399. # Here, names is either an iterable of (name, value) or a mapping.
  400. for item in names:
  401. if isinstance(item, str):
  402. member_name, member_value = item, names[item]
  403. else:
  404. member_name, member_value = item
  405. classdict[member_name] = member_value
  406. enum_class = metacls.__new__(metacls, class_name, bases, classdict)
  407. # TODO: replace the frame hack if a blessed way to know the calling
  408. # module is ever developed
  409. if module is None:
  410. try:
  411. module = sys._getframe(2).f_globals['__name__']
  412. except (AttributeError, ValueError, KeyError) as exc:
  413. pass
  414. if module is None:
  415. _make_class_unpicklable(enum_class)
  416. else:
  417. enum_class.__module__ = module
  418. if qualname is not None:
  419. enum_class.__qualname__ = qualname
  420. return enum_class
  421. def _convert_(cls, name, module, filter, source=None):
  422. """
  423. Create a new Enum subclass that replaces a collection of global constants
  424. """
  425. # convert all constants from source (or module) that pass filter() to
  426. # a new Enum called name, and export the enum and its members back to
  427. # module;
  428. # also, replace the __reduce_ex__ method so unpickling works in
  429. # previous Python versions
  430. module_globals = vars(sys.modules[module])
  431. if source:
  432. source = vars(source)
  433. else:
  434. source = module_globals
  435. # _value2member_map_ is populated in the same order every time
  436. # for a consistent reverse mapping of number to name when there
  437. # are multiple names for the same number.
  438. members = [
  439. (name, value)
  440. for name, value in source.items()
  441. if filter(name)]
  442. try:
  443. # sort by value
  444. members.sort(key=lambda t: (t[1], t[0]))
  445. except TypeError:
  446. # unless some values aren't comparable, in which case sort by name
  447. members.sort(key=lambda t: t[0])
  448. cls = cls(name, members, module=module)
  449. cls.__reduce_ex__ = _reduce_ex_by_name
  450. module_globals.update(cls.__members__)
  451. module_globals[name] = cls
  452. return cls
  453. def _convert(cls, *args, **kwargs):
  454. import warnings
  455. warnings.warn("_convert is deprecated and will be removed in 3.9, use "
  456. "_convert_ instead.", DeprecationWarning, stacklevel=2)
  457. return cls._convert_(*args, **kwargs)
  458. @staticmethod
  459. def _check_for_existing_members(class_name, bases):
  460. for chain in bases:
  461. for base in chain.__mro__:
  462. if issubclass(base, Enum) and base._member_names_:
  463. raise TypeError(
  464. "%s: cannot extend enumeration %r"
  465. % (class_name, base.__name__)
  466. )
  467. @staticmethod
  468. def _get_mixins_(class_name, bases):
  469. """
  470. Returns the type for creating enum members, and the first inherited
  471. enum class.
  472. bases: the tuple of bases that was given to __new__
  473. """
  474. if not bases:
  475. return object, Enum
  476. def _find_data_type(bases):
  477. data_types = []
  478. for chain in bases:
  479. candidate = None
  480. for base in chain.__mro__:
  481. if base is object:
  482. continue
  483. elif issubclass(base, Enum):
  484. if base._member_type_ is not object:
  485. data_types.append(base._member_type_)
  486. break
  487. elif '__new__' in base.__dict__:
  488. if issubclass(base, Enum):
  489. continue
  490. data_types.append(candidate or base)
  491. break
  492. else:
  493. candidate = base
  494. if len(data_types) > 1:
  495. raise TypeError('%r: too many data types: %r' % (class_name, data_types))
  496. elif data_types:
  497. return data_types[0]
  498. else:
  499. return None
  500. # ensure final parent class is an Enum derivative, find any concrete
  501. # data type, and check that Enum has no members
  502. first_enum = bases[-1]
  503. if not issubclass(first_enum, Enum):
  504. raise TypeError("new enumerations should be created as "
  505. "`EnumName([mixin_type, ...] [data_type,] enum_type)`")
  506. member_type = _find_data_type(bases) or object
  507. if first_enum._member_names_:
  508. raise TypeError("Cannot extend enumerations")
  509. return member_type, first_enum
  510. @staticmethod
  511. def _find_new_(classdict, member_type, first_enum):
  512. """
  513. Returns the __new__ to be used for creating the enum members.
  514. classdict: the class dictionary given to __new__
  515. member_type: the data type whose __new__ will be used by default
  516. first_enum: enumeration to check for an overriding __new__
  517. """
  518. # now find the correct __new__, checking to see of one was defined
  519. # by the user; also check earlier enum classes in case a __new__ was
  520. # saved as __new_member__
  521. __new__ = classdict.get('__new__', None)
  522. # should __new__ be saved as __new_member__ later?
  523. save_new = __new__ is not None
  524. if __new__ is None:
  525. # check all possibles for __new_member__ before falling back to
  526. # __new__
  527. for method in ('__new_member__', '__new__'):
  528. for possible in (member_type, first_enum):
  529. target = getattr(possible, method, None)
  530. if target not in {
  531. None,
  532. None.__new__,
  533. object.__new__,
  534. Enum.__new__,
  535. }:
  536. __new__ = target
  537. break
  538. if __new__ is not None:
  539. break
  540. else:
  541. __new__ = object.__new__
  542. # if a non-object.__new__ is used then whatever value/tuple was
  543. # assigned to the enum member name will be passed to __new__ and to the
  544. # new enum member's __init__
  545. if __new__ is object.__new__:
  546. use_args = False
  547. else:
  548. use_args = True
  549. return __new__, save_new, use_args
  550. class Enum(metaclass=EnumMeta):
  551. """
  552. Generic enumeration.
  553. Derive from this class to define new enumerations.
  554. """
  555. def __new__(cls, value):
  556. # all enum instances are actually created during class construction
  557. # without calling this method; this method is called by the metaclass'
  558. # __call__ (i.e. Color(3) ), and by pickle
  559. if type(value) is cls:
  560. # For lookups like Color(Color.RED)
  561. return value
  562. # by-value search for a matching enum member
  563. # see if it's in the reverse mapping (for hashable values)
  564. try:
  565. return cls._value2member_map_[value]
  566. except KeyError:
  567. # Not found, no need to do long O(n) search
  568. pass
  569. except TypeError:
  570. # not there, now do long search -- O(n) behavior
  571. for member in cls._member_map_.values():
  572. if member._value_ == value:
  573. return member
  574. # still not found -- try _missing_ hook
  575. try:
  576. exc = None
  577. result = cls._missing_(value)
  578. except Exception as e:
  579. exc = e
  580. result = None
  581. if isinstance(result, cls):
  582. return result
  583. else:
  584. ve_exc = ValueError("%r is not a valid %s" % (value, cls.__name__))
  585. if result is None and exc is None:
  586. raise ve_exc
  587. elif exc is None:
  588. exc = TypeError(
  589. 'error in %s._missing_: returned %r instead of None or a valid member'
  590. % (cls.__name__, result)
  591. )
  592. exc.__context__ = ve_exc
  593. raise exc
  594. def _generate_next_value_(name, start, count, last_values):
  595. """
  596. Generate the next value when not given.
  597. name: the name of the member
  598. start: the initial start value or None
  599. count: the number of existing members
  600. last_value: the last value assigned or None
  601. """
  602. for last_value in reversed(last_values):
  603. try:
  604. return last_value + 1
  605. except TypeError:
  606. pass
  607. else:
  608. return start
  609. @classmethod
  610. def _missing_(cls, value):
  611. return None
  612. def __repr__(self):
  613. return "<%s.%s: %r>" % (
  614. self.__class__.__name__, self._name_, self._value_)
  615. def __str__(self):
  616. return "%s.%s" % (self.__class__.__name__, self._name_)
  617. def __dir__(self):
  618. """
  619. Returns all members and all public methods
  620. """
  621. added_behavior = [
  622. m
  623. for cls in self.__class__.mro()
  624. for m in cls.__dict__
  625. if m[0] != '_' and m not in self._member_map_
  626. ] + [m for m in self.__dict__ if m[0] != '_']
  627. return (['__class__', '__doc__', '__module__'] + added_behavior)
  628. def __format__(self, format_spec):
  629. """
  630. Returns format using actual value type unless __str__ has been overridden.
  631. """
  632. # mixed-in Enums should use the mixed-in type's __format__, otherwise
  633. # we can get strange results with the Enum name showing up instead of
  634. # the value
  635. # pure Enum branch, or branch with __str__ explicitly overridden
  636. str_overridden = type(self).__str__ not in (Enum.__str__, Flag.__str__)
  637. if self._member_type_ is object or str_overridden:
  638. cls = str
  639. val = str(self)
  640. # mix-in branch
  641. else:
  642. cls = self._member_type_
  643. val = self._value_
  644. return cls.__format__(val, format_spec)
  645. def __hash__(self):
  646. return hash(self._name_)
  647. def __reduce_ex__(self, proto):
  648. return self.__class__, (self._value_, )
  649. # DynamicClassAttribute is used to provide access to the `name` and
  650. # `value` properties of enum members while keeping some measure of
  651. # protection from modification, while still allowing for an enumeration
  652. # to have members named `name` and `value`. This works because enumeration
  653. # members are not set directly on the enum class -- __getattr__ is
  654. # used to look them up.
  655. @DynamicClassAttribute
  656. def name(self):
  657. """The name of the Enum member."""
  658. return self._name_
  659. @DynamicClassAttribute
  660. def value(self):
  661. """The value of the Enum member."""
  662. return self._value_
  663. class IntEnum(int, Enum):
  664. """Enum where members are also (and must be) ints"""
  665. def _reduce_ex_by_name(self, proto):
  666. return self.name
  667. class Flag(Enum):
  668. """
  669. Support for flags
  670. """
  671. def _generate_next_value_(name, start, count, last_values):
  672. """
  673. Generate the next value when not given.
  674. name: the name of the member
  675. start: the initial start value or None
  676. count: the number of existing members
  677. last_value: the last value assigned or None
  678. """
  679. if not count:
  680. return start if start is not None else 1
  681. for last_value in reversed(last_values):
  682. try:
  683. high_bit = _high_bit(last_value)
  684. break
  685. except Exception:
  686. raise TypeError('Invalid Flag value: %r' % last_value) from None
  687. return 2 ** (high_bit+1)
  688. @classmethod
  689. def _missing_(cls, value):
  690. """
  691. Returns member (possibly creating it) if one can be found for value.
  692. """
  693. original_value = value
  694. if value < 0:
  695. value = ~value
  696. possible_member = cls._create_pseudo_member_(value)
  697. if original_value < 0:
  698. possible_member = ~possible_member
  699. return possible_member
  700. @classmethod
  701. def _create_pseudo_member_(cls, value):
  702. """
  703. Create a composite member iff value contains only members.
  704. """
  705. pseudo_member = cls._value2member_map_.get(value, None)
  706. if pseudo_member is None:
  707. # verify all bits are accounted for
  708. _, extra_flags = _decompose(cls, value)
  709. if extra_flags:
  710. raise ValueError("%r is not a valid %s" % (value, cls.__name__))
  711. # construct a singleton enum pseudo-member
  712. pseudo_member = object.__new__(cls)
  713. pseudo_member._name_ = None
  714. pseudo_member._value_ = value
  715. # use setdefault in case another thread already created a composite
  716. # with this value
  717. pseudo_member = cls._value2member_map_.setdefault(value, pseudo_member)
  718. return pseudo_member
  719. def __contains__(self, other):
  720. """
  721. Returns True if self has at least the same flags set as other.
  722. """
  723. if not isinstance(other, self.__class__):
  724. raise TypeError(
  725. "unsupported operand type(s) for 'in': '%s' and '%s'" % (
  726. type(other).__qualname__, self.__class__.__qualname__))
  727. return other._value_ & self._value_ == other._value_
  728. def __repr__(self):
  729. cls = self.__class__
  730. if self._name_ is not None:
  731. return '<%s.%s: %r>' % (cls.__name__, self._name_, self._value_)
  732. members, uncovered = _decompose(cls, self._value_)
  733. return '<%s.%s: %r>' % (
  734. cls.__name__,
  735. '|'.join([str(m._name_ or m._value_) for m in members]),
  736. self._value_,
  737. )
  738. def __str__(self):
  739. cls = self.__class__
  740. if self._name_ is not None:
  741. return '%s.%s' % (cls.__name__, self._name_)
  742. members, uncovered = _decompose(cls, self._value_)
  743. if len(members) == 1 and members[0]._name_ is None:
  744. return '%s.%r' % (cls.__name__, members[0]._value_)
  745. else:
  746. return '%s.%s' % (
  747. cls.__name__,
  748. '|'.join([str(m._name_ or m._value_) for m in members]),
  749. )
  750. def __bool__(self):
  751. return bool(self._value_)
  752. def __or__(self, other):
  753. if not isinstance(other, self.__class__):
  754. return NotImplemented
  755. return self.__class__(self._value_ | other._value_)
  756. def __and__(self, other):
  757. if not isinstance(other, self.__class__):
  758. return NotImplemented
  759. return self.__class__(self._value_ & other._value_)
  760. def __xor__(self, other):
  761. if not isinstance(other, self.__class__):
  762. return NotImplemented
  763. return self.__class__(self._value_ ^ other._value_)
  764. def __invert__(self):
  765. members, uncovered = _decompose(self.__class__, self._value_)
  766. inverted = self.__class__(0)
  767. for m in self.__class__:
  768. if m not in members and not (m._value_ & self._value_):
  769. inverted = inverted | m
  770. return self.__class__(inverted)
  771. class IntFlag(int, Flag):
  772. """
  773. Support for integer-based Flags
  774. """
  775. @classmethod
  776. def _missing_(cls, value):
  777. """
  778. Returns member (possibly creating it) if one can be found for value.
  779. """
  780. if not isinstance(value, int):
  781. raise ValueError("%r is not a valid %s" % (value, cls.__name__))
  782. new_member = cls._create_pseudo_member_(value)
  783. return new_member
  784. @classmethod
  785. def _create_pseudo_member_(cls, value):
  786. """
  787. Create a composite member iff value contains only members.
  788. """
  789. pseudo_member = cls._value2member_map_.get(value, None)
  790. if pseudo_member is None:
  791. need_to_create = [value]
  792. # get unaccounted for bits
  793. _, extra_flags = _decompose(cls, value)
  794. # timer = 10
  795. while extra_flags:
  796. # timer -= 1
  797. bit = _high_bit(extra_flags)
  798. flag_value = 2 ** bit
  799. if (flag_value not in cls._value2member_map_ and
  800. flag_value not in need_to_create
  801. ):
  802. need_to_create.append(flag_value)
  803. if extra_flags == -flag_value:
  804. extra_flags = 0
  805. else:
  806. extra_flags ^= flag_value
  807. for value in reversed(need_to_create):
  808. # construct singleton pseudo-members
  809. pseudo_member = int.__new__(cls, value)
  810. pseudo_member._name_ = None
  811. pseudo_member._value_ = value
  812. # use setdefault in case another thread already created a composite
  813. # with this value
  814. pseudo_member = cls._value2member_map_.setdefault(value, pseudo_member)
  815. return pseudo_member
  816. def __or__(self, other):
  817. if not isinstance(other, (self.__class__, int)):
  818. return NotImplemented
  819. result = self.__class__(self._value_ | self.__class__(other)._value_)
  820. return result
  821. def __and__(self, other):
  822. if not isinstance(other, (self.__class__, int)):
  823. return NotImplemented
  824. return self.__class__(self._value_ & self.__class__(other)._value_)
  825. def __xor__(self, other):
  826. if not isinstance(other, (self.__class__, int)):
  827. return NotImplemented
  828. return self.__class__(self._value_ ^ self.__class__(other)._value_)
  829. __ror__ = __or__
  830. __rand__ = __and__
  831. __rxor__ = __xor__
  832. def __invert__(self):
  833. result = self.__class__(~self._value_)
  834. return result
  835. def _high_bit(value):
  836. """
  837. returns index of highest bit, or -1 if value is zero or negative
  838. """
  839. return value.bit_length() - 1
  840. def unique(enumeration):
  841. """
  842. Class decorator for enumerations ensuring unique member values.
  843. """
  844. duplicates = []
  845. for name, member in enumeration.__members__.items():
  846. if name != member.name:
  847. duplicates.append((name, member.name))
  848. if duplicates:
  849. alias_details = ', '.join(
  850. ["%s -> %s" % (alias, name) for (alias, name) in duplicates])
  851. raise ValueError('duplicate values found in %r: %s' %
  852. (enumeration, alias_details))
  853. return enumeration
  854. def _decompose(flag, value):
  855. """
  856. Extract all members from the value.
  857. """
  858. # _decompose is only called if the value is not named
  859. not_covered = value
  860. negative = value < 0
  861. # issue29167: wrap accesses to _value2member_map_ in a list to avoid race
  862. # conditions between iterating over it and having more pseudo-
  863. # members added to it
  864. if negative:
  865. # only check for named flags
  866. flags_to_check = [
  867. (m, v)
  868. for v, m in list(flag._value2member_map_.items())
  869. if m.name is not None
  870. ]
  871. else:
  872. # check for named flags and powers-of-two flags
  873. flags_to_check = [
  874. (m, v)
  875. for v, m in list(flag._value2member_map_.items())
  876. if m.name is not None or _power_of_two(v)
  877. ]
  878. members = []
  879. for member, member_value in flags_to_check:
  880. if member_value and member_value & value == member_value:
  881. members.append(member)
  882. not_covered &= ~member_value
  883. if not members and value in flag._value2member_map_:
  884. members.append(flag._value2member_map_[value])
  885. members.sort(key=lambda m: m._value_, reverse=True)
  886. if len(members) > 1 and members[0].value == value:
  887. # we have the breakdown, don't need the value member itself
  888. members.pop(0)
  889. return members, not_covered
  890. def _power_of_two(value):
  891. if value < 1:
  892. return False
  893. return value == 2 ** _high_bit(value)