Barra de herramientas de depuración de Django

 

Hay muchas partes móviles debajo del capó de una aplicación web Django. Gran parte es muy transparente para el usuario del sitio, pero es importante que el desarrollador web sepa cómo funcionan las cosas para comprender cómo depurar problemas. Django tiene una barra de herramientas de depuración que puede instalar para permitir una inspección completa del entorno de Django durante el desarrollo. Una vez instalada, si carga su aplicación web localmente, verá una gran cantidad de información en un panel de depuración que ahora se muestra en el lado derecho de su navegador. En este tutorial, instalaremos la barra de herramientas de depuración de Django y la usaremos para inspeccionar cosas como configuraciones, encabezados, solicitudes HTTP, consultas SQL, archivos estáticos, plantillas, señales y más.

---

Instalar la barra de herramientas de depuración de Django

La instalación de la barra de herramientas de depuración es muy sencilla. El primer paso es simplemente usar pip para agregar el paquete python a su sistema. En la línea de comando, ingrese pip install django-debug-toolbar .

djangotutorial $ pip install django-debug-toolbar
Requisito ya satisfecho: django-debug-toolbar

Ya habíamos instalado la barra de herramientas, por lo que recibimos el mensaje de que el requisito ya está satisfecho. ¡Excelente!

---

Configurar la barra de herramientas de depuración

Instalar el paquete de Python en su máquina no es suficiente para que la barra de herramientas de depuración se muestre en su navegador web. Necesitamos configurar la barra de herramientas de depuración dentro de la configuración de Django para activarla. Esto se hace en el archivo settings.py y el archivo urls.py.

djangotutorial / settings.py
En nuestro archivo de configuración, hicimos los cambios resaltados a continuación. Estos se encuentran en las variables INSTALLED_APPS, MIDDLEWARE e INTERNAL_IPS.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

""" Django settings for djangotutorial project.   Generated by 'django-admin startproject' using Django 3.0.   For more information on this file, see https://docs.djangoproject.com/en/3.0/topics/settings/   For the full list of settings and their values, see https://docs.djangoproject.com/en/3.0/ref/settings/ """   import os   # Build paths inside the project like this: os.path.join(BASE_DIR, ...) BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))   # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/   # SECURITY WARNING: keep the secret key used in production secret! SECRET_KEY = 'n_x6notgo^4gs&real$zlnxsillyf(r187d6#q=)wqx4rt0!q'   # SECURITY WARNING: don't run with debug turned on in production! DEBUG = True   ALLOWED_HOSTS = []   # Application definition   INSTALLED_APPS = [     'django.contrib.admin',     'django.contrib.auth',     'django.contrib.contenttypes',     'django.contrib.sessions',     'django.contrib.messages',     'django.contrib.staticfiles',     'djangodogs',     'debug_toolbar' ]   MIDDLEWARE = [     'debug_toolbar.middleware.DebugToolbarMiddleware',     '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' ]   ROOT_URLCONF = 'djangotutorial.urls'   TEMPLATES = [     {         'BACKEND': 'django.template.backends.django.DjangoTemplates',         'DIRS': [],         'APP_DIRS': True,         'OPTIONS': {             'context_processors': [                 'django.template.context_processors.debug',                 'django.template.context_processors.request',                 'django.contrib.auth.context_processors.auth',                 'django.contrib.messages.context_processors.messages',             ],         },     }, ]   WSGI_APPLICATION = 'djangotutorial.wsgi.application'   # Database # https://docs.djangoproject.com/en/3.0/ref/settings/#databases   DATABASES = {     'default': {         'ENGINE': 'django.db.backends.sqlite3',         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),     } }   # Password validation # https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators   AUTH_PASSWORD_VALIDATORS = [     {         'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',     },     {         'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',     },     {         'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',     },     {         'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',     }, ]   # Internationalization # https://docs.djangoproject.com/en/3.0/topics/i18n/   LANGUAGE_CODE = 'en-us'   TIME_ZONE = 'UTC'   USE_I18N = True   USE_L10N = True   USE_TZ = True   # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/3.0/howto/static-files/   STATIC_URL = '/static/'   STATICFILES_DIRS = [     os.path.join(BASE_DIR, 'static') ]   INTERNAL_IPS = [     '127.0.0.1' ]

djangotutorial / urls.py
En urls.py, solo necesitamos hacer algunas ediciones. Así es como configuramos el nuestro.

