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

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

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

作成日: 更新日:

基本的な使い方

__str__メソッドは、Pythonのオブジェクトを人間が読みやすい形式の文字列に変換する際に自動的に実行される特殊なメソッドです。

このメソッドは、クラス内で定義することで、そのクラスから作られたオブジェクトがどのような情報を持っているかを、分かりやすく文字列として表現できるようにします。例えば、あるオブジェクトを直接print()関数で出力したり、str()関数を使って文字列型に変換したりするときに、この__str__メソッドが呼び出されます。

__str__メソッドを独自に定義しない場合、Pythonはデフォルトで、そのオブジェクトがメモリ上のどこに存在するかを示すような、あまり意味の分かりにくい文字列を返します。しかし、クラス内でこのメソッドを定義し、オブジェクトの重要な属性(例えば、名前やIDなど)を組み込んだ文字列を返すようにすると、開発者やユーザーがオブジェクトの状態を簡単に把握できるようになります。

これにより、デバッグ作業が容易になったり、プログラムの出力がより直感的になったりするメリットがあります。システムエンジニアを目指す方にとって、オブジェクトが内部でどのようなデータを保持しているかを分かりやすく表示することは、プログラムの理解を深める上で非常に重要な機能です。

構文(syntax)

1class Assert:
2    def __str__(self):
3        return "String representation of Assert object"

引数(parameters)

self: object, /

  • self: object: 文字列に変換したいAssertオブジェクト自身

戻り値(return)

str

このメソッドは、アサート(assert)の状態を人間が読みやすい文字列形式で返します。この文字列は、アサートが成功したか失敗したか、そして失敗した場合のエラーメッセージなどの詳細情報を含みます。

関連コンテンツ

関連プログラミング言語