python: how to get information about a function?

PythonFunctionMethods

Python Problem Overview


When information about a type is needed you can use:

my_list = []
dir(my_list)

gets:

['__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']

or:

dir(my_list)[36:]

gets:

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

Now, in the documentation of Python information can be found about these functions, but I would like to get info about these functions in the terminal/command-line. How should this be done?

Python Solutions


Solution 1 - Python

In python: help(my_list.append) for example, will give you the docstring of the function.

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

    Help on built-in function append:

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

Solution 2 - Python

Try

help(my_list)

to get built-in help messages.

Solution 3 - Python

You can use pydoc.

Open your terminal and type python -m pydoc list.append

The advantage of pydoc over help() is that you do not have to import a module to look at its help text. For instance python -m pydoc random.randint.

Also you can start an HTTP server to interactively browse documentation by typing python -m pydoc -b (python 3)

For more information python -m pydoc

Solution 4 - Python

Or

help(list.append)

if you're generally poking around.

Solution 5 - Python

help(functionname) Can use this to print the Additional Info About the function you specified in help(..)

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestiontaperView Question on Stackoverflow
Solution 1 - PythonTyrantWaveView Answer on Stackoverflow
Solution 2 - PythonOlliView Answer on Stackoverflow
Solution 3 - PythonAndreas ChatzivasileiadisView Answer on Stackoverflow
Solution 4 - PythonDetDevView Answer on Stackoverflow
Solution 5 - PythonAbhyu08View Answer on Stackoverflow