Pythonの関数説明　locals()

2023年9月15日

locals() は、Pythonの組み込み関数の1つで、現在のローカルスコープ内で定義された変数とその値を含む辞書を返すために使用されます。ローカルスコープは、関数内部で定義された変数が存在するスコープを指します。

locals() 関数の構文は以下の通りです:

python
locals()

locals() 関数は引数を取らずに呼び出すため、単純に現在のローカルスコープ内の変数とその値を辞書として返します。

以下は
locals() 関数の例です:

python
def example_function():
    name = "Alice"
    age = 30
    local_variables = locals()
    return local_variables

result = example_function()
print(result)

この例では、
example_function() 内で変数
name と
age が定義され、
locals() 関数を使用してローカルスコープ内の変数とその値を取得しています。結果は辞書として表示されます。

locals() 関数の主な特徴と注意点:

• ローカルスコープ内の変数:
  locals() 関数は、現在のローカルスコープ内で定義された変数を辞書として返します。これには関数内で定義された変数や引数も含まれます。

• 辞書のコピー:
  locals() から返される辞書は、現在のローカルスコープ内の変数のコピーです。変数の値を変更しても、実際のローカル変数には影響を与えません。

• インタラクティブシェルでの使用:
  locals() 関数は主にスクリプト内ではなく、インタラクティブシェルやデバッグの際に使用され、現在のスコープ内の変数を調査するのに役立ちます。

• グローバルスコープでは使用できない:
  locals() 関数は現在のローカルスコープ内の変数を取得するため、グローバルスコープや他の関数のスコープからは使用できません。

locals() 関数は主にデバッグやスクリプト内での一時的な変数の表示など、開発とデバッグの目的に使用されます。プログラム内で動的な情報を調べる際に役立ちます。