help函數是python的一個內建函數(python的內建函數可以直接調用,無需import),它是python內建的函數,任何時候都可以被使用。help函數能作什麼、怎麼使用help函數查看python模組中函數的用法,和使用help函數時需要注意哪些問題,下面來簡單的說一下。
一、help()函數的作用
在使用python來編寫代碼時,會經常使用python內建函數或模組,一些不常用的函數或是模組的用途不是很清楚,這時候就需要用到help函數來查看協助。
這裡要注意下,help()函數是查看函數或模組用途的詳細說明,而dir()函數是查看函數或模組內的操作方法都有什麼,輸出的是方法列表。
二、怎麼使用help函數查看python模組中函數的用法
help()括弧內填寫參數,操作方法很簡單。例如:
代碼如下:
>>> help('dir')
Help on built-in function dir in module builtins:
dir(...)
dir([object]) -> list of strings
If called without an argument, return the names in the current scope.
Else, return an alphabetized list of names comprising (some of) the attribut
es
of the given object, and of attributes reachable from it.
If the object supplies a method named __dir__, it will be used; otherwise
the default dir() logic is used and returns:
for a module object: the module's attributes.
for a class object: its attributes, and recursively the attributes
of its bases.
for any other object: its attributes, its class's attributes, and
recursively the attributes of its class's base classes.
三、使用help函數查看協助執行個體
在寫help()函數使用方法時說過,括弧中填寫參數,那在這裡要注意參數的形式:
1、查看一個模組的協助
代碼如下:
>>>help('sys')
之後它回開啟這個模組的協助文檔
2、查看一個資料類型的協助
代碼如下:
>>>help('str')
返回字串的方法及詳細說明
代碼如下:
>>>a = [1,2,3]
>>>help(a)
這時help(a)則會開啟list的操作方法
代碼如下:
>>>help(a.append)
會顯示list的append方法的協助