Entrar Ainda não tem acesso?
Solucionado (ver solução)
Solucionado
(ver solução)
1
resposta

[Projeto] Queria que alguém desse algumas dicas para melhorar meu projeto

Referente ao curso Python: aplicando a Orientação a Objetos, no capítulo Consolidando os conhecimentos e atividade Conclusão

por Alicia Santos De Lima
| 84.5k xp | 3 posts

Nó curso anterior da formação eu já tinha iniciado o projeto como orientado ao objeto, então ao invés de começar um novo eu dei continuidade ao que eu já tinha feito. Eu gostaria de algumas dicas como:

  • A nomeação das def estão okay ou precisa melhorar?
  • como eu posso fazer a class em um arquivo separado e ela continuar com as def return_to_menu() , def format_restaurant(restaurant), def show_subtitle(txt), eu preciso fazer as def nos dois arquivos? ou se eu tiver elas no arquivo da class quando eu importar elas vem junto?
  • a documetação está okay ou precisa ser mais explicativa quanto a funcionalidade das defs?
  • as def estão boas ou tem alguma que seria melhor não existir, ou alguma a mais que poderia existir?

Se tiver qualquer outra diga para melhor, por favor, me diga.

Meu projeto:

https://github.com/alicia-lima/aplicativo-de-cadastro-de-restaurantes/blob/master/app.py

1 resposta
solução!
por Estudante
| 568.5k xp | 1338 posts

E aí! Vou tentar te dar uma mãozinha com seu projeto Python, beleza? Vamos lá:

  1. Em geral, a nomeação das funções está clara, mas sempre é bom dar nomes que descrevam bem o que cada função faz. Por exemplo, a função return_to_menu() é autoexplicativa, mas talvez show_return_to_menu_message() poderia ser mais descritivo.

  2. Para organizar melhor o seu código, você pode separar a classe Restaurant em um arquivo diferente (por exemplo, restaurant.py). Se você quiser usar as funções auxiliares (return_to_menu, format_restaurant, etc.) junto com a classe, você pode mantê-las no mesmo arquivo ou importá-las do arquivo onde elas estão definidas.

  3. A documentação ajuda bastante! Ela poderia ser mais detalhada, principalmente nas funções da classe Restaurant. Comentários adicionais explicando o propósito de cada método e os parâmetros que ele espera seriam super úteis.

  4. Algumas funções poderiam ser mais limpas. Por exemplo, a função modify_registration tem partes repetitivas de abrir e escrever no arquivo. Você poderia considerar criar uma função auxiliar para fazer essa parte do trabalho.

  5. Parece que você está validando o CNPJ. Talvez fosse interessante ter uma função separada só para essa validação, e talvez até fazer uma chamada a uma API externa para validar o CNPJ de forma mais completa.

  6. Fique atenta às exceções. Você já tem alguns try e except, mas é bom garantir que seu código não vai quebrar se algo inesperado acontecer. Talvez seria bom especificar qual tipo de exceção você está esperando.

  7. Pense também na experiência do usuário. Melhorar as mensagens, tornar o menu mais intuitivo e oferecer feedback claro após cada ação são coisas que podem fazer uma grande diferença.

  8. Tente dividir seu código em módulos menores. Isso torna mais fácil de ler, entender e também de testar partes específicas do código.

Espero que essas dicas te ajudem! Se precisar de mais alguma coisa, é só falar!