help()
Affiche la documentation intégrée d’un objet, d’une fonction ou d’un module.
- Renvoie
None(la documentation est affichée).
Exemple
#def award(name, exp=10):
"""Attribue des points d’expérience à un élève."""
return f"{name}: +{exp} EXP"
help(award)Le résultat contient la signature award(name, exp=10) et la description du docstring. L’apparence exacte dépend de la version de Python.
Définition et utilisation
#La fonction help() affiche la documentation de l’objet donné : une description de son fonctionnement, ses paramètres et ses méthodes disponibles. Elle fonctionne avec les fonctions intégrées, les modules, les classes et votre propre code.
La documentation de vos propres fonctions vient des chaînes de documentation (docstrings) placées au début d’une fonction ou d’une classe. help() les affiche avec la signature.
En mode interactif, appeler help() sans argument ouvre un navigateur d’aide, que l’on quitte en tapant q ou quit.
Syntaxe
#help(object)Paramètres
#object
optionnel
Une fonction, un module, une classe, ou une chaîne donnant le nom d’un sujet.
Plus d’exemples
#def award(name, exp=10):
"""Attribue des points d’expérience à un élève."""
print(award.__doc__)Bonnes pratiques
#- Écrivez des docstrings pour vos fonctions.
help()et les éditeurs de code les montreront aux autres développeurs. - Pour vérifier rapidement la liste des méthodes d’un objet, utilisez
dir().
Entrées associées
#Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.