enum.py 34 KB

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