Utils library for Brazilian-specific businesses.
Brazilian Utils é uma biblioteca com foco na resolução de problemas que enfrentamos diariamente no desenvolvimento de aplicações para o business Brasileiro.
- Instalação
- Utilização
- Utilitários
- Novos Utilitários e Reportar Bugs
- Dúvidas? Ideias?
- Contribuindo com o Código do Projeto
pip install brutils
Para usar um de nossos utilitários, basta importar a função necessária, como no exemplo abaixo:
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
FalseVerifica se o CPF é valido. Apenas números, formatados como string. Não verifica se o CPF existe.
>>> from brutils import is_valid_cpf
>>> is_valid_cpf('00011122233')
FalseFormata o CPF. Retorna None se o CPF for inválido.
>>> from brutils import format_cpf
>>> format_cpf('11144477735')
'111.444.777-35'Remove os sÃmbolos de formatação do CPF e retorna somente números. Filtra apenas os sÃmbolos utilizados para a validação do CPF. Propositalmente não remove outros sÃmbolos.
>>> from brutils import remove_symbols_cpf
>>> remove_symbols_cpf('000.111.222-33')
'00011122233'Gera um CPF válido aleatório.
>>> from brutils import generate_cpf
>>> generate_cpf()
'17433964657'Verifica se o CNPJ é valido. Apenas números, formatados como string. Não verifica se o CNPJ existe.
>>> from brutils import is_valid_cnpj
>>> is_valid_cnpj('00111222000133')
FalseFormata o CNPJ.
>>> from brutils import format_cnpj
>>> format_cnpj('00111222000100')
'00.111.222/0001-00'Remove os sÃmbolos de formatação do CPF e retorna somente números. Filtra apenas os sÃmbolos utilizados para a validação do CPF. Propositalmente não remove outros sÃmbolos.
>>> from brutils import remove_symbols_cnpj
>>> remove_symbols_cnpj('00.111.222/0001-00')
'00111222000100'Gera um CNPJ válido aleatório.
>>> from brutils import generate_cnpj
>>> generate_cnpj()
'34665388000161'Verifica se o CEP é valido. Apenas números, formatados como string. Não verifica se o CEP existe.
>>> from brutils import is_valid_cep
>>> is_valid_cep('01310200')
TrueFormata o CEP. Retorna None se o CEP for inválido.
>>> from brutils import format_cep
>>> format_cep('01310200')
'01310-200'Remove os sÃmbolos de formatação do CEP e retorna somente números. Filtra apenas os sÃmbolos utilizados para a validação do CEP. Propositalmente não remove outros sÃmbolos.
>>> from brutils import remove_symbols_cep
>>> remove_symbols_cep('01310-200')
'01310200'Gera um CEP válido aleatório.
>>> from brutils import generate_cep
>>> generate_cep()
'77520503'Formata um numero de telefone recebido para um formato apresentavel humanamente. Caso não seja um numero válido, retorna None
Exemplo: 11994029275 será formatado para (11)99402-9275
>>> format_phone("11994029275")
'(11)99402-9275'
>>> format_phone("1635014415")
'(16)3501-4415'
>>> format_phone("333333")
>>>Verifica se o número de telefone é valido, podendo ser telefone fixo ou celular. Apenas números, com DDD e sem o prefixo internacional, formatados como string. Exemplo: +55 48 9999 9999 deve ser chamado como is_valid_phone('4899999999'). Esta função valida apenas números de telefone brasileiros e não verifica se o número realmente existe.
>>> from brutils import is_valid_phone
>>> is_valid_phone('11994029275')
TrueVerifica se o número de celular é valido. Apenas números, com DDD e sem o prefixo internacional, formatados como string.Exemplo: +55 48 9999 9999 ficaria '4899999999'. Esta função valida apenas números de celular brasileiros e não verifica se o número realmente existe.
>>> from brutils import is_valid_mobile_phone
>>> is_valid_mobile_phone('11994029275')
TrueVerifica se o número de telefone fixo é valido. Apenas números, com DDD e sem o prefixo internacional, formatados como string. Exemplo: +55 48 3333 3333 ficaria '4833333333'. Esta função valida apenas números de telefones fixos brasileiros e não verifica se o número realmente existe.
>>> from brutils import is_valid_landline_phone
>>> is_valid_landline_phone('1938814933')
TrueRemove sÃmbolos do número de telefone. Exemplo: (21)2569-6969 ficaria '2125696969'.
>>> from brutils import remove_symbols_phone
>>> remove_symbols_phone('(21)2569-6969')
'2125696969'Gera um número de telefone móvel válido e aleatório
>>> from brutils import generate_mobile_phone
>>> generate_mobile_phone()
'63996408441'
>>> generate_mobile_phone()
'78964850019'
>>> generate_mobile_phone()
'53924997638'Verificar se uma string corresponde a um e-mail válido. As regras para validar um endereço de e-mail geralmente seguem as especificações definidas pelo RFC 5322 (atualizado pelo RFC 5322bis), que é o padrão amplamente aceito para formatos de endereços de e-mail.
from brutils import is_valid_email
>>> is_valid_email("joao.ninguem@gmail.com")
True
>>> is_valid_email(".joao.ninguem@gmail.com")
False
>>> is_valid_email("joao.ninguem@gmail.")
False
>>> is_valid_email("joao ninguem@gmail.com")
FalseVerifica se uma placa veicular é válida. Suporta padrão antigo e padrão Mercosul.
>>> from brutils import is_valid_license_plate
>>> is_valid_license_plate('ABC1234')
True
>>> is_valid_license_plate('def5678')
True
>>> is_valid_license_plate('ABC4E67')
True
>>> is_valid_license_plate('GHI-4567')
FalseVerifica se é uma Placa de VeÃculo no antigo padrão utilizado no Brasil. Recebe como parâmetro uma string devendo conter somente caracteres alfanuméricos(letras e números) e retorna um valor booleano. Exemplo: 'abc1234' resulta em True. Esta função valida somente placas no antigo padrão e não verifica se a mesma realmente existe.
>>> from brutils import is_valid_license_plate_old_format
>>> is_valid_license_plate_old_format('ABC1234')
True
>>> is_valid_license_plate_old_format('def5678')
True
>>> is_valid_license_plate_old_format('GHI-4567')
FalseVerifica se uma string correspondente a um número da placa é válido, conforme as novas normas do Mercosul, isto é, seguindo o padrão LLLNLNN. Exemplo: ABC4E67.
>>> from brutils import is_valid_license_plate_mercosul
>>> is_valid_license_plate_mercosul('ABC4E67')
TrueConverte uma string correspondente a um número da placa é válido no formato antigo,
para o novo formato, conforme as novas normas do Mercosul (seguindo o padrão LLLNLNN).
Caso a placa informada seja inválida será retornado o valor None.
Exemplo: ABC4567 -> ABC4F67.
>>> from brutils import convert_license_plate_to_mercosul
>>> convert_license_plate_to_mercosul("ABC123")
"ABC1C34"
>>> convert_license_plate_to_mercosul("abc123")
"ABC1C34"
>>> convert_license_plate_to_mercosul("ABC1D23")
NoneDada uma String correspondente a uma placa de carro válida, seja no formato da placa é o antigo (LLLNNNN) ou o novo Formato Mercosul (LLLNLNN), retornar uma String correspondendo a esta placa formatada com o traço para o formato antigo e sem mudança para o formato Mercosul. Exemplo: ABC4567 -> ABC4F67.
>>> format_license_plate("ABC1234")
"ABC-1234"
>>> format_license_plate("abc1234")
"ABC-1234"
>>> format_license_plate("ABC1D23")
"ABC1D23"
>>> format_license_plate("abc1d23")
"ABC1D23"
>>> format_license_plate("ABCD123")
NoneRemove sÃmbolos "-" de formatação de um número de placa e retorna apenas o número. Propositalmente não remove outros sÃmbolos.
from brutils import remove_symbols_license_plate
>>> remove_symbols_license_plate("ABC-123")
"ABC123"
>>> remove_symbols_license_plate("abc123")
"abc123"
>>> remove_symbols_license_plate("ABCD123")
"ABCD123"
>>> remove_symbols_license_plate("@abc#-#123@")
"@abc##123@"Infere o formato de uma placa, LLLNNNN para o padrão antigo, LLLNLNN para o padrão Mercosul e None para placas inválidas.
from brutils import get_license_plate_format
>>> get_license_plate_format("ABC123")
"LLLNNNN"
>>> get_license_plate_format("abc123")
"LLLNNNN"
>>> get_license_plate_format("ABC1D23")
"LLLNLNN"
>>> get_license_plate_format("abc1d23")
"LLLNLNN"
>>> get_license_plate_format("ABCD123")
NoneGera placas válidas de carro utilizando como parâmetro um dos formatos válidos (LLLNLNN ou
LLLNNNN), tendo como formato padrão o padrão Mercosul. Caso seja fornecido um formato
inválido, é retornado o valor None.
from brutils import generate_license_plate
>>> generate_license_plate()
"ABC1D23"
>>> generate_license_plate(format="LLLNLNN")
"ABC4D56"
>>> generate_license_plate(format="LLLNNNN")
"ABC123"
>>> generate_license_plate(format="invalid")
## PIS
### is_valid_pis
Verifica se o número PIS/PASEP é valido. Apenas números, formatados como string. Não verifica se o PIS/PASEP existe.
Mais detalhes sobre a validação estão disponÃveis em https://www.macoratti.net/alg_pis.htm.
### generate_pis
Gera um PIS/PASEP válido aleatório.
```python
from brutils import generate_pis
>>> generate_pis()
'12038619494'
>>> generate_pis()
'57817700092'
>>> generate_pis()
'49850211630'Remove sÃmbolos "-" e "." de formatação de um número PIS/PASEP. Propositalmente não remove outros sÃmbolos.
from brutils import remove_symbols_pis
>>> remove_symbols_pis('170.33259.50-4')
'17033259504'
>>> remove_symbols_pis('/._')
'/_'Formata o número PIS. Retorna None se o PIS for inválido.
>>> from brutils import format_pis
>>> format_pis('12038619494')
'120.38619.49-4'Formata qualquer string de dÃgitos com tamanho de 20 caracteres no padrão de processo jurÃdico.
>>> from brutils import format_processo_juridico
>>> format_processo_juridico('23141945820055070079')
'2314194-58.2005.5.07.0079'
>>> format_processo_juridico('00000000000000000000')
'0000000-00.0000.0.00.0000'
>>>Remove os sÃmbolos "." e "-" de formatação de um número de processo jurÃdico e retorna apenas o número. Propositalmente não remove outros sÃmbolos.
from brutils import remove_symbols_processo_juridico
>>> remove_symbols_processo_juridico("6439067-89.2023.4.04.5902")
"64390678920234045902"
>>> remove_symbols_processo_juridico("4976023-82.2012.7.00.2263")
"49760238220127002263"
>>> remove_symbols_processo_juridico("4976023-82.2012.7.00.2263*!*&#")
"49760238220127002263*!*&#"Gera um número de processo válido de acordo com o ano informado e o órgão. Por padrão o argumento de ano recebe sempre o ano atual e o orgao recebe um valor aleatório de 1 à 9.
>>> from brutils import generate_processo_juridico
>>> print(generate_processo_juridico())
45676401020238170592
>>> print(generate_processo_juridico(ano=2025))
32110268020258121130
>>> print(generate_processo_juridico(orgao=5))
37573041520235090313
>>> print(generate_processo_juridico(ano=2024, orgao=4))
33158248820244017105
>>>Caso queira sugerir novas funcionalidades ou reportar bugs, basta criar uma nova issue e iremos lhe responder por lá!
(Para saber mais sobre github issues, confira a documentação oficial do GitHub).
Dúvidas de como utilizar a biblioteca? Novas ideias para o projeto? Quer compartilhar algo com a gente? Fique à vontade para criar um tópico no nosso Discussions que iremos interagir por lá!
(Para saber mais sobre github discussions, confira a documentação oficial do GitHub).
Sua colaboração é sempre muito bem-vinda! Preparamos o arquivo CONTRIBUTING.md para te ajudar nos primeiros passos. Lá você encontrará toda a informação necessária para contribuir com o projeto. Não hesite em nos perguntar utilizando o GitHub Discussions caso haja qualquer dificuldade ou dúvida. Toda ajuda conta!
Vamos construir juntos! 🚀🚀