Módulo 10 · Aula 10.1 · Caça aos erros: mensagens, print e pontos de interrupção

Objetivos de aprendizagem

1. Ler uma mensagem de erro do Godot: o que deu errado, em que arquivo e em que linha.
2. Usar print para ver valores enquanto o jogo roda.
3. Parar o jogo numa linha com um ponto de interrupção e olhar as variáveis.
4. Separar erro de execução (o jogo para) de erro de lógica (o jogo roda, mas faz a conta errada).

Pré-requisitos

Módulo 8.

Materiais

Godot 4.7; projeto exemplos/caca-aos-erros (sem a pasta gabarito, que fica com o professor).

Conceitos

O caixa da feira. O projeto tem um script só, caixa.gd, que soma um pedido (cuscuz R$ 3,50, tapioca R$ 5,00, suco R$ 4,00), calcula o troco de R$ 20,00 e escreve em reais. Ele tem quatro erros escondidos, de propósito. O certo seria:

Conta: R$ 12,50
Troco de R$ 20,00: R$ 7,50
Uma tapioca e um suco: R$ 9,00

Rodando o projeto como ele está, sai isto (cópia de uma execução real, sem janela):

Conta: R$ 9,0
Troco de R$ 20,00: R$ -11,0
SCRIPT ERROR: Invalid access to property or key 'Suco' on a base object of type 'Dictionary'.
   at: total (res://scripts/caixa.gd:26)
   GDScript backtrace (most recent call first):
       [0] total (res://scripts/caixa.gd:26)
       [1] _ready (res://scripts/caixa.gd:19)
Uma tapioca e um suco: R$ 0,0

Como ler a mensagem de erro. Três partes, sempre:

As mensagens do Godot são em inglês, mesmo com o editor em português. Vale ter um glossário na parede: invalid (inválido), access (acesso), key (chave), null instance (nó que não existe), nonexistent function (função que não existe).

Erro de execução × erro de lógica.

O erro de lógica é mais traiçoeiro: ninguém avisa. Só aparece quando alguém sabe qual era o resultado certo. Por isso o primeiro passo de qualquer teste é escrever o que deveria acontecer.

print. O jeito mais simples de espiar: print("i = ", i, " soma = ", soma) dentro da repetição mostra cada volta na Saída.

Ponto de interrupção (breakpoint). Clicando à esquerda do número da linha, aparece uma bolinha vermelha. Rodando pelo editor, o jogo para antes daquela linha, e o painel Depurador mostra as variáveis naquele instante. Com os botões do depurador, dá para andar uma linha de cada vez.

Quando o editor para sozinho. Rodando pelo editor, um erro de execução também para o jogo, igual a um ponto de interrupção: o depurador abre na linha do erro, com as variáveis à mostra (primeira captura).

Exemplos

O que a captura do ponto de interrupção mostra, parado na linha 26 na primeira volta:

Tutorial passo a passo

Parte A. Prever antes de rodar (40 min)

1. Abra scripts/caixa.gd. Sem rodar, calcule à mão os três resultados certos e anote no caderno.

Parte B. Rodar e ler (80 min)

2. Executar Projeto. O editor para e abre o Depurador na aba Rastreamento de Pilha, com a mensagem em vermelho e a linha 26 marcada (captura).
3. Leia a mensagem com a tabela dos Conceitos. Que item causou o erro? Qual linha chamou?
4. Pare o jogo. Na aba Saída, compare as duas primeiras linhas com o que você calculou.

Parte C. Ponto de interrupção (120 min)

5. Clique à esquerda do número 26 (ou deixe o cursor na linha e use Alternar Ponto de Interrupção, tecla F9). Aparece a bolinha vermelha.
6. Rode de novo. O jogo para na linha 26. Olhe o quadro Locals (em inglês na tela): i vale quanto?
7. Use o botão de avançar no depurador (Continuar) e veja soma e i mudarem a cada volta.
8. Ache o erro 1 e corrija. Rode de novo.

Parte D. print e os outros erros (160 min)

9. Para o troco, ponha print("pago = ", pago, " conta = ", conta) dentro de troco. Ache o erro 2.
10. Para o formato, teste reais(1205). Deveria dar R$ 12,05. Ache o erro 3 (dica: compare com a função reais da Feira do Troco, Aula 8.8).
11. Corrija o erro 4 (o que derrubava o jogo).
12. Rode tudo e compare com o que você calculou no passo 1. Apague os print de investigação.

Parte E. Registro (100 min)

13. No diário, para cada erro: sintoma, como achou (mensagem, print ou ponto de interrupção), causa e correção.

Imagens

• ../../../recursos/imagens/godot/captura-godot-depurador-erro.png: o editor parado no erro, com a mensagem Invalid access ... 'Suco', a pilha (linhas 26 e 19) e as variáveis.
• ../../../recursos/imagens/godot/captura-godot-depurador-ponto-de-interrupcao.png: parado no ponto de interrupção da linha 26, com i = 1, soma = 0 e a lista Pontos de Interrupção mostrando "Linha 26".

Indicação da interface

Os nomes das abas, dos quadros, de Remota e Local aparecem nas capturas. Alternar Ponto de Interrupção e as dicas dos botões foram lidos das traduções do Godot 4.7.2. A tecla F9 vem da documentação do Godot e não foi conferida.

O código completo

scripts/caixa.gd (com os erros):

extends Node
## Caixa da barraca de comida da feira (Aula 10.1).
## ATENÇÃO: este script tem 4 erros escondidos, de propósito. A turma vai achar todos
## lendo as mensagens do Godot, usando print e pontos de interrupção.
## Preços em centavos, como na Feira do Troco: R$ 3,50 vira 350.

const PRECOS := {
	"cuscuz": 350,
	"tapioca": 500,
	"suco": 400,
}


func _ready() -> void:
	var pedido := ["cuscuz", "tapioca", "suco"]
	var conta := total(pedido)
	print("Conta: ", reais(conta))
	print("Troco de R$ 20,00: ", reais(troco(2000, conta)))
	print("Uma tapioca e um suco: ", reais(total(["tapioca", "Suco"])))


## Soma o preço de todos os itens do pedido.
func total(itens: Array) -> int:
	var soma := 0
	for i in range(1, itens.size()):
		soma += PRECOS[itens[i]]
	return soma


## Quanto devolver para quem pagou "pago" por uma conta de "conta".
func troco(pago: int, conta: int) -> int:
	return conta - pago


## Escreve 1250 como "R$ 12,50".
func reais(centavos: int) -> String:
	return "R$ %d,%d" % [floori(centavos / 100.0), centavos % 100]

O gabarito, com um comentário em cada correção, está em gabarito/caixa_corrigido.gd.

Explicação do código

Gabarito dos quatro erros (para o professor):

Repare: o erro 4 só apareceu porque o erro 1 pulou o primeiro item e foi direto no segundo, "Suco". Erros escondem outros erros. Por isso se corrige um de cada vez e se roda de novo.

Resultado esperado

Os quatro erros achados e corrigidos, cada um com o registro de como foi achado. O teste automático (testes/godot/testar_caca_aos_erros.gd) confere, no gabarito, os resultados R$ 12,50, R$ 7,50, R$ 9,00, R$ 12,05 e R$ 0,05.

Problemas comuns

Exercício guiado

Por que o primeiro passo foi calcular os resultados à mão, antes de rodar? (Resposta: erro de lógica não dá mensagem; só dá para saber que a conta de R$ 9,00 está errada se alguém souber que o certo é R$ 12,50.)

Desafio individual

Esconda um erro de lógica no seu Projeto 6 (numa cópia), troque com a dupla e cronometre quanto tempo cada um leva para achar o do outro.

Desafio avançado (opcional)

Escreva um teste automático para o caixa corrigido, no mesmo estilo de testes/godot/testar_caca_aos_erros.gd, com três pedidos novos.

Critérios de avaliação

• Lê a mensagem de erro dizendo o quê, onde e quem chamou.
• Usa ponto de interrupção e lê as variáveis.
• Registro dos quatro erros com sintoma, método, causa e correção.

Checklist de conclusão

• Calculei os resultados certos antes de rodar
• Li a mensagem de erro
• Usei ponto de interrupção
• Usei print
• Corrigi os quatro erros
• Registrei no diário

Extensão

Procure nos seus projetos antigos um print esquecido. Ele atrapalha o jogo? E se o jogo for publicado?