Python Code Style Guide

Guide de style pour le code Python

Style guidelines are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. The PEP 8 - Style Guide for Python Code: https://peps.python.org/pep-0008/ is the most widely used style guide at the moment.

Le code FASTSUITE utilise principalement le style de nommage CapitalizedWords (ou CapWords, ou CamelCase), il est donc recommandé de suivre ce style dans tous les projets clients.

Recommandations générales de style CENIT

noms de classes et de fonctions

• Les noms de classes et de fonctions devraient normalement utiliser la convention CapWords, par exemple MaPremièreClasse ou MaPremièreFonction.

Noms de variables

• Variables locales : localVariable
• Variables globales dans un module : GlobalVariable
• Constantes : CONSTANT_VARIABLE
• Variables privées : _semiPrivate et __superPrivate

Commentaires et descriptions

Please use autoDocstring extension (see Recommended VS Code extensions).

• Les classes et fonctions doivent être documentées avec des guillemets triples, par exemple """Description"""
• Les hashtags doivent être utilisés uniquement pour les commentaires en code en ligne : # Commentaire

Code sample

• Please see one of the cenpylib classes as an example.