Sommaire

Écrire un code cohérent et homogène

Python est un langage qui demande une importante d’écriture pour obtenir un code fonctionnel. Un respect de l’indentation du code est une condition nécessaire pour avoir un script qui s’exécute proprement.

La communauté Python produit des documents nommés PEP qui contiennent un ensemble de règles de bonne conduite en termes de syntaxe, de méthodologie, d’usage. Ces documents sont le fruit de débats de la communauté et font consensus. Le PEP 8 est particulièrement intéressant pour le débutant. Ce document contient l’ensemble des recommandations liées à la façon d’écrire le code : PEP 8

  • disposition du code

  • espace entre les expressions

  • commentaires

  • compatibilité des versions

  • conventions de nommage

  • recommandations de programmation

Il existe différents outils pour vérifier que les règles PEP 8 ont bien été respectées par le développeur. C’est le cas de l’utilitaire Flake8.

Pour l’installer :

python -m pip install flake8

Pour vérifier un fichier avec Flake8 :

flake8 <monfichier.py>

Pour vérifier un ensemble de fichiers présents dans un dossier :

flake8 <chemin_vers_mon_dossier>

Soit le script nommé script_non_pep8.py, dont le code est le suivant :

print( "Ceci est un script non PEP8" ) 
 
val = 0

Exécutons Flake8 ...