python模組和函數幫助檔案快速檢視方法範例

2022-06-27 18:01:18

引言

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模組函數幫助檔案的資料請關注it145.com其它相關文章！