インスタンス変数とクラス変数について

Question

こちらでクラス変数とインスタンス変数について、調べていたのですが、分からないことがあり質問させて貰いました。

class TestClass(object):
    common_var = "Initial Value"
    def get_variable(self):
        return self.common_var
    def set_variable(self, value):
        self.common_var = value

tc1 = TestClass()
tc2 = TestClass()
tc1.set_variable("Set Variable")
print(tc2.common_var)

>>> Initial Value

class TestClass(object):
    common_var = []
    def get_variable(self):
        return self.common_var
    def set_variable(self, value):
        self.common_var.append(value)

tc1 = TestClass()
tc2 = TestClass()
tc1.set_variable("Set Variable")
print(tc2.common_var)

>>> ['Set Variable']

こちら２つのコードの内、下側のコードなのですが、上側のコードとほとんど処理の流れとしましては、同じかと思います。
print(tc2.common_var)こちらの結果なのですが、tc2インスタンスのプロパティであるはずの、common_varが['Set Variable']となるのは何故なのでしょうか？
どなたか、ご助言頂けましたら幸いです。

Answer 1

変数参照するとき、インスタンスに変数がなければクラス変数を探しにいきます。
代入は、インスタンスに代入します。

その様子を図にして、Qiitaのコメントに書いておきました。
https://qiita.com/msssgur/items/12992fc816e6adf32cff#comment-9244f5c1b6d7e194d59d

self.common_var = value

は、インスタンスの中に個別の common_var 変数を作って代入します。

self.common_var.append(value)

は

var = self.common_var
var.append(value)

と2段階に処理していて、self.common_var でオブジェクトを取り出して、取り出されたオブジェクトに対して value を append します。
インスタンス変数には common_var がないので、クラス変数の中から common_var を取り出し、クラス変数の中のリストオブジェクトに value が追加されます。

クラス変数辞書とインスタンス変数辞書を、代入前と代入後でprintして比較してみてください。

質問の下側のクラスでの確認：

class TestClass(object):
    common_var = []
    def get_variable(self):
        return self.common_var
    def set_variable(self, value):
        self.common_var.append(value)

tc1 = TestClass()
tc2 = TestClass()
print("TestClass variables:", vars(TestClass))
print("tc1 variables:", vars(tc1))
print("tc2 variables:", vars(tc2))
tc1.set_variable("Set Variable")
print(tc2.common_var)
print("TestClass variables:", vars(TestClass))
print("tc1 variables:", vars(tc1))
print("tc2 variables:", vars(tc2))

実行結果

TestClass variables: {'__module__': '__main__',, 'get_variable': <function TestClass.get_variable at 0x6fffffd0d730>, 'set_variable': <function TestClass.set_variable at 0x6fffffd0d7b8>, '__dict__': <attribute '__dict__' of 'TestClass' objects>, '__weakref__': <attribute '__weakref__' of 'TestClass' objects>, '__doc__': None
  'common_var': []}
tc1 variables: {}
tc2 variables: {}
['Set Variable']
TestClass variables: {'__module__': '__main__', 'get_variable': <function TestClass.get_variable at 0x6fffffd0d730>, 'set_variable': <function TestClass.set_variable at 0x6fffffd0d7b8>, '__dict__': <attribute '__dict__' of 'TestClass' objects>, '__weakref__': <attribute '__weakref__' of 'TestClass' objects>, '__doc__': None,
 'common_var': ['Set Variable']}
tc1 variables: {}
tc2 variables: {}

クラス変数とインスタンス変数の両方を定義する：

class TestClass(object):
    common_var = []  # クラス変数

    def __init__(self):
        self.common_var = []  # インスタンス変数

    def get_variable(self):
        return self.common_var

    def set_variable(self, value):
        self.common_var.append(value)

tc1 = TestClass()
tc2 = TestClass()
TestClass.common_var.append("Set Class Variable")
tc1.set_variable("Set Instance Variable 1")
tc2.set_variable("Set Instance Variable 2")
print(TestClass.common_var)
print(tc1.common_var)
print(tc2.common_var)

実行結果

['Set Class Variable']
['Set Instance Variable 1']
['Set Instance Variable 2']

Comments

[ruuuu]

ご回答ありがとうございます。
>インスタンスに変数がないのでクラス変数を参照します
インスタンスに変数がないとのことなのですが、提示させて頂きました下側のコードの「 common_var = []」こちらの部分が、インスタンスプロパティになるのではないのでしょうか?
tc1のcommon_varに対して、「.append」で値を追加している為、tc2へは影響がないのではないでしょうか...?

[shiracamus]

