Pythonデザインパターン

PythonのMementoパターン

このレッスンでは、Mementoパターンを使って、元に戻す機能(undo)のようにオブジェクトの状態を保存して復元します。

  • 上級
  • 約3分で読めます
  • 実行できるサンプル 1 件

はじめに

どんな問題を解決するか

元に戻す操作、ゲームのチェックポイント、「初期設定に戻す」はどれも、オブジェクトの状態を保存してあとで戻す必要があります。しかもほかのコードがオブジェクトの内部に手を突っ込まないようにです。

身近なたとえ

Memento パターンはゲームのセーブのようなものです。ゲームは状態を持ったセーブファイルを作り、あなたは中身を理解しなくてもそのファイルを持っていられます。あとでセーブを読み込めば、ゲームはちょうどその場所に戻ります。

ゲームのセーブからコードへ
editor.save()💾 セーブファイルを作る
Snapshot(text)🔒 編集できない封印されたセーブ
editor.text = "changed"🎮 プレイを続けて状態を変える
editor.restore(saved)⏪ セーブを読み込む:draft に戻る
スナップショットを保存し、変更し、スナップショットを戻します。
ひと言でいうと

Memento パターンは、オブジェクトの状態をあとで戻せるスナップショットのオブジェクトに保存し、スナップショットを保存するコードにはオブジェクトの内部の詳細を見せません。

重要なポイント

  1. Snapshot は凍結(frozen)されたデータクラスなので、保存したスナップショットはあとから変えられません。
  2. save() は今の文字列で Snapshot を作ります。
  3. その後、文字列は "changed" に変わります。
  4. restore(saved) は保存した文字列を戻すので、"draft" と表示されます。

どんな場面で使う?

  • エディターや描画ツールでの元に戻す・やり直し。
  • チェックポイントやゲームのセーブ。
  • 失敗した操作のあとのロールバック。

使わなくてよいとき

  • 頻繁に保存されるとても大きな状態:スナップショットはメモリを多く使うので、変更点だけを保存します。
  • 単純な値:変数のコピーを保存すれば十分です。

サンプルコード

コードを実行 →
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)
この例の実行ボタンを作成

実行結果

draft

コードの解説

Editorのsave()メソッドは、今の内容draftを持つスナップショットを作ります。内容がchangedに変わった後でも、restore()メソッドが保存したスナップショットから内容を取り戻すので、表示される結果はdraftです。

値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。

発展問題

下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。

  1. パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
  2. パターンをより単純な実装と比較し、トレードオフを説明してください。
  3. 別の実装を追加する前に、各参加要素のテストを書いてください。
Pythonコンパイラで実行 →

よくある間違い

変更可能な状態への参照を保存する

スナップショットがエディターの変更し続けるリストと同じものを持つと、保存した状態も変わってしまいます。

問題
def save(self):
    return Snapshot(self.lines)  # same list
修正
def save(self):
    return Snapshot(list(self.lines))  # a copy

このレッスンを終えましたか?

学習済みにすると進み具合を記録できます。