python模块和函数帮助文档快速查看方法示例

 更新时间:2022年06月27日 15:00:03   作者:cheng3100  
这篇文章主要为大家介绍了python模块和函数帮助文档快速查看方法示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

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模块函数帮助文档的资料请关注脚本之家其它相关文章!

相关文章

  • Python深度学习线性代数示例详解

    Python深度学习线性代数示例详解

    这篇文章主要为大家讲解了Python深度学习中线性代数的示例详解有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2021-10-10
  • Python爬取YY评级分数并保存数据实现过程解析

    Python爬取YY评级分数并保存数据实现过程解析

    这篇文章主要介绍了Python爬取YY评级分数并保存数据实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • python读取tif图片时保留其16bit的编码格式实例

    python读取tif图片时保留其16bit的编码格式实例

    今天小编就为大家分享一篇python读取tif图片时保留其16bit的编码格式实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-01-01
  • 在win64上使用bypy进行百度网盘文件上传功能

    在win64上使用bypy进行百度网盘文件上传功能

    这篇文章主要介绍了在win64上使用bypy进行百度网盘文件上传功能,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-01-01
  • Python实现文件只读属性的设置与取消

    Python实现文件只读属性的设置与取消

    这篇文章主要为大家详细介绍了Python如何实现设置文件只读与取消文件只读的功能,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2023-07-07
  • python 常见的反爬虫策略

    python 常见的反爬虫策略

    这篇文章主要介绍了python反爬虫策略,帮助大家更好的理解和使用python 爬虫,感兴趣的朋友可以了解下
    2020-09-09
  • Python中的self用法详解

    Python中的self用法详解

    在本篇文章里小编给大家整理的是关于Python中的self用法以及实例内容,需要的朋友们参考下。
    2019-08-08
  • 为Python程序添加图形化界面的教程

    为Python程序添加图形化界面的教程

    这篇文章主要介绍了为Python程序添加图形化界面的教程,图形化界面编程是开发Python本地应用的必备,需要的朋友可以参考下
    2015-04-04
  • Python、 Pycharm、Django安装详细教程(图文)

    Python、 Pycharm、Django安装详细教程(图文)

    这篇文章主要介绍了Python、 Pycharm、Django安装详细教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • Python学习之字符串格式化

    Python学习之字符串格式化

    这篇文章主要介绍了Python实现字符串格式化输出的方法,结合具体实例形式总结分析了Python字符串格式化输出的各种常用操作技巧,需要的朋友可以参考下
    2021-10-10

最新评论