Pythonデザインパターン

PythonのFlyweightパターン

このレッスンでは、Flyweightパターンを使って、たくさんの小さなオブジェクトでデータを共有し、メモリを節約します。

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

はじめに

どんな問題を解決するか

テキストエディターは100万文字を表示し、ゲームは何千本もの木を描くことがあります。データのほとんどが同じなのに、1つ1つに完全なオブジェクトを作ると、メモリが無駄になります。Flyweight は共通部分を共有します。

身近なたとえ

Flyweight はポスター用のスタンプセットのようなものです。A の文字が出てくるたびに彫り直すのではなく、A のスタンプを1つだけ用意して、必要な場所に押していきます。変わるのは押す位置だけで、スタンプは使い回します。

スタンプセットからコードへ
Glyph(character)🔠 文字ごとに1つのスタンプ
_cache🗃️ すでに作ったスタンプの箱
setdefault(character, ...)🔍 あれば再利用し、なければ作る
first is second✅ 2つの A は同じスタンプ:True
繰り返し出てくる部分は共有し、場面ごとに違う部分は使うときに渡します。
ひと言でいうと

Flyweight パターンは、中身が同じデータ(内在データ)を使う場面すべてで、1つのオブジェクトを共有するパターンです。位置のように場面ごとに変わるデータは、共有オブジェクトの外に置きます。

重要なポイント

  1. Glyph は共有するデータ、つまり文字だけを持ちます。
  2. _cache は文字ごとに1つの glyph を保存するクラスレベルの辞書です。
  3. self._cache.setdefault(character, Glyph(character)) は保存済みの glyph を返すか、新しいものを保存します。
  4. "A" で2回呼び出しても同じオブジェクトが返るので、first is second は True です。

どんな場面で使う?

  • 文書の文字、ゲームのタイルや木など、似たオブジェクトが膨大にある場合。
  • オブジェクトのデータの大部分が重複しているときに、メモリ使用量を減らす。
  • プログラムのあちこちで使うイミュータブルな(変更されない)値をキャッシュする。

使わなくてよいとき

  • オブジェクトが少ない場合:キャッシュは複雑さを増すだけで、ほとんど節約になりません。
  • 共有オブジェクトを呼び出し側が変更する場合:1つの変更がすべての使用箇所に影響します。

サンプルコード

コードを実行 →
main.py
class Glyph:
    # Flyweight: share repeated intrinsic state between many uses.
    def __init__(self, character): self.character = character


class GlyphFactory:
    _cache = {}

    def get(self, character):
        # Reuse immutable intrinsic state.
        return self._cache.setdefault(character, Glyph(character))


factory = GlyphFactory()
first = factory.get("A")
second = factory.get("A")
print(first is second)
print(first.character)
この例の実行ボタンを作成

実行結果

True
A

コードの解説

GlyphFactoryは、Glyphオブジェクトをキャッシュとして使う辞書に保存します。setdefault()メソッドは、その文字がまだキャッシュにないときだけ新しいGlyphを作ります。そのため、factory.get("A")を2回呼ぶとまったく同じオブジェクトが返り、first is secondの比較はTrueになります。

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

発展問題

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

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

よくある間違い

共有オブジェクトに個別のデータを保存する

glyph に自分の位置を持たせてしまうと、共有しているせいで位置がごちゃ混ぜになります。

問題
glyph = factory.get("A")
glyph.x = 10  # changes every A
修正
glyph = factory.get("A")
draw(glyph, x=10, y=20)

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

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