Python enum list values

Get List of all Enum values in python

This tutorial will discuss about unique ways to get list of all enum values in Python.

Table Of Contents

Get List of all Enum values

Iterate over all entries in Enum in a List Comprehension. For each entry in enum, select its value property during iteration, to get the value field of each entry of enum. The List comprehension will return a list of all values of the Emum.

Let’s see the complete example,

from enum import Enum class ChannelStatus(Enum): IDE =1 ACTIVE = 2 BLOCKED = 3 WAITING = 4 CLOSED = 5 # Get list of all enum values in Python enumValues = [statusMem.value for statusMem in ChannelStatus] print (enumValues)

Frequently Asked:

Get Names of all entries in Enum

Iterate over all entries in Enum using a List Comprehension. During iteration, for each entry in enum, access its name property, to get the name field of that entry in enum. The List comprehension will return a list of all names of all entries in Emum.

Let’s see the complete example,

from enum import Enum class ChannelStatus(Enum): IDE =1 ACTIVE = 2 BLOCKED = 3 WAITING = 4 CLOSED = 5 # Get list of names of all enum values in Python enumValueNames = [statusMem.name for statusMem in ChannelStatus] print (enumValueNames)

['IDE', 'ACTIVE', 'BLOCKED', 'WAITING', 'CLOSED']

Get name/value pairs of all entries in Enum

Iterate over all entries in Enum using for loop, and for each enum entry, access its name and value properties to get the details. In the belowe example, we have printed all the names and value of all entries in the enum, one by one.

Let’s see the complete example,

from enum import Enum class ChannelStatus(Enum): IDE =1 ACTIVE = 2 BLOCKED = 3 WAITING = 4 CLOSED = 5 # iterate over all entries of name, and print # name, value of each entry in enum for status in ChannelStatus: print("Name : ", status.name, " :: Value : ", status.value)

Name : IDE :: Value : 1 Name : ACTIVE :: Value : 2 Name : BLOCKED :: Value : 3 Name : WAITING :: Value : 4 Name : CLOSED :: Value : 5

Summary

We learned about different ways to get a List of all Enum values in Python. Thanks.

Related posts:

Share your love

Leave a Comment Cancel Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Terms of Use

Disclaimer

Copyright © 2023 thisPointer

To provide the best experiences, we and our partners use technologies like cookies to store and/or access device information. Consenting to these technologies will allow us and our partners to process personal data such as browsing behavior or unique IDs on this site and show (non-) personalized ads. Not consenting or withdrawing consent, may adversely affect certain features and functions.

Click below to consent to the above or make granular choices. Your choices will be applied to this site only. You can change your settings at any time, including withdrawing your consent, by using the toggles on the Cookie Policy, or by clicking on the manage consent button at the bottom of the screen.

The technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.

The technical storage or access is necessary for the legitimate purpose of storing preferences that are not requested by the subscriber or user.

The technical storage or access that is used exclusively for statistical purposes. The technical storage or access that is used exclusively for anonymous statistical purposes. Without a subpoena, voluntary compliance on the part of your Internet Service Provider, or additional records from a third party, information stored or retrieved for this purpose alone cannot usually be used to identify you.

The technical storage or access is required to create user profiles to send advertising, or to track the user on a website or across several websites for similar marketing purposes.

Источник

Гайд по использованию enum в Python

Модуль enum содержит в себе тип для перечисления значений с возможностью итерирования и сравнения. Его можно использовать для создания понятных обозначений вместо использования чисел (для которых приходится помнить, какое число что обозначает) или строк (в которых легко опечататься и не заметить).

Создание

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

# enum_create.py import enum class BugStatus(enum.Enum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 print('\nMember name: <>'.format(BugStatus.wont_fix.name)) print('Member value: <>'.format(BugStatus.wont_fix.value))

Атрибуты класса Enum конвертируются в экземпляры при парсинге. Каждый экземпляр имеет параметр name , в котором хранится название, а также value , в котором хранится установленное значение.

$ python3 enum_create.py Member name: wont_fix Member value: 4

Итерирование

При итерировании по классу вы пройдёте по атрибутам.

# enum_iterate.py import enum class BugStatus(enum.Enum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 for status in BugStatus: print(' = <>'.format(status.name, status.value))

Цикл будет идти по элементам в том порядке, в котором они указаны при создании класса. Названия и значения никак не влияют на порядок.

$ python3 enum_iterate.py new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1

Сравнение перечислений

Так как элементы перечислений не упорядочены, то они поддерживают сравнение только по названию или значению.

# enum_comparison.py import enum class BugStatus(enum.Enum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 actual_state = BugStatus.wont_fix desired_state = BugStatus.fix_released print('Equality:', actual_state == desired_state, actual_state == BugStatus.wont_fix) # проверка на равенство print('Identity:', actual_state is desired_state, actual_state is BugStatus.wont_fix) # проверка на то, это один и тот же элемент или нет print('Ordered by value:') try: print('\n'.join(' ' + s.name for s in sorted(BugStatus))) # пытаемся упорядочить except TypeError as err: print(' Cannot sort: <>'.format(err)) # вывод ошибки в случае неудачи

