Pythonのメソッドチェーンとは？クラスでの実装方法をわかりやすく解説

メソッドチェーン（Method Chaining）とは

メソッドチェーンとは、同じオブジェクトに対して複数のメソッドを連続して呼び出すテクニックです。オブジェクトへの参照を一度書くだけで済むため、コードが簡潔になり、可読性も向上します。

基本的な考え方

例として、barとbazという2つのメソッドを持つクラスFooを考えてみましょう。まず、クラスFooのインスタンスを作成します。

foo = Foo()

メソッドチェーンを使わない場合、オブジェクトfooに対してbarとbazの両方を呼び出すには、次のように記述します。

foo.bar()
foo.baz()

一方、メソッドチェーンを使えば、次のように1行でまとめて書くことができます。

foo.bar().baz()

実装例

Pythonでは、各メソッドがself（自分自身のインスタンス）を返すようにするだけで、シンプルなメソッドチェーンを簡単に実現できます。

class Foo(object):
    def bar(self):
        print("Foo.bar called")
        return self

    def baz(self):
        print("Foo.baz called")
        return self

foo = Foo()
foo2 = foo.bar().baz()

print(" id(foo):", id(foo))
print("id(foo2):", id(foo2))

実行結果

上記プログラムを実行すると、次のような出力が得られます。

Foo.bar called
Foo.baz called
 id(foo): 87108128
id(foo2): 87108128

仕組みのポイント

この動作の鍵となるのは、各メソッドがreturn selfによって自分自身を返している点です。foo.bar()の戻り値が依然としてオブジェクトfooそのものであるため、その結果に対して続けて.baz()を呼び出せるというわけです。

また、実行結果を見るとfooとfoo2のid()（オブジェクトの識別値）が同一であることが確認できます。これは、チェーン呼び出しを行っても新しいオブジェクトは生成されず、常に同じインスタンスに対して操作が行われていることを示しています。