Pratique de nommage pour les objets d'une classe en Python

Question

J'ai ce problème étrange de savoir comment nommer les objets d'une classe.

Par exemple, considérons la classe:

>>> class DoSomething: 
     pass 

Que dois-je appeler l'objet de cette classe? do_something ou quoi? Depuis que je suis sorti de l'apprentissage, j'avais l'habitude d'utiliser x, y ou z ou tout ce qui me venait à l'esprit. Mais maintenant que j'apprends à écrire le bon code et pas la langue, je suis toujours confronté à ce problème. Aucune suggestion?

Answer 1

Nommez-le quelque chose de représentatif de ce qu'il est réellement utilisé. Par exemple:

class Cereal: 
    def eat(self): 
     print 'yum' 

breakfast = Cereal() 
breakfast.eat() 

ou

class User: 
    def __init__(self, userid): 
     # ... 

admin_user = User(ADMIN_ID) 

Answer 2

Vous devriez le nommer après ce qu'elle représente. Par exemple, si j'ai une classe User dans une application Web et que je veux faire référence à l'utilisateur actuellement connecté, je nomme la variable current_user.

Et si vous avez plus d'objets d'une classe, votre approche échoue immédiatement. Donner à la variable un index comme do_something1, do_something2n'est pas et ne sera jamais une option.

Utilisez quelque chose signifiant, afin qu'un lecteur de votre code sache ce que cette variable représente.

---

Btw. ceci s'applique à tous les langages de programmation, pas seulement Python.

Answer 3

Une bonne pratique de dénomination consiste à donner plusieurs noms à des collections telles que des ensembles et des listes.