Python 組み込み関数のヘルプ

英語ドキュメント:

help([object])

組み込みヘルプ システムを呼び出します (この関数は対話型での使用を目的としています)。引数が指定されていない場合、対話型ヘルプ システムがインタープリタ コンソールで起動します。引数が文字列の場合、その文字列はモジュール、関数、クラス、メソッド、キーワード、またはドキュメント トピックの名前として検索され、引数が他の種類のオブジェクトの場合は、コンソールにヘルプ ページが表示されます。オブジェクトのヘルプ ページが生成されます。この関数は、サイト モジュールによって組み込みの名前空間に追加され、組み込みのヘルプ システムが起動されます。ヘルプ システム内のモジュール、クラス、関数などの名前を入力すると、「quit」と入力して組み込みのヘルプ システムを終了し、対話型インターフェイスに戻ります。

>>> help() #不带参数

Welcome to Python 3.5'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='') -> 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 'strict'.
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 ................................


help> 1 #不存在的模块名、类名、函数名
No Python documentation found for '1'.
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('string')"
has the same effect as typing a particular string at the help> prompt.

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

2. インタプリタの対話型インターフェースでは、関数を呼び出すためにパラメータを渡すときに、パラメータがモジュール名、クラス名、関数名であるかどうかを確認し、そうであればその使用方法が表示されます。

りー