Pythonデザインパターン
PythonのSingletonパターン
このレッスンでは、Singletonパターンを実装し、クラスのオブジェクトが共有される1つだけになるようにします。
はじめに
どんな問題を解決するか
プログラムの中に1つだけあるべきものがあります。アプリの設定、コネクションプール、1つのファイルに書き込むロガーなどです。コードの各部分が自分のコピーを作ると、設定がずれ、資源も無駄になります。
身近なたとえ
シングルトンは、校舎にたった1つある学校のチャイムのようなものです。どの教室も同じチャイムを鳴らし、自分専用のチャイムを付ける人はいません。どこで「チャイム」と言っても、いつも同じ1つのチャイムが返ってきます。
学校のチャイムからコードへ
_instance = None🔔 まだチャイムがないif cls._instance is None:🔧 最初に誰かが求めたときに取り付けるreturn cls._instance🔁 その後は誰もが同じチャイムを使うfirst is second✅ 2回求めても1つのオブジェクト:Trueひと言でいうと
Singleton パターンは、クラスが作られるたびに同じ1つのインスタンスを返すようにし、プログラムに共有のオブジェクトを1つ与えます。
重要なポイント
_instanceは共有の1つのオブジェクトを保存するクラス属性です。__new__は Python がオブジェクトを作るときに呼ぶメソッドで、_instanceがまだ None のときだけオブジェクトを作ります。cls._instance.theme = "dark"は共有オブジェクトを1回だけ設定します。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コンパイラで実行できます。
発展問題
下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。
- パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
- パターンをより単純な実装と比較し、トレードオフを説明してください。
- 別の実装を追加する前に、各参加要素のテストを書いてください。
よくある間違い
__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 のレビューも受けられます。
すべてのチャレンジ