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

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

Open niltonpimentel02 opened this issue 2 months ago • 3 comments

Seu pedido de recurso está relacionado a um problema?

  • O arquivo brutils/pis.py mantém tipagem no formato legado (# type:), afetando a clareza dos contratos e uso de ferramentas de tipagem.

Descreva a solução que você gostaria

  • Adotar anotações modernas nas funções, incluindo format_pis(pis: str) -> str | None e retornos explícitos em is_valid_pis, remove_symbols_pis, generate_pis.

Descreva alternativas que você considerou

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

Contexto adicional

  • Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/pis.py
  • Funções relevantes: is_valid_pis, format_pis, remove_symbols_pis, generate_pis.
  • Benefícios: padronização, melhor DX e prevenção de erros de integração.

💌 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

camilotmundim avatar Oct 27 '25 13:10 camilotmundim

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

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

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

@niltonpimentel02 , acredito que a issue já tenha sido atendida, pois o código já está no padrão proposto.

camilotmundim avatar Oct 27 '25 13:10 camilotmundim

@camilotmundim obrigado pelo aviso! 🎉

niltonpimentel02 avatar Nov 04 '25 19:11 niltonpimentel02