【Django】models.py：def str(self)とは？使用方法と管理画面での表示について

2020.08.06 / 2020.08.06

この記事は、DjangoでWebアプリケーションを作成している方を対象としております。

Djangoでは、データベースを直接扱わなくてもいいようにmodels.pyを使用します。

データベースへのアクセスをmodels.pyに記述されているクラスを操作することで、非常に簡単にデータベースを操作できます。

そのmodels.pyのモデル（オブジェクト）内には、def __str__(self)の記載があります。
これはどういった役割をモデルの中で行っているのか。

girlsチュートリアルなどでは詳しい説明がなかったので、ここではdef __str__(self)について解説してみたいと思います。

def str(self)とは

まず結論からお伝えすると、
def __str__(self)により、管理画面に表示されるモデル内のデータ（レコード）を判別するための、名前（文字列）を定義することができます。

def __str__(self)がない場合、管理画面の表示から、データを判別することができないため、管理が難しくなります。

後述する実際の表示画面を見て、どのように変化するのか確かめてください。

models.pyでのdef str(self)設定方法

models.pyでのdef __str__(self)の設定方法を解説します。

models.py内でモデル、フィールドの定義ができたら、そのモデル内に以下のようにdef__str__(self)を追記します。

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

class Post(models.Model):
    title = models.CharField(max_length=200)
    text = models.TextField()
    created_date = models.DateTimeField(default=timezone.now)

    def __str__(self):
        return self.title

上記サンプルでは、Postモデル内にtitle、text、created_dateフィールドを定義しており、def __str__(self)内では、titleフィールドを返すようにしています。

このreturnで設定するフィールド項目が管理画面でそのデータ（レコード）を判別できるように表示されます。

selfは、そのオブジェクト自身を指しております。