Règles de codage
Les règles de codage qui suivent décrivent la manière dont Glasnost doit être codé (et non pas forcément la manière dont elle est codée en ce moment.)
Commentaires
- Les commentaires doivent être écrits en Anglais.
- Lorsque vous détectez un problème dans le code source et que vous ne pouvez pas le corriger tout de suite, faites le précéder d'un commentaire commençant par « FIXME » (écrit de cette manière exactement).
Importation de modules Python
- Toutes les commandes import doivent être placés dans l'entête du fichier Python.
- Ne jamais utiliser l'instruction from ... import *. Utiliser plutôt import ... as .... Par exemple import glasnost.common.tools_new as commonTools.
- Ne plus rien ajouter dans les différents fichiers tools.py. Ces fichiers sont en effet importés par un from tools import * et sont appelés à disparaître. Utiliser les fichier tools_new.py (qui seront renommés par la suite en tools.py).
Divers
- Quand le contexte n'est pas passé en paramètre, vous devez utiliser getGlobalContext(), pour retrouver le contexte dans lequel l'application (que ce soit un serveur XML-RPC ou le serveur web ou ...) s'exécute en ce moment.