Guide de style de code Python

Guide de style pour le code Python

Les lignes directrices de style visent à améliorer la lisibilité du code et à le rendre cohérent sur l’ensemble du large spectre du code Python. Le PEP 8 – Guide de style pour le code Python :

https://peps.python.org/pep-0008/

est le guide de style le plus utilisé à ce jour.

FASTSUITE code 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 fonctions

• Les noms de classes et fonctions doivent 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

Veuillez utiliser

autoDocstring

extension (voir

[Extensions VS Code recommandées] (./debugging-vscode)

).

• 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 : # Commenter

Exemple de code

• Veuillez prendre l’une des classes cenpylib comme exemple.