Twitter iPhone pliant OnePlus 11 PS5 Disney+ Orange Livebox Windows 11

pydoc et variables membre

1 réponse
Avatar
Guillaume Lemaître
Bonjour,

N'étant pas débutant programmeur, mais débutant python, je me pose
certaines questions dont la réponse est certainement triviale pour qui
sait. Entre autres, je n'ai pas trouvé comment ajouter un commentaire
pydoc à une variable membre de classe. Le seul moyen détourné que je
connaisse est de ne pas publier la variable mais d'avoir des accesseurs
sur celle-ci.

N'y a-t-il pas mieux que ça ?

Guillaume

1 réponse

Avatar
Bruno Desthuilliers
Guillaume Lemaître a écrit :
Bonjour,

N'étant pas débutant programmeur, mais débutant python, je me pose
certaines questions dont la réponse est certainement triviale pour qui
sait. Entre autres, je n'ai pas trouvé comment ajouter un commentaire
pydoc à une variable membre de classe.



Un peu (même complètement) HS, mais bon: l'expression "variable membre
de classe" est du jargon C++ ou Java, pas du jargon Python. En Python,
on parle d'attributs, pas de "variable membre", et on fait la
distinction entre "attributs de classe" (ie : appartenant à l'objet
classe concerné, et partagés par toutes les instances de la classe) et
"attributs d'instance" (appartenant en propre à l'instance). Et
accessoirement, les attributs incluent les méthodes...

Donc quand tu parles de "variable membre de classe", je ne sais pas si
tu penses à un attribut de classe ou a un attribut d'instance.

Le seul moyen détourné que je
connaisse est de ne pas publier la variable mais d'avoir des accesseurs
sur celle-ci.

N'y a-t-il pas mieux que ça ?



Documenter ton API dans la docstring de la classe, tout simplement.