Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversão de código do estado do IBGE para a sigla do Estado #410

Merged
merged 5 commits into from
Sep 23, 2024

Conversation

carlos-moreno
Copy link
Contributor

@carlos-moreno carlos-moreno commented Sep 13, 2024

Descrição

Converter o código de estado do IBGE na sigla do Estado

Mudanças Propostas

Adicionado função responsável por realizar a conversão do código de estado do IBGE na sigla do estado.

  • Adicionado função de conversão convert_code_to_uf.
  • Adicionado testes unitários.
  • Importado a função no init.py

Checklist de Revisão

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

Comentários Adicionais (opcional)

Issue Relacionada

Closes #397

 - Adicionado função responsável por converter o código de estado do IBGE na sigla do estado
 - Adicionado testes unitários
@carlos-moreno carlos-moreno requested review from a team as code owners September 13, 2024 19:25
Copy link

codecov bot commented Sep 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (9972d18) to head (16dd8d9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #410      +/-   ##
==========================================
+ Coverage   99.77%   99.78%   +0.01%     
==========================================
  Files          17       18       +1     
  Lines         437      472      +35     
==========================================
+ Hits          436      471      +35     
  Misses          1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@antoniamaia antoniamaia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oii @carlos-moreno, faltaram dois detalhes importantes: o item 10. Atualizar READMEs e o item 12. Adicione Entradas no CHANGELOG.md.. Muito obrigada pela contribuição!! 🎉

@carlos-moreno
Copy link
Contributor Author

Co-authored-by: Fernando Bezerra fsbezerra@outlook.com

README.md Outdated
* code (str): O código IBGE de 2 dígitos a ser convertido.

Retorna:
* str or None: O código UF correspondente ao código IBGE, ou Nenhum se o
Copy link
Member

@camilamaia camilamaia Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dá para deixar o tipo em inglês mesmo, porque assim fica claro do que se está falando. Só para não confundir mesmo.

Suggested change
* str or None: O código UF correspondente ao código IBGE, ou Nenhum se o
* str or None: O código UF correspondente ao código IBGE, ou None se o

self.assertIsNone(convert_code_to_uf("")) # Código vazio
self.assertIsNone(convert_code_to_uf("AB")) # Código não numérico

# implementar mais casos de teste aqui se necessário
Copy link
Member

@camilamaia camilamaia Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Como vcs não sentiram a necessidade de implementar mais testes, dá só para arrancar fora esse comentário mesmo. Ele era só para ajudar a guiar.

Suggested change
# implementar mais casos de teste aqui se necessário

Copy link
Member

@camilamaia camilamaia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boa, ficou lindão!! 👏

Só comentei dois pequenos detalhes, mas fora isso já tá pronto para mergear. Se vcs quiserem, eu mesma posso atualizar aqui com as modificações e já dale.

@carlos-moreno
Copy link
Contributor Author

Boa, valeu pelas dicas @camilamaia
Alterações indicadas feitas.

Copy link
Contributor

@antoniamaia antoniamaia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mandaram ver!! Obrigada pela contribuição e participação no tutorial, pessoal!! 🌟

@camilamaia camilamaia merged commit 6346f4c into brazilian-utils:main Sep 23, 2024
8 checks passed
camilamaia pushed a commit that referenced this pull request Sep 23, 2024
Co-authored-by: Fernando Bezerra <fsbezerra@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Conversão de Código do IBGE de Estado para UF
3 participants