Design pattern in Python

Il design pattern Memento in Python

In questa lezione userai il pattern Memento per salvare e ripristinare lo stato di un oggetto, come la funzione annulla (undo).

  • Avanzato
  • 3 min di lettura
  • 1 esempio eseguibile

Introduzione

Il problema

Il pulsante Annulla, i checkpoint nei giochi e il ripristino delle impostazioni predefinite hanno bisogno di salvare lo stato di un oggetto e di riportarlo indietro più tardi, senza che altro codice metta le mani dentro l'oggetto.

Immaginalo così

Il pattern Memento è come salvare una partita. Il gioco crea un file di salvataggio con il suo stato. Tu conservi il salvataggio senza dover capire cosa c'è dentro. Più tardi, quando lo carichi, il gioco torna esattamente dov'era.

Dal salvare una partita al codice
editor.save()💾 Crea un file di salvataggio
Snapshot(text)🔒 Un salvataggio sigillato che non si può modificare
editor.text = "changed"🎮 Continua a giocare e cambia le cose
editor.restore(saved)⏪ Carica il salvataggio: di nuovo draft
Salva un'istantanea, cambia le cose, ripristina l'istantanea.
In una frase

Il pattern Memento cattura lo stato di un oggetto in un'istantanea (snapshot) che più tardi permette di ripristinarlo. Il codice che conserva l'istantanea non vede i dettagli interni dell'oggetto.

Punti chiave

  1. Snapshot è una dataclass frozen (immutabile), quindi un'istantanea salvata non si può più modificare.
  2. save() crea uno Snapshot con il testo attuale.
  3. Il testo viene poi cambiato in "changed".
  4. restore(saved) rimette il testo salvato, quindi viene stampato "draft".

Quando si usa?

  • Annulla e ripeti in editor e strumenti di disegno.
  • Checkpoint e salvataggi di gioco.
  • Tornare indietro dopo un'operazione fallita.

Quando non serve

  • Stati molto grandi salvati spesso: le istantanee occupano molta memoria. Meglio salvare solo le modifiche.
  • Valori semplici: basta salvare una copia della variabile.

Codice di esempio

Esegui codice →
main.py
from dataclasses import dataclass


@dataclass(frozen=True)
class Snapshot:
    # Memento: store a restorable snapshot without exposing internals.
    text: str


class Editor:
    def __init__(self): self.text = ""
    def save(self): return Snapshot(self.text)

    def restore(self, snapshot):
        # Restore state without exposing representation details.
        self.text = snapshot.text


editor = Editor()
editor.text = "draft"
saved = editor.save()
editor.text = "changed"
editor.restore(saved)
print(editor.text)
Crea un pulsante Run per questo esempio

Risultato dell'esecuzione

draft

Spiegazione del codice

Il metodo save() di Editor crea un'istantanea con il contenuto attuale, draft. Dopo che il contenuto diventa changed, il metodo restore() recupera il contenuto dall'istantanea salvata, per questo il risultato stampato è draft.

Modifica i valori ed esegui il programma nel compilatore Python online CodeUtility senza installare Python.

Esercizi di approfondimento

Prova a modificare il codice seguendo i suggerimenti qui sotto. Cambiare il codice e osservare il risultato ti aiuta a capire molto più che leggerlo soltanto.

  1. Sostituisci il dominio di esempio mantenendo la struttura del pattern.
  2. Confronta il pattern con un’implementazione più semplice e spiegane i compromessi.
  3. Scrivi test per ogni partecipante prima di aggiungere un’altra implementazione.
Esegui nel compilatore Python →

Errori comuni

Salvare un riferimento a uno stato mutabile

Se l'istantanea tiene la stessa lista che l'editor continua a cambiare, anche lo stato salvato cambia.

Problema
def save(self):
    return Snapshot(self.lines)  # same list
Correzione
def save(self):
    return Snapshot(list(self.lines))  # a copy

Hai finito questa lezione?

Segnala come imparata per tenere traccia dei tuoi progressi.