Po tej lekcji będziesz potrafić:

• dostosować czytelny dla człowieka tekst obiektu za pomocą __str__.
• zrozumieć różnicę między __str__ a przeznaczonym dla programistów __repr__.
• deklarować proste klasy przechowujące dane za pomocą @dataclass z polami z typami.
• polegać na inicjalizacji i równości opartej na wartościach generowanych przez dataclass.

Python nazywa metody o nazwach takich jak __str__ i __repr__ metodami dunder (skrót od „double underscore”, czyli podwójne podkreślenie). str(obj) i print(obj) używają __str__, gdy jest zdefiniowane. repr(obj) ma pomagać programistom w inspekcji obiektu; domyślnie Python może pokazać ogólną reprezentację z klasą i adresem.

Dla klas zorientowanych na dane @dataclass z dataclasses automatycznie tworzy typowe metody na podstawie zadeklarowanych pól z adnotacjami typów. Obejmuje to inicjalizator, użyteczną reprezentację i równość opartą na wartościach (==). Adnotacje typów opisują pola; nie walidują automatycznie typów w czasie działania.

W dataclass nadal możesz zdefiniować własne __str__, aby kontrolować wyświetlanie, zachowując wygenerowany inicjalizator i równość. Preferuj dataclasses dla prostych rekordów strukturalnych; złożone zachowanie zostaw w zwykłych klasach, gdy zwiększa to czytelność.

1. Czytelne __str__

class Server:
    def __init__(self, name, region):
        self.name = name
        self.region = region

    def __str__(self):
        return f"{self.name}@{self.region}"

print(Server("worker", "eu"))

Wynik:

worker@eu

__str__ musi zwrócić napis, a nie go wypisać.

2. Porównanie reprezentacji czytelnej i dla programistów

Ta klasa definiuje obie reprezentacje dla różnych odbiorców.

class Build:
    def __init__(self, number):
        self.number = number

    def __str__(self):
        return f"Build #{self.number}"

    def __repr__(self):
        return f"Build(number={self.number})"

build = Build(9)
print(str(build))
print(repr(build))

Wynik:

Build #9
Build(number=9)

3. Pozwolenie @dataclass na utworzenie inicjalizatora

from dataclasses import dataclass

@dataclass
class Job:
    name: str
    retries: int

job = Job("backup", 2)
print(job.name)
print(repr(job))

Wynik:

backup
Job(name='backup', retries=2)

Pola automatycznie stają się parametrami konstruktora.

4. Porównywanie wartości dataclass

Dwie różne instancje mogą nadal reprezentować równe dane.

from dataclasses import dataclass

@dataclass
class Version:
    component: str
    major: int

first = Version("api", 2)
second = Version("api", 2)
print(first == second)
print(first is second)

Wynik:

True
False

1. Zwracanie liczby lub None z __str__; Python wymaga napisu.
2. Używanie is do porównywania niezależnych rekordów danych według wartości.
3. Myślenie, że adnotacje typów w dataclass automatycznie wymuszają typy w czasie działania.
4. Zakładanie, że @dataclass uniemożliwia pisanie własnych metod; nadal możesz dostosować zachowanie.