かばんの規格書：クラスとインスタンス

ド・ミラン班長の机の引き出しには、かばんの規格書がひと束入っています。規格書が一枚あれば、同じ形のかばんをいくつでも作れます。「規格書も一枚の紙、かばんも一つひとつ。どっちも物なんだ」

ムン室長は、バイオリンケースに「割れ物注意」を貼っただけなのに、チェロケースにも同じステッカーが見えるといいます。班長はケースではなく規格書を広げてみます。ステッカーはそこに貼られていました。

7-1. 規格書もかばんである：クラスオブジェクト (7分)

class 文は、クラスオブジェクトを作って名前に結び付ける代入です（1限目の def と同じです）。クラスも型を持つオブジェクトで、その型は type です。

class Case:
    size = "M"
    def __init__(self, owner):
        self.owner = owner

print(type(Case), isinstance(Case, type))
# <class 'type'> True
b = Case("cello")
print(type(b).__name__, type(b) is Case)
# Case True
print(vars(b))
# {'owner': 'cello'}
print([k for k in vars(Case) if not k.startswith("__")])
# ['size']
print(b.size, "size" in vars(b))
# M False

• b の __dict__ には owner しかありません。それなのに b.size は "M" と読めます。
• 属性を読むときは、まずインスタンスの __dict__ を見て、なければクラスを見ます。かばんになければ規格書を広げてみる、というわけです。
• クラスの __dict__ は mappingproxy という読み取り専用の窓です。クラス属性を変えたいときは、Case.size = "L" のようにクラスに直接代入します。

7-2. 皆で共有するクラス属性 (10分)

届出人の規格書です。

class Case:
    stickers = []
    def __init__(self, owner):
        self.owner = owner

a = Case("violin")
b = Case("cello")
a.stickers.append("FRAGILE")
print(b.stickers, Case.stickers)
# ['FRAGILE'] ['FRAGILE']
print(a.stickers is b.stickers, "stickers" in vars(a))
# True False

• stickers = [] はクラス本体で一度だけ実行されます。リストは規格書に一つ貼られているだけです。
• a.stickers は a の __dict__ にないのでクラスで見つかり、append はその一つしかないリストを変えます（かばんの変更）。
• 4限目のデフォルト引数と同じ形のバグです。「一度作ったミュータブルなオブジェクトを、皆で共有している」

インスタンスごとに別々に持つべきものは、__init__ で self に付けます。下で三つのやり方を比べてみてください。

三つ目のやり方のように、インスタンスに同じ名前で代入すると、クラス属性はそのままで、インスタンスの __dict__ に新しい名前ができます。そのインスタンスでは、クラス属性が隠れます（5限目の、組み込みの名前を隠すのと同じ形です）。

class Case:
    size = "M"

a = Case()
b = Case()
a.size = "L"
print(a.size, b.size, vars(a))
# L M {'size': 'L'}
Case.size = "S"
print(a.size, b.size)
# L S
del a.size
print(a.size)
# S

• クラス属性を変えると、隠していないすべてのインスタンス（b）からすぐに見えます。
• del a.size でインスタンスの名前を外すと、またクラスの値が見えます。

+= も代入だということを忘れないでください。数値のクラス属性に += を使うと、インスタンスに新しい名前ができます。

class Gate:
    count = 0

g = Gate()
g.count += 1
print(g.count, Gate.count, vars(g))
# 1 0 {'count': 1}

g.count += 1 は g.count = g.count + 1 です。右辺はクラスから0を読み、左辺は g の __dict__ に1を入れます。すべてのインスタンスで一緒に数える数なら、Gate.count += 1 のようにクラスに直接代入しなければなりません。

7-3. 読む順番：インスタンスの次にクラス (7分)

b.x を読むときにPythonがたどる道を、検査場の流れ図で見てみます。この回では、2段階目（インスタンスの __dict__）と4段階目（クラスの普通の属性）だけを見れば十分です。1・3・5段階目は10限目で扱います。

下の b は、size をクラスにも、自分の __dict__ にも持っています。

• size はクラスにもありますが、2段階目で先に見つかるので 'L' です。「結果」の行のかっこ内の Case.size は、「クラスにも同じ名前がある」という印です。
• label はクラスにある関数です。関数は3段階目に引っかかる特別なオブジェクトなので、取り出すとただの関数ではなく bound method になります。次の節のテーマです。

7-4. バウンドメソッド：取り出すたびに新しく作られる (6分)

メソッドは、クラスに入っている普通の関数です。インスタンスを通して取り出すと、Pythonが関数とインスタンスを束ねた新しいオブジェクト、つまりバウンドメソッドを作ってくれます。

class Bag:
    def __init__(self, owner):
        self.owner = owner
    def label(self):
        return "bag of " + self.owner

bag = Bag("kim")
print(bag.label is bag.label, bag.label == bag.label)
# False True
print(bag.label.__self__ is bag, bag.label.__func__ is Bag.label)
# True True
print(bag.label(), Bag.label(bag))
# bag of kim bag of kim
print(type(bag.label).__name__, type(Bag.label).__name__)
# method function

