Pythonの弱参照（weakref）モジュールの使い方を徹底解説

Pythonで弱参照（Weak Reference）を作成するには、標準ライブラリの weakref モジュールを使用します。弱参照はオブジェクトを生存させ続ける力を持たない参照であり、その主な用途として、大きなオブジェクトに対するキャッシュやマッピングの実装が挙げられます。

weakrefモジュールのインポート

このモジュールを使うには、まず以下のようにインポートします。

import weakref

なお、すべてのオブジェクトが弱参照をサポートしているわけではありません。例えば tuple や int といった一部の組み込み型は弱参照に対応していません。そのため、通常は独自に定義したクラスのインスタンスに対して使用します。

weakrefモジュールの主要なクラスとメソッド

weakref.ref(object[, callback])

指定したオブジェクトへの弱参照を返すクラスです。参照先のオブジェクトがまだ生存している場合、弱参照オブジェクトを呼び出すことで元のオブジェクトを取得できます。一方、オブジェクトがすでに破棄されている場合は None が返されます。

weakref.proxy(object[, callback])

弱参照を利用するプロキシ（代理オブジェクト）を返すメソッドです。戻り値は ProxyType または CallableProxyType のいずれかになります。プロキシを使うと、元のオブジェクトと同じように属性やメソッドへ直接アクセスできるのが特徴です。

weakref.getweakrefcount(object)

指定したオブジェクトに紐づく弱参照およびプロキシの数を返すメソッドです。

weakref.getweakrefs(object)

指定したオブジェクトに関連付けられた弱参照およびプロキシオブジェクトのリストを返すメソッドです。

サンプルコード

以下の例では、list を継承したクラスのインスタンスに対して、弱参照・プロキシを作成し、それぞれの動作を確認しています。

import weakref
class my_list(list):
   pass
new_list = my_list('String') # my_listクラスでリストを定義
print(new_list)
weak_ref = weakref.ref(new_list)
new_weak_list = weak_ref()
new_proxy = weakref.proxy(new_list)
print(new_weak_list)
print('The object using proxy: ' + str(new_proxy))
if new_list is new_weak_list:
   print("There is a weak reference")
print('The Number of Weak references: ' + str(weakref.getweakrefcount(new_list)))
del new_list, new_weak_list # 両方のオブジェクトを削除
print("The weak reference is: " + str(weak_ref()))

実行結果

['S', 't', 'r', 'i', 'n', 'g']
['S', 't', 'r', 'i', 'n', 'g']
The object using proxy: ['S', 't', 'r', 'i', 'n', 'g']
There is a weak reference
The Number of Weak references: 2
The weak reference is: None

この実行結果から、del によって元のオブジェクトが破棄されると、弱参照を呼び出しても None が返されることがわかります。これにより、メモリリークを防ぎながらオブジェクトへの一時的なアクセスを実現できます。キャッシュ機構や大規模データの一時保持など、メモリ効率が重要な場面で活用すると効果的です。