it-swarm-eu.dev

Python convention de dénomination des fichiers?

J'ai vu cette partie de PEP-8 https://www.python.org/dev/peps/pep-0008/#package-and-module-names

Je ne sais pas si cela fait référence au nom de fichier d'un module/classe/package.

Si j'avais un exemple de chacun, les noms de fichiers devraient-ils être en minuscules avec des traits de soulignement, le cas échéant? Ou autre chose?

164
darkace

Citation https://www.python.org/dev/peps/pep-0008/#package-and-module-names :

Les modules doivent avoir des noms courts tout en minuscules. Les traits de soulignement peuvent être utilisés dans le nom du module s'il améliore la lisibilité. Python doivent également avoir des noms courts tout en minuscules, bien que l'utilisation de soulignements soit déconseillée.

Pour classes :

Les noms de classe doivent normalement utiliser la convention CapWords.

Et noms de fonction et de variable (locale) devrait être:

en minuscules, les mots étant séparés par des traits de soulignement si nécessaire pour améliorer la lisibilité

Voir cette réponse pour la différence entre un module, une classe et un package:

  • Un module Python est simplement un fichier source Python, qui peut exposer des classes, des fonctions et des variables globales).
  • Un package Python est simplement un répertoire de modules Python).

Donc PEP 8 vous dit que :

  • les modules (noms de fichiers) doivent avoir des noms courts tout en minuscules, et ils peuvent contenir des traits de soulignement;
  • les packages (répertoires) doivent avoir des noms courts, tout en minuscules, de préférence sans traits de soulignement;
  • les classes doivent utiliser la convention CapWords.

PEP 8 indique que les noms doivent être court; cette réponse donne un bon aperçu des éléments à prendre en compte lors de la création de noms de variables, qui s'appliquent également à d'autres noms (pour les classes, les packages, etc.):

  • les noms de variables ne sont pas des descripteurs complets;
  • mettre des détails dans les commentaires;
  • un nom trop spécifique peut signifier un code trop spécifique;
  • garder des portées courtes pour une recherche rapide;
  • passer du temps à penser à la lisibilité.

Pour terminer, un bon aperçu des conventions de dénomination est donné dans le Google Python Style Guide .

171
agold

Ici est un lien pour différents types de conventions de nom Python).

Le guide de style pour Python est basé sur les recommandations de la convention de nommage de Guido.

enter image description here

7
Vlad Bezden