Guide de style (PEP8)

Cette spéfification réalise une proposition sur la manière d’organiser et formater du code Python, quelles sont les conventions pour l’indentation, le nommage des variables et des classes, … Il s’agit d’une proposition concrète concernant la lisibilité du code - sachant que du code est plus lu qu’écrit (ce qui nous ramène à la notion d’environnement.

En bref, elle décrit comment écrire du code proprement, afin que d’autres développeurs puissent le reprendre facilement, ou simplement que votre base de code ne dérive lentement vers un seuil de non-maintenabilité. Comme l’indique la PEP20, Readibility counts. Ceci implique de garder une cohérence dans l’écriture du code, dont les principales recommandations concernent:

• Le layout général du code: indentation, longueur de ligne, séparateurs de lignes, encodage des fichiers sources et gestion des imports.
• La gestion des commentaires, en fonction de leur emplacement : blocs de commentaires, commentaires embarqués ou documentation.
• Les conventions de nommage : les noms à éviter, comment nommer une classe, une fonction ou une variable, un paquet, les exceptions ou les constantes.
• Des recommandations de programmation, concernant le typage statique.

Pour vous aider dans cette tâche, il existe plusieurs outils qui s’occuperont de lister l’ensemble des conventions qui ne seraient pas correctement suivies, le plus connu est https://pypi.org/project/pycodestyle/.