Pythonで関数内のローカル変数の数を取得する方法

本記事では、次の問題に対する解決策について学びます。

問題の概要

ある関数が与えられたとき、その関数内に存在するローカル変数の数を表示する必要があります。

解決方法

Pythonでは、関数オブジェクトが持つ __code__ 属性の co_nlocals を参照することで、関数内のローカル変数の数を簡単に取得できます。それでは、実際の実装例を見ていきましょう。

例1

# ローカル変数の確認
def scope():
    a = 25.5
    b = 5
    str_ = 'Tutorialspoint'

# メイン処理
print("利用可能なローカル変数の数:",
      scope.__code__.co_nlocals)

出力

利用可能なローカル変数の数: 3

例2

# ローカル変数の確認
def empty():
    pass

def scope():
    a, b, c = 9, 23.4, True
    str = 'Tutorialspoint'

# メイン処理
print("利用可能なローカル変数の数:", empty.__code__.co_nlocals)
print("利用可能なローカル変数の数:", scope.__code__.co_nlocals)

出力

利用可能なローカル変数の数: 0
利用可能なローカル変数の数: 4

補足説明

co_nlocals はコードオブジェクトが持つ属性の一つで、関数内で定義されたローカル変数（引数を含む）の数を整数値として返します。例2のように、pass のみで何も処理しない関数の場合は 0 が返されます。また、a, b, c = 9, 23.4, True のように一度に複数の変数へ代入した場合でも、それぞれが個別のローカル変数としてカウントされる点に注意してください。

まとめ

本記事では、Pythonプログラムを使って関数内のローカル変数の数を取得する方法を学びました。__code__.co_nlocals を活用すれば、たった一行のコードでローカル変数の数を確認できるため、デバッグやコード解析の際にも非常に便利です。