python模塊和函數幫助文檔快速查看方法示例

Posted on by

引言

python的一個優勢是有著大量自帶和在線的模塊(module)資源，可以提供豐富的功能，在使用這些模塊的時候，如果每次都去網站找在線文檔會過於耗費時間，結果也不一定準確。因此這裡介紹下python自帶的查看幫助功能，可以在編程時不中斷地迅速找到所需模塊和函數的使用方法

通用幫助函數help()

在python命令行中鍵入help(),可以看到：

>>> 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幫助文檔界面，根據屏幕提示可以繼續鍵入相應關鍵詞進行查詢，繼續鍵入modules可以列出當前所有安裝的模塊：

help> modules
Please wait a moment while I gather a list of all available modules...
AutoComplete        _pyio               filecmp             pyscreeze
AutoCompleteWindow  _random             fileinput           pytweening
......        
Enter any module name to get more help.  Or, type "modules spam" to search
for modules whose name or summary contain the string "spam".

可以繼續鍵入相應的模塊名稱得到該模塊的幫助信息。

這是python的通用的查詢幫助，可以查到幾乎所有的幫助文檔，但我們很多時候不需要這樣層級式地向下查詢，接下來會介紹如何直接查詢特定的模塊和函數幫助信息。

模塊幫助查詢

查看.py結尾的普通模塊

help(module_name)

例如要查詢math模塊的使用方法，可以如下操作：

>>> import math
>>> help(math)
Help on built-in module math:
NAME
    math
DESCRIPTION
    This module is always available.  It provides access to the
    mathematical functions defined by the C standard.
FUNCTIONS
    acos(...)
        acos(x)
        Return the arc cosine (measured in radians) of x.
...
>>>

使用help(module_name)時首先需要import該模塊，有些教程中不進行導入而在模塊名中加入引號help('module_name')，這種方法可能會帶來問題，大傢可以用math模塊測試，建議使用先導入再使用help()函數查詢

查看內建模塊

sys.bultin_modulenames

>>> import sys
>>> sys.builtin_module_names
('_ast', '_bisect', '_codecs', '_codecs_cn', '_codecs_hk', ... 'zlib')
>>>

需要導入sys模塊。這裡列舉的一般是自帶的使用C/C++編譯鏈接的模塊

查詢函數信息

查看模塊下所有函數

dir(module_name)

如我們需要列舉出math模塊下所有的函數名稱

>>> dir(math)
['__doc__', '__loader__', '__name__',...]
>>>

同樣需要首先導入該模塊

查看模塊下特定函數信息

help(module_name.func_name)

如查看math下的sin()函數

>>> help(math.sin)
Help on built-in function sin in module math:
sin(...)
    sin(x)
    Return the sine of x (measured in radians).
>>>

查看函數信息的另一種方法

print(func_name.__doc__)

如查看內建函數print用法

>>> print(print.__doc__)
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default.
...
>>>

__doc__前後是兩個短下劃線，在python中會合並為長下劃線

python中的help()類似unix中的man指令，熟悉後會對我們的編程帶來很大幫助

以上就是python模塊和函數幫助文檔快速查看方法示例的詳細內容，更多關於查看python模塊函數幫助文檔的資料請關註WalkonNet其它相關文章！

推薦閱讀：