Pythonにおいて、クラスのインスタンスを文字列として出力する際にどのように表示されるかをカスタマイズする方法を詳しく解説します。具体的なコード例とその解説、応用例を含めています。
目次
はじめに
Pythonでオブジェクトの文字列表現を得る方法として`__str__`と`__repr__`メソッドがあります。この記事では、これらのメソッドを使ってクラスのストリングリプレゼンテーションをカスタマイズする方法を解説します。
基本的な方法
`__str__` メソッド
`__str__`メソッドは、`str()`関数が呼び出されたとき、または`print()`関数でオブジェクトを出力するときに呼び出されます。
class Person:
def __init__(self, name, age):
self.name = name
self.age = age
def __str__(self):
return f"Person(name={self.name}, age={self.age})"
# インスタンス生成
p = Person("Taro", 30)
# 出力
print(p) # Person(name=Taro, age=30)
`__repr__` メソッド
`__repr__`メソッドは主にデバッグ目的で使用されます。このメソッドが定義されていない場合、`__str__`メソッドが呼び出されます。
class Person:
def __init__(self, name, age):
self.name = name
self.age = age
def __repr__(self):
return f"Person(name={self.name}, age={self.age})"
# インスタンス生成
p = Person("Taro", 30)
# 出力
print(repr(p)) # Person(name=Taro, age=30)
応用例
1. 日時情報のカスタマイズ
クラス内で日時情報を持つ場合のストリングリプレゼンテーションのカスタマイズ例です。
from datetime import datetime
class Event:
def __init__(self, name, datetime):
self.name = name
self.datetime = datetime
def __str__(self):
formatted_date = self.datetime.strftime('%Y-%m-%d %H:%M:%S')
return f"Event(name={self.name}, datetime={formatted_date})"
2. ネストしたオブジェクト
クラスが他のクラスを属性として持っている場合のストリングリプレゼンテーションのカスタマイズ例です。
class Team:
def __init__(self, name, members):
self.name = name
self.members = members
def __str__(self):
members_str = ", ".join(str(member) for member in self.members)
return f"Team(name={self.name}, members=[{members_str}])"
3. 条件による出力の変更
ある条件に基づいて、ストリングリプレゼンテーションを動的に変更する例です。
class Product:
def __init__(self, name, stock):
self.name = name
self.stock = stock
def __str__(self):
return f"Product(name={self.name}, stock={'In Stock' if self.stock > 0 else 'Out of Stock'})"
まとめ
Pythonでは、`__str__`や`__repr__`メソッドをオーバーライドすることで、クラスのストリングリプレゼンテーションを独自にカスタマイズできます。このようにして、デバッグやログの分析、ユーザー体験の向上など、多様な用途に対応することが可能です。
コメント