Salut les amis ! Dans cet article, nous allons nous concentrer sur une fonction explicative importante de Python – la fonction Python help().

Nécessité de la méthode help()

Lorsque nous codons dans un langage de programmation particulier, il est très essentiel pour nous de connaître la documentation de base du langage encadré. C’est à ce moment que la fonction help() entre en jeu.

Cette fonction nous fournit la documentation de base du langage Python. Elle nous donne les informations sur les méthodes et les instances associées à une méthode ou à une classe particulière.

La méthode help() fonctionne avec des mots-clés, des Classes, des fonctions et des modules pour nous aider à acquérir les terminologies de base, les instances et le travail qui y sont attachés respectivement.

En général, le help() method est utilisé aux côtés de l’interprète Python pour avoir accès aux détails sous-jacents sur les objets Python qui lui sont passés en paramètre.

Fonctionnement de la méthode Python help()

Comme mentionné ci-dessus, la méthode help() fournit des informations sur les objets Python qui lui sont passés.

Si le help() function est mentionné sans aucun paramètre, il démarre la console de l’interpréteur dans laquelle nous pouvons mentionner n’importe quel module, objets, classe, etc pour disposer de la documentation à ce sujet.

Exemple :

help()

Sortie:

Fonction Python help() avec une classe

La fonction help peut être alimentée avec des paramètres personnalisés ou prédéfinis pour travailler avec. Nous pouvons créer une classe personnalisée et la passer à la fonction help() pour examiner la documentation fournie par la fonction.

Exemple:

class Info: lang = "Python" name = "JournalDev"obj = Info()help(Info)

Nous avons créé une classe définie par l’utilisateur et l’avons passée à la fonction help(). La fonction help() a renvoyé la documentation nécessaire de la classe ‘Info’.

Sortie:

Help on class Info in module __main__:class Info(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | lang = 'Python' | | name = 'JournalDev'

Fonction Python help() avec une fonction

La fonction help() nous aide à accéder à la syntaxe, à la liste des paramètres et à la description concernant toute fonction qui lui est passée en utilisant la commande ci-dessous.

Syntaxe:

help('function-name')

Exemple 1:

help('getattr')

Sortie:

Exemple 2:

help('map')

Sortie :

Fonction Python help() avec un module

Nous pouvons obtenir des informations sur le module en utilisant la fonction help(). Lorsqu’un module est passé à la fonction help(), celle-ci fournit la documentation en termes de version, d’emplacement de fichier, de contenu du module et de données qui lui sont associées.

Syntaxe:

help('module-name')

Exemple:

help('seaborn')

Sortie :

La fonction help() avec un mot-clé

En passant un mot-clé Python en paramètre à la fonction help(), celle-ci renvoie la documentation en termes de classe du mot-clé, des méthodes qui lui sont associées, etc.

Syntaxe:

help('keyword-name')

Exemple 1:

help(True)

Sortie:

Exemple 2 :

help(int)

Sortie:

Conclusion

Parce que nous sommes arrivés à la fin de ce sujet. Nous avons compris le besoin et le fonctionnement de la fonction help(). J’espère que ce concept est clair pour tous les lecteurs.