enum.py 34 KB

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