Crear una aplicación web en 30 minutos

1. Aislar el entorno

Para esta parte vamos a utilizar el trabajo realizado en el capítulo anterior.

Para entrar en el entorno de trabajo, solo tiene que situarse en el directorio del proyecto y ejecutar los comandos:

$ docker compose up -d 
$ docker compose run project_main bash 

Así abrirá un terminal en el entorno de trabajo.

Hay que destacar que Pyramid hace algunas elecciones importantes, como la que consiste en usar cookie cutter para generar el código inicial del proyecto; lo veremos inmediatamente después.

La plantilla de código usa un método antiguo para empaquetar la aplicación, se basa en un archivo setup.py.

Le invito a seguir los distintos tutoriales de Pyramid para profundizar en este aspecto, en particular porque este tutorial evita repetir y presentar aspectos que ya aparecen en los tutoriales y ofrece complementos mostrando técnicas que no están incluidas en ellos.

A pesar de eso, por nuestra parte, vamos a hacer empaquetado usando poetry y, por lo tanto, el archivo pyproject.toml ya iniciado en el capítulo anterior, pero igualmente vamos a usar la misma base de código que el tutorial oficial de Pyramid, utilizado el mismo cookie cutter de plantillas.

2. Creación del proyecto

La primera etapa consiste en instalar Pyramid con poetry si no lo ha hecho antes:

$ poetry add pyramid  

Si funciona correctamente, el siguiente comando debería funcionar:

$ pserve -help 

pserve es el servidor web Python que permite ejecutar la aplicación con el objetivo de desarrollarla, ofreciendo herramientas para el desarrollo (no sirve para poner la aplicación en producción, pues ese es el rol de apache2+wsgi).

Tan solo queda crear el proyecto:

$ poetry add cookiecutter 
$ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout 2.0-branch 

Este último comando es estrictamente idéntico al del tutorial oficial, lo que permite generar un código idéntico al que habría obtenido usando el método presentado en el tutorial.

3. Configuración

Una vez creado el proyecto, hay que ubicarse en la carpeta que lo contiene:

$ cd project/ 

La primera etapa consiste en abrir el archivo setup.py y personalizarlo (esta función no es útil en nuestro caso, pero permite garantizar la compatibilidad con el método clásico):

$ vi setup.py 

He aquí los campos que es preciso modificar, entre otros:

Los últimos puntos deben modificarse cuando se conocen bien los componentes y se quieren aportar los cambios.

Para los install_requires, podremos considerar la posibilidad de añadir el conector a la base de datos elegida (si no se ha hecho en el capítulo anterior) y habrá que especificar...

1. Modelos

Esta sección es particular, pues este modelo sirve también como base a los proyectos detallados en los siguientes capítulos. Vamos a escribir el modelo en un archivo project.py situado en la carpeta project/models.

Contiene:

# -*- coding: utf-8 -*- 
 
from datetime import datetime  
 
from sqlalchemy import ( 
    Column, 
    ForeignKey, 
    Index, 
    Integer,     UnicodeText, 
    Unicode, 
    DateTime, 
    ) 
 
 
from .meta_import_base 
 
__all__ = ['Subject', 'Contact']  
  class Subject(Base): 
    __tablename__ = 'subjects' 
    id = Column(Integer, primary_key=True) 
    name = Column(Unicode(255), unique=True) 
 
Index('subject_name_index', Subject.name, unique=True, 
mysql_length=255) 
 
class Contact(Base): 
    __tablename__ = 'contacts' 
    id = Column(Integer, primary_key=True) 
    email = Column(Unicode(255), nullable=False) 
    subject_id = Column(Integer, ForeignKey(Subject.id)) 
    text = Column(UnicodeText, nullable=False) 
    created = Column(DateTime, default=datetime.now) 
 
Index('contact_email_index', Contact.email, mysql_length=255) 

Conocer SQLAlchemy es un requisito previo que se explica en el capítulo Manipulación de datos.

Este ejemplo muestra cómo hacer que un campo sea obligatorio o único, cómo colocar índices, claves primarias y claves foráneas o valores por defecto, como la fecha en curso.

Una vez escritos los modelos, hay que gestionar las migraciones. En efecto, en producción, es necesario mantener la base de datos. Cada vez que se hacen modificaciones, hay que generar un script que permita pasar de una estructura dada a la nueva. Son las migraciones.

Existe una herramienta que nos permite gestionarlas automáticamente. Cada vez que modifique los modelos, podrá escribir:

$ alembic -c development.ini revision --autogenerate -m "Add new models" 

La palabra importante es revision. El comentario permite describir el cambio que se ha producido en los modelos desde la última versión.

Para aplicar esta migración, es decir, hacer que la base de datos sea conforme con los modelos descritos en el código, hay que aplicar el siguiente comando:

$alembic -c development.ini upgrade head 

Ahora podemos utilizar nuestros modelos y una sesión para modificar datos en la base de datos. Vamos a empezar inmediatamente modificando el script de inicialización de datos que se encuentra en contact/scripts/initializedb.py de la siguiente manera:

import argparse 
import sys 
import transaction 
 
from pyramid.paster import bootstrap, setup_logging, 
from sqlalchemy.exc import OperationalError 
 
from ..models import MyModel, Subject, Contact, 
from ..models.meta import   Base, 
 
 
def setup_models(dbsession)  : 
    """ 
    Add or update models / fixtures in the database. 
 
    """ 
    model = MyModel(name='one', value=1) 
    dbsession.add(model) 
 
        for subject_name in ('Python', 'Pyramid', 'Pygame'): 
            model = Subject(name=subject_name) 
            dbsession.add(model) ...