【Python】locals関数の使い方　locals関数を使ったソースコードをみてみよう！ デバッグが捗る関数です。

はじめに

Pythonでプログラミングを行う際に、各種の組み込み関数を利用することが一般的です。

その中でも今回は、locals()関数について詳しく説明します。

locals関数とは？

Pythonのlocals関数は、現在の名前空間の中に存在するローカル変数を辞書型で返す関数です。

名前空間とは、変数や関数、クラスなどの名前が存在する範囲のことを指します。

locals関数の基本的な使い方

step
1locals関数の基本的な使い方

 出力結果
{'local_var': "I'm local!"}

この例では、関数test_func内で定義したローカル変数local_varが、locals()関数によって取得されています。

出力結果は辞書型となり、その中にローカル変数名とその値が格納されています。

locals関数を用いたデバッグ

step
2locals関数を用いたデバッグ

locals関数は、プログラムのデバッグ時に特に有用です。

プログラムの特定の部分でどのようなローカル変数が存在し、その値が何であるかを確認することができます。

 出力結果
{'var1': 'Hello', 'var2': 123, 'var3': [1, 2, 3]}

このコード例では、debug_func関数内の3つのローカル変数の値が、locals関数によって一度に取得されています。

デバッグ時に各変数の値を一つ一つprint関数で表示させる代わりに、locals関数を用いることで効率的に変数の値を確認できます。

locals関数の注意点

step
3locals関数の注意点

しかし、locals関数を使う際には注意が必要です。

特に、この関数が返す辞書を変更すると予期しない動作を引き起こす可能性があります。

Pythonの公式ドキュメンテーションでも、locals関数が返す辞書の変更は「サポートされていない」と明記されています。

 出力結果
name 'new_var' is not defined

このコードでは、locals関数が返す辞書に新しい項目を追加しようとしています。

しかし、その後で新しい変数を参照しようとすると、変数が定義されていないというエラーが出ます。

このように、locals関数が返す辞書を変更しようとすると予期せぬエラーを引き起こす可能性があるため、注意が必要です。

まとめ

今回はPythonのlocals関数について学びました。

ローカル変数を一覧表示したいときやデバッグに利用することができますが、関数が返す辞書を変更すると予期せぬエラーを引き起こす可能性があるため注意が必要です。

最後まで読んで頂き、ありがとうございました。少しでもお役にたてたなら幸いです！