# Enum HOWTO

An `Enum` is a set of symbolic names bound to unique values. They are similar to global variables, but they offer a more useful `repr()`, grouping, type-safety, and a few other features.

Вони найбільш корисні, коли у вас є змінна, яка може приймати одне з обмеженого вибору значень. Наприклад, дні тижня:

    >>> from enum import Enum
    >>> class Weekday(Enum):
    ...     MONDAY = 1
    ...     TUESDAY = 2
    ...     WEDNESDAY = 3
    ...     THURSDAY = 4
    ...     FRIDAY = 5
    ...     SATURDAY = 6
    ...     SUNDAY = 7

Or perhaps the RGB primary colors:

    >>> from enum import Enum
    >>> class Color(Enum):
    ...     RED = 1
    ...     GREEN = 2
    ...     BLUE = 3

Як бачите, створити `Enum` так само просто, як написати клас, який успадковує сам `Enum`.

Примітка

Випадок членів Enum

Because Enums are used to represent constants we recommend using UPPER_CASE names for members, and will be using that style in our examples.

Залежно від характеру переліку значення члена може бути важливим або неважливим, але в будь-якому випадку це значення можна використовувати для отримання відповідного члена:

    >>> Weekday(3)
    <Weekday.WEDNESDAY: 3>

As you can see, the `repr()` of a member shows the enum name, the member name, and the value. The `str()` of a member shows only the enum name and member name:

    >>> print(Weekday.THURSDAY)
    Weekday.THURSDAY

Тип члена переліку — це enum, якому він належить:

    >>> type(Weekday.MONDAY)
    <enum 'Weekday'>
    >>> isinstance(Weekday.FRIDAY, Weekday)
    True

Enum members have an attribute that contains just their `name`:

    >>> print(Weekday.TUESDAY.name)
    TUESDAY

Likewise, they have an attribute for their `value`:

    >>> Weekday.WEDNESDAY.value
    3

Unlike many languages that treat enumerations solely as name/value pairs, Python Enums can have behavior added. For example, `datetime.date` has two methods for returning the weekday: `weekday()` and `isoweekday()`. The difference is that one of them counts from 0-6 and the other from 1-7. Rather than keep track of that ourselves we can add a method to the `Weekday` enum to extract the day from the `date` instance and return the matching enum member:

    @classmethod
    def from_date(cls, date):
        return cls(date.isoweekday())

The complete `Weekday` enum now looks like this:

    >>> class Weekday(Enum):
    ...     MONDAY = 1
    ...     TUESDAY = 2
    ...     WEDNESDAY = 3
    ...     THURSDAY = 4
    ...     FRIDAY = 5
    ...     SATURDAY = 6
    ...     SUNDAY = 7
    ...     #
    ...     @classmethod
    ...     def from_date(cls, date):
    ...         return cls(date.isoweekday())

Тепер ми можемо дізнатися, що таке сьогодні! Спостерігати:

    >>> from datetime import date
    >>> Weekday.from_date(date.today())
    <Weekday.TUESDAY: 2>

Звичайно, якщо ви читаєте це в інший день, ви побачите цей день.

This `Weekday` enum is great if our variable only needs one day, but what if we need several? Maybe we’re writing a function to plot chores during a week, and don’t want to use a `list` – we could use a different type of `Enum`:

    >>> from enum import Flag
    >>> class Weekday(Flag):
    ...     MONDAY = 1
    ...     TUESDAY = 2
    ...     WEDNESDAY = 4
    ...     THURSDAY = 8
    ...     FRIDAY = 16
    ...     SATURDAY = 32
    ...     SUNDAY = 64

Ми змінили дві речі: ми успадковані від `Flag`, і всі значення є степенями 2.

Just like the original `Weekday` enum above, we can have a single selection:

    >>> first_week_day = Weekday.MONDAY
    >>> first_week_day
    <Weekday.MONDAY: 1>

Але `Flag` також дозволяє нам об’єднати кілька членів в одну змінну:

    >>> weekend = Weekday.SATURDAY | Weekday.SUNDAY
    >>> weekend
    <Weekday.SATURDAY|SUNDAY: 96>

Ви навіть можете перебирати змінну `Flag`:

    >>> for day in weekend:
    ...     print(day)
    Weekday.SATURDAY
    Weekday.SUNDAY

Гаразд, давайте приступимо до роботи:

    >>> chores_for_ethan = {
    ...     'feed the cat': Weekday.MONDAY | Weekday.WEDNESDAY | Weekday.FRIDAY,
    ...     'do the dishes': Weekday.TUESDAY | Weekday.THURSDAY,
    ...     'answer SO questions': Weekday.SATURDAY,
    ...     }

І функція для відображення справ за певний день:

    >>> def show_chores(chores, day):
    ...     for chore, days in chores.items():
    ...         if day in days:
    ...             print(chore)
    >>> show_chores(chores_for_ethan, Weekday.SATURDAY)
    answer SO questions

In cases where the actual values of the members do not matter, you can save yourself some work and use `auto()` for the values:

    >>> from enum import auto
    >>> class Weekday(Flag):
    ...     MONDAY = auto()
    ...     TUESDAY = auto()
    ...     WEDNESDAY = auto()
    ...     THURSDAY = auto()
    ...     FRIDAY = auto()
    ...     SATURDAY = auto()
    ...     SUNDAY = auto()
    ...     WEEKEND = SATURDAY | SUNDAY

