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

refactor: Migrar type hints de license_plate.py de acordo com PEP 484

Open lucasjl opened this issue 2 months ago • 2 comments

Descrição

Este PR resolve a issue #620 , migrando type hints do arquivo license_plate.py de acordo com PEP 484, utilizando anotações modernas

Mudanças Propostas

  • Substituir Optional[str] por 'str | None' em anotações de funções.
  • Ajustar docstrings que mencionam Optional, substituindo pelas anotações modernas.
  • Uso do Literal para especificar 'old_format' ou 'mercosul' no argumento 'type' da função 'is_valid'

Checklist de Revisão

  • [X] Eu li o Contributing.md
  • [X] Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
  • [X] Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
  • [X] A documentação em português foi atualizada ou criada, se necessário.
  • [X] Se feita a documentação, a atualização do arquivo em inglês.
  • [X] Eu documentei as minhas mudanças no código, adicionando docstrings e comentários. Instruções
  • [X] O código segue as diretrizes de estilo e padrões de codificação do projeto.
  • [X] Todos os testes passam. Instruções
  • [X] O Pull Request foi testado localmente. Instruções
  • [X] Não há conflitos de mesclagem.

Comentários Adicionais (opcional)

N/A

Issue Relacionada

Closes #620

lucasjl avatar Oct 27 '25 17:10 lucasjl

Boa @lucasjl ! Só faltou atualizar o CHANGELOG.md

Muito obrigado pela revisão, Willian!

Sobre o Changelog, ali durante o dia da sprint comentaram que esses mudanças nos type hints seriam classificadas como mudanças internas do código e não precisariam ser adicionadas ao CHANGELOG. Vendo o escopo da issue e as mudanças, realmente não vejo nada público, aí acabei não adicionando mesmo.

O que tu acha? Posso adicionar sem problemas, só queria confirmar contigo.

Abraço!

lucasjl avatar Oct 30 '25 03:10 lucasjl

Boa @lucasjl ! Só faltou atualizar o CHANGELOG.md

Muito obrigado pela revisão, Willian!

Sobre o Changelog, ali durante o dia da sprint comentaram que esses mudanças nos type hints seriam classificadas como mudanças internas do código e não precisariam ser adicionadas ao CHANGELOG. Vendo o escopo da issue e as mudanças, realmente não vejo nada público, aí acabei não adicionando mesmo.

O que tu acha? Posso adicionar sem problemas, só queria confirmar contigo.

Abraço!

Fechou! Acho que faz sentido mesmo deixar como mudanças internas.

morais90 avatar Nov 02 '25 12:11 morais90

@lucasjl muito bom parabéns 🎉

niltonpimentel02 avatar Nov 04 '25 19:11 niltonpimentel02