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

[niltonpimentel02]

Seu pedido de recurso está relacionado a um problema?

• O arquivo brutils/cnpj.py utiliza type hints no formato de comentários (# type:), o que reduz a legibilidade e a padronização com práticas modernas de tipagem em Python 3, dificultando a verificação estática e a experiência em IDEs.

---

Descreva a solução que você gostaria

• Migrar todos os comentários de tipo (# type:) para anotações de função modernas (PEP 484/526), explicitando retornos opcionais (str | None) onde aplicável (ex.: format_cnpj) e padronizando as assinaturas no módulo.

---

Descreva alternativas que você considerou

• Manter apenas docstrings: melhora documentação, mas não permite checagem estática.
• Criar stubs .pyi: aumenta manutenção e risco de divergência entre implementação e tipos.

---

Contexto adicional

• Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/cnpj.py
• Funções relevantes: is_valid_cnpj, format_cnpj, remove_symbols_cnpj, generate_cnpj.
• Benefícios: melhor DX, integração com mypy/pyright, maior clareza de contratos de tipos e consistência com Python 3.8+.

---

💌 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. ✨

[luizweb]

bora!

[github-actions[bot]]

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

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