Integración del ORM de Python tortoise con FastAPI

Eduardo Zepeda

21 de septiembre de 2021

Traducciones:

- en: Python tortoise ORM integration with FastAPI

⏲ Tiempo de lectura 7 minutos

Fastapi

Una de las cosas que más me gustan de Django es su ORM; una de las razones por las que este framework es tan popular . Por otro lado FastAPI no cuenta con un ORM y se centra únicamente en servir endpoints, mostrándose agnóstico sobre la base de datos. Hay bastantes opciones de ORM para python: django-alchemy, peewee, ponyORM, tortoise. Este último, además de ser asíncrono, está inspirado en el ORM de django, por lo que su sintaxis es bastante similar, incluso muchas funciones de tortoise comparten nombre con su contraparte de Django, por lo que los usuarios que usan el ORM de Django van a ahorrarse mucho tiempo aprendiendo las funciones de tortoise.

Para este tutorial voy a usar fastAPI y tortoise-orm juntos por lo que asegúrate de saber al menos lo básico del framework fastAPI y lo básico de base de datos.

Compatibilidad de tortoise

Tortoise es compatible con las siguientes bases de datos.

PostgreSQL >= 9.4 (usando asyncpg)
SQLite (usando aiosqlite)
MySQL/MariaDB (using aiomysql o asyncmy)

Pero para este ejemplo voy a usar SQLite, por que no necesita configuración de ningún tipo.

Instalación del ORM de Python tortoise

Para instalar tortoise-orm basta con usar el administrador de entornos virtuales que prefieras, yo usaré pipenv.

pip install tortoise-orm

Instalaré también fastAPI y otras utilidades que necesitaremos

pip install python-multipart fastapi uvicorn pydantic

Crear modelos con tortoise

Vamos a crear un directorio llamado app y un archivo de modelos llamado models.py

# app/models.py
from tortoise.models import Model
from tortoise import fields


class Job(Model):
    # El campo de la llave primaria se crea automáticamente
    # id = fields.IntField(pk=True) 
    name = fields.CharField(max_length=255)
    description = fields.TextField()

    def __str__(self):
        return self.name

Si te fijas la sintaxis es bastante similar a los campos de Django, incluso algunos parámetros son iguales.

Para empezar a trabajar con el ORM de tortoise necesitamos:

Conectarnos a la base de datos
Crear la(s) tabla(s) necesaria(s)

Conectarse a la base de datos con tortoise

Vamos a crear una función para conectarnos a la base de datos en un directorio llamado database:

# database/connectToDatabase.py
from tortoise import Tortoise

async def connectToDatabase():
    await Tortoise.init(
        db_url='sqlite://db.sqlite3',
        modules={'models': ['app.models']}
    )

Generando esquemas con tortoise

Ahora creemos una función para generar los modelos en la raíz de nuestra aplicación.

# createSchema.py
from tortoise import Tortoise, run_async
from database.connectToDatabase import connectToDatabase

async def main():
    await connectToDatabase()
    await Tortoise.generate_schemas()

if __name__ == '__main__':
    run_async(main())

Observa como importamos la función para conectarnos que acabamos de crear y posteriormente llamamos al método generate_schemas() , que se encargará de leer nuestros modelos y hacer los cambios en la base de datos.

Otro aspecto que debes apreciar es que corremos la función principal dentro de la función run_async(), que nos provee tortoise. Esto es necesario para que nuestras funciones await se ejecuten, de otra forma solo se crearía un objeto corroutine.

¿Por qué colocamos este método en un archivo externo? Porque generate_schemas() solo requiere usarse una vez; cuando se crean las tablas. No debemos incluirlo en el archivo que se correrá cuando se ejecute fastAPI.

Sabiendo eso, ejecutémoslo para crear nuestras tablas.

python3 createSchema.py

Si todo salió bien ya tendremos las tablas creadas en nuestra base de datos SQLite.

Integración de tortoise con fastAPI

Partiremos de una aplicación sencilla de fastAPI.

Para conectar fastAPI con tortoise, esta última nos da una función llamada register_tortosise(). Que recibe la instancia que creamos con fastAPI, la dirección a la base de datos y la ubicación de nuestros modelos.

# main.py
from fastapi import FastAPI
from database.connectToDatabase import connectToDatabase

app = FastAPI()
await connectToDatabase()

@app.get("/")
async def read_root():
    return {"Hello": "World"}

register_tortoise(
    app,
    db_url="sqlite://db.sqlite3",
    modules={"models": ["app.models"]},
    generate_schemas=True,
    add_exception_handlers=True,
)

Crear un objeto con tortoise

Para crear un objeto podemos optar por llamar al método create() del modelo, dentro de una función decorada con el método post() de nuestra instancia, o también crear una instancia y posteriormente llamar a su método save().

# main.py
from fastapi import FastAPI
from tortoise.contrib.fastapi import HTTPNotFoundError, register_tortoise

app = FastAPI()

@app.get("/")
async def read_root():
    return {"Hello": "World"}

@app.post("/job/create/", status_code=201)
async def create_job(name=Form(...), description=Form(...)):
    job = await Job.create(name=name, description=description)
    return {"status":"ok"}
