repr関数はどのように使いますか？

repr関数は、オブジェクトの正式な文字列表現を取得し、それを表示するために使います。評価可能な形式で出力されるため、デバッグやログ出力に役立ちます。

repr関数とstr関数の違いは何ですか？

repr関数はオブジェクトの正式で詳細な表現を返し、str関数はユーザーフレンドリーな読みやすい表現を返します。

repr関数はどのような場面で役立ちますか？

repr関数はデバッグや開発時にオブジェクトの詳細な内部状態を確認したいときに役立ちます。

【Python】repr関数について - オブジェクトの正式な文字列表現を取得する方法

概要

Pythonのrepr関数は、オブジェクトの正式で評価可能な文字列表現を取得するための関数です。この関数は、特にデバッグやログ出力の際に、オブジェクトの内部状態や構造を詳細に把握するために非常に役立ちます。repr関数は、開発者がオブジェクトの「正確な」姿を確認したい場面で使用され、得られた文字列は再度eval関数で評価可能な形式であることが多いです。本記事では、repr関数の基本的な使い方と、str関数との違い、さらにどのような場面で使えるかについて詳しく解説します。

repr関数の基本構文

repr(object)

パラメータ

object
任意のオブジェクト。repr関数は、このオブジェクトの正式な文字列表現を返します。

戻り値

repr関数は、オブジェクトの形式的で評価可能な文字列表現を文字列として返します。

使用例

基本的な使用例

文字列や数値、リストなどの標準的なデータ型に対してreprを使うと、その型に応じた正式な表現が返されます。

x = 123
y = "Hello, World!"
print(repr(x))  # 出力: '123'
print(repr(y))  # 出力: "'Hello, World!'"

このように、数値はそのままの形式で、文字列はシングルクオートで囲まれて表示されます。reprによって返された文字列は、ほぼeval()で再評価できる形式です。

リストや辞書の表示

複雑なデータ型、例えばリストや辞書に対してもreprを使用できます。

lst = [1, 2, 3, "`Python`"]
dct = {"a": 1, "b": 2}
print(repr(lst))  # 出力: "[1, 2, 3, '`Python`']"
print(repr(dct))  # 出力: "{'a': 1, 'b': 2}"

リスト内の文字列もシングルクオートで囲まれ、辞書のキーと値のペアも正確に表現されます。

str関数との違い

Pythonにはrepr関数とよく似たstr関数がありますが、両者には重要な違いがあります。

repr関数: オブジェクトの「正式な」文字列表現を返します。この表現は主に開発者向けで、再度評価可能な形式にすることを意図しています。
str関数: オブジェクトの「人間が読みやすい」文字列表現を返します。ユーザー向けに出力する際に使われるのが一般的です。

`repr`と`str`の比較例

x = "Hello\nWorld"
print(repr(x))  # 出力: "'Hello\\nWorld'"
print(str(x))   # 出力: "Hello
                #         World"

この例では、repr関数が\nをエスケープして表示しているのに対し、str関数は改行をそのまま反映しています。reprは技術的な正確性を重視し、strは人間が読みやすい出力を意図しています。

カスタムクラスでの`repr`と`str`

独自のクラスを作成した場合、reprとstrをオーバーライドして、クラスのオブジェクトがどのように表示されるかをカスタマイズすることができます。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    def __repr__(self):
        return f"Person('{self.name}', {self.age})"
    def __str__(self):
        return f"{self.name}, {self.age}歳"
p = Person("Alice", 30)
print(repr(p))  # 出力: "Person('Alice', 30)"
print(str(p))   # 出力: "Alice, 30歳"

この例では、reprを使うとオブジェクトの正式な表現（オブジェクトの再構築に使える表現）が表示され、strを使うとユーザー向けの簡潔な情報が表示されます。

reprを使う主なシーン

デバッグ

repr関数は、デバッグ時にオブジェクトの内部状態を確認する際に特に有用です。オブジェクトの「生の状態」を正確に出力できるため、開発者が予期しない動作をしているコードの原因を突き止める際に役立ちます。

x = "Hello\nWorld"
print(f"デバッグ情報: {repr(x)}")  # 出力: デバッグ情報: 'Hello\nWorld'

このように、エスケープシーケンスや特殊文字が含まれている場合でも、reprを使えばその正確な内容を確認できます。

ログ出力

reprは、システムのログを記録する際にも活用できます。reprを使うことで、ログに出力される内容がオブジェクトの正確な状態を反映するため、後からログを解析する際に役立ちます。

with open('logfile.txt', 'a') as f:
    f.write(f"ログ出力: {repr(x)}\n")

テストやアサーション

テストを書く際に、オブジェクトの出力が期待した形式かどうかを確認するためにもreprを使うことができます。特に、reprの出力は詳細であるため、テストがより信頼性の高いものになります。

def test_repr():
    p = Person("Alice", 30)
    assert repr(p) == "Person('Alice', 30)"

カスタムオブジェクトにおけるreprの重要性

カスタムクラスでreprメソッドを定義することは、オブジェクトのデバッグやログ出力を効率的に行うために非常に重要です。特に、オブジェクトの属性や状態を一目で理解できるように設計することで、開発時に大きな助けとなります。

class Product:
    def __init__(self, name, price):
        self.name = name
        self.price = price
    def __repr__(self):
        return f"Product(name={self.name!r}, price={self.price})"
p = Product("Laptop", 1000)
print(repr(p))  # 出力: Product(name='Laptop', price=1000)

このように、カスタムクラスでもreprを適切に実装することで、オブジェクトの状態を明確に把握できるようになります。

まとめ

Pythonのrepr関数は、オブジェクトの正式な文字列表現を取得するための非常に便利なツールです。特にデバッグやログ出力において、reprはオブジェクトの内部状態を正確に確認するために不可欠です。また、reprとstrの違いを理解することで、開発者はユーザー向けとシステム内部向けの出力を適切に使い分けることができます。reprを正しく活用し、効率的でトラブルシューティングしやすいコードを書きましょう。

参照:

`Python`のrepr関数 | `Python`公式ドキュメント

概要