Conventions de nommage
Leçon 3 sur 28 du cours Clean Code - Écrire un meilleur code avec Python de Coddy.
Le nommage est une partie cruciale de l'écriture de code. Vous donnez des noms aux variables, fonctions, classes et plus encore...
Python introduit quelques styles de nommage suggérés :
| Type | Convention | Exemple |
|---|---|---|
| Variable | Snake case | x, index, max_number |
| Fonction | Snake case | calculate, convert_to_int |
| Classe | Pascal case | Person, JavaCompiler |
| Méthode | Snake case | print, make_sound |
| Constante | Snake case (tout en majuscules) | PI, MAX_TIMEOUT, MIN_AGE |
| Module | Snake case | script.py, my_app.py |
| Package | Snake case (sans underscores) | package, mypackage |
- Snake case (snake_case) - Lettres minuscules, mots séparés par des underscores.
- Pascal case (PascalCase) - Mots commençant par une majuscule.
Exemple plus détaillé utilisant tout cela ensemble :
import my_module
class ImportantClass:
MY_CONSTANT = 3.14
def good_function(self, variable):
return variable
def better_function(self):
return MY_CONSTANT
def __name__ == '__main__':
var = my_module.secret()
important_class = ImportantClass()
important_class.good_function(var)
print(important_class.better_function())
Remarquez tous les différents types ici !
Le saviez-vous ? La différence entre une fonction et une méthode est qu'une méthode est une fonction associée à un objet ou une classe.
Essayez vous-même
Cette leçon ne comprend pas de défi de code.