• bag.label と書くたびに、新しいバウンドメソッドができます。だから is は False です。同じ関数と同じインスタンスを束ねているので、== は True です。
• __self__ は束ねられたインスタンス、__func__ はクラスにある元の関数です。
• bag.label() は Bag.label(bag) と同じです。self は、バウンドメソッドが代わりに埋めてくれる最初の引数にすぎません。
• 関数が取り出されるときにどうやってメソッドに変わるのかは、10限目（ディスクリプタ）で解き明かします。

7-5. 名前を文字列で扱う：vars、getattr、setattr、hasattr (5分)

属性の名前を、実行中に文字列で決めなければならないことがあります。設定ファイルのキーや、画面で選んだ列の名前などです。

class Bag:
    def __init__(self, owner):
        self.owner = owner

bag = Bag("kim")
setattr(bag, "color", "red")
print(getattr(bag, "color"), hasattr(bag, "weight"), getattr(bag, "weight", 0))
# red False 0
print(vars(bag))
# {'owner': 'kim', 'color': 'red'}
vars(bag)["tag"] = "T1"
print(bag.tag, vars(bag) is bag.__dict__)
# T1 True
bag.weight
# AttributeError: 'Bag' object has no attribute 'weight'

• setattr(obj, "x", v) は obj.x = v、getattr(obj, "x") は obj.x と同じです。getattr の3番目の引数は、ないときに返すデフォルト値です。
• hasattr は、実際に getattr してみて AttributeError が出るかどうかで判断します。
• インスタンスの vars() はスナップショットではなく、本物の __dict__ です。5限目の、関数の中の locals() とは違います。
• Pythonのオブジェクトには、いつでも新しい属性を付けられます。便利ですが、タイプミス（bag.colour = ...）も黙って新しい属性になってしまいます。

7-6. 規格書を引き締める：__slots__ とそのほかの新機能 (5分)

__slots__ に属性の名前を書いておくと、インスタンスに __dict__ が作られず、書いた名前だけが使えます。CPythonでは、インスタンスごとの辞書がないぶんメモリも節約できます。

class Slim:
    __slots__ = ("owner",)
    def __init__(self, owner):
        self.owner = owner

s = Slim("kim")
print(s.owner, hasattr(s, "__dict__"))
# kim False
s.color = "red"
# AttributeError: 'Slim' object has no attribute 'color' and no __dict__ for setting new attributes

3.13から、クラスには __static_attributes__ があります。クラスのメソッドの中で self.名前 = ... として値を入れた名前を、並べ替えて集めておいてくれます。

class Trunk:
    def __init__(self, owner):
        self.owner = owner
        self.tags = []
    def pack(self):
        self.weight = 10

print(Trunk.__static_attributes__)
# ('owner', 'tags', 'weight')

最後に、3.14のアノテーションの遅延評価（PEP 649、749）です。クラス本体のアノテーションは、クラスを作るときではなく、__annotations__ を初めて読むときに計算されます。そのため、まだ定義していない名前をアノテーションに書いても、クラスは作られます。3.13までは friend: Missing の行で NameError になっていました。

class Partner:
    friend: Missing

print("created", Partner.__name__)
# created Partner

class Missing:
    pass

print(Partner.__annotations__)
# {'friend': <class '__main__.Missing'>}

事件解決 (10分)

ステッカーのリストを規格書からはがし、ケースごとに貼ります。共有する値（規格のサイズ）はクラスに残しておきます。

class Case:
    size = "M"
    def __init__(self, owner):
        self.owner = owner
        self.stickers = []

a = Case("violin")
b = Case("cello")
a.stickers.append("FRAGILE")
print(a.stickers, b.stickers)
# ['FRAGILE'] []
print(vars(a))
# {'owner': 'violin', 'stickers': ['FRAGILE']}
print(Case.__static_attributes__)
# ('owner', 'stickers')

これで「割れ物注意」はバイオリンケースにだけ貼られます。ムン室長が帰ったあと、ピンが13番コンベヤーの幽霊かばんの記録を画面に映します。二つのかばんは同じ規格で作られていて、片方の partner 属性はもう片方を、もう片方の partner はまたこちらを指しています。班長はその行にペンで丸を付けます。

練習問題

1. クラスに Case.stickers = [] をそのまま置いたまま a.stickers += ["FRAGILE"] を実行すると、b.stickers と vars(a) はどうなるでしょう？（ヒント：2限目の += と、7-2の += が同時に起こります。）
2. __slots__ = ("owner",) のクラスにクラス属性 size = "M" を置いたら、インスタンスで s.size を読めるでしょうか？　s.size = "L" はどうでしょう？
3. getattr で ["owner", "color", "weight"] の三つの属性を順に取り出して表示し、ない属性は "-" と表示するループを書いてみてください。