# ...

Si ahora hacemos una petición web usando la interfaz de documentación que crea fastAPI, en /docs/, veremos que seremos capaces de crear un objeto Job usando un nombre y una descripción.

Serializar objetos con pydantic y tortoise

Hemos creado el objeto, pero, ¿y si queremos devolver el objeto después de crearlo? Dado que es una instancia de un modelo, no podemos devolverlo nada más así. Necesitamos un tipo de datos apto para una respuesta HTTP.

Pydantic nos permite serializar objetos de la base de datos para poder devolverlos como respuesta JSON o lo que querramos.

Hay que importar la función pydantic_model_creator y pasarle como parámetro nuestro modelo.

# main.py
from fastapi import FastAPI
from app.models import Job
from tortoise.contrib.fastapi import HTTPNotFoundError, register_tortoise
from tortoise.contrib.pydantic import pydantic_model_creator

app = FastAPI()

job_pydantic = pydantic_model_creator(Job)

@app.get("/")
async def read_root():
    return {"Hello": "World"}

@app.post("/job/create/", status_code=201)
async def create_job(name=Form(...), description=Form(...)):
    job = await Job.create(name=name, description=description)
    return await job_pydantic.from_tortoise_orm(job)

register_tortoise(
    app,
    db_url="sqlite://db.sqlite3",
    modules={"models": ["app.models"]},
    add_exception_handlers=True,
)

Y para obtener nuestro objeto en JSON llamamos al método al método from_tortoise_orm() del objeto que acabamos de crear.

Recuerda anteponer la palabra await o lo que retornarás es una corroutine.

Obtener una lista objetos de un queryset

Usaremos el método get() de nuestra instancia de fastAPI.

Para obtener una lista de objetos usamos el método all() y, serializamos el resultado con from_queryset().

# main.py

# ...

@app.get("/jobs/")
async def get_jobs():
    return await job_pydantic.from_queryset(Job.all())

Actualizar un objeto con tortoise

Ahora creamos un endpoint que reciba un id y esté decorada con el método put(). Le pasamos como response_model el objeto job_pydantic, para que valide la entrada de los datos, los incluya en la documentación y limite la respuesta a los campos modificables .

Ademas vamos a crear un segundo objeto job_pydantic, es decir otro serializador, que excluya los campos de solo lectura (nuestra llave primaria), para devolverlos sin id.

Y, para actualizar un objeto, usamos el método put de fastAPI y recibimos la id del objeto a editar. A continuación filtramos aquellos objetos que coinciden con la id con Job.filter() y luego llamamos a su método update(). Dado que el id es único, ya que es llave primaria, solo se editará el objeto cuya id corresponda con el dato que enviamos.

# main.py

job_pydantic = pydantic_model_creator(Job)
job_pydantic_no_ids = pydantic_model_creator(Job, exclude_readonly=True)
# ...

@app.put("/job/{job_id}", response_model=job_pydantic, responses={404: {"model": HTTPNotFoundError}})
async def update_job(job_id: int, job: job_pydantic):
    await Job.filter(id=job_id).update(**job.dict())
    return await job_pydantic_no_ids.from_queryset_single(Job.get(id=job_id))

Obtener un objeto con tortoise

Ahora podemos aplicar el mismo método de la sección pasada. Esta vez necesitaremos un id y el método get() de fastAPI. Le pasamos el response_model para que se encargue de la validación y definimos que el único parámetro que usaremos será la id, con la cual usaremos el método from_queryset_single() sobre el resultado de la query del ORM: Job.ge_t(id=job_id)_.

# main.py

# ...

@app.get("/job/{job_id}", response_model=job_pydantic, responses={404: {"model": HTTPNotFoundError}})
async def get_job(job_id: int):
    return await job_pydantic_no_ids.from_queryset_single(Job.get(id=job_id))

Eliminar un objeto con tortoise

Para eliminar un objeto también vamos a necesitar un id y llamar al método delete() de fastAPI, por lo que la función quedaría de la siguiente manera:

# main.py
class Status(BaseModel):
    message: str
# ...

@app.delete("/job/{job_id}", response_model=Status, responses={404: {"model": HTTPNotFoundError}})
async def delete_job(job_id: int):
    deleted_job = await Job.filter(id=job_id).delete()
    if not deleted_job:
        raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
    return Status(message=f"Deleted job {job_id}")

Filtramos por el id que obtenemos en la url y, si encontramos el objeto, lo borramos, en caso de que no exista el id de ese objeto devolveremos un error 404 por medio de una excepción. En caso de que sí, ya no vamos a devolver el objeto, sino que bastará con que devolvamos un mensaje avisando que el id fue borrado.

Y con eso podemos realizar las operaciones básicas de CRUD en fastAPI usando tortoise como ORM. En esta entrada no he tratado las llaves foráneas, ni los campos de llave foránea, ni los many to many, ni otro tipo de relaciones entre modelos. Probablemente haga una entrada en un futuro sobre eso, mientras tanto puedes leerte la documentación oficial de tortoise.