__str__について、DjangoまたはPythonで質問があります。

Question

以下のようなmodels.pyの記述があったとします。

import uuid
from django.db import models

class Book(models.Model):
    class Meta:
        db_table = 'book'

    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    title = models.CharField(verbose_name='タイトル', max_length=20)
    price = models.IntegerField(verbose_name='価格', null=True, blank=True)
    created_at = models.DateTimeField(verbose_name='登録日時',
                                      auto_now_add=True)

    def __str__(self):
        return self.title

最下部の、

    def __str__(self):
        return self.title

の部分がどういう意味（役割）を意図して書かれているのか全くわからないのですが、教えていただけないでしょうか。このモデルを別のプログラム（例えばviews.py）で利用したときに、プライマリキーでフィルターをかけてアクセスしたときにまず初めに title の値がリターンされるようにしている（？）という意味でしょうか？全く意味がわかっておらず、抽象的な質問で申し訳ございません。

Answer 1

Pythonの特殊メソッドの一つです．

book = Book()
print(book)

のように書くと，__str__()なしではオブジェクト情報はid(例: <__main__.Book object at 0x102d195e0>)しか得られないのに対して，__str__()の中に書いた情報をprint文で表示してくれます．他にもstr(book)としたときに返すべき文字列を決定するメソッドです．

公式から抜粋すると

オブジェクトの「非公式の (informal)」あるいは表示に適した文字列表現を計算するために、str(object)と組み込み関数format(),print()によって呼ばれます。戻り値はstringオブジェクトでなければなりません。
__str__()が有効な Python 表現を返すことが期待されないという点で、このメソッドはobject.__repr__()とは異なります: より便利な、または簡潔な表現を使用することができます。

と書かれてますね．質問のコードではstr(book)やprint(book)として呼ばれたらタイトルself.titleを返すようにしています．公式の言う通り，有効なPython表現を返す必要がないのが特徴です．言い換えれば，自分のわかりやすいように文字列を返して良いメソッドです．

逆に__repr__はeval(repr(book))と書いてオブジェクトに戻せるような(有効なPython表現の)文字列を返さなくてはなりません．が今回はあまり関係ないので忘れてもらって結構です．

Comments

[ps_aux_grep]

can110さんの解答と合わせて説明すると，管理画面の設計上`str()`などでBookを表示していると考えられるので，このときにわかりやすくするためのメソッド．ということになるかと．

[sasaki0628]

ps_aux_grepさんも丁寧に回答して頂き、ありがとうございました。助かりました。

[ps_aux_grep]

管理画面で使う．はあくまでDjangoに限った話ですので，広義の回答になりました．今後何らかのオブジェクトを自作する際は活用されると良いと思います．

Answer 2

Django上での利用にフォーカスした回答となりますが
【Django】models.py：def str(self)とは？使用方法と管理画面での表示についてや
What is doing str function in Django?で説明されている通り、__str__によりそのモデルの各インスタンスを（人間にとって）識別できるような文字列を返すことによって、管理画面などでの表示で分かりやすくなります。

Comments

[sasaki0628]

ありがとうございます。管理画面で利用するとのこと、理解できました。