HELP |
Aide |
|---|---|
| Python Version 2.2 ou supérieur | |
Syntaxe
| help() |
| help(objet) |
Paramètres
| Nom | Description |
|---|---|
| objet | Ce paramètre optionnel permet d'indiquer un objet à analyser. Si aucun paramètre n'est spécifié, le système d'aide interactif démarre sur la console d'interprétation. Si le paramètre est une chaîne de caractères, la chaîne de caractères est recherchée comme le nom d'un module, d'une fonction, d'une classe, d'une méthode, d'un mot clef ou d'une rubrique de documentation, et une page d'aide est affichée sur la console. Si le paramètre est tout autre type d'objet, une page d'aide sur l'objet est générée. |
Description
Cette fonction permet de demander le message d'aide, intégré, associé à l'objet.
Algorithme
|
MODULE HELP(objet) * Vérifier si l'objet est nul SI objet est nul ALORS Afficher "Aucune information disponible pour cet objet." RETOURNE FIN SI * Vérifier si l'objet est un module ou un objet ayant de l'aide associée SI objet a une méthode __doc__ ALORS afficher objet.__doc__ FIN SI * Afficher des informations supplémentaires selon l'objet SI objet est un module ALORS Afficher des informations supplémentaires sur le module SINON SI objet est une classe ALORS Afficher la hiérarchie de classes et les méthodes SINON SI objet est une fonction ou méthode ALORS Afficher la signature et la documentation de la fonction SINON Afficher "Aucune information d'aide spécifique pour cet objet." FIN SI |
Remarques
- Cette fonction est destinée à une utilisation interactive. Si aucun paramètre n'est fourni, le système d'aide interactif démarre sur la console d'interprétation. Si le paramètre est une chaîne de caractères, la chaîne de caractères est recherchée comme nom d'un module, de fonction, de classe, de méthode, de mot clef ou de sujet de documentation, et une page d'aide est affichée sur la console. Si le paramètre est un autre type d'objet, une page d'aide sur l'objet est générée.
- Cette fonction est ajoutée à l'espace de noms intégré par le module site.
- La fonction help est une nouveauté de la version 2.2 de Python.
Dernière mise à jour : Mercredi, le 14 septembre 2016