特殊メソッド — + や print の挙動をクラスに教える

前回まででインスタンスメソッド・クラスメソッド・スタティックメソッドの 3 種類のメソッドを整理しました。ここからは特殊なメソッド — 特殊メソッド（ダンダーメソッド） — を解説します。

特殊メソッドとは — 「ダンダーメソッド」

Python のクラスでよく見かける__init__や__str__のように、前後をアンダースコア 2 つで囲んだ名前のメソッドを特殊メソッドと呼びます。アンダースコア（dunder = double underscore）に挟まれているため、ダンダーメソッドとも呼ばれます。

特殊メソッドの大きな特徴は、自分で直接呼び出すものではなく、Python が特定の操作をしたときに自動で呼んでくれる点です。たとえばv1 + v2と書いたとき、Python は内部でv1.__add__(v2)を呼びに行きます。print(p)を書いたらp.__str__()が呼ばれ、a == bを書いたらa.__eq__(b)が呼ばれます。

__add__ で + 演算子を定義する

代表例として+を見てみます。たとえば「金額（円）を表すMoneyクラス」を作ったとして、Money(300) + Money(500)と書いてMoney(800)を作りたい — ということがあります。何もせずに足し算しようとすると、Python は「Money同士の足し方を知らない」と言ってTypeErrorを出してしまいます。

この「足し方」をクラスに教えるのが__add__メソッドです。def __add__(self, other):を定義して、自分（self）と相手（other）から新しいインスタンスを作って返すように書けば、+演算子で使えるようになります。

class Money:
    def __init__(self, amount):
        self.amount = amount

    def __add__(self, other):                 # + のときに呼ばれる
        return Money(self.amount + other.amount)

wallet  = Money(300)
payment = Money(500)
total   = wallet + payment                    # 内部的には wallet.__add__(payment)
print(total.amount)                           # 800

Moneyクラスに__add__を実装して、+で残高を合算できるようにします。

① class Money:を定義し、__init__(self, amount)でself.amount = amountを代入してください。

② __add__(self, other)を定義し、return Money(self.amount + other.amount)を返してください。

③ wallet = Money(300)とpayment = Money(500)を作り、total = wallet + paymentのtotal.amountをprintしてください。

（正しく実行できれば解説が表示されます）

__str__ と __repr__ — 文字列表現を 2 種類用意する

次は「インスタンスを文字列にする」ときに呼ばれる特殊メソッドです。これには 2 つあって、目的が違います。

- __str__ — print(p)やstr(p)のときに呼ばれる、ユーザー向けの見やすい文字列

- __repr__ — 対話シェルや開発者がデバッグ時に見たい、コードに近い形の詳細な文字列

何もしないとprint(user)は<__main__.User object at 0x...>のような分かりづらい結果になります。__str__を定義すると見やすい表示になり、さらに__repr__も定義しておくとデバッグの際に型と中身が一目で分かるようになります。

class User:
    def __init__(self, name, age):
        self.name = name
        self.age  = age

    def __str__(self):                       # print() / str() のとき
        return f"{self.name}（{self.age}歳）"

    def __repr__(self):                      # 開発者向けデバッグ用
        return f"User(name={self.name!r}, age={self.age})"

u = User("花子", 30)
print(u)             # 花子（30歳）          ← __str__
print(repr(u))       # User(name='花子', age=30) ← __repr__

Userクラスに__str__と__repr__を実装して、print結果とrepr結果を比べます。

① class User:を定義し、__init__(self, name, age)でself.name / self.ageを代入してください。

② __str__(self)を定義し、return f"{self.name}（{self.age}歳）"を返してください。

③ __repr__(self)を定義し、return f"User(name={self.name!r}, age={self.age})"を返してください。{self.name!r}の!rは、値に対して repr() を呼んだ結果を埋め込む書き方で、文字列なら'花子'のようにシングルクォート付きで出ます（{self.name}だと花子）。

④ u = User("花子", 30)を作り、print(u)とprint(repr(u))の両方を実行して、表示の違いを確認してください。

__eq__ で == の比較を定義する

次は等価性を見てみます。a == bと書いたとき、Python は内部的にa.__eq__(b)を呼びますが、自作クラスで__eq__を定義していないと、デフォルトでは「同じメモリ上のオブジェクトか」（idの比較）になってしまいます。

