Aide Python()

Comme la plupart des codeurs, je consulte régulièrement un moteur de recherche - ouais, comme s'il y avait beaucoup de bonnes options ;) - pour en savoir plus sur les listes de paramètres de fonctions Python spécifiques. Si vous vous tenez vraiment sur les épaules de géants et exploitez les puissantes bibliothèques Python développées par certains des meilleurs codeurs au monde, l'étude de l'API des fonctions existantes devrait constituer une partie élémentaire de votre travail de codage quotidien.

help() intégré de Python La fonction lance le système d'aide de Python. Sans argument, help() démarre une session interactive. Avec un argument de chaîne, help(name) recherche le nom et affiche une page d'aide sur le shell. Avec un argument non-chaîne, help(object) imprime une page d'aide sur l'objet.

>>> help(list)             # Prints the documentation of list
>>> help(dict)             # Prints the documentation of dict
>>> help(int)              # Prints the documentation of int
>>> help('help')           # Prints the documentation of help()
>>> help()                 # Opens an interactive "help" session

Aide sur la syntaxe()

Le help() objet a la syntaxe suivante :

Syntax: 
help()               # Opens an interactive help session to explore multiple objects
help(string)         # Looks up the name and prints a help page to the shell
help(object)         # Prints a help page on object

Arguments	`object`	Facultatif. Si donné, imprime une page d'aide sur l'objet. S'il s'agit d'une chaîne, il recherche le nom de mappage -> objet et imprime la page d'aide sur l'objet. S'il n'est pas fourni, ouvre une session d'aide interactive.
Valeur de retour	`None`	Renvoie `None` .

Aide sur la valeur de retour()

Le help(object) la fonction renvoie None .

Exemple help() sans Argument

Sans argument, help() démarre une session interactive.

>>> help()

Welcome to Python 3.7's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.7/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help> string
Help on module string:

NAME
    string - A collection of string constants.

DESCRIPTION
    Public module variables:

Dans cet exemple, vous avez créé la session d'aide interactive et transmis la chaîne de nom (qui est un objet) dans la session. Python imprime ensuite la documentation associée. Vous pouvez fermer la session d'aide interactive en appuyant sur CTRL + C ou tapez quit , puis appuyez sur enter .

Exemple help() avec argument de chaîne

Avec un argument de chaîne, help(name) recherche le nom et imprime une page d'aide sur le shell.

>>> help('help')
	       
Help on module help:

NAME
    help

DESCRIPTION
    help.py: Implement the Idle help menu.
    Contents are subject to revision at any time, without notice.
...

Vous pouvez vous demander :où Python recherche-t-il les objets associés à chaque valeur de chaîne ?

La réponse est simple :à l'aide d'espaces de noms, il recherche les noms des modules, des fonctions, des méthodes, des variables dans les chemins Python. Étant donné le nom, il peut alors obtenir les objets associés à partir du mappage de la mémoire - chaque nom pointe vers un objet en mémoire.

Vous pouvez en savoir plus dans nos tutoriels complets :

locaux Python()
Globales Python()
Les espaces de noms Python simplifiés

Exemple help() avec argument d'objet

Avec un argument non-chaîne, help(object) imprime une page d'aide sur l'objet.

>>> help(print)
	       
Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

L'objet fonction passé associé au print name fonctionne également comme entrée pour le help() fonction. Dans ce cas, aucune recherche n'est nécessaire, mais la documentation de l'objet transmis est imprimée immédiatement.

Python help() Function Docstring

help(object) de Python La fonction renvoie la docstring associée à l'objet. La docstring est une chaîne qui suit immédiatement la définition d'un module, d'une fonction, d'une méthode ou d'un objet.

Voici un exemple de définition d'une fonction add() avec une docstring :

def add(a, b):
    '''Calculates a+b and returns the sum.'''
    return a+b

Et voici comment vous pouvez y accéder dans votre code via le help(add) appel de fonction :

>>> help(add)
Help on function add in module __main__:

add(a, b)
    Calculates a+b and returns the sum.

De cette façon, vous pouvez écrire votre propre documentation et permettre à d'autres codeurs d'accéder à vos informations utiles lors de l'écriture d'extraits de code.

Fonction Python help() sur une classe personnalisée

Vous pouvez également appeler le help() fonction sur les classes. Python vous montrera ensuite les méthodes disponibles et leurs docstrings. Voici un exemple :

class Car:
    '''Representing cool cars'''

    def __init__(self, brand, color):
        '''Creates a new car with a brand and color'''
        self.brand = brand
        self.color = color


    def speed():
        '''Returns the speed of the car given brand'''
        if self.brand == 'porsche':
            return 150
        return 100

Chaque méthode et la classe elle-même ont une docstring. La sortie lors de l'appel du help() fonction sur la classe Car est le suivant :

>>> help(Car)
Help on class Car in module __main__:

class Car(builtins.object)
 |  Car(brand, color)
 |  
 |  Representing cool cars
 |  
 |  Methods defined here:
 |  
 |  __init__(self, brand, color)
 |      Creates a new car with a brand and color
 |  
 |  speed()
 |      Returns the speed of the car given brand
 |  
 |  – --------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Mais avant de continuer, je suis ravi de vous présenter mon nouveau livre Python Python One-Liners (Lien Amazon).

Si vous aimez les one-liners, vous allez adorer le livre. Il vous apprendra tout ce qu'il y a à savoir sur une seule ligne de code Python. Mais c'est aussi une introduction à l'informatique , science des données, apprentissage automatique et algorithmes. L'univers en une seule ligne de Python !

Le livre est sorti en 2020 avec l'éditeur de livres de programmation de classe mondiale NoStarch Press (San Francisco).

Lien :https://nostarch.com/pythononeliners

Résumé

help() intégré de Python la fonction lance le système d'aide de Python .

Sans argument, help() démarre une session interactive—voir l'extrait de code suivant.
Avec un argument de chaîne, help(name) recherche le nom et affiche une page d'aide sur le shell.
Avec un argument qui n'est pas une chaîne, help(object) imprime une page d'aide sur l'objet.

>>> help()

Welcome to Python 3.7's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.7/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help> string
Help on module string:

NAME
    string - A collection of string constants.

DESCRIPTION
    Public module variables:
...

J'espère que vous avez apprécié l'article! Pour améliorer votre formation Python, vous pouvez rejoindre la populaire et gratuite Finxter Email Academy :

Voulez-vous améliorer vos compétences Python d'une manière amusante et facile à consommer ? Considérez les ressources suivantes et devenez un maître codeur !