Migrar type hints de `brutils/cep.py` para anotações modernas (PEP 484)

[niltonpimentel02]

Seu pedido de recurso está relacionado a um problema?

• O arquivo brutils/cep.py utiliza type hints no formato de comentários (# type:), prejudicando a clareza e a padronização com Python 3, além de dificultar a verificação estática e a manutenção.

---

Descreva a solução que você gostaria

• Atualizar para anotações modernas (PEP 484/526), incluindo retornos opcionais explícitos (ex.: format_cep pode retornar str | None) e tipar respostas das integrações ViaCEP (Address | None e list[Address] | None).

---

Descreva alternativas que você considerou

• Docstrings apenas: não habilitam checagem estática.
• Stubs .pyi: paralelizam manutenção e podem divergir da implementação.

---

Contexto adicional

• Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/cep.py
• Funções relevantes: is_valid_cep, format_cep, remove_symbols_cep, generate_cep, get_address_from_cep, get_cep_information_from_address.
• Benefícios: DX melhor, tipos verificáveis para integrações externas e padronização de retornos opcionais.

---

💌 Quer contribuir, mas não se sente à vontade?

Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente?

Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜

Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para [email protected] e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar.

O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨

[camilotmundim]

bora

[github-actions[bot]]

🇧🇷 Português ✅ Issue #616 atribuída a @camilotmundim. Verifique o guia de contribuição para instruções sobre como submeter sua Pull Request.

🇬🇧 English ✅ Issue #616 assigned to @camilotmundim. Check the contributing guide for instructions on submitting your Pull Request.