Levantando un error 404¶

Hasta ahora, si no encontrábamos una clave, saltaba una excepción DoesNotExist. Pero al responder con un objeto HttpResponse, la respueta HTTP que enviábamos de vuelta era un 200 OK. Vamos a cambiarlo para que sea un 404:

from django.http import HttpResponse, Http404

from .models import Contenido

def get_content(request, llave):
    try:
        respuesta = Contenido.objects.get(clave=llave).valor  
    except Contenido.DoesNotExist:
        raise Http404("No existe la clave " + llave)
    return HttpResponse(respuesta)

El nuevo concepto aquí: La vista levanta la excepción Http404 si no existe el contenido con la clave solicitada.

Es una práctica muy común utilizar get() y levantar la excepción Http404 si no existe el objeto. Por eso, Django proporciona un atajo. Aquí está la vista get_content(), reescrita:

from django.shortcuts import get_object_or_404
from django.http import HttpResponse

from .models import Contenido

def get_content(request, llave):
    contenido = get_object_or_404(Contenido, clave=llave)
    return HttpResponse(contenido.valor)

La función get_object_or_404() toma un modelo Django como su primer argumento y un número arbitrario de argumentos de palabra clave que pasa a la función get() del administrador del modelo. Levanta la excepción Http404 si no existe el objeto.

También hay una función get_list_or_404() , que funciona igual que get_object_or_404() - excepto usando filter() en lugar de get(). La misma levanta la excepción Http404 si la lista está vacía.

Añadiendo contenidos con POST¶

La semana pasada vimos cómo hacer para enviar nuevos contenidos a cms con el método PUT. Si lo queremos hacer con POST, tendremos que crear un formulario con HTML. Lo que vamos a hacer es que dado un recurso (exista éste o no), vamos a mostrar el formulario para introducir el valor. Nota que si ya existe ese recurso, no creará una nueva entrada en la base de datos, sino que alterará la ya existente.

La vista en el fichero cms/views.py quedaría de la siguiente manera:

from django.http import HttpResponse
from django.shortcuts import get_object_or_404
from django.views.decorators.csrf import csrf_exempt

from .models import Contenido, Comentario

formulario_contenido = """
<br>
<form action="" method="POST">
  Introduce el (nuevo) contenido para esta página: 
  <input type="text" name="valor">
  <input type="submit" value="Enviar">
</form>
"""

@csrf_exempt
def get_content(request, llave):
    if request.method == "PUT":
        valor = request.body.decode('utf-8')           
    elif request.method == "POST":
        valor = request.POST['valor']             
    if request.method in ["PUT", "POST"]:
        try:
            c = Contenido.objects.get(clave=llave)
            c.valor = valor
        except Contenido.DoesNotExist:
            c = Contenido(clave=llave, valor=valor)
        c.save()

    contenido = get_object_or_404(Contenido, clave=llave)
    return HttpResponse(contenido.valor + formulario_contenido)

En el caso de recibir un POST, el valor se encontrará tambień en el cuerpo de la petición. Sin embargo, el cuerpo de la petición tendrá esta pinta: campo1=valor_introducido1&campo2=valor_introducido2. Por eso, llamamos a request.POST, que nos devuelve los valores de POST como si fuera un diccionario.

A continuación, miramos si ya existe un contenido con esa llave. Si existe, tomamos ese objeto y cambiamos su valor. Si no existe, saltará una excepción Contenido.DoesNotExist, por lo que procederemos a crear el objeto. En ambos casos, al final guardamos el cambio en la base de datos con c.save().

Otro cambio con respecto a la versión anterior es que hemos creado una nueva variable formulario, que es un string multilínea que contiene un formulario HTML. Este formulario lo añadimos a toda repuesta que enviamos con HttpResponse (es por ello por lo que añadimos una marca de salto de línea, <br&gr;, para que no salga todo apelotonado en la página web).

Añadiendo comentarios¶

Hemos añadido comentarios a algún contenido, pero todavía no mostramos ningún comentario en las vistas, ni podemos añadirlos vía web. El siguiente extracto de código muestra cómo habría que cambiar la vista para hacerlo.

from django.http import HttpResponse
from django.shortcuts import get_object_or_404
from django.views.decorators.csrf import csrf_exempt
from django.utils import timezone

