Serialização
model_dump, esquema JSON e serializadores personalizados.
Receita
Cartão de receita de referência rápida - pronto para copiar e colar.
data = model.model_dump(exclude_none=True, by_alias=True)Quando usar isso:
- Respostas de API
- Cargas úteis de eventos
- Camadas de cache
Exemplo de Trabalho
from pydantic import BaseModel, field_serializer
class Event(BaseModel):
ts: datetime
@field_serializer("ts")
def ser_ts(self, v: datetime) -> str:
return v.isoformat()O que isso demonstra:
- exclude_none
- by_alias
- field_serializer
Análise Detalhada
Como Funciona
- A serialização é separada da validação.
- Serializadores personalizados controlam os tipos de saída.
model_dump_jsonpara bytes JSON UTF-8.
Armadilhas
- Validação de limite ignorada - Dados inválidos chegam às camadas de persistência. Correção: Valide com Pydantic ou formulários do framework na borda.
- Exposição de rastros de pilha - Clientes veem erros internos. Correção: Mapeie exceções para respostas HTTP estáveis.
- Bloqueio de loops de eventos assíncronos - Workers param sob carga concorrente. Correção: Use drivers assíncronos ou wrappers de threadpool.
- Segredos em controle de versão - Credenciais vazam via histórico do git. Correção: Carregue segredos de variáveis de ambiente ou de um cofre em tempo de execução.
- Falta de observabilidade - Incidentes são difíceis de depurar. Correção: Adicione logs estruturados, métricas e IDs de solicitação.
Alternativas
| Alternativa | Usar Quando | Não Usar Quando |
|---|---|---|
| Framework alternativo neste cookbook | Padrão da equipe ou monólito existente | API Greenfield com restrições diferentes |
| BaaS Gerenciado | MVP apenas CRUD | Autenticação personalizada, fluxos de trabalho ou necessidades de conformidade |
| gRPC | RPC interna de alto desempenho | Clientes HTTP públicos e acesso ao navegador |
FAQs
Quando devo adotar a serialização Pydantic?
Use-a quando os padrões e trade-offs nesta página corresponderem à sua API ou limite de dados.
Qual é o principal erro de produção com a serialização Pydantic?
Ignorar validação, timeouts ou contratos de erro explícitos na borda HTTP.
Como testar a serialização Pydantic?
Use o cliente de teste do framework, substitua dependências e afirme o status mais a forma JSON.
A serialização Pydantic funciona com Python 3.14?
Sim - os exemplos visam Python 3.14 com versões de framework fixadas do rodapé da pilha.
Como a serialização Pydantic se relaciona com o Pydantic 2?
Valide e serialize nas bordas; mantenha os serviços funcionando com objetos de domínio tipados.
Síncrono ou assíncrono?
Prefira rotas assíncronas quando o I/O dominar; mantenha o trabalho da CPU pequeno ou descarregue para workers.
Onde a lógica de negócios deve residir?
Handlers finos; serviços possuem regras; repositórios possuem consultas.
Como documentar APIs?
Publique documentação OpenAPI ou de esquema que corresponda aos modelos de resposta no código.
Como lidar com versionamento?
Versionamento explícito de URL ou cabeçalho com janelas de depreciação - evite quebras silenciosas.
O que ler a seguir?
Siga os links Relacionados para a próxima camada de profundidade nesta seção.
Como me manter seguro?
Autentique chamadores, autorize por recurso, limite a taxa e nunca registre segredos.
Primeiro passo de desempenho?
Meça a latência do DB e upstream antes de trocar de frameworks.
Relacionado
- Noções Básicas de Pydantic - Modelos principais
- Validadores - Regras personalizadas
- Serialização -
model_dump - Gerenciamento de Configurações - Configuração de env
Versões da Pilha: Esta página foi escrita para Python 3.14.0 (3.14 estável, 3.13 de manutenção), FastAPI 0.115+, Django 5.2, Flask 3.1, Pydantic 2, PyTorch 2.6+, pandas 2.2+, Polars 1.x, ruff 0.9+ e uv 0.6+.