Serialización
model_dump, esquema JSON y serializadores personalizados.
Receta
Tarjeta de receta de referencia rápida, lista para copiar y pegar.
data = model.model_dump(exclude_none=True, by_alias=True)Cuándo usar esto:
- Respuestas de API
- Cargas útiles de eventos
- Capas de caché
Ejemplo de trabajo
from pydantic import BaseModel, field_serializer
class Event(BaseModel):
ts: datetime
@field_serializer("ts")
def ser_ts(self, v: datetime) -> str:
return v.isoformat()Lo que esto demuestra:
exclude_noneby_aliasfield_serializer
Análisis Profundo
Cómo funciona
- La serialización está separada de la validación.
- Los serializadores personalizados controlan los tipos de salida.
model_dump_jsonpara bytes JSON UTF-8.
Errores comunes
- Validación de límites omitida: Datos inválidos llegan a las capas de persistencia. Solución: Valida con Pydantic o formularios del framework en el borde.
- Fugas de trazas de pila: Los clientes ven errores internos. Solución: Mapea excepciones a respuestas HTTP estables.
- Bloqueo de bucles de eventos asíncronos: Los trabajadores se detienen bajo carga concurrente. Solución: Usa drivers asíncronos o wrappers de pool de hilos.
- Secretos en control de código fuente: Credenciales filtradas a través del historial de git. Solución: Carga secretos desde el entorno o una bóveda en tiempo de ejecución.
- Falta de observabilidad: Los incidentes son difíciles de depurar. Solución: Agrega logs estructurados, métricas e IDs de solicitud.
Alternativas
| Alternativa | Usar cuándo | No usar cuándo |
|---|---|---|
| Marco alternativo en este cookbook | Estándar del equipo o monolito existente | API nueva con diferentes restricciones |
| BaaS administrado | MVP solo CRUD | Autenticación personalizada, flujos de trabajo o necesidades de cumplimiento |
| gRPC | RPC interno de alto rendimiento | Clientes HTTP públicos y acceso al navegador |
Preguntas frecuentes
¿Cuándo debería adoptar la serialización de Pydantic?
Úsalo cuando los patrones y las compensaciones de esta página coincidan con tu API o límite de datos.
¿Cuál es el principal error de producción con la serialización de Pydantic?
Omitir la validación, los tiempos de espera o los contratos de error explícitos en el borde HTTP.
¿Cómo pruebo la serialización de Pydantic?
Usa el cliente de prueba del framework, anula las dependencias y afirma el estado más la forma JSON.
¿La serialización de Pydantic funciona con Python 3.14?
Sí, los ejemplos se dirigen a Python 3.14 con versiones de framework fijadas del pie de página de la pila.
¿Cómo se relaciona la serialización de Pydantic con Pydantic 2?
Valida y serializa en los límites; mantén los servicios funcionando con objetos de dominio tipados.
¿Sincronizado o asíncrono?
Prefiere rutas asíncronas cuando la E/S domina; mantén el trabajo de CPU pequeño o descárgalo a los trabajadores.
¿Dónde debe residir la lógica de negocio?
Controladores delgados; los servicios poseen las reglas; los repositorios poseen las consultas.
¿Cómo documento las API?
Publica documentación OpenAPI o de esquema que coincida con los modelos de respuesta en el código.
¿Cómo manejo el versionado?
Versionado explícito de URL o encabezado con ventanas de deprecación; evita roturas silenciosas.
¿Qué debo leer a continuación?
Sigue los enlaces Relacionados para obtener la siguiente capa de profundidad en esta sección.
¿Cómo me mantengo seguro?
Autentica a los llamadores, autoriza por recurso, limita la tasa y nunca registres secretos.
¿Primer paso para el rendimiento?
Mide la latencia de la base de datos y la externa antes de cambiar de framework.
Relacionado
- Conceptos básicos de Pydantic - Modelos principales
- Validadores - Reglas personalizadas
- Serialización -
model_dump - Gestión de configuración - Configuración del entorno
Versiones de la pila: Esta página se escribió para Python 3.14.0 (estable 3.14, mantenimiento 3.13), FastAPI 0.115+, Django 5.2, Flask 3.1, Pydantic 2, PyTorch 2.6+, pandas 2.2+, Polars 1.x, ruff 0.9+ y uv 0.6+.