python查看函数文档的方法
导读:本文共2197字符,通常情况下阅读需要7分钟。同时您也可以点击右侧朗读,来听本文内容。按键盘←(左) →(右) 方向键可以翻页。
摘要: python的一个优势是有着大量自带和在线的模块(module)资源,可以提供丰富的功能,在使用这些模块的时候,如果每次都去网站找在线文档会过于耗费时间,结果也不一定准确。因此这里介绍下python自带的查看帮助功能,可以在编程时不中断地迅速找到所需模块和函数的使用方法通用帮助函数help()在python命令行中键入help(),可以看到:>>&g... ...
目录
(为您整理了一些要点),点击可以直达。python的一个优势是有着大量自带和在线的模块(module)资源,可以提供丰富的功能,在使用这些模块的时候,如果每次都去网站找在线文档会过于耗费时间,结果也不一定准确。因此这里介绍下python自带的查看帮助功能,可以在编程时不中断地迅速找到所需模块和函数的使用方法
通用帮助函数help()
在python命令行中键入help(),可以看到:
进入help帮助文档界面,根据屏幕提示可以继续键入相应关键词进行查询,继续键入modules可以列出当前所有安装的模块:
可以继续键入相应的模块名称得到该模块的帮助信息。
这是python的通用的查询帮助,可以查到几乎所有的帮助文档,但我们很多时候不需要这样层级式地向下查询,接下来会介绍如何直接查询特定的模块和函数帮助信息。
模块帮助查询
查看.py结尾的普通模块help(module_name)
例如要查询math模块的使用方法,可以如下操作:
使用help(module_name)时首先需要import该模块,有些教程中不进行导入而在模块名中加入引号help('module_name'),这种方法可能会带来问题,大家可以用math模块测试,建议使用先导入再使用help()函数查询。
查看内建模块sys.bultin_modulenames
需要导入sys模块。这里列举的一般是自带的使用C/C++编译链接的模块
查询函数信息
查看模块下所有函数dir(module_name)
如我们需要列举出math模块下所有的函数名称
同样需要首先导入该模块
查看模块下特定函数信息help(module_name.func_name)
如查看math下的sin()函数
查看函数信息的另一种方法print(func_name.__doc__)
如查看内建函数print用法
python查看函数文档的方法的详细内容,希望对您有所帮助,信息来源于网络。