Anatomie de la structure d’un programme Python

Aujourd’hui nous allons voir ensemble l’anatomie et la structure d’un programme Python. Tout d’abord, structurer son code le rendre plus lisible pour vous et pour les autres. De plus, le fait de structurer votre programme vous permettra de retrouver plus facilement les briques de code.

L’entête

Il existe plusieurs façons de déterminer une entête. Les Python Enhancement Proposals (PEP) et notamment la PEP 256 donne des conseils concernant les entêtes. Lorsque vous créerez des programmes que vous diffuserez vous pourrez suivre les recommandes concernant les « docstrings ». Cependant, dans un premier, nous allons rester simple. L’entête comportera le type d’encodage utilisé dans le document, par défaut UTF-8 puis la date ainsi que l’auteur. De plus, il est vivement recommandé d’écrire en une ligne ou deux ce que réalise votre programme. Si vous utilisez un environnement de développement comme VScode ou Spyder, le logiciel doit vous insérer l’entête automatiquement.

# -*- coding: utf-8 -*-
"""
Created on ....

@author: ...

The purpose of this program is to ... 
"""

Les librairies

Ensuite, vous allez importer toutes les librairies dont vous aurez besoin dans votre programme. Si vous n’avez pas importé la librairie et que vous essayez d’appeler un module de celle-ci, vous obtiendrez une erreur donc autant le faire dès le début du programme. Les regrouper au début permet de ne pas importer plusieurs la même librairie (ce qui n’est pas source d’erreur en soit).

import os # Pour travailler avec le système d'exploitation de votre ordinateur
import pandas as pd # Pour analyser les données via l'utilisation des dataframes
import matplotlib.pyplot as plt # Pour tracer des graphiques
import numpy as np # Pour réaliser des calculs sur les données

Les fonctions

L’étape suivante consiste à définir les fonctions dont vous aurez besoin dans votre programme. Au tout début, vous ne connaitrez pas votre besoin en terme de fonction mais sachez que celle-ci doivent être définies avant de pouvoir les utiliser. Elles doivent donc être écrites avant d’en faire l’appel. Cette zone de votre programme sera donc dédiée à vos fonctions.

def addition(a,b):
  return a + b
def multiplication(a,b):
  return a * b

Vos fonctions peuvent aussi se trouver dans un autre fichier. Ceci permet de réduire la taille de votre fichier principal. Il faudra alors comme pour les librairies importer vos fonctions. Par exemple, supposons que nous avons créé les deux fonctions précédentes dans les fichiers « fonctions.py ». Vous pourrez alors appeler vos fonctions comme ceci :

from fonctions import addition
from fonctions import multiplication

import fonctions

Ou tout simplement :

import fonctions

Cependant, cette dernière solution ne rend pas explicite les fonctions ou module qui seront utilisés dans votre programme.

La déclaration des variables de base

J’ai fait exprès de ne pas utiliser le terme variable globale. En effet, par définition, une variable globale est accessible à partir de n’importe quelle fonction du programme. Utiliser des variables globales n’est pas préconisé. L’utilisation de variable globale nuit à la lisibilité et vous risquez de provoquer des erreurs inattendues si vous changez sa valeur dans une fonction locale. Si une variable est nécessaire dans votre code, faites la passer en argument mais n’utilisez pas de variable globale.

Voici quelques exemples de variables de base :

fichier = "nom_du_fichier.txt"
chemin = "C:\\dossier1\\dossier2"

intervalle = 10
temps_max = 10000

Comme vous pouvez le voir dans les exemples, ces variables sont là pour structurer et définir la base du programme.

Votre programme principal

Voilà maintenant la section où vous pourrez écrire votre code pour définir la structure globale de votre programme. N’oubliez de mettre des commentaires pour aider à la compréhension de votre code. De plus, faites en sorte d’avoir des fonctions simples. Une fonction simple est une fonction qui ne fait qu’une seule tâche. Une fonction est dite simple si son nombre d’arguments ne dépasse le nombre de 5 ou 6.

Conclusion

Vous avez maintenant une base pour commencer à coder dans de bonnes conditions. Afin de peaufiner votre manière d’écrire du code, je vous invite également à lire cet article sur les bonnes pratiques pour la programmation avec Python.

N’oubliez pas de mettre des commentaires dans votre code, c’est très important. Et pour terminer cette conclusion, voici une trame que vous pourrez utiliser dans vos prochains codes.

# -*- coding: utf-8 -*-
"""
Created on ....

@author: ...

The purpose of this program is to ... 
"""

# Librairies

# Fonctions

# Variables de base

# Programme princpal

Merci de m’avoir lu, n’hésitez pas à laisser un commentaire, j’y répondrai avec plaisir.
A bientôt,
Benjamin