Programmation PYTHON - Zenk - Security - Repository

Conventions de codage
CHAPITRE 7
Sur le matériel actuel, les développeurs qui travaillent avec des éditeurs comme
Emacs ou Vim alignent généralement deux terminaux.
Cette taille limite de 80 caractères reste de toute manière un standard immuable et
défini par défaut dans la plupart des éditeurs Python.
Pour les lignes dépassant la limite, il est nécessaire d’utiliser :
un saut de ligne dans une séquence d’éléments entre parenthèses, accolades ou
crochets ;
des antislash (\) ou des parenthèses supplémentaires;
puis d’indenter correctement le code passé à la ligne.
Exemples de passage à la ligne
Commentaires
def _layout_modified(self, REQUEST, RESPONSE, type_id,
layout_index=1, is_flexible=False):
"""Modifie le layout à la volée."""
if layout_index == 1 and is_flexible and self.step == 12 and \
type_id != 4:
self._modify(type_id)
elif layout_index == 1 and is_flexible and (self.step == 13
X and type_id = 3):
self._modifyAll(type_id)
else:
self._modifyAll(13)
À SAVOIR Éditeurs Python
Les éditeurs qui gèrent Python proposent parfois une gestion automatique du passage à la ligne.
La bonne quantité de commentaires est en général assez difficile à trouver et dépend
de plusieurs facteurs :
la personnalité du développeur ;
la nature du code ;
le rythme du projet.
Le développeur qui entame un projet est toujours plus bavard dans ses commentaires
que celui qui essaye de terminer dans les temps.
Enfin, l’utilisation de plus en plus fréquente des doctests, décrits au chapitre 12, qui
donnent directement des exemples d’utilisation du code, réduit considérablement le
besoin de certains types de commentaires.
199