__str__メソッドの役割は何なのか？

Question

__str__メソッドの役割は何なのでしょうか？
ドキュメントのチュートリアルを見ながらwebサイトを作っています。

from django.db import models
from django.utils import timezone

class Question(models.Model):
    class Meta:
        verbose_name = '質問'
        verbose_name_plural = '質問の複数形'
    question_text = models.CharField(max_length=200,default='xxxx')
    pub_date = models.DateTimeField('date published', default=timezone.now)

    def __str__(self):
        return self.question_text

class Choice(models.Model):
    question = models.ForeignKey(Question,on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

とコードを書くと、

のように”２つの質問”と”what's up?”と質問のタイトルが出てきます。

    def __str__(self):
        return self.question_text

の部分を追加しないと質問のタイトルは出てきません。
この、str__メソッドが何なのかわからないです。クラスオブジェクトをstirng型に変更するものだとは思うのですが、なぜメソッドなのに__str(変数)のように呼び出している箇所がないのに呼び出せているのかわかりません。
また、

def __str__(self)

の引数のselfが何を指しているのか、

return self.question_text

のselfが何を指しているのかもわかりません。これらの部分はどういう役割を持っているのでしょうか？

Answer 1

この、strメソッドが何なのかわからないです。クラスオブジェクトをstirng型に変更するものだとは思うのですが、なぜメソッドなのにstr(変数)のように呼び出している箇所がないのに呼び出せているのかわかりません。

Djangoが str(そのオブジェクト) を呼んでいます。

def str(self)

の引数のselfが何を指しているのか、

return self.question_text

のselfが何を指しているのかもわかりません。これらの部分はどういう役割を持っているのでしょうか？

selfはそのオブジェクト自身です。

http://docs.python.jp/3/library/stdtypes.html#str から引用します。

str() は object の 文字列 版を返します。 object が与えられなかった場合、空文字列が返されます。それ以外の場合 (...中略...) str(object) は object.__str__() の結果を返します。

Comments

[退会済みユーザー]

ありがとうございます。何点か質問があります。
selfはそのオブジェクト自身　に関して、ここではstrということでしょうか？
また、str() は object の 文字列 版を返します　に関して”文字列版”とはどういう意味なのでしょうか？

[shimizukawa]

違います。Questionのインスタンスです。文字列版、は、文字列のことです。人間が見て分かる文字にした、ということです。通常この文字列からインスタンスを再現はできません。表示用、ということですね。

Answer 2

Classを文字列で表現する際に、
なんと記述するかを明記しているのが、__str__ です。

たとえば、

class MyClass:
    def __init__(self):
        self.name = "my class"

    def getName(self):
        return self.name

    def setName(self, name):
        self.name = name

このようなクラスがあった際に、

print MyClass

としたらなんと出力されるでしょうか？

この時、このクラス内に、

    def __str__(self):
        return "これは<MyClass>です。"

というような記述があった際は、上記のようにprintしたらなんと表示されるでしょうか？

「クラスを文字列で表現する」というシチュエーションは往々にしてあるため、
このようなメソッドが存在します。