Операторы больше и меньше порождают TypeError .

$ python3 enum_comparison.py Equality: False True Identity: False True Ordered by value: Cannot sort: '

# enum_intenum.py import enum class BugStatus(enum.IntEnum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 print('Ordered by value:') print('\n'.join(' ' + s.name for s in sorted(BugStatus))) # упорядочивание по значению

$ python3 enum_intenum.py Ordered by value: fix_released fix_committed in_progress wont_fix invalid incomplete new

# enum_aliases.py import enum class BugStatus(enum.Enum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 by_design = 4 closed = 1 for status in BugStatus: print(' = <>'.format(status.name, status.value)) print('\nSame: by_design is wont_fix: ', BugStatus.by_design is BugStatus.wont_fix) print('Same: closed is fix_released: ', BugStatus.closed is BugStatus.fix_released)

$ python3 enum_aliases.py new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 Same: by_design is wont_fix: True Same: closed is fix_released: True

# enum_unique_enforce.py import enum @enum.unique class BugStatus(enum.Enum): new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1 # This will trigger an error with unique applied. by_design = 4 closed = 1

$ python3 enum_unique_enforce.py Traceback (most recent call last): File "enum_unique_enforce.py", line 11, in class BugStatus(enum.Enum): File ". /lib/python3.7/enum.py", line 848, in unique (enumeration, alias_details)) ValueError: duplicate values found in : by_design -> wont_fix, closed -> fix_released

# enum_programmatic_create.py import enum BugStatus = enum.Enum( value='BugStatus', names=('fix_released fix_committed in_progress ' 'wont_fix invalid incomplete new'), ) print('Member: <>'.format(BugStatus.new)) print('\nAll members:') for status in BugStatus: print(' = <>'.format(status.name, status.value))

$ python3 enum_programmatic_create.py Member: BugStatus.new All members: fix_released = 1 fix_committed = 2 in_progress = 3 wont_fix = 4 invalid = 5 incomplete = 6 new = 7

# enum_programmatic_mapping.py import enum BugStatus = enum.Enum( value='BugStatus', names=[ ('new', 7), ('incomplete', 6), ('invalid', 5), ('wont_fix', 4), ('in_progress', 3), ('fix_committed', 2), ('fix_released', 1), ], ) print('All members:') for status in BugStatus: print(' = <>'.format(status.name, status.value))

$ python3 enum_programmatic_mapping.py All members: new = 7 incomplete = 6 invalid = 5 wont_fix = 4 in_progress = 3 fix_committed = 2 fix_released = 1

# enum_tuple_values.py import enum class BugStatus(enum.Enum): new = (7, ['incomplete', 'invalid', 'wont_fix', 'in_progress']) incomplete = (6, ['new', 'wont_fix']) invalid = (5, ['new']) wont_fix = (4, ['new']) in_progress = (3, ['new', 'fix_committed']) fix_committed = (2, ['in_progress', 'fix_released']) fix_released = (1, ['new']) def __init__(self, num, transitions): self.num = num self.transitions = transitions def can_transition(self, new_state): return new_state.name in self.transitions print('Name:', BugStatus.in_progress) print('Value:', BugStatus.in_progress.value) print('Custom attribute:', BugStatus.in_progress.transitions) print('Using attribute:', BugStatus.in_progress.can_transition(BugStatus.new))

$ python3 enum_tuple_values.py Name: BugStatus.in_progress Value: (3, ['new', 'fix_committed']) Custom attribute: ['new', 'fix_committed'] Using attribute: True

# enum_complex_values.py import enum class BugStatus(enum.Enum): new = < 'num': 7, 'transitions': [ 'incomplete', 'invalid', 'wont_fix', 'in_progress', ], >incomplete = < 'num': 6, 'transitions': ['new', 'wont_fix'], >invalid = < 'num': 5, 'transitions': ['new'], >wont_fix = < 'num': 4, 'transitions': ['new'], >in_progress = < 'num': 3, 'transitions': ['new', 'fix_committed'], >fix_committed = < 'num': 2, 'transitions': ['in_progress', 'fix_released'], >fix_released = < 'num': 1, 'transitions': ['new'], >def __init__(self, vals): self.num = vals['num'] self.transitions = vals['transitions'] def can_transition(self, new_state): return new_state.name in self.transitions print('Name:', BugStatus.in_progress) print('Value:', BugStatus.in_progress.value) print('Custom attribute:', BugStatus.in_progress.transitions) print('Using attribute:', BugStatus.in_progress.can_transition(BugStatus.new))

$ python3 enum_complex_values.py Name: BugStatus.in_progress Value: Custom attribute: ['new', 'fix_committed'] Using attribute: True