Conventions de style
Mise en page
- Utiliser 4 espaces par niveau d’indentation. (Sous Spyder : Préférences > Éditeur > Options avancées > Caractères d’indentation : 4 espaces.)
- Limiter la longueur des lignes à 79 caractères. (Sous Spyder : Préférences > Éditeur > Affichage, puis
- Afficher une ligne verticale après 79 caractères, et enfin
- Retour à la ligne automatique.)
Espaces
- Ne jamais insérer d’espaces dans les situations suivantes :
- directement à l’intérieur de parenthèses ou de crochets ;
- avant une virgule ;
- avant la parenthèse annonçant la liste des arguments d’une fonction ;
- avant le crochet annonçant un indice ou une tranche dans une liste.
- Toujours insérer un espace après une virgule.
- Toujours insérer un espace de chaque côté des opérateurs suivants :
- affectation (=) ;
- comparaison (==, <, >, !=, <=, >=) ;
- opérateurs booléens (and, or, not).
- Entourer les opérateurs mathématiques binaires (+, *, -, /, %, //) d’au plus un espace de chaque côté, en mettant en évidence les priorités relatives entre opérateurs.
Documentation et commentaires
- Commenter de sorte de rendre plus clair ce qui est déjà écrit.
- Tout commentaire doit être rédigé dans un français correct. Privilégier des phrases complètes.
Noms de variables et de fonctions
- Plus les objets sont utilisés à des endroits éloignés les uns des autres, plus leur nom doit être évocateur.
À proscrire
- from module import *
- if test == True
- liste = liste + [valeur]