django-debug-toolbarを設定する

Django Python デバック

概要

こんにちは、すずです。
Djangoを使ってweb開発をしているとrunserverを起動しながらデバックをとりたいという場面が多く感じると思います。

web開発はPythonコードが原因でエラーしているとは限らないからです。
というか多くはデータベース関連のエラーが多いですよね...あとはurlとかね(^^)
ともかくすぐにエラーが出てどこでバグってるのかわからないという状況が多いですよねｗ

エラーが出てやりたいことのモチベーションが下がっていくというのは
モチベ低下の鉄板ですね笑

今回はエラーを迅速に対処するためのツールをご紹介いたします!(^^)!

django-debug-toolbarとは

詳しいことはググってくださいｗ
というのは半分嘘で、個人的に使える機能を紹介しておきます

SQLパネル
この機能の恩恵が一番大きいと思います
runserverを起動しながら、使用されたクリエを確認することができます
どこでバグってん！？なんで検索結果ちゃうねんっ！！って時に役立ちます笑

Templates
これはシンプルにテンプレート周りのバグが（初心者のうちは特に）多いからです。
ターミナルで確認するよりもわかりやすいです(^^)/

それでは実際に使っていきましょう！！

環境

Pytho3.7.2
Django2.1.7
django-debug-toolbar1.11

やり方

まずはdjango-debug-toolbarをインストールしましょう↓↓

$ pip install django-debug-toolbar

これで自身の環境にdjango-debug-toolbarを入れることができました！
次はsettings.pyにアプリ使用の設定をしましょう(^^)/

settings.py

# mysite/mysite/settings.py
# settings.pyの一番下に付け足しましょう

・・・・
・・・・・・・

if DEBUG:
    def show_toolbar(request):
        return True


    INSTALLED_APPS += (
        'debug_toolbar',
    )
    MIDDLEWARE += (
        'debug_toolbar.middleware.DebugToolbarMiddleware',
    )
    # ここで表示する内容を設定できます↓↓基本的にはこれでok
    DEBUG_TOOLBAR_CONFIG = {
        'SHOW_TOOLBAR_CALLBACK': show_toolbar,
    }

if文を使ってDEBUGがTrueだった場合、設定を後付けするようにしております。
次にurls.pyの設定をしていきます

urls.py

# mysite/mysite/urls.py
# urls.pyの一番下に付け足しましょう

・・・・・
・・・・・・・

if settings.DEBUG:
    import debug_toolbar

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

こんな感じでやると使えるようになります
下の画像のように様々な項目をrunserver上でちちくりまわせます(ﾆﾔﾘ
詳しい使い方と見方とかは’習うより慣れよ’ですｗ
使ってるうちに「あ～～そゆことね。」ってなってくると思います(プログラムあるある)

参考画像

f:id:S2notC2:20190429161156p:plain

まとめ

今回はデバックツールの紹介でしたが、このdjango-debug-toolbarはDjango使う上で必須のツールだと思います。
ある程度経験を積まれている方はみんな使用していると思います(^^)

初心者の方も自分はまだ・・・と言わずに
早い段階で導入することでスキルがついたときには慣れていると思うので、早めの導入をお勧めします！

また実用編としては前に記事にもさせていただいた

s2notc2.hatenablog.com

と併用して使用することをお勧めします！
プロジェクトごとに何度も書くのはめんどくさいですからねｗ

Twitterではこんな感じにお役立ち情報を流してますので是非覗いてみてください

twitter.com