HOWTO · Python
Python で文字列を変数名に変換する
この記事では、Python で文字列値を変数名に変換するさまざまな方法について説明します。
このページの内容
Python では、通常の変数への代入で、左辺の名前として文字列の値が使われることはありません。実行時に名前を作成したりアクセスしたりするには、その名前を保持すべき名前空間を選びます。モジュールレベル変数には globals()、ローカル名の検査には locals()、生成したソースコードには exec()、オブジェクト属性には setattr() を使い、名前が実質的にデータである場合には辞書を使います。
注意: 動的な変数名は依存関係を見えにくくし、名前空間を汚染し、作成されていない名前をコードが読み取ると
NameErrorを発生させる可能性があります。本番ソフトウェアでは最善の選択になることはほとんどありません。実際のグローバル変数やオブジェクト属性が必要な場合を除き、辞書を優先してください。
Python で globals() と locals() を使用して文字列を変数名に変換する
組み込みの globals() 関数は、現在のグローバルシンボルテーブルの辞書を返します。その辞書は、各グローバル変数の名前をその値に対応付けます。モジュールスコープでは、この辞書を通じて新しいキーを書き込むと、その文字列を名前とする実際のグローバル変数が作成されます。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
def create_global_variable(name, value):
globals()[name] = value
variable_name = "dynamicGlobalVar"
variable_value = 10
create_global_variable(variable_name, variable_value)
print(dynamicGlobalVar)
10
この関数は name 引数として "dynamicGlobalVar" を受け取り、グローバルシンボルテーブル内のそのキーに 10 を格納します。その後の式 dynamicGlobalVar が機能するのは、モジュールにその正確な名前のグローバル変数ができたためです。ソースコードが名前でアクセスする場合、文字列は有効な Python 識別子でなければなりません。そうでない場合は globals()[name] で取得してください。
グローバル名は読み取る前に作成しておく必要があります。先に dynamicGlobalVar をグローバルシンボルテーブルへ追加していなければ、最後の行は NameError を送出します。実際のコードでは、プログラム全体に未検証の文字列を埋め込むのではなく、書き込みには variable_name のような変数を使うことを推奨します。
locals() を使用してローカル変数にアクセスする
locals() 関数は、現在のローカルシンボルテーブルを表すマッピングを返します。関数内では、文字列に保持されたローカル名を検索するのに便利です。
def demonstrate_locals():
temp_var = "Dynamic Content"
name = "temp_var"
return locals().get(name)
print(demonstrate_locals())
Dynamic Content
ここで locals().get(name) は、関数の実行中に "temp_var" を解決し、既存のローカル変数の値を返します。.get() を使う方が、要求した名前が存在しないときに None を返すため、マッピングを直接インデックス指定するより安全です。
locals()[name] = value に頼って関数ローカル変数を作成しないでください。Python の実装はローカル変数を最適化でき、返されたマッピングへの書き込みがインタプリタの実際のローカル束縛を更新することは必須ではありません。locals() は主に検索と検査のためのツールとして扱い、書き込み可能な動的な名前が必要な場合は globals()、setattr()、または辞書を使ってください。
Python で exec() を使用して文字列を変数名に変換する
exec() 関数は、文字列として渡された Python ソースコードを実行します。その文字列に代入が含まれている場合、それを実行すると現在の実行コンテキストに対応する変数が作成されます。
このセクションのコードと表示されるラベルや出力は英語のままです。
variable_name = "dynamicVar"
value = 42
exec(f"{variable_name} = {value}")
print(dynamicVar)
42
f文字列はソーステキスト dynamicVar = 42 を構築し、exec() がその代入を実行します。モジュールレベルでは、結果として dynamicVar という名前の新しいグローバル変数が作成されます。数値以外の値を挿入する場合は、repr() または同等の書式設定を使い、生成されるソースに有効な Python リテラルが含まれるようにしてください。
exec() は、文字列に単一の代入だけでなく、ループ、インポート、関数定義、任意の呼び出しを含められるため強力です。その強力さは、主な危険でもあります。ユーザーが制御するテキストやその他の信頼できないテキストを exec() に渡さないでください。悪意のある名前や値の断片だけでも、有害なコードを実行する可能性があります。locals() と同様に、exec() も最適化された関数ローカル変数を更新する手段としては信頼できません。そのため、この手法はモジュールスコープまたは明示的な名前空間辞書で使うのが最も明確です。
Python で setattr() を使用して文字列を変数名に変換する
目的の「変数」が実際にはオブジェクト、クラス、またはモジュール上の属性である場合、setattr() が適切な手段です。これは、オブジェクト、文字列としての属性名、および代入する値を受け取ります。
このセクションのコードと表示されるラベルや出力は英語のままです。
class Settings:
pass
settings = Settings()
attribute_name = "theme"
attribute_value = "dark"
setattr(settings, attribute_name, attribute_value)
print(settings.theme)
dark
この呼び出しは settings.theme = "dark" と同等ですが、属性名が実行時に attribute_name から供給される点が異なります。これは、設定オブジェクト、レコード、プラグインフックなど、名前空間オブジェクトがすでに設計の一部になっている場面で役立ちます。
setattr() は通常のモジュール変数や関数変数を作成しません。対象オブジェクトの属性名前空間を更新します。値を動的に読み取るには getattr(settings, attribute_name) を使い、フォールバックが必要な場合は getattr(settings, attribute_name, default_value) を使います。
Python で動的な変数名の代わりに辞書を使用する
プログラムが実行時にしか分からない名前で値を保存する場合、通常は辞書が最も明確な答えです。文字列はキーのままなので、動的な名前の集合は明示的で検査しやすい状態に保たれます。
このセクションのコードと表示されるラベルや出力は英語のままです。
dynamic_vars = {}
var_name = "temperature"
var_value = 23
dynamic_vars[var_name] = var_value
print(dynamic_vars["temperature"])
23
これは、temperature という名前の変数が 23 を保持するのと同じ関連付けを作成しますが、Python の名前空間に名前を追加しません。キーは一覧表示、別の関数への受け渡し、シリアライズ、削除ができ、globals() 内の予期しないエントリを探す必要はありません。
辞書のキーは Python の識別子ルールにも制限されないため、"daily total" のような名前をデータとして使用できます。必須のキーには dynamic_vars[var_name] でアクセスするか、存在しないキーに失敗ではなくフォールバックを返させたい場合は dynamic_vars.get(var_name) を使います。プログラムがソースレベルの変数を解決するのではなくデータ構造を照会するため、これにより NameError の処理を回避できます。
まとめ
Python には、実行時の文字列を使用可能な名前に変える方法がいくつかあります。globals() はグローバルシンボルテーブルを通じて実際のモジュールレベル変数を作成できます。locals() はローカル名を検索できますが、書き込み手段としては信頼できません。exec() は生成した代入を実行できますが、セキュリティと明確さのリスクが最も大きくなります。動的な名前がオブジェクトやモジュールに属する場合は setattr() が適しています。
ほとんどのプログラムでは、辞書が最も安全で保守しやすい選択肢です。辞書は動的な名前をデータとして保持し、Python の名前空間の汚染を避け、名前がない場合の動作を明示的にします。実際の動的変数や属性は、それが本当に必要な設計に限定してください。