Reading Time: 1 minutesUsing help() in Python
Using help() in Python
Python's builtin help() function returns the description of the object passed to it, in addition to its basic usage. For example, if you were to know how to use the replace() method of strings, you would execute help(str.replace).
Help on method_descriptor: |
S.replace(old, new[, count]) -> str |
Return a copy of S with all occurrences of substring |
old replaced by new. If the optional argument count is |
given, only the first count occurrences are replaced. |
The help() function without any argument gives you the help console, where you type the object you seek help on.
Welcome to Python 3.4's help utility! |
If this is your first time using Python, you should definitely check out |
the tutorial on the Internet at http://docs.python.org/3.4/tutorial/. |
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, symbols, or topics, type |
"modules", "keywords", "symbols", or "topics". Each module also comes |
with a one-line summary of what it does; to list the modules whose name |
or summary contain a given string such as "spam", type "modules spam". |
Help on method_descriptor in str: |
str.replace = replace(...) |
S.replace(old, new[, count]) -> str |
Return a copy of S with all occurrences of substring |
old replaced by new. If the optional argument count is |
given, only the first count occurrences are replaced. |
See also:
