pydantic-br 1.2.0

Pydantic library extension with Brazilian fields

Pydantic BR

Essa é uma biblioteca de extensão e visa disponibilizar campos com validações brasileiras para a biblioteca pydantic.

Compatível com a versão v1 e v2 do Pydantic.

---

Código fonte: https://github.com/scjorge/pydantic_br

Documentação: https://pydantic-br.readthedocs.io

---

Disponibilidades

Campo	Grupo de Documentos	Nome do Documento	Método de validação
CPF	Pessoa física	Cadastro de Pessoa Física	Digito Verificador
CNH	Pessoa física	Carteira Nacional de Habilitação	Digito Verificador
TE	Pessoa física	Título de Eleitor	Digito Verificador
PIS	Pessoa física	Programa de Integração Social	Digito Verificador
CERT	Pessoa física	Certidão (Nascimento/Casamento/Óbito)	Digito Verificador
CNS	Pessoa física	Cartão Nacional de Saúde	Digito Verificador
CNPJ	Pessoa Jurídica	Carteira Nacional de Pessoas Jurídicas	Digito Verificador
CEP	Endereços	Código de Endereçamento Postal	RegExr
SiglaEstado	Endereços	Sigla oficial do Estado Brasileiro	RegExr
RENAVAM	Veículos	Registro Nacional de Veículos Automotores	Digito Verificador
PlacaVeiculo	Veículos	Placa do Veículo	RegExr

Instalação

Utilizando pip

pip install pydantic-br

Utilizando Poetry

poetry add pydantic-br

Exemplos de Utilização

Os exemplos de dados exemplificados foram tirados dos seguintes sites:

• geradordecpf
• 4devs

A má utilização dos dados é de total responsabilidade do usuário.

CPF válido

from pprint import pprint

from pydantic import BaseModel

from pydantic_br import CPF, CPFDigits, CPFMask


class Pessoa(BaseModel):
    nome: str
    cpf: CPF  # aceita CPF válidos com ou sem máscara
    cpf_mask: CPFMask  # aceita CPF válido apenas com máscara
    cpf_digits: CPFDigits  # aceita CPF válido apenas com dígitos


p1 = Pessoa(
    nome="João", cpf="53221394780", cpf_mask="532.213.947-80", cpf_digits="53221394780"
)


pprint(p1.model_dump())

Saída

{'cpf': '53221394780',
 'cpf_digits': '53221394780',
 'cpf_mask': '532.213.947-80',
 'nome': 'João'}

CPF inválido

from pprint import pprint

from pydantic import BaseModel

from pydantic_br import CPF, CPFDigits, CPFMask


class Pessoa(BaseModel):
    nome: str
    cpf: CPF  # aceita CPF válidos com ou sem máscara
    cpf_mask: CPFMask  # aceita CPF válido apenas com máscara
    cpf_digits: CPFDigits  # aceita CPF válido apenas com dígitos


p1 = Pessoa(
    nome="João", cpf="00000000000", cpf_mask="53221394780", cpf_digits="532.213.947-80"
)

pprint(p1.model_dump())

Saída

Traceback (most recent call last):
    p1 = Pessoa(
  File "pydantic\main.py", line 341, in pydantic.main.BaseModel.__init__
pydantic.error_wrappers.ValidationError: 3 validation errors for Pessoa
cpf
  invalid data [type=invalid_data, input_value='00000000000', input_type=str]
cpf_mask
  invalid mask format [type=invalid_mask, input_value='53221394780', input_type=str]
cpf_digits
  field only accept digits as string [type=not_digits, input_value='532.213.947-80', input_type=str]

Versões do Pydantic

Os exemplos acima estão escritos na versão v1 do Pydantic. Entretanto, funciona perfeitamente com a versão v2.

Então que mudará? Bem, uma das coisa é que os métodos de 'apresentação' das models foram alterados na v2.

• O método dict() foi alterado para model_dump() e model_dump_json()
• O método schema() foi alterado para model_json_schema()