brutils-python icon indicating copy to clipboard operation
brutils-python copied to clipboard

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

Open niltonpimentel02 opened this issue 2 months ago • 2 comments

Seu pedido de recurso está relacionado a um problema?

  • O arquivo brutils/voter_id.py usa type hints no padrão legado, prejudicando a clareza e a adoção de práticas atuais de tipagem.

Descreva a solução que você gostaria

  • Introduzir anotações modernas (PEP 484/526) explicitando format_voter_id(voter_id: str) -> str | None e mantendo retornos booleanos onde cabível.

Descreva alternativas que você considerou

  • Docstrings: não habilitam verificação estática.
  • Stubs .pyi: manutenção duplicada.

Contexto adicional

  • Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/voter_id.py
  • Funções relevantes: is_valid_voter_id, format_voter_id, generate_voter_id.
  • Benefícios: tipagem consistente, maior legibilidade e melhor tooling.

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

niltonpimentel02 avatar Oct 17 '25 18:10 niltonpimentel02

Bora

felipecolen avatar Oct 27 '25 13:10 felipecolen

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

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

github-actions[bot] avatar Oct 27 '25 14:10 github-actions[bot]