1. 程式人生 > >python 檢視函式幫助資訊

python 檢視函式幫助資訊

注:本文基於Python 2.7.5編寫

在linux上檢視某個命令的使用可以使用man看使用者手冊,但是對於python的一些函式使用,卻沒辦法使用man這個命令。但是也是有辦法查詢相應的幫助資訊的,那就是用help的方式。

首先要進入python互動式環境,然後直接使用help(fun)的方式檢視。

[root@CentOS-7-2 ~]# python
Python 2.7.5 (default, Nov 20 2015, 02:00:19) 
[GCC 4.8.5 20150623 (Red Hat 4.8.5-4)] on linux2
Type "help", "copyright", "credits"
or "license" for more information. >>> help(input)

接著就會出現input的幫助資訊,

Help on built-in function input in module __builtin__:

input(...)
    input([prompt]) -> value

    Equivalent to eval(raw_input(prompt)).

使用help需要注意的是要分清內建函式和一些其他模組的方法,比如,檢視列表list的append方法,就不能直接使用help(append)

>>> help(append)
Traceback
(most recent call last): File "<stdin>", line 1, in <module> NameError: name 'append' is not defined >>>

需要使用help(list.append),

>>> help(list.append)

Help on method_descriptor:

append(...)
    L.append(object) -- append object to end

此外,對於一些第三方模組也需要匯入後才能使用help查詢幫助,

>>> from PIL import Image
>>> help(Image.save)

Help on function open in module PIL.Image:

open(fp, mode='r')
    Opens and identifies the given image file.
    ......