Pythonの特殊メソッド__str__の使い方を現役エンジニアが解説【初心者向け】

初心者向けにPythonの特殊メソッド__str__の使い方について解説しています。printを使って書くことも出来ますが、独自にクラス定義をする際は、デバッグやロギングの効率が上がるため__str__を実装するようにしたほうがよいでしょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

Pythonの特殊メソッド__str__の使い方について解説します。

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

特殊メソッド__str__の使い方について詳しく説明していくね!

大石ゆかり

お願いします!

 

__str__とは

オブジェクトの文字列表現を定義するために用いる特殊メソッドです。

オブジェクトにstrやprintを適用した場合に呼び出されます。戻り値はstringオブジェクトでなければいけません。

詳細は公式のリファレンスを参照してください。

__str__の使い方

クラスで__str__メソッドを定義します。

前述の通り、戻り値はstringオブジェクトとします。インスタンスにstrやprintを適用すると、__str__メソッドが呼び出されます。

class MyClass:
  def __str__(self):
    return ... # stringオブジェクト

x = MyClass()
str(x)
print(x)

 

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

実際に書いてみよう

サンプルコード

class PersonA:
  def __init__(self, name, age):
    self._name = name
    self._age = age
  
class PersonB(PersonA):
  def __str__(self):
    return '%sは%d歳です' % (self._name, self._age)

a = PersonA('太郎', 10)
b = PersonB('花子', 20)
print(a)
print(b)

 

実行結果

<__main__.PersonA object at 0x7f68d9df04e0>
花子は20歳です

 

解説

人物を表すクラスPersonAを定義しました。PersonBはPersonAを継承し、さらに__str__メソッドを実装しました。

PersonAのインスタンスaをprintで表示すると、 <__main__.PersonA object … > のようなPythonの内部表現が表示されました。

PersonBのインスタンスbをprintで表示すると、__str__で定義した文字列表現が表示されました。

監修してくれたメンター

橋本紘希

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

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

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

 

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

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