## Програмний доступ до елементів переліку та їх атрибутів

Іноді корисно отримати доступ до членів у перерахуваннях програмно (тобто ситуації, коли `Color.RED` не підійде, оскільки точний колір невідомий під час написання програми). `Enum` дозволяє такий доступ:

    >>> Color(1)
    <Color.RED: 1>
    >>> Color(3)
    <Color.BLUE: 3>

Якщо ви хочете отримати доступ до членів enum за ім’ям, використовуйте доступ до елемента:

    >>> Color['RED']
    <Color.RED: 1>
    >>> Color['GREEN']
    <Color.GREEN: 2>

If you have an enum member and need its `name` or `value`:

    >>> member = Color.RED
    >>> member.name
    'RED'
    >>> member.value
    1

## Дублювання членів enum і значень

Наявність двох членів переліку з однаковими іменами недійсна:

    >>> class Shape(Enum):
    ...     SQUARE = 2
    ...     SQUARE = 3
    ...
    Traceback (most recent call last):
    ...
    TypeError: 'SQUARE' already defined as 2

Однак член enum може мати інші імена, пов’язані з ним. За наявності двох записів `A` і `B` з однаковим значенням (і `A`, визначеним першим), `B` є псевдонімом для члена `A`. Пошук за значенням значення `A` поверне член `A`. Пошук за назвою `A` поверне член `A`. Пошук за назвою `B` також поверне член `A`:

    >>> class Shape(Enum):
    ...     SQUARE = 2
    ...     DIAMOND = 1
    ...     CIRCLE = 3
    ...     ALIAS_FOR_SQUARE = 2
    ...
    >>> Shape.SQUARE
    <Shape.SQUARE: 2>
    >>> Shape.ALIAS_FOR_SQUARE
    <Shape.SQUARE: 2>
    >>> Shape(2)
    <Shape.SQUARE: 2>

Примітка

Спроба створити член із тим же ім’ям, що й уже визначений атрибут (інший член, метод тощо), або спроба створити атрибут із тим же ім’ям, що й член, не дозволяється.

## Забезпечення унікальних значень перерахування

За замовчуванням перерахування дозволяють використовувати кілька імен як псевдоніми для одного значення. Якщо така поведінка небажана, ви можете використати декоратор `unique()`:

    >>> 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

## Використання автоматичних значень

Якщо точне значення неважливе, ви можете використовувати `auto`:

    >>> from enum import Enum, auto
    >>> class Color(Enum):
    ...     RED = auto()
    ...     BLUE = auto()
    ...     GREEN = auto()
    ...
    >>> [member.value for member in Color]
    [1, 2, 3]

The values are chosen by `_generate_next_value_()`, which can be overridden:

    >>> class AutoName(Enum):
    ...     def _generate_next_value_(name, start, count, last_values):
    ...         return name
    ...
    >>> class Ordinal(AutoName):
    ...     NORTH = auto()
    ...     SOUTH = auto()
    ...     EAST = auto()
    ...     WEST = auto()
    ...
    >>> [member.value for member in Ordinal]
    ['NORTH', 'SOUTH', 'EAST', 'WEST']

Примітка

The `_generate_next_value_()` method must be defined before any members.

## Ітерація

Перебір членів enum не забезпечує псевдоніми:

    >>> list(Shape)
    [<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]
    >>> list(Weekday)
    [<Weekday.MONDAY: 1>, <Weekday.TUESDAY: 2>, <Weekday.WEDNESDAY: 4>, <Weekday.THURSDAY: 8>, <Weekday.FRIDAY: 16>, <Weekday.SATURDAY: 32>, <Weekday.SUNDAY: 64>]

Note that the aliases `Shape.ALIAS_FOR_SQUARE` and `Weekday.WEEKEND` aren’t shown.

Спеціальний атрибут `__members__` — це впорядковане відображення імен учасників лише для читання. Він включає всі імена, визначені в переліку, включаючи псевдоніми:

    >>> for name, member in Shape.__members__.items():
    ...     name, member
    ...
    ('SQUARE', <Shape.SQUARE: 2>)
    ('DIAMOND', <Shape.DIAMOND: 1>)
    ('CIRCLE', <Shape.CIRCLE: 3>)
    ('ALIAS_FOR_SQUARE', <Shape.SQUARE: 2>)

Атрибут `__members__` можна використовувати для детального програмного доступу до елементів переліку. Наприклад, пошук усіх псевдонімів:

    >>> [name for name, member in Shape.__members__.items() if member.name != name]
    ['ALIAS_FOR_SQUARE']

Примітка

Aliases for flags include values with multiple flags set, such as `3`, and no flags set, i.e. `0`.

## Порівняння

Члени переліку порівнюються за ідентичністю:

    >>> Color.RED is Color.RED
    True
    >>> Color.RED is Color.BLUE
    False
    >>> Color.RED is not Color.BLUE
    True

Упорядковані порівняння між значеннями перерахування не підтримуються. Члени Enum не є цілими числами (але дивіться IntEnum нижче):

    >>> Color.RED < Color.BLUE
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    TypeError: '<' not supported between instances of 'Color' and 'Color'

