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

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

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

作成日: 更新日:

基本的な使い方

__eq__メソッドは、Pythonのオブジェクト間で「等しい」という比較を行う際に使用される特殊なメソッドです。具体的には、プログラム内で==演算子(等価演算子)を使って二つのオブジェクトが比較された時に自動的に呼び出されます。

Pythonのオブジェクトは、デフォルトではメモリ上のアドレスが同じである場合にのみ等しいと判断されます。しかし、この__eq__メソッドをクラス内で独自に定義(オーバーライド)することで、開発者が「等しい」と考える独自の条件を設定できるようになります。例えば、あるクラスの二つのインスタンスが、たとえ異なるオブジェクトであっても、それらが保持しているデータ(属性)がすべて同じであれば「等しい」と判断させたい場合に__eq__を実装します。

このメソッドを実装する際は、比較対象のオブジェクトが異なる型である場合や、比較できない状況である場合にNotImplementedを返すことが推奨されます。これにより、Pythonは比較の処理を相手側のオブジェクトに委ねたり、他の比較方法を試みたりする機会を得ることができます。__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, value: object

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

戻り値(return)

bool

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

関連コンテンツ

関連プログラミング言語