Programmation PYTHON - Zenk - Security - Repository

Conventions de codage
CHAPITRE 7
layoutdef = {'ncols': 1, 'rows': []}
rows = []
for item in layout.objectIds():
element = {}
element['widget_id'] = item[3:] # retrait du préfixe "w__"
element['ncols'] = 1
rows.append([element])
layoutdef['rows'] = rows
# appel au moteur de rendu
layout.set_layout_definition(layoutdef)
Les blocs servent aussi comme en-têtes des modules pour insérer les informations de
licence, de copyright et autres éléments spécifiques et communs à tous les fichiers du
projet, comme nous le verrons dans la structure d’un module en fin de chapitre.
Enfin, les notes de développement sont souvent des commentaires avec un préfixe
particulier (FIXME:, TODO: ou XXX:).
Commentaire de développement
[...]
def afficher(self, taille):
""" affichage """
# FIXME: A quoi sert cette variable ?
i = 12
for u in range(taille):
print str(u)
[...]
BONS USAGES Soigner les commentaires
Un soin tout particulier doit être apporté aux commentaires pour la valorisation à long terme du code.
Lors d’étapes de refactoring ou d’outsourcing, qui peuvent survenir des mois, voire des années après la
création initiale, les modules peu ou mal commentés sont en général très rapidement jetés aux oubliettes.
Documentation strings ou docstrings
Il est recommandé de fournir un docstring pour tous les éléments de code, exceptés
les méthodes privées. La raison est que l’interpréteur Python lit ces docstrings et les
associe pour chaque élément commenté à un attribut spécial __doc__. Cet attribut est
utilisé dans certains cas lors d’interactions entre l’utilisateur et le programme et
devient parfois obligatoire. Par exemple, dans une application Zope 2, une méthode
d’une classe sans docstring ne pourra pas être appelée par le biais de l’interface web.
201