Django 除錯(debug)實用技巧

雖然目前 Django 1.9 (or later) 的除錯模式(debug mode)已經十分實用了，包含 exception, traceback, frame, code 都會清楚的顯示出來。但不見得每次都可以開啟除錯模式或者有最新版的 Django 可以使用，這時候還是有幾個實用的技巧能夠使用。

pdb & Django Client #

這個技巧適合在沒有除錯模式時使用。主要是利用 Django 的 test client 搭配 python 的 pdb 模組進行除錯。

假設有一個 view 會有預期的例外(exception)發生，就可以用 client 去 get/post 該 view ，例如以下的極簡範例，就是用 test client 去 get 一個會有例外發生的頁面：

# my_test_client.py
import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "your_django.settings")
import django
django.setup()

from django.test import Client


if __name__ == '__main__':
    Client().get('/you_will_get_an_exception')

接著就可以使用以下指令利用 python 的 pdb 進行除錯：

$ python -m pdb my_test_client.py

更多 Django test client

更多 pdb

Werkzeug - The Python WSGI Utility Library #

如果是較舊的 Django ，則可以搭配 Werkzeug 這個不錯的 Python WSGI Utility Library 來增強舊版本的 Django 除錯模式的不足。最棒的特點是可以直接在除錯模式的頁面上使用 python interactive console ，超棒！

安裝方法：

$ pip install Werkzeug

使用方法：

在 Django project 的 wsgi.py 找到 application = get_wsgi_application() 後先註解起來，並添加以下的程式碼就可以了。

# wsgi.py
# ...
#application = get_wsgi_application()
from werkzeug.debug import DebuggedApplication
application = DebuggedApplication(get_wsgi_application, evalex=True)

當然也可以利用一個 DEBUG 的變數作為開啟或關閉這個功能的 flag 。

更多 Werkzeug

python pdb django client werkzeug