Классы IntEnum и StrEnum

Курс по стандартной библиотеке: https://stepik.org/a/259466?utm_source=proproprogs

На предыдущем занятии мы с вами познакомились с общим классом Enum для создания перечислений в Python-программах. Однако часто на практике требуются специализированные перечисления, состоящие только из набора целых чисел или строк. Для их определения доступны следующие два класса:

• IntEnum – для создания перечисления из набора целых чисел;
• StrEnum – для создания перечисления из набора строк.

Давайте посмотрим, чем эти классы отличаются от ранее рассмотренного класса Enum. Предположим, что нам нужно сформировать перечисление для дней недели. Сделаем это следующим образом:

import enum
 
 
class Week(enum.IntEnum):
    Monday = 1
    Tuesday = 2
    Wednesday = 3
    Thursday = 4
    Friday = 5
    Saturday = 6
    Sunday = 7

С элементами такого перечисления возможны следующие операции:

p1 = Week.Monday
p2 = Week.Friday
 
p1 == Week.Monday # True
p1 == 1 # True
p1 == Week.Thursday # False
p1 == p2 # False
p1.value # 1
p2.name # 'Friday'
p1 + p2 # 6
p1 < p2 # True
p2 <= p1 # False

Обратите внимание, объекты p1, p2 можно сравнивать на равенство не только с объектами Week.Monday, Week.Thursday, но и с конкретными числами. Кроме того, с p1, p2 можно выполнять различные арифметические операции, как с целыми числами, что было недопустимо с объектами обычного перечисления Enum. Кроме того, если попытаться присвоить какому-либо атрибуту значение, не приводящееся к целочисленному, например:

class Week(enum.IntEnum):
    Monday = 'a'
    ...

то при выполнении программы возникнет ошибка ValueError. То есть, класс IntEnum гарантирует целочисленные значения своих элементов и расширяет их операции до сравнения с числами и различных арифметических действий.

Пример использования перечисления IntEnum

Рассмотрим небольшой пример использования данного перечисления. Объявим функцию, которая будет выдавать список предметов для указанного дня:

def get_subjects(day: Week):
    match day:
        case Week.Monday:
            return "Информатика", "Математика"
        case Week.Tuesday:
            return "Физика",
        case Week.Friday:
            return "Машинное обучение", "Математика", "Информатика"
        case _:
            return tuple()

Здесь используется конструкция match/case для выбора указанного дня и если шаблон проверки совпадает, то возвращается кортеж из названий дисциплин. Последний case реализует поведение по умолчанию, возвращающий пустой кортеж.

Воспользоваться этой функцией можно следующим образом:

subjects = get_subjects(Week.Friday)
print(subjects)

После запуска программы, получим:

('Машинное обучение', 'Математика', 'Информатика')

Обратите внимание, что из-за использования типа IntEnum, мы можем в аргументе указать целое число, соответствующее дню Friday:

subjects = get_subjects(5)

Результат будет тем же.

Перечисления типа StrEnum

По аналогии работает перечисление типа StrEnum, которое в качестве значений атрибутов требует строковые данные. Например:

class Filter(enum.StrEnum):
    ASC = 'ascend'
    DESC = 'descent'
    BYID = 'id'

Который можно также перебрать с помощью цикла for:

for p in Filter:
    print(f"{p.name}: {p.value}")

Или, извлечь любое значение по имени атрибута:

p1 = Filter.DESC # <enum 'Filter'>
p2 = Filter['ASC'] # <enum 'Filter'>

Каждый элемент будет являться объектом класса Filter. С этими элементами допустимы следующие операции:

p1 == p2 # False
p2 == Filter.ASC # True
p1 < Filter.BYID # True (лексикографическое сравнение строк)
p2 >= Filter.DESC # False
p1 + p2 # 'descentascend'

То есть, можно выполнять те же операции, что и со строками.

Если при объявлении перечисления типа StrEnum в значении какого-либо атрибута указать не строковую величину, например:

