Detailed introduction to Python's built-in help function-Python Tutorial-php.cn

Detailed introduction to Python's built-in help function

高洛峰

Release： 2017-03-21 10:49:19

Original

2336 people have browsed it

English documentation:

help([object])

Invoke the built-in help system. (This function is intended for interactive use.) 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.

This function is added to the built-in namespace by the site module.

Instructions:

　1. In the interpreter interactive interface, when calling a function without passing parameters, the built-in help system will be activated and the help system will be entered. When you enter the name of a module, class, function, etc. inside the help system, its usage instructions will be displayed. Enter quit to exit the built-in help system and return to the interactive interface.

>>> help() #不带参数

Welcome to Python 3.5&#39;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.5/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>
help> str #str的帮助信息
Help on class str in module builtins:

class str(object)
 |  str(object=&#39;&#39;) -> str
 |  str(bytes_or_buffer[, encoding[, errors]]) -> str
 |  
 |  Create a new string object from the given object. If encoding or
 |  errors is specified, then the object must expose a data buffer
 |  that will be decoded using the given encoding and error handler.
 |  Otherwise, returns the result of object.__str__() (if defined)
 |  or repr(object).
 |  encoding defaults to sys.getdefaultencoding().
 |  errors defaults to &#39;strict&#39;.
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 ................................


help> 1 #不存在的模块名、类名、函数名
No Python documentation found for &#39;1&#39;.
Use help() to get the interactive help utility.
Use help(str) for help on the str class.

help> quit #退出内置帮助系统

You are now leaving help and returning to the Python interpreter.
If you want to ask for help on a particular object directly from the
interpreter, you can type "help(object)".  Executing "help(&#39;string&#39;)"
has the same effect as typing a particular string at the help> prompt.

# 已退出内置帮助系统，返回交互界面 help> 变成 >>>
>>>

Copy after login

2. In the interpreter interactive interface, when passing in parameters to call a function, it will check whether the parameters are module names, class names, and function names. If so, its usage instructions will be displayed.

>>> help(str) 
Help on class str in module builtins:

class str(object)
 |  str(object=&#39;&#39;) -> str
 |  str(bytes_or_buffer[, encoding[, errors]]) -> str
 |  
 |  Create a new string object from the given object. If encoding or
 |  errors is specified, then the object must expose a data buffer
 |  that will be decoded using the given encoding and error handler.
 |  Otherwise, returns the result of object.__str__() (if defined)
 |  or repr(object).
 |  encoding defaults to sys.getdefaultencoding().
 |  errors defaults to &#39;strict&#39;.
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 |  
  ***************************

Copy after login

The above is the detailed content of Detailed introduction to Python's built-in help function. For more information, please follow other related articles on the PHP Chinese website!