【django-debug-toolbar】の使い方と設定方法

2022-05-312024-03-23

当ページのリンクには広告が含まれています。

URLをコピーしました！

djangoでの開発環境で必須のdjango-debug-toolbar。

今回は導入方法と設定方法をご紹介いたします。

https://django-debug-toolbar.readthedocs.io/en/latest/

django-debug-toolbarのインストール

まずはインストール。

$ pip install django-debug-toolbar

settings.pyの分割

settings.pyに直接記入しても良いのですが、開発環境と本番環境用に設定ファイルを分割したほうがわかりやすいです。

今回は、ファイルを分割します。

詳細な設定方法は下記記事をご参照ください。

local.pyの作成

from .base import *

ALLOWED_HOSTS = ['*']

INSTALLED_APPS += [
    'debug_toolbar',
]

MIDDLEWARE += [
    'debug_toolbar.middleware.DebugToolbarMiddleware',
]

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'django',
        'USER': 'admin',
        'PASSWORD': 'admin',
        'PORT': '5433'
    }
}

INTERNAL_IPS = ['127.0.0.1']

INSTALLED_APPS
MIDDLEWARE
INTERNAL_IPS

それぞれ追加します。
データベース設定は適宜記入してください。

urls.pyの記入

from django.contrib import admin
from django.urls import path, include

from .settings.base import DEBUG

urlpatterns = [
    path('admin/', admin.site.urls),
]

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

DEBUG=True時のみdebug-toolbarを有効にします。これで設定完了です。