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

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

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

作成日: 更新日:

基本的な使い方

__eq__メソッドは、二つのオブジェクトが「等しい」かどうかを判断するための比較を実行するメソッドです。Pythonにおいて、オブジェクト同士を==演算子(イコール記号を二つ並べたもの)を使って比較する際に、内部的にこの__eq__メソッドが呼び出されます。

標準のオブジェクトでは、このメソッドはデフォルトで、二つのオブジェクトがメモリ上で同じ場所を指しているか、つまり完全に同一のオブジェクトであるかを比較します。しかし、クラスを独自に定義する際、プログラマはオブジェクトの内容に基づいて「等しい」と判断する独自のルールを定義したい場合があります。例えば、二つの顧客情報オブジェクトが、そのIDや名前がすべて同じであれば「等しい」とみなしたい場合などです。

このような場合に、開発者は自身のクラス内で__eq__メソッドをオーバーライド(上書き)することで、カスタムの等価性比較ロジックを実装できます。これにより、オブジェクトの同一性ではなく、その値や属性が等しいかどうかを正確に判定できるようになります。このメソッドは、リストやセットなどのコレクション内でのオブジェクトの検索、重複の排除、またはテストコードにおける期待値との比較など、多岐にわたる場面で重要な役割を果たします。

構文(syntax)

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

引数(parameters)

self, other: object

  • self: 比較対象となるオブジェクト自身
  • other: 比較する別のオブジェクト

戻り値(return)

bool

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

関連コンテンツ

関連プログラミング言語