特殊メソッド

Contents

1 特殊メソッド
2 基本的な特殊メソッドの紹介
3 __str__と__repr__
4 __bool__

Pythonのクラスでは、特殊メソッドと呼ばれるアンダーバー2つで囲まれた特定の名前のメソッドを実装すると、ある処理を実行した際にそのメソッドが自動的に呼び出されます。たとえば__init__がそれに該当しますね。オブジェクト生成時に自動的に呼びだされます。

基本的な特殊メソッドの紹介

かなりの種類があるためここでは簡単に紹介するにとどめます。また、次ページ以降で紹介するディスクリプタや演算の定義で使用するものも特殊メソッドの一種です。

repr

オブジェクト情報を表す文字列を返します。

str

オブジェクトを文字列に変換して返します。

bool(self)

オブジェクト真理値の評価を返します。

strとrepr

特殊メソッドの__str__と__repr__を実装したクラスのサンプルを見てみましょう。


class User():
    """
    ユーザークラス
    """

    def __init__(self, name="", age=0):
        self.name = name
        self.age = age

    def say_hello(self):
        print("Hello, my name is " + self.name)

    def __str__(self):
        return "User:" + self.name

    def __repr__(self):
        return str({"name": self.name, "age": str(self.age)})


user = User("Kuro", 30)

print(user)  # print(str(user))と同じ
# User:Kuro

print(repr(user))
# {'name': 'Kuro', 'age': '30'}

strの引数にUser型のオブジェクトを指定すると、__str__で実装した内容の文字列表現が取得できました。そして、前述の通りprint関数は内部的にstrを呼び出すため、コード中のコメントの通りprint(str(user))としても同様の結果を得ることができます。

また、repr関数を使用すると__repr__で返される値を得ることができます。なお、__str__を実装せずに__repr__のみ実装すると、str関数実行時に__repr__の値が取得されます。このため、__str__は__repr__の簡易版と捉えても良さそうです。

独自にクラス定義をする場合、デバッグやロギングの効率が上がるため__repr__若しくは__str__を実装するようにしたほうがよいでしょう。

bool

__bool__を実装すると、bool関数を実行した際のオブジェクトの真理値を設定することができます。サンプルを見てみましょう。

class Coordinate:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __bool__(self):
        if self.x or self.y:
            return True
        else:
            return False


p0 = Coordinate(0, 0)
p1 = Coordinate(100, 200)
p2 = Coordinate(0, 200)

if p0:
    print("点p0は真と評価されました")

if p1:
    print("点p1は真と評価されました")

if p2:
    print("点p2は真と評価されました")

# 実行結果
# 点p1は真と評価されました
# 点p2は真と評価されました

上のコードでは2次元平面上の座標を表すCoordinateクラスを実装しています。点の座標がともに0、つまり原点以外は真と評価されます。実際、コード後方にて原点p0、それ以外のp1、p2の真理値を評価していますが、原点の場合は偽と評価されることが確認てきます。

特殊メソッド