Pythonの__str__と__repr__の違いを現役エンジニアが解説【初心者向け】

初心者向けにPythonの__str__と__repr__の違いについて現役エンジニアが解説しています。__str__と__repr__とは、ともにクラスで定義できる特殊なメソッドです。__str__と__repr__メソッドの比較や使い分け、クラス内での書き方などを解説します。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonの__str__と__repr__の違いについて、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonの__str__と__repr__の違いについて詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

__str__メソッドとは

__str__は、クラスで定義できる特殊なメソッドの一つです。

class Sample:
  def __str__(self):
    # 処理
s = Sample()
str(s)

とコーディングした場合、最終行のstr(s)が、__str__メソッドを呼び出します。

[PR] Pythonで挫折しない学習方法を動画で公開中

__repr__メソッドとは

__repr__も同様なメソッドです。

class Sample:
  def __repr__(self):
    # 処理
s = Sample()
repr(s)

とコーディングした場合、最終行のrepr(s)が、__repr__メソッドを呼び出します。

__str__メソッドと__repr__メソッドの比較と使い分け

公式のドキュメントを参照すると、__str__は以下の通りです。

Called by str(object) and the built-in functions format() and print() to compute the “informal” or nicely printable string representation of an object.

一方、__repr__は以下の通りです。

Called by the repr() built-in function to compute the “official” string representation of an object. If at all possible, this should look like a valid Python expression that could be used to recreate an object with the same value (given an appropriate environment). 

どちらのメソッドも戻り値は文字列型です。__str__は、人間にとってわかりやすい、画面に表示しやすい、オブジェクトの表現を返すべきと定義されています。

一方、__repr__は、可能であれば、Pythonが復元できる(evalで評価すると元のオブジェクトに戻る)、オブジェクトの表現を返すべきと定義されています。

datetime型を例にします。strを呼び出すと、以下の通り人間にとってわかりやすい文字列表現になります。

>>> import datetime
>>> t = datetime.datetime.today()
>>> str(t)
'2020-09-15 10:11:45.503449'

reprの戻り値を以下のようにevalで評価すると、datetime型を復元できます。

>>> import datetime
>>> t = datetime.datetime.today()
>>> t2 = eval(repr(t))
>>> type(t2)
<class 'datetime.datetime'>
>>> t2
datetime.datetime(2020, 9, 15, 10, 11, 45, 503449)

 

実際に書いてみよう

ソースコード

class Person:
    def __init__(self, name, age):
        self._name = name
        self._age = age

    def __str__(self):
        return f'名前は{self._name} 年齢は{self._age}'
    
    def __repr__(self):
        return f'Person("{self._name}", {self._age})'

p = Person('Alice', 10)
print(str(p))
print(repr(p))
p2 = eval(repr(p))
print(str(p2))

 

実行結果

名前はAlice 年齢は10
Person("Alice", 10)
名前はAlice 年齢は10

 

解説

Personクラスを定義し、name, ageをメンバ変数として定義しました。
__str__メソッドは、名前や年齢をわかりやすく表現するものとしました。
__repr__メソッドは、evalで評価できる形式にしました。

実行結果の通り、strメソッドでPersonオブジェクトを見やすく表現できました。また、reprメソッドの戻り値をevalで評価すると、Personオブジェクトを復元できました。

まとめ

この記事では__str__と__repr__メソッドの用途、使い分けを解説しました。どちらも自作クラスの使いやすさやデバッグしやすさに寄与するメソッドなので、適宜使い分けてください。

監修してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間でPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。