Programmation PYTHON - Zenk - Security - Repository

Choix de la langue
Conventions de codage
CHAPITRE 7
Python est un langage écrit en anglais et tous ses éléments sont des mots anglais.
L’anglais étant de plus la langue universelle de l’informatique, il est vivement conseillé
de l’adopter pour tous les noms si le contexte le permet.
Il est aussi nécessaire de maîtriser l’anglais utilisé pour éviter des franglismes ou des
fautes d’orthographe qui peuvent prêter à confusion sur le sens des noms.
Unicité des noms
Une fois un nom choisi, il doit être utilisé et écrit de la même manière dans tout le
programme, dans la documentation et dans les spécifications techniques. Il faut
absolument éviter d’utiliser plusieurs noms différents pour parler de la même chose.
La bonne longueur
Utiliser des abréviations pour les noms n’est pas une bonne idée. Les noms trop
courts perdent du sens et deviennent vite anonymes. Lorsque l’on recherche une
variable nommée cpt dans le code, on risque d’être noyé sous les résultats.
Des noms trop longs ne sont pas non plus conseillés, à l’instar des noms à rallonge
que l’on trouve en Java.
La bonne longueur est donc un nom court mais précis, et non abrégé.
Éviter le mélange domaine/technique
Les termes techniques de Python peuvent être : dictionnaire, dico, liste, collection,
tuple, etc.
Les termes du domaine peuvent être : article, rayon, catalogue, etc.
Pour éviter de rendre le code illisible, il ne faut jamais mélanger les deux ensembles
pour composer des noms comme : dico_article, tuple_rayon, etc.
Règles pour chaque type
Modules
Le nom d’un module doit informer sur son contenu et rester homogène, lorsque le
cas se présente, aux autres modules du même paquet ou du même thème.
Un module de client sftp s’appellera logiquement sftplib, en continuité avec
ftplib, httplib, imaplib, etc.
213