Valide dados em Python com Pydantic

pip install pydantic

​

Criando um modelo

• Primeiro, precisamos importar pydantic.BaseModel e fazer a nossa classe herdar dele para começar a validar. No nosso exemplo, vamos criar uma classe chamada Person, que terá um nome, uma idade e um e-mail.

from pydantic import BaseModel

class Person(BaseModel):
    name: str
    age: int
    email: str

• Com essa classe, ao instanciá-la, o pydantic vai validar se name e email são strings e se age é um inteiro.

​

Usando o modelo

• Agora que a criamos, vamos instanciar a classe. Vamos criar um dicionário com os dados e desempacotá-lo na nossa classe.

data = {
    "name": "John",
    "age": 19,
    "email": "john@example.com"
}
person = Person(**data)

• O exemplo acima não gera nenhum erro, pois todos os campos têm o tipo correto. Por padrão, o pydantic também converte valores compatíveis: se age for a string "19", ela vira o inteiro 19. Agora vamos enviar dados errados para confirmar que a validação funciona.

data = {
    "name": "John",
    "age": "nineteen",
    "email": "john@example.com"
}
person = Person(**data)

• O exemplo acima gera um ValidationError, pois age precisa ser um inteiro e "nineteen" não pode ser convertido em um:

1 validation error for Person
age
  Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='nineteen', input_type=str]

• Para tratar o erro em vez de deixá-lo parar o seu programa, capture-o com try/except. O método errors() lista cada campo inválido:

from pydantic import ValidationError

try:
    Person(name="John", age="nineteen", email="john@example.com")
except ValidationError as error:
    for item in error.errors():
        print(item["loc"], item["msg"])
# ('age',) Input should be a valid integer, unable to parse string as an integer

​

Modo estrito

• Se você quiser rejeitar também strings como "19", ative o modo estrito no modelo. Assim, age só aceita um int de verdade, e Person(name="John", age="19", email="john@example.com") gera ValidationError.

from pydantic import BaseModel, ConfigDict

class Person(BaseModel):
    model_config = ConfigDict(strict=True)

    name: str
    age: int
    email: str

​

Criando uma dataclass

• Você também pode criar dataclasses com o pydantic. Elas são parecidas com as dataclasses padrão do Python, mas validam os campos como o BaseModel.

from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: str

• Se enviarmos a string "19" para age, ela será convertida para o int 19.

​

Extras

• O Pydantic tem alguns extras, como a validação de e-mail e um pacote de fallback de timezone. Para instalá-los, execute os comandos abaixo:

pip install "pydantic[email]"

pip install "pydantic[timezone]"

• Você pode instalar os dois de uma vez com o seguinte comando.

pip install "pydantic[email,timezone]"

• O pydantic[email] adiciona o tipo EmailStr, que valida o formato user@domain.tld e normaliza o endereço.

from pydantic import EmailStr
from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: EmailStr

​

Validando variáveis de ambiente na inicialização

• Bots e APIs leem tokens e configurações de variáveis de ambiente. Com o pydantic-settings, uma variável faltando ou inválida para a aplicação na inicialização com um erro claro, em vez de falhar mais tarde no meio de uma requisição.

pip install pydantic-settings

• Declare as variáveis de que a sua aplicação precisa em uma classe que herda de BaseSettings. Cada campo lê a variável de ambiente de mesmo nome, sem diferenciar maiúsculas de minúsculas: discord_token lê DISCORD_TOKEN.

from pydantic import SecretStr
from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    discord_token: SecretStr  # obrigatória: a aplicação não inicia sem ela
    port: int = 80  # opcional: 80 quando PORT não está definida
    debug: bool = False


settings = Settings()

• Se DISCORD_TOKEN não estiver definida, Settings() gera um ValidationError para discord_token com a mensagem Field required. Um valor como PORT=abc falha da mesma forma, porque port precisa ser um inteiro.
• O SecretStr esconde o token quando você imprime ou registra as configurações nos logs. Leia o valor real com settings.discord_token.get_secret_value().

​

Rode na Square Cloud

pydantic[email]
pydantic-settings

DISPLAY_NAME=My Python Bot
MAIN=main.py
MEMORY=512
VERSION=recommended
AUTORESTART=true

​

Próximos passos

​

Gostou desse artigo?

• Criamos este conteúdo com o máximo de cuidado para oferecer a melhor ajuda possível. Se o artigo contribuiu de alguma forma, valorize nosso trabalho! Desenvolvedores já avaliaram a Square Cloud com 4,9/5 em 402 avaliações no Google e Trustpilot: deixe a sua também! Isso nos ajuda a entender o que é mais importante para você.