from .models import Contenido, Comentario

formulario_contenido = """
<br>
<form action="" method="POST">
  Introduce el (nuevo) contenido para esta página: 
  <input type="text" name="valor">
  <input type="submit" name="action" value="Enviar Contenido">
</form>
"""

formulario_comentario = """
<br>
<form action="" method="POST">
  Introduce un nuevo comentario para esta página: 
  <br>Título: <input type="text" name="titulo">
  <br>Cuerpo: <input type="text" name="cuerpo">
  <input type="submit" name="action" value="Enviar Comentario">
</form>
"""

@csrf_exempt
def get_content(request, llave):
    if request.method == "PUT":
        valor = request.body.decode('utf-8')           
    elif request.method == "POST":
        action = request.POST['action']
        if action == "Enviar Contenido":
            valor = request.POST['valor']
    if request.method == "PUT" or (request.method == "POST" and action == "Enviar Contenido"):
        try:
            c = Contenido.objects.get(clave=llave)
            c.valor = valor
        except Contenido.DoesNotExist:
            c = Contenido(clave=llave, valor=valor)
        c.save()
    if request.method == "POST" and action == "Enviar Comentario":
            c = Contenido.objects.get(clave=llave)    
            titulo = request.POST['titulo']
            cuerpo = request.POST['cuerpo']
            q = Comentario(contenido=c, titulo=titulo, cuerpo=cuerpo, fecha=timezone.now())
            q.save()

    contenido = get_object_or_404(Contenido, clave=llave)
    comentarios = contenido.comentario_set.all()
    respuesta = contenido.valor
    for comentario in comentarios:
        respuesta += "<p><b>Título</b>: " + comentario.titulo + "<br><b>Cuerpo</b>: " + comentario.cuerpo + "<br><b>Enviado</b>: " + comentario.fecha.strftime('%Y-%m-%d %H:%M:%S') + "</p>"
    respuesta += formulario_comentario
    return HttpResponse(respuesta + formulario_contenido)

En primer lugar, notemos que hay un import del módulo timezone. Este módulo nos proporciona funcionalidad de fechas -- y vamos a necesitarlo al introducir la fecha en la que se ha enviado un comentario.

Además, hemos añadido un nuevo formulario para introducir comentarios. Como ahora la página web tendrá dos formularios (el que teníamos antes para contenidos y el nuevo de comentarios), tenemos que añadir un atributo name al botón de submit. Este atributo nos permitirá tomar el valor del botón que se ha pulsado (que puede ser "Enviar contenido" o "Enviar comentario").

En get_content(), tomamos primero los valores enviados por el formulario. Para eso debemos tener en cuenta si la petición ha sido PUT (sólo se envía el valor en el cuerpo) o POST (tenemos que tener en cuenta el action y el cuerpo).

Si se trata de un contenido, tendremos que comprobar si ya existe en la base de datos para evitar duplicados. Si se trata de un comentario, tendremos que crear un objeto Comentario nuevo. Necesitamos pasar como parámetros el objeto Contenido al que se refiere el comentario, el título y el cuerpo del comentario a partir del formulario HTML y la fecha utilizando el método now() del módulo timezone.

Finalmente, mostramos el resultado. Para ello, obtenemos primero el contenido (con get_object_or_404(Contenido, clave=llave)) y luego sus comentarios. El contenido puede no tener comentarios, tener uno o tener varios. Es por eso que haremos contenido.comentario_set.all() sobre el objeto contenido al que corresponden. Esto nos devolverá una lista, por la que iteraremos, utilizando el string respuesta para ir añadiendo los comentarios.

Especialmente en la línea correspondiente a la concatenación de respuestas dentro del bucle for es fea. Esto es así, porque estamos mezclando código Python y lenguaje HTML. Nótese que se trata de dos concepctos diferentes: el código Python es la lógica del negocio, mientras que el HTML es como se muestra. Si quisiéramos modificar cómo se ve la página en el navegador, tendríamos que tocar el código. En este caso, todavía es poco (así de feas son nuestras páginas por ahora), pero tendremos más y más. Es por eso que vamos a ver un mecanismo para separar el código de la presentación. Vamos a ver las plantillas.

