Programmation PYTHON - Zenk - Security - Repository

212
Éléments du langage
DEUXIÈME PARTIE
Structuration d’une classe
class RPCDataStream(BaseDataStream):
"""Classe pour les flux RPC."""
Cette notation permet de renforcer la visibilité lorsque les modules commencent à
faire une certaine taille.
Quoi qu’il en soit, des méthodes ou des modules anormalement longs sont bien souvent
le témoin d’une mauvaise architecture, et un éclatement est en général à envisager.
Conseils pour le choix des noms
Le choix des noms, que ce soit pour les classes, variables, méthodes, ou tout autre
élément du code, doit être fait en gardant à l’esprit que le programme n’est pas destiné
à être lu par des ordinateurs, mais par des développeurs ou des clients.
L’ordinateur n’attache aucune importance aux noms choisis pour les variables, le
développeur en charge de la correction du module quant à lui peut vivre un véritable
cauchemar si les variables trouvées dans le programme s’appellent toujours a, b et c.
Règles générales
def _fonction_interne1(self):
...
def _fonction_interne2(self):
...
#
# API public
#
def read_stream(self):
"""Lecture d'un flux RPC."""
...
Du sens
Un nom doit être porteur de sens. Hormis quelques exceptions comme le nom de
certaines variables utilisées dans des boucles, un nom doit informer sur la nature de
l’élément qu’il désigne.