selfを返すとは？

Question

はじめに

具体的なエラーが出てるわけではないです。

質問

オライリー出版の『Pythonではじめる機械学習』の67ページに以下のような記載があります。下に記載したlogregの式ですが、fitメソッドがselfを返さないとどういう式になるのでしょうか？また__init__とfitを続けて書くとありますが、コードに__init__が現れておらずこの辺の仕組みがこちらの記事を読んでもあまり理解できないのですがどなたかご教授いただけますでしょうか？よろしくお願いいたします。

以下、抜粋　

すべてのscikit-learnモデルのfitメソッドはselfを返す。これによって既に本章で何度も登場している、次のような書き方が可能になる。
logreg = LogisticRegression().fit(X_train, y_train)
ここで、我々はfitメソッドの返り値(つまりself)を訓練済みモデルである変数logregに割り当てている。このように複数のメソッド呼び出し(ここでは__init__とfit)を続けて書くことを、メソッドチェーンと呼ぶ。

Answer 1

pythonに限らず他の言語でもあります
phpの例を提示しますね

class foo {
  protected $a;
  protected $b;
  public function setA($a)
  {
    $this->a = $a;
  }

  public function setB($b)
  {
    $this->b = $b;
  }
}

$test = new foo;
$test->setA(10);
$test->setB(20);

このように$this(selfど同じ意味)を返却していない場合は↑こうなります
ところが$thisを返すようにすると

class foo {
  protected $a;
  protected $b;
  public function setA($a)
  {
    $this->a = $a;
    return $this;
  }

  public function setB($b)
  {
    $this->b = $b;
    return $this;
  }
}

$test = new foo;
$test->setA(10)
     ->setB(20);

のように一気に書けるんです

Answer 2

fitメソッドがselfを返さないとどういう式になるのでしょうか？

logreg = LogisticRegression()
logreg.fit(X_train, y_train)

コードに__init__が現れておらず

LogisticRegression()のことです。

Answer 3

__init__はPythonにおけるコンストラクタです。
LogisticRegression()でLogisticRegression.__init__()が実行されるので、そういう意味でしょう。
self実行時には見えず、暗黙的に代入されるはメソッドの第一引数で、オブジェクト自身のことです。呼び出すときは見えませんが、クラス定義では__init__(self)等となっており、クラス中で自身を参照する際に利用します。
__init__では必ずselfが返ります。
つまり、LogisticRegressionで返るオブジェクトのfitを実行して返るオブジェクト自身を得るということでしょう。

実際的には

logreg = LogisticRegression()
logreg.fit(X_train, y_train)

でも何も変わりませんし、なんの問題もないですが、初期化時にfitまでまとめてした方が可読性が高く楽ってことだと思います。

Comments

[cunwe]

ご回答いただきありがとうございます。
僕は今まで何も考えずにlogreg = LogisticRegression().fit(X_train, y_train)のように書いてしまっていたのですが、クラス定義で__init__(self)となってないクラスを使うときは
logreg = hogehogeClass()
logreg.fit(X_train, y_train)
のように書かなくてはいけないということでしょうか？

[kairi003]

いえ、__init__は戻り値が必ずselfであり(他の値を返そうとするとエラーになる)、未定義でも勝手に定義されるので定義されないってことはないです。
むしろ今回のケースが特殊なのはfitの戻り値がselfな点です。このおかげでインスタンスの生成にそのまま繋げて書くことができるわけですね。

logreg = hogehogeClass()
logreg.fit(X_train, y_train)

みたいに書かなきゃいけない、というケースは、例えばrangeからリストを作って末尾に0を加えたいときに

li = list(range(10))
li.append(0)

とする、みたいな話ですかね…
appendは戻り値がNoneなので

li = list(range(10)).append(0)

と書いたらliにはNoneが代入されてしまいます。(まあこの場合普通に+で繋げればいいんですが…)
しかし、自分でlistを継承したクラスを定義して、

class MyList(list):
____def my_append(self, x):
________self.append(x)
________return self
(コメントはインデントが効かないのでアンダーバーを書いてます)

とappendしてselfを返すメソッドを定義すれば

li = MyList(range(10)).my_append(0)

でliにきちんと[0,1,...9,0]が代入されます。

[cunwe]

fitの戻り値がselfなのが例外的なのですね。append()についてですが今回はわかりやすく例として使っただけで、実際には実務とかでは独自のappend()を作ってしまうと後々の人が混乱するのでしょうか？

[kairi003]

そうですね。appendは例で、実際に意味もなく改造するのはあまり推奨できません。
このような「自分を返すメソッド」で1文のうちにメソッドを連続して実行する手法はメソッドチェーンと呼ばれていてそこそこメジャーな設計ですが、多用するかは言語とライブラリによります。
Pythonでは画像処理とかnumpy系ではわりと使うイメージがあります。

[cunwe]

なるほど、そうなのですね。メソッドチェーンの仕組みと画像処理やnumpy系では使われがちということを理解しました、ありがとうございます！