Pythonデザインパターン

PythonのPrototypeパターン

このレッスンでは、Prototypeパターンを使って、既存のオブジェクトをコピーして新しいオブジェクトを作ります。

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

はじめに

どんな問題を解決するか

オブジェクトを一から作るのが遅かったり複雑だったりする一方で、ほぼ望みどおりのものがすでに手元にあることがあります。設定を済ませた文書や、パラメーターを調整済みのゲームの敵キャラなどです。それをコピーして数か所だけ変えるほうが、もう1つ一から作るより簡単です。

身近なたとえ

Prototype パターンは、記入済みの書類をコピーするようなものです。全部を書き直す代わりに書類をコピーし、違う欄だけを書き換えます。元の書類はそのままです。

書類のコピーからコードへ
draft = Document("Draft")📝 記入済みの元の書類
draft.clone()📠 コピーを取る
published.status = "Published"✏️ コピーの欄を1つ書き換える
draft.status📄 元の書類はまだ Draft のまま
既存のオブジェクトを複製し、コピーを調整します。
ひと言でいうと

Prototype パターンは、既存のオブジェクト(プロトタイプ)をコピーし、違う部分だけを変えて新しいオブジェクトを作ります。

重要なポイント

  1. clone() は copy(self) を返します。同じ属性値を持つ新しいオブジェクトです。
  2. published は別のオブジェクトなので、published.status を変えても draft には影響しません。
  3. copy は浅いコピーを作るので、入れ子のリストや辞書は共有されたままです。
  4. 出力を見ると、元は Draft、コピーは Published になっています。

どんな場面で使う?

  • 設定に手間がかかるオブジェクトをコピーしてから調整する。
  • 文書、ゲームのユニット、設定などのテンプレート。
  • 出発点になる状態を取っておき、そこから多くのバリエーションを作る。

使わなくてよいとき

  • 一から作っても手間のかからないオブジェクト:コンストラクターを呼べば済みます。
  • 開いたファイルや接続など、コピーすべきでないリソースを持つオブジェクト。

サンプルコード

コードを実行 →
main.py
from copy import copy


# Prototype: clone an existing configured object.
class Document:
    def __init__(self, status):
        self.status = status

    def clone(self):
        # Return a shallow copy of this configured object.
        return copy(self)


draft = Document("Draft")
published = draft.clone()
published.status = "Published"
print(draft.status)
print(published.status)
この例の実行ボタンを作成

実行結果

Draft
Published

コードの解説

clone()メソッドはcopy()関数を使って、Documentオブジェクトの独立したコピーを作ります。コピーの状態をPublishedに変えても、元のオブジェクトはDraftのままです。copy()は浅いコピー(shallow copy)しか作らない点に注意してください。オブジェクトの中にリストや辞書がある場合は、deepcopy()が必要になることがあります。

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

発展問題

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

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

よくある間違い

入れ子のデータに浅いコピーを使う

copy() では内側のリストが共有されるので、コピー側のリストを変えると元のリストも変わります。

問題
from copy import copy
clone = copy(document)  # document.tags is shared
修正
from copy import deepcopy
clone = deepcopy(document)

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

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