Однак порівняння рівності визначено:

    >>> Color.BLUE == Color.RED
    False
    >>> Color.BLUE != Color.RED
    True
    >>> Color.BLUE == Color.BLUE
    True

Порівняння зі значеннями, не пов’язаними з перерахуванням, завжди порівнюватиметься нерівними (знову ж таки, `IntEnum` був явно розроблений для іншої поведінки, див. нижче):

    >>> Color.BLUE == 2
    False

Попередження

It is possible to reload modules – if a reloaded module contains enums, they will be recreated, and the new members may not compare identical/equal to the original members.

## Дозволені члени та атрибути перерахувань

Більшість наведених вище прикладів використовують цілі числа для значень перерахування. Використання цілих чисел є коротким і зручним (і надається за замовчуванням Functional API), але не суворо дотримується. У переважній більшості варіантів використання байдуже, яке фактичне значення перерахування. Але якщо значення є важливим, перерахування можуть мати довільні значення.

Перерахування є класами Python і, як зазвичай, можуть мати методи та спеціальні методи. Якщо ми маємо цей перелік:

    >>> class Mood(Enum):
    ...     FUNKY = 1
    ...     HAPPY = 3
    ...
    ...     def describe(self):
    ...         # self is the member here
    ...         return self.name, self.value
    ...
    ...     def __str__(self):
    ...         return 'my custom str! {0}'.format(self.value)
    ...
    ...     @classmethod
    ...     def favorite_mood(cls):
    ...         # cls here is the enumeration
    ...         return cls.HAPPY
    ...

Потім:

    >>> Mood.favorite_mood()
    <Mood.HAPPY: 3>
    >>> Mood.HAPPY.describe()
    ('HAPPY', 3)
    >>> str(Mood.FUNKY)
    'my custom str! 1'

The rules for what is allowed are as follows: names that start and end with a single underscore are reserved by enum and cannot be used; all other attributes defined within an enumeration will become members of this enumeration, with the exception of special methods (`__str__()`, `__add__()`, etc.), descriptors (methods are also descriptors), and variable names listed in `_ignore_`.

Note: if your enumeration defines `__new__()` and/or `__init__()`, any value(s) given to the enum member will be passed into those methods. See Planet for an example.

Примітка

The `__new__()` method, if defined, is used during creation of the Enum members; it is then replaced by Enum’s `__new__()` which is used after class creation for lookup of existing members. See When to use __new__() vs. __init__() for more details.

## Обмежений підклас Enum

Новий клас `Enum` повинен мати один базовий клас enum, до одного конкретного типу даних і стільки класів міксину на основі `object`, скільки потрібно. Порядок цих базових класів:

    class EnumName([mix-in, ...,] [data-type,] base-enum):
        pass

Крім того, створення підкласу переліку дозволяється, лише якщо перелік не визначає жодних членів. Тому це заборонено:

    >>> class MoreColor(Color):
    ...     PINK = 17
    ...
    Traceback (most recent call last):
    ...
    TypeError: <enum 'MoreColor'> cannot extend <enum 'Color'>

Але це дозволено:

    >>> class Foo(Enum):
    ...     def some_behavior(self):
    ...         pass
    ...
    >>> class Bar(Foo):
    ...     HAPPY = 1
    ...     SAD = 2
    ...

Дозвіл створення підкласів для переліків, які визначають члени, призведе до порушення деяких важливих інваріантів типів і екземплярів. З іншого боку, має сенс дозволити спільну поведінку між групою перерахувань. (Див. OrderedEnum для прикладу.)

## Соління

Перерахування можна маринувати і не маринувати:

    >>> from test.test_enum import Fruit
    >>> from pickle import dumps, loads
    >>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
    True

Застосовуються звичайні обмеження для маркування: переліки, які можна піклувати, повинні бути визначені на верхньому рівні модуля, оскільки для скасування потрібно, щоб їх можна було імпортувати з цього модуля.

Примітка

За допомогою протоколу pickle версії 4 можна легко маринувати переліки, вкладені в інші класи.

It is possible to modify how enum members are pickled/unpickled by defining `__reduce_ex__()` in the enumeration class. The default method is by-value, but enums with complicated values may want to use by-name:

    >>> import enum
    >>> class MyEnum(enum.Enum):
    ...     __reduce_ex__ = enum.pickle_by_enum_name

Примітка

Using by-name for flags is not recommended, as unnamed aliases will not unpickle.

## Функціональний API

Клас `Enum` можна викликати, забезпечуючи такий функціональний API:

    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
    >>> Animal
    <enum 'Animal'>
    >>> Animal.ANT
    <Animal.ANT: 1>
    >>> list(Animal)
    [<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]

Семантика цього API нагадує `namedtuple`. Першим аргументом виклику `Enum` є назва переліку.

The second argument is the source of enumeration member names. It can be a whitespace-separated string of names, a sequence of names, a sequence of 2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to values. The last two options enable assigning arbitrary values to enumerations; the others auto-assign increasing integers starting with 1 (use the `start` parameter to specify a different starting value). A new class derived from `Enum` is returned. In other words, the above assignment to `Animal` is equivalent to:

    >>> class Animal(Enum):
    ...     ANT = 1
    ...     BEE = 2
    ...     CAT = 3
    ...     DOG = 4
    ...

