Módulo satcomum.br
¶
-
exception
satcomum.br.
NumeroCEPError
¶
-
exception
satcomum.br.
NumeroCNPJCPFError
¶
-
exception
satcomum.br.
NumeroCNPJError
¶
-
exception
satcomum.br.
NumeroCPFError
¶
-
exception
satcomum.br.
UnidadeFederativaError
¶
-
satcomum.br.
as_cep
(numero)¶ Formata um número de CEP. Se o argumento não for um CEP válido apenas retorna o argumento sem qualquer modificação.
-
satcomum.br.
as_cnpj
(numero)¶ Formata um número de CNPJ. Se o número não for um CNPJ válido apenas retorna o argumento sem qualquer modificação.
-
satcomum.br.
as_cnpjcpf
(numero)¶ Formata um número de CNPJ ou CPF. Se o número não for um CNPJ ou CPF válidos apenas retorna o argumento sem qualquer modificação.
-
satcomum.br.
as_cpf
(numero)¶ Formata um número de CPF. Se o número não for um CPF válido apenas retorna o argumento sem qualquer modificação.
-
satcomum.br.
cep
(numero)¶ Valida um número de CEP. O número deverá ser informado como uma string contendo 8 dígitos numéricos. Se o número informado for inválido será lançada a exceção
NumeroCEPError
.Aviso
Qualquer string que contenha 8 dígitos será considerada como um CEP válido, desde que os dígitos não sejam todos iguais.
-
satcomum.br.
cnpj
(numero)¶ Valida um número de CNPJ. O número deverá ser informado como uma string contendo 14 dígitos numéricos. Se o número informado for inválido será lançada a exceção
NumeroCNPJError
. Esta implementação da validação foi delicadamente copiada de python-sped <http://git.io/vfuGW>.
-
satcomum.br.
codigo_ibge_uf
(sigla)¶ Retorna o código do IBGE para a UF informada.
-
satcomum.br.
cpf
(numero)¶ Valida um número de CPF. O número deverá ser informado como uma string contendo 11 dígitos numéricos. Se o número informado for inválido será lançada a exceção
NumeroCPFError
. Esta implementação da validação foi delicadamente copiada de python-sped <http://git.io/vfuGW>.
-
satcomum.br.
is_cep
(numero, estrito=False)¶ Uma versão conveniente para usar em testes condicionais. Apenas retorna verdadeiro ou falso, conforme o argumento é validado.
Parâmetros: estrito (bool) – Padrão False
, indica se apenas os dígitos do número deverão ser considerados. Se verdadeiro, potenciais caracteres que formam a máscara serão removidos antes da validação ser realizada.
-
satcomum.br.
is_cnpj
(numero, estrito=False)¶ Uma versão conveniente para usar em testes condicionais. Apenas retorna verdadeiro ou falso, conforme o argumento é validado.
Parâmetros: estrito (bool) – Padrão False
, indica se apenas os dígitos do número deverão ser considerados. Se verdadeiro, potenciais caracteres que formam a máscara serão removidos antes da validação ser realizada.
-
satcomum.br.
is_cnpjcpf
(numero, estrito=False)¶ Uma versão conveniente para usar em testes condicionais. Apenas retorna verdadeiro ou falso, conforme o argumento é validado.
Parâmetros: estrito (bool) – Padrão False
, indica se apenas os dígitos do número deverão ser considerados. Se verdadeiro, potenciais caracteres que formam a máscara serão removidos antes da validação ser realizada.
-
satcomum.br.
is_codigo_uf
(codigo_ibge)¶ Indica se o código da UF é um código válido.
-
satcomum.br.
is_cpf
(numero, estrito=False)¶ Uma versão conveniente para usar em testes condicionais. Apenas retorna verdadeiro ou falso, conforme o argumento é validado.
Parâmetros: estrito (bool) – Padrão False
, indica se apenas os dígitos do número deverão ser considerados. Se verdadeiro, potenciais caracteres que formam a máscara serão removidos antes da validação ser realizada.
-
satcomum.br.
is_uf
(sigla)¶ Uma versão conveniente para usar em testes condicionais. Apenas retorna verdadeiro ou falso, conforme o argumento é validado.
-
satcomum.br.
uf
(sigla)¶ Valida a sigla da Unidade Federativa. Se não for uma sigla de UF válida, será lançada a exceção
UnidadeFederativaError
.
-
satcomum.br.
uf_pelo_codigo
(codigo_ibge)¶ Retorna a UF para o código do IBGE informado.