collections. namedtuple
Crée des tuples à champs nommés : vous lisez les données avec student.points au lieu de student[2], et l’objet reste immuable.
- Renvoie
- Une nouvelle classe qui hérite de
tuple.
Exemple
#from collections import namedtuple
Student = namedtuple("Student", ["name", "world", "points"])
lea = Student("Léa", 7, 250)
print(lea)
print(lea.name, lea.points)
print(lea[1], len(lea))
name, world, points = lea
print(f"{name} est dans le monde {world}")Définition et utilisation
#La fonction namedtuple() du module collections crée une nouvelle classe de tuples dont chaque champ a un nom. Au lieu de vous rappeler que, dans le tuple ("Léa", 7, 250), les points sont à l’indice 2, vous écrivez student.points. Les objets restent de simples tuples, l’indexation, le déballage, la comparaison et len() fonctionnent donc.
Comme tout tuple, l’objet est immuable : l’assignation à un champ lève AttributeError. Une nouvelle version avec un champ modifié est créée par la méthode _replace(), et _asdict() transforme l’objet en dictionnaire. L’attribut _fields contient les noms des champs, et _make() crée un objet à partir de n’importe quelle séquence, par exemple une ligne d’un fichier CSV. Le tiret bas dans ces noms ne signifie pas qu’ils sont privés, il évite seulement les conflits avec les noms de vos champs.
Une notation plus moderne est une classe héritant de typing.NamedTuple, où les champs sont déclarés avec des annotations de types, comme dans @dataclass. Lorsque vous avez besoin d’un objet dont les champs peuvent changer, choisissez @dataclass.
Syntaxe
#from collections import namedtuple
Nom = namedtuple("Nom", ["champ1", "champ2"], defaults=None)
objet = Nom(valeur1, valeur2)
objet.champ1
objet._replace(champ1=nouvelle_valeur)
objet._asdict()Paramètres
#typename
str
Le nom de la nouvelle classe, visible notamment dansrepr(). En général le même que le nom de la variable.field_names
liste de chaînes ou chaîne
Les noms des champs, par exemple["x", "y"]ou"x y".defaults
séquence, facultative
Les valeurs par défaut des derniers champs.
Plus d’exemples
#from collections import namedtuple
Student = namedtuple("Student", "name points level", defaults=[1])
jean = Student("Jean", 80)
print(jean)
try:
jean.points = 120
except AttributeError:
print("Le champ ne peut pas être modifié")
promoted = jean._replace(points=120, level=2)
print(promoted)
print(promoted._asdict())
print(Student._fields)from typing import NamedTuple
class Point(NamedTuple):
x: float
y: float = 0.0
def distance(self):
return (self.x ** 2 + self.y ** 2) ** 0.5
p = Point(3, 4)
print(p, p.distance())
print(Point(1.5))
print(sorted([Point(2, 1), Point(1, 5), Point(1, 2)]))Les annotations ne convertissent pas les types : Point(3, 4) stocke des entiers. Le tri compare les champs un par un, comme pour les tuples ordinaires.
import csv
from collections import namedtuple
lines = ["name,world,points", "Léa,7,250", "Jean,2,80"]
reader = csv.reader(lines)
Row = namedtuple("Row", next(reader))
for row in map(Row._make, reader):
print(row.name, int(row.points))Bonnes pratiques
#- Les méthodes
_replace(),_asdict()et_make()sont publiques malgré le tiret bas. Il protège d’un conflit avec les noms de vos champs. - Un namedtuple convient bien pour renvoyer plusieurs valeurs depuis une fonction : vous déballez le résultat comme un tuple ou le lisez par les noms de champs.
- Si les champs doivent changer, ou si la classe a besoin de nombreuses méthodes, utilisez
@dataclass.
Entrées associées
#- namedtuple vs dataclassnamedtuple crée un tuple léger et immuable à champs nommés ; @dataclass crée une classe ordinaire et modifiable avec __init__, __repr__ et __eq__ générés.
- tuple()Crée un tuple : une séquence immuable d’éléments.
- Déballage de séquencesAffectation des éléments d’un tuple ou d’une liste à plusieurs variables à la fois.
- @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.
- csvLecture et écriture de fichiers CSV, c’est-à-dire des tableaux enregistrés sous forme de texte, dont les valeurs sont séparées par une virgule ou un point-virgule.
Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.