Le PEP 8 : guide de style pour le code Python

Indentation, espacement et longueur des lignes : la structure visuelle de votre code

Le PEP 8 définit des règles précises pour l'indentation, l'espacement et la longueur des lignes, afin de rendre le code Python plus lisible et plus cohérent.

L'indentation est cruciale en Python, car elle définit la structure des blocs de code (contrairement à d'autres langages qui utilisent des accolades). Le PEP 8 recommande d'utiliser 4 espaces pour chaque niveau d'indentation, et de ne jamais utiliser de tabulations.

L'espacement est également important pour la lisibilité. Le PEP 8 recommande de mettre un espace après une virgule, un espace autour des opérateurs binaires (+, -, *, /, ==, !=, etc.), et pas d'espace après une parenthèse ouvrante ou avant une parenthèse fermante.

La longueur des lignes est limitée à 79 caractères (ou 72 caractères pour les docstrings et les commentaires). Cela permet d'afficher le code confortablement sur la plupart des écrans, et de faciliter la comparaison de code (par exemple, lors de revues de code).

Nous verrons des exemples de code qui respectent (et qui ne respectent pas) ces règles, et comment utiliser un éditeur de code ou un IDE pour vous aider à les suivre.

Conventions de nommage (variables, fonctions, classes, etc.) : choisissez des noms clairs et cohérents

Le PEP 8 définit des conventions de nommage pour les différents éléments de votre code (variables, fonctions, classes, modules, constantes, etc.). Ces conventions ne sont pas obligatoires (votre code fonctionnera même si vous ne les suivez pas), mais elles sont fortement recommandées, car elles rendent votre code plus lisible et plus compréhensible pour les autres développeurs Python (et pour vous-même, dans le futur !).

Voici les principales conventions de nommage :

• Variables et fonctions : utilisez des noms en minuscules, avec des mots séparés par des tirets bas (`snake_case`). Par exemple : `ma_variable`, `calculer_moyenne`. Eviter d'utiliser une seule lettre, sauf pour les index ou les variables temporaires sans grande importance.
• Classes : utilisez des noms en CamelCase (chaque mot commence par une majuscule, sans espaces ni tirets bas). Par exemple : `MaClasse`, `CalculateurMoyenne`.
• Constantes : utilisez des noms en majuscules, avec des mots séparés par des tirets bas. Par exemple : `MA_CONSTANTE`, `PI`.
• Modules : utilisez des noms en minuscules, courts et si possible sans tiret bas.
• Privé : Le nom des attributs, méthodes, fonctions et variables locales qui ne doivent pas être utilisés en dehors du cadre où ils sont définis doit commencer par un caractère de soulignement `_`.

En plus de ces conventions, il est important de choisir des noms descriptifs, qui indiquent clairement le rôle de l'élément. Evitez les abréviations obscures et les noms trop génériques.

Nous verrons des exemples de bons et de mauvais noms, et comment choisir des noms qui rendent votre code plus clair.

Organisation du code et commentaires : structurez et expliquez votre code

Le PEP 8 donne également des recommandations sur l'organisation du code et l'utilisation des commentaires.

Il est recommandé de séparer les différentes parties de votre code par des lignes vides, pour améliorer la lisibilité. Par exemple, vous pouvez laisser deux lignes vides entre les définitions de fonctions de haut niveau ou de classes, et une ligne vide entre les définitions de méthodes à l'intérieur d'une classe.

Il est également recommandé d'importer les modules au début du fichier, en les regroupant par catégories (modules de la bibliothèque standard, modules tiers, modules locaux).

Les commentaires sont essentiels pour expliquer votre code. Le PEP 8 recommande d'utiliser des commentaires pour expliquer les parties complexes de votre code, les algorithmes, les choix de conception, etc. Les commentaires doivent être clairs, concis et précis, et ils doivent être mis à jour lorsque vous modifiez votre code.

Il est préférable d'utiliser des phrases complètes pour les commentaires, et de les écrire en anglais (sauf si vous êtes sûr que votre code ne sera jamais lu par des personnes qui ne parlent pas votre langue).

Nous verrons des exemples de code bien organisé et bien commenté, et des conseils pour écrire des commentaires efficaces.