> common_var = []」こちらの部分が、インスタンスプロパティになるのではないのでしょうか?

それがクラス変数です。
self. がインスタンスプロパティです。
回答欄に print(vars(...)) の実行例を追記しましたので、それぞれの変数辞書に何が格納されるか確認してみてください。

[ruuuu]

ご返信ありがとうございます。
>それがクラス変数です。
self. がインスタンスプロパティです。
こちらなのですが、質問に記載させて頂きました上側のコードにも、「common_var = "Initial Value"」とあります。
こちらはクラス変数ではないということでしょうか...?
上側のコードにも、
「def set_variable(self, value):
self.common_var = value」
このように、「self」と書いてあります為、こちらの部分について、混乱してしまっている部分ではございます。

[shiracamus]

> こちらはクラス変数ではないということでしょうか...?

それもクラス変数です。

> self.common_var = value

これによって self. の インスタンス変数に value が登録されます。
self.common_var.append(value) は、self.common_var は参照しているだけで代入はしません。.append によってクラス変数のリストオブジェクトの中に追加されます。
回答欄に追記した print(vars(...)) によってその様子を確認できます。

[hayataka2049]

横からコメント。
クラス変数は、クラスのブロックの中で作られている変数のことです。
インスタンス変数は、
self.属性名 = なにか
のように代入されたときに作られるものです。
selfではどちらも参照できる仕組みになっています。
同名のクラス変数とインスタンス変数が存在するという状況は、あり得ます。というか普通に起きます。その場合、selfから参照するとインスタンス変数が優先されます（それでもクラス変数が存在しなくなる訳ではない。インスタンス変数をdel インスタンス変数とかで消せばまたクラス変数が見えるようになる）。
厳密にクラス変数にアクセスしたいときは「type(self).クラス変数の名前」のようにしてください。
という説明で良いでしょうか。

[ruuuu]

ご返信及びコメントありがとうございます。
>回答欄に追記した print(vars(...)) によってその様子を確認できます。
こちら、検証してみたいと思います。
>self.common_var.append(value) は、self.common_var は参照しているだけで代入はしません。
掲示させて頂きました上側のコードと下側のコードで違いが分からなかったのですが、変数「common_bar」が、配列であるために、インスタンス化した際は、プロパティとして、保持できないということなのでしょうか...?

[shiracamus]

self.common_var = [value] にすれば、インスタンス変数に代入されますよ。
あるいは
self.common_var = []
としてから
self.common_var.append(value)
すればインスタンス変数にappendされます。

[ruuuu]

すみません。少々混乱してしまい、言っていることが二転三転してしまっているのですが、プロパティとして保持は出来るが、参照、追加などの場合は、クラス変数に対して直接行うといった感じなのでしょうか...?

[ruuuu]

>self.common_var.append(value) では、インスタンス変数に common_var がない
こちらですが、だとすると上側のコードの「common_bar」もインスタンス変数がないということになるのではないでしょうか...?

[shiracamus]

> プロパティとして保持は出来るが、参照、追加などの場合は、クラス変数に対して直接行うといった感じなのでしょうか...?

インスタンスに保持してあれば、インスタンス変数を参照したり追加したりできます。

[shiracamus]

> こちらですが、だとすると上側のコードの「common_bar」もインスタンス変数がないということになるのではないでしょうか...?

self.common_var = value
によってインスタンス変数が新しく作られます。
クラス変数にある common_var もそのまま存在します。
クラスとインスタンスに同じ名前で別の値の変数が存在することになります。

[ruuuu]

んーなるほどです...
となりますと、もしかすると「append」による追加の為、クラス変数に対して直接参照や追加が行われていると言ったことなのでしょうか。。？

[hayataka2049]

「代入」がものっっっすごく特別な操作である、というのはPythonの勘所の一つなのですが、わかりづらいところでもありますね。

[shiracamus]

回答欄に、クラスとインスタンスの両方にリストを持つようにした例を追加してみました。

[ruuuu]

追記ありがとうございます。
大変分かりやすく理解することができました。
ここまで丁寧に教えて頂き、理解できないのも申し訳ないとも思うのですが、どうしても、質問させて頂きました上側のコードの「print(tc2.common_var)」こちらの結果が、「Set Variable」ではなく、「Initial Value」になるのかが分らないです...
関数「set_variable」とは別に、追記頂きました以下のようなメソッドが必要となってくるのではないのでしょうか...?
「def __init__(self):
self.common_var = [] # インスタンス変数」

[shiracamus]

インスタンス変数がないときにクラス変数を探しに行く、ということを説明するためのコードでしょうから、あえて __init__ を書いていないのだと思います。
試しに、 def __init__(self): を定義して self.common = 123 とでも書いて実行してみてはいかがでしょうか？

