Nomes, funções e clareza

Neste capítulo você vai melhorar nomes e funcoes sem mudar o comportamento. O projeto de estudo é o Caderno da Mangueira, horto comunitário fictício em Belém.

Seu ponto de partida

Você sabe abrir pastas e um terminal. O exemplo deste capítulo é 28-clareza, no pacote que acompanha o volume. Trabalhe sobre uma cópia da pasta inicio/ e preserve o original; a versão de referência fica na raiz do exemplo.

No terminal, entre na pasta da cópia e rode:

python main.py

Não publique nada. Tudo fica no seu computador.

Como praticar

Leia → confira o código → mude uma coisa → preveja → rode de novo → confira. Investigue o erro antes de avançar. Ao terminar cada experiência, restaure a mudança pedida quando o capítulo indicar.

Nomeie com intenção

Nomes longos e claros batem jargão curto. O Caderno da Mangueira registra mudas, tarefas e colheitas fictícias. Cada capítulo acrescenta uma peça.

Faça na sua cópia

Abra main.py e localize o trecho desta lição. A implementação completa está no pacote de exemplos que acompanha este volume.

def soma_mudas(quantidades):
    return sum(quantidades)

Mude uma coisa e preveja

Altere somente um valor ou uma mensagem ligada a esta lição.

Anote o que espera observar antes de rodar de novo.

Recarregue e confira

Rode python main.py. Compare com a previsão. Se divergiu, leia o erro por completo.

Se não acontecer

Confirme a pasta do terminal e o arquivo editado. Na dúvida, compare com a referência da raiz do exemplo.

Comportamento igual

Refatorar não muda o resultado.

Faça na sua cópia

Repita o ciclo com o segundo ponto do capítulo. Mantenha o restante estável.

Mude uma coisa e preveja

Faça uma mudança pequena e diferente da primeira lição.

Anote a previsão.

Recarregue e confira

O console deve refletir só o que você alterou.

Se não acontecer

Releia a mensagem de erro de baixo para cima. Corrija uma causa por vez.

Erro comum

Renomear e quebrar chamadas.

Faça na sua cópia

Provoca o erro de propósito na cópia, observe a mensagem, depois restaure o arquivo bom.

Mude uma coisa e preveja

Preveja a mensagem antes de provocar o erro.

Recarregue e confira

A mensagem deve apontar o arquivo e a linha. Restaure em seguida.

Se não acontecer

Se o erro for outro, você mudou demais. Volte à referência e refaça só o passo pedido.

Atividades

Faça na cópia. Não olhe as respostas antes de tentar.

1. Explique com suas palavras o objetivo: Melhorar nomes e funcoes sem mudar o comportamento.
2. Faça uma mudança diferente da lição e diga o que esperava versus o que viu.
3. Escreva um caso em que o programa deve falhar de propósito e como você reconhece o erro.

Critério de avanço

Você avança quando melhorar nomes e funcoes sem mudar o comportamento.

Respostas comentadas

Atividade 1

O objetivo amarra a etapa ao Caderno da Mangueira; sem isso o comando fica solto.

Atividade 2

Prever antes de rodar mostra se você entendeu a regra ou só imitou o código.

Atividade 3

Provocar o erro e ler a mensagem é parte do ofício, não sinal de fracasso.

O arquivo completo

Referência do exemplo 28-clareza, reproduzida aqui para que você possa conferir sem sair da página.

main.py

# Antes: x = [8, 5]; t = 0; ...
# Depois: nomes claros

def soma_mudas(quantidades):
    return sum(quantidades)


canteiros = [8, 5, 3]
print(soma_mudas(canteiros))