Django 2008
Cargado por
Anonymous 0QRYC8xDjango 2008
Cargado por
Anonymous 0QRYC8xEl libro de Django
Autores: Adrian Holovaty y Jacob Kaplan-Moss
Editor tcnico: Jeremy Dunck
NOTA: Este trabajo de traduccin an no est completo.
Nmero de revisin: 757
Fecha de compaginacin: 28 de julio de 2008
ndice general
Preliminares
xvii
Reconocimientos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
Sobre los autores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
Sobre el editor tcnico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
Sobre los traductores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xviii
Sobre el libro
xviii
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduccin
xix
1. Introduccin a Django
1.1.
Qu es un Framework Web?
1.2.
El patrn de diseo MVC
1.3.
La historia de Django
1.4.
Cmo leer este libro
1.5.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.1.
Conocimientos de programacin requeridos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.
Conocimientos de Python requeridos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.3.
Nuevas caractersticas de Django . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.
Obteniendo ayuda
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2. Empezando
2.1.
Instalar Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.
Instalar Django . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2.1.
Instalar un lanzamiento o cial
2.2.2.
Instalar Django desde Subversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Con gurando la base de datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.1.
Usar Django con PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.2.
Usar Django con SQLite 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.3.
Usar Django con MySQL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.4.
Usar Django sin una base de datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.3.
2.4.
Comenzando un proyecto
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
El servidor de desarrollo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
2.4.1.
2.5.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3. Los principios de las pginas Web dinmicas
13
3.1.
Tu primera Vista: Contenido dinmico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
3.2.
Mapeando URLs a Vistas
14
3.3.
Cmo procesa una peticin Django . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16
3.3.1.
. . . . . . . . . . . . . . . . . . . . . .
16
3.4.
URLconfs y el acoplamiento dbil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
3.5.
Errores 404
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18
3.6.
Tu segunda Vista: URLs dinmicas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cmo procesa una peticin Django: Detalles completos
3.6.1.
Algunas palabras acerca de las URLs bonitas . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
3.6.2.
Comodines en los patrones URL
20
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.7.
Pginas de error bonitas con Django
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
3.8.
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
revisin 757 del 28 de julio de 2008
NDICE GENERAL
iv
4. El sistema de plantillas de Django
4.1.
Sistema bsico de plantillas
4.2.
Empleo del sistema de plantillas
4.3.
25
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
4.2.1.
Creacin de objetos Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
4.2.2.
Renderizar una plantilla . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
4.2.3.
Mltiples contextos, mismas plantillas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
4.2.4.
Bsqueda del contexto de una variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
4.2.5.
Jugando con objetos Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
Etiquetas de plantillas bsicas y ltros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
4.3.1.
Etiquetas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
4.3.2.
Filtros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
4.4.
Filosofa y Limitaciones
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
4.5.
Uso de plantillas en las vistas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
38
4.6.
Cargadores de plantillas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
4.6.1.
render_to_response() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
4.6.2.
El truco locals()
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
42
4.6.3.
Subdirectorios en get_template() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
4.6.4.
La etiqueta de plantilla
43
include
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.7.
Herencia de plantillas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
4.8.
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
5. Interactuar con una base de datos: Modelos
47
5.1.
La manera tonta de hacer una consulta a la base de datos en las vistas . . . . . . . . . . . . . . . . .
47
5.2.
El patrn de diseo MTV
48
5.3.
Con guracin de la base de datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
49
5.4.
Tu primera aplicacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
5.5.
De nir modelos en Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
5.6.
Tu primer modelo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
5.7.
Instalando el modelo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
54
5.8.
Acceso bsico a datos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
5.9.
Agregando strings de representacin del modelo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.10. Insertando y actualizando datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
57
5.11. Seleccionar objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
5.11.1. Filtrar datos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.11.2. Obteniendo objetos individuales
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59
60
5.11.3. Ordenando datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60
5.11.4. Encadenando bsquedas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
5.11.5. Rebanando datos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
5.12. Eliminando objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
62
5.13. Realizando cambios en el esquema de una base de datos
62
. . . . . . . . . . . . . . . . . . . . . . . . . .
5.13.1. Agregando campos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
62
5.13.2. Eliminando campos
64
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.13.3. Eliminando campos Many-to-Many . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
5.13.4. Eliminando modelos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
5.14. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65
6. El sitio de Administracin Django
67
6.1.
Activando la interfaz de administracin
6.2.
Usando la interfaz de administracin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
6.2.1.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
6.3.
Personalizando la interfaz de administracin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
6.4.
Personalizando la apariencia de la interfaz de administracin
77
6.5.
Personalizando la pgina ndice del administrador . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
79
6.6.
Cundo y porqu usar la interfaz de administracin . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
79
6.7.
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
79
Usuarios, Grupos y Permisos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . .
revisin 757 del 28 de julio de 2008
67
NDICE GENERAL
7. Procesamiento de formularios
81
7.1.
Bsquedas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.2.
El formulario perfecto
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
83
7.3.
Creacin de un formulario para comentarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
83
7.4.
Procesamiento de los datos suministrados
86
7.5.
Nuestras propias reglas de validacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
7.6.
Una presentacin personalizada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
88
7.7.
Creando formularios a partir de Modelos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
7.8.
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8. Vistas avanzadas y URLconfs
8.1.
91
Trucos de URLconf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
8.1.1.
Importacin de funciones de forma efectiva
91
8.1.2.
Usar mltiples pre jos de vista
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
8.1.3.
Casos especiales de URLs en modo Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
8.1.4.
Usar grupos con nombre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
8.1.5.
Comprender el algoritmo de combinacin/agrupacin . . . . . . . . . . . . . . . . . . . . . . . .
95
8.1.6.
Pasarle opciones extra a las funciones vista
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
95
8.1.7.
Usando argumentos de vista por omisin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
99
8.1.8.
Manejando vistas en forma especial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
100
8.1.9.
Capturando texto en URLs
8.3.
Incluyendo otras URLconfs
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8.1.10. Entendiendo dnde busca una URLconf
8.2.
100
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
101
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
101
8.2.1.
Cmo trabajan los parmetros capturados con include() . . . . . . . . . . . . . . . . . . . . . .
102
8.2.2.
Cmo funcionan las opciones extra de URLconf con include() . . . . . . . . . . . . . . . . . . .
102
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
103
9. Vistas genricas
105
9.1.
Usar vistas genricas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.2.
Vistas genricas de objetos
9.3.
Extender las vistas genricas
9.4.
81
105
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
106
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
107
9.3.1.
Crear contextos de plantilla amistosos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
108
9.3.2.
Agregar un contexto extra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
108
9.3.3.
Mostrar subconjuntos de objetos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
109
9.3.4.
Filtrado complejo con funciones wrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
109
9.3.5.
Realizar trabajo extra
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
110
Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
111
10.Extendiendo el sistema de plantillas
10.1. Revisin del lenguaje de plantillas
10.2. Procesadores de contexto
113
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
10.2.1. django.core.context_processors.auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
117
10.2.2. django.core.context_processors.debug
117
10.2.3. django.core.context_processors.i18n
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10.2.4. django.core.context_processors.request
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10.2.5. Consideraciones para escribir tus propios procesadores de contexto . . . . . . . . . . . . . . . .
10.3. Detalles internos de la carga de plantillas
10.4. Extendiendo el sistema de plantillas
117
117
117
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
118
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
119
10.4.1. Creando una biblioteca para plantillas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
119
10.4.2. Escribiendo ltros de plantilla personalizados . . . . . . . . . . . . . . . . . . . . . . . . . . . .
120
10.4.3. Escribiendo etiquetas de plantilla personalizadas
121
. . . . . . . . . . . . . . . . . . . . . . . . . .
10.4.4. Un atajo para etiquetas simples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
125
10.4.5. Etiquetas de inclusin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
125
10.5. Escribiendo cargadores de plantillas personalizados . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
126
10.6. Usando la referencia de plantillas incorporadas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
127
10.7. Con gurando el sistema de plantillas en modo autnomo . . . . . . . . . . . . . . . . . . . . . . . . . .
128
10.8. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
128
revisin 757 del 28 de julio de 2008
NDICE GENERAL
vi
11.Generacin de contenido no HTML
129
11.1. Lo bsico: Vistas y tipos MIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
129
11.2. Produccin de CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
130
11.3. Generando PDFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.3.1. Instalando ReportLab
131
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
131
11.3.2. Escribiendo tu Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
131
11.3.3. PDFs complejos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
132
11.4. Otras posibilidades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
133
11.5. El Framework de Feeds de Sindicacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
133
11.5.1. Inicializacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
133
11.5.2. Un Feed simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
134
11.5.3. Un Feed ms complejo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
135
11.5.4. Especi cando el tipo de Feed
136
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.5.5. Enclosures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
137
11.5.6. Idioma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
137
11.5.7. URLs
137
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.5.8. Publicando feeds Atom y RSS conjuntamente . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.6. El framework Sitemap
11.6.1. Instalacin
11.6.2. Inicializacin
137
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
138
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
138
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
139
11.6.3. Clases Sitemap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
139
11.6.4. Accesos directos
140
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.6.5. Creando un ndice Sitemap
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
141
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
141
11.7. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
142
11.6.6. Haciendo ping a Google
12.Sesiones, usuario e inscripciones
12.1. Cookies
143
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12.1.1. Cmo de nir y leer los valores de las cookies
143
. . . . . . . . . . . . . . . . . . . . . . . . . . . .
144
12.1.2. Las cookies tienen doble lo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
145
12.2. El entorno de sesiones de Django . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
145
12.2.1. Activar sesiones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
146
12.2.2. Usar las sesiones en una vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
146
12.2.3. Comprobar que las cookies sean utilizables
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
147
12.2.4. Usar las sesiones fuera de las vistas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
148
12.2.5. Cundo se salvan las sesiones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
148
12.2.6. Sesiones breves frente a sesiones persistentes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
149
12.2.7. Otras caractersticas de las sesiones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
149
12.3. Usuarios e identi cacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
150
12.3.1. Habilitando el soporte para autenti cacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
151
12.4. Utilizando usuarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
151
12.4.1. Iniciar y cerrar sesin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
153
12.4.2. Limitar el acceso a los usuarios identi cados . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
154
12.4.3. Limitar el acceso a usuarios que pasan una prueba
155
12.4.4. Gestionar usuarios, permisos y grupos
. . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12.4.5. Usar informacin de autenti cacin en plantillas
12.5. El resto de detalles: permisos, grupos, mensajes y per les
. . . . . . . . . . . . . . . . . . . . . . . . . .
156
158
. . . . . . . . . . . . . . . . . . . . . . . . .
159
12.5.1. Permisos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
159
12.5.2. Grupos
12.5.3. Mensajes
12.5.4. Per les
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
160
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
160
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
161
12.6. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
161
revisin 757 del 28 de julio de 2008
NDICE GENERAL
vii
13.Cache
163
13.1. Activando el Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
163
13.1.1. Memcached . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
164
13.1.2. Cache en Base de datos
164
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.1.3. Cache en Sistema de Archivos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
165
13.1.4. Cache en Memoria local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
165
13.1.5. Cache Simple (para desarrollo)
165
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.1.6. Cache Dummy (o estpida) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
165
13.1.7. Argumentos de CACHE_BACKEND
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
165
13.2. La cache por sitio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
166
13.3. Cache por vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.3.1. Especi cando la cache por vista en URLconf
. . . . . . . . . . . . . . . . . . . . . . . . . . . .
167
167
13.4. La API de cache de bajo nivel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
168
13.5. Caches upstream
169
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.5.1. Usando el encabezado Vary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
169
13.5.2. Otros Encabezados de cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
170
13.6. Otras optimizaciones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
171
13.7. Orden de MIDDLEWARE_CLASSES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
171
13.8. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
172
14.Otros sub-frameworks contribuidos
173
14.1. La biblioteca estndar de Django . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
173
14.2. Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
174
14.2.1. Escenario 1: reuso de los datos en mltiples sitios . . . . . . . . . . . . . . . . . . . . . . . . . .
174
14.2.2. Escenario 2: alojamiento del nombre/dominio de tu sitio en un solo lugar
174
. . . . . . . . . . . .
14.2.3. Modo de uso del framework sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
174
14.2.4. Las capacidades del framework Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
175
14.2.5. CurrentSiteManager
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
177
14.2.6. El uso que hace Django del framework Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
178
14.3. Flatpages
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
178
14.3.1. Usando atpages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
179
14.3.2. Agregando, modi cando y eliminando atpages . . . . . . . . . . . . . . . . . . . . . . . . . . .
180
14.3.3. Usando plantillas de atpages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
180
14.4. Redirects
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14.4.1. Usando el framework redirects
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
181
181
14.4.2. Agregando, modi cando y eliminando redirecciones . . . . . . . . . . . . . . . . . . . . . . . . .
181
14.5. Proteccin contra CSRF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
182
14.5.1. Un ejemplo simple de CSRF
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14.5.2. Un ejemplo ms complejo de CSRF
182
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
182
14.5.3. Previniendo la CSRF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
183
14.6. Haciendo los datos ms humanos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
184
14.6.1. apnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
184
14.6.2. intcomma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
184
14.6.3. intword
184
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14.6.4. ordinal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
184
14.7. Filtros de marcado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
185
14.8. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
185
15.Middleware
187
15.1. Qu es middleware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
187
15.2. Instalacin de Middleware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
188
15.3. Mtodos de un Middleware
188
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15.3.1. Inicializar: __init__(self )
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
188
15.3.2. Pre-procesador de peticin: process_request(self, request) . . . . . . . . . . . . . . . . . . . . .
188
15.3.3. Pre-procesador de vista: process_view(self, request, view, args, kwargs)
. . . . . . . . . . . . .
189
15.3.4. Pos-procesador de respuesta: process_response(self, request, response) . . . . . . . . . . . . . .
189
15.3.5. Pos-procesador de excepcin: process_exception(self, request, exception) . . . . . . . . . . . . .
15.4. Middleware incluido
189
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
190
15.4.1. Middleware de soporte para autenticacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
190
revisin 757 del 28 de julio de 2008
NDICE GENERAL
viii
15.4.2. Middleware Common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
190
15.4.3. Middleware de compresin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
190
15.4.4. Middleware de GET condicional
191
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15.4.5. Soporte para uso de proxy inverso (Middleware X-Forwarded-For)
. . . . . . . . . . . . . . . .
191
15.4.6. Middleware de soporte para sesiones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
15.4.7. Middleware de cache de todo el sitio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
15.4.8. Middleware de transaccin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
15.5. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
191
15.4.9. Middleware X-View
16.Integracin con Base de datos y Aplicaciones existentes
16.1. Integracin con una base de datos existente
16.1.1. Empleo de
inspectdb
193
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
193
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
193
16.1.2. Limpiar los modelos generados
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16.2. Integracin con un sistema de autenti cacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16.2.1. Especi car los back-ends de autenti cacin
194
194
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
195
16.2.2. Escribir un back-end de autenti cacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
195
16.3. Integracin con aplicaciones web existentes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
196
16.4. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
196
17.Extendiendo la Interfaz de Administracin de Django
199
17.1. El Zen de la aplicacin Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17.1.1. Usuarios con ables ...
200
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
200
17.1.2. ... editando ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
200
17.1.3. ... contenido estructurado
200
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17.1.4. Parada Completa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17.2. Pesonalizando las plantillas de la interfaz
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
200
201
17.2.1. Plantillas de modelos propios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
201
17.2.2. JavaScript Personalizado
203
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17.3. Creando vistas de administracin personalizadas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
203
17.4. Sobreescribiendo vistas incorporadas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
205
17.5. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
205
18.Internacionalizacin
207
18.1. Especi cando cadenas de traduccin en cdigo Python . . . . . . . . . . . . . . . . . . . . . . . . . . .
208
18.1.1. Funciones estndar de traduccin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
208
18.1.2. Marcando cadenas como no-op
209
18.1.3. Traduccin perezosa
18.1.4. Pluralizacin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
209
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
209
18.2. Especi cando cadenas de traduccin en cdigo de plantillas
. . . . . . . . . . . . . . . . . . . . . . . .
210
18.3. Creando archivos de idioma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
211
18.3.1. Creando los archivos de mensajes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
211
18.3.2. Compilando archivos de mensajes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
212
18.4. Cmo descubre Django la preferencia de idioma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
212
18.5. La vista de redireccin set_language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
214
18.6. Usando traducciones en tus propios proyectos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
214
18.7. Traducciones y JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18.7.1. La vista javascript_catalog
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18.7.2. Usando el catlogo de traducciones JavaScript
215
215
. . . . . . . . . . . . . . . . . . . . . . . . . . .
216
18.7.3. Creando catlogos de traducciones JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . .
216
18.8. Notas para usuarios familiarizados con
gettext
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
217
18.9. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
217
revisin 757 del 28 de julio de 2008
NDICE GENERAL
ix
19.Seguridad
219
19.1. El tema de la seguridad en la Web
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
219
19.2. Inyeccin de SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
219
19.2.1. La solucin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.3. Cross-Site Scripting (XSS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.3.1. La solucin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.4. Cross-Site Request Forgery
220
221
221
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
222
19.5. Session Forging/Hijacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
222
19.5.1. La solucin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.6. Inyeccin de cabeceras de email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.6.1. La solucin
223
223
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
224
19.7. Directory Traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
224
19.7.1. La solucin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.8. Exposicin de mensajes de error
19.8.1. La solucin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.9. Palabras nales sobre la seguridad
224
225
225
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
225
19.10.Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
226
20.Implementando Django
227
20.1. Nada Compartido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20.2. Un nota sobre preferencias personales
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20.3. Usando Django con Apache y mod_python
227
228
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
229
20.3.1. Con guracin bsica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
229
20.3.2. Corriendo multiples instalaciones de Django en la misma instancia Apache
. . . . . . . . . . .
230
. . . . . . . . . . . . . . . . . . . . . . .
231
20.3.4. Sirviendo Django y archivos multimedia desde la misma instancia Apache . . . . . . . . . . . .
231
20.3.5. Manejo de errores
232
20.3.3. Corriendo un servidor de desarrollo con mod_python
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20.3.6. Manejando fallas de segmentacin
20.4. Usando Django con FastCGI
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
232
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
232
20.4.1. Descripcin de FastCGI
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20.4.2. Ejecutando tu Servidor FastCGI
232
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
233
20.4.3. Usando Django con Apache y FastCGI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
234
20.4.4. FastCGI y lighttpd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
235
20.4.5. Ejecutando Django en un Proveedor de Hosting Compartido con Apache . . . . . . . . . . . . .
20.5. Escalamiento
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
236
236
20.5.1. Ejecutando en un Servidor nico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
237
20.5.2. Separando el Servidor de Bases de Datos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
237
20.5.3. Ejecutando un Servidor de Medios Separado . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
237
20.5.4. Implementando Balance de Carga y Redundancia . . . . . . . . . . . . . . . . . . . . . . . . . .
239
20.5.5. Yendo a lo grande
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
239
20.6. Ajuste de Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
20.6.1. No hay tal cosa como demasiada RAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
20.6.2. Deshabilita Keep-Alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
20.6.3. Usa memcached
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
20.6.4. Usa memcached siempre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
20.6.5. nete a la Conversacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
243
20.7. Qu sigue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
243
A. Casos de estudio
245
A.1. Elenco . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
245
A.2. Por qu Django? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
246
A.3. Comenzando
247
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A.4. Portando cdigo existente . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
247
A.5. Cmo les fue?
247
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A.6. Estructura de Equipo
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
249
A.7. Implementacin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
249
revisin 757 del 28 de julio de 2008
NDICE GENERAL
B. Referencia de la de nicin de modelos
B.1. Campos
251
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
251
B.1.1. AutoField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.2. BooleanField
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.3. CharField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.4. CommaSeparatedIntegerField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.5. DateField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.6. DateTimeField
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.8. FileField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
B.1.9. FilePathField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
253
B.1.7. EmailField
B.1.10. FloatField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
B.1.11. ImageField
254
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.1.12. IntegerField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
B.1.13. IPAddressField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
B.1.14. NullBooleanField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
B.1.15. PhoneNumberField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
B.1.16. PositiveIntegerField
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.1.17. PositiveSmallIntegerField
B.1.18. SlugField
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
254
254
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.1.19. SmallIntegerField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.1.20. TextField
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.1.21. TimeField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.1.22. URLField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.1.23. USStateField
255
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.1.24. XMLField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.2. Opciones Universales de Campo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
255
B.2.1. null
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
256
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
256
B.2.3. choices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
256
B.2.4. db_column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.2. blank
B.2.5. db_index
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.6. default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.7. editable
257
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.2.8. help_text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.9. primary_key
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.10. radio_admin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.11. unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.12. unique_for_date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
257
B.2.13. unique_for_month . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
258
B.2.14. unique_for_year . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
258
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
258
B.3. Relaciones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.2.15. verbose_name
258
B.3.1. Relaciones Muchos-a-Uno
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.3.2. Relaciones Muchos-a-Muchos
258
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
260
B.4. Opciones de los Metadatos del Modelo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
261
B.4.1. db_table
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.4.2. get_latest_by
261
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
262
B.4.3. order_with_respect_to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
262
B.4.4. ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
262
B.4.5. permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
262
B.4.6. unique_together
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
263
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
263
B.4.7. verbose_name
B.4.8. verbose_name_plural . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.5. Managers
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
263
263
B.5.1. Nombres de Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
264
B.5.2. Managers Personalizados
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
264
B.6. Mtodos de Modelo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
266
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xi
B.6.1. __str__ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
266
B.6.2. get_absolute_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
267
B.6.3. Ejecutando SQL personalizado
268
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.4. Sobreescribiendo los Mtodos por omisin del Modelo
. . . . . . . . . . . . . . . . . . . . . . .
268
B.7. Opciones del Administrador . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
268
B.7.1. date_hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
269
B.7.2. elds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
269
B.7.3. js . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
270
B.7.4. list_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
270
B.7.5. list_display_links
B.7.6. list_ lter
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
271
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.7. list_per_page
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.8. list_select_related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.9. ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.10. save_as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.11. save_on_top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
B.7.12. search_ elds
272
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C. Referencia de la API de base de datos
C.1. Creando Objetos
275
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.1.1. Qu pasa cuando grabas?
275
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
276
C.1.2. Claves primarias autoincrementales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
276
C.2. Grabando cambios de objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
277
C.3. Recuperando objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
277
C.4. Caching y QuerySets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
278
C.5. Filtrando objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
278
C.5.1. Encadenando ltros
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
279
C.5.2. Limitando QuerySets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
280
C.5.3. Mtodos de consulta que retornan nuevos QuerySets . . . . . . . . . . . . . . . . . . . . . . . .
280
C.5.4. Metodos de
283
QuerySet
C.6. Patrones de bsqueda
que no devuelven un
QuerySet
. . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
285
C.6.1. exact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
286
C.6.2. iexact
286
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.6.3. contains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
286
C.6.4. icontains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
286
C.6.5. gt, gte, lt, and lte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
C.6.6. in
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
C.6.7. startswith . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
C.6.8. istartswith
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.6.9. endswith and iendswith
C.6.10. range
287
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
C.6.11. year, month, and day
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
287
C.6.12. isnull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
288
C.6.13. search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
288
C.6.14. El patrn de bsqueda pk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
288
C.7. Bsquedas complejas con Objetos Q
C.8. Objetos Relacionados
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
289
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
289
C.8.1. Consultas Que Cruzan Relaciones
C.8.2. Relaciones de Clave Fornea
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.8.3. Relaciones de Clave Forenea Inversas
C.8.4. Relaciones muchos-a-muchos
290
290
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
290
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
292
C.8.5. Consultas que Abarcan Objetos Relacionados . . . . . . . . . . . . . . . . . . . . . . . . . . . .
292
C.9. Borrando Objectos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
292
C.10.Mtodos de Instancia Adicionales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
293
C.10.1. get_FOO_display()
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
293
C.10.2. get_next_by_FOO(**kwargs) y get_previous_by_FOO(**kwargs) . . . . . . . . . . . . . . .
293
C.10.3. get_FOO_ lename()
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
294
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
294
C.10.4. get_FOO_url()
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xii
C.10.5. get_FOO_size() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
294
C.10.6. save_FOO_ le( lename, raw_contents) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
294
C.10.7. get_FOO_height() and get_FOO_width() . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.11.Atajos (Shortcuts)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C.11.1. get_object_or_404()
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
294
294
294
C.11.2. get_list_or_404() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
295
C.12.Utilizando SQL Crudo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
295
D. Referencia de las vistas genricas
297
D.1. Argumentos comunes a todas las vistas genricas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
297
D.2. Vistas genricas simples
298
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
D.2.1. Representar una plantilla
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
298
D.2.2. Redirigir a otra URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
298
D.3. Vistas de listado/detalle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
299
D.3.1. Listas de objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
299
D.3.2. Vista de detalle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
D.4. Vistas genricas basadas en fechas
300
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
302
D.4.1. ndice de archivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
302
D.4.2. Archivos anuales
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
303
D.4.3. Archivos mensuales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
304
D.4.4. Archivos semanales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
306
D.4.5. Archivos diarios
307
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
D.4.6. Archivo para hoy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
308
D.4.7. Pginas de detalle basadas en fecha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
308
D.5. Vistas genericas para Crear/Modi car/Borrar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
309
D.5.1. Vista de creacin de objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
310
D.5.2. Vista de modi cacin de objetos
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
311
D.5.3. Vista de borrado de objetos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
312
E. Variables de con guracin
313
E.1. Qu es un archivo de con guracin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
313
E.1.1.
Valores por omisin
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
313
E.1.2.
Viendo cules variables de con guracin has cambiado . . . . . . . . . . . . . . . . . . . . . . .
313
E.1.3.
Usando variables de con guracin en cdigo Python
E.1.4.
Modi cando variables de con guracin en tiempo de ejecucin
E.1.5.
Seguridad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
314
E.1.6.
Creando tus propias variables de con guracin
314
. . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . .
E.2. Indicando la con guracin: DJANGO_SETTINGS_MODULE . . . . . . . . . . . . . . . . . . . . . .
314
314
314
E.2.1.
La utilidad django-admin.py
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
315
E.2.2.
En el servidor (mod_python) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
315
E.3. Usando variables de con guracin sin jar DJANGO_SETTINGS_MODULE
. . . . . . . . . . . . .
315
E.3.1.
Variables de con guracin por omisin personalizados
. . . . . . . . . . . . . . . . . . . . . . .
316
E.3.2.
Es necesario que uses con gure() o DJANGO_SETTINGS_MODULE . . . . . . . . . . . . . .
316
E.4. Variables de con guracin disponibles
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
316
E.4.1.
ABSOLUTE_URL_OVERRIDES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
316
E.4.2.
ADMIN_FOR
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
316
E.4.3.
ADMIN_MEDIA_PREFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.4.
ADMINS
E.4.5.
ALLOWED_INCLUDE_ROOTS
E.4.6.
APPEND_SLASH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.7.
CACHE_BACKEND
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.8.
CACHE_MIDDLEWARE_KEY_PREFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.9.
DATABASE_ENGINE
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
317
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.10. DATABASE_HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
317
E.4.11. DATABASE_NAME
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.12. DATABASE_OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.13. DATABASE_PASSWORD
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.14. DATABASE_PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.15. DATABASE_USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xiii
E.4.16. DATE_FORMAT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.17. DATETIME_FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.18. DEBUG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
318
E.4.19. DEFAULT_CHARSET
319
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E.4.20. DEFAULT_CONTENT_TYPE
E.4.21. DEFAULT_FROM_EMAIL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
E.4.22. DISALLOWED_USER_AGENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
E.4.23. EMAIL_HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
E.4.24. EMAIL_HOST_PASSWORD
E.4.25. EMAIL_HOST_USER
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
E.4.26. EMAIL_PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
E.4.27. EMAIL_SUBJECT_PREFIX
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
319
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.28. FIXTURE_DIRS
E.4.29. IGNORABLE_404_ENDS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.30. IGNORABLE_404_STARTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.31. INSTALLED_APPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.32. INTERNAL_IPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.33. JING_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.34. LANGUAGE_CODE
320
E.4.35. LANGUAGES
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
320
E.4.36. MANAGERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
321
E.4.37. MEDIA_ROOT
321
E.4.38. MEDIA_URL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
321
E.4.39. MIDDLEWARE_CLASSES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
321
E.4.40. MONTH_DAY_FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
321
E.4.41. PREPEND_WWW
321
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E.4.42. PROFANITIES_LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.43. ROOT_URLCONF
322
E.4.44. SECRET_KEY
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E.4.45. SEND_BROKEN_LINK_EMAILS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
322
E.4.46. SERIALIZATION_MODULES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.47. SERVER_EMAIL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.48. SESSION_COOKIE_AGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.49. SESSION_COOKIE_DOMAIN
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.50. SESSION_COOKIE_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
322
E.4.51. SESSION_COOKIE_SECURE
323
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E.4.52. SESSION_EXPIRE_AT_BROWSER_CLOSE
. . . . . . . . . . . . . . . . . . . . . . . . . .
323
E.4.53. SESSION_SAVE_EVERY_REQUEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323
E.4.54. SITE_ID
323
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
E.4.55. TEMPLATE_CONTEXT_PROCESSORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323
E.4.56. TEMPLATE_DEBUG
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323
E.4.58. TEMPLATE_LOADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
323
E.4.57. TEMPLATE_DIRS
E.4.59. TEMPLATE_STRING_IF_INVALID
E.4.60. TEST_RUNNER
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
E.4.61. TEST_DATABASE_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
E.4.62. TIME_FORMAT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
E.4.63. TIME_ZONE
E.4.64. URL_VALIDATOR_USER_AGENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
E.4.65. USE_ETAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
324
E.4.66. USE_I18N
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
325
E.4.67. YEAR_MONTH_FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
325
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xiv
F. Etiquetas de plantilla y ltros prede nidos
F.1. Etiquetas prede nidas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
327
327
F.1.1.
block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
327
F.1.2.
comment
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
327
F.1.3.
cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
327
F.1.4.
debug
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
F.1.5.
extends
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
F.1.6.
lter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
F.1.7.
rstof
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
F.1.8.
for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
F.1.9.
if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F.1.10. ifchanged
329
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
330
F.1.11. ifequal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
330
F.1.12. ifnotequal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
330
F.1.13. include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
331
F.1.14. load
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
331
F.1.15. now
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F.1.16. regroup
331
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
333
F.1.17. spaceless . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
333
F.1.18. ssi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
334
F.1.19. templatetag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
334
F.1.20. url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
334
F.1.21. widthratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
F.2. Filtros prede nidos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
F.2.1.
add
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
F.2.2.
addslashes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
F.2.3.
cap rst
F.2.4.
center
F.2.5.
cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
F.2.6.
date
336
F.2.7.
default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
336
F.2.8.
default_if_none
336
F.2.9.
dictsort
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
335
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
336
F.2.10. dictsortreversed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
336
F.2.11. divisibleby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
336
F.2.12. escape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
336
F.2.13. lesizeformat
F.2.14. rst
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
337
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
337
F.2.15. x_ampersands
F.2.16. oatformat
F.2.17. get_digit
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
337
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
337
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
337
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.19. length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.20. length_is
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.21. linebreaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.18. join
F.2.22. linebreaksbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.23. linenumbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.24. ljust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.25. lower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
338
F.2.26. make_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
339
F.2.27. phone2numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
339
F.2.28. pluralize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
339
F.2.29. pprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
339
F.2.30. random
339
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F.2.31. removetags
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.32. rjust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.33. slice
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.34. slugify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xv
F.2.35. stringformat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.36. striptags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.37. time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
340
F.2.38. timesince
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
341
F.2.39. timeuntil
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
341
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
341
F.2.40. title
F.2.41. truncatewords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
341
F.2.42. truncatewords_html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
341
F.2.43. unordered_list
341
F.2.44. upper
F.2.45. urlencode
F.2.46. urlize
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
F.2.47. urlizetrunc
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
F.2.48. wordcount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
F.2.49. wordwrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
342
F.2.50. yesno
343
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G. El utilitario django-admin
345
G.1. Uso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
345
G.2. Acciones Disponibles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
345
G.2.1. adminindex [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
346
G.2.2. createcachetable [tablename]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
346
G.2.3. dbshell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
346
G.2.4. disettings
346
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.5. dumpdata [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
346
G.2.6. ush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
346
G.2.7. inspectdb
346
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.8. loaddata [ xture xture ...]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
347
G.2.9. reset [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
348
G.2.10. runfcgi [options]
348
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.11. runserver [nmero de puerto opcional, or direccinIP:puerto]
. . . . . . . . . . . . . . . . . . .
348
G.2.12. shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
348
G.2.13. sql [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.14. sqlall [appname appname ...]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.15. sqlclear [appname appname ...]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
349
G.2.16. sqlcustom [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.17. sqlindexes [appname appname ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.18. sqlreset [appname appname ...]
349
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.19. sqlsequencereset [appname appname ...]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.20. startapp [appname] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.21. startproject [projectname] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.22. syncdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
349
G.2.23. test
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.2.24. validate
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.3. Opciones Disponibles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.3.1. --settings
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.3.2. --pythonpath
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
350
350
350
350
350
G.3.3. --format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
350
G.3.4. --help
350
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G.3.5. --indent
G.3.6. --noinput
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
350
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
351
G.3.7. --noreload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
351
G.3.8. --version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
351
G.3.9. --verbosity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
351
G.3.10. --adminmedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
351
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xvi
H. Objetos Peticin y Respuesta
H.1. HttpRequest
353
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
353
H.1.1. Objetos QueryDict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
355
H.1.2. Un ejemplo completo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
356
H.2. HttpResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
357
H.2.1. Construccin de HttpResponses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
357
H.2.2. Establecer las cabeceras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
357
H.2.3. Subclases de HttpResponse
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
358
H.2.4. Retornar Errores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
358
H.2.5. Personalizar la Vista 404 (Not Found) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
359
H.2.6. Personalizar la Vista 500 (Server Error)
359
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
I. Docutils System Messages
361
revisin 757 del 28 de julio de 2008
Preliminares
Reconocimientos
El aspecto ms grati cante de trabajar con Django es la comunidad. Hemos sido especialmente afortunados de que
Django haya atrado a tanta gente inteligente, motivada y amistosa. Un segmento de esa comunidad nos sigui durante
el lanzamiento online beta de este libro. Sus revisiones y comentarios fueron indispensables; este libro no hubiese
sido posible sin esa maravillosa revisin de pares. Casi mil personas dejaron comentarios que ayudaron a mejorar la
claridad, calidad y el ujo del libro nal. Queremos agradecer a todos y cada uno de ellos.
Estamos especialmente agradecidos con aquellos que dispusieron de su tiempo para revisar el libro en profundidad
y dejarnos decenas (a veces cientos) de comentarios: Marty Alchin, Max Battcher, Oliver Beattie, Rod Begbie, Paul
Bissex, Matt Boersma, Robbin Bonthond, Peter Bowyer, Nesta Campbell, Jon Colverson, Je Croft, Chris Dary, Alex
Dong, Matt Drew, Robert Dzikowski, Nick Eord, Ludvig Ericson, Eric Floehr, Brad Fults, David Grant, Simon Greenhill, Robert Haveman, Kent Johnson, Andrew Kember, Marek Kubica, Eduard Kucera, Anand Kumria, Scott Lamb,
Fredrik Lundh, Vadim Macagon, Markus Majer, Orestis Markou, R. Mason, Yasushi Masuda, Kevin Menard, Carlo
Miron, James Mulholland, R.D. Nielsen, Michael O'Keefe, Lawrence Oluyede, Andreas Pfrengle, Frankie Robertson,
Mike Robinson, Armin Ronacher, Daniel Roseman, Johan Samyn, Ross Shannon, Carolina F. Silva, Paul Smith, Bjrn
Stabell, Bob Stepno, Graeme Stevenson, Justin Stockton, Kevin Teague, Daniel Tietze, Brooks Travis, Peter Tripp,
Matthias Urlichs, Peter van Kampen, Alexandre Vassalotti, Jay Wang, Brian Will y Joshua Works.
Muchas gracias a nuestro editor tcnico, Jeremy Dunck. Sin Jeremy, este libro habra quedado en desorden, con
errores, inexactitudes y cdigo roto. Nos sentimos realmente afortunados de que alguien con el talento de Jeremy
encontrase el tiempo de ayudarnos.
Un especial agradecimiento a Simon Willison por escribir el captulo de procesamiento de formularios. Realmente
apreciamos la ayuda y nos enorgullece que la excelente redaccin de Simon pueda ser parte de este libro.
Estamos agradecidos por todo el duro trabajo que la gente de Apress hizo en este libro. Su ayuda y paciencia ha
sido asombrosa; este libro no habra quedado terminado sin todo ese trabajo de su parte. Nos pone especialmente
felices que Apress haya apoyado e incluso alentado el lanzamiento libre de este libro on line; es maravilloso ver a un
editor tan abrazado al espritu del open source.
Finalmente, por supuesto, gracias a nuestros amigos, familias y compaeros que gentilmente toleraron nuestra
ausencia mental mientras terminbamos este trabajo.
Sobre los autores
Adrian Holovaty, desarrollador Web y periodista, es uno de los creadores y desarrolladores del ncleo de Django.
Es el fundador de EveryBlock, una Web startup local de noticias. Cuando no est trabajando en mejoras para Django,
Adrian hackea en proyectos de bene cio pblico, como chicagocrime.org, uno de los mashups originales de Google
Maps. Vive en Chicago y mantiene un weblog en holovaty.com.
Jacob Kaplan-Moss es uno de los principales desarrolladores de Django. En su empleo diurno, es el desarrollador
principal para el Lawrence Journal-World, un peridico de dueos locales en Lawrence, Kansas, donde Django fue
desarrollado. En el Journal-World, supervisa el desarrollo de Ellington, una plataforma de publicacin online de
noticias para compaas de medios de comunicacin. A Jacob se lo puede encontrar online en jacobian.org.
Sobre el editor tcnico
Jeremy Dunck es el principal desarrollador de Pegasus News, un sitio local personalizado con base en Dallas,
Texas. Es uno de los primeros colaboradores de Greasemonkey y Django y ve la tecnologa como una herramienta para
la comunicacin y el acceso al conocimiento.
revisin 757 del 28 de julio de 2008
NDICE GENERAL
xviii
Sobre los traductores
La traduccin al espaol de El libro de Django fue posible gracias a la colaboracin voluntaria de la comunidad Django en Espaol y Python Argentina. El proyecto se lleva a cabo desde
http://humitos.homelinux.net/django-book.
A la fecha, han contribuido de una u otra manera a este trabajo:
Manuel Kaufmann <humitos en gmail.com>
Martn Gaitn <gaitan en gmail.com>
Leonardo Gastn De Luca <lgdeluca84 en gmail.com>
Guillermo Heizenreder <gheize en gmail.com>
Alejandro Autaln <alejandroautalan en gmail.com>
Renzo Carbonara <gnuk0001 en gmail.com>
Milton Mazzarri <milmazz en gmail.com>
Ramiro Morales <ramiro+djbook en rmorales dot net>
Juan Ignacio Rodrguez de Len <euribates+django en gmail punto com>
Percy Prez Pinedo <percyp3 en gmail punto com>
Toms Casquero <tcasquero en gmail.com>
Marcos Agustn Lewis <marcoslewis en gmail punto com>
Lenidas Hernn Olivera <lholivera en gmail punto com>
Federico M. Peretti <federico en perettifederico.com.ar>
Csar Ballardini <cesar en ballardini.com.ar>
Anthony Lenton <anthony en except.com.ar>
Csar Roldn <cesar en hugoroldan.com.ar>
Gonzalo Delgado <gonzalodel en gmail.com>
Sobre el libro
Ests leyendo El libro de Django, publicado en Diciembre de 2007 por Apress con el ttulo The De nitive Guide
to Django: Web Development Done Right.
Hemos lanzado este libro libremente por un par de razones. La primera es que amamos Django y queremos que sea
tan accesible como sea posible. Muchos programadores aprenden su arte desde material tcnico bien escrito, as que
nosotros intentamos escribir una gua destacada que sirva adems como referencia para Django.
La segunda, es que resulta que escribir libros sobre tecnologa es particularmente difcil: sus palabras se vuelven
anticuadas incluso antes de que el libro llegue a la imprenta. En la web, sin embargo, la tinta nunca se seca -podremos mantener este libro al da (y as lo haremos) --.
La respuesta de los lectores es una parte crtica de ese proceso. Hemos construido un sistema de comentarios que
te dejar comentar sobre cualquier parte del libro; leeremos y utilizaremos estos comentarios en nuevas versiones.
revisin 757 del 28 de julio de 2008
Introduccin
Al comienzo, los desarrolladores web escriban cada una de las pginas a mano. Actualizar un sitio web signi caba
editar HTML; un rediseo implicaba rehacer cada una de las pginas, una por vez.
Como los sitios web crecieron y se hicieron ms ambiciosos, rpidamente se hizo obvio que esta situacin era tediosa,
consuma tiempo y al nal era insostenible. Un grupo de emprendedores del NCSA (Centro Nacional de Aplicaciones
para Supercomputadoras, donde Mosaic, el primer navegador web gr co, fue desarrollado) solucion este problema
permitiendo que el servidor web invocara programas externos capaces de generar HTML dinmicamente. Ellos llamaron
a este protocolo Puerta de Enlace Comn, o CGI
1 , y esto cambi la web para siempre.
Ahora es duro imaginar la revelacin que CGI debe haber sido: en vez de tratar con pginas HTML como simples
archivos del disco, CGI te permite pensar en pginas como recursos generados dinmicamente bajo demanda. El
desarrollo de CGI hace pensar en la primera generacin de pgina web dinmicas.
Sin embargo, CGI tiene sus problemas: los scripts CGI necesitan contener gran cantidad de cdigo repetitivo que
los hace difcil de reutilizar, as como complicados de entender y escribir para los desarrolladores novatos.
PHP solucion varios de estos problemas y tom al mundo por sorpresa --ahora es, por lejos, la herramienta ms
popular usada para crear sitios web dinmicos, y decenas de lenguajes y entornos similares (ASP, JSP, etc.) siguieron
de cerca el diseo de PHP. La mayor innovacin de PHP es que es fcil de usar: el cdigo PHP es simple de embeber
en un HTML plano; la curva de aprendizaje para algunos que recin conocen HTML es extremadamente llana.
Pero PHP tiene sus propios problemas; por su facilidad de uso alienta a la produccin de cdigo mal hecho. Lo
que es peor, PHP hace poco para proteger a los programadores en cuanto a vulnerabilidades de seguridad, por lo que
muchos desarrolladores de PHP se encontraron con que tenan que aprender sobre seguridad cuando ya era demasiado
tarde.
Estas y otras frustraciones similares, condujeron directamente al desarrollo de los actuales frameworks de desarrollo
web de tercera generacin. Estos frameworks -- Django y Ruby on Rails parecen ser muy populares en estos das
-- reconocen que la importancia de la web se ha intensi cado en los ltimos tiempos. Con esta nueva explosin del
desarrollo web comienza otro incremento en la ambicin; se espera que los desarrolladores web hagan ms y ms cada
da.
Django fue inventado para satisfacer esas nuevas ambiciones. Django te permite construir en profundidad, de
forma dinmica, sitios interesantes en un tiempo extremadamente corto. Django est diseado para hacer foco en la
diversin, en las partes interesantes de tu trabajo, al mismo tiempo que alivia el dolor de las partes repetitivas. Al
hacerlo, proporciona abstracciones de alto nivel de patrones comunes del desarrollo web, atajos para tareas frecuentes
de programacin y claras convenciones sobre cmo resolver problemas. Al mismo tiempo, Django intenta mantenerse
fuera de tu camino, dejando que trabajes fuera del alcance del framework cuando es necesario. Escribimos este libro
porque creemos rmemente que Django mejora el desarrollo web. Est diseado para poner rpidamente en movimiento
tu propio proyecto de Django, en ltima instancia aprenders todo lo que necesites saber para producir un diseo,
desarrollo y despliegue de sitios satisfactorios y de los cuales te sientas orgulloso.
Estamos extremadamente interesados en la retroalimentacin. La versin online de este libro te permite dejar
un comentario en cualquier parte del libro y discutir con otros lectores. Hacemos cuanto podemos para leer todos
los comentarios posteados all y responder tantos como sea posible. Si pre eres utilizar correo electrnico, por favor
envanos unas lneas (en ingls) a [email protected]. De cualquier modo, nos encantara escucharte! Nos
alegra que ests aqu, y esperamos que encuentres a Django tan emocionante, divertido y til como nosotros.
1 N.
del T.: Common Gateway Interface
revisin 757 del 28 de julio de 2008
Captulo 1
Introduccin a Django
Este libro es sobre Django, un framework de desarrollo Web que ahorra tiempo y hace que el desarrollo Web sea
divertido. Utilizando Django puedes crear y mantener aplicaciones Web de alta calidad con un mnimo esfuerzo.
En el mejor de los casos, el desarrollo web es un acto entretenido y creativo; en el peor, puede ser una molestia
repetitiva y frustrante. Django te permite enfocarte en la parte divertida -- el quid de tus aplicaciones Web -- al
mismo tiempo que mitiga el esfuerzo de las partes repetitivas. De esta forma, provee un alto nivel de abstraccin de
patrones comunes en el desarrollo Web, atajos para tareas frecuentes de programacin y convenciones claras sobre
cmo solucionar problemas. Al mismo tiempo, Django intenta no entrometerse, dejndote trabajar fuera del mbito
del framework segn sea necesario.
El objetivo de este libro es convertirte en un experto de Django. El enfoque es doble. Primero, explicamos en
profundidad lo que hace Django, y cmo crear aplicaciones Web con l. Segundo, discutiremos conceptos de alto nivel
cuando se considere apropiado, contestando la pregunta Cmo puedo aplicar estas herramientas de forma efectiva en
mis propios proyectos? Al leer este libro, aprenders las habilidades necesarias para desarrollar sitios Web poderosos
de forma rpida, con cdigo limpio y de fcil mantenimiento.
En este captulo ofrecemos una visin general de Django.
1.1.
Qu es un Framework Web?
Django es un miembro importante de una nueva generacin de frameworks Web. Y qu signi ca ese trmino
exactamente?
Para contestar esa pregunta, consideremos el diseo de una aplicacin Web escrita usando el estndar Common
Gateway Interface (CGI), una forma popular de escribir aplicaciones Web alrededor del ao 1998. En esa poca, cuando
escribas una aplicacin CGI, hacas todo por ti mismo -- el equivalente a hacer una torta desde cero --. Por ejemplo,
aqu hay un script CGI sencillo, escrito en Python, que muestra los diez libros ms recientemente publicados de una
base de datos:
#!/usr/bin/python
import MySQLdb
print
print
print
print
print
print
"Content-Type: text/html"
"<html><head><title>Libros</title></head>"
"<body>"
"<h1>Los ultimos 10 libros</h1>"
"<ul>"
conexion = MySQLdb.connect(user='yo', passwd='dejame_entrar', db='mi_base')
cursor = conexion.cursor()
cursor.execute("SELECT nombre FROM libros ORDER BY fecha_pub DESC LIMIT 10")
for fila in cursor.fetchall():
print "<li> %s</li>" % fila[0]
print "</ul>"
revisin 757 del 28 de julio de 2008
CAPTULO 1. INTRODUCCIN A DJANGO
print "</body></html>"
conexion.close()
Este cdigo es fcil de entender. Primero imprime una lnea de Content-Type, seguido de una lnea en blanco, tal
como requiere CGI. Imprime HTML introductorio, se conecta a la base de datos y ejecuta una consulta que obtiene los
diez libros ms recientes. Hace un bucle sobre esos libros y genera una lista HTML desordenada. Finalmente imprime
el cdigo para cerrar el HTML y cierra la conexin con la base de datos.
Con una nica pgina dinmica como esta, el enfoque desde cero no es necesariamente malo. Por un lado, este
cdigo es sencillo de comprender -- incluso un desarrollador novato puede leer estas 16 lneas de Python y entender
todo lo que hace, de principio a n --. No hay ms nada que aprender; no hay ms cdigo para leer. Tambin es sencillo
de utilizar: tan slo guarda este cdigo en un archivo llamado
ultimoslibros.cgi,
sube ese archivo a un servidor
Web y visita esa pgina con un navegador.
Pero a medida que una aplicacin Web crece ms all de lo trivial, este enfoque se desmorona y te enfrentas a una
serie de problemas:
Qu sucede cuando mltiples pginas necesitan conectarse a la base de datos? Seguro que ese cdigo
de conexin a la base de datos no debera estar duplicado en cada uno de los scripts CGI, as que la
forma pragmtica de hacerlo sera refactorizarlo en una funcin compartida.
Debera un desarrollador realmente tener que preocuparse por imprimir la lnea de Content-Type
y acordarse de cerrar la conexin con la base de datos? Este tipo de cdigo repetitivo reduce la
productividad del programador e introduce la oportunidad para que se cometan errores. Estas tareas
de con guracin y cierre estaran mejor manejadas por una infraestructura comn.
Qu sucede cuando este cdigo es reutilizado en mltiples entornos, cada uno con una base de datos
y contraseas diferentes? En ese punto, se vuelve esencial alguna con guracin espec ca del entorno.
Qu sucede cuando un diseador Web que no tiene experiencia programando en Python desea redisear la pgina? Lo ideal sera que la lgica de la pgina -- la bsqueda de libros en la base de datos
-- est separada del cdigo HTML de la pgina, de modo que el diseador pueda hacer modi caciones
sin afectar la bsqueda.
Precisamente estos son los problemas que un framework Web intenta resolver. Un framework Web provee una
infraestructura de programacin para tus aplicaciones, para que puedas concentrarte en escribir cdigo limpio y de
fcil mantenimiento sin tener que reinventar la rueda. En resumidas cuentas, eso es lo que hace Django.
1.2.
El patrn de diseo MVC
Comencemos con un rpido ejemplo que demuestra la diferencia entre el enfoque anterior y el empleado al usar un
framework Web. As es como se podra escribir el cdigo CGI anterior usando Django:
# models.py (las tablas de la base de datos)
from django.db import models
class Book(models.Model):
name = models.CharField(maxlength=50)
pub_date = models.DateField()
# views.py (la parte lgica)
from django.shortcuts import render_to_response
from models import Book
def latest_books(request):
book_list = Book.objects.order_by('-pub_date')[:10]
return render_to_response('latest_books.html', {'book_list': book_list})
revisin 757 del 28 de julio de 2008
1.3. LA HISTORIA DE DJANGO
# urls.py (la configuracin URL)
from django.conf.urls.defaults import *
import views
urlpatterns = patterns('',
(r'latest/$', views.latest_books),
)
# latest_books.html (la plantilla)
<html><head><title>Books</title></head>
<body>
<h1>Books</h1>
<ul>
{ % for book in book_list %}
<li>{{ book.name }}</li>
{ % endfor %}
</ul>
</body></html>
Todava no es necesario preocuparse por los detalles de cmo funciona esto -- tan slo queremos que te acostumbres
al diseo general --. Lo que hay que notar principalmente en este caso son las cuestiones de separacin :
models.py contiene una descripcin de la tabla de la base de datos, como una clase Python.
El archivo
A esto se lo llama el modelo. Usando esta clase se pueden crear, buscar, actualizar y borrar entradas
de tu base de datos usando cdigo Python sencillo en lugar de escribir declaraciones SQL repetitivas.
views.py contiene la lgica de la pgina, en la funcin latest_books(). A esta funcin se
El archivo
la denomina vista.
El archivo
/latest/
El archivo
urls.py
especi ca qu vista es llamada segn el patrn URL. En este caso, la URL
ser manejada por la funcin
latest_books.html
latest_books().
es una plantilla HTML que describe el diseo de la pgina.
Tomadas en su conjunto, estas piezas se aproximan al patrn de diseo Modelo-Vista-Controlador (MVC). Dicho
de manera ms fcil, MVC de ne una forma de desarrollar software en la que el cdigo para de nir y acceder a los
datos (el modelo) est separado del pedido lgico de asignacin de ruta (el controlador), que a su vez est separado
de la interfaz del usuario (la vista).
Una ventaja clave de este enfoque es que los componentes tienen un acoplamiento dbil (N. de T.: por loosely
coupled ) entre s. Eso signi ca que cada pieza de la aplicacin Web que funciona sobre Django tiene un nico propsito
clave, que puede ser modi cado independientemente sin afectar las otras piezas. Por ejemplo, un desarrollador puede
cambiar la URL de cierta parte de la aplicacin sin afectar la implementacin subyacente. Un diseador puede cambiar
el HTML de una pgina sin tener que tocar el cdigo Python que la renderiza. Un administrador de base de datos
puede renombrar una tabla de la base de datos y especi car el cambio en un nico lugar, en lugar de tener que buscar
y reemplazar en varios archivos.
En este libro, cada componente tiene su propio captulo. Por ejemplo, el Captulo 3 trata sobre las vistas, el
Captulo 4 sobre las plantillas, y el Captulo 5 sobre los modelos. El Captulo 5 profundiza tambin en la losofa MVC
de Django.
1.3.
La historia de Django
Antes de continuar con ms cdigo, deberamos tomarnos un momento para explicar la historia de Django. Es til
entender por qu se cre el framework, ya que el conocimiento de la historia pone en contexto la razn por la cual
Django trabaja de la forma en que lo hace.
Si has estado creando aplicaciones Web por un tiempo, probablemente ests familiarizado con los problemas del
ejemplo CGI presentado con anterioridad. El camino clsico de un desarrollador Web es algo como esto:
1. Escribir una aplicacin Web desde cero.
revisin 757 del 28 de julio de 2008
CAPTULO 1. INTRODUCCIN A DJANGO
2. Escribir otra aplicacin Web desde cero.
3. Darse cuenta de que la aplicacin del paso 1 tiene muchas cosas en comn con la aplicacin del
paso 2.
4. Refactorizar el cdigo para que la aplicacin 1 comparta cdigo con la aplicacin 2.
5. Repetir los pasos 2-4 varias veces.
6. Darse cuenta de que acaba de inventar un framework.
As es precisamente como fue creado Django.
Django naci naturalmente de aplicaciones de la vida real escritas por un equipo de desarrolladores Web en
Lawrence, Kansas. Naci en el otoo boreal de 2003, cuando los programadores Web del diario Lawrence Journal-
World, Adrian Holovaty y Simon Willison, comenzaron a usar Python para crear sus aplicaciones. El equipo de
The World Online, responsable de la produccin y mantenimiento de varios sitios locales de noticias, prosperaban
en un entorno de desarrollo dictado por las fechas lmite del periodismo. Para los sitios -- incluidos LJWorld.com,
Lawrence.com y KUsports.com -- los periodistas (y los directivos) exigan que se agregaran nuevas caractersticas y
que aplicaciones enteras se crearan a una velocidad vertiginosa, a menudo con slo das u horas de preaviso. Es as que
Adrian y Simon desarrollaron por necesidad un framework de desarrollo Web que les ahorrara tiempo -- era la nica
forma en que podan crear aplicaciones mantenibles en tan poco tiempo -- .
En el verano boreal de 2005, luego de haber desarrollado este framework hasta el punto en que estaba haciendo
funcionar la mayora de los sitios World Online, el equipo de World Online, que ahora inclua a Jacob Kaplan-Moss,
decidi liberar el framework como software de cdigo abierto. Lo liberaron en julio de 2005 y lo llamaron Django, por
el guitarrista de jazz Django Reinhardt.
A pesar de que Django ahora es un proyecto de cdigo abierto con colaboradores por todo el mundo, los desarrolladores originales de World Online todava aportan una gua centralizada para el crecimiento del framework, y
World Online colabora con otros aspectos importantes tales como tiempo de trabajo, materiales de marketing, y
hosting/ancho de banda para el Web site del framework (http://www.djangoproject.com/).
Esta historia es relevante porque ayuda a explicar dos cuestiones clave. La primera es el punto dulce de Django.
Debido a que Django naci en un entorno de noticias, ofrece varias caractersticas (en particular la interfaz admin,
tratada en el Captulo 6) que son particularmente apropiadas para sitios de contenido -- sitios como eBay, craigslist.org
y washingtonpost.com que ofrecen informacin basada en bases de datos --. (De todas formas, no dejes que eso te quite
las ganas -- a pesar de que Django es particularmente bueno para desarrollar esa clase de sitios, eso no signi ca que
no sea una herramienta efectiva para crear cualquier tipo de sitio Web dinmico --. Existe una diferencia entre ser
particularmente efectivo para algo y no ser efectivo para otras cosas).
La segunda cuestin a resaltar es cmo los orgenes de Django le han dado forma a la cultura de su comunidad de
cdigo abierto. Debido a que Django fue extrado de cdigo de la vida real, en lugar de ser un ejercicio acadmico o un
producto comercial, est especialmente enfocado en resolver problemas de desarrollo Web con los que los desarrolladores
de Django se han encontrado -- y con los que continan encontrndose --. Como resultado de eso, Django es activamente
mejorado casi diariamente. Los desarrolladores del framework tienen un alto grado de inters en asegurarse de que
Django les ahorre tiempo a los desarrolladores, produzca aplicaciones que son fciles de mantener y rindan bajo mucha
carga. Aunque existan otras razones, los desarrolladores estn motivados por sus propios deseos egostas de ahorrarse
tiempo a ellos mismos y disfrutar de sus trabajos. (Para decirlo sin vueltas, se comen su propia comida para perros).
1.4.
Cmo leer este libro
Al escribir este libro, tratamos de alcanzar un balance entre legibilidad y referencia, con una tendencia a la
legibilidad. Nuestro objetivo con este libro, como se mencion anteriormente, es hacerte un experto en Django, y
creemos que la mejor manera de ensear es a travs de la prosa y numerosos ejemplos, en vez de proveer un exhaustivo
pero intil catlogo de las caractersticas de Django (Como alguien dijo una vez, no puedes esperar ensearle a alguien
cmo hablar simplemente ensendole el alfabeto).
Con eso en mente, te recomendamos que leas los captulos del 1 al 7 en orden. Ellos forman los fundamentos de
cmo se usa Django; una vez que los hayas ledo, sers capaz de construir sitios Web que funcionan sobre Django. Los
captulos restantes, los cuales se enfocan en caractersticas espec cas de Django, pueden ser ledos en cualquier orden.
Los apndices son para referencia. Ellos, junto con la documentacin libre en
http://www.djangoproject.com/,
son probablemente lo que releers de vez en cuando para recordar la sintaxis o buscar un resumen rpido de lo que
hacen ciertas partes de Django.
revisin 757 del 28 de julio de 2008
1.5. QU SIGUE?
1.4.1.
Conocimientos de programacin requeridos
Los lectores de este libro deben comprender las bases de la programacin orientada a objetos e imperativa: estruc-
turas de control (if,
while
for),
estructuras de datos (listas, hashes/diccionarios), variables, clases y objetos.
La experiencia en desarrollo Web es, como podrs esperar, muy til, pero no es requisito para leer este libro. A
lo largo del mismo, tratamos de promover las mejores prcticas en desarrollo Web para los lectores a los que les falta
este tipo de experiencia.
1.4.2.
Conocimientos de Python requeridos
En esencia, Django es sencillamente una coleccin de bibliotecas escritas en el lenguaje de programacin Python.
Para desarrollar un sitio usando Django escribes cdigo Python que utiliza esas bibliotecas. Aprender Django, entonces,
es slo cuestin de aprender a programar en Python y comprender cmo funcionan las bibliotecas Django.
Si tienes experiencia programando en Python, no deberas tener problema en meterte de lleno. En conjunto, el
cdigo Django no produce magia negra (es decir, trucos de programacin cuya implementacin es difcil de explicar
o entender). Para ti, aprender Django ser slo cuestin de aprender las convenciones y APIs de Django.
Si no tienes experiencia programando en Python, te espera una grata sorpresa. Es fcil de aprender y muy divertido
de usar. A pesar de que este libro no incluye un tutorial completo de Python, s hace hincapi en las caractersticas y
funcionalidades de Python cuando se considera apropiado, particularmente cuando el cdigo no cobra sentido de inme-
http://pyspanishdoc.sourceforge.
http://docs.python.org/tut/. Tambin recomendamos
Python, disponible en http://es.diveintopython.org/ y
diato. An as, recomendamos leer el tutorial o cial de Python, disponible en
net/tut/tut.html
o su versin ms reciente en ingls en
el libro libre y gratuito de Mark Pilgrim Inmersin en
publicado en ingls en papel por Apress.
1.4.3.
Nuevas caractersticas de Django
Tal como hicimos notar anteriormente, Django es mejorado con frecuencia, y probablemente tendr un gran nmero
de nuevas -- e incluso esenciales -- caractersticas para cuando este libro sea publicado. Por ese motivo, nuestro objetivo
como autores de este libro es doble:
Asegurarnos que este libro sea a prueba de tiempo tanto como nos sea posible, para que cualquier
cosa que leas aqu todava sea relevante en futuras versiones de Django.
Actualizar este libro continuamente en el sitio Web en ingls,
http://www.djangobook.com/,
para
que puedas acceder a la mejor y ms reciente documentacin tan pronto como la escribimos.
Si quieres implementar con Django algo que no est explicado en este libro, revisa la versin ms reciente de este
libro en el sitio Web antes mencionado y tambin revisa la documentacin o cial de Django.
1.4.4.
Obteniendo ayuda
Uno de los mayores bene cios de Django es su comunidad de usuarios amable y servicial. Para ayuda con cualquier
aspecto de Django -- desde instalacin y diseo de aplicaciones, hasta diseo de bases de datos e implementaciones -sintete libre de hacer preguntas online.
En la lista de correo en ingls de usuarios de Django se juntan miles de usuarios para preguntar
http://www.djangoproject.com/r/django-users
http://groups.google.es/group/django-es (espaol).
y responder dudas. Suscrbete gratuitamente en
(ingls) o
El canal de IRC de Django donde los usuarios de Django se juntan a chatear y se ayudan unos a otros
en tiempo real. nete a la diversin en #django (ingls) o #django-es (espaol) en la red de IRC
Freenode.
1.5.
Qu sigue?
En el Captulo 2, a continuacin, empezaremos con Django, explicando su instalacin y con guracin inicial.
revisin 757 del 28 de julio de 2008
CAPTULO 1. INTRODUCCIN A DJANGO
revisin 757 del 28 de julio de 2008
Captulo 2
Empezando
Creemos que es mejor empezar con fuerza. En los captulos que le siguen a este descubrirs los detalles y el alcance
del framework Django, pero por ahora, confa en nosotros, este captulo es divertido.
Instalar Django es fcil. Django se puede usar en cualquier sistema que corra Python, por eso es posible instalarlo
de varias maneras. En este captulo explicamos las situaciones ms comunes de instalacin de Django. El Captulo 20
explica como utilizar Django en produccin.
2.1.
Instalar Python
Django est escrito 100 % en puro cdigo Python, as que necesitars instalar Python en tu computadora. Django
necesita Python 2.3 o superior.
Si ests usando Linux o Mac OS X probablemente ya tienes Python instalado. Escribe
python
en una terminal. Si
ves algo as, Python est instalado:
Python 2.4.1 (#2, Mar 31 2005, 00:05:10)
[GCC 3.3 20030304 (Apple Computer, Inc. build 1666)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>
en
Si ves un error como: "command not found" u "orden no encontrada", tienes que bajar e instalar Python. Fjate
http://www.python.org/download/ para empezar. La instalacin es rpida y fcil.
2.2.
Instalar Django
En esta seccin explicamos dos opciones de instalacin: instalar un lanzamiento o cial e instalar desde Subversion.
2.2.1.
Instalar un lanzamiento o cial
La mayora de la gente querr instalar el lanzamiento o cial ms reciente de
download/.
Django usa el mtodo
distutils
http://www.djangoproject.com/
estndar de instalacin de Python, que en el mundo de Linux es as:
1. Baja el tarball, que se llamar algo as como Django-0.96.tar.gz
2.
tar xzvf Django-*.tar.gz
3.
cd Django-*
4.
sudo python setup.py install
En Windows, recomendamos usar 7-Zip para manejar archivos comprimidos de todo tipo, incluyendo
http://www.djangoproject.com/r/7zip/.
otro directorio e inicia python. Si todo est funcionando
.tar.gz.
Puedes bajar 7-Zip de
Cambia a algn
django:
>>> import django
>>> django.VERSION
(0, 96, None)
revisin 757 del 28 de julio de 2008
bien, deberas poder importar el mdulo
CAPTULO 2. EMPEZANDO
Nota
El intrprete interactivo de Python es un programa de lnea de comandos que te permite escribir
un programa Python de forma interactiva. Para iniciarlo slo ejecuta el comando
python
en la
lnea de comandos. Durante todo este libro, mostraremos ejemplos de cdigo Python como si
estuviesen escritos en el intrprete interactivo. El triple signo de mayor que (>>>) es el prompt de
Python.
2.2.2.
Instalar Django desde Subversion
Si quieres trabajar sobre la versin de desarrollo, o si quieres contribuir con el cdigo de Django en s mismo,
deberas instalar Django desde el repositorio de Subversion.
Subversion es libre, es un sistema de control de versiones de cdigo abierto similar a CVS, y es el que el equipo de
Django utiliza para administrar cambios en el cdigo base de Django. Puedes utilizar un cliente de Subversion para
hacerte con el cdigo fuente ms actual de Django y, en cualquier momento, puedes actualizar tu copia local del cdigo
de Django, conocido como un checkout local, para obtener los ltimos cambios y mejoras hechas por los desarrolladores
de Django.
Al ltimo cdigo de desarrollo de Django se hace referencia como el trunk. El equipo de Django ejecuta sitios de
produccin sobre el trunk y procura permanecer estable.
Para obtener el trunk de Django, sigue los siguientes pasos:
1. Asegrate de tener un cliente de Subversion instalado. Puedes conseguir este programa libremente
desde http://subversion.tigris.org/, y puedes encontrar documentacin excelente en http:
//svnbook.red-bean.com/.
2. Haz un check out del trunk usando el comando
djtrunk.
3. Crea
svn co http://code.djangoproject.com/svn/django/trunk
site-packages/django.pth y agrega el directorio djtrunk a este, o actualiza tu PYTHONPATH
djtrunk.
agregando
4. Incluye
djtrunk/django/bin en el PATH
django-admin.py.
de tu sistema. Este directorio incluye utilidades de
administracin como
Consejo:
.pth son nuevos para ti, puedes
djangoproject.com/r/python/site-module/.
Si los archivo
aprender ms de ellos en
http://www.
Luego de descargarlo desde Subversion y haber seguido los pasos anteriores, no necesitas ejecutar
install
python setup.py
--Acabas de hacer este trabajo a mano!
Debido a que el trunk de Django cambia a menudo corrigiendo bugs y agregando funcionalidades, probablemente
quieras actualizarlo con frecuencia -- a cada hora, si eres un obsesivo. Para actualizar el cdigo, solo ejecuta el
svn update desde el directorio djtrunk. Cuando ejecutes este comando, Subversion contactar http://
code.djangoproject.com, determinar si el cdigo ha cambiado, y actualizar tu versin local del cdigo con cualquier
comando
cambio que se haya hecho desde la ltima actualizacin. Es muy bueno.
2.3.
Con gurando la base de datos
El nico prerequisito de Django es una instalacin funcionando de Python. Sin embargo, este libro se centra en una
de las mejores funcionalidades de Django, el desarrollo de sitios web con soporte de base de datos, para esto necesitars
instalar un servidor de base de datos de algn tipo, para almacenar tus datos.
Si slo quieres comenzar a jugar con Django, salta a la seccin Comenzando un proyecto -- pero crenos, querrs
instalar una base de datos nalmente. Todos los ejemplos de este libro asumen que tienes una base de datos con gurada.
Hasta el momento de escribir esto, Django admite tres motores de base de datos:
PostgreSQL (http://www.postgresql.org/)
SQLite 3 (http://www.sqlite.org/)
MySQL (http://www.mysql.com/)
revisin 757 del 28 de julio de 2008
2.4. COMENZANDO UN PROYECTO
Se est trabajando para admitir Microsoft SQL Server y Oracle. El sitio web de Django siempre contendr la ltima
informacin acerca de las base de datos admitidas.
A nosotros el que ms nos gusta es PostgreSQL, por razones que exceden el alcance de este libro, por eso lo
mencionamos primero. Sin embargo, todos los motores que listamos aqu trabajan bien con Django.
SQLite merece especial atencin como herramienta de desarrollo. Es un motor de base de datos extremadamente
simple y no requiere ningn tipo de instalacin y con guracin del servidor. Es por lejos el ms fcil de con gurar si
slo quieres jugar con Django, y viene incluido en la biblioteca estndar de Python 2.5.
En Windows, obtener los drivers binarios de la base de datos es a veces un proceso complicado. Ya que slo ests
inicindote en Django, recomendamos usar Python 2.5 y el soporte incluido para SQLite. La compilacin de drivers
puede ser estresante.
2.3.1.
Usar Django con PostgreSQL
Si ests utilizando PostgreSQL, necesitars el paquete
r/python-pgsql/.
psycopg
disponible en
http://www.djangoproject.com/
Toma nota de la versin que ests usando (1 o 2); necesitars esta informacin luego.
Si ests usando PostgresSQL en Windows, puedes encontrar los binarios precompilados de
//www.djangoproject.com/r/python-pgsql/windows/.
2.3.2.
psycopg
en
http:
Usar Django con SQLite 3
Si ests usando una versin de Python igual o posterior a 2.5, ya tienes SQLite. Si ests trabajando con Python
http://www.djangoproject.com/r/sqlite/ y el paquete
http://www.djangoproject.com/r/python-sqlite/. Asegrate de tener pysqlite en una versin
2.4 o menor, necesitas SQLite 3 --no la versin 2-- desde
pysqlite
desde
2.0.3 o superior.
En Windows, puedes omitir la instalacin separada de los binarios de SQLite, ya que estn enlazados dentro de los
binarios de
2.3.3.
pysqlite.
Usar Django con MySQL
Django requiere MySQL 4.0 o superior; la versin 3.x no admite subconsultas anidadas ni algunas otras sentencias
SQL perfectamente estndar. Tambin necesitas instalar el paquete
r/python-mysql/.
2.3.4.
MySQLdb desde http://www.djangoproject.com/
Usar Django sin una base de datos
Como mencionamos anteriormente, Django actualmente no requiere una base de datos. Si slo quieres usar este
como un servidor dinmico de pginas que no use una base de datos, est perfectamente bien.
Con esto dicho, ten en cuenta que algunas de las herramientas extras de Django requieren una base de datos, por lo
tanto si eliges no usar una base de datos, perders estas utilidades. (Sealaremos estas utilidades a lo largo del libro).
2.4.
Comenzando un proyecto
Un proyecto es una coleccin de con guraciones para una instancia de Django, incluyendo con guracin de base
de datos, opciones espec cas de Django y con guraciones espec cas de aplicaciones.
Si esta es la primera vez que usas Django, tendrs que tener cuidado de algunas con guraciones iniciales. Crea un
nuevo directorio para empezar a trabajar, quizs algo como
/home/username/djcode/,
e ingresa a este directorio.
Nota
django-admin.py debera estar en el PATH de tu sistema si instalaste Django con la utilidad
setup.py. Si hiciste un check out desde Subversion, puedes encontrarlo en djtrunk/django/bin.
Como vas a utilizar con frecuencia django-admin.py, considera agregarlo a tu PATH. En
Unix, puedes hacer un link simblico de /usr/local/bin, usando un comando como sudo ln
-s /path/to/django/bin/django-admin.py /usr/local/bin/django-admin.py. En Windows, necesitars actualizar tu variable de entorno PATH .
Ejecuta el comando
django-admin.py startproject mysite
actual.
Echemos un vistazo a lo que
startproject
para crear el directorio
cre:
revisin 757 del 28 de julio de 2008
mysite
en el directorio
10
CAPTULO 2. EMPEZANDO
mysite/
__init__.py
manage.py
settings.py
urls.py
Estos archivos son los siguientes:
__init__.py:
Un archivo requerido para que Python trate a este directorio como un paquete (i.e. un
grupo de mdulos).
manage.py:
Una utilidad de lnea de comandos que te deja interactuar con este proyecto de Django
de varias formas.
settings.py: Opciones/con guraciones para este proyecto de Django.
urls.py: La declaracin de las URL para este proyecto de Django; una
tabla de contenidos de tu
sitio hecho con Django.
Dnde debera estar este directorio?
Si vienes de PHP, probablemente pondras el cdigo debajo de la carpeta raz del servidor web
(en lugares como
/var/www). Con Django, no tienes que hacer esto. No es una buena idea poner
cualquier cdigo Python en la carpeta raz del servidor web, porque al hacerlo se arriesga a que
la gente sea capaz de ver el cdigo en la web. Esto no es bueno para la seguridad.
Pon tu cdigo en algn directorio
2.4.1.
fuera de la carpeta raz.
El servidor de desarrollo
Django incluye un servidor web ligero que puedes usar mientras ests desarrollando tu sitio. Incluimos este servidor
para que puedas desarrollar tu sitio rpidamente, sin tener que lidiar con con guraciones de servidores web de produccin (i.e., Apache) hasta que ests listo para la produccin. Este servidor de desarrollo vigila tu cdigo a la espera
de cambios y se reinicia automticamente, ayudndote a hacer algunos cambios rpidos en tu proyecto sin necesidad
de reiniciar nada.
Entra en el directorio
mysite,
si an no lo has hecho, y ejecuta el comando
python manage.py runserver.
Vers
algo parecido a esto:
Validating models...
0 errors found.
Django version 1.0, using settings 'mysite.settings'
Development server is running at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
Aunque el servidor de desarrollo es extremadamente til para, bueno, desarrollar, resiste la tentacin de usar este
servidor en cualquier entorno parecido a produccin. El servidor de desarrollo puede manejar ablemente una sola
peticin a la vez, y no ha pasado por una auditora de seguridad de ningn tipo. Cuando sea el momento de lanzar tu
sitio, mira el Captulo 20 para informacin sobre cmo hacerlo con Django.
Cambiar el host o el puerto
Por defecto, el comando
runserver inicia el servidor de desarrollo en el puerto 8000, escuchando
slo conexiones locales. Si quieres cambiar el puerto del servidor, pasa este como un argumento
de lnea de comandos:
python manage.py runserver 8080
Tambin puedes cambiar las direcciones de IP que escucha el servidor. Esto es utilizado especialmente si quieres compartir el desarrollo de un sitio con otros desarrolladores. Lo siguiente:
python manage.py runserver 0.0.0.0:8080
har que Django escuche sobre cualquier interfaz de red, permitiendo que los dems equipos
puedan conectarse al servidor de desarrollo.
Ahora que el servidor est corriendo, visita
http://127.0.0.1:8000/ con tu navegador web. Vers una pgina de
Bienvenido a Django sombreada con un azul pastel agradable. Funciona!
revisin 757 del 28 de julio de 2008
2.5. QU SIGUE?
2.5.
11
Qu sigue?
Ahora que tienes todo instalado y el servidor de desarrollo corriendo, en el
de cdigo bsico que muestra cmo servir pginas Web usando Django.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
`prximo captulo`_ escribirs algo
12
CAPTULO 2. EMPEZANDO
revisin 757 del 28 de julio de 2008
Captulo 3
Los principios de las pginas Web dinmicas
En el captulo anterior, explicamos cmo crear un proyecto en Django y cmo poner en marcha el servidor de
desarrollo de Django. Por supuesto, el sitio no hace nada til todava -- slo muestra el mensaje It worked!. Cambiemos
eso. Este captulo presenta cmo crear paginas web dinmicas con Django.
3.1.
Tu primera Vista: Contenido dinmico
Lo primero que haremos es crear una pgina web que muestre la fecha y la hora actual. Este es un buen ejemplo
de una pgina dinmica, porque el contenido de la misma no es esttico -- al contrario, los contenidos cambian de
acuerdo con el resultado de un clculo (en este caso, el clculo de la hora actual). Este simple ejemplo no involucra
una base de datos cualquier tipo de entrada del usuario, slo muestra la salida del reloj interno del servidor.
Para crear esta pgina, crearemos una funcin de vista. Una funcin de vista, o vista en pocas palabras, es una
simple funcin de Python que toma como argumento una peticin Web y retorna una respuesta Web. Esta respuesta
puede ser el contenido HTML de la pgina web, una redireccin, o un error 404, o un documento XML, o una imagen...
o en realidad, cualquier cosa. La vista en s contiene toda la lgica necesaria para retornar esa respuesta. El cdigo
puede encontrarse donde quieras, mientras que se encuentre dentro de tu Python path. No hay otro requerimiento
-- no hay magia, por as decirlo. Por poner el cdigo en algn lugar, creemos un archivo llamado
directorio
mysite,
views.py
en el
el cual creamos en el captulo anterior.
Esta es la vista que retorna la fecha y hora actual, como un documento HTML:
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
html = "<html><body>It is now %s.</body></html>" % now
return HttpResponse(html)
Repasemos el cdigo anterior lnea a lnea:
HttpResponse, la cual pertenece al mdulo django.http. Para ver ms
HttpRequest y HttpResponse puedes consultar el Apndice H.
Primero, importamos la clase
detalles de los objetos
Luego importamos el mdulo
datetime
de la biblioteca estndar de Python, el conjunto de mdulos
tiles que vienen con Python. El mdulo
datetime
contiene varias funciones y clases para trabajar
con fechas y horas, incluyendo una funcin que retorna la hora actual.
A continuacin, de nimos la funcin llamada
current_datetime. Esta es una funcin de vista. Cada
HttpRequest, al que tpicamente se le asigna
funcin de vista toma como primer argumento un objeto
el nombre
request.
Nota que el nombre de la funcin de vista no importa; no tiene que ser nombrada de una determinada
current_datetime aqu, porque el nombre indica
super_duper_awesome_current_time, o algo ms
manera para que Django la reconozca. La llamamos
claramente lo que hace, pero se podra llamar
repugnante. A Django no le interesa. La siguiente seccin explica cmo Django encuentra esta funcion.
La primera lnea de cdigo dentro de la funcin calcula la fecha/hora actual, como un objeto
y almacena el resultado en la variable local
now.
revisin 757 del 28 de julio de 2008
datetime.datetime,
14
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
La segunda lnea de cdigo dentro de la funcin construye la respuesta HTML usando el formato de
cadena de caracteres de Python. El %s dentro de la cadena de caracteres es un marcador de posicin,
y el signo porcentaje despus de la cadena de caracteres, signi ca Reemplaza el %s por el valor de
la variable now.. (S, el HTML es invlido, pero estamos tratando de mantener el ejemplo simple y
corto)
Por ltimo, la vista retorna un objeto
HttpResponse que contiene la respuesta generada. Cada funcin
HttpResponse. (Hay excepciones, pero lo haremos ms
de vista es responsable de retornar un objeto
adelante)
Zona Horaria de Django
Django incluye una opcin
TIME_ZONE que por omisin es America/Chicago. Probablemente no
settings.py. Vese el Apndice E para ms
es donde vivas, por lo que puedes cambiarlo en tu
detalles.
3.2.
Mapeando URLs a Vistas
Repasemos, esta funcin de vista retorna un pgina HTML que contiene la fecha y hora actual. Pero cmo le
decimos a Django que utilice ese cdigo?. Ah es donde vienen las URLconfs.
Una URLconf es como una tabla de contenido para tu sitio web hecho con Django. Bsicamente, es un mapeo entre
los patrones URL y las funciones de vista que deben ser llamadas por esos patrones URL. Es como decirle a Django,
Para esta URL, llama a este cdigo, y para esta URL, llama a este otro cdigo. Recuerda que estas funciones de
vista deben estar en tu Python path.
Python Path
Python path es la lista de directorios en tu sistema en donde Python buscar cuando uses la
sentencia
import
de Python.
supongamos
que
tu
Python
path
tiene
el
valor
['',
'/usr/lib/python2.4/site-packages', '/home/username/djcode/']. Si ejecutas el
cdigo Python from foo import bar, Python en primer lugar va a buscar el mdulo llamado
foo.py en el directorio actual. (La primera entrada en el Python path, una cadena de caracteres
Por
ejemplo,
vaca, signi ca el directorio actual.) Si ese archivo no existe, Python va a buscar el mdulo
/usr/lib/python2.4/site-packages/foo.py.
/home/username/djcode/foo.py. Finalmente,
ImportError
en
Si ese archivo no existe, entonces probar
en
si ese archivo no existe, Python lanzar
Si ests interesado en ver el valor de tu Python path, abre un interprete interactivo de Python y
escribe
import sys,
seguido de
print sys.path.
Generalmente no tienes que preocuparte de asigarle valores al Python path -- Python y Django se
encargan automticamente de hacer esas cosas por ti entre bastidores. (Si eres curioso, establecer
el Python path es una de las cosas que hace el archivo
Cuando ejecutaste
manage.py).
django-admin.py startproject en el captulo anterior, el script
urls.py. Editemos ese archivo. Por omisin, se ver como:
cre automticamente una
URLconf por t: el archivo
from django.conf.urls.defaults import *
urlpatterns = patterns('',
# Example:
# (r'^mysite/', include('mysite.apps.foo.urls.foo')),
#
)
# Uncomment this for admin:
(r'^admin/', include('django.contrib.admin.urls')),
Repasemos el cdigo anterior lnea a lnea:
La primera lnea importa todos los objetos desde el mdulo
una funcin llamada
patterns.
django.conf.urls.defaults, incluyendo
revisin 757 del 28 de julio de 2008
3.2. MAPEANDO URLS A VISTAS
15
La segunda lnea llama a la funcin
urlpatterns.
La funcin
patterns()
patterns()
y guarda el resultado en una variable llamada
slo recibe un argumento -- la cadena de caracteres vaca.
El resto de las lneas estn comentadas. (La cadena de caracteres puede ser usada para proveer un
pre jo comn para las funciones de vista, pero dejemos este uso ms avanzado para ms adelante).
Lo principal que debemos notar aqu es la variable
ROOT_URLCONF.
urlpatterns,
la cual Django espera encontrar en tu mdulo
Esta variable de ne el mapeo entre las URLs y el cdigo que manejan esas URLs.
Por defecto, todo lo que est en URLconf est comentado -- tu aplicacin de Django es una pizarra blanca. (Como
nota adicional, esta es la forma en la que Django saba que deba mostrar la pgina It worked! en el captulo anterior.
Si la URLconf esta vaca, Django asume que acabas de crear el proyecto, por lo tanto, muestra ese mensaje).
Editemos este archivo para exponer nuestra vista
current_datetime:
from django.conf.urls.defaults import *
from mysite.views import current_datetime
urlpatterns = patterns('',
(r'^time/$', current_datetime),
)
current_datetime desde el mdulo (mysite/views.py,
mysite.views). Luego, agregamos la lnea (r'^time/$',
Hicimos dos cambios aqu. Primero, importamos la vista
que en la sintaxis de import de Python se traduce a
current_datetime),.
Esta lnea hace referencia a un URLpattern -- es una tupla de Python en dnde el primer
elemento es una expresin regular simple y el segundo elemento es la funcin de vista que usa para ese patrn.
En pocas palabras, le estamos diciendo a Django que cualquier peticin a la URL
funcin de vista
current_datetime.
/time
ser manejada por la
Algunas cosas que vale la pena resaltar:
Notemos que, en este ejemplo, pasamos la funcin de vista
current_datetime
como un objeto sin
llamar a la funcin. Esto es una caracterstica de Python (y otros lenguajes dinmicos): las funciones
son objetos de primera clase, lo cual signi ca que puedes pasarlas como cualquier otra variable. Qu
bueno!, no?
La
en
r'^time/$'
signi ca que
'^time/$
es una cadena de caracteres en crudo de Python. Esto
permite que las expresiones regulares sean escritas sin demasiadas sentencias de escape.
Puedes excluir la barra al comienzo de la expresin
'^time/$' para que coincida con /time/. Django
automticamente agrega una barra antes de toda expresin. A primera vista esto parece raro, pero
una URLconf puede ser incluida en otra URLconf, y el dejar la barra de lado simpli ca mucho las
cosas. Esto se retoma en el Captulo 8.
El caracter acento circun ejo (^) y el carcter signo de dlar ($) son importantes. El acento circun ejo
signi ca que requiere que el patrn concuerde con el inicio de la cadena de caracteres, y el signo de
dlar signi ca que exige que el patrn concuerde con el n de la cadena.
Este concepto se explica mejor con un ejemplo. Si hubiramos utilizado el patrn
el signo de dlar al nal), entonces cualquier URL que comience con
/time/foo
/time/bar,
no slo
/time/.
time/
'^time/'
Del mismo modo, si dejamos de lado el carcter acento
circun ejo inicial ('time/$'), Django concordara con cualquier URL que termine con
como
/foo/bar/time/.
(sin
concordara, as como
time/,
as
Por lo tanto, usamos tanto el acento circun ejo como el signo de dlar para
asegurarnos que slo la URL
/time/
concuerde. Nada ms y nada menos.
/time. Esto es manejado como esperaras
APPEND_SLASH tenga asignado el valor True.
Quizs te preguntes qu pasa si alguien intenta acceder a
(a travs de un redireccionamiento) siempre y cuando
(Vese el Apndice E para una buena lectura sobre este tema).
Para probar nuestro cambios en la URLconf, inicia el servidor de desarrollo de Django, como hiciste en el Captulo
2, ejecutando el comando
python manage.py runserver. (Si ya lo tenas corriendo, est bien tambin. El servidor de
desarrollo automticamente detecta los cambios en tu cdigo de Python y recarga de ser necesario, as no tienes que
reiniciar el servidor al hacer cambios). El servidor est corriendo en la direccin
abre tu navegador web y ve a
http://127.0.0.1:8000/time/.
http://127.0.0.1:8000/,
Deberas ver la salida de tu vista de Django.
Enhorabuena! Has creado tu primera pgina Web hecha con Django.
revisin 757 del 28 de julio de 2008
entonces
16
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
Expresiones Regulares
Las Expresiones Regulares (o regexes ) son la forma compacta de especi car patrones en un texto.
Aunque las URLconfs de Django permiten el uso de regexes arbitrarias para tener un potente
sistema de de nicin de URLs, probablemente en la prctica no utilices ms que un par de
patrones regex. Esta es una pequea seleccin de patrones comunes:
Smbolo
Coincide con
. (punto)
\d
[A-Z]
[a-z]
[A-Za-z]
+
[^/]+
*
{1,3}
Cualquier carcter
Cualquier dgito
Cualquier carcter, A-Z (maysculas)
Cualquier carcter, a-z (minsculas)
Cualquier carcter, a-z (no distingue entre mayscula y minscula)
Una o ms ocurrencias de la expresin anterior (ejemplo,
Cero o ms ocurrencias de la expresin anterior (ejemplo,
\d* coincidir con cero o ms dgitos)
Entre una y tres (inclusive) ocurrencias de la expresin anterior
Para ms informacin acerca de las expresiones regulares, mira el mdulo
djangoproject.com/r/python/re-module/.
3.3.
\d+ coincidir con uno o ms dgitos)
Todos los caracteres excepto la barra.
http://www.
Cmo procesa una peticin Django
Debemos sealar varias cosas en lo que hemos visto. Este es el detalle de lo que sucede cuando ejecutas el servidor
de desarrollo de Django y hacemos una peticin a una pgina Web.
El comando
python manage.py runserver
importa un archivo llamado
settings.py
desde el mis-
mo directorio. Este archivo contiene todo tipo de con guraciones opcionales para esta instancia de
Django en particular, pero una de las con guraciones ms importantes es
ROOT_URLCONF
ROOT_URLCONF.
La variable
le dice a Django qu mdulo de Python debera usar para la URLconf de este sitio
Web.
Recuerdas cuando
el
settings.py
django-admin.py startproject cre el archivo settings.py y urls.py? Bueno,
ROOT_URLCONF que apunta al urls.py generado
generado automticamente tena un
automticamente. Qu conveniente!
Cuando llega una peticin-- digamos, una peticin a la URL
apuntada por la variable
ROOT_URLCONF.
/time/
-- Django carga la URLconf
Luego comprueba cada uno de los patrones de URL en la
URLconf en orden, comparando la URL solicitada con un patrn a la vez, hasta que encuentra uno
que coincida. Cuando encuentra uno que coincide, llama a la funcin de vista asociada con ese patrn,
pasando un objeto
HttpRequest como primer parmetro de la funcin. (Veremos ms de HttpRequest
luego).
La funcin de vista es responsable de retornar un objeto
HttpResponse.
Conoces ahora lo bsico sobre cmo hacer pginas Web con Django. Es muy sencillo, realmente -- slo tenemos
que escribir funciones de vista y relacionarlas con URLs mediante URLconfs. Podras pensar que es lento enlazar las
URL con funciones usando una serie de expresiones regulares, pero te sorprenders.
3.3.1.
Cmo procesa una peticin Django: Detalles completos
Adems del mapeo directo de URLs con funciones vista que acabamos de describir, Django nos provee un poco
ms de exibilidad en el procesamiento de peticiones.
El ujo tpico -- resolucin de URLconf a una funcin de vista que retorna un
circuitado o
HttpResponse--
puede ser corto-
*augmented* mediante middleware. Los secretos del middleware sern tratados en profundidad en el
Captulo 15, pero un esquema (ver Figura 3-1) te ayudar conceptualmente a poner todas las piezas juntas.
revisin 757 del 28 de julio de 2008
3.3. CMO PROCESA UNA PETICIN DJANGO
Figura 3.1: El ujo completo de un peticin y una respuesta Django.
revisin 757 del 28 de julio de 2008
17
18
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
Cuando llega una peticin HTTP desde el navegador, un manejador espec co a cada servidor construye la
HttpRequest,
para pasarla a los componentes y maneja el ujo del procesamiento de la respuesta.
El manejador luego llama a cualquier middleware de Peticin o Vista disponible. Estos tipos de middleware son
tiles para
*augmenting* los objetos
HttpRequest
as como tambin para proveer manejo especial a determinados
tipos de peticiones. En el caso de que alguno de los mismos retornara un
HttpResponse
la vista no es invocada.
Hasta a los mejores programadores se le escapan errores (bugs ), pero el middleware de excepcin ayuda a aplastarlos.
Si una funcin de vista lanza una excepcin, el control pasa al middleware de Excepcin. Si este middleware no retorna
un
HttpResponse,
la excepcin se vuelve a lanzar.
Sin embargo, no todo est perdido. Django incluye vistas por omisin para respuestas amigables a errores 404 y
500.
Finalmente, el middleware de respuesta es bueno para el procesamiento posterior a un
HttpResponse
justo antes
de que se enve al navegador o haciendo una limpieza de recursos espec cos a una peticin.
3.4.
URLconfs y el acoplamiento dbil
Ahora es el momento de resaltar una parte clave de losofa detrs de las URLconf y detrs de Django en general:
el principio de acoplamiento dbil (loose coupling ). Para explicarlo simplemente, el acoplamiento dbil es una manera
de disear software aprovechando el valor de la importancia de que se puedan cambiar las piezas. Si dos piezas de
cdigo estn dbilmente acopladas (loosely coupled ) los cambios realizados sobre una de dichas piezas va a tener poco
o ningn efecto sobre la otra.
Las URLconfs de Django son un claro ejemplo de este principio en la prctica. En una aplicacin Web de Django,
la de nicin de la URL y la funcin de vista que se llamar estn dbilmente acopladas; de esta manera, la decisin
de cul debe ser la URL para una funcin, y la implementacin de la funcin misma, residen en dos lugares separados.
Esto permite el desarrollo de una pieza sin afectar a la otra.
En contraste, otras plataformas de desarrollo Web acoplan la URL con el programa. En las tpicas aplicaciones PHP
(http://www.php.net/), por ejemplo, la URL de tu aplicacin es designada por dnde colocas el cdigo en el sistema
de archivos. En versiones anteriores del framework Web Python CherryPy (http://www.cherrypy.org/) la URL de
tu aplicacin corresponda al nombre del mtodo donde resida tu cdigo. Esto puede parecer un atajo conveniente en
el corto plazo, pero puede tornarse inmanejable a largo plazo.
Por ejemplo, consideremos la funcin de vista que escribimos antes, la cul nos mostraba la fecha y la hora actual.
Si quieres cambiar la URL de tu aplicacin -- digamos, mover desde
/time a /currenttime/ -- puedes hacer un rpido
cambio en la URLconf, sin preocuparte acerca de la implementacin subyacente de la funcin. Similarmente, si quieres
cambiar la funcin de vista -- alterando la lgica de alguna manera -- puedes hacerlo sin afectar la URL a la que
est asociada tu funcin de vista. Adems, si quisiramos exponer la funcionalidad de fecha actual en varias URL
podramos hacerlo editando el URLconf con cuidado, sin tener que tocar una sola lnea de cdigo de la vista.
Eso es el acoplamiento dbil en accin. Continuaremos exponiendo ejemplos de esta importante losofa de desarrollo
a lo largo del libro.
3.5.
Errores 404
En las URLconf anteriores, hemos de nido un solo patrn URL: el que maneja la peticin para la URL
/time.
Qu pasara si se solicita una URL diferente?
Para averiguarlo, prueba ejecutar el servidor de desarrollo Django e intenta acceder a una pgina Web como
http://127.0.0.1:8000/hello/ o http://127.0.0.1:8000/does-not-exist/, o mejor como http://127.0.0.1:8000/
(la raz del sitio). Deberas ver el mensaje Page not found (ver la Figura 3-2). (Es linda, no? A la gente de Django
seguro le gustan los colores pasteles). Django muestra este mensaje porque solicitaste una URL que no est de nida
en tu URLconf.
La utilidad de esta pgina va ms all del mensaje bsico de error 404; nos dice tambin, qu URLconf utiliz
Django y todos los patrones de esa URLconf. Con esa informacin, tendramos que ser capaces de establecer porqu
la URL solicitada lanz un error 404.
Naturalmente, esta es informacin importante slo destinada a ti, el administrador Web. Si esto fuera un sitio en
produccin alojado en Internet, no quisiramos mostrar esta informacin al pblico. Por esta razn, la pgina Page
not found es slo mostrada si nuestro proyecto en Django est en modo de depuracin (debug mode ). Explicaremos
cmo desactivar este modo ms adelante. Por ahora, slo diremos que todos los proyectos estn en modo de depuracin
cuando los creamos, y si el proyecto no lo estuviese, se retornara una respuesta diferente.
revisin 757 del 28 de julio de 2008
3.5. ERRORES 404
19
Figura 3.2: Pgina 404 de Django
revisin 757 del 28 de julio de 2008
20
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
3.6.
Tu segunda Vista: URLs dinmicas
En la primer vista de ejemplo, el contenido de la pgina -- la fecha/hora actual -- eran dinmicas, pero la URL
(/time) era esttica. En la mayora de las aplicaciones Web, sin embargo, la URL contiene parmetros que in uyen
en la salida de la pgina.
Vamos a crear una segunda vista que nos muestre la fecha y hora actual con un adelanto de ciertas horas. El
objetivo es montar un sitio en la que la pgina
/time/plus/2/
la pgina
/time/plus/1/
muestre la fecha/hora una hora ms adelantada,
muestre la fecha/hora dos horas ms adelantada, la pgina
/time/plus/3/
muestre la
fecha/hora tres horas ms adelantada, y as.
A un novato se le ocurrira escribir una funcin de vista distinta para cada adelanto de horas, lo que resultara una
URLconf como esta:
urlpatterns = patterns('',
(r'^time/$', current_datetime),
(r'^time/plus/1/$', one_hour_ahead),
(r'^time/plus/2/$', two_hours_ahead),
(r'^time/plus/3/$', three_hours_ahead),
(r'^time/plus/4//$', four_hours_ahead),
)
Claramente, esta lnea de pensamiento es incorrecta. No slo porque producir redundancia entre las funciones de
vista, sino tambin la aplicacin estar limitada a admitir slo el rango horario de nido -- uno, dos, tres o cuatro horas.
Si, de repente, quisiramos crear una pgina que mostrara la hora cinco horas adelantada, tendramos que crear una
vista distinta y una lnea URLconf, perpetuando la duplicacin y la demencia. Aqu necesitamos algo de abstraccin.
3.6.1.
Algunas palabras acerca de las URLs bonitas
Si tienes experiencia en otra plataforma de diseo Web, como PHP o Java, es posible que ests pensado, Oye,
usemos un parmetro cadena de consulta!, algo como
parmetro
hours
/time/plus?hours=3,
en la cual la hora ser designada por el
de la cadena de consulta de la URL (la parte a continuacin de
?).
Con Django puedes hacer eso (pero te diremos cmo ms adelante, si es que realmente quieres saberlo), pero una
de las losofas del ncleo de Django es que las URLs deben ser bonitas. La URL
/time/plus/3 es mucho ms limpia,
ms simple, ms legible, ms fcil de dictarse a alguien y . . . justamente ms bonita que su homloga forma de cadena
de consulta. Las URLs bonitas son un signo de calidad en las aplicaciones Web.
El sistema de URLconf que usa Django estimula a generar URLs bonitas, haciendo ms fcil el usarlas que el no
usarlas.
3.6.2.
Comodines en los patrones URL
Continuando con nuestro ejemplo
hours_ahead,
pongmosle un comodn al patrn URL. Como ya se mencion
antes, un patrn URL es una expresin regular; de aqu, es que usamos el patrn de expresin regular
\d+
para que
coincida con uno o ms dgitos:
from django.conf.urls.defaults import *
from mysite.views import current_datetime, hours_ahead
urlpatterns = patterns('',
(r'^time/$', current_datetime),
(r'^time/plus/\d+/$', hours_ahead),
)
Este patrn coincidir con cualquier URL que sea como
/time/plus/2/, /time/plus/25/, o tambin /time/plus/100000000000/
Ahora que lo pienso, podemos limitar el lapso mximo de horas en 99. Eso signi ca que queremos tener nmeros de
uno o dos dgitos en la sintaxis de las expresiones regulares, con lo que nos quedara as
\d{1,2}:
(r'^time/plus/\d{1,2}/$', hours_ahead),
Nota
Cuando construimos aplicaciones Web, siempre es importante considerar el caso ms descabellado
posible de entrada, y decidir si la aplicacin admitir o no esa entrada. Aqu hemos limitado a
los exagerados reconociendo lapsos de hasta 99 horas. Y, por cierto, Los Limitadores exagerados,
aunque largo, sera un nombre fantstico para una banda musical.
revisin 757 del 28 de julio de 2008
3.6. TU SEGUNDA VISTA: URLS DINMICAS
21
Ahora designaremos el comodn para la URL, necesitamos una forma de pasar esa informacin a la funcin de
vista, as podremos usar una sola funcin de vista para cualquier adelanto de hora. Lo haremos colocando parntesis
alrededor de los datos en el patrn URL que querramos guardar. En el caso del ejemplo, queremos guardar cualquier
nmero que se anotar en la URL, entonces pongamos parntesis alrededor de
\d{1,2}:
(r'^time/plus/(\d{1,2})/$', hours_ahead),
Si ests familiarizado con las expresiones regulares, te sentirs como en casa aqu; estamos usando parntesis para
capturar los datos del texto que coincide.
La URLconf nal, incluyendo la vista anterior
current_datetime,
nos quedar algo as:
from django.conf.urls.defaults import *
from mysite.views import current_datetime, hours_ahead
urlpatterns = patterns('',
(r'^time/$', current_datetime),
(r'^time/plus/(\d{1,2})/$', hours_ahead),
)
Con cuidado, vamos a escribir la vista
hours_ahead.
Orden para programar
En este ejemplo, primero escribimos el patrn URL y en segundo lugar la vista, pero en el ejemplo
anterior, escribimos la vista primero y luego el patrn de URL. Qu tcnica es mejor? Bien, cada
programador es diferente.
Si eres del tipo de programadores que piensan globalmente, puede que tenga ms sentido que
escribas todos los patrones de URL para la aplicacin al mismo tiempo, al inicio del proyecto, y
despus el cdigo de las funciones de vista. Esto tiene la ventaja de darnos una lista de objetivos
clara, y es esencial de nir los parmetros requeridos por las funciones de vista que necesitaremos
desarrollar.
Si eres del tipo de programadores que les gusta ir de abajo hacia arriba, tal vez pre eras escribir
las funciones de vista primero, y luego asociarlas a URLs. Esto tambin est bien.
Al nal, todo se reduce a elegir qu tcnica se amolda ms a tu cerebro. Ambos enfoques son
vlidos.
hours_ahead es muy similar a current_datetime, vista que escribimos antes, slo que con una diferencia: tomar
views.py lo siguiente:
un argumento extra, el nmero de horas que debemos adelantar. Agrega al archivo
def hours_ahead(request, offset):
offset = int(offset)
dt = datetime.datetime.now() + datetime.timedelta(hours=offset)
html = "<html><body>In %s hour(s), it will be %s.</body></html>" % (offset, dt)
return HttpResponse(html)
Repasemos el cdigo anterior lnea a lnea:
current_datetime, importamos la clase django.http.HttpResponse y
datetime.
funcin de vista hours_ahead, toma dos parmetros: request y offset.
request es un objeto HttpRequest, al igual que en current_datetime. Lo diremos nuevamente: cada vista siempre toma un objeto HttpRequest como primer parmetro.
offset es la cadena de caracteres capturada por los parntesis en el patrn URL. Por
ejemplo, si la peticin URL fuera /time/plus/3/, entonces el offset debera ser la
cadena de caracteres '3'. Si la peticin URL fuera /time/plus/21/, entonces el offset
debera ser la cadena de caracteres '21'. Notar que la cadena de caracteres capturada
Tal como hicimos en la vista
el mdulo
La
siempre es una cadena de caracteres, no un entero, incluso si se compone slo de dgitos,
como en el caso
'21'.
Decidimos llamar a la variable
offset, pero puedes asignarle el nombre que quieras, siem-
pre que sea un identi cador vlido para Python. El nombre de la variable no importa; todo
lo que importa es lo que contiene el segundo parmetro de la funcin (luego de
request).
Es posible tambin usar una palabra clave, en lugar de posicin, como argumentos en la
URLconf. Eso lo veremos en detalle en el Captulo 8.
revisin 757 del 28 de julio de 2008
22
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
Lo primero que hacemos en la funcin es llamar a
int()
sobre
offset.
Esto convierte el valor de la
cadena de caracteres a entero.
Tener en cuenta que Python lanzar una excepcin
ValueError si se llama a la funcin int() con un
'foo'. Sin embargo,
valor que no puede convertirse a un entero, como lo sera la cadena de caracteres
en este ejemplo no debemos preocuparnos de atrapar la excepcin, porque tenemos la certeza que
la variable
offset
ser una cadena de caracteres conformada slo por dgitos. Sabemos esto, por el
patrn URL de la expresin regular en el URLconf --
(\d{1,2})--
captura slo dgitos. Esto ilustra
otra ventaja de tener un URLconf: nos provee un primer nivel de validacin de entrada.
La siguiente lnea de la funcin muestra la razn por la que se llam a la funcin
En esta lnea, calculamos la hora actual ms las hora que tiene
la variable
dt.
La funcin
datetime.timedelta
offset,
int()
con
offset.
almacenando el resultado en
requiere que el parmetro
hours
sea un entero.
A continuacin, construimos la salida HTML de esta funcin de vista, tal como lo hicimos en la vista
current_datetime.
Una pequea diferencia en esta lnea, es que usamos el formato de cadenas de
Python con dos valores, no slo uno. Por lo tanto, hay dos smbolos %s en la cadena de caracteres y
(offset, dt).
Finalmente, retornamos el HttpResponse del HTML -- de nuevo, tal como hicimos en la vista current_datetime.
la tupla de valores a insertar sera:
Con esta funcin de vista y la URLconf escrita, ejecuta el servidor de desarrollo de Django (si no est co-
http://127.0.0.1:8000/time/plus/3/ para veri car que lo que hicimos funciona. Luego prueba
http://127.0.0.1:8000/time/plus/5/. Para terminar visita http://127.0.0.1:8000/time/plus/100/ para verirriendo), y visita
car que el patrn en la URLconf slo acepta nmero de uno o dos dgitos, Django debera mostrar un error en este caso
como Page not found, tal como vimos en la seccin Errores 404 anteriormente. La URL
(sin horas designadas) debera tambin mostrar un error 404.
Si ests siguiendo el libro y programando al mismo tiempo, notars que el archivo
vistas. (Omitimos la vista
current_datetime
http://127.0.0.1:8000/time/plus/
views.py
ahora contiene dos
del ejemplo anterior slo por claridad). Ponindolas juntas, veramos
algo similar a esto:
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
html = "<html><body>It is now %s.</body></html>" % now
return HttpResponse(html)
def hours_ahead(request, offset):
offset = int(offset)
dt = datetime.datetime.now() + datetime.timedelta(hours=offset)
html = "<html><body>In %s hour(s), it will be %s.</body></html>" % (offset, dt)
return HttpResponse(html)
3.7.
Pginas de error bonitas con Django
Tommonos un momento para admirar la bonita aplicacin web que hemos creado hasta ahora . . . y ahora
rompmosla! Introduzcamos deliberadamente un error de Python en el archivo
= int(offset)
de la vista
hours_ahead:
views.py comentando la lnea offset
def hours_ahead(request, offset):
#offset = int(offset)
dt = datetime.datetime.now() + datetime.timedelta(hours=offset)
html = "<html><body>In %s hour(s), it will be %s.</body></html>" % (offset, dt)
return HttpResponse(html)
/time/plus/3/. Vers una pgina de error con mucha informacin
TypeError mostrado en la parte superior de la pgina: "unsupported type for
timedelta hours component: str".
Qu ha ocurrido? Bueno, la funcin datetime.timedelta espera que el parmetro hours sea un entero, y hemos
comentado la lnea de cdigo que realiza la conversin del offset a entero. Eso causa que datetime.timedelta lance
un TypeError. Es el tpico pequeo bug que todo programador comete en algn momento.
Ejecuta el servidor de desarrollo y navega a
signi cativa, incluyendo el mensaje
revisin 757 del 28 de julio de 2008
3.8. QU SIGUE?
23
El punto de este ejemplo fue demostrar la pgina de error de Django. Dediquemos un momento a explorar esta
pgina y descubrir las distintas piezas de informacin que nos brinda.
Aqu comentamos algunas cosas a destacar:
En la parte superior de la pgina se muestra la informacin clave de la excepcin: el tipo y cualquier
parmetro de la excepcin (el mensaje
"unsupported type"
en este caso), el archivo en el cul la
excepcin fue lanzada, y el nmero de lnea que contiene el error.
*traceback* de Python para
*traceback* estndar que se obtiene en el interprete de Python, slo que
Abajo de la informacin clave de la excepcin, la pgina muestra el
dicha excepcin. Este es el
ms interactivo. Por cada marco de la pila, Django muestra el nombre del archivo, el nombre de la
funcin/mtodo, el nmero de lnea, y el cdigo fuente de esa lnea.
Haz click en la lnea de cdigo (en gris oscuro) para ver varias lneas anteriores y posteriores a la lnea
errnea, lo que nos brinda un poco de contexto.
Haz click en Locals vars debajo de cualquier marco de la pila para ver la tabla de todas las variables
locales y sus valores, en ese marco y en la posicin exacta de cdigo en el cual fue lanzada la excepcin.
Esta informacin de depuracin es invaluable.
Nota el texto Switch to copy-and-paste view debajo de la cabecera Traceback . Haz click en esas
palabras, y el
*traceback* cambiar a una versin que te permitir fcilmente copiar y pegar. Usando
esto para cuando necesitemos compartir el traceback de la excepcin con otros para obtener soporte
tcnico -- como los amables colegas que encontraremos en el canal de IRC o la lista de correo de
Django.
A continuacin, la seccin Request information incluye una gran cantidad de informacin sobre la
peticin Web que provoc el error: informacin GET y POST, valores de las cookies y meta informacin
como las cabeceras CGI. El
Apndice H`_`_ es una completa referencia sobre toda la informacin
que contienen los objetos peticiones.
Inline literal start-string without end-string.
Ms abajo, la seccin Settings lista la con guracin de la instalacin de Django en particular. El
Apndice E`_`_, cubre en detalle los ajustes de con guracin disponibles. Por ahora, slo mira los
ajustes para tener una idea de la informacin disponible.
Inline literal start-string without end-string.
La pgina de error de Django es capaz de mostrar ms informacin en ciertos casos especiales, como por ejemplo,
en el caso de error de sintaxis en las plantillas. Lo abordaremos ms tarde, cuando discutamos el sistema de plantillas
de Django. Por ahora, quita el comentario en la lnea
offset = int(offset)
normalmente de nuevo.
para que la funcin de vista funcione
print cuidadosamente colocadas?
print. En cualquier punto de la vista,
Eres el tipo de programador al que le gusta depurar con la ayuda de sentencias
Puedes usar la pgina de error de Django para hacer eso -- sin la sentencia
temporalmente podemos insertar un
assert False
para provocar una pgina de error. Luego, podremos ver las
variables locales y el estado del programa. (Hay maneras ms avanzadas de depurar las vista en Django, lo explicaremos
ms adelante, pero esto es la forma ms rpida y fcil).
Finalmente, es obvio que la mayor parte de la informacin es delicada -- expone las entraas del cdigo fuente de
Python, como tambin de la con guracin de Django -- y sera una estupidez mostrarla al pblico en Internet. Una
persona con malas intenciones podra usar esto para intentar aplicar ingeniera inversa en la aplicacin Web y hacer
cosas maliciosas. Por esta razn, la pgina de error es mostrada slo cuando el proyecto est en modo depuracin.
Explicaremos cmo desactivar este modo ms adelante. Por ahora, hay que tener en claro que todos los proyectos
de Django estn en modo depuracin automticamente cuando son creados. (Suena familiar? Los errores Page not
found, descriptos en la seccin Errores 404, trabajan de manera similar.)
3.8.
Qu sigue?
Hasta ahora hemos producido las vistas mediante cdigo HTML dentro del cdigo Python. Desafortunadamente,
esto es casi siempre es una mala idea. Pero por suerte, con Django podemos hacer esto con un potente motor de
plantillas que nos permite separar el diseo de las pginas del cdigo fuente subyacente. Nos sumergiremos en el motor
de plantillas de Django en el
`prximo captulo`_
Duplicate explicit target name: prximo captulo.
malformed hyperlink target.
malformed hyperlink target.
Explicit markup ends without a blank line; unexpected unindent.
revisin 757 del 28 de julio de 2008
24
CAPTULO 3. LOS PRINCIPIOS DE LAS PGINAS WEB DINMICAS
revisin 757 del 28 de julio de 2008
Captulo 4
El sistema de plantillas de Django
En el captulo anterior, quizs notaste algo extrao en cmo retornbamos el texto en nuestras vistas de ejemplos.
A saber, el HTML fue codi cado
2 directamente en nuestro cdigo Python.
Este convenio conduce a problemas severos:
Cualquier cambio en el diseo de la pgina requiere un cambio en el cdigo de Python. El diseo de
un sitio tiende a cambiar ms frecuentemente que el subyacente cdigo de Python, por lo que sera
conveniente si el diseo podra ser cambiado sin la necesidad de modi car el cdigo Python.
Escribir cdigo Python y disear HTML son dos disciplinas diferentes, y la mayora de los entornos
de desarrollo web profesional dividen estas responsabilidades entre personas separadas (o incluso en
departamento separados). Diseadores y programadores HTML/CSS no deberan tener que editar
cdigo Python para conseguir hacer su trabajo; ellos deberan tratar con HTML.
Asimismo, esto es ms e ciente si los programadores pueden trabajar sobre el cdigo Python y los
diseadores sobre las plantillas al mismo tiempo, ms bien que una persona espere por otra a que
termine de editar un solo archivo que contiene ambos: Python y HTML.
Por esas razones, es mucho ms limpio y mantenible separar el diseo de la pgina del cdigo Python en s mismo.
Podemos hacer esto con el sistema de plantillas de Django, el cual trataremos en este captulo.
4.1.
Sistema bsico de plantillas
Una plantilla de Django es una cadena de texto que pretende separar la presentacin de un documento de sus
datos. Una plantilla de ne rellenos y diversos bits de lgica bsica (esto es, etiquetas de plantillas) que regulan como
el documento debe ser mostrado. Normalmente, las plantillas son usadas para producir HTML, pero las plantillas de
Django son igualmente capaces de generar cualquier formato basado en texto.
Vamos a sumergirnos con una simple plantilla de ejemplo. Esta plantilla describe una pgina HTML que agradece
a una persona por un pedido de la empresa. Piensa en esto como un formulario de una carta:
<html>
<head><title>Ordering notice</title></head>
<body>
<p>Dear {{ person_name }},</p>
<p>Thanks for placing an order from {{ company }}. It's scheduled to
ship on {{ ship_date|date:"F j, Y" }}.</p>
<p>Here are the items you've ordered:</p>
<ul>
{ % for item in item_list %}
<li>{{ item }}</li>
{ % endfor %}
</ul>
revisin 757 del 28 de julio de 2008
26
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
{ % if ordered_warranty %}
<p>Your warranty information will be included in the packaging.</p>
{ % endif %}
<p>Sincerely,<br />{{ company }}</p>
</body>
</html>
Esta plantilla es un HTML bsico con algunas variables y etiquetas de plantillas agregadas. Vamos paso a paso a
travs de este:
Cualquier texto encerrado por un par de llaves (por ej.
{{ person_name }})
es una variable. Esto
signi ca insertar el valor de la variable con el nombre tomado. Cmo especi camos el valor de las
variables?. Vamos a llegar a eso en un momento.
Cualquier texto que est rodeado por llaves y signos de porcentaje (por ej.
{ % if ordered_warranty %})
es una etiqueta de plantilla. La de nicin de etiqueta es bastante extensa: una etiqueta slo le indica
al sistema de plantilla haz algo.
Este ejemplo de plantilla contiene dos etiquetas: la etiqueta
etiqueta
for)
Una etiqueta
y la etiqueta
for
{ % if ordered_warranty %}
{ % for item in item_list %}
if).
(una
(una etiqueta
acta como un simple constructor de bucle, dejndote recorrer sobre cada uno de
los items de una secuencia. Una etiqueta
if,
como quizs esperabas, acta como una clusula lgica
ordered_warranty
True. Si lo hace, el sistema de plantillas mostrar todo entre { % if ordered_warranty %} y
{ % endif %}. Si no, el sistema de plantillas no mostrar esto. El sistema de plantillas tambin admite
{ % else %} y otras varias clusulas lgicas.
if . En este caso en particular, la etiqueta chequea cuando el valor de la variable
evala a
Finalmente, el segundo prrafo de esta plantilla tiene un ejemplo de un ltro, con el cual puedes alterar
la exposicin de una variable. En este ejemplo,
la variable
date
ship_date
por el ltro
date,
{{ ship_date|date:"F j, Y" }}, estamos
date el argumento "F j, Y".
tomando el ltro
pasando
El ltro
formatea fechas en el formato tomado, especi cado por ese argumento. Los ltros se conceden
mediante el uso de un caracter pipe (|), como una referencia a las tuberas de Unix.
Cada plantilla de Django tiene acceso a varias etiquetas y ltros incorporados, algunas de ellas sern tratadas en
la seccin que sigue. El Apndice F contiene la lista completa de etiquetas y ltros, y sta es una buena idea para
familiarizarse con esta lista, de modo que sepas qu es posible. Tambin es posible crear tus propios ltros y etiquetas,
los cuales cubriremos en el
4.2.
`Captulo 10`_.
Empleo del sistema de plantillas
Para usar el sistema de plantillas en el cdigo Python, slo sigue estos dos pasos:
1. Crea un objeto
Template
brindando el cdigo crudo de la plantilla como una cadena. Django
tambin ofrece un camino para crear objetos
Template por la designacin de una ruta al archivo
de plantilla en el sistemas de archivo; vamos a examinar esto en un rato.
2. Llama al mtodo
render() del objeto Template con un conjunto de variables (o sea, el contexto).
Este retorna una plantilla totalmente renderizada como una cadena de caracteres, con todas las
variables y etiquetas de bloques evaluadas de acuerdo al contexto.
Las siguientes secciones describen cada uno de los pasos con mayor detalle.
4.2.1.
Creacin de objetos Template
La manera fcil de crear objetos
django.template,
Template es instanciarlo directamente. La clase Template se encuentra en el mdulo
y el constructor toma un argumento, el cdigo en crudo de la plantilla. Vamos a sumergirnos en el
intrprete interactivo de Python para ver como funciona este cdigo.
revisin 757 del 28 de julio de 2008
4.2. EMPLEO DEL SISTEMA DE PLANTILLAS
27
Ejemplos del Intrprete Interactivo
Durante todo el libro, hemos expuesto sesiones de ejemplo del intrprete Python interactivo.
Puedes reconocer estos ejemplos por el triple signo mayor-que (>>>), el cul designa el prompt
del intrprete. Si ests copiando los ejemplos del libro, no copies estos signos mayor-que.
Las sentencias multilneas en el intrprete interactivo son rellenadas con tres puntos (...), por
ejemplo:
>>> print """This is a
... string that spans
... three lines."""
This is a
string that spans
three lines.
>>> def my_function(value):
...
print value
>>> my_function('hello')
hello
Esos tres puntos al comienzo de una lnea adicional son insertados por el shell de Python -- no
son parte de nuestra entrada. Los incluimos aqu por ser el a la salida actual del intrprete. Si
ests copiando nuestros ejemplos para seguirlos, no copies esos puntos.
Desde dentro del directorio del proyecto creado por
tulo 2), escribe
python manage.py shell
django-admin.py startproject (como se expuso en el Cap-
para comenzar el intrprete interactivo. Aqu hay una base:
>>> from django.template import Template
>>> t = Template("My name is {{ name }}.")
>>> print t
Si lo ests siguiendo interactivamente, vers algo como esto:
<django.template.Template object at 0xb7d5f24c>
Ese
0xb7d5f24c ser
Template.
distinto cada vez, y realmente no importa; es la simple forma en que Python identi ca un
objeto de
Variables de con guracin de Django
Cuando usas Django, necesitas indicarle qu valores usar para sus variables de con guracin.
Interactivamente, suele usarse
python manage.py shell,
pero tienes otras opciones descriptas
en el Apndice E.
Cuando creas un objeto
Template,
el sistema de plantillas compila el cdigo crudo en uno interno, de forma
optimizada, listo para renderizar. Pero si tu cdigo de plantilla incluye errores de sintaxis, la llamada a
causar una excepcin
TemplateSyntaxError:
>>> from django.template import Template
>>> t = Template('{ % notatag %} ')
Traceback (most recent call last):
File "<stdin>", line 1, in ?
...
django.template.TemplateSyntaxError: Invalid block tag: 'notatag'
El sistema lanza una excepcin
TemplateSyntaxError
por alguno de los siguientes casos:
Bloques de etiquetas invlidos
Argumentos invlidos de una etiqueta vlida
Filtros invlidos
Argumentos invlidos para ltros vlidos
Sintaxis de plantilla invlida
Etiquetas de bloque sin cerrar (para etiquetas de bloque que requieran la etiqueta de cierre)
revisin 757 del 28 de julio de 2008
Template()
28
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
4.2.2.
Renderizar una plantilla
Una vez que tienes un objeto
Template, le puedes pasar datos brindando un contexto. Un contexto es simplemente
un conjunto de variables y sus valores asociados. Una plantilla usar estas variables para poblar y evaluar estas etiquetas
de bloque.
Un contexto es representado en Django por la clase
Context,
sta se encuentra en el mdulo
django.template.
Su constructor toma un argumento opcional: un diccionario mapeando nombres de variables con valores. La llamada
al mtodo
>>>
>>>
>>>
>>>
'My
render()
del objeto
Template
con el contexto rellena la plantilla:
from django.template import Context, Template
t = Template("My name is {{ name }}.")
c = Context({"name": "Stephane"})
t.render(c)
name is Stephane.'
Diccionarios y Contextos
Un diccionario de Python es un mapeo entre llaves conocidas y valores de variables. Un
es similar a un diccionario, pero un
`Captulo 10`_.
Context
Context
provee funcionalidad adicional, como se cubre en el
Los nombres de las variables deben comenzar con una letra (A-Z o a-z) y pueden contener dgitos, guiones bajos,
y puntos. (Los puntos son un caso especial al que llegaremos en un momento). Los nombres de variables son sensible
a maysculas-minsculas.
Este es un ejemplo de compilacin y renderizacin de una plantilla, usando una plantilla de muestra comienzo de
este captulo:
>>> from django.template import Template, Context
>>> raw_template = """<p>Dear {{ person_name }},</p>
...
... <p>Thanks for ordering {{ product }} from {{ company }}. It's scheduled
... to ship on {{ ship_date|date:"F j, Y" }}.</p>
...
... { % if ordered_warranty %}
... <p>Your warranty information will be included in the packaging.</p>
... { % endif %}
...
... <p>Sincerely,<br />{{ company }}</p>"""
>>> t = Template(raw_template)
>>> import datetime
>>> c = Context({'person_name': 'John Smith',
...
'product': 'Super Lawn Mower',
...
'company': 'Outdoor Equipment',
...
'ship_date': datetime.date(2009, 4, 2),
...
'ordered_warranty': True})
>>> t.render(c)
"<p>Dear John Smith,</p>\n\n<p>Thanks for ordering Super Lawn Mower from
Outdoor Equipment. It's scheduled \nto ship on April 2, 2009.</p>\n\n\n
<p>Your warranty information will be included in the packaging.</p>\n\n\n
<p>Sincerely,<br />Outdoor Equipment</p>"
Vamos paso a paso por este cdigo de a una sentencia a la vez:
Primero, importamos la clase
Template y Context, ambas se encuentran en el mdulo django.template.
Guardamos el texto crudo de nuestra plantilla en la variable
raw_template.
Note que usamos triple
comillas para designar la cadena de caracteres, debido a que envuelven varias lneas; en el cdigo
Python, las cadenas de caracteres designadas con una sola comilla marca que no puede envolver varias
lneas.
Luego, creamos un objeto plantilla,
t,
pasndole
raw_template
al constructor de la clase
revisin 757 del 28 de julio de 2008
Template.
4.2. EMPLEO DEL SISTEMA DE PLANTILLAS
Importamos el mdulo
29
datetime desde la biblioteca estndar de Python, porque lo vamos a necesitar
en la prxima sentencia.
Context , c. El constructor de Context toma un diccionario de Python,
person_name
es 'John Smith', product es 'Super Lawn Mower', y as sucesivamente.
Finalmente, llamamos al mtodo render() sobre nuestro objeto de plantilla, pasando a este el conEntonces, creamos un objeto
el cual mapea nombres de variables con valores. Aqu, por ejemplo, especi camos que la
texto. Este retorna la plantilla renderizada -- esto es, reemplaza las variables de la plantilla con los
valores actuales de las variables, y ejecuta cualquier bloque de etiquetas.
Nota que el prrafo de garanta fue mostrado porque la variable
Tambin nota que la fecha
j, Y.
April 2, 2009,
ordered_warranty
evalu a
True.
F
es mostrada acorde al formato de cadena de caracteres
(Explicaremos los formatos de cadenas de caracteres para el ltro
date
a la brevedad).
Si eres nuevo en Python, quizs te asombre porqu la salida incluye los caracteres de nueva lnea ('\n')
en vez de mostrar los saltos de lnea. Esto sucede porque es una sutileza del intrprete interactivo de
Python: la llamada a
t.render(c)
retorna una cadena de caracteres, y el intrprete interactivo, por
omisin, muestra una representacin de esta, en vez de imprimir el valor de la cadena. Si quieres ver
la cadena de caracteres con los saltos de lneas como verdaderos saltos de lneas en vez de caracteres
'\n',
usa la sentencia
print: print t.render(c).
Estos son los fundamentos de usar el sistema de plantillas de Django: slo escribe una plantilla, crea un objeto
Template,
4.2.3.
crea un
Context,
y llama al mtodo
render().
Mltiples contextos, mismas plantillas
Una vez que tengas un objeto
Template,
puedes renderizarlo con de mltiples contextos, por ejemplo:
>>> from django.template import Template, Context
>>> t = Template('Hello, {{ name }}')
>>> print t.render(Context({'name': 'John'}))
Hello, John
>>> print t.render(Context({'name': 'Julie'}))
Hello, Julie
>>> print t.render(Context({'name': 'Pat'}))
Hello, Pat
Cuando ests usando la misma plantilla fuente para renderizar mltiples contextos como este, es ms e ciente crear
el objeto
Template
una sola vez y luego llamar a
render()
sobre este muchas veces:
# Bad
for name in ('John', 'Julie', 'Pat'):
t = Template('Hello, {{ name }}')
print t.render(Context({'name': name}))
# Good
t = Template('Hello, {{ name }}')
for name in ('John', 'Julie', 'Pat'):
print t.render(Context({'name': name}))
El anlisis sintctico de las plantillas de Django es bastante rpido. Detrs de escena, la mayora de los analizadores
pasan con una simple llamada a una expresin regular corta. En contraste con el motor de plantillas de XML, que
incurren en la actividad general de un analizador XML, tienden a ser rdenes de magnitud ms lentos que el motor
de renderizado de Django.
4.2.4.
Bsqueda del contexto de una variable
En los ejemplos hasta el momento, pasamos simples valores en los contextos--en su mayora cadena de caracteres, ms un
datetime.date.
Sin embargo, el sistema de plantillas maneja elegantemente estructuras de datos ms
complicadas, como listas, diccionarios, y objetos personalizados.
La clave para atravesar estructuras de datos complejas en las plantillas de Django ese el carcter punto (.). Usa
un punto para acceder a las claves de un diccionario, atributos, ndices, o mtodos de un objeto.
Esto es mejor ilustrarlos con algunos ejemplos. Por ejemplo, supone que pasas un diccionario de Python a una
plantilla. Para acceder al valor de ese diccionario por su clave, usa el punto:
revisin 757 del 28 de julio de 2008
30
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
>>> from django.template import Template, Context
>>> person = {'name': 'Sally', 'age': '43'}
>>> t = Template('{{ person.name }} is {{ person.age }} years old.')
>>> c = Context({'person': person})
>>> t.render(c)
'Sally is 43 years old.'
De forma similar, los puntos te permiten acceder a los atributos de los objetos. Por ejemplo, un objeto de Python
datetime.date
tiene los atributos
year, month
day,
y puedes usar el punto para acceder a ellos en las plantillas de
Django:
>>> from django.template import Template, Context
>>> import datetime
>>> d = datetime.date(1993, 5, 2)
>>> d.year
1993
>>> d.month
5
>>> d.day
2
>>> t = Template('The month is {{ date.month }} and the year is {{ date.year }}.')
>>> c = Context({'date': d})
>>> t.render(c)
'The month is 5 and the year is 1993.'
Este ejemplo usa una clase personalizada:
>>> from django.template import Template, Context
>>> class Person(object):
...
def __init__(self, first_name, last_name):
...
self.first_name, self.last_name = first_name, last_name
>>> t = Template('Hello, {{ person.first_name }} {{ person.last_name }}.')
>>> c = Context({'person': Person('John', 'Smith')})
>>> t.render(c)
'Hello, John Smith.'
Los puntos tambin son utilizados para llamar a mtodos sobre los objetos. Por ejemplo, cada cadena de caracteres
de Python tiene el mtodos
upper() y isdigit(), y puedes llamar a estos en las plantillas de Django usando la misma
sintaxis de punto:
>>> from django.template import Template, Context
>>> t = Template('{{ var }} -- {{ var.upper }} -- {{ var.isdigit }}')
>>> t.render(Context({'var': 'hello'}))
'hello -- HELLO -- False'
>>> t.render(Context({'var': '123'}))
'123 -- 123 -- True'
Nota que no tienes que incluir los parntesis en las llamadas a los mtodos. Adems, tampoco es posible pasar
argumentos a los mtodos; slo puedes llamar los mtodos que no requieran argumentos. (Explicaremos esta losofa
luego en este captulo).
Finalmente, los puntos tambin son usados para acceder a los ndices de las listas, por ejemplo:
>>> from django.template import Template, Context
>>> t = Template('Item 2 is {{ items.2 }}.')
>>> c = Context({'items': ['apples', 'bananas', 'carrots']})
>>> t.render(c)
'Item 2 is carrots.'
Los ndices negativos de las listas no estn permitidos. Por ejemplo, la variable
TemplateSyntaxError.
revisin 757 del 28 de julio de 2008
{{ items.-1 }}
causar una
4.2. EMPLEO DEL SISTEMA DE PLANTILLAS
31
Listas de Python
Las listas de Python comienzan en cero, entonces el primer elemento es el 0, el segundo es el 1 y
as sucesivamente.
La bsqueda del punto puede resumirse como esto: cuando un sistema de plantillas encuentra un punto en una
variable, este intenta la siguiente bsqueda en este orden:
foo["bar"])
foo.bar)
Llamada de mtodo (por ej. foo.bar())
ndice de lista (por ej. foo[bar])
Diccionario (por ej.
Atributo (por ej.
El sistema utiliza el primer tipo de bsqueda que funcione. Es la lgica de cortocircuito.
Los puntos pueden ser anidados a mltiples niveles de profundidad. El siguiente ejemplo usa
}}, el cual
(upper()):
{{ person.name.upper
se traslada en una bsqueda de diccionario (person['name']) y luego en una llamada a un mtodo
>>> from django.template import Template, Context
>>> person = {'name': 'Sally', 'age': '43'}
>>> t = Template('{{ person.name.upper }} is {{ person.age }} years old.')
>>> c = Context({'person': person})
>>> t.render(c)
'SALLY is 43 years old.'
Comportamiento de la llamada a los mtodos
La llamada a los mtodos es ligeramente ms compleja que los otros tipos de bsquedas. Aqu hay algunas cosas a
tener en cuenta:
Si, durante la bsqueda de mtodo, un mtodo provoca una excepcin, la excepcin ser propagada,
silent_variable_failure cuyo valor es True. Si la
silent_variable_failure, la variable ser renderizada como un string
a menos que la excepcin tenga un atributo
excepcin tiene el atributo
vaco, por ejemplo:
>>> t = Template("My name is {{ person.first_name }}.")
>>> class PersonClass3:
...
def first_name(self):
...
raise AssertionError, "foo"
>>> p = PersonClass3()
>>> t.render(Context({"person": p}))
Traceback (most recent call last):
...
AssertionError: foo
>>>
...
>>>
...
...
>>>
>>>
"My
class SilentAssertionError(AssertionError):
silent_variable_failure = True
class PersonClass4:
def first_name(self):
raise SilentAssertionError
p = PersonClass4()
t.render(Context({"person": p}))
name is ."
La llamada a un mtodo funcionar slo si el mtodo no requiere argumentos. En otro caso, el sistema
se mover a la prxima bsqueda de tipo (ndice de lista).
Evidentemente, algunos mtodos tienen efectos secundarios, por lo que sera absurdo, en el mejor de
los casos, y posiblemente un agujero de seguridad, permitir que el sistema de plantillas tenga acceso
a ellos.
BankAccount que tiene un mtodo delete().
{{ account.delete }}.
atributo alters_data de la funcin en el mtodo:
Digamos, por ejemplo, tienes objeto
debera permitir incluir algo como
Para prevenir esto, asigna el
revisin 757 del 28 de julio de 2008
Una plantilla no
32
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
def delete(self):
# Delete the account
delete.alters_data = True
El sistema de plantillas no debera ejecutar cualquier mtodo marcado de este modo. En otras palabras,
si una plantilla incluye
{{ account.delete }}, esta etiqueta no ejecutar el mtodo delete(). Este
fallar silenciosamente.
Cmo se manejan las variables invlidas?
Por omisin, si una variable no existe, el sistema de plantillas renderiza este como un string vaco, fallando silenciosamente, por ejemplo:
>>> from django.template import Template, Context
>>> t = Template('Your name is {{ name }}.')
>>> t.render(Context())
'Your name is .'
>>> t.render(Context({'var': 'hello'}))
'Your name is .'
>>> t.render(Context({'NAME': 'hello'}))
'Your name is .'
>>> t.render(Context({'Name': 'hello'}))
'Your name is .'
El sistema falla silenciosamente en vez de levantar una excepcin porque intenta ser elstico para errores humanos.
En este caso, todas las bsquedas fallan porque los nombres de las variables, o su capitalizacin es incorrecta. En el
mundo real, esto es inaceptable para un sitio web ser inaccesible debido a un error de sintaxis tan pequeo.
Ten en cuenta que es posible cambiar el comportamiento por omisin de Django en este sentido, ajustando la
con guracin de Django. Discutiremos esto ms adelante en el
4.2.5.
`Captulo 10`_.
Jugando con objetos Context
La mayora de la veces, instancias un objeto
Context pasando un diccionario completamente poblado a Context.
Context una vez que este es instanciado, tambin, usando la
Pero puedes agregar y quitar elementos desde un objeto
sintaxis de los diccionarios estndares de Python:
>>> from django.template import Context
>>> c = Context({"foo": "bar"})
>>> c['foo']
'bar'
>>> del c['foo']
>>> c['foo']
''
>>> c['newvariable'] = 'hello'
>>> c['newvariable']
'hello'
4.3.
Etiquetas de plantillas bsicas y ltros
Como hemos mencionamos, el sistema de plantillas se distribuye con etiquetas y ltros incorporados. Las secciones
que siguen proveen un resumen de la mayora de las etiquetas y ltros.
4.3.1.
Etiquetas
if/else
La etiqueta
{ % if %} evala una variable, y si esta es true (esto es, existe, no est vaca, y no es un valor Boolean
{ % if %} y { % endif %}, por ejemplo:
falso), el sistemas mostrar todo entre
{ % if today_is_weekend %}
<p>Welcome to the weekend!</p>
{ % endif %}
revisin 757 del 28 de julio de 2008
4.3. ETIQUETAS DE PLANTILLAS BSICAS Y FILTROS
La etiqueta
{ % else %}
33
es opcional:
{ % if today_is_weekend %}
<p>Welcome to the weekend!</p>
{ % else %}
<p>Get back to work.</p>
{ % endif %}
Las verdades de Python
En Python, la lista vaca ([]), tuplas (()), diccionario ({}), string (''), cero (0), y el objeto
especia
La etiqueta
None
{ % if %}
son
False
acepta
en un contexto booleano. Todo lo dems es
and, or,
not
True.
para testear mltiples variables, o para negarlas. Por ejemplo:
{ % if athlete_list and coach_list %}
Both athletes and coaches are available.
{ % endif %}
{ % if not athlete_list %}
There are no athletes.
{ % endif %}
{ % if athlete_list or coach_list %}
There are some athletes or some coaches.
{ % endif %}
{ % if not athlete_list or coach_list %}
There are no athletes or there are some coaches. (OK, so
writing English translations of Boolean logic sounds
stupid; it's not our fault.)
{ % endif %}
{ % if athlete_list and not coach_list %}
There are some athletes and absolutely no coaches.
{ % endif %}
Las etiquetas
{ % if %}
no permiten las clusulas
and
or
en la misma etiqueta, porque el orden de evaluacin
lgico puede ser ambiguo. Por ejemplo, esto es invlido:
{ % if athlete_list and coach_list or cheerleader_list %}
No se admite el uso de parntesis para controlar el orden de las operaciones. Si encuentras que necesitas parntesis,
considera efectuar la lgica en el cdigo de la vista para simpli car las plantillas. An as, si necesitas combinar
and
or
para hacer lgica avanzada, usa etiquetas
{ % if %}
and
anidadas, por ejemplo:
{ % if athlete_list %}
{ % if coach_list or cheerleader_list %}
We have athletes, and either coaches or cheerleaders!
{ % endif %}
{ % endif %}
Usar varias veces el mismo operador lgico estn bien, pero no puedes combinar diferentes operadores. Por ejemplo,
esto es vlido:
{ % if athlete_list or coach_list or parent_list or teacher_list %}
Ah no hay una etiqueta
{ % elif %}.
Usa etiquetas
{ % if %}
anidadas para conseguir alguna cosa:
{ % if athlete_list %}
<p>Here are the athletes: {{ athlete_list }}.</p>
{ % else %}
<p>No athletes are available.</p>
revisin 757 del 28 de julio de 2008
34
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
{ % if coach_list %}
<p>Here are the coaches: {{ coach_list }}.</p>
{ % endif %}
{ % endif %}
Asegrate de cerrar cada
{ % if %} con un { % endif %}. En otro caso, Django levantar la excepcin TemplateSyntaxError.
for
La etiqueta
{ % for %}
de Python, la sintaxis es
permite iterar sobre cada uno de los elementos de una secuencia. Como en la sentencia
for X in Y,
dnde
es la secuencia sobre la que se hace el bucle y
for
es el nombre de la
variable que se usar para cada uno de los ciclos del bucle. Cada vez que atravesamos el bucle, el sistema de plantillas
renderizar todo entre
{ % for %}
{ % endfor %}.
Por ejemplo, puedes usar lo siguiente para mostrar una lista de atletas tomadas de la variable
athlete_list:
<ul>
{ % for athlete in athlete_list %}
<li>{{ athlete.name }}</li>
{ % endfor %}
</ul>
Agrega
reversed
a la etiqueta para iterar sobre la lista en orden inverso:
{ % for athlete in athlete_list reversed %}
...
{ % endfor %}
Es posible anidar etiquetas
{ % for %}:
{ % for country in countries %}
<h1>{{ country.name }}</h1>
<ul>
{ % for city in country.city_list %}
<li>{{ city }}</li>
{ % endfor %}
</ul>
{ % endfor %}
No se admite la ruptura de un bucle antes de que termine. Si quieres conseguir esto, cambia la variable sobre la
que ests iterando para que incluya slo los valores sobre los cuales quieres iterar. De manera similar, no hay apoyo
para la sentencia continue que se encargue de retornar inmediatamente al inicio del bucle. (Ve a la seccin Filosofa
y limitaciones luego en este captulo para comprender el razonamiento detrs de este decisin de diseo.)
La etiqueta
{ % for %}
asigna la variable
forloop
mgica a la plantilla con el bucle. Esta variable tiene algunos
atributos que toman informacin acerca del progreso del bucle:
forloop.counter
es siempre asignada a un nmero entero representando el nmero de veces que se
ha entrado en el bucle. Esta es indexada a partir de 1, por lo que la primera vez que se ingresa al
forloop.counter ser 1. Aqu un ejemplo:
{ % for item in todo_list %}
<p>{{ forloop.counter }}: {{ item }}</p>
{ % endfor %}
forloop.counter0 es como forloop.counter, excepto que esta es indexada a partir de cero. Contendr el valor 0 la primera vez que se atraviese el bucle.
forloop.revcounter es siempre asignada a un entero que representa el nmero de iteraciones que
faltan para terminar el bucle. La primera vez que se ejecuta el bucle forloop.revcounter ser
bucle,
igual al nmero de elementos que hay en la secuencia. La ltima vez que se atraviese el bucle, a
forloop.revcounter se la asignar el valor 1.
forloop.revcounter0 es como forloop.revcounter, a excepcin de que est indexada a partir
de cero. La primera vez que se atraviesa el bucle, forloop.revcounter0 es asignada al nmero de
elementos que hay en la secuencia menos 1. La ltima vez que se atraviese el bucle, el valor de esta
ser
0.
revisin 757 del 28 de julio de 2008
4.3. ETIQUETAS DE PLANTILLAS BSICAS Y FILTROS
forloop.first
es un valor booleano asignado a
True
35
si es la primera vez que se pasa por el bucle.
Esto es conveniente para ocasiones especiales:
{ % for object in objects %}
{ % if forloop.first %}<li class="first">{ % else %}<li>{ % endif %}
{{ object }}
</li>
{ % endfor %}
forloop.last es un valor booleano asignado a True si es la ltima pasada por el bucle. Un uso comn
es para esto es poner un carcter pipe entre una lista de enlaces:
{ % for link in links %}{{ link }}{ % if not forloop.last %} | { % endif %}{ % endfor %}
El cdigo de la plantilla de arriba puede mostrar algo parecido a esto:
Link1 | Link2 | Link3 | Link4
forloop.parentloop esta es una referencia al objeto padre
de
forloop, en el caso de bucles anidados.
Aqu un ejemplo:
{ % for country in countries %}
<table>
{ % for city in country.city_list %}
<tr>
<td>Country #{{ forloop.parentloop.counter }}</td>
<td>City #{{ forloop.counter }}</td>
<td>{{ city }}</td>
</tr>
{ % endfor %}
</table>
{ % endfor %}
La variable mgica forloop est slo disponible dentro de bucles. Despus de que el analizados sintctico encuentra
{ % endfor %}, forloop desaparece.
Contextos y la variable forloop
Dentro de un bloque
{ % for %},
las variables existentes se mueven fuera de tal manera
de evitar sobreescribir la variable mgica
forloop.parentloop.
riable a la plantilla llamada
forloop.parentloop
forloop.
Django expone ese contexto movido en
Generalmente no necesitas preocuparte por esto, si provees una va-
forloop
(a pesar de que no lo recomendamos), se llamar
mientras est dentro del bloque
{ % for %}.
ifequal/ifnotequal
El sistema de plantillas de Django a propsito no es un lenguaje de programacin completo y por lo tanto no
permite ejecutar sentencias arbitrarias de Python. (Ms sobre esta idea en la seccin Filosofa y limitaciones). Sin
embargo, es bastante comn que una plantilla requiera comparar dos valores y mostrar algo si ellos son iguales --
{ % ifequal %} para este propsito.
{ % ifequal %} compara dos valores y muestra
Django provee la etiqueta
La etiqueta
endifequal %}
si el valor es igual.
Este ejemplo compara las variables
user
currentuser
todo lo que se encuentra entre
{ % ifequal %}
de la plantilla:
{ % ifequal user currentuser %}
<h1>Welcome!</h1>
{ % endifequal %}
Los argumentos pueden ser strings hard-codeados, con simples o dobles comillas, lo siguiente es vlido:
{ % ifequal section 'sitenews' %}
<h1>Site News</h1>
{ % endifequal %}
{ % ifequal section "community" %}
<h1>Community</h1>
{ % endifequal %}
revisin 757 del 28 de julio de 2008
{%
36
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
Como
{ % if %},
la etiqueta
{ % ifequal %}
admite un opcional
{ % else %}:
{ % ifequal section 'sitenews' %}
<h1>Site News</h1>
{ % else %}
<h1>No News Here</h1>
{ % endifequal %}
Slo las variables de la plantilla, string, enteros y nmeros decimales son permitidos como argumentos para
ifequal %}.
{%
{%
{%
{%
{%
Estos son ejemplos vlidos:
ifequal
ifequal
ifequal
ifequal
variable
variable
variable
variable
1 %}
1.23 %}
'foo' %}
"foo" %}
Cualquier otro tipo de variables, tales como diccionarios de Python, listas, o booleanos, no pueden ser comparados
en
{ % ifequal %}.
Estos ejemplos son invlidos:
{ % ifequal variable True %}
{ % ifequal variable [1, 2, 3] %}
{ % ifequal variable {'key': 'value'} %}
Si necesitas comprobar cuando algo es verdadero o falso, usa la etiqueta
{ % if %}
en vez de
{ % ifequal %}.
Comentarios
Al igual que en HTML o en un lenguaje de programacin como Python, el lenguaje de plantillas de Django permite
comentarios. Para designar un comentario, usa
{# #}:
{# This is a comment #}
Este comentario no ser mostrado cuando la plantilla sea renderizada.
Un comentario no puede abarcar mltiples lneas. Esta limitacin mejora la performance del analizador sintctico
de plantillas. En la siguiente plantilla, la salida del renderizado mostrara exactamente lo mismo que la plantilla (esto
es, la etiqueta comentario no ser tomada como comentario):
This is a {# this is not
a comment #}
test.
4.3.2.
Filtros
Como explicamos anteriormente en este captulo, los ltros de plantillas son formas simples de alterar el valor de
una variable antes de mostrarla. Los ltros se parecen a esto:
{{ name|lower }}
Esto muestra el valor de
{{ name }}
Usa un pipe (|) para aplicar el ltro.
despus de aplicarle el ltro
lower,
el cual convierte el texto a minscula.
Los ltros pueden estar en cadena -- eso es, la salida del uno de los ltros puede ser aplicada al prximo. Aqu un
modismo comn para escapar contenido del texto, y entonces convertir los saltos de lneas en etiquetas
<p>:
{{ my_text|escape|linebreaks }}
Algunos ltros toman argumentos. Un ltro con argumento se ve de este modo:
{{ bio|truncatewords:"30" }}
Esto muestra las primeras 30 palabras de la variable
bio. Los argumentos de los ltros estn siempre entre comillas
dobles.
Los siguientes son algunos de los ltros ms importantes; el Apndice F cubre el resto.
addslashes:
Agrega una con contra-barra antes de cualquier contra-barra, comilla simple o comilla
doble. Esto es til si el texto producido est incluido en un string de JavaScript.
revisin 757 del 28 de julio de 2008
4.4. FILOSOFA Y LIMITACIONES
date:
Formatea un objeto
date
37
datetime
de acuerdo al formato tomado como parmetro, por
ejemplo:
{{ pub_date|date:"F j, Y" }}
El formato de los strings est de nido en el Apndice F.
escape:
Escapa ampersands(&), comillas, y corchetes del string tomado. Esto es usado para desin-
fectar datos suministrados por el usuario y asegurar que los datos son vlidos para XML y XHTML.
Espec camente,
escape
Convierte
Convierte
Convierte
Convierte
Convierte
&
<
>
"
'
en
en
en
hace estas conversiones:
&
<
>
(comilla doble) en
"
'
(comilla simple) en
length: Retorna la longitud del valor. Puedes usar este con una lista o con un string, o con cualquier
objeto Python que sepa como determinar su longitud (o sea cualquier objeto que tenga el mtodo
__len__()).
4.4.
Filosofa y Limitaciones
Ahora que tienes una idea del lenguaje de plantillas de Django, debemos sealar algunas de sus limitaciones
intencionales, junto con algunas losofas detrs de la forma en que este funciona.
Ms que cualquier otro componente de la aplicacin web, las opiniones de los programadores sobre el sistema
de plantillas vara extremadamente. El hecho de que Python slo implemente decenas, sino cientos, de lenguajes de
plantillas de cdigo abierto lo dice todo. Cada uno fue creado probablemente porque su desarrollador estima que todos
los existentes son inadecuados. (De hecho, se dice que es un rito para los desarrolladores de Python escribir su propio
lenguaje de plantillas! Si todava no lo has hecho, tenlo en cuenta. Es un ejercicio divertido).
Con eso en la cabeza, debes estar interesado en saber que Django no requiere que uses su lenguaje de plantillas.
Pero Django pretende ser un completo framework que provee todas las piezas necesarias para que el desarrollo web
sea productivo, quizs a veces es ms conveniente usar el sistema de plantillas de Django que otras bibliotecas de
plantillas de Python, pero no es un requerimiento estricto en ningn sentido. Como vers en la prxima seccin Uso
de plantillas en las vistas, es muy fcil usar otro lenguaje de plantillas con Django.
An as, es claro que tenemos una fuerte preferencia por el sistema de plantillas de Django. El sistema de plantillas
tiene races en la forma en que el desarrollo web se realiza en World Online y la experiencia combinada de los creadores
de Django. stas con algunas de esas losofas:
La lgica de negocios debe ser separada de la presentacin lgica. Vemos al sistema de plantillas como
una herramienta que controla la presentacin y la lgica relacionado a esta -- y eso es todo. El sistema
de plantillas no debera admitir funcionalidad que vaya ms all de este concepto bsico.
Por esta razn, es imposible llamar a cdigo Python directamente dentro de las plantillas de Django.
Todo programador est fundamentalmente limitado al alcance de lo que una etiqueta puede hacer.
Es posible escribir etiquetas personalizadas que hagan cosas arbitrarias, pero las etiquetas de Django
intencionalmente no permiten ejecutar cdigo arbitrario de Python.
La sintaxis debe ser independiente de HTML/XML. Aunque el sistemas de plantillas de Django es
usado principalmente para producir HTML, este pretende ser til para formatos no HTML, como
texto plano. Algunos otros lenguajes de plantillas estn basados en XML, poniendo toda la lgica de
plantilla con etiquetas XML o atributos, pero Django evita deliberadamente esta limitacin. Requerir
un XML vlido para escribir plantillas introduce un mundo de errores humanos y mensajes difcil de
entender, y usando un motor de XML para parsear plantillas implica un inaceptable nivel de overhead
en el procesamiento de la plantilla.
Los diseadores se supone que se sienten ms cmodos con el cdigo HTML. El sistema de plantillas
no est diseado para que las plantillas necesariamente sean mostradas de forma agradable en los
editores WYSIWYG
3 tales como Dreamweaver. Eso es tambin una limitacin severa y no permitira
que la sintaxis sea tan clara como lo es. Django espera las plantillas de los autores para estar cmodo
editando HTML directamente.
revisin 757 del 28 de julio de 2008
38
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
Se supone que los diseadores no son programadores Python. El sistema de plantillas de los autores
reconoce que las plantillas de las pginas web son en al mayora de los casos escritos por diseadores,
no por programadores, y por esto no debera asumir ningn conocimiento de Python.
Sin embargo, el sistema tambin pretende acomodar pequeos grupos en los cuales las plantillas sean
creadas por programadores de Python. Esto ofrece otro camino para extender la sintaxis del sistema
escribiendo cdigo Python puro. (Ms de esto en el
`Captulo 10`_).
El objetivo no es inventar un lenguaje de programacin. El objetivo es ofrecer slo la su ciente funcionalidad de programacin, tales como rami cacin e iteracin, que son esenciales para hacer presentaciones relacionadas a decisiones.
Como resultado de esta losofa, el lenguaje de plantillas de Django tiene las siguientes limitaciones:
Una plantilla no puede asignar una variable o cambiar el valor de esta. Esto es posible escribiendo una
etiqueta personalizada para cumplir con esta meta (ve el
`Captulo 10`_), pero la pila de etiquetas
de Django no lo permite.
Una plantilla no puede llamar cdigo Python crudo. No hay forma de ingresar en modo Python o
usar sentencias puras de Python. De nuevo, esto es posible creando plantillas personalizadas, pero la
pila de etiquetas de Django no lo permiten.
4.5.
Uso de plantillas en las vistas
Has aprendido el uso bsico del sistema de plantillas; ahora vamos a usar este conocimiento para crear una vista.
Recordemos la vista
current_datetime
en
mysite.views,
la que comenzamos en el captulo anterior. Se vea como
esto:
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
html = "<html><body>It is now %s.</body></html>" % now
return HttpResponse(html)
Vamos a cambiar esta vista usando el sistema de plantillas de Django. Primero, podemos pensar en algo como esto:
from django.template import Template, Context
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
t = Template("<html><body>It is now {{ current_date }}.</body></html>")
html = t.render(Context({'current_date': now}))
return HttpResponse(html)
Seguro, esto usa el sistema de plantillas, pero no soluciona el problema que planteamos en la introduccin de
este captulo. A saber, la plantilla sigue estando embebida en el cdigo Python. Vamos a solucionar esto poniendo la
plantilla en un archivo separado, que la vista cargar.
Puedes primer considerar guardar la plantilla en algn lugar del disco y usar las funcionalidades de Python
para abrir y leer el contenido de la plantilla. Esto puede verse as, suponiendo que la plantilla est guardada en
/home/djangouser/templates/mytemplate.html:
from django.template import Template, Context
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
# Simple way of using templates from the filesystem.
# This doesn't account for missing files!
revisin 757 del 28 de julio de 2008
4.6. CARGADORES DE PLANTILLAS
39
fp = open('/home/djangouser/templates/mytemplate.html')
t = Template(fp.read())
fp.close()
html = t.render(Context({'current_date': now}))
return HttpResponse(html)
Esta aproximacin, sin embargo, es poco elegante por estas razones:
No maneja el caso en que no encuentre el archivo. Si el archivo
accesible para lectura, la llamada a
open()
mytemplate.html
IOError.
no existe o no es
levantar la excepcin
Involucra la ruta de tu plantilla. Si vas a usar esta tcnica para cada una de las funciones de las vistas,
estars duplicando rutas de plantillas. Sin mencionar que esto implica teclear mucho ms!
Incluye una cantidad aburrida de cdigo repetitivo. Tienes mejores cosas para hacer en vez de escribir
open(), fp.read()
fp.close()
cada vez que cargas una plantilla
Para solucionar estos problemas, usamos cargadores de plantillas y directorios de plantillas, los cuales son descriptos
en las secciones que siguen.
4.6.
Cargadores de plantillas
Django provee una prctica y poderosa API
4 para cargar plantillas del disco, con el objetivo de quitar la redun-
dancia en la carga de la plantilla y en las mismas plantillas.
Para usar la API para cargar plantillas, primero necesitas indicarle al framework dnde estn guardadas tus
plantillas. El lugar para hacer esto es en el archivo de con guracin.
El archivo de con guracin de Django es el lugar para poner con guraciones para tu instancia de Django (aka
tu proyecto de Django). Es un simple mdulo de Python con variables, una por cada con guracin.
Cuando ejecutaste
django-admin.py startproject mysite en el Captulo 2, el script cre un archivo de consettings.py. chale un vistazo al contenido del archivo. Este contiene
guracin por omisin por ti, bien llamado
variables que se parecen a estas (no necesariamente en este orden):
DEBUG = True
TIME_ZONE = 'America/Chicago'
USE_I18N = True
ROOT_URLCONF = 'mysite.urls'
stas se explican por s solas; las con guraciones y sus respectivos valores son simples variables de Python. Como
el archivo de con guracin es slo un mdulo plano de Python, puedes hacer cosas dinmicas como veri car el valor
de una variable antes de con gurar otra. (Esto tambin signi ca que debes evitar errores de sintaxis de Python en los
archivos de con guracin).
Cubriremos el archivo de con guracin en profundidad en el Apndice E, pero por ahora, veamos la variable de
con guracin
TEMPLATE_DIRS.
Esta variable le indica al mecanismo de carga de plantillas dnde buscar las plantillas.
Por omisin, sta es una tupla vaca. Elige un directorio en el que desees guardar tus plantillas y agrega este a
TEMPLATE_DIRS,
as:
TEMPLATE_DIRS = (
'/home/django/mysite/templates',
)
Hay algunas cosas para notar:
Puedes especi car cualquier directorio que quieras, siempre y cuando la cuenta de usuario en el cual
se ejecuta el servidor web tengan acceso al directorio y su contenido. Si no puedes pensar en un
lugar apropiado para poner las plantillas, te recomendamos crear un directorio
del proyecto de Django (esto es, dentro del directorio
mysite
templates
dentro
que creaste en el Captulo 2, si vienes
siguiendo los ejemplos a lo largo del libro).
No olvides la coma al nal del string del directorio de plantillas! Python requiere una coma en las
tuplas de un solo elemento para diferenciarlas de una expresin de parntesis. Esto es comn en los
usuarios nuevos.
Si quieres evitar este error, puedes hacer
TEMPLATE_DIRS
una lista, en vez de una tupla, porque un
solo elemento en una lista no requiere estar seguido de una coma:
revisin 757 del 28 de julio de 2008
40
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
TEMPLATE_DIRS = [
'/home/django/mysite/templates'
]
Una tupla es un poco ms correcta semnticamente que una lista (las tuplas no pueden cambiar
luego de ser creadas, y nada podra cambiar las con guraciones una vez que fueron ledas), nosotros
recomendamos usar tuplas para la variable
TEMPLATE_DIRS.
Si ests en Windows, incluye tu letra de unidad y usa el estilo de Unix para las barras en vez de barras
invertidas, como sigue:
TEMPLATE_DIRS = (
'C:/www/django/templates',
)
Es ms sencillo usar rutas absolutas (esto es, las rutas de directorios comienzan desde la raz del
sistema de archivos). Si quieres sen un poco ms exible e independiente, tambin, puedes tomar el
hecho de que el archivo de con guracin de Django es slo cdigo de Python y construir la variable
TEMPLATE_DIRS dinmicamente,
import os.path
por ejemplo:
TEMPLATE_DIRS = (
os.path.join(os.path.dirname(__file__), 'templates').replace('\\','/'),
)
Este ejemplo usa la variable de Python mgica __file__, la cual es automticamente asignada
al
nombre del archivo del mdulo de Python en el que se encuentra el cdigo.
Con la variable
TEMPLATE_DIRS con gurada, el prximo paso es cambiar el cdigo de vista que usa la funcionalidad
current_datetime,
de carga de plantillas de Django, para no incluir la ruta a la plantilla. Volvamos a nuestra vista
vamos a cambiar esta como sigue:
from django.template.loader import get_template
from django.template import Context
from django.http import HttpResponse
import datetime
def current_datetime(request):
now = datetime.datetime.now()
t = get_template('current_datetime.html')
html = t.render(Context({'current_date': now}))
return HttpResponse(html)
django.template.loader.get_template() en vez de cargar la plantilla desde
get_template() toma el nombre de la plantilla como argumento, se
cuenta de dnde est la plantilla en el sistema de archivos, lo abre, y retorna un objeto Template compilado.
Si get_template() no puede encontrar la plantilla con el nombre pasado, esta levanta una excepcin TemplateDoesNotExist.
En este ejemplo, usamos la funcin
el sistemas de archivos manualmente. La funcin
da
Para ver que cmo se ve eso, ejecutar el servidor de desarrollo de Django otra vez, como en el Captulo 3, ejecutando
python manage.py runserver en el directorio de tu proyecto de Django. Luego, escribe en tu navegador la pgina
que activa la vista current_datetime (o sea, http://127.0.0.1:8000/time/). Asumiendo que tu variable de con guracin DEBUG est asignada a True y todava no has creado la plantilla current_datetime.html, deberas ver una
pgina de error de Django resaltando el error TemplateDoesNotExist.
Esta pgina de error es similar a la que explicamos en el Captulo 3, con una pieza adicional de informacin de
depuracin: una seccin Postmortem del cargador de plantillas. Esta seccin te indica qu plantilla intent cargar
Django acompaado de una razn para cada intento fallido (por ej. File does not exist). Esta informacin es invaluable
cuando hacemos depuracin de errores de carga de plantillas.
Como probablemente puedas distinguir de los mensajes de error de la Figura 4-1, Django intent buscar una plantilla
TEMPLATE_DIRS con el nombre de la plantilla pasada a get_template(). EntonTEMPLATE_DIRS contiene '/home/django/templates', Django buscar '/home/django/templates/current_datet
TEMPLATE_DIRS contiene ms que un directorio, cada uno de estos es examinado hasta que se encuentre la plantilla
combinando el directorio de la variable
ces si tu variable
Si
o hasta que no haya ms directorios.
Continuando, crea el archivo
current_datetime.html
en tu directorio de plantillas usando el siguiente cdigo:
<html><body>It is now {{ current_date }}.</body></html>
Refresca la pgina en tu navegador web, y deberas ver la pgina completamente renderizada.
revisin 757 del 28 de julio de 2008
4.6. CARGADORES DE PLANTILLAS
Figura 4.1: La pgina de error que se muestra cuando una plantilla no se encuentra
revisin 757 del 28 de julio de 2008
41
42
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
4.6.1.
render_to_response()
Debido a que es comn cargar una plantilla, rellenar un
Context,
y retornar un objeto
HttpResponse
con el
resultado de la plantilla renderizada, Django provee un atajo que te deja hacer estas cosas en una lnea de cdigo.
render_to_response(), la cual se encuentra en el mdulo django.shortcuts. La
render_to_response() en vez de cargar las plantillas y crear los objetos Context y
Este atajo es la funcin llamada
mayora de las veces, usars
HttpResponse
manualmente.
Aqu est el ejemplo actual
current_datetime
reescrito utilizando
render_to_response():
from django.shortcuts import render_to_response
import datetime
def current_datetime(request):
now = datetime.datetime.now()
return render_to_response('current_datetime.html', {'current_date': now})
Qu diferencia! Vamos paso a paso a travs de los cambios del cdigo:
get_template, Template, Context, o HttpResponse. En vez
django.shortcuts.render_to_response. import datetime se mantiene.
No tenemos que importar
portamos
En la funcin
current_datetime,
de esto, im-
now, pero la carga de la plantilla, creacin
HttpResponse se encarga la llamada a
render_to_response() retorna un objeto HttpResponse, podemos
seguimos calculando
del contexto, renderizacin de esta, y de la creacin de
render_to_response(). Como
retornar ese valor
simplemente
en la vista.
render_to_response() debe ser el nombre de la plantilla a utilizar. El segundo argumento,
Context para esa plantilla. Si no se le pasa un
render_to_response() utilizar un diccionario vaco.
El primer argumento de
si es pasado, debe ser un diccionario para usar en la creacin de un
segundo argumento,
4.6.2.
El truco locals()
Considera nuestra ltima versin de
current_datetime:
def current_datetime(request):
now = datetime.datetime.now()
return render_to_response('current_datetime.html', {'current_date': now})
Muchas veces, como en este ejemplo, buscars t mismo calcular algunos valores, guardando ellos en variables (por
ej.
now
en el cdigo anterior), y pasando estas a la plantilla. Particularmente los programadores perezosos notarn
que es ligeramente redundante tener esos nombres en variables temporales y tener nombres para las variables de la
plantilla. No slo que esto es redundante, sino que tambin hay que teclear ms.
Entonces si eres uno de esos programadores perezosos y quieres ahorrar cdigo particularmente conciso, puedes
tomar la ventaja de la funcin built-in de Python llamada
locals().
Esta retorna un diccionario mapeando todos los
nombres de variables locales con sus valores. De esta manera, la vista anterior podra reescribirse como sigue:
def current_datetime(request):
current_date = datetime.datetime.now()
return render_to_response('current_datetime.html', locals())
Aqu, en vez de especi car manualmente el diccionario al contexto como antes, pasamos el valor de
locals(),
el cual incluye todas las variables de nidas hasta ese punto en la ejecucin de la funcin. Como una consecuencia,
now a current_date, porque esta es la variable que especi camos en la plantilla.
locals() no ofrece una gran mejora, pero esta tcnica puede salvar un poco de tipeo si tienes plantillas
renombramos el nombre de la variable
En este ejemplo,
con varias variables de nidas -- o si eres perezoso.
Una cosa en la que tiene que tener cuidado cuando usas
locals()
es que esta incluye todas las variables locales,
con lo cual quizs conste de ms variables de las cuales quieres tener acceso en la plantilla. En el ejemplo anterior,
locals()
tambin incluir
request.
Depende de tu aplicacin saber si esto es de importancia.
La ltima cosa a considerar es que
locals()
provoca un poco sobrecarga, porque cuando es llamado, Python crea
el diccionario dinmicamente. Si especi cas el diccionario al contexto manualmente, evitas esta sobrecarga.
revisin 757 del 28 de julio de 2008
4.7. HERENCIA DE PLANTILLAS
4.6.3.
43
Subdirectorios en get_template()
Puede ser un poco inmanejable guardar todas las plantillas en un solo directorio. Quizs quieras guardar las
plantillas en subdirectorios del directorio de tus plantillas, y esto est bien. De hecho, recomendamos hacerlo; algunas
de las caractersticas ms avanzadas de Django (como las vistas genricas del sistema, las cuales veremos en el Captulo
9) esperan esta distribucin de las plantillas como una convencin por omisin.
Guardar las plantillas en subdirectorios de tu directorio de plantilla es fcil. En tus llamadas a
get_template(),
slo incluye el nombre del subdirectorio y una barra antes del nombre de la plantilla, as:
t = get_template('dateapp/current_datetime.html')
Debido a que
render_to_response() es un pequeo envoltorio de get_template(), puedes hacer lo mismo con el
render_to_response().
primer argumento de
No hay lmites para la profundidad del rbol de subdirectorios. Sintete libre de usar tantos como quieras.
Nota
Los usuario de Windows, asegrense de usar barras comunes en vez de barras invertidas.
get_template()
4.6.4.
asume el estilo de designacin de archivos de Unix.
La etiqueta de plantilla
include
Ahora que vimos el mecanismo para cargar plantillas, podemos introducir una plantilla built-in que tiene una
ventaja para esto:
{ % include %}.
Esta etiqueta te permite incluir el contenido de otra plantilla. El argumento para
esta etiqueta debera ser el nombre de la plantilla a incluir, y el nombre de la plantilla puede ser una variable string
hard-coded (entre comillas), entre simples o dobles comillas. En cualquier momento que tengas el mismo cdigo en
varias etiquetas, considera utilizar un
{ % include %}
para eliminar lo duplicado.
Estos dos ejemplos incluyen el contenido de la plantilla
nav.html.
Los ejemplos son equivalentes e ilustran que
cualquier modo de comillas est permitido:
{ % include 'nav.html' %}
{ % include "nav.html" %}
Este ejemplo incluye el contenido de la plantilla
includes/nav.html:
{ % include 'includes/nav.html' %}
Este ejemplo incluye el contenido de la plantilla cuyo nombre se encuentra en la variable
template_name:
{ % include template_name %}
get_template(), el nombre del archivo de la plantilla es determinado agregando el directorio de plantillas
TEMPLATE_DIRS para el nombre de plantilla solicitado.
Como en
tomado de
Las plantillas incluidas son evaluadas con el contexto de la plantilla en la cual est incluida.
Si una plantilla no encuentra el nombre tomado, Django har una de estas dos cosas:
Si
Si
4.7.
DEBUG
DEBUG
es
es
True, vers la excepcin TemplateDoesNotExist sobre la pgina
False, la etiqueta fallar silenciosamente, sin mostrar nada en el
de error de Django.
lugar de la etiqueta.
Herencia de plantillas
Nuestras plantillas de ejemplo hasta el momento han sido fragmentos de HTML, pero en el mundo real, usars el
sistema de plantillas de Django para crear pginas HTML enteras. Esto conduce a un problema comn del desarrollo
web: Cmo reducimos la duplicacin y redundancia de las reas comunes de las pginas, como por ejemplo, los paneles
de navegacin?
Una forma clsica de solucionar este problema es usar includes, insertando dentro de las pginas HTML a incluir
una pgina dentro de otra. Es ms, Django admite esta aproximacin, con la etiqueta
{ % include %}
anteriormente
descripta. Pero la mejor forma de solucionar este problema con Django es usar una estrategia ms elegante llamada
herencia de plantillas.
En esencia, la herencia de plantillas te deja construir una plantilla base esqueleto que contenga todas las partes
comunes de tu sitio y de nir bloques que los hijos puedan sobreescribir.
Veamos un ejemplo de esto creando una plantilla completa para nuestra vista
archivo
current_datetime.html:
revisin 757 del 28 de julio de 2008
current_datetime,
editando el
44
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<title>The current time</title>
</head>
<body>
<h1>My helpful timestamp site</h1>
<p>It is now {{ current_date }}.</p>
<hr>
<p>Thanks for visiting my site.</p>
</body>
</html>
Esto se ve bien, pero Qu sucede cuando queremos crear una plantilla para otra vista --digamos, La vista
hours_ahead
del Captulo 3? Si queremos hacer nuevamente una agradable, vlida, y completa plantilla HTML,
crearamos algo como:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<title>Future time</title>
</head>
<body>
<h1>My helpful timestamp site</h1>
<p>In {{ hour_offset }} hour(s), it will be {{ next_time }}.</p>
<hr>
<p>Thanks for visiting my site.</p>
</body>
</html>
Claramente, estaramos duplicando una cantidad de cdigo HTML. Imagina si tendramos ms sitios tpicos,
incluyendo barra de navegacin, algunas hojas de estilo, quizs algo de JavaScript -- terminaramos poniendo todo
tipo de HTML redundante en cada plantilla.
La solucin a este problema usando includes en el servidor es sacar factor comn de ambas plantillas y guardarlas
en recortes de plantillas separados, que luego son incluidos en cada plantilla. Quizs quieras guardar la parte superior
de la plantilla en un archivo llamado
header.html:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
Y quizs quieras guardar la parte inferior en un archivo llamado
footer.html:
<hr>
<p>Thanks for visiting my site.</p>
</body>
</html>
Con una estrategia basada en includes, la cabecera y la parte de abajo son fciles. Es el medio el que queda
<h1>My helpful timestamp site</h1>-- pero
header.html porque <title> en las dos pginas es diferente. Si incluimos <h1>
incluir <title>, lo cual no permitira personalizar este en cada pgina. Ves a dnde
desordenado. En este ejemplo, ambas pginas contienen un ttulo -ese ttulo no puede encajar dentro de
en la cabecera, tendramos que
queremos llegar?
El sistema de herencia de Django soluciona estos problemas. Lo puedes pensar a esto como la versin contraria a
la del lado del servidor. En vez de de nir los pedazos que son comunes, de nes los pedazos que son diferentes.
El primer paso es de nir una plantilla base -- un esquelete de tu pgina que las plantillas hijas llenaran luego.
Aqu hay una platilla para nuestro ejemplo actual:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
revisin 757 del 28 de julio de 2008
4.7. HERENCIA DE PLANTILLAS
45
<html lang="en">
<head>
<title>{ % block title %}{ % endblock %}</title>
</head>
<body>
<h1>My helpful timestamp site</h1>
{ % block content %}{ % endblock %}
{ % block footer %}
<hr>
<p>Thanks for visiting my site.</p>
{ % endblock %}
</body>
</html>
Esta plantilla, que llamamos
base.html,
de ne un documento esqueleto HTML simple que usaremos para todas
las pginas del sitio. Es trabajo de las plantillas hijas sobreescribir, agregar, dejar vaco el contenido de los bloques.
(Si ests lo siguiendo desde casa, guarda este archivo en tu directorio de plantillas).
Usamos una etiqueta de plantilla aqu que no hemos visto antes: la etiqueta
block %}
{ % block %}.
Todas las etiquetas
{%
le indican al motor de plantillas que una plantilla hijo quizs sobreescriba esa porcin de la plantilla.
Ahora que tenemos una plantilla base, podemos modi car nuestra plantilla existente
current_datetime.html para
usar esto:
{ % extends "base.html" %}
{ % block title %}The current time{ % endblock %}
{ % block content %}
<p>It is now {{ current_date }}.</p>
{ % endblock %}
hours_ahead del Captulo 3. (Si lo ests
hours_ahead para usar el sistema de plantilla). As sera el resultado:
Como estamos en este tema, vamos a crear una plantilla para la vista
siguiendo junto con el cdigo, te dejamos cambiar
{ % extends "base.html" %}
{ % block title %}Future time{ % endblock %}
{ % block content %}
<p>In {{ hour_offset }} hour(s), it will be {{ next_time }}.</p>
{ % endblock %}
No es hermoso? Cada plantilla contiene slo el cdigo que es nico para esa plantilla. No necesita redundancia. Si
necesitas hacer un cambio grande en el diseo del sitio, slo cambia
el efecto inmediatamente.
Veamos cmo trabaja. Cuando cargamos una plantilla
{ % extends %}, nota
caso, base.html.
base.html,
y todas las otras plantillas re ejarn
current_datetime.html, el motor de plantillas ve la etiqueta
que esta plantilla es la hija de otra. El motor inmediatamente carga la plantilla padre --en este
Hasta este punto, el motor de la plantilla nota las tres etiquetas
{ % block %} en base.html y reemplaza estos
{ % block title %} ser usado, as
bloques por el contenido de la plantilla hija. Entonces, el ttulo que de nimos en
como
{ % block content %}.
footer, entonces el sistema de plantillas usa el valor desde
{ % block %} en la plantilla padre es siempre usado como un plan
Nota que desde la plantilla hija no de nimos el bloque
la plantilla padre. El contenido de la etiqueta
alternativo.
La herencia no afecta el funcionamiento del contexto, y puedes usar tantos niveles de herencia como necesites. Una
forma comn de utilizar la herencia es el siguiente enfoque de tres niveles:
1. Crear una plantilla
base.html
que contenga el aspecto principal de tu sitio. Esto es lo que rara
vez cambiar, si es que alguna vez cambia.
base_SECTION.html para cada seccin de tu sitio (por ej. base_photos.html
base_forum.html). Esas plantillas heredan de base.html e incluyen secciones espec cas de
2. Crear una plantilla
y
estilo/diseo.
revisin 757 del 28 de julio de 2008
46
CAPTULO 4. EL SISTEMA DE PLANTILLAS DE DJANGO
3. Crear una plantilla individual para cada tipo de pgina, tales como pginas de formulario o
galera de fotos. Estas plantillas heredan de la plantilla de la seccin apropiada.
Esta aproximacin maximiza la reutilizacin de cdigo y hace fcil el agregado de elementos para compartir reas,
como puede ser un navegador de seccin.
Aqu hay algunos consejos para el trabajo con herencia de plantillas:
Si usas
{ % extends %}
en la plantilla, esta debe ser la primer etiqueta de esa plantilla. En otro caso,
la herencia no funcionar.
Generalmente, cuanto ms etiquetas
{ % block %} tengas en tus plantillas, mejor. Recuerda, las plan-
tillas hijas no tienen que de nir todos los bloques del padre, entonces puedes rellenar un nmero
razonable de bloques por omisin, y luego de nir slo lo que necesiten las plantillas hijas. Es mejor
tener ms conexiones que menos.
Si encuentras cdigo duplicado en un nmero de plantillas, esto probablemente signi que que debes
mover ese cdigo a un
{ % block %}
en la plantilla padre.
{{ block.super
}} har este truco. Esto es til si quieres agregar contenido del bloque padre en vez de sobreescribirlo
Si necesitas obtener el contenido de un bloque desde la plantilla padre, la variable
completamente.
No puedes de nir mltiples etiquetas
{ % block %}
con el mismo nombre en la misma plantilla. Esta
limitacin existe porque una etiqueta bloque trabaja en ambas direcciones. Esto es, una etiqueta
bloque no slo provee un agujero a llenar, sino que tambin de ne el contenido que llenar ese agujero
en el padre. Si hay dos nombres similares de etiquetas
{ % block %}
en una plantilla, el padre de esta
plantilla puede no saber cual de los bloques usar.
El nombre de plantilla pasado a
{ % extends %} es cargado usando el mismo mtodo que get_template().
TEMPLATE_DIRS.
Esto es, el nombre de la plantilla es agregado a la variable
En la mayora de los casos, el argumento para
{ % extends %}
ser un string, pero tambin puede ser
una variable, si no sabes el nombre de la plantilla padre hasta la ejecucin. Esto te permite hacer
cosas divertidas, dinmicas.
4.8.
Qu sigue?
Los sitios web ms modernos son manejados con una base de datos : el contenido de la pgina web est guardado
en una base de datos relacional. Esto permite una clara separacin de los datos y la lgica (de la misma manera que
las vistas y las etiquetas permiten una separacin de la lgica y la vista).
El
`prximo captulo`_ cubre las herramientas que Django brinda para interactuar con la base de datos.
Duplicate explicit target name: prximo captulo.
2 N.
3 N.
4 N.
5 N.
del T.: hard-coded
del T.: WYSIWYG: What you see is what you get (Lo que ves es lo que obtienes)
del T.: API: Application Program Interface (Interfaz de programacin de aplicaciones)
del T.: aka: Also Know As (Tambin conocido como)
revisin 757 del 28 de julio de 2008
Captulo 5
Interactuar con una base de datos: Modelos
En el Captulo 3, recorrimos los conceptos fundamentales de la construccin dinmica de sitios web con Django:
La con guracin de vistas y URLconfs. Como explicamos, una vista es responsable de implementar alguna lgica
arbitraria, y luego retornar una respuesta. En el ejemplo, nuestra lgica arbitraria era calcular la fecha y hora actual.
En las aplicaciones web modernas, la lgica arbitraria a menudo implica interactuar con una base de datos. Detrs de
escena, un sitio web impulsado por una base de datos se conecta a un servidor de base de datos, recupera algunos datos
de esta, y los muestra con un formato agradable en una pgina web. O, del mismo modo, el sitio puede proporcionar
funcionalidad que permita a los visitantes del sitio poblar la base de datos por su propia cuenta.
Muchos sitios web ms complejos proporcionan alguna combinacin de las dos. Amazon.com, por ejemplo, es un
gran ejemplo de un sitio que maneja una base de datos. Cada pgina de un producto es esencialmente una consulta
a la base de datos de productos de Amazon formateada en HTML, y cuando envas una opinin de cliente (customer
review ), esta es insertada en la base de datos de opiniones.
Django es apropiado para crear sitios web que manejen una base de datos, ya que incluye una manera fcil pero
poderosa de realizar consultas a bases de datos utilizando Python. Este captulo explica esta funcionalidad: la capa de
la base de datos de Django.
(Nota: Aunque no es estrictamente necesario conocer teora bsica de bases de datos y SQL para usar la capa de
base de datos de Django, es altamente recomendado. Una introduccin a estos conceptos est ms all del alcance de
este libro, pero contina leyendo si eres nuevo en el tema. Probablemente seas capaz de seguir adelante y captar los
conceptos bsicos en base al contexto).
5.1.
La manera tonta de hacer una consulta a la base de datos en las
vistas
As como en el Captulo 3 detallamos la manera tonta de producir una salida con la vista (codi cando en duro )
el texto directamente dentro de la vista), hay una manera tonta de recuperar datos desde la base de datos en una
vista. Esto es simple: slo usa una biblioteca de Python existente para ejecutar una consulta SQL y haz algo con los
resultados.
En este ejemplo de vista, usamos la biblioteca
MySQLdb (disponible en http://www.djangoproject.com/r/python-mysql/
para conectarnos a una base de datos de MySQL, recuperar algunos registros, y alimentar con ellos una plantilla para
mostrar una pgina web:
from django.shortcuts import render_to_response
import MySQLdb
def book_list(request):
db = MySQLdb.connect(user='me', db='mydb', passwd='secret', host='localhost')
cursor = db.cursor()
cursor.execute('SELECT name FROM books ORDER BY name')
names = [row[0] for row in cursor.fetchall()]
db.close()
return render_to_response('book_list.html', {'names': names})
Este enfoque funciona, pero deberan hacerse evidentes inmediatamente algunos problemas:
revisin 757 del 28 de julio de 2008
48
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
Estamos codi cando en duro (hard-coding ) los parmetros de la conexin a la base de datos. Lo ideal
sera que esos parmetros se guardarsen en la con guracin de Django.
Tenemos que escribir una cantidad de cdigo estereotpico: crear una conexin, un cursor, ejecutar una
sentencia, y cerrar la conexin. Lo ideal sera que todo lo que tuviramos que hacer fuera especi car
los resultados que queremos.
Nos ata a MySQL. Si, en el camino, cambiamos de MySQL a PostgreSQL, tenemos que usar un
adaptador de base de datos diferente (por ej.
psycopg
en vez de
MySQLdb),
alterar los parmetros de
conexin y -- dependiendo de la naturaleza de las sentencia de SQL -- posiblemente reescribir el SQL.
La idea es que el servidor de base de datos que usemos est abstrado, entonces el pasarnos a otro
servidor podra signi car realizar un cambio en un nico lugar.
Como esperabas, la capa de la base de datos de Django apunta a resolver estos problemas. Este es un adelanto de
cmo la vista anterior puede ser reescrita usando la API de Django:
from django.shortcuts import render_to_response
from mysite.books.models import Book
def book_list(request):
books = Book.objects.order_by('name')
return render_to_response('book_list.html', {'books': books})
Explicaremos este cdigo enseguida en este captulo. Por ahora, tengamos slo una idea de cmo es.
5.2.
El patrn de diseo MTV
Antes de profundizar en ms cdigo, tommonos un momento para considerar el diseo global de una aplicacin
Web Django impulsada por bases de datos.
Como mencionamos en los captulos anteriores, Django fue diseado para promover el acoplamiento dbil y la
estricta separacin entre las piezas de una aplicacin. Si sigues esta losofa, es fcil hacer cambios en un lugar
particular de la aplicacin sin afectar otras piezas. En las funciones de vista, por ejemplo, discutimos la importancia
de separar la lgica de negocios de la lgica de presentacin usando un sistema de plantillas. Con la capa de la base
de datos, aplicamos esa misma losofa para el acceso lgico a los datos.
Estas tres piezas juntas -- la lgica de acceso a la base de datos, la lgica de negocios, y la lgica de presentacin
-- comprenden un concepto que a veces es llamado el patrn de arquitectura de software Modelo-Vista-Controlador
(MVC). En este patrn, el Modelo hace referencia al acceso a la capa de datos, la Vista se re ere a la parte del
sistema que selecciona qu mostrar y cmo mostrarlo, y el Controlador implica la parte del sistema que decide qu
vista usar, dependiendo de la entrada del usuario, accediendo al modelo si es necesario.
Por qu el acrnimo?
El objetivo de de nir en forma explcita patrones como MVC es principalmente simpli car la
comunicacin entre los desarrolladores. En lugar de tener que decir a tus compaeros de trabajo,
Vamos a hacer una abstraccin del acceso a la base de datos, luego vamos a tener una capa que
se encarga de mostrar los datos, y vamos a poner una capa en el medio para que regule esto,
puedes sacar provecho de un vocabulario compartido y decir, Vamos a usar un patrn MVC aqu.
Django sigue el patrn MVC tan al pie de la letra que puede ser llamado un framework MVC. Someramente, la M,
V y C se separan en Django de la siguiente manera:
M, la porcin de acceso a la base de datos, es manejada por la capa de la base de datos de Django, la
cual describiremos en este captulo.
V, la porcin que selecciona qu datos mostrar y cmo mostrarlos, es manejada por la vista y las
plantillas.
C, la porcin que delega a la vista dependiendo de la entrada del usuario, es manejada por el framework
mismo siguiendo tu URLconf y llamando a la funcin apropiada de Python para la URL obtenida.
Debido a que la C es manejada por el mismo framework y la parte ms emocionante se produce en los modelos,
las plantillas y las vistas, Django es conocido como un Framework MTV. En el patrn de diseo MTV,
revisin 757 del 28 de julio de 2008
5.3. CONFIGURACIN DE LA BASE DE DATOS
49
M signi ca Model (Modelo), la capa de acceso a la base de datos. Esta capa contiene toda la
informacin sobre los datos: cmo acceder a estos, cmo validarlos, cul es el comportamiento que
tiene, y las relaciones entre los datos.
T signi ca Template (Plantilla), la capa de presentacin. Esta capa contiene las decisiones relacionadas a la presentacin: como algunas cosas son mostradas sobre una pgina web o otro tipo de
documento.
V signi ca View (Vista), la capa de la lgica de negocios. Esta capa contiene la lgica que accede al
modelo y la delega a la plantilla apropiada: puedes pensar en esto como un puente entre el modelos
y las plantillas.
Si ests familiarizado con otros frameworks de desarrollo web MVC, como Ruby on Rails, quizs consideres que
las vistas de Django pueden ser el controlador y las plantillas de Django pueden ser la vista. Esto es una confusin
desafortunada a raz de las diferentes interpretaciones de MVC. En la interpretacin de Django de MVC, la vista
describe los datos que son presentados al usuario; no necesariamente el cmo se mostrarn, pero si cules datos son
presentados. En contraste, Ruby on Rails y frameworks similares sugieren que el trabajo del controlador incluya la
decisin de cuales datos son presentados al usuario, mientras que la vista sea estrictamente el cmo sern presentados
y no cules.
Ninguna de las interpretaciones es ms correcta que otras. Lo importante es entender los conceptos subyacentes.
5.3.
Con guracin de la base de datos
Con toda esta losofa en mente, vamos a comenzar a explorar la capa de la base de datos de Django. Primero,
necesitamos tener en cuenta algunas con guraciones iniciales: necesitamos indicarle a Django qu servidor de base de
datos usar y cmo conectarse con el mismo.
Asumimos que haz con gurado un servidor de base de datos, lo has activado, y has creado una base de datos en
este (por ej. usando la sentencia
CREATE DATABASE).
SQLite es un caso especial; es este caso, no hay que crear una
base de datos, porque SQLite usa un archivo autnomo sobre el sistema de archivos para guardar los datos.
Como con
TEMPLATE_DIRS en los captulos anteriores, la con guracin de la base de datos se encuentra en el archivo
settings.py. Edita este archivo y busca las opciones de la base de
de con guracin de Django, llamado, por omisin,
datos:
DATABASE_ENGINE = ''
DATABASE_NAME = ''
DATABASE_USER = ''
DATABASE_PASSWORD = ''
DATABASE_HOST = ''
DATABASE_PORT = ''
Aqu hay un resumen de cada propiedad.
DATABASE_ENGINE le indica a Django qu base de datos utilizar. Si usas una base de datos con Django,
DATABASE_ENGINE debe con gurarse con un string de los mostrados en la Tabla 5-1.
Cuadro 5.1: Con guracin de motores de base de datos
Con guracin
Base de datos
postgresql
PostgreSQL
postgresql_psycopg2
PostgreSQL
mysql
MySQL
sqlite3
SQLite
Adaptador requerido
psycopg version 1.x, http://www.djangoproject.com/
r/python-pgsql/1/.
psycopg versin 2.x, http://www.djangoproject.com/
r/python-pgsql/.
MySQLdb,
http://www.djangoproject.com/r/
python-mysql/.
No necesita adaptador si se usa Python 2.5+. En caso
pysqlite, http://www.djangoproject.com/
r/python-sqlite/.
adodbapi version 2.0.1+, http://www.djangoproject.
com/r/python-ado/.
cx_Oracle,
http://www.djangoproject.com/r/
python-oracle/
.
28 de julio de 2008
contrario,
ado_mssql
Microsoft SQL Server
oracle
Oracle
revisin 757 del
50
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
Nota que cualquiera sea la base de datos que uses, necesitars descargar e instalar el adaptador
apropiado. Cada uno de estos est disponible libremente en la web; slo sigue el enlace en la columna
Adaptador requerido en la Tabla 5-1.
DATABASE_NAME
la indica a Django el nombre de tu base de datos. Si ests usando SQLite, es-
peci ca la ruta completo del sistema de archivos hacia el archivo de la base de datos (por ej.
'/home/django/mydata.db').
DATABASE_USER
le indica a Django cual es el nombre de usuario a usar cuando se conecte con tu base
de datos. Si ests usando SQLite, deja este en blanco.
DATABASE_PASSWORD le
indica a Django cual es la contrasea a utilizar cuando se conecte con tu base
de datos. Si ests utilizando SQLite o tienes una contrasea vaca, deja este en blanco.
DATABASE_HOST
le indica a Django cual es el host a usar cuando se conecta a tu base de datos. Si tu
base de datos est sobre la misma computadora que la instalacin de Django (o sea localhost), deja
este en blanco. Si ests usando SQLite, deja este en blanco.
MySQL es un caso especial aqu. Si este valor comienza con una barra ('/') y ests usando MySQL,
MySQL se conectar al socket especi cado por medio de un socket Unix, por ejemplo:
DATABASE_HOST = '/var/run/mysql'
Si ests utilizando MySQL y este valor no comienza con una barra, entonces este valor es asumido
como el host.
DATABASE_PORT
le indica a Django qu puerto usar cuando se conecte a la base de datos. Si ests
utilizando SQLite, deja este en blanco. En otro caso, si dejas este en blanco, el adaptador de base de
datos subyacente usar el puerto por omisin acorde al servidor de base de datos. En la mayora de
los casos, el puerto por omisin est bien, por lo tanto puedes dejar este en blanco.
Una vez que hayas ingresado estas con guraciones, comprubalas. Primero, desde el directorio del proyecto que
creaste en el Captulo 2, ejecuta el comando
python manage.py shell.
Notars que comienza un intrprete interactivo de Python. Las apariencias pueden engaar. Hay una diferencia
python manage.py shell dentro del directorio del proyecto de Django y el ms
python. El ltimo es el Python shell bsico, pero el anterior le indica a Django cuales archivos de con guracin
importante entre ejecutar el comando
genrico
usar antes de comenzar el shell. Este es un requerimiento clave para hacer consultas a la base de datos: Django necesita
saber cuales son los archivos de con guraciones a usar para obtener la informacin de la conexin a la base de datos.
python manage.py shell simplemente asume que tu archivo de con guracin est en el mismo
manage.py. Hay otras maneras de indicarle a Django qu mdulo de con guracin usar, pero este subtcubriremos luego. Por ahora, usa python manage.py shell cuando necesites hacer modi caciones espec cas
Detrs de escena,
directorio que
tulo lo
a Django.
Una vez que hayas entrado al shell, escribe estos comando para probar la con guracin de tu base de datos:
>>> from django.db import connection
>>> cursor = connection.cursor()
Si no sucede nada, entonces tu base de datos est con gurada correctamente. De lo contrario revisa el mensaje de
error para obtener un indicio sobre qu es lo que est mal. La Tabla 5-2 muestra algunos mensajes de error comunes.
Cuadro 5.2: Mensajes de error de con guracin de la base de datos
Mensaje de error
Solucin
You haven't set the DATABASE_ENGINE setting yet.
Con gura la variable
DATABASE_ENGINE
con otra cosa
que un string vaco.
Environment
variable
DJAN-
GO_SETTINGS_MODULE is unde ned.
Error
loading
_____
module:
No
module
_____.
Ejecuta el comando
de
named
python.
python manage.py shell
en vez
No tienes instalado el mdulo apropiado para la base
psycopg o MySQLdb).
DATABASE_ENGINE con un mo-
de datos especi cada (por ej.
_____ isn't an available database backend.
Con gura la variable
tor vlido descrito previamente. Habrs cometido un
error de tipeo?
database _____ does not exist
Cambia la variable
DATABASE_NAME
para que apunte
a una base de datos existente, o ejecuta la sentencia
CREATE DATABASE
revisin 757 del 28 de julio de 2008
apropiada para crearla.
5.4. TU PRIMERA APLICACIN
51
Cuadro 5.2: Mensajes de error de con guracin de la base de datos
Mensaje de error
Solucin
role _____ does not exist
Cambia la variable
DATABASE_USER
para que apunte a
un usuario que exista, o crea el usuario en tu base de
datos.
could not connect to server
Asegrate de que
DATABASE_HOST y DATABASE_PORT es-
tn con gurados correctamente y que el servidor est
corriendo.
5.4.
Tu primera aplicacin
Ahora que veri camos que la conexin est funcionando, es hora de crear una Aplicacin de Django -- una coleccin
de archivos de cdigo fuente, incluyendo modelos y vistas, que conviven en un solo paquete de Python y representen
una aplicacin completa de Django.
Vale la pena explicar la terminologa aqu, porque esto es algo que suele hacer tropezar a los principiantes. Ya
hemos creado un proyecto, en el Captulo 2, entonces, cul es la diferencia entre un proyecto y una aplicacin ? La
diferencia es la que existe entre la con guracin y el cdigo:
Un proyecto es una instancia de un cierto conjunto de aplicaciones de Django, ms las con guraciones
de esas aplicaciones.
Tcnicamente, el nico requerimiento de un proyecto es que este suministre un archivo de con guracin, el cual de ne la informacin hacia la conexin a la base de datos, la lista de las aplicaciones
instaladas, la variable
TEMPLATE_DIRS,
y as sucesivamente.
Una aplicacin es un conjunto portable de una funcionalidad de Django, tpicamente incluye modelos
y vistas, que conviven en un solo paquete de Python.
Por ejemplo, Django incluye un nmero de aplicaciones, tales como un sistema de comentarios y una
interfaz de administracin automtica. Una cosa clave para notar sobre estas aplicaciones es que son
portables y reusables en mltiples proyectos.
Hay pocas reglas estrictas sobre cmo encajar el cdigo Django en este esquema; es exible. Si ests construyendo
un sitio web simple, quizs uses una sola aplicacin. Si ests construyendo un sitio web complejo con varias piezas que
no se relacionan entre s, tales como un sistema de comercio electrnico o un foro, probablemente quieras dividir esto
en aplicaciones para que te sea posible reusar estas individualmente en un futuro.
Es ms, no necesariamente debes crear aplicaciones en absoluto, como lo hace evidente la funcin de la vista del
ejemplo que creamos antes en este libro. En estos casos, simplemente creamos un archivo llamado
views.py, llenamos
este con una funcin de vista, y apuntamos nuestra URLconf a esa funcin. No se necesitan aplicaciones.
No obstante, existe un requisito respecto a la convencin de la aplicacin: si ests usando la capa de base de datos
de Django (modelos), debes crear una aplicacin de Django. Los modelos deben vivir dentro de aplicaciones.
Dentro del directorio del proyecto
mysite que creaste en el Captulo 2, escribe este comando para crear una nueva
aplicacin llamada books:
python manage.py startapp books
Este comando no produce ninguna salida, pero crea un directorio
books dentro del directorio mysite. Echemos un
vistazo al contenido:
books/
__init__.py
models.py
views.py
Esos archivos contendrn los modelos y las vistas para esta aplicacin.
models.py y views.py en tu editor de texto favorito. Ambos archivos estn vacos, excepto
models.py. Este es el espacio disponible para ser creativo con tu aplicacin de Django.
Echa un vistazo a
la importacin en
revisin 757 del 28 de julio de 2008
por
52
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
5.5.
De nir modelos en Python
Como discutimos en los captulos anteriores, la M de MTV hace referencia al Modelo. Un modelo de Django
es una descripcin de los datos en la base de datos, representada como cdigo de Python. Esta es tu capa de datos -- lo
equivalente de tu sentencia SQL
CREATE TABLE -- excepto que estn en Python en vez de SQL, e incluye ms que slo
de nicin de columnas de la base de datos. Django usa un modelo para ejecutar cdigo SQL detrs de las escenas y
retornar estructuras de datos convenientes en Python representando las las de tus tablas de la base de datos. Django
tambin usa modelos para representar conceptos de alto nivel que no necesariamente pueden ser manejados por SQL.
Si ests familiarizado con base de datos, inmediatamente podra pensar, No es redundante de nir modelos de
datos en Python y en SQL? Django trabaja de este modo por varias razones:
La introspeccin requiere
*overhead* y es imperfecta. Con el objetivo de proveer una API conveniente
de acceso a los datos, Django necesita conocer de alguna forma la capa de la base de datos, y hay
dos formas de lograr esto. La primera sera describir explcitamente los datos en Python, y la segunda
sera la introspeccin de la base de datos en tiempo de ejecucin para determinar el modelo de la base
de datos.
La segunda forma parece clara, porque los metadatos sobre tus tablas vive en un nico lugar, pero
introduce algunos problemas. Primero, introspeccionar una base de datos en tiempo de ejecucin
obviamente requiere overhead. Si el framework tuviera que introspeccionar la base de datos cada vez
que se procese una peticin, o incluso cuando el servidor web sea inicializado, esto podra provocar
un nivel de overhead inaceptable. (Mientras algunos creen que el nivel de overhead es aceptable,
los desarrolladores de Django apuntan a quitar del framework tanto overhead como sea posible, y
esta aproximacin hace que Django sea ms rpido que los frameworks competidores de alto nivel en
mediciones de desempeo). Segundo, algunas bases de datos, notablemente viejas versiones de MySQL,
no guardan su ciente metadatos para asegurarse una completa introspeccin.
Escribir Python es divertido, y dejar todo en Python limita el nmero de veces que tu cerebro tiene
que realizar un cambio de contexto. Si te mantienes en un solo entorno/mentalidad de programacin
tanto tiempo como sea posible, ayuda para la productividad. Teniendo que escribir SQL, luego Python,
y luego SQL otra vez es perjudicial.
Tener modelos de datos guardados como cdigo en vez de en tu base de datos hace fcil dejar tus
modelos bajo un control de versiones. De esta forma, puedes fcilmente dejar rastro de los cambios a
tu capa de modelos.
SQL permite slo un cierto nivel de metadatos acerca de un
*layout* de datos. La mayora de sistemas
de base de datos, por ejemplo, no provee un tipo de datos especializado para representar una direccin
web o de email. Los modelos de Django s. La ventaja de un tipo de datos de alto nivel es la alta
productividad y la reusabilidad de cdigo.
SQL es inconsistente a travs de distintas plataformas. Si ests redistribuyendo una aplicacin web,
por ejemplo, es mucho ms pragmtico distribuir un mdulo de Python que describa tu capa de datos
que separar conjuntos de sentencias
CREATE TABLE
para MySQL, PostgreSQL y SQLite.
Una contra de esta aproximacin, sin embargo, es que es posible que el cdigo Python quede fuera de sincrona
respecto a lo que hay actualmente en la base. Si haces cambios en un modelo Django, necesitars hacer los mismos
cambios dentro de tu base de datos para mantenerla consistente con el modelo. Detallaremos algunas estrategias para
manejar este problema ms adelante en este captulo.
Finalmente, Django incluye una utilidad que puede generar modelos haciendo introspeccin sobre una base de datos
existente. Esto es til para comenzar a trabajar rpidamente sobre datos heredados.
5.6.
Tu primer modelo
Como ejemplo continuo en este captulo y el siguiente, nos enfocaremos en una con guracin de datos bsica sobre
libro/autor/editor. Usamos esto como ejemplo porque las relaciones conceptuales entre libros, autores y editores son
bien conocidas, y es una con guracin de datos comnmente utilizada en libros de texto introductorios de SQL. Por
otra parte, ests leyendo un libro que fue escrito por autores y producido por un editor!
Supondremos los siguientes conceptos, campos y relaciones:
Un autor tiene un ttulo (ej.: Sr. o Sra.), nombre, apellido, direccin de correo electrnico y una foto
tipo carnet.
Un editor tiene un nombre, una direccin, una ciudad, un estado o provincia, un pas y un sitio Web.
revisin 757 del 28 de julio de 2008
5.6. TU PRIMER MODELO
53
Un libro tiene un ttulo y una fecha de publicacin. Tambin tiene uno o ms autores (una relacin
muchos-a-muchos con autores) y un nico editor (una relacin uno a muchos -- tambin conocida
como clave fornea -- con editores).
El primer paso para utilizar esta con guracin de base de datos con Django es expresarla como cdigo Python. En
el archivo
models.py
que se cre con el comando
startapp,
ingresa lo siguiente:
from django.db import models
class Publisher(models.Model):
name = models.CharField(maxlength=30)
address = models.CharField(maxlength=50)
city = models.CharField(maxlength=60)
state_province = models.CharField(maxlength=30)
country = models.CharField(maxlength=50)
website = models.URLField()
class Author(models.Model):
salutation = models.CharField(maxlength=10)
first_name = models.CharField(maxlength=30)
last_name = models.CharField(maxlength=40)
email = models.EmailField()
headshot = models.ImageField(upload_to='/tmp')
class Book(models.Model):
title = models.CharField(maxlength=100)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
Examinemos rpidamente este cdigo para conocer lo bsico. La primer cosa a notar es que cada modelo es
representado por una clase Python que es una subclase de
django.db.models.Model.
La clase antecesora,
Model,
contiene toda la maquinaria necesaria para hacer que estos objetos sean capaces de interactuar con la base de datos -y que hace que nuestros modelos slo sean responsables de de nir sus campos, en una sintaxis compacta y agradable.
Lo creas o no, ste es todo el cdigo que necesitamos para tener acceso bsico a los datos con Django.
Cada modelo generalmente corresponde a una tabla nica de la base de datos, y cada atributo de un modelo
generalmente corresponde a una columna en esa tabla. El nombre de atributo corresponde al nombre de columna, y
el tipo de campo (ej.:
modelo
Publisher
CharField)
corresponde al tipo de columna de la base de datos (ej.:
varchar). Por ejemplo,
CREATE TABLE):
el
es equivalente a la siguiente tabla (asumiendo la sintaxis de PostgreSQL para
CREATE TABLE "books_publisher" (
"id" serial NOT NULL PRIMARY KEY,
"name" varchar(30) NOT NULL,
"address" varchar(50) NOT NULL,
"city" varchar(60) NOT NULL,
"state_province" varchar(30) NOT NULL,
"country" varchar(50) NOT NULL,
"website" varchar(200) NOT NULL
);
En efecto, Django puede generar esta sentencia
CREATE TABLE
automticamente como veremos en un momento.
La excepcin a la regla una-clase-por-tabla es el caso de las relaciones muchos-a-muchos. En nuestros modelos de
ejemplo,
Book
tiene un
ManyToManyField llamado authors. Esto signi ca que un libro tiene uno o ms autores, pero
Book no tiene una columna authors. En su lugar, Django crea una tabla adicional -- una
la tabla de la base de datos
tabla de join muchos-a-muchos -- que maneja la correlacin entre libros y autores.
Para una lista completa de tipos de campo y opciones de sintaxis de modelos, ver el Apndice B.
Finalmente, debes notar que no hemos de nido explcitamente una clave primaria en ninguno de estos modelos. A
no ser que le indiques lo contrario, Django dar automticamente a cada modelo un campo de clave primaria entera
llamado
id.
Es un requerimiento el que cada modelo Django tenga una clave primaria de columna simple.
revisin 757 del 28 de julio de 2008
54
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
5.7.
Instalando el modelo
Ya escribimos el cdigo; creemos ahora las tablas en la base de datos. Para hacerlo, el primer paso es activar estos
books
a la lista de aplicaciones instaladas
otra vez, y examina la variable de con guracin
INSTALLED_APPS. INSTALLED_APPS
modelos en nuestro proyecto Django. Hacemos esto agregando la aplicacin
en el archivo de con guracin.
Edita el archivo
settings.py
le indica a Django qu aplicaciones estn activadas para un proyecto determinado. Por omisin, se ve como esto:
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
)
Temporalmente, comenta estos cuatro strings poniendo un carcter (#) al principio. (Estn incluidos por omisin
porque es frecuente usarlas, pero las activaremos y las discutiremos ms adelante) Cuando termines, modi ca las
con guraciones por omisin de
MIDDLEWARE_CLASSES
TEMPLATE_CONTEXT_PROCESSORS. stas dependen
'mysite.books' a la lista INSTALLED_APPS,
de las aplicaciones que hemos comentado. Entonces, agrega
de algunas
de manera
que la con guracin termine vindose as:
MIDDLEWARE_CLASSES = (
#
'django.middleware.common.CommonMiddleware',
#
'django.contrib.sessions.middleware.SessionMiddleware',
#
'django.contrib.auth.middleware.AuthenticationMiddleware',
#
'django.middleware.doc.XViewMiddleware',
)
TEMPLATE_CONTEXT_PROCESSORS = ()
#...
INSTALLED_APPS = (
#'django.contrib.auth',
#'django.contrib.contenttypes',
#'django.contrib.sessions',
#'django.contrib.sites',
'mysite.books',
)
(Como aqu estamos tratando con una tupla de un solo elemento, no olvides la coma nal. De paso, los autores de
este libro pre eren poner una coma despus de cada elemento de una tupla, aunque la tupla tenga slo un elemento.
Esto evita el problema de olvidar comas, y no hay penalizacin por el use de esa coma extra)
'mysite.books' se re ere a la aplicacin books en la que estamos trabajando. Cada aplicacin en INSTALLED_APPS
es representada por su ruta Python completa -- esto es, la ruta de paquetes, separados por puntos, que lleva al paquete
de la aplicacin.
Ahora que la aplicacin Django ha sido activada en el archivo de con guracin, podemos crear las tablas en nuestra
base de datos. Primero, validemos los modelos ejecutando este comando:
python manage.py validate
validate veri ca si la sintaxis y la lgica de tus modelos son correctas. Si todo est bien, vers el
0 errors found. Si no, asegrate de haber escrito el cdigo del modelo correctamente. La salida del error
El comando
mensaje
debe brindarte informacin til acerca de qu es lo que est mal en el cdigo.
Cada vez que piensas que tienes problemas con tus modelos, ejecuta
python manage.py validate.
capturar todos los problemas comunes del modelo.
Si tus modelos son vlidos, ejecuta el siguiente comando para que Django genere sentencias
tus modelos en la aplicacin
books
Tiende a
CREATE TABLE
para
(con sintaxis resaltada en colores disponible si ests usando Unix):
python manage.py sqlall books
En este comando, books es el nombre de la aplicacin. Es lo que hayas especi cado
manage.py startapp. Cuando ejecutes el comando, debes ver algo como esto:
revisin 757 del 28 de julio de 2008
cuando ejecutaste el comando
5.7. INSTALANDO EL MODELO
55
BEGIN;
CREATE TABLE "books_publisher" (
"id" serial NOT NULL PRIMARY KEY,
"name" varchar(30) NOT NULL,
"address" varchar(50) NOT NULL,
"city" varchar(60) NOT NULL,
"state_province" varchar(30) NOT NULL,
"country" varchar(50) NOT NULL,
"website" varchar(200) NOT NULL
);
CREATE TABLE "books_book" (
"id" serial NOT NULL PRIMARY KEY,
"title" varchar(100) NOT NULL,
"publisher_id" integer NOT NULL REFERENCES "books_publisher" ("id"),
"publication_date" date NOT NULL
);
CREATE TABLE "books_author" (
"id" serial NOT NULL PRIMARY KEY,
"salutation" varchar(10) NOT NULL,
"first_name" varchar(30) NOT NULL,
"last_name" varchar(40) NOT NULL,
"email" varchar(75) NOT NULL,
"headshot" varchar(100) NOT NULL
);
CREATE TABLE "books_book_authors" (
"id" serial NOT NULL PRIMARY KEY,
"book_id" integer NOT NULL REFERENCES "books_book" ("id"),
"author_id" integer NOT NULL REFERENCES "books_author" ("id"),
UNIQUE ("book_id", "author_id")
);
CREATE INDEX books_book_publisher_id ON "books_book" ("publisher_id");
COMMIT;
Observa lo siguiente:
Los nombres de tabla se generan automticamente combinando el nombre de la aplicacin (books) y
el nombre en minsculas del modelo (publisher,
book, y author). Puedes sobreescribir este compor-
tamiento, como se detalla en el Apndice B.
Como mencionamos antes, Django agrega una clave primaria para cada tabla automticamente -- los
campos
id.
Tambin puedes sobreescribir esto.
Por convencin, Django agrega
"_id"
al nombre de campo de las claves forneas. Como ya puedes
imaginar, tambin puedes sobreescribir esto.
La relacin de clave fornea se hace explcita con una sentencia
Estas sentencias
CREATE TABLE
REFERENCES
son adaptadas a medida de la base de datos que ests usando, de
manera que Django maneja automticamente los tipos de campo espec cos de cada base de datos,
como
auto_increment
(MySQL),
serial
(PostgreSQL), o
integer primary key
(SQLite), por ti.
Lo mismo sucede con el uso de las comillas simples o dobles en los nombres de columna. La salida del
ejemplo est en la sintaxis de PostgreSQL.
El comando
sqlall
no crea ni toca de ninguna forma tu base de datos -- slo imprime una salida en la pantalla
para que puedas ver qu SQL ejecutara Django si le pidieras que lo hiciera. Si quieres, puedes copiar y pegar este
fragmento de SQL en tu cliente de base de datos, o usa los pipes de Unix para pasarlo directamente. De todas formas,
Django provee una manera ms fcil de con rmar el envo del SQL a la base de datos. Ejecuta el comando
esta manera:
python manage.py syncdb
Vers algo como esto:
revisin 757 del 28 de julio de 2008
syncdb
de
56
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
Creating table books_publisher
Creating table books_book
Creating table books_author
Installing index for books.Book model
El comando
syncdb
es una simple sincronizacin de tus modelos hacia tu base de datos. El mismo examina todos
INSTALLED_APPS, veri ca la base de datos
syncdb no sincroniza los cambios o
eliminaciones de los modelos; si haces un cambio o modi cas un modelo, y quieres actualizar la base de datos, syncdb
los modelos en cada aplicacin que gure en tu variable de con guracin
para ver si las tablas apropiadas ya existen, y las crea si no existen. Observa que
no maneja esto. (Ms sobre esto despus.)
python manage.py syncdb de nuevo, nada sucede, porque no has agregado ningn modelo a la aplibooks ni has incorporado ninguna aplicacin en INSTALLED_APPS. Ergo, siempre es seguro ejecutar python
manage.py syncdb -- no har desaparecer cosas.
Si ejecutas
cacin
Si ests interesado, toma un momento para bucear en el cliente de lnea de comandos de tu servidor de bases de
psql para
python manage.py dbshell, que deducir qu cliente de linea de comando
DATABASE_SERVER. Esto ltimo es casi siempre ms conveniente.
datos y ver las tablas que cre Django. Puedes ejecutar manualmente el cliente de lnea de comandos (ej.:
PostgreSQL) o puedes ejecutar el comando
ejecutar, dependiendo de tu con guracin
5.8.
Acceso bsico a datos
Una vez que has creado un modelo, Django provee automticamente una API Python de alto nivel para trabajar
con estos modelos. Prueba ejecutando
python manage.py shell
y escribiendo lo siguiente:
>>> from books.models import Publisher
>>> p1 = Publisher(name='Addison-Wesley', address='75 Arlington Street',
...
city='Boston', state_province='MA', country='U.S.A.',
...
website='http://www.apress.com/')
>>> p1.save()
>>> p2 = Publisher(name="O'Reilly", address='10 Fawcett St.',
...
city='Cambridge', state_province='MA', country='U.S.A.',
...
website='http://www.oreilly.com/')
>>> p2.save()
>>> publisher_list = Publisher.objects.all()
>>> publisher_list
[<Publisher: Publisher object>, <Publisher: Publisher object>]
Estas pocas lneas logran bastantes resultados. Estos son los puntos salientes:
Para crear un objeto, slo importa la clase del modelo apropiada y crea una instancia pasndole
valores para cada campo.
Para guardar el objeto en la base de datos, llama el mtodo
Django ejecuta aqu una sentencia SQL
INSERT.
Para recuperar objetos de la base de datos, usa el atributo
todos los objetos
Publisher
save()
del objeto. Detrs de la escena,
Publisher.objects. Busca una lista de
Publisher.objects.all(). Detrs
en la base de datos con la sentencia
de escenas, Django ejecuta aqu una sentencia SQL
SELECT.
Naturalmente, puedes hacer mucho con la API de base de datos de Django -- pero primero, tengamos cuidado de
una pequea incomodidad.
5.9.
Agregando strings de representacin del modelo
Cuando imprimimos la lista de editores, todo lo que obtuvimos fue esta salida poco til que haca difcil distinguir
los objetos
Publisher:
[<Publisher: Publisher object>, <Publisher: Publisher object>]
Podemos arreglar esto fcilmente agregando un mtodo llamado __str__() a nuestro objeto Publisher. Un mtodo
__str__() le dice a Python como mostrar la representacin string de un objeto. Puedes ver esto en accin agregando
un mtodo __str__() a los tres modelos:
revisin 757 del 28 de julio de 2008
5.10. INSERTANDO Y ACTUALIZANDO DATOS
57
from django.db import models
class Publisher(models.Model):
name = models.CharField(maxlength=30)
address = models.CharField(maxlength=50)
city = models.CharField(maxlength=60)
state_province = models.CharField(maxlength=30)
country = models.CharField(maxlength=50)
website = models.URLField()
def __str__(self):
return self.name
class Author(models.Model):
salutation = models.CharField(maxlength=10)
first_name = models.CharField(maxlength=30)
last_name = models.CharField(maxlength=40)
email = models.EmailField()
headshot = models.ImageField(upload_to='/tmp')
def __str__(self):
return ' %s %s' % (self.first_name, self.last_name)
class Book(models.Model):
title = models.CharField(maxlength=100)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
def __str__(self):
return self.title
__str__() puede hacer lo que sea que necesite hacer para devolver una represen__str__() de Publisher y Book devuelven simplemente el nombre y ttulo del
objeto respectivamente, pero el __str__() del Author es un poco ms complejo -- junta los campos first_name y
last_name. El nico requerimiento para __str__() es que devuelva un string. Si __str__() no devuelve un string -si retorna, digamos, un entero -- entonces Python generar un TypeError con un mensaje como "__str__ returned
non-string".
Para que los cambios sean efectivos, sal del shell Python y entra de nuevo con python manage.py shell. (Esta
es la manera ms simple de hacer que los cambios en el cdigo tengan efecto.) Ahora la lista de objetos Publisher es
Como puedes ver, un mtodo
tacin textual. Aqu, los mtodos
ms fcil de entender:
>>> from books.models import Publisher
>>> publisher_list = Publisher.objects.all()
>>> publisher_list
[<Publisher: Addison-Wesley>, <Publisher: O'Reilly>]
Asegrate de que cada modelo que de nas tenga un mtodo
__str__()
-- no solo por tu propia conveniencia
cuando usas el intrprete interactivo, sino tambin porque Django usa la salida de
__str__()
en muchos lugares
cuando necesita mostrar objetos.
Finalmente, observa que
__str__()
es un buen ejemplo de agregar comportamiento a los modelos. Un modelo
Django describe ms que la con guracin de la tabla de la base de datos; tambin describe toda funcionalidad que el
objeto sepa hacer.
5.10.
__str__()
es un ejemplo de esa funcionalidad -- un modelo sabe cmo mostrarse.
Insertando y actualizando datos
Ya has visto cmo se hace: para insertar una la en tu base de datos, primero crea una instancia de tu modelo
usando argumentos por nombre, como:
revisin 757 del 28 de julio de 2008
58
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
>>> p = Publisher(name='Apress',
...
address='2855 Telegraph Ave.',
...
city='Berkeley',
...
state_province='CA',
...
country='U.S.A.',
...
website='http://www.apress.com/')
Este acto de instanciar una clase modelo no toca la base de datos.
Para guardar el registro en la base de datos (esto es, para realizar la sentencia SQL
save()
INSERT),
llama al mtodo
del objeto:
>>> p.save()
En SQL, esto puede ser traducido directamente en lo siguiente:
INSERT INTO book_publisher
(name, address, city, state_province, country, website)
VALUES
('Apress', '2855 Telegraph Ave.', 'Berkeley', 'CA',
'U.S.A.', 'http://www.apress.com/');
Como el modelo
Publisher
usa una clave primaria autoincremental
id,
la llamada inicial a
save() hace una cosa
id de la instancia:
ms: calcula el valor de la clave primaria para el registro y lo establece como el valor del atributo
>>> p.id
52
# esto ser diferente segn tus datos
save() guardarn el registro
UPDATE en lugar de un INSERT):
Las subsecuentes llamadas a
ejecutarn una sentencia SQL
en su lugar, sin crear un nuevo registro (es decir,
>>> p.name = 'Apress Publishing'
>>> p.save()
La sentencia
save()
del prrafo anterior resulta aproximadamente en la sentencia SQL siguiente:
UPDATE book_publisher SET
name = 'Apress Publishing',
address = '2855 Telegraph Ave.',
city = 'Berkeley',
state_province = 'CA',
country = 'U.S.A.',
website = 'http://www.apress.com'
WHERE id = 52;
5.11.
Seleccionar objetos
La creacin y actualizacin de datos seguro es divertida, pero tambin es intil sin una forma de tamizar los datos.
Ya hemos visto una forma de examinar todos los datos de un determinado modelo:
>>> Publisher.objects.all()
[<Publisher: Addison-Wesley>, <Publisher: O'Reilly>, <Publisher: Apress Publishing>]
Eso se traslada a esto en SQL:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher;
Nota
Nota que Django no usa
SELECT *
cuando busca datos y en cambio lista todos los campos
explcitamente. Esto es una decisin de diseo: en determinadas circunstancias
SELECT *
puede
ser lento, y (ms importante) listar los campos sigue el principio del Zen de Python: Explcito es
mejor que implcito.
Para ms sobre el Zen de Python, intenta escribiendo
import this
revisin 757 del 28 de julio de 2008
en el prompt de Python.
5.11. SELECCIONAR OBJETOS
59
Echemos un vistazo a cada parte de esta linea
Publisher.objects.all():
En primer lugar, tenemos nuestro modelo de nido,
Publisher.
Aqu no hay nada extrao: cuando
quieras buscar datos, usa el modelo para esto.
Luego, tenemos
objects.
Tcnicamente, esto es un administrador (manager ). Los administradores
son discutidos en el Apndice B. Por ahora, todo lo que necesitas saber es que los administradores se
encargan de todas las operaciones a nivel de tablas sobre los datos incluidos, y lo ms importante,
las consultas.
Todos los modelos automticamente obtienen un administrador
objects;
debes usar el mismo cada
vez que quieras consultar sobre una instancia del modelo.
Finalmente, tenemos
all(). Este es un mtodo del administrador objects que retorna todas las las
de la base de datos. Aunque este objeto se parece a una lista, es actualmente un QuerySet -- un
objeto que representa algn conjunto de las de la base de datos. El Apndice C describe QuerySets
en detalle. Para el resto de este captulo, slo trataremos estos como listas emuladas.
Cualquier bsqueda en base de datos va a seguir esta pauta general -- llamaremos mtodos del administrador
adjunto al modelo en el cual queremos hacer nuestra consulta.
5.11.1.
Filtrar datos
Aunque obtener todos los objetos es algo que ciertamente tiene su utilidad, la mayora de las veces lo que vamos a
necesitar es manejarnos slo con un subconjunto de los datos. Para ello usaremos el mtodo
filter():
>>> Publisher.objects.filter(name="Apress Publishing")
[<Publisher: Apress Publishing>]
filter() toma argumentos de palabra clave que son traducidos en las clusulas SQL WHERE apropiadas. El ejemplo
anterior sera traducido en algo como:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
WHERE name = 'Apress Publishing';
Puedes pasarle a
filter()
mltiples argumentos para reducir las cosas an ms:
>>> Publisher.objects.filter(country="U.S.A.", state_province="CA")
[<Publisher: Apress Publishing>]
AND.
Esos mltiples argumentos son traducidos a clusulas SQL
Por lo tanto el ejemplo en el fragmento de cdigo
se traduce a lo siguiente:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
WHERE country = 'U.S.A.' AND state_province = 'CA';
Notar que por omisin la bsqueda usa el operador SQL
para realizar bsquedas exactas. Existen tambin otros
tipos de bsquedas:
>>> Publisher.objects.filter(name__contains="press")
[<Publisher: Apress Publishing>]
Notar el doble guin bajo entre
name
contains.
Del mismo modo que Python, Django usa el doble guin bajo
para indicar que algo mgico est sucediendo -- aqu la parte
SQL
LIKE:
__contains
es traducida por Django en una sentencia
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
WHERE name LIKE ' %press %';
icontains (LIKE no sensible a diferencias de mayscustartswith y endswith, y range (consultas SQL BETWEEN). El Apndice C describe en detalle todos
Hay disponibles varios otos tipos de bsqueda, incluyendo
las/minsculas),
esos tipos de bsqueda.
revisin 757 del 28 de julio de 2008
60
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
5.11.2.
Obteniendo objetos individuales
En ocasiones desears obtener un nico objeto. Para esto existe el mtodo
get():
>>> Publisher.objects.get(name="Apress Publishing")
<Publisher: Apress Publishing>
En lugar de una lista (o ms bien, un QuerySet), este mtodo retorna un objeto individual. Debido a eso, una
consulta cuyo resultado sean mltiples objetos causar una excepcin:
>>> Publisher.objects.get(country="U.S.A.")
Traceback (most recent call last):
...
AssertionError: get() returned more than one Publisher -- it returned 2!
Una consulta que no retorne objeto alguno tambin causar una excepcin:
>>> Publisher.objects.get(name="Penguin")
Traceback (most recent call last):
...
DoesNotExist: Publisher matching query does not exist.
5.11.3.
Ordenando datos
A medida que juegas con los ejemplos anteriores, podras descubrir que los objetos so devueltos en lo que parece
ser un orden aleatorio. No ests imaginndote cosas, hasta ahora no le hemos indicado a la base de datos cmo ordenar
sus resultados, de manera que simplemente estamos recibiendo datos con algn orden arbitrario seleccionado por la
base de datos.
Eso es, obviamente, un poco
*silly* (tonto), no querramos que una pgina Web que muestra una lista de editores
estuviera ordenada aleatoriamente. As que, en la prctica, probablemente querremos usar
order_by() para reordenar
nuestros datos en listas ms tiles:
>>> Publisher.objects.order_by("name")
[<Publisher: Apress Publishing>, <Publisher: Addison-Wesley>, <Publisher: O'Reilly>]
Esto no se ve muy diferente del ejemplo de
all()
anterior, pero el SQL incluye ahora un ordenamiento espec co:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
ORDER BY name;
Podemos ordenar por cualquier campo que deseemos:
>>> Publisher.objects.order_by("address")
[<Publisher: O'Reilly>, <Publisher: Apress Publishing>, <Publisher: Addison-Wesley>]
>>> Publisher.objects.order_by("state_province")
[<Publisher: Apress Publishing>, <Publisher: Addison-Wesley>, <Publisher: O'Reilly>]
y por mltiples campos:
>>> Publisher.objects.order_by("state_provice", "address")
[<Publisher: Apress Publishing>, <Publisher: O'Reilly>, <Publisher: Addison-Wesley>]
Tambin podemos especi car un ordenamiento inverso antecediendo al nombre del campo un pre jo
(el smbolo
menos):
>>> Publisher.objects.order_by("-name")
[<Publisher: O'Reilly>, <Publisher: Apress Publishing>, <Publisher: Addison-Wesley>]
Aunque esta exibilidad es til, usar
order_by()
todo el tiempo puede ser demasiado repetitivo. La mayor parte
del tiempo tendrs un campo particular por el que usualmente desears ordenar. Es esos casos Django te permite
anexar al modelo un ordenamiento por omisin para el mismo:
revisin 757 del 28 de julio de 2008
5.11. SELECCIONAR OBJETOS
61
class Publisher(models.Model):
name = models.CharField(maxlength=30)
address = models.CharField(maxlength=50)
city = models.CharField(maxlength=60)
state_province = models.CharField(maxlength=30)
country = models.CharField(maxlength=50)
website = models.URLField()
def __str__(self):
return self.name
class Meta:
ordering = ["name"]
ordering = ["name"] le indica a Django que a menos que
order_by(), todos los editores debern ser ordenados por su nombre.
Este fragmento
diante
se proporcione un ordenamiento me-
Qu es este asunto de Meta?
Django usa esta
class Meta
interna como un lugar en el cual se pueden especi car metadatos
adicionales acerca de un modelo. Es completamente opcional, pero puede realizar algunas cosas
muy tiles. Examina el Apndice B para conocer las opciones que puede poner bajo
5.11.4.
Meta.
Encadenando bsquedas
Has visto cmo puedes ltrar datos y has visto cmo ordenarlos. En ocasiones, por supuesto, vas a desear realizar
ambas cosas. En esos casos simplemente encadenas las bsquedas entre s:
>>> Publisher.objects.filter(country="U.S.A.").order_by("-name")
[<Publisher: O'Reilly>, <Publisher: Apress Publishing>, <Publisher: Addison-Wesley>]
Como podras esperar, esto se traduce a una consulta SQL conteniendo tanto un
WHERE
como un
ORDER BY:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
WHERE country = 'U.S.A'
ORDER BY name DESC;
Puedes encadenar consultas en forma consecutiva tantas veces como desees. No existe un lmite para esto.
5.11.5.
Rebanando datos
Otra necesidad comn es buscar slo un nmero jo de las. Imagina que tienes miles de editores en tu base de
datos, pero quieres mostrar slo el primero. Puedes hacer eso usando la sintaxis estndar de Python para el rebanado
de listas:
>>> Publisher.objects.all()[0]
<Publisher: Addison-Wesley>
Esto se traduce, someramente, a:
SELECT
id, name, address, city, state_province, country, website
FROM book_publisher
ORDER BY name
LIMIT 1;
Y ms...
Hemos slo araado la super cie del manejo de modelos, pero deberas ya conocer lo su ciente
para entender todos los ejemplos del resto del libro. Cuando ests listo para aprender los detalles
completos detrs de las bsquedas de objetos, chale una mirada al Apndice C.
revisin 757 del 28 de julio de 2008
62
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
5.12.
Eliminando objetos
Para eliminar objetos, simplemente llama al mtodo
delete()
de tu objeto:
>>> p = Publisher.objects.get(name="Addison-Wesley")
>>> p.delete()
>>> Publisher.objects.all()
[<Publisher: Apress Publishing>, <Publisher: O'Reilly>]
Puedes tambin borrar objetos al por mayor llamando a
delete()
en el resultado de algunas bsquedas:
>>> publishers = Publisher.objects.all()
>>> publishers.delete()
>>> Publisher.objects.all()
[]
Nota
Los borrados son permanentes, as que, se cuidadoso!. En efecto, es usualmente una buena idea
evitar eliminar objetos a menos que realmente tengas que hacerlo -- las base de datos relacionales
no tiene una caracterstica deshacer muy buena, y recuperar desde copias de respaldo es doloroso.
A menudo es una buena idea agregar banderas activo a tus modelos de datos. Puedes buscar
slo objetos activos, y simplemente jar el campo activo a
False en lugar de eliminar el objeto.
Entonces, si descubres que has cometido un error, puedes simplemente volver a conmutar el estado
de la bandera.
5.13.
Realizando cambios en el esquema de una base de datos
Cuando presentamos el comando
syncdb previamente en este captulo, hicimos notar que syncdb simplemente crea
tablas que todava no existen en tu base de datos -- no sincroniza cambios en modelos ni borra modelos. Si agregas o
modi cas un campo de un modelo o si eliminas un modelo, ser necesario que realices el cambio en tu base de datos
en forma manual. Esta seccin explica cmo hacerlo.
Cuando ests realizando cambios de esquema, es importante tener presente algunas caractersticas de la capa de
base de datos de Django:
Django se quejar estrepitosamente si un modelo contiene un campo que todava no ha sido creado en
la tabla de la base de datos. Esto causar un error la primera vez que uses la API de base de datos de
Django para consultar la tabla en cuestin (esto es, ocurrir en tiempo de ejecucin y no en tiempo
de compilacin).
A Django no le importa si una tabla de base de datos contiene columnas que no estn de nidas en el
modelo.
A Django no le importa si una base de datos contiene una tabla que no est representada por un
modelo.
El realizar cambios al esquema de una base de datos es cuestin de cambiar las distintas piezas -- el cdigo Python
y la base de datos en s misma -- en el orden correcto.
5.13.1.
Agregando campos
Cuando se agrega un campo a una tabla/modelo en un entorno de produccin, el truco es sacar ventaja del hecho
que a Django no le importa si una tabla contiene columnas que no estn de nidas en el modelo. La estrategia es
agregar la columna en la base de datos y luego actualizar el modelo Django para que incluya el nuevo campo.
Sin embargo, tenemos aqu un pequeo problema del huevo y la gallina, porque para poder saber cmo debe
expresarse la nueva columna en SQL, necesitas ver la salida producida por el comando
manage.py sqlall de Django,
el cual requiere que el campo exista en el modelo. (Notar que no es un requerimiento el que crees tu columna con
exactamente el mismo SQL que usara Django, pero es una buena idea el hacerlo para estar seguros de que todo est
en sincrona).
La solucin al problema del huevo y la gallina es usar un entorno de desarrollo en lugar de realizar los cambios en
un servidor de produccin. (Ests usando un entorno de pruebas/desarrollo, no es cierto?). Este es el detalle de los
pasos a seguir.
Primero, realiza los siguientes pasos en el entorno de desarrollo (o sea, no en el servidor de produccin):
revisin 757 del 28 de julio de 2008
5.13. REALIZANDO CAMBIOS EN EL ESQUEMA DE UNA BASE DE DATOS
63
1. Agrega el campo a tu modelo.
2. Ejecuta
manage.py sqlall [yourapp]
para ver la nueva sentencia
CREATE TABLE
para el mo-
delo. Toma nota de la de nicin de la columna para el nuevo campo.
3. Arranca el shell interactivo de tu base de datos (por ej.
dbshell).
Ejecuta una sentencia
ALTER TABLE
psql
mysql,
o puedes usar
manage.py
que agregue tu nueva columna.
4. (Opcional) Arranca el shell interactivo de Python con
manage.py shell
y veri ca que el nuevo
campo haya sido agregado correctamente importando el modelo y seleccionando desde la tabla
(por ej.
MyModel.objects.all()[:5]).
Entonces en el servidor de produccin realiza los siguientes pasos:
1. Arranca el shell interactivo de tu base de datos.
2. Ejecuta la sentencia
ALTER TABLE
que usaste en el paso 3 de arriba.
3. Agrega el campo a tu modelo. Si ests usando un sistema de control de revisiones de cdigo
fuente y has realizado un check in de la modi cacin del paso 1 del trabajo en el entorno de
desarrollo, entonces puedes actualizar el cdigo (por ej.
svn update
si usas Subversion) en el
servidor de produccin.
4. Reinicia el servidor Web para que los cambios en el cdigo surtan efecto.
Por ejemplo, hagamos un repaso de los que haramos si agregramos un campo
num_pages al modelo Book descrito
previamente en este captulo. Primero, alteraramos el modelo en nuestro entorno de desarrollo para que se viera as:
class Book(models.Model):
title = models.CharField(maxlength=100)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
num_pages = models.IntegerField(blank=True, null=True)
def __str__(self):
return self.title
(Nota: Revisa el apartado Agregando columnas NOT NULL para conocer detalles importantes acerca de porqu
hemos incluido
blank=True
null=True).
manage.py sqlall books para ver la sentencia CREATE TABLE. La misma se vera
Luego ejecutaramos el comando
similar a esto:
CREATE TABLE "books_book" (
"id" serial NOT NULL PRIMARY KEY,
"title" varchar(100) NOT NULL,
"publisher_id" integer NOT NULL REFERENCES "books_publisher" ("id"),
"publication_date" date NOT NULL,
"num_pages" integer NULL
);
La nueva columna est representada de la siguiente manera:
"num_pages" integer NULL
A continuacin, arrancaramos el shell interactivo de base de datos en nuestra base de datos de desarrollo escribiendo
psql
(para PostgreSQL), y ejecutaramos la siguiente sentencia:
ALTER TABLE books_book ADD COLUMN num_pages integer;
revisin 757 del 28 de julio de 2008
64
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
Agregando columnas NOT NULL
Existe un detalle sutil aqu que merece ser mencionado. Cuando agregamos el campo
a nuestro modelo, incluimos las opciones
blank=True
null=True.
num_pages
Lo hicimos porque una
columna de una base de datos contendr inicialmente valores NULL desde el momento que la
crees.
Sin embargo, es tambin posible agregar columnas que no puedan contener valores NULL. Para
hacer esto, tienes que crear la columna como
NULL, luego poblar los valores de la columna usando
NOT NULL.
algunos valor(es) por omisin, y luego modi car la columna para activar el modi cador
Por ejemplo:
BEGIN;
ALTER TABLE books_book ADD COLUMN num_pages integer;
UPDATE books_book SET num_pages=0;
ALTER TABLE books_book ALTER COLUMN num_pages SET NOT NULL;
COMMIT;
Si sigues este camino, recuerda que debes quitar
Luego de la sentencia
ALTER TABLE,
blank=True
null=True
de tu modelo.
veri caramos que el cambio haya funcionado correctamente, para ello inicia-
ramos el shell de Python y ejecutaramos este cdigo:
>>> from mysite.books.models import Book
>>> Book.objects.all()[:5]
Si dicho cdigo no produjera errores, podramos movernos a nuestro servidor de produccin y ejecutaramos la
sentencia
ALTER TABLE
en la base de datos de produccin. Entonces, actualizaramos el modelo en el entorno de
produccin y reiniciaramos el servidor Web.
5.13.2.
Eliminando campos
Eliminar un campo de un modelo es mucho ms fcil que agregar uno. Para borrar un campo, slo sigue los
siguientes pasos:
1. Elimina el campo de tu modelo y reinicia el servidor Web.
2. Elimina la columna de tu base de datos, usando un comando como este:
ALTER TABLE books_book DROP COLUMN num_pages;
5.13.3.
Eliminando campos Many-to-Many
Debido a que los campos many-to-many son diferentes a los campos normales, el proceso de borrado es diferente:
1. Elimina el campo
ManyToManyField
de tu modelo y reinicia el servidor Web.
2. Elimina la tabla many-to-many de tu base de datos, usando un comando como este:
DROP TABLE books_books_publishers;
5.13.4.
Eliminando modelos
Eliminar completamente un modelo es tan fcil como el eliminar un campo. Para borrar un modelo, sigue los
siguientes pasos:
1. Elimina el modelo de tu archivo
models.py
y reinicia el servidor Web.
2. Elimina la tabla de tu base de datos, usando un comando como este:
DROP TABLE books_book;
revisin 757 del 28 de julio de 2008
5.14. QU SIGUE?
5.14.
65
Qu sigue?
Una vez que has de nido tus modelos, el paso siguiente es el poblar tu base de datos con datos. Podras tener datos
legados, en cuyo caso el Captulo 16 te aconsejar acerca de cmo integrar bases de datos heredadas. Podras delegar
en los usuario del sitio la provisin de los datos, en cuyo caso el Captulo 7 te ensear cmo procesar datos enviados
por los usuarios mediante formularios.
Pero en algunos casos, t o tu equipo podran necesitar ingresar datos en forma manual, en cuyo caso sera de
ayuda el disponer de una interfaz basada en Web para el ingreso y el manejo de los datos. El
`prximo captulo`_
est dedicado a la interfaz de administracin de Django, la cual existe precisamente por esa razn.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
66
CAPTULO 5. INTERACTUAR CON UNA BASE DE DATOS: MODELOS
revisin 757 del 28 de julio de 2008
Captulo 6
El sitio de Administracin Django
Para cierto tipo de Sitios Web, una interfaz de administracin es una parte esencial de la infraestructura. Se trata
de una interfaz basada en web, limitada a los administradores autorizados, que permite agregar, editar y eliminar el
contenido del sitio. La interfaz que usas para escribir en tu blog, el sitio privado que los editores usan para moderar
los comentarios de los lectores, la herramienta que tus clientes utilizan para actualizar los comunicados de prensa en
la web que construiste para ellos -- todos son ejemplos de interfaces de administracin.
Aunque hay un problema con las interfaces de administracin: es aburrido construirlas. El desarrollo web es divertido
cuando ests desarrollando funcionalidades de lado pblico del sitio, pero construir interfaces de administracin es
siempre lo mismo. Tienes que autenticar usuarios, mostrar y manipular formularios, validar las entradas y dems. Es
aburrido y repetitivo.
Cul es la solucin de Django para estas tareas aburridas y repetitivas? Las hace todas por ti -- en slo un par de
lneas de cdigo, ni ms ni menos. Con Django, construir interfaces de administracin es un problema resuelto.
Este captulo trata sobre la interfaz de administracin automtica de Django. Esta caracterstica funciona leyendo
los meta-datos en tus modelos para brindar una interfaz potente y lista para produccin que los administradores del
sitio podrn usar inmediatamente. Aqu discutimos cmo activar, usar y personalizar esta utilidad.
6.1.
Activando la interfaz de administracin
Pensamos que la interfaz de administracin es la caracterstica ms atractiva de Django -- y la mayora de Djangonautas estn de acuerdo -- pero como no todo el mundo lo necesita, es una pieza opcional. Esto signi ca que hay
que dar tres pasos para activar la interfaz de administracin:
1. Agrega meta-datos de administracin a tus modelos.
No todos los modelos pueden (o deberan) ser editables por los usuarios administradores, por lo
que necesitas marcar los modelos que deberan tener una interfaz de administracin. Esto lo
hacemos aadiendo al modelo una clase interna
Admin
(junto con la clase
Meta, si es
Book del
una). As que, para agregar una interfaz de administracin a nuestro modelo
que hay
captulo
anterior, usamos:
class Book(models.Model):
title = models.CharField(maxlength=100)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
num_pages = models.IntegerField(blank=True, null=True)
def __str__(self):
return self.title
La
class Admin:
pass
declaracin de Admin
marca la clase como poseedora de una interfaz de administracin. Hay
una serie de opciones que podemos incluir bajo
comportamiento por defecto, as que escribimos
Admin, pero por
pass para decirle
est vaca.
revisin 757 del 28 de julio de 2008
ahora vamos a limitarnos al
a Python que la clase
Admin
68
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Si ests siguiendo este ejemplo escribiendo tu propio cdigo, probablemente sea buena idea agregar ahora declaraciones de
2. Instalar la aplicacin
Admin
a las clases
Publisher
Author.
admin. Esto se hace agregando "django.contrib.admin" a tus INSTALLED_APPS
settings.py.
de tu archivo de con guracin
"django.contrib.sessions", "django.contrib.auth",
admin depende
de ellas. Tambin descomenta todas las lneas de MIDDLEWARE_CLASSES con gurando la tupla,
y borra la de nicin de TEMPLATE_CONTEXT_PROCESSOR para permitir que tome los valores por
3. Adems, asegurate de que las aplicaciones
y
"django.contrib.contenttypes"
no estn comentadas, ya que la aplicacin
defecto.
4. Ejecuta
python manage.py syncdb.
Este paso instalar las tablas de la base de datos que la
interfaz de administracin necesita.
Nota
Es probable que la primera vez que ejecutaste
syncdb
con
"django.contrib.auth"
en INSTA-
LLED_APPS, te preguntara algo sobre crear un superusuario. Si no lo hiciste en ese momento,
tendrs que ejecutar
django/contrib/auth/bin/create_superuser.py
para crear este usua-
rio administrador. En caso contrario no sers capaz de identi carte para entrar a la interfaz de
administracin.
5. Agrega el patrn de URL en tu
urls.py. Si an ests usando el que fue creado por startproject,
el patrn de la URL de administracin ya debera estar ah, pero comentado. De cualquier forma,
los patrones de URL deberan terminar siendo algo as:
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^admin/', include('django.contrib.admin.urls')),
)
Eso es todo. Ahora ejecuta
python manage.py runserver
para iniciar el servidor de pruebas. Vers algo como
esto:
Validating models...
0 errors found.
Django version 0.97, using settings 'mysite.settings'
Development server is running at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
Ahora puedes visitar la URL que te brinda Django (http://127.0.0.1:8000/admin/ en el ejemplo precedente),
identi carte, y jugar un poco.
6.2.
Usando la interfaz de administracin
La interfaz de administracin est diseada para ser usada por usuarios no tcnicos, y como tal debera ser lo
su cientemente clara como para explicarse por s misma. An as, se brindan unas pocas notas sobre sus caractersticas.
Lo primero que vers es una pgina de identi cacin, como se muestra en la Figura 6-1.
Usars el nombre de usuario y la clave que con guraste cuando agregaste tu superusuario. Una vez identi cado,
vers que puedes gestionar usuarios, grupos y permisos (veremos ms sobre esto en breve).
Cada objeto al que se le di una declaracin
Admin aparece en el ndice de la pgina principal, como se muestra en
la Figura 6-2
6 y
Los enlaces para agregar y modi car objetos llevan a dos pginas a las que nos referiremos como
formularios de edicin
7 de objetos:
listas de cambio
Las listas de cambio son esencialmente pginas de ndices de objetos en el sistema, como se muestra en la Figura
6-3.
Hay varias opciones que pueden controlar los campos que aparecen en esas listas y la aparicin de caractersticas
extra como campos de bsqueda e accesos directo a ltros prede nidos. Ms adelante hablaremos sobre esto.
Los formularios de edicin se usan para modi car objetos existente y crear nuevos (mira la Figura 6-4). Cada
campo de nido en tu modelo aparece aqu, y notars que campos de tipos diferentes tienen diferentes controles. (Por
ejemplo, los campos de fecha/hora tienen controles tipo calendario, las claves forneas usan cajas de seleccin, etc.)
revisin 757 del 28 de julio de 2008
6.2. USANDO LA INTERFAZ DE ADMINISTRACIN
Figura 6.1: Pantalla de autenticacin de Django.
revisin 757 del 28 de julio de 2008
69
70
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Figura 6.2: El ndice principal de la Administracin de Django.
revisin 757 del 28 de julio de 2008
6.2. USANDO LA INTERFAZ DE ADMINISTRACIN
Figura 6.3: Una tpica vista de lista de cambio
revisin 757 del 28 de julio de 2008
71
72
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Figura 6.4: Un tpico formulario de edicin
revisin 757 del 28 de julio de 2008
6.3. PERSONALIZANDO LA INTERFAZ DE ADMINISTRACIN
73
Te dars cuenta que la interfaz de administracin tambin controla por ti la validez de los datos ingresado. Intenta
dejar un campo requerido en blanco o poner una fecha invlida en un campo de fecha, y vers esos avisos de esos
errores cuando intentes guardar el objeto, como se muestra en la Figura 6-5.
Cuando editas un objeto existente, vers el botn Historia en la esquina superior derecha de la ventana. Cada
cambio realizado a travs de la interfaz de administracin es registrado, y puedes examinar este registro haciendo click
en este botn (mira la Figura 6-6).
Cuando eliminas un objeto existente, la interfaz de administracin solicita una con rmacin para prevenir costosos
errores. La eliminacin de un objeto se desencadena en cascada, y la pgina de con rmacin de eliminacin del objeto
muestra todos los objetos relacionados que se eliminarn con l (mira la Figura 6-7).
6.2.1.
Usuarios, Grupos y Permisos
Desde que ests identi cado como un superusuario, tienes acceso a crear, editar y eliminar cualquier objeto. Sin
embargo, la interfaz de administracin tiene un sistema de permisos de usuario que puedes usar para darle a otros
usuarios acceso limitado a las partes de la interfaz que ellos necesitan.
Puedes editar estos usuarios y permisos a travs de la interfaz de administracin, como si fuese cualquier otro
objeto. Los vnculos a los modelos
Usuarios y Grupos se encuentran en el ndice de la pgina principal junto con todo
el resto de los modelos que haz de nido.
Los objetos
usuario
tienen el los campos estndar nombre de usuario, contrasea, direccin de correo, y nombre
real que puedes esperar, seguidos de un conjunto de campos que de nen lo que el usuario tiene permitido hacer en la
interfaz de administracin. Primero, hay un conjunto de tres opciones seleccionables:
La opcin Es sta indica que el usuario est habilitado a ingresar a la interfaz de administracin
(por ejemplo, indica que el usuario es considerado un miembro del sta en tu organizacin). Como
el mismo sistema de usuarios puede usarse para controlar el acceso al sitio pblico (es decir, sitios
restringidos no administrativos. Mira el Captulo 12.), esta opcin diferencia entre usuarios pblicos
y administradores.
La opcin Activo de ne si el usuario est activo en todo sentido. Si est desactivada, el usuario no
tendr acceso a ninguna URL que requiera identi cacin.
La opcin es superusuario da al usuario completo e irrestricto acceso a todos los elementos de la
interfaz de administracin, y sus permisos regulares son ignorados.
Los administradores normales -- esto es, activos, no superusuarios y miembros del sta -- tienen accesos que
dependen del conjunto de permisos concedidos. Cada objeto editable a travs de la interfaz de administracin tiene
tres permisos: un permiso de crear
8 , un permiso de modi car 9 , y un permiso de eliminar 10 . Lgicamente, asignando
permisos a un usuario habilitas que este acceda a realizar la accin que el permiso describe.
Nota
El acceso a editar usuarios y permisos tambin es controlado por el sistema de permisos. Si le das
a alguien el permiso de editar usuarios, estar en condiciones de editar sus propios permisos, que
probablemente no es lo que queras!
Tambin puedes asignar usuarios a grupos. Un grupo es simplemente un conjunto de permisos a aplicar a todos los
usuarios de ese grupo. Los grupos son tiles para otorgar idnticos permisos a un gran nmero de usuarios.
6.3.
Personalizando la interfaz de administracin
Puedes personalizar el aspecto y la forma en que la interfaz de administracin se comporta de varias maneras. En
esta seccin slo vamos a cubrir algunas de ellas relacionadas con nuestro modelo
Libro.
El Captulo 17 descubre la
personalizacin de la interfaz de administracin en detalle.
Como estamos ahora, la lista de cambio de nuestros libros slo muestra la cadena de representacin del modelo que
agregamos con el mtodo
__str__
Esto funciona bien slo para algunos libros, pero si tuviramos cientos o miles de libros, se volvera tan difcil como
encontrar una aguja en un pajar. Sin embargo, fcilmente podremos agregar algunas columnas, funciones de bsqueda
y ltros y a esta interfaz. Cambia la declaracin de
Admin
como sigue:
class Book(models.Model):
title = models.CharField(maxlength=100)
revisin 757 del 28 de julio de 2008
74
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Figura 6.5: Un formulario de edicin mostrando errores
revisin 757 del 28 de julio de 2008
6.3. PERSONALIZANDO LA INTERFAZ DE ADMINISTRACIN
Figura 6.6: Pgina de historia de un objeto django.
revisin 757 del 28 de julio de 2008
75
76
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Figura 6.7: Una pgina de con rmacin de eliminacin de un objeto Django
revisin 757 del 28 de julio de 2008
6.4. PERSONALIZANDO LA APARIENCIA DE LA INTERFAZ DE ADMINISTRACIN
77
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
class Admin:
list_display = ('title', 'publisher', 'publication_date')
list_filter = ('publisher', 'publication_date')
ordering = ('-publication_date',)
search_fields = ('title',)
Estas cuatro lneas de cdigo cambian dramticamente la interfaz de nuestra lista, como se muestra en la gura
6-8.
Cada una de estas lneas indica a la interfaz de administracin que construya diferentes piezas de la interfaz:
La opcin
list_display controla que columnas aparecen en la tabla de la lista. Por defecto, la lista de
cambios muestra una sola columna que contiene la representacin en cadena de caracteres del objeto.
Aqu podemos cambiar eso para mostrar el ttulo, el editor y la fecha de publicacin.
La opcin
list_filter
crea una barra de ltrado del lado derecho de la lista. Estaremos habilitados
a ltrar por fecha (que te permite ver slo los libros publicados la ltima semana, mes, etc.) y por
editor.
Puedes indicarle a la interfaz de administracin que ltre por cualquier campo, pero las claves forneas,
fechas, booleanos, y campos con un atributo de opciones
choices
son las que mejor funcionan. Los
ltros aparecen cuando tienen al menos 2 valores de dnde elegir.
La opcin
ordering
controla el orden en el que los objetos son presentados en la interfaz de ad-
ministracin. Es simplemente una lista de campos con los cuales ordenar el resultado; anteponiendo
un signo menos a un campo se obtiene el orden reverso. En este ejemplo, ordenamos por fecha de
publicacin con los ms recientes al principio.
Finalmente, la opcin
search_fields crea un campo que permite buscar texto. En nuestro caso,
ttulo (entonces podras ingresar Django para mostrar todos los libros
buscar el texto en el campo
con Django en el ttulo).
Usando estas opciones (y las otras descriptas en el captulo 17) puedes, con slo algunas lneas de cdigo, hacer
una interfaz de edicin de datos realmente potente y lista para produccin.
6.4.
Personalizando la apariencia de la interfaz de administracin
Claramente, tener la frase Administracin de Django en la cabecera de cada pgina de administracin es ridculo.
Es slo un texto de relleno que es fcil de cambiar, usando el sistema de plantillas de Django. El sitio de administracin
de Django est propulsado por el mismo Django, sus interfaces usan el sistema de plantillas propio de Django. (El
sistema de plantillas de Django fue presentado en el Captulo 4.)
Como explicamos en el Captulo 4, la con guracin de
TEMPLATE_DIRS especi ca una lista de directorios a veri car
cuando se cargan plantillas Django. Para personalizar las plantillas del sitio de administracin, simplemente copia el
conjunto relevante de plantillas de la distribucin Django en uno de los directorios apuntados por
TEMPLATE_DIRS.
El sitio de administracin muestra Administracin de Django en la cabecera porque esto es lo que se incluye en la
admin/base_site.html. Por defecto, esta plantilla se encuentra en el directorio de plantillas de administracin
django/contrib/admin/templates, que puedes encontrar buscando en tu directorio site-packages de
Python, o donde sea que Django fue instalado. Para personalizar esta plantilla base_site.html, copia la original dentro
de un subdirectorio llamado admin dentro de cualquiera del directorio de TEMPLATE_DIRS que ests usando. Por ejemplo,
si tu TEMPLATE_DIRS incluye "/home/misplantillas", entonces copia django/contrib/admin/templates/admin/base_site
a /home/misplantillas/admin/base_site.html. No te olvides del subdirectorio admin.
Luego, slo edita el nuevo archivo admin/base_site.html para reemplazar el texto genrico de Django, por el
plantilla
de Django,
nombre de tu propio sitio, tal como lo quieres ver.
Nota que cualquier plantilla por defecto de Django Admin puede ser reescrita. Para reescribir una plantilla, haz lo
mismo que hicimos con
base_site.html: copia esta desde el directorio original a tu directorio personalizado y haz los
cambios sobre esta copia.
Puede que te preguntes cmo, si
TEMPLATE_DIRS
estaba vaci al principio, Django encuentra las plantillas por
defecto de la interfaz de administracin. La respuesta es que, por defecto, Django automticamente busca plantillas
dentro del subdirectorio
templates/ de cada paquete de aplicacin como alternativa. Mira el captulo 10 para obtener
ms informacin sobre cmo funciona esto.
revisin 757 del 28 de julio de 2008
78
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Figura 6.8: Pgina de lista de cambios modi cada
revisin 757 del 28 de julio de 2008
6.5. PERSONALIZANDO LA PGINA NDICE DEL ADMINISTRADOR
6.5.
79
Personalizando la pgina ndice del administrador
En una nota similar, puedes tener la intencin de personalizar la apariencia (el look & feel ) de la pgina principal
del administrador. Por defecto, aqu se muestran todas las aplicaciones, de acuerdo a la con guracin que tenga
INSTALLED_APPS,
ordenados por el nombre de la aplicacin. Quizs quieras, por ejemplo, cambiar el orden para hacer
ms fcil ubicar determinada aplicacin que ests buscando. Despus de todo, la pgina inicial es probablemente la
ms importante de la interfaz de administracin, y debera ser fcil utilizarla.
La plantilla para personalizarla es
admin/index.html. (Recuerda copiar admin/index.html a tu directorio de plan{ % get_admin_app_list
tillas propio como en el ejemplo previo). Edita el archivo, y vers que usa una etiqueta llamada
as app_list %}. Esta etiqueta devuelve todas las aplicaciones Django instaladas. En vez de usar esta etiqueta, puedes
incluir vnculos explcitos a objetos espec cos de la manera que creas ms conveniente. Si cdigo explcito en una
plantilla no te satisface, puedes ver el
`Captulo 10`_ para encontrar detalles sobre cmo implementar tu propias
etiquetas de plantillas.
Django ofrece otro acceso directo en este apartado. Ejecuta el comando
python manage.py adminindex <aplicacin>
para obtener un pedazo de cdigo de plantilla para incluir en la pgina ndice del administrador. Es un punto de partida
bastante til.
Para detalles completos sobre la personalizacin del sitio de administracin de Django, mira el Captulo 17.
6.6.
Cundo y porqu usar la interfaz de administracin
Pensamos que la interfaz de administracin de Django es bastante espectacular. De hecho, diramos que es una
de sus killer feautures, o sea, una de sus caractersticas sobresalientes. Sin embargo, a menudo nos preguntan sobre
casos de uso para la interfaz de administracin (Cundo debemos usarlo y por qu?). A lo largo de los aos, hemos
descubierto algunos patrones donde pensamos que usar la interfaz de administracin resulta til.
Obviamente, es muy til para modi car datos (se vea venir). Si tenemos cualquier tipo de tarea de introduccin
de datos, el administrador es difcil de superar. Sospechamos que la gran mayora de lectores de este libro tiene una
horda de tareas de este tipo.
La interfaz de administracin de Django brilla especialmente cuando usuarios no tcnicos necesitan ser capaces de
ingresar datos; ese es el propsito detrs de esta caracterstica, despus de todo. En el peridico donde Django fue
creado originalmente, el desarrollo una caracterstica tpica online -- un reporte especial sobre la calidad del agua del
acueducto municipal, pongamos -- implicaba algo as:
El periodista responsable del artculo se rene con uno de los desarrolladores y discuten sobre la
informacin disponible.
El desarrollador disea un modelo basado en esta informacin y luego abre la interfaz de administracin
para el periodista.
Mientras el periodista ingresa datos a Django, el programador puede enfocarse en desarrollar la interfaz
accesible pblicamente (la parte divertida!).
En otras palabras, la razn de ser de la interfaz de administracin de Django es facilitar el trabajo simultneo de
productores de contenido y programadores.
Sin embargo, ms all de estas tareas de entrada de datos obvias, encontramos que la interfaz de administracin
es til en algunos otros casos:
Inspeccionar modelos de datos : La primer cosa que hacemos cuando hemos de nido un nuevo modelo
es llamarlo desde la interfaz de administracin e ingresar algunos datos de relleno. Esto es usual para
encontrar errores de modelado; tener una una interfaz gr ca al modelo revela problemas rpidamente.
Gestin de datos adquiridos : Hay una pequea entrada de datos asociada a un sitio como
http://chicagocrime.or
puesto que la mayora de los datos provienen de una fuente automtica. No obstante, cuando surgen
problemas con los datos automticos, es til poder entrar y editarlos fcilmente.
6.7.
Qu sigue?
Hasta ahora hemos creado algunos modelos y con gurado una interfaz de primera clase para modi car datos.
En el
`prximo captulo`_, nos meteremos en el verdadero guiso del desarrollo Web: creacin y procesamiento de
formularios.
revisin 757 del 28 de julio de 2008
80
CAPTULO 6. EL SITIO DE ADMINISTRACIN DJANGO
Duplicate explicit target name: prximo captulo.
6 N.
7 N.
8 N.
9 N.
10 N.
del T.:
del T.:
change list es el nombre que recibe en ingls
edit forms es el nombre que recibe en ingls
del T.: En el control de seleccin de permisos aparece como
Can change
del T.: Can delete
del T.:
Can add
revisin 757 del 28 de julio de 2008
Captulo 7
Procesamiento de formularios
Autor invitado: Simon Willison
Si has estado siguiendo el captulo anterior, ya deberas tener un sitio completamente funcional, aunque un poco
simple. En este captulo trataremos con la prxima pieza del juego: cmo construir vistas que obtienen entradas desde
los usuarios.
Comenzaremos haciendo un simple formulario de bsqueda a mano, viendo cmo manejar los datos suministrados
al navegador. Y a partir de ah, pasaremos al uso del framework de formularios que trae Django.
7.1.
Bsquedas
En la Web todo se trata de bsquedas. Dos de los casos de xito ms grandes, Google y Yahoo, han construido
sus empresas multimillonarias alrededor de las bsquedas. Casi todos los sitios observan un gran porcentaje de tr co
viniendo desde y hacia sus pginas de bsqueda. A menudo, la diferencia entre el xito y el fracaso de un sitio, lo
determina la calidad de su bsqueda. As que sera mejor que agreguemos un poco de bsqueda a nuestro pequeo
sitio de libros, no?
Comenzaremos agregando la vista para la bsqueda a nuestro URLconf (mysite.urls). Recuerda que esto se hace
agregando algo como
(r'^search/$', 'mysite.books.views.search') al conjunto de URL patterns
search en nuestro mdulo de vistas (mysite.books.views):
(patrones).
A continuacin, escribiremos la vista
from django.db.models import Q
from django.shortcuts import render_to_response
from models import Book
def search(request):
query = request.GET.get('q', '')
if query:
qset = (
Q(title__icontains=query) |
Q(authors__first_name__icontains=query) |
Q(authors__last_name__icontains=query)
)
results = Book.objects.filter(qset).distinct()
else:
results = []
return render_to_response("books/search.html", {
"results": results,
"query": query
})
Aqu han surgido algunas cosas que todava no vimos. La primera, ese
request.GET.
As es cmo accedes a los
datos del GET desde Django; Los datos del POST se acceden de manera similar, a travs de un objeto llamado
request.POST.
Estos objetos se comportan exactamente como los diccionarios estndar de Python, y tienen adems
otras capacidades, que se cubren en el apndice H.
revisin 757 del 28 de julio de 2008
82
CAPTULO 7. PROCESAMIENTO DE FORMULARIOS
Qu son estos datos del GET y del POST?
GET y POST son los dos mtodos que emplean los navegadores para enviar datos a un servidor.
Los encontrars con frecuencia en los elementos form de HTML:
<form action="/books/search/" method="get">
Esto le indica al navegador que suministre los datos del formulario a la URL
/books/search/
empleando el mtodo GET.
Hay diferencias de semntica importantes entre el GET y el POST, que no vamos a ver ahora mismo, pero dirjete a
http://www.w3.org/2001/tag/doc/whenToUseGet.html
si quieres
aprender ms.
As que la lnea:
query = request.GET.get('q', '')
q y retorna una cadena de texto vaca si este parmetro no fue suministrado.
get() de request.GET, algo potencialmente confuso. Este mtodo get() es el
busca un parmetro del GET llamado
Observa que estamos usando el mtodo
mismo que posee cualquier diccionario de Python. Lo estamos usando aqu para ser precavidos: no es seguro asumir
que
''
request.GET
tiene una clave
'q',
as que usamos
get('q', '')
para proporcionar un valor por omisin, que es
(el string vaco). Si hubiramos intentado acceder a la variable simplemente usando
hubiese estado disponible en los datos del GET, se habra lanzado un
Segundo, qu es ese
KeyError.
request.GET['q'],
no
Q? Los objetos Q se utilizan para ir construyendo consultas complejas -- en este caso, estamos
Q consisten
buscando los libros que coincidan en el ttulo o en el nombre con la consulta. Tcnicamente, estos objetos
de un QuerySet, y puede leer ms sobre esto en el apndice C.
En estas consultas,
icontains
es una bsqueda en la que no se distinguen maysculas de minsculas (case-
insensitive ), y que internamente usa el operador
LIKE
de SQL en la base de datos.
Dado que estamos buscando en campos de muchos-a-muchos, es posible que un libro se obtenga ms de una vez
(por ej: un libro que tiene dos autores, y los nombres de ambos concuerdan con la consulta). Al agregar
en el ltrado, se eliminan los resultados duplicados.
Todava no hay una plantilla para esta vista. Esto lo solucionar:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<title>Search{ % if query %} Results{ % endif %}</title>
</head>
<body>
<h1>Search</h1>
<form action="." method="GET">
<label for="q">Search: </label>
<input type="text" name="q" value="{{ query|escape }}">
<input type="submit" value="Search">
</form>
{ % if query %}
<h2>Results for "{{ query|escape }}":</h2>
{ % if results %}
<ul>
{ % for book in results %}
<li>{{ book|escape }}</l1>
{ % endfor %}
</ul>
{ % else %}
<p>No books found</p>
{ % endif %}
{ % endif %}
</body>
</html>
revisin 757 del 28 de julio de 2008
.distinct()
7.2. EL FORMULARIO PERFECTO
83
A esta altura, lo que esto hace debera ser obvio. Sin embargo, hay unas pocas sutilezas que vale la pena resaltar:
action es
en el formulario, esto signi ca la URL actual. Esta es una buena prctica estndar: no
utilices vistas distintas para la pgina que contiene el formulario y para la pgina con los resultados;
usa una pgina nica para las dos cosas.
Volvemos a insertar el texto de la consulta en el
<input>. Esto permite a los usuarios re nar fcilmente
sus bsquedas sin tener que volver a teclear todo nuevamente.
En todo lugar que aparece
query
book,
lo pasamos por el ltro
escape
para asegurarnos de que
cualquier bsqueda potencialmente maliciosa sea descartada antes de que se inserte en la pgina
Es vital hacer esto con todo el contenido suministrado por el usuario! De otra forma el sitio se abre a
ataques de cross-site scripting (XSS). El
`Captulo 19`_ discute XSS y la seguridad con ms detalle.
En cambio, no necesitamos preocuparnos por el contenido malicioso en las bsquedas de la base de
datos -- podemos pasar directamente la consulta a la base de datos. Esto es posible gracias a que la
capa de base de datos de Django se encarga de manejar este aspecto de la seguridad por ti.
Ahora ya tenemos la bsqueda funcionando. Se podra mejorar ms el sitio colocando el formulario de bsqueda
en cada pgina (esto es, en la plantilla base). Dejaremos esto de tarea para el hogar.
A continuacin veremos un ejemplo ms complejo. Pero antes de hacerlo, discutamos un tpico ms abstracto: el
formulario perfecto.
7.2.
El formulario perfecto
Los formularios pueden ser a menudo una causa importante de frustracin para los usuarios de tu sitio. Consideremos
el comportamiento de un hipottico formulario perfecto:
Debera pedirle al usuario cierta informacin, obviamente. La accesibilidad y la usabilidad importan
aqu. As que es importante el uso inteligente del elemento
<label>
de HTML, y tambin lo es
proporcionar ayuda contextual til.
Los datos suministrados deberan ser sometidos a una validacin extensiva. La regla de oro para la
seguridad de una aplicacin web es nunca confes en la informacin que ingresa. As que la validacin
es esencial.
Si el usuario ha cometido algn error, el formulario debera volver a mostrarse, junto a mensajes de
error detallados e informativos. Los campos deberan rellenarse con los datos previamente suministrados, para evitarle al usuario tener que volver a tipear todo nuevamente.
El formulario debera volver a mostrarse una y otra vez, hasta que todos los campos se hayan rellenado
correctamente.
Construir el formulario perfecto pareciera llevar mucho trabajo! Por suerte, el framework de formularios de Django
est diseado para hacer la mayor parte del trabajo por ti. Se le proporciona una descripcin de los campos del
formulario, reglas de validacin, y una simple plantilla, y Django hace el resto. El resultado es un formulario perfecto
que requiere de muy poco esfuerzo.
7.3.
Creacin de un formulario para comentarios
La mejor forma de construir un sitio que la gente ame es atendiendo a sus comentarios. Muchos sitios parecen
olvidar esto; ocultan los detalles de su contacto en FAQs, y parecen di cultar lo ms posible el encuentro con las
personas.
Cuando tu sitio tiene millones de usuarios, esto puede ser una estrategia razonable. En cambio, cuando intentas
formarte una audiencia, deberas pedir comentarios cada vez que se presente la oportunidad. Escribamos entonces un
simple formulario para comentarios, y usmoslo para ilustrar al framework de Django en plena accin.
Comenzaremos agregando
(r'^contact/$', 'mysite.books.views.contact')
al URLconf, y luego de namos
nuestro formulario. Los formularios en Django se crean de una manera similar a los modelos: declarativamente, empleando una clase de Python. He aqu la clase para nuestro simple formulario. Por convencin, lo insertaremos en un
nuevo archivo
forms.py
dentro del directorio de nuestra aplicacin:
revisin 757 del 28 de julio de 2008
84
CAPTULO 7. PROCESAMIENTO DE FORMULARIOS
from django import newforms as forms
TOPIC_CHOICES = (
('general', 'General enquiry'),
('bug', 'Bug report'),
('suggestion', 'Suggestion'),
)
class ContactForm(forms.Form):
topic = forms.ChoiceField(choices=TOPIC_CHOICES)
message = forms.CharField()
sender = forms.EmailField(required=False)
New Forms? Qu?
Cuando Django fue lanzado al pblico por primera vez, posea un sistema de formularios complicado y confuso. Como haca muy di cultosa la produccin de formularios, fue rescrito y ahora se
llama newforms (nuevos formularios). Sin embargo, como todava hay cierta cantidad de cdigo
que depende del viejo sistema de formularios, Django actualmente viene con ambos paquetes.
Al momento de escribir ese libro, el viejo sistema de formularios de Django sigue disponible
como
django.forms, y el nuevo paquete como django.newforms. En algn momento esto va
django.forms har referencia al nuevo paquete de formularios. Sin embargo, para
a cambiar, y
estar seguros de que los ejemplos de este libro funcionen lo ms ampliamente posible, todos harn
referencia a
django.newforms.
django.newforms.Form, tal como un modelo de Django es una
django.db.models.Model. El mdulo django.newforms tambin contiene cierta cantidad de clases Field
Un formulario de Django es una subclase de
subclase de
para los campos. Una lista completa de stas ltimas se encuentra disponible en la documentacin de Django, en
http://www.djangoproject.com/documentation/0.96/newforms/.
Nuestro ContactForm consiste de tres campos: un tpico, que se
puede elegir entre tres opciones; un mensaje,
que es un campo de caracteres; y un emisor, que es un campo de correo electrnico y es opcional (porque incluso los
comentarios annimos pueden ser tiles). Hay una cantidad de otros tipos de campos disponibles, y puedes escribir
nuevos tipos si ninguno cubre tus necesidades.
El objeto formulario sabe cmo hacer una cantidad de cosas tiles por s mismo. Puede validar una coleccin de
datos, puede generar sus propios widgets de HTML, puede construir un conjunto de mensajes de error tiles. Y si
ests en perezoso, puede incluso dibujar el formulario completo por ti. Incluyamos esto en una vista y vemoslo en
accin. En
from
from
from
from
views.py:
django.db.models import Q
django.shortcuts import render_to_response
models import Book
forms import ContactForm
def search(request):
query = request.GET.get('q', '')
if query:
qset = (
Q(title__icontains=query) |
Q(authors__first_name__icontains=query) |
Q(authors__last_name__icontains=query)
)
results = Book.objects.filter(qset).distinct()
else:
results = []
return render_to_response("books/search.html", {
"results": results,
"query": query
})
revisin 757 del 28 de julio de 2008
7.3. CREACIN DE UN FORMULARIO PARA COMENTARIOS
85
def contact(request):
form = ContactForm()
return render_to_response('contact.html', {'form': form})
y en
contact.html:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<title>Contact us</title>
</head>
<body>
<h1>Contact us</h1>
<form action="." method="POST">
<table>
{{ form.as_table }}
</table>
<p><input type="submit" value="Submit"></p>
</form>
</body>
</html>
La lnea ms interesante aqu es
al
render_to_response. as_table
{{ form.as_table }}. form es nuestra instancia de ContactForm, que fue pasada
es un mtodo de ese objeto que reproduce el formulario como una secuencia de
renglones de una tabla (tambin pueden usarse
as_ul
as_p).
El HTML generado se ve as:
<tr>
<th><label for="id_topic">Topic:</label></th>
<td>
<select name="topic" id="id_topic">
<option value="general">General enquiry</option>
<option value="bug">Bug report</option>
<option value="suggestion">Suggestion</option>
</select>
</td>
</tr>
<tr>
<th><label for="id_message">Message:</label></th>
<td><input type="text" name="message" id="id_message" /></td>
</tr>
<tr>
<th><label for="id_sender">Sender:</label></th>
<td><input type="text" name="sender" id="id_sender" /></td>
</tr>
Observa que las etiquetas
<table> y <form> no se han incluido; debes de nirlas por tu cuenta en la plantilla. Esto
te da control sobre el comportamiento del formulario al ser suministrado. Los elementos label s se incluyen, y proveen
a los formularios de accesibilidad desde fbrica.
Nuestro formulario actualmente utiliza un widget
<input type="text">
para el campo del mensaje. Pero no
queremos restringir a nuestros usuarios a una sola lnea de texto, as que la cambiaremos por un widget
<textarea>:
class ContactForm(forms.Form):
topic = forms.ChoiceField(choices=TOPIC_CHOICES)
message = forms.CharField(widget=forms.Textarea())
sender = forms.EmailField(required=False)
El framework de formularios divide la lgica de presentacin para cada campo, en un conjunto de widgets. Cada
tipo de campo tiene un widget por defecto, pero puedes sobreescribirlo fcilmente, o proporcionar uno nuevo de tu
creacin.
Por el momento, si se suministra el formulario, no sucede nada. Agreguemos nuestras reglas de validacin:
revisin 757 del 28 de julio de 2008
86
CAPTULO 7. PROCESAMIENTO DE FORMULARIOS
def contact(request):
if request.method == 'POST':
form = ContactForm(request.POST)
else:
form = ContactForm()
return render_to_response('contact.html', {'form': form})
Una instancia de formulario puede estar en uno de dos estados: bound (vinculado) o unbound (no vinculado). Una
instancia bound se construye con un diccionario (o un objeto que funcione como un diccionario) y sabe cmo validar y
volver a representar sus datos. Un formulario unbound no tiene datos asociados y simplemente sabe cmo representarse
a s mismo.
Intenta hacer clic en Submit en el formulario vaco. La pgina se volver a cargar, mostrando un error de validacin
que informa que nuestro campo de mensaje es obligatorio.
Intenta tambin ingresar una direccin de correo electrnico invlida. El
EmailField
sabe cmo validar estas
direcciones, por lo menos a un nivel razonable.
Cmo especi car datos iniciales
Al pasar datos directamente al constructor del formulario, estos se vinculan, y se indica que la
validacin debe ser efectuada. A menudo, necesitamos mostrar un formulario inicial con algunos
campos previamente rellenados -- por ejemplo, en un formulario editar. Podemos hacerlo con el
argumento de palabras claves
initial:
form = CommentForm(initial={'sender': '[email protected]'})
Si nuestro formulario siempre usar los mismos valores por defecto, podemos con gurarlos en la
de nicin misma del formulario:
message = forms.CharField(widget=forms.Textarea(),
initial="Replace with your feedback")
7.4.
Procesamiento de los datos suministrados
Una vez que el usuario ha llenado el formulario al punto de que pasa nuestras reglas de validacin, necesitamos
hacer algo til con los datos. En este caso, deseamos construir un correo electrnico que contenga los comentarios del
usuario, y enviarlo. Para esto, usaremos el paquete de correo electrnico de Django.
Pero antes, necesitamos saber si los datos son en verdad vlidos, y si lo son, necesitamos una forma de accederlos.
El framework de formularios hace ms que validar los datos, tambin los convierte a tipos de datos de Python.
IntegerField o
DateTimeField, el framework de formularios se encarga de que se devuelvan como un valor entero de Python, o como
un objeto datetime, respectivamente.
Para saber si un formulario est vinculado (bound ) a datos vlidos, llamamos al mtodo is_valid():
Nuestro formulario para comentarios slo trata con texto, pero si estamos usando campos como
form = ContactForm(request.POST)
if form.is_valid():
# Process form data
Ahora necesitamos acceder a los datos. Podramos sacarlos directamente del
request.POST,
pero si lo hiciramos,
no nos estaramos bene ciando de la conversin de tipos que realiza el framework de formularios. En cambio, usamos
form.clean_data:
if form.is_valid():
topic = form.clean_data['topic']
message = form.clean_data['message']
sender = form.clean_data.get('sender', '[email protected]')
# ...
Observa que dado que
sender
no es obligatorio, proveemos un valor por defecto por si no fue proporcionado.
Finalmente, necesitamos registrar los comentarios del usuario. La manera ms fcil de hacerlo es enviando un correo
electrnico al administrador del sitio. Podemos hacerlo empleando la funcin:
revisin 757 del 28 de julio de 2008
7.5. NUESTRAS PROPIAS REGLAS DE VALIDACIN
87
from django.core.mail import send_mail
# ...
send_mail(
'Feedback from your site, topic: %s' % topic,
message, sender,
['[email protected]']
)
La funcin
send_mail
tiene cuatro argumentos obligatorios: el asunto y el cuerpo del mensaje, la direccin del
emisor, y una lista de direcciones destino.
send_mail
es un cdigo conveniente que envuelve a la clase
EmailMessage
de Django. Esta clase provee caractersticas avanzadas como adjuntos, mensajes multiparte, y un control completo
sobre los encabezados del mensaje.
Una vez enviado el mensaje con los comentarios, redirigiremos a nuestro usuario a una pgina esttica de con rmacin. La funcin de la vista nalizada se ve as:
from
from
from
from
django.http import HttpResponseRedirect
django.shortcuts import render_to_response
django.core.mail import send_mail
forms import ContactForm
def contact(request):
if request.method == 'POST':
form = ContactForm(request.POST)
if form.is_valid():
topic = form.clean_data['topic']
message = form.clean_data['message']
sender = form.clean_data.get('sender', '[email protected]')
send_mail(
'Feedback from your site, topic: %s' % topic,
message, sender,
['[email protected]']
)
return HttpResponseRedirect('/contact/thanks/')
else:
form = ContactForm()
return render_to_response('contact.html', {'form': form})
Redirigir luego del POST
Si un usuario selecciona actualizar sobre una pgina que muestra una consulta POST, la consulta
se repetir. Esto probablemente lleve a un comportamiento no deseado, por ejemplo, que el registro
se agregue dos veces a la base de datos. Redirigir luego del POST es un patrn til que puede
ayudar a prevenir este escenario. As que luego de que se haya procesado el POST con xito,
redirige al usuario a otra pgina en lugar de retornar HTML directamente.
7.5.
Nuestras propias reglas de validacin
Imagina que hemos lanzado al pblico a nuestro formulario de comentarios, y los correos electrnicos han empezado
a llegar. Nos encontramos con un problema: algunos mensajes vienen con slo una o dos palabras, es poco probable
que tengan algo interesante. Decidimos adoptar una nueva pliza de validacin: cuatro palabras o ms, por favor.
Hay varias formas de insertar nuestras propias validaciones en un formulario de Django. Si vamos a usar nuestra regla
una y otra vez, podemos crear un nuevo tipo de campo. Sin embargo, la mayora de las validaciones que agreguemos
sern de un solo uso, y pueden agregarse directamente a la clase del formulario.
En este caso, necesitamos validacin adicional sobre el campo
clean_message
message,
a nuestro formulario:
class ContactForm(forms.Form):
revisin 757 del 28 de julio de 2008
as que debemos agregar un mtodo
88
CAPTULO 7. PROCESAMIENTO DE FORMULARIOS
topic = forms.ChoiceField(choices=TOPIC_CHOICES)
message = forms.CharField(widget=forms.Textarea())
sender = forms.EmailField(required=False)
def clean_message(self):
message = self.clean_data.get('message', '')
num_words = len(message.split())
if num_words < 4:
raise forms.ValidationError("Not enough words!")
return message
Este nuevo mtodo ser llamado despus del validador que tiene el campo por defecto (en este caso, el validador de
CharField obligatorio). Dado que los datos del campo ya han sido procesados parcialmente, necesitamos obtenerlos
desde el diccionario clean_data del formulario.
Usamos una combinacin de len() y split() para contar la cantidad de palabras. Si el usuario ha ingresado muy
pocas palabras, lanzamos un error ValidationError. El texto que lleva esta excepcin se mostrar al usuario como
un
un elemento de la lista de errores.
Es importante que retornemos explcitamente el valor del campo al nal del mtodo. Esto nos permite modi car
el valor (o convertirlo a otro tipo de Python) dentro de nuestro mtodo de validacin. Si nos olvidamos de retornarlo,
se retornar
7.6.
None
y el valor original ser perdido.
Una presentacin personalizada
La forma ms rpida de personalizar la presentacin de un formulario es mediante CSS. En particular, la lista de
errores puede dotarse de mejoras visuales, y el elemento
<ul>
tiene asignada la clase
errorlist
para ese propsito.
El CSS a continuacin hace que nuestros errores salten a la vista:
<style type="text/css">
ul.errorlist {
margin: 0;
padding: 0;
}
.errorlist li {
background-color: red;
color: white;
display: block;
font-size: 10px;
margin: 0 0 3px;
padding: 4px 5px;
}
</style>
Si bien es conveniente que el HTML del formulario sea generado por nosotros, en muchos casos la disposicin
por defecto no quedara bien en nuestra aplicacin.
{{ form.as_table }}
y similares son atajos tiles que podemos
usar mientras desarrollamos nuestra aplicacin, pero todo lo que concierne a la forma en que nuestro formulario es
representado puede ser sobreescrito, casi siempre desde la plantilla misma.
Cada widget de un campo (<input
type="text">, <select>, <textarea>, o similares) puede generarse indivi{{ form.fieldname }}. Cualquier error asociado con un campo est disponible como {{
form.fieldname.errors }}. Podemos usar estas variables para construir nuestra propia plantilla para el formulario:
dualmente accediendo a
<form action="." method="POST">
<div class="fieldWrapper">
{{ form.topic.errors }}
<label for="id_topic">Kind of feedback:</label>
{{ form.topic }}
</div>
<div class="fieldWrapper">
{{ form.message.errors }}
<label for="id_message">Your message:</label>
revisin 757 del 28 de julio de 2008
7.7. CREANDO FORMULARIOS A PARTIR DE MODELOS
89
{{ form.message }}
</div>
<div class="fieldWrapper">
{{ form.sender.errors }}
<label for="id_sender">Your email (optional):</label>
{{ form.sender }}
</div>
<p><input type="submit" value="Submit"></p>
</form>
{{ form.message.errors }}
se muestra como un
<ul class="errorlist">
si se presentan errores y como una
cadena de caracteres en blanco si el campo es vlido ( o si el formulario no est vinculado). Tambin podemos tratar a
la variable
form.message.errors como a un booleano o incluso iterar sobre la misma como en una lista, por ejemplo:
<div class="fieldWrapper{ % if form.message.errors %} errors{ % endif %}">
{ % if form.message.errors %}
<ol>
{ % for error in form.message.errors %}
<li><strong>{{ error|escape }}</strong></li>
{ % endfor %}
</ol>
{ % endif %}
{{ form.message }}
</div>
En caso de que hubieran errores de validacin, se agrega la clase errors al
<div>
contenedor y se muestran los
errores en una lista ordenada.
7.7.
Creando formularios a partir de Modelos
Construyamos algo un poquito ms interesante: un formulario que suministre los datos de un nuevo publicista a
nuestra aplicacin de libros del Captulo 5.
Una regla de oro que es importante en el desarrollo de software, a la que Django intenta adherirse, es: no te
repitas (del ingls Don't Repeat Yourself, abreviado DRY). Andy Hunt y Dave Thomas la de nen como sigue, en The
Pragmatic Programmer :
Cada pieza de conocimiento debe tener una representacin nica, no ambigua, y de autoridad, dentro de
un sistema.
Nuestro modelo de la clase
Publisher dice que un publicista tiene un nombre, un domicilio, una ciudad, un estado o
provincia, un pas, y un sitio web. Si duplicamos esta informacin en la de nicin del formulario, estaramos quebrando
la regla anterior. En cambio, podemos usar este til atajo:
form_for_model():
from models import Publisher
from django.newforms import form_for_model
PublisherForm = form_for_model(Publisher)
PublisherForm es una subclase de Form, tal como la clase ContactForm que creamos manualmente con anterioridad.
Podemos usarla de la misma forma:
from forms import PublisherForm
def add_publisher(request):
if request.method == 'POST':
form = PublisherForm(request.POST)
if form.is_valid():
form.save()
return HttpResponseRedirect('/add_publisher/thanks/')
else:
form = PublisherForm()
return render_to_response('books/add_publisher.html', {'form': form})
revisin 757 del 28 de julio de 2008
90
CAPTULO 7. PROCESAMIENTO DE FORMULARIOS
El archivo
add_publisher.html es casi idntico a nuestra plantilla contact.html original, as que la omitimos. Re(r'^add_publisher/$', 'mysite.books.views.add_publisher').
cuerda adems agregar un nuevo patrn al URLconf:
Ah se muestra un atajo ms. Dado que los formularios derivados de modelos se emplean a menudo para guardar
nuevas instancias del modelo en la base de datos, la clase del formulario creada por
conveniente mtodo
save().
form_for_model
incluye un
Este mtodo trata con el uso comn; pero puedes ignorarlo si deseas hacer algo ms que
tenga que ver con los datos suministrados.
form_for_instance() es un mtodo que est relacionado con el anterior, y puede crear formularios preinicializados
a partir de la instancia de un modelo. Esto es til al crear formularios editar.
7.8.
Qu sigue?
Este captulo concluye con el material introductorio de este libro. Los prximos trece captulos tratan con varios
tpicos avanzados, incluyendo la generacin de contenido que no es HTML (Captulo 11), seguridad (`Captulo
19`_),
y entrega del servicio (Captulo 20).
Luego de estos primeros siete captulos, deberas saber lo su ciente como para comenzar a escribir tus propios
proyectos en Django. El resto del material de este libro te ayudar a completar las piezas faltantes a medida que las
vayas necesitando.
Comenzaremos el Captulo 8 yendo hacia atrs, volviendo para darle una mirada ms de cerca a las vistas y a los
URLconfs (introducidos por primera vez en el Captulo 3).
revisin 757 del 28 de julio de 2008
Captulo 8
Vistas avanzadas y URLconfs
En el Captulo 3, explicamos las bases de las funciones vista de Django y las URLconfs. Este captulo entra en
detalle sobre funcionalidad avanzada en esas dos partes del framework.
8.1.
Trucos de URLconf
No hay nada de especial con las URLconfs -- como cualquier otra cosa en Django, son slo cdigo Python --.
Puedes aprovecharte de esto de varias maneras, como se describe las secciones que siguen.
8.1.1.
Importacin de funciones de forma efectiva
Considera esta URLconf, que se basa en el ejemplo del Captulo 3:
from django.conf.urls.defaults import *
from mysite.views import current_datetime, hours_ahead, hours_behind, now_in_chicago, now_in_london
urlpatterns = patterns('',
(r'^now/$', current_datetime),
(r'^now/plus(\d{1,2})hours/$', hours_ahead),
(r'^now/minus(\d{1,2})hours/$', hours_behind),
(r'^now/in_chicago/$', now_in_chicago),
(r'^now/in_london/$', now_in_london),
)
Como se explic en el Captulo 3, cada entrada de la URLconf incluye su funcin vista asociada, que se pasa
directamente como un mtodo. Esto signi ca que es necesario importar las funciones view en la parte superior del
mdulo.
Pero a medida que las aplicaciones Django crecen en complejidad, sus URLconf crecen tambin, y mantener esos
import puede ser tedioso de manejar. (Por cada nueva funcin vista, tienes que recordar importarla y la declaracin
de importaciones tiende a volverse demasiado larga si se utiliza este mtodo). Es posible evitar esa tarea tediosa
importando el mdulo
views
directamente. Este ejemplo de URLconf es equivalente al anterior:
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^now/$', views.current_datetime),
(r'^now/plus(\d{1,2})hours/$', views.hours_ahead),
(r'^now/minus(\d{1,2})hours/$', views.hours_behind),
(r'^now/in_chicago/$', views.now_in_chicago),
(r'^now/in_london/$', views.now_in_london),
)
Django ofrece otra forma de especi car la funcin vista para un patrn en particular en la URLconf: se le puede
pasar un string que contiene el nombre del mdulo y de la funcin en lugar del mtodo. Continuando con el ejemplo:
revisin 757 del 28 de julio de 2008
92
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^now/$', 'mysite.views.current_datetime'),
(r'^now/plus(\d{1,2})hours/$', 'mysite.views.hours_ahead'),
(r'^now/minus(\d{1,2})hours/$', 'mysite.views.hours_behind'),
(r'^now/in_chicago/$', 'mysite.views.now_in_chicago'),
(r'^now/in_london/$', 'mysite.views.now_in_london'),
)
(Nota que los nombres de las vistas estn entre comillas. Estamos usando
con comillas -- en lugar de
mysite.views.current_datetime.)
'mysite.views.current_datetime'
--
Al usar esta tcnica ya no es necesario importar las funciones vista; Django importa automticamente la funcin
vista apropiada la primera vez que sea necesaria, segn el string que describe el nombre y la ruta de la funcin vista.
Otro atajo que puedes tomar al usar la tcnica del string es sacar factor comn de pre jos view. En nuestro ejemplo
'mysite.views',
patterns(), as:
URLconf, cada uno de los strings vista comienza con
pre jo comn y pasarlo como primer argumento de
lo cual es redundante. Podemos factorizar ese
from django.conf.urls.defaults import *
urlpatterns = patterns('mysite.views',
(r'^now/$', 'current_datetime'),
(r'^now/plus(\d{1,2})hours/$', 'hours_ahead'),
(r'^now/minus(\d{1,2})hours/$', 'hours_behind'),
(r'^now/in_chicago/$', 'now_in_chicago'),
(r'^now/in_london/$', 'now_in_london'),
)
Nota que no se pone un punto detrs del pre jo, ni un punto delante de los string vista. Django los pone automticamente.
Con estos dos enfoques en mente, cul es mejor? Realmente depende de tu estilo personal de programacin y tus
necesidades.
Las siguientes son ventajas del enfoque string:
Es ms compacto, porque no requiere que importes las funciones vista.
Resulta en URLconfs ms fciles de leer y de manejar si tus funciones vista estn extendidas por
varios mdulos Python diferentes.
Las siguientes son ventajas del enfoque del mtodo:
Permite un fcil empaquetado de funciones vista. Ver la seccin `Empaquetado
de funciones
vista`_ ms adelante en este captulo.
Es ms Pythnico -- es decir, est ms en lnea con las tradiciones Python, como la de pasar funciones
como objetos.
Ambos enfoques son vlidos e incluso puedes mezclarlos dentro de la misma URLconf. La eleccin es tuya.
8.1.2.
Usar mltiples pre jos de vista
En la prctica, si usas la tcnica del string, probablemente termines mezclando vistas hasta el punto en que las
vistas de tu URLconf no tengan un pre jo comn. Sin embargo, todava puedes sacar provecho del atajo del pre jo de
las vistas para remover esta duplicacin. Simplemente junta los objetos
patterns(),
Antes:
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^/?$', 'mysite.views.archive_index'),
(r'^(\d{4})/([a-z]{3})/$', 'mysite.views.archive_month'),
(r'^tag/(\w+)/$', 'weblog.views.tag'),
)
revisin 757 del 28 de julio de 2008
as:
8.1. TRUCOS DE URLCONF
93
Despus:
from django.conf.urls.defaults import *
urlpatterns = patterns('mysite.views',
(r'^/?$', 'archive_index'),
(r'^(\d{4})/([a-z]{3})/$', 'archive_month'),
)
urlpatterns += patterns('weblog.views',
(r'^tag/(\w+)/$', 'tag'),
)
Lo nico que le importa al framework es que existe una variable a nivel mdulo llamada
urlpatterns. Esta variable
puede ser construida de forma dinmica, como lo hacemos en este ejemplo.
8.1.3.
Casos especiales de URLs en modo Debug
Hablando de construir
urlpatterns de forma dinmica, quizs quieras aprovechar esta tcnica para alterar el com-
portamiento de tu URLconf mientras ests en el modo depuracin de Django. Para hacer eso simplemente comprueba
el valor de la con guracin
DEBUG
en tiempo de ejecucin, as:
from django.conf.urls.defaults import*
from django.conf import settings
urlpatterns = patterns('',
(r'^$', 'mysite.views.homepage'),
(r'^(\d{4})/([a-z]{3})/$', 'mysite.views.archive_month'),
)
if settings.DEBUG:
urlpatterns += patterns('',
(r'^debuginfo$', 'mysite.views.debug'),
)
En este ejemplo, la URL
8.1.4.
/debuginfo/
slo estar disponible si tu con guracin
DEBUG
tiene el valor
True.
Usar grupos con nombre
Hasta ahora en todos nuestros ejemplos URLconf hemos usado, grupos de expresiones regulares sin nombre -- es
decir, ponemos parntesis en las partes de la URL que queremos capturar y Django le pasa ese texto capturado a la
funcin vista como un argumento posicional. En un uso ms avanzado, es posible usar grupos de expresiones regulares
con nombre para capturar partes de la URL y pasarlos como argumentos clave a una vista.
revisin 757 del 28 de julio de 2008
94
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
Argumentos claves vs. Argumentos posicionales
A una funcin de Python se la puede llamar usando argumentos de palabra clave o argumentos
posicionales -- y, en algunos casos, los dos al mismo tiempo. En una llamada por argumentos de
palabra clave, se especi can los nombres de los argumentos junto con los valores que se le pasan.
En una llamada por argumento posicional, sencillamente pasas los argumentos sin especi car
explcitamente qu argumento concuerda con cual valor; la asociacin est implcita en el orden
de los argumentos.
Por ejemplo, considera esta sencilla funcin:
def sell(item, price, quantity):
print "Selling %s unit(s) of %s at %s" % (quantity, item, price)
Para llamarla con argumentos posicionales, se especi can los argumentos en el orden en que estn
listados en la de nicin de la funcin:
sell('Socks', '$2.50', 6)
Para llamarla con argumentos de palabra clave, se especi can los nombres de los argumentos junto
con sus valores. Las siguientes sentencias son equivalentes:
sell(item='Socks', price='$2.50', quantity=6)
sell(item='Socks', quantity=6, price='$2.50')
sell(price='$2.50', item='Socks', quantity=6)
sell(price='$2.50', quantity=6, item='Socks')
sell(quantity=6, item='Socks', price='$2.50')
sell(quantity=6, price='$2.50', item='Socks')
Finalmente, se pueden mezclar los argumentos posicionales y por palabra clave, siempre y cuando los argumentos posicionales estn listados antes que los argumentos por palabra clave. Las
siguientes sentencias son equivalentes a los ejemplos anteriores:
sell('Socks', '$2.50', quantity=6)
sell('Socks', price='$2.50', quantity=6)
sell('Socks', quantity=6, price='$2.50')
En las expresiones regulares de Python, la sintaxis para los grupos de expresiones regulares con nombre es
(?P<nombre>patrn),
donde
nombre
es el nombre del grupo y
patrn
es algn patrn a buscar.
Aqu hay un ejemplo de URLconf que usa grupos sin nombre:
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^articles/(\d{4})/$', views.year_archive),
(r'^articles/(\d{4})/(\d{2})/$', views.month_archive),
)
Aqu est la misma URLconf, reescrita para usar grupos con nombre:
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^articles/(?P<year>\d{4})/$', views.year_archive),
(r'^articles/(?P<year>\d{4})/(?P<month>\d{2})/$', views.month_archive),
)
Esto produce exactamente el mismo resultado que el ejemplo anterior, con una sutil diferencia: se le pasa a las
funciones vista los valores capturados como argumentos clave en lugar de argumentos posicionales.
Por ejemplo, con los grupos sin nombre una peticin a
/articles/2006/03/
equivalente a esto:
revisin 757 del 28 de julio de 2008
resultara en una llamada de funcin
8.1. TRUCOS DE URLCONF
95
month_archive(request, '2006', '03')
Sin embargo, con los grupos con nombre, la misma peticin resultara en esta llamada de funcin:
month_archive(request, year='2006', month='03')
En la prctica, usar grupos con nombres hace que tus URLconfs sean un poco ms explcitas y menos propensas a
bugs causados por argumentos -- y puedes reordenar los argumentos en las de niciones de tus funciones vista. Siguiendo
con el ejemplo anterior, si quisiramos cambiar las URLs para incluir el mes antes del ao, y estuviramos usando
grupos sin nombre, tendramos que acordarnos de cambiar el orden de los argumentos en la vista
month_archive.
Si
estuviramos usando grupos con nombre, cambiar el orden de los parmetros capturados en la URL no tendra ningn
efecto sobre la vista.
Por supuesto, los bene cios de los grupos con nombre tienen el costo de la falta de brevedad; algunos desarrolladores
opinan que la sintaxis de los grupos con nombre es fea y larga. An as, otra ventaja de los grupos con nombres es
la facilidad de lectura, especialmente para las personas que no estn ntimamente relacionadas con las expresiones
regulares o con tu aplicacin Django en particular. Es ms fcil ver lo que est pasando, a primera vista, en una
URLconf que usa grupos con nombre.
8.1.5.
Comprender el algoritmo de combinacin/agrupacin
Una advertencia al usar grupos con nombre en una URLconf es que un simple patrn URLconf no puede contener
grupos con nombre y sin nombre. Si haces eso, Django no generar ningn mensaje de error, pero probablemente
descubras que tus URLs no se estn disparando de la forma esperada. Aqu est espec camente el algoritmo que sigue
el parser URLconf, con respecto a grupos con nombre vs. grupos sin nombre en una expresin regular:
Si existe algn argumento con nombre, usar esos, ignorando los argumentos sin nombre.
Adems, pasar todos los argumentos sin nombre como argumentos posicionales.
En ambos casos, pasar cualquier opcin extra como argumentos de palabra clave. Ver la prxima
seccin para ms informacin.
8.1.6.
Pasarle opciones extra a las funciones vista
A veces te encontrars escribiendo funciones vista que son bastante similares, con tan slo algunas pequeas
diferencias. Por ejemplo, digamos que tienes dos vistas cuyo contenido es idntico excepto por la plantilla que utilizan:
# urls.py
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^foo/$', views.foo_view),
(r'^bar/$', views.bar_view),
)
# views.py
from django.shortcuts import render_to_response
from mysite.models import MyModel
def foo_view(request):
m_list = MyModel.objects.filter(is_new=True)
return render_to_response('template1.html', {'m_list': m_list})
def bar_view(request):
m_list = MyModel.objects.filter(is_new=True)
return render_to_response('template2.html', {'m_list': m_list})
Con este cdigo nos estamos repitiendo y eso no es elegante. Al comienzo, podras pensar en reducir la redundancia
usando la misma vista para ambas URLs, poniendo parntesis alrededor de la URL para capturarla y comprobando
la URL dentro de la vista para determinar la plantilla, como mostramos a continuacin:
revisin 757 del 28 de julio de 2008
96
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
# urls.py
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^(foo)/$', views.foobar_view),
(r'^(bar)/$', views.foobar_view),
)
# views.py
from django.shortcuts import render_to_response
from mysite.models import MyModel
def foobar_view(request, url):
m_list = MyModel.objects.filter(is_new=True)
if url == 'foo':
template_name = 'template1.html'
elif url == 'bar':
template_name = 'template2.html'
return render_to_response(template_name, {'m_list': m_list})
Sin embargo, el problema con esa solucin es que acopla fuertemente tus URLs y tu cdigo Si decides renombrar
/foo/
/fooey/,
tienes que recordar cambiar el cdigo de la vista.
La solucin elegante involucra un parmetro URLconf opcional. Cada patrn en una URLconf puede incluir un
tercer tem: un diccionario de argumentos de palabra clave para pasarle a la funcin vista.
Con esto en mente podemos reescribir nuestro ejemplo anterior as:
# urls.py
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^foo/$', views.foobar_view, {'template_name': 'template1.html'}),
(r'^bar/$', views.foobar_view, {'template_name': 'template2.html'}),
)
# views.py
from django.shortcuts import render_to_response
from mysite.models import MyModel
def foobar_view(request, template_name):
m_list = MyModel.objects.filter(is_new=True)
return render_to_response(template_name, {'m_list': m_list})
Como puedes ver, la URLconf en este ejemplo especi ca
template_name
en la URLconf. La funcin vista lo trata
como a cualquier otro parmetro.
Esta tcnica de la opcin extra en la URLconf es una linda forma de enviar informacin adicional a tus funciones
vista sin tanta complicacin. Por ese motivo es que es usada por algunas aplicaciones incluidas en Django, ms
notablemente el sistema de vistas genricas, que tratamos en el Captulo 9.
La siguiente seccin contiene algunas ideas sobre cmo puedes usar la tcnica de la opcin extra en la URLconf
como parte de tus proyectos.
Simulando valores capturados en URLconf
Supongamos que posees un conjunto de vistas que son disparadas va un patrn y otra URL que no lo es pero cuya
lgica de vista es la misma. En este caso puedes simular la captura de valores de la URL usando opciones extra de
URLconf para manejar esa URL extra con una nica vista.
revisin 757 del 28 de julio de 2008
8.1. TRUCOS DE URLCONF
97
Por ejemplo, podras tener una aplicacin que muestra algunos datos para un da particular, con URLs tales como:
/mydata/jan/01/
/mydata/jan/02/
/mydata/jan/03/
# ...
/mydata/dec/30/
/mydata/dec/31/
Esto es lo su cientemente simple de manejar -- puedes capturar los mismos en una URLconf como esta (usando
sintaxis de grupos con nombre):
urlpatterns = patterns('',
(r'^mydata/(?P<month>\w{3})/(?P<day>\d\d)/$', views.my_view),
)
Y la
*signature* de la funcin vista se vera as:
def my_view(request, month, day):
# ....
Este enfoque es simple y directo -- no es nada que no hayamos visto antes. El truco entra en juego cuando quieres
agregar otra URL que usa
my_view
month ni/o un day.
/mydata/birthday/, que sera equivalente
pero cuya URL no incluye un
Por ejemplo, podras querer agregar otra URL,
/mydata/jan/06/.
Puedes sacar provecho de opciones extra de las URLconf de la siguiente forma:
urlpatterns = patterns('',
(r'^mydata/birthday/$', views.my_view, {'month': 'jan', 'day': '06'}),
(r'^mydata/(?P<month>\w{3})/(?P<day>\d\d)/$', views.my_view),
)
El detalle genial aqu es que no necesitas cambiar tu funcin vista para nada. A la funcin vista slo le incumbe el
obtener los parmetros
month
day
-- no importa si los mismos provienen de la captura de la URL o de parmetros
extra.
Convirtiendo una vista en genrica
Es una buena prctica de programacin el factorizar para aislar las partes comunes del cdigo. Por ejemplo, con
estas dos funciones Python:
def say_hello(person_name):
print 'Hello, %s' % person_name
def say_goodbye(person_name):
print 'Goodbye, %s' % person_name
podemos extraer el saludo para convertirlo en un parmetro:
def greet(person_name, greeting):
print ' %s, %s' % (greeting, person_name)
Puedes aplicar la misma losofa a tus vistas Django usando los parmetros extra de URLconf.
Con esto en mente, puedes comenzar a hacer abstracciones de nivel ms alto de tus vistas. En lugar de pensar
Esta vista muestra una lista de objetos
Event
y Esta otra vista muestra una lista de objetos
BlogEntry,
descubre
que ambas son casos espec cos de Una vista que muestra una lista de objetos, donde el tipo de objeto es variable.
Usemos este cdigo como ejemplo:
# urls.py
from django.conf.urls.defaults import *
from mysite import views
urlpatterns = patterns('',
(r'^events/$', views.event_list),
revisin 757 del 28 de julio de 2008
98
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
(r'^blog/entries/$', views.entry_list),
# views.py
from django.shortcuts import render_to_response
from mysite.models import Event, BlogEntry
def event_list(request):
obj_list = Event.objects.all()
return render_to_response('mysite/event_list.html', {'event_list': obj_list})
def entry_list(request):
obj_list = BlogEntry.objects.all()
return render_to_response('mysite/blogentry_list.html', {'entry_list': obj_list})
Ambas vistas hacen esencialmente lo mismo: muestran una lista de objetos. Refactoricemos el cdigo para extraer
el tipo de objetos que muestran:
# urls.py
from django.conf.urls.defaults import *
from mysite import models, views
urlpatterns = patterns('',
(r'^events/$', views.object_list, {'model': models.Event}),
(r'^blog/entries/$', views.object_list, {'model': models.BlogEntry}),
)
# views.py
from django.shortcuts import render_to_response
def object_list(request, model):
obj_list = model.objects.all()
template_name = 'mysite/ %s_list.html' % model.__name__.lower()
return render_to_response(template_name, {'object_list': obj_list})
Con esos pequeos cambios tenemos, de repente, una vista reusable e independiente del modelo. De ahora en
adelante, cada vez que necesitemos una lista que muestre una listado de objetos, podemos simplemente reusar esta
vista
object_list
en lugar de escribir cdigo de vista. A continuacin, un par de notas acerca de lo que hicimos:
Estamos pasando las clases de modelos directamente, como el parmetro
model.
El diccionario de
opciones extra de ULconf puede pasar cualquier tipo de objetos Python -- no slo strings.
La lnea
model.objects.all()
es un ejemplo de tipado de pato (duck typing ): Si camina como un
pato, y habla como un pato, podemos tratarlo como un pato. Nota que el cdigo no conoce de qu
tipo de objeto se trata
model; el nico requerimiento es que model tenga un atributo objects, el cual
all().
a su vez tiene un mtodo
Estamos usando
model.__name__.lower() para determinar el nombre de la plantilla. Cada clase
__name__ que retorna el nombre de la clase. Esta caracterstica es til en
Python tiene un atributo
momentos como este, cuando no conocemos el tipo de clase hasta el momento de la ejecucin. Por
ejemplo, el
__name__
de la clase
BlogEntry
es la cadena
BlogEntry.
En una sutil diferencia entre este ejemplo y el ejemplo previo, estamos pasando a la plantilla el
object_list. Podemos fcilmente
event_list, pero hemos dejado eso como un
nombre de variable genrico
blogentry_list
cambiar este nombre de variable a
ejercicio para el lector.
Debido a que los sitios Web impulsados por bases de datos tienen varios patrones comunes, Django incluye un
conjunto de vistas genricas que usan justamente esta tcnica para ahorrarte tiempo. Nos ocupamos de las vistas
genricas incluidas con Django en el prximo captulo.
revisin 757 del 28 de julio de 2008
8.1. TRUCOS DE URLCONF
99
Pasando opciones de con guracin a una vista
Si ests distribuyendo una aplicacin Django, es probable que tus usuarios deseen cierto grado de con guracin.
En este caso, es una buena idea agregar puntos de extensin a tus vistas para las opciones de con guracin que piensas
que la gente pudiera desear cambiar. Puedes usar los parmetros extra de URLconf para este n.
Una parte de una aplicacin que normalmente se hace con gurable es el nombre de la plantilla:
def my_view(request, template_name):
var = do_something()
return render_to_response(template_name, {'var': var})
Entendiendo la precedencia entre valores captuardos vs. opciones extra
Cuando se presenta un con icto, los parmetros extra de la URLconf tiene precedencia sobre los parmetros
capturados. En otras palabras, si tu URLconf captura una variable de grupo con nombre y un parmetro extra de
URLconf incluye una variable con el mismo nombre, se usar el parmetro extra de la URLconf.
Por ejemplo, analicemos esta URLconf:
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^mydata/(?P<id>\d+)/$', views.my_view, {'id': 3}),
)
id. Tiene precedencia el id jo especi cado.
/mydata/432432/) sern tratados como si id estuviera
Aqu, tanto la expresin regular como el diccionario extra incluye un
Esto signi ca que cualquier peticin (por ej.
jado a
3,
/mydata/2/
independientemente del valor capturado en la URL.
Los lectores atentos notarn que en este caso es una prdida de tiempo y de tipeo capturar
id
en la expresin
regular, porque su valor ser siempre descartado en favor del valor proveniente del diccionario. Esto es correcto; lo
traemos a colacin slo para ayudarte a evitar el cometer ese error.
8.1.7.
Usando argumentos de vista por omisin
Otro truco cmodo es el de especi car parmetros por omisin para los argumentos de una vista. Esto le indica a
la vista qu valor usar para un parmetro por omisin si es que no se especi ca ninguno.
Veamos un ejemplo:
# urls.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^blog/$', views.page),
(r'^blog/page(?P<num>\d+)/$', views.page),
)
# views.py
def page(request, num="1"):
# Output the appropriate page of blog entries, according to num.
# ...
views.page -- pero el primer patrn no captura nada
page() usar su argumento por omisin para num, "1". Si el
num que se haya capturado mediante la expresin regular.
Aqu, ambos patrones de URL apuntan a la misma vista -de la URL. Si el primer patrn es disparado, la funcin
segundo patrn es disparado,
page()
usar el valor de
Es comn usar esta tcnica en combinacin con opciones de con guracin, como explicamos previamente. Este
ejemplo implementa una pequea mejora al ejemplo de la seccin Pasando opciones de con guracin a una vista:
provee un valor por omisin para
template_name:
def my_view(request, template_name='mysite/my_view.html'):
var = do_something()
return render_to_response(template_name, {'var': var})
revisin 757 del 28 de julio de 2008
100
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
8.1.8.
Manejando vistas en forma especial
En algunas ocasiones tendrs un patrn en tu URLconf que maneja un gran nmero de URLs, pero necesitars
realizar un manejo especial en una de ellas. En este caso, saca provecho de la forma lineal en la que son procesadas la
URLconfs y coloca el caso especial primero.
Por ejemplo, las pginas agregar un objeto en el sitio de administracin de Django estn representadas por la
siguiente lnea de URLconf:
urlpatterns = patterns('',
# ...
('^([^/]+)/([^/]+)/add/$', 'django.contrib.admin.views.main.add_stage'),
# ...
)
Esto se disparar con URLs como
/myblog/entries/add/ y /auth/groups/add/. Sin embargo, la pgina agregar
de un objeto usuario (/auth/user/add/) es un caso especial -- la misma no muestra todos los campos del formulario,
muestra dos campos de contrasea, etc. Podramos resolver este problema tratando esto como un caso especial en la
vista, de esta manera:
def add_stage(request, app_label, model_name):
if app_label == 'auth' and model_name == 'user':
# do special-case code
else:
# do normal code
pero eso es poco elegante por una razn que hemos mencionado en mltiples oportunidades en este captulo: Coloca
lgica de URLs en la vista. Una manera ms elegante sera la de hacer uso del hecho que las URLconfs se procesan
desde arriba hacia abajo:
urlpatterns = patterns('',
# ...
('^auth/user/add/$', 'django.contrib.admin.views.auth.user_add_stage'),
('^([^/]+)/([^/]+)/add/$', 'django.contrib.admin.views.main.add_stage'),
# ...
)
Con esto, una peticin de
/auth/user/add/
ser manejada por la vista
user_add_stage.
Aunque dicha URL
coincide con el segundo patrn, coincide primero con el patrn ubicado ms arriba. (Esto es lgica de corto circuito).
8.1.9.
Capturando texto en URLs
Cada argumento capturado es enviado a la vista como una cadena Python, sin importar qu tipo de coincidencia
se haya producido con la expresin regular. Por ejemplo en esta lnea de URLconf:
(r'^articles/(?P<year>\d{4})/$', views.year_archive),
el argumento
year
de
views.year.archive()
ser una cadena, no un entero, aun cuando
\d{4}
slo coincidir
con cadenas que representen enteros.
Es importante tener esto presente cuando ests escribiendo cdigo de vistas. Muchas funciones incluidas con Python
son exigentes (y eso es bueno) acerca de aceptar objetos de cierto tipo. Un error comn es intentar crear un objeto
datetime.date
con valores de cadena en lugar de valores enteros:
>>> import datetime
>>> datetime.date('1993', '7', '9')
Traceback (most recent call last):
...
TypeError: an integer is required
>>> datetime.date(1993, 7, 9)
datetime.date(1993, 7, 9)
Traducido a una URLconf y una vista, este error se vera as:
revisin 757 del 28 de julio de 2008
8.2. INCLUYENDO OTRAS URLCONFS
101
# urls.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^articles/(\d{4})/(\d{2})/(\d{2})/$', views.day_archive),
)
# views.py
import datetime
def day_archive(request, year, month, day)
# The following statement raises a TypeError!
date = datetime.date(year, month, day)
En cambio
day_archive
puede ser escrito correctamente de la siguiente forma:
def day_archive(request, year, month, day)
date = datetime.date(int(year), int(month), int(day))
Notar que
int()
lanza un
ValueError
cuando le pasas una cadena que no est compuesta nicamente de dgitos,
pero estamos evitando ese error en este caso porque la expresin regular en nuestra URLconf ya se ha asegurado que
slo se pasen a la funcin vista cadenas que contengan dgitos.
8.1.10.
Entendiendo dnde busca una URLconf
Cuando llega una peticin, Django intenta comparar los patrones de la URLconf con la URL solicitada como una
cadena Python normal (no como una cadena Unicode). Esto no incluye los parmetros de
GET
POST
o el nombre del
dominio. Tampoco incluye la barra inicial porque toda URL tiene una barra inicial.
http://www.example.com/myapp/ Django tratar de encontrar una coincidencia
myapp/. En una peticin de http.//www.example.com/myapp/?page3 Django tratar de buscar una coincidencia
para myapp/.
El mtodo de la peticin (por ej. POST, GET, HEAD) no se tiene en cuenta cuando se recorre la URLconf. En otras
Por ejemplo, en una peticin de
para
palabras, todos los mtodos sern encaminados hacia la misma funcin para la misma URL. Es responsabilidad de
una funcin vista el manejar de maneras distintas en base al mtodo de la peticin.
8.2.
Incluyendo otras URLconfs
Si tu intencin es que tu cdigo sea usando en mltiples sitios implementados con Django, debes considerar el
organizar tus URLconfs en una manera que permita el uso de inclusiones.
Tu URLconf puede, en cualquier punto, incluir otros mdulos URLconf. Esto se trata, en esencia, de enraizar
un conjunto de URLs debajo de otras. Por ejemplo, esta URLconf incluye otras URLconfs:
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^weblog/', include('mysite.blog.urls')),
(r'^photos/', include('mysite.photos.urls')),
(r'^about/$', 'mysite.views.about'),
)
Existe aqu un detalle importante: en este ejemplo, la expresin regular que apunta a un
include()
$
include(),
no tiene un
(carcter que coincide con un n de cadena) pero si incluye una barra al nal. Cuando Django encuentra
elimina todo el fragmento de la URL que ya ha coincidido hasta ese momento y enva la cadena restante a la URLconf
incluida para su procesamiento subsecuente.
Continuando con este ejemplo, esta es la URLconf
mysite.blog.urls:
from django.conf.urls.defaults import *
revisin 757 del 28 de julio de 2008
102
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
urlpatterns = patterns('',
(r'^(\d\d\d\d)/$', 'mysite.blog.views.year_detail'),
(r'^(\d\d\d\d)/(\d\d)/$', 'mysite.blog.views.month_detail'),
)
Con esas dos URLconfs, veremos aqu cmo seran manejadas algunas peticiones de ejemplo:
/weblog/2007/: En la primera URLconf, el patrn r'^weblog/' coincide. Debido a que es un include(),
'weblog/'. La parte restante de la URL
es 2007/, la cual coincide con la primera lnea en la URLconf mysite.blog.urls.
Django quita todo el texto coincidente, que en este caso es
/weblog//2007/: En la primera URLconf, el patrn r'^weblog/' coincide. Debido a que es un
include(), Django quita todo el texto coinciente, que en este caso es weblog/. La parte restante
de la URL es /2007/ (con una barra inicial), la cual no coincide con ninguna de la lneas en la
URLconf mysite.blog.urls.
/about/:
8.2.1.
mysite.views.about en la primera
include() con patrones no include().
Esto coincide con el patrn de la vista
mostrando que puedes combinar patrones
URLconf, de-
Cmo trabajan los parmetros capturados con include()
Una URLconf incluida recibe todo parmetro que se haya capturado desde las URLconf padres, por ejemplo:
# root urls.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^(?P<username>\w+)/blog/', include('foo.urls.blog')),
)
# foo/urls/blog.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^$', 'foo.views.blog_index'),
(r'^archive/$', 'foo.views.blog_archive'),
)
En este ejemplo, la variable capturada
username()
es pasada a la URLconf incluida y, por lo tanto, a todas las
funciones vista en dicha URLconf.
Notar que los parmetros capturados sern pasados siempre a todas las lneas en la URLconf incluida, con independencia de si la vista de la lnea realmente acepta esos parmetros como vlidos. Por esta razn esta tcnica solamente
es til si ests seguro de que cada vista en la URLconf incluida acepta los parmetros que ests pasando.
8.2.2.
Cmo funcionan las opciones extra de URLconf con include()
De manera similar, puedes pasar opciones extra de URLconf a
include()
as como puedes pasar opciones extra
de URLconf a una vista normal -- como un diccionario. Cuando haces esto, las opciones extra sern pasadas a todas
las lneas en la URLconf incluida.
Por ejemplo, los siguientes dos conjuntos de URLconfs son funcionalmente idnticos.
Conjunto uno:
# urls.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^blog/', include('inner'), {'blogid': 3}),
)
revisin 757 del 28 de julio de 2008
8.3. QU SIGUE?
103
# inner.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^archive/$', 'mysite.views.archive'),
(r'^about/$', 'mysite.views.about'),
(r'^rss/$', 'mysite.views.rss'),
)
Conjunto dos:
# urls.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^blog/', include('inner')),
)
# inner.py
from django.conf.urls.defaults import *
urlpatterns = patterns('',
(r'^archive/$', 'mysite.views.archive', {'blogid': 3}),
(r'^about/$', 'mysite.views.about', {'blogid': 3}),
(r'^rss/$', 'mysite.views.rss', {'blogid': 3}),
)
Como en el caso de los parmetros capturados (sobre los cuales se explic en la seccin anterior), las opciones extra
se pasarn siempre a todas las lneas en la URLconf incluida, sin importar de si la vista de la lnea realmente acepta
esas opciones como vlidas. Por eta razn esta tcnica es til slo si ests seguro que todas las vistas en la URLconf
incluida acepta las opciones extra que ests pasando.
8.3.
Qu sigue?
Uno de los principales objetivos de Django es reducir la cantidad de cdigo que los desarrolladores deben escribir
y en este captulo hemos sugerido formas en las cuales se puede reducir el cdigo de tus vistas y URLconfs.
El prximo paso lgico en la reduccin de cdigo es eliminar completamente la necesidad de escribir vistas. Ese es
el tpico del
`prximo captulo`_.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
104
CAPTULO 8. VISTAS AVANZADAS Y URLCONFS
revisin 757 del 28 de julio de 2008
Captulo 9
Vistas genricas
De nuevo aparece aqu un tema recurrente en este libro: en el peor de los casos, el desarrollo Web es aburrido y
montono. Hasta aqu, hemos cubierto cmo Django trata de alejar parte de esa monotona en las capas del modelo y
las plantillas, pero los desarrolladores Web tambin experimentan este aburrimiento al nivel de las vistas.
Las vistas genricas de Django fueron desarrolladas para aliviar ese dolor. stas recogen ciertos estilos y patrones
comunes encontrados en el desarrollo de vistas y los abstraen, de modo que puedas escribir rpidamente vistas comunes
de datos sin que tengas que escribir mucho cdigo. De hecho, casi todos los ejemplos de vistas en los captulos
precedentes pueden ser reescritos con la ayuda de vistas genricas.
El Captulo 8 re ri brevemente sobre cmo haras para crear una vista genrica. Para repasar, podemos reconocer
ciertas tareas comunes, como mostrar una lista de objetos, y escribir cdigo que muestra una lista de cualquier objeto.
Por lo tanto el modelo en cuestin puede ser pasado como un argumento extra a la URLconf.
Django viene con vistas genricas para hacer lo siguiente:
Realizar tareas sencillas comunes: redirigir a una pgina diferente y renderizar una plantilla dada.
Mostrar pginas de listado y detalle para un solo objeto. Las vistas
event_list
entry_list
del
Captulo 8 son ejemplos de vistas de listado. Una pgina de evento simple es un ejemplo de lo que
llamamos vista detallada.
Presentar objetos basados en fechas en pginas de archivo de tipo da/mes/ao, su detalle asociado,
y las pginas ms recientes. Los archivos por da, mes, ao del Weblog de Django (http://www.
djangoproject.com/weblog/) estn construidos con ellas, como lo estaran los tpicos archivos de un
peridico.
Permitir a los usuarios crear, actualizar y borrar objetos -- con o sin autorizacin.
Agrupadas, estas vistas proveen interfaces fciles para realizar las tareas ms comunes que encuentran los desarrolladores.
9.1.
Usar vistas genricas
Todas estas vistas se usan creando diccionarios de con guracin en tus archivos URLconf y pasando estos diccionarios como el tercer miembro de la tupla URLconf para un patrn dado.
Por ejemplo, sta es una URLconf simple que podras usar para presentar una pgina esttica about (acerca de):
from django.conf.urls.defaults import *
from django.views.generic.simple import direct_to_template
urlpatterns = patterns('',
('^about/$', direct_to_template, {
'template': 'about.html'
})
)
Aunque esto podra verse un poco mgico a primera vista -- mira, una vista sin cdigo! --, es en realidad exactamente lo mismo que los ejemplos en el la vista
direct_to_template
simplemente toma informacin del diccionario
de parmetros extra y usa esa informacin cuando renderiza la vista.
revisin 757 del 28 de julio de 2008
106
CAPTULO 9. VISTAS GENRICAS
Ya que esta vista genrica -- y todas las otras -- es una funcin de vista regular como cualquier otra, podemos
reusarla dentro de nuestras propias vistas. Como ejemplo, extendamos nuestro ejemplo about para mapear URLs
de la forma
/about/<cualquiercosa>/ para renderizar estticamente /about/<cualquiercosa>.html. Haremos esto
primero modi cando la URLconf para que apunte a una funcin de vista:
from django.conf.urls.defaults import *
from django.views.generic.simple import direct_to_template
from mysite.books.views import about_pages
urlpatterns = patterns('',
('^about/$', direct_to_template, {
'template': 'about.html'
}),
('^about/(w+)/$', about_pages),
)
A continuacin, escribimos la vista
about_pages:
from django.http import Http404
from django.template import TemplateDoesNotExist
from django.views.generic.simple import direct_to_template
def about_pages(request, page):
try:
return direct_to_template(request, template="about/ %s.html" % page)
except TemplateDoesNotExist:
raise Http404()
Aqu estamos tratando
direct_to_template como cualquier otra funcin. Ya que esta devuelve una HttpResponse,
podemos retornarlo as como est. La nica ligera di cultad aqu es ocuparse de las plantillas perdidas. No queremos
que una plantilla inexistente cause un error de servidor, por lo tanto atrapamos las excepciones
TemplateDoesNotExist
y en su lugar devolvemos errores 404.
Hay una vulnerabilidad de seguridad aqu?
Los lectores atentos pueden haber notado un posible agujero de seguridad: estamos construyendo el nombre de la plantilla usando contenido interpolado proveniente del navegador
(template="about/ %s.html" %
page).
rabilidad de recorrido de directorio
A primera vista, esto parece como una clsica vulne-
11 (discutida en detalle en el
realmente una vulnerabilidad?
No exactamente. S, un valor creado maliciosamente de
directorio, pero aunque
page es
page
\w
Pero es
podra causar un recorrido de
tomado de la URL solicitada, no todos los valores sern aceptados.
La clave esta en la URLconf: estamos usando la expresin regular
de la URL y
`Captulo 19`_).
\w+ para veri car la parte page
slo acepta letras y nmeros. Por lo tanto, cualquier caracter malicioso (puntos
y barras, en este caso) sern rechazadas por el URL resolver antes de alcanzar la vista en s.
9.2.
Vistas genricas de objetos
La vista genrica
direct_to_template
ciertamente es til, pero las vistas genricas de Django brillan realmente
cuando se trata de presentar vistas del contenido de tu base de datos. Ya que es una tarea tan comn, Django viene con
un puado de vistas genricas incluidas que hacen la generacin de vistas de listado y detalle de objetos increblemente
fcil.
Demos un vistazo a una de estas vistas genricas: la vista object list. Usaremos el objeto
5:
class Publisher(models.Model):
name = models.CharField(maxlength=30)
address = models.CharField(maxlength=50)
city = models.CharField(maxlength=60)
state_province = models.CharField(maxlength=30)
revisin 757 del 28 de julio de 2008
Publisher del Captulo
9.3. EXTENDER LAS VISTAS GENRICAS
107
country = models.CharField(maxlength=50)
website = models.URLField()
def __str__(self):
return self.name
class Meta:
ordering = ["-name"]
class Admin:
pass
Para construir una pgina listado de todos los books, usaremos la URLconf bajo estas lneas:
from django.conf.urls.defaults import *
from django.views.generic import list_detail
from mysite.books.models import Publisher
publisher_info = {
"queryset" : Publisher.objects.all(),
}
urlpatterns = patterns('',
(r'^publishers/$', list_detail.object_list, publisher_info)
)
Ese es todo el cdigo Python que necesitamos escribir. Sin embargo, todava necesitamos escribir una plantilla.
Podramos decirle explcitamente a la vista
object_list que plantilla debe usar incluyendo una clave template_name
en el diccionario de argumentos extra, pero en la ausencia de una plantilla explcita Django inferir una del nombre del
objeto. En este caso, la plantilla inferida ser
"books/publisher_list.html" -- la parte books
proviene del nombre
de la aplicacin que de ne el modelo, mientras que la parte publisher es slo la versin en minsculas del nombre
del modelo.
Esta plantilla ser renderizada en un contexto que contiene una variable llamada
object_list
la cual contiene
todos los objetos book. Una plantilla muy simple podra verse como la siguiente:
{ % extends "base.html" %}
{ % block content %}
<h2>Publishers</h2>
<ul>
{ % for publisher in object_list %}
<li>{{ publisher.name }}</li>
{ % endfor %}
</ul>
{ % endblock %}
Eso es realmente todo en lo referente al tema. Todas las geniales caractersticas de las vistas genricas provienen
de cambiar el diccionario info pasado a la vista genrica. El Apndice D documenta todas las vistas genricas y
todas sus opciones en detalle; el resto de este captulo considerar algunas de las maneras comunes en que t puedes
personalizar y extender las vistas genricas.
9.3.
Extender las vistas genricas
No hay duda de que usar las vistas genricas puede acelerar el desarrollo sustancialmente. En la mayora de los
proyectos, sin embargo, llega un momento en el que las vistas genricas no son su cientes. De hecho, la pregunta ms
comn que se hacen los nuevos desarrolladores de Django es cmo hacer que las vistas genricas manejen un rango
ms amplio de situaciones.
Afortunadamente, en casi cada uno de estos casos, hay maneras de simplemente extender las vistas genricas para
manejar un conjunto ms amplio de casos de uso. Estas situaciones usualmente recaen en un puado de patrones que
se tratan en las secciones que siguen.
revisin 757 del 28 de julio de 2008
108
CAPTULO 9. VISTAS GENRICAS
9.3.1.
Crear contextos de plantilla amistosos
Tal vez hayas notado que el ejemplo de la plantilla publisher list almacena todos los books en una variable llamada
object_list.
Aunque que esto funciona bien, no es una forma amistosa para los autores de plantillas: ellos slo
tienen que saber aqu que estn trabajando con books. Un nombre mejor para esa variable sera
el contenido de esa variable es bastante obvio.
Podemos cambiar el nombre de esa variable fcilmente con el argumento
publisher_list;
template_object_name:
publisher_info = {
"queryset" : Publisher.objects.all(),
"template_object_name" : "publisher",
}
urlpatterns = patterns('',
(r'^publishers/$', list_detail.object_list, publisher_info)
)
Proveer un
template_object_name
til es siempre una buena idea. Tus compaeros de trabajo que disean las
plantillas te lo agradecern.
9.3.2.
Agregar un contexto extra
A menudo simplemente necesitas presentar alguna informacin extra aparte de la proporcionada por la vista
genrica. Por ejemplo, piensa en mostrar una lista de todos los otros publisher en cada pgina de detalle de un
publisher. La vista genrica
object_detail
provee el publisher al contexto, pero parece que no hay forma de obtener
una lista de todos los publishers en esa plantilla.
Pero s la hay: todas las vistas genricas toman un parmetro opcional extra,
extra_context. Este es un diccionario
de objetos extra que sern agregados al contexto de la plantilla. Por lo tanto, para proporcionar la lista de todos los
publishers en la vista de detalles, usamos un diccionario info como el que sigue:
publisher_info = {
"queryset" : Publisher.objects.all(),
"template_object_name" : "publisher",
"extra_context" : {"book_list" : Book.objects.all()}
}
Esto llenara una variable
{{ book_list }} en el contexto de la plantilla. Este patrn puede ser usado para pasar
cualquier informacin hacia la plantilla para la vista genrica. Es muy prctico.
Sin embargo, en realidad hay un error sutil aqu -- puedes detectarlo?
El problema aparece cuando las consultas en
Publisher.objects.all()
extra_context
son evaluadas. Debido a que este ejemplo coloca
en la URLconf, slo se evaluar una vez (cuando la URLconf se cargue por primera vez).
Una vez que agregues o elimines publishers, notars que la vista genrica no re eja estos cambios hasta que reinicias el
servidor Web (mira Almacenamiento en cach y QuerySets en el Apndice C para mayor informacin sobre cundo
los QuerySets son almacenados en la cache y evaluados).
Nota
Este problema no se aplica al argumento
queryset
de las vistas genricas. Ya que Django sabe
que ese QuerySet en particular nunca debe ser almacenado en la cach, la vista genrica se hace
cargo de limpiar la cach cuando cada vista es renderizada.
funcin) que sea pasado a
12 en
extra_context
extra_context ser evaluado
La solucin es usar un callback
en vez de un valor. Cualquier callable
13 (por ejemplo, una
cuando su vista sea renderizada (en vez de slo la primera
vez). Puedes hacer esto con una funcin explcitamente de nida:
def get_books():
return Book.objects.all()
publisher_info = {
"queryset" : Publisher.objects.all(),
"template_object_name" : "publisher",
"extra_context" : {"book_list" : get_books}
}
revisin 757 del 28 de julio de 2008
9.3. EXTENDER LAS VISTAS GENRICAS
109
o puedes usar una versin menos obvia pero ms corta que se basa en el hecho de que
Publisher.objects.all
es
en s un callable:
publisher_info = {
"queryset" : Publisher.objects.all(),
"template_object_name" : "publisher",
"extra_context" : {"book_list" : Book.objects.all}
}
Nota la falta de parntesis despus de
Book.objects.all; esto hace referencia a la funcin sin invocarla realmente
(cosa que har la vista genrica luego).
9.3.3.
Mostrar subconjuntos de objetos
queryset que hemos venido usando hasta aqu. La mayora
queryset -- es la manera en que la vista conoce qu conjunto
Ahora echemos un vistazo ms de cerca a esta clave
de las vistas genricas usan uno de estos argumentos
de objetos mostrar (mira Seleccionando objetos en el Captulo 5 para una introduccin a los QuerySets, y mira el
Apndice C para los detalles completos).
Para tomar un ejemplo simple, tal vez querramos ordenar una lista de books por fecha de publicacin, con el ms
reciente primero.
book_info = {
"queryset" : Book.objects.all().order_by("-publication_date"),
}
urlpatterns = patterns('',
(r'^publishers/$', list_detail.object_list, publisher_info),
(r'^books/$', list_detail.object_list, book_info),
)
Este es un muy lindo y simple ejemplo, pero ilustra bien la idea. Por supuesto, t usualmente querrs hacer ms
que slo reordenar objetos. Si quieres presentar una lista de books de un publisher particular, puedes usar la misma
tcnica:
apress_books = {
"queryset": Book.objects.filter(publisher__name="Apress Publishing"),
"template_name" : "books/apress_list.html"
}
urlpatterns = patterns('',
(r'^publishers/$', list_detail.object_list, publisher_info),
(r'^books/apress/$', list_detail.object_list, apress_books),
)
Nota que adems de un
queryset
ltrado, tambin estamos usando un nombre de plantilla personalizado. Si no
lo hiciramos, la vista genrica usara la misma plantilla que la lista de objetos genrica
14 , que puede no ser lo que
queremos.
Tambin nota que sta no es una forma muy elegante de hacer publisher-speci c books. Si queremos agregar otra
pgina publisher, necesitamos otro puado de lneas en la URLconf, y ms de unos pocos publishers no ser razonable.
Enfrentaremos este problema en la siguiente seccin.
Nota
Si obtienes un error 404 cuando solicitas
/books/apress/,
para estar seguro, veri ca que en
realidad tienes un Publisher con el nombre 'Apress Publishing'. Las vistas genricas tienen un
parmetro
9.3.4.
allow_empty
para este caso. Mira el Apndice D para mayores detalles.
Filtrado complejo con funciones wrapper
Otra necesidad comn es ltrar los objetos que se muestran en una pgina listado por alguna clave en la URLconf.
15 el nombre del publisher en la URLconf, pero qu pasa si queremos escribir una vista
16 la vista genrica object_list
que muestre todos los books por algn publisher arbitrario?. Podemos encapsular
Anteriormente codi camos
para evitar escribir mucho cdigo a mano. Como siempre, empezamos escribiendo una URLconf.
revisin 757 del 28 de julio de 2008
110
CAPTULO 9. VISTAS GENRICAS
urlpatterns = patterns('',
(r'^publishers/$', list_detail.object_list, publisher_info),
(r'^books/(w+)/$', books_by_publisher),
)
A continuacin, escribiremos la vista
books_by_publisher:
from django.http import Http404
from django.views.generic import list_detail
from mysite.books.models import Book, Publisher
def books_by_publisher(request, name):
# Look up the publisher (and raise a 404 if it can't be found).
try:
publisher = Publisher.objects.get(name__iexact=name)
except Publisher.DoesNotExist:
raise Http404
# Use the object_list view for the heavy lifting.
return list_detail.object_list(
request,
queryset = Book.objects.filter(publisher=publisher),
template_name = "books/books_by_publisher.html",
template_object_name = "books",
extra_context = {"publisher" : publisher}
)
Esto funciona porque en realidad no hay nada en especial sobre las vistas genricas -- son slo funciones Python.
Como cualquier funcin de vista, las vistas genricas esperan un cierto conjunto de argumentos y retornan objetos
HttpResponse.
Por lo tanto, es increblemente fcil encapsular una pequea funcin sobre una vista genrica que
realiza trabajo adicional antes (o despus; mira la siguiente seccin) de pasarle el control a la vista genrica.
Nota
Nota que en el ejemplo anterior pasamos el publisher que se est mostrando actualmente en el
extra_context.
Esto es usualmente una buena idea en wrappers de esta naturaleza; le permite
a la plantilla saber qu objeto padre esta siendo navegado en ese momento.
9.3.5.
Realizar trabajo extra
El ltimo patrn comn que veremos involucra realizar algn trabajo extra antes o despus de llamar a la vista
genrica.
Imagina que tenemos un campo
last_accessed
Author que estuvimos usando para tener un
object_detail, por supuesto, no sabra nada
en nuestro objeto
registro de la ltima vez que alguien vio ese author. La vista genrica
sobre este campo, pero una vez ms fcilmente podramos escribir una vista personalizada para mantener ese campo
actualizado.
Primero, necesitamos agregar una pequea parte de detalle sobre el author en la URLconf para que apunte a una
vista personalizada:
from mysite.books.views import author_detail
urlpatterns = patterns('',
#...
(r'^authors/(?P<author_id>d+)/$', author_detail),
)
Luego escribiremos nuestra funcin wrapper:
import datetime
from mysite.books.models import Author
revisin 757 del 28 de julio de 2008
9.4. QU SIGUE?
111
from django.views.generic import list_detail
from django.shortcuts import get_object_or_404
def author_detail(request, author_id):
# Look up the Author (and raise a 404 if she's not found)
author = get_object_or_404(Author, pk=author_id)
# Record the last accessed date
author.last_accessed = datetime.datetime.now()
author.save()
# Show the detail page
return list_detail.object_detail(
request,
queryset = Author.objects.all(),
object_id = author_id,
)
Nota
Este cdigo en realidad no funcionar a menos que agregues un campo
modelo
Author
y agregues una plantilla
books/author_detail.html.
last_accessed
a tu
Podemos usar un mtodo similar para alterar la respuesta devuelta por la vista genrica. Si quisiramos proporcionar
una versin en texto plano
17 que se pueda descargar desde la lista de autores, podramos usar una vista como esta:
def author_list_plaintext(request):
response = list_detail.object_list(
request,
queryset = Author.objects.all(),
mimetype = "text/plain",
template_name = "books/author_list.txt"
)
response["Content-Disposition"] = "attachment; filename=authors.txt"
return response
HttpResponse que pueden ser tratados como
Content-Disposition, por otro lado, instruye al
Esto funciona porque la vista genrica devuelve simplemente objetos
diccionarios para establecer las cabeceras HTTP. Este arreglo de
navegador a descargar y guardar la pgina en vez de mostrarla en pantalla.
9.4.
Qu sigue?
En este captulo hemos examinado slo un par de las vistas genricas que incluye Django, pero las ideas generales
presentadas aqu deberan aplicarse a cualquier vista genrica. El Apndice D cubre todas las vistas disponibles en
detalle, y es de lectura obligada si quieres sacar el mayor provecho de esta caracterstica.
En el
`prximo captulo`_ ahondamos profundamente en el funcionamiento interno de las plantillas de Django,
mostrando todas las maneras geniales en que pueden ser extendidas. Hasta ahora, hemos tratado el sistema de plantillas
meramente como una herramienta esttica que puedes usar para renderizar tu contenido.
Duplicate explicit target name: prximo captulo.
11 N.
12 N.
13 N.
14 N.
15 N.
16 N.
17 N.
del T.: directory traversal vulnerability.
del T.: llamada a funcin.
del T.: en Python cualquier objeto que puede ser llamado como funcin.
del T.: vanilla object list.
del T.: hard-coded.
del T.: wrap.
del T.: en texto plano.
revisin 757 del 28 de julio de 2008
112
CAPTULO 9. VISTAS GENRICAS
revisin 757 del 28 de julio de 2008
Captulo 10
Extendiendo el sistema de plantillas
Aunque la mayor parte de tu interaccin con el sistema de plantillas (templates ) de Django ser en el rol de autor,
probablemente quieras algunas veces modi car y extender el sistema de plantillas -- as sea para agregar funcionalidad,
o para hacer tu trabajo ms fcil de alguna otra manera.
Este captulo se adentra en el sistema de plantillas de Django, cubriendo todo lo que necesitas saber, ya sea por si
planeas extender el sistema, o por si slo eres curioso acerca de su funcionamiento.
Si ests tratando de utilizar el sistema de plantillas de Django como parte de otra aplicacin, es decir, sin el resto
del framework, lee la seccin Con gurando el Sistema de plantillas en modo autnomo luego en este mismo captulo.
10.1.
Revisin del lenguaje de plantillas
Primero, vamos a recordar algunos trminos presentados en el Captulo 4:
Una plantilla es un documento de texto, o un string normal de Python marcado con la sintaxis especial
del lenguaje de plantillas de Django. Una plantilla puede contener etiquetas de bloque (block tags ) y
variables.
Una etiqueta de bloque es un smbolo dentro de una plantilla que hace algo. Esta de nicin es as
de vaga a propsito. Por ejemplo, una etiqueta de bloque puede producir contenido, servir como
estructura de control (una sentencia
if
for),
o un loop
obtener contenido de la base de datos, o
habilitar acceso a otras etiquetas de plantilla.
Las etiquetas de bloque deben ser rodeadas por
{%
y %}:
{ % if is_logged_in %}
Thanks for logging in!
{ % else %}
Please log in.
{ % endif %}
Una variable es un smbolo dentro de una plantilla que emite un valor.
Las etiquetas de variable deben ser rodeadas por
{{
}}:
My first name is {{ first_name }}. My last name is {{ last_name }}.
Un contexto es un mapa entre nombres y valores (similar a un diccionario de Python) que es pasado
a una plantilla.
Una plantilla renderiza un contexto reemplazando los huecos que dejan las variables por valores
tomados del contexto y ejecutando todas las etiquetes de bloque.
Para ms detalles acerca de estos trminos, referirse al Captulo 4.
El resto de este captulo discute las distintas maneras de extender el sistema de plantillas. Aunque primero, debemos
dar una mirada a algunos conceptos internos que quedaron fuera del Captulo 4 por simplicidad.
10.2.
Procesadores de contexto
Cuando una plantilla debe ser renderizada, necesita un contexto. Usualmente este contexto es una instancia de
django.template.Context,
pero Django tambin provee una subclase especial:
revisin 757 del 28 de julio de 2008
django.template.RequestContext
114
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
RequestContext agrega muchas variables al contexto de nuestra plantilla
HttpRequest o informacin acerca del usuario que est siendo usado actualmente.
RequestContext cuando no quieras especi car el mismo conjunto de variables una y otra vez en una serie de
que acta de una manera levemente diferente.
-- cosas como el objeto
Usa
plantillas. Por ejemplo, considera estas cuatro vistas:
from django.template import loader, Context
def view_1(request):
# ...
t = loader.get_template('template1.html')
c = Context({
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR'],
'message': 'I am view 1.'
})
return t.render(c)
def view_2(request):
# ...
t = loader.get_template('template2.html')
c = Context({
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR'],
'message': 'I am the second view.'
})
return t.render(c)
def view_3(request):
# ...
t = loader.get_template('template3.html')
c = Context({
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR'],
'message': 'I am the third view.'
})
return t.render(c)
def view_4(request):
# ...
t = loader.get_template('template4.html')
c = Context({
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR'],
'message': 'I am the fourth view.'
})
return t.render(c)
A propsito no hemos usado el atajo
render_to_response en estos ejemplos -- manualmente cargamos las planti-
llas, construimos el contexto y renderizamos las plantillas. Simplemente por claridad, estamos demostrando todos los
pasos necesarios.
Cada vista pasa las mismas tres variables --
app, user
ip_address
-- a su plantilla. No sera bueno poder
eliminar esa redundancia?
RequestContext
y los
procesadores de contexto fueron creado para resolver este problema. Los procesadores
de contexto te permiten especi car un nmero de variables que son incluidas automticamente en cada contexto -- sin
la necesidad de tener que hacerlo manualmente en cada llamada a
RequestContext
en lugar de
Context
render_to_response().
cuando renderizamos una plantilla.
revisin 757 del 28 de julio de 2008
El secreto est en utilizar
10.2. PROCESADORES DE CONTEXTO
115
La forma de nivel ms bajo de usar procesadores de contexto es crear algunos de ellos y pasarlos a
RequestContext.
A continuacin mostramos como el ejemplo anterior puede lograrse utilizando procesadores de contexto:
from django.template import loader, RequestContext
def custom_proc(request):
"A context processor that provides 'app', 'user' and 'ip_address'."
return {
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR']
}
def view_1(request):
# ...
t = loader.get_template('template1.html')
c = RequestContext(request, {'message': 'I am view 1.'},
processors=[custom_proc])
return t.render(c)
def view_2(request):
# ...
t = loader.get_template('template2.html')
c = RequestContext(request, {'message': 'I am the second view.'},
processors=[custom_proc])
return t.render(c)
def view_3(request):
# ...
t = loader.get_template('template3.html')
c = RequestContext(request, {'message': 'I am the third view.'},
processors=[custom_proc])
return t.render(c)
def view_4(request):
# ...
t = loader.get_template('template4.html')
c = RequestContext(request, {'message': 'I am the fourth view.'},
processors=[custom_proc])
return t.render(c)
Inspeccionemos paso a paso este cdigo:
Primero, de nimos una funcin
HttpRequest
custom_proc.
Este es un procesador de contexto -- toma un objeto
y devuelve un diccionario con variables a usar en contexto de la plantilla. Eso es todo
lo que hace.
Hemos cambiado las cuatro vistas para que usen
RequestContext en lugar de Context. Hay
RequestContext requiere que el
diferencias en cuanto a cmo el contexto es construido. Uno,
mer argumento sea una instancia de
(request). Dos,
RequestContext
HttpRequest
dos
pri-
-- la cual fue pasada a la vista en primer lugar
recibe un parmetro opcional
processors, el cual es una list o
custom_proc, nuestro
tupla de funciones procesadoras de contexto a utilizar. En este caso, pasamos
procesador de contexto de nido previamente.
Ya no es necesario en cada vista incluir
app, user o ip_address
custom_proc.
cuando construimos el contexto, ya
que ahora estas variables son provistas por
Cada vista an posee la exibilidad como para introducir una o ms variables en el contexto de la
plantilla si es necesario. En este ejemplo, la variable de plantilla
message es creada de manera diferente
en cada una de las vistas.
En el Captulo 4, presentamos el atajo
luego crear un
Context
render_to_response(), el cual nos ahorra tener que llamar a loader.get_template
render() en la plantilla. Para demostrar el funcionamiento a
y ademas, llamar al mtodo
revisin 757 del 28 de julio de 2008
116
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
render_to_response(),
render_to_response(). Esto lo logramos
bajo nivel de los procesadores de contexto, en los ejemplos anteriores no hemos utilizado
pero es posible -- y preferible -- utilizar los procesadores de contexto junto a
mediante el argumento
context_instance
de la siguiente manera:
from django.shortcuts import render_to_response
from django.template import RequestContext
def custom_proc(request):
"A context processor that provides 'app', 'user' and 'ip_address'."
return {
'app': 'My app',
'user': request.user,
'ip_address': request.META['REMOTE_ADDR']
}
def view_1(request):
# ...
return render_to_response('template1.html',
{'message': 'I am view 1.'},
context_instance=RequestContext(request, processors=[custom_proc]))
def view_2(request):
# ...
return render_to_response('template2.html',
{'message': 'I am the second view.'},
context_instance=RequestContext(request, processors=[custom_proc]))
def view_3(request):
# ...
return render_to_response('template3.html',
{'message': 'I am the third view.'},
context_instance=RequestContext(request, processors=[custom_proc]))
def view_4(request):
# ...
return render_to_response('template4.html',
{'message': 'I am the fourth view.'},
context_instance=RequestContext(request, processors=[custom_proc]))
Aqu, hemos logrado reducir el cdigo para renderizar las plantillas en cada vista a una sola lnea.
Esto es una mejora, pero, evaluando la concisin de este cdigo, debemos admitir que hemos logrado reducir la
redundancia en los datos (nuestras variables de plantilla), pero aun as, estamos especi cando una y otra vez nuestro
contexto. Es decir, hasta ahora usar procesadores de contexto no nos ahorra mucho cdigo si tenemos que escribir
processors
constantemente.
Por esta razn, Django admite el uso de procesadores de contexto globales. El parmetro de con guracin
designa cuales sern los procesadores de contexto que debern ser aplicados siempre a
processors cada vez que utilizamos RequestContext.
TEMPLATE_CONTEXT_PROCESSORS tiene, por omisin, el siguiente valor:
RequestContext.
TEMPLATE_CONTEXT_PROC
Esto elimina
la necesidad de especi car
TEMPLATE_CONTEXT_PROCESSORS = (
'django.core.context_processors.auth',
'django.core.context_processors.debug',
'django.core.context_processors.i18n',
'django.core.context_processors.media',
)
Este parmetro de con guracin es una tupla de funciones que utilizan la misma interfaz que nuestra funcin
custom_proc
utilizada previamente -- funciones que toman un objeto
HttpRequest
como primer argumento, y de-
vuelven un diccionario de items que sern incluidos en el contexto de la plantilla. Ten en cuenta que los valores en
TEMPLATE_CONTEXT_PROCESSORS son especi cados como strings, lo cual signi ca que estos procesadores debern
en algn lugar dentro de tu PYTHONPATH (para poder referirse a ellos desde el archivo de con guracin)
revisin 757 del 28 de julio de 2008
estar
10.2. PROCESADORES DE CONTEXTO
117
Estos procesadores de contexto son aplicados en orden, es decir, si uno de estos procesadores aade una variable
al contexto y un segundo procesador aade otra variable con el mismo nombre, entonces la segunda sobre-escribir a
la primera.
Django provee un numero de procesadores de contexto simples, entre ellos los que estn activos por defecto.
10.2.1.
Si
django.core.context_processors.auth
TEMPLATE_CONTEXT_PROCESSORS contiene este procesador, cada RequestContext contendr las siguientes varia-
bles:
user:
Una instancia de
django.contrib.auth.models.User representando al usuario
AnonymousUser si el cliente no se ha autenticado an).
actualmente
autenticado (o una instancia de
messages:
Una lista de mensajes (como string ) para el usuario actualmente autenticado. Detrs del
teln, esta variable llama a
request.user.get_and_delete_messages() para cada request. Este m-
todo colecta los mensajes del usuario, y luego los borra de la base de datos.
perms: Instancia de django.core.context_processors.PermWrapper, la cual representa los permisos
que posee el usuario actualmente autenticado.
En el Captulo 12 encontrars ms informacin acerca de usuarios, permisos y mensajes.
10.2.2.
django.core.context_processors.debug
Este procesador aade informacin de depuracin a la capa de plantillas. Si
tiene este procesador, cada
debug:
RequestContext
TEMPLATE_CONTEXT_PROCESSORS
con-
contendr las siguientes variables:
False).
Esta variable puede usarse en
{'sql': ..., 'time': ...}
representando todas las con-
El valor del parmetro de con guracin
DEBUG (True
las plantillas para saber si ests en modo de depuracin o no.
sql_queries:
Una lista de diccionarios
sultas SQL que se generaron durante la peticin (request ) y cunto duraron. La lista est ordenada
respecto a cundo fue ejecutada cada consulta.
Como la informacin de depuracin es sensible, este procesador de contexto slo agregar las variables al contexto
si las dos siguientes condiciones son verdaderas.
El parmetro de con guracin
DEBUG
es True
La solicitud (request ) viene de una direccin IP listada en el parmetro de con guracin
10.2.3.
INTERNAL_IPS.
django.core.context_processors.i18n
Si este procesador est habilitado, cada
LANGUAGES:
RequestContext
contendr las siguientes variables:
El valor del parmetro de con guracin
LANGUAGE_CODE: request.LANGUAGE_CODE
LANGUAGE_CODE.
LANGUAGES.
si existe; de lo contrario, el valor del parmetro de con -
guracin
En el Apndice E se especi ca ms informacin sobre estos parmetros.
10.2.4.
django.core.context_processors.request
Si este procesador est habilitado, cada
objeto
HttpRequest.
10.2.5.
RequestContext
contendr una variable
request,
la cual es el actual
Este procesador no est habilitado por defecto.
Consideraciones para escribir tus propios procesadores de contexto
Algunos puntos a tener en cuenta:
Cada procesador de contexto debe ser responsable por la mnima cantidad de funcionalidad posible.
Usar muchos procesadores es algo sencillo, es por eso que dividir la funcionalidad de tu procesador de
manera lgica puede ser til para poder reutilizarlos en el futuro.
revisin 757 del 28 de julio de 2008
118
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
Ten presente que cualquier procesador de contexto en
TEMPLATE_CONTEXT_PROCESSORS
estar dispo-
nible en cada plantilla cuya con guracin est dictada por ese archivo de con guracin, as que trata
de seleccionar nombres de variables con pocas probabilidades de entrar en con icto con nombre de
variables que tus plantillas pudieran usar en forma independiente. Como los nombres de variables son
sensibles a maysculas/minsculas no es una mala idea usar maysculas para las variables provistas
por un procesador.
No importa dnde residan en el sistema de archivos, mientras se hallen en tu ruta de Python de manera
que puedas incluirlos en tu variable de con guracin
TEMPLATE_CONTEXT_PROCESSORS. Habiendo dicho
context_processors.py
eso, diremos tambin que la convencin es grabarlos en un archivo llamado
ubicado en tu aplicacin o en tu proyecto.
10.3.
Detalles internos de la carga de plantillas
En general las plantillas se almacenan en archivos en el sistema de archivos, pero puedes usar cargadores de plantillas
personalizados (custom ) para cargar plantillas desde otros orgenes.
Django tiene dos maneras de cargar plantillas:
django.template.loader.get_template(template): get_template retorna
(un objeto Template) para la plantilla con el nombre provisto. Si la plantilla
una excepcin TemplateDoesNotExist.
la plantilla compilada
no existe, se generar
django.template.loader.select_template(template_name_list): select_template es similar a
get-template, excepto que recibe una lista de nombres de plantillas. Retorna la primera plantilla de
dicha lista que existe. Si ninguna de las plantillas existe se lanzar una excepcin TemplateDoesNotExist.
Como se vio en el Captulo 4, cada una de esas funciones usan por omisin el valor de tu variable de con guracin
TEMPLATE_DIRS para cargar las plantillas. Sin embargo, internamente las mismas delegan la tarea pesada a un cargador
de plantillas.
Algunos de los cargadores estn, por omisin, desactivados pero puedes activarlos editando la variable de con guracin
TEMPLATE_LOADERS. TEMPLATE_LOADERS
debe ser una tupla de cadenas, donde cada cadena representa un
cargador de plantillas. Estos son los cargadores de plantillas incluidos con Django:
django.template.loaders.filesystem.load_template_source: Este cargador carga plantillas desde el sistema de archivos, de acuerdo a TEMPLATE_DIRS. Por omisin est activo.
django.template.loaders.app_directories.load_template_source:
Este cargador carga planti-
llas desde aplicaciones Django en el sistema de archivos. Para cada aplicacin en
cargador busca un sub-directorio
templates.
INSTALLED_APPS,
el
Si el directorio existe, Django buscar una plantilla en
el mismo.
Esto signi ca que puedes almacenar plantillas en tus aplicaciones individuales, facilitando la distri-
INSTALLED_APPS contiene
get_template('foo.html') buscar planti-
bucin de aplicaciones Django con plantillas por omisin. Por ejemplo si
('myproject.polls', 'myproject.music')
entonces
llas en el siguiente orden:
/path/to/myproject/polls/templates/foo.html
/path/to/myproject/music/templates/foo.html
Notar que el cargador realiza una optimizacin cuando es importado por primera vez: hace caching
de una lista de cuales de los paquetes en
INSTALLED_APPS
tienen un sub-directorio
templates.
Por omisin este cargador est activo.
django.template.loaders.eggs.load_template_source: Este cargador es bsicamente idntico a
app_directories, excepto que carga las plantillas desde eggs Python en lugar de hacerlo desde el
sistema de archivos. Por omisin este cargador est desactivado; necesitars activarlo si ests usando
eggs para distribuir tu aplicacin.
Django usa los cargadores de plantillas en el orden en el que aparecen en la variable de con guracin
TEMPLATE_DIRS.
Usar cada uno de los cargadores hasta que uno de los mismos tenga xito en la bsqueda de la plantilla.
revisin 757 del 28 de julio de 2008
10.4. EXTENDIENDO EL SISTEMA DE PLANTILLAS
10.4.
119
Extendiendo el sistema de plantillas
Ahora que entiendes un poco ms acerca del funcionamiento interno del sistema de plantillas, echemos una mirada
a cmo extender el sistema con cdigo propio.
La mayor parte de la personalizacin de plantillas se da en forma de etiquetas y/o ltros. Aunque el lenguaje de
plantillas de Django incluye muchos, probablemente ensamblars tus propias bibliotecas de etiquetas y ltros que se
adapten a tus propias necesidades. Afortunadamente, es muy fcil de nir tu propia funcionalidad.
10.4.1.
Creando una biblioteca para plantillas
Ya sea que ests escribiendo etiquetas o ltros personalizados, la primera tarea a realizar es crear una
biblioteca
para plantillas -- un pequeo fragmento de infraestructura con el cual Django puede interactuar.
La creacin de una biblioteca para plantillas es un proceso de dos pasos:
Primero, decidir qu aplicacin Django alojar la biblioteca. Si has creado una aplicacin va
startapp
manage.py
puedes colocarla all, o puedes crear otra aplicacin con el solo n de alojar la biblioteca.
Sin importar cual de las dos rutas tomes, asegrate de agregar la aplicacin a tu variable de con guracin
INSTALLED_APPS.
Explicaremos esto un poco ms adelante.
Segundo, crear un directorio
templatetags en el paquete de aplicacin
models.py, views.py, etc. Por ejemplo:
Django apropiado. Debe
encontrarse en el mismo nivel que
books/
__init__.py
models.py
templatetags/
views.py
Crea dos archivos vacos en el directorio
templatetags:
un archivo
__init__.py
(para indicarle a
Python que se trata de un paquete que contiene cdigo Python) y un archivo que contendr tus
de niciones personalizadas de etiquetas/ ltros. El nombre del segundo archivo es el que usars para
cargar las etiquetas ms tarde. Por ejemplo, si tus etiquetas/ ltros personalizadas estn en un archivo
llamado
poll_extras.py,
entonces debers escribir lo siguiente en una plantilla:
{ % load poll_extras %}
La etiqueta
{ % load %}
examina tu variable de con guracin
INSTALLED_APPS
y slo permite la
carga de bibliotecas para plantillas desde aplicaciones Django que estn instaladas. Se trata de una
caracterstica de seguridad; te permite tener en cierto equipo el cdigo Python de varias bibliotecas
para plantillas sin tener que activar el acceso a todas ellas para cada instalacin de Django.
Si escribes una biblioteca para plantillas que no se encuentra atada a ningn modelo/vista particular es vlido y
normal el tener un paquete de aplicacin Django que slo contiene un paquete
lo referente a cuntos mdulos puedes poner en el paquete
load %}
templatetags.
templatetags.
No existen lmites en
Slo ten presente que una sentencia
{%
cargar etiquetas/ ltros para el nombre del mdulo Python provisto, no el nombre de la aplicacin.
Una vez que has creado ese mdulo Python, slo tendrs que escribir un poquito de cdigo Python, dependiendo
de si ests escribiendo ltros o etiquetas.
Para ser una biblioteca de etiquetas vlida, el mdulo debe contener una variable a nivel del mdulo llamada
register que sea una instancia de template.Library. Esta instancia de template.Library es la estructura de datos
en la cual son registradas todas las etiquetas y ltros. As que inserta en la zona superior de tu mdulo, lo siguiente:
from django import template
register = template.Library()
Nota
Para ver un buen nmero de ejemplos, examina el cdigo fuente de los ltros y etique-
django/template/defaultfilters.py
django/template/defaulttags.py, respectivamente. Algunas aplicaciones en
django.contrib tambin contienen bibliotecas para plantillas.
tas incluidos con Django. Puedes encontrarlos en
Una vez que hayas creado esta variable
register,
usars la misma para crear ltros y etiquetas para plantillas.
revisin 757 del 28 de julio de 2008
120
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
10.4.2.
Escribiendo ltros de plantilla personalizados
Los ltros personalizados son slo funciones Python que reciben uno o dos argumentos:
El valor de la variable (entrada)
El valor del argumento, el cual puede tener un valor por omisin o puede ser obviado.
Por ejemplo, en el ltro
"bar".
{{ var|foo:"bar" }} el ltro foo recibira el contenido de la variable var y el argumento
Las funciones ltro deben siempre retornar algo. No deben arrojar excepciones, y deben fallar silenciosamente.
Si existe un error, las mismas deben retornar la entrada original o una cadena vaca, dependiendo de qu sea ms
apropiado.
Esta es un ejemplo de de nicin de un ltro:
def cut(value, arg):
"Removes all values of arg from the given string"
return value.replace(arg, '')
Y este es un ejemplo de cmo se usara:
{{ somevariable|cut:"0" }}
La mayora de los ltros no reciben argumentos. En ese caso, basta con que no incluyas el argumento en tu funcin:
def lower(value): # Only one argument.
"Converts a string into all lowercase"
return value.lower()
Una vez que has escrito tu de nicin de ltro, necesitas registrarlo en tu instancia de
Library,
para que est
disponible para el lenguaje de plantillas de Django:
register.filter('cut', cut)
register.filter('lower', lower)
El mtodo
Library.filter()
tiene dos argumentos:
El nombre del ltro (una cadena)
La funcin ltro propiamente dicha
Si ests usando Python 2.4 o ms reciente, puedes usar
register.filter()
como un decorador:
@register.filter(name='cut')
def cut(value, arg):
return value.replace(arg, '')
@register.filter
def lower(value):
return value.lower()
Si no provees el argumento
name, como en el segundo ejemplo, Django usar el nombre de la funcin como nombre
del ltro.
Veamos entonces el ejemplo completo de una biblioteca para plantillas, que provee el ltro
from django import template
register = template.Library()
@register.filter(name='cut')
def cut(value, arg):
return value.replace(arg, '')
revisin 757 del 28 de julio de 2008
cut:
10.4. EXTENDIENDO EL SISTEMA DE PLANTILLAS
10.4.3.
121
Escribiendo etiquetas de plantilla personalizadas
Las etiquetas son ms complejas que los ltros porque las etiquetas pueden implementar prcticamente cualquier
funcionalidad.
El Captulo 4 describe cmo el sistema de plantillas funciona como un proceso de dos etapas: compilacin y
renderizado. Para de nir una etiqueta de plantilla personalizada, necesitas indicarle a Django cmo manejar ambas
etapas cuando llega a tu etiqueta.
Cuando Django compila una plantilla, divide el texto crudo de la plantilla en nodos. Cada nodo es una instancia
django.template.Node y tiene un
lista de objetos Node.
Cuando llamas a render() en una
de
mtodo
render().
Por lo tanto, una plantilla compilada es simplemente una
render()
plantilla compilada, la plantilla llama a
en cada
Node()
de su lista
de nodos, con el contexto proporcionado. Los resultados son todos concatenados juntos para formar la salida de la
plantilla. Por ende, para de nir una etiqueta de plantilla personalizada debes especi car cmo se debe convertir la
etiqueta en crudo en un
Node
(la funcin de compilacin) y qu hace el mtodo
render()
del nodo.
En las secciones que siguen, explicaremos todos los pasos necesarios para escribir una etiqueta propia.
Escribiendo la funcin de compilacin
Para cada etiqueta de plantilla que encuentra, el intrprete (parser ) de plantillas llama a una funcin de Python
pasndole el contenido de la etiqueta y el objeto parser en s mismo. Esta funcin tiene la responsabilidad de retornar
una instancia de
Node
basada en el contenido de la etiqueta.
Por ejemplo, escribamos una etiqueta
{ % current_time %} que visualice la fecha/hora actuales con un formato destrftime (ver http://www.djangoproject.com/r/pyt
terminado por un parmetro pasado a la etiqueta, usando la sintaxis de
Es una buena idea de nir la sintaxis de la etiqueta previamente. En nuestro caso, supongamos que la etiqueta deber
ser usada de la siguiente manera:
<p>The time is { % current_time " %Y- %m- %d %I: %M %p" %}.</p>
Nota
Si, esta etiqueta de plantilla es redundante -- La etiqueta
{ % now %}
incluida en Django por
defecto hace exactamente lo mismo con una sintaxis ms simple. Slo mostramos esta etiqueta a
modo de ejemplo.
Para evaluar esta funcin, se deber obtener el parmetro y crear el objeto
Node:
from django import template
def do_current_time(parser, token):
try:
# split_contents() knows not to split quoted strings.
tag_name, format_string = token.split_contents()
except ValueError:
msg = ' %r tag requires a single argument' % token.split_contents()[0]
raise template.TemplateSyntaxError(msg)
return CurrentTimeNode(format_string[1:-1])
Hay muchas cosas en juego aqu:
parser es la instancia del parser. No lo necesitamos en este ejemplo.
token.contents es un string con los contenidos crudos de la etiqueta, en nuestro ejemplo sera:
'current_time " %Y- %m- %d %I: %M %p"'.
El mtodo token.split_contents() separa los argumentos en sus espacios, mientras deja unidas a
los strings. Evite utilizar token.contentes.split() (el cual usa la semntica natural de Python para
dividir strings, y por esto no es tan robusto, ya que divide en todos los espacios, incluyendo aquellos
dentro de cadenas entre comillas.
Esta funcin es la responsable de generar la excepcin
django.template.TemplateSyntaxError
con
mensajes tiles, ante cualquier caso de error de sintaxis.
No escribas el nombre de la etiqueta en el mensaje de error, ya que eso acoplara innecesariamente el
nombre de la etiqueta a la funcin. En cambio,
token.split_contents()[0]
nombre de tu etiqueta -- an cuando la etiqueta no lleve argumentos.
revisin 757 del 28 de julio de 2008
siempre contendr el
122
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
CurrentTimeNode (el cual mostraremos en un momento) conteniendo todo lo que
" %Y- %m- %d %I: %M %p".
Las comillas son removidas con format_string[1:-1].
Las funciones de compilacin de etiquetas de plantilla deben devolver una subclase de Nodo; cualquier
La funcin devuelve
el nodo necesita saber sobre esta etiqueta. En este caso, slo pasa el argumento
otro valor es un error.
Escribiendo el nodo de plantilla
El segundo paso para escribir etiquetas propias, es de nir una subclase de
Continuando con el ejemplo previo, debemos de nir
CurrentTimeNode:
Node
que posea un mtodo
render().
import datetime
class CurrentTimeNode(template.Node):
def __init__(self, format_string):
self.format_string = format_string
def render(self, context):
now = datetime.datetime.now()
return now.strftime(self.format_string)
Estas dos funciones (__init__ y
render) se relacionan directamente con los dos pasos para el proceso de la plantilla
(compilacin y renderizado). La funcin de inicializacin slo necesitar almacenar el string con el formato deseado,
el trabajo real sucede dentro de la funcin
render()
Del mismo modo que los ltros de plantilla, estas funciones de renderizacin deberan fallar silenciosamente en
lugar de generar errores. En el nico momento en el cual se le es permitido a las etiquetas de plantilla generar errores
es en tiempo de compilacin.
Registrando la etiqueta
Finalmente, debers registrar la etiqueta con tu objeto
Library
dentro del mdulo. Registrar nuevas etique-
tas es muy similar a registrar nuevos ltros (como explicamos previamente). Slo debers instanciar un objeto
template.Library
y llamar a su mtodo
tag().
Por ejemplo:
register.tag('current_time', do_current_time)
El mtodo
tag()
toma dos argumentos:
El nombre de la etiqueta de plantilla (string ). Si esto se omite, se utilizar el nombre de la funcin de
compilacin.
La funcin de compilacin.
De manera similar a como sucede con el registro de ltros, tambin es posible utilizar
register.tag
como un
decorador en Python 2.4 o posterior:
@register.tag(name="current_time")
def do_current_time(parser, token):
# ...
@register.tag
def shout(parser, token):
# ...
Si omitimos el argumento
name, as como en el segundo ejemplo, Django usar el nombre de la funcin como nombre
de la etiqueta.
De niendo una variable en el contexto
El ejemplo en la seccin anterior simplemente devuelve un valor. Muchas veces es til de nir variables de plantilla
en vez de simplemente devolver valores. De esta manera, los autores de plantillas podrn directamente utilizar las
variables que esta etiqueta de na.
revisin 757 del 28 de julio de 2008
10.4. EXTENDIENDO EL SISTEMA DE PLANTILLAS
Para de nir una variable en el contexto, asignaremos a nuestro objeto
123
context
que de ne una variable de plantilla,
current_time,
render()
CurrentTimeNode
disponible en el mtodo
nuestras variables, como si de un diccionario se tratase. Aqu mostramos la versin actualizada de
en lugar de devolverla:
class CurrentTimeNode2(template.Node):
def __init__(self, format_string):
self.format_string = format_string
def render(self, context):
now = datetime.datetime.now()
context['current_time'] = now.strftime(self.format_string)
return ''
render() siempre debe devolver un string.
render() debe al menos devolver un string vaco.
Devolvemos un string vaco, debido a que
etiqueta hace es de nir una variable,
Entonces, si todo lo que la
De esta manera usaramos esta nueva versin de nuestra etiqueta:
{ % current_time2 " %Y- %M- %d %I: %M %p" %}
<p>The time is {{ current_time }}.</p>
Pero hay un problema con
CurrentTimeNode2:
cdigo. Esto signi ca que tendrs que asegurar que
plantilla, ya que
{ % current_time %}
el nombre de la variable
{{ current_time }}
current_node
est de nido dentro del
no sea utilizado en otro lugar dentro de la
sobreescribir el valor de esa otra variable.
Una solucin ms limpia, es poder recibir el nombre de la variable en la etiqueta de plantilla as:
{ % get_current_time " %Y- %M- %d %I: %M %p" as my_current_time %}
<p>The current time is {{ my_current_time }}.</p>
Para hacer esto, necesitaremos modi car tanto la funcin de compilacin como la clase
import re
class CurrentTimeNode3(template.Node):
def __init__(self, format_string, var_name):
self.format_string = format_string
self.var_name = var_name
def render(self, context):
now = datetime.datetime.now()
context[self.var_name] = now.strftime(self.format_string)
return ''
def do_current_time(parser, token):
# This version uses a regular expression to parse tag contents.
try:
# Splitting by None == splitting by spaces.
tag_name, arg = token.contents.split(None, 1)
except ValueError:
msg = ' %r tag requires arguments' % token.contents[0]
raise template.TemplateSyntaxError(msg)
m = re.search(r'(.*?) as (\w+)', arg)
if m:
fmt, var_name = m.groups()
else:
msg = ' %r tag had invalid arguments' % tag_name
raise template.TemplateSyntaxError(msg)
if not (fmt[0] == fmt[-1] and fmt[0] in ('"', "'")):
revisin 757 del 28 de julio de 2008
Node
de esta manera:
124
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
msg = " %r tag's argument should be in quotes" % tag_name
raise template.TemplateSyntaxError(msg)
return CurrentTimeNode3(fmt[1:-1], var_name)
Ahora,
do_current_time()
pasa el string de formato junto al nombre de la variable a
CurrentTimeNode3.
Evaluando hasta otra etiqueta de bloque
Las etiquetas de plantilla pueden funcionar como bloques que contienen otras etiquetas (piensa en
for %},
parser.parse() en tu funcin
estndar { % coment %}:
etc.). Para crear una etiqueta como esta, usa
Aqu vemos como est implementada la etiqueta
{ % if %}, { %
de compilacin.
def do_comment(parser, token):
nodelist = parser.parse(('endcomment',))
parser.delete_first_token()
return CommentNode()
class CommentNode(template.Node):
def render(self, context):
return ''
parser.parse() toma una tupla
django.template.NodeList, la cual
de nombres de etiquetas de bloque para evaluar y devuelve una instancia de
es una lista de todos los objetos
Nodo
que el parser encontr antes de haber
encontrado alguna de las etiquetas nombradas en la tupla.
nodelist es una lista con todos los nodos entre { % comment %} y { % endcomment %},
{ % comment %} y { % endcomment %}.
parser.parse() es llamado el parser an no ha consumido la etiqueta { % endcomment %}, es
cdigo se necesita llamar explcitamente a parser.delete_first_token() para prevenir que esta
Entonces, en el ejemplo previo,
excluyendo a los mismos
Luego de que
por eso que en el
etiqueta sea procesada nuevamente.
Luego, CommentNode.render()
endcomment %} es ignorada.
simplemente devuelve un string vaco. Cualquier cosa entre
{ % comment %}
{%
Evaluando hasta otra etiqueta de bloque y guardando el contenido
En el ejemplo anterior,
do_comment()
desech todo entre
posible hacer algo con el cdigo entre estas etiquetas.
Por ejemplo, presentamos una etiqueta de plantilla,
etiqueta
{ % endupper %}:
{ % comment %}
{ % upper %},
{ % endcomment %},
pero tambin es
que convertir a maysculas todo hasta la
{ % upper %}
This will appear in uppercase, {{ your_name }}.
{ % endupper %}
Como en el ejemplo previo, utilizaremos
parser.parse() pero esta vez pasamos el resultado en nodelist a Node:
@register.tag
def do_upper(parser, token):
nodelist = parser.parse(('endupper',))
parser.delete_first_token()
return UpperNode(nodelist)
class UpperNode(template.Node):
def __init__(self, nodelist):
self.nodelist = nodelist
def render(self, context):
output = self.nodelist.render(context)
return output.upper()
revisin 757 del 28 de julio de 2008
10.4. EXTENDIENDO EL SISTEMA DE PLANTILLAS
125
self.nodelist.render(context)
Node en la lista de nodos.
El nico concepto nuevo aqu es
mente llama a
render()
en cada
en
UpperNode.render().
El mismo simple-
{ % if %}, { % for %}, { %
django/template/defaulttags.py.
Para ms ejemplos de renderizado complejo, examina el cdigo fuente para las etiquetas
ifequal %}
{ % ifchanged %}.
10.4.4.
Un atajo para etiquetas simples
Puedes encontrarlas en
Muchas etiquetas de plantilla reciben un nico argumento--una cadena o una referencia a una variable de plantilla-y retornan una cadena luego de hacer algn procesamiento basado solamente en el argumento de entrada e informacin
externa. Por ejemplo la etiqueta
current_time que escribimos antes es de este tipo. Le pasamos una cadena de formato,
y retorna la hora como una cadena.
Para facilitar la creacin de esos tipos de etiquetas, Django provee una funcin auxiliar:
que es un mtodo de
funcin
render
django.template.Library,
simple_tag. Esta funcin,
recibe un funcin que acepta un argumento, lo encapsula en una
y el resto de las piezas necesarias que mencionamos previamente y lo registra con el sistema de
plantillas.
Nuestra funcin
current_time
podra entonces ser escrita de la siguiente manera:
def current_time(format_string):
return datetime.datetime.now().strftime(format_string)
register.simple_tag(current_time)
En Python 2.4 la sintaxis de decorador tambin funciona:
@register.simple_tag
def current_time(token):
...
Un par de cosas a tener en cuenta acerca de la funcin auxiliar
simple_tag:
Slo se pasa un argumento a nuestra funcin.
La veri cacin de la cantidad de requerida de argumentos ya ha sido realizada para el momento en el
que nuestra funcin es llamada, de manera que no es necesario que lo hagamos nosotros.
Las comillas alrededor del argumento (si existieran) ya han sido quitadas, de manera que recibimos
una cadena comn.
10.4.5.
Etiquetas de inclusin
Otro tipo de etiquetas de plantilla comn es aquel que visualiza ciertos datos renderizando otra plantilla. Por
ejemplo la interfaz de administracin de Django usa etiquetas de plantillas personalizadas (custom ) para visualizar los
botones en la parte inferior de la pginas de formularios agregar/cambiar. Dichos botones siempre se ven igual, pero
el destino del enlace cambia dependiendo del objeto que se est modi cando. Se trata de un caso perfecto para el uso
de una pequea plantilla que es llenada con detalles del objeto actual.
Ese tipo de etiquetas reciben el nombre de etiquetas de inclusin. Es probablemente mejor demostrar cmo escribir
una usando un ejemplo. Escribamos una etiqueta que produzca una lista de opciones para un simple objeto
Poll
con
mltiples opciones. Usaremos una etiqueta como esta:
{ % show_results poll %}
El resultado ser algo como esto:
<ul>
<li>First choice</li>
<li>Second choice</li>
<li>Third choice</li>
</ul>
Primero de nimos la funcin que toma el argumento y produce un diccionario de datos con los resultados. Nota
que nos basta un diccionario y no necesitamos retornar nada ms complejo. Esto ser usado como el contexto para el
fragmento de plantilla:
revisin 757 del 28 de julio de 2008
126
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
def show_books_for_author(author):
books = author.book_set.all()
return {'books': books}
Luego creamos la plantilla usada para renderizar la salida de la etiqueta. Siguiendo con nuestro ejemplo, la plantilla
es muy simple:
<ul>
{ % for book in books %}
<li> {{ book }} </li>
{ % endfor %}
</ul>
Finalmente creamos y registramos la etiqueta de inclusin invocando el mtodo
Library.
inclusion_tag() sobre un objeto
Continuando con nuestro ejemplo, si la plantilla se encuentra en un archivo llamado
polls/result_snippet.html,
registraremos la plantilla de la siguiente manera:
register.inclusion_tag('books/books_for_author.html')(show_books_for_author)
Como siempre, la sintaxis de decoradores de Python 2.4 tambin funciona, de manera que en cambio podramos
haber escrito:
@register.inclusion_tag('books/books_for_author.html')
def show_books_for_author(show_books_for_author):
...
A veces tus etiquetas de inclusin necesitan tener acceso a valores del contexto de la plantilla padre. Para resolver
esto Django provee una opcin
takes_context
para las etiquetas de inclusin. Si especi cas
takes_context
cuando
creas una etiqueta de plantilla, la misma no tendr argumentos obligatorios y la funcin Python subyacente tendr un
argumento: el contexto de la plantilla en el estado en el que se encontraba cuando la etiqueta fue invocada.
Por ejemplo supongamos que ests escribiendo una etiqueta de inclusin que ser siempre usada en un contexto
que contiene variables
home_link
home_title
que apuntan a la pgina principal. As es como se vera la funcin
Python:
@register.inclusion_tag('link.html', takes_context=True)
def jump_link(context):
return {
'link': context['home_link'],
'title': context['home_title'],
}
Nota
El primer parmetro de la funcin debe llamarse
La plantilla
link.html
context.
podra contener lo siguiente:
Jump directly to <a href="{{ link }}">{{ title }}</a>.
Entonces, cada vez que desees usar esa etiqueta personalizada, carga su biblioteca y ejectala sin argumentos, de
la siguiente manera:
{ % jump_link %}
10.5.
Escribiendo cargadores de plantillas personalizados
Los cargadores de plantillas incluidos con Django (descriptos en la seccin Etiquetas de inclusin ms arriba)
cubrirn usualmente todas tus necesidades de carga de plantillas, pero es muy sencillo escribir el tuyo propio si necesitas
alguna lgica especial en dicha carga. Por ejemplo podras cargar plantillas desde una base de datos, o directamente
desde un repositorio Subversion usando las libreras (bindings ) Python de Subversion, o (como veremos) desde un
archivo ZIP.
Un cargador de plantillas --esto es, cada entrada en la variables de con guracin
objeto invocable (callable ) con la siguiente interfaz:
revisin 757 del 28 de julio de 2008
TEMPLATE_LOADERS--
debe ser un
10.6. USANDO LA REFERENCIA DE PLANTILLAS INCORPORADAS
127
load_template_source(template_name, template_dirs=None)
El argumento template_name es el nombre de la plantilla a cargar (tal como fue pasado a loader.get_template()
loader.select_template()) y template_dirs es una lista opcional de directorios en los que se buscar en lugar
de TEMPLATE_DIRS.
Si un cargador es capaz de cargar en forma exitosa una plantilla, debe retornar una tupla: (template_source,
template_path). Donde template_source es la cadena de plantilla que ser compilada por la maquinaria de plantillas,
y template_path es la ruta desde la cual fue cargada la plantilla. Dicha ruta podra ser presentada al usuario para
o
nes de depuracin as que debe identi car en forma rpida desde dnde fue cargada la plantilla.
Si al cargador no le es posible cargar una plantilla, debe lanzar
django.template.TemplateDoesNotExist.
is_usable. Este es un Booleano que
Cada funcin del cargador debe tambin poseer un atributo de funcin
le
informa a la maquinaria de plantillas si este cargador est disponible en la instalacin de Python actual. Por ejemplo
el cargador desde eggs (que es capaz de cargar plantillas desde eggs Python) ja
pkg_resources
no se encuentra instalado, porque
pkg_resources
is_usable
False
si el mdulo
es necesario para leer datos desde eggs.
Un ejemplo ayudar a clari car todo esto. Aqu tenemos una funcin cargadora de plantillas que puede cargar
TEMPLATE_ZIP_FILES como una ruta
TEMPLATE_DIRS y espera que cada tem en dicha ruta sea un archivo ZIP contiendo plantillas:
plantillas desde un archivo ZIP. Usa una variable de con guracin personalizada
de bsqueda en lugar de
import zipfile
from django.conf import settings
from django.template import TemplateDoesNotExist
def load_template_source(template_name, template_dirs=None):
"""Template loader that loads templates from a ZIP file."""
template_zipfiles = getattr(settings, "TEMPLATE_ZIP_FILES", [])
# Try each ZIP file in TEMPLATE_ZIP_FILES.
for fname in template_zipfiles:
try:
z = zipfile.ZipFile(fname)
source = z.read(template_name)
except (IOError, KeyError):
continue
z.close()
# We found a template, so return the source.
template_path = " %s: %s" % (fname, template_name)
return (source, template_path)
# If we reach here, the template couldn't be loaded
raise TemplateDoesNotExist(template_name)
# This loader is always usable (since zipfile is included with Python)
load_template_source.is_usable = True
TEMPLATE_LOADERS.
mysite.zip_loader entonces agregaremos mysite.zip_loader.load_templ
El nico paso restante si deseamos usar este cargador es agregarlo a la variable de con guracin
Si pusiramos este cdigo en un paquete llamado
a
TEMPLATE_LOADERS.
10.6.
Usando la referencia de plantillas incorporadas
La interfaz de administracin de Django incluye una referencia completa de todas las etiquetas y ltros de plantillas
disponibles para un sitio determinado. Est designada para ser una herramienta que los programadores Django proveen
a los desarrolladores de plantillas. Para verla, ve a la interfaz de administracin y haz click en el enlace Documentacin
en la zona superior derecha de la pgina.
La referencia est dividida en cuatro secciones: etiquetas, ltros, modelos y vistas. Las secciones etiquetas y ltros
describen todas las etiquetas incluidas (en efecto, las referencias de etiquetas y ltros del Captulo 4 han sido extradas
directamente de esas pginas) as como cualquier biblioteca de etiquetas o ltros personalizados disponible.
La pgina views es la ms valiosa. Cada URL en tu sitio tiene all una entrada separada. Si la vista relacionada
incluye una docstring, haciendo click en la URL te mostrar lo siguiente:
revisin 757 del 28 de julio de 2008
128
CAPTULO 10. EXTENDIENDO EL SISTEMA DE PLANTILLAS
El nombre de la funcin de vista que genera esa vista.
Una breve descripcin de qu hace la vista.
El contexto, o una lista de variables disponibles en la plantilla de la vista.
El nombre de la plantilla o plantillas usados para esa vista.
Para un ejemplo detallado de la documentacin de vistas, lee el cdigo fuente de la vista genrica de Django
object_list
la cual se encuentra en
django/views/generic/list_detail.py.
Debido a que los sitios implementados con Django generalmente usan objetos de bases de datos, las pginas models
describen cada tipo de objeto en el sistema as como todos los campos disponibles en esos objetos.
En forma conjunta, las pginas de documentacin deberan proveerte cada etiqueta, ltro, variable y objeto disponible para su uso en una plantilla arbitraria.
10.7.
Con gurando el sistema de plantillas en modo autnomo
Nota
Esta seccin es slo de inters para aquellos que intentan usar el sistema de plantillas como un
componente de salida en otra aplicacin. Si ests usando el sistema como parte de un aplicacin
Django, la informacin aqu presentada no es relevante para ti.
Normalmente Django carga toda la informacin de con guracin que necesita desde su propio archivo de con guracin por omisin, combinado con las variables de con guracin en el mdulo indicado en la variable de entorno
DJANGO_SETTINGS_MODULE.
Pero si ests usando el sistema de plantillas independientemente del resto de Django, el
esquema de la variable de entorno no es muy conveniente porque probablemente quieras con gurar el sistema de plantillas en una manera acorde con el resto de tu aplicacin en lugar de tener que vrtelas con archivos de con guracin
e indicando los mismos con variables de entorno.
Para resolver este problema necesitas usar la opcin de con guracin manual descripta en forma completa en el
Apndice E. En resumen, necesitas importar las partes apropiadas del sistema de plantillas y entonces, antes de invocar
alguna de las funciones de plantillas, invoca
que desees especi car.
Podras desear considerar jar al menos
(aunque el valor por omisin
utf-8
django.conf.settings.configure() con cualquier valor de con guracin
TEMPLATE_DIRS (si vas a usar cargadores de plantillas), DEFAULT_CHARSET
TEMPLATE_DEBUG. Todas las variables de con gutodos las variables cuyos nombres comienzan con TEMPLATE_ son de obvio
probablemente sea adecuado) y
racin estn descriptas en el Apndice E y
inters.
10.8.
Qu sigue?
Hasta ahora este libro ha asumido que el contenido que ests visualizando es HTML. Esta no es una suposicin
incorrecta para un libro sobre desarrollo Web, pero en algunas ocasiones querrs usar Django para generar otros
formatos de datos.
El
`prximo captulo`_ describe cmo puedes usar Django para producir imgenes, PDFs y cualquier otro
formato de datos que puedas imaginar.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
Captulo 11
Generacin de contenido no HTML
Usualmente cuando hablamos sobre desarrollo de sitios Web, hablamos de producir HTML. Por supuesto, hay
mucho ms que contenido HTML en la Web; la usamos para distribuir datos en todo tipo de formatos: RSS, PDFs,
imgenes, y as sucesivamente.
Hasta ahora nos hemos concentrado en el caso comn de la produccin de HTML, pero en ese captulo tomaremos
un desvo y veremos cmo usar Django para producir otro tipo de contenido.
Django posee varias herramientas tiles que puedes usar para producir algunos tipos comunes de contenido no
HTML:
Feeds de sindicacin RSS/Atom
Mapas de sitios haciendo uso de Sitemaps (un formato XML originalmente desarrollado por Google
que provee de ayuda a motores de bsqueda)
Examinaremos cada una de esas herramientas un poco ms adelante, pero antes cubriremos los principios bsicos.
11.1.
Lo bsico: Vistas y tipos MIME
Recuerdas esto del Captulo 3?
Una funcin vista, o una vista por abreviar, es simplemente una funcin en Python que recibe una peticin
Web y retorna una respuesta Web. Esta respuesta puede ser el contenido HTML de una pgina Web, una
redireccin, un error 404, un documento XML, una imagen... en realidad, cualquier cosa.
Ms formalmente, una funcin vista Django debe
Aceptar una instancia
HttpRequest
Retornar una instancia
como primer argumento.
HttpResponse.
La clave para retornar contenido no HTML desde una vista reside en la claseHttpResponse, espec camente en el
argumento
mimetype del constructor. Cambiando el tipo MIME, podemos indicarle al navegador que hemos retornado
una respuesta en un formato diferente
Por ejemplo, veamos una vista que devuelve una imagen PNG. Para mantener las cosas sencillas, simplemente
leeremos un chero desde el disco:
from django.http import HttpResponse
def my_image(request):
image_data = open("/path/to/my/image.png", "rb").read()
return HttpResponse(image_data, mimetype="image/png")
Eso es todo! Si sustituimos la ruta de la imagen en la llamada a
open()
con la ruta a una imagen real, podemos
usar esta vista bastante sencilla para servir una imagen, y el navegador la mostrar correctamente.
La otra cosa importante a tener presente es que los objetos
HttpResponse implementan el API estndar de Python
HttpResponse en cualquier lugar donde Python (o
para cheros. Esto signi ca que podemos usar una instancia de
biblioteca de terceros) espera un chero.
Como un ejemplo de cmo funciona esto, veamos la produccin de CSV con Django.
revisin 757 del 28 de julio de 2008
130
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
11.2.
Produccin de CSV
CSV es formato de datos sencillo que suele ser usada por software de hojas de clculo. Bsicamente es una serie de
las en una tabla, cada celda en la la est separada por comas (CSV signi ca comma-separated values ). Por ejemplo,
aqu tienes una lista de pasajeros problemticos en lneas areas en formato CSV:
Year,Unruly Airline Passengers
1995,146
1996,184
1997,235
1998,200
1999,226
2000,251
2001,299
2002,273
2003,281
2004,304
2005,203
Nota
El
listado
precedente
Administracin
Federal
contiene
de
nmeros
Aviacin
reales;
(FAA)
cortesa
de
de
E.E.U.U.
la
Vea
http://www.faa.gov/data_statistics/passengers_cargo/unruly_passengers/.
Aunque CSV parezca simple, no es un formato que ha sido de nido formalmente. Diferentes piezas de software
producen y consumen diferentes variantes de CSV, haciendo un poco complicado usarlo. Afortunadamente, Python
incluye una biblioteca estndar para CSV,
Debido a que el mdulo
csv
csv,
que es bastante robusta.
opera sobre objetos similares a cheros, es muy fcil usar un
HttpResponse
en lugar
de un chero:
import csv
from django.http import HttpResponse
# Nmero de pasajeros problematicos por ao entre 1995 - 2005. En una aplicacin real
# esto vendra desde una base de datos o cualquier otro medio de almacenamiento.
UNRULY_PASSENGERS = [146,184,235,200,226,251,299,273,281,304,203]
def unruly_passengers_csv(request):
# Creamos el objeto Httpresponse con la cabecera CSV apropiada.
response = HttpResponse(mimetype='text/csv')
response['Content-Disposition'] = 'attachment; filename=unruly.csv'
# Creamos un escritor CSV usando a HttpResponse como "fichero"
writer = csv.writer(response)
writer.writerow(['Year', 'Unruly Airline Passengers'])
for (year, num) in zip(range(1995, 2006), UNRULY_PASSENGERS):
writer.writerow([year, num])
return response
El cdigo y los comentarios deberan ser bastante claros, pero hay unas pocas cosas que merecen mencin especial:
Se le da a la respuesta el tipo MIME
text/csv
(en lugar del tipo predeterminado
text/html).
Esto
le dice a los navegadores que el documento es un chero CSV.
La respuesta obtiene una cabecera
Content-Disposition
adicional, la cual contiene el nombre del
chero CSV. Esta cabecera (bueno, la parte adjunta) le indicar al navegador que solicite la ubicacin
donde guardar el chero (en lugar de simplemente mostrarlo). Este nombre de chero es arbitrario;
llmalo como quieras. Ser usado por los navegadores en el cuadro de dilogo Guardar como...
revisin 757 del 28 de julio de 2008
11.3. GENERANDO PDFS
131
Usar el API de generacin de CSV es sencillo: basta pasar
csv.writer.
La funcin
csv.writer
response
como primer argumento a
espera un objeto de tipo chero, y los de tipo
HttpResponse
se
ajustan.
Por cada la en el chero CSV, invocamos a
writer.writerow,
pasndole un objeto iterable como
una lista o una tupla.
El mdulo CSV se encarga de poner comillas por ti, as que no tendrs que preocuparte por escapar
caracteres en las cadenas que tengan comillas o comas en su interior. Limtate a pasar la informacin
a
writerow(),
que har lo correcto.
Este es el patrn general que usars siempre que necesites retornar contenido no HTML: crear un objeto
HttpResponse
de respuesta (con un tipo MIME especial), pasrselo a algo que espera un chero, y luego devolver la respuesta.
Veamos unos cuntos ejemplos ms.
11.3.
Generando PDFs
El Formato Portable de Documentos (PDF, por Portable Document Format) es un formato desarrollado por
Adobe que es usado para representar documentos imprimibles, completos con formato perfecto hasta un nivel de
detalle medido en pixels, tipografas empotradas y gr cos de vectores en 2D. Puedes pensar en un documento PDF
como el equivalente digital de un documento impreso; efectivamente, los PDFs se usan normalmente cuando se necesita
entregar un documento a alguien para que lo imprima.
Puedes generar PDFs fcilmente con Python y Django gracias a la excelente biblioteca open source ReportLab
(http://www.reportlab.org/rl_toolkit.html). La ventaja de generar cheros PDFs dinmicamente es que puedes crear
PDFs a medida para diferentes propsitos -- supongamos, para diferentes usuarios u diferentes contenidos.
Por ejemplo, hemos usado Django y ReportLab en KUSports.com para generar programas de torneos de la NCAA
personalizados, listos para ser impresos.
11.3.1.
Instalando ReportLab
Antes de que puedas generar ningn PDF, debers instalar ReportLab. Esto es usualmente muy simple: slo
descarga e instala la biblioteca desde
http://www.reportlab.org/downloads.html.
http://www.reportlab.org/rsrc/userguide.
La gua del usuario (naturalmente slo disponible en formato PDF) en
contiene instrucciones de instalacin adicionales.
Nota
Si ests usando una distribucin moderna de Linux, podras desear comprobar con la utilidad de
manejo de paquetes de software antes de instalar ReportLab. La mayora de los repositorios de
paquetes ya incluyen ReportLab.
Por ejemplo, si ests usando la (excelente) distribucin Ubuntu, un simple
python-reportlab
apt-get install
har la magia necesaria.
Prueba tu instalacin importando la misma en el intrprete interactivo Python:
>>> import reportlab
Si ese comando no lanza ningn error, la instalacin funcion.
11.3.2.
Escribiendo tu Vista
Del mismo modo que CSV, la generacin de PDFs en forma dinmica con Django es sencilla porque la API
ReportLab acta sobre objetos similares a cheros ( le-like segn la jerga Python).
A continuacin un ejemplo Hola Mundo:
from reportlab.pdfgen import canvas
from django.http import HttpResponse
def hello_pdf(request):
# Se crea el objeto HttpResponse con los headers PDF apropiados.
response = HttpResponse(mimetype='application/pdf')
response['Content-Disposition'] = 'attachment; filename=hello.pdf'
revisin 757 del 28 de julio de 2008
132
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
# Se crea el objeto PDF, usando el objeto de respuesta como si fuese un "archivo".
p = canvas.Canvas(response)
# Se dibujan cosas en el PDF. Aqu es donde se crea el PDF.
# Lee la documentacin de ReportLab para una lista de funcionalidades.
p.drawString(100, 100, "Hello world.")
# Se cierra el objeto PDF, y terminamos.
p.showPage()
p.save()
return response
Son necesarias alguna notas:
Usamos el tipo MIME
application/pdf.
Esto le indica al navegador que el documento es un chero
PDF y no un chero HTML. Si no incluyes esta informacin, los navegadores web probablemente
interpretarn la respuesta como HTML, lo que resultar en jerogl cos en la ventana del navegador.
Interactuar con la API ReportLab es sencillo: slo pasa
canvas.Canvas.
La clase
Canvas
response
como el primer argumento a
espera un objeto le-like, y los objetos
HttpResponse
se ajusta-
rn a la norma.
Todos los mtodos de generacin de PDF subsecuentes son llamados pasndoles el objeto PDF (en
este caso
p),
no
response.
Finalmente, es importante llamar a los mtodos
showPage() y save() del objeto PDF (de otra manera
obtendrs un chero PDF corrupto).
11.3.3.
PDFs complejos
Si ests creando un documento PDF complejo (o cualquier pieza de datos de gran tamao), considera usar la
biblioteca
cStringIO
como un lugar de almacenamiento temporario para tu chero PDF. La biblioteca
provee una interfaz va objetos le-like que est escrita en C para mxima e ciencia.
Ese es el ejemplo Hola Mundo anterior modi cado para usar
cStringIO:
from cStringIO import StringIO
from reportlab.pdfgen import canvas
from django.http import HttpResponse
def hello_pdf(request):
# Se crea el objeto HttpResponse con los headers PDF apropiados.
response = HttpResponse(mimetype='application/pdf')
response['Content-Disposition'] = 'attachment; filename=hello.pdf'
temp = StringIO()
# Se crea el objeto PDF, usando el objeto StringIO como si fuese un "archivo".
p = canvas.Canvas(temp)
# Se dibujan cosas en el PDF. Aqu es donde se crea el PDF.
# Lee la documentacin de ReportLab para una lista de funcionalidades.
p.drawString(100, 100, "Hello world.")
# Se cierra el objeto PDF.
p.showPage()
p.save()
# Lee el valor del buffer de StringIO y escribe la respuesta.
response.write(temp.getvalue())
return response
revisin 757 del 28 de julio de 2008
cStringIO
11.4. OTRAS POSIBILIDADES
11.4.
133
Otras posibilidades
Hay in nidad de otros tipos de contenido que puedes generar en Python. Aqu tenemos algunas otras ideas y las
bibliotecas que podras usar para implementarlas:
Archivos ZIP : La biblioteca estndar de Python contiene el mdulo
zipfile,
que puede escribir y
leer cheros comprimidos en formato ZIP. Puedes usarla para guardar cheros bajo demanda, o quizs
comprimir grandes documentos cuando lo requieran. De la misma manera puedes generar cheros en
formato TAR usando el mdulo de la biblioteca estndar
tarfile.
Imgenes Dinmicas : Biblioteca Python de procesamiento de Imgenes (Python Imaging Library, PIL;
http://www.pythonware.com/products/pil/)
es una herramienta fantstica para producir imge-
nes (PNG, JPEG, GIF, y muchas ms). Puedes usarla para escalar automticamente imgenes para
generar miniaturas, agrupar varias imgenes en un solo marco e incluso realizar procesamiento de
imgenes directamente en la web.
Ploteos y Gr cos : Existe un nmero importante de increblemente potentes bibliotecas de Python
para Ploteo y Gr cos, que se pueden utilizar para generar mapas, dibujos, ploteos y gr cos. Es
imposible listar todas las bibliotecas, as que resaltamos algunas de ellas:
matplotlib (http://matplotlib.sourceforge.net/)
puede usarse para generar plo-
teos de alta calidad al estilo de los generados con MatLab o Mathematica.
pygraphviz (https://networkx.lanl.gov/wiki/pygraphviz), una interfaz con la herramienta Graphviz (http://graphviz.org/), puede usarse para generar diagramas estructurados de grafos y redes.
En general, cualquier biblioteca Python capaz de escribir en un chero puede ser utilizada dentro de Django. Las
posibilidades son realmente interminables.
Ahora que hemos visto lo bsico de generar contenido no-HTML, avancemos al siguiente nivel de abstraccin.
Django incluye algunas herramientas bonitas e ingeniosas para generar cierto tipo de contenido no-HTML.
11.5.
El Framework de Feeds de Sindicacin
Django incluye un framework para la generacin y sindicacin de feeds de alto nivel que permite crear feeds RSS
y Atom de manera sencilla.
Qu es RSS? Qu es Atom?
RSS y Atom son formatos basados en XML que se puede utilizar para actualizar automticamente
http://www.whatisrss.com/,
http://www.atomenabled.org/.
los feeds con el contenido de tu sitio. Lee ms sobre RSS en
obtn informacin sobre Atom en
Para crear cualquier feed de sindicacin, todo lo que debes hacer es escribir una corta clase Python. Puedes crear
tantos feeds como desees.
/feeds/ por convencin. Django usa
/feeds/) para determinar qu feed retornar.
Para crear un feed, necesitas escribir una clase Feed y hacer referencia a la misma en tu URLconf (ver los Captulos
El framework de generacin de feeds de alto nivel es una vista enganchada a
el nal de la URL (todo lo que este despus de
3 y 8 para ms informacin sobre URLconfs).
11.5.1.
Inicializacin
Para activar los feeds de sindicacin en tu sitio Django, agrega lo siguiente en tu URLconf:
(r'^feeds/(?P<url>.*)/$',
'django.contrib.syndication.views.feed',
{'feed_dict': feeds}
),
Esa lnea le indica a Django que use el framework RSS para captar las URLs que comienzan con
cambiar
"feeds/"
"feeds/". (Puedes
por algo que se adapte a tus necesidades).
Esta lnea de URLconf tiene un argumento extra:
{'feed_dict': feeds}.
Usa este argumento extra para pasar
al framework de feeds de sindicacin los feeds que deben ser publicados en dicha URL.
Espec camente,
feed_dict debe ser un diccionario que mapee el
feed_dict en el mismo URLconf. Este es
clase Feed. Puedes de nir el
slug (etiqueta corta de URL) de un feed a la
un ejemplo completo de URLconf:
revisin 757 del 28 de julio de 2008
134
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
from django.conf.urls.defaults import *
from myproject.feeds import LatestEntries, LatestEntriesByCategory
feeds = {
'latest': LatestEntries,
'categories': LatestEntriesByCategory,
}
urlpatterns = patterns('',
# ...
(r'^feeds/(?P<url>.*)/$', 'django.contrib.syndication.views.feed',
{'feed_dict': feeds}),
# ...
)
El ejemplo anterior registra dos feeds:
El feed representado por
El feed representado por
LatestEntries residir en feeds/latest/.
LatestEntriesByCategory residir en feeds/categories/.
Una vez que este con gurado, necesitas de nir la propia clase
Una clase
Feed
Feed.
es una simple clase Python que representa un feed de sindicacin. Un feed puede ser simple (p. ej.
noticias del sitio, o una lista de las ltimas entradas del blog) o ms complejo (p. ej. mostrar todas las entradas de
un blog en una categora en particular, donde la categora es variable).
La clase
Feed debe se una subclase de django.contrib.syndication.feeds.Feed. Esta puede residir en cualquier
parte del rbol de cdigo.
11.5.2.
Un Feed simple
Este ejemplo simple, tomado de chicagocrime.org, describe un feed que muestra los ltimos cinco items agregados:
from django.contrib.syndication.feeds import Feed
from chicagocrime.models import NewsItem
class LatestEntries(Feed):
title = "Chicagocrime.org site news"
link = "/sitenews/"
description = "Updates on changes and additions to chicagocrime.org."
def items(self):
return NewsItem.objects.order_by('-pub_date')[:5]
Las cosas importantes a tener en cuenta son:
django.contrib.syndication.feeds.Feed.
title, link, y description corresponden a los elementos RSS estndar <title>, <link>, y <description>
La clase es subclase de
respectivamente.
items()
es simplemente un mtodo que retorna una lista de objetos que deben incluirse en el feed
como elementos
<item>.
Aunque este ejemplo retorna objetos
datos de Django, no es un requerimiento que
items()
NewsItem
usando la API de base de
deba retornar instancias de modelos.
Obtienes unos pocos bits de funcionalidad gratis usando los modelos de Django, pero
items() puede
retornar cualquier tipo de objeto que desees.
Hay solamente un paso ms. En un feed RSS, cada
<item> posee <title>, <link>, y <description>. Necesitamos
decirle al framework qu datos debe poner en cada uno de los elementos.
<title> y <description>, crea plantillas Django (ver Captulo 4)
feeds/latest_title.html y feeds/latest_description.html, donde latest es el slug
especi cado en URLconf para el feed dado. Notar que la extensin .html es requerida.
Para especi car el contenido de
llamadas
El sistema RSS renderiza dicha plantilla por cada tem, pasndole dos variables de contexto para
plantillas:
revisin 757 del 28 de julio de 2008
11.5. EL FRAMEWORK DE FEEDS DE SINDICACIN
135
obj: El objeto actual (uno de los tantos que retorna en items()).
site: Un objeto django.models.core.sites.Site representa el sitio actual. Esto es til
para {{ site.domain }} o {{ site.name }}.
Si no creas una plantilla para el ttulo o la descripcin, el framework utilizar la plantilla por omisin
"{{ obj }}"
-- exacto, la cadena normal de representacin del objeto.
title_template y description_template
Feed.
Para especi car el contenido de <link>, hay dos opciones. Por cada tem en items(), Django primero
tratar de ejecutar el mtodo get_absolute_url() en dicho objeto. Si dicho mtodo no existe, entonces trata de llamar al mtodo item_link() en la clase Feed, pasndole un nico parmetro, item,
Tambin puedes cambiar los nombres de estas plantillas especi cando
como atributos de tu clase
que es el objeto en s mismo.
Ambos
get_absolute_url() y item_link() deben retornar la URL del tem como una cadena normal
de Python.
Para el ejemplo anterior
LatestEntries, podemos usar plantillas de feed muy simples. latest_title.html
contiene:
{{ obj.title }}
latest_description.html
{{ obj.description }}
contiene:
Es casi demasiado fcil...
11.5.3.
Un Feed ms complejo
El framework tambin permite la creacin de feeds ms complejos mediante el uso de parmetros.
Por ejemplo, chicagocrime.org ofrece un feed RSS de los crmenes recientes de cada departamento de polica en
Chicago. Sera tonto crear una clase
Feed separada por cada departamento; esto puede violar el principio No te repitas
a ti mismo (DRY, por Do not repeat yourself ) y creara acoplamiento entre los datos y la lgica de programacin.
En su lugar, el framework de feeds de sindicacin te permite crear feeds genricos que retornan items basados en
la informacin en la URL del feed.
En chicagocrime.org, los feed por departamento de polica son accesibles mediante URLs como estas:
http://www.chicagocrime.org/rss/beats/0613/:
Retorna los crmenes ms recientes para el de-
partamento 0613
http://www.chicagocrime.org/rss/beats/1424/:
Retorna los crmenes ms recientes para el de-
partamento 1424
El slug aqu es
"beats".
El framework de sindicacin ve las partes extra en la URL tras el slug --
0613
1424
--
y te provee un gancho (hook ) para que le indiques qu signi ca cada uno de esas partes y cmo in uyen en los items
que sern publicados en el feed.
un ejemplo aclarar esto. Este es el cdigo para los feeds por departamento:
from django.core.exceptions import ObjectDoesNotExist
class BeatFeed(Feed):
def get_object(self, bits):
# En caso de "/rss/beats/0613/foo/bar/baz/", u otro
# revoltijo, corroborar que bits tiene slo un miembro.
if len(bits) != 1:
raise ObjectDoesNotExist
return Beat.objects.get(beat__exact=bits[0])
def title(self, obj):
return "Chicagocrime.org: Crimes for beat %s" % obj.beat
def link(self, obj):
return obj.get_absolute_url()
def description(self, obj):
revisin 757 del 28 de julio de 2008
136
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
return "Crimes recently reported in police beat %s" % obj.beat
def items(self, obj):
crimes = Crime.objects.filter(beat__id__exact=obj.id)
return crimes.order_by('-crime_date')[:30]
Aqu tenemos el algoritmo bsico del framework RSS, asumiendo esa clase y un requerimiento a la URL
#. El framework toma la URL
/rss/beats/0613/:
/rss/beats/0613/ y nota que la URL contiene una parte extra tras el
"/" y llama al mtodo get_object() de la clase Feed
slug. Separa esa cadena remanente por el carcter
pasndole los trozos (bits ) resultantes.
['0613'].
['0613', 'foo', 'bar'].
En este caso, los trozos son
sern
1.
get_object()
Para un requerimiento a
/rss/beats/0613/foo/bar/,
es el responsable de obtener el departamento requerido, a partir del
bits
dado.
En este caso, usa la API de base de datos de Django para obtener el departamento. Notar que
get_object()
django.core.exceptions.ObjectDoesNotExist si
try/except abarcando la llamada a Beat.objects.get()
porque no es necesario. Esa funcin, ante una falla lanza la excepcin Beat.DoesNotExist, y
Beat.DoesNotExist es una subclase de ObjectDoesNotExist. Lanzar la excepcin ObjectDoesNotExist
en get_object() le dice a Django que produzca un error 404 error para el requerimiento en curso.
debe capturar la excepcin
recibe parmetros invlidos. No hay
<title>, <link>,
description(). En el
2. Para generar los campos
title(), link(),
<description>
del feed, Django usa los mtodos
ejemplo anterior, se utilizaron atributos simples de
clase string, pero este ejemplo muestra que estos pueden ser strings o mtodos. Por cada
link,
description,
1. Trata de llamar al mtodo, pasando el argumento
retornado por
title,
Django sigue este algoritmo:
get_object().
obj,
donde
obj
es el objeto
2. Si eso falla, trata de llamar al mtodo sin argumentos.
3. Si eso falla, usa los atributos de clase.
items() en el ejemplo tambin toma como argumento a obj. El algoritmo
items es el mismo que se describe en el paso anterior -- primero prueba items(obj), despus
items(), y nalmente un atributo de clase items (que debe ser una lista).
3. Finalmente, nota que
para
La documentacin completa de todos los mtodos y atributos de las clases
Feed
siempre esta disponible en la
documentacin o cial de Django (http://www.djangoproject.com/documentation/0.96/syndication_feeds/).
11.5.4.
Especi cando el tipo de Feed
Por omisin, el framework de feeds de sindicacin produce RSS 2.0. Para cambiar eso, agrega un atributo
a tu clase
Feed:
feed_type
from django.utils.feedgenerator import Atom1Feed
class MyFeed(Feed):
feed_type = Atom1Feed
Nota que asignas como valor de
feed_type una clase, no a una instancia. Los tipos de feeds disponibles actualmente
se muestran en la Tabla 11-1.
Cuadro 11.1: Tipos de Feeds
Clase Feed
Formato
django.utils.feedgenerator.Rss201rev2Feed
django.utils.feedgenerator.RssUserland091Feed
django.utils.feedgenerator.Atom1Feed
revisin 757 del 28 de julio de 2008
RSS 2.01 (por defecto)
RSS 0.91
Atom 1.0
11.5. EL FRAMEWORK DE FEEDS DE SINDICACIN
11.5.5.
137
Enclosures
Para especi car enclosures (p. ej. recursos multimedia asociados al tem del feed tales como feeds de podcasts
MP3), usa los ganchos
item_enclosure_url, item_enclosure_length,
item_enclosure_mime_type,
por ejemplo:
from myproject.models import Song
class MyFeedWithEnclosures(Feed):
title = "Example feed with enclosures"
link = "/feeds/example-with-enclosures/"
def items(self):
return Song.objects.all()[:30]
def item_enclosure_url(self, item):
return item.song_url
def item_enclosure_length(self, item):
return item.song_length
item_enclosure_mime_type = "audio/mpeg"
Esto asume, por supuesto, que has creado un objeto
Song
con los campos
song_url
song_length
(p. ej. el
tamao en bytes).
11.5.6.
Idioma
Los Feeds creados por el framework de sindicacin incluyen automticamente la etiqueta
el atributo
11.5.7.
xml:lang
<language> (RSS 2.0)
LANGUAGE_CODE.
apropiados (Atom). Esto viene directamente de tu variable de con guracin
URLs
"/blog/") como una URL con el nom"http://www.example.com/blog/"). Si link no retorna el dominio, el
framework de sindicacin insertar el dominio del sitio actual, acorde a la variable de con guracin SITE_ID.
Los feeds Atom requieren un <link rel="self"> que de ne la ubicacin actual del feed. El framework de sinEl mtodo/atributo
link
puede retornar tanto una URL absoluta (p. ej.
bre completo de dominio y protocolo (p. ej.
dicacin completa esto automticamente, usando el dominio del sitio actual acorde a la variable de con guracin
SITE_ID.
11.5.8.
Publicando feeds Atom y RSS conjuntamente
Algunos desarrolladores pre eren ofrecer ambas versiones Atom y RSS de sus feeds. Esto es simple de hacer con
Django: solamente crea una subclase de tu clase
feed
y asigna a
feed_type
un valor diferente. Luego actualiza tu
URLconf para agregar una versin extra. Aqu un ejemplo completo:
from django.contrib.syndication.feeds import Feed
from chicagocrime.models import NewsItem
from django.utils.feedgenerator import Atom1Feed
class RssSiteNewsFeed(Feed):
title = "Chicagocrime.org site news"
link = "/sitenews/"
description = "Updates on changes and additions to chicagocrime.org."
def items(self):
return NewsItem.objects.order_by('-pub_date')[:5]
class AtomSiteNewsFeed(RssSiteNewsFeed):
feed_type = Atom1Feed
Y este es el URLconf asociado:
revisin 757 del 28 de julio de 2008
138
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
from django.conf.urls.defaults import *
from myproject.feeds import RssSiteNewsFeed, AtomSiteNewsFeed
feeds = {
'rss': RssSiteNewsFeed,
'atom': AtomSiteNewsFeed,
}
urlpatterns = patterns('',
# ...
(r'^feeds/(?P<url>.*)/$', 'django.contrib.syndication.views.feed',
{'feed_dict': feeds}),
# ...
)
11.6.
El framework Sitemap
Un sitemap es un chero XML en tu sitio web que le indica a los indexadores de los motores de bsqueda cuan
frecuentemente cambian tus pginas as como la importancia relativa de ciertas pginas en relacin con otras (siempre
hablando de pginas de tu sitio). Esta informacin ayuda a los motores de bsqueda a indexar tu sitio.
Por ejemplo, esta es una parte del sitemap del sitio web de Django (http://www.djangoproject.com/sitemap.
xml):
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://www.djangoproject.com/documentation/</loc>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>http://www.djangoproject.com/documentation/0_90/</loc>
<changefreq>never</changefreq>
<priority>0.1</priority>
</url>
...
</urlset>
Para ms informacin sobre sitemaps, vea
http://www.sitemaps.org/.
El framework sitemap de Django automatiza la creacin de este chero XML si lo indicas expresamente en el cdigo
Python. Para crear un sitemap, debes simplemente escribir una clase
Sitemap
y hacer referencia a la misma en tu
URLconf.
11.6.1.
Instalacin
Para instalar la aplicacin sitemap, sigue los siguientes pasos:
1. Agrega
'django.contrib.sitemaps'
#. Asegrate de que
a tu variable de con guracin
INSTALLED_APPS.
'django.template.loaders.app_directories.load_template_source' est en tu
TEMPLATE_LOADERS. Por omisin se encuentra activado, por lo que los cambios
variable de con guracin
son necesarios solamente si modi caste dicha variable de con guracin.
1. Asegrate de que tienes instalado el framework sites (ver Captulo 14).
Nota
La aplicacin sitemap no instala tablas en la base de datos. La nica razn de que est en
INSTALLED_APPS
es que el cargador de plantillas
load_template_source
plantillas includas.
revisin 757 del 28 de julio de 2008
pueda encontrar las
11.6. EL FRAMEWORK SITEMAP
11.6.2.
139
Inicializacin
Para activar la generacin del sitemap en tu sitio Django, agrega la siguiente lnea a tu URLconf:
(r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps})
Esta lnea le dice a Django que construya un sitemap cuando un cliente accede a
/sitemap.xml.
El nombre del chero sitemap no es importante, pero la ubicacin s lo es. Los motores de bsqueda solamente
indexan los enlaces en tu sitemap para el nivel de URL actual y anterior. Por ejemplo, si
sitemap.xml
reside en
tu directorio principal, el mismo puede hacer referencia a cualquier URL en tu sitio. Pero si tu sitemap reside en
/content/sitemap.xml,
/content/.
{'sitemaps': sitemaps}. sitemaps debe ser un diccionario que
de seccin (p. ej. blog o news) a tu clase Sitemap (p.e., BlogSitemap o NewsSitemap).
instancia de una clase Sitemap (p. ej. BlogSitemap(some_var)).
solamente podr hacer referencia a URLs que comiencen con
La vista sitemap toma un argumento extra:
mapee una etiqueta corta
Tambin mapea hacia una
11.6.3.
Clases Sitemap
Una clase
Sitemap es simplemente una clase Python que representa una seccin de
Sitemap puede representar todas las entradas de tu weblog, y otra
ejemplo, una clase
eventos de tu calendario.
En el caso ms simple, todas estas secciones se unen en un nico
sitemap.xml,
entradas en tu sitemap. Por
puede representar todos los
pero tambin es posible usar el
framework para generar un ndice sitemap que haga referencia cheros sitemap individuales, uno por seccin (describindolo sintticamente).
Las clases
Sitemap debe ser una subclase de django.contrib.sitemaps.Sitemap. Estas pueden residir en cualquier
parte del rbol de cdigo.
Por ejemplo, asumamos que posees un sistema de blog, con un modelo
todos los enlaces a las entradas individuales de tu Blog. Tu clase
Sitemap
Entry,
y quieres que tu sitemap incluya
debera verse as:
from django.contrib.sitemaps import Sitemap
from mysite.blog.models import Entry
class BlogSitemap(Sitemap):
changefreq = "never"
priority = 0.5
def items(self):
return Entry.objects.filter(is_draft=False)
def lastmod(self, obj):
return obj.pub_date
Declarar un
Sitemap
debera verse muy similar a declarar un
En manera similar a las clases
Feed,
los miembros de
Sitemap
Feed;
esto es justamente un objetivo del diseo.
pueden ser mtodos o atributos. Ver los pasos en la
seccin Un feed ms complejo para ms informacin sobre cmo funciona esto.
Una clase
Sitemap
puede de nir los siguientes mtodos/atributos:
items (requerido): Provee una lista de objetos. Al framework no le importa que tipo de objeto es; todo
location(), lastmod(), changefreq(),
y priority().
lo que importa es que los objetos sean pasados a los mtodos
location (opcional): Provee la URL absoluta para el objeto dado. Aqu URL absoluta
signi ca una
URL que no incluye el protocolo o el dominio. Estos son algunos ejemplos:
Si
Bien:
Mal:
Mal:
'/foo/bar/'
'example.com/foo/bar/'
'http://example.com/foo/bar/'
location no es provisto, el framework llamar al mtodo get_absolute_url() en cada uno de los
items().
objetos retornados por
lastmod (opcional): La fecha de ltima modi cacin del objeto, como un objeto datetime de Python.
changefreq
(opcional): Cun a menudo el objeto cambia. Los valores posibles (segn indican las
especi caciones de Sitemaps) son:
revisin 757 del 28 de julio de 2008
140
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
'always'
'hourly'
'daily'
'weekly'
'monthly'
'yearly'
'never'
priority
funciona
11.6.4.
0.0 y 1.0. La prioridad por omisin de
http://sitemaps.org para ms informacin de cmo
(opcional): Prioridad sugerida de indexado entre
0.5; ver
priority.
una pgina es
la documentacin de
Accesos directos
El framework sitemap provee un conjunto de clases para los casos ms comunes. Describiremos estos casos en las
secciones a continuacin.
FlatPageSitemap
La clase
django.contrib.sitemaps.FlatPageSitemap
apunta a todas las pginas planas de nidas para el sitio
actual y crea una entrada en el sitemap. Estas entradas incluyen solamente el atributo
changefreq,
priority.
location
-- no
lastmod,
Para ms informacin sobre Pginas Planas ver el Captulo 14.
Sitemap Genrico
GenericSitemap trabaja con cualquier vista genrica (ver Captulo 9) que pudieras poseer con anterioridad.
info_dict que se pasa a la vista genrica. El nico
requerimiento es que el diccionario tenga una entrada queryset. Tambin debe poseer una entrada date_field
que especi ca un campo fecha para los objetos obtenidos del queryset. Esto ser usado por el atributo lastmod
en el sitemap generado. Tambin puedes pasar los argumentos palabra clave (keyword ) priority y changefreq al
constructor GenericSitemap para especi car dichos atributos para todas las URLs.
Este es un ejemplo de URLconf usando tanto, FlatPageSitemap como GenericSiteMap (con el anterior objeto
hipottico Entry):
La clase
Para usarla, crea una instancia, pasndola en el mismo
from django.conf.urls.defaults import *
from django.contrib.sitemaps import FlatPageSitemap, GenericSitemap
from mysite.blog.models import Entry
info_dict = {
'queryset': Entry.objects.all(),
'date_field': 'pub_date',
}
sitemaps = {
'flatpages': FlatPageSitemap,
'blog': GenericSitemap(info_dict, priority=0.6),
}
urlpatterns = patterns('',
# some generic view using info_dict
# ...
# the sitemap
(r'^sitemap.xml$',
'django.contrib.sitemaps.views.sitemap',
{'sitemaps': sitemaps})
revisin 757 del 28 de julio de 2008
11.6. EL FRAMEWORK SITEMAP
11.6.5.
141
Creando un ndice Sitemap
El framework sitemap tambin tiene la habilidad de crear ndices sitemap que hagan referencia a cheros sitemap
individuales, uno por cada seccin de nida en tu diccionario
Usas dos vistas en tu URLconf:
sitemaps.
django.contrib.sitemaps.views.index y django.contrib.sitemaps.views.si
django.contrib.sitemaps.views.sitemap
section.
La vista
mado
Las nica diferencias de uso son:
debe tomar un argumento de palabra clave lla-
As deberan verse las lneas relevantes en tu URLconf para el ejemplo anterior:
(r'^sitemap.xml$',
'django.contrib.sitemaps.views.index',
{'sitemaps': sitemaps}),
(r'^sitemap-(?P<section>.+).xml$',
'django.contrib.sitemaps.views.sitemap',
{'sitemaps': sitemaps})
Esto genera automticamente un chero
sitemap-blog.xml.
11.6.6.
La clase
Sitemap
sitemap.xml que hace referencia a ambos cheros sitemap-flatpages.xml
sitemaps no cambian en absoluto.
y el diccionario
Haciendo ping a Google
Puedes desear hacer un ping a Google cuando tu sitemap cambia, para hacerle saber que debe reindexar tu sitio.
El framework provee una funcin para hacer justamente eso:
django.contrib.sitemaps.ping_google().
Nota
Hasta el momento en que este libro se escribi, nicamente Google responde a los pings de
sitemap. Pero es muy probable que pronto Yahoo y/o MSN tambin admitan estos pings.
eso
suceda,
cambiaremos
el
nombre
de
ping_google() a algo como
ping_search_engines(), as que asegrate de veri car la ultima documentacin de sitemap en http://www.djangoproject.com/documentation/0.96/sitemaps/.
Cuando
ping_google() toma un argumento opcional, sitemap_url, que debe ser la URL absoluta de tu sitemap (por ej.,
'/sitemap.xml'). Si este argumento no es provisto, ping_google() tratar de generar un sitemap realizando una
bsqueda reversa en tu URLconf.
ping_google()
lanza la excepcin
de tu sitemap.
Una forma til de llamar a
django.contrib.sitemaps.SitemapNotFound
ping_google()
es desde el mtodo
si no puede determinar la URL
save():
from django.contrib.sitemaps import ping_google
class Entry(models.Model):
# ...
def save(self):
super(Entry, self).save()
try:
ping_google()
except Exception:
# Bare 'except' because we could get a variety
# of HTTP-related exceptions.
pass
Una solucin ms e ciente, sin embargo, sera llamar a
ping_google()
desde un script
cron
o un manejador de
tareas. La funcin hace un pedido HTTP a los servidores de Google, por lo que no querrs introducir esa demora
asociada a la actividad de red cada vez que se llame al mtodo
save().
revisin 757 del 28 de julio de 2008
142
11.7.
CAPTULO 11. GENERACIN DE CONTENIDO NO HTML
Qu sigue?
A continuacin, seguiremos indagando ms profundamente en las herramientas internas que Django nos ofrece.
El Captulo 12 examina todas las herramientas que necesitas para proveer sitios personalizados: sesiones, usuarios, y
autenticacin.
Adelante!
revisin 757 del 28 de julio de 2008
Captulo 12
Sesiones, usuario e inscripciones
Tenemos que confesar algo: hasta el momento hemos ignorado un aspecto absolutamente importante del desarrollo
web. Hemos hecho la suposicin de que el tr co que visita nuestra web est compuesto por una masa amorfa de
usuarios annimos, que se precipitan contra nuestras cuidadosamente diseadas pginas.
Esto no es verdad, claro. Los navegadores que consultan nuestras pginas tienen a personas reales detrs (la mayor
parte del tiempo, al menos). Este es un hecho importantsimo y que no debemos ignorar: Lo mejor de Internet es
que sirve para conectar personas, no mquinas. Si queremos desarrollar un sitio web realmente competitivo, antes o
despus tendremos que plantearnos como tratar a las personas que estn detrs del navegador.
Por desgracia, no es tan fcil como podra parecer. El protocolo HTTP se dise espec camente para que fuera un
protocolo sin estado, es decir, que cada peticin y respuesta est totalmente aislada de las dems. No hay persistencia
entre una peticin y la siguiente, y ninguno de los atributos de la peticin (Direccin IP, identi cador del agente, etc...)
nos permite discriminar de forma segura y consistente las peticiones de una persona de las del resto.
En este captulo aprenderemos como solucionar esta carencia de estados. Empezaremos al nivel ms bajo (cookies ),
e iremos ascendiendo hasta las herramientas de alto nivel que nos permitirn gestionar sesiones, usuarios y altas o
inscripciones de los mismos.
12.1.
Cookies
Los desarrolladores de navegadores hace tiempo que se dieron cuenta de que esta carencia de estados iba a representar un problema para los desarrolladores web, y as fue como nacieron las cookies (literalmente galleta ). Una cookie
es una pequea cantidad de informacin que el servidor delega en el navegador, de forma que este la almacena. Cada
vez que el cliente web solicita una pgina del servidor, se le enva de vuelta la cookie.
Veamos con un poco ms de detalle el funcionamiento. Cuando abrimos nuestro navegador y escribimos
google.com,
el navegador enva una solicitud HTTP a Google que empieza ms o menos as:
GET / HTTP/1.1
Host: google.com
...
Cuando Google responde, la respuesta contiene algo parecido a esto:
HTTP/1.1 200 OK
Content-Type: text/html
Set-Cookie: PREF=ID=5b14f22bdaf1e81c:TM=1167000671:LM=1167000671;
expires=Sun, 17-Jan-2038 19:14:07 GMT;
path=/; domain=.google.com
Server: GWS/2.1
...
Fjate en la lnea que comienza con
Set-Cookie. El navegador almacenar el valor indicado (PREF=ID=5b14f22bdaf1e81c:T
y se lo volver a enviar a Google cada vez que vuelva a acceder a alguna de sus pginas; de esa forma, la prxima vez
que vuelvas a Google, la peticin que enviar el navegador se parecer a esta:
GET / HTTP/1.1
Host: google.com
Cookie: PREF=ID=5b14f22bdaf1e81c:TM=1167000671:LM=1167000671
...
revisin 757 del 28 de julio de 2008
144
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Google puede saber ahora, gracias al valor de la Cookie, que eres la misma persona que accedi un rato antes. Este
valor puede ser, por ejemplo, una clave en una tabla de la base de datos que almacene los datos del usuario. Con esa
informacin, Google puede hacer aparecer tu nombre en la pgina (De hecho, lo hace).
12.1.1.
Cmo de nir y leer los valores de las cookies
A la hora de utilizar las capacidades de persistencia de Django, lo ms probable es que uses las prestaciones de
alto nivel para la gestin de sesiones y de usuarios, prestaciones que discutiremos un poco ms adelante en este mismo
captulo. No obstante, ahora vamos a hacer una breve parada y veremos como leer y de nir cookies a bajo nivel. Esto
debera ayudarte a entender como funcionan el resto de las herramientas que veremos en el captulo, y te ser de
utilidad si alguna vez tienes que trabajar con las cookies directamente.
Obtener los valores de las cookies que ya estn de nidas es muy fcil. Cada objeto de tipo peticin,
contiene un objeto
COOKIES
request,
que se comporta como un diccionario; puedes usarlo para leer cualquier cookie que el
navegador haya enviado a la vista:
def show_color(request):
if "favorite_color" in request.COOKIES:
return HttpResponse("Your favorite color is %s" % \
request.COOKIES["favorite_color"])
else:
return HttpResponse("You don't have a favorite color.")
De nir los valores de las cookies es slo un poco ms complicado. Debes usar el mtodo
HttpResponse.
parmetro GET:
de tipo
como
He aqu un ejemplo que de ne la cookie
favorite_color
set_cookie() en un objeto
utilizando el valor que se le pasa
def set_color(request):
if "favorite_color" in request.GET:
# Create an HttpResponse object...
response = HttpResponse("Your favorite color is now %s" % \
request.GET["favorite_color"])
# ... and set a cookie on the response
response.set_cookie("favorite_color",
request.GET["favorite_color"])
return response
else:
return HttpResponse("You didn't give a favorite color.")
Hay una serie de parmetros opcionales que puedes pasar a
response.set_cookie()
y que te permiten controlar
determinadas caractersticas de la cookie, tal y como se muestra en la tabla 12-1.
Cuadro 12.1: Opciones de las Cookies
Parmetro
max_age
Valor por omisin
None
Descripcin
El tiempo (en segundos) que la cookie debe permanecer activa. Si este
parmetro es, la cookie desaparecer automticamente cuando se cierre
el navegador.
expires
None
La fecha y hora en que la cookie debe expirar. Debe estar en el formato
"Wdy, DD-Mth-YY HH:MM:SS GMT".
Si se utiliza este parmetro, su
valor tiene preferencia sobre el de nido mediante
path
"/"
max_age.
La ruta o path para la cual es vlida la cookie. Los navegadores solo
reenviarn la cookie a las pginas que estn en dicha ruta. Esto impide
que se enve esta cookie a otras secciones de la web.
Es especialmente til si no se tiene el control del nivel superior de
directorios del servidor web.
revisin 757 del 28 de julio de 2008
12.2. EL ENTORNO DE SESIONES DE DJANGO
145
Cuadro 12.1: Opciones de las Cookies
Parmetro
domain
Valor por omisin
None
Descripcin
El dominio para el cual es vlida la cookie. Se puede usar este
parmetro para de nir una cookie que sea apta para varios domi-
domain=".example.com" la cookie sewww.example.com, www2.example.com y
aun.otro.subdominio.example.com.
nios. Por ejemplo, de niendo
r enviada a los dominios
Si a este parmetro no se le asigna ningn valor, la cookie solo ser
enviada al dominio que la de ni.
secure
False
Si este valor se de ne como
True,
se le indica al navegador que s-
lo retorne esta cookie a las pginas que se accedan de forma segura
(protocolo HTTPS en vez de HTTP).
12.1.2.
Las cookies tienen doble lo
Puede que te hayas dado cuenta de algunos de los problemas potenciales que se presentan con esto de las cookies;
vamos a ver algunos de los ms importantes:
El almacenamiento de los cookies es voluntario; los navegadores no dan ninguna garanta. De hecho,
los navegadores permiten al usuario de nir una poltica de aceptacin o rechazo de las mismas. Para
darte cuenta de lo muy usadas que son las cookies en la web actual, simplemente activa la opcin de
Avisar antes de aceptar cualquier cookie y date un paseo por Internet.
A pesar de su uso habitual, las cookies son el ejemplo perfecto de algo que no es con able. Esto
signi ca que el desarrollador debe comprobar que el usuario est dispuesto a aceptar las cookies antes
de con ar en ellas.
An ms importante, nunca debes almacenar informacin fundamental en las cookies. La Web rebosa
de historias de terror acerca de desarrolladores que guardaron informacin irrecuperable en las cookies
del usuario, solo para encontrarse con que el navegador haba borrado todos esos datos por cualesquiera
razones.
Las Cookies (Especialmente aquellas que no se envan mediante HTTPS) no son seguras. Dado que los
datos enviados viajan en texto claro, estn expuestas a que terceras personas lean esa informacin, lo
que se llama ataques de tipo snooping (por snoop, sgonear, husmear). Por lo tanto, un atacante que
tenga acceso al medio puede interceptar la cookie y leer su valor. El resultado de esto es que nunca se
debe almacenar informacin con dencial en una cookie.
Hay otro tipo de ataque, an ms insidioso, conocido como ataque man-in-the-middle o MitM (Ataque
de tipo Hombre-en-medio o Intermediario). Aqu, el atacante no solo intercepta la cookie, sino que
adems la usa para actuar ante el servidor como si fuera el usuario legtimo. El
`Captulo 19`_
describe en profundidad este tipo de ataques, as como formas de prevenirlo.
Las Cookies ni siquiera son seguras para los servidores. La mayora de los navegadores permiten
manipular y editar de forma sencilla los contenidos de cookies individuales, y existen herramientas
como mechanize (http://wwwsearch.sourceforge.net/mechanize/) que permiten a cualquiera que
est lo su cientemente motivado construir solicitudes HTTP a mano.
As que tampoco debemos almacenar en las cookies datos que sean fciles de falsi car. El error habitual
en este escenario consiste en almacenar algo as como
IsLoggedIn=1
en una cookie cuando el usuario
se ha validado. Te sorprendera saber cuantos sitios web cometen este tipo de error; no lleva ms de
unos segundos engaar a sus sistemas de seguridad.
12.2.
El entorno de sesiones de Django
Con todas estas limitaciones y agujeros potenciales de seguridad, es obvio que la gestin de las cookies y de las
sesiones persistentes es el origen de muchos dolores de cabeza para los desarrolladores web. Por supuesto, uno de los
objetivos de Django es evitar e cazmente estos dolores de cabeza, as que dispone de un entorno de sesiones diseado
para suavizar y facilitar todas estas cuestiones por ti.
El entorno de sesiones te permite almacenar y recuperar cualquier dato que quieras basndote en la sesin del
usuario. Almacena la informacin relevante solo en el servidor y abstrae todo el problema del envo y recepcin de las
revisin 757 del 28 de julio de 2008
146
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
cookies. Estas solo almacenan una versin codi cada (hash ) del identi cador de la sesin, y ningn otro dato, lo cual
te aisla de la mayora de los problemas asociados con las cookies.
Veamos como activar las sesiones, y como usarlas en nuestras vistas.
12.2.1.
Activar sesiones
Las sesiones se implementan mediante un poco de middleware (vase Captulo 15) y un modelo Django. Para
activar las sesiones, necesitas seguir los siguientes pasos:
1. Editar el valor de
MIDDLEWARE_CLASSES de forma que contenga 'django.contrib.sessions.middleware.SessionMiddle
'django.contrib.sessions' est incluido
manage.py syncdb si lo has tenido que aadir).
2. Comprobar que
ejecutar
Los valores por defecto creados por
startproject
en el valor de
INSTALLED_APPS
(Y
ya tienes estas dos caractersticas habilitadas, as que a menos
que las hayas borrado, es muy probable que no tengas que hacer nada para empezar a usar las sesiones.
Si lo que quieres en realidad es no usar sesiones, deberas quitar la referencia a
y borrar
'django.contrib.sessions'
de
INSTALLED_APPS.
SessionMiddleware de MIDDLEWARE_CLASSES
Esto te permitir disminuir mnimamente la sobrecarga
del servidor, pero toda ayuda es buena.
12.2.2.
Usar las sesiones en una vista
Cuando estn activadas las sesiones, los objetos
HttpRequest --el primer argumento de cualquier funcin que acte
session, que se comporta igual que un diccionario. Se puede
como una vista en Django-- tendrn un atributo llamado
leer y escribir en l de la misma forma en que lo haras con un diccionario normal. Por ejemplo, podras usar algo
como esto en una de tus vistas:
# Set a session value:
request.session["fav_color"] = "blue"
# Get a session value -- this could be called in a different view,
# or many requests later (or both):
fav_color = request.session["fav_color"]
# Clear an item from the session:
del request.session["fav_color"]
# Check if the session has a given key:
if "fav_color" in request.session:
...
Tambin puedes usar otros mtodos propios de un diccionario como
keys()
items()
en
request.session.
Hay dos o tres reglas muy sencillas para usar e cazmente las sesiones en Django:
Debes usar slo cadenas de texto normales como valores de clave en
request.session,
en vez de,
por ejemplo, enteros, objetos, etc. Esto es ms un convenio que un regla en el sentido estricto, pero
merece la pena seguirla.
Los valores de las claves de una sesin que empiecen con el carcter subrayado estn reservadas para
uso interno de Django. En la prctica, slo hay unas pocas variables as, pero, a no ser que sepas
lo que ests haciendo (y ests dispuesto a mantenerte al da en los cambios internos de Django), lo
mejor que puedes hacer es evitar usar el carcter subrayado como pre jo en tus propias variables; eso
impedir que Django pueda interferir con tu aplicacin,
Nunca reemplaces
request.session
por otro objeto, y nunca accedas o modi ques sus atributos.
Utilzalo slo como si fuera un diccionario.
Veamos un ejemplo rpido. Esta vista simpli cada de ne una variable
has_commented
como
True
despus de que
el usuario haya publicado un comentario. Es una forma sencilla (aunque no particularmente segura) de impedir que el
usuario publique dos veces el mismo comentario:
def post_comment(request, new_comment):
if request.session.get('has_commented', False):
revisin 757 del 28 de julio de 2008
12.2. EL ENTORNO DE SESIONES DE DJANGO
147
return HttpResponse("You've already commented.")
c = comments.Comment(comment=new_comment)
c.save()
request.session['has_commented'] = True
return HttpResponse('Thanks for your comment!')
Esta vista simpli cada permite que un usuario se identi que como tal en nuestras pginas:
def login(request):
try:
m = Member.objects.get(username__exact=request.POST['username'])
if m.password == request.POST['password']:
request.session['member_id'] = m.id
return HttpResponse("You're logged in.")
except Member.DoesNotExist:
return HttpResponse("Your username and password didn't match.")
Y esta le permite cerrar o salir de la sesin:
def logout(request):
try:
del request.session['member_id']
except KeyError:
pass
return HttpResponse("You're logged out.")
Nota
En la prctica, esta sera una forma psima de validar a tus usuarios. El mecanismo de autenti cacin que presentaremos un poco ms adelante realiza esta tarea de forma mucho ms segura y
robusta. Los ejemplo son deliberadamente simples para que se comprendan con ms facilidad.
12.2.3.
Comprobar que las
cookies
sean utilizables
Como ya mencionamos, no se puede con ar en que el cualquier navegador sea capaz de aceptar cookies. Por ello,
Django incluye una forma fcil de comprobar que el cliente del usuario disponga de esta capacidad. Slo es necesario
request.session.set_test_cookie() en una vista, y comprobar posteriormente, en otra vista
request.session.test_cookie_worked().
un tanto extraa entre las llamadas a set_test_cookie() y test_cookie_worked() se debe a la
llamar a la funcin
distinta, el resultado de llamar a
Esta divisin
forma es que trabajan las cookies. Cuando se de ne una cookie, no tienes forma de saber si el navegador la ha aceptado
realmente hasta la siguiente solicitud.
Es una prctica recomendable llamar a la funcin
delete_test_cookie() para limpiar la cookie de prueba despus
de haberla usado. Lo mejor es hacerlo justo despus de haber veri cado que las cookies funcionan.
He aqu un ejemplo tpico de uso:
def login(request):
# If we submitted the form...
if request.method == 'POST':
# Check that the test cookie worked (we set it below):
if request.session.test_cookie_worked():
# The test cookie worked, so delete it.
request.session.delete_test_cookie()
# In practice, we'd need some logic to check username/password
# here, but since this is an example...
return HttpResponse("You're logged in.")
# The test cookie failed, so display an error message. If this
revisin 757 del 28 de julio de 2008
148
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
# was a real site we'd want to display a friendlier message.
else:
return HttpResponse("Please enable cookies and try again.")
# If we didn't post, send the test cookie along with the login form.
request.session.set_test_cookie()
return render_to_response('foo/login_form.html')
Nota
De nuevo, las funciones de autenti cacin ya de nidas en el entorno realizan estos chequeos por
ti.
12.2.4.
Usar las sesiones fuera de las vistas
Internamente, cada sesin es simplemente un modelo de entidad de Django como cualquier otro, de nido en
django.contrib.sessions.models. Cada sesin se identi ca gracias a un hash
pseudo-aleatorio de 32 caracteres, que
es el valor que se almacena en la cookie. Dado que es un modelo normal, puedes acceder a las propiedades de las
sesiones usando la API de acceso a la base de datos de Django:
>>> from django.contrib.sessions.models import Session
>>> s = Session.objects.get(pk='2b1189a188b44ad18c35e113ac6ceead')
>>> s.expire_date
datetime.datetime(2005, 8, 20, 13, 35, 12)
Para poder acceder a los datos de la sesin, hay que usar el mtodo
get_decoded(). Esto se debe a que estos datos,
que consistan en un diccionario, estn almacenados codi cados:
>>> s.session_data
'KGRwMQpTJ19hdXRoX3VzZXJfaWQnCnAyCkkxCnMuMTExY2ZjODI2Yj...'
>>> s.get_decoded()
{'user_id': 42}
12.2.5.
Cundo se salvan las sesiones
Django, en principio, solo salva la sesin en la base de datos si esta ha sido modi cada; es decir, si cualquiera de
los valores almacenados en el diccionario es asignado o borrado. Esto puede dar lugar a algunos errores sutiles, como
se indica en el ltimo ejemplo:
# Session is modified.
request.session['foo'] = 'bar'
# Session is modified.
del request.session['foo']
# Session is modified.
request.session['foo'] = {}
# Gotcha: Session is NOT modified, because this alters
# request.session['foo'] instead of request.session.
request.session['foo']['bar'] = 'baz'
Se puede cambiar este comportamiento, especi cando la opcin
SESSION_SAVE_EVERY_REQUEST
True.
Si lo ha-
cemos as, Django salvar la sesin en la base de datos en cada peticin, incluso si no se ha modi cado ninguno de sus
valores.
SESSION_SAVE_EVERY_REQUEST
True, la cookie de sesin ser reenviada en cada peticin. De forma similar, la seccin de expiracin (expires)
Fjate que la cookie de sesin slo se enva cuando se ha creado o modi cado una sesin. Si
est como
se actualizar cada vez que se reenve la cookie.
revisin 757 del 28 de julio de 2008
12.2. EL ENTORNO DE SESIONES DE DJANGO
12.2.6.
149
Sesiones breves frente a sesiones persistentes
Es posible que te hayas jado en que la cookie que nos envi Google al principio del captulo contena el siguiente
texto
expires=Sun, 17-Jan-2038 19:14:07 GMT;.
Las Cookies pueden incluir opcionalmente una fecha de expira-
cin, que informa al navegador del momento en que se debe desechar, por invlida. Si la cookie no contiene ningn
valor de expiracin, el navegador entiende que esta debe expirar en el momento en que se cierra el propio navegador.
Se puede controlar el comportamiento del entorno para que use cookies de este tipo, breves, ajustando en valor de la
SESSION_EXPIRE_AT_BROWSER_CLOSE.
SESSION_EXPIRE_AT_BROWSER_CLOSE es False, lo que signi ca que las cookies
almacenadas en el navegador del usuario durante SESSION_COOKIE_AGE segundos (Cuyo valor por defecto es de
opcin
El valor por omisin de la opcin
sern
dos semanas, o 1.209.600 segundos). Estos valores son adecuados si no quieres obligar a tus usuarios a validarse cada
vez que abran el navegador y accedan a tu pgina.
Si
SESSION_EXPIRE_AT_BROWSER_CLOSE
se establece a
True,
Django usar cookies que se invalidarn cuando el
usuario cierre el navegador.
12.2.7.
Otras caractersticas de las sesiones
Adems de las caractersticas ya mencionadas, hay otros valores de con guracin que in uyen en la gestin de
sesiones con Django, tal y como se muestra en la tabla 12-2.
Cuadro 12.2: Valores de con guracin que in uyen en el comportamiento de las cookies
Opcin
SESSION_COOKIE_DOMAIN
Descripcin
Valor por defecto
El Dominio a utilizar por la cookie de se-
None
sin. Se puede utilizar, por ejemplo, el valor
".lawrence.com"
para utilizar la co-
okie en diferentes subdominios. El valor
None
SESSION_COOKIE_NAME
indica una cookie estndar.
El nombre de la cookie de sesiones. Puede
"sessionid"
ser cualquier cadena de texto.
SESSION_COOKIE_SECURE
Indica si se debe usar una cookie segura para la cookie de sesin. Si el valor es
True,
la cookie se marcar como segura,
lo que signi ca que slo se podr utilizar
mediante el protocolo HTTPS.
revisin 757 del 28 de julio de 2008
False
150
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Detalles tcnicos
Para los ms curiosos, he aqu una serie de notas tcnicas acerca de algunos aspectos interesantes
de la gestin interna de las sesiones:
El diccionario de la sesin acepta cualquier objeto Python capaz de ser serializado con
pickled.
pickle
Vase la documentacin del mdulo
incluido en la
biblioteca estndar de Python para ms informacin.
Los datos de la sesin se almacenan en una tabla en la base de datos llamada
django_session.
Los datos de la sesin son suministrados bajo demanda. Si nunca accedes al
atributo
request.session,
Django
slo
enva
la
Django nunca acceder a la base de datos.
cookie
si
tiene
que
hacerlo.
Si
no
modi cas
nin-
gn valor de la sesin, no reenva la cookie (A no ser que hayas de nido
SESSION_SAVE_EVERY_REQUEST
como
True).
El entorno de sesiones de Django se basa entera y exclusivamente en las cookies.
No almacena la informacin de la sesin en las URL, como recurso extremo en el
caso de que no se puedan utilizar las cookies, como hacen otros entornos (PHP,
JSP).
Esta es una decisin tomada de forma consciente. Poner los identi cadores de
sesin en las URL no solo hace que las direcciones sean ms feas, tambin
hace que el sistema sea vulnerable ante un tipo de ataque en que se roba el
identi cador de la sesin utilizando la cabecera
Si
aun
te
pica
la
curiosidad,
django.contrib.sessions
12.3.
el
cdigo
fuente
es
Referer.
bastante
directo
claro,
mira
en
para ms detalles.
Usuarios e identi cacin
TM . Las sesiones nos permiten
Estamos ya a medio camino de poder conectar los navegadores con la Gente de Verdad
almacenar informacin a lo largo de las diferentes peticiones del navegador; la segunda parte de la ecuacin es utilizar
esas sesiones para validar al usuario, es decir, permitirle hacer login. Por supuesto, no podemos simplemente con ar
en que los usuarios sean quien dicen ser, necesitamos autenti carlos de alguna manera.
Naturalmente, Django nos proporciona las herramientas necesarias para tratar con este problema tan habitual (Y
con muchos otros). El sistema de autenti cacin de usuarios de Django maneja cuentas de usuarios, grupos, permisos
y sesiones basadas en cookies. El sistema tambin es llamada sistema aut/aut (autentica cacin y autorizacin). El
nombre implica que, a menudo, tratar con los usuarios implica dos procesos. Se necesita:
Veri car (autenti cacin ) que un usuario es quien dice ser (Normalmente comprobando un nombre
de usuario y una contrasea contra una tabla de una base de datos)
Veri car que el usuario est autorizado (autorizacin ) a realizar una operacin determinada (Normalmente comprobando una tabla de permisos)
Siguiendo estos requerimientos, el sistema aut/aut de Django consta de los siguientes componentes:
Usuarios : Personas registradas en tu sitio web
Permisos : Valores binarios (Si/No) que indican si un usuario puede o no realizar una tarea determinada.
grupos : Una forma genrica de aplicar etiquetas y permisos a ms de un usuario.
mensajes : Un mecanismo sencillo que permite enviar y mostrar mensajes del sistema usando una cola.
Per les : Un mecanismo que permite extender los objetos de tipo usuario con campos adicionales.
Si ya has utilizado la herramienta de administracin (descrita en el Captulo 6), habrs visto muchas de estas
utilidades, y si has modi cado usuarios y grupos con dicha herramienta, ya has modi cado las tablas en las que se
basa el sistema aut/aut.
revisin 757 del 28 de julio de 2008
12.4. UTILIZANDO USUARIOS
12.3.1.
151
Habilitando el soporte para autenti cacin
Al igual que ocurra con las sesiones, el sistema de autenti cacin viene incluido como una aplicacin en el mdulo
django.contrib,
y necesita ser instalado. De igual manera, viene instalado por defecto, por lo que solo es necesario
seguir los siguientes pasos si previamente la has desinstalado:
Comprueba que el sistema de sesiones est activo, tal y como se explico previamente en este captulo.
Seguir la pista de los usuario implica usar cookies, y por lo tanto necesitamos el entorno de sesiones
operativo.
Incluye
'django.contrib.auth'
dentro de tu
INSTALLED_APPS
y ejecuta
manage.py syncdb.
'django.contrib.auth.middleware.AuthenticationMiddleware'
MIDDLEWARE_CLASSES despus de SessionMiddleware.
Asegrate de que
en
est incluido
Una vez resuelto este tema, ya estamos preparados para empezar a lidiar con los usuarios en nuestras vistas. La
principal interfaz que usars para trabajar con los datos del usuario dentro de una vista es
request.user; es un objeto
que representa al usuario que est conectado en ese momento. Si no hay ningn usuario conectado, este objeto ser
una instancia de la clase
AnonymousUser
(Veremos ms sobre esta clase un poco ms adelante).
Puedes saber fcilmente si el usuario est identi cado o no con el mtodo
is_authenticated():
if request.user.is_authenticated():
# Do something for authenticated users.
else:
# Do something for anonymous users.
12.4.
Utilizando usuarios
Una vez que ya tienes un usuario (normalmente mediante
request.user, pero tambin puede ser por otros mtodos,
que se describirn en breve) dispondrs de una serie de campos de datos y mtodos asociados al mismo. Los objetos
AnonymousUser emulan parte de esta interfaz, pero no toda, por lo que es preferible comprobar el resultado
user.is_authenticated() antes de asumir de buena fe que nos encontramos ante un usuario legtimo. Las tablas
12-3 y 12-4 listan todos los campos y mtodos, respectivamente, de los objetos de la clase User.
de la clase
de
Cuadro 12.3: Campos de los objetos User
Campo
username
Descripcin
Obligatorio; 30 caracteres como mximo. Slo acepta caracteres alfanumricos (letras, dgitos y el carcter subrayado).
first_name
last_name
email
password
Opcional; 30 caracteres como mximo.
Opcional; 30 caracteres como mximo.
Opcional. Direccin de correo electrnico.
Obligatorio. Un cdigo de comprobacin (hash ), junto con otros metadatos
de la contrasea. Django nunca almacena la contrasea en crudo. Vase la
seccin `Contraseas`_ para ms informacin
is_staff
Booleano. Indica que el usuario puede acceder a las secciones de administracin.
is_active
Booleano. Indica que la cuenta puede ser usada para identi carse. Se puede
poner a
False
para deshabilitar a un usuario sin tener que borrarlo de la
tabla.
is_superuser
Booleano. Seala que el usuario tiene todos los permisos, an cuando no se
le hayan asignado explcitamente
last_login
Fecha y hora de la ltima vez que el usuario se identi c. Se asigna automticamente a la fecha actual por defecto.
date_joined
Fecha y hora en que fue creada esta cuenta de usuario. Se asigna automticamente a la fecha actual en su momento.
revisin 757 del 28 de julio de 2008
152
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Cuadro 12.4: Mtodos de los objetos User
Mtodo
Descripcin
is_authenticated()
Siempre devuelve
True
para usuario reales. Es una forma
de determinar si el usuario se ha identi cado. esto no implica que posea ningn permiso, y tampoco comprueba que
la cuenta est activa. Slo indica que el usuario se ha identi cado con xito.
is_anonymous()
True` slo para usuarios annimos, y
``False` para usuarios "reales". En general, es
preferible usar el mtodo `is_authenticated().
Devuelve la concatenacin de los campos first_name y
last_name, con un espacio en medio.
Devuelve
get_full_name()
set_password(passwd)
Cambia la contrasea del usuario a la cadena de texto en
claro indicada, realizando internamente las operaciones necesarias para calcular el cdigo de comprobacin o hash
necesario. Este mtodo no salva el objeto
check_password(passwd)
devuelve
True
User.
si la cadena de texto en claro que se le pasa
coincide con la contrasea del usuario. Realiza internamente las operaciones necesarias para calcular los cdigos de
comprobacin o hash necesarios.
get_group_permissions()
Devuelve una lista con los permisos que tiene un usuario,
obtenidos a travs del grupo o grupos a las que pertenezca.
get_all_permissions()
Devuelve una lista con los permisos que tiene concedidos un
usuario, ya sea a travs de los grupos a los que pertenece o
bien asignados directamente.
has_perm(perm)
True si el usuario tiene el permiso indicado. El
perm est en el formato `"package.codename". Si
el usuario no est activo, siempre devolver False.
Devuelve True si el usuario tiene todos los permisos indicados. Si el usuario no est activo, siempre devolver False.
Devuelve True si el usuario tiene algn permiso en la etiqueta de aplicacin indicada, app_label. Si el usuario no
est activo, siempre devolver False.
Devuelve
valor de
has_perms(perm_list)
has_module_perms(app_label)
get_and_delete_messages()
Devuelve
email_user(subj, msg)
Enva un correo electrnico al usuario. El mensaje apare-
una
lista
de
mensajes
(objetos
de
la
clase
Message) de la cola del usuario, y los borra posteriormente.
ce como enviado desde la direccin indicada en el valor
DEFAULT_FROM_EMAIL. Se le puede pasar un tercer parfrom_email, para indicar otra direccin de
metro opcional,
remite distinta.
get_profile()
Devuelve un per l del usuario espec co para el sitio. En la
seccin Per les se explicar con ms detalle este mtodo.
User mantienen dos campos de relaciones mltiples o muchos-a-muchos: Grupos y
permissions). Se puede acceder a estos objetos relacionados de la misma manera en que se usan
Por ltimo, los objetos de tipo
permisos (groups y
otros campos mltiples:
# Set a user's groups:
myuser.groups = group_list
# Add a user to some groups:
myuser.groups.add(group1, group2,...)
# Remove a user from some groups:
myuser.groups.remove(group1, group2,...)
revisin 757 del 28 de julio de 2008
12.4. UTILIZANDO USUARIOS
153
# Remove a user from all groups:
myuser.groups.clear()
# Permissions work the same way
myuser.permissions = permission_list
myuser.permissions.add(permission1, permission2, ...)
myuser.permissions.remove(permission1, permission2, ...)
myuser.permissions.clear()
12.4.1.
Iniciar y cerrar sesin
Django proporciona vistas prede nidas para gestionar la entrada del usuario, (el momento en que se identi ca), y la
salida, (es decir, cuando cierra la sesin), adems de otros trucos ingeniosos. Pero antes de entrar en detalles, veremos
como hacer que los usuario pueden iniciar y cerrar la sesin a mano. Django incluye dos funciones para realizar estas
acciones, en el mdulo
django.contrib.auth: authenticate()
login().
Para autenti car un identi cador de usuario y una contrasea, se utiliza la funcin
acepta dos parmetros ,
username
password,
y devuelve un objeto de tipo
User
authenticate().
esta funcin
si la contrasea es correcta para el
identi cador de usuario. Si falla la comprobacin (ya sea porque sea incorrecta la contrasea o porque sea incorrecta
la identi cacin del usuario), la funcin devolver
>>>
>>>
>>>
...
...
...
None:
from django.contrib import auth
user = auth.authenticate(username='john', password='secret')
if user is not None:
print "Correct!"
else:
print "Oops, that's wrong!"
La llamada a
login() para
objeto User y
authenticate()
slo veri ca las credenciales del usuario. Todava hay que realizar una llamada a
completar el inicio de sesin. La llamada a
login()
acepta un objeto de la clase
HttpRequest
y un
almacena el identi cador del usuario en la sesin, usando el entorno de sesiones de Django.
El siguiente ejemplo muestra el uso de ambas funciones,
authenticate()
login(),
dentro de una vista:
from django.contrib import auth
def login(request):
username = request.POST['username']
password = request.POST['password']
user = auth.authenticate(username=username, password=password)
if user is not None and user.is_active:
# Correct password, and the user is marked "active"
auth.login(request, user)
# Redirect to a success page.
return HttpResponseRedirect("/account/loggedin/")
else:
# Show an error page
return HttpResponseRedirect("/account/invalid/")
django.contrib.auth.logout() dentro
HttpRequest, y no devuelve ningn valor:
Para cerrar la sesin, se puede llamar a
pase como parmetro un objeto de tipo
de una vista. Necesita que se le
from django.contrib import auth
def logout(request):
auth.logout(request)
# Redirect to a success page.
return HttpResponseRedirect("/account/loggedout/")
La llamada a
logout()
no produce ningn error, aun si no hubiera ningn usuario conectado.
En la prctica, no es normalmente necesario escribir tus propias funciones para realizar estas tareas; el sistema de
autenti cacin viene con un conjunto de vistas prede nidas para ello.
revisin 757 del 28 de julio de 2008
154
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
El primer paso para utilizar las vistas de autenti cacin es mapearlas en tu URLconf. Necesitas modi car tu cdigo
hasta tener algo parecido a esto:
from django.contrib.auth.views import login, logout
urlpatterns = patterns('',
# existing patterns here...
(r'^accounts/login/$', login),
(r'^accounts/logout/$', logout),
)
/accounts/login/
/accounts/logout/ son las URL por defecto que usa Django para estas vistas.
login utiliza la plantilla de nida en registration/login.html (puedes cambiar el nombre
de la plantilla utilizando un parmetro opcional, template_name). El formulario necesita contener un campo llamado
username y otro llamado password. Una plantilla de ejemplo podra ser esta:
y
Por defecto, la vista de
{ % extends "base.html" %}
{ % block content %}
{ % if form.errors %}
<p class="error">Sorry, that's not a valid username or password</p>
{ % endif %}
<form action='.' method='post'>
<label for="username">User name:</label>
<input type="text" name="username" value="" id="username">
<label for="password">Password:</label>
<input type="password" name="password" value="" id="password">
<input type="submit" value="login" />
<input type="hidden" name="next" value="{{ next|escape }}" />
<form action='.' method='post'>
{ % endblock %}
/accounts/profile/. Puedes indicar una
next, cuyo valor debe ser la URL
puedes pasar este valor como un parmetro GET a la vista de
al contexto en una variable llamada next, que puedes incluir
Si el usuario se identi ca correctamente, su navegador ser redirigido a
direccin distinta especi cando un tercer campo (normalmente oculto) que se llame
a redireccionar despus de la identi cacin. Tambin
identi cacin y se aadir automticamente su valor
ahora en un campo oculto.
La vista de cierre de sesin se comporta de forma un poco diferente. Por defecto utiliza la plantilla de nida
en
registration/logged_out.html
(Que normalmente contiene un mensaje del tipo Ha cerrado su sesin). No
obstante, se puede llamar a esta vista con un parmetro extra, llamado
next_page,
que indicara la vista a la que se
debe redirigir una vez efectuado el cierre de la sesin.
12.4.2.
Limitar el acceso a los usuarios identi cados
Por supuesto, la razn de haber implementado todo este sistema es permitirnos limitar el acceso a determinadas
partes de nuestro sitio.
La forma ms simple y directa de limitar este acceso es comprobar el resultado de llamar a la funcin
y redirigir a una pgina de identi cacin, si procede:
from django.http import HttpResponseRedirect
def my_view(request):
if not request.user.is_authenticated():
return HttpResponseRedirect('/login/?next= %s' % request.path)
# ...
O quizs mostrar un mensaje de error:
revisin 757 del 28 de julio de 2008
request.user.is_authentic
12.4. UTILIZANDO USUARIOS
155
def my_view(request):
if not request.user.is_authenticated():
return render_to_response('myapp/login_error.html')
# ...
Si se desea abreviar, se puede usar el decorador
login_required
sobre las vistas que nos interese proteger:
from django.contrib.auth.decorators import login_required
@login_required
def my_view(request):
# ...
Esto es lo que hace el decorador
login_required:
/accounts/login/, incluyendo la url
/accounts/login/?next=/polls/3/.
Si el usuario no est identi cado, redirige a la direccin
como un parmetro con el nombre
next,
por ejemplo
actual
Si el usuario est identi cado, ejecuta la vista sin ningn cambio. La vista puede asumir sin problemas
que el usuario esta identi cado correctamente
12.4.3.
Limitar el acceso a usuarios que pasan una prueba
Se puede limitar el acceso basndose en ciertos permisos o en algn otro tipo de prueba, o proporcionar una pgina
de identi cacin distinta de la vista por defecto, y las dos cosas se hacen de manera similar.
La forma ms cruda es ejecutar las pruebas que queremos hacer directamente en el cdigo de la vista. Por ejemplo,
para comprobar que el usuario est identi cado y que, adems, tenga asignado el permiso
polls.can_vote (Se explicar
esto de los permisos con ms detalle dentro de poco ) haramos:
def vote(request):
if request.user.is_authenticated() and request.user.has_perm('polls.can_vote')):
# vote here
else:
return HttpResponse("You can't vote in this poll.")
De nuevo, Django proporciona una forma abreviada llamada
user_passes_test.
Requiere que se la pasen unos
argumentos y genera un decorador especializado para cada situacin en particular:
def user_can_vote(user):
return user.is_authenticated() and user.has_perm("polls.can_vote")
@user_passes_test(user_can_vote, login_url="/login/")
def vote(request):
# Code here can assume a logged-in user with the correct permission.
...
user_passes_test tiene un parmetro obligatorio: un objeto que se pueda llamar (normalmente una
User, y devuelva True si el usuario puede acceder
caso contrario. Es importante destacar que user_passes_test no comprueba automticamente que el
El decorador
funcin) y que a su vez acepte como parmetro un objeto del tipo
y
False
en
usuario est identi cado; esa es una comprobacin que se debe hacer explcitamente.
En este ejemplo, hemos usado tambin un segundo parmetro opcional,
login_url,
que te permite indicar la url
de la pgina que el usuario debe utilizar para identi carse (/accounts/login/ por defecto).
Comprobar si un usuario posee un determinado permiso es una tarea muy frecuente, as que Django proporciona una
forma abreviada para estos casos: El decorador
permission_required().
Usando este decorador, el ejemplo anterior
se podra codi car as:
from django.contrib.auth.decorators import permission_required
@permission_required('polls.can_vote', login_url="/login/")
def vote(request):
# ...
El decorador permission_required()
/accounts/login/ en caso de omisin.
tambin acepta el parmetro opcional
revisin 757 del 28 de julio de 2008
login_url,
de nuevo con el valor
156
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Limitar el acceso a vistas genricas
Una de las preguntas ms frecuentes en la lista de usuarios de Django trata de cmo limitar el
acceso a una vista genrica. Para conseguirlo, tienes que usar un recubrimiento sencillo alrededor
de la vista que quieres proteger, y apuntar en tu URLconf al recubrimiento en vez de a la vista
genrica:
from dango.contrib.auth.decorators import login_required
from django.views.generic.date_based import object_detail
@login_required
def limited_object_detail(*args, **kwargs):
return object_detail(*args, **kwargs)
Puedes cambiar el decorador
12.4.4.
login_required por cualquier otro que quieras usar, como es lgico.
Gestionar usuarios, permisos y grupos
La forma ms fcil de gestionar el sistema de autenti cacin es a travs de la interfaz de administracin
admin.
El
Captulo 6 describe como usar esta interfaz para modi car los datos de los usuarios y controlar sus permisos y accesos,
y la mayor parte del tiempo esa es la forma ms adecuada de gestin.
A veces, no obstante, hace falta un mayor control, y para eso podemos utilizar las llamadas a bajo nivel que
describiremos en este captulo.
Crear usuarios
Puedes crear usuarios con el mtodo
create_user:
>>> from django.contrib.auth.models import User
>>> user = User.objects.create_user(username='john',
...
email='[email protected]',
...
password='glass onion')
En este momento,
user
es una instancia de la clase
(create_user() no llama al mtodo
save()).
User,
preparada para ser almacenada en la base de datos
Este te permite cambiar algunos de sus atributos antes de salvarlos, si
quieres:
>>> user.is_staff = True
>>> user.save()
Cambia contraseas
Puedes cambiar las contrasea de un usuario llamando a
set_password():
>>> user = User.objects.get(username='john')
>>> user.set_password('goo goo goo joob')
>>> user.save()
No debes modi car directamente el atributo
password,
a no ser que tengas muy claro lo que ests haciendo. La
contrasea se almacena en la base de datos en forma de cdigo de comprobacin (salted hash ) y, por tanto, debe ser
modi cada slo a travs de este mtodo.
Para ser ms exactos, el atributo
password
de un objeto
User
es una cadena de texto con el siguiente formato:
hashtype$salt$hash
Es decir, el tipo de hash, el grano de sal (salt ) y el cdigo hash propiamente dicho, separados entre si por el carcter
dolar ($).
El valor de
hashtype puede ser sha1 (por defecto) o md5, el algoritmo usado para realizar una transformacin hash
de un solo sentido sobre la contrasea. El grano de sal es una cadena de texto aleatoria que se utiliza para aumentar
la resistencia de esta codi cacin frente a un ataque por diccionario. Por ejemplo:
sha1$a1976$a36cc8cbf81742a8fb52e221aaeab48ed7f58ab4
revisin 757 del 28 de julio de 2008
12.4. UTILIZANDO USUARIOS
Las funciones
157
User.set_password()
User.check_password()
manejan todos estos detalles y comprobaciones
de forma transparente.
Tengo que echar sal a mi ordenador?
No, la sal de la que hablamos no tiene nada que ver con ninguna receta de cocina; es una forma
habitual de aumentar la seguridad a la hora de almacenar una contrasea. Una funcin hash es
una funcin criptogr ca, que se caracteriza por ser de un solo sentido; es decir, es fcil calcular el
cdigo hash de un determinado valor, pero es prcticamente imposible reconstruir el valor original
partiendo nicamente del cdigo hash.
Si almacenramos las contraseas como texto en claro, cualquiera que pudiera obtener acceso a
la base de datos podra saber sin ninguna di cultad todas las contraseas al instante. Al guardar
las contraseas en forma de cdigos hash se reduce el peligro en caso de que se comprometa la
seguridad de la base de datos.
No obstante, un atacante que pudiera acceder a la base de datos podra ahora realizar un ataque
por fuerza bruta, calculando los cdigos hash de millones de contraseas distintas y comparando
esos cdigos con los que estn almacenados en la base de datos. Este llevar algo de tiempo, pero
menos de lo que parece, los ordenadores son increblemente rpidos.
Para empeorar las cosas, hay disponibles pblicamente lo que se conoce como tablas arco iris
(rainbow tables ), que consisten en valores hash precalculados de millones de contraseas de uso
habitual. Usando una tabla arco iris, un atacante puede romper la mayora de las contraseas en
segundos.
Para aumentar la seguridad, se aade un valor inicial aleatorio y diferente a cada contrasea antes
de obtener el cdigo hash. Este valor aleatorio es el grano de sal. Como cada grano de sal es
diferente para cada password se evita el uso de tablas arco iris, lo que obliga al atacante a volver
al sistema de ataque por fuerza bruta, que a su vez es ms complicado al haber aumentado la
entropa con el grano de sal. Otra ventaja es que si dos usuarios eligen la misma contrasea, al
aadir el grano de sal los cdigos hash resultantes sern diferentes.
Aunque esta tcnica no es, en trminos absolutos, la ms segura posible, ofrece un buen compromiso entre seguridad y conveniencia.
El alta del usuario
Podemos usar estas herramientas de bajo nivel para crear vistas que permitan al usuario darse de alta. Prcticamente todos los desarrolladores quieren implementar el alta del usuario a su manera, por lo que Django da la opcin
de crearte tu propia vista para ello. Afortunadamente, es muy fcil de hacer.
La forma ms sencilla es escribir una pequea vista que pregunte al usuario los datos que necesita y con ellos se
cree directamente el usuario. Django proporciona un formulario prefabricado que se puede usar con este n, como se
muestra en el siguiente ejemplo:
from
from
from
from
django import oldforms as forms
django.http import HttpResponseRedirect
django.shortcuts import render_to_response
django.contrib.auth.forms import UserCreationForm
def register(request):
form = UserCreationForm()
if request.method == 'POST':
data = request.POST.copy()
errors = form.get_validation_errors(data)
if not errors:
new_user = form.save(data)
return HttpResponseRedirect("/books/")
else:
data, errors = {}, {}
return render_to_response("registration/register.html", {
'form' : forms.FormWrapper(form, data, errors)
})
revisin 757 del 28 de julio de 2008
158
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Este formulario asume que existe una plantilla llamada
registration/register.html. esa plantilla podra consistir
en algo parecido a esto:
{ % extends "base.html" %}
{ % block title %}Create an account{ % endblock %}
{ % block content %}
<h1>Create an account</h1>
<form action="." method="post">
{ % if form.error_dict %}
<p class="error">Please correct the errors below.</p>
{ % endif %}
{ % if form.username.errors %}
{{ form.username.html_error_list }}
{ % endif %}
<label for="id_username">Username:</label> {{ form.username }}
{ % if form.password1.errors %}
{{ form.password1.html_error_list }}
{ % endif %}
<label for="id_password1">Password: {{ form.password1 }}
{ % if form.password2.errors %}
{{ form.password2.html_error_list }}
{ % endif %}
<label for="id_password2">Password (again): {{ form.password2 }}
<input type="submit" value="Create the account" />
</label>
{ % endblock %}
Nota
django.contrib.auth.forms.UserCreationForm es, a la hora de publicar esto, un formulario del estilo oldforms. Vase http://www.djangoproject.com/documentation/0.96/forms/
para ms detalles sobre oldforms. La transicin al nuevo sistema, tal y como se explica en el captulo siete, ser completada muy pronto.
12.4.5.
Usar informacin de autenti cacin en plantillas
El usuario actual, as como sus permisos, estn disponibles en el contexto de la plantilla cuando usas
(vase
RequestContext
`Captulo 10`_).
Nota
Tcnicamente
hablando,
tilla
usas
estas
variables
estn
RequestContext y en
"django.core.context_processors.auth" en
slo
si
disponibles
la
en
el
con guracin
la opcin
contexto
est
de
incluido
la
plan-
el
valor
TEMPLATE_CONTEXT_PROCESSORS,
que es el valor que viene prede nido cuando se crea un proyecto. Como ya se coment, vase
el
`Captulo 10`_ para ms informacin.
Cuando se usa
RequestContext, el usuario actual (Ya sea una instancia de User o de AnonymousUser) es accesible
{{ user }}:
en la plantilla con el nombre
{ % if user.is_authenticated %}
<p>Welcome, {{ user.username }}. Thanks for logging in.</p>
{ % else %}
<p>Welcome, new user. Please log in.</p>
{ % endif %}
revisin 757 del 28 de julio de 2008
12.5. EL RESTO DE DETALLES: PERMISOS, GRUPOS, MENSAJES Y PERFILES
Los permisos del usuario se almacenan en la variable
{{ perms }}.
159
En realidad, es una forma simpli cada de
acceder a un par de mtodos sobre los permisos que veremos en breve.
Hay dos formas de usar este objeto
perms. Puedes usar {{ perms.polls }} para comprobar si un usuario tienen al{{ perms.polls.can_vote
gn permiso para una determinada aplicacin, o se puede usar una forma ms espec ca, como
}},
para comprobar si el usuario tiene concedido un permiso en concreto.
Por lo tanto, se pueden usar estas comprobaciones en sentencias
{ % if %}:
{ % if perms.polls %}
<p>You have permission to do something in the polls app.</p>
{ % if perms.polls.can_vote %}
<p>You can vote!</p>
{ % endif %}
{ % else %}
<p>You don't have permission to do anything in the polls app.</p>
{ % endif %}
12.5.
El resto de detalles: permisos, grupos, mensajes y per les
Hay unas cuantas cosas que pertenecen al entorno de autenti cacin y que hasta ahora slo hemos podido ver de
pasada. En esta seccin las veremos con un poco ms de detalle.
12.5.1.
Permisos
Los permisos son una forma sencilla de marcar que determinados usuarios o grupos pueden realizar una accin.
Se usan normalmente para la parte de administracin de Django, pero puedes usarlos tambin en tu cdigo.
El sistema de administracin de Django utiliza los siguientes permisos:
Acceso a visualizar el formulario Aadir, y Aadir objetos, est limitado a los usuarios que tengan
el permiso add para ese tipo de objeto.
El acceso a la lista de cambios, ver el formulario de cambios y cambiar un objeto est limitado a los
usuarios que tengan el permisos change para ese tipo de objeto.
Borrar objetos est limitado a los usuarios que tengan el permiso delete para ese tipo de objeto.
Los permisos se de nen a nivel de las clases o tipos de objetos, no a nivel de instancias. Por ejemplo, se puede decir
Mara puede modi car los reportajes nuevos, pero no Mara solo puede modi car los reportajes nuevos que haya
creado ella, ni Mara slo puede cambiar los reportajes que tengan un determinado estado, fecha de publicacin o
identi cador.
Estos tres permisos bsicos, aadir, cambiar y borrar, se crean automticamente para cualquier modelo Django
que incluya una clase
manage.py syncdb.
Admin.
Entre bambalinas, los permisos se aada a la tabla
auth_permission
cuando ejecutas
"<app>.<action>_<object_name>". Por ejemplo, si tienes una
encuestas, con un modelo llamado Respuesta, se crearan automticamente los tres permisos con
los nombres "encuestas.add_respuesta", "encuestas.change_respuesta" y "encuestas.delete_respuesta".
Hay que tener cuidado de que el modelo tenga creada una clase Admin a la hora de ejecutar syncdb. Si no la tiene,
no se crearn los permisos. Si has inicializado la base de datos y has aadido la clase Admin con posterioridad, debes
ejecutar otra vez syncdb para crear los permisos.
Tambin puedes de nir tus propios permisos para un modelo, usando el atributo permissions en la clase Meta. El
Estos permisos se crean con el siguiente formato:
aplicacin llamada
siguiente ejemplo crea tres permisos hechos a medida:
class USCitizen(models.Model):
# ...
class Meta:
permissions = (
# Permission identifier
("can_drive",
("can_vote",
("can_drink",
)
human-readable permission name
"Can drive"),
"Can vote in elections"),
"Can drink alcohol"),
revisin 757 del 28 de julio de 2008
160
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
Esto permisos slo se crearn cuando ejecutes
syncdb.
Es responsabilidad tuya comprobar estos permisos en tus
vistas.
Igual que con los usuarios, los permisos se implementa en un modelo Django que reside en el mdulo
django.contrib.auth.model
Esto signi ca que puedes usar la API de acceso a la base de datos para interactuar con los permisos de la forma que
quieras.
12.5.2.
Grupos
Los grupos son una forma genrica de trabajar con varios usuarios a la vez, de forma que se les pueda asignar
permisos o etiquetas en bloque. Un usuario puede pertenecer a varios grupos a la vez.
Un usuario que pertenezca a un grupo recibe automticamente todos los permisos que se la hayan otorgado al
grupo. Por ejemplo, si el grupo
Editores
tiene el permiso
can_edit_home_page,
cualquier usuario que pertenezca a
dicho grupo tambin tiene ese permiso.
Los grupos tambin son una forma cmoda de categorizar a los usuarios para asignarles una determinada etiqueta,
o para otorgarles una funcionalidad extra. Por ejemplo, se puede crear un grupo
Usuarios especiales,
y utilizar
cdigo para permitir el acceso a determinadas porciones de tu sitio slo a los miembros de ese grupo, o para enviarles
un correo electrnico slo a ellos.
Al igual que con los usuarios, la manera ms sencilla de gestionar los grupos es usando la interfaz de administracin
de Django. Los grupos, en cualquier caso, son modelos Django que residen en el mdulo
django.contrib.auth.models
as que, al igual que en el caso anterior, puedes usar la API de acceso a la base de datos para trabajar con los grupos
a bajo nivel.
12.5.3.
Mensajes
El sistema de mensajes es un forma muy ligera y sencilla de enviarle mensajes a un usuario. Cada usuario tiene
asociada una cola de mensajes, de forma que los mensajes lleguen en el orden en que fueron enviados. Los mensajes
no tienen ni fecha de caducidad ni fecha de envo.
La interfaz de administracin de Django usa los mensajes para noti car que determinadas acciones han podido ser
llevadas a cabo con xito. Por ejemplo, al crear un objeto, vers que aparece un mensaje en lo alto de la pgina de
administracin, indicando que se ha podido crear el objeto sin problemas.
Puedes usar la misma API para enviar o mostrar mensajes en tu propia aplicacin. Las llamadas de la API son
bastante simples:
Para crear un nuevo mensaje usa
user.message_set.create(message='message_text').
user.get_and_delete_messages(), la cual retorna una lista
Message en la cola del usuario (si es que existiera alguno) y elimina el mensaje de la misma.
Para recuperar/eliminar mensajes usa
de objetos
En el siguiente ejemplo, la vista salva un mensaje para el usuario despus de crear una lista de reproduccin:
def create_playlist(request, songs):
# Create the playlist with the given songs.
# ...
request.user.message_set.create(
message="Your playlist was added successfully."
)
return render_to_response("playlists/create.html",
context_instance=RequestContext(request))
Al usar
RequestContext, los mensajes del usuario actual, si los tuviera, estn accesibles desde la variable de
{{ messages }}. El siguiente ejemplo representa un fragmento de cdigo que muestras los
contexto usando el nombre
mensajes:
{ % if messages %}
<ul>
{ % for message in messages %}
<li>{{ message }}</li>
{ % endfor %}
</ul>
{ % endif %}
revisin 757 del 28 de julio de 2008
12.6. QU SIGUE?
Hay que hacer notar que
161
RequestContext
llama a
get_and_delete_messages
de forma implcita, por lo que los
mensajes sern borrados, an si no se muestran en pantalla.
Por ltimo, el sistema de mensajera slo funciona para usuarios de la base de datos. Para enviar mensajes a
usuarios annimos hay que usar en entorno de sesiones directamente.
12.5.4.
Per les
La parte nal de nuestro puzzle consiste en el sistema de per les. Para entender mejor que es este sistema y para
que sirve, veamos primero el problema que se supone tiene que resolver.
El resumen sera este: Muchos sitios en Internet necesitan almacenar ms informacin acerca de sus usuarios de
la que est disponible en un objeto de la clase
User.
Para resolver este problema, otros entornos de nen una serie
de campos extra. Django, por el contrario, ha optado por proporcionar un mecanismo sencillo que permita crear un
per l con los datos que queramos, y que queda enlazado con la cuenta de usuario. Estos per les pueden incluso ser
diferentes segn cada proyecto, y tambin se pueden gestionar diferentes per les para sitios diferentes usando la misma
base de datos.
El primer paso para crear un per l es de nir el modelo que va a almacenar la informacin que queremos guardar.
ForeignKey,
user. Aparte de
El nico requerimiento que Django impone a este modelo es que disponga de una campo de tipo
sea nico (unique=True) y que lo vincule con el modelo
User.
Adems, el campo debe llamarse
que
eso,
puedes usar tantos y tan variados campos de datos como quieres. El siguiente ejemplo muestra un per l absolutamente
arbitrario:
from django.db import models
from django.contrib.auth.models import User
class MySiteProfile(models.Model):
# This is the only required field
user = models.ForeignKey(User, unique=True)
# The rest is completely up to you...
favorite_band = models.CharField(maxlength=100, blank=True)
favorite_cheese = models.CharField(maxlength=100, blank=True)
lucky_number = models.IntegerField()
El siguiente paso es decirle a Django donde buscar estos per les. Para ello asigna a la variable de con guracin
AUTH_PROFILE_MODULE
el identi cador de tu modelo. As, si el per l que de nimos en el ejemplo anterior residiera en
una aplicacin llamada myapp, pondras esto en tu chero de con guracin:
AUTH_PROFILE_MODULE = "myapp.mysiteprofile"
Una vez hecho esto, se puede acceder al per l del usuario llamando a
una excepcin de tipo
DoesNotExist
user.get_profile().
Esta funcin elevar
si el usuario no tiene creado el per l (puedes atrapar esta excepcin y crear el
per l en ese momento).
12.6.
Qu sigue?
Si, la verdad es que el sistema de autorizacin tiene tela que cortar. La mayor parte de las veces no tendrs que
preocuparte por todos los detalles que se describen en este captulo, pero si alguna vez tienes que gestionar interacciones
complicadas con los usuarios, agradecers tener todas las utilidades posibles a mano.
En el
`prximo captulo`_, echaremos un vistazo a una parte de Django que necesita la infraestructura que
proporciona el sistema de usuarios/sesiones de Django: la aplicacin de comentarios. Esta aplicacin permite aadir,
de forma muy sencilla, un completo sistema de comentarios -por parte de usuarios annimos o identi cados- a cualquier
tipo de objeto que queramos. Hasta el in nito y ms all!
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
162
CAPTULO 12. SESIONES, USUARIO E INSCRIPCIONES
revisin 757 del 28 de julio de 2008
Captulo 13
Cache
Los sitios Web estticos, en las que las pginas son servidas directamente a la Web, generan un gran escalamiento.
Una gran desventaja en los sitios Web dinmicos, es precisamente eso, que son dinmicos. Cada vez que un usuario
pide una pgina, el servidor realiza una serie de clculos--consultas a una base de datos, renderizado de plantillas,
lgica de negocio--para crear la pgina que el visitante nalmente ve. Esto es costoso desde el punto de vista del
sobreprocesamiento.
Para la mayora de las aplicaciones Web, esta sobrecarga no es gran cosa. La mayora de las aplicaciones Web no
son el washingtonpost.com o Slashdot; son de un tamao pequeo a uno mediano, y con poco tr co. Pero para los
sitios con tr co de medio a alto es esencial bajar lo ms que se pueda el costo de procesamiento. He aqu cuando
realizar un cache es de mucha ayuda.
Colocar en cache algo signi ca guardar el resultado de un clculo costoso para que no se tenga que realizar el
mismo la prxima vez. Aqu mostramos un pseudocdigo explicando como podra funcionar esto para una pgina Web
dinmica:
dada una URL, buscar esa pgina en la cache
si la pgina est en la cache:
devolver la pgina en cache
si no:
generar la pgina
guardar la pgina generada en la cache (para la prxima vez)
devolver la pgina generada
Django incluye un sistema de cache robusto que permite guardar pginas dinmicas para que no tengan que ser
recalculadas cada vez que se piden. Por conveniencia, Django ofrece diferentes niveles de granularidad de cache. Puedes
dejar en cache el resultado de diferentes vistas, slo las piezas que son difciles de producir, o se puede dejar en cache
el sitio entero.
Django tambin trabaja muy bien con caches de upstream, tales como Squid (http://www.squid-cache.org/)
y las caches de los navegadores. Estos son los tipos de cache que no controlas directamente pero a las cuales puedes
proveerles algunas pistas (va cabeceras HTTP) acerca de qu partes de tu sitio deben ser colocadas en cache y cmo.
Sigue leyendo para descubrir como usar el sistema de cache de Django. Cuando tu sitio se parezca cada vez ms a
Slashdot, estars contento de entender este material.
13.1.
Activando el Cache
El sistema de cache requiere slo una pequea con guracin. A saber, tendrs que decirle donde vivirn los datos
de tu cache, si es en una base de datos, en el sistema de archivos, o directamente en memoria. Esta es una decisin
importante que afecta el rendimiento de tu cache (si, algunos tipos de cache son ms rpidos que otros). La cache en
memoria generalmente ser mucho ms rpida que la cache en el sistema de archivos o la cache en una base de datos,
porque carece del trabajo de tocar los mismos.
CACHE_BACKEND en tu archivo de con guracin. Si
simple:/// por omisin. Las siguientes secciones explican
Tus preferencias acerca de la cache van en
CACHE_BACKEND, Django
disponibles para CACHE_BACKEND.
especi cas
usar
revisin 757 del 28 de julio de 2008
usas cache y no
todos los valores
164
CAPTULO 13. CACHE
13.1.1.
Memcached
Por lejos la ms rpida, el tipo de cache ms e ciente para Django, Memcached es un framework de cache enteramen-
te en memoria, originalmente desarrollado para manejar grandes cargas en LiveJournal (http://www.livejournal.
com/) y subsecuentemente por Danga Interactive (http://danga.com/). Es usado por sitios como Slashdot y Wikipedia
para reducir el acceso a bases de datos e incrementar el rendimiento dramticamente.
Memcached est libremente disponible en
http://danga.com/memcached/.
Corre como un demonio y se le asigna
una cantidad espec ca de memoria RAM. Su caracterstica principal es proveer una interfaz--una super-liviana-y-
rpida interfaz--para aadir, obtener y eliminar arbitrariamente datos en la cache. Todos los datos son guardados
directamente en memoria, por lo tanto no existe sobrecarga de uso en una base de datos o en el sistema de archivos.
Despus de haber instalado Memcached, es necesario que instales los bindings Python para Memcached, los cuales
memcache.py, el cual est disponible en
http://www.tummy.com/Community/software/python-memcached/.
Para usar Memcached con Django, coloca CACHE_BACKEND como memcached://ip:puerto/, donde ip es la direccin
IP del demonio de Memcached y puerto es el puerto donde Memcached est corriendo.
no vienen con Django. Dichos bindings vienen en un mdulo de Python,
En el siguiente ejemplo, Memcached est corriendo en localhost (127.0.0.1) en el puerto 11211:
CACHE_BACKEND = 'memcached://127.0.0.1:11211/'
Una muy buena caracterstica de Memcached es su habilidad de compartir la cache en varios servidores. Esto
signi ca que puedes correr demonios de Memcached en diferentes mquinas, y el programa seguir tratando el grupo
de diferentes mquinas como una sola cache, sin la necesidad de duplicar los valores de la cache en cada mquina. Para
sacar provecho de esta caracterstica con Django, incluye todas las direcciones de los servidores en
CACHE_BACKEND,
separados por punto y coma.
En el siguiente ejemplo, la cache es compartida en varias instancias de Memcached en las direcciones IP 172.19.26.240
y 172.19.26.242, ambas en el puerto 11211:
CACHE_BACKEND = 'memcached://172.19.26.240:11211;172.19.26.242:11211/'
En el siguiente ejemplo, la cache es compartida en diferentes instancias de Memcached corriendo en las direcciones
IP 172.19.26.240 (puerto 11211), 172.19.126.242 (puerto 11212) y 172.19.26.244 (puerto 11213):
CACHE_BACKEND = 'memcached://172.19.26.240:11211;172.19.26.242:11212;172.19.26.244:11213/'
Una ltima observacin acerca de Memcached es que la cache basada en memoria tiene una importante desventaja.
Como los datos de la cache son guardados en memoria, sern perdidos si los servidores se caen. Ms claramente,
la memoria no es para almacenamiento permanente, por lo tanto no te quedes solamente con una cache basada en
memoria. Sin duda, ninguno de los sistemas de cache de Django debe ser utilizado para almacenamiento permanente-son todos una solucin para la cache, no para almacenamiento--pero hacemos hincapi aqu porque la cache basada
en memoria es particularmente temporaria.
13.1.2.
Cache en Base de datos
Para usar una tabla de una base de datos como cache, tienes que crear una tabla en tu base de datos y apuntar el
sistema de cache de Django a ella.
Primero, crea la tabla de cache corriendo el siguiente comando:
python manage.py createcachetable [nombre_tabla_cache]
donde
[nombre_tabla_cache]
es el nombre de la tabla a crear. Este nombre puede ser cualquiera que desees,
siempre y cuando sea un nombre vlido para una tabla y que no est ya en uso en tu base de datos. Este comando
crea una nica tabla en tu base de datos con un formato apropiado para el sistema de cache de Django.
Una vez que se hayas creado la tabla, coloca la propiedad
nombre_tabla es el nombre
cache es mi_tabla_cache:
CACHE_BACKEND
como
"db://nombre_tabla",
donde
de la tabla en la base de datos. En el siguiente ejemplo, el nombre de la tabla para el
CACHE_BACKEND = 'db://mi_tabla_cache'
El sistema de cache usar la misma base de datos especi cada en el archivo de con guracin. No podrs usar un
base de datos diferente para tal.
revisin 757 del 28 de julio de 2008
13.1. ACTIVANDO EL CACHE
13.1.3.
165
Cache en Sistema de Archivos
Para almacenar la cache en el sistema de archivos, coloca el tipo
"file://"
en la propiedad
CACHE_BACKEND,
especi cando el directorio en tu sistema de archivos que debera almacenar los datos de la cache.
Por ejemplo, para almacenar los datos de la cache en
/var/tmp/django_cache,
coloca lo siguiente:
CACHE_BACKEND = 'file:///var/tmp/django_cache'
Observa que hay tres barras invertidas en el comienzo del ejemplo anterior. Las primeras dos son para
/var/tmp/django_cache.
aqu:: file://c:/foo/bar.
y la tercera es el primer caracter de la ruta del directorio,
letra correspondiente al disco despus de
file://,
como
file://,
Si ests en Windows, coloca la
La ruta del directorio debe ser absoluta --debe comenzar con la raz de tu sistema de archivos. No importa si colocas
una barra al nal de la misma.
Asegrate que el directorio apuntado por esta propiedad exista y que pueda ser ledo y escrito por el usuario de
sistema uado por tu servidor Web para ejecutarse.
Continuando con el ejemplo anterior, si tu servidor corre como usuario
exista y pueda ser ledo y escrito por el usuario
apache.
apache, asegrate que el directorio /var/tmp/django
Cada valor de la cache ser almacenado como un archivo separado conteniendo los datos de la cache serializados (pickled), usando el mdulo Python
pickle.
Cada nombre de archivo es una clave de la cache, modi cado
convenientemente para que pueda ser usado por el sistema de archivos.
13.1.4.
Cache en Memoria local
Si quieres la ventaja que otorga la velocidad de la cache en memoria pero no tienes la capacidad de correr Memcached, puedes optar por el cache de memoria-local. Esta cache es por proceso y thread-safe, pero no es tan e ciente
como Memcache dada su estrategia de bloqueo simple y reserva de memoria.
Para usarla, coloca
CACHE_BACKEND
como
'locmem:///',
por ejemplo:
CACHE_BACKEND = 'locmem:///'
13.1.5.
Cache Simple (para desarrollo)
Una cache simple, y de un solo proceso en memoria, est disponible como
'simple:///',
por ejemplo:
CACHE_BACKEND = 'simple:///'
Esta cache apenas guarda los datos en proceso, lo que signi ca que slo debe ser usada para desarrollo o testing.
13.1.6.
Cache Dummy (o estpida)
Finalmente, Django incluye una cache dummy que no realiza cache; slo implementa la interfaz de cache sin
realizar ninguna accin.
Esto es til cuando tienes un sitio en produccin que usa mucho cache en varias partes y en un entorno de
desarrollo/prueba en cual no quieres hacer cache. En ese caso, usa
CACHE_BACKEND
como
'dummy:///'
en el archivo
de con guracin para tu entorno de desarrollo, por ejemplo:
CACHE_BACKEND = 'dummy:///'
Como resultado de esto, tu entorno de desarrollo no usar cache, pero tu entorno de produccin si lo har.
13.1.7.
Argumentos de CACHE_BACKEND
Cada tipo de cache puede recibir argumentos. Estos son dados como una query-string en la propiedad
CACHE_BACKEND.
Los argumentos vlidos son:
timeout:
El tiempo de vida por omisin, en segundos, que usar la cache. Este argumento tomar el
valor de 300 segundos (5 minutos) si no se lo especi ca.
max_entries:
Para la cache simple, la cache de memoria local, y la cache de base de datos, es el
nmero mximo de entradas permitidas en la cache a partir del cual los valores ms viejos sern
eliminados. Tomar un valor de 300 si no se lo especi ca.
revisin 757 del 28 de julio de 2008
166
CAPTULO 13. CACHE
cull_frequency: La proporcin de entradas que sern sacri cadas cuando la cantidad de max_entries
1/cull_frequency, si quieres sacri car la mitad de las entradas
cuando se llegue a una cantidad de max_entries coloca cull_frequency=2.
Un valor de 0 para cull_frequency signi ca que toda la cache ser limpiada cuando se llegue a una
cantidad de entradas igual a max_entries. Esto hace que el proceso de limpieza de la cache mucho
es alcanzada. La proporcin actual es
ms rpido pero al costo de perder ms datos de la cache. Este argumento tomar un valor de 3 si no
se especi ca.
En este ejemplo,
timeout
se ja en
60:
CACHE_BACKEND = "locmem:///?timeout=60"
En este ejemplo,
timeout
se ja en
30
max_entries
en
400:
CACHE_BACKEND = "locmem:///?timeout=30&max_entries=400"
Tanto los argumentos desconocidos asi como los valores invlidos de argumentos conocidos son ignorados silenciosamente.
13.2.
La cache por sitio
Una vez que hayas especi cado
CACHE_BACKEND,
la manera ms simple de usar la cache es colocar en cache el sitio
entero. Esto signi ca que cada pgina que no tenga parmetros GET o POST ser puesta en cache por un cierto
perodo de tiempo la primera vez que sean pedidas.
Para activar la cache por sitio solamente agrega
MIDDLEWARE_CLASSES,
'django.middleware.cache.CacheMiddleware'
a la propiedad
como en el siguiente ejemplo:
MIDDLEWARE_CLASSES = (
'django.middleware.cache.CacheMiddleware',
'django.middleware.common.CommonMiddleware',
)
Nota
El
orden
de
MIDDLEWARE_CLASSES
importa.
Mira
la
seccin
Orden
de
MIDDLEWA-
RE_CLASSES ms adelante en este captulo.
Luego, agrega las siguientes propiedades en el archivo de con guracin de Django:
CACHE_MIDDLEWARE_SECONDS: El tiempo en segundos que cada pgina ser mantenida en la cache.
CACHE_MIDDLEWARE_KEY_PREFIX: Si la cache es compartida a travs de mltiples sitios usando
la
misma instalacin Django, coloca esta propiedad como el nombre del sitio, u otra cadena que sea
nica para la instancia de Django, para prevenir colisiones. Usa una cadena vaca si no te interesa.
La cache middleware coloca en cache cada pgina que no tenga parmetros GET o POST. Esto signi ca que si
un usuario pide una pgina y pasa parmetros GET en la cadena de consulta, o pasa parmetros POST, la cache
middleware no intentar obtener la versin en cache de la pgina. Si intentas usar la cache por sitio ten esto en mente
cuando disees tu aplicacin; no uses URLs con cadena de consulta, por ejemplo, a menos que sea aceptable que tu
aplicacin no coloque en cache esas pginas.
CACHE_MIDDLEWARE_ANONYMOUS_ONLY. Si de nes esta caractersTrue, la cache middleware slo colocar en cache pedidos annimos (p.e.: pedidos hechos por un
Esta cache middleware admite otras caracterstica,
tica, y la de nes como
usuario no logueado). Esta es una manera simple y efectiva de deshabilitar la cache para cualquier pgina de algn usua-
CACHE_MIDDLEWARE_ANONYMOUS_ONLY,
AuthenticationMiddleware y que AuthenticationMiddleware aparezca antes
CacheMiddleware en tus MIDDLEWARE_CLASSES
Finalmente, nota que CacheMiddleware automticamente coloca unos pocos encabezados en cada HttpResponse:
rio espec co, como la interfaz de administracin de Django. Ten en cuenta que si usas
debers asegurarte que has activado
de
Coloca el encabezado
Last-Modified
con el valor actual de la fecha y hora cuando una pgina (an
no en cache) es requerida.
Expires con el valor de la fecha y hora ms el tiempo de nido en CACHE_MIDDLEWARE_SECONDS.
Cache-Control para otorgarle una vida mxima a la pgina, como se especi ca
CACHE_MIDDLEWARE_SECONDS.
Coloca el encabezado
Coloca el encabezado
en
revisin 757 del 28 de julio de 2008
13.3. CACHE POR VISTA
13.3.
167
Cache por vista
Una forma ms granular de usar el framework de cache es colocar en cache la salida de las diferentes vistas. Esto
tiene el mismo efecto que la cache por sitio (incluyendo la omisin de colocar en cache los pedidos con parmetros
GET y POST). Se aplica a cualquier vista que tu especi ques, en vez de aplicarse al sitio entero.
Haz esto usando un decorador, que es un wrapper de la funcin de la vista que altera su comportamiento para usar la
cache. El decorador de cache por vista es llamado
cache_page y se encuentra en el mdulo django.views.decorators.cache,
por ejemplo:
from django.views.decorators.cache import cache_page
def my_view(request, param):
# ...
my_view = cache_page(my_view, 60 * 15)
De otra manera, si ests usando la versin 2.4 o superior de Python, puedes usar la sintaxis de un decorador. El
siguiente ejemplo es equivalente al anterior:
from django.views.decorators.cache import cache_page
@cache_page(60 * 15)
def my_view(request, param):
# ...
cache_page recibe un nico argumento: el tiempo de vida en segundos de la cache. En el ejemplo anterior, el
my_view() estar en cache unos 15 minutos. (toma nota de que lo hemos escrito como 60 * 15 para
que sea entendible. 60 * 15 ser evaluado como 900--que es igual a 15 minutos multiplicados por 60 segundos cada
resultado de
minuto.)
La cache por vista, como la cache por sitio, es indexada independientemente de la URL. Si mltiples URLs apuntan a
la misma vista, cada URL ser puesta en cache separadamente. Continuando con el ejemplo de
my_view, si tu URLconf
se ve como:
urlpatterns = ('',
(r'^foo/(\d{1,2})/$', my_view),
)
los pedidos a
/foo/1/
y a
/foo/23/ sern puestos en cache separadamente, como es de esperar.
/foo/23/), los siguientes pedidos a esa URL utilizarn la cache.
Pero una vez que
una misma URL es pedida (p.e.
13.3.1.
Especi cando la cache por vista en URLconf
Los ejemplos en la seccin anterior tienen codi cado
modi ca la funcin
my_view
18 que la vista se coloque en cache, porque
cache_page
ah mismo. Este enfoque acopla tu vista con el sistema de cache, lo cual no es lo ideal
por varias razones. Por ejemplo, puede que quieras reusar las funciones de la vista en otro sitio sin cache, o puede
que quieras distribuir las vistas a gente que quiera usarlas sin que sean colocadas en la cache. La solucin para estos
problemas es especi car la cache por vista en URLconf en vez de especi carla junto a las vistas mismas.
Hacer eso es muy fcil: simplemente envuelve la funcin de la vista con
cache_page cuando hagas referencia a ella
en URLconf. Aqu el URLconf como estaba antes:
urlpatterns = ('',
(r'^foo/(\d{1,2})/$', my_view),
)
Ahora la misma cosa con
my_view
envuelto con
cache_page:
from django.views.decorators.cache import cache_page
urlpatterns = ('',
(r'^foo/(\d{1,2})/$', cache_page(my_view, 60 * 15)),
)
Si tomas este enfoque no olvides de importar
cache_page
dentro de tu URLconf.
revisin 757 del 28 de julio de 2008
168
CAPTULO 13. CACHE
13.4.
La API de cache de bajo nivel
Algunas veces, colocar en cache una pgina entera no te hace ganar mucho y es, de hecho, un inconveniente excesivo.
Quizs, por ejemplo, tu sitio incluye una vista cuyos resultados dependen de diversas consultas costosas, lo resultados de las cuales cambian en intervalos diferentes. En este caso, no sera ideal usar la pgina entera en cache que
la cache por sitio o por vista ofrecen, porque no querrs guardar en cache todo el resultado (ya que los resultados
cambian frecuentemente), pero querrs guardar en cache los resultados que rara vez cambian.
Para casos como este, Django expone una simple API de cache de bajo nivel, la cual vive en el mdulo
django.core.cache.
Puedes usar la API de cache de bajo nivel para almacenar los objetos en la cache con cualquier nivel de granularidad que te guste. Puedes colocar en la cache cualquier objeto Python que pueda ser serializado de forma segura:
strings, diccionarios, listas de objetos del modelo, y dems. (La mayora de los objetos comunes de Python pueden ser
serializados; revisa la documentacin de Python para ms informacin acerca de serializacin). N.T.: pickling
Aqu vemos como importar la API:
>>> from django.core.cache import cache
La interfaz bsica es
set(key, value, timeout_seconds)
get(key):
>>> cache.set('my_key', 'hello, world!', 30)
>>> cache.get('my_key')
'hello, world!'
El argumento
timeout_seconds es opcional y obtiene el valor del argumento timeout de CACHE_BACKEND, explicado
anteriormente, si no se lo especi ca.
Si el objeto no existe en la cache, o el sistema de cache no se puede alcanzar,
cache.get()
devuelve
None:
# Wait 30 seconds for 'my_key' to expire...
>>> cache.get('my_key')
None
>>> cache.get('some_unset_key')
None
Te recomendamos que no almacenes el valor literal None en la cache, porque no podrs distinguir entre tu valor
None almacenado y el valor que devuelve la cache cuando no encuentra un objeto.
cache.get() puede recibir un argumento por omisin. Esto especi ca qu valor debe devolver si el objeto no existe
en la cache:
>>> cache.get('my_key', 'has expired')
'has expired'
Para obtener mltiples valores de la cache de una sola vez, usa
posible,
get_many()
cache.get_many().
Si al sistema de cache le es
tocar la cache slo una vez, al contrario de tocar la cache por cada valor.
get_many()
devuelve
un diccionario con todas las key que has pedido que existen en la cache y todava no han expirado:
>>> cache.set('a', 1)
>>> cache.set('b', 2)
>>> cache.set('c', 3)
>>> cache.get_many(['a', 'b', 'c'])
{'a': 1, 'b': 2, 'c': 3}
Si una key no existe o ha expirado, no ser incluida en el diccionario. Lo siguiente es una continuacin del ejemplo
anterior:
>>> cache.get_many(['a', 'b', 'c', 'd'])
{'a': 1, 'b': 2, 'c': 3}
Finalmente, puedes eliminar keys explcitamente con
cache.delete(). Esta es una manera fcil de limpiar la cache
para un objeto en particular:
>>> cache.delete('a')
cache.delete()
no tiene un valor de retorno, y funciona de la misma manera si existe o no un valor en la cache.
revisin 757 del 28 de julio de 2008
13.5. CACHES UPSTREAM
13.5.
169
Caches upstream
Este captulo se ha enfocado en la cache de tus propios datos. Pero existe otro tipo de cache que es muy importante
para los desarrolladores web: la cache realizada por los upstream. Estos son sistemas que colocan en cache pginas an
antes de que estas sean pedidas a tu sitio Web.
Aqu hay algunos ejemplos de caches para upstream:
Tu ISP puede tener en cache algunas pginas, si tu pides una pgina de
http://example.com/,
tu ISP te enviar la pgina sin tener que acceder a example.com directamente. Los responsables
de example.com no tienen idea que esto pasa; el ISP se coloca entre example.com y tu navegador,
manejando todo lo que se re era a cache transparentemente.
Tu sitio en Django puede colocarse detrs de un cache proxy, como Squid Web Proxy Cache (http::
//www.squid-cache.org/),
que coloca en cache pginas para un mejor rendimiento. En este caso,
cada pedido ser controlado por el proxy antes que nada, y ser pasado a tu aplicacin slo si es
necesario.
Tu navegador tambin pone pginas en un cache. Si una pgina Web enva unos encabezados apropiados, tu navegador usar su copia de la cache local para los siguientes pedidos a esa pgina, sin
siquiera hacer nuevamente contacto con la pgina web para ver si esta ha cambiado.
La cache de upstream es un gran bene cio, pero puede ser peligroso. El contenido de muchas pginas Web pueden
cambiar segn la autenticacin que se haya realizado u otras variables, y los sistemas basados en almacenar en cache
segn la URL pueden exponer datos incorrectos o delicados a diferentes visitantes de esas pginas.
Por ejemplo, digamos que manejas un sistema de e-mail basado en Web, el contenido de la bandeja de entrada
obviamente depende de que usuario est logueado. Si el ISP hace caching de tu sitio ciegamente, el primer usuario
que ingrese al sistema compartir su bandeja de entrada, que est en cache, con los dems usuarios del sistema. Eso,
de nitivamente no es bueno.
Afortunadamente, el protocolo HTTP provee una solucin a este problema. Existen un nmero de encabezados
HTTP que indican a las cache de upstream que diferencien sus contenidos de la cache dependiendo de algunas variables,
y para que algunas pginas particulares no se coloquen en cache. Veremos algunos de estos encabezados en las secciones
que siguen.
13.5.1.
Usando el encabezado Vary
El encabezado
Vary de ne cuales encabezados debera tener en cuenta un sistema de cache cuando construye claves
de su cache. Por ejemplo, si el contenido de una pgina Web depende de las preferencias de lenguaje del usuario, se
dice que la pgina vara segn el lenguaje.
Por omisin, el sistema de cache de Django crea sus claves de cache usando la ruta que se ha requerido (p.e.:
"/stories/2005/jun/23/bank_robbed/").
Esto signi ca que cada pedido a esa URL usar la misma versin de
cache, independientemente de las caractersticas del navegador del cliente, como las cookies o las preferencias del
lenguaje. Sin embargo, si esta pgina produce contenidos diferentes basndose en algunas cabeceras del request--como
las cookies, el lenguaje, o el navegador--necesitars usar el encabezado
depende de esas cosas.
Para hacer esto en Django, usa el decorador
vary_on_headers
Vary
para indicarle a la cache que esa pgina
como sigue:
from django.views.decorators.vary import vary_on_headers
# Python 2.3 syntax.
def my_view(request):
# ...
my_view = vary_on_headers(my_view, 'User-Agent')
# Python 2.4+ decorator syntax.
@vary_on_headers('User-Agent')
def my_view(request):
# ...
En este caso, el mecanismo de cache (como middleware) colocar en cache una versin distinta de la pgina para
cada tipo de user-agent.
revisin 757 del 28 de julio de 2008
170
CAPTULO 13. CACHE
vary_on_headers en vez de jar manualmente el encabezado Vary (usando algo
response['Vary'] = 'user-agent') es que el decorador agrega al encabezado Vary (el cual podra ya existir),
La ventaja de usar el decorador
como
en vez de jarlo desde cero y potencialmente sobrescribir lo que ya haba ah.
Puedes pasar mltiples encabezados a
vary_on_headers():
@vary_on_headers('User-Agent', 'Cookie')
def my_view(request):
# ...
Esto le dice a la cache de upstream que diferencie ambos, lo que signi ca que cada combinacin de una cookie y
un navegador obtendr su propio valor en cache. Por ejemplo, un pedido con navegador
valor
foo=bar
ser considerada diferente a un pedido con el navegador
Mozilla
Como las variaciones con las cookies son tan comunes existe un decorador
Mozilla
y una cookie con el
y una cookie con el valor
vary_on_cookie.
foo=ham.
Las siguientes dos
vistas son equivalentes:
@vary_on_cookie
def my_view(request):
# ...
@vary_on_headers('Cookie')
def my_view(request):
# ...
El encabezado que le pasas a
que
"user-agent".
Tambin puedes usar
al
Vary header,
vary_on_headers no diferencia maysculas de minsculas; "User-Agent" es lo mismo
django.utils.cache.patch_vary_headers como funcin de ayuda. Esta funcin ja o aade
por ejemplo:
from django.utils.cache import patch_vary_headers
def my_view(request):
# ...
response = render_to_response('template_name', context)
patch_vary_headers(response, ['Cookie'])
return response
patch_vary_headers
obtiene una instancia de
HttpResponse
como su primer argumento y una lista/tupla de
nombres de encabezados, sin diferenciar maysculas de minsculas, como su segundo argumento.
13.5.2.
Otros Encabezados de cache
Otro problema con la cache es la privacidad de los datos y donde deberan almacenarse los datos cuando se hace
un vuelco de la cache.
El usuario generalmente se enfrenta con dos tipos de cache: su propia cache de su navegador (una cache privada)
y la cache de su proveedor (una cache pblica). Una cache pblica es usada por mltiples usuarios y controlada por
algunos otros. Esto genera un problema con datos sensibles--no quieres que, por ejemplo, el nmero de tu cuenta
bancaria sea almacenado en una cache pblica. Por lo que las aplicaciones Web necesitan una manera de indicarle a
la cache cuales datos son privados y cuales son pblicos.
La solucin es indicar que la copia en cache de una pgina es privada. Para hacer esto en Django usa el decorador
de vista
cache_control:
from django.views.decorators.cache import cache_control
@cache_control(private=True)
def my_view(request):
# ...
Este decorador se encarga de enviar los encabezados HTTP apropiados detrs de escena.
Existen otras pocas maneras de controlar los parmetros de cache. Por ejemplo, HTTP permite a las aplicaciones
hacer lo siguiente:
De nir el tiempo mximo que una pgina debe estar en cache.
revisin 757 del 28 de julio de 2008
13.6. OTRAS OPTIMIZACIONES
171
Especi car si una cache debera comprobar siempre la existencia de nuevas versiones, entregando
unicamente el contenido de la cache cuando no hubiesen cambios. (Algunas caches pueden entregar
contenido aun si la pgina en el servidor ha cambiado, simplemente porque la copia en cache todava
no ha expirado.)
En Django, utiliza el decorador
ejemplo,
cache_control
cache_control
para especi car estos parmetros de la cache. En el siguiente
le indica a la cache revalidarse en cada acceso y almacenar versiones en cache hasta 3.600
segundos:
from django.views.decorators.cache import cache_control
@cache_control(must_revalidate=True, max_age=3600)
def my_view(request):
...
Cualquier directiva
Cache-Control
de HTTP vlida es vlida en
cache_control().
Aqu hay una lista completa:
public=True
private=True
no_cache=True
no_transform=True
must_revalidate=True
proxy_revalidate=True
max_age=num_seconds
s_maxage=num_seconds
Tip
Para una explicacin de las directivas
Cache-Control
de HTTP, lea las especi caciones en
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Nota
El
middleware
de
caching
ya
ja
el
encabezado
CACHE_MIDDLEWARE_SETTINGS. Si utilizas un valor
cache_control, el decorador tendr precedencia, y los
propio
max-age con
de max_age en
el
un
valor
de
decorador
valores del encabezado sern fusionados
correctamente.
13.6.
Otras optimizaciones
Django incluye otras piezas de middleware que pueden ser de ayuda para optimizar el rendimiento de tus aplicaciones:
django.middleware.http.ConditionalGetMiddleware
agrega soporte para navegadores modernos
para condicionar respuestas GET basadas en los encabezados
ETag
Las-Modified.
django.middleware.gzip.GZipMiddleware comprime las respuestas para todos los navegadores modernos, ahorrando ancho de banda y tiempo de transferencia.
13.7.
Orden de MIDDLEWARE_CLASSES
Si utilizas
CacheMiddleware, es importante colocarlas en el lugar correcto dentro de la propiedad MIDDLEWARE_CLASSES,
porque el middleware de cache necesita conocer los encabezados por los cuales cambiar el almacenamiento en la cache.
Coloca el
CacheMiddleware
despus de cualquier middleware que pueda agregar algo al encabezado
yendo los siguientes:
SessionMiddleware,
GZipMiddleware,
que agrega
que agrega
Cookie
Accept-Encoding
revisin 757 del 28 de julio de 2008
Vary,
inclu-
172
CAPTULO 13. CACHE
13.8.
Qu sigue?
Django incluye un nmero de paquetes opcionales. Hemos cubierto algunos de los mismos: el sistema de administracin (Captulo 6) y el marco de sesiones/usuarios (Captulo 11).
El
`prximo captulo`_ cubre el resto de los marcos de trabajos de la comunidad. Existen una cantidad
interesante de herramientas disponibles; no querrs perderte ninguna de ellas.
Duplicate explicit target name: prximo captulo.
18 N.
del T.: hard-coded
revisin 757 del 28 de julio de 2008
Captulo 14
Otros sub-frameworks contribuidos
Una de las varias fortalezas de Python, es su losofa de bateras incluidas. Cuando instalas Python, viene con
una amplia biblioteca de paquetes que puedes comenzar a usar inmediatamente, sin necesidad de descargar nada ms.
Django trata de seguir esta losofa, e incluye su propia biblioteca estndar de agregados tiles para las tareas comunes
del desarrollo web. Este captulo cubre dicha coleccin de agregados.
14.1.
La biblioteca estndar de Django
La biblioteca estndar de Django vive en el paquete
django.contrib.
Dentro de cada sub-paquete hay una pieza
aislada de funcionalidad para agregar. Estas piezas no estn necesariamente relacionadas, pero algunos sub-paquetes
de
django.contrib
pueden requerir a otros.
No hay grandes requerimientos para los tipos de funcionalidad que hay en
django.contrib. Algunos de los paquetes
incluyen modelos (y por lo tanto requieren que instales sus tablas en tu base de datos), pero otros consisten solamente
de middleware o de etiquetas de plantillas (template tags ).
La nica caracterstica comn a todos los paquetes de
django.contrib es la siguiente: si borraras dicho paquete por
completo, seguiras pudiendo usar las capacidades fundamentales de Django sin problemas. Cuando los desarrolladores
de Django agregan nueva funcionalidad al framework, emplean esa regla de oro al decidir en dnde va a residir la nueva
django.contrib, o en algn otro lugar.
django.contrib consiste de los siguientes paquetes:
funcionalidad, si en
admin:
auth:
el sitio automtico de administracin. Consulta los captulos 6 y 18.
el framework de autenticacin de Django. Consulta el Captulo 12.
comments: una aplicacin para comentarios. Esta aplicacin est actualmente bajo un fuerte desarrollo,
y por lo tanto, no puede ser cubierta por completo para cuando se publique de este libro. Chequea el
sitio web de Django para obtener la ltima informacin sobre esta aplicacin.
contenttypes:
un framework para conectar tipos de contenido, en que cada modelo de Django
instalado es un tipo de contenido aislado. Este framework es usado internamente por otras aplicaciones
contrib, y est especialmente enfocada a los desarrolladores de Django muy avanzados . Dichos
desarrolladores pueden hallar ms informacin sobre esta aplicacin, leyendo el cdigo fuente que est
en
django/contrib/contenttypes/.
csrf:
proteccin ante un ataque de falsi cacin de peticin en sitios cruzados, en ingls Cross-Site
Request Forgery (CSRF). Consulta la seccin titulada Proteccin contra CSRF ms adelante.
flatpages:
un framework para administrar contenido HTML simple, plano, dentro de la base de
datos. Consulta la seccin titulada Flatpages ms adelante.
humanize:
un conjunto de ltros de plantillas Django, tiles para darle un toque de humanidad a
los datos. Consulta la seccin titulada Haciendo los datos ms humanos ms adelante.
markup:
un conjunto de ltros de plantillas de Django, que implementan varios lenguajes de marcado
conocidos. Consulta la seccin titulada Filtros de marcado ms adelante.
redirects:
un framework para administrar redirecciones. Consulta la seccin titulada Redirects
ms adelante.
sessions:
el framework de sesiones de Django. Consulta el Captulo 12.
revisin 757 del 28 de julio de 2008
174
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
sitemaps: un framework para generara archivos de mapas de sitio XML. Consulta el Captulo 11.
sites: un framework que te permite operar mltiples sitios web desde la misma base de datos, y con
una nica instalacin de Django. Consulta la prxima seccin, Sites.
syndication:
un framework para generar documentos de sindicacin (feeds ), en RSS y en Atom.
Consulta el Captulo 11.
El resto de este captulo entra en los detalles de cada paquete
django.contrib que no ha sido cubierto an en este
libro.
14.2.
Sites
El sistema sites de Django es un framework genrico que te permite operar mltiples sitios web desde la misma
base de datos, y desde el mismo proyecto de Django. ste es un concepto abstracto, y puede ser difcil de entender,
as que comenzaremos mostrando algunos escenarios en donde sera til usarlo.
14.2.1.
Escenario 1: reuso de los datos en mltiples sitios
Como explicamos en el Captulo 1, los sitios LJWorld.com y Lawrence.com, que funcionan gracias a Django, son
operados por la misma organizacin de prensa, el diario Lawrence Journal-World de Lawrence, Kansas. LJWorld.com
se enfoca en noticias, mientras que Lawrence.com se enfoca en el entretenimiento local. Pero a veces los editores quieren
publicar un artculo en ambos sitios.
La forma cabeza dura de resolver el problema sera usar una base de datos para cada sitio, y pedirle a los productores
que publiquen la misma nota dos veces: una para LJWorld.com y nuevamente para Lawrence.com. Pero esto es
ine ciente para los productores del sitio, y es redundante conservar mltiples copias de la misma nota en las bases de
datos.
Una solucin mejor? Que ambos sitios usen la misma base de datos de artculos, y que un artculo est asociado
con uno o ms sitios por una relacin de muchos-a-muchos. El framework sites de Django, proporciona la tabla de
base de datos que hace que los artculos se puedan relacionar de esta forma. Sirve para asociar datos con uno o ms
sitios.
14.2.2.
Escenario 2: alojamiento del nombre/dominio de tu sitio en un solo lugar
Los dos sitios LJWorld.com y Lawrence.com, tienen la funcionalidad de alertas por correo electrnico, que les
permite a los lectores registrarse para obtener noti caciones. Es bastante bsico: un lector se registra en un formulario
web, e inmediatamente obtiene un correo electrnico que dice Gracias por su suscripcin.
Sera ine ciente y redundante implementar el cdigo del procesamiento de registros dos veces, as que los sitios
usan el mismo cdigo detrs de escena. Pero la noticia Gracias por su suscripcin debe ser distinta para cada sitio.
Site, podemos abstraer el agradecimiento para usar
'LJWorld.com') y domain (ej. 'www.ljworld.com').
Empleando objetos
variables
name
(ej.
los valores del nombre y dominio del sitio,
El framework sites te proporciona un lugar para que puedas almacenar el nombre (name) y el dominio (domain)
de cada sitio de tu proyecto, lo que signi ca que puedes reutilizar estos valores de manera genrica.
14.2.3.
Modo de uso del
framework sites
Sites ms que un framework, es una serie de convenciones. Toda la cosa se basa en dos conceptos simples:
el modelo
Site,
django.contrib.sites,
SITE_ID especi ca el ID de la
que se halla en
la opcin de con guracin
tiene los campos
domain
base de datos del objeto
name.
Site asociado
y
con
este archivo de con guracin en particular.
La manera en que uses estos dos conceptos queda a tu criterio, pero Django los usa de varios modos de manera
automtica, siguiendo convenciones simples.
Para instalar la aplicacin sites, sigue estos pasos:
'django.contrib.sites' a tu INSTALLED_APPS.
Ejecuta el comando manage.py syncdb para instalar la tabla django_site en tu base de datos.
Agrega uno o ms objetos Site, por medio del sitio de administracin de Django, o por medio
de la API de Python. Crea un objeto Site para cada sitio/dominio que est respaldado por este
1. Agrega
2.
3.
proyecto Django.
revisin 757 del 28 de julio de 2008
14.2. SITES
175
4. De ne la opcin de con guracin
SITE_ID en cada uno de tus archivos de con guracin (settings ).
Site para el sitio respaldado por el archivo
Este valor debera ser el ID de base de datos del objeto
de con guracin.
14.2.4.
Las capacidades del framework Sites
Las siguientes secciones describen las cosas que puedes hacer con este framework.
Reuso de los datos en mltiples sitios
Para reusar los datos en mltiples sitios, como explicamos en el primer escenario, simplemente debes agregarle un
campo muchos-a-muchos,
ManyToManyField
hacia
Site
en tus modelos. Por ejemplo:
from django.db import models
from django.contrib.sites.models import Site
class Article(models.Model):
headline = models.CharField(maxlength=200)
# ...
sites = models.ManyToManyField(Site)
Esa es toda la infraestructura necesaria para asociar artculos con mltiples sitios en tu base de datos. Con eso
en su lugar, puedes reusar el mismo cdigo de vista para mltiples sitios. Continuando con el modelo
ejemplo, aqu mostramos cmo lucira una vista
article_detail:
Article
del
from django.conf import settings
def article_detail(request, article_id):
try:
a = Article.objects.get(id=article_id, sites__id=settings.SITE_ID)
except Article.DoesNotExist:
raise Http404
# ...
esta funcin de vista es reusable porque chequea el sitio del artculo dinmicamente, segn cul sea el valor de la
opcin
SITE_ID.
Por ejemplo, digamos que el archivo de con guracin de LJWorld.com tiene un
Lawrence.com lo tiene asignado a
2.
SITE_ID
asignado a
1,
y que el de
Si esta vista es llamada cuando el archivo de con guracin de LJWorld.com est
activado, entonces la bsqueda de artculos se limita a aquellos en que la lista de sitios incluye LJWorld.com.
Asociacin de contenido con un solo sitio
De manera similar, puedes asociar un modelo con el modelo
Site en una relacin muchos-a-uno, usando ForeignKey.
Por ejemplo, si un artculo slo se permite en un sitio, puedes usar un modelo como este:
from django.db import models
from django.contrib.sites.models import Site
class Article(models.Model):
headline = models.CharField(maxlength=200)
# ...
site = models.ForeignKey(Site)
Este tiene los mismos bene cios, como se describe en la ltima seccin.
Obtencin del sitio actual desde las vistas
A un nivel ms bajo, puedes usar el framework sites en tus vistas de Django para hacer cosas particulares segn
el sitio en el cual la vista sea llamada. Por ejemplo:
revisin 757 del 28 de julio de 2008
176
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
from django.conf import settings
def my_view(request):
if settings.SITE_ID == 3:
# Do something.
else:
# Do something else.
Por supuesto, es horrible meter en el cdigo el ID del sitio de esa manera. Una forma levemente ms limpia de
lograr lo mismo, es chequear el dominio actual del sitio:
from django.conf import settings
from django.contrib.sites.models import Site
def my_view(request):
current_site = Site.objects.get(id=settings.SITE_ID)
if current_site.domain == 'foo.com':
# Do something
else:
# Do something else.
Site
Este fragmento de cdigo usado para obtener el objeto
que el administrador de modelos de
Site (Site.objects)
settings.SITE_ID es
get_current(). El siguiente
segn el valor de
tiene un mtodo
tan usado,
ejemplo es
equivalente al anterior:
from django.contrib.sites.models import Site
def my_view(request):
current_site = Site.objects.get_current()
if current_site.domain == 'foo.com':
# Do something
else:
# Do something else.
Nota
En este ltimo ejemplo, no hay necesidad de importar
django.conf.settings.
Obtencin del dominio actual para ser mostrado
Una forma DRY (acrnimo del ingls Don't Repeat Yourself, no te repitas) de guardar el nombre del sitio y del
dominio, como explicamos en Escenario 2: alojamiento del nombre/dominio de tu sitio en un solo lugar, se logra
simplemente haciendo referencia a
name
y a
domain
del objeto
Site
actual. Por ejemplo:
from django.contrib.sites.models import Site
from django.core.mail import send_mail
def register_for_newsletter(request):
# Check form values, etc., and subscribe the user.
# ...
current_site = Site.objects.get_current()
send_mail('Thanks for subscribing to %s alerts' % current_site.name,
'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % current_site.name,
'editor@ %s' % current_site.domain,
[user_email])
# ...
Continuando con nuestro ejemplo de LJWorld.com y Lawrence.com, en Lawrence.com el correo electrnico tiene
como sujeto la lnea Gracias por suscribirse a las alertas de lawrence.com. En LJWorld.com, en cambio, el sujeto es
Gracias por suscribirse a las alertas de LJWorld.com. Este comportamiento espec co para cada sitio, tambin se
aplica al cuerpo del correo electrnico.
revisin 757 del 28 de julio de 2008
14.2. SITES
177
Una forma an ms exible (aunque un poco ms pesada) de hacer lo mismo, es usando el sistema de plantillas
de Django. Asumiendo que Lawrence.com y LJWorld.com tienen distintos directorios de plantillas (TEMPLATE_DIRS),
puedes simplemente delegarlo al sistema de plantillas as:
from django.core.mail import send_mail
from django.template import loader, Context
def register_for_newsletter(request):
# Check form values, etc., and subscribe the user.
# ...
subject = loader.get_template('alerts/subject.txt').render(Context({}))
message = loader.get_template('alerts/message.txt').render(Context({}))
send_mail(subject, message, '[email protected]', [user_email])
# ...
En este caso, debes crear las plantillas
subject.txt
message.txt
en ambos directorios de plantillas, el de
LJWorld.com y el d Lawrence.com . Como mencionamos anteriormente, eso te da ms exibilidad, pero tambin es
ms complejo.
Una buena idea ex explotar los objetos
Site lo ms posible, para que no hayan una complejidad y una redundancia
innecesarias.
Obtencin del dominio actual para las URLs completas
La convencin de Django de usar
get_absolute_url()
para obtener las URLs de los objetos sin el dominio, est
muy bien. Pero en en algunos casos puedes querer mostrar la URL completa -- con
http://
y el dominio, y todo --
para un objeto. Para hacerlo, puedes usar el framework sites. Este es un ejemplo:
>>> from django.contrib.sites.models import Site
>>> obj = MyModel.objects.get(id=3)
>>> obj.get_absolute_url()
'/mymodel/objects/3/'
>>> Site.objects.get_current().domain
'example.com'
>>> 'http:// %s %s' % (Site.objects.get_current().domain, obj.get_absolute_url())
'http://example.com/mymodel/objects/3/'
14.2.5.
Si los
CurrentSiteManager
Site``s juegan roles importante en tu aplicacin, considera el uso del til ``CurrentSiteManager
en tu modelo (o modelos). Es un administrador de modelos (consulta el Apndice B) que ltra automticamente sus
consultas para incluir slo los objetos asociados al
Usa
CurrentSiteManager
Site
actual.
agregndolo a tu modelo explcitamente. Por ejemplo:
from django.db import models
from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
class Photo(models.Model):
photo = models.FileField(upload_to='/home/photos')
photographer_name = models.CharField(maxlength=100)
pub_date = models.DateField()
site = models.ForeignKey(Site)
objects = models.Manager()
on_site = CurrentSiteManager()
Con este modelo,
Photo.objects.all() retorna todos los objetos Photo de la base de datos, pero Photo.on_site.all()
Photo asociados con el sitio actual, de acuerdo a la opcin de con guracin SITE_ID.
retorna slo los objetos
En otras palabras, estas dos sentencias son equivalentes:
Photo.objects.filter(site=settings.SITE_ID)
Photo.on_site.all()
revisin 757 del 28 de julio de 2008
178
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
CurrentSiteManager cul campo de Photo era el Site? Por defecto busca un campo llamado site. Si
ForeignKey o un campo ManyToManyField llamado de otra forma que site, debes pasarlo
explcitamente como el parmetro para CurrentSiteManager. El modelo a continuacin, que tiene un campo llamado
publish_on, lo demuestra:
Cmo supo
tu modelo tiene un campo
from django.db import models
from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
class Photo(models.Model):
photo = models.FileField(upload_to='/home/photos')
photographer_name = models.CharField(maxlength=100)
pub_date = models.DateField()
publish_on = models.ForeignKey(Site)
objects = models.Manager()
on_site = CurrentSiteManager('publish_on')
Si intentas usar
CurrentSiteManager y pasarle un nombre de campo que no existe, Django lanzar un ValueError.
Nota
Probablemente querrs tener un
usas
CurrentSiteManager.
Manager
normal (no espec co al sitio) en tu modelo, incluso si
Como se explica en el Apndice B, si de nes un manager manual-
mente, Django no crear automticamente el manager
objects = models.Manager().
Adems, algunas partes de Django -- el sitio de administracin y las vistas genricas -- usan
el manager que haya sido de nido primero en el modelo. As que si quieres que el sitio de
administracin tenga acceso a todos los objetos (no slo a los espec cos al sitio actual), pon un
objects = models.Manager()
14.2.6.
en tu modelo, antes de de nir
El uso que hace Django del
framework
CurrentSiteManager.
Sites
Si bien no es necesario que uses el framework sites, es extremadamente recomendado, porque Django toma ventaja
de ello en algunos lugares. Incluso si tu instalacin de Django est alimentando a un solo sitio, deberas tomarte unos
segundos para crear el objeto site con tu
domain
name,
y apuntar su ID en tu opcin de con guracin
SITE_ID.
Este es el uso que hace Django del framework sites :
En el framework redirects (consulta la seccin Redirects ms adelante), cada objeto redirect est
asociado con un sitio en particular. Cuando Django busca un redirect, toma en cuenta el
SITE_ID
actual.
En el framework comments, cada comentario est asociado con un sitio en particular. Cuando un
comentario es posteado, su
site es asignado al SITE_ID actual, y cuando los comentarios son listados
con la etiqueta de plantillas apropiada, slo los comentarios del sitio actual son mostrados.
En el framework atpages (consulta la seccin Flatpages ms adelante), cada pgina es asociada
con un sitio en particular. Cuando una pgina es creada, t especi cas su
atpage chequea el
SITE_ID
site,
y el middleware de
actual cuando se traen pginas para ser mostradas.
En el framework syndication (consulta el Captulo 11), las plantillas para
title
tienen acceso automtico a la variable
que representa al sitio
{{ site }},
que es el objeto
Site
actual. Adems, la conexin para proporcionar las URLs de los elementos usan el
objeto
Site
description
domain
dede el
actual si no especi cas un fully quali ed domain.
django.contrib.auth.views.login
{{ site_name }}.
En el framework authentication (consulta el Captulo 12), la vista
le pasa el nombre del
14.3.
Site
actual a la plantilla como
Flatpages
A menudo tendrs una aplicacin Web impulsada por bases de datos ya funcionando, pero necesitars agregar un
par de pginas estticas, tales como una pgina Acerca de o una pgina de Poltica de Privacidad. Sera posible usar
un servidor Web estndar como por ejemplo Apache para servir ese archivos como archivos HTML planos, pero eso
introduce un nivel extra de complejidad en tu aplicacin, porque entonces tienes que preocuparte de la con guracin
revisin 757 del 28 de julio de 2008
14.3. FLATPAGES
179
de Apache, tienes que preparar el acceso para que tu equipo pueda editar esos archivos, y no puedes sacar provecho
del sistema de plantillas de Django para darle estilo a las pginas.
La solucin a este problema es la aplicacin atpages de Django, la cual reside en el paquete
django.contrib.flatpages.
Esta aplicacin te permite manejar esas pginas aisladas mediante el sitio de administracin de Django, y te permite
especi car plantillas para las mismas usando el sistema de plantillas de Django. Detrs de escena usa modelos Django,
lo que signi ca que almacena las pginas en una base de datos, de la misma manera que el resto de tus datos, y puedes
acceder a las atpages con la API de bases de datos estndar de Django.
Las atpages son identi cadas por su URL y su sitio. Cuando creas una atpage, especi cas con cual URL est
asociada, junto con en cul(es) sitio(s) est (para ms informacin acerca de sitios, consulta la seccin Sites).
14.3.1.
Usando atpages
Para instalar la aplicacin atpages, sigue estos pasos:
'django.contrib.flatpages'
django.contrib.sites, as
INSTALLED_APPS.
1. Agrega
pendes de
2. Agrega
a tu
INSTALLED_APPS. django.contrib.flatpages
de-
que asegrate de que ambos paquetes se encuentren en
'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware'
MIDDLEWARE_CLASSES.
a tu varia-
ble de con guracin
3. Ejecuta el comando
manage.py syncdb
para instalar las dos tables necesarias en tu base de
datos.
La aplicacin atpages crea dos tablas en tu base de datos:
django_flatpage y django_flatpage_sites. django_flatpag
django_flatpage_sites es
simplemente mantiene una correspondencia entre URLs y ttulos ms contenido de texto.
una tabla muchos a muchos que asocia una atpage con uno o ms sitios.
La aplicacin incluye un nico modelo
FlatPage,
de nido en
django/contrib/flatpages/models.py.
El mismo
se ve as:
from django.db import models
from django.contrib.sites.models import Site
class FlatPage(models.Model):
url = models.CharField(maxlength=100)
title = models.CharField(maxlength=200)
content = models.TextField()
enable_comments = models.BooleanField()
template_name = models.CharField(maxlength=70, blank=True)
registration_required = models.BooleanField()
sites = models.ManyToManyField(Site)
Examinemos cada uno de los campos:
url: La URL donde reside esta atpage,
(/) inicial (por ej. /about/contact/).
excluyendo el nombre del dominio pero incluyendo la barra
title: El ttulo de la atpage. El framework no usa esto para nada en especial. Es tu responsabilidad
visualizarlo en tu plantilla.
content:
El contenido de la atpage (por ej. el HTML de la pgina). El framework no usa esto para
nada en especial. Es tu responsabilidad visualizarlo en tu plantilla.
enable_comments:
Indica si deben activarse los comentarios e esta atpage. El framework no usa
esto para nada en especial. Puedes comprobar este valor en tu plantilla y mostrar un formulario de
comentario si es necesario.
template_name: El nombre de la plantilla a usarse para renderizar esta atpage. Es opcional; si no se
indica o si esta plantilla no existe, el framework usar la plantilla flatpages/default.html.
registration_required:
Indica si se requerir registro para ver esta atpage. Esto se integra con el
framework de autenticacin/usuarios de Django, el cual se trata en el Captulo 12.
sites:
Los sitios en los cuales reside esta atpage. Esto se integra con el framework sites de Django,
el cual se trata en la seccin Sites en este captulo.
revisin 757 del 28 de julio de 2008
180
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
Puedes crear atpages ya sea a travs de la interfaz de administracin de Django o a travs de la API de base de
datos de Django. Para ms informacin, examina la seccin Agregando, modi cando y eliminando atpages.
Una vez que has creado atpages,
FlatpageFallbackMiddleware
se encarga de todo el trabajo. Cada vez que
cualquier aplicacin Django lanza un error, este middleware veri ca como ltimo recurso la base de datos de atpages
en bsqueda de la URL que se ha requerido. Espec camente busca una atpage con la URL en cuestin y con un
identi cador de sitio que coincida con la variable de con guracin
SITE_ID.
flatpages/default.html
Si encuentra una coincidencia, carga la plantilla de la atpage, o
si la atpage no ha
especi cado una plantilla personalizada. Le pasa a dicha plantilla una nica variable de contexto:
RequestContext para renderizar la plantilla.
FlatpageFallbackMiddleware no encuentra una coincidencia, el
flatpage,
la cual
es el objeto atpage. Usa
Si
proceso de la peticin contina normalmente.
Nota
Este middleware slo se activa para errores 404 (pgina no encontrada) -- no para errores 500 (error
MIDDLEWARE_CLASSES es
FlatpageFallbackMiddleware en o cerca del nal
en servidor) u otras respuestas de error. Nota tambin que el orden de
relevante. Generalmente, puedes colocar el
de la lista, debido a que se trata de una opcin de ltimo recurso.
14.3.2.
Agregando, modi cando y eliminando atpages
Puedes agregar, cambiar y eliminar atpages de dos maneras:
Va la interfaz de administracin
Si has activado la interfaz automtica de administracin de Django, deberas ver una seccin Flatpages en la
pgina de ndice de la aplicacin admin. Edita las atpages como lo haras con cualquier otro objeto en el sistema.
Va la API Python
Como ya se describi, las atpages se representan mediante un modelo Django estndar que reside en
django/contrib/flatpages
Por lo tanto puede acceder a objetos atpage mediante la API de base de datos Django, por ejemplo:
>>> from django.contrib.flatpages.models import FlatPage
>>> from django.contrib.sites.models import Site
>>> fp = FlatPage(
...
url='/about/',
...
title='About',
...
content='<p>About this site...</p>',
...
enable_comments=False,
...
template_name='',
...
registration_required=False,
... )
>>> fp.save()
>>> fp.sites.add(Site.objects.get(id=1))
>>> FlatPage.objects.get(url='/about/')
<FlatPage: /about/ -- About>
14.3.3.
Usando plantillas de atpages
flatpages/default.html, pero puedes cambiar eso
template_name en el objeto FlatPage.
Es tu responsabilidad el crear la plantilla flatpages/default.html. En tu directorio de plantillas, crea un directorio flatpages que contenga un archivo default.html.
A la plantillas de atpages se les pasa una nica variable de contexto: flatpage, la cual es el objeto atpage.
Este es un ejemplo de una plantilla flatpages/default.html:
Por omisin, las atpages son renderizadas va la plantilla
para cualquier atpage con el campo
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
<title>{{ flatpage.title }}</title>
revisin 757 del 28 de julio de 2008
14.4. REDIRECTS
181
</head>
<body>
{{ flatpage.content }}
</body>
</html>
14.4.
Redirects
El framework redirects de Django te permite administrar las redirecciones con facilidad almacenndolos en una
base de datos y tratndolos como cualquier otro objeto modelo de Django. Por ejemplo puedes usar el framework
redirects para indicarle a Django Redirecciona cualquier peticin de
/music/
/sections/arts/music/..
Esto es
til cuando necesitas cambiar las cosas de lugar en tu sitio; los desarrolladores Web deberan hacer lo que est en sus
manos para evitar los enlaces rotos.
14.4.1.
Usando el framework redirects
Para instalar la aplicacin redirects, sigue estos pasos:
1. Agrega
2. Agrega
'django.contrib.redirects'
a tu
INSTALLED_APPS.
'django.contrib.redirects.middleware.RedirectFallbackMiddleware'
MIDDLEWARE_CLASSES.
a tu varia-
ble de con guracin
3. Ejecuta el comando
manage.py syncdb para instalar la nica tabla necesaria a tu base de datos.
manage.py syncdb crea una tabla django_redirect en tu base de datos. Esta se trata sencillamente de una tabla
site_id, old_path y new_path.
de bsqueda con campos
Puedes crear redirecciones tanto a travs de la interfaz de administracin como a travs de la API de base de datos
de Django. Para ms informacin puedes leer la seccin Agregando, modi cando y eliminando redirecciones.
Una vez que has creado redirecciones, la clase
RedirectFallbackMiddleware
se encarga de todo el trabajo. Cada
vez que cualquier aplicacin Django lanza un error 404, este middleware veri ca como ltimo recurso la base de datos
old_path provisto
SITE_ID. (para ms informacin acerca de
de redirects en bsqueda de la URL que se ha requerido. Espec camente busca un redirect con el
y con un identi cador de sitio que coincida con la variable de con guracin
SITE_ID
y el framework sites, consulta la seccin Sites). Luego entonces realiza los siguientes pasos:
Si encuentra una coincidencia y
Si encuentra una coincidencia y
new_path
no est vaco, redirecciona la peticin a
new_path
new_path.
est vaci, enva una cabecera HTTP 410 (Ausente) y
una respuesta vaca (sin contenido).
Si no encuentra una coincidencia, el procesamiento de la peticin contina normalmente.
El middleware slo se activa ante errores 404 -- no en errores 500 o respuestas con otros cdigos de estado.
Notar que el orden de
MIDDLEWARE_CLASSES es relevante. Generalmente puedes colocar RedirectFallbackMiddleware
cerca del nal de la lista, debido a que se trata de una opcin de ltimo recurso.
Nota
Si usas los middlewares redirect y atpages, analiza cual de los dos (redirect o atpages) desearas sea ejecutado primero. Sugerimos con gurar atpages antes que redirects (o sea colocar el
middleware atpages antes que el middleware redirects) pero tu podras decidir lo contrario.
14.4.2.
Agregando, modi cando y eliminando redirecciones
Puedes agregar, modi car y eliminar redirecciones de dos maneras:
Va la interfaz de administracin
Si has activado la interfaz automtica de administracin de Django, deberas ver una seccin Redirects en la
pgina de ndice de la aplicacin admin. Edita las redirecciones como lo haras con cualquier otro objeto en el sistema.
revisin 757 del 28 de julio de 2008
182
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
Va la API Python
Las redirecciones se representan mediante un modelo estndar Django que reside en
django/contrib/redirects/models.py.
Por lo tanto puedes acceder a los objetos redirect va la API de base de datos de Django, por ejemplo:
>>> from django.contrib.redirects.models import Redirect
>>> from django.contrib.sites.models import Site
>>> red = Redirect(
...
site=Site.objects.get(id=1),
...
old_path='/music/',
...
new_path='/sections/arts/music/',
... )
>>> red.save()
>>> Redirect.objects.get(old_path='/music/')
<Redirect: /music/ ---> /sections/arts/music/>
14.5.
Proteccin contra CSRF
El paquete
django.contrib.csrf
provee proteccin contra Cross-site request forgery (CSRF) (falsi cacin de
peticiones inter-sitio).
CSRF, tambin conocido como session riding (montado de sesiones) es un exploit de seguridad en sitios Web. Se
presenta cuando un sitio Web malicioso induce a un usuario a cargar sin saberlo una URL desde un sitio al cual dicho
usuario ya se ha autenticado, por lo tanto saca ventaja de su estado autenticado. Inicialmente esto puede ser un poco
difcil de entender as que en esta seccin recorreremos un par de ejemplos.
14.5.1.
Un ejemplo simple de CSRF
example.com. Este sitio proveedor de webmail tiene un botn
example.com/logout -- esto es, la nica accin que necesitas realizar para desconectarte
visitar la pgina example.com/logout.
malicioso puede coercerte a visitar la URL example.com/logout incluyendo esa URL como un <iframe>
Supongamos que posees una cuenta de webmail en
Log Out que apunta a la URL
(log out ) es
Un sitio
oculto en su propia pgina maliciosa. De manera que si ests conectado (logged in ) a tu cuenta de webmail del sitio
example.com
y visitas la pgina maliciosa, el hecho de visitar la misma te desconectar de
example.com.
Claramente, ser desconectado de un sitio de webmail contra tu voluntad no es un incidente de seguridad aterrorizante, pero este tipo de exploit puede sucederle a cualquier sitio que confa en sus usuarios, tales como un sitio de
un banco o un sitio de comercio electrnico.
14.5.2.
Un ejemplo ms complejo de CSRF
En el ejemplo anterior, el sitio
example.com
tena parte de la culpa debido a que permita que se pudiera solicitar
GET. Es una prctica mucho mejor el requerir
POST HTTP para cada peticin que cambie el estado en el servidor. Pero aun los sitios Web que requieren
el uso de POST para acciones que signi quen cambios de estado son vulnerables a CSRF.
Supongamos que example.com ha mejorado su funcionalidad de desconexin de manera que Log Out es ahora
un botn de un <form> que es enviado va un POST a la URL example.com/logout. Adicionalmente, el <form> de
un cambio de estado (la desconexin del sitio) mediante el mtodo HTTP
el uso de un
desconexin incluye un campo oculto:
<input type="hidden" name="confirm" value="true" />
Esto asegura que un simple
POST
a la URL
example.com/logout no desconectar a un usuario; para que los
example.com/logout usando POST y enviar la variable
usuarios puedan desconectarse, debern enviar una peticin a
POST confirm
con el valor
'true'.
Bueno, aun con dichas medidas extra de seguridad, este esquema tambin puede ser atacado mediante CSRF -- la
pgina maliciosa slo necesita hacer un poquito ms de trabajo. Los atacantes pueden crear un formulario completo
que enve su peticin a tu sitio, ocultar el mismo en un
<iframe>
invisible y luego usar JavaScript para enviar dicho
formulario en forma automtica.
revisin 757 del 28 de julio de 2008
14.5. PROTECCIN CONTRA CSRF
14.5.3.
183
Previniendo la CSRF
Entonces, Cmo puede tu sitio defenderse de este exploit?. El primer paso es asegurarse que todas las peticiones
GET
no posean efectos colaterales. De esa forma, si un sitio malicioso incluye una de tus pginas como un
esto no tendr un efecto negativo.
Esto nos deja con las peticiones
<iframe>,
POST. El segundo paso es dotar a cada <form> que se enviar va POST un campo
oculto cuyo valor sea secreto y sea generado en base al identi cador de sesin del usuario. Entonces luego, cuando se
est realizando el procesamiento del formulario en el servidor, comprobar dicho campo secreto y generar un error si
dicha comprobacin no es exitosa.
Esto es precisamente que lo hace la capa de prevencin de CSRF de Django, tal como se explica en la siguiente
seccin.
Usando el middleware CSRF
django.contrib.csrf contiene slo un mdulo: middleware.py. Este mdulo contiene una clase middCsrfMiddleware la cual implementa la proteccin contra CSRF.
Para activar esta proteccion, agrega 'django.contrib.csrf.middleware.CsrfMiddleware' a la variable de con guracin MIDDLEWARE_CLASSES en tu archivo de con guracin. Este middleware necesita procesar la respuesta despus
de SessionMiddleware, as que CsrfMiddleware debe aparecer antes que SessionMiddleware en la lista (esto es
El paquete
leware Django:
debido que el middleware de respuesta es procesado desde atrs hacia adelante). Por otra parte, debe procesar la
CsrfMiddleware debe
MIDDLEWARE_CLASSES ya ests listo. Revisa
respuesta antes que la misma sea comprimida o alterada de alguna otra forma, de manera que
aparecer despus de
GZipMiddleware.
Una vez que has agregado eso a tu
la seccin Orden de MIDDLEWARE_CLASSES en el Captulo 13 si necesitas conocer ms sobre el tema.
En el caso en el que ests interesado, as es como trabaja
CsrfMiddleware.
Realiza las siguientes dos cosas:
1. Modi ca las respuestas salientes a peticiones agregando un campo de formulario oculto a todos
los formularios
POST,
con el nombre
csrfmiddlewaretoken
y un valor que es un
*hash* del
identi cador de sesin ms una clave secreta. El middleware no modi ca la respuesta si no existe
un identi cador de sesin, de manera que el costo en rendimiento es despreciable para peticiones
que no usan sesiones.
2. Para todas las peticiones
POST que porten la cookie de sesin, comprueba que csrfmiddlewaretoken
est presente y tenga un valor correcto. Si no cumple estas condiciones, el usuario recibir un
error
HTTP
403. El contenido de la pgina de error es el mensaje Cross Site Request Forgery
detected. Request aborted.
Esto asegura que solamente se puedan usar formularios que se hayan originado en tu sitio Web para enviar datos
va POST al mismo.
POST (y sus correspondientes formulaGET nunca deberan tener efectos colaterales; es tu responsabilidad
Este middleware deliberadamente trabaja solamente sobre peticiones HTTP
rios POST). Como ya hemos explicado, las peticiones
asegurar eso.
Las peticiones
POST
que no estn acompaadas de una cookie de sesin no son protegidas simplemente porque no
tiene sentido protegerlas, un sitio Web malicioso podra de todas formas generar ese tipo de peticiones.
Content-Type de la respuesta
application/xml+xhtml.
Para evitar alterar peticiones no HTML, el middleware revisa la cabecera
modi carla. Slo modi ca las pginas que son servidas como
text/html
antes de
Limitaciones del middleware CSRF
CsrfMiddleware
necesita el framework de sesiones de Django para poder funcionar. (Revisa el Captulo 12 para
obtener ms informacin sobre sesiones). Si ests usando un framework de sesiones o autenticacin personalizado que
maneja en forma manual las cookies de sesin, este middleware no te ser de ayuda.
Si tu aplicacin crea pginas HTML y formularios con algn mtodo inusual (por ej. si enva fragmentos de HTML
document.write), podras estr salteandote el ltro que agrega el campo oculto al formulario.
CsrfMiddleware usa una
agregar el campo csrfmiddlewaretoken a tu HTML antes de que la pgina sea enviada al
en sentencias JavaScript
De presentarse esta situacin, el envo del formulario fallar siempre. (Esto sucede porque
expresin regular para
cliente, y la expresin regular a veces no puede manejar cdigo HTML muy extravagante). Si sospechas que esto
podra estar sucediendo, slo examina el cdigo en tu navegador Web para ver si es que
sido insertado en tu
<form>.
Para ms informacin y ejemplos sobre CSRF, visita
csrfmiddlewaretoken
http://en.wikipedia.org/wiki/CSRF.
revisin 757 del 28 de julio de 2008
ha
184
14.6.
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
Haciendo los datos ms humanos
Esta aplicacin aloja un conjunto de ltros de plantilla tiles a la hora de agregar un toque humano a los datos.
django.contrib.humanize a tu variable de con guracin INSTALLED_APPS. Una vez
{ % load humanize %} en una plantilla, y tendrs acceso a los ltros que se describen en las
Para activar esos ltros, agrega
que has hecho eso, usa
siguientes secciones.
14.6.1.
apnumber
Para nmeros entre 1 y 9, este ltro retorna la representacin textual del nmero. Caso contrario retorna el numeral.
Esto cumple con el estilo Associated Press.
Ejemplos:
1 se convierte en uno.
2 se convierte en dos.
10 se convierte en 10.
Puedes pasarle ya sea un entero o una representacin en cadena de un entero.
14.6.2.
intcomma
Este ltro convierte un entero a una cadena conteniendo comas cada tres dgitos.
Ejemplos:
4500 se convierte en 4,500.
45000 se convierte en 45,000.
450000 se convierte en 450,000.
4500000 se convierte en 4,500,000.
Puedes pasarle ya sea un entero o una representacin en cadena de un entero.
14.6.3.
intword
Este ltro convierte un entero grande a una representacin amigable en texto. Funciona mejor con nmeros mayores
a un milln.
Ejemplos:
1000000 se convierte en 1.0 milln.
1200000 se convierte en 1.2 milln.
1200000000 se convierte en 1.2 millardos.
Se admiten valores hasta un billardo (1,000,000,000,000,000).
Puedes pasarle ya sea un entero o una representacin en cadena de un entero.
14.6.4.
ordinal
Este ltro convierte un entero a una cadena cuyo valor es su ordinal.
Ejemplos:
1 se convierte en 1st.
2 se convierte en 2nd.
3 se convierte en 3rd.
Puedes pasarle ya sea un entero o una representacin en cadena de un entero.
revisin 757 del 28 de julio de 2008
14.7. FILTROS DE MARCADO
14.7.
185
Filtros de marcado
La siguiente coleccin de ltros de plantilla implementa lenguajes comunes de marcado:
textile:
Implementa Textile (http://en.wikipedia.org/wiki/Textile_%28markup_language%29)
markdown:
Implementa Markdown (http://en.wikipedia.org/wiki/Markdown)
restructuredtext: Implementa ReStructured Text (http://en.wikipedia.org/wiki/ReStructuredText)
En cada caso el ltro espera el texto con formato de marcado como una cadena y retorna una cadena representando
el texto con formato. Por ejemplo el ltro
textile
convierte texto marcado con formato Textile a HTML:
{ % load markup %}
{{ object.content|textile }}
django.contrib.markup a tu variable de con guracin INSTALLED_APPS. Una
{ % load markup %} en una plantilla y tendrs acceso a dichos ltros. Para ms detalles
django/contrib/markup/templatetags/markup.py.
Para activar estos ltros, agrega
vez que hayas hecho esto, usa
examina el cdigo fuente en
14.8.
Qu sigue?
Muchos de estos frameworks contribuidos (CSRF, el sistema de autenticacin, etc.) hacen su magia proveyendo
una pieza de middleware. El middleware es esencialmente cdigo que se ejecuta antes y/o despus de cada peticin y
puede modi car cada peticin y respuesta a voluntad. A continuacin trataremos el middleware incluido con Django
y explicaremos cmo puedes crear el tuyo propio.
revisin 757 del 28 de julio de 2008
186
CAPTULO 14. OTROS SUB-FRAMEWORKS CONTRIBUIDOS
revisin 757 del 28 de julio de 2008
Captulo 15
Middleware
En ocasiones, necesitars ejecutar una pieza de cdigo en todas las peticiones que maneja Django. ste cdigo
puede necesitar modi car la peticin antes de que la vista se encargue de ella, puede necesitar registrar informacin
sobre la peticin para propsitos de debugging, y as sucesivamente.
Tu puedes hacer esto con el framework middleware de Django, que es un conjunto de acoples dentro del procesamiento de peticin/respuesta de Django. Es un sistema de plug-in liviano y de bajo nivel capaz de alterar de forma
global tanto la entrada como la salida de Django.
Cada componente middleware es responsable de hacer alguna funcin espec ca. Si estas leyendo este libro de forma
lineal (disculpen, posmodernistas), has visto middleware varias veces ya:
Todas las herramientas de usuario y sesin que vimos en el Captulo 12 son posibles gracias a unas
pequeas piezas de middleware (ms espec camente, el middleware hace que
request.user
request.session
estn disponibles para ti en las vistas.
La cache global del sitio discutida en el Captulo 13 es solo una pieza de middleware que desva la
llamada a tu funcin de vista si la respuesta para esa vista ya fue almacenada en la cache.
Todas las aplicaciones contribuidas
flatpages, redirects,
csrf
del Captulo 14 hacen su magia a
travs de componentes middleware.
Este captulo se sumerge ms profundamente en qu es exactamente el middleware y cmo funciona, y explica
cmo puedes escribir tu propio middleware.
15.1.
Qu es middleware
Un componente middleware es simplemente una clase Python que se ajusta a una cierta API. Antes de entrar en
los aspectos formales de los que es esa API, miremos un ejemplo muy sencillo.
Sitios de tr co alto a menudo necesitan implementar Django detrs de un proxy de balanceo de carga (mira
el Captulo 20). Esto puede causar unas pequeas complicaciones, una de las cuales es que la IP remota de cada
peticin (request.META["REMOTE_IP"]) ser la del balanceador de carga, no la IP real que realiza la peticin. Los
balanceadores de carga manejan esto estableciendo una cabecera especial,
X-Forwarded-For,
con el valor real de la
direccin IP que realiza la peticin.
As que aqu est una pequea parte de middleware que le permite a los sitios que se ejecutan detrs de un proxy
ver la direccin IP correcta en
request.META["REMOTE_ADDR"]:
class SetRemoteAddrFromForwardedFor(object):
def process_request(self, request):
try:
real_ip = request.META['HTTP_X_FORWARDED_FOR']
except KeyError:
pass
else:
# HTTP_X_FORWARDED_FOR can be a comma-separated list of IPs.
# Take just the first one.
real_ip = real_ip.split(",")[0]
request.META['REMOTE_ADDR'] = real_ip
revisin 757 del 28 de julio de 2008
188
CAPTULO 15. MIDDLEWARE
X-Forwarded-For de todas las peticiones ser automtirequest.META['REMOTE_ADDR']. Esto signi ca que tus aplicaciones Django no necesitan conocer
si estn detrs de un proxy de balanceo de carga o no, pueden simplemente acceder a request.META['REMOTE_ADDR'],
Si esto es instalado (mira la siguiente seccin), el valor de
camente insertado en
y eso funcionar si se usa un proxy o no.
De hecho, es una necesidad tan comn, que esta pieza de middleware ya viene incorporada en Django. Esta ubicada
en
django.middleware.http,
15.2.
y puedes leer ms sobre ella en la siguiente seccin.
Instalacin de Middleware
Si has ledo este libro completamente hasta aqu, ya has visto varios ejemplos de instalacin de middleware; muchos
de los ejemplos en los captulos previos han requerido cierto middleware. Para completar, a continuacin se muestra
la manera de instalar middleware.
Para activar un componente middleware, agregarlo a la tupla
En
MIDDLEWARE_CLASSES,
MIDDLEWARE_CLASSES en tu archivo de con guracin.
cada componente middleware se representa con un string: la ruta Python completa al
nombre de la clase middleware. Por ejemplo, aqu se muestra la tupla
django-admin.py startproject:
MIDDLEWARE_CLASSES
por omisin creada por
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.middleware.doc.XViewMiddleware'
)
Una instalacin Django no requiere ningn middleware -- La tupla
quieres -- pero te recomendamos que actives
CommonMiddleware,
MIDDLEWARE_CLASSES
puede estar vaca, si tu
la cual explicaremos en breve.
El orden es importante. En las fases de peticin y vista, Django aplica el middleware en el orden que gura en
MIDDLEWARE_CLASSES, y en las fases de respuesta y excepcin, Django
decir, Django trata MIDDLEWARE_CLASSES como una especie de wrapper
aplica el middleware en el orden inverso. Es
alrededor de la funcin de vista: en la peticin
recorre hacia abajo la lista hasta la vista, y en la respuesta la recorre hacia arriba. Mira la seccin Cmo procesa una
peticin Django: Detalles completos en el Captulo 3 para un repaso de las fases.
15.3.
Mtodos de un Middleware
Ahora que sabes qu es un middleware y cmo instalarlo, echemos un vistazo a todos los mtodos disponibles que
las clases middleware pueden de nir.
15.3.1.
Utiliza
Inicializar: __init__(self )
__init__()
para realizar una con guracin a nivel de sistema de una determinada clase middleware.
Por razones de rendimiento, cada clase middleware activada es instanciada slo una vez por proceso servidor. Esto
signi ca que
__init__()
es llamada slo una vez -- al iniciar el servidor -- no para peticiones individuales.
__init__() es para veri car si el middleware es en realidad nece__init__() emite django.core.exceptions.MiddlewareNotUsed, entonces Django remover el middleware
Una razn comn para implementar un mtodo
sario. Si
de la pila de middleware. Tu podras usar esta caracterstica para veri car si existe una pieza de software que la clase
middleware requiere, o veri car si el servidor esta ejecutndose en modo debug, o cualquier otra situacin similar.
Si una clase middleware de ne un mtodo
15.3.2.
__init__(), ste no debe tomar argumentos ms all del estndar self.
Pre-procesador de peticin: process_request(self, request)
ste mtodo es llamado tan pronto como la peticin ha sido recibida -- antes de que Django haya analizado
sintcticamente la URL para determinar cul vista ejecutar. Se le pasa el objeto
a tu voluntad.
process_request()
Si devuelve
debe retornar ya sea
None,
None
o un objeto
HttpRequest, el cual puedes modi car
HttpResponse.
Django continuar procesando esta peticin, ejecutando cualquier otro middleware
y la vista apropiada.
Si devuelve un objeto
HttpResponse,
Django no se encargar de llamar a cualquier otro middleware
(de ningn tipo) o a la vista apropiada. Django inmediatamente devolver se objeto
revisin 757 del 28 de julio de 2008
HttpResponse.
15.3. MTODOS DE UN MIDDLEWARE
15.3.3.
189
Pre-procesador de vista: process_view(self, request, view, args, kwargs)
ste mtodo es llamado despus de la llamada al pre-procesador de peticin y despus de que Django haya determinado qu vista ejecutar, pero antes de que sa vista sea realmente ejecutada.
Los argumentos que se pasan a esta vista son mostrados en la Tabla 15-1.
Cuadro 15.1: Argumentos que se pasan a process_view()
Argumento
Explicacin
request
view
El objeto
HttpRequest.
La funcin Python que Django llamar para manejar esta peticin. Este es en
realidad el objeto funcin en s, no el nombre de la funcin como string.
args
La lista de argumentos posicionales que sern pasados a la vista, no incluye el
argumento
kwargs
request
(el cual es siempre el primer argumento de una vista).
El diccionario de palabras clave argumento que ser pasado a la vista.
As como el mtodo
Si devuelve
process_request()`, ``process_view() debe retornar ya sea None o un objeto HttpResponse.
None,
Django continuar procesando esta peticin, ejecutando cualquier otro middleware
y la vista apropiada.
Si devuelve un objeto
HttpResponse,
Django no se encargar de llamar a cualquier otro middleware
(de ningn tipo) o a la vista apropiada. Django inmediatamente devolver se objeto
15.3.4.
HttpResponse.
Pos-procesador de respuesta: process_response(self, request, response)
ste mtodo es llamado despus de que la funcin de vista es llamada y la respuesta generada. Aqu, el procesador
puede modi car el contenido de una respuesta; un caso de uso obvio es la compresin de contenido, como por ejemplo
la compresin con gzip del HTML de la respuesta.
Los parmetros deben ser bastante auto-explicativos:
request
es el objeto peticin, y
response
es el objeto
respuesta retornados por la vista.
None, process_response()
HttpResponse. Esa respuesta puede ser la respuesta original pasada a la funcin (posiblemente
A diferencia de los pre-procesadores de peticin y vista, los cuales pueden retornar
debe retornar un objeto
modi cada) o una totalmente nueva.
15.3.5.
Pos-procesador de excepcin: process_exception(self, request, exception)
ste mtodo es llamado slo si ocurre algn error y la vista emite una excepcin sin capturar. Puedes usar este
mtodo para enviar noti caciones de error, volcar informacin postmrtem a un registro, o incluso tratar de recuperarse
del error automticamente.
Los parmetros para esta funcin son el mismo objeto request con el que hemos
exception, el cual es el objeto Exception real emitido por la funcin de vista.
process_exception() debe retornar ya sea None o un objeto HttpResponse.
Si devuelve
None,
venido tratando hasta aqu, y
Django continuar procesando esta peticin con el manejador de excepcin incor-
porado en el framework.
Si devuelve un objeto
HttpResponse,
Django usar esa respuesta en vez del manejador de excepcin
incorporado en el framework.
Nota
Django trae incorporado una serie de clases middleware (que se discuten en la seccin siguiente)
que hacen de buenos ejemplos. La lectura de su cdigo debera darte una buena idea de la potencia
del middleware.
Tambin puedes encontrar una serie de ejemplos contribuidos por la comunidad en el wiki de
Django:
http://code.djangoproject.com/wiki/ContributedMiddleware
revisin 757 del 28 de julio de 2008
190
15.4.
CAPTULO 15. MIDDLEWARE
Middleware incluido
Django viene con algunos middleware incorporados para lidiar con problemas comunes, los cuales discutiremos en
las secciones que siguen.
15.4.1.
Middleware de soporte para autenticacin
django.contrib.auth.middleware.AuthenticationMiddleware.
request.user, que representa el usuario
todo objeto HttpRequest que se recibe.
Clase middleware:
Este middleware permite el soporte para autenticacin. Agrega el atributo
actual registrado, a
Mira el Captulo 12 para los detalles completos.
15.4.2.
Middleware Common
Clase middleware:
django.middleware.common.CommonMiddleware.
Este middleware agrega algunas conveniencias para los perfeccionistas:
Prohbe el acceso a los agentes de usuario especi cados en la con guracin DISALLOWED_USER_AGENTS :
Si se especi ca, esta con guracin debera ser una lista de objetos de expresiones regulares compiladas
que se comparan con el encabezado user-agent de cada peticin que se recibe. Aqu esta un pequeo
ejemplo de un archivo de con guracin:
import re
DISALLOWED_USER_AGENTS = (
re.compile(r'^OmniExplorer_Bot'),
re.compile(r'^Googlebot')
)
Nota el
import re, ya que DISALLOWED_USER_AGENTS requiere que sus valores sean expresiones regure.compile()). El archivo de con guracin es un archivo
de Python, por lo tanto es perfectamente adecuado incluir sentencias import en l.
lares compiladas (es decir, el resultado de
comn
Realiza re-escritura de URL basado en las con guraciones APPEND_SLASH y PREPEND_WWW :
Si
APPEND_SLASH
es igual a
True,
las URLs que no poseen una barra al nal sern redirigidas a la
misma URL con una barra al nal, a menos que el ltimo componente en el path contenga un punto.
De esta manera
foo.com/bar
es redirigido a
foo.com/bar/,
pero
foo.com/bar/file.txt
es pasado
a travs sin cambios.
Si
PREPEND_WWW es igual a True, las URLs que no poseen el pre jo www.
sern redirigidas a la misma
URL con el pre jo www..
Ambas opciones tienen por objeto normalizar URLs. La losofa es que cada URL debera existir en
example.com/bar es distinta de example.com/bar/,
www.example.com/bar/. Un motor de bsqueda indizador tratara
un -- y slo un -- lugar. Tcnicamente la URL
la cual a su vez es distinta de
de forma separada estas URLs, lo cual es perjudicial para la valoracin de tu sitio en el motor de
bsqueda, por lo tanto es una buena prctica normalizar las URLs.
Maneja ETags basado en la con guracin USE_ETAGS : ETags son una optimizacin a nivel HTTP
para almacenar condicionalmente las pginas en la cach. Si
USE_ETAGS
es igual a
True,
Django
calcular una ETag para cada peticin mediante la generacin de un hash MD5 del contenido de la
pgina, y se har cargo de enviar respuestas
Nota tambin que existe un middleware de
Not Modified, si es apropiado.
GET condicional, que veremos en
breve, el cual maneja
ETags y hace algo ms.
15.4.3.
Middleware de compresin
Clase middleware:
django.middleware.gzip.GZipMiddleware.
Este middleware comprime automticamente el contenido para aquellos navegadores que comprenden la compresin
gzip (todos los navegadores modernos). Esto puede reducir mucho la cantidad de ancho de banda que consume un
servidor Web. La desventaja es que esto toma un poco de tiempo de procesamiento para comprimir las pginas.
Nosotros por lo general preferimos velocidad sobre ancho de banda, pero si tu pre eres lo contrario, solo habilita
este middleware.
revisin 757 del 28 de julio de 2008
15.5. QU SIGUE?
15.4.4.
191
Middleware de GET condicional
django.middleware.http.ConditionalGetMiddleware.
GET condicionales. Si la respuesta contiene un encabezado
Last-Modified o ETag, y la peticin contiene If-None-Match o If-Modified-Since, la respuesta es reemplazada
por una respuesta 304 (Not modi ed). El soporte para ETag depende de la con guracin USE_ETAGS y espera que
el encabezado ETag de la respuesta ya este previamente jado. Como se seal anteriormente, el encabezado ETag es
Clase middleware:
Este middleware provee soporte para operaciones
jado por el middleware Common.
Tambin elimina el contenido de cualquier respuesta a una peticin
Content-Length
15.4.5.
HEAD
y ja los encabezados de respuesta
Date
para todas las peticiones.
Soporte para uso de proxy inverso (Middleware X-Forwarded-For)
Clase middleware:
django.middleware.http.SetRemoteAddrFromForwardedFor.
Este es el ejemplo que examinamos en la seccin anterior Qu es middleware. Este establece el valor de
request.META['HTTP_X_FORWARDED_FOR'], si este ltimo esta
proxy inverso que provoca que cada peticin REMOTE_ADDR sea jada
request.META['RE
basndose en el valor de
jado. Esto es til si estas
parado detrs de un
127.0.0.1.
Atencin!
HTTP_X_FORWARDED_FOR.
HTTP_X_FORWARDED_FOR automticamente,
no uses este middleware. Cualquiera puede inventar el valor de HTTP_X_FORWARDED_FOR, y ya
que este establece REMOTE_ADDR basndose en HTTP_X_FORWARDED_FOR, signi ca que cualquiera
Este middleware no hace validar
Si no estas detrs de un proxy inverso que establece
puede falsear su direccin IP.
Solo usa este middleware cuando confes absolutamente en el valor de
15.4.6.
HTTP_X_FORWARDED_FOR.
Middleware de soporte para sesiones
Clase middleware:
django.contrib.sessions.middleware.SessionMiddleware.
Este middleware habilita el soporte para sesiones. Mira el Captulo 12 para ms detalles.
15.4.7.
Middleware de cache de todo el sitio
Clase middleware:
django.middleware.cache.CacheMiddleware.
Este middleware almacena en la cache cada pgina impulsada por Django. Este se analiz en detalle en el Captulo
13.
15.4.8.
Middleware de transaccin
Clase middleware:
django.middleware.transaction.TransactionMiddleware.
COMMIT o ROLLBACK de la base de datos con una fase de peticin/respuesta. Si una vista
con xito, se emite un COMMIT. Si la vista provoca una excepcin, se emite un ROLLBACK.
Este middleware asocia un
de funcin se ejecuta
El orden de este middleware en la pila es importante. Los mdulos middleware que se ejecutan fuera de este, se
ejecutan con commit-on-save -- el comportamiento por omisin de Django. Los mdulos middleware que se ejecutan
dentro de este (prximos al nal de la pila) estarn bajo el mismo control de transaccin que las vistas de funcin.
Mira el Apndice C para obtener ms informacin sobre las transacciones de base de datos.
15.4.9.
Middleware X-View
django.middleware.doc.XViewMiddleware.
X-View personalizadas a peticiones HEAD que provienen de direcciones
IP de nidas en la con guracin INTERNAL_IPS. Esto es usado por el sistema automtico de documentacin de Django.
Clase middleware:
Este middleware enva cabeceras HTTP
15.5.
Qu sigue?
Los desarrolladores Web y los diseadores de esquemas de bases de datos no siempre tienen el lujo de comenzar
desde cero. En el
`prximo captulo`_, vamos a cubrir el modo de integrarse con sistemas existentes, tales como
esquemas de bases de datos que has heredado de la dcada de los 80.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
192
CAPTULO 15. MIDDLEWARE
revisin 757 del 28 de julio de 2008
Captulo 16
Integracin con Base de datos y Aplicaciones
existentes
Django es el ms adecuado para el desarrollo denominado de campo verde -- es decir, comenzar proyectos desde cero,
como si estuviramos construyendo un edi cio en un campo de verde pasto fresco. Pero a pesar de que Django favorece
a los proyectos iniciados desde cero, es posible integrar el framework con bases de datos y aplicaciones existentes
19 .
Este captulo explica algunas de las estrategias de integracin.
16.1.
Integracin con una base de datos existente
La capa de base de datos de Django genera esquemas SQL desde cdigo Python -- pero con una base de datos
existente, t ya tienes los esquemas SQL. En tal caso, necesitas crear modelos para tus tablas de la base de datos
existente. Para este propsito, Django incluye una herramienta que puede generar el cdigo del modelo leyendo el diseo
de las tablas de la base de datos. Esta herramienta se llama
manage.py inspectdb.
16.1.1.
Empleo de
La utilidad
inspectdb
inspectdb,
y puedes llamarla ejecutando el comando
inspectdb
realiza una introspeccin de la base de datos a la que apunta tu archivo de con guracin,
determina una representacin del modelo que usar Django para cada una de tus tablas, e imprime el cdigo Python
del modelo a la salida estndar.
Esta es una gua de un proceso tpico de integracin con una base de datos existente desde cero. Las nicas
suposiciones son que Django esta instalado y tienes una base de datos existente.
1. Crea un proyecto Django ejecutando
django-admin.py startproject mysite (donde mysite
mysite como nombre de proyecto en este ejemplo.
es el nombre de tu proyecto). Usaremos
2. Edita el archivo de con guracin en ese proyecto,
mysite/settings.py,
para decirle a Djan-
go cules son los parmetros de conexin a tu base de datos y cul es su nombre. Espec camente, provee las con guraciones de
DATABASE_PASSWORD, DATABASE_HOST,
DATABASE_NAME, DATABASE_ENGINE, DATABASE_USER,
DATABASE_PORT. (Ten en cuenta que algunas de estas
con guraciones son opcionales. Mira el Captulo 5 para ms informacin).
python mysite/manage.py startapp
myapp (donde myapp es el nombre de tu aplicacin). Usaremos myapp como el nombre de aplicacin
3. Crea una aplicacin dentro de tu proyecto ejecutando
aqu.
python mysite/manage.py inspectdb. Esto examinar las tablas en la base
DATABASE_NAME e imprimir para cada tabla el modelo de clase generado. Hecha una
a la salida para tener una idea de lo que puede hacer inspectdb.
4. Ejecuta el comando
de datos
mirada
5. Guarda la salida en el archivo
models.py dentro de tu aplicacin usando la redireccin de salida
estndar de la shell:
python mysite/manage.py inspectdb > mysite/myapp/models.py
6. Edita el archivo
mysite/myapp/models.py para limpiar los modelos generados y realiza cualquier
personalizacin necesaria. Te daremos algunas sugerencias para esto en la siguiente seccin.
revisin 757 del 28 de julio de 2008
194
CAPTULO 16. INTEGRACIN CON BASE DE DATOS Y APLICACIONES EXISTENTES
16.1.2.
Limpiar los modelos generados
Como podras esperar, la introspeccin de la base de datos no es perfecta, y necesitars hacer una pequea limpieza
al cdigo del modelo resultante. Aqu hay algunos apuntes para lidiar con los modelos generados:
1. Cada tabla de la base de datos es convertida en una clase del modelo (es decir, hay un mapeo
de uno-a-uno entre las tablas de la base de datos y las clases del modelo). Esto signi ca que
tendrs que refactorizar los modelos para tablas con relaciones muchos-a-muchos en objetos
ManyToManyField.
2. Cada modelo generado tiene un atributo para cada campo, incluyendo campos de clave primaria
id.
Sin embargo, recuerda que Django agrega automticamente un campo de clave primaria
id
si un modelo no tiene una clave primaria. Por lo tanto, querrs remover cualquier lnea que se
parezca a sta:
id = models.IntegerField(primary_key=True)
No solo estas lneas son redundantes, sino que pueden causar problemas si tu aplicacin agregar nuevos registros a estas tablas. El comando
inspectdb no puede detectar
AutoField, si es necesario.
si un campo es
autoincrementado, as que esta en ti cambiar esto a
CharField, DateField) es determinado mirando el tipo de la columna
VARCHAR, DATE). Si inspectdb no puede mapear un tipo de columna a
modelo, usar TextField e insertar el comentario Python 'This field
3. Cada tipo de campo (ej.,
de la base de datos (ej.,
un tipo de campo del
type is a guess.'
a continuacin del campo en el modelo generado. Mantn un ojo en eso, y
cambia el tipo de campo adecuadamente si es necesario.
Si un campo en tu base de datos no tiene un buen equivalente en Django, con seguridad puedes
dejarlo fuera. La capa de modelo de Django no requiere que incluyas todos los campos de tu(s)
tabla(s).
pass,
'_field' al nombre del atributo y establecer el atributo
del campo (ej., pass, class, o for).
tiene una columna INT llamada for, el modelo generado tendr un
4. Si un nombre de columna de tu base de datos es una palabra reservada de Python (como
class o for), inspectdb
db_column al nombre real
Por ejemplo, si una tabla
agregar
campo como este:
for_field = models.IntegerField(db_column='for')
inspectdb insertar el comentario Python 'Field renamed because it was a Python reserved
word.' a continuacin del campo.
5. Si tu base de datos contiene tablas que hacen referencia a otras tablas (como la mayora de las
bases de datos lo hacen), tal vez tengas que re-acomodar el orden de los modelos generados, de
manera que los modelos que hacen referencia a otros modelos estn ordenados apropiadamente.
Por ejemplo, si un modelo
Book tiene una ForeignKey al modelo Author, el modelo Author debe
Book. Si necesitas crear una relacin en un modelo que todava no
ser de nido antes del modelo
esta de nido, puedes usar el nombre del modelo, en vez del objeto modelo en s.
6.
inspectdb detecta claves primarias para PostgreSQL, MySQL y SQLite. Es decir, inserta primary_key=True
primary_key=True para
donde sea necesario. Para otras bases de datos, necesitars insertar
al menos un campo en cada modelo, ya que los modelos Django requieren tener un campo
primary_key=True.
7. La deteccin de claves forneas slo funciona con PostgreSQL y con ciertos tipos de tablas
MySQL. En otros casos, los campos de clave fornea sern generados como campos
asumiendo que la columna de clave fornea fue una columna
16.2.
INT.
IntegerField,
Integracin con un sistema de autenti cacin
Es posible integrar Django con un sistema de autenti cacin existente -- otra fuente de nombres de usuario y
contraseas o mtodos de autenti cacin.
Por ejemplo, tu compaa ya puede tener una con guracin LDAP que almacena un nombre de usuario y contrasea
para cada empleado. Sera una molestia tanto para el administrador de red como para los usuarios, si cada uno de
ellos tiene cuentas separadas en LDAP y en las aplicaciones basadas en Django.
Para manejar situaciones como sta, el sistema de autenti cacin de Django te permite conectarte con otras fuentes
de autenti cacin. Puedes anular el esquema por omisin de Django basado en base de datos, o puedes usar el sistema
por omisin en conjunto con otros sistemas.
revisin 757 del 28 de julio de 2008
16.2. INTEGRACIN CON UN SISTEMA DE AUTENTIFICACIN
16.2.1.
195
Especi car los back-ends de autenti cacin
Detrs de escena, Django mantiene una lista de back-ends de autenti cacin que utiliza para autenti car. Cuando
alguien llama a
django.contrib.auth.authenticate() (como se describi en el Captulo 12), Django intenta auten-
ti car usando todos sus back-ends de autenti cacin. Si el primer mtodo de autenti cacin falla, Django intenta con
el segundo, y as sucesivamente, hasta que todos los back-ends han sido intentados.
La lista de back-ends de autenti cacin a usar se especi ca en la con guracin
AUTHENTICATION_BACKENDS.
sta
debe ser una tupla de nombres de ruta Python que apuntan a clases que saben cmo autenti car. Estas clases pueden
estar en cualquier lugar de tu ruta Python
Por omisin,
20 .
AUTHENTICATION_BACKENDS
contiene lo siguiente:
('django.contrib.auth.backends.ModelBackend',)
Ese es el esquema bsico de autenti cacin que veri ca la base de datos de usuarios de Django.
El orden de
AUTHENTICATION_BACKENDS se tiene en cuenta, por lo que si el mismo usuario y contrasea son vlidos
en mltiples back-ends, Django detendr el procesamiento en la primera coincidencia positiva.
16.2.2.
Escribir un back-end de autenti cacin
get_user(id) y authenticate(**credentials).
get_user recibe un id -- el cual podra ser un nombre de usuario, un ID de la base de datos o cualquier
cosa -- y devuelve un objeto User.
El mtodo authenticate recibe credenciales como argumentos de palabras clave. La mayora de las veces se parece
Un back-end de autenti cacin es un clase que implementa dos mtodos:
El mtodo
a esto:
class MyBackend(object):
def authenticate(self, username=None, password=None):
# Check the username/password and return a User.
Pero podra tambien autenti car un token, como se muestra a continuacin:
class MyBackend(object):
def authenticate(self, token=None):
# Check the token and return a User.
authenticate debe veri car las credenciales que recibe, y debe retornar un objeto User que
None.
El sistema de administracin de Django esta altamente acoplado a su propio objeto User respaldado por base de
datos descripto en el Captulo 12. La mejor manera de lidiar con esto es crear un objeto User de Django para cada
De cualquier manera,
coincide con esas credenciales, si las credenciales son vlidas. Si no son vlidas, debe retornar
usuario que existe en tu back-end (ej., en tu directorio LDAP, tu base de datos SQL externa, etc.). De cualquier manera
puedes escribir un script para hacer esto por adelantado o tu mtodo de autenti cacin puede hacerlo la primera vez
que el usuario ingresa al sistema.
Aqu est un ejemplo de back-end que autenti ca contra unas variables de usuario y contrasea de nidas en tu
archivo
settings.py
y crea un objeto
User
de Django la primera vez que un usuario se autenti ca:
from django.conf import settings
from django.contrib.auth.models import User, check_password
class SettingsBackend(object):
"""
Authenticate against the settings ADMIN_LOGIN and ADMIN_PASSWORD.
Use the login name, and a hash of the password. For example:
ADMIN_LOGIN = 'admin'
ADMIN_PASSWORD = 'sha1$4e987$afbcf42e21bd417fb71db8c66b321e9fc33051de'
"""
def authenticate(self, username=None, password=None):
login_valid = (settings.ADMIN_LOGIN == username)
pwd_valid = check_password(password, settings.ADMIN_PASSWORD)
if login_valid and pwd_valid:
try:
revisin 757 del 28 de julio de 2008
196
CAPTULO 16. INTEGRACIN CON BASE DE DATOS Y APLICACIONES EXISTENTES
user = User.objects.get(username=username)
except User.DoesNotExist:
# Create a new user. Note that we can set password
# to anything, because it won't be checked; the password
# from settings.py will.
user = User(username=username, password='get from settings.py')
user.is_staff = True
user.is_superuser = True
user.save()
return user
return None
def get_user(self, user_id):
try:
return User.objects.get(pk=user_id)
except User.DoesNotExist:
return None
16.3.
Integracin con aplicaciones web existentes
Es posible ejecutar una aplicacin Django en el mismo servidor de una aplicacin impulsada por otra tecnologa. La manera ms directa de hacer esto es usar el archivo de con guracin de Apache,
httpd.conf,
para delegar
patrones de URL diferentes a distintas tecnologas (Nota que el Captulo 20 cubre el despliegue con Django en Apache/mod_python, por lo tanto tal vez valga la pena leer ese captulo primero antes de intentar esta integracin).
La clave est en que Django ser activado para un patrn particular de URL slo si tu archivo
httpd.conf lo dice.
El despliegue por omisin explicado en el Captulo 20 asume que quieres que Django impulse todas las pginas en un
dominio particular:
<Location "/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
PythonDebug On
</Location>
Aqu, la lnea
<Location "/">
signi ca maneja cada URL, comenzando en la raz, con Django.
Esta perfectamente bien limitar esta directiva
<Location>
a cierto rbol de directorio. Por ejemplo, digamos que
tienes una aplicacin PHP existente que impulsa la mayora de las pginas en un dominio y quieres instalar el sitio de
administracin de Django en
a
/admin/:
/admin/ sin afectar el cdigo PHP. Para hacer esto, slo con gura la directiva <Location>
<Location "/admin/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
PythonDebug On
</Location>
Con esto en su lugar, slo las URLs que comiencen con
/admin/
activarn Django. Cualquier otra pgina usar
cualquier infraestructura que ya exista.
/admin/ en el ejemplo de esta seccin) no afecta a Django en
/admin/people/person/add/), no con una versin
de la URL (ej., /people/person/add/). Esto signi ca que tu URLconf raz debe incluir el pre jo /admin/.
Nota que adjuntar Django a una URL cali cada (como
el anlisis de las URLs. Django trabaja con la URL absoluta (ej.,
recortada
16.4.
Qu sigue?
Hablando del sitio de administracin de Django y sobre cmo acomodar el framework para encajar con necesidades
existentes, otra tarea comn es personalizar el sitio de administracin de Django. El
en dicha personalizacin.
revisin 757 del 28 de julio de 2008
`prximo captulo`_ se enfoca
16.4. QU SIGUE?
197
Duplicate explicit target name: prximo captulo.
19 N.
20 N.
del T.: del ingls legacy databases and applications, aplicaciones y base de datos que ya estn en uso en entornos de produccin.
del T.: del ingls Python path.
revisin 757 del 28 de julio de 2008
198
CAPTULO 16. INTEGRACIN CON BASE DE DATOS Y APLICACIONES EXISTENTES
revisin 757 del 28 de julio de 2008
Captulo 17
Extendiendo la Interfaz de Administracin
de Django
El Captulo 6 introdujo la interfaz de administracin de Django, y ya es tiempo de volver atrs y dar una mirada
ms minuciosa al asunto.
Como dijimos varias veces antes, la interfaz de administracin es una de las caractersticas ms sobresalientes de
este framework, y la mayora de los desarrolladores que usan Django lo encuentran til y e ciente. Debido a que esta
interfaz es tan popular, es comun que los desarrolladores quieran personalizarlo o extenderlo.
Las ultimas secciones del Captulo 6 ofrecieron algunas maneras simples de personalizar ciertos aspectos de la
interfaz. Antes de continuar con este capitulo, considera revisar ese material; cubre como personalizar las listas de
cambio y los formularios de edicin de, asi como una forma fcil de remarcar la interfaz para que se indenti que con
tu sitio.
El capitulo 6 discute tambin cuando y porqu querras usar la interfaz de administracin y desde hicimos un gran
salto desde esos prrafos hasta este punto, lo reproduciremos nuevamente aqu:
Obviamente, es muy til para modi car datos (se vea venir). Si tenemos cualquier tipo de tarea de introduccin de datos, el administrador es lo mejor que hay. Sospechamos que la gran mayora de lectores de
este libro tiene una horda de tareas de este tipo.
La interfaz de administracin de Django brilla especialmente cuando usuarios no tcnicos necesitan ser
capaces de ingresar datos; ese es el propsito detrs de esta caracteristica, despus de todo. En el peridico
donde Django fue creado orginalmente, el desarrollo una caracterstica tipica online --un reporte especial
sobre la calidad del agua del acueducto municipal, pongamos-- implicaba algo as:
El periodista responsable del artculo se reunecon uno de los desarrolladores y discuten sobre
la informacin disponible.
El desarrollador disea un modelo basado en esta informacin y luego abre la interfaz de
administracin para el periodista.
Mientras el periodista ingresa datos a Django, el programador puede enforcarse en desarrollar
la interfaz accesible publicamente (la parte divertida!).
En otras palabras, la razn de ser de la interfaz de administracin de Django es facilitar el trabajo simultneo
de productores de contenido y programadores.
Sin embargo, ms all de estas tareas de entrada de datos obvias, encontramos que la interfaz de administracin es til en algunos otros casos:
Inspeccionar modelos de datos : La primer cosa que hacemos cuando hemos de nido un nuevo
modelo es llamarlo desde la interfaz de administracin e ingresar algunos datos de relleno.
Esto es usual para encontrar errores de modelado; tener una una interfaz gr ca al modelo
revela problemas rpidamente.
Gestin de datos adquiridos : Hay una pequea entrada de datos asociada a un sitio como
http://chicagocrime.org,
puesto que la mayora de los datos provienen de una fuente
automtica. No obstante, cuando surgen problemas con los datos automticos, es til poder
entrar y editarlos fcilmente.
revisin 757 del 28 de julio de 2008
200
CAPTULO 17. EXTENDIENDO LA INTERFAZ DE ADMINISTRACIN DE DJANGO
La interfaz de administracin de Django maneja estos casos comunes con algunas o ninguna personalizacin.
Aunque, como sucede con la mayora de las generalizaciones en el diseo, la gestin uni cada de todos estos casos
signi ca que la interfaz no maneja igual de bien otros modos de edicin.
Hablaremos de estos casos para los que la interfaz de administracin de Django no est diseada un poquito ms
adelante, pero primero, vayamos a una breve disgrecin para una discusin los ca.
17.1.
El Zen de la aplicacin Admin
En su ncleo, la interfaz de administracin de Django est diseada para una sola actividad:
Usuarios con ables editando contenido estructurado.
S, es extremadamente simple -- pero esa simplicidad se basa en un montn de asunciones importantes. La entera
losofa de la interfaz de administracin de Django sigue directamente estas a asunciones , as que vamos a cavar sobre
el subtexto de esta frase en la secciones que siguen.
17.1.1.
Usuarios con ables ...
La intefaz de administracin est diseada para ser usada por usuarios en lo que t, el desarrollador, confas. Esto
no signi ca slo gente que ha sido autenticada; signi ca que Django asume que se puede con ar que tus editores de
contenido harn las cosas correctas.
Signi ca adems que no hay procesos de aprobacin para la edicin de contenido -- si con as en tus usuarios,
nadie necesita aprobar sus ediciones. Otra implicancia es que el sistema de permisos, aunque poderoso, no permite (al
momento en el que se escribe esto) limitar accesos basados en objetos espec cos. Si con as en que alguien edite sus
propias historias, con as en que ese usuario no edite las historias de cualquier otro sin permiso.
17.1.2.
... editando ...
El propsito primario de la interfaz de administracin de Django es dejar que la gente edite informacin. Esto
parece obvio al principio, pero de nuevo tiene poderosas y profundas repercusiones.
Por ejemplo, aunque la interfaz es bastante util para revisar datos (segn se ha descripto=, no est diseada con
este propsito en mente. Por caso, nota la ausencia de un permiso puede ver (ve el Captulo 12). Django asume que
si la gente puede ver el contenido en la interfaz de administrain, entonces tambien tienen permito editarlo.
Otra cosa ms importante es la ausencia de cualquier cosa que se aproxime remotamente a un ujo de trabajo.
Si una tarea dada requiere una serie de pasos, no existe algo que permita forzar a que estos pasos se realicen en un
determinado orden. La interfaz se concentra en editar, no en actividades alrededor de la edicin. Esta supresin de un
ujo de trabajo tambien proviene del principio de con anza: la losofa de la interfaz es que este ujo es una decisin
personal, no algo que se pueda implementar en cdigo.
Finalmente, nota la ausencia de agregaciones en la interfaz. Esto es, no existe la infraestructura necesaria para
mostrar totales, promedios y esas cosas. De nuevo, la interfaz es para editar -- y se espera que escribas tus vistas
personalizadas para todo el resto.
17.1.3.
... contenido estructurado
Como el resto de Django, la interfaz pre ere que trabajes con datos estructurados. Esto es porque slo sirve para
editar informacin almacenada en modelos de Django; para cualquier otra cosa, como datos almacenados en archivos,
necesitars vistas propias.
17.1.4.
Parada Completa
A esta altura debera estar claro que la interfaz de administracin de Django no intenta ser todas las cosas para
toda la gente; y en cambio, elegimos enfocarnos en una cosa y hacerla extremadamente bien.
Cuando se va a extender la interfaz de administracin, mucha de esa misma losofa se sostiene (nota que extensibilidad no gura de nuestros objetivos). Debido a que vistas personalizadas pueden hacer cualquier cosa, y debido
a que estas puede ser visualmente integradas a la interfaz de administracin muy facilmente (como se describe en la
siguiente seccin), las posibilidades de personalizacin incorporadas estn un poco limitadas por diseo.
Deberas tener en mente que la interfaz de administracin es slo una aplicacin; y aunque sea una muy compleja,
no hace nada que cualquier desarrollador Django con su ciente tiempo no podra reproducir. Es enteramente posible
revisin 757 del 28 de julio de 2008
17.2. PESONALIZANDO LAS PLANTILLAS DE LA INTERFAZ
201
que en el futuro alguien desarrolle una interfaz de adminitracin diferente que est basada en un conjunto de asunciones
distintas y que por lo tanto se comportar de otra manera.
Finalmente, debemos destacar que, a la fecha que escribimos esto, los desarrolladores de Django trabajaban en una
nueva versin de la interfaz de administracin que permite mucha ms exibilidad y personalizacin. Para el momento
en que leas esto, esas nuevas caracteristicas pudieron haberse incorporado a la distribucin de Django o cial. Para
averiguar al respecto, preguntale a alguien de la comunidad Django si la rama newforms-admin ha sido integrada.
17.2.
Pesonalizando las plantillas de la interfaz
Como sale de fbrica, Django provee un nmero de herramientas para personalizar las plantillas de la interfaz que
vienen integradas, las cuales veremos pronto, pero para las tareas detrs de ellas (por ejemplo, cualquier cosa que
requiera un ujo de trabajo espec co o permisos granulares), necesitars leer la seccin titulada Creando Vistas de
administracin personalizadas, ms adelante en este captulo.
Para ahora, miremos algunas maneras rpidas de modi car el aspecto (y, en cierto grado, el comportamiento) de la
interfaz de administracin. El Captulo 6 cubre algunas de las tareas ms comunes: cambiar la marca de la interfaz
de adminitracin (para todos esos Jefes Pelopunta que odian el azul) y proveer un formulario de administracin
personalizado.
Pasado ese punto, el objetivo usualmente implica cambiar alguna de las plantillas para un item en particular. Cada
vista de administracin -- las listas de cambio, los formularios de edicin, las pginas de con rmacin de eliminacin
y vistas de historial -- tienen una plantilla asociada que puede ser reescrita de diferentes maneras.
Primero, puedes reescribir la plantilla globalmente. La vista de administracin busca plantillas utilizando el mecanismo de carga de plantillas estndar, por lo que si creas tus plantillas en alguno de los directorios declarados para tal
n, Django cargar esas en vez de las vienen por defecto. Estas plantillas globales se describen el la Tabla 17-1.
Cuadro 17.1: Plantillas globales de la interfaz de administracin
Vista
Nombre de la plantilla base
admin/change_list.html
admin/change_form.html
admin/delete_confirmation.html
admin/object_history.html
Lista de cambios
Formulario para agregar/editar
Con rmacin de eliminacin
Historial de un objeto
La mayora de las veces, sin embargo, querrs cambiar la plantilla slo para un nico objeto o aplicacin (no
globalmente). As, cada vista busca primero plantillas para modelos y aplicaciones espec cas, en el siguiente orden:
admin/<aplicacin>/<nombre_objeto>/<plantilla>.html
admin/<aplicacin>/<plantilla>.html
admin/<plantilla>.html
Por ejemplo, la vista del formulario de agregar/editar para un modelo
Libro in la aplicacin libros busca plantillas
en este orden:
admin/libros/libro/change_form.html
admin/libros/change_form.html
admin/change_form.html
17.2.1.
Plantillas de modelos propios
La mayora de las veces, y querrs usar la primer plantilla para crear una basada destinada a un modelo espec co.
Usualmente la mejor forma de realizar esto es extendiendo y agregando informacin a uno de los bloques de nidos en
la plantilla que se est modi cando.
Por ejemplo, supongamos que queremos agregar un pequeo texto de ayuda en la cabecera de nuestra pgina de
libros. Quizas algo parecido a lo que muestra la Figura 17-1.
Esta es una manera muy fcil de hacerlo: simplemente crea una plantilla llamada
e inserta este cdigo:
revisin 757 del 28 de julio de 2008
admin/libreria/libro/change_form.ht
202
CAPTULO 17. EXTENDIENDO LA INTERFAZ DE ADMINISTRACIN DE DJANGO
Figura 17.1: Un formulario de edicin de libros personalizado
revisin 757 del 28 de julio de 2008
17.3. CREANDO VISTAS DE ADMINISTRACIN PERSONALIZADAS
203
{ % extends "admin/change_form.html" %}
{ % block form_top %}
<p>Inserta un mensaje de ayuda significativo aqu...</p>
{ % endblock %}
Todas esta plantillas de nen un nmero de bloques que puedes sobreescribir. Como con la mayora de los programas,
la mejor documentacin es el propio cdigo, por lo que te animamos a mirar las plantillas originales (que se encuentran
en
django/contrib/admin/templates/)
17.2.2.
para trabajar con la informacin ms actualizada.
JavaScript Personalizado
Un uso comn para estas plantillas propias para modelos
A common use for these custom model templates implica agregar cdigo JavaScript extra a las pginas de la interfz
-- posiblemennte para implementar algn widget especial o un comportamiento del lado del cliente.
Por suerte, esto no podra ser ms fcil. Cada plantilla del administrador de ne un
cual puedes usar para incluir contenido extra dentro del elemento
<head>.
{ % block extrahead %},
el
Por ejemplo, incluir la biblioteca jQuery
(http://jquery.com/) en tu pgina de historia de objetos, es tan simple como esto:
{ % extends "admin/object_history.html" %}
{ % block extrahead %}
<script src="http://media.ejemplo.com/javascript/jquery.js" type="text/javascript"></script>
<script type="text/javascript">
// el cdigo que utiliza jQuery ira aqu...
</script>
{ % endblock %}
Nota
No estamos seguros porqu necesitaras jQuery en la pgina de historia de objetos, pero, por
supuesto, este ejemplo es vlido para cualquier plantilla de la interfaz de administracin.
Puedes usar esta tcnica para incluir cualquier tipo de controladores JavaScript que puedas necesitar en tus formularios.
17.3.
Creando vistas de administracin personalizadas
Hasta ahora, cualquiera que haya buscando agregar comportamientos personalizados a la interfaz de administracin
probablemente est un poco frustrado. Todo lo que han dicho es cmo cambiar la interfaz visualmente , los escuchamos
llorar. Pero como puedo cambiar la forma en que la interfaz de administracin funciona ?
La primer cosa para entender es que esto no es mgico. Esto es, nada de lo que la interfaz hace es especial de manera
alguna -- ya que se trata simplemente de un conjunto de vistas (que se encuentran en
django.contrib.admin.views)
que manipulan datos como cualquier otra vista.
Seguro, hay bastante cdigo all, y se debe a que tienen que lidear con todas las opciones, diferentes tipos de
campos, y con guraciones que in yen en el comportamiento. No obstante, cuando te das cuenta que la intefaz de
administracin es slo un juego de vistas, agregar las tuyas propias es ms fcil de entender.
A modo de ejemplo, agreguemos una vista reporte de editores a nuestra aplicacin de libros del Captulo 6.
Construiremos una vista de administracin que muestre la lista de libros en funcin de los editores -- un ejemplo
bastante tpico de vista de reporte que puedes necesitar construir.
Primero, actualicemos nuestro archivo URLconf. Necesitamos insertar esta lnea:
(r'^admin/libros/reporte/$', 'misitio.libros.admin_views.reporte'),
antes de la lnea que incluye las vistas del administrador. Un esqueletos del URLconf puede parecerse a algo as:
from django.conf.urls.defaults import *
revisin 757 del 28 de julio de 2008
204
CAPTULO 17. EXTENDIENDO LA INTERFAZ DE ADMINISTRACIN DE DJANGO
urlpatterns = patterns('',
(r'^admin/libreria/reporte/$', 'libreria.admin_views.reporte'),
(r'^admin/', include('django.contrib.admin.urls')),
)
Por qu ponemos la vista personalizada antes de incluir las del administrador? Recuerda que Django procesa los
patrones de URL en orden. La inclusin de los patrones de urls del administrador coincide con casi cualquier cosa que
llega a su punto de inclusin, por lo que si invertimos el orden de esas lineas, Django encontrar una vista por omisin
para ese patrn y no funcionar como queremos. En este caso particular, intentar cargar un un lista de cambios para
un modelo Reporte en la aplicacin libros, que no existe.
Ahora escribamos nuestra vista. Para hacer honor a la simplicidad, slo cargaremos todos los libros dentro del
contexto, y dejaremos que la plantilla maneje el agrupamiento con la etiqueta
books/admin_views.py,
from
from
from
from
{ % regroup %}.
Crea un archivo
con este cdigo:
misitio.libros.models import Libro
django.template import RequestContext
django.shortcuts import render_to_response
django.contrib.admin.views.decorators import staff_member_required
def reporte(request):
return render_to_response(
"admin/libros/reporte.html",
{'lista_libros' : Book.objects.all()},
RequestContext(request, {}),
)
reporte = staff_member_required(reporte)
Debido a que dejamos el agrupamiento a la plantilla, esta vista es bastante simple. Sin embargo, hay algunos
fragmentos sutiles dignos de explicitar:
staff_member_required de django.contrib.admin.views.decorators. Esto
login_required discutido en el Captulo 12, pero este decorador tambin veri ca que
Usamos el decorador
es similar a
el usuario est marcado como un mientro del sta , y tenga en consecuencia acceso a la interfaz de
administracin
Este decorador protege todos las vistas prede nidas del administrador, y hace que la lgica de autenticacin para tus vistas coincida con la del resto de la interfaz.
Renderizamos una plantilla que se encuntra bajo
admin/.
Aunque esto no estrictamente requerido,
se considera una buena practica para mantener todas tus plantillas de administracin agrupadas en
un directorio
admin/. Tambin pusimos la plantilla en un directorio llamado libros luego de nuestra
aplicacin -- lo que es tambin una buena prctica.
Usamos
RequestContext``como el tercer parmetro (``context_instance) para render_to_response.
Esto asegura que la informacin sobre el usuario en curso est disponible para la plantilla.
Mira el
`Captulo 10`_ para saber ms sobre
RequestContext.
Finalmente, haremos una plantilla para esta vista. Extenderemos una plantilla de la administracin para que lograr
que nuestra vista coincida visualmente con el resto de la interfaz:
{ % extends "admin/base_site.html" %}
{ % block title %}Lista de libros por editor{ % endblock %}
{ % block content %}
<div id="content-main">
<h1>Lista de libros por editor:</h1>
{ % regroup lista_libros|dictsort:"editor.nombre" by editor as libros_por_editor %}
{ % for editor in libros_por_editor %}
<h3>{{ editor.grouper }}</h3>
<ul>
{ % for libro in editor.list|dictsort:"titulo" %}
revisin 757 del 28 de julio de 2008
17.4. SOBREESCRIBIENDO VISTAS INCORPORADAS
205
<li>{{ libro }}</li>
{ % endfor %}
</ul>
{ % endfor %}
</div>
{ % endblock %}
Al extender
admin/base_site.html,
conseguimos el look and feel de la interfaz de administracin de Django
gratis. La Figura 17-2 muestra como luce el resultado.
Puedes usar esta tcnica para agregar cualquier cosa que suees para la interfaz de administracin. Recuerda que
las llamadas vistas de administracin personalizadas en realidad son slo vistas comunes de Django; por lo que puedes
usar todas las tcnicas aprendidas en el resto de este libro para proveer una interfaz con tanta complejidad como
necesites.
Cerraremos este captulo con algunas ideas para vistas de administracin personalizadas.
17.4.
Sobreescribiendo vistas incorporadas
Algunas veces las vistas de administracin por omisin simplemente no te sirven. Fcilmente puedes reemplazarlas
por las tuyas propias en cualquier etapa de la interfaz de administracin; simplemente haz que tu URL haga sombra*
sobre la que incorporada. Es decir, si tu vista viene antes que la vista incorporada de la aplicacin en URLconf, tu
vista ser invocada por sobre la de omisin.
Por ejemplo, podriamos reemplazar la vista incorporada para crear libros con un formulario que permita a los
usuarios ingresar simplemente un cdigo ISBN. Luego podriamos buscar la informacin del libro desde
http://isbn.nu
y crear el objeto automticamente.
El cdigo para esa vista te lo dejamos como ejercicio, pero la parte importante esta partecita del URLconf:
(r'^admin/libreria/libro/add/$', 'misitio.libros.admin_views.agregar_por_isbn'),
Si esta linea aparece antes que las URLs de administracion en tu URLconf, la vista
agregar_por_isbn reemplazar
completamente a la vista estndar para ese modelo.
Podriamos seguir un truco similar para reemplazar la pgina de con rmacin de eliminacin, la de edicin o
cualquier otra parte de la interfaz.
17.5.
Qu sigue?
Si tu idioma nativo es el ingls --cosa que gracias a los traductores ya no es necesaria para leer este libro-- quizas
no te hayas enterado de una las ms fantsticas caractersticas de la interfaz de administracion: est disponible en
casi 40 idiomas distintos! Esto es posible gracias al framework de internacionalizacin de Django (y el duro trabajo de
los traductores voluntarios de Django). El
`prximo captulo`_ explaya como usar este framework para crear sitios
Django localizados.
Avanti!
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
206
CAPTULO 17. EXTENDIENDO LA INTERFAZ DE ADMINISTRACIN DE DJANGO
Figura 17.2: Una vista personalizada libros por editor.
revisin 757 del 28 de julio de 2008
Captulo 18
Internacionalizacin
Django fue originalmente desarrollado exactamente en el medio de los Estados Unidos (literalmente; Lawrence,
Kansas, se halla a menos de 40 millas del centro geogr co de la porcin continental de los Estados Unidos). Como la
mayora de los proyectos open source, sin embargo, la comunidad de Django creci hasta incluir gente de todo el globo.
A medida que la comunidad fue tornndose ms diversa, la internacionalizacin y la localizacin fueron tomando una
importancia creciente. Debido a que muchos desarrolladores tienen, en el mejor de los casos, una comprensin difusa
de dichos trminos vamos a de nirlos brevemente.
Internacionalizacin se re ere al proceso de diseo de programas para el uso potencial de cualquier *locale*
Esto incluye el marcado del texto (tales como elementos de la interfaz con el usuario o mensajes de error) para su
futura traduccin, la abstraccin de la visualizacin de fechas y horarios de manera que sea posible respetar diferentes
estndares locales, la provisin de lo necesario para admitir diferentes zonas horarias, y en general el asegurarse
de que el cdigo no contenga ninguna suposicin acerca de la ubicacin de sus usuarios. Encontrars a menudo
internacionalizacin abreviada como I18N (el nmero 18 se re ere al nmero de letras omitidos entre la I inicial y
la N nal).
Localizacin se re ere al proceso espec co de traducir un programa internacionalizado para su uso en un *locale*
particular. Encontrars a menudo localizacin abreviada como L10N.
Django en si est totalmente internacionalizado; todas las cadenas estn marcadas para su traduccin, y existen
variables de con guracin que controlan la visualizacin de valores dependientes del
*locale* como fechas y horarios.
Django tambin incluye ms de 40 archivos de localizacin. Si no hablas ingls en forma nativa, existe una buena
probabilidad de que Django ya se encuentre traducido a tu idioma nativo.
El mismo framework de internacionalizacin usado para esas localizaciones est disponible para que lo uses en tu
propio cdigo y plantillas.
En resumen, necesitars agregar una cantidad mnima de *hooks* a tu cdigo Python y a tus plantillas. Esos
*hooks* reciben el nombre de cadenas de traduccin. Los mismos le indican a Django Este texto debe ser traducido
al idioma del usuario nal si existe una traduccin a dicho idioma de ese texto.
Django se encarga de usar esos
*hooks* para traducir las aplicaciones Web al vuelo de acuerdo a las preferencias
de idioma del usuario.
Esencialmente, Django hace dos cosas:
Le permite a los desarrolladores y autores de plantillas especi car qu partes de sus aplicaciones deben
ser traducibles.
Usa esta informacin para traducir las aplicaciones Web para usuarios particulares de acuerdo a sus
preferencias de idioma.
Nota
gettext de GNU (http://www.gnu.org/software/
gettext incluido en Python.
La maquinaria de traduccin de Django usa
gettext/)
via el mdulo estndar
revisin 757 del 28 de julio de 2008
208
CAPTULO 18. INTERNACIONALIZACIN
Si no necesitas usar internacionalizacin:
Los
*hooks* de internacionalizacin de Django se encuentran activos por omisin, lo cual incurre
*overhead*. Si no utilizas internacionalizacin, deberas establecer USE_I18N =
en un pequeo
False
en tu archivo de con guracin. Si
USE_I18N
tiene el valor
False
Django implementar
algunas optimizaciones de manera de no cargar la maquinaria de localizacin.
'django.core.context_processors.i18n' de tu vaTEMPLATE_CONTEXT_PROCESSORS.
Probablemente querrs tambin eliminar
riable de con guracin
18.1.
Especi cando cadenas de traduccin en cdigo Python
Las cadenas de traduccin especi can Este texto debera ser traducido. dichas cadenas pueden aparecer en tu
cdigo Python y en tus plantillas. Es t responsabilidad marcar las cadenas traducibles; el sistema slo puede traducir
cadenas sobre las que est al tanto.
18.1.1.
Funciones estndar de traduccin
Las cadenas de traduccin se especi can usando la funcin
_().
(Si, el nombre de la funcin es el carcter guin
bajo). Esta funcin est disponible globalmente (o sea como un componente incluido); no es necesario que lo importes.
En este ejemplo, el texto
"Welcome to my site."
est marcado como una cadena de traduccin:
def my_view(request):
output = _("Welcome to my site.")
return HttpResponse(output)
La funcin
django.utils.translation.gettext()
es idntica a
_().
Este ejemplo es idntico al anterior:
from django.utils.translation import gettext
def my_view(request):
output = gettext("Welcome to my site.")
return HttpResponse(output)
La mayora de los desarrolladores pre ere usar
_(),
debido a que es ms corta.
La traduccin funciona tambin sobre valores computados. Este ejemplo es idntico a los dos anteriores:
def my_view(request):
words = ['Welcome', 'to', 'my', 'site.']
output = _(' '.join(words))
return HttpResponse(output)
La traduccin funciona tambin sobre variables. De nuevo, este es otro ejemplo idntico:
def my_view(request):
sentence = 'Welcome to my site.'
output = _(sentence)
return HttpResponse(output)
(algo a tener en cuenta cuando se usan variables o valores computados, como se vea en los dos ejemplos previos,
es que la utilidad de deteccin de cadenas de traduccin de Django,
make-messages ms adelante).
pasas a _() o gettext() pueden contener
make-messages.py,
no ser capaz de encontrar
esas cadenas. Trataremos
Las cadenas que le
marcadores de posicin (por placeholders ), especi -
cados con la sintaxis estndar de interpolacin de cadenas con nombres, por ejemplo:
def my_view(request, n):
output = _(' %(name)s is my name.') % {'name': n}
return HttpResponse(output)
Esta tcnica permite que las traducciones espec cas de cada idioma reordenen el texto de los marcadores de
posicin. Por ejemplo, una traduccin al ingls podra ser
podra ser
Me llamo Adrian,
Adrian is my name, mientras que una traduccin al espaol
con el marcador de posicin (el nombre) ubicado a continuacin del texto traducido y
no antes del mismo.
Por esta razn, deberas usar interpolacin de cadenas con nombres (por ejemplo %(name)s) en lugar de interpola-
cin posicional (por ejemplo %s o %d). Si usas interpolacin posicional las traducciones no sern capaces de reordenar
el texto de los marcadores de posicin.
revisin 757 del 28 de julio de 2008
18.1. ESPECIFICANDO CADENAS DE TRADUCCIN EN CDIGO PYTHON
18.1.2.
209
Marcando cadenas como no-op
Usa la funcin
django.utils.translation.gettext_noop()
para marcar una cadena como una cadena de tra-
duccin sin realmente traducirla en ese momento. Las cadenas as marcadas no son traducidas sino hasta el ltimo
momento que sea posible.
Usa este enfoque si deseas tener cadenas constantes que deben ser almacenadas en el idioma original -- tales como
cadenas en una base de datos -- pero que deben ser traducidas en el ltimo momento posible, por ejemplo cuando la
cadena es presentada al usuario.
18.1.3.
Traduccin perezosa
django.utils.translation.gettext_lazy() para traducir cadenas en forma perezosa
gettext_lazy().
para marcar el atributo help_text de un campo como traducible, haz lo siguiente:
Usa la funcin
-- cuando
el valor es accedido en lugar de cuando se llama a la funcin
Por ejemplo,
from django.utils.translation import gettext_lazy
class MyThing(models.Model):
name = models.CharField(help_text=gettext_lazy('This is the help text'))
En este ejemplo,
gettext_lazy() almacena una referencia perezosa a la cadena -- no el verdadero texto traducido.
La traduccin en si misma se llevar a cabo cuando sea usada en un contexto de cadena, tal como el renderizado de
una plantilla en el sitio de administracin de Django.
Si no te gusta el nombre largo
gettext_lazy
puedes simplemente crear un alias
(guin bajo) para el mismo, de
la siguiente forma:
from django.utils.translation import gettext_lazy as _
class MyThing(models.Model):
name = models.CharField(help_text=_('This is the help text'))
Usa siempre traducciones perezosas en modelos Django (de lo contrario no sern traducidos correctamente para
cada usuario). Y es una buena idea agregar tambin traducciones de los nombres de campos y nombres de tablas. Esto
signi ca escribir las opciones
verbose_name
verbose_name_plural
en forma explcita en la clase
Meta:
from django.utils.translation import gettext_lazy as _
class MyThing(models.Model):
name = models.CharField(_('name'), help_text=_('This is the help text'))
class Meta:
verbose_name = _('my thing')
verbose_name_plural = _('mythings')
18.1.4.
Pluralizacin
Usa la funcin
django.utils.translation.ngettext()
para especi car mensajes que tienen formas singular y
plural distintas, por ejemplo:
from django.utils.translation import ngettext
def hello_world(request, count):
page = ngettext(
'there is %(count)d object',
'there are %(count)d objects', count
) % {'count': count}
return HttpResponse(page)
ngettext
tiene tres argumentos: la cadena de traduccin singular, la cadena de traduccin plural y el nmero de
objetos (el cual es pasado a los idiomas de traduccin como la variable
count).
revisin 757 del 28 de julio de 2008
210
CAPTULO 18. INTERNACIONALIZACIN
18.2.
Especi cando cadenas de traduccin en cdigo de plantillas
Las traducciones en las plantillas Django usan dos etiquetas de plantilla y una sintaxis ligeramente diferente a la
del cdigo Python. Para que tus plantillas puedan acceder a esas etiquetas coloca
plantilla.
La etiqueta de plantilla
{ % trans %}
{ % load i18n %} al principio de tu
marca una cadena para su traduccin:
<title>{ % trans "This is the title." %}</title>
Si solo deseas marcar un valor para traduccin pero para traduccin posterior, usa la opcin
noop:
<title>{ % trans "value" noop %}</title>
No es posible usar variables de plantilla en
{ % trans %}
-- solo estn permitidas cadenas constantes, rodeadas de
comillas simples o dobles. Si tu traduccin requiere variables (marcadores de posicin) puedes usar por ejemplo
blocktrans %}:
{%
{ % blocktrans %}This will have {{ value }} inside.{ % endblocktrans %}
Para traducir una expresin de plantilla -- por ejemplo, cuando usas ltros de plantillas -- necesitas asociar la
expresin a una variable local que ser la que se usar dentro del bloque de traduccin:
{ % blocktrans with value|filter as myvar %}
This will have {{ myvar }} inside.
{ % endblocktrans %}
Si necesitas asociar ms de una expresin dentro de una etiqueta
blocktrans,
separa las partes con
and:
{ % blocktrans with book|title as book_t and author|title as author_t %}
This is {{ book_t }} by {{ author_t }}
{ % endblocktrans %}
Para pluralizar, especi ca tanto la forma singular como la plural con la etiqueta
dentro de
{ % blocktrans %}
{ % endblocktrans %},
{ % plural %}
la cual aparece
por ejemplo:
{ % blocktrans count list|length as counter %}
There is only one {{ name }} object.
{ % plural %}
There are {{ counter }} {{ name }} objects.
{ % endblocktrans %}
Internamente, todas las traducciones en bloque y en lnea usan las llamadas apropiadas a
Cuando usas
RequestContext
(ver
gettext/ngettext.
`Captulo 10`_), tus plantillas tienen acceso a tres variables espec cas rela-
cionadas con la traduccin:
{{ LANGUAGES }}
es una lista de tuplas en las cuales el primer elemento es el cdigo de idioma y el
segundo es el nombre y escrito usando el mismo).
{{ LANGUAGE_CODE }} es el idioma preferido del usuario actual, expresado como una cadena (por
ejemplo en-us). (Consulta la seccin Cmo descubre Django la preferencia de idioma para informacin adicional).
{{ LANGUAGE_BIDI }} es el sistema de escritura del idioma actual. Si el valor es True, se trata de un
idioma derecha-a-izquierda (por ejemplo hebreo, rabe). Si el valor es False, se trata de de un idioma
izquierda-a-derecha (por ejemplo ingls, francs, alemn).
Puedes tambin cargar los siguientes valores usando etiquetas de plantilla:
{%
{%
{%
{%
load i18n %}
get_current_language as LANGUAGE_CODE %}
get_available_languages as LANGUAGES %}
get_current_language_bidi as LANGUAGE_BIDI %}
Tambin existen
*hooks* de traduccin que estn disponibles en el interior de cualquier etiqueta de bloque de
plantilla que acepte cadenas constantes. En dichos casos basta con que uses la sintaxis
_() para especi car una cadena
de traduccin, por ejemplo:
{ % some_special_tag _("Page not found") value|yesno:_("yes,no") %}
En este caso tanto la etiqueta como el ltro vern la cadena ya traducida (en otras palabras la cadena es traducida
antes de ser pasada a las funciones de manejo de etiquetas), de manera que no necesitan estar preparadas para manejar
traduccin.
revisin 757 del 28 de julio de 2008
18.3. CREANDO ARCHIVOS DE IDIOMA
18.3.
211
Creando archivos de idioma
Una vez que hayas etiquetado tus cadenas para su posterior traduccin, necesitas escribir (u obtener) las traducciones propiamente dichas. En esta seccin explicaremos como es que eso funciona.
18.3.1.
Creando los archivos de mensajes
El primer paso es crear un archivo de mensajes para un nuevo idioma. Un archivo de mensajes es un archivo de
texto comn que representa un nico idioma que contiene todas las cadenas de traduccin disponibles y cmo deben
ser representadas las mismas en el idioma en cuestin. Los archivos de mensajes tiene una extensin
Django incluye una herramienta,
bin/make-messages,
.po.
que automatiza la creacin y el mantenimiento de dichos
archivos.
Para crear o actualizar un archivo de mensajes, ejecuta este comando:
bin/make-messages.py -l de
de es el cdigo de idioma para el archivo de mensajes que deseas crear. El cdigo de idioma en este caso est
pt_BR para portugus de Brasil y de_AT para alemn de Austria. Echa
un vistazo a los cdigos de idioma en el directorio django/conf/locale/ para ver cuales son los idiomas actualmente
donde
en formato locale. Por ejemplo, el mismo es
incluidos.
El script debe ser ejecutado desde una de tres ubicaciones:
El directorio raz
$PYTHONPATH
django (no una copia de trabajo de Subversion, sino el que se halla referenciado por
o que se encuentra en algn punto debajo de esa ruta.
El directorio raz de tu proyecto Django
El directorio raz de tu aplicacin Django
El script recorre completamente el rbol en el cual es ejecutado y extrae todas las cadenas marcadas para traduccin. Crea (o actualiza) un archivo de mensajes en el directorio
conf/locale/de/LC_MESSAGES/django.po.
conf/locale.
En el ejemplo
de,
el archivo ser
Si es ejecutado sobre el rbol de tu proyecto o tu aplicacin, har lo mismo pero la ubicacin del directorio locale es
locale/LANG/LC_MESSAGES (nota que no tiene un pre jo conf). La primera vez que lo ejecutes en tu rbol necesitars
crear el directorio locale.
Sin gettext?
Si no tienes instaladas las utilidades
gettext, make-messages.py
crear archivos vacos. Si te
encuentras ante esa situacin debes o instalar dichas utilidades o simplemente copiar el archivo
de mensajes de ingls (conf/locale/en/LC_MESSAGES/django.po) y usar el mismo como un
punto de partida; se trata simplemente de un archivo de traduccin vaco.
El formato de los archivos
.po
es sencillo. Cada archivo
.po
contiene una pequea cantidad de metadatos tales
como la informacin de contacto de quines mantienen la traduccin, pero el grueso del archivo es una lista de mensajes
-- mapeos simples entre las cadenas de traduccin y las traducciones al idioma en cuestin propiamente dichas.
Por ejemplo, si tu aplicacin Django contiene una cadena de traduccin para el texto
Welcome to my site:
_("Welcome to my site.")
entonces
make-messages.py
habr creado un archivo
.po
que contendr el siguiente fragmento -- un mensaje:
#: path/to/python/module.py:23
msgid "Welcome to my site."
msgstr ""
Es necesaria una rpida explicacin:
msgid es la cadena de traduccin, la cual aparece en el cdigo fuente. No la modi ques.
msgstr es donde colocas la traduccin espec ca a un idioma. Su valor inicial es vaco
de manera
que es tu responsabilidad el cambiar esto. Asegrate de que mantienes las comillas alrededor de tu
traduccin.
Por conveniencia, cada mensaje incluye el nombre del archivo y el nmero de lnea desde el cual la
cadena de traduccin fue extrada.
revisin 757 del 28 de julio de 2008
212
CAPTULO 18. INTERNACIONALIZACIN
Los mensajes largos son un caso especial. La primera cadena inmediatamente a continuacin de
msgstr
(o
msgid)
es una cadena vaca. El contenido en si mismo se encontrar en las prximas lneas con el formato de una cadena por
lnea. Dichas cadenas se concatenan en forma directa. No olvides los espacios al nal de las cadenas; en caso contrario
todas sern agrupadas sin espacios entre las mismas!.
Por ejemplo, a continuacin vemos una traduccin de mltiples lneas (extrada de la localizacin al espaol incluida
con Django):
msgid ""
"There's been an error. It's been reported to the site administrators via e-"
"mail and should be fixed shortly. Thanks for your patience."
msgstr ""
"Ha ocurrido un error. Se ha informado a los administradores del sitio "
"mediante correo electrnico y debera arreglarse en breve. Gracias por su "
"paciencia."
Notar los espacios nales.
Ten en cuenta el conjunto de caracteres
Cuando crees un archivo
.po
con tu editor de texto favorito, primero edita la lnea del conjunto
de caracteres (busca por el texto
"CHARSET")
y ja su valor al del conjunto de caracteres usars
para editar el contenido. Generalmente, UTF-8 debera funcionar para la mayora de los idiomas
pero
gettext
debera poder manejar cualquier conjunto de caracteres.
Para reexaminar todo el cdigo fuente y las plantillas en bsqueda de nuevas cadenas de traduccin y actualizar
todos los archivos de mensajes para todos los idiomas, ejecuta lo siguiente:
make-messages.py -a
18.3.2.
Compilando archivos de mensajes
Luego de que has creado tu archivo de mensajes, y cada vez que realices cambios sobre el mismo necesitars
compilarlo a una forma ms e ciente, segn los usa
Esta herramienta recorre todos los archivos
optimizados para su uso por parte de
compile-messages.py
ejecuta
gettext.
.po
gettext.
Usa para ello la utilidad
disponibles y crea archivos
.mo,
bin/compile-messages.py.
los cuales son archivos binarios
En el mismo directorio desde el cual ejecutaste
make-messages.py,
de la siguiente manera:
bin/compile-messages.py
Y eso es todo. Tus traducciones estn listas para ser usadas.
18.4.
Cmo descubre Django la preferencia de idioma
Una vez que has preparado tus traducciones -- o, si solo deseas usar las que estn incluidas en Django -- necesitars
activar el sistema de traduccin para tu aplicacin.
Detrs de escena, Django tiene un modelo muy exible para decidir qu idioma se usar -- determinado a nivel de
la instalacin, para un usuario particular, o ambas.
Para con gurar una preferencia de idioma a nivel de la instalacin, ja
LANGUAGE_CODE en tu archivo de con gura-
cin. Django usar este idioma como la traduccin por omisin -- la opcin a seleccionarse en ltimo trmino si ningn
otro traductor encuentra una traduccin.
Si todo lo que deseas hacer es ejecutar Django con tu idioma nativo y hay disponible un archivo de idioma para el
mismo, simplemente asigna un valor a
LANGUAGE_CODE.
Si deseas permitir que cada usuario individual especi que el idioma que ella o l pre ere, usa
LocaleMiddleware
para cada usuario.
LocaleMiddleware, agrega django.middleware.locale.LocaleMiddleware a tu variable de con guMIDDLEWARE_CLASSES. Debido a que el orden de los middlewares es relevante, deberas seguir las siguientes
Para usar
racin
LocaleMiddleware.
permite la seleccin del idioma basado en datos incluidos en la peticin. Personaliza el contenido
guas:
Asegrate de que se encuentre entre las primeras clases middleware instaladas.
revisin 757 del 28 de julio de 2008
18.4. CMO DESCUBRE DJANGO LA PREFERENCIA DE IDIOMA
Debe estar ubicado despus de
SessionMiddleware,
213
esto es debido a que
LocaleMiddleware
usa
datos de la sesin.
Si usas
CacheMiddleware,
coloca
LocaleMiddleware
despus de este (de otra forma los usuarios
podran recibir contenido cacheado del locale equivocado).
Por ejemplo tu
MIDDLEWARE_CLASSES
podra verse como esta:
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.locale.LocaleMiddleware'
)
LocaleMiddleware
intenta determinar la preferencia de idioma del usuario siguiendo el siguiente algoritmo:
Primero, busca una clave
django_language
Se eso falla, busca una cookie llamada
Si eso falla, busca la cabecera HTTP
en la sesin del usuario actual.
django_language.
Accept-Language.
Esta cabecera es enviada por tu navegador
y le indica al servidor qu idioma(s) pre eres en orden de prioridad. Django intenta con cada idioma
que aparezca en dicha cabecera hasta que encuentra uno para el que haya disponible una traduccin.
Si eso falla, usa la variable de con guracin global
LANGUAGE_CODE.
En cada uno de dichas ubicaciones, el formato esperado para la preferencia de idioma es el formato estndar,
como una cadena. Por ejemplo, portugus de Brasil es
pt-br.
Si un idioma base est disponible pero el sub-idioma
especi cado no, Django usar el idioma base. Por ejemplo, si un usuario especi ca
Django solo tiene disponible
de
, usar
de.
de-at
(alemn Austraco) pero
Slo pueden seleccionarse idiomas que se encuentren listados en la variable de con guracin
LANGUAGES.
Si deseas
restringir la seleccin de idiomas a un subconjunto de los idiomas provistos (debido a que tu aplicacin no incluye
todos esos idiomas), ja tu
LANGUAGES
a una lista de idiomas, por ejemplo:
LANGUAGES = (
('de', _('German')),
('en', _('English')),
)
Este ejemplo restringe los idiomas que se encuentran disponibles para su seleccin automtica a alemn e ingls (y
de-ch o en-us).
LANGUAGES personalizado es posible marcar los idiomas como cadenas de traduccin -- pero usa una funcin gettext() boba, no la que se encuentra en django.utils.translation. Nunca debes importar django.utils.transla
cualquier sub-idioma, como
Si de nes un
desde el archivo de con guracin debido a que ese mdulo a su vez depende de las variables de con guracin, y eso
creara una importacin circular.
La solucin es usar una funcin
gettext()`
boba. A continuacin un archivo de con guracin de ejemplo:
_ = lambda s: s
LANGUAGES = (
('de', _('German')),
('en', _('English')),
)
Con este esquema,
make-messages.py todava ser capaz de encontrar y marcar dichas cadenas para su traduccin
pero la misma no ocurrir en tiempo de ejecucin, de manera que tendrs que recordar envolver los idiomas con la
gettext() en cualquier cdigo que use LANGUAGES en tiempo de ejecucin.
LocaleMiddleware slo puede seleccionar idiomas para los cuales exista una traduccin base provista por Django.
verdadera
El
Si deseas ofrecer traducciones para tu aplicacin que no se encuentran en el conjunto de traducciones incluidas en el
cdigo fuente de Django, querrs proveer al menos traducciones bsicas para ese idioma. Por ejemplo, Django usa
identi cadores de mensajes tcnicos para traducir formatos de fechas y de horas -- as que necesitars al menos esas
traducciones para que el sistema funcione correctamente.
Un buen punto de partida es copiar el archivo
.po
de ingls y traducir al menos los mensajes tcnicos, y quiz
tambin los mensajes de los validadores.
revisin 757 del 28 de julio de 2008
214
CAPTULO 18. INTERNACIONALIZACIN
Los identi cadores de mensajes tcnicos son fcilmente reconocibles; estn completamente en maysculas. No
necesitas traducir los identi cadores de mensajes como lo haces con otros mensajes; en cambio, deber proporcionar la
variante local correcta del valor provisto en ingls. Por ejemplo, con
DATETIME_FORMAT (o DATE_FORMAT o TIME_FORMAT),
este sera la cadena de formato que deseas usar en tu idioma. El formato es idntico al de la cadena de formato usado
now.
LocaleMiddleware ha determinado la preferencia del usuario, la deja disponible como request.LANGUAGE_CODE
por la etiqueta de plantillas
Una vez que el
para cada objeto peticin. Eres libre de leer este valor en tu cdigo de vista. A continuacin un ejemplo simple:
def hello_world(request, count):
if request.LANGUAGE_CODE == 'de-at':
return HttpResponse("You prefer to read Austrian German.")
else:
return HttpResponse("You prefer to read another language.")
settings.LANGUAGE_CODE,
request.LANGUAGE_CODE.
Nota que con traduccin esttica (en otras palabras sin middleware) el idioma est en
mientras que con traduccin dinmica (con middleware) el mismo est en
18.5.
La vista de redireccin set_language
Por conveniencia, Django incluye una vista
django.views.i18n.set_language,
que ja la preferencia de idioma
de un usuario y redirecciona de vuelta a la pgina previa.
Activa esta vista agregando la siguiente lnea a tu URLconf:
(r'^i18n/', include('django.conf.urls.i18n')),
/i18n/setlang/).
GET, con un parmetro language incluido en la cadena de consulta. Si el
(Nota que este ejemplo publica la vista en
La vista espera ser llamada va el mtodo
soporte para sesiones est activo, la vista guarda la opcin de idioma en la sesin del usuario. Caso contrario, guarda
el idioma en una cookie
django_language.
Despus de haber jado la opcin de idioma Django redirecciona al usuario, para eso sigue el siguiente algoritmo:
Django busca un parmetro
next
en la cadena de consulta.
Si el mismo no existe o est vaci, Django intenta la URL contenida en la cabecera
Referer.
Si la misma est vaca -- por ejemplo, si el navegador de un usuario suprime dicha cabecera -- entonces
el usuario ser redireccionado a
(la raz del sitio) como un ltimo recurso.
Este es un fragmento de cdigo de plantilla HTML de ejemplo:
<form action="/i18n/setlang/" method="get">
<input name="next" type="hidden" value="/next/page/" />
<select name="language">
{ % for lang in LANGUAGES %}
<option value="{{ lang.0 }}">{{ lang.1 }}</option>
{ % endfor %}
</select>
<input type="submit" value="Go" />
</form>
18.6.
Usando traducciones en tus propios proyectos
Django busca traducciones siguiendo el siguiendo algoritmo:
Primero, busca un directorio
locale en el directorio de la aplicacin correspondiente a la vista que se
est llamando. Si encuentra una traduccin para el idioma seleccionado, la misma ser instalada.
A continuacin, busca un directorio
locale en el directorio del proyecto. Si encuentra una traduccin,
la misma ser instalada.
Finalmente, veri ca la traduccin base en
django/conf/locale.
revisin 757 del 28 de julio de 2008
18.7. TRADUCCIONES Y JAVASCRIPT
215
De esta forma, puedes escribir aplicaciones que incluyan su propias traducciones, y puedes reemplazar traducciones
base colocando las tuyas propias en la ruta de tu proyecto. O puedes simplemente construir un proyecto grande a
partir de varias aplicaciones y poner todas las traducciones en un gran archivo de mensajes. Es tu eleccin.
Nota
Si ests jando manualmente la variables de con guracin, el directorio
locale
en el directorio
del proyecto no ser examinado dado que Django pierde la capacidad de deducir la ubicacin del
directorio del proyecto. (Django normalmente usa la ubicacin del archivo de con guracin para
determinar esto, y en el caso que ests jando manualmente tus variables de con guracin dicho
archivo no existe).
Todos los repositorios de archivos de mensajes estn estructurados de ka misma manera:
$APPPATH/locale/<language>/LC_MESSAGES/django.(po|mo)
$PROJECTPATH/locale/<language>/LC_MESSAGES/django.(po|mo)
LOCALE_PATHS en tu archivo de con guracin
<language>/LC_MESSAGES/django.(po|mo)
Todas las rutas listandas en
orden en bsquda de
son examinadas en ese
$PYTHONPATH/django/conf/locale/<language>/LC_MESSAGES/django.(po|mo)
Para crear archivos de mensajes, usas la misma herramienta
make-messages.py
que usabas con los archivos de
mensajes de Django. Solo necesitas estar en la ubicacin adecuada -- en el directorio en el cual exista ya sea el directorio
conf/locale (en el caso del rbol de cdigo fuente) o el directorio locale/ (en el caso de mensajes de aplicacin o de
proyecto). Usas tambin la misma herramienta compile-messages.py para producir los archivos binarios django.mo
usados por gettext.
Los archivos de mensajes de aplicaciones son un poquito complicados a la hora de buscar por los mismos -necesitas el
LocaleMiddleware.
Si no usas el middleware, solo sern procesados los archivos de mensajes de Django y
del proyecto.
Finalmente, debes dedicarle tiempo al diseo de la estructura de tus archivos de traduccin. Si tus aplicaciones
necesitan ser enviadas a otros usuarios y sern usadas en otros proeyctos, posiblemente quieras usar traducciones
espec cas a dichas aplicaciones. Pero el usar traducciones espec cas a aplicaciones y aplicaciones en proyectos podran
producir problemas extraos con
make-messages.py. make-messages
recorrer todos los directorios situados por
debajo de la ruta actual y de esa forma podra colocar en el archivo de mensajes del proyecto identi cadores de
mensajes que ya se encuentran en los archivos de mensajes de la aplicacin.
la salida ms fcil de este problema es almacenar las aplicaciones que no son partes del proyecto (y por ende poseen
sus propias traducciones) fuera del rbol del proyecto. De esa forma make-messages.py ejecutado a nivel proyecto slo
traducir cadenas que estn conectadas a tu proyecto y no cadenas que son distribuidas en forma independiente.
18.7.
Traducciones y JavaScript
El agregar traducciones a JavaScript plantea algunos problemas:
El cdigo JavaScript no tiene acceso a una implementacin de
El cdigo JavaScript no tiene acceso a los archivos
gettext.
.po o .mo; los mismos necesitan ser enviados desde
el servidor.
Los catlogos de traduccin para JavaScript deben ser mantenidos tan pequeos como sea posible.
Django provee una solucin integrada para esos problemas: convierte las traducciones a JavaScript, de manera que
puedas llamar a
18.7.1.
gettext
y dems desde JavaScript.
La vista javascript_catalog
javascript_catalog, que
gettext ms un arreglo de cadenas
La solucin principal a esos problemas es la vista
JavaScript con funciones que emulan la interfaz
genera una biblioteca de cdigo
de traduccin. Dichas cadenas de
traduccin se toman desde la aplicacin, el proyecto o el ncleo de Django, de acuerdo a lo que especi ques ya sea en
el
info_dict
o en la URL.
La forma de usar esto es asi:
revisin 757 del 28 de julio de 2008
216
CAPTULO 18. INTERNACIONALIZACIN
js_info_dict = {
'packages': ('your.app.package',),
}
urlpatterns = patterns('',
(r'^jsi18n/$', 'django.views.i18n.javascript_catalog', js_info_dict),
)
package debe seguir la sintaxis
INSTALLED_APPS) y deben referirse
Cada cadena en
las cadenas en
paquete separados por puntos de Python (el mismo formato que
a un paquete que contenga un directorio
locale.
Si especi cas
mltiples paquetes, todos esos catlogos son fusionados en un catlogo nico. esto es til si usas JavaScript que usa
cadenas de diferentes aplicaciones.
Puedes hacer que la vista sea dinmica colocando los paquetes en el patrn de la URL:
urlpatterns = patterns('',
(r'^jsi18n/(?P<packages>\S+?)/$, 'django.views.i18n.javascript_catalog'),
)
Con esto, especi cas los paquetes como una lista de nombres de paquetes delimitados por un smbolo
+ en la URL.
Esto es especialmente til si tus pginas usan cdigo de diferentes aplicaciones, este cambia frecuentemente y no deseas
tener que descargar un nico gran catlogo. Como una medida de seguridad, esos valores pueden solo tomar los valores
django.conf
18.7.2.
o cualquier paquete de la variable de con guracin
INSTALLED_APPS.
Usando el catlogo de traducciones JavaScript
Para usar el catlogo simplemente descarga el script generado dinmicamente de la siguiente forma:
<script type="text/javascript" src="/path/to/jsi18n/"></script>
Esta es la forma en la que el sitio de administracin obtiene el catlogo de traducciones desde el servidor. Una vez
que se ha cargado el catlogo, tu cdigo JavaScript puede usar la interfaz estndar
gettext
para acceder al mismo:
document.write(gettext('this is to be translated'));
Existe incluso una interfaz
ngettext
y una funcin de interpolacin de cadenas:
d = {
count: 10
};
s = interpolate(ngettext('this is %(count)s object', 'this are %(count)s objects', d.count), d);
La funcin
interpolate admite tanto interpolacin posicional como interpolacin con nombres. De manera que el
cdigo de arriba podra haber sido escrito de la siguiente manera:
s = interpolate(ngettext('this is %s object', 'this are %s objects', 11), [11]);
La sintaxis de interpolacin se tom prestada de Python. Sin embargo, no debes exagerar con el uso de la interpolacin de cadenas -- esto sigue siendo JavaScript as que el cdigo tendr que realizar mltiples sustituciones de
expresiones regulares. Esto no es tan rpido como la interpolacin de cadenas en Python, de manera que deberas
reservarlo para los casos en los que realmente lo necesites (por ejemplo en combinacin con
ngettext
para generar
pluralizaciones en forma correcta).
18.7.3.
Creando catlogos de traducciones JavaScript
Los catlogos de traducciones se crean y actualizan de la misma manera que el resto de los catlogos de traducciones
de Django: con la herramienta
-d djangojs,
make-messages.py.
La nica diferencia es que es necesario que proveas un parmetro
de la siguiente forma:
make-messages.py -d djangojs -l de
Esto crea o actualiza el catlogo de traduccin para JavaScript para alemn. Luego de haber actualizado catlogos,
slo ejecuta
compile-messages.py
de la misma manera que lo haces con los catlogos de traduccin normales de
Django.
revisin 757 del 28 de julio de 2008
18.8. NOTAS PARA USUARIOS FAMILIARIZADOS CON
18.8.
GETTEXT
Notas para usuarios familiarizados con
Si conoces
217
gettext
gettext podras notar las siguientes particularidades en la forma en que Django maneja las traducciones:
El dominio de las cadenas es
django
djangojs.
El dominio de cadenas se usa para diferenciar
entre diferentes programas que almacenan sus datos en una biblioteca comn de archivos de mensajes
(usualmente
/usr/share/locale/). EL dominio django se usa para cadenas de traduccin de Python
djangojs se usa slo para
y plantillas y se carga en los catlogos de traducciones globales. El dominio
catlogos de traducciones de JavaScript para asegurar que los mismos sean tan pequeos como sea
posible.
gettext y gettext_noop.
DEFAULT_CHARSET. Usar ugettext
Django slo usa
Esto es debido a que Django siempre usa internamente
cadenas
no signi cara muchas ventajas ya que de todas formas
siempre necesitars producir UTF-8.
Django no usa
msgfmt.
18.9.
xgettext en forma independiente. Usa *wrappers* Python alrededor de xgettext y
Esto es ms que nada por conveniencia.
Qu sigue?
Este captulo esencialmente concluye nuestra cobertura de las caractersticas de Django. Deberas conocer lo su ciente para comenzar a producir tus propios sitios usando Django.
Sin embargo, escribir el cdigo es solo el primer paso de la instalacin de un sitio Web exitoso. Los siguientes dos
`Captulo
19`_ trata cmo puedes hacer para hace que tus sitios y tus usuarios estn seguros ante atacantes maliciosos y el
captulos cubren las cosas que necesitars conocer si deseas que tu sitio sobreviva en el mundo real. El
Captulo 20 detalla cmo instalar una aplicacin Django en uno o varios servidores.
revisin 757 del 28 de julio de 2008
218
CAPTULO 18. INTERNACIONALIZACIN
revisin 757 del 28 de julio de 2008
Captulo 19
Seguridad
Internet puede ser un lugar aterrador.
En estos tiempos, los papelones de seguridad con alta exposicin pblica parecen ser cosa de todos los das. Hemos
visto virus propagarse con una velocidad asombrosa, ejrcitos de computadoras comprometidas ser empuados como
armas, una interminable carrera armamentista contra los spammers, y muchos, muchos reportes de robos de identidad
de sitios Web hackeados.
Parte de las tareas de un desarrollador Web es hacer lo que est en sus manos para combatir esas fuerzas de la
oscuridad. Todo desarrollador Web necesita considerar la seguridad como un aspecto fundamental de la programacin
Web. Desafortunadamente, se da el caso de que implementar la seguridad es difcil -- los atacantes slo necesitan
encontrar una nica vulnerabilidad, pero los defensores deben proteger todas y cada una.
Django intenta mitigar esta di cultad. Est diseado para protegerte automticamente de muchos de los errores de
seguridad comunes que cometen los nuevos (e incluso los experimentados) desarrolladores Web. Aun as, es importante
entender de qu se tratan dichos problemas, cmo es que Django te protege, y -- esto es lo ms importante -- los pasos
que puedes tomar para hacer tu cdigo aun ms seguro.
Antes, sin embargo, una importante aclaracin: No es nuestra intencin presentar una gua de nitiva sobre todos los
exploits de seguridad Web conocidos, y tampoco trataremos de explicar cada vulnerabilidad en una forma completa.
En cambio, presentaremos una breve sinopsis de problemas de seguridad que son relevantes para Django.
19.1.
El tema de la seguridad en la Web
Si aprendes slo una cosa de este captulo, que sea esto:
Nunca -- bajo ninguna circunstancia -- confes en datos enviados por un navegador.
Nunca sabes quin est del otro lado de esa conexin HTTP. Podra tratarse de uno de tus usuarios, pero con igual
facilidad podra tratarse de un vil cracker buscando un resquicio.
Cualquier dato de cualquier naturaleza que arriba desde el navegador necesita ser tratado con una generosa dosis
de paranoia. Esto incluye tanto datos que se encuentran in band (por ejemplo enviados desde formularios Web) como
out of band (por ejemplo cabeceras HTTP, cookies, y otra informacin de peticin). Es trivial falsi car los metadatos
de la peticin que los navegadores usualmente agregan automticamente.
Todas las vulnerabilidades tratadas en este captulo derivan directamente de con ar en datos que arriban a travs
del cable y luego fallar a la hora de limpiar esos datos antes de usarlos. Debes convertir en una prctica general el
preguntarte De donde vienen estos datos`
19.2.
Inyeccin de SQL
La inyeccin de SQL es un exploit comn en el cual un atacante altera los parmetros de la pgina (tales como
datos de
GET/POST
o URLs) para insertar fragmentos arbitrarios de SQL que una aplicacin Web ingenua ejecuta
directamente en su base de datos. Es probablemente la ms peligrosa -- y, desafortunadamente una de las ms comunes
-- vulnerabilidad existente.
Esta vulnerabilidad se presenta ms comnmente cuando se est construyendo SQL a mano a partir de datos
ingresados por el usuario. Por ejemplo, imaginemos que se escribe una funcin para obtener una lista de informacin
de contacto desde una pgina de bsqueda. Para prevenir que los spammers lean todas las direcciones de email en
nuestro sistema, vamos a exigir al usuario que escriba el nombre de usuario del cual quiere conocer sus datos antes de
proveerle la direccin de email respectiva:
revisin 757 del 28 de julio de 2008
220
CAPTULO 19. SEGURIDAD
def user_contacts(request):
user = request.GET['username']
sql = "SELECT * FROM user_contacts WHERE username = ' %s';" % username
# execute the SQL here...
Nota
En este ejemplo, y en todos los ejemplos similares del tipo no hagas esto que siguen, hemos
omitido deliberadamente la mayor parte del cdigo necesario para hacer que el mismo realmente
funcione. No queremos que este cdigo sirva si accidentalmente alguien lo toma fuera de contexto
y lo usa.
A pesar de que a primera vista eso no parece peligroso, realmente lo es.
Primero, nuestro intento de proteger nuestra lista de emails completa va a fallar con una consulta construida en
forma ingeniosa. Pensemos acerca de qu sucede si un atacante escribe
"'OR 'a'='a"
en la caja de bsqueda. En ese
caso, la consulta que la interpolacin construir ser:
SELECT * FROM user_contacts WHERE username = '' OR 'a' = 'a';
Debido a que hemos permitido SQL sin proteccin en la string, la clusula
OR
agregada por el atacante logra que
se retornen todas los registros.
Sin embargo, ese es el menos pavoroso de los ataques. Imaginemos qu sucedera si el atacante enva
FROM user_contacts WHERE 'a' = 'a'".
"'; DELETE
Nos encontraramos con la siguiente consulta completa:
SELECT * FROM user_contacts WHERE username = ''; DELETE FROM user_contacts WHERE 'a' = 'a';
Ouch! Donde ira a parar nuestra lista de contactos?
19.2.1.
La solucin
Aunque este problema es insidioso y a veces difcil de detectar la solucin es simple: nunca confes en datos provistos
por el usuario y siempre escapa el mismo cuando lo conviertes en SQL.
La API de base de datos de Django hace esto por ti. Escapa automticamente todos los parmetros especiales
SQL, de acuerdo a las convenciones de uso de comillas del servidor de base de datos que ests usando (por ejemplo,
PostgreSQL o MySQL).
Por ejemplo, en esta llamada a la API:
foo.get_list(bar__exact="' OR 1=1")
Django escapar la entrada apropiadamente, resultando en una sentencia como esta:
SELECT * FROM foos WHERE bar = '\' OR 1=1'
que es completamente inocua.
Esto se aplica a la totalidad de la API de base de datos de Django, con un par de excepciones:
El argumento
where del mtodo extra() (ver Apndice C). Dicho parmetro acepta, por diseo, SQL
crudo.
Consultas realizadas a mano usando la API de base de datos de nivel ms bajo.
En tales casos, es fcil mantenerse protegido. para ello evita realizar interpolacin de strings y en cambio usa
parmetros asociados (bind parameters ). Esto es, el ejemplo con el que comenzamos esta seccin debe ser escrito de la
siguiente manera:
from django.db import connection
def user_contacts(request):
user = request.GET['username']
sql = "SELECT * FROM user_contacts WHERE username = %s;"
cursor = connection.cursor()
cursor.execute(sql, [user])
# ... do something with the results
revisin 757 del 28 de julio de 2008
19.3. CROSS-SITE SCRIPTING (XSS)
El mtodo de bajo nivel
execute
221
toma un string SQL con marcadores de posicin %s y automticamente escapa e
inserta parmetros desde la lista que se le provee como segundo argumento. Cuando construyas SQL en forma manual
hazlo siempre de esta manera.
Desafortunadamente, no puedes usar parmetros asociados en todas partes en SQL; no son permitidos como identi cadores (esto es, nombres de tablas o columnas). As que, si, por ejemplo, necesitas construir dinmicamente una
lista de tablas a partir de una variable enviada mediante
provee una funcin,
django.db.backend.quote_name,
POST,
necesitars escapar ese nombre en tu cdigo. Django
la cual escapar el identi cador de acuerdo al esquema de uso
de comillas de la base de datos actual.
19.3.
Cross-Site Scripting (XSS)
El Cross-site scripting (XSS) (Scripting inter-sitio), puede encontrarse en aplicaciones Web que fallan a la hora
de escapar en forma correcta contenido provisto por el usuario antes de renderizarlo en HTML. Esto le permite a un
atacante insertar HTML arbitrario en tu pgina Web, usualmente en la forma de etiquetas
<script>.
Los atacantes a menudo usan ataques XSS para robar informacin de cookies y sesiones, o para engaar usuarios
y lograr que proporcionen informacin privada a la persona equivocada (tambin conocido como phishing ).
Este tipo de ataque puede tomar diferentes formas y tiene prcticamente in nitas permutaciones, as que slo
vamos a analizar un ejemplo tpico. Consideremos esta simple vista Hola mundo:
def say_hello(request):
name = request.GET.get('name', 'world')
return render_to_response("hello.html", {"name" : name})
Esta vista simplemente lee un nombre desde un parmetro
GET
y pasa dicho nombre a la plantilla
hello.html.
Podramos escribir una plantilla para esta vista de la siguiente manera:
<h1>Hello, {{ name }}!</h1>
De manera que si accediramos a
http://example.com/hello/?name=Jacob,
la pgina renderizada contendra lo
siguiente:
<h1>Hello, Jacob!</h1>
Pero atencin -- qu sucede si accedemos a
http://example.com/hello/?name=<i>Jacob</i>?
En ese caso
obtenemos esto:
<h1>Hello, <i>Jacob</i>!</h1>
Obviamente, un atacante no usar algo tan inofensivo como etiquetas
<i>;
podra incluir un fragmento completo
de HTML que se apropiara de tu pgina insertando contenido arbitrario. Este tipo de ataques ha sido usado para
engaar a usuarios e inducirlos a introducir datos en lo que parece ser el sitio Web de su banco, pero en efecto es un
formulario saboteado va XSS que enva su informacin bancaria a un atacante.
El problema se complica aun ms si almacenas estos datos en la base de datos y luego la visualizas en tu sitio. Por
ejemplo, en una oportunidad se encontr que MySpace era vulnerable a un ataque XSS de esta naturaleza. Un usuario
haba insertado JavaScript en su pgina de per l, dicho cdigo agregana lo agregaba a la lista de amigos de todos los
usuarios que visitaran su pgina de per l. En unos pocos das lleg a tener millones de amigos.
Ahora, esto podra sonar relativamente inofensivo, pero no olvides que este atacante haba logrado que su cdigo
-- no el cdigo de MySpace -- se ejecutara en tu computadora. Esto viola la con anza asumida acerca de que todo el
cdigo ubicado en MySpace es realmente escrito por MySpace.
MySpace fue muy afortunado de que este cdigo malicioso no hiciera cosas como borrar automticamente las
cuentas de los usuarios que lo ejecutaran, o cambiar sus contraseas, o inundar el sitio con spam, o cualquiera de los
otros escenarios de pesadilla que esta vulnerabilidad hace posibles.
19.3.1.
La solucin
La solucin es simple: siempre escapa todo el contenido que pudiera haber sido enviado por un usuario. Si simplemente reescribiramos nuestra plantilla de la siguiente manera:
<h1>Hello, {{ name|escape }}!</h1>
ya no seramos vulnerables. Debes usar siempre la etiqueta
escape
(o algo equivalente) cuando visualizas en tu
sitio contenido enviado por el usuario.
revisin 757 del 28 de julio de 2008
222
CAPTULO 19. SEGURIDAD
Porqu simplemente Django no hace esto por m?
Modi car Django para que escape automticamente todas las variables visualizadas en plantillas
es un tpico de frecuente tratamiento en la lista de correo de desarrollo de Django.
Hasta ahora, las plantillas Django han evitado este comportamiento debido a que esto cambia
sutilmente algo que debera ser un comportamiento no complejo (la visualizacin de variables). Es
un asunto no trivial y una decisin de compromiso difcil de evaluar. Agregando comportamiento
implcito y oculto va contra los ideales de base de Django (y los de Python), pero la seguridad es
igual de importante.
Todo esto nos lleva, entonces, a a rmar que es muy probable que Django incorpore alguna forma
de comportamiento de auto-escaping (o algo cercano a auto-escaping ) en el futuro. Es una
buena idea revisar la documentacin o cial de Django para conocer las novedades respecto a
las caractersticas de Django; esta ser siempre ms actual que este libro, especialmente que la
versin impresa.
Aun si Django incorpora esta caracterstica debes formar el hbito de preguntarte, en todo momento, De donde provienen estos datos`. Ninguna solucin automtica proteger tu sitio de
ataques XSS el 100 % del tiempo.
19.4.
Cross-Site Request Forgery
La Cross-site request forgery (CSRF) (Falsi cacin de peticiones inter-sitio) sucede cuando un sitio Web malicioso
engaa a los usuarios y los induce a visitar una URL desde un sitio ante el cual ya se han autenticado -- por lo tanto
saca provecho de su condicin de usuario ya autenticado.
Django incluye herramientas para proteger ante este tipo de ataques. Tanto el ataque en s mismo como dichas
herramientas son tratados con gran detalle en el Captulo 14.
19.5.
Session Forging/Hijacking
No se trata de un ataque espec co, sino una clase general de ataques sobre los datos de sesin de un usuario.
Puede tomar diferentes formas:
Un ataque del tipo man-in-the-middle, en el cual un atacante espa datos de sesin mientras estos
viajan por la red (cableada o inalmbrica).
Session forging (Falsi cacin de sesin), en la cual un atacante usa un identi cador de sesin (posiblemente obtenido mediante un ataque man-in-the-middle) para simular ser otro usuario.
Un ejemplo de los dos primeros sera una atacante en una cafetera usando la red inalmbrica del lugar
para capturar una cookie de sesin. Podra usar esa cookie para hacerse pasar por el usuario original.
Un ataque de falsi cacin de cookies en el cual un atacante sobrescribe los datos almacenados en una
cookie que en teora no son modi cables. El Captulo 12 explica en detalle cmo funcionan las cookies,
y uno de los puntos salientes es que es trivial para los navegadores y usuarios maliciosos el cambiar
las cookies sin tu conocimiento.
Existe una larga historia de sitios Web que han almacenado una cookie del tipo
LoggedInAsUser=jacob.
IsLoggedIn=1
o aun
Es trivialmente simple sacar provecho de ese tipo de cookies.
En un nivel aun ms sutil, nunca ser una buena idea con ar en nada que se almacene en cookies;
nunca sabes quin puede haber estado manoseando las mismas.
Session xation ( jacin de sesin), en la cual un atacante engaa a un usuario y logra asignar un
nuevo valor o limpiar el valor existente del identi cador de su sesin.
Por ejemplo, PHP permite que los identi cadores de sesin se pasen en la URL (por ejemplo,
http://example.com/?PHPSE
Un atacante que logre engaar a un usuario para que haga click en un link que posea un identi cador
de sesin jo causar que ese usuario comience a usar esa sesin.
La jacin de sesin se ha usado en ataques de phishing para engaar a usuarios e inducirlos a ingresar
informacin personal en una cuenta que est bajo el control de atacante. Este puede luego conectarse
al sitio con dicho usuario y obtener datos.
Session poisoning (envenenamiento de sesin), en el cual in atacante inyecta datos potencialmente
peligrosos en la sesin de un usuario -- usualmente a travs de un formulario que el usuario enva con
datos de su sesin.
revisin 757 del 28 de julio de 2008
19.6. INYECCIN DE CABECERAS DE EMAIL
223
Un ejemplo cannico es un sitio que almacena un valor de preferencia simple (como el color de fondo
de una pgina) en una cookie. Un atacante podra engaar a un usuario e inducirlo a hacer click en
un link que enva un color que en realidad contiene un ataque XSS; si dicho color no est siendo
escapado, el usuario podra insertar nuevamente cdigo malicioso en el entorno del usuario.
19.5.1.
La solucin
Existe un nmero de principios generales que pueden protegerte de estos ataques:
Nunca permitas que exista informacin sobre sesiones contenida en las URLs.
El framework de sesiones de Django (ver Captulo 12) simplemente no permite que las URLs contengan
sesiones.
No almacenes datos en cookies en forma directa; en cambio, almacena un identi cador de sesin que
est relacionado a datos de sesin almacenados en el back-end.
Si usas el framework de sesiones incluido en Django (o sea
request.session),
eso es manejado en
forma automtica. La nica cookie que usa el framework de sesiones es un identi cador de sesin;
todos los datos de la sesiones se almacenan en la base de datos.
Recuerda escapar los datos de la sesin si los visualizas en la plantilla. Revisa la seccin previa sobre
XSS y recuerda que esto se aplica a cualquier contenido creado por el usuario as como a cualquier
dato enviado por el navegador. Debes considerar la informacin de sesiones como datos creados por
el usuario.
Previene la falsi cacin de de identi cadores de sesin por parte de un atacante siempre que sea
posible.
A pesar de que es prcticamente imposible detectar a alguien que se ha apropiado de un identi cador
de sesin, Django incluye proteccin contra un ataque de sesiones de fuerza bruta. Los identi cadores
de sesin se almacenan como hashes (en vez de nmeros secuenciales) lo que previene un ataque por
fuerza bruta, y un usuario siempre obtendr un nuevo identi cador de sesin si intenta usar uno no
existente, lo que previene la session xation.
Nota que ninguno de estos principios y herramientas previene ante ataques man-in-the-middle. Dichos tipos de
ataques son prcticamente imposibles de detectar. Si tu sitio permite que usuarios identi cados visualicen algn tipo
de datos importantes debes, siempre, publicar dicho sitio va HTTPS. Adicionalmente, si tienes un sitio con SSL, debes
asignar a la variable de con guracin
SESSION_COOKIE_SECURE
el valor
True;
esto har que Django enve las cookies
de sesin va HTTPS.
19.6.
Inyeccin de cabeceras de email
La hermana menos conocida de la inyeccin de SQL, la inyeccin de cabeceras de email, toma control de formularios
Web que envan emails. Un atacante puede usar esta tcnica para enviar spam mediante tu servidor de email. Cualquier
formulario que construya cabeceras de email a partir de datos de un formulario Web es vulnerable a este tipo de ataque.
Analicemos el formulario de contacto cannico que puede encontrarse en muchos sitios. Usualmente el mismo enva
un mensaje a una direccin de email ja y, por lo tanto, a primera vista no parece ser vulnerable a abusos de spam.
Sin embargo, muchos de esos formularios permiten tambin que los usuarios escriban su propio asunto para el email
(en conjunto con una direccin de, el cuerpo del mensaje y a veces algunos otros campos). Este campo asunto es
usado para construir la cabecera subject del mensaje de email.
Si dicha cabecera no es escapada cuando se construye el mensaje de email, un atacante podra enviar algo como
"hello\ncc:[email protected]" (donde "\n" es un caracter de salto de lnea). Eso hara que las cabeceras de
email fueran:
To: [email protected]
Subject: hello
cc: [email protected]
Como en la inyeccin de SQL, si con amos en la lnea de asunto enviada por el usuario, estaremos permitindole
construir un conjunto malicioso de cabeceras, y podr usar nuestro formulario de contacto para enviar spam.
revisin 757 del 28 de julio de 2008
224
CAPTULO 19. SEGURIDAD
19.6.1.
La solucin
Podemos prevenir este ataque de la misma manera en la que prevenimos la inyeccin de SQL: escapando o veri cando
siempre el contenido enviado por el usuario.
Las funciones de mail incluidas en Django (en
django.core.mail)
simplemente no permiten saltos de lnea
en ninguno de los campos usados para construir cabeceras (las direcciones de y para, ms el asunto). Si inten-
tas usar django.core.mail.send_mail
BadHeaderError.
con un asunto que contenga saltos de lnea, Django arrojar una excepcin
Si no usas las funciones de email de Django para enviar email, necesitars asegurarte de que los saltos de lnea en las
cabeceras o causan un error o son eliminados. Podras querer examinar la clase
SafeMIMEText
en
django.core.mail
para ver cmo implementa esto Django.
19.7.
Directory Traversal
Directory traversal se trata de otro ataque del tipo inyeccin, en el cual un usuario malicioso subvierte cdigo de
manejo de sistema de archivos para que lea y/o escriba archivos a los cuales el servidor Web no debera tener acceso.
Un ejemplo podra ser una vista que lee archivos desde disco sin limpiar cuidadosamente el nombre de archivo:
def dump_file(request):
filename = request.GET["filename"]
filename = os.path.join(BASE_PATH, filename)
content = open(filename).read()
# ...
A pesar que parece que la vista restringe el acceso a archivos que se encuentren ms all que
os.path.join),
si la atacante enva un
filename
que contenga
..
BASE_PATH
(usando
(esto es, dos puntos, una notacin corta para el
directorio padre), podra acceder a archivos que se encuentren ms arriba que
BASE_PATH.
De all en ms es slo
una cuestin de tiempo el hecho que descubra el nmero correcto de puntos para acceder exitosamente, por ejemplo a
../../../../../etc/passwd.
Todo aquello que lea archivos sin el escaping adecuado es vulnerable a este problema. Las vistas que escriben
archivos son igual de vulnerables, pero las consecuencias son doblemente calamitosas.
Otra permutacin de este problema yace en cdigo que carga mdulos dinmicamente a partir de la URL u otra
informacin de la peticin. Un muy pblico ejemplo se present en el mundo de Ruby on Rails. Con anterioridad a
mediados del 2006, Rails usaba URLs como
http://example.com/person/poke/1 directamente para cargar mdulos
e invocar mtodos. El resultado fu que una URL cuidadosamente construida poda cargar automticamente cdigo
arbitrario, incluso un script de reset de base de datos!
19.7.1.
La solucin
Si tu cdigo necesita alguna vez leer o escribir archivos a partir de datos ingresados por el usuario, necesitas limpiar
muy cuidadosamente la ruta solicitada para asegurarte que un atacante no pueda escapar del directorio base ms all
del cual ests restringiendo el acceso.
Nota
No es necesario decirlo, nunca debes escribir cdigo que pueda leer cualquier rea del disco!
Un buen ejemplo de cmo hacer este escaping yace en la vista de publicacin de contenido estticos (en
Este es el cdigo relevante:
import os
import posixpath
# ...
path = posixpath.normpath(urllib.unquote(path))
newpath = ''
for part in path.split('/'):
if not part:
revisin 757 del 28 de julio de 2008
django.view.static).
19.8. EXPOSICIN DE MENSAJES DE ERROR
225
# strip empty path components
continue
drive, part = os.path.splitdrive(part)
head, part = os.path.split(part)
if part in (os.curdir, os.pardir):
# strip '.' and '..' in path
continue
newpath = os.path.join(newpath, part).replace('\\', '/')
Django no lee archivos (a menos que uses la funcin
static.serve,
pero en ese caso est protegida por el cdigo
recin mostrado), as que esta vulnerabilidad no afecta demasiado el cdigo del ncleo.
Adicionalmente, el uso de la abstraccin de URLconf signi ca que Django solo cargar cdigo que le hayas indicado
explcitamente que cargue. No existe manera de crear una URL que cause que Django cargue algo no mencionado en
una URLconf.
19.8.
Exposicin de mensajes de error
Mientras se desarrolla, tener la posibilidad de ver tracebacks y errores en vivo en tu navegador es extremadamente
til. Django posee mensajes de depuracin vistosos e informativos espec camente para hacer la tarea de depuracin
ms fcil.
Sin embargo, si esos errores son visualizados una vez que el sitio pasa a produccin, pueden revelar aspectos de tu
cdigo o con guracin que podran ser de utilidad a un atacante.
Es ms, los errores y tracebacks no son para nada tiles para los usuarios nales. La losofa de Django es que los
visitantes al sitio nunca deben ver mensajes de error relacionados a una aplicacin. Si tu cdigo genera una excepcin
no tratada, un visitante al sitio no debera ver un traceback completo -- ni ninguna pista de fragmentos de cdigo o
mensajes de error (destinados a programadores) de Python. En cambio, el visitante debera ver un amistoso mensaje
Esta pgina no est disponible.
Naturalmente, por supuesto, los desarrolladores necesitan ver tracebacks para depurar problemas en su cdigo. As
que el framework debera ocultar todos los mensajes de error al pblico pero debera mostrarlos a los desarrolladores
del sitio.
19.8.1.
La solucin
Django tiene un sencillo control que gobierna la visualizacin de esos mensajes de error. Si se ja la variable de
con guracin
DEBUG
al valor
True,
los mensajes de error sern visualizados en el navegador. De otra forma, Django
retornar un mensaje HTTP 500 (Error interno del servidor) y renderizar una plantilla de error provista por ti.
Esta plantilla de error tiene el nombre
500.html y debe estar situada en la raz de uno de tus directorios de plantillas.
Dado que los desarrolladores aun necesitan ver los errores que se generan en un sitio en produccin, todos los
errores que se manejen de esta manera dispararn el envo de un email con el traceback completo a las direcciones de
correo con guradas en la variable
ADMINS.
Los usuarios que implementen en conjunto con Apache y mod_python deben tambin asegurarse que tienen
PythonDebug Off
en sus archivos de con guracin de Apache; esto suprimir cualquier error que pudiera ocurrir aun
antes de que Django se haya cargado.
19.9.
Palabras nales sobre la seguridad
Esperamos que toda esta exposicin sobre problemas de seguridad no sea demasiado intimidante. Es cierto que la
Web puede ser un mundo salvaje y confuso, pero con un poco de previsin puedes tener un sitio Web seguro.
Ten en mente que la seguridad Web es un campo en constante cambio; si ests leyendo la versin en papel de
este libro, asegrate de consultar recursos sobre seguridad ms actuales en bsqueda de nuevas vulnerabilidades
que pudieran haber sido descubiertas. En efecto, siempre es una buena idea dedicar algn tiempo semanalmente o
mensualmente a investigar y mantenerse actualizado acerca del estado de la seguridad de aplicaciones Web. Es una
pequea inversin a realizar, pero la proteccin que obtendrs para ti y tus usuarios no tiene precio.
revisin 757 del 28 de julio de 2008
226
19.10.
En el
CAPTULO 19. SEGURIDAD
Qu sigue?
`prximo captulo`_, nalmente trataremos las sutilezas de la implementacin de Django: como lanzar un
sitio de produccin y como dotarlo de escalabilidad.
Duplicate explicit target name: prximo captulo.
revisin 757 del 28 de julio de 2008
Captulo 20
Implementando Django
A lo largo de este libro, hemos mencionado algunos objetivos que conducen el desarrollo de Django. Facilidad de
uso, amigabilidad para nuevos programadores, abstraccin de tareas repetitivas -- todos esas metas marcaron el camino
de los desarrolladores.
Sin embargo, desde la concepcin de Django, ha existido siempre otro objetivo importante: Django debera ser fcil
de implementar, y debera poder servir una gran cantidad de tr co con recursos limitados.
Las motivaciones para este objetivo se vuelven evidentes cuando observas el trasfondo de Django: un pequeo
peridico en Kansas difcilmente pueda costear hardware de servidor de ltima tecnologa, por lo que los desarrolladores
originales de Django trataron de extraer el mximo desempeo posible de los escasos recursos disponibles. De hecho,
por aos los desarrolladores de Django actuaron como sus propios administradores de sistema -- ya que simplemente
no haba su ciente harware como para necesitar administradores dedicados a esa tarea -- incluso manejando sitios con
decenas de millones de entradas por da.
Como Django se volvi un proyecto open source, este enfoque en el desempeo y la facilidad de implementacin
se torn importante por diferentes razones: los desarrolladores a cionados tienen los mismos requerimientos. Los
individuos que quieren usar Django estn encantados de saber que pueden hospedar un sitio con tr co entre pequeo
y mediano por menos de u$s 10 mensuales.
Pero ser capaz de escalar hacia abajo es solamente la mitad de la batalla. Django tambin debe ser capaz de escalar
hacia arriba para conocer las necesidades de grandes empresas y corporaciones. Aqu, Django adopta una losofa
comn entre los grupos de software del tipo LAMP que suele llamarse shared nothing (nada compartido).
Qu es LAMP?
El acrnimo LAMP fue originalmente acuado para describir un conjunto de software open source
utilizado para propulsar muchos sitios web:
Linux (sistema operativo)
Apache (servidor web)
MySQL (base de datos)
PHP (lenguaje de programacin)
A lo largo del tiempo, el acrnimo se ha vuelto ms una referencia a la losofa de este tipo de
agrupamiento de software que a cualquiera de estos en particular. Por ello, aunque Django usa
Python y es agnstico respecto al motor de base de datos a utilizar, las losofas probadas por
los agrupamientos tipo LAMP permanece en la mentalidad de implementacin de Django.
Han habido algunos (ms que nada cmicos) intentos de acuar acrnimos similares para describir
los agrupamientos de tecnologa que usa Django. Los autores de este libro estn encariados con
LAPD (Linux, Apache, PostgreSQL, y Django) o PAID (PostgreSQL, Apache, Internet, y Django).
Usa Django y consigue un PAID! (N. de T.: En ingls, PAID signi ca pago).
20.1.
Nada Compartido
Esencialmente, la losofa shared nothing se trata de el acoplamiento dbil aplicado a todo el conjunto de software
utilizado. Esta arquitectura se present como respuesta directa a la que en su momento prevaleca: una aplicacin de
revisin 757 del 28 de julio de 2008
228
CAPTULO 20. IMPLEMENTANDO DJANGO
servidor web monoltica que encapsulaba el lenguaje, la base de datos y el servidor web -- e incluso partes del sistema
operativo -- un nico proceso (por ejemplo, Java).
Cuando llega el momento de escalar, esto puede ser un problema serio; es casi imposible separar el trabajo de un
proceso monoltico entre muchas maquinas fsicas diferentes, por lo que las aplicaciones monolticas requieren servidores
enormemente potentes. Estos servidores, por supuesto, cuestan decenas o a veces centenas de miles de dolares, dejando
a los sitios web de gran escala lejos del alcance de individuos o pequeas compaas con buenas ideas pero sin efectivo.
No obstante, lo que la comunidad LAMP descubri fue que si se separa cada pieza de esa pila de software Web
en componentes individuales, se podra fcilmente comenzar con un servidor barato y simplemente ir agregando ms
servidores baratos a medida que se crece. Si un servidor de base de datos de u$s3000 ya no puede manejar la carga,
sencillamente se comprara un segundo (o un tercero, o un cuarto) hasta que pueda. Si se necesita ms capacidad de
almacenamiento, se agregara un servidor NFS.
Aunque para que esto funcione, las aplicaciones Web deben dejar de asumir que el mismo servidor es el que maneja
cada peticin -- o incluso las distintas partes de una peticin. En una implementacin LAMP (y Django) de gran
escala, ms de media docena de servidores pueden estar involucrados en servir una sola peticin! Las repercusiones a
esta situacin son numerosas, pero pueden reducirse a estos puntos:
El estado no puede ser guardado localmente. En otras palabras, cualquier dato que deba estar disponible entre mltiples solicitudes, debe almacenarse en algn tipo de almacenamiento permanente como
la base de datos o una cach centralizada.
El software no puede asumir que los recursos son locales. Por ejemplo, la plataforma web no puede
asumir que la base de datos corre en el mismo servidor; por lo que debe ser capaz de conectarse a
servidor de base de datos remoto.
Cada pieza del conjunto debe ser fcilmente trasladable o reemplazable. Si Apache por alguna razn no
funciona para la implementacin dada, deberas ser posible cambiarlo por otro servidor con mnimas
complicaciones. O a nivel hardware, si un servidor web falla, debera ser posible reemplazarlo por
otra maquina con n mos tiempos de cada. Recuerda, esta losofa sobre implementacin se basa
enteramente en hardware barato. Fallas en maquinas individuales deben estar contempladas.
Como probablemente esperabas, Django maneja todo esto ms o menos de forma transparente -- ninguna parte de
Django viola estos principios -- pero conocer la losofa ayuda cuando es tiempo de escalar.
Pero esto funciona?
Esta losofa puede sonar bien en papel (o en tu pantalla), pero funciona realmente?
Bueno, en vez de responder directamente, permtanos mostrarle una lista no muy exhaustiva de
compaas que han basado sus negocios en esta arquitectura. Probablemente reconozca algunos
de estos nombres:
Amazon
Blogger
Craigslist
LiveJournal
Slashdot
Wikipedia
Yahoo
YouTube
Parafraseando la famosa escena de Cuando Harry conoci a Sally...: Tendremos lo que ellos
tienen`
20.2.
Un nota sobre preferencias personales
Antes de entrar en detalles, un rpido comentario.
revisin 757 del 28 de julio de 2008
20.3. USANDO DJANGO CON APACHE Y MOD_PYTHON
229
El open source es famoso por sus llamadas guerras religiosas; mucha tinta (digital) ha sido despilfarrada argumen-
tando sobre editores de textos (emacs versus
vi),sistemas operativos (Linux versus Windows versus Mac OS), motores
de base de datos (MySQL versus PostgreSQL), y -- por supuesto -- lenguajes de programacin.
Nosotros tratamos de permanecer lejos de esas batallas. Simplemente no hay tiempo su ciente.
Sin embargo, hay algunas elecciones que tomar al momento de implementar Django, y constantemente nos preguntar por nuestras preferencias. Conscientes de que explicitar esas preferencias puede encender una de de esas batallas
ya mencionadas, la mayora de las veces hemos tratado de evitarlo. Pero para permitir un debate completo lo explicitaremos aqu. Preferimos lo siguiente:
Linux (espec camente Ubuntu) como nuestro sistema operativo
Apache y mod_python para el servidor web
PostgreSQL como servidor de base de datos
Por supuesto, podemos indicarles muchos usuarios de Django que han hecho otras elecciones con gran xito.
20.3.
Usando Django con Apache y mod_python
Apache con mod_python es actualmente la con guracin ms robusta para usar Django en un servidor en produccin.
mod_python (http://www.djangoproject.com/r/mod_python/) es un plugin de Apache que embebe Python dentro
de Apache y carga cdigo Python en memoria cuando el servidor se inicia. El cdigo permanece en memoria a lo largo
de la vida del proceso Apache, lo que repercute en aumentos signi cativos de desempeo comparado con otros arreglos
de servidor.
Django requiere Apache 2.x y mod_python 3.x, y nosotros preferimos el mdulo de multiprocesamiento (MPM)
prefork de Apache, por sobre el MPM worker.
Nota
Con gurar Apache est claramente ms all del alcance de este libro, por lo que simplemente mencionaremos algunos detalles que necesitamos. Afortunadamente existen grandes recursos
disponibles para aprender ms sobre Apache. Algunos de los que nos gustan son los siguientes:
La
documentacin
gratuita
de
Apache,
djangoproject.com/r/apache/docs/
disponible
via
http://www.
Pro Apache, Third Edition (Apress, 2004) de Peter Wainwright, disponible via
http://www.djangoproject.com/r/books/pro-apache/
Apache: The De nitive Guide, Third Edition (O'Reilly, 2002) de Ben Laurie y Peter Laurie, disponible via
apache-pra/
20.3.1.
http://www.djangoproject.com/r/books/
Con guracin bsica
Para con gurar Django con mod_python, primero debe asegurarse de que tiene Apache instalado con el mdulo
mod_python activado. Esto usualmente signi ca tener una directiva
LoadModule
Apache. Puede parecerse a esto:
LoadModule python_module /usr/lib/apache2/modules/mod_python.so
Luego, edite su archivo de con guracin de Apache y agregue lo siguiente:
<Location "/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE misitio.settings
PythonDebug On
</Location>
revisin 757 del 28 de julio de 2008
en tu archivo de con guracin de
230
CAPTULO 20. IMPLEMENTANDO DJANGO
Asegurese de reemplazar
misitio.settings
por el
DJANGO_SETTINGS_MODULE
apropiado para tu sitio.
Esto le dice a Apache, Usa mod_python para cualquier URL en '/' o bajo ella, usando el manejado mod_python
DJANGO_SETTINGS_MODULE de modo que mod_python conoce que con guracin utilizar.
<Location> y no <Directory>. Esta ltima se utiliza para apuntar a lugares
de nuestra sistema de archivos, mientras que <Location> apunta a lugares en la estructura de la URL de un sitio web.
<Directory> no tendra sentido aqu.
de Django. Le pasa el valor de
Nota que estamos usando la directiva
Apache comunmente corre como un usuario diferente de tu usuario normal y puede tener una ruta y un sys.path
distintos. Puedes necesitar decirle a mod_python cmo encontrar tu proyecto y a Django mismo:
PythonPath "['/ruta/al/proyecto', '/ruta/a/django'] + sys.path"
Tambin puedes agregar directivas como PythonAutoReload O ` para ajustar la performance. Mira la documentacin de mod_python para un obtener un listado completo de opciones.
Ten en cuenta que deberias con gurar
PythonDebug Off
en un servidor de produccin. Si dejas
PythonDebug On,
tus usuarios vern feas trazas de error de Python si algo sale dentro de mod_python.
Reinicia Apache, y cualquier peticin a tu sitio (o a tu host virtual si pusiste las directivas dentro de un bloque
<VirtualHost>)
ser servida por Django.
Nota
Si implementas Django en un subdirectorio -- esto es, en algun lugar ms profundo que / -Django no recortar el pre jo de la URL para tu URLpatterns. Entonces, si tu con guracin de
Apache luce como esto:
<Location "/misitio/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE misitio.settings
PythonDebug On
</Location>
entonces todos tus patrones de URL debern comenzar con
"/misitio/".
Por esta razn es
que usualmente recomendamos implementar Django sobre la raiz de tu dominio o host virtual.
Alternativamente, simplemente puede hacer descender el nivel de tu URL usando una cua de
URLconf:
urlpatterns = patterns('',
(r'^misitio/', include('normal.root.urls')),
)
20.3.2.
Corriendo multiples instalaciones de Django en la misma instancia Apache
Es enteramente posible correr multiples instalaciones de Django en la misma instancia de Apache. Probablemente
quieras hacer esto si eres un desarrollador web independiente con multiples clientes pero un slo un nico servidor.
Para lograr esto, simplemente usa
VirtualHost
as:
NameVirtualHost *
<VirtualHost *>
ServerName www.ejemplo.com
# ...
SetEnv DJANGO_SETTINGS_MODULE misitio.settings
</VirtualHost>
<VirtualHost *>
ServerName www2.ejemplo.com
# ...
SetEnv DJANGO_SETTINGS_MODULE misitio.other_settings
</VirtualHost>
revisin 757 del 28 de julio de 2008
20.3. USANDO DJANGO CON APACHE Y MOD_PYTHON
Si necesitar poner dos instalaciones de Django sobre el mismo
231
VirtualHost,
necesitar prestar especial atencin
para asegurarte de que el cach de cdigo de mod_python no mezcle las cosas. Usa la directiva
para brindar diferentes directivas
<Location>
PythonInterpreter
a interpretes distintos:
<VirtualHost *>
ServerName www.ejemplo.com
# ...
<Location "/algo">
SetEnv DJANGO_SETTINGS_MODULE misitio.settings
PythonInterpreter misitio
</Location>
<Location "/otracosa">
SetEnv DJANGO_SETTINGS_MODULE misitio.other_settings
PythonInterpreter misitio_otro
</Location>
</VirtualHost>
Los valores de
PythonInterpreter
no importante realmente ya que se encuentran en dos bloques
Location
dife-
rentes.
20.3.3.
Corriendo un servidor de desarrollo con mod_python
Debido a que mod_python cachea el cdigo python cargado, cuando implemantas sitios Django sobre mod_python
necesitars reiniciar Apache cada vez que realizar cambios en tu cdigo. Esto puede ser tedioso, por lo que aqui compartimos un pequeo truco para evitarlo: simplemente agrega
MaxRequestsPerChild 1
a tu archivo de con guracin
para forzar a Apache a recargar todo con cada peticin. Pero no hagas esto en un servidor de produccin, o revocaremos
tus privilegios Django.
Si eres el tipo de programador que depuran dispersando sentencias
cuenta que
por el cdigo (nosotros somos), ten en
no tiene efectos sobre mod_python; estas no aparecen en el log de Apache como pudras esperar.
Si necesitas imprimir informacin de depuracin en una con guracin mod_python, probablemente quieras usar el
paquete de registro de eventos estndar de Python (Python's standard logging package). Hay ms informacin disponible en
http://docs.python.org/lib/module-logging.html.
Alternativamente, puedes agregar la informacin de
depuracin a las plantillas de tu pgina.
20.3.4.
Sirviendo Django y archivos multimedia desde la misma instancia Apache
Django no debera ser utilizado para servir archivos multimedia (imgen, audio, video, ash) por s mismo; mejor
deja ese trabajo al servidor web que hayas elegido. Recomendamos usar un servidor Web separado (es decir, uno que
no est corriendo a la vez Django) para servir estos archivos. Para ms informacin, mira la seccin Escalamiento.
Sin embargo, si no tienes opcin para servir los archivos multimedia que no sea el mismo
VirtualHost Apache que
usa Django, aqu te mostramos como desactivar mod_python para una parte particular del sitio:
<Location "/media/">
SetHandler None
</Location>
Cambia
Location
a la URL raiz donde se encuentran tus archivos.
Tambien puedes usar
<LocationMatch>
para comparar con una expresin regular. Por ejemplo, esto con gura
Django en la raiz del sitio pero deshabilitando Django para el subdirectorio
.jpg, .gif,
.png:
<Location "/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
</Location>
<Location "/media/">
SetHandler None
</Location>
revisin 757 del 28 de julio de 2008
media
y cualquier URL que termine en
232
CAPTULO 20. IMPLEMENTANDO DJANGO
<LocationMatch "\.(jpg|gif|png)$">
SetHandler None
</LocationMatch>
En todos estos casos, necesitars con gurar la directiva
DocumentRoot
para que Apache sepa dnde encontrar tus
archivos estticos.
20.3.5.
Manejo de errores
Cuando usas Apache/mod_python, los errores sern canalizados por Django -- en otras palabras, estos no se
propagan al nivel de Apache y no aparecern en el
error_log
del servidor.
La excepcin a esto sucede si algo est realmente desordenado en tu con guracin Django. En este caso, vers una
pgina Internal Server Error en tu navegador, y el volcado de error (traceback) de Python completo en tu archivo
error_log
de Apache. Este volcado de error se difunde por multiples lneas. (S, es feo y bastante difcil de leer, pero
as como mod_python hace las cosas).
20.3.6.
Manejando fallas de segmentacin
Algunas veces, Apache produce fallas de segmentacin (Segmentation faults, en ingls) cuando instalas Django.
Cuando esto sucede, se trata casi siempre de una o dos causas no muy relacionadas con Django en s:
Puede ser que tu cdigo Python est importando el mdulo
pyexpat (usado para parseo XML), lo que
puede entrar en con icto con la versin embebida en Apache. Para informacin detallada, revisa Expat
Causing Apache Crash en
http://www.djangoproject.com/r/articles/expat-apache-crash/.
Puede deberse a que ests corriendo mod_python y mod_php sobre la misma instancia de Apache,
con MySQL como motor de base de datos. En algunos casos, esto ocasiona un conocido problema
que mod_python tiene debido a con ictos de versin en PHP y el back-end MySQL de la base. Hay
informacin detallada en un listado FAQ de mod_python, accesible via
com/r/articles/php-modpython-faq/
http://www.djangoproject.
Si continuas teniendo problemas para con gurar mod_python, una buena cosa para hacer es poner un esqueleto de sitio sobre mod_python a funcionar, sin el framework Django. Esta es una manera fcil de aislar los problemas espec cos de mod_python. El artculo Getting mod_python Working detalla el procedimiento:
//www.djangoproject.com/r/articles/getting-modpython-working/.
http:
El siguiente paso debera ser editar tu cdigo de pruebas y agregar la importacin de cualquier cdigo espec co
de Django que estes usando -- tus vistas, tus modelos, tu URLconf, la con guracin de RSS, y as. Incluye estas
importaciones en tu funcin de gestin de pruebas, y accede a la URL correspondiente desde tu navegador. Si esto
causa un colapso, habrs con rmado que es la importacin de cdigo Django la causa del problema. Gradulamente
reduce el conjunto de importaciones hasta que el colapso desaparezca, de manera de encontrar el mdulo espec co
que es el culpable. Profundiza en los mdulos y revisa sus importaciones si es necesario. Para ms ayuda, herramientas
de sistema como
ldconfig
en Linux,
otool
en Mac OS, y
ListDLLs
(de SysInternals) en Windows pueden ayudarte
a indenti car dependencias compartidas y posibles con ictos de version.
20.4.
Usando Django con FastCGI
Aunque Django bajo Apache y mod_python es la con guracin ms robusta de implementacin, mucha gente usa
hosting compartido, en los que FastCGI es la nica opcin de implementacin.
Adicionalmente, en algunas situaciones, FastCGI permite mayor seguridad y posiblemente una mejor performance
que mod_python. Para sitios pequeos, FastCGI adems puede ser ms liviano que Apache.
20.4.1.
Descripcin de FastCGI
FastCGI es una manera e ciente de dejar que una aplicacin externa genere pginas para un servidor Web. El
servidor delega las peticiones Web entrantes (a travs de un socket) a FastCGI, quien ejecuta el cdigo y devuelve la
respuesta al servidor, quien, a su turno, la remitir al navegador del cliente.
Como mod_python, FastCGI permite que el cdigo permanezca en memoria, logrando que las peticiones sean
servidas sin tiempo de inicializacin. A diferencia de mod_python, un proceso FastCGI no corre dentro del proceso
del servidor Web, sino en un proceso separado y persistente.
revisin 757 del 28 de julio de 2008
20.4. USANDO DJANGO CON FASTCGI
233
Por qu ejecutar cdigo en un proceso separado?
Los mdulos tradicionales
mod_*
en Apache embeben varios lenguajes de scripting (los ms no-
tables son PHP, Python/mod_python, y Perl/mod_perl) dentro del espacion de procesos de tu
servidor Web. A pesar de que esto reduce el tiempo de inicio (porque el cdigo no tiene que ser
ledo del disco para cara consulta), lo hace al costo de ocupar espacio en memoria.
Cada proceso Apache consigue una copia completa del motor de Apache, con todas las caractersticas de Apache que Django simplemente no aprovecha. Los procesos FastCGI, por otro lado,
solo tienen el overhead de memoria de Python y Django.
Debido a la naturaleza de FastCGI, tambin es posible tener procesos ejecutando bajo una cuenta
de usuario diferente de la del proceso del servidor Web. Este es un buen bene cio de seguridad es
sistemas compartidos, dado que signi ca que puedes asegurar tu cdigo de otros usuarios.
Antes de que puedas empezar a usar FastCGI con Django, necesitas instalar
flup,
una biblioteca Python para
flup, por lo cual
http://www.djangoproject.com/r/flup/.
manejar FastCGI. Algunos usuarios han reportado pginas que explotaron con versiones antiguas de
puedes querer utilizar la ltima versin SVN. Puedes conseguir
20.4.2.
flup
en
Ejecutando tu Servidor FastCGI
FastCGI opera sobre un modelo cliente/servidor, y en la mayora de los casos estars iniciando el proceso servidor
FastCGI por tu cuenta. Tu servidor Web (ya sea Apache, lighttpd, o algn otro) hace contacto con tu proceso DjangoFastCGI solo cuando el servidor necesita cargar una pgina dinmica. Como el demonio ya est ejecutando su cdigo
en memoria, puede servir la respuesta muy rpido.
Nota
Si ests en un sistema de hosting compartido, probablemente ests forzado a usar procesos FastCGI
manejados por el Web server. Si ests en esta situacin, debes leer la seccin titulada Ejecutando
Django en un proveedor de Hosting compartido con Apache, ms abajo.
Un servidor Web puede conectarse a un servidor FastCGI de dos formas: usando un socket de dominio Unix, (un
named pipe en sistemas Win32) o un socket TCP. Lo que elijas es una cuestin de preferencias; usualmente un socket
TCP es ms fcil debido a cuestiones de permisos.
Para iniciar tu servidor, primero cambia al directorio de tu proyecto (donde est tu
con el comando
runfcgi:
manage.py), y ejecuta manage.py
./manage.py runfcgi [options]
Si especi cas
help como nica opcin despus de runfcgi, se mostrar una lista de todas las opciones disponibles.
socket o si no host y port. Entonces, cuando con gures tu servidor Web, solo necesitas
Necesitars especi car un
apuntarlo al socket o host/port que especi caste cuando iniciaste el servidor FastCGI.
Algunos ejemplos pueden ayudar a explicarlo:
Ejecutar un servidor 'threaded' en un puerto TCP:
./manage.py runfcgi method=threaded host=127.0.0.1 port=3033
Ejecutar un servidor preforked sobre un socket de dominio Unix:
./manage.py runfcgi method=prefork socket=/home/user/mysite.sock pidfile=django.pid
Ejecutar sin demonizar (ejecutar en segundo plano) el proceso (es bueno para el debugging):
./manage.py runfcgi daemonize=false socket=/tmp/mysite.sock
Detener el Demonio FastCGI
Si tienes el proceso ejecutando en primer plano, es fcil detenerlo: simplemente presiona Ctrl+C para detenerlo y
salir del servidor FastCGI. Si ests tratando con procesos en segundo plano, necesitars recurrir al comando
Unix.
Si especi cas la opcin
pidfile
en
manage.py runfcgi,
kill
de
puedes detener el demonio FastCGI en ejecucin de esta
forma:
kill `cat $PIDFILE`
revisin 757 del 28 de julio de 2008
234
CAPTULO 20. IMPLEMENTANDO DJANGO
donde
$PIDFILE
es el
pidfile
que especi caste.
Para reiniciar con facilidad tu demonio FastCGI en Unix, pedes usar este breve script en la lnea de comandos:
#!/bin/bash
# Replace these three settings.
PROJDIR="/home/user/myproject"
PIDFILE="$PROJDIR/mysite.pid"
SOCKET="$PROJDIR/mysite.sock"
cd $PROJDIR
if [ -f $PIDFILE ]; then
kill `cat -- $PIDFILE`
rm -f -- $PIDFILE
fi
exec /usr/bin/env - \
PYTHONPATH="../python:.." \
./manage.py runfcgi socket=$SOCKET pidfile=$PIDFILE
20.4.3.
Usando Django con Apache y FastCGI
Para usar Django con Apache y FastCGI, necesitars que Apache est instalado y con gurado, con mod_fastcgi ins-
talado y habilitado. Consulta la documentacin de Apache y mod_fastcgi para instrucciones detalladas: http://www.djangoproject.co
Una vez que hayas completado la con guracin, apunta Apache a tu instancia FastCGI de Django editando el
archivo
httpd.conf
(de la con guracin de Apache). Necesitars hacer dos cosas:
FastCGIExternalServer para especi car la localizacin de
mod_rewrite para apuntar las URLs a FastCGI segn sea necesario.
Usar la directiva
Usar
tu servidor FastCGI.
Especi cando la Localizacin del Servidor FastCGI
La directiva
FastCGIExternalServer
le dice a Apache como encontrar tu servidor FastCGI. Como se explica en
los documentos de FastCGIExternalServer (http://www.djangoproject.com/r/mod_fastcgi/FastCGIExternalServer/),
puedes especi car un
socket
o un
host.
Aqu hay ejemplos de ambos:
# Connect to FastCGI via a socket/named pipe:
FastCGIExternalServer /home/user/public_html/mysite.fcgi -socket /home/user/mysite.sock
# Connect to FastCGI via a TCP host/port:
FastCGIExternalServer /home/user/public_html/mysite.fcgi -host 127.0.0.1:3033
En los dos casos, el directorio /home/user/public_html/ debe existir, aunque el archivo
/home/user/public_html/mysite.fcgi
no necesariamente tiene que existir. Es solo una URL usada por el servidor Web internamente -- un enganche para
indicar que las consultas en esa URL deben ser manejadas por FastCGI. (Ms sobre esto en la siguiente seccin.)
Usando mod_rewrite para apuntar URLs hacia FastCGI
El segundo paso es decirle a Apache que use FastCGI para las URLS que coincidan con cierto patrn. PAra hacer
esto, usa el mdulo mod_rewrite y reescribe las URLs hacia
FastCGIExternalServer,
mysite.fcgi
(o donde hayas especi cado en la directiva
como se explic en la seccin anterior).
En este ejemplo, le decimos a Apache que use FastCGI para manejar cualquier consulta que no represente un
archivo del sistema de archivos y no empiece con
/media/. Probablemente ste sea el caso ms comn, si ests usando
el sitio de administracin de Django:
<VirtualHost 12.34.56.78>
ServerName example.com
DocumentRoot /home/user/public_html
Alias /media /home/user/python/django/contrib/admin/media
RewriteEngine On
RewriteRule ^/(media.*)$ /$1 [QSA,L]
revisin 757 del 28 de julio de 2008
20.4. USANDO DJANGO CON FASTCGI
235
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mysite.fcgi/$1 [QSA,L]
</VirtualHost>
20.4.4.
FastCGI y lighttpd
lighttpd (http://www.djangoproject.com/r/lighttpd/) es un servidor Web liviano usado habitualmente para
servir archivos estticos. Admite FastCGI en forma nativa y por lo tanto es tambin una opcin ideal para servir tanto
pginas estticas como dinmicas, si tu sitio no tiene necesidades espec cas de Apache.
mod_fastcgi est en tu lista de modulos, en algn lugar despus de mod_rewrite y mod_access,
mod_accesslog. Probablemente desees tambin mod_alias, para servir medios de administracin.
Asegrate que
antes de
Agrega lo siguiente a tu archivo de con guracin de lighttpd:
server.document-root = "/home/user/public_html"
fastcgi.server = (
"/mysite.fcgi" => (
"main" => (
# Use host / port instead of socket for TCP fastcgi
# "host" => "127.0.0.1",
# "port" => 3033,
"socket" => "/home/user/mysite.sock",
"check-local" => "disable",
)
),
)
alias.url = (
"/media/" => "/home/user/django/contrib/admin/media/",
)
url.rewrite-once = (
"^(/media.*)$" => "$1",
"^/favicon\.ico$" => "/media/favicon.ico",
"^(/.*)$" => "/mysite.fcgi$1",
)
Ejecutando Mltiples Sitios Django en Una Instancia lighttpd
lighttpd te permite usar con guracin condicional para permitir la con guracin personalizada para cada host.
Para especi car mltiples sitios FastCGI, solo agrega un bloque condicional en torno a tu con guracin FastCGI para
cada sitio:
# If the hostname is 'www.example1.com'...
$HTTP["host"] == "www.example1.com" {
server.document-root = "/foo/site1"
fastcgi.server = (
...
)
...
}
# If the hostname is 'www.example2.com'...
$HTTP["host"] == "www.example2.com" {
server.document-root = "/foo/site2"
fastcgi.server = (
...
)
...
}
Puedes tambin ejecutar mltiples instalaciones de Django en el mismo sitio simplemente especi cando mltiples
entradas en la directiva
fastcgi.server.
Agrega un host FastCGI para cada una.
revisin 757 del 28 de julio de 2008
236
CAPTULO 20. IMPLEMENTANDO DJANGO
20.4.5.
Ejecutando Django en un Proveedor de Hosting Compartido con Apache
Muchos proveedores de hosting compartido no te permiten ejecutar tus propios demonios servidores o editar el
archivo
httpd.conf.
En estos casos, an es posible ejecutar Django usando procesos iniciados por el sevidor Web.
Nota
Si ests usando procesos iniciados por el servidor Web, como se explica en esta seccin, no
necesitas iniciar el servidor FastCGI por tu cuenta. Apache iniciar una cantidad de procesos,
escalando segn lo necesite.
En el directorio raz de tu Web, agrega esto a un archivo llamado
.htaccess
AddHandler fastcgi-script .fcgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]
Despus, crea un pequeo script que le diga a Apache como iniciar tu programa FastCGI. Crea un archivo
mysite.fcgi,
colcalo en tu directorio Web, y asegrate de hacerlo ejecutable:
#!/usr/bin/python
import sys, os
# Add a custom Python path.
sys.path.insert(0, "/home/user/python")
# Switch to the directory of your project. (Optional.)
# os.chdir("/home/user/myproject")
# Set the DJANGO_SETTINGS_MODULE environment variable.
os.environ['DJANGO_SETTINGS_MODULE'] = "myproject.settings"
from django.core.servers.fastcgi import runfastcgi
runfastcgi(method="threaded", daemonize="false")
Reiniciando el Server Iniciado
Si cambias cualquier cdigo Python en tu sitio, necesitars decirle a FastCGI que el cdigo ha cambiado. Pero no
hay necesidad de reiniciar Apache en este caso the. Slo volver a subir
mysite.fcgi -- o editar el archivo -- de manera
que la fecha y hora del archivo cambien. Cuando Apache ve que el archivo ha sido actualizado, reiniciar tu aplicacin
Django por ti.
Si tienen acceso a la lnea de comandos en un sistema Unix system, puedes hacer esto fcilmente usando el comando
touch:
touch mysite.fcgi
20.5.
Escalamiento
Ahora que sabes como tener a Django ejecutando en un servidor simple, veamos como puedes escalar una instalacin
Django. Esta seccin explica como puede escalar un sitio desde un servidor nico a un cluster de gran escala que pueda
servir millones de hits por hora.
Es importante notar, sin embargo, que cada sitio grande es grande de diferentes formas, por lo que escalar es
cualquier cosa menos una operacin de una solucin nica para todos los casos. La siguiente cobertura debe ser
su ciente para mostrat el principio general, y cuando sea posible, trateremos de sealar donde se puedan elegir
distintas opciones.
Primero, haremos una buena presuposicin, y hablaremos exclusivamente acerca de escalamiento bajo Apache y
mod_python. A pesar de que conocemos vario casos exitosos de desarrollos FastCGI medios y grandes, estamos mucho
ms familiarizados con Apache.
revisin 757 del 28 de julio de 2008
20.5. ESCALAMIENTO
20.5.1.
237
Ejecutando en un Servidor nico
LA mayora de los sitios empiezan ejecutando en un servidor nico, con una arquitectura que se ve como en la
Figura 20-1.
Figura 20.1: con guracin de Django en un servidor nico .
Esto funciona bien para sitios pequeos y medianos, y es relativamente barato -- puedes instalar un servidor nico
diseado para Django por menos de 3,000 dlares.
Sin embargo, a medida que el tr co se incemente, caers rpidamente en contencin de recursos entre las diferentes
piezas de software. Los servidores de base de datos y los servidores Web adoran tener el servidor entero para ellos, y
cuando corren en el mismo servidos siempre terminan peleando por los mismos recursos (RAM, CPU) que pre eren
monopolizar.
Esto se resuelve fcilmente moviendo el servidor de base de datos a una segunda mquina, como se explica en la
siguiente seccin.
20.5.2.
Separando el Servidor de Bases de Datos
En lo que tiene que ver con Django, el proceso de separar el servidor de bases de datos es extremadamente sencillo:
simplemente necesitas cambiar la con guracin de
DATABASE_HOST a la IP o nombre DNS de tu servidor. Probablemente
sea una buena idea usar la IP si es posible, ya que depender de la DNS para la conexin entre el servidor Web y el
servidor de bases de datos no se recomienda.
Con un servidor de base de datos separado, nuestra arquitectura ahora se ve como en la Figura 20-2.
Aqui es donde empezamos a movernos hacia lo que usualmente se llama arquitectura n-tier. No te asustes por la
terminiloga -- slo se re ere al hecho de que diferentes tiers de la pila Web separadas en diferentes mquinas fsicas.
A esta altura, si anticipas que en algn momento vas a necesitar crecer ms all de un servidor de base de datos
nico, probablemente sea una buena idea empezar a pensar en pooling de conexiones y/o replicacin de bases de datos.
Desafortunadamente, no hay su ciente espacio para hacerle justicia a estos temas en este libro, as que vas a necesitar
consultar la documentacin y/o a la comunidad de tu base de datos para ms informacin.
20.5.3.
Ejecutando un Servidor de Medios Separado
An tenemos un gran problema por delante desde la con guracin del servidor nico: el servicio de medios desde
la misma caja que maneja el contenido dinmico.
Estas dos actividades tienen su mejor performance bajo distintas circunstancias, y encerrndolas en la misma caja
terminars con que ninguna de las dos tendr particularmente buena performance. As que el siguiente paso es separar
los medios -- esto es, todo lo que no es generado por una vista de Django -- a un servidor dedicado (ver Figura 20-3).
revisin 757 del 28 de julio de 2008
238
CAPTULO 20. IMPLEMENTANDO DJANGO
Figura 20.2: Moviendo la base de datos a un servidor dedicado.
Figura 20.3: Separando el servidor de medios.
revisin 757 del 28 de julio de 2008
20.5. ESCALAMIENTO
239
Idealmente, este servidor de medios debera correr un servidor Web desnudo, optimizado para la entrega de me-
dios estticos. lighttpd y tux (http://www.djangoproject.com/r/tux/) son dos excelentes elecciones aqu, pero un
servidor Apache bien 'pelado' tambin puede funcionar.
Para sitios pesados en contenidos estticos (fotos, videos, etc.), moverse a un servidor de medios separado es
doblemente importante y debera ser el primer paso en el escalamiento hacia arriba.
De todos modos, este paso puede ser un poco delicado. El administrador de Django necesita poder escribir medios
'subidos' en el servidor de medios. (la con guracin de
MEDIA_ROOT
controla donde se esciben estos medios). Si un
medio habita en otro servidor, de todas formas necesitas organizar una forma de que esa escritura se pueda hacer a
traves de la red.
La manera ms fcil de hacer esto es usar el NFS para montar los directorios de medios del servidor de medios en
el servidor Web (o los servidores Web). Si los montas en la misma ubicacin apuntada por
MEDIA_ROOT,
el uploading
de medios Simplemente Funciona.
20.5.4.
Implementando Balance de Carga y Redundancia
A esta altura, ya hemos separado las cosas todo lo posible. Esta con guracin de tres servers debera manejar una
cantidad muy grande de tr co -- nosotros servimos alrededor de 10 millones de hits por da con una arquitectura de
este tipo-- as que si creces ms all, necesitars empezar a agregar redundancia.
Actualmente, esto es algo bueno. Una mirada a la Figura 20-3 te permitir cer que si falla aunque sea uno solo
de los servidores, el sitio entero se cae. Asi que a medida que agregas servidores redundantes, no slo incrementas
capacidad, sino tambin con abilidad.
Para este ejemplo, asumamos que el primero que se ve superado en capacidad es el servidor Web. Es fcil tener
mltiples copias de un sitio Djando ejecutando en diferente hardware. -- simplemente copia el cdigo en varias mquinas,
y inicia Apache en cada una de ellas.
Sin embargo, necesitas otra pieza de software para distribuir el tr co entre los servidores: un balanceador de carga.
Puedes comprar balanceadores de carga por hardware caros y propietarios, pero existen algunos balanceadores de
carga por software de alta calidad que son open source.
mod_proxy de Apache es una opcin, pero hemos encontrado que Perlbal (http://www.djangoproject.com/r/
perlbal/) es simplemente fantstico. Es un balanceador de carga y proxy inverso escrito por las mismas personas que
escribieron memcached (ver Captulo 13).
Nota
Si ests usando FastCGI, puedes realizar este mismo paso distribucin y balance de carga separando
los servidores Web front-end y los procesos FastCGI back-end en diferentes mquinas. El servidor
front-end se convierte esencialmente en el balanceador de carga, y los procesos FastCGI back-end
reemplaza a los servidores Apache/mod_python/Django.
Con los servidores Web en cluster, nuestra arquitectura en evolucin empieza a verse ms compleja, como se ve en
la Figura 20-4.
Observar que en el diagrama nos referimos a los servidores Web como el cluster para indicar que el numero de
servidores basicamente es variable. Una vez que tienes un balanceador de carga en el frente, pueder agregar y eliminar
servidores Web back-end sin perder un segundo fuera de servicio.
20.5.5.
Yendo a lo grande
En este punto, los siguientes pasos son derivaciones del ltimo:
A menida que necesites ms performance en la base de datos, necesitars agregar servidores de base
de datos relicados. MySQL tiene replicacin incorporada; los usuarios de PostgreSQL deberan mirar
a Slony (http://www.djangoproject.com/r/slony/) y pgpool (http://www.djangoproject.com/
r/pgpool/)
para replicacin y pooling de conexiones, respectivamente.
Si un solo balanceador de carga no es su ciente, puedes agregar ms mquinas balanceadoras de carga
y distribuir entre ellas usando DNS round-robin.
Si un servidor nico de medios no es su ciente, puedes agregar ms servidores de medios y distribuir
la carga con tu cluster de balanceadores de carga.
Si necesitas ms almacenamiento cache, puedes agregar servidores de cache dedicados.
En cualquier etapa, si un cluster no tiene buena performance, puedes agregar ms servidores al cluster.
revisin 757 del 28 de julio de 2008
240
CAPTULO 20. IMPLEMENTANDO DJANGO
Figura 20.4: Con guracin de un server redundante con balance de carga.
revisin 757 del 28 de julio de 2008
20.5. ESCALAMIENTO
241
Figura 20.5: Un ejemplo de con guracin de Django de gran escala.
revisin 757 del 28 de julio de 2008
242
CAPTULO 20. IMPLEMENTANDO DJANGO
Despus de algunas de estas iteraciones, una arquitectura de gran escala debe verse como en la Figura 20-5.
A pesar de que mostramos solo dos o tres servidores en cada nivel, no hay un lmite fundamental a cuantos puedes
agregar.
Una vez que haz llegado a este nivel, te quedan pocas opciones. El Apndice A tiene alguna informacin proveniente
de desarrolladores responsables de algunas instalaciones Django de gran escala. Si ests plani cando un sitio Django
de alto tr co, es una lectura recomendada.
20.6.
Ajuste de Performance
Si tienes grandes cantidades de dinero, simplemente puedes irle arrojando hardware a los problemas de escalado.
Para el resto de nosotros, sin embargo, el ajuste de performance es una obligacin.
Nota
Incidentalmente, si alguien con monstruosas cantidades de dinero est leyendo este libro, por favor
considere una donacin sustancial al proyecto Django. Aceptamos diamantes en bruto y lingotes
de oro.
Desafortunadamente, el ajuste de performance es ms un arte que una ciencia, y es aun ms di cil de escribir sobre
eso que sobre escalamiento. Si ests pensando seriamente en desplegar una aplicacin Django de gran escala, debers
pasar un un buen tiempo aprendiendo como ajustar cada pieza de tu stack.
Las siguientes secciones, sin embargo, presentan algunos tips espec cos del ajuste de performance de Django que
hemos descubiero a traves de los aos.
20.6.1.
No hay tal cosa como demasiada RAM
Cuando escribimos esto, la RAM realmente cara cuesta aproximadamente 200 dlares por gigabyte -- moneditas
comparado con el tiempo empleado en ajustes de performance. Compra toda la RAM que puedas, y despus compra
un poco ms.
Los procesadores ms rpidos no mejoran la performance tanto. La mayora de los servidores Web desperdician el
90 % de su tiempo esperando I/O del disco. En cuanto empieces a swappear, la performance directamente se muere.
Los discos ms rpidos pueden ayudar levemente, pero son mucho ms caros que la RAM, as que no cuentan.
Si tienes varios servidores, el primer lugar donde poner tu RAM es en el servidor de base de datos. Si puedes,
compra su ciente ram como para tener toda tu base de datos en memoria. Esto no es tan difcil. La base de datos de
LJWorld.com -- que incluye medio milln de artculos desde 1989 -- tiene menos de 2 GB.
Despus, maximiza la RAM de tu servidor Web. La situacin ideal es aquella en la que ningn servidor swapea -nunca. Si llegas a ese punto, debes poder manejar la mayor parte del tr co normal.
20.6.2.
Deshabilita Keep-Alive
Keep-Alive
es una caracterstica de HTTP que permite que mltiples pedidos HTTP sean servidos sobre una
conexin TCP nica, evitando el overhead de conectar y desconectar.
Esto parece bueno a primera vista, pero puede asesinar al performance de un sitio Django. Si ests sirviendo medios
desde un servidor separado, cada usuario que est navegando tu sitio solo requerir una pgina del servidor Django
cada diez segundos aproximadamente. Esto deja a los servidores HTTP esperando el siguiente pedido keep-alive, y un
servidor HTTP ocioso consume RAM que debera estar usando un servidor activo.
20.6.3.
Usa memcached
A pesar de que Django admite varios back-ends de cache diferentes, ninguno de ellos siquiera se acerca a ser
tan rpido como memcached. Si tienes un sitio con tr co alto, ni pierdas tiempo con los otros -- ve directamente a
memcached.
20.6.4.
Usa memcached siempre
Por supuesto, seleccionar memcached no te hace mejor si no lo usas realmente. El Captulo 13 es tu mejor amigo
aqu: aprende como usar el framework de cache de Django, y usalo en todas partes que te sea posible. Un uso de cache
agresivo y preemptico es usualmente lo nico que se puede hacer para mantener un sitio funcionando bajo el mayor
tr co.
revisin 757 del 28 de julio de 2008
20.7. QU SIGUE?
20.6.5.
243
nete a la Conversacin
Cada pieza del stack de Django -- desde Linux a Apache a PostgreSQL o MySQL -- tiene una comunidad maravillosa
detrs. Si realmente quieres obtener ese ltimo 1 % de tus servidores, nete a las comunidades open source que estn
detrs de tu software y pide ayuda. La mayora de los miembros de la comunidad del software libre estarn felices de
ayudar.
Y tambin asegrate de unirte a la comunidad Django. Tus humildes autores son solo dos miembros de un grupo increblemente activo y creciente de desarrolladores Django. Nuestra comunidad tiene una enorme cantidad de
experiencia colectiva para ofrecer.
20.7.
Qu sigue?
Has alcanzado el nal de nuestro programa regular. Los siguientes apndices contienen material de referencia que
puedes necesitar a medida que trabajes sobre tus proyectos Django
Te deseamos la mejor de las suertes en la puesta en marcha de tu sitio Django, ya sea un pequeo juguete para t
o el prximo Google.
revisin 757 del 28 de julio de 2008
244
CAPTULO 20. IMPLEMENTANDO DJANGO
revisin 757 del 28 de julio de 2008
Apndice A
Casos de estudio
Para ayudar a responder las preguntas acerca de cmo funciona Django en el mundo real, hablamos (bueno, nos
escribimos) con un puado de personas que tienen sitios completos y funcionales desarrollados en Django. La mayor
parte de este apndice son sus palabras, que han sido ligeramente editadas para mayor claridad.
A.1.
Elenco
Conozcamos a nuestros personajes y sus proyectos.
Ned Batchelder es el ingeniero principal de Tabblo.com. Tabblo comenz su vida como una herramienta
para contar historias basadas en fotos compartidas, pero recientemente fue comprado por HewlettPackard para propsitos de mayor alcance:
HP vio valor real en nuestro estilo de desarrollo web, y en la forma en que tendimos puentes
entre el mundo virtual y el mundo fsico. Nos adquirieron de modo que pudiramos llevar esa
tecnologa a otros sitios en la Web. Tabblo.com todava es un gran sitio para contar historias,
pero ahora tambin estamos trabajando en separar componentes y reutilizar las piezas ms
importantes de nuestra tecnologa.
Johannes Beigel es uno de los principales desarrolladores en Brainbot Technologies AG. El sitio
Django ms orientado al pblico de Brainbot es
http://pediapress.com/, donde se pueden solicitar
versiones impresas de artculos de Wikipedia. El equipo de Johannes actualmente est trabajando en
un programa de gestin de conocimiento para empresas conocido como Brain ler.
Johannes nos cuenta que Brain ler
[...] es una solucin de software para gestionar, buscar, categorizar y compartir informacin
de fuentes distribuidas. Est construido para el uso empresarial tanto en entornos de intranet
como internet y es altamente escalable y personalizable. El desarrollo de los conceptos y componentes medulares comenz en el 2001. Recientemente hemos rediseado/reimplementado
el servidor y el cliente web, que [ahora] est basado en Django.
David Cramer es el desarrollador principal de Curse, Inc. l desarroll Curse.com, un sitio para
devotos a los videojuegos multijugador masivos como World of Warcraft, Ultima Online, y otros.
Curse.com es uno de los sitios sobre Django ms grandes de Internet:
Tenemos aproximadamente entre 60 y 90 millones de visitas a la pgina en promedio por mes,y
tuvimos picos de ms de 130 millones de visitas (en un mes) usando Django. Somos un sitio
web muy dinmico y orientado al usuario espec camente enfocado en juegos multijugador
masivos, y uno de los sitios web ms grandes acerca de World of Warcraft globalmente.
Nuestro sitio web se estableci a principios de 2005, y desde nales de 2006 nos hemos estado
expandiendo a juegos ms all de World of Warcraft.
Christian Hammond es un ingeniero senior en VMware (un desarrollador lder de software de virtua-
lizacin). Tambin es el desarrollador principal de Review Board (http://www.review-board.org/),
un sistema de revisin de cdigo basado en Web. Review Board naci como un proyecto interno de
VMware, pero ahora es open source:
A nales de 2006, David Trowbridge y yo discutamos el proceso que usabamos en VMware
para manejar la revisin de cdigo. Antes de que la gente enviara cdigo al repositorio, se
revisin 757 del 28 de julio de 2008
246
APNDICE A. CASOS DE ESTUDIO
supona que enviaran un di de los cambios a una lista de correo para ser revisado. Todo
se manejaba por email, y por supuesto, se volvi difcil seguir las revisiones que necesitaban
mayor atencin. Fue entonces que comenzamos a discutir potenciales soluciones para este
problema.
En vez de escribir mis ideas, las puse en cdigo. En poco tiempo, naci Review Board. Review
Board ayuda a los desarrolladores, contribuidores y revisores a seguir la evolucin del cdigo
propuesto a revisin y a mejorar la comunicacin entre unos y otros. En vez de hacer una vaga
referencia a una parte del cdigo en un email, el revisor puede comentar directamente sobre
el cdigo. El cdigo, junto a los comentarios, aparecer entonces en las revisiones, dando a los
desarrolladores su ciente contexto para trabajar ms rpidamente en los cambios que hagan
falta.
Review Board creci rpidamente en VMware. De hecho, mucho ms rpido de lo esperado. En
unas pocas semanas, tuvimos diez equipos usando Review Board. Sin embargo, este proyecto
no es interno para VMware. Se decidi desde el da uno que debera ser open source y estar
disponible para ser usado por cualquier compaa o proyecto.
Hicimos un anuncio de open source y habilitamos el sitio conjuntamente, que est disponible en
http://www.review-board.org/.
La respuesta a nuestro anuncio pblico fue tan
impresionante como nuestro anuncio interno a VMware. En poco tiempo, nuestro servidor de
demostracin recibi ms de 600 usuarios, y la gente comenz a contribuir al proyecto en s.
Review Board no es la nica herramienta de revisin de cdigo del mercado, pero es la
primera que hemos visto que es abierta y tiene el extenso conjunto de caractersticas en el
que hemos trabajado para que incluya. Esperamos que esto repercuta en bene cios de tiempo
para muchos proyectos (open source o no).
A.2.
Por qu Django?
Le preguntamos a cada desarrollador por qu decidi usar Django, qu otras opciones fueron consideradas, y cmo
se tom la decisin de nitiva de usar Django.
Ned Batchelder :
Antes de unirme a Tabblo, Antonio Rodriguez (fundador/CTO de Tabblo) hizo una evaluacin de Rails
y Django, y encontr que ambos provean un gran ambiente de desarrollo rpido quick-out-of-the-blocks.
Comparando ambos, encontr que Django tena una mayor profundidad tcnica que hara ms fcil construir
un sitio robusto y escalable. Tambin, el que Django est basado en Python signi c que tendramos toda
la riqueza del ecosistema Python para soportar nuestro trabajo. Esto de nitivamente qued demostrado a
medida que construimos Tabblo.
Johannes Beigel :
Como hemos estado codi cando en Python por muchos aos ya, y rpidamente comenzamos a usar el
framework Twisted, Nevow era la solucin ms natural para resolver nuestras aplicaciones web. Pero pronto
nos dimos cuenta que -- a pesar de la integracin perfecta con Twisted -- muchas cosas eran un poco
incmodas de realizar dentro de nuestros procesos de desarrollo gil.
Luego de investigar un poco en Internet, nos qued claro que Django era el framework de desarrollo web
ms prometedor para nuestros requerimientos.
Lo que nos condujo a Django fue la sintaxis de sus templates, pero pronto apreciamos todas las otras
caractersticas que estaban incluidas, y as fue que compramos rpidamente a Django.
Despus de algunos aos de desarrollo e implementacin en paralelo de sistemas (Nevow todava est
en uso para algunos proyectos en sitios de clientes), llegamos a la conclusin de que Django es mucho
menos incmodo, resultando en un cdigo mucho mejor para mantener, y que es mucho ms divertido para
trabajar.
David Cramer :
Escuch sobre Django en el verano de 2006, momento en que estabamos listos para hacer un reacondicionamiento de Curse, y decidimos investigarlo. Quedamos muy impresionado de lo que poda hacer, y todos
los aspectos donde poda ahorrarnos tiempo. Lo conversamos y al decidirnos por Django comenzamos a
escribir la tercera revisio del sitio web casi inmediatamente.
revisin 757 del 28 de julio de 2008
A.3. COMENZANDO
247
Christian Hammond :
Haba jugado con Django en un par de pequeos proyectos y qued muy impresionado con l. Est basado
en Python, del que soy un gran fantico, y esto lo hace fcil no slo para desarrollar sitios y aplicaciones
web, sino que tambin mantiene el trabajo organizado y mantenible. Esto siempre es un problema en PHP
y Perl. Basado en experiencias del pasado, no necesit pensar mucho para meterme con Django.
A.3.
Comenzando
Como Django es una herramienta relativamente nueva, no hay muchos desarrolladores experimentados ah afuera
que lo dominen ampliamente. Le preguntamos a nuestro panel cmo consiguieron que su equipo adquiriese velocidad
con Django y qu consejos querran compartir con nuevos desarrolladores Django.
Johannes Beigel :
Luego de programar principalmente en C++ y Perl, nos cambiamos a Python y continuamos usando C++
para el cdigo computacionalmente intensivo.
[Aprendimos Django mientras] trabajamos con el tutorial, navegando la documentacin para obtener una
idea de lo que es posible (es fcil perderse muchas caracterstica si slo se sigue el tutorial), e intentando
comprender los conceptos bsicos detrs del middleware, objetos request, modelos de base de datos, etiquetas de plantillas, ltros personalizados, los formularios, autorizacin, localizacin... Luego podramos
revisar ms profundamente esos tpicos cuando realmente los necesitramos.
David Cramer :
La documentacin del sitio web es grandiosa. Pgate a ella.
Christian Hammond :
David y yo tenamos una experiencia previa con Django, aunque era limitada. Hemos aprendido mucho
mientras desarrollbamos Review Board. Le aconsejara a los nuevos usuarios que lean la tan bien escrita
documentacin de Django y el libro que ahora estn leyendo, ya que ambos han sido inestimables para
nosotros.
No tuvimos que sobornar a Christian para conseguir esa declaracin -- lo juramos!
A.4.
Portando cdigo existente
Aunque Review Board y Tabblo fueron desarrollos desde cero, los otros sitios fueron portados desde cdigo ya
existente. Estbamos interesados en escuchar fue ese proceso.
Johannes Beigel :
Comenzamos a migrar el sitio desde Nevow, pero pronto nos dimos cuenta de que queramos cambiar
tantos aspectos conceptuales (tanto en la interfaz de usuario como en la parte del servidor de aplicacin)
que empezamos todo de nuevo usando el cdigo que tenamos meramente como una referencia.
David Cramer :
El sitio anterior estaba escrito en PHP. Ir de PHP a Python fue grandioso programticamente. El nico
detalle es que hay que tener mucho ms cuidado con la gestin de memoria [ya que los procesos Django
permanecen mucho ms tiempo que los procesos PHP (que son simples ciclos)].
A.5.
Cmo les fue?
Ahora la pregunta del milln: Cmo los trat Django? Estabamos especialmente interesados en escuchar dnde
Django perdi fuerza -- es importante conocer en que aspectos tus armas son dbiles antes de usarlas en la barricada.
Ned Batchelder :
Django realmente nos permiti experimentar con las funcionalidades de nuestro sitio web. Tanto antes como
una startup en busca del calor de clientes y negocios, como ahora como parte de HP y trabajando con un
nmero de socios, tuvimos que ser muy giles cuando hubo que adaptar el software a nuevas demandas.
revisin 757 del 28 de julio de 2008
248
APNDICE A. CASOS DE ESTUDIO
La separacin de la funcionalidad en modelos, vistas y controladores nos brind una modularidad que
permiti elegir apropiadamente dnde extender y modi car. El ambiente Python de trasfondo nos dio la
oportunidad de utilizar bibliotecas existentes para resolver problemas sin reinventar la rueda. PIL, PDFlib,
ZSI, JSmin, y BeautifulSoup son slo un puado de bibliotecas que agregamos para hacer algunas tareas
que eran engorrosas para nosotros.
La parte ms difcil del nuestro uso de Django ha sido la relacin entre los objetos de memoria y lo objetos
de la base de datos, de algunas maneras. Primero, el Mapeo Objeto-relacional (ORM) de Django no asegura
que dos referencias a la misma entrada en la base de datos sean el mismo objeto Python, por lo que puedes
verte en situaciones donde dos partes del cdigo intentan modi car la misma entrada y una de las copias
est anticuada. Segundo, el modelo de desarrollo de Django te anima a basar tus modelos de objetos de
datos en objetos de base de datos. A lo largo del tiempo hemos encontrado ms y ms usos de objetos de
datos que no se ajustan a la base de datos, y tenemos que migrarlos desde su naturaleza asumiendo que su
informacin se almacenar en una base.
Para una base de cdigo grande y que se utilizar por mucho tiempo, de nitivamente tiene sentido gastar
tiempo estudiando las formas en que tus datos sern almacenados y accedidos, y construyendo alguna
infraestructura que soporte esas formas.
Tambin hemos agregado nuestra propia facilidad para la migracin de la base por lo que los desarrolladores
no tienen que aplicar parches SQL para mantener los actuales esquemas de base de datos funcionando. Los
desarrolladores que cambian el esquema escriben una funcin Python para actualizar la base, y eso se aplica
automticamente cuando el servidor se inicia.
Johannes Beigel :
Consideramos Django como una plataforma muy satisfactoria que encaja perfectamente con la manera
Pythonica de pensar. Casi todo simplemente funciona segn lo previsto.
Una cosa que necesit un poco de trabajo en nuestro proyecto en curso fue ajustar la con guracin del
archivo
settings.py y la estructura de directorios/con guracin (para aplicaciones, plantilla, datos locales,
etc), porque implementamos un sistema altamente modular y con gurable, donde todas las vistas de Django
son mtodos de algunas instancias de clase. Pero con la omnipotencia del dinmico cdigo Python, fue
posible hacerlo.
David Cramer :
Gestionamos la implementacin de grandes aplicaciones de base de datos en un n de semana. Esto nos
hubiera llevado una o dos semanas hacerlo en el sitio web previo, en PHP. Django ha brillado exactamente
donde queramos que lo haga.
Ahora, aunque Django es una gran plataforma, es evidente que no est construido para las necesidades
especi cas que cualquiera necesite. Al tiempo del lanzamiento inicial del sitio web sobre Django, tuvimos
nuestro mayor tr co mensual del ao, y no podamos continuar. Durante los meses siguientes ajustamos
algunos detalles, mayormente el hardware y el software que serva las peticiones a Django. Esto incluy
modi caciones de nuestra con guracin de hardware, optimizacin de Django, y perfeccionar el software
servidor que usbamos, que en ese entonces era lighttpd y FastCGI.
En mayo de 2007, Blizzard (los creadores de World of Warcraft) lanzaron otro parche bastante grande,
como el que haban lanzado en diciembre cuando nuestro sitio fue lanzado en Django. La primer cosa que
pas por nuestras cabezas fue, hey, si soportamos el aluvin de diciembre, esto de ninguna manera puede
ser tan grande, deberamos estar bien. Perdimos cerca de 12 horas antes de que los servidores comenzaran
a sentir el calor. La pregunta surgi de nuevo: Realmente era Django la mejor solucin para lo que nosotros
queramos lograr?
Gracias a todo el gran apoyo de la comunidad, y largas noches, pudimos implementar varios arreglos en
caliente sobre el sitio durante esos das. Los cambios introducidos (que con suerte estarn incorporados
a Django en el momento que este libro vea la luz) permiten que con completa tranquilidad, aquellos (no
cualquiera) que tengan que lidiar con 300 peticiones web por segundo, puedan hacerlo, con Django.
Christian Hammond :
Django nos permiti construir Review Board bastante rpidamente forzndonos a estar organizados a travs
de la separacin de URL, vistas y plantillas, y proveyndonos tiles componentes listos para usar, como
la aplicacin de autenticacin, cacheo, y la abstraccin de base de datos. La mayor parte de esto funcion
realmente bien para nosotros.
revisin 757 del 28 de julio de 2008
A.6. ESTRUCTURA DE EQUIPO
249
Siendo un aplicacin web dinmica, tuvimos que escribir un montn de cdigo JavaScript. Esta es una rea
en la que Django no ha podido ayudarnos realmente mucho. El soporte que provee Django para el uso de
plantillas, etiquetas, ltros y formularios son grandiosos, pero no son fcilmente utilizables desde cdigo
JavaScript. Hay veces que quisiramos usar una plantilla en particular o un ltro, pero no hay manera
de usarlo desde JavaScript. Personalmente me gustara ver que se incorporen a Django algunas soluciones
creativa para esto.
A.6.
Estructura de Equipo
A menudo, los proyectos son exitosos gracias a sus equipos, y no a tecnologa elegida. Consultamos a nuestro panel
sobre sus equipos de trabajo, y qu herramientas y tcnicas utilizan para permanecer en carrera.
Ned Batchelder :
Somos un ambiente de Startup Web bastante estndar: Trac/SVN, cinco desarrolladores. Tenemos un
servidor de desarrollo, un servidor de produccin, un script desarrollado ad hoc, y as.
Ah, y amamos Memcached.
Johannes Beigel :
Usamos Trac como nuestro bug tracker y wiki, y recientemente reemplazamos Subversion+SVK por Mercurial (un sistema de control de versiones distribuido escrito en Python que maneja la rami cacin y fusin
con encanto)
Pienso que tenemos un proceso de desarrollo muy gil, pero no seguimos una metodologa rgida como
Extreme Programming (aunque tomamos prestadas muchas ideas de ah). Somos ms bien programadores
pragmticos.
Tenemos un sistema de construccin automatizada (personalizado pero basado en SCons), y pruebas unitarias para casi todo.
David Cramer :
Nuestro equipo consiste en cuatro desarrolladores web, todos trabajando en la misma o cina de modo que
es bastante fcil comunicarse. Nos basamos en herramientas comunes como SVN y Trac.
Christian Hammond :
Review Board tiene actualmente dos desarrolladores principales (David Trowbridge y yo) y un par de
contribuidores. Estamos hospedados en Google Code y usamos su repositorio Subversion, issue tracker,
y wiki. De hecho, usamos Review Board para revisar nuestros cambios antes de incorporarlos. Hacemos
pruebas en nuestras computadores locales, tanto manualmente como por pruebas de unidad. Nuestros
usuarios en VMware que usan Review Board todos los das nos proveen de un montn de feedback til y
reportes de errores, que intentamos incorporar en el programa.
A.7.
Implementacin
Los desarrolladores de Django toman la facilidad de implementacin y escalamiento muy seriamente, por lo que
siempre estamos interesados en escuchar sobre ensayos y tribulaciones del mundo real.
Ned Batchelder :
Hemos usado cacheo tanto en la capa de consulta como de respuesta para agilizar los tiempos de respuesta.
Tenemos una con guracin clsica: un multiplexor, varios servidores de aplicacin, un servidor de base de
datos. Eso ha funcionado bien para nosotros, porque podemos usar cacheo sobre el servidor de aplicacin
para evitar el acceso a la base de datos, y luego agregar tantos servidores de aplicacin como necesitemos
para manejar la demanda.
Johannes Beigel :
Servidores Linux, preferentemente Debian, con muchos gigas de RAM. Lighttpd como servidor Web, Pound
como front-end HTTPS y balanceador de carga si se necesita, y Memcached como sistema de cach. SQLite
para pequeas bases de datos, Postgres si los datos crecen mucho, y cosas altamente especializadas de base
de datos para nuestros componentes de bsqueda y de gestin de conocimiento.
revisin 757 del 28 de julio de 2008
250
APNDICE A. CASOS DE ESTUDIO
David Cramer :
Nuestra estructura todava est para debatirse... (pero es esto actualmente):
Cuando un usuario solicita el sitio se lo enva a un cluster de servidores Squid usando Lighttpd. All, los
servidores veri can si el usuario est registrado en el sistema. Si no lo est, se le sirve una pgina cacheada.
Un usuario autenticado es reenviado a un cluster de servidores corriendo Apache2 con mod_python (cada
uno con una gran cantidad de memoria), donde luego cada uno hace uso de en un sistema Memcached
distribuido y un bestial servidor de base de datos MySQL. Los datos estticos, como archivos grandes o
videos, (actualmente) estan hospedados en un servidor corriendo una instalacin mnima de Django usando
lighttpd con fastcgi. Ms adelante, migraremos todos esos datos a un servicio similar al S3 de Amazon.
Christian Hammond :
Hay dos servidores de produccin en este momento. Uno est en VMware y consiste en una maquina virtual
Ubuntu corriendo en VMware ESX. Usamos MySQL para la base de datos, Memcached para nuestro backend de cacheo, y actualmente Apache para el servidor Web. Tenemos varios servidores potentes que pueden
escalarse cuando lo requiramos. Tambin podemos mudar MySQL o Memcached a otra maquina virtual a
medida que nuestra base de usuarios crece.
El segundo servidor de produccin es el de Review Board mismo. La con guracin es casi idntica al
anterior, excepto que la maquina virtual se basa en VMware Server.
Block quote ends without a blank line; unexpected unindent.
revisin 757 del 28 de julio de 2008
Apndice B
Referencia de la de nicin de modelos
El Captulo 5 explica lo bsico de la de nicin de modelos, y lo utilizamos en el resto del libro. Existe un enorme
rango de opciones disponibles que no se han cubierto en otro lado. Este apndice explica toda opcin disponible en la
de nicin de modelos.
A pesar de que estas APIs se consideran muy estables, los desarrolladores de Django agregan en forma consistente
nuevos atajos y conveniencias a la de nicin de modelos. Es buena idea chequear siempre la ltima documentacin
online en
http://www.djangoproject.com/documentation/0.96/model-api/.
B.1.
Campos
/0.96? /
La parte ms importante de un modelo -- y la nica parte requerida de un modelo -- es la lista de campos de la
base de datos que de ne.
Restricciones en el nombre de los campos
Django pone solo dos restricciones en el nombre de los campos:
1. Un nombre de campo no puede ser una palabra reservada de Python, porque
eso ocasionara un error de sintaxis en Python, por ejemplo:
class Example(models.Model):
pass = models.IntegerField() # 'pass' es una palabra reservada!
2. Un nombre de campo no puede contener dos o ms guiones bajos consecutivos, debido a la forma en que trabaja la sintaxis de las consultas de
bsqueda de , por ejemplo:
class Example(models.Model):
foo__bar = models.IntegerField() # 'foo__bar' tiene dos guiones bajos!
Estas limitaciones se pueden manejar sin mayores problemas, dado que el nombre del campo
no necesariamente tiene que coincidir con el nombre de la columna en la base de datos. Ver
db_column, ms abajo.
Las palabras reservadas de SQL, como
join, where, o select, son
permitidas como nombres de
campo, dado que Django escapea todos los nombres de tabla y columna de la base de datos
en cada consulta SQL subyacente. Utiliza la sintaxis de quoteo del motor de base de datos
particular.
Cada campo en tu modelo debe ser una instancia de la clase de campo apropiada. Django usa los tipos de clase
Field
para determinar algunas cosas:
El tipo de columna de la base de datos (ej.:,
INTEGER, VARCHAR).
El widget a usar en la interfaz de administracin de Django, si vas a usarla (ej.,
<select>).
<input type="text">,
Los requerimientos mnimos de validacin, que se usan en la interfaz de administracin de Django.
A continuacin, una lista completa de las clases de campo, ordenadas alfabticamente. Los campos de relacin
(ForeignKey, etc.) se tratan en la siguiente seccin.
revisin 757 del 28 de julio de 2008
252
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.1.1.
Un
AutoField
IntegerField
que se incrementa automticamente de acuerdo con los IDs disponibles. Normalmente no nece-
sitars utilizarlos directamente; se agrega un campo de clave primaria automticamente a tu modelo si no especi cas
una clave primaria.
B.1.2.
BooleanField
Un campo Verdadero/Falso.
B.1.3.
CharField
Un campo string, para cadenas cortas o largas. Para grandes cantidades de texto, usa
CharField
requiere un argumento extra,
max_length,
TextField.
que es la longitud mxima (en caracteres) del campo. Esta
longitud mxima es reforzada a nivel de la base de datos y en la validacin de Django.
B.1.4.
CommaSeparatedIntegerField
Un campo de enteros separados por comas. Igual que en
B.1.5.
CharField,
se requiere el argumento
max_length.
DateField
Un campo de fecha.
DateField
tiene algunos argumentos opcionales extra, como se muestra en la Tabla B-1.
Cuadro B.1: Argumentos opcionales extra de DateField
Argumento
auto_now
Descripcin
Asigna automticamente al campo un valor igual al momento en que se
salva el objeto. Es til para las marcas de tiempo ltima modi cacin.
Observar que siempre se usa la fecha actual; no es un valor por omisin
que se pueda sobreescribir.
auto_now_add
Asigna automticamente al campo un valor igual al momento en que se
crea el objeto. Es til para la creacin de marcas de tiempo. Observar
que siempre se usa la fecha actual; no es un valor por omisin que se
pueda sobreescribir.
B.1.6.
DateTimeField
Un campo de fecha y hora. Tiene las mismas opciones extra que
B.1.7.
Un
DateField.
EmailField
CharField
que chequea que el valor sea una direccin de email vlida. No acepta
max_length;
su
max_length
se establece automticamente en 75.
B.1.8.
FileField
Un campo de upload de archivos. Tiene un argumento requerido, como se ve en la Tabla B-3.
Cuadro B.2: Opciones extra de FileField
Argumento
upload_to
Esta ruta puede contener formato
Descripcin
Una ruta del sistema de archivos local que se agregar a la con guracin
de MEDIA_ROOT para determinar
get_<fieldname>_url()
strftime
(ver
el resultado de la funcin de ayuda
http://www.djangoproject.com/r/python/strftime/),
que
ser reemplazada por la fecha y hora del upload del archivo (de manera que los archivos subidos no llenen el directorio
revisin 757 del 28 de julio de 2008
B.1. CAMPOS
dada).
El uso de un
253
FileField
o un
ImageField
en un modelo requiere algunos pasos:
1. En el archivo de con guracin (settings), es necesario de nir
MEDIA_ROOT
con la ruta completa
al directorio donde quieras que Django almacene los archivos subidos. (Por performance, estos
archivos no se almacenan en la base de datos.) De nir
MEDIA_URL con la URL pblica base de ese
directorio. Asegurarse de que la cuenta del usuario del servidor web tenga permiso de escritura
en este directorio.
2. Agregar el
FileField
ImageField
al modelo, asegurndose de de nir la opcin
para decirle a Django a cual subdirectorio de
MEDIA_ROOT
upload_to
debe subir los archivos.
MEDIA_ROOT).
get_<fieldname>_url provista por Django.
3. Todo lo que se va a almacenar en la base de datos es la ruta al archivo (relativa a
Seguramente preferirs usar la facilidad de la funcin
Por ejemplo, si tu
en un plantilla con
ImageField se llama mug_shot, puedes
{{object.get_mug_shot_url }}.
obtener la URL absoluta a tu image
Por ejemplo, digamos que tu MEDIA_ROOT es '/home/media', y upload_to es 'photos/ %Y/ %m/ %d'. La parte
' %Y/ %m/ %d' de upload_to es formato strftime; ' %Y' es el ao en cuatro dgitos, ' %m' es el mes en dos digitos, y ' %d'
es el da en dos dgitos. Si subes un archivo el 15 de enero de 2007, ser guardado en /home/media/photos/2007/01/15.
Si quieres recuperar el nombre en disco del archivo subido, o una URL que se re era a ese archivo, o el tamao del
archivo, puedes usar los mtodos
get_FIELD_filename(), get_FIELD_url(),
get_FIELD_size().
Ver el Apndice
C para una explicacin completa de estos mtodos.
Nota
Cualquiera sea la forma en que manejes tus archivos subidos, tienes que prestar mucha atencin
a donde los ests subiendo y que tipo de archivos son, para evitar huecos en la seguridad. Valida
todos los archivos subidos para asegurarte que esos archivos son lo que piensas que son.
Por ejemplo, si dejas que cualquiera suba archivos ciegamente, sin validacin, a un directorio que
est dentro de la raz de documentos (document root ) de tu servidor web, alguien podra subir
un script CGI o PHP y ejecutarlo visitando su URL en tu sitio. No permitas que pase!
B.1.9.
FilePathField
Un campo cuyas opciones estn limitadas a los nombres de archivo en un cierto directorio en el sistema de archivos.
Tiene tres argumentos especiales, que se muestran en la Tabla B-3.
Cuadro B.3: Opciones extra de FilePathField
Argumento
Descripcin
path
Requerido ; la ruta absoluta en el sistema de archivos hacia el directorio del
cual este
match
FilePathField
"/home/images").
FilePathField usar para
debe tomar sus opciones (ej.:
Opcional; una expresin regular como string, que
ltrar los nombres de archivo. Observar que la regex ser aplicada al nombre
"foo.*\.txt^", va a matchear con
foo23.txt, pero no con bar.txt o foo23.gif).
Opcional; True o False. El valor por omisin es False. Especi ca si deben
incluirse todos los subdirectorios de path.
de archivo base, no a la ruta completa (ej.:
un archivo llamado
recursive
Por supuesto, estos argumentos pueden usarse juntos.
El nico 'gotcha' potencial es que
match
se aplica sobre el nombre de archivo base, no la ruta completa. De esta
manera, este ejemplo:
FilePathField(path="/home/images", match="foo.*", recursive=True)
va a matchear con
/home/images/foo.gif
bar.gif).
nombre de archivo base (foo.gif y
pero no con
/home/images/foo/bar.gif
revisin 757 del 28 de julio de 2008
porque el
match
se aplica al
254
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.1.10.
FloatField
Un numero de punto otante, representado en Python por una instancia de
float. Tiene dos argumentos requeridos,
que se muestran en la Tabla B-4.
Cuadro B.4: Opciones extra de FloatField
Argumento
descripcin
max_digits
decimal_places
La cantidad mximo de dgitos permitidos en el nmero.
La cantidad de posiciones decimales a almacenar con el nmero.
Por ejemplo, para almacenar nmeros hasta 999 con una resolucin de dos decimales, hay que usar:
models.FloatField(..., max_digits=5, decimal_places=2)
Y para almacenar nmeros hasta aproximadamente mil millones con una resolucin de diez dgitos decimales, hay
que usar:
models.FloatField(..., max_digits=19, decimal_places=10)
B.1.11.
ImageField
FileField, pero valida que el objeto subido sea una imagen vlida.
height_field y width_field, que si se utilizan, sern auto-rellenados con
Similar a
extra,
Tiene dos argumentos opcionales
la altura y el ancho de la imagen
cada vez que se guarde una instancia del modelo.
get_FIELD_* que estn disponibles para FileField, un ImageField tiene
get_FIELD_height() y get_FIELD_width(). stos estn documentados en el Apndice C.
ImageField requiere la biblioteca Python Imaging Library (http://www.pythonware.com/products/pil/).
Adems de los mtodos especiales
tambin los mtodos
B.1.12.
IntegerField
Un entero.
B.1.13.
IPAddressField
Una direccin IP, en formato string (ej.:
B.1.14.
NullBooleanField
Similar a
null=True.
B.1.15.
Un
"24.124.1.30").
BooleanField,
pero permite
None/NULL
como opciones. Usar ste en lugar de un
BooleanField
con
PhoneNumberField
CharField
que chequea que el valor es un telfono vlido estilo U.S. (en formato
XXX-XXX-XXXX).
Nota
Si
necesitas
representar
django.contrib.localflavor
telfonos
para
ver
de
si
otros
ya
estn
pases,
incluidas
consulta
las
el
de niciones
paquete
para
tu
pas.
B.1.16.
PositiveIntegerField
IntegerField,
Similar a
B.1.17.
pero debe ser positivo.
PositiveSmallIntegerField
Similar a
PositiveIntegerField,
pero solo permite valores por debajo de un lmite. El valor mximo permitido
para estos campos depende de la base de datos, pero como las bases de datos tienen un tipo entero corto de 2 bytes,
el valor mximo positivo usualmente es 65,535.
revisin 757 del 28 de julio de 2008
B.2. OPCIONES UNIVERSALES DE CAMPO
B.1.18.
255
SlugField
Slug es un trmino de la prensa. Un slug es una etiqueta corta para algo, que contiene solo letras, nmeros,
guiones bajos o simples. Generalmente se usan en URLs.
De igual forma que en
CharField,
puedes especi car
max_length.
Si
max_length
no est especi cado, Django
asume un valor por omisin de 50.
Un
SlugField
implica
db_index=True
datos.
SlugField
acepta una opcin extra,
debido a que son los se usan principalmente para bsquedas en la base de
prepopulate_from,
que es una lista de campos a partir de los cuales auto-
rellenar el slug, va JavaScript, en el formulario de administracin del objeto:
models.SlugField(prepopulate_from=("pre_name", "name"))
prepopulate_from
B.1.19.
no acepta nombres
DateTimeField
como argumentos.
SmallIntegerField
Similar a
IntegerField, pero solo permite valores en un cierto rango dependiente de la base de datos (usualmente
-32,768 a +32,767).
B.1.20.
TextField
Un campo de texto de longitud ilimitada.
B.1.21.
TimeField
Un campo de hora. Acepta las mismas opciones de autocompletacin de
B.1.22.
DateField
DateTimeField.
URLField
Un campo para una URL. Si la opcin
verify_exists
es
True
(valor por omisin), se chequea la existencia de la
URL dada (la URL carga y no da una respuesta 404).
Como los otros campos de caracteres,
URLField
toma el argumento
max_length.
Si no se especi ca, el valor por
omisin es 200.
B.1.23.
USStateField
Una abreviatura de dos letras de un estado de U.S.
Nota
Si
necesitas
representar
django.contrib.localflavor
otros
pases
estados,
busca
en
el
paquete
para ver si Django ya incluye los campos para tu locali-
zacin.
B.1.24.
Un
XMLField
TextField que chequea que el valor sea un XML vlido que matchea con un esquema dado. Tiene un argumento
schema_path, que es la ruta en el sistema de archivos a un esquema RELAX NG (http://www.relaxng.
requerido,
org/)
contra el cual validar el campo.
Requiere
B.2.
jing (http://thaiopensource.com/relaxng/jing.html)
para validar el XML.
Opciones Universales de Campo
Los siguientes argumentos estn disponibles para todos los tipos de campo. Todos son opcionales.
revisin 757 del 28 de julio de 2008
256
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.2.1.
null
Si est en
True,
Django almacenar valores vacos como
NULL
False.
NULL. Utiliza null=True
en la base de datos. El valor por omisin es
Observar que los valores de string nulo siempre se almacenan como strings vacos, no como
solo para campos no-string, como enteros, booleanos y fechas. En los dos casos, tambin necesitars establecer
blank=True
si deseas permitir valores vacos en los formularios, ya que el parmetro
null
solo afecta el almace-
namiento en la base de datos (ver la siguiente seccin, titulada blank).
Evita utilizar
null
sin datos:
CharField y TextField salvo que tengas una excelente
null=True, eso signi ca que tiene dos valores posibles para
en campos basados en string como
razn para hacerlo. Si un campo basado en string tiene
NULL y el string
NULL.
vaco. En la mayora de los casos, esto es redundante; la convencin de Django es usar el
string vaco, no
B.2.2.
blank
False.
null. null solo se relaciona con la base de datos, mientras que blank est
relacionado con la validacin. Si un campo tiene blank=True, la validacin del administrador de Django permitir la
entrada de un valor vaco. Si un campo tiene blank=False, es un campo requerido.
Si est en
True,
est permitido que el campo est en blanco. El valor por omisin es
Observar que esto es diferente de
B.2.3.
choices
Un iterable (ej.: una lista, tupla, o otro objeto iterable de Python) de dos tuplas para usar como opciones para
este campo.
Si esto est dado,la interfaz de administracin de Django utilizar un cuadro de seleccin en lugar del campo de
texto estndar, y limitar las opciones a las dadas.
Una lista de opciones se ve as:
YEAR_IN_SCHOOL_CHOICES = (
('FR', 'Freshman'),
('SO', 'Sophomore'),
('JR', 'Junior'),
('SR', 'Senior'),
('GR', 'Graduate'),
)
El primer elemento de cada tupla es el valor actual a ser almacenado. El segundo elemento es el nombre legible por
humanos para la opcin.
La lista de opciones puede ser de nida tambin como parte de la clase del modelo:
class Foo(models.Model):
GENDER_CHOICES = (
('M', 'Male'),
('F', 'Female'),
)
gender = models.CharField(maxlength=1, choices=GENDER_CHOICES)
o fuera de la clase del modelo:
GENDER_CHOICES = (
('M', 'Male'),
('F', 'Female'),
)
class Foo(models.Model):
gender = models.CharField(maxlength=1, choices=GENDER_CHOICES)
Para cada campo del modelo que tenga establecidas
choices, Django agregar un mtodo para recuperar el nombre
legible por humanos para el valor actual del campo. Ver Apndice C para ms detalles.
revisin 757 del 28 de julio de 2008
B.2. OPCIONES UNIVERSALES DE CAMPO
B.2.4.
257
db_column
El nombre de la columna de la base de datos a usar para este campo. Si no est dada, Django utilizar el nombre
del campo. Esto es til cuando ests de niendo un modelo sobre una base de datos existente.
Si tu nombre de columna de la base de datos es una palabra reservada de SQL, o contiene caracteres que no estn
permitidos en un nombre de variable de Python (en particular el guin simple), no hay problema. Django quotea los
nombres de columna y tabla detrs de la escena.
B.2.5.
db_index
Si est en
True, Django crear un
manage.py syncdb).
ndice en la base de datos para esta columna cuando cree la tabla (es decir,
cuando ejecute
B.2.6.
default
El valor por omisin del campo.
B.2.7.
Si es
editable
False, el campo no ser editable en la interfaz de administracin o via procesamiento de formularios. El valor
True.
por omisin es
B.2.8.
help_text
Texto de ayuda extra a ser mostrado bajo el campo en el formulario de administracin del objeto. Es til como
documentacin aunque tu objeto no tenga formulario de administracin.
B.2.9.
Si es
primary_key
True,
este campo es la clave primaria del modelo.
Su no se especi ca
primary_key=True
para ningn campo del modelo, Django agregar automticamente este
campo:
id = models.AutoField('ID', primary_key=True)
Por lo tanto, no necesitas establecer
primary_key=True
en ningn campo, salvo que quieras sobreescribir el com-
portamiento por omisin de la clave primaria.
primary_key=True
implica
blank=False, null=False,
unique=True.
Solo se permite una clave primaria en un
objeto.
B.2.10.
radio_admin
Por omisin,el administrador de Django usa una interfaz de cuadro de seleccin (<select>) para campos que son
ForeignKey
o tienen
choices.
Si
radio_admin es True, Django utilizar una interfaz
ForeignKey o no tenga choices.
radio-button en su lugar.
No utilice esto para un campo que no sea
B.2.11.
Si es
unique
True,
B.2.12.
el valor para este campo debe ser nico en la tabla.
unique_for_date
Asignar como valor el nombre de un
DateField
DateTimeField
para requerir que este campo sea nico para el
valor del campo tipo fecha, por ejemplo:
class Story(models.Model):
pub_date = models.DateTimeField()
slug = models.SlugField(unique_for_date="pub_date")
...
En este cdigo, Django no permitir la creacin de dos historias con el mismo slug publicados en la misma fecha.
Esto di ere de usar la restriccin
unique_together
en que solo toma en cuenta la fecha del campo
no importa.
revisin 757 del 28 de julio de 2008
pub_date;
la hora
258
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.2.13.
unique_for_month
Similar a
B.2.14.
pero requiere que el campo sea nico con respecto al mes del campo dado.
unique_for_year
Similar a
B.2.15.
unique_for_date,
unique_for_date
unique_for_month,
pero para el ao.
verbose_name
Cada tipo de campo, excepto
ForeignKey, ManyToManyField,
OneToOneField,
toma un primer argumento po-
sicional opcional -- un nombre descriptivo. Si el nombre descriptivo no est dado, Django lo crear automticamente
usando el nombre de atributo del campo, convirtiendo guiones bajos en espacios.
En este ejemplo, el nombre descriptivo es
"Person's first name":
first_name = models.CharField("Person's first name", maxlength=30)
En este ejemplo, el nombre descriptivo es
"first name":
first_name = models.CharField(maxlength=30)
ForeignKey, ManyToManyField, y OneToOneField requieren que el primer argumento sea una clase del modelo, en
verbose_name como argumento con nombre:
este caso hay que usar
poll = models.ForeignKey(Poll, verbose_name="the related poll")
sites = models.ManyToManyField(Site, verbose_name="list of sites")
place = models.OneToOneField(Place, verbose_name="related place")
La convencin es no capitalizar la primera letra del
verbose_name. Django convertir a mayscula automticamente
la primera letra cuando lo necesite.
B.3.
Relaciones
Es claro que el poder de las bases de datos se basa en relacionar tablas entre s. Django ofrece formas de de nir
los tres tipos de relaciones ms comunes en las bases de datos: muchos-a-uno, muchos-a-muchos, y uno-a-uno.
Sin embargo, la semntica de las relaciones uno-a-uno esta siendo revisada mientras se imprime este libro, as que
no se cubren en esta seccin. Consulte en la documentacin on-line la informacin ms actualizada.
B.3.1.
Relaciones Muchos-a-Uno
Para de nir una relacin muchos-a-uno, usa
ForeignKey.
Se usa como cualquier otro tipo
Field:
incluyndolo
como un atributo de clase en tu modelo.
ForeignKey
requiere un argumento posicional: la clase a la cual se relaciona el modelo.
Car tiene
Manufacturer --
Por ejemplo, si un modelo
cada
Car
tiene solo un
un
Manufacturer
-- es decir, un
Manufacturer
fabrica mltiples autos pero
usa la siguiente de nicin:
class Manufacturer(models.Model):
...
class Car(models.Model):
manufacturer = models.ForeignKey(Manufacturer)
...
Para crear una relacin recursiva -- un objeto que tiene una relacin muchos-a-uno con l mismo -- usa
models.ForeignKey('self
class Employee(models.Model):
manager = models.ForeignKey('self')
Si necesitas crear una relacin con un modelo que an no se ha de nido, puedes usar el nombre del modelo en lugar
del objeto modelo:
revisin 757 del 28 de julio de 2008
B.3. RELACIONES
259
class Car(models.Model):
manufacturer = models.ForeignKey('Manufacturer')
...
class Manufacturer(models.Model):
...
Observar que de todas formas solo puedes usar strings para hacer referencia a modelos dentro del mismo archivo
models.py -- no puedes usar un string para hacer referencia a un modelo en una aplicacin diferente, o hacer referencia
a un modelo que ha sido importado de cualquier otro lado.
Detrs de la escena, Django agrega
"_id"
al nombre de campo para crear su nombre de columna en la base
de datos. En el ejemplo anterior, la tabla de la base de datos correspondiente al modelo
na
manufacturer_id.
(Puedes cambiar esto explcitamente especi cando
db_column;
Car,
tendr una colum-
ver ms arriba en la seccin
db_column.) De todas formas, tu cdigo nunca debe utilizar el nombre de la columna de la base de datos, salvo que
escribas tus propias SQL. Siempre te manejars con los nombres de campo de tu objeto modelo.
Se sugiere, pero no es requerido, que el nombre de un campo
ForeignKey (manufacturer
en el ejemplo) sea el
nombre del modelo en minsculas. Por supuesto, puedes ponerle el nombre que quieras. Por ejemplo:
class Car(models.Model):
company_that_makes_it = models.ForeignKey(Manufacturer)
# ...
Los campos
ForeignKey
reciben algunos argumentos extra para de nir como debe trabajar la relacin (ver Tabla
B-5). Todos son opcionales.
Cuadro B.5: Opciones de ForeignKey
Argumento
edit_inline
Descripcin
Si no es
False,
este objeto relacionado se edita inline en la pgina del objeto
relacionado. Esto signi ca que el objeto no tendr su propia interfaz de administracin. Usa
models.TABULAR
models.STACKED,
que designan si los objetos
editables inline se muestran como una tabla o como una pila de conjuntos de
campos, respectivamente.
limit_choices_to
Un diccionario para buscar argumentos y valores (ver el Apndice C) que limita
las opciones de administracin disponibles para este objeto. Usa esto con funciones del mdulo
datetime
de Python para limitar las opciones de fecha de los
objetos. Por ejemplo:
limit_choices_to = {'pub_date__lte': datetime.now}
slo permite la eleccin de objetos relacionados con pub_date
cha/hora actual.
En lugar de un diccionario, esto puede ser un objeto
anterior a la fe-
(ver Apndice C) para
consultas ms complejas.
No es compatible con
max_num_in_admin
edit_inline.
Para objetos editados inline, este es el nmero mximo de objetos relacionados a
mostrar en la interfaz de administracin. Por lo tanto, si una pizza puede tener
como mximo diez ingredientes,
max_num_in_admin=10 asegurar que un usuario
nunca ingresar ms de diez ingredientes.
Observar que esto no asegura que no se puedan crear ms de diez ingredientes
relacionados. Simplemente controla la interfaz de administracin; no fortalece
cosas a nivel de Python API o base de datos.
min_num_in_admin
La cantidad mnima de objetos relacionados que se muestran en la interfaz de administracin. Normalmente, en el momento de la creacin se muestran
tran
num_in_admin objetos
num_extra_on_change
inline , y en el momento de edicin se muesobjetos en blanco adems de todos los objetos
relacionados preexistentes. De todas formas, nunca se mostrarn menos de
min_num_in_admin
num_extra_on_change
objetos relacionados.
La cantidad de campos en blanco extra de objetos relacionados a mostrar en el
momento de realizar cambios.
revisin 757 del 28 de julio de 2008
260
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
Cuadro B.5: Opciones de ForeignKey
Argumento
Descripcin
num_in_admin
El valor por omisin de la cantidad de objetos inline a mostrar en la pgina del
objeto en el momento de agregar.
raw_id_admin
Solo muestra un campo para ingresar un entero en lugar de un men desplegable.
Esto es til cuando se relaciona con un tipo de objeto que tiene demasiadas las
para que sea prctico utilizar una caja de seleccin.
No es utilizado con
related_name
edit_inline.
El nombre a utilizar para la relacin desde el objeto relacionado de hacia ste
objeto. Para ms informacin, ver el Apndice C.
to_field
El campo en el objeto relacionado con el cual se establece la relacin. Por omisin,
Django usa la clave primaria del objeto relacionado.
B.3.2.
Relaciones Muchos-a-Muchos
Para de nir una relacin muchos-a-muchos, usa
ManyToManyField.
Al igual que
requiere un argumento posicional: la clase a la cual se relaciona el modelo.
Por ejemplo, si una
y cada
Pizza
Pizza
tiene mltiples objetos
Topping
-- es decir, un
Topping
ForeignKey, ManyToManyField
puede estar en mltiples pizzas
tiene mltiples ingredientes (toppings) -- debe representarse as:
class Topping(models.Model):
...
class Pizza(models.Model):
toppings = models.ManyToManyField(Topping)
...
Como sucede con
ForeignKey,
una relacin de un objeto con s mismo puede de nirse usando el string
'self'
en
lugar del nombre del modelo, y puedes hacer referencia a modelos que todava no se de nieron usando un string que
contenga el nombre del modelo. De todas formas solo puedes usar strings para hacer referencia a modelos dentro del
mismo archivo
models.py
-- no puedes usar un string para hacer referencia a un modelo en una aplicacin diferente,
o hacer referencia a un modelo que ha sido importado de cualquier otro lado.
Se sugiere, pero no es requerido, que el nombre de un campo
ManyToManyField (toppings,
en el ejemplo) sea un
trmino en plural que describa al conjunto de objetos relacionados con el modelo.
Detrs de la escena, Django crea una tabla join intermedia para representar la relacin muchos-a-muchos.
No importa cual de los modelos tiene el
ManyToManyField,
en los dos.
pero es necesario que est en uno de los modelos -- no
ManyToManyField deben ir en el objeto que va a ser
toppings estn en la Pizza (en lugar de que
natural pensar que una Pizza tiene varios ingredientes
Si ests usando la interfaz de administracin, las instancias
editado en la interfaz de administracin. En el ejemplo anterior, los
el
Topping
tenga
pizzas ManyToManyField
) porque es ms
(toppings) que pensar que un ingrediente est en muchas pizzas. En la forma en que est con gurado el ejemplo, el
formulario de administracin de laPizza permitir que los usuarios selecciones los ingredientes.
Los objetos
ManyToManyField
toman algunos argumentos extra para de nir como debe trabajar la relacin (ver
Tabla B-6). Todos son opcionales.
Cuadro B.6: Opciones de ManyToManyField
Argumento
related_name
Descripcin
El nombre a utilizar para la relacin desde el objeto relacionado hacia este
objeto. Ver Apndice C para ms informacin.
filter_interface
Usa una interfaz de ltro JavaScript agradable y discreta en lugar de la menos
cmoda
<select multiple> en el formulario administrativo de este objeto. El
models.HORIZONTAL o models.VERTICAL (es decir, la interfaz
valos debe ser
debe apilarse horizontal o verticalmente).
limit_choices_to
Ver la descripcin en
ForeignKey.
revisin 757 del 28 de julio de 2008
B.4. OPCIONES DE LOS METADATOS DEL MODELO
261
Cuadro B.6: Opciones de ManyToManyField
Argumento
Descripcin
symmetrical
Solo utilizado en la de nicin de
ManyToManyField
sobre s mismo. Considera
el siguiente modelo:
class Person(models.Model):
friends = models.ManyToManyField("self")
ManyToManyField
person_set a la clase
ManyToManyField es simtrico --
Cuando Django procesa este modelo, identi ca que tiene un
sobre s mismo, y como resultado, no agrega un atributo
Person.
En lugar de eso, se asumen que el
esto es, si yo soy tu amigo, entonces tu eres mi amigo.
Si no deseas la simetra en las relaciones
symmetrical
en
False.
ManyToMany
relacin inversa, permitiendo que las relaciones
db_table
con
self,
establece
Esto forzar a Django a agregar el descriptor para la
ManyToMany
sean asimtricas.
El nombre de la tabla a crear para almacenar los datos de la relacin muchosa-muchos. Si no se provee, Django asumir un nombre por omisin basado en
los nombres de las dos tablas a ser vinculadas.
B.4.
Opciones de los Metadatos del Modelo
Los metadatos espec cos de un modelo viven en una
class Meta
de nida en el cuerpo de tu clase modelo:
class Book(models.Model):
title = models.CharField(maxlength=100)
class Meta:
# model metadata options go here
...
Los metadatos del modelo son cualquier cosa que no sea un campo, como opciones de ordenamiento, etc.
Las secciones que siguen presentan una lista de todas las posibles
requerida. Agregar
B.4.1.
class Meta
Meta
opciones. Ninguna de estas opciones es
a un modelo es completamente opcional.
db_table
El nombre de la tabla de la base de datos a usar para el modelo.
Para ahorrarte tiempo, Django deriva automticamente el nombre de la tabla de la base de datos a partir del
nombre de la clase modelo y la aplicacin que la contiene. Un nombre de tabla de base de datos de un modelo se
construye uniendo la etiqueta de la aplicacin del modelo -- el nombre que usaste en
nombre de la clase modelo, con un guin bajo entre ellos.
Por ejemplo, si tienes una aplicacin
class Book
books
manage.py startapp
-- con el
manage.py startapp books), un modelo de nido como
books.
datos, use el parmetro db_table dentro de class Meta:
(creada por
tendr una tabla en la base de datos llamada
Para sobreescribir el nombre de la tabla de la base de
class Book(models.Model):
...
class Meta:
db_table = 'things_to_read'
Si no se de ne, Django utilizar
app_label + '_' + model_class_name. Ver la seccin `Nombres de Tabla`_
para ms informacin.
Si tu nombre de tabla de base de datos es una palabra reservada de SQL, o contiene caracteres que no estn
permitidos en los nombres de variable de Python (especialmente el guin simple), no hay problema. Django quotea los
nombres de tabla y de columna detrs de la escena.
revisin 757 del 28 de julio de 2008
262
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.4.2.
get_latest_by
El nombre de un
mtodo
latest()
DateField o DateTimeField
Manager del modelo.
del modelo. Esto especi ca el campo a utilizar por omisin en el
del
Aqu hay un ejemplo:
class CustomerOrder(models.Model):
order_date = models.DateTimeField()
...
class Meta:
get_latest_by = "order_date"
Ver el Apndice C para ms informacin sobre el mtodo
B.4.3.
latest().
order_with_respect_to
Marca este objeto como ordenable con respecto al campo dado. Esto se utiliza casi siempre con objetos relacionados para permitir que puedan ser ordenados respecto a un objeto padre. Por ejemplo, si una
un objeto
Question,
Answer
se relaciona a
y una pregunta tiene ms de una respuesta, y el orden de las respuestas importa, hars esto:
class Answer(models.Model):
question = models.ForeignKey(Question)
# ...
class Meta:
order_with_respect_to = 'question'
B.4.4.
ordering
El ordenamiento por omisin del objeto, utilizado cuando se obtienen listas de objetos:
class Book(models.Model):
title = models.CharField(maxlength=100)
class Meta:
ordering = ['title']
-, que indica orden
"?" para ordenar al
Esto es una tupla o lista de strings. Cada string es un nombre de campo con un pre jo opcional
descendiente. Los campos sin un
precedente se ordenarn en forma ascendente. Use el string
azar.
Por ejemplo, para ordenar por un campo
title
en orden ascendente (A-Z), usa esto:
ordering = ['title']
Para ordenar por
title
en orden descendente (Z-A), usa esto:
ordering = ['-title']
Para ordenar por
title
en orden descendente, y luego por
author
en orden ascendente, usa esto:
ordering = ['-title', 'author']
Observar que no importa cuantos campos haya en
B.4.5.
ordering,
el sitio de administracin usa slo el primer campo.
permissions
Permisos extra para almacenar en la tabla de permisos cuando se crea este objeto. Se crean automticamente
permisos para agregar, eliminar y cambiar para cada objeto que tenga establecida la opcin
especi ca un permiso extra,
can_deliver_pizzas:
revisin 757 del 28 de julio de 2008
admin.
Este ejemplo
B.5. MANAGERS
263
class Employee(models.Model):
...
class Meta:
permissions = (
("can_deliver_pizzas", "Can deliver pizzas"),
)
Esto es una lista o tupla de dos tuplas de la forma
(permission_code, human_readable_permission_name).
Ver el Captulo 12 para ms detalles sobre permisos.
B.4.6.
unique_together
Conjuntos de nombres de campo que tomados juntos deben ser nicos:
class Employee(models.Model):
department = models.ForeignKey(Department)
extension = models.CharField(maxlength=10)
...
class Meta:
unique_together = [("department", "extension")]
Esto es una lista de listas de campos que deben ser nicos cuando se consideran juntos. Es usado en la interfaz de
administracin de Django y se refuerza a nivel de base de datos (esto es, se incluyen las sentencias
en la sentencia
B.4.7.
CREATE TABLE).
UNIQUE apropiadas
verbose_name
Un nombre legible por humanos para el objeto, en singular:
class CustomerOrder(models.Model):
order_date = models.DateTimeField()
...
class Meta:
verbose_name = "order"
Si no se de ne, Django utilizar una versin adaptada del nombre de la clase, en la cual
en
camel case.
B.4.8.
CamelCase
se convierte
verbose_name_plural
El nombre del objeto en plural:
class Sphynx(models.Model):
...
class Meta:
verbose_name_plural = "sphynges"
Si no se de ne, Django agregar una s al nal del
B.5.
Un
verbose_name.
Managers
Manager
es la interfaz a travs de la cual se proveen las operaciones de consulta de la base de datos a los
Manager para cada modelo en una aplicacin Django.
Manager est documentada en el Apndice C. Esta seccin trata espec camente
personaliza el comportamiento del Manager.
modelos de Django. Existe al menos un
La forma en que trabajan las clases
las opciones del modelo que
revisin 757 del 28 de julio de 2008
264
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.5.1.
Nombres de Manager
Por omisin, Django agrega un
quieres usar
objects
Manager
llamado
objects
renombrarlo en cada uno de los modelos. Para renombrar el
de tipo
a cada clase modelo de Django. De todas formas, si tu
como nombre de campo, o quieres usar un nombre distinto de
models.Manager()
Manager
objects
para el
Manager,
puedes
para una clase dada, de ne un atributo de clase
en ese modelo, por ejemplo:
from django.db import models
class Person(models.Model):
...
people = models.Manager()
Person.objects generar una excepcin AttributeError (dado que Person
Person.people.all() devolver una lista de todos los objetos Person.
Usando este modelo de ejemplo,
tiene un atributo
B.5.2.
objects),
pero
no
Managers Personalizados
Puedes utilizar un
ciando tu
Manager
Manager
personalizado en un modelo en particular extendiendo la clase base
personalizado en tu modelo.
Hay dos razones por las que puedes querer personalizar un
para modi car el
QuerySet
inicial que devuelve el
Manager.
Manager:
Manager
para agregar mtodos extra al
e instan-
Manager,
y/o
Agregando Mtodos Extra al Manager
Agregar mtodos extra al
Manager
es la forma preferida de agregar funcionalidad a nivel de tabla a tus modelos.
(Para funcionalidad a nivel de registro -- esto es, funciones que actan sobre una instancia simple de un objeto modelo
Manager personalizados .)
Manager personalizado puede retornar cualquier cosa que necesites. No tiene que retornar un QuerySet.
ejemplo, este Manager personalizado ofrece un mtodo with_counts(), que retorna una lista de todos los
OpinionPoll, cada uno con un atributo extra num_responses que es el resultado de una consulta agregada:
-- usa mtodos modelo (ver ms abajo), no mtodos de
Un mtodo
Por
objetos
from django.db import connection
class PollManager(models.Manager):
def with_counts(self):
cursor = connection.cursor()
cursor.execute("""
SELECT p.id, p.question, p.poll_date, COUNT(*)
FROM polls_opinionpoll p, polls_response r
WHERE p.id = r.poll_id
GROUP BY 1, 2, 3
ORDER BY 3 DESC""")
result_list = []
for row in cursor.fetchall():
p = self.model(id=row[0], question=row[1], poll_date=row[2])
p.num_responses = row[3]
result_list.append(p)
return result_list
class OpinionPoll(models.Model):
question = models.CharField(maxlength=200)
poll_date = models.DateField()
objects = PollManager()
class Response(models.Model):
poll = models.ForeignKey(Poll)
person_name = models.CharField(maxlength=50)
response = models.TextField()
revisin 757 del 28 de julio de 2008
B.5. MANAGERS
265
En este ejemplo, puedes usar
con el atributo
num_responses.
OpinionPoll.objects.with_counts() para retornar la lista de objetos OpinionPoll
Otra cosa a observar en este ejemplo es que los mtodos de un
Manager pueden acceder a self.model para obtener
la clase modelo a la cual estn anexados.
Modi cando los QuerySets iniciales del Manager
Un
QuerySet
base de un
Manager
devuelve todos los objetos en el sistema. Por ejemplo, usando este modelo:
class Book(models.Model):
title = models.CharField(maxlength=100)
author = models.CharField(maxlength=50)
Book.objects.all() retornar todos los libros de la base de datos.
QuerySet base, sobreescribiendo el mtodo Manager.get_query_set(). get_query_set()
un QuerySet con las propiedades que tu requieres.
la sentencia
Puedes sobreescribir el
debe retornar
Por ejemplo, el siguiente modelo tiene dos managers -- uno que devuelve todos los objetos, y otro que retorna solo
los libros de Roald Dahl:
# First, define the Manager subclass.
class DahlBookManager(models.Manager):
def get_query_set(self):
return super(DahlBookManager, self).get_query_set().filter(author='Roald Dahl')
# Then hook it into the Book model explicitly.
class Book(models.Model):
title = models.CharField(maxlength=100)
author = models.CharField(maxlength=50)
objects = models.Manager() # The default manager.
dahl_objects = DahlBookManager() # The Dahl-specific manager.
Con este modelo de ejemplo,
Book.objects.all() retornar todos los libros de la base de datos, pero Book.dahl_objects.
solo retornar aquellos escritos por Roald Dahl.
get_query_set() devuelve un objeto QuerySet,
QuerySet sobre l. Por lo tanto, estas sentencias son
Por supuesto, como
los otro mtodos de
puedes usar
filter(), exclude(),
y todos
todas legales:
Book.dahl_objects.all()
Book.dahl_objects.filter(title='Matilda')
Book.dahl_objects.count()
Este ejemplo tambin seala otra tcnica interesante: usar varios managers en el mismo modelo. Puedes agregar
tantas instancias de
Manager()
como quieras. Esta es una manera fcil de de nir lters comunes para tus modelos.
Aqu hay un ejemplo:
class MaleManager(models.Manager):
def get_query_set(self):
return super(MaleManager, self).get_query_set().filter(sex='M')
class FemaleManager(models.Manager):
def get_query_set(self):
return super(FemaleManager, self).get_query_set().filter(sex='F')
class Person(models.Model):
first_name = models.CharField(maxlength=50)
last_name = models.CharField(maxlength=50)
sex = models.CharField(maxlength=1, choices=(('M', 'Male'), ('F', 'Female')))
people = models.Manager()
men = MaleManager()
women = FemaleManager()
revisin 757 del 28 de julio de 2008
266
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
Este ejemplo te permite consultar
Person.men.all(), Person.women.all(),
Person.people.all(),
con los
resultados predecibles.
Manager personalizados, toma nota que el primer Manager que encuentre Django (en el orden en el
Manager de nido en una clase
como el Manager por omisin. Ciertas operaciones -- como las del sitio de administracin de Django -- usan el Manager
por omisin para obtener listas de objetos, por lo que generalmente es una buena idea que el primer Manager est
relativamente sin ltrar. En el ltimo ejemplo, el manager people est de nido primero -- por lo cual es el Manager
Si usas objetos
que estn de nidos en el modelo) tiene un status especial. Django interpreta el primer
por omisin.
B.6.
Mtodos de Modelo
De ne mtodos personalizados en un modelo para agregar funcionalidad personalizada a nivel de registro para tus
objetos. Mientras que los mtodos
Manager
estn pensados para hacer cosas a nivel de tabla, los mtodos de modelo
deben actual en una instancia particular del modelo.
Esta es una tcnica valiosa para mantener la lgica del negocio en un slo lugar: el modelo. Por ejemplo, este
modelo tiene algunos mtodos personalizados:
class Person(models.Model):
first_name = models.CharField(maxlength=50)
last_name = models.CharField(maxlength=50)
birth_date = models.DateField()
address = models.CharField(maxlength=100)
city = models.CharField(maxlength=50)
state = models.USStateField() # Yes, this is America-centric...
def baby_boomer_status(self):
"""Returns the person's baby-boomer status."""
import datetime
if datetime.date(1945, 8, 1) <= self.birth_date <= datetime.date(1964, 12, 31):
return "Baby boomer"
if self.birth_date < datetime.date(1945, 8, 1):
return "Pre-boomer"
return "Post-boomer"
def is_midwestern(self):
"""Returns True if this person is from the Midwest."""
return self.state in ('IL', 'WI', 'MI', 'IN', 'OH', 'IA', 'MO')
@property
def full_name(self):
"""Returns the person's full name."""
return ' %s %s' % (self.first_name, self.last_name)
El ltimo mtodo en este ejemplo es una propiedad -- un atributo implementado por cdigo getter/setter personalizado. Las propiedades son un truco ingenioso agregado en Python 2.2; puedes leer ms acerca de ellas en
http://www.python.org/download/releases/2.2/descrintro/#property.
Existen tambin un puado de mtodos de modelo que tienen un signi cado especial para Python o Django.
Estos mtodos se describen en las secciones que siguen.
B.6.1.
__str__
__str__()
es un mtodo mgico de Python que de ne lo que debe ser devuelto si llamas a
objeto. Django usa
str(obj)
(o la funcin relacionada
unicode(obj),
str()
sobre el
que se describe ms abajo) en varios lugares,
particularmente como el valor mostrado para hacer el render de un objeto en el sitio de administracin de Django y
como el valor insertado en un plantilla cuando muestra un objeto. Por eso, siempre debes retornar un string agradable
y legible por humanos en el
__str__
de un objeto. A pesar de que esto no es requerido, es altamente recomendado.
Aqu hay un ejemplo:
class Person(models.Model):
revisin 757 del 28 de julio de 2008
B.6. MTODOS DE MODELO
267
first_name = models.CharField(maxlength=50)
last_name = models.CharField(maxlength=50)
def __str__(self):
return ' %s %s' % (self.first_name, self.last_name)
B.6.2.
get_absolute_url
De ne un mtodo
get_absolute_url()
para decirle a Django cmo calcular la URL de un objeto, por ejemplo:
def get_absolute_url(self):
return "/people/ %i/" % self.id
Django usa esto en la interfaz de administracin. Si un objeto de ne
get_absolute_url(),
la pgina de edi-
cin del objeto tendr un enlace View on site, que te llevar directamente a la vista pblica del objeto, segn
get_absolute_url().
Tambin un par de otras partes de Django, como el framework de sindicacin de feeds, usan
get_absolute_url()
como facilidad para recompensar a las personas que han de nido el mtodo.
Es una buena prctica usar
get_absolute_url() en plantillas, en lugar de codi car en duro las URL de tus objetos.
Por ejemplo, este cdigo de plantilla es malo :
<a href="/people/{{ object.id }}/">{{ object.name }}</a>
Pero este es bueno:
<a href="{{ object.get_absolute_url }}">{{ object.name }}</a>
El problema con la forma en que simplemente escribimos
get_absolute_url()
es que viola levemente el principio
DRY: la URL de este objeto de de ne dos veces, en el archivo URLconf y en el modelo.
Adems puedes desacoplar tus modelos de el URLconf usando el decorator
permalink.
A este decorator se le pasa
funcin de view, una lista de parmetros posicionales, y (opcionalmente) un diccionario de parmetros por nombre.
Django calcula la URL completa correspondiente usando el URLconf, sustituyendo los parmetros que le has pasado
en la URL. Por ejemplo, si tu URLconf contiene una lnea como sta:
(r'^people/(\d+)/$', 'people.views.details'),
tu modelo puede tener un mtodo
get_absolute_url
como ste:
@models.permalink
def get_absolute_url(self):
return ('people.views.details', [str(self.id)])
En forma similar, si tienes una entrada en URLconf que se ve como esta:
(r'/archive/(?P<year>\d{4})/(?P<month>\d{1,2})/(?P<day>\d{1,2})/$', archive_view)
puedes hacer referencia a la misma usando
permalink()
como sigue:
@models.permalink
def get_absolute_url(self):
return ('archive_view', (), {
'year': self.created.year,
'month': self.created.month,
'day': self.created.day})
Observar que especi camos una secuencia vaca para el segundo argumento en este caso, porque slo queremos
pasar argumentos por clave, no argumentos por nombre.
De esta forma, ests ests ligando la URL absoluta del modelo a la vista que se utiliza para mostrarla, sin repetir
la informacin de la URL en ningn lado. An puedes usar el mtodo
get_absolute_url
revisin 757 del 28 de julio de 2008
en plantillas, como antes.
268
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.6.3.
Ejecutando SQL personalizado
Sintete libre de escribir sentencias SQL personalizadas en mtodos personalizados de modelo y mtodos a nivel
django.db.connection representa la conexin actual a la base de datos. Para usarla, invoconnection.cursor() para obtener un objeto cursor. Despus, llama a cursor.execute(sql, [params]) para
ejecutar la SQL, y cursor.fetchone() o cursor.fetchall() para devolver las las resultantes:
de mdulo. El objeto
ca
def my_custom_sql(self):
from django.db import connection
cursor = connection.cursor()
cursor.execute("SELECT foo FROM bar WHERE baz = %s", [self.baz])
row = cursor.fetchone()
return row
connection y cursor implementan en su mayor parte la DB-API estndar de Python (http://www.python.
org/peps/pep-0249.html). Si no ests familiarizado con la DB-API de Python, observa que la sentencia SQL en
cursor.execute() usa placeholders, " %s", en lugar de agregar los parmetros directamente dentro de la SQL. Si usas
esta tcnica, la biblioteca subyacente de base de datos automticamente agregar comillas y secuencias de escape a
" %s", no
tus parmetros segn sea necesario. (Observar tambin que Django espera el placeholder
el placeholder
"?",
que es utilizado por los enlaces Python a SQLite. Python bindings. Esto es por consistencia y salud mental).
Una nota nal: Si todo lo que quieres hacer es usar una clusula
where, tables,
B.6.4.
params
WHERE
personalizada, puedes usar los argumentos
de la API estndar de bsqueda. Ver Apndice C.
Sobreescribiendo los Mtodos por omisin del Modelo
Como se explica en el Apndice C, cada modelo obtiene algunos mtodos automticamente -- los ms notables son
save()
delete().
Puedes sobreescribir estos mtodos para alterar el comportamiento.
Un caso de uso clsico de sobreescritura de los mtodos incorporados es cuando necesitas que suceda algo cuando
guardas un objeto, por ejemplo:
class Blog(models.Model):
name = models.CharField(maxlength=100)
tagline = models.TextField()
def save(self):
do_something()
super(Blog, self).save() # Call the "real" save() method.
do_something_else()
Tambin puedes evitar el guardado:
class Blog(models.Model):
name = models.CharField(maxlength=100)
tagline = models.TextField()
def save(self):
if self.name == "Yoko Ono's blog":
return # Yoko shall never have her own blog!
else:
super(Blog, self).save() # Call the "real" save() method
B.7.
Opciones del Administrador
La clase
Admin
le dice a Django cmo mostrar el modelo en el sitio de administracin.
Las siguientes secciones presentan una lista de todas las opciones posibles de
Admin.
Ninguna de estas opciones es
requerida. Para utilizar una interfaz de administracin sin especi car ninguna opcin, use
class Admin:
pass
Agregar
class Admin
a un modelo es completamente opcional.
revisin 757 del 28 de julio de 2008
pass,
como en:
B.7. OPCIONES DEL ADMINISTRADOR
B.7.1.
269
date_hierarchy
Establece
date_hierarchy con el nombre de un DateField o DateTimeField en tu modelo, y la pgina de la lista
de cambios incluir una navegacin basada en la fecha usando ese campo.
Aqu hay un ejemplo:
class CustomerOrder(models.Model):
order_date = models.DateTimeField()
...
class Admin:
date_hierarchy = "order_date"
B.7.2.
elds
Establece
fields
para controlar la disposicin de las pginas agregar y modi car de la interfaz de administra-
cin.
fields
es una estructura anidada bastante compleja que se demuestra mejor con un ejemplo. Lo siguiente est
tomado del modelo
FlatPage
que es parte de
django.contrib.flatpages:
class FlatPage(models.Model):
...
class Admin:
fields = (
(None, {
'fields': ('url', 'title', 'content', 'sites')
}),
('Advanced options', {
'classes': 'collapse',
'fields' : ('enable_comments', 'registration_required', 'template_name')
}),
)
Formalmente,
fields
es una lista de tuplas dobles, en la que cada tupla doble representa un
<fieldset> es una seccin del formulario.)
son de la forma (name, field_options), donde name es un string que
y field_options es un diccionario de informacin acerca del conjunto
<fieldset>
en el
formulario de la pgina de administracin. (Un
Las tuplas dobles
conjunto de campos,
representa el ttulo del
de campos, incluyendo
una lista de los campos a mostrar en l.
Si
fields no est de nido, Django mostrar por omisin cada campo que no sea un AutoField y tenga editable=True,
en un conjunto de campos simple, en el mismo orden en que aparecen los campos de nidos en el modelo.
El diccionario
field_options
puede tener las clave que se describen en la siguiente seccin.
elds
Una tupla de nombres de campo a mostrar en el conjunto de campos. Esta clave es requerida.
Para mostrar mltiples campos en la misma linea, encierra esos campos en su propia tupla. En este ejemplo, los
campos
first_name
last_name
se mostrarn en la misma lnea:
'fields': (('first_name', 'last_name'), 'address', 'city', 'state'),
classes
Un string conteniendo clases extra CSS para aplicar al conjunto de campos.
Aplica mltiples clases separndolas con espacios:
'classes': 'wide extrapretty',
collapse y wide. Los
collapse sern colapsados inicialmente en el sitio de administracin y reemplazados
por un pequeo enlace click to expand. Los conjuntos de campos con el estilo wide tendrn espacio horizontal extra.
Dos clases tiles de nidas por la hoja de estilo del sitio de administracin por omisin son
conjuntos de campos con el estilo
revisin 757 del 28 de julio de 2008
270
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
description
Un string de texto extra opcional para mostrar encima de cada conjunto de campos, bajo el encabezado del mismo.
Se usa tal cual es, de manera que puedes usar cualquier HTML, y debes crear las secuencias de escape correspondientes
para cualquier carcter especial HTML (como los ampersands).
B.7.3.
js
Una lista de strings representando URLs de archivos JavaScript a vincular en la pantalla de administracin mediante
etiquetas
<script src="">.
Esto puede ser usado para ajustar un tipo determinado de pgina de administracin en
JavaScript o para proveer quick links para llenar valores por omisin para ciertos campos.
http:// o /
settings.ADMIN_MEDIA_PREFIX.
Si usas URLs relativas -- esto es, URLs que no empiezan con
pre jar automticamente estos enlaces con
B.7.4.
-- entonces el sitio de administracin
list_display
Establece
list_display para controlar que campos se muestran en la pgina de la lista de
list_display, el sitio de administracin mostrar una columna simple
Si no se de ne
__str__()
de cada objeto.
Aqu hay algunos casos especiales a obsevar acerca de
Si el campo es una
ForeignKey,
No se admiten los campos
del administrador.
con la representacin
list_display:
Django mostrar el
__str__()
del objeto relacionado.
ManyToManyField, porque eso implicara la ejecucin de una sentencia SQL
separada para cada la en la tabla. Si de todas formas quieres hacer esto, dale a tu modelo un mtodo
personalizado, y agrega el nombre de ese mtodo a
personalizados en
list_display
BooleanField
True o False.
Si el campo es un
o en lugar de
list_display.
(Ms informacin sobre mtodos
en breve.)
o
NullBooleanField,
Django mostrar unos bonitos iconos on o
Si el string dado es un mtodo del modelo, Django lo invocar y mostrar la salida. Este mtodo debe
tener un atributo de funcin
short_description
para usar como encabezado del campo.
Aqu est un modelo de ejemplo completo:
class Person(models.Model):
name = models.CharField(maxlength=50)
birthday = models.DateField()
class Admin:
list_display = ('name', 'decade_born_in')
def decade_born_in(self):
return self.birthday.strftime(' %Y')[:3] + "0's"
decade_born_in.short_descripcin = 'Birth decade'
Si el string dado es un mtodo del modelo, Django har un HTML-escape de la salida por omisin.
Si no quieres 'escapear' la salida del mtodo, dale al mtodo un atributo
True.
allow_tags
con el valor en
Aqu est un modelo de ejemplo completo:
class Person(models.Model):
first_name = models.CharField(maxlength=50)
last_name = models.CharField(maxlength=50)
color_code = models.CharField(maxlength=6)
class Admin:
list_display = ('first_name', 'last_name', 'colored_name')
def colored_name(self):
return '<span style="color: # %s;"> %s %s</span>' % (self.color_code, self.first_name, self
colored_name.allow_tags = True
revisin 757 del 28 de julio de 2008
B.7. OPCIONES DEL ADMINISTRADOR
271
True
boolean con
False, Django
True.
Si el string dado es un mtodo del modelo que retorna
icono on o o si le das al mtodo un atributo
valor en
mostrar un bonito
Aqu est un modelo de ejemplo completo:
class Person(models.Model):
first_name = models.CharField(maxlength=50)
birthday = models.DateField()
class Admin:
list_display = ('name', 'born_in_fifties')
def born_in_fifties(self):
return self.birthday.strftime(' %Y')[:3] == 5
born_in_fifties.boolean = True
Los mtodos
__str__()
son tan vlidos en
list_display
como cualquieras otro mtodo del modelo,
por lo cual est perfectamente OK hacer esto:
list_display = ('__str__', 'some_other_field')
Usualmente, los elementos de
list_display
que no son campos de la base de datos no pueden ser
utilizados en ordenamientos (porque Django hace todo el ordenamiento a nivel de base de datos).
De todas formas, si un elemento de
list_display representa cierto campo de la base de datos, puedes
admin_order_field del tem, por ejemplo:
indicar este hecho estableciendo el atributo
class Person(models.Model):
first_name = models.CharField(maxlength=50)
color_code = models.CharField(maxlength=6)
class Admin:
list_display = ('first_name', 'colored_first_name')
def colored_first_name(self):
return '<span style="color: # %s;"> %s</span>' % (self.color_code, self.first_name)
colored_first_name.allow_tags = True
colored_first_name.admin_order_field = 'first_name'
El cdigo precedente le dir a Django que ordene segn el campo
por
B.7.5.
colored_first_name
first_name cuando trate de ordenar
en el sitio de administracin.
list_display_links
Establece
list_display_links
para controlar cuales campos de
list_display
deben ser vinculados a la pagina
de cambios de un objeto.
Por omisin, la pgina de la lista de cambios vincular la primera columna -- el primer campo especi cado en
list_display -- a la pgina de cambios de cada tem. Pero list_display_links te permite cambiar cules columnas
se vinculan. Establece list_display_links a una lista o tupla de nombres de campo (en el mismo formato que
list_display) para vincularlos.
list_display_links puede especi car uno o varios nombres de campo. Mientras los nombres de campo aparezcan
en list_display, a Django no le preocupa si los campos vinculados son muchos o pocos. El nico requerimiento es
que si quieres usarlist_display_links, debes de nir list_display.
En este ejemplo, los campos first_name y last_name sern vinculados a la pgina de la lista de cambios:
class Person(models.Model):
...
class Admin:
list_display = ('first_name', 'last_name', 'birthday')
list_display_links = ('first_name', 'last_name')
Finalmente, observa que para usar
list_display_links,
debes de nir tambin
revisin 757 del 28 de julio de 2008
list_display.
272
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
B.7.6.
list_ lter
Establece
list_filter
para activar los ltros en la barra lateral derecha de la pgina de la lista de cambios en la
interfaz de administracin. Debe ser una lista de nombres de campo, y cada campo especi cado debe ser de alguno de
BooleanField, DateField, DateTimeField, o ForeignKey.
django.contrib.auth.models.User muestra como trabajan ambos, list_display
list_filter:
los tipos
Este ejemplo, tomado del modelo
class User(models.Model):
...
class Admin:
list_display = ('username', 'email', 'first_name', 'last_name', 'is_staff')
list_filter = ('is_staff', 'is_superuser')
B.7.7.
list_per_page
Establece
list_per_page
para controlar cuantos items aparecen en cada pgina de la lista de cambios del admi-
nistrador. Por omisin, este valor se establece en
B.7.8.
100.
list_select_related
Establece
list_select_related para indicarle a Django que use select_related() al recuperar la lista de objetos
de la pgina de la lista de cambios del administrador. Esto puede ahorrarte una cantidad de consultas a la base de
datos si ests utilizando objetos relacionados en la lista de cambios que muestra el administrador.
True
El valor debe ser
ForeignKey.
Para ms detalles sobre
B.7.9.
False.
Por omisin es
select_related(),
False,
salvo que uno de los campos
list_display
sea una
ver Apndice C.
ordering
Establece
ordering
para especi car como deben ordenarse los objetos en la pgina de la lista de cambios del
administrador. Esto debe ser una lista o tupla en el mismo formato que el parmetro
ordering
del modelo.
Si no est de nido, la interfaz de administracin de Django usar el ordenamiento por omisin del modelo.
B.7.10.
save_as
Establece
save_as a True para habilitar la caracterstica save as
en los formularios de cambios del administrador.
Normalmente, los objetos tienen tres opciones al guardar: Save, Save and continue editing y Save and add
another. Si
save_as
es
True,
Save and add another ser reemplazado por un botn Save as.
Save as signi ca que el objeto ser guardado como un objeto nuevo (con un identi cador nuevo), en lugar del
objeto viejo.
Por omisin,
B.7.11.
save_as
es
False.
save_on_top
Establece
save_on_top para agregar botones de guardado a lo largo del encabezado de tus formularios de cambios
del administrador.
Normalmente, los botones de guardado aparecen solamente al pie de los formularios. Si estableces
save_on_top,
los botones aparecern en el encabezado y al pi del formulario.
Por omisin,
B.7.12.
save_on_top
es
False.
search_ elds
Establece
search_fields
para habilitar un cuadro de bsqueda en la pgina de la lista de cambios del adminis-
trador. Debe ser una lista de nombres de campo que se utilizar para la bsqueda cuando alguien enve una consulta
en ese cuadro de texto.
Estos campos deben ser de alguna tipo de campo de texto, como
una bsqueda relacionada sobre una
ForeignKey
CharField o TextField. Tambin puedes realizar
con la notacin de bsqueda de la API:
revisin 757 del 28 de julio de 2008
B.7. OPCIONES DEL ADMINISTRADOR
273
class Employee(models.Model):
department = models.ForeignKey(Department)
...
class Admin:
search_fields = ['department__name']
Cuando alguien hace una bsqueda en el cuadro de bsqueda del administrador, Django divide la consulta de
bsqueda en palabras y retorna todos los objetos que contengan alguna de las palabras, sin distinguir maysculas y
search_fields. Por ejemplo, si search_fields es
john lennon, Django har el equivalente a esta clusula WHERE
minsculas, donde cada palabra debe estar en al menos uno de los
['first_name', 'last_name']
y un usuario busca
en SQL:
WHERE (first_name ILIKE ' %john %' OR last_name ILIKE ' %john %')
AND (first_name ILIKE ' %lennon %' OR last_name ILIKE ' %lennon %')
Para bsquedas ms rpidas y/o ms restrictivas, agrega como pre jo al nombre de campo un operador como se
muestra en la Tabla B-7.
Cuadro B.7: Operadores Permitidos en search_ elds
Operador
Signi cado
el principio del campo. Por ejemplo, si search_fields es ['^first_name',
'^last_name'], y un usuario busca john lennon, Django har el equivalente a esta clusula WHERE en SQL:
WHERE (first_name ILIKE 'john %' OR last_name ILIKE 'john %')
AND (first_name ILIKE 'lennon %' OR last_name ILIKE 'lennon %')
Esta consulta es ms e ciente que la consulta ' %john %', dado que la base de datos solo necesita
Matchea
examinar el principio de una columna de datos, en lugar de buscar a travs de todos los datos
de la columna. Adems, si la columna tiene un ndice, algunas bases de datos pueden permitir
el uso del ndice para esta consulta, a pesar de que sea una consulta
LIKE.
search_fields es
['=first_name', '=last_name'] y un usuario busca john lennon, Django har el equivalente
a esta clausula WHERE en SQL:
WHERE (first_name ILIKE 'john' OR last_name ILIKE 'john')
AND (first_name ILIKE 'lennon' OR last_name ILIKE 'lennon')
Matchea exactamente, sin distinguir maysculas y minsculas. Por ejemplo, si
Observar que la entrada de la consulta se divide por los espacios, por lo cual actualmente no
es posible hacer una bsqueda de todos los registros en los cuales
'john winston'
@
first_name
es exactamente
(con un espacio en el medio).
Realiza una bsqueda en todo el texto. Es similar al mtodo de bsqueda predeterminado, pero
usa un ndice. Actualmente solo est disponible para MySQL.
revisin 757 del 28 de julio de 2008
274
APNDICE B. REFERENCIA DE LA DEFINICIN DE MODELOS
revisin 757 del 28 de julio de 2008
Apndice C
Referencia de la API de base de datos
La API de base de datos de Django es la otra mitad de la API de modelos discutido en el Apndice B. Una vez
que hayas de nido un modelo, usars esta API en cualquier momento que necesites acceder a la base de datos. Has
visto ejemplos del uso de esta API a travs del libro; este apndice explica todas las varias opciones detalladamente.
De manera similar a lo que ocurre con las APIs de modelos descriptos en el apndice B, aunque estas APIs son considerados muy estables, los desarrolladores de Django constantemente aaden nuevos atajos y conveniencias. Es buena
idea consultar siempre la documentacin en lnea ms actual que est disponible en
com/documentation/0.96/db-api/.
http://www.djangoproject.
A lo largo de este apndice, vamos a hacer referencia a los siguientes modelos, los cuales pueden formar una simple
aplicacin de blog:
from django.db import models
class Blog(models.Model):
name = models.CharField(max_length=100)
tagline = models.TextField()
def __str__(self):
return self.name
class Author(models.Model):
name = models.CharField(max_length=50)
email = models.EmailField()
def __str__(self):
return self.name
class Entry(models.Model):
blog = models.ForeignKey(Blog)
headline = models.CharField(max_length=255)
body_text = models.TextField()
pub_date = models.DateTimeField()
authors = models.ManyToManyField(Author)
def __str__(self):
return self.headline
C.1.
Creando Objetos
Para crear un objeto, crea una instancia de la clase modelo usando argumentos de palabra clave y luego llama a
save()
para grabarlo en la base de datos:
>>> from mysite.blog.models import Blog
>>> b = Blog(name='Beatles Blog', tagline='All the latest Beatles news.')
>>> b.save()
revisin 757 del 28 de julio de 2008
276
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
Esto, detrs de escena, ejecuta una sentencia SQL
explcitamente invoques a
El mtodo
save()
save().
INSERT.
Django no accede a la base de datos hasta que t
no retorna nada.
Para crear un objeto y grabarlo todo en un paso revisa el mtodo
create
de la clase
Manager
que describiremos
en breve.
C.1.1.
Qu pasa cuando grabas?
Cuando grabas un objeto, Django realiza los siguientes pasos:
1.
Emitir una seal pre_save. Esto provee una noti cacin de que un objeto est a punto de
*listener* que ser invocado en cuanto esta seal sea emitida.
ser grabado. Puedes registrar un
Estas seales todava estn en desarrollo y no estaban documentadas cuando este libro fue a
impresin; revisa la documentacin en lnea para obtener la informacin ms actual.
2.
Pre-procesar los datos. Se le solicita a cada campo del objeto implementar cualquier modi cacin automatizada de datos que pudiera necesitar realizar.
La mayora de los campos no realizan pre-procesamiento -- los datos del campo se guardan tal
como estn. Slo se usa pre-procesamiento en campos que tienen comportamiento especial, como
campos de archivo.
3.
Preparar los datos para la base de datos. Se le solicita a cada campo que provea su valor
actual en un tipo de dato que puede ser grabado en la base de datos.
La mayora de los campos no requieren preparacin de los datos. Los tipos de datos simples,
como enteros y cadenas, estn listos para escribir como un objeto de Python. Sin embargo,
DateFields
datetime Python para almacenar datos. Las bases de datos no almacenan objetos
tipo de datos ms complejos requieren a menudo alguna modi cacin. Por ejemplo,
usa un objeto
datetime,
de manera que el valor del campo debe ser convertido en una cadena de fecha que
cumpla con la norma ISO correspondiente para la insercin en la base de datos.
4.
Insertar los datos en la base. Los datos pre-procesados y preparados son entonces incorporados en una sentencia SQL para su insercin en la base de datos.
5.
Emitir una seal post_save. Como con la seal
pre_save, esta es utilizada para proporcionar
noti cacin de que un objeto ha sido grabado satisfactoriamente. De nuevo, estas seales todava
no han sido documentadas.
C.1.2.
Claves primarias autoincrementales
Por conveniencia, a cada modelo se le da una clave primaria autoincremental llamada
primary_key=True en el campo (ver la seccin titulada AutoField en el
Si tu modelo tiene un AutoField, ese valor incrementado automticamente ser
atributo de tu objeto la primera vez que llames a save():
especi ques
id a menos que explcitamente
Apndice B).
calculado y grabado como un
>>> b2 = Blog(name='Cheddar Talk', tagline='Thoughts on cheese.')
>>> b2.id
# Returns None, because b doesn't have an ID yet.
None
>>> b2.save()
>>> b2.id
# Returns the ID of your new object.
14
No hay forma de saber cual ser el valor de un identi cador antes que llames a
save() esto se debe a que ese valor
es calculado por tu base de datos, no por Django.
Si un modelo tiene un
AutoField
pero quieres de nir el identi cador de un nuevo objeto explcitamente cuando
grabas, solo defnelo explcitamente antes de grabarlo en vez de con ar en la asignacin automtica de valor del
identi cador:
>>>
>>>
3
>>>
>>>
3
b3 = Blog(id=3, name='Cheddar Talk', tagline='Thoughts on cheese.')
b3.id
b3.save()
b3.id
revisin 757 del 28 de julio de 2008
C.2. GRABANDO CAMBIOS DE OBJETOS
277
Si asignas manualmente valores de claves primarias autoincrementales Asegrate de no usar un valor de clave
primaria que ya existe!. Si creas un objeto con un valor explcito de clave primaria que ya existe en la base de datos,
Django asumir que ests cambiando el registro existente en vez de crear uno nuevo.
Dado el ejemplo precedente de blog
'Cheddar Talk',
este ejemplo sobrescribira el registro previo en la base de
datos:
>>> b4 = Blog(id=3, name='Not Cheddar', tagline='Anything but cheese.')
>>> b4.save() # Overrides the previous blog with ID=3!
El especi car explcitamente valores de claves primarias autoincrementales es ms til cuando se estn grabando
objetos en lotes, cuando ests seguro de que no tendrs colisiones de claves primarias.
C.2.
Grabando cambios de objetos
save().
Blog b5 que ya ha sido grabada en la base de datos, este ejemplo cambia su nombre y actualiza
Para grabar los cambios hechos a un objeto que existe en la base de datos, usa
Dada la instancia de
su registro en la base:
>>> b5.name = 'New name'
>>> b5.save()
Detrs de escena, esto ejecuta una sentencia SQL
que llamas explcitamente a
save().
Como sabe Django cuando usar
UPDATE.
UPDATE
De nuevo: Django no accede a la base de datos hasta
y cuando usar
INSERT
save() para
INSERT o UPDATE.
Habrs notado que los objetos de base de datos de Django usan el mismo mtodo
crear y cambiar objetos. Django abstrae la necesidad de usar sentencias SQL
Espec camente, cuando llamas a
save(),
Django sigue este algoritmo:
Si el atributo clave primaria del objeto tiene asignado un valor que evala
(esto es, un valor distinto a
consulta
SELECT
None
True
o a la cadena vaca) Django ejecuta una
para determinar si existe un registro con la clave primaria es-
peci cada.
Si el registro con la clave primaria especi cada ya existe, Django ejecuta una
consulta
UPDATE.
Si el atributo clave primaria del objeto no tiene valor o si lo tiene pero no existe
un registro, Django ejecuta un
INSERT.
Debido a esto, debes tener cuidado de no especi car un valor explcito para una clave primaria
cuando grabas nuevos objetos si es que no puedes garantizar que el valor de clave primaria est
disponible para ser usado.
La actualizacin de campos
ForeignKey
funciona exactamente de la misma forma; simplemente asigna un objeto
del tipo correcto al campo en cuestin:
>>> joe = Author.objects.create(name="Joe")
>>> entry.author = joe
>>> entry.save()
Django se quejar si intentas asignar un objeto del tipo incorrecto.
C.3.
Recuperando objetos
A travs del libro has visto cmo se recuperan objetos usando cdigo como el siguiente:
>>> blogs = Blog.objects.filter(author__name__contains="Joe")
Hay bastantes partes mviles detrs de escena aqu: cuando recuperas objetos de la base de datos, ests construyendo
realmente un
QuerySet
usando el
Manager
del modelo. Este
QuerySet
sabe como ejecutar SQL y retornar los objetos
solicitados.
revisin 757 del 28 de julio de 2008
278
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
El Apndice B trat ambos objetos desde el punto de vista de la de nicin del modelo; ahora vamos a ver cmo
funcionan.
QuerySet
Un
representa una coleccin de objetos de tu base de datos. Puede tener cero, uno, o muchos ltros --
QuerySet se compara a
SELECT y un ltro es una clusula de limitacin como por ejemplo WHERE o LIMIT.
Consigues un QuerySet usando el Manager del modelo. Cada modelo tiene por lo menos un Manager y tiene, por
omisin, el nombre objects. Accede al mismo directamente a travs de la clase del modelo, as:
criterios que limitan la coleccin basados en parmetros provistos. En trminos de SQL un
una declaracin
>>> Blog.objects
<django.db.models.manager.Manager object at 0x137d00d>
Los
Managers
solo son accesibles a travs de las clases de los modelos, en vez desde una instancia de un modelo,
para as hacer cumplir con la separacin entre las operaciones a nivel de tabla y las operaciones a nivel de registro:
>>> b = Blog(name='Foo', tagline='Bar')
>>> b.objects
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: Manager isn't accessible via Blog instances.
Manager es la principal fuente de QuerySets para un modelo. Acta como un QuerySet raz que describe todos
Blog.objects es el QuerySets inicial que contiene
los objetos Blog en la base de datos.
El
los objetos de la tabla de base de datos del modelo. Por ejemplo,
todos
C.4.
Caching y QuerySets
QuerySet
Cada
contiene un cache, para minimizar el acceso a la base de datos. Es importante entender como
funciona, para escribir cdigo mas e ciente.
En un
QuerySet
recin creado, el cache esta vaco. La primera vez que un
QuerySet
es evaluado -- y, por lo tanto,
ocurre un acceso a la base de datos -- Django graba el resultado de la consulta en el cache del
QuerySet
y retorna
los resultados que han sido solicitados explcitamente (por ejemplo, el siguiente elemento, si se est iterando sobre el
QuerySet).
Evaluaciones subsecuentes del
QuerySet
re-usan los resultados alojados en el cache.
Ten presente este comportamiento de caching, porque puede morderte si no usas tus
ejemplo, lo siguiente crear dos
QuerySets,
QuerySets correctamente. Por
los evaluar, y los descartar:
print [e.headline for e in Entry.objects.all()]
print [e.pub_date for e in Entry.objects.all()]
Eso signi ca que la consulta sera ejecutada dos veces en la base de datos, duplicando la carga sobre la misma.
Tambin existe una posibilidad de que las dos listas pudieran no incluir los mismos registros de la base de datos, porque
se podra haber agregado o borrado un
Entry
durante el pequesimo perodo de tiempo entre ambas peticiones.
Para evitar este problema, simplemente graba el
QuerySet
y re-salo:
queryset = Poll.objects.all()
print [p.headline for p in queryset] # Evaluate the query set.
print [p.pub_date for p in queryset] # Reuse the cache from the evaluation.
C.5.
Filtrando objetos
La manera mas simple de recuperar objetos de una tabla es conseguirlos todos. Para hacer esto, usa el mtodo
all()
en un
Manager:
>>> Entry.objects.all()
El mtodo
all()
retorna un
QuerySet
de todos los objetos de la base de datos.
Sin embargo, usualmente solo necesitars seleccionar un subconjunto del conjunto completo de objetos. Para crear
QuerySet
exclude():
tal subconjunto, re nas el
mtodos
filter()
y/o
inicial, aadiendo condiciones con ltros. Usualmente hars esto usando los
>>> y2006 = Entry.objects.filter(pub_date__year=2006)
>>> not2006 = Entry.objects.exclude(pub_date__year=2006)
Tanto
filter()
como
exclude()
toman argumentos de patrones de bsqueda, los cuales se discutirn detallada-
mente en breve.
revisin 757 del 28 de julio de 2008
C.5. FILTRANDO OBJETOS
C.5.1.
279
Encadenando ltros
El resultado de re nar un
QuerySet
es otro
QuerySet
as que es posible enlazar re namientos, por ejemplo:
>>> qs = Entry.objects.filter(headline__startswith='What')
>>> qs = qs..exclude(pub_date__gte=datetime.datetime.now())
>>> qs = qs.filter(pub_date__gte=datetime.datetime(2005, 1, 1))
Esto toma el
QuerySet
inicial de todas las entradas en la base de datos, agrega un ltro, luego una exclusin,
y luego otro ltro. El resultado nal es un
QuerySet
conteniendo todas las entradas con un ttulo que empieza con
What que fueron publicadas entre Enero 1, 2005, y el da actual.
Es importante precisar aqu que los
QuerySet
son perezosos -- el acto de crear un
QuerySet
no implica ninguna
actividad en la base de datos. De hecho, las tres lneas precedentes no hacen ninguna llamada a la base de datos;
puedes enlazar/encadenar ltros todo el da y Django no ejecutar realmente la consulta hasta que el
evaluado.
Puedes evaluar un
QuerySet
Iterando : Un
QuerySet
en cualquiera de las siguientes formas:
QuerySet es iterable, y ejecuta su consulta en la base de datos la primera vez que iteras
QuerySet no es evaluado hasta que se iterado sobre l en el bucle
sobre el. Por ejemplo, el siguiente
for:
qs = Entry.objects.filter(pub_date__year=2006)
qs = qs.filter(headline__icontains="bill")
for e in qs:
print e.headline
Esto imprime todos los ttulos desde el 2006 que contienen bill pero genera solo un acceso a la base
de datos.
Imprimindolo : Un
QuerySet
es evaluado cuando ejecutas
repr()
sobre el mismo. Esto es por con-
veniencia en el interprete interactivo Python, as puedes ver inmediatamente tus resultados cuando
usas el API interactivamente.
Rebanado : Segn lo explicado en la prxima seccin Limitando QuerySets, un
QuerySet
rebanado usando la sintaxis de rebanado de arreglos de Python. Usualmente el rebanar un
retorna otro
QuerySet
puede ser
QuerySet
(no evaluado), pero Django ejecutar la consulta a la base de datos si usas el
parmetro step de la sintaxis de rebanado.
Convirtiendo a una lista : Puedes forzar la evaluacin de un
QuerySet
ejecutando
list()
sobre el
mismo, por ejemplo:
>>> entry_list = list(Entry.objects.all())
Sin embargo, quedas advertido de que esto podra signi car un gran impacto en la memoria porque
Django cargar cada elemento de la lista en memoria. En cambio, el iterar sobre un
QuerySet
sacar
ventaja de tu base de datos para cargar datos e inicializar objetos solo a medida que vas necesitando
los mismos.
Los QuerySets ltrados son nicos
Cada vez que re nas un
QuerySet
obtienes un nuevo
QuerySet que no est de ninguna manera
QuerySet separado y distinto que puede
atado al QuerySet` anterior. Cada re namiento crea un
ser almacenado, usado y re-usado:
q1 = Entry.objects.filter(headline__startswith="What")
q2 = q1.exclude(pub_date__gte=datetime.now())
q3 = q1.filter(pub_date__gte=datetime.now())
Estos tres
QuerySets
son separados. El primero es un
QuerySet
base que contiene todas las
entradas que contienen un ttulo que empieza con What. El segundo es un sub-conjunto del
primero, con un criterio adicional que excluye los registros cuyo
pub_date es mayor que el da de
hoy. El tercero es un sub-conjunto del primero, con un criterio adicional que selecciona solo los
registros cuyo
pub_date
es mayor que el da de hoy. El
QuerySet
inicial (q1) no es afectado por
el proceso de re namiento.
revisin 757 del 28 de julio de 2008
sea
280
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
C.5.2.
Limitando QuerySets
Usa la sintaxis de rebanado de arreglos de Python para limitar tu
es equivalente a las clausulas de SQL de
LIMIT
OFFSET.
Por ejemplo, esto retorna las primeras cinco entradas (LIMIT
QuerySet a un cierto nmero de resultados. Esto
5):
>>> Entry.objects.all()[:5]
Esto retorna las entradas desde la sexta hasta la dcima (OFFSET
5 LIMIT 5):
>>> Entry.objects.all()[5:10]
Generalmente, el rebanar un
QuerySet
QuerySet
retorna un nuevo
-- no evala la consulta. Una excepcin es si
usas el parmetro step de la sintaxis de rebanado de Python. Por ejemplo, esto realmente ejecutara la consulta con
el objetivo de retornar una lista, objeto de por medio de los primeros diez:
>>> Entry.objects.all()[:10:2]
SELECT foo FROM bar LIMIT 1) usa un simple ndice
Entry en la base de datos, despus de ordenar las entradas
Para recuperar un solo objeto en vez de una lista (por ej.
en vez de un rebanado. Por ejemplo, esto retorna el primer
alfabticamente por ttulo:
>>> Entry.objects.order_by('headline')[0]
y es equivalente a lo siguiente:
>>> Entry.objects.order_by('headline')[0:1].get()
Nota, sin embargo, que el primero de estos generar
IndexError
mientras el segundo generar
DoesNotExist
si
ninguno de los objetos coincide con el criterio dado.
C.5.3.
Mtodos de consulta que retornan nuevos QuerySets
Django provee una variedad de mtodos de re namiento de
retornados por el
QuerySet
QuerySet
que modi can ya sea los tipos de resultados
o la forma como se ejecuta su consulta SQL. Estos mtodos se describen en las secciones
que siguen. Algunos de estos mtodos reciben argumentos de patrones de bsqueda, los cuales se discuten en detalle
mas adelante.
lter(**lookup)
Retorna un nuevo
QuerySet
conteniendo objetos que son iguales a los parmetros de bsqueda provistos.
QuerySet
conteniendo objetos que no son iguales a los parmetros de bsqueda provistos.
exclude(**kwargs)
Retorna un nuevo
order_by(*campos)
Por omisin, los resultados retornados por un
por la opcin
ordering
QuerySet
estn ordenados por la tupla de ordenamiento indicada
en los metadatos del modelo (ver Apndice B). Puedes sobrescribir esto para una consulta
particular usando el mtodo
order_by():
>>> Entry.objects.filter(pub_date__year=2005).order_by('-pub_date', 'headline')
pub_date de forma descendente, luego por headline de forma ascendente. El
"-pub_date" indica orden descendiente. Si el - esta ausente se asume un orden ascendente.
aleatoriamente, usa "?", as:
Este resultado ser ordenado por
signo negativo en frente de
Para ordenar
>>> Entry.objects.order_by('?')
distinct()
Retorna un nuevo
QuerySet
que usa
SELECT DISTINCT
en su consulta SQL. Esto elimina las duplicadas en el
resultado de la misma.
Por omisin, un
QuerySet no eliminar las duplicadas. En la prctica esto raramente es un
Blog.objects.all() no introducen la posibilidad de registros duplicados.
problema porque
consultas simples como
Sin embargo, si tu consulta abarca mltiples tablas, es posible obtener resultados duplicados cuando un
es evaluado. Esos son los casos en los que usaras
distinct().
revisin 757 del 28 de julio de 2008
QuerySet
C.5. FILTRANDO OBJETOS
281
values(*campos)
Retorna un
QuerySet especial que evala a una lista de diccionarios en lugar de objetos instancia de modelo. Cada
uno de esos diccionarios representa un objeto, con las las claves en correspondencia con los nombre de los atributos de
los objetos modelo:
# This list contains a Blog object.
>>> Blog.objects.filter(name__startswith='Beatles')
[Beatles Blog]
# This list contains a dictionary.
>>> Blog.objects.filter(name__startswith='Beatles').values()
[{'id': 1, 'name': 'Beatles Blog', 'tagline': 'All the latest Beatles news.'}]
values() puede recibir argumentos posicionales opcionales, *campos, los cuales especi can los nombres de campos
SELECT. Si especi cas los campos, cada diccionario contendr solamente las claves/valores
a los cuales debe limitarse el
de campos para los campos que especi ques. Si no especi cas los campos, cada diccionario contendr una clave y un
valor para todos los campos en la table de base de datos:
>>> Blog.objects.values()
[{'id': 1, 'name': 'Beatles Blog', 'tagline': 'All the latest Beatles news.'}],
>>> Blog.objects.values('id', 'name')
[{'id': 1, 'name': 'Beatles Blog'}]
Este mtodo es til cuando sabes de antemano que solo vas a necesitar valores de un pequeo nmero de los
campos disponibles y no necesitars la funcionalidad de un objeto instancia de modelo. Es ms e ciente el seleccionar
solamente los campos que necesitas usar.
dates(campo, tipo, orden)
Retorna un
QuerySet
datetime.datetime que representan todas las
QuerySet.
campo debe ser el nombre de un DateField o de un DateTimeField de tu modelo. El argumento
sea year, month o day. Cada objeto datetime.datetime en la lista de resultados es truncado de
especial que evala a una lista de objetos
fechas disponibles de un cierto tipo en el contenido de la
El argumento
tipo
debe ser ya
acuerdo al
tipo
provisto:
"year"
retorna una lista de todos los valores de aos distintos entre s para el campo.
"month"
"day"
retorna una lista de todos los valores de aos/mes distintos entre s para el campo.
retorna una lista de todos los valores de aos/mes/da distintos entre s para el campo.
orden, cuyo valor por omisin es 'ASC', debe ser 'ASC' o 'DESC'. El mismo especi ca cmo ordenar los resultados.
Aqu tenemos algunos ejemplos:
>>> Entry.objects.dates('pub_date', 'year')
[datetime.datetime(2005, 1, 1)]
>>> Entry.objects.dates('pub_date', 'month')
[datetime.datetime(2005, 2, 1), datetime.datetime(2005, 3, 1)]
>>> Entry.objects.dates('pub_date', 'day')
[datetime.datetime(2005, 2, 20), datetime.datetime(2005, 3, 20)]
>>> Entry.objects.dates('pub_date', 'day', order='DESC')
[datetime.datetime(2005, 3, 20), datetime.datetime(2005, 2, 20)]
>>> Entry.objects.filter(headline__contains='Lennon').dates('pub_date', 'day')
[datetime.datetime(2005, 3, 20)]
revisin 757 del 28 de julio de 2008
282
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
select_related()
Retorna un
QuerySet que seguir automticamente relaciones de clave fornea, seleccionando esos datos adicionales
de objetos relacionados cuando ejecuta su consulta. Esto contribuye a la mejora de rendimiento que resulta en consultas
(aveces mucho) ms grandes pero signi can que el uso posterior de relaciones de clave fornea no requerirn consultas
a la base de datos.
Los siguientes ejemplos ilustran la diferencia entre bsquedas normales y bsquedas
select_related().
Esta es
una bsqueda normal:
# Hits the database.
>>> e = Entry.objects.get(id=5)
# Hits the database again to get the related Blog object.
>>> b = e.blog
Esta es una bsqueda
select_related:
# Hits the database.
>>> e = Entry.objects.select_related().get(id=5)
# Doesn't hit the database, because e.blog has been prepopulated
# in the previous query.
>>> b = e.blog
select_related()
sigue claves forneas tan lejos como le sea posible. Si tienes los siguientes modelos:
class City(models.Model):
# ...
class Person(models.Model):
# ...
hometown = models.ForeignKey(City)
class Book(models.Model):
# ...
author = models.ForeignKey(Person)
entonces una llamada a
y la
City
Book.objects.select_related().get(id=4)
colocar en el cache la
Person
relacionada
relacionada:
>>> b = Book.objects.select_related().get(id=4)
>>> p = b.author
# Doesn't hit the database.
>>> c = p.hometown
# Doesn't hit the database.
>>> b = Book.objects.get(id=4) # No select_related() in this example.
>>> p = b.author
# Hits the database.
>>> c = p.hometown
# Hits the database.
Notar que
select_related no sigue claves forneas que tienen null=True.
select_related() puede mejorar muchsimo el desempeo porque tu aplicacin puede puede
Usualmente, el usar
entonces evitar muchas llamadas a la base de datos. Sin embargo, en siuaciones con conjuntos de relaciones profundamente anidadas,
select_related()
puede en algunos casos terminar siguiendo demasiadas relaciones y puede
generar consultas tan grandes que terminan siendo lentas.
extra()
A veces, el lenguaje de consulta de Django no puede expresar facilmente clusulas
extremos, Django provee un modi cador de
dentro del SQL generado por un
QuerySet.
QuerySet
llamado
extra()
WHERE complejas. Para estos casos
-- una forma de inyectar clusulas especi cas
Por de nicin, estas consultas especiales pueden no ser portables entre los distintos motores de bases de datos
(debido a que ests escribiendo cdigo SQL explcito) y violan el principio DRY, as que deberas evitarlas de ser
posible.
revisin 757 del 28 de julio de 2008
C.5. FILTRANDO OBJETOS
283
Se puede especi car uno o ms de
params, select, where,
tables.
Ninguno de los argumentos es obligatorio,
pero deberas indicar al menos uno.
El argumento
select permite indicar campos adicionales en una clusula de SELECT. Debe contener un diccionario
que mapee nombres de atributo a clusulas SQL que se utilizarn para calcular el atributo en cuestin:
>>> Entry.objects.extra(select={'is_recent': "pub_date > '2006-01-01'"})
Como resultado, cada objeto
sentar si el atributo
pub_date
Entry
tendr en este caso un atributo adicional,
is_recent,
del entry es mayor que el 1 de Enero de 2006.
El siguiente ejemplo es ms avanzado; realiza una subconsulta para darle a cada objeto
entry_count,
un entero que indica la cantidad de objetos
Entry
un booleano que repre-
Blog resultante un atributo
asociados al blog:
>>> subq = 'SELECT COUNT(*) FROM blog_entry WHERE blog_entry.blog_id = blog_blog.id'
>>> Blog.objects.extra(select={'entry_count': subq})
(En este caso en particular, estamos aprovechando el hecho de que la consulta ya contiene la tabla
su clusula
FROM.)
Tambin es posible de nir clusulas
where.
blog_blog
en
WHERE explcitas -- quizs para realizar joins implcitos -- usando el argumento
FROM del SQL usando el argumento tables.
una lista de cadenas. Todos los argumentos de where son unidos con AND a
Se puede agregar tablas manualmente a la clusula
Tanto
where
como
tables
reciben
cualquier otro criterio de bsqueda:
>>> Entry.objects.extra(where=['id IN (3, 4, 5, 20)'])
select y where antes descriptos pueden utilizar los comodines normales para bases de datos en
' %s' para indicar parmetros que deberan ser escapados automticamente por el motor de la base de datos.
argumento params es una lista de los parmetros que sern utilizados para realizar la sustitucin:
Los parmetros
Python:
El
>>> Entry.objects.extra(where=['headline= %s'], params=['Lennon'])
Siempre se debe utilizar
params
en vez de utilizar valores directamente en
select
where
ya que
params
asegura
que los valores sern escapados correctamente de acuerdo con tu motor de base de datos particular.
Este es un ejemplo de lo que est incorrecto:
Entry.objects.extra(where=["headline=' %s'" % name])
Este es un ejemplo de lo que es correcto:
Entry.objects.extra(where=['headline= %s'], params=[name])
C.5.4.
Metodos de
Los mtodos de
QuerySet
QuerySet
QuerySet
que no devuelven un
QuerySet
que se describen a continuacin evaluan el
QuerySet
y devuelven algo que no es un
-- un objeto, un valor, o algo as.
get(**lookup)
Devuelve el objeto que matchee el parmetro de bsqueda provisto. El parmetro debe proveerse de la manera
descripta en la seccin Patrones de bsqueda. Este mtodo levanta
AssertionError si ms de un objecto concuerda
con el patrn provisto.
Si no se encuentra ningn objeto que coincida con el patrn de bsqueda provisto
DoesNotExist.
get()
levanta una excepcin de
Esta excepcin es un atributo de la clase del modelo, por ejemplo:
>>> Entry.objects.get(id='foo') # levanta Entry.DoesNotExist
La excepcin
DoesNotExist hereda de django.core.exceptions.ObjectDoesNotExist, as que puedes protegerte
DoesNotExist:
de mltiples excepciones
>>> from django.core.exceptions import ObjectDoesNotExist
>>> try:
...
e = Entry.objects.get(id=3)
...
b = Blog.objects.get(id=1)
... except ObjectDoesNotExist:
...
print "Either the entry or blog doesn't exist."
revisin 757 del 28 de julio de 2008
284
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
create(**kwargs)
Este mtodo sirve para crear un objeto y guardarlo en un mismo paso. Te permite abreviar dos pasos comunes:
>>> p = Person(first_name="Bruce", last_name="Springsteen")
>>> p.save()
en una sola lnea:
>>> p = Person.objects.create(first_name="Bruce", last_name="Springsteen")
get_or_create(**kwargs)
Este mtodo sirve para buscar un objeto y crearlo si no existe. Devuelve una tupla
object
es el objecto encontrado o creado, y
created
(object, created),
donde
es un booleano que indica si el objeto fue creado.
Est pensado como un atajo para el caso de uso tpico y es ms que nada til para scripts de importacin de datos,
por ejemplo:
try:
obj = Person.objects.get(first_name='John', last_name='Lennon')
except Person.DoesNotExist:
obj = Person(first_name='John', last_name='Lennon', birthday=date(1940, 10, 9))
obj.save()
Este patrn se vuelve inmanejable a medida que aumenta el nmero de campos en el modelo. El ejemplo anterior
puede ser escrito usando
obj, created =
first_name
last_name
defaults
)
get_or_create
as:
Person.objects.get_or_create(
= 'John',
= 'Lennon',
= {'birthday': date(1940, 10, 9)}
get_or_create() -- excepto el argumento opcional defaults -- ser utilizado
get_or_create devolver una tupla con ese objeto y False. Si
get_or_create() instanciar y guardar un objeto nuevo, devolviendo una tupla con el
Cualquier argumento que se le pase a
en una llamada a
get().
Si se encuentra un objecto,
no se encuentra un objeto,
nuevo objeto y
True.
El nuevo objeto ser creado de acuerdo con el siguiente algoritmo:
defaults = kwargs.pop('defaults', {})
params = dict([(k, v) for k, v in kwargs.items() if '__' not in k])
params.update(defaults)
obj = self.model(**params)
obj.save()
Esto es, se comienza con los argumentos que no sean
'defaults'
indicara una bsqueda no exacta). Luego se le agrega el contenido de
y que no contengan doble guin bajo (lo cual
defaults,
sobreescribiendo cualquier valor que
ya estuviera asignado, y se usa el resultado como claves para el constructor del modelo.
defaults y es necesario usarlo para una bsqueda exacta en get_or_create(),
'defaults__exact' as:
Si el modelo tiene un campo llamado
simplemente hay que utilizar
Foo.objects.get_or_create(
defaults__exact = 'bar',
defaults={'defaults': 'baz'}
)
Nota
Como ya se mencion,
get_or_create
es utilizado ms que nada en scripts que necesiten pro-
cesar datos y crear nuevos campos si los que existen no estn disponibles. Si necesitas utilizar
get_or_create()
POST salvo que
GET no deberan afectar los datos de ningu-
en una vista, por favor asegurate de utilizarlo solo en pedidos
tengas una buena razn para no hacerlo. Los pedidos
na manera; se debe utilizar
POST
en cualquier pedido a una pgina que pueda tener como efecto
secundario una modi cacin a tus datos.
revisin 757 del 28 de julio de 2008
C.6. PATRONES DE BSQUEDA
285
count()
Devuelve un entero representando el nmero de objetos en la base de datos que coincidan con el
QuerySet. count()
nunca levanta excepciones. He aqu un ejemplo:
# Returns the total number of entries in the database.
>>> Entry.objects.count()
4
# Returns the number of entries whose headline contains 'Lennon'
>>> Entry.objects.filter(headline__contains='Lennon').count()
1
count() en el fondo realiza un SELECT COUNT(*), as que deberas siempre utilizar count() en vez de cargar todos
len() sobre el resultado.
Dependiendo de la base de datos que ests utilizando (e.g., PostgreSQL o MySQL), count() podra devolver
los registros en objetos Python y luego invocar
un entero largo en vez de un entero normal de Python. Esto es una caracterstica particular de la implementacin
subyacente que no debera ser ningn problema en la vida real.
in_bulk(id_list)
Este mtodo toma una lista de claves primarias y devuelve un diccionario que mapea cada clave primaria en una
instancia con el ID dado, por ejemplo:
>>>
{1:
>>>
{1:
>>>
{}
Blog.objects.in_bulk([1])
Beatles Blog}
Blog.objects.in_bulk([1, 2])
Beatles Blog, 2: Cheddar Talk}
Blog.objects.in_bulk([])
Si no se encuentra un objeto en la base para un ID en particular, este id no aparecer en el diccionario resultante.
Si le pasas una lista vaca a
in_bulk(),
obtendrs un diccionario vaco.
latest( eld_name=None)
Devuelve el ltimo objeto de la tabla, ordenados por fecha, utilizando el campo que se provea en el argumento
field_name como fecha. Este ejemplo devuelve el Entry ms reciente en la tabla, de acuerdo con el campo pub_date:
>>> Entry.objects.latest('pub_date')
Si el
Meta
get_latest_by, se puede omitir el argumento field_name. Django utilizar
get_latest_by por defecto.
get(), latest() levanta DoesNotExist si no existe un objeto con los parmetros provistos.
de tu modelo especi ca
el
campo indicado en
Al igual que
C.6.
Patrones de bsqueda
WHERE de SQL. Consisten de
filter(), exclude() y get() de QuerySet.
toman la forma de campo__tipodebusqueda=valor (notar el doble guin
Los patrones de bsqueda son la manera en que se especi ca la carne de una clusula
argumentos de palabra clave para los mtodos
Los parmetros bsicos de bsqueda
bajo). Por ejemplo:
>>> Entry.objects.filter(pub_date__lte='2006-01-01')
se traduce (aproximadamente) al siguiente comando SQL:
SELECT * FROM blog_entry WHERE pub_date <= '2006-01-01';
Si se suministra un argumento de palabra clave invlido, la funcin levantar una excepcin de
A continuacin se listan los tipos de bsqueda que existen.
revisin 757 del 28 de julio de 2008
TypeError.
286
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
C.6.1.
exact
Realiza una bsqueda por coincidencias exactas:
>>> Entry.objects.get(headline__exact="Man bites dog")
Esto busca objetos que tengan en el campo headline la frase exacta Man bites dog.
Si no se suministra un tipo de bsqueda -- O sea, si tu argumento de palabra clave no contiene un doble guin bajo
-- el tipo de bsqueda se asume como
exact.
Por ejemplo, las siguientes dos sentencias son equivalentes:
>>> Blog.objects.get(id__exact=14) # Explicit form
>>> Blog.objects.get(id=14) # __exact is implied
Esto es por conveniencia, dado que las bsquedas con tipo de bsqueda
C.6.2.
exact
son las ms frecuentes.
iexact
Realiza una bsqueda por coincidencias exactas sin distinguir maysculas de minsculas:
>>> Blog.objects.get(name__iexact='beatles blog')
Traer objetos con nombre
C.6.3.
'Beatles Blog', 'beatles blog', 'BeAtLes BLoG',
etctera.
contains
Realiza una bsqueda de subcadenas, distinguiendo maysculas y minsculas:
Entry.objects.get(headline__contains='Lennon')
Esto coincidir con el titular
SQLite no admite sentencias
comporta como
icontains.
'Today Lennon honored' pero no con 'today lennon honored'.
LIKE distinguiendo maysculas y minsculas; cuando se utiliza SQLite, contains
Escapado de porciento y guin bajo en sentencias
LIKE
LIKE (iexact, contains, icontains,
iendswith) escaparn automticamente los dos caracteres especiales utilizados en sentencias LIKE -- el porciento y el guin bajo. (En una sentencia
LIKE, el smbolo de porciento indica una secuencia de caracteres cualesquiera, y el guin bajo
Los patrones de bsqueda que resulten en sentencias SQL
startswith, istartswith, endswith,
indica un solo caracter cualquiera).
Esto signi ca que las cosas deberan funcionar de manera intuitiva, por que la abstraccin funciona bien. Por ejemplo, para obtener todos los Entries que contengan un smbolo de porciento,
simplemente hace falta utilizar el smbolo de porcentaje como cualquier otro caracter:
Entry.objects.filter(headline__contains=' %')
Django se hace cargo del escapado. El SQL resultante ser algo similar a esto:
SELECT ... WHERE headline LIKE ' %\ % %';
Lo mismo vale para el guin bajo. Tanto el smbolo de porcentaje como el guin bajo se deberan
manejar de manera transparente.
C.6.4.
icontains
Realiza una bsqueda de subcadenas, sin distinguir maysculas y minsculas:
>>> Entry.objects.get(headline__icontains='Lennon')
A diferencia de
contains, icontains
s trer
today lennon honored.
revisin 757 del 28 de julio de 2008
se
C.6. PATRONES DE BSQUEDA
C.6.5.
287
gt, gte, lt, and lte
Estos representan los operadores de mayor a, mayor o igual a, menor a, y menor o igual a, respectivamente:
>>> Entry.objects.filter(id__gt=4)
>>> Entry.objects.filter(id__lt=15)
>>> Entry.objects.filter(id__gte=0)
Estas consultas devuelven cualquier objeto con un ID mayor a 4, un ID menor a 15, y un ID mayor o igual a 1,
respectivamente.
Por lo general estos operadores se utilizarn con campos numricos. Se debe tener cuidado con los campos de
caracteres, ya que el orden no siempre es el que uno se esperara (i.e., la cadena 4 resulta ser mayor que la cadena
10).
C.6.6.
in
Aplica un ltro para encontrar valores en una lista dada:
Entry.objects.filter(id__in=[1, 3, 4])
Esto devolver todos los objetos que tengan un ID de 1, 3 o 4.
C.6.7.
startswith
Busca coincidencias de pre jos distinguiendo maysculas y minsculas:
>>> Entry.objects.filter(headline__startswith='Will')
Esto encontrar los titulares Will he run` y Willbur named judge, pero no Who is Will` o will found in crypt.
C.6.8.
istartswith
Realiza una bsqueda por pre jos, sin distinguir maysculas y minsculas:
>>> Entry.objects.filter(headline__istartswith='will')
Esto devolver los titulares Will he run`, Willbur named judge, y will found in crypt, pero no Who is Will`
C.6.9.
endswith and iendswith
Realiza bsqueda de su jos, distinguiendo y sin distinguir maysculas de minsculas, respectivamente:
>>> Entry.objects.filter(headline__endswith='cats')
>>> Entry.objects.filter(headline__iendswith='cats')
C.6.10.
range
Realiza una bsqueda por rango:
>>> start_date = datetime.date(2005, 1, 1)
>>> end_date = datetime.date(2005, 3, 31)
>>> Entry.objects.filter(pub_date__range=(start_date, end_date))
Se puede utilizar
range en cualquier lugar donde podras utilizar BETWEEN en SQL -- para fechas, nmeros, e incluso
cadenas de caracteres.
C.6.11.
year, month, and day
Para campos
date
datetime,
realiza bsqueda exacta por ao, mes o da:
revisin 757 del 28 de julio de 2008
288
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
# Bsqueda por ao
>>>Entry.objects.filter(pub_date__year=2005)
# Bsqueda por mes -- toma enteros
>>> Entry.objects.filter(pub_date__month=12)
# Bsqueda por da
>>> Entry.objects.filter(pub_date__day=3)
# Combinacin: devuelve todas las entradas de Navidad de cualquier ao
>>> Entry.objects.filter(pub_date__month=12, pub_date_day=25)
C.6.12.
isnull
Toma valores
True o False, que correspondern a consultas SQL de IS NULL``y ``IS NOT NULL, respectivamente:
>>> Entry.objects.filter(pub_date__isnull=True)
__isnull=True
vs.
__exact=None
Hay una diferencia importante entre
__isnull=True
__exact=None. __exact=None
siempre
devolver como resultado un conjunto vaco, ya que SQL requiere que ningn valor sea igual
a
NULL. __isnull
determina si el campo actualmente contiene un valor
NULL
sin realizar la
comparacin.
C.6.13.
search
Un booleano que realiza bsquedas
full-text,
que aprovecha el indexado
pero signi cativamente ms rpido debido al indexado
full-text.
full-text.
Esto es como
contains
Ntese que este tipo de bsqueda slo est disponible en MySQL y requiere de manipulacin directa de la base de
datos para agregar el ndice
C.6.14.
full-text.
El patrn de bsqueda pk
Por conveniencia, Django provee un patrn de bsqueda
modelo (pk por
En el
primary key, del ingls).
modelo de ejemplo Blog, la clave
pk,
primaria es el campo
que realiza una bsqueda sobre la clave primaria del
id,
as que estas sentencias seran equivalentes:
>>> Blog.objects.get(id__exact=14) # Forma explcita
>>> Blog.objects.get(id=14) # __exact implcito
>>> Blog.objects.get(pk=14) # pk implica id__exact
El uso de
pk
no se limita a bsquedas
__exact
-- cualquier patrn de bsqueda puede ser combinado con
realizar una bsqueda sobre la clave primaria de un modelo:
# Buscar entradas en blogs con id 1, 4, o 7
>>> Blog.objects.filter(pk__in=[1,4,7])
# Buscar entradas en blogs con id > 14
>>> Blog.objects.filter(pk__gt=14)
Las bsquedas
pk
tambin funcionan con joins. Por ejemplo, estas tres sentencias son equivalentes:
>>> Entry.objects.filter(blog__id__exact=3) # Forma explcita
>>> Entry.objects.filter(blog__id=3) # __exact implcito
>>> Entry.objects.filter(blog__pk=3) # __pk implica __id__exact
revisin 757 del 28 de julio de 2008
pk
para
C.7. BSQUEDAS COMPLEJAS CON OBJETOS Q
C.7.
289
Bsquedas complejas con Objetos Q
Los argumentos de palabras clave en las bsquedas -- en
filter() por ejemplo -- son unidos con AND. Si necesitas
OR), puedes utilizar objetos Q.
realizar bsquedas ms complejas (e.g., bsquedas con sentencias
Un objeto
Q (django.db.models.Q)
es un objeto que se utiliza para encapsular una coleccin de argumentos de
palabra clave. Estos argumentos de palabra clave son especi cados como se indica en la seccin Patrones de bsqueda.
Por ejemplo, este objeto
encapsula una consulta con un nico
LIKE:
Q(question__startswith='What')
Los objetos
pueden ser combinados utilizando los operadores
objetos, se obtiene un nuevo objeto
Q.
Por ejemplo, un
OR
&
|.
de dos consultas
Cuando se utiliza un operador sobre dos
question__startswith
sera:
Q(question__startswith='Who') | Q(question__startswith='What')
Esto ser equivalente a la siguiente clusula
WHERE
en SQL:
WHERE question LIKE 'Who %' OR question LIKE 'What %'
Puede componer sentencias de complejidad arbitraria combinando objetos
pueden utilizar parntesis para agrupar.
Cualquier funcin de bsqueda que tome argumentos de palabra clave (e.g.,
recibir tambin uno o ms objetos
con los operadores
&
|.
Tambin se
filter(), exclude(), get())
puede
como argumento posicional (no nombrado). Si se proveen multiples objetos
como argumentos a una funcin de bsqueda, los argumentos sern unidos con AND, por ejemplo:
Poll.objects.get(
Q(question__startswith='Who'),
Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6))
)
se traduce aproximadamente al siguiente SQL:
SELECT * from polls WHERE question LIKE 'Who %'
AND (pub_date = '2005-05-02' OR pub_date = '2005-05-06')
Las funciones de bsqueda pueden adems mezclar el uso de objetos
y de argumentos de palabra clave. Todos
Q) son unidos con
Q debe preceder la de nicin de todos los argumentos de palabra clave. Por
los argumentos provistos a una funcin de bsqueda (sean argumentos de palabra clave u objetos
AND. Sin embargo, si se provee un objeto
ejemplo, lo siguiente:
Poll.objects.get(
Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6)),
question__startswith='Who')
es una consulta vlida, equivalente al ejemplo anterior, pero esto:
# CONSULTA INVALIDA
Poll.objects.get(
question__startswith='Who',
Q(pub_date=date(2005, 5, 2)) | Q(pub_date=date(2005, 5, 6)))
no es vlido.
Hay algunos ejemplos disponibles online en http://www.djangoproject.com/documentation/0.96/models/or_lookups/
.
C.8.
Objetos Relacionados
Cuando de nes una relacin en un modelo (i.e. un
ForeignKey, OneToOneField, or ManyToManyField), las instan-
cias de ese modelo tendrn una API conveniente para acceder a estos objetos relacionados.
Por ejemplo, si
e es un objeto Entry, puede acceder a su Blog asociado accediendo al atributo blog, esto es e.blog.
Django tambin crea una API para acceder al otro lado de la relacin -- el vnculo del modelo relacionado al
b es un
entry_set: b.entry_set.all().
modelo que de ne la relacin. Por ejemplo, si
travs del atributo
objeto
Blog,
tiene acceso a la lista de todos los objetos
Todos los ejemplos en esta seccin utilizan los modelos de ejemplo
Entry
Blog, Author y Entry que se de nen al principio
de esta seccin.
revisin 757 del 28 de julio de 2008
290
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
C.8.1.
Consultas Que Cruzan Relaciones
Django ofrece un mecanismo poderoso e intuitivo para seguir relaciones cuando se realizan bsquedas, hacindose
cargo de los
JOINs
de SQL de manera automtica. Para cruzar una relacin simplemente hace falta utilizar el nombre
de campo de los campos relacionados entre modelos, separados por dos guiones bajos, hasta que llegues al campo que
necesitabas.
Este ejemplo busca todos los objetos
Entry
que tengan un
Blog
cuyo
nombre
sea
'Beatles Blog':
>>> Entry.objects.filter(blog__name__exact='Beatles Blog')
Este camino puede ser tan largo como quieras.
Tambin Funciona en la otra direccin. Para referirse a una relacin inversa, simplemente hay que utilizar el
nombre en minsculas del modelo.
Este ejemplo busca todos los objetos
Blog
que tengan al menos un
Entry
cuyo
headline
contenga
'Lennon':
>>> Blog.objects.filter(entry__headline__contains='Lennon')
C.8.2.
Relaciones de Clave Fornea
Si un modelo contiene un
ForeignKey, las
instancias de ese modelo tendrn acceso al objeto relacionado (forneo)
va un simple atributo del modelo, por ejemplo:
e = Entry.objects.get(id=2)
e.blog # Devuelve el objeto Blog relacionado
Se puede acceder y asignar el valor de la clave fornea va el atributo. Como sera de esperar, los cambios a la clave
fornea no se guardan en el modelo hasta que invoques el mtodo
save(),
por ejemplo:
e = Entry.objects.get(id=2)
e.blog = some_blog
e.save()
Si un campo
ForeignKey
tiene la opcin
null=True
seteada (i.e. permite valores
NULL),
se le puede asignar
None:
e = Entry.objects.get(id=2)
e.blog = None
e.save() # "UPDATE blog_entry SET blog_id = NULL ...;"
El acceso a relaciones uno-a-muchos se almacena la primera vez que se accede al objeto relacionado. Cualquier
acceso subsiguiente a la clave fornea del mismo objeto son cacheadas, por ejemplo:
e = Entry.objects.get(id=2)
print e.blog # Busca el Blog asociado en la base de datos.
print e.blog # No va a la base de datos; usa la versin cacheada.
Notar que el mtodo de
QuerySet select_related()
busca inmediatamente todos los objetos de relaciones uno-
a-muchos de la instancia:
e = Entry.objects.select_related().get(id=2)
print e.blog # No va a la base de datos; usa la versin cacheada.
print e.blog # No va a la base de datos; usa la versin cacheada.
select_related()
C.8.3.
est documentada en la seccin Mtodos de consulta que retornan nuevos QuerySets.
Relaciones de Clave Forenea Inversas
Las relaciones de clave fornea son automticamente simtricas -- se in ere una relacin inversa de la presencia de
un campo
ForeignKey
que apunte a otro modelo.
ForeignKey, las instancias del modelo de la clave fornea tendrn acceso a un Manager que
Manager se llama FOO_set, donde FOO es el nombre
modelo que contiene la clave fornea, todo en minsculas. Este Manager devuelve QuerySets, que pueden ser ltradas
Si un modelo tiene una
devuelve todas las instancias del primer modelo. Por defecto, este
y manipuladas como se describe en la seccin Recuperando objetos.
Aqu se muestra un ejemplo:
revisin 757 del 28 de julio de 2008
C.8. OBJETOS RELACIONADOS
291
b = Blog.objects.get(id=1)
b.entry_set.all() # Encontrar todos los objetos Entry relacionados a b.
# b.entry_set es un Manager que devuelve QuerySets.
b.entry_set.filter(headline__contains='Lennon')
b.entry_set.count()
Se puede cambiar el nombre del atributo FOO_set indicando el parmetro related_name en la de nicin del
ForeignKey(). Por ejemplo, si el modelo Entry fuera cambiado por blog = ForeignKey(Blog, related_name='entries'),
el ejemplo anterior pasara a ser as:
b = Blog.objects.get(id=1)
b.entries.all() # Encontrar todos los objetos Entry relacionados a b.
# b.entries es un Manager que devuelve QuerySets.
b.entries.filter(headline__contains='Lennon')
b.entries.count()
No se puede acceder al
Manager de ForeignKey inverso desde la clase misma; debe ser accedido desde una instancia:
Blog.entry_set # Raises AttributeError: "Manager must be accessed via instance".
Adems de los metodos de
QuerySet
de nidos en la seccin Recuperando Objetos, el
Manager
de
ForeignKey
tiene los siguientes mtodos adicionales:
add(obj1, obj2, ...):
Agrega los objetos del modelo indicado al conjunto de objetos relacionados,
por ejemplo:
b = Blog.objects.get(id=1)
e = Entry.objects.get(id=234)
b.entry_set.add(e) # Associates Entry e with Blog b.
create(**kwargs): Crea un nuevo objeto, lo guarda, y lo deja en el conjunto de objetos relacionados.
Devuelve el objeto recin creado:
b = Blog.objects.get(id=1)
e = b.entry_set.create(headline='Hello', body_text='Hi', pub_date=datetime.date(2005, 1, 1)
# No hace falta llamar a e.save() ac -- ya ha sido guardado
Esto es equivalente a (pero ms simple que) lo siguiente:
b = Blog.objects.get(id=1)
e = Entry(blog=b, headline='Hello', body_text='Hi', pub_date=datetime.date(2005, 1, 1))
e.save()
Notar que no es necesario especi car el argumento de palabra clave correspondiente al modelo que
de ne la relacin. En el ejemplo anterior, no le pasamos el parmetro
que el campo
blog
del nuevo
remove(obj1, obj2, ...):
Entry
debera ser
b.
blog a create(). Django deduce
Quita los objetos indicados del conjunto de objetos relacionados:
b = Blog.objects.get(id=1)
e = Entry.objects.get(id=234)
b.entry_set.remove(e) # Desasociar al Entry e del Blog b.
ForeignKey donde
null=True. Si el campo relacionado no puede pasar ser None (NULL), entonces un objeto no puede ser
quitado de una relacin sin ser agregado a otra. En el ejemplo anterior, el quitar a e de b.entry_set()
es equivalente a hacer e.blog = None, y dado que la de nicin del campo ForeignKey blog (en el
modelo Entry) no indica null=True, esto es una accin invlida.
Para evitar inconsistencias en la base de datos, este mtodo slo existe para objetos
clear():
Quita todos los objetos del conjunto de objetos relacionados:
b = Blog.objects.get(id=1)
b.entry_set.clear()
Notar que esto no borra los objetos relacionados -- simplemente los desasocia.
Al igual que
remove(), clear
solo est disponible para campos
ForeignKey
revisin 757 del 28 de julio de 2008
donde
null=True.
292
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
Para asignar todos los miembros de un conjunto relacionado en un solo paso, simplemente se le asigna al conjunto
un objeto iterable, por ejemplo:
b = Blog.objects.get(id=1)
b.entry_set = [e1, e2]
Si el mtodo
clear()
est de nido, todos los objetos pre-existentes sern quitados del
entry_set antes de que
clear() no est
todos los objetos en el iterable (en este caso, la lista) sean agregados al conjunto. Si el mtodo
disponible, todos los objetos del iterable son agregados al conjunto sin quitar antes los objetos pre-existentes.
Todas las operaciones inversas de nidas en esta seccin tienen efectos inmediatos en la base de datos. Toda
creacin, borradura y agregado son inmediata y automticamente grabados en la base de datos.
C.8.4.
Relaciones muchos-a-muchos
Ambos extremos de las relaciones muchos-a-muchos obtienen una API de acceso automticamente. La API funciona
igual que las funciones inversas de las relaciones uno-a-muchos (descriptas en la seccin anterior).
La nica diferencia es el nombrado de los atributos: el modelo que de ne el campo
ManyToManyField usa el nombre
del atributo del campo mismo, mientras que el modelo inverso utiliza el nombre del modelo original, en minsculas,
con el su jo
'_set'
(tal como lo hacen las relaciones uno-a-muchos).
Un ejemplo de esto lo har ms fcil de entender:
e = Entry.objects.get(id=3)
e.authors.all() # Devuelve todos los objetos Author para este Entry.
e.authors.count()
e.authors.filter(name__contains='John')
a = Author.objects.get(id=5)
a.entry_set.all() # Devuelve todos los obejtos Entry para este Author.
ForeignKey, los ManyToManyField pueden indicar un related_name. En el ejemplo
ManyToManyField en el modelo Entry indicara related_name='entries', cualquier instancia de
atributo entries en vez de entry_set.
Al igual que los campos
anterior, si el campo
Author
tendra un
Cmo son posibles las relaciones inversas?
El mapeador objeto-relacional requiere que de nas relaciones en ambos extremos. Los desarrolladores Django creen que esto es una violacin del principio DRY (Don't Repeat Yourself ), as que
Django slo te exige que de nas la relacin en uno de los extremos. Pero cmo es esto posible,
dado que una clase modelo no sabe qu otros modelos se relacionan con l hasta que los otros
modelos sean cargados?
INSTALLED_APPS. La primera vez que se carga cualquier modelo,
INSTALLED_APPS y crea las relaciones inversas en memoria
como sea necesario. Esencialmente, una de las funciones de INSTALLES_APPS es indicarle a Django
La respuesta yace en la variable
Django itera sobre todos los modelos en
el dominio completo de modelos que se utiliza.
C.8.5.
Consultas que Abarcan Objetos Relacionados
Las consultas que involucran objetos relacionados siguen las mismas reglas que las consultas que involucran campos
normales. Cuando se indica el valor que se requiere en una bsqueda, se puede utilizar tanto una instancia del modelo
o bien el valor de la clave primaria del objeto.
Por ejemplo, si
es un objeto
Blog
con
id=5,
las tres siguientes consultas son idnticas:
Entry.objects.filter(blog=b) # Query using object instance
Entry.objects.filter(blog=b.id) # Query using id from instance
Entry.objects.filter(blog=5) # Query using id directly
C.9.
Borrando Objectos
El mtodos para borrar se llama
delete().
Este mtodo inmediatamente borra el objeto y no tiene ningn valor
de retorno:
revisin 757 del 28 de julio de 2008
C.10. MTODOS DE INSTANCIA ADICIONALES
293
e.delete()
Tambin se puede borrar objetos en grupo. Todo objeto
miembros de ese
QuerySet.
QuerySet
Por ejemplo, esto borra todos los objetos
tiene un mtodo
Entry
delete()
que borra todos los
que tengan un ao de
pub_date
igual a
2005:
Entry.objects.filter(pub_date__year=2005).delete()
Cuando Django borra un objeto, emula el comportamiento de la restriccin de SQL
ON DELETE CASCADE -- en otras
palabras, todos los objetos que tengan una clave fornea que apunte al objeto que est siendo borrado sern borrados
tambin, por ejemplo:
b = Blog.objects.get(pk=1)
# Esto borra el Blog y todos sus objetos Entry.
b.delete()
Notar que
delete()
es el nico mtodo de
QuerySet
Manager mismo. Esto es un
Entry.objects.delete() y borres todos los Entry.
que no est expuesto en el
mecanismo de seguridad para evitar que accidentalmente solicites
Si realmente quieres borrar todos los objetos, hay que pedirlo explcitamente al conjunto completo de objetos:
Entry.objects.all().delete()
C.10.
Mtodos de Instancia Adicionales
Adems de
C.10.1.
save()
delete(),
un objeto modelo puede tener cualquiera o todos de los siguientes mtodos.
get_FOO_display()
Por cada campo que indica la opcin
choices,
el objeto tendr un mtodo
get_FOO_display(),
donde
FOO
es
el nombre del campo. Este mtodo devuelve el valor humanamente legible del campo. Por ejemplo, en el siguiente
modelo:
GENDER_CHOICES = (
('M', 'Male'),
('F', 'Female'),
)
class Person(models.Model):
name = models.CharField(max_length=20)
gender = models.CharField(max_length=1, choices=GENDER_CHOICES)
cada instancia de
Person
tendr un mtodo
get_gender_display:
>>> p = Person(name='John', gender='M')
>>> p.save()
>>> p.gender
'M'
>>> p.get_gender_display()
'Male'
C.10.2.
get_next_by_FOO(**kwargs) y get_previous_by_FOO(**kwargs)
Por cada campo DateField y DateTimeField que no tenga null=True, el objeto tendr dos mtodos get_next_by_FOO()
get_previous_by_FOO(), donde FOO es el nombre del campo. Estos mtodos devuelven el objeto siguiente y anterior
en orden cronolgico respecto del campo en cuestin, respectivamente, levantando la excepcin DoesNotExist cuando
y
no exista tal objeto.
Ambos mtodos aceptan argumentos de palabra clave opcionales, que deberan ser de la forma descripta en la
seccin Patrones de bsqueda.
Notar que en el caso de valores de fecha idnticos, estos mtodos utilizarn el ID como un chequeo secundario. Esto
garantiza que no se saltearn registros ni aparecern duplicados. Hay un ejemplo completo en los ejemplos de la API
de bsqueda, en
http://www.djangoproject.com/documentation/0.96/models/lookup/.
revisin 757 del 28 de julio de 2008
294
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
C.10.3.
get_FOO_ lename()
Todo campo
FileField
le dar al objeto un mtodo
get_FOO_filename(),
donde
FOO
es el nombre del campo.
Esto devuelve el nombre de archivo completo en el sistema de archivos, de acuerdo con la variable
Notar que el campo
campo
ImageField
C.10.4.
ImageField
es tcnicamente una subclase de
FileField,
MEDIA_ROOT.
as que todo modelo que tenga un
obtendr tambin este mtodo.
get_FOO_url()
FileField
Por todo campo
el objeto tendr un mtodo
get_FOO_url(), donde FOO es el nombre del campo. Este
MEDIA_URL. Si esta variable est vaca, el mtodo
mtodo devuelve la URL al archivo, de acuerdo con tu variable
devolver una cadena vaca.
C.10.5.
get_FOO_size()
FileField el objeto tendr un mtodo get_FOO_size(), donde FOO es el nombre del campo. Este
os.path.getsize.)
Por cada campo
mtodo devuelve el tamao del archivo, en bytes. (La implementacin de este mtodo utiliza
C.10.6.
save_FOO_ le( lename, raw_contents)
Por cada campo
FileField,
el objeto tendr un mtodo
save_FOO_file(),
donde
FOO
es el nombre del campo.
Este mtodo guarda el archivo en el sistema de archivos, utilizando el nombre dado. Si un archivo con el nombre dado
ya existe, Django le agrega guiones bajos al nal del nombre de archivo (pero antes de la extensin) hasta que el
nombre de archivos est disponible.
C.10.7.
get_FOO_height() and get_FOO_width()
Por cada campo
ImageField, el objeto obtendr dos mtodos, get_FOO_height() y get_FOO_width(), donde FOO
es el nombre del campo. Estos mtodos devuelven el alto y el ancho (respectivamente) de la imagen, en pixeles, como
un entero.
C.11.
Atajos (Shortcuts)
A medida que desarrolles tus vistas, descubrirs una serie de modismos en la manera de utilizar la API de la base
de datos. Django codi ca algunos de estos modismos como atajos que pueden ser utilizados par simpli car el proceso
de escribir vistas. Estas funciones se pueden hallar en el mdulo
C.11.1.
django.shortcuts.
get_object_or_404()
get() y levantar un Http404 si el objeto no existe. Este modismo es capturado
get_object_or_404(). Esta funcion toma un modelo Django como su primer argumento, y una cantidad
arbitraria de argumentos de palabra clave, que le pasa al mtodo get() del Manager por defecto del modelo. Luego
levanta un Http404 si el objeto no existe, por ejemplo:
Un modismo frecuente es llamar a
en la funcin
# Get the Entry with a primary key of 3
e = get_object_or_404(Entry, pk=3)
Cuando se le pasa un modelo a esta funcin, se utiliza el
Manager
por defecto para ejecutar la consulta
get()
subyacente. Si no quieres que se utilice el manager por defecto, o si quiere buscar en una lista de objetos relacionados,
se le puede pasar a
get_object_or_404()
un objeto
Manager
en vez:
# Get the author of blog instance e with a name of 'Fred'
a = get_object_or_404(e.authors, name='Fred')
# Use a custom manager 'recent_entries' in the search for an
# entry with a primary key of 3
e = get_object_or_404(Entry.recent_entries, pk=3)
revisin 757 del 28 de julio de 2008
C.12. UTILIZANDO SQL CRUDO
C.11.2.
get_list_or_404()
get_list_or_404() se comporta igual que get_object_or_404(),
get(). Levanta un Http404 si la lista resulta vaca.
C.12.
295
salvo porque llama a
filter()
en vez de a
Utilizando SQL Crudo
Si te encuentras necesitando escribir una consulta SQL que es demasiado compleja para manejarlo con el mapeador
de base de datos de Django, todava puede optar por escribir la sentencia directamente en SQL crudo.
La forma preferida para hacer esto es dndole a tu modelo mtodos personalizados o mtodos de
Manager persona-
lizados que realicen las consultas. Aunque no exista ningn requisito en Django que exija que las consultas a la base
de datos vivan en la capa del modelo, esta implementacin pone a toda tu lgica de acceso a los datos en un mismo
lugar, lo cual es una idea astuta desde el punto de vista de organizacin del cdigo. Por ms instrucciones, vase el
Apndice B..
Finalmente, es importante notar que la capa de base de datos de Django es meramente una interfaz a tu base de
datos. Puedes acceder a la base de datos utilizando otras herramientas, lenguajes de programacin o frameworks de
bases de datos -- No hay nada espec camente de Django acerca de tu base de datos.
revisin 757 del 28 de julio de 2008
296
APNDICE C. REFERENCIA DE LA API DE BASE DE DATOS
revisin 757 del 28 de julio de 2008
Apndice D
Referencia de las vistas genricas
El Captulo 9 es una introduccin a las vistas genricas, pero pasa por alto algunos detalles . Este apndice describe
todas las vistas genricas, junto con las opciones que cada una de ellas puede aceptar. Antes de intentar entender este
material de referencia es muy conveniente leer el Captulo 9 . Tampoco viene mal un repaso a los modelos
Publisher
D.1.
Author
Book,
de nidos en dicho captulo, ya que sern usados en los ejemplo incluidos en esta apndice.
Argumentos comunes a todas las vistas genricas
La mayora de las vistas aceptan varios argumentos que pueden modi car su comportamiento. Muchos de esos
argumentos funcionan igual para la mayora de las vistas. La tabla D-1 describe estos argumentos comunes; cada vez
que veas uno de estos argumentos en la lista de parmetros admitidos por una vista genrica, su comportamiento ser
tal y como se describe en esta tabla.
Cuadro D.1: Argumentos comunes de las vistas genricas.
Argumento
allow_empty
Descripcin
Un valor booleano que indica como debe comportarse la vista si
no hay objetos disponibles. Si vale
False y no hay objetos, la vista
elevar un error 404 en vez de mostrar una pgina vaca. Su valor
por defecto es
context_processors
Falsa.
Es una lista de procesadores de contexto adicionales (adems de los
incluidos por el sistema), que se aplican a la plantilla de la vista. En
el
`Captulo 10`_ se explica con detalle la lista de procesadores
de contexto adicionales.
extra_context
Un diccionario cuyos valores se aaden al contexto de la plantilla.
Si se almacena un objeto que sea invocable, la vista genrica lo
ejecutar justo antes de representar la plantilla
mimetype
El tipo MIME a usar para el documento resultante. Por defecto
utiliza
el
tipo
DEFAULT_MIME_TYPE,
queryset
Un
objeto
de
de nido
en
la
variable
de
con guracin
text/html.
QuerySet
(por
cuyo valor inicial es
Author.objects.all())
tipo
ejemplo,
del cual se leern los objetos a uti-
lizar por la vista. En el apndice C hay ms informacin acerca de
los objetos
QuerySet. La mayora de las vistas genricas necesitan
este argumento.
template_loader
El
cargador
de
plantillas
django.template.loader.
Vase
utilizar.
el
Por
`Captulo
defecto
es
10`_ donde
se da ms informacin acerca de los cargadores de plantillas.
template_name
El nombre completo de la plantilla a usar para representar la pgina. Este argumento se puede usar si queremos modi car el nombre
que se genera automticamente a partir del
revisin 757 del 28 de julio de 2008
QuerySet.
298
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
Cuadro D.1: Argumentos comunes de las vistas genricas.
Argumento
Descripcin
template_object_name
El nombre de la variable principal en el contexto de la plantilla.
Por defecto, es
'object'. Para las listas que utilizan ms de objeto
(por ejemplo, las vistas de listados o de archivos por fechas), se
aade el su jo
'_list' al valor de este parmetro, as que si no se
indica nada y la vista utiliza varios objetos, estos estarn accesibles
mediante una variable llamada
D.2.
object_list.
Vistas genricas simples
Dentro del mdulo
django.views.generic.simple hay varias vistas sencillas que manejan unos cuantos problemas
frecuentes: mostrar una plantilla que no necesita una vista lgica, y hacer una redireccin de una pgina.
D.2.1.
Representar una plantilla
Vista a importar :
django.views.generic.simple.direct_to_template
Esta vista representa una plantilla, a la que se le pasa una variable de plantilla accesible como
{{ params }},
que es un diccionario que contiene los parmetros capturados de la URL, si los hubiera.
Ejemplo
Dada la siguiente con guracin del URLconf:
from django.conf.urls.defaults import *
from django.views.generic.simple import direct_to_template
urlpatterns = patterns('',
(r'^foo/$',
direct_to_template, {'template': 'foo_index.html'}),
(r'^foo/(?P<id>\d+)/$', direct_to_template, {'template': 'foo_detail.html'}),
)
Una peticin a
/foo/ mostrara la plantilla foo_index.html, y una solicitud a /foo/15/ mostrara foo_detail.html
{{ params.id }} cuyo valor sera 15.
con una variable de contexto
Argumentos obligatorios
template:
D.2.2.
El nombre completo de la plantilla a representar.
Redirigir a otra URL
Vista a importar :
django.views.generic.simple.redirect_to
Esta vista redirige a otra URL. La URL que se pasa como parmetro puede tener secuencias de formato aptas para
diccionarios, que sern interpretadas contra los parmetros capturados desde la URL origen.
Si la URL pasada como parmetro es
None,
Django retornar un mensaje de error 410 (Gone segn el estndar
HTTP).
Ejemplo
Este URLconf redirige desde
/foo/<id>/
/bar/<id>/:
from django.conf.urls.defaults import *
from django.views.generic.simple import redirect_to
urlpatterns = patterns('django.views.generic.simple',
('^foo/(?p<id>\d+)/$', redirect_to, {'url': '/bar/ %(id)s/'}),
)
Este ejemplo devuelve una respuesta Gone para cualquier peticin a
/bar/:
revisin 757 del 28 de julio de 2008
D.3. VISTAS DE LISTADO/DETALLE
299
from django.views.generic.simple import redirect_to
urlpatterns = patterns('django.views.generic.simple',
('^bar/$', redirect_to, {'url': None}),
)
Argumentos obligatorios
url:
La URL a la que redirigir, en forma de cadena de texto, o
None
si quereremos devolver una
respuesta 410 (Gone segn el estndar HTTP).
D.3.
Vistas de listado/detalle
Las vistas genricas de listados/detalle (que residen en el mdulo
Django.views.generic.list_detail) se encar-
gan de la habitual tarea de mostrar una lista de elementos por un lado (el listado) y una vista individual para cada
uno de los elementos (el detalle).
D.3.1.
Listas de objetos
Vista a importar :
django.views.generic.list_detail.object_list
Esta vista sirve para representear una lista de objetos.
Ejemplo
Si consideramos el objeto
Author
tal y como se de ni en el captulo 5, podemos usar la vista
object_list
obtener un listado sencillo de todos los autores usando el siguiente URLconf:
from mysite.books.models import Author
from django.conf.urls.defaults import *
from django.views.generic import list_detail
author_list_info = {
'queryset' :
Author.objects.all(),
'allow_empty': True,
}
urlpatterns = patterns('',
(r'authors/$', list_detail.object_list, author_list_info)
)
Argumentos obligatorios
queryset:
Un
QuerySet
de los objetos a listar (Vase la table D-1).
Argumentos opcionales
paginate_by:
es un nmero entero que especi ca cuantos objetos se deben mostrar en cada pgina.
Segn se especi que en este parmetro, los resultados sern paginados, de forma que se distribuirn
por varias pginas de resultado. La vista determinar que pgina de resultados debe mostrar o bien
desde un parmetro
page
incluido en la URL (va
Get)
o mediante una variable
page
especi cada en
el URLconf. En cualquiera de los dos casos, el ndice comienza en cero. En la siguiente seccin hay
una nota sobre paginacin donde se explica con un poco ms de detalle este sistema.
Adems, esta vidta acepta cualquiera de los siguientes argumentos opcionales descritos en la tabla D-1:
allow_empty
context_processors
extra_context
mimetype
revisin 757 del 28 de julio de 2008
para
300
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se ha especi cado el parmetro opcional
template_name, la vista usar una plantilla llamada <app_label>/<model_name>_l
queryset. La etiqueta de
Tanto la etiqueta de la aplicacin como la etiqueta del modelo se obtienen del parmetro
aplicacin es el nombre de la aplicacin en que se ha de nido el modelo, y la etiqueta de modelo es el nombre, en
minsculas, de la clase del modelo.
queryset sera Author.objects.all(), por lo que la etiqueta de la
books y el nombre del modelo es author. Con esos datos, el nombre de la plantilla a utilizar por
books/author_list.html.
En el ejemplo anterior, tendriamos que el
aplicacin ser
defecto ser
Contexto de plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
object_list: La lista de los objetos. El nombre de la variable viene determinado por el parmetro
template_object_name, y vale 'object' por defecto. Si se de niera template_object_name como
'foo', el nombre de esta variable sera foo_list.
is_paginated: Un valor booleano que indicar si los resultados sern paginados o no. Concretamente,
valdr False si el nmero de objetos disponibles es inferior o igual a paginate_by.
Si los resultados estn paginados, el contexto dispondr tambin de estas variables:
results_per_page: El nmero de objetos por pgina. (Su valor es el mismo que el del parmetro
paginate_by).
has_next: Un valor booleano indicando si hay una siguiente pgina.
has_previous: Un valor booleano indicando si hay una pgina previa.
page: El nmero de la pgina actual, siendo 1 la primera pgina.
next: El nmero de la siguiente pgina. Incluso si no hubiera siguiente pgina, este valor seguir siendo un numero entero que apuntara a una hipottica siguiente pgina. Tambin utiliza
un ndice basado en 1, no en cero.
previous: El nmero de la anterior pgina, usando un ndice basado en 1, no
pages: El nmero total de pginas.
hits: El nmero total de objetos en todas las pginas, no slo en la actual.
en cero.
Una nota sobre paginacin
Si se utiliza el parmetro
paginate_by, Django paginar los resultados. Puedes indicar qu pagina
visualizar usando dos mtodos diferentes:
Usar un parmetro
page
en el URLconf. Por ejemplo, tu URLconf podra pare-
cerse a este:
(r'^objects/page(?P<page>[0-9]+)/$', 'object_list', dict(info_dict))
Pasar el nmero de la pgina mediante un parmetro
page
en la URL: Por
ejemplo, tus URL se podran parecer a esto:
/objects/?page=3
En ambos casos,
page
es un ndice basado en 1, lo que signi ca que la primera pgina siempre
ser la nmero 1, no la nmero 0.
D.3.2.
Vista de detalle
Vista a importar :
django.views.generic.list_detail.object_detail
Esta vista proporciona una representacin indidual de los detalles de un objeto.
revisin 757 del 28 de julio de 2008
D.3. VISTAS DE LISTADO/DETALLE
301
Ejemplo
Siguiendo con el ejemplo anterior, podemos aadir una vista de detalle de cada autor modi cacando el URLconf
de la siguiente manera:
from mysite.books.models import Author
from django.conf.urls.defaults import *
from django.views.generic import list_detail
author_list_info = {
'queryset' :
Author.objects.all(),
'allow_empty': True,
}
author_detail_info = {
"queryset" : Author.objects.all(),
"template_object_name" : "author",
}
urlpatterns = patterns('',
(r'authors/$', list_detail.object_list, author_list_info),
(r'^authors/(?P<object_id>d+)/$', list_detail.object_detail, author_detail_info),
)
Argumentos obligatorios
queryset:
Un
QuerySet
que ser usado para localizar el objeto a mostrar (vase la Tabla D-1).
y luego hace falta, o un:
object_id:
El valor de la clave primaria del objeto a mostrar.
o bien:
slug:
La etiqueta o slug del objeto en cuestin. Si se usa este sistema de identi cacin, hay que
emplear obligatoriamente el argumento
slug_field
(que se explica en la siguiente seccin).
Argumentos opcionales
slug_field: El nombre del atributo del objeto que contiene el slug. Es obligatorio si ests usando el
argumento slug, y no se debe usar si ests usando el argumento object_id.
template_name_field: El nombre de un atributo del objeto cuyo valor se usar como el nombre de
la plantilla a utilizar. De esta forma, puedes almacenar en tu objeto la plantilla a usar.
'the_template' que contiene la cadena de textemplate_name_field para que valga 'the_template', entonces la vista
usar como plantilla 'foo.html'.
por template_name_field no existe, se usara el indicado por el argumento
En otras palabras, si tu objeto tiene un atributo
to
'foo.html',
y de nes
genrica de este objeto
Si el atributo indicado
template_name.
Es un mecanismo un poco enmaraado, pero puede ser de mucha ayuda en algunos
casos.
Esta vista tambin acepta estos argumentos comunes (Vase la tabla D-1):
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se especi can
template_name ni template_name_field, se usar la plantilla <app_label>/<model_name>_detail.ht
revisin 757 del 28 de julio de 2008
302
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
Contexto de plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
object: El objeto. El nombre de esta variable puede ser distinto
template_object_name, cuyo valor es 'object' por defecto. Si
como 'foo', el nombre de la variable ser foo.
D.4.
si se ha especi cado el argumento
de nimos
template_object_name
Vistas genricas basadas en fechas
Estas vistas genricas basadas en fechas se suelen utilizar para organizar la parte de archivo de nuestro contenido.
Los casos tpicos son los archivos por ao/mes/da de un peridico, o el archivo de una bitcora o blog.
Truco:
En principio, estas vistas ignoran las fechas que estn situadas en el futuro.
Esto signi ca que si intentas visitar una pgina del archivo que est en el futuro, Django mostrar
automticamente un error 404 (Pgina no encontrada), incluso aunque hubiera objetos con esa
fecha en el sistema.
Esto te permite publicar objetos por adelantado, que no se mostrarn pblicamente hasta que se
llegue a la fecha de publicacin deseada.
Sin embargo, para otros tipos de objetos con fechas, este comportamiento no es el deseable (por
ejemplo, un calendario de prximos eventos). Para estas vistas, podemos de nir el argumento
allow_future como True y de esa manera conseguir que los objetos con fechas futuras aparezcan
(o permitir a los usuarios visitar pginas de archivo en el futuro).
D.4.1.
ndice de archivo
Vista a importar :
django.views.generic.date_based.archive_index
Esta vista proporciona un ndice donde se mostrara los ltimos objetos (es decir, los ms recientes) segn la
fecha.
Ejemplo
Supongamos el tpico editor que desea una pgina con la lista de sus ltimos libros publicados. Suponiendo que tenemos un objeto
Book con un atributo de fecha de publicacin, publication_date, podemos usar la vista archive_index
para resolver este problema:
from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic import date_based
book_info = {
"queryset"
: Book.objects.all(),
"date_field" : "publication_date"
}
urlpatterns = patterns('',
(r'^books/$', date_based.archive_index, book_info),
)
Argumentos obligatorios
date_field: El nombre de un campo DateField o DateTimeField de los objetos que componen el
QuerySet. La vista usar los valores de ese campo como referencia para obtener los ltimos objetos.
queryset:
El
QuerySet
de objetos que forman el archivo.
revisin 757 del 28 de julio de 2008
D.4. VISTAS GENRICAS BASADAS EN FECHAS
303
Argumentos opcionales
allow_future: Un valor booleano que indica si los objetos futuros
(es decir, con fecha de referencia
en el futuro) deben aparecer o no.
num_latest:
El nmero de objetos que se deben enviar a la plantilla. Su valor por defecto es 15.
Esta vista tambin acepta estos argumentos comunes (Vase la tabla D-1):
allow_empty
context_processors
extra_context
mimetype
template_loader
template_name
Nombre de la plantilla
Si no se ha especi cado
template_name,
se usar la plantilla
<app_label>/<model_name>_archive.html.
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
date_list:
Una lista de objetos de tipo
hay objetos, de acuerdo al
queryset.
datetime.date
que representaran todos los aos en los que
Vienen ordenados de forma descendente, los aos mas recientes
primero.
Por ejemplo, para un blog que tuviera entradas desde el ao 2003 hasta el 2006, la lista contendr
cuatro objetos de tipo
latest:
Los ltimos
diente por el campo
ser una lista de los
D.4.2.
datetime.date,
uno para cada uno se esos aos.
num_latest objetos en el sistema, considerndolos ordenados de forma descendate_field de referencia. Por ejemplo, si num_latest vale 10, entonces latest
ltimos 10 objetos contenidos en el queryset.
Archivos anuales
Vista a importar :
django.views.generic.date_based.archive_year
Esta vista sirve para presentar archivos basados en aos. Poseen una lista de los meses en los que hay algn objeto,
y pueden mostrar opcionalmente todos los objetos publicados en un ao determinado.
Ejemplo
Vamos a ampliar el ejemplo anterior incluyendo una vista que muestre todos los libros publicados en un determinado
ao:
from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic import date_based
book_info = {
"queryset"
: Book.objects.all(),
"date_field" : "publication_date"
}
urlpatterns = patterns('',
(r'^books/$', date_based.archive_index, book_info),
(r'^books/(?P<year>d{4})/?$', date_based.archive_year, book_info),
)
revisin 757 del 28 de julio de 2008
304
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
Argumentos obligatorios
date_field:
queryset:
Igual que en
El
QuerySet
archive_index
(Vase la seccin previa).
de objetos archivados.
year: El ao, con cuatro dgitos, que la vista usar para mostrar el archivo (Como se ve en el ejemplo,
normalmente se obtiene de un parmetro en la URL).
Argumentos opcionales
make_object_list: Un valor booleano que indica si se debe obtener la lista completa de objetos para
este ao y pasrsela a la plantilla. Si es True, la lista de objetos estar disponible para la plantilla
con el nombre de object_list (Aunque este nombre podra ser diferente; vase la informacin sobre
object_list en la siguiente explicacin sobre Contexto de plantilla). Su valor por defecto es False.
allow_future:
Un valor booleano que indica si deben incluirse o no en esta vista las fechas en el
futuro.
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
allow_empty
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se especi ca ningn valor en
template_name, la vista usar la plantilla <app_label>/<model_name>_archive_year.html.
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
date_list:
Una lista de objetos de tipo
datetime.date,
que representan todos los meses en los que
hay disponibles objetos en un ao determinado, de acuerdo al contenido del
queryset,
en orden
ascendente.
year:
El ao a mostrar, en forma de cadena de texto con cuatro dgitos.
object_list: Si el parmetro make_object_list es True, esta variable ser una lista de objetos cuya
fecha de referencia cae en en ao a mostrar, ordenados por fecha. El nombre de la variable depende
template_object_name, que es 'object' por defecto. Si template_object_name fuera
'foo', el nombre de esta variable sera foo_list.
Si make_object_list es False, object_list ser una lista vaca.
del parmetro
D.4.3.
Archivos mensuales
Vista a importar :
django.views.generic.date_based.archive_month
Esta vista proporciona una representacin basada en meses, en la que se muestran todos los objetos cuya fecha de
referencia caiga en un determinado mes y ao.
revisin 757 del 28 de julio de 2008
D.4. VISTAS GENRICAS BASADAS EN FECHAS
305
Ejemplo
Siguiendo con nuestro ejemplo, aadir una vista mensual debera ser algo sencillo:
urlpatterns = patterns('',
(r'^books/$', date_based.archive_index, book_info),
(r'^books/(?P<year>d{4})/?$', date_based.archive_year, book_info),
(
r'^(?P<year>d{4})/(?P<month>[a-z]{3})/$',
date_based.archive_month,
book_info
),
)
Argumentos obligatorios
year: El ao a mostrar, en forma de cadena de texto con cuatro dgitos.
month: El mes a mostrar, formateado de acuerdo con el argumento month_format.
queryset: El QuerySet de objetos archivados.
date_field: El nombre del campo de tipo DateField o DateTimeField en el modelo
QuerySet que se usar como fecha de referencia.
usado para el
Argumentos opcionales
month_format:
month. La
time.strftime (La documentacin de esta funcin
http://www.djangoproject.com/r/python/strftime/). Su valor por defecto
Una cadena de texto que determina el formato que debe usar el parmetro
sintaxis a usar debe coincidir con la de la funcin
se puede consultar en
es
" %b",
que signi ca el nombre del mes, en ingls, y abreviado a tres letras (Es decir, jan, feb,
etc.). Para cambiarlo de forma que se usen nmeros, hay que utilizar como cadena de formato
allow_future:
" %m".
Un valor booleano que indica si deben incluirse o no en esta vista las fechas en el
futuro, igual al que hemos visto en otras vistas anteriores.
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
allow_empty
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se especi ca ningn valor en
template_name, la vista usar como plantilla <app_label>/<model_name>_archive_mon
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
month: Un objeto de tipo datetime.date que representa el mes y ao de referencia.
next_month: Un objeto de tipo datetime.date que representa el primer da del siguiente mes. Si el
siguiente mes cae en el futuro, valdr None.
previous_month: Un objeto de tipo datetime.date que representa el primer da del mes anterior. Al
contrario que next_month, su valor nunca ser None.
object_list: Una lista de objetos cuya fecha de referencia cae en en ao y mes a mostrar. El nombre de la variable depende del parmetro template_object_name, que es 'object' por defecto. Si
template_object_name fuera 'foo', el nombre de esta variable sera foo_list.
revisin 757 del 28 de julio de 2008
306
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
D.4.4.
Archivos semanales
Vista a importar :
django.views.generic.date_based.archive_week
Esta vista muestra todos los objetos de una semana determinada.
Nota
Por consistencia con las bibliotecas de manejo de fechas de Python, Django asume que el primer
da de la semana es el domingo.
Ejemplo
urlpatterns = patterns('',
# ...
(
r'^(?P<year>d{4})/(?P<week>d{2})/$',
date_based.archive_week,
book_info
),
)
Argumentos obligatorios
year:
El ao, con cuatro dgitos (Una cadena de texto).
week:
La semana del ao (Una cadena de texto).
queryset:
El
QuerySet
de los objetos archivados.
date_field: El nombre del campo de tipo DateField
QuerySet que se usar como fecha de referencia.
DateTimeField
en el modelo usado para el
Argumentos opcionales
allow_future:
Un valor booleano que indica si deben incluirse o no en esta vista las fechas en el
futuro.
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
allow_empty
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se ha especi cado ningn valor en
template_name la vista usar como plantilla <app_label>/<model_name>_archive_week
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
week:
Un objeto de tipo
datetime.date,
cuyo valor es el primer da de la semana considerada.
object_list: Una lista de objetos disponibles para la semana en cuestin. El nombre de esta variable
depende del parmetro template_object_name, que es 'object' por defecto. Si template_object_name
fuera 'foo', el nombre de esta variable sera foo_list.
revisin 757 del 28 de julio de 2008
D.4. VISTAS GENRICAS BASADAS EN FECHAS
D.4.5.
307
Archivos diarios
Vista a importar :
django.views.generic.date_based.archive_day
esta vista muestra todos los objetos para un da determinado.
Ejemplo
urlpatterns = patterns('',
# ...
(
r'^(?P<year>d{4})/(?P<month>[a-z]{3})/(?P<day>d{2})/$',
date_based.archive_day,
book_info
),
)
Argumentos obligatorios
year:
El ao, con cuatro dgitos (Una cadena de texto).
month:
day:
El mes, formateado de acuerdo a lo indicado por el argumento
El da, formateado de acuerdo al argumento
queryset:
El
QuerySet
month_format
day_format.
de los objetos archivados.
date_field: El nombre del campo de tipo DateField
QuerySet que se usar como fecha de referencia.
DateTimeField
en el modelo usado para el
Argumentos opcionales
month_format:
Una cadena de texto que determina el formato que debe usar el parmetro
month.
Hay una explicacin ms detallada en la seccion de Archivos mensuales, incluida anteriormente.
day_format:
Equivalente a
month_format,
pero para el da. Su valor por defecto es
" %d"
(que es el
da del mes como nmero decimal y relleno con ceros de ser necesario; 01-31).
allow_future:
Un valor booleano que indica si deben incluirse o no en esta vista las fechas en el
futuro.
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
allow_empty
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se ha especi cado ningn valor en
template_name la vista usar como plantilla <app_label>/<model_name>_archive
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
day:
Un objeto de tipo
datetime.date
cuyo valor es el del da en cuestin.
next_day: Un objeto de tipo datetime.date que representa el siguiente da. Si cae en el futuro, valdr
None.
revisin 757 del 28 de julio de 2008
308
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
previous_day: Un objeto de tipo datetime.date
next_day, su valor nunca ser None.
que representa el da anterior. Al contrario que
object_list: Una lista de objetos disponibles para el da en cuestin. El nombre de esta variable depende del parmetro template_object_name, que es 'object' por defecto. Si template_object_name
fuera 'foo', el nombre de esta variable sera foo_list.
D.4.6.
Archivo para hoy
La vista
django.views.generic.date_based.archive_today muestra todos los objetos cuya fecha de referencia
archive_day, excepto que no se utilizan los argumentos year, month ni day, ya que
sea hoy. Es exactamente igual a
esos datos se obtendrn de la fecha actual.
Ejemplo
urlpatterns = patterns('',
# ...
(r'^books/today/$', date_based.archive_today, book_info),
)
D.4.7.
Pginas de detalle basadas en fecha
Vista a importar :
django.views.generic.date_based.object_detail
Se usa esta vista para representar un objeto individual.
Esta vista tiene una URL distinta de la vista
ejemplo,
/entries/<slug>/,
object_detail; mientras que la ltima usa
/entries/2006/aug/27/<slug>/.
una URL como, por
esta usa una URL en la forma
Nota
Si ests usando pginas de detalle basadas en la fecha con slugs en la URL, lo ms probable es
que quieras usar la opcin
unique_for_date
en el campo slug, de forma que se garantice que
los slugs nunca se duplican para una misma fecha. Lee el apndice F para ms detalles sobre la
opcin
unique_for_date.
Ejemplo
Esta vista tiene una (pequea) diferencia con las dems vistas basadas en fechas que hemos visto anteriormente, y es
que necesita que le especi quemos de forma inequvoca el objeto en cuestin; esto lo podemos hacer con el identi cador
del objeto o con un campo de tipo slug.
Como el objeto que estamos usando en el ejemplo no tiene ningn campo de tipo slug, usaremos el identi cador para
la URL. Normalmente se considera una buena prctica usar un campo slug, pero no lo haremos en aras de simpli car
el ejemplo.
urlpatterns = patterns('',
# ...
(
r'^(?P<year>d{4})/(?P<month>[a-z]{3})/(?P<day>d{2})/(?P<object_id>[w-]+)/$',
date_based.object_detail,
book_info
),
)
Argumentos obligatorios
year:
El ao, con cuatro dgitos (Una cadena de texto).
month:
day:
El mes, formateado de acuerdo a lo indicado por el argumento
El da, formateado de acuerdo al argumento
queryset:
El
QuerySet
month_format
day_format.
que contiene el objeto.
date_field: El nombre del campo de tipo DateField
QuerySet que se usar como fecha de referencia.
DateTimeField
revisin 757 del 28 de julio de 2008
en el modelo usado para el
D.5. VISTAS GENERICAS PARA CREAR/MODIFICAR/BORRAR
309
Y tambin habr que especi car, o bien un:
object_id:
El valor de la clave primaria del objeto.
o bien un:
slug:
El slug del objeto. Si se utiliza este argumento, es obligatorio especi car un valor para el
argumento
slug_field
(que describiremos en la siguiente seccin).
Argumentos opcionales
allow_future:
Un valor booleano que indica si deben incluirse o no en esta vista las fechas en el
futuro.
day_format:
Equivalente a
month_format,
pero para el da. Su valor por defecto es
" %d"
(que es el
da del mes como nmero decimal y relleno con ceros de ser necesario; 01-31).
month_format:
month.
Una cadena de texto que determina el formato que debe usar el parmetro
Hay una explicacin ms detallada en la seccion de Archivos mensuales, incluida anteriormente.
slug_field:
El nombre del atributo que almacena el valor del slug. Es obligatorio incluirlo si se ha
slug, y no debe aparecer si se ha especi cado el argumento object_id.
template_name_field: El nombre de un atributo del objeto cuyo valor se usar como el nombre
usado el argumento
de
la plantilla a utilizar. De esta forma, puedes almacenar en tu objeto la plantilla a usar.
'the_template' que contiene la cadena
template_name_field para que valga 'the_template', entonces
usar como plantilla 'foo.html'.
En otras palabras, si tu objeto tiene un atributo
de tex-
to
la vista
'foo.html',
y de nes
genrica de este objeto
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
context_processors
extra_context
mimetype
template_loader
template_name
template_object_name
Nombre de la plantilla
Si no se ha especi cado ningn valor en
template_name la vista usar como plantilla <app_label>/<model_name>_detail.
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
object: El object. El nombre de esta variable depende del parmetro template_object_name, que es
object por defecto. Si template_object_name fuera foo, el nombre de esta variable sera foo.
D.5.
Vistas genericas para Crear/Modi car/Borrar
El mdulo
Django.views.generic.create_update
contiene una serie de funciones para crear, modi car y borrar
objetos.
Nota
Estas vistas pueden cambiar ligeramente en la nueva revisin de la arquitectura de formularios de
Django (que est en fase de desarrollo con el nombre
Todas estas vistas presenta formularios si se acceden con
si se acceden con
POST.
django.newforms).
GET y realizan la operacin solicitada (crear/modi car/borrar)
Estas vistas tienen un concepto muy simple de la seguridad. Aunque aceptan un argumento llamado
login_required,
que restringe el acceso slo a usuarios identi cados, no hacen nada ms. Por ejemplo, no comprueban que el usuario
que est modi cando un objeto sea el mismo usuario que lo creo, ni validarn ningn tipo de permisos.
En cualquier caso, la mayor parte de las veces se puede conseguir esta funcionalidad simplemente escribiendo un
pequeo recubrimiento alrededor de la vista genrica. Para ms informacin sobre esta tcnica, vase el Captulo 9.
revisin 757 del 28 de julio de 2008
310
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
D.5.1.
Vista de creacin de objetos
Vista a importar :
django.views.generic.create_update.create_object
Esta vista presenta un formulario que permite la creacin de un objeto. Cuando se envan los datos del formulario,
la vista se vuelve a mostrar si se produce algn error de validacin (incluyendo, por supuesto, los mensajes pertinentes)
o, en caso de que no se produzca ningn error de validacin, salva el objeto en la base de datos.
Ejemplo
Si quisiramos permitir al usuario que creara nuevos libros en la base de datos, podramos hacer algo como esto:
from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic import date_based
book_info = {'model' : Book}
urlpatterns = patterns('',
(r'^books/create/$', create_update.create_object, book_info),
)
Argumentos obligatorios
model:
El modelo Django del objeto a crear.
Nota
Obsrvese que esta vista espera el modelo del objeto a crear, y no un
QuerySet como el resto de
las vistas anteriores que se han visto previamente.
Argumentos opcionales
post_save_redirect:
Una URL, a la cual la vista redirigir despus de haber salvado el objeto. Si
no se especi ca, se tomar de
object.get_absolute_url()
post_save_redirect: puede contener cadenas de formato para diccionarios, cuyos valores se interpolarn usando los nombres de los atributos del objeto. Por ejemplo, se podra usar: post_save_redirect="/polls/ %(slug)s
login_required: Un valor booleano que obliga a que la operacin la realice un usuario identi cado,
ya sea para ver el formulario o para realizar la operacin de creacin del objeto. Utiliza el subsistema
de autenti cacin y seguridad de Django. Por defecto, su valor es
True,
En caso de que se de na como
False.
si un usuario no identi cado intentase acceder a esta pgina o
salvar los datos, Django le redirigira a
/accounts/login/
Esta vista tambin acepta los siguientes argumentos comunes (Vase la Tabla D-1):
context_processors
extra_context
template_loader
template_name
Nombre de la plantilla
Si no se ha especi cado ningn valor en
template_name la vista usar como plantilla <app_label>/<model_name>_form.html.
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
form:
Una instancia de la clase
FormWrapper,
que representa el formulario a utilizar. Esto te permite
referirte de una forma sencilla a los campos del formulario desde la plantilla. Por ejemplo, si el modelo
consta de dos atributos,
name
address:
revisin 757 del 28 de julio de 2008
D.5. VISTAS GENERICAS PARA CREAR/MODIFICAR/BORRAR
311
<form action="" method="post">
<p><label for="id_name">Name:</label> {{ form.name }}</p>
<p><label for="id_address">Address:</label> {{ form.address }}</p>
</form>
form es un FormWrapper de nido en oldforms, y que no est contemplado
http://www.djangoproject.com/documentation/0.96/forms/ par ms infor-
Hay que hacer notar que
en este libro. Vase
macin.
D.5.2.
Vista de modi cacin de objetos
Vista a importar :
django.views.generic.create_update.update_object
Esta vista es prcticamente igual al anterior, siendo la nica diferencia que esta permite la modi cacin de los
atributos del objeto, en vez de su creacin.
Ejemplo
Siguiendo con el ejemplo, podemos proporcionar al usuario una interfaz de modi cacin de los datos de un libro
con el siguiente cdigo en el URLconf:
from mysite.books.models import Book
from django.conf.urls.defaults import *
from django.views.generic. import date_based
book_info = {'model' : Book}
urlpatterns = patterns('',
(r'^books/create/$', create_update.create_object, book_info),
(
r'^books/edit/(?P<object_id>d+)/$',
create_update.update_object,
book_info
),
)
Argumentos obligatorios
model: El modelo
QuerySet.
Django a editar. Hay que prestar atencin a que es el modelo en s, y no un objeto
tipo
Y, o bien un:
object_id:
El valor de la clave primaria del objeto a modi car.
o bien un:
slug: El slug
slug_field.
del objeto a modi car. Si se pasa este argumento, es obligatorio tambin el argumento
Argumentos opcionales
slug_field: El nombre del campo en el que se almacena el valor del slug del sujeto. Es obligado usar
slug, pero no debe especi carse si hemos optado por
identi car el objeto mediante su calve primaria, usando el argumento object_id.
este argumento si se ha indicado el argumento
Esta vista acepta los mismos argumentos opcionales que la vista de creacin y, adems, el argumento comn
template_object_name,
explicado en la tabla D-1.
Nombre de la plantilla
Esta vista utiliza el mismo nombre de plantilla por defecto que la vista de creacin (<app_label>/<model_name>_form.htm
revisin 757 del 28 de julio de 2008
312
APNDICE D. REFERENCIA DE LAS VISTAS GENRICAS
Contexto de la plantilla
Adems de los valores que se puedan haber de nido en
extra_context,
el contexto de la plantilla tendr los
siguientes valores:
form:
Una instancia de
FormWrapper
que representa el formulario de edicin del objeto. Vase la
seccin Vista de creacin de objetos para obtener ms informacin de esta variable.
object:
El objeto a editar (El nombre de esta variable puede ser diferente si se ha especi cado el
argumento
D.5.3.
template_object_name).
Vista de borrado de objetos
Vista a importar :
django.views.generic.create_update.delete_object
Esta vista es muy similar a la dos anteriores: crear y modi car objetos. El propsito de esta es, sin embargo,
permitir el borrado de objetos.
Si la vista es alimentada mediante
GET,
se mostrar una pantalla de con rmacin (del tipo Realmente quieres
borrar este objeto`). Si la vista se alimenta con
POST,
el objeto ser borrado sin conformacin.
Los argumentos son los mismos que los de la vista de modi cacin, as como las variables de contexto. El nombre
de la plantilla por defecto para esta vista es
<app_label>/<model_name>_confirm_delete.html.
revisin 757 del 28 de julio de 2008
Apndice E
Variables de con guracin
Tu archivo de con guracin contiene toda la con guracin de tu instalacin de Django. Este apndice explica cmo
funcionan las variables de con guracin y qu variables de con guracin estn disponibles.
Nota
A medida que Django crece, es ocasionalmente necesario agregar o (raramente) cambiar variables
de con guracin. Debes siempre buscar la informacin mas reciente en la documentacin de
con guracin en lnea que se encuentra en
0.96/settings/.
E.1.
http://www.djangoproject.com/documentation/
Qu es un archivo de con guracin
Un archivo de con guracin es slo un mdulo Python con variables a nivel de mdulo.
Un par de ejemplos de variables de con guracin:
DEBUG = False
DEFAULT_FROM_EMAIL = '[email protected]'
TEMPLATE_DIRS = ('/home/templates/mike', '/home/templates/john')
Debido a que un archivo de con guracin es un mdulo Python, las siguientes a rmaciones son ciertas:
Debe ser cdigo Python vlido; no se permiten los errores de sintaxis.
El mismo puede asignar valores a las variables dinmicamente usando sintaxis normal de Python, por
ejemplo:
MY_SETTING = [str(i) for i in range(30)]
El mismo puede importar valores desde otros archivos de con guracin.
E.1.1.
Valores por omisin
No es necesario que un archivo de con guracin de Django de na una variable de con guracin si es que no es
necesario. Cada variable de con guracin tiene un valor por omisin sensato. Dichos valores por omisin residen en el
archivo
django/conf/global_settings.py.
Este es el algoritmo que usa Django cuando compila los valores de con guracin:
Carga las variables de con guracin desde
global_settings.
Carga las variables de con guracin desde el archivo de con guracin especi cado, reemplazando de
ser necesario los valores globales previos.
Nota que un archivo de con guracin no debe importar desde
E.1.2.
global_settings,
ya que eso sera redundante.
Viendo cules variables de con guracin has cambiado
Existe una manera fcil de ver cules de tus variables de con guracin di eren del valor por omisin. El comando
manage.py diffsettings
visualiza las diferencias entre el archivo de con guracin actual y los valores por omisin
de Django.
manage.py
es descripto con mas detalle en el Apndice G.
revisin 757 del 28 de julio de 2008
314
APNDICE E. VARIABLES DE CONFIGURACIN
E.1.3.
Usando variables de con guracin en cdigo Python
En tus aplicaciones Django, usa variables de con guracin importando el objeto
django.conf.settings,
por
ejemplo:
from django.conf import settings
if settings.DEBUG:
# Do something
Nota que
django.conf.settings no es un mdulo -- es un objeto. De manera que no es posible importar variables
de con guracin individualmente.
from django.conf.settings import DEBUG # This won't work.
global_settings ni desde tu propio archivo de
django.conf.settings provee abstraccin para los conceptos de variables de con guracin por omisin
Ten en cuenta tambin que tu cdigo no debe importar ni desde
con guracin.
y variables de con guracin espec cas de un sitio; presenta una nica interfaz. Tambin desacopla el cdigo que usa
variables de con guracin de la ubicacin de dicha con guracin.
E.1.4.
Modi cando variables de con guracin en tiempo de ejecucin
No debes alterar variables de con guracin en tiempo de ejecucin. Por ejemplo, no hagas esto en una vista:
from django.conf import settings
settings.DEBUG = True
# Don't do this!
El nico lugar en el que debes asignar valores a
E.1.5.
settings
es en un archivo de con guracin.
Seguridad
Debido que un archivo de con guracin contiene informacin importante, tal como la contrasea de la base de
datos, debes hacer lo que est e tus manos para limitar el acceso al mismo. Por ejemplo, cambia los permisos de acceso
en el sistema de archivos de manera que solo tu y el usuario de tu servidor Web puedan leerlo. Esto es especialmente
importante en un entorno de alojamiento compartido.
E.1.6.
Creando tus propias variables de con guracin
No existe nada que impida que crees tus propias variables de con guracin, para tus propias aplicaciones Django.
Slo sigue las siguientes convenciones:
Usa nombres de variables en maysculas.
Para con guraciones que sean secuencias, usa tuplas en lugar de listas. Las variables de con guracin
deben ser consideradas inmutables y no deben ser modi cadas una vez que se las ha de nido. El usar
tuplas re eja esa semntica.
No reinventes una variable de con guracin que ya existe.
E.2.
Indicando la con guracin: DJANGO_SETTINGS_MODULE
Cuando usas Django tienes que indicarle qu con guracin ests usando. Haz esto mediante el uso de de la variable
de entorno
DJANGO_SETTINGS_MODULE.
DJANGO_SETTINGS_MODULE
El valor de
debe respetar la sintaxis de rutas de Python (por ej.
mysite.settings.
Notar que el mdulo de con guracin debe ser encontrarse en la ruta de bsqueda para las importaciones de Python
(PYTHONPATH).
Consejo:
Puedes
encontrar
una
buena
gua
acerca
de
PYTHONPATH`
http://diveintopython.org/getting_to_know_python/everything_is_an_object.html.
revisin 757 del 28 de julio de 2008
en
E.3. USANDO VARIABLES DE CONFIGURACIN SIN FIJAR
DJANGO_SETTINGS_MODULE
E.2.1.
315
La utilidad django-admin.py
Cuando usas
django-admin.py
(ver Apndice G), puedes ya sea jar el valor de la variable de entorno una vez o
especi car explcitamente el mdulo de con guracin cada vez que ejecutes la utilidad.
Este es un ejemplo usando el shell Bash de Unix:
export DJANGO_SETTINGS_MODULE=mysite.settings
django-admin.py runserver
Este es otro ejemplo, esta vez usando el shell de Windows:
set DJANGO_SETTINGS_MODULE=mysite.settings
django-admin.py runserver
Usa el argumento de lnea de comandos
--settings para especi car el mdulo de con guracin en forma manual:
django-admin.py runserver --settings=mysite.settings
La utilidad
manage.py creada por startproject como parte del esqueleto del proyecto asigna un valor a DJANGO_SETTINGS_
manage.py.
en forma automtica; revisa el Apndice G si deseas conocer ms sobre
E.2.2.
En el servidor (mod_python)
En tu entorno del servidor activo, necesitars indicarle a Apache/mod_python qu archivo de con guracin debe
usar. Haz eso con
SetEnv:
<Location "/mysite/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
</Location>
Para ms informacin, revisa la documentacin en lnea de mod_python en
documentation/0.96/modpython/.
E.3.
http://www.djangoproject.com/
Usando variables de con guracin sin jar DJANGO_SETTINGS_MOD
Es algunos casos, querrs saltearte la variable de entorno
DJANGO_SETTINGS_MODULE.
Por ejemplo, si ests usando
el sistema de plantillas en forma aislada, muy probablemente no desears tener que preparar una variable de entorno
que apunte a un mdulo de con guracin.
En esos casos, puedes jar los valores de las variables de con guracin de Django manualmente. Haz esto llamando
django.conf.settings.configure().
Este es un ejemplo:
from django.conf import settings
settings.configure(
DEBUG = True,
TEMPLATE_DEBUG = True,
TEMPLATE_DIRS = [
'/home/web-apps/myapp',
'/home/web-apps/base',
]
)
Psale a
configure()
tantos argumentos de palabra clave como desees, con cada argumento representando una
variable de con guracin y su valor. Cada nombre de argumento debe estar escrito totalmente en maysculas, con
el mismo nombre que que la variable de con guracin que ya se describieron. Si una variable de con guracin no es
pasada a
configure()
y es necesario luego, Django usar el valor por omisin respectivo.
El con gurar Django de esta manera es en general necesario -- y, en efecto, recomendado -- cuando usas una parte
del framework dentro de una aplicacin ms grande.
En consecuencia, cuando es con gurado va
settings.configured(), Django no har modi cacin alguna a las
TIME_ZONE mas adelante en este apndice para conocer
variables de entorno del proceso (revisa la explicacin acerca de
porqu habra de ocurrir esto). Asumimos que en esos casos ya tienes completo control de tu entorno.
revisin 757 del 28 de julio de 2008
316
APNDICE E. VARIABLES DE CONFIGURACIN
E.3.1.
Variables de con guracin por omisin personalizados
Si te gustara que los valores por omisin provinieran desde otra ubicacin diferente a
django.conf.global_settings,
default_settings
puedes pasarle un mdulo o clase que provea las variables de con guracin por omisin como el argumento
(o como el primer argumento posicional) en la llamada a
configure().
En este ejemplo, las variables de con guracin por omisin se toman desde
DEBUG
en
True,
myapp_defaults:
independientemente de su valor en
myapp-defaults,
y se ja el valor de
from django.conf import settings
from myapp import myapp_defaults
settings.configure(default_settings=myapp_defaults, DEBUG=True)
El siguiente ejemplo, que usa
myapp_defaults
como un argumento posicional, es equivalente:
settings.configure(myapp_defaults, DEBUG = True)
Normalmente, no necesitars sobreescribir los valores por omisin de esta manera. Los valores por omisin provistos
por Django son su cientemente sensatos como para que puedas usarlos. Ten en cuenta que si pasas un nuevo valor por
omisin, este reemplaza completamente los valores de Django, as que debes especi car un valor para cada variable de
con guracin posible que pudiera ser usado en el cdigo que ests importando. Examina
django.conf.settings.global_settings
para ver la lista completa.
E.3.2.
Es necesario que uses con gure() o DJANGO_SETTINGS_MODULE
Si no ests jando la variable de entorno
DJANGO_SETTINGS_MODULE,
debes llamar a
configure()
en algn punto
antes de usar cualquier cdigo que lea las variables de con guracin.
Si no jas
DJANGO_SETTINGS_MODULE y no llamas a configure(), Django lanzar una excepcin EnvironmentError
la primera vez que se accede a una variable de con guracin.
Si jas el valor de
DJANGO_SETTINGS_MODULE, luego accedes a los valores de las variables de con guracin de alguna
configure(), Django lanzar un EnvironmentError indicando que la con guracin ya
manera, y entonces llamas a
ha sido preparada.
Tambin es un error el llamar a
configure() mas de una vez, o llamar a configure luego de que ya se ha accedido
a alguna variable de con guracin.
En resumen: Usa exactamente una vez ya sea
E.4.
configure() o DJANGO_SETTINGS_MODULE. No ambos, y no ninguno.
Variables de con guracin disponibles
Las siguientes secciones consisten de una lista completa de todas las variables de con guracin en orden alfabtico,
y sus valores por omisin.
E.4.1.
ABSOLUTE_URL_OVERRIDES
Valor por omisin :
{}
(diccionario vaco)
Un diccionario interrelacionando cadenas
app_label.model_name a funciones que toman un objeto modelo y
get_absolute_url() en cada instalacin. Un ejemplo:
retornan su URL. Esta es una forma de sobreescribir mtodos
ABSOLUTE_URL_OVERRIDES = {
'blogs.weblog': lambda o: "/blogs/ %s/" % o.slug,
'news.story': lambda o: "/stories/ %s/ %s/" % (o.pub_year, o.slug),
}
Notar que el nombre del modelo usado en esta variable de con guracin debe estar escrito totalmente en maysculas,
con independencia de la combinacin de maysculas y minsculas del nombre real de la clase del modelo.
E.4.2.
ADMIN_FOR
Valor por omisin :
()
(lista vaca)
Esta variable de con guracin es usada en mdulos de con guracin de sitios de administracin. Debe ser una
tupla de mdulos de con guracin (en el formato
'foo.bar.baz')
para los cuales este sitio es una aplicacin de
administracin.
El sitio de administracin usa esto en la documentacin automticamente introspeccionada de modelos, vistas y
etiquetas de plantillas.
revisin 757 del 28 de julio de 2008
E.4. VARIABLES DE CONFIGURACIN DISPONIBLES
E.4.3.
317
ADMIN_MEDIA_PREFIX
Valor por omisin :
'/media/'
Esta variable de con guracin es el pre jo de la URL para los medios del sitio de administracin: CSS, JavaScript
e imgenes. Asegrate de usar una barra al nal.
E.4.4.
ADMINS
Valor por omisin :
()
(tupla vaca)
Una tupla que enumera las personas que recibirn noti caciones de errores en el cdigo. Cuando
DEBUG=False
una vista laza una excepcin, Django enviar a esta gente un e-mail con la informacin completa de la informacin.
Cada miembro de la tupla debe ser una tupla de (Nombre completo, direccin de e-mail), por ejemplo:
(('John', '[email protected]'), ('Mary', '[email protected]'))
Notar que Django el enviar e-mail a todas estas personas cada vez que ocurra un error.
E.4.5.
ALLOWED_INCLUDE_ROOTS
Valor por omisin :
()
(tupla vaca)
Una tupla de cadenas que representan pre jos permitidos para la etiqueta de plantillas
{ % ssi %}. Se trata de una
medida de seguridad, que impide que los autores de plantillas puedan acceder a archivos a los que no deberan acceder.
ALLOWED_INCLUDE_ROOTS es ('/home/html', '/var/www') entonces { % ssi /home/html/foo.txt %}
{ % ssi /etc/passwd %} no.
Por ejemplo, si
funcionara pero
E.4.6.
APPEND_SLASH
Valor por omisin :
True
Esta variable de con guracin indica si debe anexarse barras al nal de las URLs. Se usa solamente si est instalado
CommonMiddleware
E.4.7.
(ver Captulo 15). Ver tambin
CACHE_BACKEND
Valor por omisin :
El
PREPEND_WWW.
'simple://'
*back-end* de cache a usarse (ver Captulo 13).
E.4.8.
CACHE_MIDDLEWARE_KEY_PREFIX
Valor por omisin :
''
(cadena vaca)
El pre jo de las claves de cache que debe usar el middleware de cache (ver Captulo 13).
E.4.9.
DATABASE_ENGINE
Valor por omisin :
''
(cadena vaca)
Esta variable de con guracin indica qu
'postgresql', 'mysql', 'mysql_old'
E.4.10.
*back-end* de base de datos debe usarse:
'sqlite3'.
'postgresql_psycopg2',
DATABASE_HOST
Valor por omisin :
''
(cadena vaca)
Esta variable de con guracin indica qu equipo debe usarse cuando se establezca una conexin a la base de datos.
Una cadena vaca signi ca
localhost.
No se usa con SQLite.
Si este valor comienza con una barra (/) y ests usando MySQL, MySQL se conectar al socket va un socket Unix:
DATABASE_HOST = '/var/run/mysql'
Si ests usando MySQL este valor no comienza con una barra, entonces se asume que el mismo es el nombre del
equipo.
revisin 757 del 28 de julio de 2008
318
E.4.11.
APNDICE E. VARIABLES DE CONFIGURACIN
DATABASE_NAME
Valor por omisin :
''
(cadena vaca)
El nombre de la base de datos a usarse. Para SQLite, es la ruta completa al archivo de la base de datos.
E.4.12.
DATABASE_OPTIONS
Valor por omisin :
{}
(diccionario vaco)
Parmetros extra a usarse cuando se establece la conexin a la base de datos. Consulta el mdulo back-end para
conocer las palabras claves disponibles.
E.4.13.
DATABASE_PASSWORD
Valor por omisin :
''
(cadena vaca)
Esta variable de con guracin es la contrasea a usarse cuando se establece una conexin a la base de datos. No
se usa con SQLite.
E.4.14.
DATABASE_PORT
Valor por omisin :
''
(cadena vaca)
El puerto a usarse cuando se establece una conexin a la base de datos. Una cadena vaca signi ca el puerto por
omisin. No se usa con SQLite.
E.4.15.
DATABASE_USER
Valor por omisin :
''
(cadena vaca)
Esta variable de con guracin es el nombre de usuario a usarse cuando se establece una conexin a la base da
datos. No se usa con SQLite.
E.4.16.
DATE_FORMAT
Valor por omisin :
'N j, Y'
(por ej.
Feb. 4, 2003)
El formato a usar por omisin para los campos de fecha en las pginas lista de cambios en el sitio de administracin
de Django -- y, posiblemente, por otras partes del sistema. Acepta el mismo formato que la etiqueta
F, Tabla F-2).
Ver tambin
E.4.17.
DATETIME_FORMAT, TIME_FORMAT, YEAR_MONTH_FORMAT
now ver Apndice
MONTH_DAY_FORMAT.
DATETIME_FORMAT
Valor por omisin :
'N j, Y, P'
(por ej.
Feb. 4, 2003, 4 p.m.)
El formato a usar por omisin para los campos de fecha-hora en las pginas lista de cambios en el sitio de administracin de Django -- y, posiblemente, por otras partes del sistema. Acepta el mismo formato que la etiqueta
Apndice F, Tabla F-2).
Ver tambin
E.4.18.
DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT, YEAR_MONTH_FORMAT
now
ver
MONTH_DAY_FORMAT.
DEBUG
Valor por omisin :
False
Esta variable de con guracin es un Booleano que activa y desactiva el modo de depuracin.
django/views/debug.py tiene una expresin regular HIDDEN_SETTINGS
DEBUG todo aquello que contenga SECRET, PASSWORD o PROFANITIES. Esto permite que usuarios
Si de nes variables de con guracin personalizadas,
que ocultar de la vista
en los que no se confa puedan proveer
*backtraces* sin ver variables de con guracin con contenido importante (u
ofensivo).
Si embargo, nota que siempre existirn secciones de la salida de depuracin que son inapropiadas para el consumo
del pblico. Rutas de archivos, opciones de con guracin y similares le proveen a potenciales atacantes informacin
extra acerca de tu servidor. Nunca instales un sitio con
DEBUG
activo.
revisin 757 del 28 de julio de 2008
E.4. VARIABLES DE CONFIGURACIN DISPONIBLES
E.4.19.
319
DEFAULT_CHARSET
Valor por omisin :
'utf-8'
HttpResponse si no se especi ca en forma
DEFAULT_CONTENT_TYPE para construir la cabecera Content-Type. Ver
de los objetos HttpResponse.
El conjunto de caracteres a usar por omisin para todos los objetos
manual un tipo MIME. Se usa en conjunto con
el Apndice H para ms informacin acerca
E.4.20.
DEFAULT_CONTENT_TYPE
Valor por omisin :
'text/html'
Tipo de contenido a usar por omisin para todos los objetos
DEFAULT_CHARSET
objetos HttpResponse.
tipo MIME. Se usa en conjunto con
para conocer ms acerca de los
E.4.21.
HttpResponse,
si no se especi ca manualmente un
para construir la cabecera
Content-Type.
Ver el Apndice H
DEFAULT_FROM_EMAIL
Valor por omisin :
'webmaster@localhost'
La direccin de correo a usar por omisin para correspondencia automatizada enviada por el administrador del
sitio.
E.4.22.
DISALLOWED_USER_AGENTS
Valor por omisin :
()
(tupla vaca)
Una lista de objetos expresiones regulares compiladas que representan cadenas User-Agent que no tiene permitido
visitar ninguna pgina del sitio, a nivel global para el sitio. Usa la misma para bloquear robots y crawlers con mal
comportamiento. Se usa nicamente si se ha instalado
E.4.23.
(ver Captulo 15).
EMAIL_HOST
Valor por omisin :
'localhost'
El host a usarse para enviar e-mail. Ver tambin
E.4.24.
CommonMiddleware
EMAIL_PORT.
EMAIL_HOST_PASSWORD
Valor por omisin :
''
(cadena vaca)
La contrasea a usarse para el servidor SMTP de nido en
combinacin con
EMAIL_HOST_USER
EMAIL_HOST.
Esta variable de con guracin se usa en
cuando se est autenticando ante el servidor SMTP. Si alguna de estas variables
de con guracin est vaca, Django no intentar usar autenticacin.
Ver tambin
E.4.25.
EMAIL_HOST_USER.
EMAIL_HOST_USER
Valor por omisin :
''
(cadena vaca)
El nombre de usuario a usarse para el servidor SMTP de nido en
usar autenticacin. Ver tambin
E.4.26.
EMAIL_HOST_PASSWORD.
Si est vaco, Django no intentar
EMAIL_PORT
Valor por omisin :
25
El puerto a usarse pata el servidor SMTP de nido en
E.4.27.
EMAIL_HOST.
EMAIL_HOST.
EMAIL_SUBJECT_PREFIX
Valor por omisin :
'[Django] '
El pre jo del asunto para mensajes de e-mail enviados con
django.core.mail.mail_admins o django.core.mail.mail_ma
Probablemente querrs incluir un espacio al nal.
revisin 757 del 28 de julio de 2008
320
E.4.28.
APNDICE E. VARIABLES DE CONFIGURACIN
FIXTURE_DIRS
Valor por omisin :
()
(tupla vaca)
Una lista de ubicaciones para los archivos con datos de
* xtures*, en el orden en el que se se buscar en las mismas.
Notar que esas rutas deben usar barras de estilo Unix an en Windows. Es usado por el framework de pruebas de
Django, el cual se trata en
E.4.29.
http://www.djangoproject.com/documentation/0.96/testing/.
IGNORABLE_404_ENDS
('mail.pl', 'mailform.pl', 'mail.cgi', 'mailform.cgi', 'favicon.ico', '.php')
IGNORABLE_404_STARTS y Error reporting via e-mail.
Valor por omisin :
Ver tambin
E.4.30.
IGNORABLE_404_STARTS
Valor por omisin :
('/cgi-bin/', '/_vti_bin', '/_vti_inf')
Una tupla de cadenas que especi can las partes iniciales de URLs que deben ser ignoradas para el envo de mensajes
de e-mail para errores 404. Ver tambin
E.4.31.
SEND_BROKEN_LINK_EMAILS
IGNORABLE_404_ENDS.
INSTALLED_APPS
Valor por omisin :
()
(tupla vaca)
Una tupla de cadenas que indican todas las aplicaciones que estn activas en esta instalacin de Django. Cada
cadena debe ser una ruta completa de Python hacia un paquete Python que contiene una aplicacin Django. Ver el
Captulo 5 para ms informacin acerca de aplicaciones.
E.4.32.
INTERNAL_IPS
Valor por omisin :
()
(tupla vaca)
Una tupla de direcciones IP, como cadenas, que:
Pueden ver comentarios de depuracin cuando
Reciben cabeceras X si est instalado
E.4.33.
DEBUG
es
XViewMiddleware
True
(ver Captulo 15)
JING_PATH
Valor por omisin :
'/usr/bin/jing'
La ruta al ejecutable Jing. Jing es un validador RELAX NG, y Django usa el mismo para validar los campos
XMLField
E.4.34.
en tus modelos. Ver
http://www.thaiopensource.com/relaxng/jing.html.
LANGUAGE_CODE
Valor por omisin :
'en-us'
Una cadena representando el cdigo de idioma para esta instalacin. Debe estar expresado usando el formato
estndar -- por ejemplo, Ingls de EUA es en-us. Ver el Captulo 18.
E.4.35.
LANGUAGES
Valor por omisin : Una tupla de todos los idiomas disponibles. Esta lista est en continuo crecimiento y cualquier
copia que incluyramos aqu inevitablemente quedara rpidamente desactualizada. Puedes ver la lista actual de idiomas
traducidos examinando
django/conf/global_settings.py.
La lista es una tupla de tuplas de dos elementos en el formato (cdigo de idioma, nombre de idioma) -- por ejemplo,
('ja', 'Japanese').
Especi ca qu idiomas estn disponibles para la seleccin de idioma. Ver el Captulo 18 para
ms informacin acerca de seleccin de idiomas.
Generalmente, el valor por omisin debera ser su ciente. Solo asigna valor a esta variable de con guracin si deseas
restringir la seleccin de idiomas a un subconjunto de los idiomas provistos con Django.
LANGUAGES, est permitido marcar los idiomas como cadenas de traduccin,
django.utils.translation desde el archivo de con guracin, porque ese mdulo a su
Si asignas un valor personalizado a
pero nunca debes importar
vez depende de la con guracin y esto creara una importacin circular.
La solucin es usar una funcin
gettext()
boba. A continuacin un archivo de con guracin ejemplo:
revisin 757 del 28 de julio de 2008
E.4. VARIABLES DE CONFIGURACIN DISPONIBLES
321
gettext = lambda s: s
LANGUAGES = (
('de', gettext('German')),
('en', gettext('English')),
)
Con este esquema,
make-messages.py
todava podr encontrar y marcar esas cadenas para traduccin, pero la
traduccin no ocurrir en tiempo de ejecucin -- as que tendrs que recordar envolver los idiomas con la
real en todo cdigo que use
E.4.36.
LANGUAGES
MANAGERS
Valor por omisin :
()
(tupla vaca)
Esta tupla est en el mismo formato que
cuando
SEND_BROKEN_LINK_EMAILS
E.4.37.
ADMINS que especi ca quines deben recibir noti caciones de enlaces rotos
True.
tiene el valor
MEDIA_ROOT
Valor por omisin :
''
(cadena vaca)
Una ruta absoluta al directorio que contiene medios para esta instalacin (por ej.
Ver tambin
E.4.38.
gettext()
en tiempo de ejecucin.
MEDIA_URL.
"/home/media/media.lawrence.com/").
MEDIA_URL
Valor por omisin :
''
(cadena vaca)
Esta URL maneja los medios servidos desde
MEDIA_ROOT
(por ej.
"http://media.lawrence.com").
Notar que esta debe tener una barra nal si posee un componente de ruta:
Correcto :
"http://www.example.com/static/"
Incorrecto :
E.4.39.
"http://www.example.com/static"
MIDDLEWARE_CLASSES
Valor por omisin :
("django.contrib.sessions.middleware.SessionMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.doc.XViewMiddleware")
Una tupla de clases middleware a usarse. Ver el Captulo 15.
E.4.40.
MONTH_DAY_FORMAT
Valor por omisin :
'F j'
El formato a usar por omisin para campos de fecha en las pginas de lista de cambios en la aplicacin de
administracin de Django -- y, probablemente, en otras partes del sistema -- en casos en los que slo se muestran el
mes y el da. Acepta el mismo formato que la etiqueta
now
(ver Apndice F, tabla F-2)
Por ejemplo, cuando en una pgina de lista de cambios la aplicacin de administracin de Django se ltra por una
fecha, la cabecera para un da determinado muestra el da y mes. Diferentes locales tienen diferentes formatos. Por
ejemplo, el Ingls de EUA tendra January 1 mientras que Espaol podra tener 1 Enero.
Ver tambin
E.4.41.
DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT
YEAR_MONTH_FORMAT.
PREPEND_WWW
Valor por omisin :
False
Esta variable de con guracin indica si se debe agregar el pre jo de subdominio www. a URLs que no lo poseen.
Se usa nicamente si
CommonMiddleware
est instalado (ver Captulo 15). Ver tambin
revisin 757 del 28 de julio de 2008
APPEND_SLASH.
322
E.4.42.
APNDICE E. VARIABLES DE CONFIGURACIN
PROFANITIES_LIST
Una tupla de profanidades, como cadenas, que dispararn un error de validacin cuando se llama al validador
hasNoProfanities.
No enumeramos aqu los valores por omisin, debido a que esto podra hacer que nos cayera encima la comisin de
django/conf/global_settings.py.
clasi cacin de la MPAA. Para ver los valores por omisin examina el archivo
E.4.43.
ROOT_URLCONF
Valor por omisin : No de nido
Una cadena que representa la ruta completa de importacin Python hacia tu URLconf raz (por ej.
"mydjangoapps.urls").
Ver Captulo 3.
E.4.44.
SECRET_KEY
Valor por omisin : (Generado automticamente cuando creas un proyecto)
Una clave secreta para esta instalacin particular de Django. Es usada para proveer una semilla para los algoritmos de hashing. Asigna un valor de una cadena con caracteres al azar -- mientras mas larga mejor.
startproject
E.4.45.
django-admin
crea una en forma automtica y en la mayora de los casos no ser necesario que la modi ques.
SEND_BROKEN_LINK_EMAILS
Valor por omisin :
False
Esta variable de con guracin indica si se debe enviar un e-mail a los
MANAGERS
cada vez que alguien visita
una pgina impulsada por Django que generar un error 404 y que posea una cabecera referer no vaca (en otras
palabras un enlace roto). Es solamente usado si est instalado
IGNORABLE_404_STARTS
E.4.46.
IGNORABLE_404_ENDS.
CommonMiddleware
(ver Captulo 15). Ver tambin
SERIALIZATION_MODULES
Valor por omisin : No de nida.
La serializacin es una caracterstica que todava est bajo fuerte desarrollo. Revisa la documentacin en lnea en
http://www.djangoproject.com/documentation/0.96/serialization/
E.4.47.
si deseas ms informacin.
SERVER_EMAIL
Valor por omisin :
'root@localhost'
La direccin de e-mail a usarse como remitente para los mensajes de error, tales como los enviados a
MANAGERS.
E.4.48.
ADMINS
SESSION_COOKIE_AGE
Valor por omisin :
1209600
(dos semanas, en segundos)
Esta es la edad de las cookies de sesin, en segundos. Ver Captulo 12.
E.4.49.
SESSION_COOKIE_DOMAIN
Valor por omisin :
None
El dominio a usarse para las cookies de sesin. Asigna como valor una cadena tal como
cookies inter-dominio, o usa
E.4.50.
None
".lawrence.com"
para una cookie de dominio estndar. Ver Captulo 12.
SESSION_COOKIE_NAME
Valor por omisin :
'sessionid'
El nombre de la cookie a usarse para las sesiones; puede tener el valor que tu desees. Ver Captulo 12.
revisin 757 del 28 de julio de 2008
para
E.4. VARIABLES DE CONFIGURACIN DISPONIBLES
E.4.51.
323
SESSION_COOKIE_SECURE
Valor por omisin :
False
Esta variable de con guracin indica si debe usarse una cookie segura para la cookie de sesin. Si tiene un valor
True, la cookie ser marcada como segura, lo que signi ca que los navegadores podran asegurarse que la cookie slo
se enve va una conexin HTTPS. Ver Captulo 12.
E.4.52.
SESSION_EXPIRE_AT_BROWSER_CLOSE
Valor por omisin :
False
Esta variable de con guracin indica si las sesiones deben caducar cuando el usuario cierre su navegador. Ver
Captulo 12.
E.4.53.
SESSION_SAVE_EVERY_REQUEST
Valor por omisin :
False
Esta variable de con guracin indica si la sesin debe ser grabada en cada peticin. Ver Captulo 12.
E.4.54.
SITE_ID
Valor por omisin : No de nida.
El identi cador, como un entero, del sitio actual en la tabla
django_site de la base de datos. Es usada de manera
que datos de aplicacin puede conectarse en sitio(s) espec co(s) y una nica base de datos pueda manejar contenido
de mltiples sitios. Ver Captulo 14.
E.4.55.
TEMPLATE_CONTEXT_PROCESSORS
Valor por omisin :
("django.core.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n")
Una tupla de
*callables* que son usados para poblar el contexto en
RequestContext.
Esos
*callables* reciben
`Captulo
como argumento un objeto peticin y retornan un diccionario de items a ser fusionados con el contexto. Ver
10`_.
E.4.56.
TEMPLATE_DEBUG
Valor por omisin :
False
True la pgina
TemplateSyntaxError. Este reporte contiene los fragmentos
Este Booleano controla el estado encendido/apagado del modo de depuracin de plantillas. Si es
de error vistosa mostrar un reporte detallado para cada
relevantes de la plantilla, en los cuales se han resaltado las lneas relevantes.
Notar que Django solo muestra pginas de error vistosas si
DEBUG
es
True,
as que es posible que desees activar
dicha variable para sacar provecho de esta variable.
Ver tambin
E.4.57.
DEBUG.
TEMPLATE_DIRS
Valor por omisin :
()
(tupla vaca)
Un lista de ubicaciones de los archivos de cdigo fuente de plantillas, en el orden en el que sern examinadas. Notar
que esas rutas deben usar barras al estilo Unix, aun en Windows. Ver Captulos 4 y 10.
E.4.58.
TEMPLATE_LOADERS
Valor por omisin :
Una tupla de
('django.template.loaders.filesystem.load_template_source',)
*callables* (como cadenas) que saben como importar plantillas desde diferentes orgenes. Ver
`Captulo 10`_.
revisin 757 del 28 de julio de 2008
324
APNDICE E. VARIABLES DE CONFIGURACIN
E.4.59.
TEMPLATE_STRING_IF_INVALID
Valor por omisin :
''
(cadena vaca)
La salida, como una cadena, que debe usar el sistema de plantillas para variables invlidas (por ej. con errores de
sintaxis en el nombre). Ver Captulo 10.
E.4.60.
TEST_RUNNER
Valor por omisin :
'django.test.simple.run_tests'
El nombre del mtodo a usarse para arrancar la batera de pruebas (por test suite ). Es usado por el framework de
pruebas de Django, el cual se describe en lnea en
E.4.61.
http://www.djangoproject.com/documentation/0.96/testing/.
TEST_DATABASE_NAME
Valor por omisin :
None
El nombre de la base de datos a usarse cuando se ejecute la batera de pruebas (por test suite ). Si se especi ca un
None, el nombre de la base de datos de pruebas ser 'test_' + settings.DATABASE_NAME. Ver la documentacin
http://www.djangoproject.com/documentation/
0.96/testing/.
valor
del framework de pruebas de Django el cual se describe en lnea en
E.4.62.
TIME_FORMAT
Valor por omisin :
'P'
(e.g.,
4 p.m.)
El formato a usar por omisin para los campos de hora en las pginas lista de cambios en el sitio de administracin
de Django -- y, posiblemente, por otras partes del sistema. Acepta el mismo formato que la etiqueta
F, Tabla F-2).
Ver tambin
E.4.63.
DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT, YEAR_MONTH_FORMAT
now ver Apndice
MONTH_DAY_FORMAT.
TIME_ZONE
Valor por omisin :
'America/Chicago'
Una cadena que representa la zona horaria para esta instalacin. Las zonas horarias se expresan en el forma-
to
zic
estndar de Unix. Puede encontrarse una lista relativamente completa de cadenas de zonas horarias en
http://www.postgresql.org/docs/8.1/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE.
Esta es la zona a la cual Django convertir todas las fechas/horas -- no necesariamente la zona horaria del servidor.
Por ejemplo, un servidor podra servir mltiples sitios impulsados por Django, cada uno con una con guracin de zona
horaria separada.
Normalmente, Django ja la variable
guracin
TIME_ZONE.
os.environ['TZ']
a la zona horaria que especi cas en la variable de con -
Por lo tanto, todas tus vistas y modelos operarn automticamente en la zona horaria correcta.
Sin embargo, si ests usando el mtodo de con guracin manual (descrito arriba en la seccin Usando variables de
con guracin sin jar DJANGO_SETTINGS_MODULE ) Django no tocar la variable de entorno
TZ y quedar en
tus manos asegurarte de que tus procesos se ejecuten en el entorno correcto.
Nota
Django no puede usar en forma con able zonas horarias alternativas en un entorno Windows. Si
ests ejecutando Django en Windows debes asignar a esta variable un valor que coincida con la
zona horaria del sistema.
E.4.64.
URL_VALIDATOR_USER_AGENT
Django/<version> (http://www.djangoproject.com/)
User-Agent cuando se realizan veri caciones
verify_exists de URLField; ver Apndice B).
Valor por omisin :
La cadena usarse como la cabecera
la opcin
E.4.65.
acerca e si las URLs existen (ver
USE_ETAGS
Valor por omisin :
False
Este Booleano especi ca si debe generarse la cabecera
ETag. La misma permite
CommonMiddleware (ver
disminuye el rendimiento. Se usa solamente si se ha instalado
revisin 757 del 28 de julio de 2008
ahorrar ancho de banda pero
Captulo 15).
E.4. VARIABLES DE CONFIGURACIN DISPONIBLES
E.4.66.
325
USE_I18N
Valor por omisin :
True
Este Booleano especi ca si debe activarse el sistema de internacionalizacin de Django (ver Captulo 18). Provee
una forma sencilla de desactivar la internacionalizacin, para mejorar el rendimiento. Si se asigna a esta variable el
valor
False Django realizar algunas optimizaciones de manera que no se cargue la maquinaria de internacionalizacin.
E.4.67.
YEAR_MONTH_FORMAT
Valor por omisin :
'F Y'
El formato a usar por omisin para los campos de fecha en las pginas lista de cambios en el sitio de administracin
de Django -- y, posiblemente, por otras partes del sistema- en los casos en los que slo se muestran el mes y el ao.
Acepta el mismo formato que la etiqueta
now
ver Apndice F).
Por ejemplo, cuando se est ltrando una pgina lista de cambios de la aplicacin de administracin de Django
mediante un detalle de fecha, la cabecera de un mes determinado muestra el mes y el ao. Los distintos locales
tienen diferentes formatos. Por ejemplo, el Ingls de EUA usara January 2006 mientras que otro locale podra usar
2006/January.
Ver tambin
DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT
MONTH_DAY_FORMAT.
revisin 757 del 28 de julio de 2008
326
APNDICE E. VARIABLES DE CONFIGURACIN
revisin 757 del 28 de julio de 2008
Apndice F
Etiquetas de plantilla y ltros prede nidos
En el Captulo 4 se hace una introduccin de las etiquetas de plantilla y ltros ms utilizados, pero Django incorpora
muchas ms. En este apndice se listan todas las que estaban incluidas en el momento en que se escribi el libro, pero
se aaden nuevas etiquetas y ltros de forma regular.
La mejor referencia de todas las etiquetas y ltros disponibles se encuentra en la propia pgina de administracin.
All se incluye una referencia completa de todas las etiquetas y ltros que hay disponibles para una determinada
aplicacin. Para verla, slo tienes que pulsar con el ratn en el enlace de documentacin que est en la esquina
superior derecha de la pgina.
Las secciones de etiquetas y ltros de esta documentacin incluirn tanto las etiquetas y ltros prede nidos (de
hecho, las referencias de este apndice vienen directamente de ah) como aquellas etiquetas y ltros que se hayan
incluido o escrito para la aplicacin.
Este apndice ser ms til, por tanto, para aquellos que no dispongan de acceso a la interfaz de administracin.
Como Django es altamente con gurable, las indicaciones de la interfaz de administracin deben ser consideradas como
la documentacin ms actualizada y, por tanto, la de mayor autoridad.
F.1.
F.1.1.
Etiquetas prede nidas
block
De ne un bloque que puede ser sobreescrito por las plantillas derivadas. Vase la seccin acerca de herencia de
plantillas en el Captulo 4 para ms informacin.
F.1.2.
comment
Ignora todo lo que aparezca entre
F.1.3.
{ % comment %}
{ % endcomment %}.
cycle
Rota una cadena de texto entre diferentes valores, cada vez que aparece la etiqueta.
Dentro de un bucle, el valor rotan entre los distintos valores disponibles en cada iteracin del bucle:
{ % for o in some_list %}
<tr class="{ % cycle row1,row2 %}">
...
</tr>
{ % endfor %}
Fuera de un bucle, hay que asignar un nombre nico la primera vez que se usa la etiqueta, y luego hay que incluirlo
ese nombre en las sucesivas llamadas:
<tr class="{ % cycle row1,row2,row3 as rowcolors %}">...</tr>
<tr class="{ % cycle rowcolors %}">...</tr>
<tr class="{ % cycle rowcolors %}">...</tr>
Se pueden usar cualquier nmero de valores, separndolos por comas. Asegrate de no poner espacios entre los
valores, slo comas.
revisin 757 del 28 de julio de 2008
328
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
F.1.4.
debug
Muestra un montn de informacin para depuracin de errores, incluyendo el contexto actual y los mdulos importados.
F.1.5.
extends
Sirve para indicar que esta plantilla extiende una plantilla padre.
Esta etiqueta se puede usar de dos maneras:
{ % extends "base.html" %} (Con las comillas) interpreta literalmente "base.html" como el nombre
de la plantilla a extender.
{ % extends variable %}
usa el valor de
variable.
Si la variable apunta a una cadena de texto,
Django usar dicha cadena como el nombre de la plantilla padre. Si la variable es un objeto de tipo
Template,
se usar ese mismo objeto como plantilla base.
En el Captulo 4 podrs encontrar muchos ejemplo de uso de esta etiqueta.
F.1.6.
lter
Filtra el contenido de una variable.
Los ltros pueden ser encadenados sucesivamente (La salida de uno es la entrada del siguiente), y pueden tener
argumentos, como en la sintaxis para variables
He aqu un ejemplo:
{ % filter escape|lower %}
This text will be HTML-escaped, and will appear in all lowercase.
{ % endfilter %}
F.1.7.
rstof
Presenta como salida la primera de las variables que se le pasen que evale como no falsa. La salida ser nula si
todas las variables pasadas valen
False.
He aqu un ejemplo:
{ % firstof var1 var2 var3 %}
Equivale a:
{ % if var1 %}
{{ var1 }}
{ % else %}{ % if var2 %}
{{ var2 }}
{ % else %}{ % if var3 %}
{{ var3 }}
{ % endif %}{ % endif %}{ % endif %}
F.1.8.
for
Itera sobre cada uno de los elementos de un lista o array. Por ejemplo, para mostrar una lista de atletas, cuyos
nombres estn en la lista
athlete_list,
podramos hacer:
<ul>
{ % for athlete in athlete_list %}
<li>{{ athlete.name }}</li>
{ % endfor %}
</ul>
{ % for obj in list reversed %}.
for crea una serie de variables. A estas variables se puede acceder nicamente
Tambin se puede iterar la lista en orden inverso usando
Dentro de un bucle, la propia sentencia
dentro del bucle. Las distintas variables se explican en la Tabla F-1.
revisin 757 del 28 de julio de 2008
F.1. ETIQUETAS PREDEFINIDAS
329
Cuadro F.1: Variables accesibles dentro de bucles { % for %}
Variable
Descripcin
forloop.counter
forloop.counter0
forloop.revcounter
El nmero de vuelta o iteracin actual (usando un ndice basado en 1).
El nmero de vuelta o iteracin actual (usando un ndice basado en 0).
El nmero de vuelta o iteracin contando desde el n del bucle (usando
un ndice basado en 1).
forloop.revcounter0
El nmero de vuelta o iteracin contando desde el n del bucle (usando
un ndice basado en 0).
forloop.first
forloop.last
forloop.parentloop
F.1.9.
True
True
si es la primera iteracin.
si es la ltima iteracin.
Para bucles anidados, es una referencia al bucle externo.
if
La etiqueta
{ % if %}
evalua una variable. Si dicha variable se evalua como una expresin verdadera (Es decir,
False),
que el valor exista, no est vacia y no es el valor booleano
se muestra el contenido del bloque:
{ % if athlete_list %}
Number of athletes: {{ athlete_list|length }}
{ % else %}
No athletes.
{ % endif %}
}}
Si la lista
athlete_list no est vaca, podemos mostrar el nmero de atletas con la expresin {{ athlete_list|length
Adems, como se puede ver en el ejemplo, la etiqueta
mostrar en el caso de que la evaluacin de falso.
Las etiquetas
if
pueden usar operadores lgicos como
if
puede tener un bloque opcional
and, or
not
{ % else %}
que se
para evaluar expresiones ms complejas:
{ % if athlete_list and coach_list %}
Both athletes and coaches are available.
{ % endif %}
{ % if not athlete_list %}
There are no athletes.
{ % endif %}
{ % if athlete_list or coach_list %}
There are some athletes or some coaches.
{ % endif %}
{ % if not athlete_list or coach_list %}
There are no athletes or there are some coaches (OK, so
writing English translations of Boolean logic sounds
stupid; it's not our fault).
{ % endif %}
{ % if athlete_list and not coach_list %}
There are some athletes and absolutely no coaches.
{ % endif %}
La etiqueta
if no admite, sin embargo, mezclar los operadores and y or dentro de la misma comprobacin, porque
la orden de aplicacin de los operadores lgicos sera ambigua. Por ejemplo, el siguiente cdigo es invlido:
{ % if athlete_list and coach_list or cheerleader_list %}
Para combinar operadores
and
or,
puedes usar sentencias
if
anidadas, como en el siguiente ejemplo:
revisin 757 del 28 de julio de 2008
330
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
{ % if athlete_list %}
{ % if coach_list or cheerleader_list %}
We have athletes, and either coaches or cheerleaders!
{ % endif %}
{ % endif %}
Es perfectamente posible usar varias veces un operador lgico, siempre que sea el mismo siempre. Por ejemplo, el
siguiente cdigo es vlido:
{ % if athlete_list or coach_list or parent_list or teacher_list %}
F.1.10.
ifchanged
Comprueba si un valor ha sido cambiado desde la ltima iteracin de un bucle.
La etiqueta
ifchanged
solo tiene sentido dentro de un bucle. Tiene dos usos posibles:
1. Comprueba su propio contenido mostrado contra su estado anterior, y solo lo muestra si el
contenido ha cambiado. El siguiente ejemplo muestra una lista de das, y solo aparecer el nombre
del mes si este cambia:
<h1>Archive for {{ year }}</h1>
{ % for date in days %}
{ % ifchanged %}<h3>{{ date|date:"F" }}</h3>{ % endifchanged %}
<a href="{{ date|date:"M/d"|lower }}/">{{ date|date:"j" }}</a>
{ % endfor %}
2. Se le pasa una o ms variables, y se comprueba si esas variables han sido cambiadas:
{ % for date in days %}
{ % ifchanged date.date %} {{ date.date }} { % endifchanged %}
{ % ifchanged date.hour date.date %}
{{ date.hour }}
{ % endifchanged %}
{ % endfor %}
El ejemplo anterior muestra la fecha cada vez que cambia, pero slo muestra la hora si tanto la
hora como el da han cambiado.
F.1.11.
ifequal
Muestra el contenido del bloque si los dos argumentos suministrados son iguales.
He aqu un ejemplo:
{ % ifequal user.id comment.user_id %}
...
{ % endifequal %}
Al igual que con la etiqueta
{ % if %},
existe una clusula
{ % else %}
opcional.
Los argumentos pueden ser cadenas de texto, as que el siguiente cdigo es vlido:
{ % ifequal user.username "adrian" %}
...
{ % endifequal %}
Slo se puede comprobar la igualdad de variables o cadenas de texto. No se puede comparar con objetos Python
como
True
F.1.12.
False.
Para ello, utilice la etiqueta
if
directamente.
ifnotequal
Es igual que
ifequal,
excepto que comprueba que los dos parmetros suministrados no sean iguales.
revisin 757 del 28 de julio de 2008
F.1. ETIQUETAS PREDEFINIDAS
F.1.13.
331
include
Carga una plantilla y la representa usando el contexto actual. Es una forma de incluir una plantilla dentro de
otra.
El nombre de la plantilla puede o bien ser el valor de una variable o estar escrita en forma de cadena de texto,
rodeada ya sea con comillas simples o comillas dobles, a gusto del lector.
El siguiente ejemplo incluye el contenido de la plantilla
"foo/bar.html":
{ % include "foo/bar.html" %}
Este otro ejemplo incluye el contenido de la plantilla cuyo nombre sea el valor de la variable
template_name:
{ % include template_name %}
F.1.14.
load
Carga una biblioteca de plantillas. En el
`Captulo 10`_ puedes encontrar ms informacin acerca de las bibliotecas
de plantillas.
F.1.15.
now
Muestra la fecha, escrita de acuerdo a un formato indicado.
Esta etiqueta fue inspirada por la funcin
net/date).
date()
de PHP(), y utiliza el mismo formato que esta (http://php.
La versin Django tiene, sin embargo, algunos extras.
La tabla F-2 muestra las cadenas de formato que se pueden utilizar.
Cuadro F.2: Cadenas de formato para fechas y horas
Carc. formato
a
Descripcin
'a.m.'
'p.m.'.
Ejemplo de salida
(Obsrvese que
'a.m.'
la salida es ligeramente distinta de
la de PHP, ya que aqu se incluyen
puntos para adecuarse al libro de
estilo de Associated Press).
A
'AM'
El nombre del mes, en forma de
'PM'.
'AM'
'jan'
abreviatura de tres letras minsculas.
d
Da del mes, dos dgitos que inclu-
'01'
'31'
yen rellenando con cero por la izquierda si fuera necesario.
D
Da de la semana, en forma de
'Fri'
abreviatura de tres letras.
f
La hora, en formato de 12 horas y
'1', '1:30'
minutos, omitiendo los minutos si
estos son cero.
F
El mes, en forma de texto
La hora, en formato de 12 horas,
'January'
'1' a '12'
sin rellenar por la izquierda con ceros.
G
La hora, en formato de 24 horas,
'0'
'23'
sin rellenar por la izquierda con ceros.
h
La hora, en formato de 12 horas.
La hora, en formato de 24 horas.
Minutos.
'01'
'00'
'00'
a
a
a
'12'
'23'
'59'
revisin 757 del 28 de julio de 2008
332
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
Cuadro F.2: Cadenas de formato para fechas y horas
Carc. formato
j
Descripcin
Ejemplo de salida
El da del mes, sin rellenar por la
'1'
'31'
izquierda con ceros.
l
El nombre del da de la semana.
Booleano que indica si el ao es
'Friday'
True o False
bisiesto.
m
El da del mes, rellenando por la
'01'
'12'
izquierda con ceros si fuera necesario.
M
Nombre del mes, abreviado en for-
'Jan'
ma de abreviatura de tres letras.
n
El mes, sin rellenar con ceros
La abreviatura del mes siguiendo
'1' a '12'
'Jan.', 'Feb.' , 'March', 'May'
el estilo de la Associated Press.
O
Diferencia con respecto al tiempo
'+0200'
medio de Grennwich (Greenwich
Mean Time - GMT)
P
La hora, en formato de 12 horas,
'1 a.m.', '1:30 p.m.' , 'midnight', 'noon' , '12:30 p.m.'
ms los minutos, recto si estos son
cero y con la indicacin a.m./p.m.
Adems,
se
usarn
de texto especiales
'noon'
las
cadenas
'midnight'
para la medianoche y el
medioda respectivamente.
r
La fecha en formato RFC 822.
Los segundos, rellenos con ceros
'Thu, 21 Dec 2000 16:01:07 +0200'
'00' a '59'
por la izquierda de ser necesario.
S
El su jo ingls para el da del mes
'st', 'nd', 'rd'
'th'
28 a 31
'EST', 'MDT'
'0' (Domingo)
'6'
(dos caracteres).
t
Nmero de das del mes.
Zona horaria
Da de la semana, en forma de d-
(Sbado)
gito.
W
Semana del ao, siguiente la nor-
1, 23
ma ISO-8601, con la semana empezando el lunes.
y
Ao, con dos dgitos.
Ao, con cuatro dgitos.
Da del ao
Desfase de la zona horaria, en se-
'99'
'1999'
0 a 365
-43200 a 43200
gundos. El desplazamiento siempre es negativo para las zonas al
oeste del meridiano de Greenwich,
y positivo para las zonas que estn
al este.
He aqu un ejemplo:
It is { % now "jS F Y H:i" %}
Se pueden escapar los caracteres de formato con una barra invertida, si se quieren incluir de forma literal. En el
siguiente ejemplo, se escapa el signi cado de la letra f con la barra invertida, ya que de otra manera se interpretara
revisin 757 del 28 de julio de 2008
F.1. ETIQUETAS PREDEFINIDAS
333
como una indicacin de incluir la hora. La o, por otro lado, no necesita ser escapada, ya que no es un carcter de
formato:
It is the { % now "jS o\f F" %}
El ejemplo mostrara: It is the 4th of September.
F.1.16.
regroup
Reagrupa una lista de objetos similares usando un atributo comn.
people es una lista de objetos de tipo
gender. Queremos mostrar un listado
Para comprender esta etiqueta, es mejor recurrir a un ejemplo. Digamos que
Person,
y que dichos objetos tienen los atributos
first_name, last_name
como el siguiente:
* Male:
* George Bush
* Bill Clinton
* Female:
* Margaret Thatcher
* Condoleezza Rice
* Unknown:
* Pat Smith
El siguiente fragmento de plantilla mostrara como realizar esta tarea:
{ % regroup people by gender as grouped %}
<ul>
{ % for group in grouped %}
<li>{{ group.grouper }}
<ul>
{ % for item in group.list %}
<li>{{ item }}</li>
{ % endfor %}
</ul>
</li>
{ % endfor %}
</ul>
Como puedes ver, { % regroup %} crea una nueva variable, que es una lista de objetos que tienen dos tributos,
grouper y list. En grouper se almacena el valor de agrupacin, list contiene una lista de los objetos que tenan en
comn al valor de agrupacin. En este caso, grouper podra valer Male, Female y Unknown, y list sera una lista con
las personas correspondientes a cada uno de estos sexos.
Hay que destacar que
{ % regroup %}
no funciona correctamente cuando la lista no est ordenada por el mismo
atributo que se quiere agrupar. Esto signi ca que si la lista del ejemplo no est ordenada por el sexo, debes asegurarte
de que se ordene antes correctamente, por ejemplo con el siguiente cdigo:
{ % regroup people|dictsort:"gender" by gender as grouped %}
F.1.17.
spaceless
Elimina los espacios en blanco entre etiquetas Html. Esto incluye tabuladores y saltos de lnea.
El siguiente ejemplo:
{ % spaceless %}
<p>
<a href="foo/">Foo</a>
</p>
{ % endspaceless %}
Retornara el siguiente cdigo HTML:
<p><a href="foo/">Foo</a></p>
revisin 757 del 28 de julio de 2008
334
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
Slo se eliminan los espacios entre las etiquetas, no los espacios entre la etiqueta y el texto. En el siguiente ejemplo,
no se quitan los espacios que rodean la palabra
Hello:
{ % spaceless %}
<strong>
Hello
</strong>
{ % endspaceless %}
F.1.18.
ssi
Muestra el contenido de un chero determinado dentro de la pgina.
Al igual que la etiqueta include,
{ % ssi %} incluye el contenido de otro chero (que debe ser especi cado usando
una ruta absoluta) en la pgina actual:
{ % ssi /home/html/ljworld.com/includes/right_generic.html %}
Si se le pasa el parmetro opcional parsed, el contenido del chero incluido se evala como si fuera cdigo de
plantilla, usando el contexto actual:
{ % ssi /home/html/ljworld.com/includes/right_generic.html parsed %}
Para poder usar la etiqueta
{ % ssi %},
hay que de nir el valor ALLOWED_INCLUDE_ROOTS en los ajustes
de Django, como medida de seguridad.
La mayor parte de las veces,
{ % include %} funcionar mejor que { % ssi %}; esta se ha incluido slo para garantizar
compatibilidad hacia atrs.
F.1.19.
templatetag
Permite representar los caracteres que estn de nidos como parte del sistema de plantillas.
Como el sistema de plantillas no tiene el concepto de escapar el signi cado de las combinaciones de smbolos que
usa internamente, tenemos que recurrir a la etiqueta
{ % templatetag %}
si nos vemos obligados a representarlos.
Se le pasa un argumento que indica que combinacin de smbolos debe producir. Los valores posibles del argumento
se muestran en la tabla F-3.
Cuadro F.3: Argumentos vlidos de templatetag
Argumento
openblock
closeblock
openvariable
closevariable
openbrace
closebrace
opencomment
closecomment
F.1.20.
Salida
{%
%}
{{
}}
{
}
{#
#}
url
Devuelve una URL absoluta (Es decir, una URL sin la parte del dominio) que coincide con una determinada
vista, incluyendo sus parmetros opcionales. De esta forma se posibilita realizar enlaces sin violar el principio DRY,
codi cando las direcciones en nuestras plantillas:
{ % url path.to.some_view arg1,arg2,name1=value1 %}
El primer argumento es la ruta a la funcin de vista, en el formato
paquete.paquete.modulo.funcion.
El resto
de parmetros son opcionales y deben ir separados con comas, convirtindose en parmetros posicionales o por nombre
que se incluirn en la URL. Deben estar presentes todos los argumentos que se hayan de nido como obligatorios en el
URLconf.
revisin 757 del 28 de julio de 2008
F.2. FILTROS PREDEFINIDOS
335
Por ejemplo, supongamos que tenemos una vista,
app_name.client,
y que en el URLconf se la indica que acepta
un parmetro, el identi cador del cliente. La lnea del URL podra ser algo as:
('^client/(\d+)/$', 'app_name.client')
Si este URLconf fuera incluido en el URLconf del proyecto bajo un directorio, como en este ejemplo:
('^clients/', include('project_name.app_name.urls'))
Podramos crear un enlace a esta vista, en nuestra plantilla, con la siguiente etiqueta:
{ % url app_name.client client.id %}
La salida de esta etiqueta ser
F.1.21.
/clients/client/123/.
widthratio
Esta etiqueta es til para presentar gr cos de barras y similares. Calcula la proporcin entre un valor dado y un
mximo prede nido, y luego multiplica ese cociente por una constante.
Veamos un ejemplo:
<img src="bar.gif" height="10" width="{ % widthratio this_value max_value 100 %}" />
this_value
Si
vale 175 y
max_value
es 200, la imagen resultante tendr un ancho de 88 pixels (porque 175/200
= 0.875 y 0.875 * 100 = 87.5, que se redondea a 88).
F.2.
F.2.1.
Filtros prede nidos
add
Ejemplo:
{{ value|add:"5" }}
Suma el argumento indicado.
F.2.2.
addslashes
Ejemplo:
{{ string|addslashes }}
Aade barras invertidas antes de las comillas, ya sean simples o dobles. Es til para pasar cadenas de texto como
javascript, por ejemplo:
F.2.3.
cap rst
Ejemplo:
{{ string|capfirst }}
Pasa a maysculas la primera letra de la primera palabra.
F.2.4.
center
Ejemplo:
{{ string|center:"50" }}
Centra el texto en un campo de la anchura indicada.
F.2.5.
cut
Ejemplo:
{{ string|cut:"spam" }}
Elimina todas las apariciones del valor indicado.
revisin 757 del 28 de julio de 2008
336
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
F.2.6.
date
Ejemplo:
{{ value|date:"F j, Y" }}
Formatea una fecha de acuerdo al formato indicado en la cadena de texto (Se usa el mismo formato que con la
etiqueta
now).
F.2.7.
default
Ejemplo:
{{ value|default:"(N/A)" }}
Si
value
F.2.8.
no est de nido, se usa el valor del argumento en su lugar.
default_if_none
Ejemplo:
{{ value|default_if_none:"(N/A)" }}
Si
value
F.2.9.
es nulo, se usa el valor del argumento en su lugar.
dictsort
Ejemplo:
{{ list|dictsort:"foo" }}
Acepta una lista de diccionarios y devuelve una lista ordenada segn la propiedad indicada en el argumento.
F.2.10.
dictsortreversed
Ejemplo:
{{ list|dictsortreversed:"foo" }}
Acepta una lista de diccionarios y devuelve una lista ordenada de forma descendente segn la propiedad indicada
en el argumento.
F.2.11.
divisibleby
Ejemplo:
{ % if value|divisibleby:"2" %}
Even!
{ % else %}
Odd!
{ % else %}
Devuelve
F.2.12.
True
si es valor pasado es divisible por el argumento.
escape
Ejemplo:
{{ string|escape }}
Transforma un texto que est en HTML de forma que se pueda representar en una pgina web. Concretamente,
realiza los siguientes cambios:
"&" a "&"
< a "<"
> a ">"
'"' (comilla doble) a '"'
"'" (comillas simple) a '''
revisin 757 del 28 de julio de 2008
F.2. FILTROS PREDEFINIDOS
F.2.13.
337
lesizeformat
Ejemplo:
{{ value|filesizeformat }}
Representa un valor, interpretndolo como si fuera el tamao de un chero y humanizando el resultado, de forma
que sea fcil de leer. Por ejemplo, las salidas podran ser
F.2.14.
'13 KB', '4.1 MB', '102 bytes',
etc.
rst
Ejemplo:
{{ list|first }}
Devuelve el primer elemento de una lista.
F.2.15.
x_ampersands
Ejemplo:
{{ string|fix_ampersands }}
&.
Reemplaza los smbolos ampersand con la entidad
F.2.16.
oatformat
Ejemplos:
{{ value|floatformat }}
{{ value|floatformat:"2" }}
Si se usa sin argumento, redondea un nmero en coma otante a un nico dgito decimal (pero slo si hay una
parte decimal que mostrar), por ejemplo:
36.123
36.15
36
se representara como
se representara como
se representara como
36.2.
36.
Si te utiliza un argumento numrico,
36.1234
36
36.1.
floatformat
redondea a ese nmero de lugares decimales:
con oatformat:3 se representara como
con oatformat:4 se representara como
Si el argumento pasado a
floatformat
36.123.
36.0000.
es negativo, redondear a ese nmero de decimales, pero slo si el nmero
tiene parte decimal.
36.1234
36
Usar
con oatformat:-3 gets converted to
con oatformat:-4 gets converted to
floatformat
F.2.17.
36.123.
36.
sin argumentos es equivalente a usarlo con un argumento de -1.
get_digit
Ejemplo:
{{ value|get_digit:"1" }}
Dado un nmero, devuelve el dgito que est en la posicin indicada, siendo 1 el dgito ms a la derecha. En caso
de que la entrada sea invlida, devolver el valor original (Si la entrada o el argumento no fueran enteros, o si el
argumento fuera inferior a 1). Si la entrada es correcta, la salida siempre ser un entero.
revisin 757 del 28 de julio de 2008
338
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
F.2.18.
join
Ejemplo:
{{ list|join:", " }}
Concatena todos los elementos de una lista para formar una cadena de texto, usando como separador el texto que
se le pasa como argumento. Es equivalente a la llamada en Python
F.2.19.
str.join(list)
length
Ejemplo:
{{ list|length }}
Devuelve la longitud del valor.
F.2.20.
length_is
Ejemplo:
{ % if list|length_is:"3" %}
...
{ % endif %}
Devuelve un valor booleano que ser verdadero si la longitud de la entrada coincide con el argumento suministrado.
F.2.21.
linebreaks
Ejemplo:
{{ string|linebreaks }}
Convierte los saltos de lnea en etiquetas
F.2.22.
<p>
<br />.
linebreaksbr
Ejemplo:
{{ string|linebreaksbr }}
Convierte los saltos de lnea en etiquetas
F.2.23.
<br />.
linenumbers
Ejemplo:
{{ string|linenumbers }}
Muestra el texto de la entrada con nmeros de lnea.
F.2.24.
ljust
Ejemplo:
{{ string|ljust:"50" }}
Justi ca el texto de la entrada a la izquierda utilizando la anchura indicada.
F.2.25.
lower
Ejemplo:
{{ string|lower }}
Convierte el texto de la entrada a letras minsculas.
revisin 757 del 28 de julio de 2008
F.2. FILTROS PREDEFINIDOS
F.2.26.
339
make_list
Ejemplo:
{ % for i in number|make_list %}
...
{ % endfor %}
Devuelve la entrada en forma de lista. Si la entrada es un nmero entero, se devuelve una lista de dgitos. Si es
una cadena de texto, se devuelve una lista de caracteres.
F.2.27.
phone2numeric
Ejemplo:
{{ string|phone2numeric }}
Convierte un nmero de telfono (que incluso puede contener letras) a su forma numrica equivalente. Por ejemplo
'800-COLLECT'
se transformar en
'800-2655328'.
La entrada no tiene porque ser un nmero de telfono vlido. El ltro convertir alegremente cualquier texto que
se le pase.
F.2.28.
pluralize
Ejemplo:
The list has {{ list|length }} item{{ list|pluralize }}.
Retorno el su jo para formar el plural si el valor es mayor que uno. Por defecto el su jo es
's'.
Ejemplo:
You have {{ num_messages }} message{{ num_messages|pluralize }}.
Para aquellas palabras que requieran otro su jo para formar el plural, podemos usar una sintaxis alternativa en la
que indicamos el su jo que queramos con un argumento.
Ejemplo:
You have {{ num_walruses }} walrus{{ num_walrus|pluralize:"es" }}.
Para aquellas palabras que forman el plural de forma ms compleja que con un simple su jo, hay otra tercera
sintaxis que permite indicar las formas en singular y en plural a partir de una raz comn.
Ejemplo:
You have {{ num_cherries }} cherr{{ num_cherries|pluralize:"y,ies" }}.
F.2.29.
pprint
Ejemplo:
{{ object|pprint }}
Un recubrimiento que permite llamar a la funcin de Python
pprint.pprint.
depurado de errores.
F.2.30.
random
Ejemplo:
{{ list|random }}
Devuelve un elemento elegido al azar de la lista.
revisin 757 del 28 de julio de 2008
Se usa sobre todo para tareas de
340
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
F.2.31.
removetags
Ejemplo:
{{ string|removetags:"br p div" }}
Elimina de la entrada una o varias clases de etiquetas [X]HTML. Las etiquetas se indican en forma de texto,
separando cada etiqueta a eliminar por un espacio.
F.2.32.
rjust
Ejemplo:
{{ string|rjust:"50" }}
Justi ca el texto de la entrada a la derecha utilizando la anchura indicada..
F.2.33.
slice
Ejemplo:
{{ some_list|slice:":2" }}
Devuelve una seccin de la lista.
Usa la misma sintaxis que se usa en Python para seccionar una lista. Vase http://diveintopython.org/native_data_types/lists.ht
para una explicacin.
F.2.34.
slugify
Ejemplo:
{{ string|slugify }}
Convierte el texto a minsculas, elimina los caracteres que no formen palabras (caracteres alfanumricos y carcter
subrayado), y convierte los espacios en guiones. Tambin elimina los espacios que hubiera al principio y al nal del
texto.
F.2.35.
stringformat
Ejemplo:
{{ number|stringformat:"02i" }}
Formatea el valor de entrada de acuerdo a lo especi cado en el formato que se le pasa como parmetro. La sintaxis
a utilizar es idntica a la de Python, con la excepcin de que el carcter % se omite.
En
http://docs.python.org/lib/typesseq-strings.html puedes consultar las opciones de formateo de cadenas
de Python.
F.2.36.
striptags
Ejemplo:
{{ string|striptags }}
Elimina todas las etiquetas [X]HTML.
F.2.37.
time
Ejemplo:
{{ value|time:"P" }}
Formatea la salida asumiendo que es una fecha/hora, con el formato indicado como argumento (Lo mismo que la
etiqueta
now).
revisin 757 del 28 de julio de 2008
F.2. FILTROS PREDEFINIDOS
F.2.38.
341
timesince
Ejemplos:
{{ datetime|timesince }}
{{ datetime|timesince:"other_datetime" }}
Representa una fecha como un intervalo de tiempo (por ejemplo, 4 days, 6 hours).
Acepta un argumento opcional, que es una variable con la fecha a usar como punto de referencia para calcular el
blog_date es una fecha con valor
comment_date es una fecha con valor las 08:00 horas del da 1 de junio
{{ comment_date|timesince:blog_date }} devolvera 8 hours.
intervalo (Si no se especi ca, la referencia es el momento actual). Por ejemplo, si
igual a la medianoche del 1 de junio de 2006, y
de 2006, entonces
F.2.39.
timeuntil
Ejemplos:
{{ datetime|timeuntil }}
{{ datetime|timeuntil:"other_datetime" }}
timesince, excepto en que mide el tiempo desde la fecha de referencia hasta la fecha dada. Por ejemplo,
conference_date es una fecha cuyo valor es igual al 29 de junio de 2006, entonces {{
conference_date|timeuntil }} devolvera 28 days.
Es similar a
si hoy es 1 de junio de 2006 y
Acepta un argumento opcional, que es una variable con la fecha a usar como punto de referencia para calcular el
intervalo, si se quiere usar otra distinta del momento actual. Si
conference_date|timeuntil:from_date }}
F.2.40.
from_date
apunta al 22 de junio de 2006, entonces
{{
devolvera 7 days.
title
Ejemplo:
{{ string|titlecase }}
Representa una cadena de texto en forma de ttulo, siguiendo las convenciones del idioma ingls (todas las palabras
con la inicial en mayscula).
F.2.41.
truncatewords
Ejemplo:
{{ string|truncatewords:"15" }}
Recorta la salida de forma que tenga como mximo el nmero de palabras que se indican en el argumento.
F.2.42.
truncatewords_html
Ejemplo:
{{ string|truncatewords_html:"15" }}
Es similar a
truncatewords, excepto que es capaz de reconocer las etiquetas HTML y, por tanto, no deja etiquetas
hurfanas. Cualquier etiqueta que se hubiera abierto antes del punto de recorte es cerrada por el propio ltro.
Es menos e ciente que
truncatewords,
as que debe ser usada solamente si sabemos que en la entrada va texto
HTML.
F.2.43.
unordered_list
Ejemplo:
<ul>
{{ list|unordered_list }}
</ul>
revisin 757 del 28 de julio de 2008
342
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
Acepta una lista, e incluso varias listas anidadas, y recorre recursivamente las mismas representndolas en forma
de listas HTML no ordenadas, sin incluir las etiquetas de inicio y n de lista (<ul> y
</ul> respectivamente).
var contiene ['States', [['Kansas',
[['Lawrence', []], ['Topeka', []]]], ['Illinois', []]]], entonces {{ var|unordered_list }} retornara
Se asume que las listas est en el formato correcto. Por ejemplo, si
lo siguiente:
<li>States
<ul>
<li>Kansas
<ul>
<li>Lawrence</li>
<li>Topeka</li>
</ul>
</li>
<li>Illinois</li>
</ul>
</li>
F.2.44.
upper
Ejemplo:
{{ string|upper }}
Convierte una string a maysculas.
F.2.45.
urlencode
Ejemplo:
<a href="{{ link|urlencode }}">linkage</a>
Escapa la entrada de forma que pueda ser utilizado dentro de una URL.
F.2.46.
urlize
Ejemplo:
{{ string|urlize }}
Transforma un texto de entrada, de forma que si contiene direcciones URL en texto plano, las convierte en enlaces
HTML.
F.2.47.
urlizetrunc
Ejemplo:
{{ string|urlizetrunc:"30" }}
Convierte las direcciones URL de un texto en enlaces, recortando la representacin de la URL para que el nmero
de caracteres sea como mximo el del argumento suministrado.
F.2.48.
wordcount
Ejemplo:
{{ string|wordcount }}
Devuelve el nmero de palabras en la entrada.
F.2.49.
wordwrap
Ejemplo:
{{ string|wordwrap:"75" }}
Ajusta la longitud del texto para las lneas se adecen a la longitud especi cada como argumento.
revisin 757 del 28 de julio de 2008
F.2. FILTROS PREDEFINIDOS
F.2.50.
343
yesno
Ejemplo:
{{ boolean|yesno:"Yes,No,Perhaps" }}
Dada una serie de textos que se asocian a los valores de
True, False y (opcionalmente) None, devuelve uno de esos
textos segn el valor de la entrada. Vase la tabla F-4.
Cuadro F.4: Ejemplos del ltro yesno
Valor
True
False
None
None
Argumento
"yeah,no,maybe"
"yeah,no,maybe"
"yeah,no,maybe"
"yeah,no"
Salida
yeah
no
maybe
"no" (considera None como False si no se asigna ningn
texto a None.
revisin 757 del 28 de julio de 2008
344
APNDICE F. ETIQUETAS DE PLANTILLA Y FILTROS PREDEFINIDOS
revisin 757 del 28 de julio de 2008
Apndice G
El utilitario django-admin
django-admin.py
es el utilitario de linea de comandos de Djangopara tareas administrativas.
Este apndice explica sus mltiples poderes.
Usualmente accedes a
django-admin.py
cosas por ti antes de delegar a
django-admin.py:
Pone el paquete de tu proyecto en
Establece la variable de entorno
manage.py. manage.py es creado
django-admin.py. Toma cuidado de
a travs del wrapper del proyecto
tomticamente en cada proyecto Django y es un wrapper liviano en torno a
audos
sys.path.
DJANGO_SETTINGS_MODULE
para que apunte al archivo
settings.py
de tu proyecto.
django-admin.py debe estar en la ruta de tu sistema si instalaste Django mediante su utilitario setup.py.
site-packages/django/bin dentro de tu instalacin de Python. Considera
establecer un enlace simblico a l desde algn lugar en tu ruta, como en /usr/local/bin.
Los usuarios de Windows, que no disponen de la funcionalidad de los enlaces simblicos, pueden copiar django-admin.py
a una ubicacin que est en su ruta existente o editar la con guracin del PATH (bajo Con guracin ~TRA Panel de
El script
Si no est en tu ruta, puedes encontrarlo en
Control ~TRA Sistema ~TRA Avanzado ~TRA Entorno) para apuntar a la ubicacin de su instalacin.
Generalmente, cuando se trabaja en un proyecto Django simple, es ms fcil usar
con
DJANGO_SETTINGS_MODULE
o la opcin de lnea de comando
--settings,
archivos de con guracin de Django.
Los ejemplos de lnea de comandos a lo largo de este apndice usan
cada ejemplo puede usar de la misma forma
G.1.
manage.py.
manage.py. Usa django-admin.py
si necesitas cambiar entre mltiples
django-admin.py
para ser consistentes, pero
Uso
El uso bsico es:
django-admin.py action [options]
o:
manage.py action [options]
action
debe ser una de las acciones listadas en este documento.
options,
que es opcional, deben ser cero o ms
opciones de las listadas en este documento.
Ejecuta
django-admin.py --help para ver un mensaje de ayuda que incluye una larga lista de todas las opciones
y acciones disponibles.
La mayora de las acciones toman una lista de nombres de aplicacin. Un nombre de aplicacin es el nombre base
del paquete que contiene tus modelos. Por ejemplo, si tu
de la aplicacin es
G.2.
blog.
INSTALLED_APPS contiene el string 'mysite.blog', el nombre
Acciones Disponibles
Las siguientes secciones cubren las acciones disponibles.
revisin 757 del 28 de julio de 2008
346
G.2.1.
APNDICE G. EL UTILITARIO DJANGO-ADMIN
adminindex [appname appname ...]
Imprime el snippet de la plantilla de admin-index para los nombres de aplicacin dados. Usa los snippets de la
plantilla de admin-index si quiere personalizar la apariencia de la pgina del ndice del administrador.
G.2.2.
createcachetable [tablename]
Crea una tabla de cache llamada
tablename para usar con el back-end de cache de la base de datos. Ver el Captulo
13 para ms acerca de caching.
G.2.3.
dbshell
DATABASE_ENGINE,
DATABASE_USER, DATABASE_PASSWORD, etc.
Corre el cliente de lnea de comandos del motor de base de datos especi cado en tu con guracin de
con los parmetros de conexin especi cados en la con guracin de
Para PostgreSQL, esto ejecuta el cliente de lnea de comandos
psql
For MySQL, esto ejecuta el cliente de lnea de comandos
mysql.
For SQLite, esto ejecuta el cliente de lnea de comandos
sqlite3.
PATH de manera que una simple llamada con el nombre del
mysql, o sqlite3) encontrar el programa en el lugar correcto. No hay forma de especi car en forma
Este comando asume que los programas estn en tu
programa (psql,
manual la localizacin del programa.
G.2.4.
disettings
Muestra las diferencias entre la con guracin actual y la con guracin por omisin de Django.
"###". Por ejemplo, la
ROOT_URLCONF, por lo que si aparece ROOT_URLCONF en la salida de diffsettings
Las con guraciones que no aparecen en la con guracin por omisin estn seguidos por
con guracin por omisin no de ne
lo hace seguido de
"###".
Observa que la con guracin por omisin de Django habita en
django.conf.global_settings,
si alguna vez
sientes curiosidad por ver la lista completa de valores por omisin.
G.2.5.
dumpdata [appname appname ...]
Dirige a la salida estndar todos los datos de la base de datos asociados con la(s) aplicacin(es) nombrada(s).
Por omisin, la base de datos ser volcada en formato JSON. Si quieres que la salida est en otro formato, usa la
--format (ej.: format=xml). Puedes especi car cualquier back-end de serializacin de Django (incluyendo cualSERIALIZATION_MODULES
setting). La opcin --indent puede ser usada para lograr una impresin diseada de la salida.
opcin
quier back-end de serializacin especi cado por el usuario mencionado en la con guracin de
Si no se provee niingn nombre de aplicacin, se volcarn todas las aplicaciones instaladas.
La salida de
G.2.6.
dumpdata
puede usarse como entrada para
loaddata.
ush
Devuelve la base de datos al estado en el que estaba inmediatemente despus de que se ejecut syncdb. Esto signi ca
que todos los datos sern eliminados de la base de datos, todo manejador de postsinchronizacin ser reejecutado, y
el componente
G.2.7.
initial_data
ser reinstalado.
inspectdb
Realiza la introspeccin sobre las tablas de la base de datos apuntada por la con guracin
un modulo de modelo de Django (un archivo
models.py)
DATABASE_NAME y enva
a la salida estndar.
Usa esto si tienes una base de datos personalizada con la cual quieres usar Django. El script inspeccionar la base
de datos y crear un modelo para cada tabla que contenga.
Como podrs esperar, los modelos creados tendrn un atributo por cada campo de la tabla. Observa que
inspectdb
tiene algunos casos especiales en los nombres de campo resultantes:
Si
inspectdb no puede mapear un tipo de columna a un tipo de campo del modelo, usar TextField
'This field type is a guess.' junto al campo en el modelo
e insertar el comentario Python
generado.
revisin 757 del 28 de julio de 2008
G.2. ACCIONES DISPONIBLES
347
Si el nombre de columna de la base de datos es una palabra reservada de Python( como 'pass',
'class', o 'for'), inspectdb agregar '_field' al nombre de atributo. Por ejemplo, si una tabla tiene una columna 'for', el modelo generado tendr un campo 'for_field', con el atributo db_column
establecido en 'for'. inspectdb insertar el comentario Python 'Field renamed because it was
a Python reserved word.' junto al campo.
Esta caracterstica est pensada como un atajo, no como la generacin de un modelo de nitivo. Despus de
ejecutarla, querrs revisar los modelos genrados para personalizarlos. En particular, necesitars reordenar los modelos
de manera tal que las relaciones esten ordenadas adecuadamente.
Las claves primarias son detectadas automticamente durante la introspeccin para PostgreSQL, MySQL, y SQLite,
primary_key=True donde sea necesario.
inspectdb trabaja con PostgreSQL, MySQL, y SQLite. La deteccin de claves forneas solo funciona en PostgreSQL
en cuyo caso Django coloca
y con ciertos tipos de tablas MySQL.
G.2.8.
loaddata [ xture xture ...]
Busca y carga el contenido del ' xture' nombrado en la base de datos.
Un xture es una coleccin de archivos que contienen los contenidos de la base de datos serializados. Cada xture
tiene un nombre nico; de todas formas, los archivos que conforman el xture pueden estar distribuidos en varios
directorios y en varias aplicaciones.
Django buscar xtures en tres ubicaciones:
fixtures
En el directorio
de cada aplicacin instalada.
En todo directorio nombreado en la con guracin
FIXTURE_DIRS
En el path literal nombrado por el xture
Django cargar todos los xtures que encuentre en estas ubucaciones que coincidan con los nombres de xture
dados.
Si el xture nombrado tiene una extensin de archivo, slo se cargarn xtures de ese tipo. Por ejemplo lo siguiente:
django-admin.py loaddata mydata.json
slo cargar xtures JSON llamados
un serializador (ej.:
json
xml).
mydata.
La extensin del xture debe corresponder al nombre registrado de
Si omites la extensin, Django buscar todos los tipos de xture disponibles para un xture coincidente. Por
ejemplo, lo siguiente:
django-admin.py loaddata mydata
buscar todos los xture de cualquier tipo de xture llamado
mydata. Si un directorio de xture contiene mydata.json,
ese xture ser cargado como un xture JSON. De todas formas, si se descubren dos xtures con el mismo nombre
pero diferente tipo (ej.: si se encuentran
mydata.json
mydata.xml en el mismo directorio de xture), la instalacin
loaddata ser removido de la base de datos.
de xture ser abortada, y todo dato instalado en la llamada a
Los xtures que son nombrados pueden incluir como componentes directorios. Estos directorios sern incluidos en
la ruta de bsqueda. Por ejemplo, lo siguiente:
django-admin.py loaddata foo/bar/mydata.json
buscar
<appname>/fixtures/foo/bar/mydata.json para cada aplicacin instalada, <dirname>/foo/bar/mydata.json
FIXTURE_DIRS, y la ruta literal foo/bar/mydata.json.
para cada directorio en
Observa que el orden en que cada xture es procesado es inde nido. De todas formas, todos los datos de xture
son instalados en una nica transaccin, por lo que los datos en un xture pueden referenciar datos en otro xture.
Si el back-end de la base de datos admite restricciones a nivel de registro, estas restricciones sern chequeadas al nal
de la transaccin.
El comando
dumpdata
puede ser usado para generar la entrada para
loaddata.
MySQL y los Fixtures
Desafortunadamente, MySQL no es capaz de dar soporte completo para todas las caractersticas
de las xtures de Django. Si usas tablas MyISAM, MySQL no admite transacciones ni restricciones,
por lo que no tendrs rollback si se encuentran varios archivos de transaccin, ni validacin de los
datos de xture. Si usas tablas InnoDB tables, no podrs tener referencias hacia adelante en tus
archivos de datos -- MySQL no provee un mecanismo para retrasar el chequeo de las restricciones
de registro hasta que la transaccin es realizada.
revisin 757 del 28 de julio de 2008
348
APNDICE G. EL UTILITARIO DJANGO-ADMIN
G.2.9.
reset [appname appname ...]
Ejecuta el equivalente de
G.2.10.
sqlreset
para los nombres de aplicacin dados.
runfcgi [options]
Inicia un conjunto de procesos FastCGI adecuados para su uso con cualquier servidor Web que admita el protocolo
FastCGI. Ver Captulo 20 para ms informacin acerca del desarrollo bajo FastCGI.
Este comando requiere el mdulo Python FastCGI de
G.2.11.
flup (http://www.djangoproject.com/r/flup/).
runserver [nmero de puerto opcional, or direccinIP:puerto]
Inicia un servidor Web liviano de desarollo en la mquina local. machine. Por omisin, el servidor ejecuta en el
puerto 8000 de la direccin IP 127.0.0.1. Puedes pasarle explcitamente una direccin IP y un nmero de puerto.
Si ejecutas este script como un usuario con privilegios normales (recomendado), puedes no tener acceso a iniciar
un puerto en un nmero de puerto bajo. Los nmeros de puerto bajos son reservados para el superusuario (root).
Advertencia
No uses este servidor en una con guracin de produccin. No se le han relizado auditoras
de seguridad o tests de performance, y no hay planes de cambiar este hecho. Los desarrolladores
de Django estn en el negocio de hacer Web frameworks, no servidores Web, por lo que mejorar
este servidor para que pueda manejar un entorno de produccin est fuera del alcance de Django.
El servidor de desarrollo carga automticamente el cdigo Python para cada pedido segn sea necesario. No
necesitas reiniciar el servidor para que los cambios en el cdigo tengan efecto.
Cuando inicias el servidor, y cada vez que cambies cdigo Python mientras el servidor est ejecutando, ste validar
todos tus modelos instalados. (Ver la seccin que viene sobre el comando
validate.) Si el validador encuentra errores,
los imprimir en la salida estndar, pero no detendr el servidor.
Puedes ejecutar tantos servidores como quieras, siempre que ejecuten en puertos separados. Slo ejecuta
runserver
django-admin.py
ms de una vez.
Observa que la direccin IP por omisin, 127.0.0.1, no es accesible desde las otras mquinas de la red. Para hacer
que el servidor de desarrollo sea visible a las otras mquinas de la red, usa su propia direccin IP (ej.: 192.168.2.1) o
0.0.0.0.
Por ejemplo, para ejecutar el servidor en el puerto 7000 en la direccin IP 127.0.0.1, usa esto:
django-admin.py runserver 7000
O para ejecutar el servidos en el puerto 7000 en la direccin IP 1.2.3.4, usa esto:
django-admin.py runserver 1.2.3.4:7000
Sirviendo Archivos Estticos con el Servidor de Desarrollo
Por omisin, el servidor de desarrollo no sirve archivos estticos para tu sitio (como archivos CSS, imgenes,
cosas bajo
MEDIA_ROOT_URL,
etc.). Si quieres con gurar Django para servir medios estticos, lee acerca de esto en
http://www.djangoproject.com/documentation/0.96/static_ les/.
Deshabilitando Autoreload
Para deshabilitar la recarga automtica del cdigo mientras el servidor de desarrollo se ejecuta, usa la opcin
--noreload,
como en:
django-admin.py runserver --noreload
G.2.12.
shell
Inicia el intrprete interactivo de Python.
Django utilizar IPython (http://ipython.scipy.org/) si no est instalado. Si tienes IPython instalado y quieres
forzar el uso del intrprete Python plano, usa la opcin
--plain,
como en:
django-admin.py shell --plain
revisin 757 del 28 de julio de 2008
G.2. ACCIONES DISPONIBLES
G.2.13.
sql [appname appname ...]
Imprime las sentencias SQL
G.2.14.
349
CREATE TABLE
para las aplicaciones mencionadas.
sqlall [appname appname ...]
CREATE TABLE y los datos iniciales para
sqlcustom para una explicacin de como
Imprime las sentencias SQL
las aplicaciones mencionadas.
Busca en la descripcin de
especi car los datos iniciales.
G.2.15.
sqlclear [appname appname ...]
Imprime las sentencias SQL
G.2.16.
DROP TABLE
para las aplicaciones mencionadas.
sqlcustom [appname appname ...]
Imprime las sentencias SQL personalizadas para las aplicaciones mencionadas.
<appname>/sql/<modelname>.sql,
<appname> es el nombre de la aplicacin dada y <modelname> es el nombre del modelo en minsculas. Por ejemplo, si tienes una aplicacin news que incluye un modelo Story, sqlcustom tratar de leer un archivo news/sql/story.sql
Para cada modelo en cada aplicacin especi cada, este comando busca el archivo
donde
y lo agregar a la salida de este comando.
Se espera que cada uno de los archivos SQL, si son dados, contengan SQL vlido. Los archivos SQL son canalizados
directamente a la base de datos despus que se hayan ejecutado todas las sentencias de creacin de tablas de los
modelos. Usa este enlace SQL para hacer cualquier modi cacin de tablas, o insertar funciones SQL en las bases de
datos.
Observa que el orden en que se procesan los archivos SQL es inde nido.
G.2.17.
sqlindexes [appname appname ...]
Imprime las sentencias SQL
G.2.18.
para las aplicaciones mencionadas.
sqlreset [appname appname ...]
Imprime las sentencias SQL
G.2.19.
CREATE INDEX
DROP TABLE
seguidas de las
CREATE TABLE
para las aplicaciones mencionadas.
sqlsequencereset [appname appname ...]
Imprime las sentencias SQL para reinicializar las secuencias de las aplicaciones mencionadas.
Necesitars esta SQL solo si ests usando PostgreSQL y has insertado datos a mano. Cuando haces eso, las
secuencias de las claves primarias de PostgreSQL pueden quedar fuera de sincronismo con las que estn en la base de
datos, y las SQL que genera este comando las limpiarn.
G.2.20.
startapp [appname]
Crea una estructura de directorios para una aplicacin Django con el nombre de aplicacin dado, en el directorio
actual.
G.2.21.
startproject [projectname]
Crea una estructura de directorios Django para el nombre de proyecto dado, en el directorio actual.
G.2.22.
syncdb
Crea las tablas de la base de datos para todas las aplicaciones en
INSTALLED_APPS cuyas tablas an no hayan sido
creadas.
Usa este comando cuando hayas agregado nuevas aplicaciones a tu proyecto y quieras instalarlas en la base de
datos. Esto incluye cualquier aplicacin incorporada en Django que est en
INSTALLED_APPS
por omisin. Cuando
empieces un nuevo proyecto, ejecuta este comando para instalas las aplicaciones predeterminadas.
Si ests instalando la aplicacin
mediatamente.
loaddata
syncdb
django.contrib.auth, syncdb
te dar la opcin de crear un superusuario in-
tambin buscar e instalar algun xture llamado
initial_data.
para los detalles de la especi cacin de los archivos de datos de xture.
revisin 757 del 28 de julio de 2008
Ver la documentacin de
350
APNDICE G. EL UTILITARIO DJANGO-ADMIN
G.2.23.
test
Descubre y ejecuta las pruebas para todos los modelos instalados. El testeo an est en desarrollo mientras se escribe
este libro, as que para aprender ms necesitars leer la documentacin online en
documentation/0.96/testing/.
G.2.24.
http://www.djangoproject.com/
validate
Valida todos los modelos instalados (segn la con guracin de
INSTALLED_APPS)
e imprime errores de validacin
en la salida estndar.
G.3.
Opciones Disponibles
Las secciones que siguen delinean las opciones que puede tomar
G.3.1.
django-admin.py.
--settings
Ejemplo de uso:
django-admin.py syncdb --settings=mysite.settings
Especi ca explcitamente el mdulo de con guracin a usar. El mdulo de con guracin debe estar en la sintaxis
mysite.settings).
de paquetes de Python (ej.:
DJANGO_SETTINGS_MODULE.
Observa que esta opcin no es necesaria en
Si no se proveen,
django-admin.py
utilizar la variable de entorno
manage.py, ya que toma en cuenta la con guracin de DJANGO_SETTINGS_MODULE
por t.
G.3.2.
--pythonpath
Ejemplo de uso:
django-admin.py syncdb --pythonpath='/home/djangoprojects/myproject'
Agrega la ruta del sistema de archivos a la ruta de bsqueda de importacin de Python. Si no se de ne,
usar la variable de entorno
PYTHONPATH.
Observa que esta opcin no es necesaria en
manage.py,
django-admin.py
ya que tiene cuidado de con gurar la ruta de Python por
t.
G.3.3.
--format
Ejemplo de uso:
django-admin.py dumpdata --format=xml
Especi ca el formato de salida que ser utilizado. El nombre provisto debe ser el nombre de un serializador
registrado.
G.3.4.
--help
Muestra un mensaje de ayuda que incluye una larga lista de todas las opciones y acciones disponibles.
G.3.5.
--indent
Ejemplo de uso:
django-admin.py dumpdata --indent=4
Especi ca el nmero de espacios que se utilizarn para la indentacin cuando se imprima una salida con formato
de impresin. Por omisin, la salida no tendr formato de impresin. El formato de impresin solo estar habilitado
si se provee la opcin de indentacin.
revisin 757 del 28 de julio de 2008
G.3. OPCIONES DISPONIBLES
G.3.6.
351
--noinput
Indica que no quieres que se te pida ninguna entrada. Es til cuando el script
django-admin se ejecutar en forma
automtica y desatendida.
G.3.7.
--noreload
Deshabilita el uso del autoreloader cuando se ejecuta el servidor de desarrollo.
G.3.8.
--version
Muestra la versin actual de Django.
Ejemplo de salida:
0.9.1
0.9.1 (SVN)
G.3.9.
--verbosity
Ejemplo de uso:
django-admin.py syncdb --verbosity=2
1
Determina la cantidad de noti caciones e informacin de depuracin que se imprimir en la consola.
es salida normal, y
G.3.10.
0 es sin salida,
es salida con explicaciones.
--adminmedia
Ejemplo de uso:
django-admin.py --adminmedia=/tmp/new-admin-style/
Le dice a Django donde encontrar los archivos CSS y JavaScript para la interfaz de administracin cuando se
ejecuta el servidor de desarrollo. Normalmente estos archivos son servidos por fuera del arbol de fuentes Django
pero como algunos diseadores personalizan estos archivos para su sitio, esta opcin te permite testear con versiones
personalizadas.
revisin 757 del 28 de julio de 2008
352
APNDICE G. EL UTILITARIO DJANGO-ADMIN
revisin 757 del 28 de julio de 2008
Apndice H
Objetos Peticin y Respuesta
Django usa los objetos respuesta y peticin para pasar informacin de estado a travs del sistema.
HttpRequest que contiene metadatos sobre la
HttpRequest como el primer argumento de la funcin
HttpResponse.
Cuando se peticiona una pgina, Django crea un objeto
Luego Django carga la vista apropiada, pasando el
Cada vista es responsable de retornar un objeto
peticin.
de vista.
Hemos usado estos objetos con frecuencia a lo largo del libro; este apndice explica las APIs completas para los
objetos
HttpRequest
H.1.
HttpResponse.
HttpRequest
HttpRequest
representa una sola peticin HTTP desde algn agente de usuario.
Mucha de la informacin importante sobre la peticin esta disponible como atributos en la instancia de
(mira la Tabla H-1). Todos los atributos excepto
session
HttpRequest
deben considerarse de slo lectura.
Cuadro H.1: Atributos de los objetos HttpRequest
Atributo
path
Descripcin
Un string que representa la ruta completa a la pgina peticionada, no incluye
el dominio -- por ejemplo,
method
"/music/bands/the_beatles/".
Un string que representa el mtodo HTTP usado en la peticin. Se garantiza
que estar en maysculas. Por ejemplo:
if request.method == 'GET':
do_something()
elif request.method == 'POST':
do_something_else()
GET
Un objeto similar a un diccionario que contiene todos los parmetros HTTP
GET dados. Mira la documentacin de
POST
QueryDict
que sigue.
Un objeto similar a un diccionario que contiene todos los parmetros HTTP
POST dados.Mira la documentacin de
QueryDict
que sigue.
Es posible que una peticin pueda ingresar va POST con un diccionario
POST
vaco -- si, digamos, un formulario es peticionado a travs del mtodo HTTP
if
request.POST para veri car el uso del mtodo POST; en su lugar, utiliza if
request.method == "POST" (mira la entrada method en esta tabla).
Nota: POST no incluye informacin sobre la subida de archivos. Mira FILES.
Por conveniencia, un objeto similar a un diccionario que busca en POST primero, y luego en GET. Inspirado por $_REQUEST de PHP.
Por
ejemplo,
si
GET = {"name": "john"} y POST = {"age": '34'},
REQUEST["name"] ser "john", y REQUEST["age"] ser "34".
Se sugiere encarecidamente que uses GET y POST en lugar de REQUEST, ya que
POST pero que no incluye datos de formulario. Por eso, no deberas usar
REQUEST
lo primero es ms explcito.
COOKIES
Un diccionario Python estndar que contiene todas las cookies. Las claves y
los valores son strings. Mira el Captulo 12 para ms sobre el uso de cookies.
revisin 757 del 28 de julio de 2008
354
APNDICE H. OBJETOS PETICIN Y RESPUESTA
Cuadro H.1: Atributos de los objetos HttpRequest
Atributo
FILES
Descripcin
Un objeto similar a un diccionario que contiene todos los archivos subidos.
Cada clave de
/>.
FILES es
FILES
Cada valor de
el atributo
name
de
<input type="file" name=""
es un diccionario Python estndar con las siguientes
tres claves:
filename: El nombre del archivo subido, como un string Python.
content-type:
content:
El contenido en crudo del archivo subido.
Nota que
FILES
el
que realiz la peticin contena
<form>
De lo contrario,
META
El tipo de contenido del archivo subido.
POST y
enctype="multipart/form-data".
contendr datos slo si el mtodo de la peticin fue
FILES
ser un objeto similar a un diccionario vaco.
Un diccionario Python estndar que contiene todos los encabezados HTTP
disponibles. Los encabezados disponibles dependen del cliente y del servidor,
pero estos son algunos ejemplos:
CONTENT_LENGTH
CONTENT_TYPE
QUERY_STRING:
La string de consulta en crudo sin analizar.
REMOTE_ADDR:
La direccin IP del cliente.
REMOTE_HOST:
El nombre host del cliente.
SERVER_NAME:
El nombre host del servidor.
SERVER_PORT:
El puerto del servidor.
Cualquier cabecera HTTP esta disponible en
HTTP_,
META
como claves con el pre jo
por ejemplo:
HTTP_ACCEPT_ENCODING
HTTP_ACCEPT_LANGUAGE
HTTP_HOST:
La cabecera HTTP
HTTP_REFERER:
host
enviada por el cliente
La pagina referente, si la hay
HTTP_USER_AGENT:
HTTP_X_BENDER:
La string de agente de usuario del cliente
El valor de la cabecera
X-Bender,
si esta es-
tablecida.
user
Un objeto
django.contrib.auth.models.User
que representa el usuario ac-
user se jar a
django.contrib.auth.models.AnonymousUser. Puedes distinguirlos con is_authenticated(), de este modo:
if request.user.is_authenticated():
# Do something for logged-in users.
else:
# Do something for anonymous users.
user esta disponible slo si tu instalacin Django tiene activado
AuthenticationMiddleware.
tual registrado. Si el usuario no esta actualmente registrado,
una instancia de
Para los detalles completos sobre autenticacin y usuarios, mira el Captulo
12.
session
Un objeto similar a un diccionario que se puede leer y modi car, que representa
la sesin actual. ste esta disponible slo si tu instalacin Django tiene activado
el soporte para sesiones. Mira el Captulo 12.
revisin 757 del 28 de julio de 2008
H.1. HTTPREQUEST
355
Cuadro H.1: Atributos de los objetos HttpRequest
Atributo
Descripcin
raw_post_data
Los datos HTTP POST en crudo. Esto es til para procesamiento avanzado.
Los objetos request tambin tienen algunos mtodos de utilidad, como se muestra en la Tabla H-2.
Cuadro H.2: Mtodos de HttpRequest
Mtodo
Descripcin
__getitem__(key)
Retorna el valor GET/POST para la clave dada, veri cando POST primero, y luego GET. Emite
KeyError
si la clave no existe.
Esto te permite usar sintaxis de acceso a diccionarios en una instancia
HttpRequest.
ejemplo,
request["foo"] es lo mismo que comprobar
request.POST["foo"] y luego request.GET["foo"].
Retorna True o False, sealando si request.GET o request.POST con-
Por
has_key()
tiene la clave dada.
get_full_path()
ruta, ms un string de consulta agregado. Por ejemplo,
"/music/bands/the_beatles/?print=true"
Retorna True si la peticin es segura; es decir si fue realizada con HTTRetorna la
is_secure()
PS.
H.1.1.
Objetos QueryDict
En un objeto
HttpRequest,
los atributos
GET
POST
son instancias de
django.http.QueryDict. QueryDict
es
una clase similar a un diccionario personalizada para tratar mltiples valores con la misma clave. Esto es necesario
ya que algunos elementos de un formulario HTML, en particular
<select multiple="multiple">,
pasan mltiples
valores para la misma clave.
Las instancias
QueryDict
son inmutables, a menos que realices una copia de ellas. Esto signi ca que tu no puedes
request.POST y request.GET.
QueryDict implementa todos los mtodos estndar de los diccionarios, debido a que es una subclase de diccionario.
cambiar directamente los atributos de
Las excepciones se resumen en la Tabla H-3.
Cuadro H.3: Como se diferencian los QueryDicts de los diccionarios
estndar.
Mtodo
__getitem__
Diferencias con la implementacin estndar de dict
Funciona como en un diccionario. Sin embargo, si la clave tiene ms de un
valor,
__setitem__
__getitem__()
retorna el ltimo valor.
Establece la clave dada a
value).
[value] (una lista de Python cuyo nico elemento es
Nota que sta, como otras funciones de diccionario que tienen efectos
secundarios, slo puede ser llamada en un
creado va
get()
update()
copy()).
Si la clave tiene ms de un valor,
__getitem__.
Recibe ya sea un
todo
update
QueryDict
get()
QueryDict
mutable (uno que fue
retorna el ltimo valor al igual que
o un diccionario estndar. A diferencia del m-
de los diccionarios estndar, este mtodo agrega elementos al
diccionario actual en vez de reemplazarlos:
>>> q = QueryDict('a=1')
>>> q = q.copy() # to make it mutable
>>> q.update({'a': '2'})
>>> q.getlist('a')
['1', '2']
>>> q['a'] # returns the last
['2']
revisin 757 del 28 de julio de 2008
356
APNDICE H. OBJETOS PETICIN Y RESPUESTA
Cuadro H.3: Como se diferencian los QueryDicts de los diccionarios
estndar.
Mtodo
Diferencias con la implementacin estndar de dict
items()
items() de un diccionario estndar, excepto que ste utiliza
__getitem()__:
>>> q = QueryDict('a=1&a=2&a=3')
>>> q.items()
[('a', '3')]
Similar al mtodo values() de un diccionario estndar, excepto que este utiliza la misma lgica del ltimo-valor de __getitem()__.
Similar al mtodo
la misma lgica del ltimo-valor de
values()
Adems,
QueryDict
posee los mtodos que se muestran en la Tabla H-4.
Cuadro H.4: Mtodos QueryDict Extra (No relacionados con diccionarios)
Mtodo
Descripcin
copy()
Retorna una copia del objeto, utilizando
copy.deepcopy()
de la
biblioteca estndar de Python. La copia ser mutable -- es decir,
puedes cambiar sus valores.
getlist(key)
Retorna los datos de la clave requerida, como una lista de Python. Retorna una lista vaca si la clave no existe. Se garantiza que
retornar una lista de algn tipo.
setlist(key, list_)
appendlist(key, item)
setlistdefault(key, l)
Establece la clave dada a
list_
Agrega un elemento item a la lista interna
Igual a
setdefault,
__setitem__()).
asociada a key.
(a diferencia de
excepto que toma una lista de valores en vez
de un slo valor.
lists()
Similar a
items(), excepto que incluye todos los valores, como una
lista, para cada miembro del diccionario. Por ejemplo:
>>> q = QueryDict('a=1&a=2&a=3')
>>> q.lists()
[('a', ['1', '2', '3'])]
urlencode()
H.1.2.
Retorna un string de los datos en formato query-string (ej.,
"a=2&b=3&b=5").
Un ejemplo completo
Por ejemplo, dado este formulario HTML:
<form action="/foo/bar/" method="post">
<input type="text" name="your_name" />
<select multiple="multiple" name="bands">
<option value="beatles">The Beatles</option>
<option value="who">The Who</option>
<option value="zombies">The Zombies</option>
</select>
<input type="submit" />
</form>
Si el usuario ingresa
"John Smith"
en el campo
your_name
y selecciona tanto The Beatles como The Zombies
en la caja de seleccin mltiple, lo siguiente es lo que contendr el objeto request de Django:
>>> request.GET
{}
>>> request.POST
{'your_name': ['John Smith'], 'bands': ['beatles', 'zombies']}
revisin 757 del 28 de julio de 2008
H.2. HTTPRESPONSE
357
>>> request.POST['your_name']
'John Smith'
>>> request.POST['bands']
'zombies'
>>> request.POST.getlist('bands')
['beatles', 'zombies']
>>> request.POST.get('your_name', 'Adrian')
'John Smith'
>>> request.POST.get('nonexistent_field', 'Nowhere Man')
'Nowhere Man'
Nota de implementacin:
Los atributos
GET, POST, COOKIES, FILES, META, REQUEST, raw_post_data,
user
son todos
cargados tardamente. Esto signi ca que Django no gasta recursos calculando los valores de estos
atributos hasta que tu cdigo los solicita.
H.2.
HttpResponse
HttpRequest, los cuales son creados automticamente por Django, los objetos HttpResponse
HttpResponse.
HttpResponse esta ubicada en django.http.HttpResponse.
A diferencia de los objetos
son tu responsabilidad. Cada vista que escribas es responsable de instanciar, poblar, y retornar un
La clase
H.2.1.
Construccin de HttpResponses
Tpicamente, tu construirs un
de
HttpResponse:
HttpResponse para pasar los contenidos de la pagina, como un string, al constructor
>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", mimetype="text/plain")
Pero si quieres agregar contenido de manera incremental, puedes usar
response
como un objeto similar a un
archivo:
>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")
Puedes pasarle a
HttpResponse
un iterador en vez de pasarle strings codi cadas a mano. Si utilizas esta tcnica,
sigue estas instrucciones:
El iterador debe retornar strings.
Si un HttpResponse ha sido inicializado con un iterador como su contenido, no puedes usar la instancia
HttpResponse como un objeto similar a un archivo. Si lo haces, emitir Exception.
Finalmente, nota que
HttpResponse implementa un mtodo write(), lo cual lo hace apto para usarlo en cualquier
lugar que Python espere un objeto similar a un archivo. Mira el Captulo 11 para ver algunos ejemplos de la utilizacin
de esta tcnica.
H.2.2.
Establecer las cabeceras
Puedes agregar o eliminar cabeceras usando sintaxis de diccionario:
>>> response = HttpResponse()
>>> response['X-DJANGO'] = "It's the best."
>>> del response['X-PHP']
>>> response['X-DJANGO']
"It's the best."
Puedes utilizar tambin
has_header(header) para veri car la existencia de una cabecera.
Cookie a mano; en cambio, mira el Captulo 12 para instrucciones sobre como trabajan
Evita con gurar cabeceras
las cookies en Django.
revisin 757 del 28 de julio de 2008
358
APNDICE H. OBJETOS PETICIN Y RESPUESTA
H.2.3.
Subclases de HttpResponse
Django incluye un numero de subclases
Tabla H-5). As como
HttpResponse,
HttpResponse
que manejan diferentes tipos de respuestas HTTP (mira la
estas subclases se encuentran en
django.http.
Cuadro H.5: Subclasses de HttpResponse
Clase
Descripcin
HttpResponseRedirect
El constructor toma un nico argumento: la ruta a la
cual re-dirigir. Esta puede ser una URL completa (ej.,
'http://search.yahoo.com/') o o una URL
sin dominio (ej., '/search/'). Ten en cuenta
absoluta
que esto
retorna un cdigo de estado HTTP 302.
HttpResponsePermanentRedirect
Como
HttpResponseRedirect,
pero esta retorna una
re-direccin permanente (cdigo de estado HTTP 301)
en vez de una re-direccin found (cdigo de estado
302).
HttpResponseNotModified
El constructor no tiene ningn argumento. Utiliza esta
para designar que una pgina no ha sido modi cada
desde la ltima peticin del usuario.
HttpResponseBadRequest
Acta como
HttpResponse pero usa un cdigo de estado
400.
HttpResponseNotFound
Acta como
HttpResponse pero usa un cdigo de estado
404.
HttpResponseForbidden
Acta como
HttpResponse pero usa un cdigo de estado
403.
HttpResponseNotAllowed
Como
HttpResponse, pero usa un cdigo de estado 405.
Toma un nico argumento: una lista de los mtodos
['GET', 'POST']).
Acta como HttpResponse pero usa un cdigo de estado
permitidos (ej.,
HttpResponseGone
410.
HttpResponseServerError
Acta como
HttpResponse pero usa un cdigo de estado
500
Puedes, por supuesto, de nir tus propias subclases de
HttpResponse
para permitir diferentes tipos de respuestas
no admitidas por las clases estndar.
H.2.4.
Retornar Errores
Retornar cdigos de error HTTP en Django es fcil. Ya hemos mencionado las subclases
HttpResponseForbidden, HttpResponseServerError,
subclases en lugar de una HttpResponse normal con el
HttpResponseNotFound,
y otras. Simplemente retorna una instancia de una de estas
n de signi car un error, por ejemplo:
def my_view(request):
# ...
if foo:
return HttpResponseNotFound('<h1>Page not found</h1>')
else:
return HttpResponse('<h1>Page was found</h1>')
Debido a que el error 404 es por mucho el error HTTP ms comn, hay una manera ms fcil de manejarlo.
Cuando retornas un error tal como
HttpResponseNotFound,
eres responsable de de nir el HTML de la pgina de
error resultante:
return HttpResponseNotFound('<h1>Page not found</h1>')
Por consistencia, y porque es una buena idea tener una pgina de error 404 consistente en todo tu sitio, Django
provee una excepcin
Http404.
Si tu emites una
Http404
en cualquier punto de una vista de funcin, Django la
atrapar y retornar la pgina de error estndar de tu aplicacin, junto con un cdigo de error HTTP 404.
revisin 757 del 28 de julio de 2008
H.2. HTTPRESPONSE
359
ste es un ejemplo:
from django.http import Http404
def detail(request, poll_id):
try:
p = Poll.objects.get(pk=poll_id)
except Poll.DoesNotExist:
raise Http404
return render_to_response('polls/detail.html', {'poll': p})
Con el n de usar la excepcin
Http404
al mximo, deberas crear una plantilla que se muestra cuando un error
404 es emitido. Esta plantilla debera ser llamada
404.html,
y debera colocarse en el nivel superior de tu rbol de
plantillas.
H.2.5.
Personalizar la Vista 404 (Not Found)
Http404, Django carga una vista especial dedicada a manejar errores 404. Por
django.views.defaults.page_not_found, la cual carga y renderiza la plantilla 404.html.
que necesitas de nir una plantilla 404.html en tu directorio raz de plantillas. Esta plantilla ser
Cuando tu emites una excepcin
omisin, es la vista
Esto signi ca
usada para todos los errores 404.
Esta vista
page_not_found debera ser su ciente para el 99 % de las aplicaciones Web, pero si tu quieres reemplazar
handler404 en tu URLconf, de la siguiente manera:
la vista 404, puedes especi car
from django.conf.urls.defaults import *
urlpatterns = patterns('',
...
)
handler404 = 'mysite.views.my_custom_404_view'
Detrs de escena, Django determina la vista 404 buscando por
handler404.
Por omisin, las URLconfs contienen
la siguiente lnea:
from django.conf.urls.defaults import *
handler404 en el mdulo actual. Como puedes ver en django/conf/urls/defaults.py,
'django.views.defaults.page_not_found' por omisin.
Esto se encarga de establecer
handler404
esta jado a
Hay tres cosas para tener en cuenta sobre las vistas 404:
La vista 404 es llamada tambin si Django no encuentra una coincidencia despus de veri car toda
expresin regular en la URLconf.
Si no de nes tu propia vista 404 -- y simplemente usas la predeterminada, lo cual es recomendado -tu an tienes una obligacin: crear una plantilla
404.html en la raz de tu directorio de plantillas. La
vista 404 predeterminada usar esa plantilla para todos los errores 404.
Si
DEBUG
esta establecido a
True
(en tu modulo de con guracin), entonces tu vista 404 nunca ser
usada, y se mostrar en su lugar el trazado de pila.
H.2.6.
Personalizar la Vista 500 (Server Error)
De manera similar, Django ejecuta comportamiento de caso especial en el caso de errores de ejecucin en el
cdigo de la vista. Si una vista resulta en una excepcin, Django llamar, de manera predeterminada, a la vista
django.views.defaults.server_error,
la cual carga y renderiza la plantilla
Esto signi ca que necesitas de nir una plantilla
500.html
500.html.
en el directorio raz de plantillas. Esta plantilla ser
usada para todos los errores de servidor.
Esta vista
server_error debera ser su ciente para el 99 % de las aplicaciones
handler500 en tu URLconf, de la siguiente manera:
la vista, puedes especi car
revisin 757 del 28 de julio de 2008
Web, pero si tu quieres reemplazar
360
APNDICE H. OBJETOS PETICIN Y RESPUESTA
from django.conf.urls.defaults import *
urlpatterns = patterns('',
...
)
handler500 = 'mysite.views.my_custom_error_view'
revisin 757 del 28 de julio de 2008
Apndice I
Docutils System Messages
Indirect hyperlink target captulo 10 (id=cap-tulo-10) refers to target extendiendo el sistema de plantillas,
which is a duplicate, and cannot be used as a unique reference.
Indirect hyperlink target captulo 19 (id=cap-tulo-19) refers to target seguridad, which is a duplicate, and
cannot be used as a unique reference.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Unknown target name: empaquetado de funciones vista.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Unknown target name: contraseas.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Duplicate target name, cannot be used as a unique reference: prximo captulo.
Unknown target name: nombres de tabla.
Generated on: 2008-07-28 23:53 UTC. Generated by Docutils from reStructuredText source.
revisin 757 del 28 de julio de 2008
También podría gustarte
- Academia X - Django de Cero A ExpertoAún no hay calificacionesAcademia X - Django de Cero A Experto83 páginas
- Django - 04. Django - Qué Es DjangoAún no hay calificacionesDjango - 04. Django - Qué Es Django8 páginas
- Desarrollo de Aplicaciones Web Con DjangoAún no hay calificacionesDesarrollo de Aplicaciones Web Con Django33 páginas
- Clase 17 - Intro Django + Proyecto FinalAún no hay calificacionesClase 17 - Intro Django + Proyecto Final21 páginas
- Tutorial - Desarrollando Una Aplicación Web Con Python y DjangoAún no hay calificacionesTutorial - Desarrollando Una Aplicación Web Con Python y Django53 páginas
- JAVA. Interfaces gráficas y aplicaciones para Internet (4ª Edición)De EverandJAVA. Interfaces gráficas y aplicaciones para Internet (4ª Edición)Aún no hay calificaciones
- Programa - Django - 2022 (Para Alumnos)Aún no hay calificacionesPrograma - Django - 2022 (Para Alumnos)3 páginas
- 01 - Instalación y Configuración de DjangoAún no hay calificaciones01 - Instalación y Configuración de Django5 páginas
- Clase 17 - Django - Portfolio (Parte 1)Aún no hay calificacionesClase 17 - Django - Portfolio (Parte 1)54 páginas
- Modelo de Informe Practica N 09 - 2022Aún no hay calificacionesModelo de Informe Practica N 09 - 202212 páginas
- Clase 2 - Introducción A Django - CompressedAún no hay calificacionesClase 2 - Introducción A Django - Compressed22 páginas
