Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

python: how to get information about a function?

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?

like image 222
taper Avatar asked Mar 25 '11 08:03

taper


People also ask

How do you display the contents of a function in Python?

We use the getsource() method of inspect module to get the source code of the function. Returns the text of the source code for an object. The argument may be a module, class, method, function, traceback, frame, or code object.

What is dir () in Python?

Python dir() Function The dir() function returns all properties and methods of the specified object, without the values. This function will return all the properties and methods, even built-in properties which are default for all object.

How do I get help for a Python module?

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, or topics, type "modules", "keywords", or "topics".

How will you display the help about print function in Python?

Return Vype: The following displays the help on the builtin print method on the Python interactive shell. Help on built-in function print in module builtins: print(...) Prints the values to a stream, or to sys.


1 Answers

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 
like image 158
TyrantWave Avatar answered Sep 23 '22 14:09

TyrantWave