Formations — 1 037 leçons en français

Accueil › Python › Méthodes spéciales : __repr__, __eq__, __len__

Méthodes spéciales : __repr__, __eq__, __len__

Classes et objetsintermediaire

Python appelle certaines méthodes de vos classes à votre place, quand une syntaxe du langage est utilisée. len(x) appelle x.__len__(), a == b appelle a.__eq__(b), print(x) appelle x.__str__(). Les implémenter, c'est faire en sorte qu'un objet à vous se comporte comme le reste du langage.

Sans __repr__, un objet est illisible — y compris dans les messages d'échec de vos tests :

>>> Produit("ref-1", 10.0)
<boutique.catalogue.Produit object at 0x7f3a1c0d4e50>

Trois méthodes couvrent presque tous les besoins.

class Produit:
    def __init__(self, reference: str, prix: float) -> None:
        self.reference = reference
        self.prix = prix

    def __repr__(self) -> str:
        return f"Produit(reference={self.reference!r}, prix={self.prix!r})"

    def __eq__(self, autre: object) -> bool:
        if not isinstance(autre, Produit):
            return NotImplemented
        return (self.reference, self.prix) == (autre.reference, autre.prix)

    def __hash__(self) -> int:
        return hash((self.reference, self.prix))

Deux règles à ne pas rater :

Et si vos classes sont de simples porteuses de données, @dataclass écrit __repr__ et __eq__ pour vous : écrivez-les à la main quand vous voulez autre chose que la comparaison de tous les champs.

Les termes à connaître

Méthode spéciale (dunder)

Une méthode au nom encadré de doubles soulignés (__repr__, __len__). Python l'appelle à votre place quand une syntaxe du langage est utilisée : len(x) appelle x.__len__(), a == b appelle a.__eq__(b).

`__repr__`

La représentation destinée au développeur : sans ambiguïté, idéalement de la forme Produit(reference='ref-1', prix=10.0). C'est ce qu'affichent l'interpréteur interactif, le débogueur et les éléments d'une liste.

`__str__`

La représentation destinée à l'utilisateur, celle que rend str(obj) et print(obj). Si elle est absente, Python retombe sur __repr__ — l'inverse n'est pas vrai.

`__eq__`

Définit ==. Doit rendre NotImplemented (et non False) face à un type qu'elle ne sait pas comparer : Python essaie alors la méthode symétrique de l'autre objet avant de conclure.

`__hash__`

Rend l'entier qui permet de ranger l'objet dans un set ou en clé de dict. Deux objets égaux doivent avoir le même hachage. Définir __eq__ met automatiquement __hash__ à None.

`__len__`

Définit len(obj). Doit rendre un entier positif ou nul. Sert aussi de valeur de vérité par défaut : sans __bool__, un objet dont __len__ vaut 0 est considéré comme faux.

`__bool__`

Définit la valeur de vérité de l'objet dans un if. Python cherche d'abord __bool__, puis __len__, et sans aucun des deux considère tout objet comme vrai.

NotImplemented

Une valeur singulière rendue par une méthode de comparaison ou d'opérateur pour dire « je ne sais pas traiter cet autre type ». Ce n'est pas l'exception NotImplementedError, qui sert à marquer une méthode à écrire.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.