Bien nommer ses variables en Python

Les conventions de nommage des variables en Python rendent votre code lisible et compréhensible. Elles permettent de suivre un ensemble de règles et de pratiques recommandées pour donner des noms significatifs à vos variables. Dans cet article, nous allons explorer à la fois la syntaxe obligatoire et les conventions préconisées par PEP et Google.

    3gms 5gms 6gms 4gms 3ttr

Syntaxe Obligatoire

En Python, il existe quelques règles de syntaxe obligatoires que vous devez respecter lors de la déclaration de vos variables :

  1. Les noms de variables doivent commencer par une lettre (a-z, A-Z) ou un trait de soulignement (_), aussi appelé "tiret du bas" ou "🇬🇧 underscore"). Par exemple, nom_variable est valide, mais 1variable ne l'est pas.

  2. Les noms de variables ne peuvent contenir que des lettres, des chiffres (0-9) et des traits de soulignement (_). Les caractères spéciaux comme les espaces ou les symboles sont interdits. Par exemple, ma_variable_1 est valide, mais ma variable ! ne l'est pas.

  3. Les noms de variables sont sensibles à la casse. Cela signifie que ma_variable et Ma_Variable sont considérés comme deux variables distinctes.

  4. Vous ne pouvez pas utiliser un mot réservé de Python comme nom de variable. Par exemple, print, if,.... sont des noms de variables incorrects.

Conventions Préconisées

Il existe également des conventions de codage pour le langage Python pour le nommage des variables. Les conventions présentées ici sont celles préconisées par la communauté de développeurs Python.

Ces conventions de nommage sont facultatives mais fortement recommandées. Si chacun est libre d'utiliser ses propres conventions, utiliser des conventions "reconnues" internationalement rendront votre code plus lisible pour les autres.

Peu importe les conventions que vous utilisez, l'important est d'être cohérent dans votre code, votre projet et dans votre équipe. Choisissez votre convention une fois pour toutes et respectez-la.

Voici quelques-unes des conventions de nommage généralement recommandées pour les variables :

  1. Utiliser des noms de variables en minuscules avec des traits de soulignement ("tirets du bas", 🇬🇧 underscores) pour séparer les mots. Par exemple, ma_variable_de_test plutôt que MaVariableDeTest.

💡 Quand on écrit un nom de variable avec des tirets du bas, on appelle ça du "snake case".

  1. Pour les constantes, utilisez des majuscules avec des traits de soulignement. Par exemple, VALEUR_MAXIMALE plutôt que valeur_maximale.

  2. Éviter d'utiliser des caractères uniques comme noms de variables, sauf pour des variables temporaires. Par exemple, i est couramment utilisé pour les indices dans les boucles, mais il est préférable d'utiliser un nom plus descriptif pour les variables importantes.

  3. Soyez descriptif dans le choix des noms de variables. Un nom de variable comme compteur est plus informatif que simplement c.

  4. De manière générale, on évite les articles dans les noms: aire_du_rectangle -> aire_rectangle

Conclusion

En conclusion, les conventions de nommage des variables en Python sont essentielles pour maintenir un code propre et lisible. En suivant la syntaxe obligatoire et en adoptant les conventions préconisées par la communauté, vous faciliterez la compréhension de votre code par vous-même et par les autres développeurs. N'oubliez pas que la cohérence est essentielle, alors choisissez une convention et suivez-la tout au long de votre projet.

Pratique

Exercice : Nommer les Variables en Respectant les Conventions Python

Vous allez vous entraîner à nommer des variables en respectant les conventions de nommage en Python. Ces conventions aident à rendre votre code plus clair, lisible et maintenable.

En Python, les variables doivent être nommées en utilisant le style snake_case, c'est-à-dire avec des mots en minuscules séparés par des underscores _. Par exemple, pour "Le nombre de kilomètres parcourus", on utilise km_parcourus.

Consignes

Pour chaque phrase ci-dessous, trouvez un nom de variable approprié en respectant les conventions Python.

  1. Le nombre total d'élèves dans la classe
  2. La longueur du rectangle en centimètres
  3. La largeur de la salle de sport
  4. Le poids de l’objet en kilogrammes
  5. Le montant total des achats
  6. La température de l'eau en degré Celsius
  7. La vitesse maximale autorisée sur la route
  8. Le nombre d'articles en stock
  9. Le nom du professeur principal
  10. L’âge de l'utilisateur
  11. La durée du trajet en heures
  12. Le niveau de batterie du téléphone
  13. La date de naissance de l'utilisateur
  14. Le pourcentage de réussite de l'examen
  15. Le nom de la ville de résidence
  16. Le nombre de pages dans le livre
  17. La quantité de sucre en grammes
  18. Le prix d'un billet de cinéma
  19. La taille de l'écran en pouces
  20. Le taux de croissance de la population
  21. Le code postal de l'adresse
  22. Le nombre de jours de vacances
  23. La distance entre deux villes en kilomètres
  24. Le numéro de la carte d'identité
  25. Le niveau sonore en décibels
  26. Le temps de réponse du serveur en millisecondes
  27. Le prix de vente d'un produit
  28. Le nombre de personnes présentes dans la salle
  29. Le taux d'inflation annuel
  30. La durée de vie moyenne d'une pile en heures

Exemple de réponse attendue :

  • Pour "Le nombre de kilomètres parcourus", la variable est km_parcourus.
  • Pour "La température extérieure", la variable est temperature_exterieure.

Objectif

Entraînez-vous à bien nommer les variables de façon claire et explicite pour que d'autres développeurs puissent comprendre facilement à quoi elles servent.


N.B. : Dans cet exercice, il n'est pas nécessaire d'implémenter un programme en Python ; concentrez-vous uniquement sur le nommage des variables en respectant les conventions de style Python.

Pour aller plus loin