Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】BinOp::__eq__()メソッドの使い方

__eq__メソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__eq__メソッドは、Pythonにおいてオブジェクト同士が等しいかどうかを判断する際に内部的に実行されるメソッドです。プログラマが オブジェクトA == オブジェクトB のように == 演算子を使って比較を行うと、この __eq__ メソッドが呼び出されます。

Pythonの組み込み型(数値、文字列など)では値が同じであれば True を返しますが、自分で定義したクラス(カスタムクラス)のインスタンスでは、デフォルトではオブジェクトが同じメモリ上の位置を参照しているか、つまり同一のオブジェクトであるかによって等価性を判断します。そのため、内容が同じであっても、異なるインスタンスであればデフォルトでは False を返します。

例えば、座標を表す Point クラスで、Point(1, 2) と Point(1, 2) という異なるインスタンスが、内容としては等しいと判断されるようにしたい場合などです。このような場合に、__eq__ メソッドをクラス内で独自に定義し直す(オーバーライドする)ことで、オブジェクトの内容に基づいた等価性比較のロジックを実装できます。これにより、オブジェクトの「値」が同じであれば等しいと判断されるように、プログラムの振る舞いをカスタマイズすることが可能です。このメソッドは、比較の結果として等しい場合はブール値の True を、等しくない場合は False を返します。

構文(syntax)

1class MyObject:
2    def __init__(self, value):
3        self.value = value
4
5    def __eq__(self, other):
6        if isinstance(other, MyObject):
7            return self.value == other.value
8        return NotImplemented

引数(parameters)

self: BinOp, value: Any, /

  • self: BinOp: 比較対象となるBinOpオブジェクト自身
  • value: Any: 比較する値

戻り値(return)

bool

BinOpクラスの__eq__メソッドは、2つのBinOpオブジェクトが等しいかどうかを比較し、その結果を真偽値(TrueまたはFalse)で返します。

関連コンテンツ

関連プログラミング言語