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

Migrar type hints de `brutils/license_plate.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/license_plate.py usa type hints via comentários, o que prejudica a legibilidade e dificulta a padronização com Python 3.

Descreva a solução que você gostaria

  • Atualizar assinaturas com anotações modernas, usando Literal para tipos de placa quando aplicável e str | None em funções que podem falhar (ex.: format_license_plate, convert_license_plate_to_mercosul).

Descreva alternativas que você considerou

  • Docstrings: não habilitam checagem estática robusta.
  • Stubs .pyi: elevam complexidade de manutenção.

Contexto adicional

  • Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/license_plate.py
  • Funções relevantes: is_valid_license_plate, format_license_plate, remove_symbols_license_plate, generate_license_plate, convert_license_plate_to_mercosul, get_format_license_plate.
  • Benefícios: contratos mais claros e melhor feedback de ferramentas estáticas.

💌 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

lucasjl avatar Oct 27 '25 13:10 lucasjl

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

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

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