法一基本就是废物,因为法二包含了法一,比法一还要好,可查询内置的函数
法一和法二得到的都是详细的文档,内容很多,很复杂,法三又太简单了,而且需要知道函数的名字才能查询。
推荐去查找对应函数的教程,当然很多教程不教你参数的含义,可以去chatgpt对应的函数
python如何查看包的函数文档
法一:下载的包,不是内置的包,可以使用pip show 包名。
如pip show numpy
H
ome-page:这里的网页就是官方文档,应该要魔法才能打开。
这里插播一句,可以使用pip -h来查看pip的用法。
C
ommmand:命令 ,pip需要执行的命令
例子:pip install numpy,使用install进行下载
options:选项,可以指定命令进行约束。
例子:pip install numpy -i Simple Index,-i表示下载numpy地址是后面的网址,-i指定下载网址
进一步查询
可以看到这里为我们提供了很多command的选择,我们选择install继续进行查询
pip install -h
可以看到这里提供了详细的用法,因为是英文的,最好去安装一个划线翻译的软件来辅助理解。
回到法二:
使用python内置的函数来进行文档获取,使用pydoc -w 包名,这个功能很强大,内置的包也会生成对应的html文档,双击打开就行。
例子:pydoc -w time
直接在文件夹打开,或者使用命令打开,浏览器名 time.html
例子:firefox time.html
使用火狐浏览器打开,还能进行翻译
法三:进入python交互界面或者新建python文件,使用内置的help函数
例子:
上面的例子查询了time包的sleep函数
如果包里面有类,类还有方法,就用.表示从属
例子:要查询argparse包里面的ArgumentParser的add_argument方法
使用:help(argparse.ArgumentParser.add_argument)
这个方法会提供要查询的函数的参数,还有简单的参数解释。