web-dev-qa-db-fra.com

python: comment obtenir des informations sur une fonction?

Lorsque des informations sur un type sont nécessaires, vous pouvez utiliser:

my_list = []
dir(my_list)

obtient:

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

ou:

dir(my_list)[36:]

obtient:

['append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

Maintenant, dans la documentation de Python, on peut trouver des informations sur ces fonctions, mais je voudrais obtenir des informations sur ces fonctions dans le terminal/la ligne de commande. Comment cela devrait-il être effectué?

55
taper

En python: help(my_list.append) par exemple, vous donnera le docstring de la fonction.

>>> my_list = []
>>> help(my_list.append)

    Help on built-in function append:

    append(...)
        L.append(object) -- append object to end
63
TyrantWave

Essayer

help(my_list)

pour obtenir des messages d'aide intégrés.

12
Olli

Vous pouvez utiliser pydoc.

Ouvrez votre terminal et écrivez python -m pydoc list.append

L'avantage de pydoc par rapport à help() est qu'il n'est pas nécessaire d'importer un module pour consulter son texte d'aide. Par exemple python -m pydoc random.randint.

Vous pouvez également démarrer un serveur HTTP pour parcourir la documentation de manière interactive en tapant python -m pydoc -b (Python 3).

Pour plus d'informations python -m pydoc

Ou

help(list.append)

si vous fouillez généralement.

1
DetDev