【Django】ローカルの設定でdjango-debug-toolbarをサクっとセットアップする方法

今回は、Djangoの環境構築の一環で、デバッグに便利なdjango-debug-toolbarをインストールします。

基本的には公式のドキュメントを参照してます。
pip install django-debug-toolbar は完了している前提で進めます。

django-debug-toolbarの使用までに編集が必要なファイルは以下の2つです。

・Settingsファイル（今回はローカル用のSettingsを編集）
・ルートURLファイル

まずはSettingsの編集です。
ローカル用の設定ファイルに、以下のコードを追記してください。

INSTALLED_APPSとMIDDLEWAREは、メインの設定ファイルへの追記ではなく、上書きで実装しています。
完全に設定を分けるなら追記ではなく、上書きの方がローカルと本番の設定の差異をイメージしやすくていいかなという、個人的なスタイルです。

#Configディレクトリ/local_settings.py

DEBUG = True

ALLOWED_HOSTS = ['*']

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '=7boxe6j8#zo!71%2(gh7_02)a&_q7!5xao(%r=ep&wj!sa67%'

# Application definition
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    #plugins
    'debug_toolbar',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    #plugins
    'debug_toolbar.middleware.DebugToolbarMiddleware',
]

def show_toolbar(request):
    return True

DEBUG_TOOLBAR_CONFIG = {
    'SHOW_TOOLBAR_CALLBACK': show_toolbar,
}

INTERNAL_IPS = ['127.0.0.1']

次に、Urlsを編集します。
同じく末尾に、こちらを入力してください。

# Configディレクトリ /urls.py

#
＃省略
#

from django.conf import settings
if settings.DEBUG:
import debug_toolbar

urlpatterns += [
path('__debug__/', include(debug_toolbar.urls)),
]

これでデバッグモードでWEBサーバを立ち上げれば、サイドバーにdjango-debug-toolbarが表示されるようになります！