pythonの関数内での変数宣言につけるselfの意味について

Question

二分木の高さを求める以下のコードで、#####の箇所について疑問があります。
self.max_depth=0
の部分ですが、selfがあることで、
" local variable 'max_depth' referenced before assignment "
のエラーが出なくなります。なぜ、selfをつけるとこのエラーを回避できるのでしょうか。
イニシャライズと同じようなことをやっているようにも思いますが、
def ____init____で定義されているわけではないので、単なる変数の宣言と
同じと考えました。しかし、そうであるなら、なぜ上記のエラーが出ないのかわかりません。

def maxDepth(self, root: Optional[TreeNode]) -> int:
    self.max_depth=0 #####
    def helper(node: TreeNode, depth: int):
        if not node:
            return 0
            
        if not node.left and not node.right:
            self.max_depth = max(self.max_depth, depth)　###
        else:
            helper(node.left, depth + 1)
            helper(node.right, depth + 1)
            
    helper(root, 1)
    return self.max_depth

言葉足らずでした。ehshellさんがおっしゃる通り、全てのselfを外すという解釈で正しいです。
その時の" local variable 'max_depth' referenced before assignment "エラーは、
当然ですが###の部分で出ます。
selfを外すと、max_depthローカル変数として扱われるということはわかりました。

