Skip to content
Pacote Python para validação de documentos brasileiros
Python
Branch: master
Clone or download
alvarofpp Merge pull request #25 from allangirao/master
Issue 24 do repo alvarofpp/validate-docbr
Latest commit 5aae135 Dec 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
tests Merge pull request #18 from luizpericolo/luizpericolo-voting-document Oct 30, 2019
validate_docbr
.gitignore Suite de testes Sep 8, 2019
CONTRIBUTING.md Update CONTRIBUTING.md Mar 12, 2019
LICENSE
README.md
mkdocs.yml Mkdocs Apr 29, 2019
setup.py Issue 24 do repo alvarofpp/validate-docbr Dec 11, 2019

README.md

validate-docbr

latest release

Pacote Python para validação de documentos brasileiros.

Para instalar o pacote:

pip install validate-docbr

A documentação pode ser acessada clicando aqui.

Documentos

Documentos que estão no pacote:

  • CPF: Cadastro de Pessoas Físicas;
  • CNH: Carteira Nacional de Habilitação;
  • CNPJ: Cadastro Nacional da Pessoa Jurídica;
  • CNS: Cartão Nacional de Saúde;
  • Título eleitoral: Cadastro que permite cidadãos brasileiros votar.

Para entender melhor os documentos e suas respectivas classes, basta acessar a Wiki do projeto.

Métodos

Todos os documentos possuem os mesmos métodos.

validate

Valida o documento passado como argumento. Retorna um bool, True caso seja válido, False caso contrário . Recebe os parâmetros:

Parâmetro Tipo Valor padrão Obrigatório Descrição
doc str '' X O documento que se quer validar.
from validate_docbr import CPF

cpf = CPF()

# Validar CPF
cpf.validate("012.345.678-90")  # True
cpf.validate("012.345.678-91")  # False

Caso especial de CPF.

validate_list

Valida uma lista de documentos passado como argumento. Retorna uma lista de bool, True caso seja válido, False caso contrário. Recebe os parâmetros:

Parâmetro Tipo Valor padrão Obrigatório Descrição
docs List[str] [] X A lista de documentos para validar.
from validate_docbr import CPF

cpf = CPF()

# Validar CPFs
cpf.validate_list(["012.345.678-90", "012.345.678-91"])  # [True, False]

generate

Gera um novo documento, retorna em formato de str. Recebe os parâmetros:

Parâmetro Tipo Valor padrão Obrigatório Descrição
mask bool False - Quando possui o valor True, o documento retornado estará formatado.
from validate_docbr import CPF

cpf = CPF()

# Gerar novo CPF
new_cpf_one = cpf.generate()  # "01234567890"
new_cpf_two = cpf.generate(True)  # "012.345.678-90"

generate_list

Gera uma lista de documentos, retorna em formato de list com elementos do tipo str. Recebe os parâmetros:

Parâmetro Tipo Valor padrão Obrigatório Descrição
n int 1 X A quantidade desejada de documentos que serão gerados.
mask bool False - Se os documentos gerados deverão ter ou não máscara.
repeat bool False - Se aceita ou não documentos repetidos.
from validate_docbr import CPF

cpf = CPF()

# Gerar lista de CPFs
cpfs_one = cpf.generate_list(2)  # [ "85215667438", "28293145811" ]
cpfs_two = cpf.generate_list(2, True)  # [ "852.156.674-38", "282.931.458-11" ]

mask

Mascara o documento passado como argumento. Retorna um str que é o documento mascarado . Recebe os parâmetros:

Parâmetro Tipo Valor padrão Obrigatório Descrição
doc str '' X O documento que se quer mascarar.
from validate_docbr import CPF

cpf = CPF()

cpf_me = "01234567890"

# Mascara o CPF
cpf.mask(cpf_me)  # "012.345.678-90"
You can’t perform that action at this time.