Pythonのrepr()とは？意味をわかりやすく簡単に解説

公開：2024年11月12日更新：2024年11月12日

repr()とは
repr()の活用と実装方法
repr()の基本的な使用方法
カスタムクラスでのrepr()の実装
repr()とstr()の違いと使い分け

repr()とは

Pythonにおけるrepr()は組み込み関数のひとつで、オブジェクトの正式な文字列表現を返すために使用されます。この関数を使うことでオブジェクトの内部状態を詳細に把握できるため、デバッグや開発時に有効です。

repr()関数はeval()関数と組み合わせて使用することで、オブジェクトを再現できるのが特徴。つまりrepr()が返す文字列を評価すると、元のオブジェクトと同じ状態のオブジェクトを生成できるのです。

repr()はクラスのデバッグや、コンソール上でのオブジェクトの表示に頻繁に利用されます。また、カスタムクラスで__repr__()メソッドをオーバーライドすることで、オブジェクトの表示方法をカスタマイズすることも可能です。

「Python」を学べるコードキャンプのサービス

repr()の活用と実装方法

repr()の活用と実装方法について、以下3つを簡単に解説します。

repr()の基本的な使用方法
カスタムクラスでのrepr()の実装
repr()とstr()の違いと使い分け

repr()の基本的な使用方法

repr()関数は引数として渡されたオブジェクトの文字列表現を返し、その結果は通常、クォートで囲まれた形式になります。

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

y = [1, 2, 3]
print(repr(y))  # 出力: [1, 2, 3]

上記の例では文字列と配列に対してrepr()関数を使用しています。文字列の場合はクォートで囲まれた形式で、配列の場合は要素がカンマで区切られた形式で表示されるのがわかります。

repr()関数はデバッグ時やログ出力時に有効です。オブジェクトの詳細な情報を得られるため、プログラムの状態を正確に把握できるのです。

おすすめのPython研修一覧

Python研修を提供しているおすすめの企業・法人を一覧で掲載しております。

Python研修の一覧を見る

おすすめのDX研修一覧

DX研修を提供しているおすすめの企業・法人を一覧で掲載しております。

DX研修の一覧を見る

おすすめのJava研修一覧

Java研修を提供しているおすすめの企業・法人を一覧で掲載しております。

Java研修の一覧を見る

おすすめのJavaScript研修一覧

JavaScript研修を提供しているおすすめの企業・法人を一覧で掲載しております。

JavaScript研修の一覧を見る

カスタムクラスでのrepr()の実装

カスタムクラスで__repr__()メソッドを定義することで、そのクラスのインスタンスに対するrepr()の挙動をカスタマイズできます。このメソッドは、オブジェクトの文字列表現を返すように実装する必要があるのです。

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})"

person = Person("Alice", 30)
print(repr(person))  # 出力: Person(name='Alice', age=30)

上記のコードはPersonクラスに__repr__()メソッドを実装している例です。このメソッドはオブジェクトの属性を含む、文字列を返すようにカスタマイズされています。

__repr__()メソッドを適切に実装することで、デバッグ時やログ出力時にオブジェクトの状態を明確に把握できます。これによりコードの可読性と保守性が向上するでしょう。

repr()とstr()の違いと使い分け

PythonにはオブジェクトOBJECTの文字列表現を取得する関数として、repr()とstr()の2つが存在します。これらの関数は似ているようで異なる目的を持っており、適切に使い分けることが重要です。

class Example:
    def __str__(self):
        return "This is an example object"
    
    def __repr__(self):
        return "Example()"

obj = Example()
print(str(obj))   # 出力: This is an example object
print(repr(obj))  # 出力: Example()

str()は人間が読みやすい形式で、オブジェクトを表現することが目的です。一方でrepr()は、開発者向けのより詳細で明示的な表現を提供します。

一般的にログ出力やデバッグ時にはrepr()を使用し、ユーザー向けの出力にはstr()を使用することが推奨されます。この使い分けにより、適切な場面で適切な情報を提供できるのです。

※上記コンテンツの内容やソースコードはAIで確認・デバッグしておりますが、間違いやエラー、脆弱性などがある場合は、コメントよりご報告いただけますと幸いです。