[shiracamus]

Qiitaの記事のコメントに図を書いてみます。

[hayataka2049]

>上側のコードの「print(tc2.common_var)」こちらの結果が、「Set Variable」ではなく、「Initial Value」になるのかが分らない
tc1.common_varも見てみると理解が深まるかもしれない。
「インスタンス」変数はインスタンスごとに独立しているわけです（だから、あるインスタンスでは存在するが、他のインスタンスではそもそも存在しないかもしれない）。
この辺は静的型付け言語とは流儀が違います。そっちの知識で理解しようとして混乱しているのかもしれません。

[shiracamus]

図を書いてみました。
https://qiita.com/msssgur/items/12992fc816e6adf32cff#comment-9244f5c1b6d7e194d59d

self.common_var.append(value)
は
var = self.common_var
var.append(value)
と2段階で処理したのと同じです。self.common への代入ではなく、参照しているだけです。

[ruuuu]

ご親切に、ありがとうございます。
図でご解説頂きましたおかげで、大分理解出来て参りました。
自分はかなり勘違いをしていたかもしれないのですが、そもそもインスタンス化「tc1 = TestClass()」した時点では、インスタンスはインスタンス固有のプロパティ(common_var）を所持しておらず、変数、メソッドにおいて、クラスに定義されたものを使用する、といった理解で合っていますでしょうか...?
そして、インスタンス変数を所持するには、「self.common_bar = 123」などのように、.appendなどではなく、代入をしなければならない、という理解で大方間違いありませんでしょうか...?

[shiracamus]

はい。その理解で正しいです。
一般的なクラス定義では、インスタンス生成時に自動的に呼び出される __init__ メソッド（初期化メソッド）を用意して、インスタンス self に初期値を代入する処理を書きます。

[ruuuu]

ご丁寧にありがとうございました。
>print("tc1 variables:", vars(tc1))
ご回答に記載頂きました、こちらなどの、「vars」メソッドはクラスやインスタンス毎に対応づけられているプロパティと値を確認することが出来るのですね。かなり便利ですし、使いやすいですね。
色々と勉強になりました。
誠に、ご親切に教えて頂きありがとうございました。

[shiracamus]

varsは単体で使える関数です。 https://docs.python.org/ja/3/library/functions.html#vars
foo.bar() のようなオブジェクトに紐付いてる関数、クラス定義の中に書かれている関数をメソッドといいます。

[ruuuu]

あ、そうなのですね...
確かに、調べて見ましたら「組み込み関数」と書いてありました。なんでもかんでも、関数 =「メソッド」という訳ではないのですね...
>一般的なクラス定義では、インスタンス生成時に自動的に呼び出される __init__ メソッド（初期化メソッド）を用意して、インスタンス self に初期値を代入する処理を書きます。
こちら、他言語でいう所のコンストラクターのようなものなのですね。
クラス定義をする際は、忘れないように覚えておきます。

Answer 2

class で最初に定義された common_var と、self.common_var は別物と考えてプログラムしないと、混乱は続きます。
最初の common_var はスタティクで、class の使用中、共有されます self.common_var はインスタンス毎に作成されて、インスタンスの数だけ存在します。self.common_var を　改名して、self.instance_var とします。common_var にアクセスする時に、TestClass.common_var とすることで、二つを別物に取り扱うことがはっきりします。

Comments

[ruuuu]

ご回答ありがとうございます。
他、ご回答者様のご回答もあり、理解することが出来ました！
>TestClass.common_var とすることで、二つを別物に取り扱うことがはっきりします。
こちらの部分に注意し、コーディングを行なっていきたいと思います。

Answer 3

下のコードではメソッド内でcommon_varに代入が無いので、common_varはクラス変数でオブジェクト間で共有されているということでしょう。
上のコードは、メソッド内でcommon_varに代入があるので、common_varはインスタンス変数になります。

Comments

[ruuuu]

>下のコードではメソッド内でcommon_varに代入が無いので、common_varはクラス変数でオブジェクト間で共有されているということでしょう。
掲示さして貰いました、下側のコードも「self.common_var.append(value)」このように、値が追加されているかと思うのですが、「append」での追加であるため、クラス変数に直接代入されてしまうと言った感じでしょうか。。？

[otn]

代入は、
変数 = 式
で、
変数.メソッド名(引数)
は、メソッド呼び出しです。代入ではありません。

変数の保持するオブジェクトが書き換わるかどうかと、変数への代入は、無関係です。

[ruuuu]

ご返信ありがとうございます。
勉強になりました。