Pythonデザインパターン

PythonのSingletonパターン

このレッスンでは、Singletonパターンを実装し、クラスのオブジェクトが共有される1つだけになるようにします。

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

はじめに

どんな問題を解決するか

プログラムの中に1つだけあるべきものがあります。アプリの設定、コネクションプール、1つのファイルに書き込むロガーなどです。コードの各部分が自分のコピーを作ると、設定がずれ、資源も無駄になります。

身近なたとえ

シングルトンは、校舎にたった1つある学校のチャイムのようなものです。どの教室も同じチャイムを鳴らし、自分専用のチャイムを付ける人はいません。どこで「チャイム」と言っても、いつも同じ1つのチャイムが返ってきます。

学校のチャイムからコードへ
_instance = None🔔 まだチャイムがない
if cls._instance is None:🔧 最初に誰かが求めたときに取り付ける
return cls._instance🔁 その後は誰もが同じチャイムを使う
first is second✅ 2回求めても1つのオブジェクト:True
どの呼び出しも同じオブジェクトを返します。
ひと言でいうと

Singleton パターンは、クラスが作られるたびに同じ1つのインスタンスを返すようにし、プログラムに共有のオブジェクトを1つ与えます。

重要なポイント

  1. _instance は共有の1つのオブジェクトを保存するクラス属性です。
  2. __new__ は Python がオブジェクトを作るときに呼ぶメソッドで、_instance がまだ None のときだけオブジェクトを作ります。
  3. cls._instance.theme = "dark" は共有オブジェクトを1回だけ設定します。
  4. first is second は True です。両方の名前がまったく同じオブジェクトを指しています。

どんな場面で使う?

  • すべてのモジュールが読む、アプリ全体の設定。
  • キャッシュ、ロガー、コネクションプールなどの共有資源。
  • __new__ がオブジェクトの生成をどう制御するかを学ぶ。

使わなくてよいとき

  • ほとんどの Python コード:モジュールレベルのオブジェクト(モジュールは1回しか作られない)のほうが簡単で、同じ役割を果たします。
  • テストしやすくしたいコード:隠れたグローバルな状態があるとテストが互いに依存するので、オブジェクトを渡すようにします。

サンプルコード

コードを実行 →
main.py
class AppConfig:
    # Singleton: every caller receives one shared configuration object.
    _instance = None

    def __new__(cls):
        # Create the shared instance only on the first call.
        if cls._instance is None:
            cls._instance = super().__new__(cls)
            cls._instance.theme = "dark"
        return cls._instance


first = AppConfig()
second = AppConfig()
print(first is second)
この例の実行ボタンを作成

実行結果

True

コードの解説

__new__メソッドは、オブジェクトを作るたびに__init__より先に呼ばれます。最初の呼び出しでは_instanceがまだNoneなので、オブジェクトを作って保存します。2回目以降、__new__は保存したオブジェクトをそのまま返すだけなので、2つのオブジェクトをisで比べるとTrueになります。

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

発展問題

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

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

よくある間違い

__init__ で状態を設定する

__init__ は呼び出しのたびに実行されるので、毎回共有オブジェクトをリセットしてしまいます。

問題
def __init__(self):
    self.theme = "dark"  # runs again for every AppConfig()
修正
if cls._instance is None:
    cls._instance = super().__new__(cls)
    cls._instance.theme = "dark"

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

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

チャレンジで練習する

このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。

すべてのチャレンジ