はてなの金次郎

とあるエンジニアの技術系ブログ

DjangoのINSTALLED_APPSの順番がめちゃくちゃ重要だった話

Django Python Programming

TL;DR

  • INSTALLED_APPS は最初にリストされているアプリケーションのソースコードが優先される
  • INSTALLED_APPS は ローカルアプリケーション・サードパーティアプリケーション・Djangoアプリケーション という順番にしたほうがよい
INSTALLED_APPS = [
    # Local apps
    'polls.apps.PollsConfig',

    # Third party apps
    'rest_framework',

    # Django apps
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
]
  • 上記の順番にするとテンプレートや静的ファイル、マネジメントコマンドを上書きする変更が反映される

INSTALLED_APPS

Djangoの環境変数に INSTALLED_APPS という環境変数があります。

これはDjangoインスタンスの中で有効化されているすべてのDjangoアプリケーションの名前を保持するリストの環境変数です。

django-admin startproject で作成されたDjangoアプリケーションの INSTALLED_APPS はデフォルトで以下のアプリケーションを保持しています。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

この INSTALLED_APPS を編集するタイミングが主に2パターンあると思います。ひとつは django-admin startapp でローカルアプリケーションを追加した場合。もうひとつはサードパーティのライブラリをインストールした場合です。

django-admin startapp でローカルアプリケーションを作成したら、そのアプリケーションおよびモデルを有効化するために INSTALLED_APPS に追加する必要があります。例えば、 polls というローカルアプリケーションを作成した場合以下のように追加します。

INSTALLED_APPS = [
    ...
    'polls.apps.PollsConfig',
    ...
]

※ ちなみに、単に polls と追加するのはタブーです。

Your code should never access INSTALLED_APPS directly. Use django.apps.apps instead.

FYI: https://docs.djangoproject.com/en/2.1/ref/settings/#installed-apps

また、サードパーティのライブラリをインストールしたら INSTALLED_APPS にアプリケーションを追加する必要がある場合があります。例えば Django REST Frameworkは以下のように rest_framework を追加する必要があります。

INSTALLED_APPS = [
    ...
    'rest_framework',
    ...
]

INSTALLED_APPSの順番

INSTALLED_APPS に関する順番に関しては特に公式ドキュメントには記載されていません。
また、さまざまなサードパーティの README やドキュメント、Djangoに関する記事を見てきましたが本当にバラバラで多種多様です。

私自身も1週間前までは特に順番を意識することなく、Djangoアプリケーション・サードパーティアプリケーション・ローカルアプリケーションの順番でなんとなくまとめているという状況でした。

順番が重要だと気付いたのは、Django管理画面の既存のテンプレートや静的ファイルをカスタマイズしたい・上書きしたいという状況の時でした。ドキュメント通りに変更を加えたつもりが一切変更は反映されなかったのです。

このときはじめて INSTALLED_APPS に関するドキュメントを読んで、最初にリストされるアプリケーションのリソース（テンプレートや静的ファイル、マネジメントコマンド、翻訳）が優先される ということを知りました。

When several applications provide different versions of the same resource (template, static file, management command, translation), the application listed first in INSTALLED_APPS has precedence.

FYI: https://docs.djangoproject.com/en/2.1/ref/settings/#installed-apps

上記の仕様があるため、サードパーティやDjangoの既存のリソースを上書きするような場合、上書きしたリソースがきちんと反映されるためにはそのリソースが含まれるアプリケーション（ローカルアプリケーションであることがほとんどだと思いますが）が上書きしたいリソースのアプリケーション（サードパーティやDjango）より優先されていなければなりません。

つまり、サードパーティやDjangoの既存のリソースを上書きするような場合、以下のような順番にする必要があります。

INSTALLED_APPS = [
    # Local apps
    'polls.apps.PollsConfig',

    # Third party apps
    'rest_framework',

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

最も反映させたいのは言わずもがなローカルアプリケーションです。次にサードパーティアプリケーションです。サードパーティがDjangoのリソースを上書きする場合があるためです。

カスタマイズは必要なくて上書きもしない場合は特にこれを意識する必要はありませんが、私のようにいざそのシチュエーションがきたとき、 INSTALLED_APPS が適切な順番でなかったら変更が反映されず混乱することになります。エラーが何か出力されるわけではないので原因の特定にもかなり苦労しました。

そんなことがないように INSTALLED_APPS の順番には意味があることをぜひ知っておいていただきたいです。余裕があれば自分のプロジェクトの INSTALLED_APPS の順番を見直してみてください。