Organiser son code en Python

Bonjour.

Je rédige ce cours pour donner des conseils sur la méthode de rédaction de ces scripts en Python. Car il ne faut pas oublier que ce code doit pouvoir être lu facilement par quelqu’un d’autre, et il doit donc respecter quelques normes.

1 : Organiser son code en Python

1.1 : Commenter

Une première règle, présente pour tous les langages de programmation, est le placement de commentaire. Pour rappel, un commentaire est une ligne de code qui est ignorée par l’interpréteur. Elle ne sert qu’à donner une indication rapidement sur un élément de votre script (Pourquoi telle variable existe, pourquoi on utilise cette fonction, pourquoi cette opération, pourquoi ci, pourquoi ça…)

Un commentaire en Python se forme de cette manière :

# Ceci est un commentaire

En plaçant un croisillon (Ou dièse, ou hashtag, comme vous voulez !), la ligne ne génèrera pas d’erreur. Elle sera ignorée. Il peut-être utile de commenter afin de présenter une variable :

#Gère l'argent du joueur
money = 150
#Gère la vie du joueur
health = 100

 

print("Chose")

Ici, ces commentaires sont obsolètes : les noms des variables décrivent déjà l’utilité de celle-çi.

Les commentaires ne sont pas à prendre à la légère : ils peuvent être aussi importants que le code lui-même !

1.2 : Aérer son code

Ici, c’est simple à comprendre, il suffit de vous montrer un comparatif. Vous préférez ça :

import os
from random import *
score = 0
rejouer = 1
while rejouer == 1:
    number1 = randrange (1,10)
    number2 = randrange (1,10)
    print("Tu veux réviser :")
    print("Les additions : 1")
    print("Les multiplications : 2")
    exercice = int(input("1 ou 2 :  "))
    print()
    if exercice == 1:
        print("Combien font ", number1, "+", number2, " ?")
        answer = int(input())
        if answer == number1 + number2:
            print("yes, it's easy, on continue")
            score = score+1
            print (score)
            print()
        else:
            rejouer = int(input("pff... 1 pour essayer à nouveau : "))
    elif exercice == 2:
        print("Combien font ", number1, "x", number2, " ?")
        answer = int(input())
        if answer == number1 * number2:
            print("yes, it's easy, on continue")
            score = score+1
            print(score)
            print()
        else:
            rejouer = int(input("pff... 1 pour essayer à nouveau : "))
print("Tu as fait ", score, "bonnes réponses à la suite")
if score < 2:
    print("C'est pas brillant")
print("A bientôt")

Ou ça :

import os
from random import *
 
score = 0
rejouer = 1
 
while rejouer == 1:
 
    number1 = randrange (1,10)
    number2 = randrange (1,10)

    print("Tu veux réviser :")
    print("Les additions : 1")
    print("Les multiplications : 2")

    exercice = int(input("1 ou 2 :  "))
    print()
 
 
    if exercice == 1:
        print("Combien font ", number1, "+", number2, " ?")
        answer = int(input())
        if answer == number1 + number2:
            print("yes, it's easy, on continue")
            score = score+1
            print (score)
            print()
        else:
            rejouer = int(input("pff... 1 pour essayer à nouveau : "))
 
 
    elif exercice == 2:
        print("Combien font ", number1, "x", number2, " ?")
        answer = int(input())
        if answer == number1 * number2:
            print("yes, it's easy, on continue")
            score = score+1
            print(score)
            print()
        else:
            rejouer = int(input("pff... 1 pour essayer à nouveau : "))
 
print("Tu as fait ", score, "bonnes réponses à la suite")
 
if score < 2:
    print("C'est pas brillant")
 
print("A bientôt")

L’essentiel à retenir : sauter des lignes afin de séparer des blocs de codes qui n’ont aucun rapport.