Programmation PYTHON - Zenk - Security - Repository

Modules
Conventions de codage
CHAPITRE 7
Avant de présenter les différentes conventions, voici quelques définitions :
CapitalizedWords : nom composé d’un ou plusieurs mots attachés dont chaque
première lettre est en majuscules ;
mixedCase : CapitalizedWords dont la première lettre est en minuscules ;
lowercase : nom composé d’un ou plusieurs mots attachés dont toutes les lettres
sont en minuscules ;
lowercase_words : nom composé d’un ou plusieurs mots séparés par des espaces
soulignés, dont toutes les lettres sont en minuscules ;
UPPERCASE_WORDS : nom composé d’un ou plusieurs mots séparés par des
espaces soulignés, dont toutes les lettres sont en majuscules.
Ces différentes écritures peuvent êtres appliquées à trois familles de noms :
les modules ;
les classes ;
les fonctions et variables globales d’un module, les méthodes et attributs d’une
classe.
Les modules doivent êtres écrits en lowercase. Il faut cependant veiller à ne pas utiliser
des noms de plus de huit caractères pour éviter par exemple, que votre code qui fonctionne
parfaitement sous GNU/Linux, ne marche plus sous certaines versions de
MS-DOS à cause de problèmes d’importation.
La recommandation précédente était de nommer les modules de deux manières différentes
suivant leur appartenance à une des deux sous-familles de modules :
les bibliothèques ;
les modules de classe.
Les bibliothèques sont des modules contenant un certain nombre de fonctions et de
classes. C’est le cas par exemple d’imaplib, de smtplib, ou encore de gzip.
Les modules de classe sont des modules qui ne contiennent qu’une seule classe et
quelques éléments supplémentaires comme des définitions de constantes. Le module
porte en général le même nom que la classe qu’il contient et utilise une notation
CapitalizedWords.
Il est préconisé aujourd’hui, outre le fait d’abandonner la notation CapitalizedWords, de
ne plus créer un module par classe mais de préférer un regroupement logique des classes,
à différencier du regroupement fonctionnel proposé par les modules de type bibliothèques.
Ce regroupement est en général défini par les relations entres classes : une classe de
base et ses classes dérivées, les classes en charge du même lot de fonctionnalités, etc.
205