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

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

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

作成日: 更新日:

基本的な使い方

__eq__メソッドは、PythonのAddクラスにおいて、そのオブジェクト間の等価性を判定するために実行するメソッドです。

このメソッドは、Pythonの特殊メソッド(マジックメソッド)の一つで、クラスのインスタンスが==(等しい)演算子によって比較された際に自動的に呼び出されます。クラスを設計する際、独自のデータを持つオブジェクトが「等しい」と見なされる条件を定義するために、この__eq__メソッドをオーバーライドすることが一般的です。

例えば、Addクラスの二つのインスタンスが、それぞれが持つ全ての内部データ(属性値)において一致する場合に、それらを「等しい」と判断するような比較ロジックを、このメソッド内に記述することができます。これにより、単なるメモリ上の同一性ではなく、オブジェクトの内容に基づいた意味のある等価性比較が可能になります。

もしクラスで__eq__メソッドを定義しない場合、Pythonはデフォルトで、二つのオブジェクトがメモリ上で全く同じインスタンスである場合にのみTrueを返します。これはis演算子の挙動に似ています。しかし、__eq__をオーバーライドすることで、たとえメモリ上の異なる場所に存在するインスタンスであっても、その「値」が同じであれば「等しい」と判断するといった、クラス固有の柔軟な比較ロジックを実装できるようになります。

このメソッドは、比較の結果としてTrueまたはFalseを返します。また、比較対象のオブジェクトがAddクラスのインスタンスではないなど、比較に適さない異なる型である場合には、NotImplementedという特殊な値を返すことが推奨されます。これにより、Pythonは異なる型の比較を処理するための代替手段を探すことができます。__eq__を適切に定義すると、多くの場合、!=(等しくない)演算子に対応する__ne__メソッドを明示的に実装しなくても、その逆の比較結果が自動的に得られます。

構文(syntax)

1class MyClassName:
2    def __eq__(self, other):
3        return NotImplemented

引数(parameters)

self, value: Any, /

  • self: 比較対象となるAddオブジェクト自身
  • value: Any: 比較する値。任意の型を指定できます。

戻り値(return)

bool

二つのAddオブジェクトが等しい場合にTrue、そうでない場合にFalseを返します。

関連コンテンツ

関連プログラミング言語