class Filter(enum.StrEnum):
    ASC = 'ascend'
    DESC = 'descent'
    BYID = 'id'
 
    p1 = ('1', '2') # ошибка (кортеж)
    p2 = 5 # ошибка (число)

то возникнет ошибка TypeError. Здесь следует явно прописывать строки или строковые переменные.

Вот так классы перечислений Enum, IntEnum, StrEnum позволяют структурировать данные, делая код понятнее и надежнее. Их использование повышает качество программного продукта благодаря строгому контролю над допустимым набором значений. Поэтому, если в проекте требуется ограничение списка возможных состояний, то для этого очень хорошо подходят классы перечислений.

Курс по стандартной библиотеке: https://stepik.org/a/259466?utm_source=proproprogs

Видео по теме

#1. Тип данных complex

#2. Множество frozenset

#3. Перечисления (enum). Класс Enum

#4. Классы IntEnum и StrEnum

#5. Именованные кортежи namedtuple модуля collections

#6. Словарь defaultdict модуля collections

#7. Упорядоченный словарь OrderedDict

#8. Класс Counter модуля collections

#9. Класс ChainMap модуля collections

#10. Функции pprint() и pformat(). Класс PrettyPrinter

#11. Очереди типов FIFO и LIFO

#12. Очередь deque модуля collections

#13. Класс Queue модуля queue

#14. Классы LifoQueue и PriorityQueue модуля queue

#15. Понятие кучи (heap). Модуль heapq

#16. Класс array. Методы класса array

#17. Модуль bisect - сортировка в моменте

#18. Функции copy() и deepcopy() модуля copy

#19. Магические методы __copy__() и __deepcopy__()

#20. Декораторы partial и partialmethod модуля functools

#21. Функция update_wrapper() и декоратор wraps

#22. Декоратор lru_cache модуля functools

#23. Функция reduce() модуля functools

#24. Декоратор singledispatch модуля functools

#25. Модуль abc (Abstract Base Classes)

#26. Модуль itertools. Функция chain()

#27. Функции zip_longest(), islice() и tee()

#28. Комбинаторные функции модуля itertools

#29. Функции фильтрации из модуля itertools

#30. Функции-генераторы модуля itertools

#31. Функции groupby() и starmap() модуля itertools

#32. Функции модуля operator. Классы itemgetter и attrgetter

#33. Функция methodcaller() модуля operator

#34. Функции модуля time. Функции time() и ctime()

#35. Функции monotonic(), perf_counter() и process_time()

#36. Функции localtime(), gmtime(), mktime(), strftime() и strptime()

#37. Модуль datetime. Классы time и date

#38. Арифметика дат. Класс timedelta

#39. Класс datetime модуля datetime

#40. Модуль calendar. Основные функции, классы и методы

#41. Модуль math (часть 1)

#42. Модуль math (часть 2)

#43. Модуль math (часть 3)

#44. Класс Decimal для точного представления вещественных чисел

#45. Методы класса Decimal

#46. Функции с числами Decimal. Глобальный и локальный контексты

#47. Класс Fraction модуля fractions

#48. Стандартные функции с объектами класса Fraction

#49. Модуль random стандартной библиотеки

#50. Введение в модуль statistics

#51. Вычисление дисперсий и ковариаций с помощью модуля statistics

#52. Введение в модуль re. Символьные классы

#53. Квантификаторы регулярных выражений

#54. Группировка и сохранение в регулярных выражениях

#55. Опережающие (lookahead) проверки. Флаги

#56. Ретроспективные (lookbehind) проверки

#57. Объект Match. Методы search(), finditer() и findall()

#58. Методы match(), split(), sub(), subn(), compile()

#59. Функции модуля os.path для анализа файловых маршрутов

#60. Дополнительные функции модуля os.path

#61. Классы PurePosixPath и PureWindowsPath модуля pathlib

#62. Классы PosixPath и WindowsPath модуля pathlib