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

feat:retorna codigo do ibge do nome do municipio e da uf #411

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

CarduCaldeira
Copy link

@CarduCaldeira CarduCaldeira commented Sep 13, 2024

Descrição

Implementa uma função que recebe o nome do municipio e a sigla da UF e retorna seu código do IBGE.
@mateusoliveira43, @pedromendesjr, @nettorobson

Mudanças Propostas

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)

Estamos na dúvida na utilização de um arquivo json para leitura dos códigos referentes ao municípios (caso implementado) ou utilização de uma API externa para obter tais códigos.

Uma sugestão de desenvolvimento para melhoria seria a criação de um processo de automação para atualização do json

Issue Relacionada

Closes #399

Copy link

codecov bot commented Sep 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.79%. Comparing base (3f0d528) to head (19ced13).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #411   +/-   ##
=======================================
  Coverage   99.78%   99.79%           
=======================================
  Files          18       19    +1     
  Lines         472      495   +23     
=======================================
+ Hits          471      494   +23     
  Misses          1        1           

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

value = file_cities.get(name_city)

if value == None:
return None
Copy link
Member

Choose a reason for hiding this comment

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

O aviso aqui diz que essa linha do código não está sendo coberta pelos testes. Ou seja, que rodando os testes, essa parte do código nunca é executada. Para isso, precisamos adicionar um teste que caia dentro desse if. Por exemplo:

        self.assertIsNone(get_code_by_municipality_name("nome inválido", "rj"))

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.

Valeu pela contribuição! Sei que tá em rascunho, mas vim dar umas dicas, vai que ajuda... qualquer coisa é só chamar que estamos aqui!

@CarduCaldeira
Copy link
Author

@camilamaia obrigado pela ajuda, em breve aplicarei as mudanças!

@CarduCaldeira CarduCaldeira marked this pull request as ready for review September 29, 2024 01:44
@CarduCaldeira CarduCaldeira requested review from a team as code owners September 29, 2024 01:44

Retorna:
* str: O código IBGE do município. Retorna None se o nome não for válido ou não existir.
Exemplo:

Choose a reason for hiding this comment

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

pular linha aqui por conta da formatação

* str: O código IBGE do município. Retorna None se o nome não for válido ou não existir.
Exemplo:

```

Choose a reason for hiding this comment

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

python

@@ -1110,6 +1112,41 @@ Exemplo:
'RJ'
>>> convert_code_to_uf("99")
>>>
>>>>>>> main

Choose a reason for hiding this comment

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

essa modificação está correta?

Choose a reason for hiding this comment

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

lembra os passos/comandos para gerar esse arquivo?

seria interessante ter essa referência para uma possível automação futura

return code


def _transform_text(municipality_name: str): # type: (str) -> str

Choose a reason for hiding this comment

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

valeria escrever teste só para essa função?

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.

Retornar Código IBGE a partir do Nome do Município
3 participants