Débogage A : ce qu'est un bug, les types d'erreurs et la lecture d'une stack trace

Qu’allons-nous apprendre ?#

• Ce qu’est un bug.
• Les trois types d’erreurs : Syntax Error, Runtime Error, Logical Error.
• Comment lire une Stack Trace (Traceback), le message d’erreur de Python.
• Les erreurs les plus courantes, et ce que dit chacune.

Pourquoi en avons-nous besoin ?#

Les développeurs passent une part énorme de leur temps à trouver et corriger des bugs. La différence entre un débutant et un professionnel n’est pas que le professionnel n’a pas de bugs, mais qu’il lit le message d’erreur et sait en quelques secondes où regarder. Les débutants voient beaucoup de texte rouge et paniquent. À la fin de la leçon, le texte rouge deviendra une carte.

Explication à partir des bases#

Qu’est-ce qu’un bug ?#

Un bug est un écart entre ce que le programme est censé faire et ce qu’il fait réellement. Parfois le programme plante, et parfois il « fonctionne » mais renvoie un résultat faux.

Les trois types d’erreurs#

Vous vous souvenez du thème sur l’ordinateur, le système d’exploitation et le réseau ? Une Syntax Error est détectée quand Python traduit en bytecode, avant l’exécution. Une Runtime Error se produit quand la PVM exécute une ligne précise et échoue.

Une Logical Error est la plus dangereuse : pas de message, pas de couleur rouge, juste un résultat faux. On ne la trouve que si l’on vérifie que le résultat est correct.

La Stack Trace — la carte de l’erreur#

Quand une Runtime Error se produit, Python affiche un Traceback (aussi appelé Stack Trace) : le chemin que le code a suivi jusqu’à l’erreur.

Traceback (most recent call last):
  File "shop.py", line 9, in <module>
    total = checkout(cart)
  File "shop.py", line 5, in checkout
    return subtotal / count
ZeroDivisionError: division by zero

Lisez-la de bas en haut :

1. La dernière ligne — le type de l’erreur (ZeroDivisionError) et le message (division by zero). Commencez toujours ici.
2. La ligne au-dessus — où exactement : le fichier shop.py, ligne 5, dans la fonction checkout, et le code lui-même.
3. Encore au-dessus — qui a appelé cette fonction : la ligne 9, au niveau supérieur du fichier (<module>).

Pourquoi « Stack » ? Parce que chaque appel de fonction est empilé sur la pile des appels (la Call Stack). Le Traceback montre la pile au moment du plantage, du premier appel (en haut) au dernier (en bas).

Les erreurs courantes en Python#

Syntaxe#

Il n’y a pas de nouvelle syntaxe. L’outil, c’est la lecture. Le modèle de tout Traceback :

Traceback (most recent call last):
  File "<file>", line <N>, in <function or <module>>
    <the code on that line>
  ...                                  ← more frames, each a function call
<ErrorType>: <message>                 ← START READING HERE

Et celui d’une Syntax Error (sans Traceback, car rien ne s’est exécuté) :

  File "<file>", line <N>
    <the code>
        ^                              ← where Python noticed the problem
SyntaxError: <message>

Premier exemple de code#

week-2/bug_report.py :

def average(numbers):
    total = sum(numbers)
    return total / len(numbers)

scores = []
print("Average score:", average(scores))

Sortie :

Traceback (most recent call last):
  File "C:\dev\kodkod6\week-2\bug_report.py", line 7, in <module>
    print("Average score:", average(scores))
                            ^^^^^^^^^^^^^^^
  File "C:\dev\kodkod6\week-2\bug_report.py", line 3, in average
    return total / len(numbers)
           ~~~~~~^~~~~~~~~~~~~~
ZeroDivisionError: division by zero

Analyse du code ligne par ligne#

Lecture du Traceback de bas en haut :

La conclusion : len(numbers) vaut 0, la liste est donc vide. Et qui a passé une liste vide ? La ligne 7 a passé scores, qui vaut []. Le vrai bug est que nous n’avons pas traité le cas d’une liste vide. La ligne qui a planté (3) est le symptôme, et décider quoi faire d’une liste vide est la correction :

def average(numbers):
    if len(numbers) == 0:
        return 0
    return sum(numbers) / len(numbers)

Un autre exemple#

Les trois types d’erreurs sur la même fonction. La fonction doit calculer un prix après une remise en pourcentage.

Syntax Error :

def price_after_discount(price, percent)
    return price - price * percent / 100

  File "discount.py", line 1
    def price_after_discount(price, percent)
                                            ^
SyntaxError: expected ':'

Il manque les deux-points. Python n’a exécuté aucune ligne.

Runtime Error :

def price_after_discount(price, percent):
    return price - price * percent / 100

print(price_after_discount("100", 10))

Traceback (most recent call last):
  File "discount.py", line 4, in <module>
    print(price_after_discount("100", 10))
  File "discount.py", line 2, in price_after_discount
    return price - price * percent / 100
                   ~~~~~~~~~~~~~~~~^~~~~
