Javatpoint Logo
Javatpoint Logo

Python help() Function

Python help() function is used to get help related to the object passed during the call. It takes an optional parameter and returns help information. If no argument is given, it shows the Python help console. It internally calls python's help function.

Signature

Parameters

object: It can be any object for which we wan to get help.

Return

It returns the object's info.

Let's see some examples of help() function to understand it's functionality.

Python help() Function Example 1

Output:

Welcome to Python 3.5's help utility!

Python help() Function Example 2

Output:

Help on int object:

class int(object)
 |  int(x=0) -> integer
 |  int(x, base=10) -> integer
 |  
 |  Methods defined here:
 |  
 |  __abs__(self, /)
 |      abs(self)
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 |  
 |  __and__(self, value, /)
 |      Return self&value.

Python help() Function Example 3

If the object is a list, it opens the list module, and it?s class. See the output.

Output:

Help on class list in module builtins:

class list(object)
 |  list() -> new empty list
 |  list(iterable) -> new list initialized from iterable's items
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 |  
 |  __contains__(self, key, /)
 |      Return key in self.
 |  
 |  __delitem__(self, key, /)
 |      Delete self[key].

Python help() Function Example 4

If no help or info is present, it shows a message to the console and returns None.

Output:

No Python documentation found for 'Javatpoint'.
Use help() to get the interactive help utility.
Use help(str) for help on the str class.

None

Next TopicPython Functions




Please Share

facebook twitter google plus pinterest

Learn Latest Tutorials


Preparation


B.Tech / MCA