Introduciendo las plantillas¶

Como decíamos, vamos a usar el sistema de plantillas de Django para separar el diseño de Python mediante la creación de una plantilla que la vista pueda utilizar.

Primero, crea un directorio llamado templates en tu directorio cms. Django buscará las plantillas allí.

La configuración de TEMPLATES de tu proyecto describe cómo Django cargará y creará las plantillas. El archivo de configuración predeterminada configura un backend DjangoTemplates cuya opción APP_DIRS está configurada como True. Convencionalmente, DjangoTemplates busca un subdirectorio «templates» en cada una de las INSTALLED_APPS.

Dentro del directorio templates que acabmos de crear, crea otro directorio llamado cms, y dentro de este último crea un fichero llamado index.html; en otras palabras, tu plantilla debería estar en cms/templates/cms/index.html. Por cómo funciona el cargador de plantillas (conocido como app_directories), esta plantilla será referida dentro de Django como cms/index.html.

Introduce el siguiente código en esa plantilla:

{% if content_list %}
    <ul>
    {% for content in content_list %}
        <li><a href="/cms/{{ content.clave }}">{{ content.clave }}</a></li>
    {% endfor %}
    </ul>
{% else %}
    <p>No contents are available.</p>
{% endif %}

Ahora vamos a crear una nueva vista index en cms/views.py para usar la plantilla. Esta vista lo que hará es mostrar cinco contenidos:

from django.http import HttpResponse
[...]
from django.template import loader

from .models import Contenido

[...]

def index(request):
    content_list = Contenido.objects.all()[:5]
    template = loader.get_template('cms/index.html')
    context = {
        'content_list': content_list,
    }
    return HttpResponse(template.render(context, request))

Ese código carga la plantilla llamada cms/index.html y le pasa un contexto. El contexto es un diccionario que relaciona los nombres de variables de plantillas con objetos Python.

Finalmente, añadiremos en cms/urls.py la siguiente regla:

from django.urls import path

from . import views

urlpatterns = [
    path('', views.index),
    path('<str:llave>', views.get_content),
]

Lanza el servidor y carga la página señalando tu navegador en «/cms/», y usted debería ver una lista con los contenidos que hemos almacenado en la base de datos. Cada contenido es un enlace que apunta a la página que nos mostrará el valor.

from django.shortcuts import render

from .models import Contenido

def index(request):
    content_list = Contenido.objects.all()[:5]
    context = {'content_list': content_list}
    return render(request, 'cms/index.html', context)

El sistema de plantillas¶

Vuelve a la vista get_content() para nuestra aplicación cms. Teniendo en cuenta la variable de contexto contenido, así es como la plantilla cms/content.html podría verse:

<h1>{{ contenido.valor }}</h1>
{% for comentario in contenido.comentario_set.all %}
    <hr>
    <h1>{{ comentario.titulo }}</h1><br>
        {{ comentario.cuerpo }}<br>
        Enviado el {{ comentario.fecha }}<br>
{% endfor %}

<hr>
<br>
<form action="" method="POST">
  Introduce el (nuevo) contenido para esta página: 
  <input type="text" name="valor">
  <input type="submit" name="action" value="Enviar Contenido">
</form>

<br>
<form action="" method="POST">
  Introduce un nuevo comentario para esta página: 
  <br>Título: <input type="text" name="titulo">
  <br>Cuerpo: <input type="text" name="cuerpo">
  <input type="submit" name="action" value="Enviar Comentario">
</form>

El sistema de plantillas utiliza la sintaxis de búsqueda con puntos para acceder a los atributos de variables. En el ejemplo de {{contenido.valor}}, Django primero realiza una consulta en el diccionario sobre el objeto contenido. Si esto falla, intenta una búsqueda de atributos que en este caso funciona. Si la búsqueda de atributos hubiera fallado, hubiera intentado una búsqueda de índice de lista.

El llamado del método ocurre en el bucle {% for%}: contenido.comentario_set.all se interpreta como el código Python contenido.comentario_set.all() que retorna un iterable de objetos Comentario y es adecuado para usarse en la etiqueta {% for%}.

Consulta la guía de plantillas para más información sobre las plantillas.