Écrire un mini-algorithme documenté

Ce qu'il faut comprendre

Un algorithme, c'est comme une recette de cuisine : une suite d'instructions simples pour arriver à un résultat. En Python, tu vas écrire ces instructions dans un fichier .py. Mais pour que toi (ou quelqu'un d'autre) comprenne ce que fait ton programme, il faut le documenter, c'est-à-dire ajouter des commentaires et des explications. C'est ce qu'on appelle un mini-algorithme documenté.

Imagine que tu dois trier une liste de notes. Sans commentaires, ton code peut être difficile à lire. Avec des commentaires, chaque étape devient claire. En Seconde, on apprend à écrire des algorithmes simples avec des variables, des conditions (if), des boucles (for, while), et à manipuler des listes et des fichiers CSV. On va voir comment faire tout ça proprement.

Les notions essentielles

Algorithme : suite d'instructions pour résoudre un problème.
Variable : boîte qui stocke une valeur (nombre, texte, liste…). Exemple : note = 15.
Condition : instruction qui exécute un bloc si une condition est vraie (if, else).
Boucle : répète un bloc d'instructions (for pour parcourir une liste, while pour répéter tant qu'une condition est vraie).
Liste : collection ordonnée d'éléments. Exemple : notes = [12, 15, 8].
Fichier CSV : fichier texte où les données sont séparées par des virgules. On peut le lire avec Python.
Documentation : commentaires (avec #) et noms de variables explicites.

Méthode

Pour écrire un mini-algorithme documenté, suis ces étapes :

Comprendre le problème : que doit faire l'algorithme ? Quelles sont les entrées (données) et les sorties (résultats) ?
Choisir les structures : as-tu besoin d'une condition ? D'une boucle ? D'une liste ?
Écrire le code en Python : utilise des noms de variables clairs (par exemple moyenne plutôt que m).
Ajouter des commentaires : explique chaque étape importante avec #.
Tester : exécute ton programme avec des exemples pour vérifier qu'il fonctionne.

Exemple corrigé

Problème : on a un fichier CSV notes.csv avec les notes d'une classe (une note par ligne). On veut calculer la moyenne et afficher les notes supérieures à 10.

Fichier notes.csv :

Algorithme documenté :

# Programme : calcul_moyenne.py
# Auteur : Moi
# Date : 2025
# Description : lit un fichier CSV de notes, calcule la moyenne et affiche les notes > 10

# 1. Ouvrir le fichier CSV en mode lecture
fichier = open("notes.csv", "r")
contenu = fichier.read()  # lire tout le fichier
fichier.close()  # fermer le fichier

# 2. Transformer le contenu en liste de nombres
lignes = contenu.split("\n")  # séparer par les sauts de ligne
notes = []  # liste vide pour stocker les notes
for ligne in lignes:
    if ligne != "":  # ignorer les lignes vides
        note = float(ligne)  # convertir en nombre décimal
        notes.append(note)  # ajouter à la liste

# 3. Calculer la moyenne
if len(notes) > 0:  # vérifier qu'il y a des notes
    somme = 0
    for note in notes:
        somme = somme + note
    moyenne = somme / len(notes)
    print("Moyenne :", moyenne)
else:
    print("Aucune note dans le fichier.")

# 4. Afficher les notes supérieures à 10
print("Notes supérieures à 10 :")
for note in notes:
    if note > 10:
        print(note)

Explication pas à pas :

On ouvre le fichier avec open(). Le "r" signifie lecture (read).
On lit tout le contenu avec read(), puis on ferme le fichier.
split("\n") découpe le texte en une liste de lignes.
On parcourt chaque ligne : si elle n'est pas vide, on la convertit en nombre (float) et on l'ajoute à la liste notes.
Pour la moyenne, on vérifie d'abord que la liste n'est pas vide (sinon division par zéro).
On calcule la somme avec une boucle, puis on divise par le nombre d'éléments.
Enfin, on affiche les notes > 10 avec une boucle et une condition.

Erreurs fréquentes

Oublier de fermer le fichier : utilise fichier.close() ou mieux, la syntaxe with open(...) as fichier: qui ferme automatiquement.
Confondre = et == : = affecte une valeur, == compare. Exemple : if note = 10: est faux, il faut if note == 10:.
Ne pas convertir les types : les données lues d'un fichier sont des chaînes de caractères. Pense à utiliser int() ou float().
Indentation incorrecte : en Python, les blocs (dans un if, une boucle) doivent être indentés (4 espaces).
Noms de variables peu clairs : évite a, b, tmp. Préfère somme, moyenne, notes.

À retenir

Un algorithme documenté = code + commentaires clairs.
Utilise des variables explicites, des conditions, des boucles.
Pour lire un fichier CSV : open(), read(), split(), conversion.
Teste toujours ton programme avec des exemples.

Pour s'entraîner

Pour t'entraîner, rends-toi sur AlloSeconde : tu trouveras des exercices interactifs et des quiz sur les variables, les listes, les fichiers CSV et les mini-algorithmes. N'oublie pas : la pratique rend parfait !