Причина того, що за замовчуванням початковим числом є `1`, а не `0`, полягає в тому, що `0` є `False` у логічному сенсі, але за замовчуванням усі члени enum оцінюються як `True`.

Pickling enums created with the functional API can be tricky as frame stack implementation details are used to try and figure out which module the enumeration is being created in (e.g. it will fail if you use a utility function in a separate module, and also may not work on IronPython or Jython). The solution is to specify the module name explicitly as follows:

    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)

Попередження

Якщо `module` не вказано, і Enum не може визначити, що це таке, нові члени Enum не можна буде вибрати; щоб зберегти помилки ближче до джерела, травлення буде вимкнено.

The new pickle protocol 4 also, in some circumstances, relies on `__qualname__` being set to the location where pickle will be able to find the class. For example, if the class was made available in class SomeData in the global scope:

    >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')

Повний підпис:

    Enum(
        value='NewEnumName',
        names=<...>,
        *,
        module='...',
        qualname='...',
        type=<mixed-in class>,
        start=1,
        )

- value: What the new enum class will record as its name.

- names: The enum members. This can be a whitespace- or comma-separated string (values will start at 1 unless otherwise specified):

      'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'

  або ітератор імен:

      ['RED', 'GREEN', 'BLUE']

  або ітератор пар (ім’я, значення):

      [('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]

  або відображення:

      {'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42}

- module: name of module where new enum class can be found.

- qualname: where in module new enum class can be found.

- type: type to mix in to new enum class.

- start: number to start counting at if only names are passed in.

Змінено в версії 3.5: Додано параметр start.

## Похідні перерахування

### IntEnum

Перший наданий варіант `Enum` також є підкласом `int`. Члени `IntEnum` можна порівняти з цілими числами; за розширенням, цілочисельні перерахування різних типів також можна порівнювати один з одним:

    >>> from enum import IntEnum
    >>> class Shape(IntEnum):
    ...     CIRCLE = 1
    ...     SQUARE = 2
    ...
    >>> class Request(IntEnum):
    ...     POST = 1
    ...     GET = 2
    ...
    >>> Shape == 1
    False
    >>> Shape.CIRCLE == 1
    True
    >>> Shape.CIRCLE == Request.POST
    True

Однак їх все ще не можна порівняти зі стандартними перерахуваннями `Enum`:

    >>> class Shape(IntEnum):
    ...     CIRCLE = 1
    ...     SQUARE = 2
    ...
    >>> class Color(Enum):
    ...     RED = 1
    ...     GREEN = 2
    ...
    >>> Shape.CIRCLE == Color.RED
    False

Значення `IntEnum` поводяться як цілі числа іншим чином:

    >>> int(Shape.CIRCLE)
    1
    >>> ['a', 'b', 'c'][Shape.CIRCLE]
    'b'
    >>> [i for i in range(Shape.SQUARE)]
    [0, 1]

### StrEnum

The second variation of `Enum` that is provided is also a subclass of `str`. Members of a `StrEnum` can be compared to strings; by extension, string enumerations of different types can also be compared to each other.

Нове в версії 3.11.

### IntFlag

The next variation of `Enum` provided, `IntFlag`, is also based on `int`. The difference being `IntFlag` members can be combined using the bitwise operators (&, |, ^, ~) and the result is still an `IntFlag` member, if possible. Like `IntEnum`, `IntFlag` members are also integers and can be used wherever an `int` is used.

Примітка

Будь-яка операція з членом `IntFlag`, крім побітових операцій, втрачає членство `IntFlag`.

Побітові операції, які призводять до недійсних значень `IntFlag`, втратять членство `IntFlag`. Перегляньте `FlagBoundary` для деталей.

Нове в версії 3.6.

Змінено в версії 3.11.

Приклад `IntFlag` class:

    >>> from enum import IntFlag
    >>> class Perm(IntFlag):
    ...     R = 4
    ...     W = 2
    ...     X = 1
    ...
    >>> Perm.R | Perm.W
    <Perm.R|W: 6>
    >>> Perm.R + Perm.W
    6
    >>> RW = Perm.R | Perm.W
    >>> Perm.R in RW
    True

Також можна назвати комбінації:

    >>> class Perm(IntFlag):
    ...     R = 4
    ...     W = 2
    ...     X = 1
    ...     RWX = 7
    >>> Perm.RWX
    <Perm.RWX: 7>
    >>> ~Perm.RWX
    <Perm: 0>
    >>> Perm(7)
    <Perm.RWX: 7>

Примітка

Іменовані комбінації вважаються псевдонімами. Псевдоніми не відображаються під час ітерації, але їх можна повернути під час пошуку за значенням.

Змінено в версії 3.11.

Ще одна важлива відмінність між `IntFlag` і `Enum` полягає в тому, що якщо не встановлено жодного прапора (значення дорівнює 0), його логічна оцінка буде `False`:

    >>> Perm.R & Perm.X
    <Perm: 0>
    >>> bool(Perm.R & Perm.X)
    False

Оскільки члени `IntFlag` також є підкласами `int`, їх можна поєднувати з ними (але вони можуть втратити членство `IntFlag`:

    >>> Perm.X | 4
    <Perm.R|X: 5>

    >>> Perm.X + 8
    9

Примітка

Оператор заперечення, `~`, завжди повертає член `IntFlag` із позитивним значенням:

    >>> (~Perm.X).value == (Perm.R|Perm.W).value == 6
    True

Члени `IntFlag` також можна повторювати:

    >>> list(RW)
    [<Perm.R: 4>, <Perm.W: 2>]

Нове в версії 3.11.

### Прапор

Останнім варіантом є `Flag`. Подібно до `IntFlag`, члени `Flag` можна комбінувати за допомогою порозрядних операторів (&, |, ^, ~). На відміну від `IntFlag`, їх не можна комбінувати з будь-яким іншим переліком `Flag` або `int`, ані порівнювати з ними. Хоча можна вказати значення безпосередньо, рекомендується використовувати `auto` як значення, а `Flag` вибрати відповідне значення.

Нове в версії 3.6.

Подібно до `IntFlag`, якщо комбінація членів `Flag` не призводить до встановлення прапорів, логічна оцінка буде `False`:

    >>> from enum import Flag, auto
    >>> class Color(Flag):
    ...     RED = auto()
    ...     BLUE = auto()
    ...     GREEN = auto()
    ...
    >>> Color.RED & Color.GREEN
    <Color: 0>
    >>> bool(Color.RED & Color.GREEN)
    False

Individual flags should have values that are powers of two (1, 2, 4, 8, …), while combinations of flags will not:

    >>> class Color(Flag):
    ...     RED = auto()
    ...     BLUE = auto()
    ...     GREEN = auto()
    ...     WHITE = RED | BLUE | GREEN
    ...
    >>> Color.WHITE
    <Color.WHITE: 7>

Присвоєння назви умові «прапори не встановлено» не змінює її логічного значення:

    >>> class Color(Flag):
    ...     BLACK = 0
    ...     RED = auto()
    ...     BLUE = auto()
    ...     GREEN = auto()
    ...
    >>> Color.BLACK
    <Color.BLACK: 0>
    >>> bool(Color.BLACK)
    False

Члени `Flag` також можна повторювати:

    >>> purple = Color.RED | Color.BLUE
    >>> list(purple)
    [<Color.RED: 1>, <Color.BLUE: 2>]

Нове в версії 3.11.

Примітка

Для більшості нового коду наполегливо рекомендується використовувати `Enum` і `Flag`, оскільки `IntEnum` і `IntFlag` порушують деякі семантичні обіцянки перерахування (через їх порівняння з цілі числа, і, таким чином, через перехідність до інших непов’язаних перерахувань). `IntEnum` і `IntFlag` слід використовувати лише у випадках, коли `Enum` і `Flag` не підходять; наприклад, коли цілі константи замінюються перерахуваннями або для взаємодії з іншими системами.

### інші

Хоча `IntEnum` є частиною модуля `enum`, його було б дуже просто реалізувати незалежно:

    class IntEnum(int, Enum):
        pass

This demonstrates how similar derived enumerations can be defined; for example a `FloatEnum` that mixes in `float` instead of `int`.

Деякі правила:

1. When subclassing `Enum`, mix-in types must appear before `Enum` itself in the sequence of bases, as in the `IntEnum` example above.

2. Mix-in types must be subclassable. For example, `bool` and `range` are not subclassable and will throw an error during Enum creation if used as the mix-in type.

3. Хоча `Enum` може мати члени будь-якого типу, коли ви додаєте додатковий тип, усі члени повинні мати значення цього типу, наприклад. `int` вище. Це обмеження не стосується змішувань, які лише додають методи і не вказують інший тип.

4. When another data type is mixed in, the `value` attribute is not the same as the enum member itself, although it is equivalent and will compare equal.

5. A `data type` is a mixin that defines `__new__()`.

6. %-style formatting: `%s` and `%r` call the `Enum` class’s `__str__()` and `__repr__()` respectively; other codes (such as `%i` or `%h` for IntEnum) treat the enum member as its mixed-in type.

7. Formatted string literals, `str.format()`, and `format()` will use the enum’s `__str__()` method.

Примітка

Because `IntEnum`, `IntFlag`, and `StrEnum` are designed to be drop-in replacements for existing constants, their `__str__()` method has been reset to their data types“ `__str__()` method.

## When to use `__new__()` vs. `__init__()`

`__new__()` must be used whenever you want to customize the actual value of the `Enum` member. Any other modifications may go in either `__new__()` or `__init__()`, with `__init__()` being preferred.

Наприклад, якщо ви хочете передати кілька елементів у конструктор, але хочете, щоб лише один із них був значенням:

    >>> class Coordinate(bytes, Enum):
    ...     """
    ...     Coordinate with binary codes that can be indexed by the int code.
    ...     """
    ...     def __new__(cls, value, label, unit):
    ...         obj = bytes.__new__(cls, [value])
    ...         obj._value_ = value
    ...         obj.label = label
    ...         obj.unit = unit
    ...         return obj
    ...     PX = (0, 'P.X', 'km')
    ...     PY = (1, 'P.Y', 'km')
    ...     VX = (2, 'V.X', 'km/s')
    ...     VY = (3, 'V.Y', 'km/s')
    ...

    >>> print(Coordinate['PY'])
    Coordinate.PY

    >>> print(Coordinate(3))
    Coordinate.VY

Попередження

Do not call `super().__new__()`, as the lookup-only `__new__` is the one that is found; instead, use the data type directly.

### Більш тонкі точки

#### Підтримувані імена `__dunder__`

`__members__` is a read-only ordered mapping of `member_name`:`member` items. It is only available on the class.

`__new__()`, if specified, must create and return the enum members; it is also a very good idea to set the member’s `_value_` appropriately. Once all the members are created it is no longer used.

#### Підтримувані імена `_sunder_`

- `_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 `list` or a `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 by the Functional API and by `auto` to get an appropriate value for an enum member; may be overridden

Примітка

For standard `Enum` classes the next value chosen is the last value seen incremented by one.

For `Flag` classes the next value chosen will be the next highest power-of-two, regardless of the last value seen.

Нове в версії 3.6: `_missing_`, `_order_`, `_generate_next_value_`

Нове в версії 3.7: `_ігнорувати_`

To help keep Python 2 / Python 3 code in sync an `_order_` attribute can be provided. It will be checked against the actual order of the enumeration and raise an error if the two do not match:

    >>> class Color(Enum):
    ...     _order_ = 'RED GREEN BLUE'
    ...     RED = 1
    ...     BLUE = 3
    ...     GREEN = 2
    ...
    Traceback (most recent call last):
    ...
    TypeError: member order does not match _order_:
      ['RED', 'BLUE', 'GREEN']
      ['RED', 'GREEN', 'BLUE']

Примітка

In Python 2 code the `_order_` attribute is necessary as definition order is lost before it can be recorded.

#### _Private__names

Private names are not converted to enum members, but remain normal attributes.

Змінено в версії 3.11.

#### Тип члена `Enum`

Enum members are instances of their enum class, and are normally accessed as `EnumClass.member`. In certain situations, such as writing custom enum behavior, being able to access one member directly from another is useful, and is supported.

Змінено в версії 3.5.

#### Створення елементів, змішаних з іншими типами даних

When subclassing other data types, such as `int` or `str`, with an `Enum`, all values after the `=` are passed to that data type’s constructor. For example:

    >>> class MyEnum(IntEnum):      # help(int) -> int(x, base=10) -> integer
    ...     example = '11', 16      # so x='11' and base=16
    ...
    >>> MyEnum.example.value        # and hex(11) is...
    17

#### Логічне значення класів і членів `Enum`

Класи Enum, змішані з типами не `Enum` (такими як `int`, `str` тощо), оцінюються відповідно до правил змішаного типу; інакше всі члени оцінюються як `True`. Щоб зробити логічне обчислення вашого власного переліку залежним від значення члена, додайте наступне до свого класу:

    def __bool__(self):
        return bool(self.value)

Класи Plain `Enum` завжди оцінюються як `True`.

#### `Enum` класи з методами

If you give your enum subclass extra methods, like the Planet class below, those methods will show up in a `dir()` of the member, but not of the class:

    >>> dir(Planet)
    ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
    >>> dir(Planet.EARTH)
    ['__class__', '__doc__', '__module__', 'mass', 'name', 'radius', 'surface_gravity', 'value']

#### Об’єднання членів `Прапора`

Ітерація по комбінації елементів `Flag` поверне лише елементи, які складаються з одного біта:

    >>> class Color(Flag):
    ...     RED = auto()
    ...     GREEN = auto()
    ...     BLUE = auto()
    ...     MAGENTA = RED | BLUE
    ...     YELLOW = RED | GREEN
    ...     CYAN = GREEN | BLUE
    ...
    >>> Color(3)  # named combination
    <Color.YELLOW: 3>
    >>> Color(7)      # not named combination
    <Color.RED|GREEN|BLUE: 7>

#### Деталі `Flag` і `IntFlag`

Використовуючи наступний фрагмент для наших прикладів:

    >>> class Color(IntFlag):
    ...     BLACK = 0
    ...     RED = 1
    ...     GREEN = 2
    ...     BLUE = 4
    ...     PURPLE = RED | BLUE
    ...     WHITE = RED | GREEN | BLUE
    ...

вірно наступне:

- однобітові прапори є канонічними

- багатобітні та нульові бітові прапорці є псевдонімами

- під час ітерації повертаються лише канонічні прапори:

      >>> list(Color.WHITE)
      [<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]

- заперечення прапора або набору прапорів повертає новий прапор/набір прапорів із відповідним додатним цілим значенням:

      >>> Color.BLUE
      <Color.BLUE: 4>

      >>> ~Color.BLUE
      <Color.RED|GREEN: 3>

- імена псевдо-прапорів складаються з імен їх членів:

      >>> (Color.RED | Color.GREEN).name
      'RED|GREEN'

- багатобітові прапорці, або псевдоніми, можуть бути повернуті з операцій:

      >>> Color.RED | Color.BLUE
      <Color.PURPLE: 5>

      >>> Color(7)  # or Color(-1)
      <Color.WHITE: 7>

      >>> Color(0)
      <Color.BLACK: 0>

- membership / containment checking: zero-valued flags are always considered to be contained:

      >>> Color.BLACK in Color.WHITE
      True

  otherwise, only if all bits of one flag are in the other flag will True be returned:

      >>> Color.PURPLE in Color.WHITE
      True

      >>> Color.GREEN in Color.PURPLE
      False

Існує новий граничний механізм, який контролює, як обробляються біти за межами діапазону/недійсні: `STRICT`, `CONFORM`, `EJECT` і `KEEP`:

- STRICT –> створює виняток, якщо надає недійсні значення

- CONFORM –> відкидає всі недійсні біти

- EJECT –> втрачає статус прапора та стає звичайним int із заданим значенням

- KEEP –> збережіть зайві біти

  - зберігає статус прапора та додаткові біти

  - зайві біти не відображаються в ітерації

  - додаткові біти з’являються в repr() і str()

Типовим значенням для прапора є `STRICT`, значенням за замовчуванням `IntFlag` є `EJECT`, а за умовчанням для `_convert_` є `KEEP` (див. `ssl.Options` для прикладу того, коли потрібен `KEEP`).

## How are Enums and Flags different?

Переліки мають спеціальний метаклас, який впливає на багато аспектів як похідних класів `Enum`, так і їх екземплярів (членів).

### Класи Enum

The `EnumType` metaclass is responsible for providing the `__contains__()`, `__dir__()`, `__iter__()` and other methods that allow one to do things with an `Enum` class that fail on a typical class, such as `list(Color)` or `some_enum_var in Color`. `EnumType` is responsible for ensuring that various other methods on the final `Enum` class are correct (such as `__new__()`, `__getnewargs__()`, `__str__()` and `__repr__()`).

### Flag Classes

Flags have an expanded view of aliasing: to be canonical, the value of a flag needs to be a power-of-two value, and not a duplicate name. So, in addition to the `Enum` definition of alias, a flag with no value (a.k.a. `0`) or with more than one power-of-two value (e.g. `3`) is considered an alias.

### Члени Enum (також відомі як екземпляри)

The most interesting thing about enum members is that they are singletons. `EnumType` creates them all while it is creating the enum class itself, and then puts a custom `__new__()` in place to ensure that no new ones are ever instantiated by returning only the existing member instances.

### Flag Members

Flag members can be iterated over just like the `Flag` class, and only the canonical members will be returned. For example:

    >>> list(Color)
    [<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]

(Note that `BLACK`, `PURPLE`, and `WHITE` do not show up.)

Inverting a flag member returns the corresponding positive value, rather than a negative value — for example:

    >>> ~Color.RED
    <Color.GREEN|BLUE: 6>

Flag members have a length corresponding to the number of power-of-two values they contain. For example:

    >>> len(Color.PURPLE)
    2

## Enum Cookbook

Хоча очікується, що `Enum`, `IntEnum`, `StrEnum`, `Flag` і `IntFlag` охоплять більшість варіантів використання, вони не можуть охопити їх усіх. Ось рецепти для деяких різних типів перерахувань, які можна використовувати безпосередньо або як приклади для створення власних.

### Пропуск значень

In many use-cases, one doesn’t care what the actual value of an enumeration is. There are several ways to define this type of simple enumeration:

- використовувати екземпляри `auto` для значення

- використовуйте екземпляри `object` як значення

- використовуйте описовий рядок як значення

- use a tuple as the value and a custom `__new__()` to replace the tuple with an `int` value

Використання будь-якого з цих методів означає для користувача, що ці значення не є важливими, а також дозволяє додавати, видаляти або змінювати порядок членів без необхідності перенумеровувати решту членів.

#### Використання `auto`

Використання `auto` виглядатиме так:

    >>> class Color(Enum):
    ...     RED = auto()
    ...     BLUE = auto()
    ...     GREEN = auto()
    ...
    >>> Color.GREEN
    <Color.GREEN: 3>

#### Використання `object`

Використання `object` виглядатиме так:

    >>> class Color(Enum):
    ...     RED = object()
    ...     GREEN = object()
    ...     BLUE = object()
    ...
    >>> Color.GREEN
    <Color.GREEN: <object object at 0x...>>

This is also a good example of why you might want to write your own `__repr__()`:

    >>> class Color(Enum):
    ...     RED = object()
    ...     GREEN = object()
    ...     BLUE = object()
    ...     def __repr__(self):
    ...         return "<%s.%s>" % (self.__class__.__name__, self._name_)
    ...
    >>> Color.GREEN
    <Color.GREEN>

#### Використання описового рядка

Використання рядка як значення виглядатиме так:

    >>> class Color(Enum):
    ...     RED = 'stop'
    ...     GREEN = 'go'
    ...     BLUE = 'too fast!'
    ...
    >>> Color.GREEN
    <Color.GREEN: 'go'>

#### Using a custom `__new__()`

Using an auto-numbering `__new__()` would look like:

    >>> class AutoNumber(Enum):
    ...     def __new__(cls):
    ...         value = len(cls.__members__) + 1
    ...         obj = object.__new__(cls)
    ...         obj._value_ = value
    ...         return obj
    ...
    >>> class Color(AutoNumber):
    ...     RED = ()
    ...     GREEN = ()
    ...     BLUE = ()
    ...
    >>> Color.GREEN
    <Color.GREEN: 2>

Щоб зробити `AutoNumber` більш загального призначення, додайте `*args` до підпису:

    >>> class AutoNumber(Enum):
    ...     def __new__(cls, *args):      # this is the only change from above
    ...         value = len(cls.__members__) + 1
    ...         obj = object.__new__(cls)
    ...         obj._value_ = value
    ...         return obj
    ...

Тоді, коли ви успадкуєте від `AutoNumber`, ви можете написати свій власний `__init__` для обробки будь-яких додаткових аргументів:

    >>> class Swatch(AutoNumber):
    ...     def __init__(self, pantone='unknown'):
    ...         self.pantone = pantone
    ...     AUBURN = '3497'
    ...     SEA_GREEN = '1246'
    ...     BLEACHED_CORAL = () # New color, no Pantone code yet!
    ...
    >>> Swatch.SEA_GREEN
    <Swatch.SEA_GREEN: 2>
    >>> Swatch.SEA_GREEN.pantone
    '1246'
    >>> Swatch.BLEACHED_CORAL.pantone
    'unknown'

Примітка

The `__new__()` method, if defined, is used during creation of the Enum members; it is then replaced by Enum’s `__new__()` which is used after class creation for lookup of existing members.

Попередження

Do not call `super().__new__()`, as the lookup-only `__new__` is the one that is found; instead, use the data type directly – e.g.:

    obj = int.__new__(cls, value)

### OrderedEnum

Упорядковане перерахування, яке не базується на `IntEnum` і тому підтримує звичайні інваріанти `Enum` (наприклад, не порівнюється з іншими переліками):

    >>> class OrderedEnum(Enum):
    ...     def __ge__(self, other):
    ...         if self.__class__ is other.__class__:
    ...             return self.value >= other.value
    ...         return NotImplemented
    ...     def __gt__(self, other):
    ...         if self.__class__ is other.__class__:
    ...             return self.value > other.value
    ...         return NotImplemented
    ...     def __le__(self, other):
    ...         if self.__class__ is other.__class__:
    ...             return self.value <= other.value
    ...         return NotImplemented
    ...     def __lt__(self, other):
    ...         if self.__class__ is other.__class__:
    ...             return self.value < other.value
    ...         return NotImplemented
    ...
    >>> class Grade(OrderedEnum):
    ...     A = 5
    ...     B = 4
    ...     C = 3
    ...     D = 2
    ...     F = 1
    ...
    >>> Grade.C < Grade.A
    True

### DuplicateFreeEnum

Raises an error if a duplicate member value is found instead of creating an alias:

    >>> class DuplicateFreeEnum(Enum):
    ...     def __init__(self, *args):
    ...         cls = self.__class__
    ...         if any(self.value == e.value for e in cls):
    ...             a = self.name
    ...             e = cls(self.value).name
    ...             raise ValueError(
    ...                 "aliases not allowed in DuplicateFreeEnum:  %r --> %r"
    ...                 % (a, e))
    ...
    >>> class Color(DuplicateFreeEnum):
    ...     RED = 1
    ...     GREEN = 2
    ...     BLUE = 3
    ...     GRENE = 2
    ...
    Traceback (most recent call last):
      ...
    ValueError: aliases not allowed in DuplicateFreeEnum:  'GRENE' --> 'GREEN'

Примітка

Це корисний приклад для підкласу Enum для додавання або зміни іншої поведінки, а також заборони псевдонімів. Якщо єдиною бажаною зміною є заборона псевдонімів, натомість можна використати декоратор `unique()`.

### Планета

If `__new__()` or `__init__()` is defined, the value of the enum member will be passed to those methods:

    >>> class Planet(Enum):
    ...     MERCURY = (3.303e+23, 2.4397e6)
    ...     VENUS   = (4.869e+24, 6.0518e6)
    ...     EARTH   = (5.976e+24, 6.37814e6)
    ...     MARS    = (6.421e+23, 3.3972e6)
    ...     JUPITER = (1.9e+27,   7.1492e7)
    ...     SATURN  = (5.688e+26, 6.0268e7)
    ...     URANUS  = (8.686e+25, 2.5559e7)
    ...     NEPTUNE = (1.024e+26, 2.4746e7)
    ...     def __init__(self, mass, radius):
    ...         self.mass = mass       # in kilograms
    ...         self.radius = radius   # in meters
    ...     @property
    ...     def surface_gravity(self):
    ...         # universal gravitational constant  (m3 kg-1 s-2)
    ...         G = 6.67300E-11
    ...         return G * self.mass / (self.radius * self.radius)
    ...
    >>> Planet.EARTH.value
    (5.976e+24, 6378140.0)
    >>> Planet.EARTH.surface_gravity
    9.802652743337129

### Період часу

An example to show the `_ignore_` attribute in use:

    >>> from datetime import timedelta
    >>> class Period(timedelta, Enum):
    ...     "different lengths of time"
    ...     _ignore_ = 'Period i'
    ...     Period = vars()
    ...     for i in range(367):
    ...         Period['day_%d' % i] = i
    ...
    >>> list(Period)[:2]
    [<Period.day_0: datetime.timedelta(0)>, <Period.day_1: datetime.timedelta(days=1)>]
    >>> list(Period)[-2:]
    [<Period.day_365: datetime.timedelta(days=365)>, <Period.day_366: datetime.timedelta(days=366)>]

## Підклас EnumType

У той час як більшість потреб enum можна задовольнити, налаштувавши підкласи `Enum`, або за допомогою декораторів класів, або користувацьких функцій, `EnumType` можна створити підкласи, щоб забезпечити інший досвід Enum.