Informa que o pacote possui tipagem

[eduardoklosowski]

• Informa que o pacote possui tipagem para ferramentas de validação externa como o mypy, por exemplo
• Adiciona tipagens faltantes no código

Reproduzindo o Problema

• Criar um virtualenv e instalar o pacote do projeto e o mypy:

mkdir validacao
python3 -m venv .venv
./.venv/bin/pip install validate-docbr mypy

• Cria código em exemplo.py:

from validate_docbr import CPF

cpf = CPF()
print(cpf.validate('000.000.000-00'))

• Validar a tipagem com mypy:

./.venv/bin/mypy exemplo.py

• Erro obtido:

exemplo.py:1: error: Skipping analyzing "validate_docbr": module is installed, but missing library stubs or py.typed marker  [import-untyped]
exemplo.py:1: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 1 error in 1 file (checked 1 source file)

Validando a Correção

• Faça o build do pacote a partir da branch do PR e instale ela no virtualenv de teste:

cd validate-docbr
git checkout typing
python3 setup.py bdist_wheel

cd validacao
./.venv/bin/pip install -U --force-reinstall validate_docbr-*.whl

• Execute o mypy:

./.venv/bin/mypy exemplo.py

• Exemplo do resultado obtido:

Success: no issues found in 1 source file