Python: help() function

help() function

The help() function is used to execute the built-in help system.

Version:

(Python 3.2.5)

Syntax:

help([object])

Parameter:

If no argument is given, the interactive help system starts on the interpreter console.
If the argument is a string, then the string is looked up as the name of a module, function, class, method, keyword, or documentation topic, and a help page is printed on the console.
If the argument is any other kind of object, a help page on the object is generated.

Example: Python help() function

help(list)

Output:

Help on class list in module built ins:
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].
 | 
 | __eq__(self, value, /)
 | Return self==value.
 | 
 | __ge__(self, value, /)
 | Return self>=value.
 | 
 | __getattribute__(self, name, /)
 | Return getattr(self, name).
 | 
 | __getitem__(...)
 | x.__getitem__(y) <==> x[y]
 | 
 | __gt__(self, value, /)
 | Return self>value.
 | 
 | __iadd__(self, value, /)
 | Implement self+=value.
 | 
 | __imul__(self, value, /)
 | Implement self*=value.
 | 
 | __init__(self, /, *args, **kwargs)
 | Initialize self. See help(type(self)) for accurate signature.
 | 
 | __iter__(self, /)
 | Implement iter(self).
 | 
 | __le__(self, value, /)
 | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __mul__(self, value, /) | Return self*value.n | | __ne__(self, value, /) | Return self!=value. | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | __repr__(self, /) | Return repr(self). | | __reversed__(...) | L.__reversed__() -- return a reverse iterator over the list | | __rmul__(self, value, /) | Return self*value. | | __setitem__(self, key, value, /) | Set self[key] to value. | | __sizeof__(...) | L.__sizeof__() -- size of L in memory, in bytes | | append(...) | L.append(object) -> None -- append object to end
 | 
 | clear(...)
 | L.clear() -> None -- remove all items from L
 | 
 | copy(...)
 | L.copy() -> list -- a shallow copy of L
 | 
 | count(...)
 | L.count(value) -> integer -- return number of occurrences of value
 | 
 | extend(...)
 | L.extend(iterable) -> None -- extend list by appending elements from the iterable
 | 
 | index(...)
 | L.index(value, [start, [stop]]) -> integer -- return first index of value.
 | Raises ValueError if the value is not present.
 | 
 | insert(...)
 | L.insert(index, object) -- insert object before index
 | 
 | pop(...)
 | L.pop([index]) -> item -- remove and return item at index (default last).
 | Raises IndexError if list is empty or index is out of range.
 | 
 | remove(...)
 | L.remove(value) -> None -- remove first occurrence of value.
 | Raises ValueError if the value is not present.
 | 
 | reverse(...)
 | L.reverse() -- reverse *IN PLACE*
 | 
 | sort(...)
 | L.sort(key=None, reverse=False) -> None -- stable sort *IN PLACE*
 | 
 | ----------------------------------------------------------------------
 | Data and other attributes defined here:
 | 
 | __hash__ = None

Example: Python help() function

help(print)

Output:

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.

Python Code Editor:

PREV : hash()
NEXT : hex()

Test your Python skills with w3resource's quiz