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.
Exemple
#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])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
#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 avecin, par exemple un ensemble de permissions.auto()
Attribue les valeurs automatiquement : dansEnum, des nombres successifs à partir de 1, et dansStrEnum, le nom du membre en minuscules.
Plus d’exemples
#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)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)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)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
StrEnumetIntEnum. - É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 avecStatus(valeur).
Entrées associées
#- classDéfinit une classe : un modèle d’objets qui réunit des données et les fonctions qui agissent dessus.
- match, caseLe filtrage par motif : choisir une branche de code d’après les données et la forme d’une valeur.
- @dataclassUn décorateur qui génère __init__, __repr__ et __eq__ à partir des champs annotés d’une classe qui sert à stocker des données.
- typingLes annotations de types : une description des valeurs qu’une fonction attend et de ce qu’elle renvoie. Elles sont vérifiées par les éditeurs et des outils comme mypy.
- jsonConvertit des données Python en texte JSON et inversement. La base de l’enregistrement de données et de la communication avec les API.
Pratiquer dans les leçons
#Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.