Votre code Python est-il lisible ?

Alors que je me lance dans l'apprentissage du codage Python, je fais attention aux détails de la façon dont mon code est écrit. Pas seulement sa fonctionnalité, mais en veillant à ce que mon code respecte les meilleures pratiques et puisse être facilement interprété par d'autres. Il s'agit d'une habitude importante à incorporer, donc si une application Web est créée ou si une partie d'une base de code est écrite à l'avenir, d'autres ingénieurs en logiciel peuvent facilement voir ce que fait le code et le travail peut être révisé. Je me suis référé au PEP 8 Style Guide for Python code pour avoir une image plus claire de ce à quoi ressemblent les meilleures pratiques de codage Python.

En Python, les espaces sont généralement préférés aux tabulations. Si vous choisissez de le faire, vous pouvez utiliser du code, mais les tabulations et les espaces ne doivent pas être mélangés ! L'importance de la cohérence sera un thème récurrent dans ce blog. Pour les humains, il est plus facile pour nous de lire le contenu et de le comprendre s'il est cohérent. L'identification doit être composée de quatre espaces. Dans l'exemple ci-dessous, print est en retrait de 4 espaces à partir du début de la première ligne.

En Python, une ligne doit être limitée à 75 caractères. Si votre code dépasse la limite de 75 caractères, vous pouvez utiliser un retrait suspendu pour déplacer votre code débordant vers la ligne suivante et vous assurer qu'il est toujours lisible. Pour la gestion des retraits, la priorité est d'aligner le code débordant avec son homologue sur la ligne précédente afin qu'il soit plus facile à lire. Par conséquent, les retraits suspendus n'ont pas besoin d'être en retrait de quatre espaces. Vous trouverez ci-dessous un exemple de code débordant utilisant un retrait suspendu.

Les espaces blancs supplémentaires entre les parenthèses et la ponctuation doivent également être évités. Je dois parfois me rappeler que j'écris du code, pas un dissertation. Vous trouverez ci-dessous un exemple flagrant d'espace blanc. En général, il est recommandé de relire votre code pour vous assurer qu'un espace supplémentaire ne s'est pas glissé dans votre code par accident.

Enfin, il est important que le code Python contienne des commentaires et que ces commentaires soient faciles à lire. Les commentaires Python doivent être écrits en phrases complètes et doivent commencer par une majuscule, à moins que le premier mot ne soit une variable en minuscule. S'il y a plusieurs phrases dans un commentaire, il devrait y avoir deux espaces après un point. (Ma pratique de dissertation est enfin utile ici !). Les commentaires sont particulièrement importants s'il existe une section de code dont l'objectif n'est pas clair.

Il y a des cas où le PEP 8 Style Guide n'a pas de préférence. Dans ces cas, vous pouvez choisir la façon dont vous souhaitez styliser votre code, mais vous devez vous efforcer de toujours être cohérent. N'oubliez pas que la cohérence est la clé !

Sources:

Cinq conseils pour améliorer la lisibilité de votre code Python. Ingénierie pour la science des données

https://engineeringfordatascience.com/posts/top_tips_for_improving_python_code_without_refactoring/