【Django】INSTALLED_APPS の適切な書き方

June 21, 2022

DjangoのINSTALLED_APPSは、最初に記載されているアプリケーションが優先されるため、記載する順番が重要なのだそうです。

正しい書き方。上から順に、

ローカルアプリケーション
サードパーティアプリケーション
Djangoアプリケーション

INSTALLED_APPS = [ 
    #Local apps
    'test.apps.TestConfig',

    #Third party apps
    'rest_framework',

    #Django apps
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

INSTALLED_APPSは、最初にリストされているアプリケーションが優先されるので、Django管理画面の既存のテンプレートや静的ファイルをカスタマイズしたい・上書きしたいという状況の時に、Djangoアプリケーションを上位に記載していると、そちらが優先されてしまい、変更が反映されないそうです。

適切に記載することで、テンプレートや静的ファイル、マネジメントコマンドを上書きする変更が反映されるそうです。

また、'test.apps.TestConfig',を'test,'のように、直接アプリ名を書いてはいけないそうです。

これらを知ることで、将来起こりうる問題を事前に回避することが出来ました。