enum

Les énumérations : un ensemble de constantes nommées, par exemple des niveaux de difficulté ou des statuts de tâche, au lieu de chaînes et de nombres épars.

Sur cette page

Exemple

#
Python
from enum import Enum

class Difficulty(Enum):
    EASY = 1
    MEDIUM = 2
    HARD = 3

level = Difficulty.HARD
print(level)
print(level.name, level.value)
print(level is Difficulty.HARD)
print(Difficulty(2).name, Difficulty["EASY"].value)
print([d.name for d in Difficulty])
Résultatrésultat enregistré, vous pouvez le vérifier
Difficulty.HARD
HARD 3
True
MEDIUM 1
['EASY', 'MEDIUM', 'HARD']

Définition et utilisation

#

Le module enum permet de définir une énumération, c’est-à-dire une classe avec une liste fermée de valeurs nommées. Au lieu de saisir dans votre code les chaînes "easy" et "hard", où une faute de frappe est facile, vous créez une classe Difficulty(Enum) avec les membres EASY, MEDIUM et HARD. Chaque membre a un nom (.name) et une valeur (.value).

On compare les membres avec is ou ==, et une faute de frappe dans un nom, par exemple Difficulty.EASSY, lève aussitôt AttributeError. On peut itérer sur une énumération dans l’ordre de définition, et retrouver un membre par sa valeur (Difficulty(2)) ou par son nom (Difficulty["HARD"]). Les valeurs n’ont pas à être des nombres, et la fonction auto() les attribue automatiquement.

Un membre d’un Enum ordinaire n’est pas égal à sa valeur : Difficulty.EASY == 1 vaut False. Lorsque les membres doivent se comporter comme des chaînes ou des nombres, par exemple pour l’écriture en JSON ou la comparaison avec des données d’une base, utilisez StrEnum ou IntEnum. Les énumérations s’associent bien à l’instruction match, où le membre s’écrit avec un point : case Difficulty.HARD:.

Syntaxe

#
Syntaxe
from enum import Enum, auto

class Nom(Enum):
    MEMBRE = valeur
    AUTRE = auto()

Nom.MEMBRE.name
Nom.MEMBRE.value
Nom(valeur)
Nom["MEMBRE"]

Les éléments les plus importants

#
  • Enum

    L’énumération de base. Les membres ne sont égaux qu’à eux-mêmes, et non à leurs valeurs.
  • StrEnum

    Les membres sont des chaînes : ils sont égaux à leurs valeurs et arrivent dans les f-strings sous la forme de la seule valeur. Depuis Python 3.11.
  • IntEnum

    Les membres sont des entiers, on peut donc les comparer à des nombres et les utiliser dans des calculs.
  • Flag

    Les valeurs peuvent être combinées avec l’opérateur | et vérifiées avec in, par exemple un ensemble de permissions.
  • auto()

    Attribue les valeurs automatiquement : dans Enum, des nombres successifs à partir de 1, et dans StrEnum, le nom du membre en minuscules.

Plus d’exemples

#
StrEnum et auto()
Python
from enum import StrEnum, auto

class Status(StrEnum):
    TODO = auto()
    IN_PROGRESS = auto()
    DONE = auto()

task = {"number": "7_3", "status": Status.DONE}

print(Status.IN_PROGRESS.value)
print(task["status"] == "done")
print(f"Statut : {task['status']}")
print(Status("todo").name)
Résultatrésultat enregistré, vous pouvez le vérifier
in_progress
True
Statut : done
TODO
Méthodes d’énumération et match
Python
from enum import Enum

class Difficulty(Enum):
    EASY = 1
    MEDIUM = 2
    HARD = 3

    @property
    def exp(self):
        return self.value * 10

def label(difficulty):
    match difficulty:
        case Difficulty.EASY:
            return "Pour s’échauffer"
        case Difficulty.HARD:
            return "Pour les persévérants"
        case _:
            return "Standard"

for d in Difficulty:
    print(d.name, d.exp, label(d))
print(Difficulty.EASY == 1)
Résultatrésultat enregistré, vous pouvez le vérifier
EASY 10 Pour s’échauffer
MEDIUM 20 Standard
HARD 30 Pour les persévérants
False
Flag : combiner des permissions
Python
from enum import Flag, auto

class Permission(Flag):
    READ = auto()
    WRITE = auto()
    DELETE = auto()

mentor = Permission.READ | Permission.WRITE
print(Permission.WRITE in mentor, Permission.DELETE in mentor)
print([p.name for p in mentor])
print(mentor.value)
Résultatrésultat enregistré, vous pouvez le vérifier
True False
['READ', 'WRITE']
3

Bonnes pratiques

#
  • Comparez les membres avec d’autres membres, et non avec des chaînes ou des nombres. Pour les comparaisons avec des valeurs brutes, il y a StrEnum et IntEnum.
  • Écrivez les noms des membres en majuscules, comme des constantes : Status.DONE.
  • Pour l’écriture en JSON, utilisez .value, et à la lecture, reconvertissez la valeur en membre avec Status(valeur).

Entrées associées

#

Pratiquer dans les leçons

#

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.