{"title":"はじめての Django アプリ作成、その 7","version":"4.1","locale":"ja","docname":"intro/tutorial07","url":"/ja/4.1/intro/tutorial07/","canonical":"https://djangodocs.dev/ja/4.1/intro/tutorial07/","summary":"This tutorial begins where Tutorial 6 left off. We're continuing the web-poll application and will focus on customizing Django's automatically-generated…","html":"

はじめての Django アプリ作成、その 7Link to this heading#

\n

This tutorial begins where Tutorial 6 left off. We're\ncontinuing the web-poll application and will focus on customizing Django's\nautomatically-generated admin site that we first explored in Tutorial 2.

\n\n
\n

admin フォームのカスタマイズLink to this heading#

\n

admin.site.register(Question) の呼び出しによって Question モデルを登録したことで、Django はデフォルトの形式でオブジェクトを表示できました。 admin フォームの表示方法や操作の仕方をデフォルトから変更したいこともよくあります。それには、オブジェクトを登録する時にオプションを指定します。

\n

ためしに、編集フォームでのフィールドの並び順を並べ替えてみましょう。 admin.site.register(Question) の行を以下のように置き換えてみてください。

\n
polls/admin.py
\n
Python
from django.contrib import admin\n\nfrom .models import Question\n\n\nclass QuestionAdmin(admin.ModelAdmin):\n    fields = ['pub_date', 'question_text']\n\nadmin.site.register(Question, QuestionAdmin)\n
\n

このように、モデルの admin のオプションを変更したいときには、モデルごとに admin クラスを作成して、 admin.site.register() の 2 番目の引数に渡すと いうパターンに従ってください。

\n

上の例では、「Publication date」フィールドの表示位置を「Question」フィールドよりも前に変更しています:

\n\"Fields\n

二つしかフィールドがないので、あまりぱっとした変化ではありませんね。しかし admin フォームで数十ものフィールドを操作するような場合には、直感的なフィー ルドの並び順というものはユーザビリティ上重要な要素です。

\n

また、数十ものフィールドがある場合、フォームを複数のフィールドセットに分割したいこともあるでしょう。

\n
polls/admin.py
\n
Python
from django.contrib import admin\n\nfrom .models import Question\n\n\nclass QuestionAdmin(admin.ModelAdmin):\n    fieldsets = [\n        (None,               {'fields': ['question_text']}),\n        ('Date information', {'fields': ['pub_date']}),\n    ]\n\nadmin.site.register(Question, QuestionAdmin)\n
\n

fieldsets の各タプルの先頭の要素はフィールドセットのタイトルです。 フォームは以下のように表示されます。

\n\"Form\n
\n\n
\n

管理サイトのチェンジリストページをカスタマイズするLink to this heading#

\n

さあ、これで Question の管理ページはだいぶよくなってきました。今度は「チェンジリスト」ページをすこしいじりましょう。チェンジリスト (change list) は、システム上の全ての Question を表示するページです。

\n

現時点では以下のように表示されています。

\n\"Polls\n

デフォルトでは、 Django はオブジェクトの str() を表示します。しかし、オブジェクトの各フィールドの値を表示したい場合もあるでしょう。各フィールドの値を表示させるには、 list_display オプションを使います。このオプションには、カラム表示したいフィールドの名前をタプルにして指定します。

\n
polls/admin.py
\n
Python
class QuestionAdmin(admin.ModelAdmin):\n    # ...\n    list_display = ('question_text', 'pub_date')\n
\n

念のため、 Tutorial 2 の was_published_recently() メソッドも含めましょう。

\n
polls/admin.py
\n
Python
class QuestionAdmin(admin.ModelAdmin):\n    # ...\n    list_display = ('question_text', 'pub_date', 'was_published_recently')\n
\n

これで、Question のチェンジリストのページは以下のようになります:

\n\"Polls\n

カラムのヘッダをクリックすると、カラムの値に応じてエントリを並べ換えできます。ただし was_published_recently ヘッダは例外であり、これはメソッドの戻り値を使った並べ換えをサポートしていないからです。 was_published_recently のカラムヘッダは、デフォルトではメソッド名 (アンダースコアを空白に置き換えたもの) になっていることに注目してください。また、各行は戻り値の文字列表現となっています。

\n

これを改善するには、display() デコレータを次のように (polls/models.py の) メソッドに使います:

\n
polls/models.py
\n
Python
from django.contrib import admin\n\nclass Question(models.Model):\n    # ...\n    @admin.display(\n        boolean=True,\n        ordering='pub_date',\n        description='Published recently?',\n    )\n    def was_published_recently(self):\n        now = timezone.now()\n        return now - datetime.timedelta(days=1) <= self.pub_date <= now\n
\n

デコレータで設定できるプロパティに関する詳しい情報は、list_display を参照してください。

\n

polls/admin.py ファイルをもう一度編集して、Question のチェンジリストのページに list_filter を追加して、さらに改良しましょう。それには、QuestionAdmin に次に行を追加します。

\n
Code
list_filter = ['pub_date']\n
\n

これで、「フィルタ (Filter)」サイドバーができ、チェンジリストを pub_date フィールドの値に従ってフィルタできるようになります。

\n\"Polls\n

フィルタの種類は、フィルタ対象のフィールドの種類に応じて変化します。pub_date は DateTimeField なので、Django はこのフィールドにふさわしいフィルタオプションが、「すべての期間 ("Any date")」「今日 ("Today")」「今週 ("Past 7 days")」「今月 ("This month")」であることを知っているのです。

\n

いい感じに体裁が整ってきました。今度は検索機能を追加してみましょう。

\n
Code
search_fields = ['question_text']\n
\n

これでチェンジリストの上部に検索ボックスが表示されます。ユーザが検索語を入力すると、 Django は question_text フィールドを検索します。フィールドはいくらでも使えますが、舞台裏では LIKE クエリを使うのでデータベースに過剰な負荷をかけないために常識的な範囲にしましょう。

\n

さて、ここでお知らせしたいこととして、チェンジリストには最初からページ分割機能があります。デフォルトではページあたり 100 個の要素を表示します。ページ分割、検索ボックス、フィルタ、日付による階層化、カラムヘッダを使った並び替え の機能は、すべて協調して思いのままに動作します。

\n
\n
\n

管理サイトのルック & フィールをカスタマイズするLink to this heading#

\n

管理サイトの上部には「Django 管理 (Django adminstration)」と表示されていますが、これはいささか滑稽ですね。これは単なるプレースホルダテキストにすぎません。

\n

ただし、Djangoのテンプレートシステムを使用して変更できます。 Django admin はDjango自体を利用しており、そのインターフェースはDjango独自のテンプレートシステムを使用しています。

\n
\n

プロジェクト テンプレートをカスタムする。Link to this heading#

\n

templates ディレクトリをプロジェクトディレクトリ (manage.py が置かれているディレクトリ) に作成してください。テンプレートは Django がアクセスできるファイルシステム内のどこに置いても構いません (アプリケーションサーバーを実行したユーザーでアクセスします)。しかし従うべき慣習として、テンプレートはプロジェクト内に置きましょう。

\n

設定ファイル (mysite/settings.py) を開いて、TEMPLATES 設定オプションの中に、次のように DIRS オプションを追加します。

\n
mysite/settings.py
\n
Python
TEMPLATES = [\n    {\n        'BACKEND': 'django.template.backends.django.DjangoTemplates',\n        'DIRS': [BASE_DIR / 'templates'],\n        'APP_DIRS': True,\n        'OPTIONS': {\n            'context_processors': [\n                'django.template.context_processors.debug',\n                'django.template.context_processors.request',\n                'django.contrib.auth.context_processors.auth',\n                'django.contrib.messages.context_processors.messages',\n            ],\n        },\n    },\n]\n
\n

DIRS は、Django がテンプレートを読み込む時にチェックする、ファイルシステム上のディレクトリのリストです。サーチパスのようなものです。

\n\n

さて、templates の中に admin という名前のディレクトリを作りましょう。Django 自体のソースコード内にある、デフォルトの Django admin テンプレートディレクトリ (django/contrib/admin/templates) を探して、 admin/base_site.html というテンプレートを、新しく作ったディレクトリにコピーします。

\n\n

そして、ファイルを編集して {{ site_header|default:_('Django administration') }} を置き換えます。(中括弧を含む)に自分のサイト名を入れてください。最終的には、次のようなコードのセクションになるはずです:

\n
Django template
{% block branding %}\n<h1 id="site-name"><a href="{% url 'admin:index' %}">Polls Administration</a></h1>\n{% endblock %}\n
\n

このようなアプローチを今使ったのは、テンプレートをオーバーライドする方法を示すためです。実際のプロジェクトで今行ったのと同じカスタマイズを行いたい場合には、 django.contrib.admin.AdminSite.site_header 属性を使えば、もっと簡単に設定できます。

\n

このテンプレートファイルは {% block branding %} や {{ title }} のようなテキストを多く含んでいます。 {% と {{ のタグは Django のテンプレート言語の一部です。 チュートリアル その3 で見たように、Djangoが admin/base_site.html をレンダリングする時に、このテンプレート言語が評価され、最終的なHTMLページが生成されます。

\n

Django のデフォルトのadminテンプレートはすべてオーバーライドできることに注意してください。テンプレートを上書きするには、base_site.html で行ったのと同じことをしてください -- デフォルトのディレクトリからカスタムディレクトリにコピーして変更してください。

\n
\n
\n

アプリケーション用の テンプレートをカスタマイズするLink to this heading#

\n

するどい読者はこう質問されるでしょう: DIRS はデフォルトで空っぽなのに、 Django はなぜデフォルトの admin テンプレートを見つけることができたのだろう? その答えは APP_DIRS が True に設定されているため、 Django は自動的に各アプリケーションのパッケージのサブディレクトリからフォールバックとして templates/ を探すからです (django.contrib.admin は一つのアプリケーションだということを忘れないでください)。

\n

投票アプリケーションはそれほど複雑ではないので、カスタムの admin テンプレートは必要ないでしょう。しかしアプリケーションがさらに凝ったものに成長し、何か機能を実現するために標準の admin テンプレートを変更する必要が出てきた場合、 アプリケーションの テンプレートを編集するほうが、 プロジェクト のテンプレートを編集するより賢い選択になるでしょう。そうすれば、投票アプリケーションを他のどの新しいプロジェクトにも追加でき、投票アプリケーションが（自分自身に必要な）カスタムテンプレートを確実に見つけることができます。

\n

Django のテンプレートの検索方法に関する詳しい情報は、テンプレート読み込み ドキュメント を参照してください。

\n
\n
\n
\n

admin index ページをカスタムするLink to this heading#

\n

近い話題として、 Django の admin index ページのルックアンドフィールをカスタマイズもできます。

\n

デフォルトでは、 admin アプリケーションで登録された INSTALLED_APPS のすべてのアプリケーションが、アルファベット順に表示されます。レイアウトを大きく変更したい場合もあるでしょう。なんといっても、index ページは admin の中でおそらく最も重要なページなので、使いやすいほうがいいですからね。

\n

カスタマイズ対象のテンプレートは admin/index.html です。 (前セクションで admin/base_site.html にしたことと同じことをしてください。つまり、デフォルトのディレクトリからコピーして、カスタムテンプレートのディレクトリに配置してください)。編集してみると app_list というテンプレート変数が使われているのがわかるでしょう。この変数にはインストールされた全 Django アプリが含まれています。これを使う代わりに、各オブジェクトの admin ページヘのリンクをハードコードし、好きなようにカスタマイズできます。

\n
\n
\n

次は何をしましょうか？Link to this heading#

\n

これで、初めての人のためのチュートリアルはおしまいです。次のステップへ では、ここから進める場所について説明しています。

\n

Python のパッケージングについて知っていて、polls アプリケーションを「再利用可能なアプリケーション」へと変える方法について学びたい場合は、チュートリアル 応用編: 再利用可能なアプリケーションの書き方 を読んでみてください。

\n
","rootId":"writing-your-first-django-app-part-7","toc":[{"title":"admin フォームのカスタマイズ","anchor":"customize-the-admin-form","children":[]},{"title":"リレーションを張ったオブジェクトの追加","anchor":"adding-related-objects","children":[]},{"title":"管理サイトのチェンジリストページをカスタマイズする","anchor":"customize-the-admin-change-list","children":[]},{"title":"管理サイトのルック & フィールをカスタマイズする","anchor":"customize-the-admin-look-and-feel","children":[{"title":"プロジェクト テンプレートをカスタムする。","anchor":"customizing-your-project-s-templates","children":[]},{"title":"アプリケーション用の テンプレートをカスタマイズする","anchor":"customizing-your-application-s-templates","children":[]}]},{"title":"admin index ページをカスタムする","anchor":"customize-the-admin-index-page","children":[]},{"title":"次は何をしましょうか？","anchor":"what-s-next","children":[]}],"breadcrumbs":[{"docname":"intro/index","title":"さぁ始めましょう","url":"/ja/4.1/intro/"}],"prev":{"docname":"intro/tutorial06","title":"はじめての Django アプリ作成、その 6","url":"/ja/4.1/intro/tutorial06/"},"next":{"docname":"intro/reusable-apps","title":"高度なチュートリアル: 再利用可能アプリの書き方","url":"/ja/4.1/intro/reusable-apps/"},"formats":{"html":"/ja/4.1/intro/tutorial07/","markdown":"/ja/4.1/intro/tutorial07.md","json":"/ja/4.1/intro/tutorial07.json"},"source":"https://github.com/django/django/blob/stable/4.1.x/docs/intro/tutorial07.txt","official":"https://docs.djangoproject.com/ja/4.1/intro/tutorial07/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}