1 2 3 4 5 6 7 8 9 10 11

from django.contrib import admin from django.urls import include, path from djangodogs import views import debug_toolbar   urlpatterns = [     path('__debug__/', include(debug_toolbar.urls)),     path('admin/', admin.site.urls),     path('', views.home, name='home'),     path('dogs/<id>/', views.dog_detail, name='dog_detail'), ]

---

¡Enciendan sus motores! (Servidores)

Todo está en su lugar y ahora podemos ejecutar nuestro servidor Python con el comando python manage.py runserver . Una vez que el servidor se está ejecutando, cargamos la página de inicio del proyecto en el que hemos estado trabajando recientemente y ¡vemos algo nuevo!

La captura de pantalla anterior es la página de inicio del sitio con la nueva barra de herramientas de depuración de Django que se muestra en el lado derecho. Como puede ver, ofrece varios paneles como versiones, hora, configuración, encabezados, solicitud, SQL, archivos estáticos, plantillas, caché, señales, registro y creación de perfiles.

Configuraciones

El panel de configuración proporciona información sobre el proyecto actual de Django. Al hacer clic en el panel de configuración, se muestran todas las configuraciones de nivel de proyecto.

Encabezados

El panel de encabezados muestra información sobre los encabezados de solicitud, los encabezados de respuesta y el entorno WSGI. Todo esto es útil para comprender el ciclo de solicitud-respuesta de cualquier página de su aplicación.

Solicitud

El panel de solicitud tiene información excelente sobre vistas, cookies, datos de sesión y si hay alguna variable GET o POST presente. Estamos visitando la página de inicio aquí, y podemos ver exactamente con la función de vista que es responsable de renderizar la plantilla. También se muestran los argumentos de la vista, los argumentos de las palabras clave y el nombre de la URL. La barra de herramientas de depuración es una herramienta fantástica para comprender realmente cómo funcionan las cosas en su aplicación Django.

SQL

El panel SQL de la barra de herramientas de depuración es realmente genial. Al hacer clic en este panel, se muestran las consultas SQL necesarias para proporcionar datos para la página determinada. Además, en la visualización de las consultas SQL, puede hacer clic en los botones Sel o Expl para ejecutar o explicar la consulta SQL en cuestión.

A continuación, se muestra un ejemplo de cómo ejecutar una de las consultas que se muestran.

Entonces ahora sabemos que al cargar la página de inicio de nuestro sitio, una de las consultas que se realizan es la siguiente.

SELECCIONE "djangodogs_dog". "Id",
       "djangodogs_dog". "nombre",
       "djangodogs_dog". "raza",
       "djangodogs_dog". "descripción"
  DE "djangodogs_dog"

¡Muy aseado! Sin embargo, ¿cómo sucede esto? Quizás recuerde que cuando creamos este proyecto de Django, en realidad nunca escribimos ninguna declaración SQL en el código Python. Esto se debe a que Django tiene su propio ORM incorporado o mapeador relacional de objetos. Lo que eso significa es que solo tenemos que usar cualquiera de los métodos proporcionados por Django ORM, y ejecuta la consulta SQL necesaria para nosotros. Entonces, el código de nuestro proyecto que está produciendo la consulta SQL que vemos arriba se encuentra en el archivo djangodogs / views.py . Esa línea de código está resaltada aquí.

1 2 3 4 5 6 7 8 9 10 11 12 13

from django.shortcuts import render from .models import Dog from django.http import Http404     def home(request):     dogs = Dog.objects.all()     return render(request, 'home.html', {'dogs': dogs})     def dog_detail(request, id):     dog = Dog.objects.get(id=id)     return render(request, 'dog_detail.html', {'dog': dog})

Como puede ver, esto es muy útil para comprender cómo su aplicación Django interactúa con la base de datos. Además, a medida que sus consultas a la base de datos se vuelven más complejas, puede usar la barra de herramientas de depuración para ver las declaraciones SQL exactas que el ORM de Django envía a la base de datos.

Resumen de la barra de herramientas de depuración de Django

La barra de herramientas de depuración de Django es una gran herramienta para desarrollar con Django. Tiene un conjunto configurable de paneles que muestran todo tipo de información útil de depuración sobre su proyecto Django. Cuando se hace clic en estos paneles, muestran información detallada como vimos en los ejemplos anteriores.