Mise en œuvre d'un projet informatique

Définir et conduire un projet informatique. On y montrera les outils nécessaire à tout projet : un linter et une bibliothèque de tests.

Un projet informatique a un début, lorsque l'on crée le dossier qui va le contenir, mais il n'a que rarement de fin : il y a toujours des fonctionnalités à ajouter et des bugs à corriger. Enfin, et c'est le plus important, un code est fait pour être utilisé.

De ces deux constatations, on en déduit trois règles fondamentales d'un code utile. Il faut qu'il soit :

• juste pour des utilisateurs puissent s'en servir
• facilement modifiable pour que l'ajout et la correction de fonctionnalités soient aisés
• lisible pour soi et pour les autres membres de l'équipe de développement

Le langage d'application n'a que peu d'intérêt en soit. On choisit celui qui est le plus adapté à notre but. Ici, on utilisera le python mais tout ce qu'on verra est transposable pour tout autre langage sérieux. L'éditeur de texte que l'on utilisera sera vscode. Il en existe d'autres très bien aussi et tout ce qu'on verra avec vscode (les raccourcis claviers, et aides au développement) sont transposables à d'autres éditeurs en lisant la doc.

Un projet

On va créer un projet pour comprendre comment tout ça fonctionne.

Nous allons préparer le projet dans lequel nous allons coder. Ceci se fait avec vscode en ouvrant un dossier. Ce dossier sera le départ de votre projet et s'appelle workspace.

Fichier python

On va créer notre premier fichier python :

Vscode à compris que c'était du python, il l'écrit dans la barre de statut (la dernière ligne, en bleu, de la fenêtre vscode, voir user interface).

Exécution d'un fichier

print("bonjour les gens !")

En vous rappelant ce que vous avez vu dans le tutorial python et vscode :

Du joli code

Vous allez passer beaucoup de temps à lire du code, le votre et celui des autres. Il est important que ce soit facile. Pour cela il faut que le style de code soit cohérent. Python donne des règle de style, c'est ce qu'on appelle la PEP8.

Linter

Un linter est un programme permettant de signaler les erreurs de style pour les corriger. Installer un linter vous permet de vous familiariser avec les règles d'un joli code.

Il existe de nombreux linter, nous allons utiliser flake8 qui s'intègre bien avec vscode.

Installation

Utilisation

Vérifions qu'il remarque bien les fautes :

print ("bonjour les gens !")

Une fois le fichier sauvé vous devriez voir que l'espace entre print et la parenthèse est souligné en rouge :

On peut cliquer sur la status-bar pour voir l'erreur ou passer le curseur sur la partie rouge :

Vous devriez peut-être aussi avoir la parenthèse de fin souligné en jaune. C'est parce que la dernière ligne de votre fichier n'est pas vide. Si ce n'est pas le cas, c'est que vous avez bien que 2 lignes dans votre fichier, la seconde étant vide.

Tout au long de ce projet et des prochains, il faut faire en sorte qu'il n'y ait jamais d'erreur de style. Soyez donc vigilant au début avant que cela devienne naturel.

black

Il existe des outils permettant de formatter automatiquement le code, comme l'utilitaire black par exemple.

Une fois black installé, vous pouvez l'utiliser depuis un terminal ou depuis vscode.

Séparer code et main

Pour séparer les différentes parties vous allez :

Fichier le_code.py :

def bonjour():
    return "Bonjour les gens !"

Fichier main.py :

from le_code import bonjour

print(bonjour())

On a importé le nom bonjour défini dans le fichier le_code.py grâce à un import. L'autre façon aurait été d'importer juste le fichier code. On aurait alors eu :

import le_code

print(le_code.bonjour())

La notation pointée se lit alors : exécute le nom bonjour définit dans le_code.py.

Tests

Les tests permettent de vérifier que notre code fonctionne. Ils font partie du programme et on peut s'y référer quand on veut. Lorsque l'on modifie le code, on pourra toujours exécuter tous les tests pour vérifier que notre programme fonctionne aussi bien qu'avant.

