Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】Continue::__str__()メソッドの使い方

__str__メソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__str__メソッドは、オブジェクトを人間が読める文字列形式に変換する際に実行されるメソッドです。Pythonにおける組み込みの特殊メソッドの一つであり、クラスのインスタンスがprint()関数で出力されたり、str()関数によって明示的に文字列に変換されたりする際に自動的に呼び出されます。

このメソッドをクラス内で定義(オーバーライド)することで、そのクラスのオブジェクトがどのような文字列として表現されるかを開発者が自由にカスタマイズできます。例えば、あるオブジェクトが持つ複数の属性値を組み合わせて、意味のあるメッセージとして表示するといった使い方が可能です。これにより、プログラムの実行結果をより直感的で理解しやすいものにすることができます。

__str__メソッドは、主にプログラムのエンドユーザーやログ出力など、読みやすさが求められる場面で利用されることを想定しています。このメソッドは常に文字列を返却する必要があります。なお、開発者向けの厳密な表現を提供する__repr__メソッドとは目的が異なる点に注意が必要です。__str__は読みやすさ、__repr__はオブジェクトの再構築を目的とした表現を提供します。

構文(syntax)

1class Continue:
2    def __init__(self, description: str = "A custom Continue object"):
3        self.description = description
4
5    def __str__(self) -> str:
6        return f"Continue('{self.description}')"

引数(parameters)

self: Continue, /

  • self: Continue: メソッドが呼び出されている Continue オブジェクト自身

戻り値(return)

str

このメソッドは、オブジェクトの文字列表現を返します。

関連コンテンツ

関連プログラミング言語