たとえばクーポンを表すCouponクラスがあって、コードが同じならクーポンとしては同じものとして扱いたい — そういう「業務上の等価性」を定義するのが__eq__の仕事です。

class Coupon:
    def __init__(self, code, discount):
        self.code     = code
        self.discount = discount

    def __eq__(self, other):
        return self.code == other.code        # コードが同じなら同じクーポン

c1 = Coupon("SPRING10", 0.10)
c2 = Coupon("SPRING10", 0.20)               # 割引率は違うがコードは同じ
c3 = Coupon("SUMMER15", 0.15)

print(c1 == c2)   # True  （code が一致）
print(c1 == c3)   # False （code が違う）

__eq__ を定義しないとどうなる？

__eq__を定義しないクラスでは、c1 == c2は同一オブジェクトかどうか（メモリ上の同じ箱を指しているか）で判定されます。たとえコード・割引率がどちらも完全に同じでも、別々に作ったインスタンスは別のメモリ上に置かれるので結果はFalseになります。「中身で比較したい」場合は__eq__を必ず自分で書きましょう。

Couponクラスに__eq__を実装して、コード（code）が同じなら等しいと判定するようにします。

① class Coupon:を定義し、__init__(self, code, discount)でself.code / self.discountを代入してください。

② __eq__(self, other)を定義し、return self.code == other.codeを返してください。

③ Coupon("SPRING10", 0.10)とCoupon("SPRING10", 0.20)、Coupon("SUMMER15", 0.15)の 3 つを作り、==で 2 通りの比較結果をprintしてください。

他にもよく使う特殊メソッド — __call__ / __len__ / __bool__

ここまで紹介した 4 つ以外にも、よく使う特殊メソッドがいくつかあります。中でも代表的な 3 つを押さえておきましょう。

- __call__ — インスタンスを関数のように () 付きで呼び出せるようにする

- __len__ — len(obj)を呼んだときの返り値を決める

- __bool__ — if obj:やbool(obj)で真偽値として評価される値を決める

どれも組み込みの操作 — 関数呼び出し、len()、ifの条件評価 — を自作クラスに教えるためのメソッドです。アクセスログを溜めていくLoggerクラスを例にすると、これら 3 つを 1 つのクラスに同居させて使い分けるイメージがつかみやすくなります。

class Logger:
    def __init__(self, name):
        self.name = name
        self.log  = []

    def __call__(self, message):                    # logger("...") で呼べる
        self.log.append(message)
        return f"[{self.name}] {message}"

    def __len__(self):                               # len(logger) のとき
        return len(self.log)

    def __bool__(self):                              # if logger: のとき
        return len(self.log) > 0

app = Logger("app")
print(app("起動しました"))   # [app] 起動しました
print(app("ログイン成功"))   # [app] ログイン成功
print(len(app))               # 2
if app:
    print("ログがあります")    # ログがあります

__bool__ を書かない場合の挙動

__bool__を定義していない場合、Python は次に__len__を見にいきます。__len__の戻り値が0ならFalse、それ以外ならTrueと扱われます。両方とも未定義のクラスは、インスタンスがどんな状態でも常にTrue扱いになります。空のリストや空文字列がFalseと評価されるのもこの仕組みです。

Loggerクラスに 3 つの特殊メソッドを実装して、ログの追加・件数取得・件数判定を組み込み構文だけで書けるようにします。

① class Logger:を定義し、__init__(self, name)でself.name = name / self.log = []を代入してください。

② __call__(self, message)を定義し、self.log.append(message)を実行してからreturn f"[{self.name}] {message}"を返してください。

③ __len__(self)を定義し、return len(self.log)を返してください。

④ __bool__(self)を定義し、return len(self.log) > 0を返してください。

⑤ error_log = Logger("error")を作り、print(bool(error_log)) → error_log("DBエラー") → print(len(error_log)) → print(bool(error_log))の順に実行してください。

他にも__hash__（setやdictのキーにする）、__lt__ / __gt__（< / >の比較）、__getitem__（obj[key]の添字アクセス）、__iter__（for x in obj:での反復）など、特殊メソッドはたくさんあります。すべてを丸暗記する必要はなく、「組み込みの操作を自作クラスに教えたいときに、対応するダンダーがある」ということを理解すれば、そのつど調べて使えるようになります。