__mul__(__add__など特殊メソッド)ってどんな時に使うんですか？

Question

前提・実現したいこと

先月からpythonを独学で学んでいます。
学習時間は40時間程度のド素人です。

発生している問題・エラーメッセージ

mul(__add__など計算する特殊メソッド)の①必要性や②どんな時に使うのかをご教示いただきたいです。
__mul__の概念なのか使い方なのかが理解できていません。

恐らく自分の中で「__mul__は計算するためのメソッドである」と解釈してしまっていることが間違っているんだと思います。
具体的には、下記図【２】のやり方で計算できるのに、【１】の必要性って何？の答えが分かりません。

分かりづらいご質問になっていましたら申し訳ございません。宜しくお願い致します。

【１】＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
class answer:
def init(self,num):
self.num=num

def __mul__(self,other):
    self.other=other
    return self.num*other.num

x=answer(8)
y=answer(9)

print(x*y)
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

【２】＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
class answer:
def init(self,num,other):
self.num=num
self.other=other

def size(self):
    return self.num*self.other

answer1=answer(8,9)
print(answer1.size())
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

python3.8.2です

Comments

[hayataka2049]

質問を編集してコードを
```python
ここにコード
```

のように囲うように書いてください。markdownを使わないとうまく表示されません。

Answer 1

__mul__は*の動作を実装するためにあります。他の言語でいうところの演算子オーバーロードに近いです。
（ただし、オーバーロードというよりは「そもそもPythonの演算子はすべて特殊メソッド呼び出しに変換される」といった方が実情にそぐうでしょう。1 * 2ですら内部的に(1).__mul__(2)と実行されます（もしかしたら処理系の実装が最適化するようになっているかもしれませんが、原則はそう））

自分で定義したクラスに対して演算子を使えるようにしたいときに使えます。もちろんそれなりの知識がないと使いこなせないですし（データモデルをちゃんと把握する必要があります）、一般ユーザが触れることはほとんどありません。学習時間40時間で知っておく必要はまずありません。

本格的に活用するのは、たとえばライブラリ開発者の人たちです。numpyなどでは多用されています。たとえば、

>>> import numpy as np
>>> a = np.arange(4).reshape(2, 2)
>>> a
array([[0, 1],
       [2, 3]])
>>> a + 1
array([[1, 2],
       [3, 4]])

はnumpy.ndarrayが__add__を実装しているから実現しています。

Comments

[Yuki.I]

ありがとうございます。__mul__が何なのかは分かりました。
どんな時に使うかについては、クラスに自分で定義した演算子を実装する？時に、__mul__等は使うってことですか？
まだ、開発とかしたことないのでわからないのですが、開発段階で使うことになるってことですか？

[hayataka2049]

自分で定義した演算子を実装する時ではなく、演算子の種類はpythonの言語仕様で定義されていて、種類に応じた動作を対応する特殊メソッドで実装する形です。
回答に書いた内容と被りますが、一般的なpython開発者が書くことはほぼないでしょう。演算子が使えるクラスを定義したいというケースはそれほど多くありません。一年くらい存在を忘れていても何も不都合はない可能性が高いです。

[Yuki.I]

ありがとうございます。理解できました。ご丁寧にご説明いただきありがとうございます！

Answer 2

文字列は 加算演算子で文字列を連結します。乗算演算子で繰り返します。
'Fizz'+'Buzz' 、"なんでやねん！"*3

pathlib では、パスの連結に 除算演算子 を使ってます。
https://docs.python.org/ja/3/library/pathlib.html

漢字の数字を数値に変換するクラスを作って、漢字のまま演算できるようにしてみました。
https://qiita.com/shiracamus/items/d4be0bdfbe62d644d985

川渡り問題「宣教師と人喰い」で船と岸の人数増減計算に __add__ と __sub__を使ってみました。
https://qiita.com/shiracamus/items/ce536aaad95932dbbfb5

ビット和演算子をコマンドのパイプ処理に見立ててみました。
https://qiita.com/shiracamus/items/5ef30ab2b44d38c62e94

Comments

[Yuki.I]

ありがとうございます。どんな時に使われるのかイメージすることができました。
すごい難しそうですが、私もこれぐらいのことが実装可能になれるように頑張ります。
ありがとうございます！

Answer 3

【Python入門】クラス利用時の特殊メソッド一覧（サンプルコード付き） | CodeCampus

解説があるので読んでみてください。

Comments

[Yuki.I]

ありがとうございます。特殊メソッドは下記の考え方があるってことですか？その場合、考え方以外で、異なることはないのでしょうか？
①クラス内のメソッドを見るだけで何がしたいのかすぐに意味を理解することができ、可読性が向上する②コードのエラーリスクを減らすことができる

[y_waiwai]

__mul__ というメソッドを実装していると、そのクラス変数どおしの * による演算ができるようになります

answer1=answer(8,9)　よりも　x*y　のほうが簡単に理解できますね
まあ、こんな簡単な例じゃなく、
(x*y+z)/w とかの式を実装しようと思ったら、特殊メソッド無しでどう実装すればいいかすぐに思いつくでしょうか

[Yuki.I]

下記が思いつきました。

class answer:
def __init__(self,w,x,y,z):
self.w=w
self.x=x
self.y=y
self.z=z

def size(self):
return (self.x*self.y+self.z)/self.w

answer1=answer(2,2,2,2)
print(answer1.size())