2013-06-14 20:55:46 -03:00
|
|
|
:mod:`enum` --- Support for enumerations
|
|
|
|
========================================
|
|
|
|
|
|
|
|
.. module:: enum
|
2013-06-14 22:59:16 -03:00
|
|
|
:synopsis: Implementation of an enumeration class.
|
|
|
|
|
2018-07-07 16:01:25 -03:00
|
|
|
.. moduleauthor:: Ethan Furman <ethan@stoneleaf.us>
|
|
|
|
.. sectionauthor:: Barry Warsaw <barry@python.org>
|
|
|
|
.. sectionauthor:: Eli Bendersky <eliben@gmail.com>
|
|
|
|
.. sectionauthor:: Ethan Furman <ethan@stoneleaf.us>
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2013-12-20 15:20:49 -04:00
|
|
|
.. versionadded:: 3.4
|
|
|
|
|
2013-06-14 20:55:46 -03:00
|
|
|
**Source code:** :source:`Lib/enum.py`
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. sidebar:: Important
|
2020-09-14 17:32:44 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
This page contains the API reference information. For tutorial
|
|
|
|
information and discussion of more advanced topics, see
|
2020-09-14 17:32:44 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
* :ref:`Basic Tutorial <enum-basic-tutorial>`
|
|
|
|
* :ref:`Advanced Tutorial <enum-advanced-tutorial>`
|
|
|
|
* :ref:`Enum Cookbook <enum-cookbook>`
|
2014-02-06 12:13:14 -04:00
|
|
|
|
2021-06-18 17:15:46 -03:00
|
|
|
---------------
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
An enumeration:
|
2016-09-11 03:36:59 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
* is a set of symbolic names (members) bound to unique values
|
|
|
|
* can be iterated over to return its members in definition order
|
2021-06-09 13:03:55 -03:00
|
|
|
* uses *call* syntax to return members by value
|
|
|
|
* uses *index* syntax to return members by name
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Enumerations are created either by using :keyword:`class` syntax, or by
|
2021-03-31 01:17:26 -03:00
|
|
|
using function-call syntax::
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> from enum import Enum
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> # class syntax
|
|
|
|
>>> class Color(Enum):
|
|
|
|
... RED = 1
|
|
|
|
... GREEN = 2
|
|
|
|
... BLUE = 3
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> # functional syntax
|
|
|
|
>>> Color = Enum('Color', ['RED', 'GREEN', 'BLUE'])
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Even though we can use :keyword:`class` syntax to create Enums, Enums
|
2021-03-31 01:17:26 -03:00
|
|
|
are not normal Python classes. See
|
|
|
|
:ref:`How are Enums different? <enum-class-differences>` for more details.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. note:: Nomenclature
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
- The class :class:`Color` is an *enumeration* (or *enum*)
|
|
|
|
- The attributes :attr:`Color.RED`, :attr:`Color.GREEN`, etc., are
|
2022-01-17 11:18:13 -04:00
|
|
|
*enumeration members* (or *members*) and are functionally constants.
|
2021-03-31 01:17:26 -03:00
|
|
|
- The enum members have *names* and *values* (the name of
|
|
|
|
:attr:`Color.RED` is ``RED``, the value of :attr:`Color.BLUE` is
|
|
|
|
``3``, etc.)
|
2013-07-18 21:05:39 -03:00
|
|
|
|
2021-06-18 17:15:46 -03:00
|
|
|
---------------
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Module Contents
|
|
|
|
---------------
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`EnumType`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
The ``type`` for Enum and its subclasses.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`Enum`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Base class for creating enumerated constants.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`IntEnum`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Base class for creating enumerated constants that are also
|
2021-06-18 17:15:46 -03:00
|
|
|
subclasses of :class:`int`. (`Notes`_)
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`StrEnum`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Base class for creating enumerated constants that are also
|
2021-06-18 17:15:46 -03:00
|
|
|
subclasses of :class:`str`. (`Notes`_)
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`Flag`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Base class for creating enumerated constants that can be combined using
|
|
|
|
the bitwise operations without losing their :class:`Flag` membership.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`IntFlag`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Base class for creating enumerated constants that can be combined using
|
|
|
|
the bitwise operators without losing their :class:`IntFlag` membership.
|
2021-06-18 17:15:46 -03:00
|
|
|
:class:`IntFlag` members are also subclasses of :class:`int`. (`Notes`_)
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-06-09 13:03:55 -03:00
|
|
|
:class:`EnumCheck`
|
|
|
|
|
|
|
|
An enumeration with the values ``CONTINUOUS``, ``NAMED_FLAGS``, and
|
|
|
|
``UNIQUE``, for use with :func:`verify` to ensure various constraints
|
|
|
|
are met by a given enumeration.
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`FlagBoundary`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
An enumeration with the values ``STRICT``, ``CONFORM``, ``EJECT``, and
|
|
|
|
``KEEP`` which allows for more fine-grained control over how invalid values
|
|
|
|
are dealt with in an enumeration.
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:class:`auto`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Instances are replaced with an appropriate value for Enum members.
|
|
|
|
:class:`StrEnum` defaults to the lower-cased version of the member name,
|
|
|
|
while other Enums default to 1 and increase from there.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2022-02-12 00:21:38 -04:00
|
|
|
:func:`~enum.property`
|
2016-08-05 20:03:16 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Allows :class:`Enum` members to have attributes without conflicting with
|
2022-01-17 11:18:13 -04:00
|
|
|
member names.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:func:`unique`
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Enum class decorator that ensures only one name is bound to any one value.
|
2013-06-28 23:37:17 -03:00
|
|
|
|
2021-06-09 13:03:55 -03:00
|
|
|
:func:`verify`
|
|
|
|
|
|
|
|
Enum class decorator that checks user-selectable constraints on an
|
|
|
|
enumeration.
|
|
|
|
|
2022-05-06 04:16:22 -03:00
|
|
|
:func:`member`
|
|
|
|
|
2022-05-15 12:55:12 -03:00
|
|
|
Make ``obj`` a member. Can be used as a decorator.
|
2022-05-06 04:16:22 -03:00
|
|
|
|
|
|
|
:func:`nonmember`
|
|
|
|
|
2022-05-15 12:55:12 -03:00
|
|
|
Do not make ``obj`` a member. Can be used as a decorator.
|
2022-05-06 04:16:22 -03:00
|
|
|
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto``
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``FlagBoundary``, ``property``
|
2022-05-06 04:16:22 -03:00
|
|
|
.. versionadded:: 3.11 ``member``, ``nonmember``
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-06-18 17:15:46 -03:00
|
|
|
---------------
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Data Types
|
|
|
|
----------
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2014-02-08 15:36:27 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: EnumType
|
2014-02-08 15:36:27 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*EnumType* is the :term:`metaclass` for *enum* enumerations. It is possible
|
|
|
|
to subclass *EnumType* -- see :ref:`Subclassing EnumType <enumtype-examples>`
|
|
|
|
for details.
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
*EnumType* is responsible for setting the correct :meth:`__repr__`,
|
|
|
|
:meth:`__str__`, :meth:`__format__`, and :meth:`__reduce__` methods on the
|
|
|
|
final *enum*, as well as creating the enum members, properly handling
|
|
|
|
duplicates, providing iteration over the enum class, etc.
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__contains__(cls, member)
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns ``True`` if member belongs to the ``cls``::
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> some_var = Color.RED
|
|
|
|
>>> some_var in Color
|
|
|
|
True
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-04-27 17:05:08 -03:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
In Python 3.12 it will be possible to check for member values and not
|
|
|
|
just members; until then, a ``TypeError`` will be raised if a
|
|
|
|
non-Enum-member is used in a containment check.
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__dir__(cls)
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns ``['__class__', '__doc__', '__members__', '__module__']`` and the
|
2022-01-17 11:18:13 -04:00
|
|
|
names of the members in *cls*::
|
2015-01-15 02:31:50 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> dir(Color)
|
2022-01-17 11:18:13 -04:00
|
|
|
['BLUE', 'GREEN', 'RED', '__class__', '__contains__', '__doc__', '__getitem__', '__init_subclass__', '__iter__', '__len__', '__members__', '__module__', '__name__', '__qualname__']
|
2015-01-15 02:31:50 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__getattr__(cls, name)
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns the Enum member in *cls* matching *name*, or raises an :exc:`AttributeError`::
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.GREEN
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.GREEN: 2>
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__getitem__(cls, name)
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Returns the Enum member in *cls* matching *name*, or raises an :exc:`KeyError`::
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color['BLUE']
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.BLUE: 3>
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__iter__(cls)
|
2014-03-03 16:42:52 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns each member in *cls* in definition order::
|
2014-09-17 00:35:55 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> list(Color)
|
2022-01-17 11:18:13 -04:00
|
|
|
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
|
2014-09-17 23:23:14 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__len__(cls)
|
2014-02-08 15:36:27 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns the number of member in *cls*::
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> len(Color)
|
|
|
|
3
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: EnumType.__reversed__(cls)
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns each member in *cls* in reverse definition order::
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> list(reversed(Color))
|
2022-01-17 11:18:13 -04:00
|
|
|
[<Color.BLUE: 3>, <Color.GREEN: 2>, <Color.RED: 1>]
|
2013-06-14 20:55:46 -03:00
|
|
|
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: Enum
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*Enum* is the base class for all *enum* enumerations.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: Enum.name
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
The name used to define the ``Enum`` member::
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.BLUE.name
|
|
|
|
'BLUE'
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: Enum.value
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
The value given to the ``Enum`` member::
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.RED.value
|
|
|
|
1
|
2020-09-22 17:00:07 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. note:: Enum member values
|
2020-09-22 17:00:07 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Member values can be anything: :class:`int`, :class:`str`, etc.. If
|
|
|
|
the exact value is unimportant you may use :class:`auto` instances and an
|
|
|
|
appropriate value will be chosen for you. Care must be taken if you mix
|
|
|
|
:class:`auto` with other values.
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: Enum._ignore_
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
``_ignore_`` is only used during creation and is removed from the
|
2022-01-17 11:18:13 -04:00
|
|
|
enumeration once creation is complete.
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
``_ignore_`` is a list of names that will not become members, and whose
|
|
|
|
names will also be removed from the completed enumeration. See
|
|
|
|
:ref:`TimePeriod <enum-time-period>` for an example.
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: Enum.__call__(cls, value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
This method is called in two different ways:
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
* to look up an existing member:
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
:cls: The enum class being called.
|
|
|
|
:value: The value to lookup.
|
|
|
|
|
|
|
|
* to use the ``cls`` enum to create a new enum:
|
|
|
|
|
|
|
|
:cls: The enum class being called.
|
|
|
|
:value: The name of the new Enum to create.
|
|
|
|
:names: The names/values of the members for the new Enum.
|
|
|
|
:module: The name of the module the new Enum is created in.
|
|
|
|
:qualname: The actual location in the module where this Enum can be found.
|
|
|
|
:type: A mix-in type for the new Enum.
|
|
|
|
:start: The first integer value for the Enum (used by :class:`auto`)
|
|
|
|
:boundary: How to handle out-of-range values from bit operations (:class:`Flag` only)
|
|
|
|
|
|
|
|
.. method:: Enum.__dir__(self)
|
|
|
|
|
|
|
|
Returns ``['__class__', '__doc__', '__module__', 'name', 'value']`` and
|
2022-01-17 11:18:13 -04:00
|
|
|
any public methods defined on *self.__class__*::
|
2021-03-31 01:17:26 -03:00
|
|
|
|
|
|
|
>>> from datetime import date
|
|
|
|
>>> class Weekday(Enum):
|
|
|
|
... MONDAY = 1
|
|
|
|
... TUESDAY = 2
|
|
|
|
... WEDNESDAY = 3
|
|
|
|
... THURSDAY = 4
|
|
|
|
... FRIDAY = 5
|
|
|
|
... SATURDAY = 6
|
|
|
|
... SUNDAY = 7
|
|
|
|
... @classmethod
|
|
|
|
... def today(cls):
|
2021-07-26 18:35:09 -03:00
|
|
|
... print('today is %s' % cls(date.today().isoweekday()).name)
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> dir(Weekday.SATURDAY)
|
2022-01-17 11:18:13 -04:00
|
|
|
['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'today', 'value']
|
2021-03-31 01:17:26 -03:00
|
|
|
|
|
|
|
.. method:: Enum._generate_next_value_(name, start, count, last_values)
|
|
|
|
|
|
|
|
:name: The name of the member being defined (e.g. 'RED').
|
|
|
|
:start: The start value for the Enum; the default is 1.
|
|
|
|
:count: The number of members currently defined, not including this one.
|
|
|
|
:last_values: A list of the previous values.
|
|
|
|
|
|
|
|
A *staticmethod* that is used to determine the next value returned by
|
|
|
|
:class:`auto`::
|
|
|
|
|
|
|
|
>>> from enum import auto
|
|
|
|
>>> class PowersOfThree(Enum):
|
|
|
|
... @staticmethod
|
|
|
|
... def _generate_next_value_(name, start, count, last_values):
|
|
|
|
... return (count + 1) * 3
|
|
|
|
... FIRST = auto()
|
|
|
|
... SECOND = auto()
|
|
|
|
>>> PowersOfThree.SECOND.value
|
|
|
|
6
|
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. method:: Enum.__init_subclass__(cls, \**kwds)
|
|
|
|
|
|
|
|
A *classmethod* that is used to further configure subsequent subclasses.
|
|
|
|
By default, does nothing.
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: Enum._missing_(cls, value)
|
|
|
|
|
|
|
|
A *classmethod* for looking up values not found in *cls*. By default it
|
|
|
|
does nothing, but can be overridden to implement custom search behavior::
|
|
|
|
|
|
|
|
>>> from enum import StrEnum
|
|
|
|
>>> class Build(StrEnum):
|
|
|
|
... DEBUG = auto()
|
|
|
|
... OPTIMIZED = auto()
|
|
|
|
... @classmethod
|
|
|
|
... def _missing_(cls, value):
|
|
|
|
... value = value.lower()
|
|
|
|
... for member in cls:
|
|
|
|
... if member.value == value:
|
|
|
|
... return member
|
|
|
|
... return None
|
|
|
|
>>> Build.DEBUG.value
|
|
|
|
'debug'
|
|
|
|
>>> Build('deBUG')
|
2022-01-17 11:18:13 -04:00
|
|
|
<Build.DEBUG: 'debug'>
|
2021-03-31 01:17:26 -03:00
|
|
|
|
|
|
|
.. method:: Enum.__repr__(self)
|
|
|
|
|
|
|
|
Returns the string used for *repr()* calls. By default, returns the
|
2022-01-17 11:18:13 -04:00
|
|
|
*Enum* name, member name, and value, but can be overridden::
|
2021-03-31 01:17:26 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
>>> class OtherStyle(Enum):
|
|
|
|
... ALTERNATE = auto()
|
|
|
|
... OTHER = auto()
|
|
|
|
... SOMETHING_ELSE = auto()
|
2021-03-31 01:17:26 -03:00
|
|
|
... def __repr__(self):
|
|
|
|
... cls_name = self.__class__.__name__
|
2022-01-17 11:18:13 -04:00
|
|
|
... return f'{cls_name}.{self.name}'
|
|
|
|
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
|
|
|
|
(OtherStyle.ALTERNATE, 'OtherStyle.ALTERNATE', 'OtherStyle.ALTERNATE')
|
2021-03-31 01:17:26 -03:00
|
|
|
|
|
|
|
.. method:: Enum.__str__(self)
|
|
|
|
|
|
|
|
Returns the string used for *str()* calls. By default, returns the
|
2022-01-17 11:18:13 -04:00
|
|
|
*Enum* name and member name, but can be overridden::
|
2021-03-31 01:17:26 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
>>> class OtherStyle(Enum):
|
|
|
|
... ALTERNATE = auto()
|
|
|
|
... OTHER = auto()
|
|
|
|
... SOMETHING_ELSE = auto()
|
2021-03-31 01:17:26 -03:00
|
|
|
... def __str__(self):
|
2022-01-17 11:18:13 -04:00
|
|
|
... return f'{self.name}'
|
|
|
|
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
|
|
|
|
(<OtherStyle.ALTERNATE: 1>, 'ALTERNATE', 'ALTERNATE')
|
|
|
|
|
|
|
|
.. method:: Enum.__format__(self)
|
|
|
|
|
|
|
|
Returns the string used for *format()* and *f-string* calls. By default,
|
|
|
|
returns :meth:`__str__` returns, but can be overridden::
|
|
|
|
|
|
|
|
>>> class OtherStyle(Enum):
|
|
|
|
... ALTERNATE = auto()
|
|
|
|
... OTHER = auto()
|
|
|
|
... SOMETHING_ELSE = auto()
|
|
|
|
... def __format__(self, spec):
|
|
|
|
... return f'{self.name}'
|
|
|
|
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
|
|
|
|
(<OtherStyle.ALTERNATE: 1>, 'OtherStyle.ALTERNATE', 'ALTERNATE')
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. note::
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Using :class:`auto` with :class:`Enum` results in integers of increasing value,
|
|
|
|
starting with ``1``.
|
2016-09-02 20:32:32 -03:00
|
|
|
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: IntEnum
|
2016-09-02 20:32:32 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*IntEnum* is the same as *Enum*, but its members are also integers and can be
|
|
|
|
used anywhere that an integer can be used. If any integer operation is performed
|
|
|
|
with an *IntEnum* member, the resulting value loses its enumeration status.
|
|
|
|
|
|
|
|
>>> from enum import IntEnum
|
|
|
|
>>> class Numbers(IntEnum):
|
|
|
|
... ONE = 1
|
|
|
|
... TWO = 2
|
|
|
|
... THREE = 3
|
|
|
|
>>> Numbers.THREE
|
2022-01-17 11:18:13 -04:00
|
|
|
<Numbers.THREE: 3>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Numbers.ONE + Numbers.TWO
|
|
|
|
3
|
|
|
|
>>> Numbers.THREE + 5
|
|
|
|
8
|
|
|
|
>>> Numbers.THREE == 3
|
|
|
|
True
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. note::
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Using :class:`auto` with :class:`IntEnum` results in integers of increasing
|
|
|
|
value, starting with ``1``.
|
|
|
|
|
|
|
|
.. versionchanged:: 3.11 :meth:`__str__` is now :func:`int.__str__` to
|
|
|
|
better support the *replacement of existing constants* use-case.
|
|
|
|
:meth:`__format__` was already :func:`int.__format__` for that same reason.
|
2016-09-02 03:55:19 -03:00
|
|
|
|
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: StrEnum
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*StrEnum* is the same as *Enum*, but its members are also strings and can be used
|
|
|
|
in most of the same places that a string can be used. The result of any string
|
|
|
|
operation performed on or with a *StrEnum* member is not part of the enumeration.
|
2013-06-14 20:55:46 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. note:: There are places in the stdlib that check for an exact :class:`str`
|
|
|
|
instead of a :class:`str` subclass (i.e. ``type(unknown) == str``
|
|
|
|
instead of ``isinstance(str, unknown)``), and in those locations you
|
|
|
|
will need to use ``str(StrEnum.member)``.
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. note::
|
2013-07-18 21:05:39 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Using :class:`auto` with :class:`StrEnum` results in the lower-cased member
|
|
|
|
name as the value.
|
2013-07-18 21:05:39 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. note:: :meth:`__str__` is :func:`str.__str__` to better support the
|
|
|
|
*replacement of existing constants* use-case. :meth:`__format__` is likewise
|
2022-02-03 11:22:41 -04:00
|
|
|
:func:`str.__format__` for that same reason.
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionadded:: 3.11
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: Flag
|
2018-01-22 11:56:37 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*Flag* members support the bitwise operators ``&`` (*AND*), ``|`` (*OR*),
|
|
|
|
``^`` (*XOR*), and ``~`` (*INVERT*); the results of those operators are members
|
|
|
|
of the enumeration.
|
2018-01-22 11:56:37 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __contains__(self, value)
|
2018-01-22 11:56:37 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns *True* if value is in self::
|
2018-01-22 11:56:37 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> from enum import Flag, auto
|
|
|
|
>>> class Color(Flag):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> purple = Color.RED | Color.BLUE
|
|
|
|
>>> white = Color.RED | Color.GREEN | Color.BLUE
|
|
|
|
>>> Color.GREEN in purple
|
|
|
|
False
|
|
|
|
>>> Color.GREEN in white
|
|
|
|
True
|
|
|
|
>>> purple in white
|
|
|
|
True
|
|
|
|
>>> white in purple
|
|
|
|
False
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __iter__(self):
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns all contained members::
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> list(Color.RED)
|
2022-01-17 11:18:13 -04:00
|
|
|
[<Color.RED: 1>]
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> list(purple)
|
2022-01-17 11:18:13 -04:00
|
|
|
[<Color.RED: 1>, <Color.BLUE: 4>]
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __len__(self):
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns number of members in flag::
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> len(Color.GREEN)
|
|
|
|
1
|
|
|
|
>>> len(white)
|
|
|
|
3
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __bool__(self):
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns *True* if any members in flag, *False* otherwise::
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> bool(Color.GREEN)
|
|
|
|
True
|
|
|
|
>>> bool(white)
|
|
|
|
True
|
|
|
|
>>> black = Color(0)
|
|
|
|
>>> bool(black)
|
|
|
|
False
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __or__(self, other)
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns current flag binary or'ed with other::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.RED | Color.GREEN
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.RED|GREEN: 3>
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __and__(self, other)
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns current flag binary and'ed with other::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> purple & white
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.RED|BLUE: 5>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> purple & Color.GREEN
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color: 0>
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __xor__(self, other)
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns current flag binary xor'ed with other::
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> purple ^ white
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.GREEN: 2>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> purple ^ Color.GREEN
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.RED|GREEN|BLUE: 7>
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. method:: __invert__(self):
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Returns all the flags in *type(self)* that are not in self::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> ~white
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color: 0>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> ~purple
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.GREEN: 2>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> ~Color.RED
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.GREEN|BLUE: 6>
|
|
|
|
|
|
|
|
.. method:: _numeric_repr_
|
|
|
|
|
|
|
|
Function used to format any remaining unnamed numeric values. Default is
|
|
|
|
the value's repr; common choices are :func:`hex` and :func:`oct`.
|
|
|
|
|
|
|
|
.. note::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Using :class:`auto` with :class:`Flag` results in integers that are powers
|
|
|
|
of two, starting with ``1``.
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionchanged:: 3.11 The *repr()* of zero-valued flags has changed. It
|
|
|
|
is now::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
>>> Color(0) # doctest: +SKIP
|
|
|
|
<Color: 0>
|
2015-11-20 17:12:26 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: IntFlag
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*IntFlag* is the same as *Flag*, but its members are also integers and can be
|
|
|
|
used anywhere that an integer can be used.
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> from enum import IntFlag, auto
|
|
|
|
>>> class Color(IntFlag):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> Color.RED & 2
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color: 0>
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.RED | 2
|
2022-01-17 11:18:13 -04:00
|
|
|
<Color.RED|GREEN: 3>
|
2020-09-21 21:23:13 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
If any integer operation is performed with an *IntFlag* member, the result is
|
|
|
|
not an *IntFlag*::
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> Color.RED + 2
|
|
|
|
3
|
2016-01-15 19:01:33 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
If a *Flag* operation is performed with an *IntFlag* member and:
|
2016-01-15 19:01:33 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
* the result is a valid *IntFlag*: an *IntFlag* is returned
|
|
|
|
* the result is not a valid *IntFlag*: the result depends on the *FlagBoundary* setting
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
The *repr()* of unnamed zero-valued flags has changed. It is now:
|
|
|
|
|
|
|
|
>>> Color(0)
|
|
|
|
<Color: 0>
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
Using :class:`auto` with :class:`IntFlag` results in integers that are powers
|
|
|
|
of two, starting with ``1``.
|
|
|
|
|
|
|
|
.. versionchanged:: 3.11 :meth:`__str__` is now :func:`int.__str__` to
|
|
|
|
better support the *replacement of existing constants* use-case.
|
|
|
|
:meth:`__format__` was already :func:`int.__format__` for that same reason.
|
2016-09-02 03:55:19 -03:00
|
|
|
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-06-09 13:03:55 -03:00
|
|
|
.. class:: EnumCheck
|
|
|
|
|
|
|
|
*EnumCheck* contains the options used by the :func:`verify` decorator to ensure
|
2022-01-17 11:18:13 -04:00
|
|
|
various constraints; failed constraints result in a :exc:`ValueError`.
|
2021-06-09 13:03:55 -03:00
|
|
|
|
|
|
|
.. attribute:: UNIQUE
|
|
|
|
|
|
|
|
Ensure that each value has only one name::
|
|
|
|
|
|
|
|
>>> from enum import Enum, verify, UNIQUE
|
|
|
|
>>> @verify(UNIQUE)
|
|
|
|
... class Color(Enum):
|
|
|
|
... RED = 1
|
|
|
|
... GREEN = 2
|
|
|
|
... BLUE = 3
|
|
|
|
... CRIMSON = 1
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
|
|
|
ValueError: aliases found in <enum 'Color'>: CRIMSON -> RED
|
|
|
|
|
|
|
|
|
|
|
|
.. attribute:: CONTINUOUS
|
|
|
|
|
|
|
|
Ensure that there are no missing values between the lowest-valued member
|
|
|
|
and the highest-valued member::
|
|
|
|
|
|
|
|
>>> from enum import Enum, verify, CONTINUOUS
|
|
|
|
>>> @verify(CONTINUOUS)
|
|
|
|
... class Color(Enum):
|
|
|
|
... RED = 1
|
|
|
|
... GREEN = 2
|
|
|
|
... BLUE = 5
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
|
|
|
ValueError: invalid enum 'Color': missing values 3, 4
|
|
|
|
|
|
|
|
.. attribute:: NAMED_FLAGS
|
|
|
|
|
|
|
|
Ensure that any flag groups/masks contain only named flags -- useful when
|
|
|
|
values are specified instead of being generated by :func:`auto`
|
|
|
|
|
|
|
|
>>> from enum import Flag, verify, NAMED_FLAGS
|
|
|
|
>>> @verify(NAMED_FLAGS)
|
|
|
|
... class Color(Flag):
|
|
|
|
... RED = 1
|
|
|
|
... GREEN = 2
|
|
|
|
... BLUE = 4
|
|
|
|
... WHITE = 15
|
|
|
|
... NEON = 31
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
2021-06-15 22:51:19 -03:00
|
|
|
ValueError: invalid Flag 'Color': aliases WHITE and NEON are missing combined values of 0x18 [use enum.show_flag_values(value) for details]
|
2021-06-09 13:03:55 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. note::
|
2021-06-09 13:03:55 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
CONTINUOUS and NAMED_FLAGS are designed to work with integer-valued members.
|
2021-06-09 13:03:55 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionadded:: 3.11
|
2021-06-09 13:03:55 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: FlagBoundary
|
2013-09-28 02:58:06 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*FlagBoundary* controls how out-of-range values are handled in *Flag* and its
|
|
|
|
subclasses.
|
2016-08-20 04:00:52 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: STRICT
|
2016-09-18 17:15:41 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Out-of-range values cause a :exc:`ValueError` to be raised. This is the
|
|
|
|
default for :class:`Flag`::
|
2016-09-18 17:15:41 -03:00
|
|
|
|
2021-03-31 13:20:08 -03:00
|
|
|
>>> from enum import Flag, STRICT
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> class StrictFlag(Flag, boundary=STRICT):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> StrictFlag(2**2 + 2**4)
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
2022-01-17 11:18:13 -04:00
|
|
|
ValueError: <flag 'StrictFlag'> invalid value 20
|
2021-03-31 01:17:26 -03:00
|
|
|
given 0b0 10100
|
|
|
|
allowed 0b0 00111
|
2016-09-18 17:15:41 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: CONFORM
|
2016-09-18 17:15:41 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Out-of-range values have invalid values removed, leaving a valid *Flag*
|
|
|
|
value::
|
2020-09-22 17:00:07 -03:00
|
|
|
|
2021-03-31 13:20:08 -03:00
|
|
|
>>> from enum import Flag, CONFORM
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> class ConformFlag(Flag, boundary=CONFORM):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> ConformFlag(2**2 + 2**4)
|
2022-01-17 11:18:13 -04:00
|
|
|
<ConformFlag.BLUE: 4>
|
2020-09-22 17:00:07 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: EJECT
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Out-of-range values lose their *Flag* membership and revert to :class:`int`.
|
|
|
|
This is the default for :class:`IntFlag`::
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 13:20:08 -03:00
|
|
|
>>> from enum import Flag, EJECT
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> class EjectFlag(Flag, boundary=EJECT):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> EjectFlag(2**2 + 2**4)
|
|
|
|
20
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. attribute:: KEEP
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
Out-of-range values are kept, and the *Flag* membership is kept. This is
|
|
|
|
used for some stdlib flags:
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 13:20:08 -03:00
|
|
|
>>> from enum import Flag, KEEP
|
2021-03-31 01:17:26 -03:00
|
|
|
>>> class KeepFlag(Flag, boundary=KEEP):
|
|
|
|
... RED = auto()
|
|
|
|
... GREEN = auto()
|
|
|
|
... BLUE = auto()
|
|
|
|
>>> KeepFlag(2**2 + 2**4)
|
2022-01-17 11:18:13 -04:00
|
|
|
<KeepFlag.BLUE|16: 20>
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-07-27 12:20:00 -03:00
|
|
|
.. versionadded:: 3.11
|
2021-05-14 02:59:53 -03:00
|
|
|
|
2021-06-18 17:15:46 -03:00
|
|
|
---------------
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
Supported ``__dunder__`` names
|
|
|
|
""""""""""""""""""""""""""""""
|
|
|
|
|
|
|
|
:attr:`__members__` is a read-only ordered mapping of ``member_name``:``member``
|
|
|
|
items. It is only available on the class.
|
|
|
|
|
|
|
|
:meth:`__new__`, if specified, must create and return the enum members; it is
|
|
|
|
also a very good idea to set the member's :attr:`_value_` appropriately. Once
|
|
|
|
all the members are created it is no longer used.
|
|
|
|
|
|
|
|
|
|
|
|
Supported ``_sunder_`` names
|
|
|
|
""""""""""""""""""""""""""""
|
|
|
|
|
|
|
|
- ``_name_`` -- name of the member
|
|
|
|
- ``_value_`` -- value of the member; can be set / modified in ``__new__``
|
|
|
|
|
|
|
|
- ``_missing_`` -- a lookup function used when a value is not found; may be
|
|
|
|
overridden
|
|
|
|
- ``_ignore_`` -- a list of names, either as a :class:`list` or a :class:`str`,
|
|
|
|
that will not be transformed into members, and will be removed from the final
|
|
|
|
class
|
|
|
|
- ``_order_`` -- used in Python 2/3 code to ensure member order is consistent
|
|
|
|
(class attribute, removed during class creation)
|
|
|
|
- ``_generate_next_value_`` -- used to get an appropriate value for an enum
|
|
|
|
member; may be overridden
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
For standard :class:`Enum` classes the next value chosen is the last value seen
|
|
|
|
incremented by one.
|
|
|
|
|
|
|
|
For :class:`Flag` classes the next value chosen will be the next highest
|
|
|
|
power-of-two, regardless of the last value seen.
|
|
|
|
|
|
|
|
.. versionadded:: 3.6 ``_missing_``, ``_order_``, ``_generate_next_value_``
|
|
|
|
.. versionadded:: 3.7 ``_ignore_``
|
|
|
|
|
|
|
|
---------------
|
|
|
|
|
2021-10-05 18:48:44 -03:00
|
|
|
Utilities and Decorators
|
|
|
|
------------------------
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. class:: auto
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
*auto* can be used in place of a value. If used, the *Enum* machinery will
|
|
|
|
call an *Enum*'s :meth:`_generate_next_value_` to get an appropriate value.
|
|
|
|
For *Enum* and *IntEnum* that appropriate value will be the last value plus
|
|
|
|
one; for *Flag* and *IntFlag* it will be the first power-of-two greater
|
|
|
|
than the last value; for *StrEnum* it will be the lower-cased version of the
|
|
|
|
member's name.
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
``_generate_next_value_`` can be overridden to customize the values used by
|
|
|
|
*auto*.
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. decorator:: property
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
A decorator similar to the built-in *property*, but specifically for
|
|
|
|
enumerations. It allows member attributes to have the same names as members
|
|
|
|
themselves.
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. note:: the *property* and the member must be defined in separate classes;
|
|
|
|
for example, the *value* and *name* attributes are defined in the
|
|
|
|
*Enum* class, and *Enum* subclasses can define members with the
|
|
|
|
names ``value`` and ``name``.
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionadded:: 3.11
|
2021-05-14 02:59:53 -03:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
.. decorator:: unique
|
bpo-38250: [Enum] single-bit flags are canonical (GH-24215)
Flag members are now divided by one-bit verses multi-bit, with multi-bit being treated as aliases. Iterating over a flag only returns the contained single-bit flags.
Iterating, repr(), and str() show members in definition order.
When constructing combined-member flags, any extra integer values are either discarded (CONFORM), turned into ints (EJECT) or treated as errors (STRICT). Flag classes can specify which of those three behaviors is desired:
>>> class Test(Flag, boundary=CONFORM):
... ONE = 1
... TWO = 2
...
>>> Test(5)
<Test.ONE: 1>
Besides the three above behaviors, there is also KEEP, which should not be used unless necessary -- for example, _convert_ specifies KEEP as there are flag sets in the stdlib that are incomplete and/or inconsistent (e.g. ssl.Options). KEEP will, as the name suggests, keep all bits; however, iterating over a flag with extra bits will only return the canonical flags contained, not the extra bits.
Iteration is now in member definition order. If member definition order
matches increasing value order, then a more efficient method of flag
decomposition is used; otherwise, sort() is called on the results of
that method to get definition order.
``re`` module:
repr() has been modified to support as closely as possible its previous
output; the big difference is that inverted flags cannot be output as
before because the inversion operation now always returns the comparable
positive result; i.e.
re.A|re.I|re.M|re.S is ~(re.L|re.U|re.S|re.T|re.DEBUG)
in both of the above terms, the ``value`` is 282.
re's tests have been updated to reflect the modifications to repr().
2021-01-25 18:26:19 -04:00
|
|
|
|
2021-03-31 01:17:26 -03:00
|
|
|
A :keyword:`class` decorator specifically for enumerations. It searches an
|
|
|
|
enumeration's :attr:`__members__`, gathering any aliases it finds; if any are
|
|
|
|
found :exc:`ValueError` is raised with the details::
|
|
|
|
|
|
|
|
>>> from enum import Enum, unique
|
|
|
|
>>> @unique
|
|
|
|
... class Mistake(Enum):
|
|
|
|
... ONE = 1
|
|
|
|
... TWO = 2
|
|
|
|
... THREE = 3
|
|
|
|
... FOUR = 3
|
|
|
|
...
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
|
|
|
ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
|
2021-06-09 13:03:55 -03:00
|
|
|
|
|
|
|
.. decorator:: verify
|
|
|
|
|
|
|
|
A :keyword:`class` decorator specifically for enumerations. Members from
|
|
|
|
:class:`EnumCheck` are used to specify which constraints should be checked
|
|
|
|
on the decorated enumeration.
|
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
.. versionadded:: 3.11
|
2021-06-18 17:15:46 -03:00
|
|
|
|
2022-05-06 04:16:22 -03:00
|
|
|
.. decorator:: member
|
|
|
|
|
2022-05-06 06:53:00 -03:00
|
|
|
A decorator for use in enums: its target will become a member.
|
2022-05-06 04:16:22 -03:00
|
|
|
|
|
|
|
.. versionadded:: 3.11
|
|
|
|
|
|
|
|
.. decorator:: nonmember
|
|
|
|
|
2022-05-06 06:53:00 -03:00
|
|
|
A decorator for use in enums: its target will not become a member.
|
2022-05-06 04:16:22 -03:00
|
|
|
|
|
|
|
.. versionadded:: 3.11
|
|
|
|
|
2021-06-18 17:15:46 -03:00
|
|
|
---------------
|
|
|
|
|
|
|
|
Notes
|
|
|
|
-----
|
|
|
|
|
|
|
|
:class:`IntEnum`, :class:`StrEnum`, and :class:`IntFlag`
|
|
|
|
|
|
|
|
These three enum types are designed to be drop-in replacements for existing
|
|
|
|
integer- and string-based values; as such, they have extra limitations:
|
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
- ``__str__`` uses the value and not the name of the enum member
|
2021-06-18 17:15:46 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
- ``__format__``, because it uses ``__str__``, will also use the value of
|
|
|
|
the enum member instead of its name
|
2021-06-18 17:15:46 -03:00
|
|
|
|
2022-01-17 11:18:13 -04:00
|
|
|
If you do not need/want those limitations, you can either create your own
|
|
|
|
base class by mixing in the ``int`` or ``str`` type yourself::
|
2021-06-18 17:15:46 -03:00
|
|
|
|
|
|
|
>>> from enum import Enum
|
|
|
|
>>> class MyIntEnum(int, Enum):
|
|
|
|
... pass
|
2022-01-17 11:18:13 -04:00
|
|
|
|
|
|
|
or you can reassign the appropriate :meth:`str`, etc., in your enum::
|
|
|
|
|
|
|
|
>>> from enum import IntEnum
|
|
|
|
>>> class MyIntEnum(IntEnum):
|
|
|
|
... __str__ = IntEnum.__str__
|