«Cosmic Data»: validación de datos con Pydantic. Tres ejercicios ambientados en un observatorio espacial que van del modelo básico con restricciones por campo a las reglas de negocio y los modelos anidados. Rank 02. Proyecto aún no hecho: aquí se explica qué pide y qué enseña, sin solución.
mypy las lee, antes de tiempo. Eso basta para tu propio código, pero no para
los datos que entran desde fuera — un JSON de una API, un CSV, un formulario —, que
pueden traer cualquier cosa. Pydantic (Samuel Colvin, 2017) le da la
vuelta a la idea: usa esas mismas anotaciones en tiempo de ejecución para
comprobar y convertir los datos al crear el objeto. Declaras una clase que hereda de
BaseModel, anotas sus campos, y Pydantic se encarga de rechazar lo que no
encaja con un mensaje de error detallado o de convertir lo compatible (la cadena
"2024-03-15T10:00:00" se convierte en un datetime). Es la base de
FastAPI y de buena parte del Python moderno que habla con el exterior. La versión 2
(2023) reescribió el núcleo en Rust (pydantic-core) y cambió la API: el
enunciado exige Pydantic 2.x y avisa de que no se usen los decoradores antiguos de la v1
como @validator. Y por primera vez en el cursus hay que instalar una
librería externa, con pip y dentro de un entorno virtual.Tres directorios, ex0/, ex1/ y ex2/, con un
fichero cada uno. Las reglas generales:
mypy, y cumple flake8.pip. Es obligatorio
trabajar en un entorno virtual (se recomiendan venv, virtualenv
o conda).json, csv o
datetime. El «Authorized: None» de cada ejercicio significa que no se añade
nada más.El enunciado trae como adjunto un generador de datos de prueba
(data_generator.py), un exportador a JSON, CSV y Python
(data_exporter.py) y datos ya generados, que se pueden importar para probar
los modelos. Resume además los tres conceptos clave: BaseModel (la clase base
de todo modelo), Field(...) (restricciones, descripción y valor por defecto
de un campo) y @model_validator(mode='after') (validación propia que corre
después de la de Pydantic).
Para hacerse una idea de la sintaxis, que no del ejercicio, así se declara un campo con restricciones y así se monta el entorno:
class Planet(BaseModel):
name: str = Field(min_length=1, max_length=30)
moons: int = Field(ge=0)
$> python3 -m venv .venv
$> source .venv/bin/activate
$> pip install "pydantic>=2"
Un modelo SpaceStation con ocho campos validados:
station_id: cadena de 3 a 10 caracteres.name: cadena de 1 a 50 caracteres.crew_size: entero de 1 a 20 personas.power_level y oxygen_level: flotantes de 0.0 a 100.0
(porcentaje).last_maintenance: fecha y hora (datetime).is_operational: booleano, True por defecto.notes: cadena opcional de 200 caracteres como máximo.Más una función main() que crea una estación válida y muestra sus datos,
intenta crear una inválida (por ejemplo con crew_size mayor que 20) y enseña
el mensaje de error de validación. La salida de ejemplo termina con
Input should be less than or equal to 20, el mensaje que genera el propio
Pydantic.
BaseModel, anotar cada campo con su tipo y añadirle límites con
Field (longitudes para cadenas, mínimos y máximos para números), valores por
defecto y campos opcionales. Y el otro lado: qué pasa cuando los datos no encajan.
Pydantic no devuelve None ni un código de error como haría una función de C,
sino que lanza una excepción, ValidationError, que reúne todos los
fallos encontrados, no solo el primero. El enunciado pide pensar en la conversión
automática: qué ocurre si a un campo datetime le pasas una cadena con una
fecha.Primero un enum ContactType con cuatro valores: radio,
visual, physical y telepathic. Luego el modelo
AlienContact:
contact_id: cadena de 5 a 15 caracteres.timestamp: fecha y hora del contacto.location: cadena de 3 a 100 caracteres.contact_type: un ContactType.signal_strength: flotante de 0.0 a 10.0.duration_minutes: entero de 1 a 1440 (24 horas como máximo).witness_count: entero de 1 a 100.message_received: cadena opcional de 500 caracteres como máximo.is_verified: booleano, False por defecto.Y, con @model_validator(mode='after'), cuatro reglas de negocio: el
contact_id empieza por "AC"; un contacto físico tiene que estar
verificado; uno telepático necesita al menos 3 testigos; y una señal fuerte (más de 7.0)
debería traer un mensaje recibido. La demostración muestra un informe válido y otros
inválidos con mensajes claros; el ejemplo termina con
Telepathic contact requires at least 3 witnesses.
Field solo ve un valor cada vez: sabe si
witness_count está entre 1 y 100, pero no puede saber que el mínimo depende
de contact_type. Para eso está el validador de modelo en modo
'after', que se ejecuta cuando todos los campos ya han pasado su validación
y tienen su tipo final, de modo que puede compararlos entre sí. Si una regla no se cumple,
se lanza una excepción y Pydantic la envuelve en su ValidationError. El
enunciado recuerda el detalle que más se olvida: el validador debe terminar devolviendo
self. De paso aparece Enum, de la biblioteca estándar: un
conjunto cerrado de valores con nombre, que Pydantic sabe validar (rechaza
"smoke_signal" si no está entre los cuatro).Un enum Rank (cadet, officer,
lieutenant, captain, commander) y dos modelos, uno
dentro del otro.
CrewMember: member_id (3–10 caracteres), name
(2–50), rank (un Rank), age (18–80),
specialization (3–30 caracteres), years_experience (0–50) e
is_active (True por defecto).
SpaceMission: mission_id (5–15 caracteres),
mission_name (3–100), destination (3–50),
launch_date (datetime), duration_days (1–3650, diez
años como máximo), crew (lista de 1 a 12 CrewMember),
mission_status (cadena, "planned" por defecto) y
budget_millions (flotante de 1.0 a 10000.0).
Reglas de seguridad con @model_validator(mode='after'): el
mission_id empieza por "M"; hay al menos un comandante o un
capitán; las misiones largas (más de 365 días) necesitan que el 50 % de la tripulación
sea experimentada (5 años o más); y todos los tripulantes están activos. La demostración
enseña una misión válida con su tripulación y una inválida; el ejemplo falla con
Mission must have at least one Commander or Captain.
CrewMember (se le pueden pasar
diccionarios y los convierte) y la lista en sí tiene sus propios límites de longitud. El
enunciado plantea la pregunta clave: qué pasa cuando un CrewMember falla
dentro de una SpaceMission — el error indica la ruta exacta del fallo (qué
campo, qué posición de la lista, qué subcampo). Las reglas del validador de misión ya no
miran solo campos sueltos, sino que recorren la tripulación para contar rangos,
experiencia o estado.@validator, @root_validator, class
Config, .dict()). El enunciado pide la sintaxis de la v2 y lo
señala de forma explícita.self. En modo 'after' el validador recibe
el modelo ya construido y debe devolverlo; si no lo haces, el resultado no es el
esperado.ValidationError. Lo que lanzas en el
validador llega envuelto. Pydantic antepone su propio prefijo al texto
(Value error, …), y su método errors() devuelve la lista de
fallos con su ubicación y su mensaje: vale la pena mirarlo para mostrar un mensaje
limpio como el del ejemplo."6" se acepta en un campo int y una cadena ISO en
un datetime. Hay que saber explicar cuándo convierte y cuándo
rechaza.radio o commander, el valor.str | None sin valor por defecto sigue siendo obligatorio al crear el
objeto.mypy, también los
validadores y la función main().Enunciado «Cosmic Data — Discover Pydantic Models & Validation», versión 3.0, en
packs/cursus/M2/211_Python_Module_09/ (en.subject.pdf y su
extracción subject.txt). Las herramientas de datos adjuntas están en
extra/data_generator.tar.