Trouver linformation des module, des fonctions et du code Python
Lorsque lon commence avec un nouveau langage de programmation, linformation et le découverte du langage passe par un ensemble de documentations : manuels, prise en main rapide, découvertes et exemples. Python, lu, apporte aussi des particularités fort intéressantes du point de vue de la connaissance, apprentissage et même compréhension du langage.
Dans vos « Bonnes Pratiques », commenter vos codes doit se faire naturellement, mais ici avec Python, ceux-ci peuvent aussi se synthériser pour vos futurs manuels utilisateurs et/ou de mainteneurs
Python a une documentation interne, que lon peut appeler avec la variable spéciale __doc__ pour quasiment chaque fonction, méthode ou objet interne à python (builtin).
Pour y accéder dans linterpréteur :
print str.__doc__
Cest intéressant si lon connait le nom de lobjet qui nous intéresse bien sûr !
Pour connaître toutes les variables et méthodes associées à un objet, on utilise la fonction dir():
dir(str) dir(list)
Et pour connaître la liste des éléments au coeur de python :
dir(__builtins__)
LA commande Help est aussi utilisable depuis linterpréteur.
Installez le paquet python-doc (sous debian/ubntu) et vous aurez également accès à une documentation complète (/usr/share/doc/python-doc/html/index.html).
En particulier, /usr/share/doc/python-doc/html/lib/lib.html contient tous les détails nécessaires sur les éléménts par défaut de python.