Python peut parfois sembler compliqué ou bien incompréhensible. Ceci peut être expliqué par la propension des élèves à ne chercher que la fonctionnalité dans Python, sans faire attention à « l’esthétique » et aux standards de présentation du programme, le rendant plus lisible et facile à comprendre. Dans cet article, nous aborderons « l’esthétique » avec un angle d’attaque bien plus pratique. Ceci permet de gagner du temps lors d’un exercice long, où plusieurs scripts sont requis, ou tout simplement de montrer sa connaissance de Python.
Il est une large part des standards de présentation de Python qui ne sont pas connus, mais qui devraient l’être, afin de faciliter la lecture ou la relecture – par le professeur – d’un programme.
Constantes
Les variables globales, qui resteront constantes et que l’on ne changera jamais, comme une liste donnée par l’énoncé d’un exercice, doivent respecter certains standards :
- Ces variables doivent être écrites en majuscules.
- Ces variables se situent en dessous de l’importation des librairies.
- Ces variables doivent être séparées par deux lignes vierges du reste du programme.
Ainsi, un script comme celui qui suit ne convient pas :
Il faut en fait modifier selon les règles susmentionnées, ce qui donne :
Librairies
Un standard similaire au précédent s’applique aux librairies, à savoir une injonction forte à séparer les librairies – leur importation – et la définition des constantes par deux lignes vierges.
Signes
Les signes mathématiques, comme « = », « == », « != », ou bien l’addition par exemple, représentent bien la règle suivante de présentation :
- Il faut un espace avant et après chaque signe mathématique (même une virgule « , » dans une liste qui nécessite un espace après !), sauf si ce sont deux signes qui se suivent.
Ainsi, une petite opération, comme ajouter quelque chose à la fin d’une liste :
Ce code deviendra :
« : »
Il faut ici simplement mettre un espace après le symbole « : », notamment dans les dictionnaires.
Parenthèses
Il est aisé de remarquer la place prépondérante que prend le parenthésage dans le langage informatique. En Python, même si ce parenthésage n’est pas aussi important qu’en C, ou en C++, ou bien même C#, il reste important et est la cause de nombreuses erreurs.
N.B. : les extraits de code montrés ici sont une production personnelle et ne reflètent pas la complexité du programme. Autrement dit, ne pas s’affoler si cela semble compliqué : il faut juste regarder les parenthèses.
En règle générale, il est conseillé de décomposer un « double parenthésage » qui est long comme suit :
La décomposition doit donc devenir :
N.B. : ce code n’est pas au programme et est issu d’une composition personnelle.
Évidemment, cela demande un tout petit peu plus de travail, mais rend le code extrêmement lisible et esthétiquement plaisant.
Lignes trop longues
On ne souhaite pas avoir, en informatique, des lignes de code trop longues. Cela est gênant pour la relecture et demande un effort de plus quand on se relit. Effort qui n’est donc pas centré sur le repérage des erreurs.
Heureusement, il y a la solution en Python à ce problème, à savoir : le symbole « \ ».
Voici un exemple de code « coupé » :
Conclusion
En appliquant ces standards de présentation, les erreurs se feront plus rares et ta compréhension du langage devrait être décuplée par ce nouveau processus de pensée. Car écrire pour faire beau n’est pas le but : le but est de transformer la vision et la pensée du langage en en voyant toutes les facettes pour mieux avancer.
Pour voir toutes nos autres ressources en Python, clique ici.
