UnboundLocalErrorの解決方法

Pythonを使っているときに遭遇する可能性のあるエラーのひとつに、「UnboundLocalError: local variable ‘x’ referenced before assignment」があります。このエラーは、特に関数内でローカル変数とグローバル変数を混同して使用した場合に発生します。本記事では、このエラーの発生原因、具体例、解決方法、そしてベストプラクティスについて解説します。

UnboundLocalError とは
1. 発生例
原因
解決方法
問題解決のための最善手
まとめ

UnboundLocalError とは

「UnboundLocalError」は、Pythonが変数を参照しようとした際、その変数がローカルスコープ内で初期化されていない場合に発生するエラーです。特に、関数内で同じ名前の変数がグローバルスコープとローカルスコープの両方で使用されている場合に、混乱が起きやすいです。

発生例

以下のコードを見てみましょう:

x = 10

def my_function():
    print(x)  # ここでエラーが発生
    x = 5

my_function()

このコードを実行すると、次のエラーが発生します:

UnboundLocalError: local variable 'x' referenced before assignment

一見、グローバル変数xを参照しているように見えますが、Pythonは関数内でxがローカル変数として扱われるため、このようなエラーが発生します。

原因

このエラーが発生する理由は、Pythonのスコープ解決ルール（LEGBルール）にあります。

L (Local): 現在の関数内のスコープ。
E (Enclosing): 外側の関数のスコープ（クロージャ内）。
G (Global): モジュールレベルのスコープ。
B (Built-in): 組み込みスコープ。

関数内で変数に値を代入すると、その変数はローカルスコープ内で定義されたものと見なされます。そのため、代入が行われる前に参照しようとするとエラーになります。

解決方法

方法1: global キーワードを使用する

グローバル変数を関数内で使用する場合は、明示的にglobalキーワードを指定します。

x = 10

def my_function():
    global x
    print(x)  # グローバル変数 x を参照
    x = 5

my_function()

方法2: ローカル変数として初期化する

ローカル変数として使用する場合は、参照する前に適切に初期化します。

def my_function():
    x = 10  # 初期化
    print(x)
    x = 5

my_function()

方法3: 関数の引数として値を渡す

関数に値を引数として渡すことで、明示的に変数を扱うことができます。

def my_function(x):
    print(x)
    x = 5

my_function(10)

問題解決のための最善手

変数のスコープを明確にする: グローバル変数とローカル変数を混在させないように設計しましょう。モジュール全体で共有する値が必要な場合は、可能であれば関数の引数や戻り値を活用するようにします。
global の多用を避ける: globalキーワードは便利ですが、多用するとコードの可読性が低下し、バグが発生しやすくなります。
関数を短く保つ: 関数が長くなりすぎるとスコープの把握が難しくなるため、単一の責務に集中した短い関数を書くよう心がけましょう。