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 essentielle de l’écriture du code. Vous donnez des noms aux variable, aux fonctions, aux class et à bien plus encore...
Python propose quelques styles de nommage recommandés :
| Type | Convention | Exemple |
|---|---|---|
| Variable | Snake case | x, index, max_number |
| Function | Snake case | calculate, convert_to_int |
| Class | Pascal case | Person, JavaCompiler |
| Method | Snake case | print, make_sound |
| Constant | 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
Voici un exemple plus détaillé de l’utilisation de tous ces styles 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 présents 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/une class.
Essayez vous-même
Cette leçon ne comprend pas de défi de code.
Toutes les leçons de Clean Code - Écrire un meilleur code avec Python
Entraînez-vous par vous-même : Compilateur Python en ligne