La commande assert

On utilise en python la commande assert. Elle fonctionne ainsi :

assert <expression logique>

Si l'expression logique est vraie, le programme continue sans rien dire et si l'expression logique est fausse, le programme s'arrête avec l'erreur : AssertionError.

Essayons ça avec la plus simple des expressions logiques : True

print("avant l'assert")

assert True

print("après l'assert")

Lorsque vous exécutez ce fichier, vous devez obtenir le résultat suivant :

avant l'assert
après l'assert

La condition logique étant vraie, la commande assert n'a rien fait.

Changeons ça en mettant une condition logique fausse :

print("avant l'assert")

assert False

print("après l'assert")

Vous devez obtenir le résultat suivant :

avant l'assert
Traceback (most recent call last):
  File "/Users/fbrucker/Documents/temp/hello-dev/test_projet.py", line 3, in 
    assert False
AssertionError

La première ligne a bien été exécutée (on voit écrit avant l'assert), puis le programme a planté. La condition logique étant fausse, la commande assert a levé une exception nommée AssertionError qui a stoppé l'exécution du programme. La ligne print("après l'assert") n'a pas été exécutée.

D'habitude, nos expressions logiques vérifie qu'un comportement observé (l'exécution d'une fonction) est conforme au comportement théorique (le résultat qu'on aimerait avoir). Pour ne pas se perdre on range ce test dans une fonction dont le nom décrit le test. Par exemple, testons la somme :

def test_somme_neutre():
    tête_a_toto = 0
    assert 0 + 0 == tête_a_toto

def test_somme_1_plus_0():
    assert 0 + 1 == 1


def test_somme_1_plus_2():
    assert 1 + 2 == 3
 

Pour tester la somme, j'ai décidé de faire 3 tests :

• le cas le plus simple où il ne se passe rien (0 + 0 = 0)
• un cas simple (0 + 1 = 1)
• un cas général (1 + 2 = 3)

Lorsque l'on exécute ce code, il ne se passe rien. Est-ce bon signe ?

# ...

def test_somme_neutre():
    tête_a_toto = 0
    assert 0 + 0 == 42

# ...

Le code s'exécute encore encombre. Bon, là, c'est pas normal car 0 + 0 ne peut être égal à 42.

La raison est que test_projet.py définit des fonctions mais il ne les exécute jamais. Les trois fonctions de test sont définies mais jamais utilisées.

On a donc 2 choix :

• exécuter les fonctions dans le fichier après les avoir définies
• utiliser un module que le fait pour nous

Nous allons utiliser la seconde option avec le module Pytest.

Installation de la bibliothèque de tests

Utilisation de la bibliothèque de tests

On y reviendra à de nombreuses reprises :

Les tests sont de petites fonctions dont le but est de tester une fonctionnalité du programme (souvent le résultat de l'exécution d'une fonction). Le test consiste en une assertion que l'on veut être vraie si que le code fonctionne. Si l'assertion est fausse c'est qu'il y a un bug.

Vous devriez obtenir quelque chose du genre :

Que fait pytest :

On peut aussi exécuter les tests directement avec vscode. Pour cela, cliquez sur le petit erlenmeyer. Vous pourrez ensuite :

1. découvrir les tests du projet
2. exécuter tous les tests
3. n'exécuter qu'un seul test

Test du projet

Notre projet contient pour l'instant une fonction qui rend une constante. Tester une constante n'a pas de sens, modifions notre code pour que notre fonction ait plus de sens :

def bonjour(nom):
    return "bonjour " + nom + " !"

On peut maintenant remplacer les tests :

from le_code import bonjour


def test_bonjour():
    assert bonjour("monde") == "bonjour monde !"

Maintenant que les tests passent, on peut modifier le programme principal.

from le_code import bonjour

print(bonjour("monde"))

Félicitations, vous avez fait votre premier projet fonctionnel !

Les fichiers

Les trois fichiers du projet final sont disponibles