Un projet avec des tests

Un projet informatique va toujours avoir 3 types de fichiers :

• le fichier à exécuter pour lancer notre programme, couramment appelé main.py. Ce fichier doit uniquement contenir des interaction avec l'utilisateur.
• Toutes les fonctions internes au programme, sont regroupées dans un fichier (ou un ensemble de fichiers)
• Tous les tests des fonctions internes au programme, sont regroupées dans un fichier (ou un ensemble de fichiers)

Par exemple, considérons un programme qui va chiffrer un message selon le code de césar.

Le projet

Du point de vue de python un projet est un dossier qui va contenir les différents fichiers python. Appelons le chiffre_cesar.

Téléchargez le projet :

Le programme principal

Le programme principal est le fichier que l'on va exécuter, on a coutume de l'appeler main.py

Dans notre cas, notre programme est :

fichier main.py :

import texte
from chiffre import césar_chiffre, césar_déchiffre

entrée = input("Tapez une chaîne de caractères en français : ")
texte = texte.conversion(entrée)


clé = input("Tapez une lettre de l'alphabet (clé de chiffrement) : ")
chiffre = césar_chiffre(texte, clé)
déchiffre = césar_déchiffre(chiffre, clé)

print("Texte initial   :", texte)
print("Texte chiffré   :", chiffre)
print("Texte déchiffré :", déchiffre)

On voit que ce fichier demande des choses à un utilisateur et utilise deux importations (texte et chiffre) qui correspondent à nos fichiers de fonctions.

Pour exécuter le fichier, on utilise le terminal dans le dossier du projet :

$> python main.py
Tapez une chaîne de caractères en français : Éléonore m'adore !           
Tapez une lettre de l'alphabet (clé de chiffrement) : F
Texte initial   : ELEONORE M'ADORE !
Texte chiffré   : JQJTSTWJ R'FITWJ !
Texte déchiffré : ELEONORE M'ADORE !

Exécutez le projet :

Fichiers de fonctions

Les deux imports du programme principal correspondent aux fichiers texte.py et chiffre.py qui sont dans le même dossier que notre programme principal. Ces deux fichiers contiennent toutes les fonctions nécessaire à l'exécution du programme principal.

Chaque fichier va contenir un ensemble de fonctions de buts similaires.

Fonctions texte

Fichier texte.py :

import unicodedata


def conversion(texte_avec_accent):
    liste_glyphes_unicode = list(unicodedata.normalize("NFKD", texte_avec_accent))

    liste_caractères = []
    for c in liste_glyphes_unicode:
        if not unicodedata.combining(c):
            liste_caractères.append(c)
    
    chaîne_sans_accent = "".join(liste_caractères)
    texte_en_majuscule = chaîne_sans_accent.upper()

    return texte_en_majuscule

Ce fichier continent une unique fonction dont le but est de convertir un texte écrit en français dans le même texte en majuscule et sans accents.

On voit que ce fichier dépend d'un module python nommé unicodedata, qui permet de gérer les chaînes de caractères Unicode. Essayez de comprendre comment fonctionne la fonction conversion.

Fonctions chiffre

Fichier texte.py :

ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"


def césar_chiffre(texte, cle):

    décalage = ALPHABET.index(cle)
    texteCesar = ""
    for x in texte:
        if x in ALPHABET:
            texteCesar += ALPHABET[(ALPHABET.index(x) + décalage) % 26]
        else:
            texteCesar += x

    return texteCesar


def césar_déchiffre(texte, cle):

    décalage = ALPHABET.index(cle)
    texteCesar = ""
    for x in texte:
        if x in ALPHABET:
            texteCesar += ALPHABET[(ALPHABET.index(x) - décalage) % 26]
        else:
            texteCesar += x

    return texteCesar

Les deux fonctions du fichiers chiffre.py sont là pour chiffrer et déchiffrer un message selon le code de César.

Fichiers de tests

L'usage veut que l'on utilise un fichier de test par fichier de fonctions.

Pour que pytest puisse comprendre que ce sont des fichiers de textes, on fait commencer les noms de fichiers par test_

On exécute nos tests dans un terminal dont le dossier courant est le dossier du projet :

python -m pytest
============================= test session starts ==============================
platform darwin -- Python 3.14.2, pytest-9.0.1, pluggy-1.6.0
rootdir: ./chffre-cesar
collected 8 items                                                              

test_chiffre.py .....                                                    [ 62%]
test_texte.py ...                                                        [100%]

============================== 8 passed in 0.04s ===============================

Ouf, tout est ok.

Exécutons les tests du projet :

Ce que l'on teste est dépendant de chaque développeur : si les tests passent il doit être convaincu que son code est fonctionnel.

Tests des fonctions de texte

Fichier test_texte.py :

from texte import conversion


def test_conversion_minuscules_vers_majuscule():
    assert "ABCDE" == conversion("abcde")


def test_conversion_avec_espaces():
    assert "AB CD" == conversion("ab cd")


def test_conversion_avec_accents():
    assert "ABC DE" == conversion("ÀBÇ dè")

Tests des fonctions de chiffre

Fichier test_chiffre.py :

from chiffre import césar_chiffre, césar_déchiffre

def test_césar_chiffre():
    assert "A B" == césar_chiffre("A B", "A")
    assert "D F" == césar_chiffre("B D", "C")
    assert "Z A" == césar_chiffre("A B", "Z")


def test_césar_déchiffre():
    assert "A B" == césar_déchiffre("A B", "A")
    assert "B D" == césar_déchiffre("D F", "C")
    assert "A B" == césar_déchiffre("Z A", "Z")

Liste des fichiers du projet

Le projet final contient 5 fichiers :

• chiffre.py
• main.py
• test_chiffre.py
• test_texte.py
• texte.py

Qui se séparent en :

• un programme principal,
• deux fichiers de fonctions,
• deux fichiers de tests, un par fichier de fonctions.