Pythonのコンテキスト変数（ContextVar）の使い方を徹底解説

コンテキスト変数とは

コンテキスト変数（Context Variable）は、その変数が属する「コンテキスト」に応じて異なる値を持つことができる特殊な変数です。スレッドローカルストレージ（Thread-Local Storage）では実行スレッドごとに変数が異なる値を持ちますが、コンテキスト変数の場合は、1つの実行スレッドの中に複数のコンテキストが存在しえます。この特性により、並行して実行される非同期タスクにおいて変数を管理・追跡する際に非常に有用です。

ContextVarクラスによる宣言

コンテキスト変数の宣言や操作には、contextvarsモジュールのContextVarクラスを使用します。

import contextvars
name = contextvars.ContextVar("name", default = 'Hello')

第2引数のdefaultは省略可能で、現在のコンテキスト内にその変数の値が見つからなかった場合、ContextVar.get()はこのデフォルト値を返します。

name： 変数の名前を表す読み取り専用プロパティです。

ContextVarクラスの主なメソッド

Contextクラス

contextvarsモジュールのContextクラスは、コンテキスト変数とその値のマッピング（対応関係）を表します。

Context()： 値を一切持たない空のコンテキストを生成します。

現在のコンテキストのコピーを取得するには、copy_context()関数を使用します。

run()メソッド

run(callable, *args, **kwargs)メソッドは、呼び出し元のコンテキストオブジェクト内でcallable(*args, **kwargs)というコードを実行し、その結果を返します。callableがコンテキスト変数に対して行った変更は、すべてそのコンテキストオブジェクト内に閉じ込められます。なお、同一のコンテキストオブジェクトに対して複数のOSスレッドから同時に呼び出した場合や、再帰的に呼び出した場合にはRuntimeErrorが発生する点に注意してください。

Contextオブジェクトのメソッド一覧