ただ、self.max_depth=0 は、maxDepth関数内で宣言されています。
グローバル変数は、関数外でイニシャライズするものとばかり思っていたのですが、
上記のような形で、グローバル変数をイニシャライズすることも多いのでしょうか。
例えば今回の場合では、`

def __init__(self):
    self.max_depth = 0
    
def maxDepth(self, root: Optional[TreeNode]) -> int:
    #以下、略

のようにするのが作法と思っていましたが、そうでもないのでしょうか。

Answer 1

根本的な問題として、maxDepthが関数かメソッドなのかは置いておいて、値を返すだけでなく引数の属性を変更あるいは追加しているということに注意が必要です。
勝手にself.max_depthをmax_depthに変更すると、戻り値が返ったとしても、引数の属性(self.max_depth)は想定通りの値が入っていません。呼び出し側が後でself.max_depthを使おうとしてもそれが使えませんので、全体として正しく動く保証がなくなります。

とりあえず、上記のことが絶対に起こらないという前提で考えてみます。

これはメソッドの話なのかメソッドの話ではないのかはっきりしていませんが、いずれにしてもインスタンス変数かどうかとは関係ない話です。

selfという名前を使うと、インスタンス変数特有の話をしているように見えて誤解を生じやすいのでarg0という名前に変更して説明します。

def maxDepth(arg0, root: Optional[TreeNode]) -> int:
    arg0.max_depth=0 #####
    def helper(node: TreeNode, depth: int):
        if not node:
            return 0

        if not node.left and not node.right:
            arg0.max_depth = max(arg0.max_depth, depth)  ###
        else:
            helper(node.left, depth + 1)
            helper(node.right, depth + 1)

    helper(root, 1)
    return arg0.max_depth

arg0関数はmaxDepthの引数です。関数helper内を含めて関数maxDepthのどこからでも参照できます。

8行目の

            arg0.max_depth = max(arg0.max_depth, depth)

の右辺のarg0.max_depthは、arg0という名前の変数(引数)のmax_depthという属性です。
関数helper内でarg0を参照することは何も問題はありません。

全てのarg0.max_depthをmax_depthに変更した場合、

def maxDepth(arg0, root: Optional[TreeNode]) -> int:
    max_depth=0 #####
    def helper(node: TreeNode, depth: int):
        if not node:
            return 0

        if not node.left and not node.right:
            max_depth = max(max_depth, depth)  ###
        else:
            helper(node.left, depth + 1)
            helper(node.right, depth + 1)

    helper(root, 1)
    return max_depth

2行目のmax_depthは関数maxDepthの変数となります。ここで定義をしているのでローカル変数と解釈されます。
関数helper内のmax_depthは変数となり、ここで定義をしているのでローカル変数と解釈されます。すると右辺で参照しているので未定義の変数を使おうとしていることになってエラーとなります。

詳しくは、4.2. 名前づけと束縛 (naming and binding)をお読みください。

これは、maxDepthがメソッドの場合でも同じです。

Comments

[fu_3823]

ありがとうございました。selfをarg0とした説明で理解が進みました。

Answer 2

selfを入れないとどの部分でエラーになるのか不明ですが、推測してみます。

その1
インスタンス変数は、__init__関数でなくても任意の関数内で作ることができます。

その2
クラス内の関数であっても、selfの付いていない変数やglobalなどの宣言をしていない変数はその関数内のローカルな変数なので、その関数の外からは参照できません。

その3
どんな変数、インスンス変数でもクラス変数でもローカル変数でもグローバル変数でも、定義前に参照すれば「referenced before assignment」と怒られます。

参照というのは、代入の右辺に置いたり「 max(self.max_depth, depth)」のように引数で使うなどして、値を使うことです。

Answer 3

二分木の高さを求める以下のコードで、#####の箇所について疑問があります。
self.max_depth=0
の部分ですが、selfがあることで、
" local variable 'max_depth' referenced before assignment "
のエラーが出なくなります。なぜ、selfをつけるとこのエラーを回避できるのでしょうか。

self.max_depth=0 #####
だけの self を付けないと
" local variable 'max_depth' referenced before assignment "
が出るのではなく４ヶ所の self.max_depth を max_depth にすると出るという前提で説明します。
４ヶ所の self.max_depth が max_depth の場合は
helper 関数内で
max_depth = max(max_depth, depth)
と max_depth に代入するため max_depth は helper 関数のローカル変数になります。
（外側のスコープにある maxDepth 関数の max_depth 変数ではありません）
そのため max(max_depth, depth) でまだ代入されていない max_depth を参照してしまいます。
そのため " local variable 'max_depth' referenced before assignment " のエラーが出ます。
helper 関数内で max_depth に代入せず単に max_depth を参照するだけであれば外側のスコープにある maxDepth 関数の max_depth にアクセスできます。

対して self.max_depth の場合は helper 関数内で self.max_depth に代入しようがしまいが maxDepth 関数の引数の self の max_depth にアクセスします。

追加質問の回答

ただ、self.max_depth=0 は、maxDepth関数内で宣言されています。
グローバル変数は、関数外でイニシャライズするものとばかり思っていたのですが、
上記のような形で、グローバル変数をイニシャライズすることも多いのでしょうか。

self.max_depth はグローバル変数ではありません。
self.max_depth=0 は 元々 self.max_depth が定義されていなければここで self のインスタンス変数を定義しています。

def __init__(self):
    self.max_depth = 0

と

def maxDepth(self, root: Optional[TreeNode]) -> int:
    self.max_depth = 0

の違いの例を示します。引数を少なくした例にしています。

まず __init__ と maxDepth が単なる関数の場合

def __init__(self):
    self.max_depth = 0

def maxDepth(self):
    print(self.max_depth)

class Goo:
    pass

g = Goo()
__init__(g)
maxDepth(g)
g2 = Goo()
maxDepth(g2)   # AttributeError: 'Goo' object has no attribute 'max_depth'

そして __init__ と maxDepth がクラス内のメソッドの場合（本来質問時に明示すべきです）

class Foo:
    def __init__(self):
        self.max_depth = 0

    def maxDepth(self):
        print(self.max_depth)

f = Foo()
f.maxDepth()

は問題なく

class Foo:
    def __init__(self):
        pass

    def maxDepth(self):
        self.max_depth = 0
        print(self.max_depth)

    def minDepth(self):
        print(self.max_depth)

f = Foo()
f.maxDepth()
f.minDepth()

も問題ないように見えますが、実際は

class Foo:
    def __init__(self):
        pass

    def maxDepth(self):
        self.max_depth = 0
        print(self.max_depth)

    def minDepth(self):
        print(self.max_depth)

f = Foo()
f.minDepth()  # AttributeError: 'Foo' object has no attribute 'max_depth'

と maxDepth を呼び出さずに minDepth を呼び出すと問題になります。