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

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

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

作成日: 更新日:

基本的な使い方

__hash__メソッドは、オブジェクトのハッシュ値を計算して返却するメソッドです。このメソッドはCompareクラスで定義されており、Pythonにおいてオブジェクトを一意に識別するための整数値である「ハッシュ値」を生成する役割を担います。

ハッシュ値は、主に辞書(dict)のキーやセット(set)の要素としてオブジェクトを使用する際に、高速な検索と管理のために不可欠です。このメソッドが実装されているオブジェクトは「ハッシュ可能(hashable)」と呼ばれ、ハッシュ可能であるためには以下の二つの重要な条件を満たす必要があります。一つ目は、オブジェクトの生存期間中、そのハッシュ値が変化しないことです。二つ目は、__eq__メソッドによって等しいと判断される二つのオブジェクトは、必ず同じハッシュ値を持つことです。

一般的に、数値(int, float)、文字列(str)、タプル(tuple)などの内容が変更できない(不変な)オブジェクトはハッシュ可能です。一方、リスト(list)や辞書(dict)のように内容が変更されうる(可変な)オブジェクトは、ハッシュ値の一貫性を保つことが難しいため、デフォルトではハッシュ不可能とされており、これらのオブジェクトを辞書のキーやセットの要素として直接使用することはできません。

カスタムクラスを作成する際、そのインスタンスを辞書のキーとして利用したい場合は、__hash__メソッドと__eq__メソッドを適切に実装する必要があります。ただし、インスタンスが変更可能な状態を持つ場合、誤解を招くハッシュ値の挙動を避けるため、__hash__メソッドを明示的にNoneに設定して、そのクラスのインスタンスをハッシュ不可能にすることもできます。

構文(syntax)

1class MyClass:
2    def __hash__(self):
3        return hash((self.attribute1, self.attribute2))

引数(parameters)

self, /

  • self: このメソッドが呼び出されるオブジェクト自身

戻り値(return)

int

このメソッドは、オブジェクトのハッシュ値を返します。ハッシュ値とは、オブジェクトを一意に識別するための整数値のことです。

関連コンテンツ

関連プログラミング言語