TypeError: unsupported operand type(s) for /: 'str' and 'int'

La syntaxe est valide, mais à l’exécution price est du texte. "100" * 10 « fonctionne » (cela répète le texte 10 fois !), mais ensuite la division par 100 échoue. Le ^ pointe vers le /.

Logical Error :

def price_after_discount(price, percent):
    return price - percent / 100

print(price_after_discount(100, 10))

99.9

Aucune erreur ! Mais une remise de 10 % sur 100 devrait renvoyer 90.0. Nous avons oublié de multiplier par price. Python ne peut pas savoir ce que nous voulions dire. Seule une vérification par rapport à un résultat attendu le révélera.

Erreur courante#

Erreur 1 : lire le Traceback depuis le haut, et paniquer. Commencez toujours par la dernière ligne : le type et le message. Puis la ligne au-dessus. La plupart du temps, c’est tout ce dont vous avez besoin.

Erreur 2 : corriger la ligne qui a planté, au lieu de la cause. Dans le premier exemple, une « correction » comme return total / (len(numbers) + 1) fait disparaître l’erreur, mais renvoie un résultat faux dans tous les cas ! Cela a transformé une Runtime Error en Logical Error. Encore pire.

Erreur 3 : chercher la Syntax Error uniquement sur la ligne indiquée dans le message. Parfois le problème est sur la ligne précédente :

prices = [10, 20, 30
total = sum(prices)

  File "test.py", line 1
    prices = [10, 20, 30
             ^
SyntaxError: '[' was never closed

Python est arrivé à la ligne 2, et a découvert que le crochet de la ligne 1 n’avait jamais été fermé. Dans les versions récentes, le message est précis, mais en général : si la ligne marquée semble correcte, vérifiez celle d’avant.

Exercices#

Les exercices n’utilisent que ce qui a été vu dans cette leçon et les précédentes. Essayez d’abord seul, et n’ouvrez la solution qu’ensuite.

Exercice 1: Quel type d’erreur ?#

Pour chaque extrait — s’agit-il d’une SyntaxError, d’une Runtime Error ou d’une Logical Error ? Et quel est le problème ?

# A
if age > 18
    print("adult")

# B
print(total_price)        # total_price was never defined

# C
def area(width, height):
    return width + height   # should be the area of a rectangle

Exercice 2: Lire une Stack Trace#

Traceback (most recent call last):
  File "shop.py", line 12, in <module>
    print(checkout([20, 30], 0))
  File "shop.py", line 7, in checkout
    return average_price(prices, count)
  File "shop.py", line 3, in average_price
    return sum(prices) / count
ZeroDivisionError: division by zero

1. Quel est le type de l’erreur et quel est le message ?
2. Dans quel fichier, à quelle ligne et dans quelle fonction s’est-elle produite ?
3. D’où venait la valeur problématique ?

Exercice 3: Un bug logique dans une conversion de température#

def to_celsius(fahrenheit):
    return fahrenheit - 32 * 5 / 9

print(to_celsius(212))
print(to_celsius(32))

Les résultats devraient être 100 et 0, mais autre chose sort. Trouvez le bug et corrigez-le.

Résultat attendu :

100.0
0.0

def to_celsius(fahrenheit):
    return (fahrenheit - 32) * 5 / 9


print(to_celsius(212))
print(to_celsius(32))

100.0
0.0

Exercice 4: TypeError#

age = 25
print("Age: " + age)

1. Quelle erreur obtiendrez-vous, et pourquoi ?
2. Corrigez-la de deux façons différentes.

Résultat attendu :

Age: 25

age = 25
print("Age: " + str(age))

Age: 25

age = 25
print("Age:", age)

Age: 25

Exercice 5: La moyenne d’une liste vide#

def average(numbers):
    return sum(numbers) / len(numbers)

print(average([80, 90]))
print(average([]))

1. Que se passera-t-il lors du second appel, et quelle erreur obtiendrez-vous ?
2. Corrigez la fonction pour qu’elle renvoie 0 pour une liste vide.

Résultat attendu :

85.0
0

def average(numbers):
    if len(numbers) == 0:
        return 0
    return sum(numbers) / len(numbers)


print(average([80, 90]))
print(average([]))

85.0
0

Résumé#

• Bug = un écart entre le comportement voulu et le comportement réel.
• Syntax Error — avant l’exécution, aucune ligne ne s’exécute. Runtime Error — au milieu de l’exécution, avec un Traceback. Logical Error — pas de message, juste un résultat faux.
• Lisez un Traceback de bas en haut : type + message → ligne et fonction → qui a appelé.
• La ligne qui a planté n’est parfois que le symptôme. Cherchez la cause.
• Les Logical Errors ne se découvrent qu’en comparant un résultat avec une valeur attendue.

Documentation officielle#

• Python Tutorial — Syntax Errors
• Python Tutorial — Exceptions
• Built-in Exceptions