前面介绍了使用 help() 函数来查看程序单元的帮助信息。比如导入 string 模块之后,即可使用 help() 函数来查看指定程序单元的帮助信息。

例如,在交互式解释器中输入如下命令来查看 string 模块下 capwords() 函数的作用:

>>> help(string.capwords) Help on function capwords in module string: capwords(s, sep=None) capwords(s [,sep]) -> string Split the argument into words using split, capitalize each word using capitalize, and join the capitalized words using join. If the optional second argument sep is absent or None, runs of whitespace characters are replaced by a single space and leading and trailing whitespace are removed, otherwise sep is used to split and join the words.

通过上面描述可以看到,capwords() 函数的作用就是将给定的 s 字符串中每个单词的首字母变成大写的。该函数可通过 sep 参数指定分隔符:如果不指定 sep 参数,该字符串默认以空白作为分隔符。

在查看了帮助信息之后,接下来通过如下命令来测试 string.capwords() 函数的用法:

>>>string.capwords('abc xyz')

'Abc Xyz'

>>> string.capwords('abc;xyz',sep=';')

'Abc;Xyz'

上面代码在第一次使用 capwords() 函数时,没有指定 sep 参数,因此默认以空格为分隔符,这意味着程序将 abc xyz 分成 abc 和 xyz 两个单词,因此该函数将 a、x 两个字母变成大写的:在第二次使用 capwords() 函数时,指定 sep 参数为“;”,这意味着以“,”为分隔符将 abc;xyz 分成 abc 和 xyz 两个单词,因此程序将 a、x 两个字母变成大写的。

需要说明的是,使用 help() 函数之所以能查看到程序单元的帮助信息,其实完全是因为该程序单元本身有文档信息,也就是有 __doc__ 属性。换句话说,使用 help() 函数查看的其实就是程序单元的 __doc__ 属性值。

例如,使用 print(string.capwords.__doc__) 命令来查看 capwords() 的帮助信息,将会看到如下输出结果:

>>> print(string.capwords.__doc__)

capwords(s [,sep]) -> string

Split the argument into words using split, capitalize each

word using capitalize, and join the capitalized words using

join.  If the optional second argument sep is absent or None,

runs of whitespace characters are replaced by a single space

and leading and trailing whitespace are removed, otherwise

sep is used to split and join the words

对比 help(string.capwords) 和 print(string.capwords.__doc__) 两个命令的输出结果,不难看到它们的输出结果完全相同,这说明使用 help() 函数查看的就是程序单元的__doc__属性值。

从理论上说,应该为每个程序单元都编写完备而详细的文档信息,这样开发者只要通过 help() 函数即可查看该程序单元的文档信息,完全不需要查看文档。但不得不说的是,有些程序单元的文档信息并不是很详细,此时可能需要借助于 Python 库的参考文档:https://docs.python.org/3/library/index.html.

python查看文档的软件_Python __doc__属性:查看文档相关推荐

  1. python爬取网页数据软件_python爬虫入门10分钟爬取一个网站

    一.基础入门 1.1什么是爬虫 爬虫(spider,又网络爬虫),是指向网站/网络发起请求,获取资源后分析并提取有用数据的程序. 从技术层面来说就是 通过程序模拟浏览器请求站点的行为,把站点返回的HT ...

  2. python电脑截图文字识别软件_Python实现文字识别,来看看大牛怎么实现截图/

    python有截屏的包吗 有你可以试试pyscreenshot. 地址:https://github.com/ponty/pyscreenshot 使用:import pyscreenshot as  ...

  3. python写安卓游戏辅助软件_python微信跳一跳辅助软件

    python微信跳一跳辅助软件是一款跳一跳小游戏的刷分辅助工具应用,用户在微信玩跳一跳游戏的时候使用软件可以随意的修改其中的成绩分数,按照你自己的意愿进行相关的改变,更好的帮助你达成游戏的最高峰,喜欢 ...

  4. python 给word添加背景图片_Python如何使用word文档插入图片和表格

    Python如何使用word文档插入图片和表格 发布时间:2020-10-26 13:49:29 来源:亿速云 阅读:101 作者:挣扎的蓝藻 这篇文章运用简单易懂的例子给大家介绍Python如何使用 ...

  5. python下载图片到文件夹_python实现解析markdown文档中的图片,并且保存到本地~

    背景 前阵子简书好像说是凉了,搞得我有点小慌,毕竟我的大部分博客都是放在简书上面的,虽然简书提供了打包导出功能,但是只能导出文字,图片的话还是存在简书服务器上面,再加上我一直想要重新做一个个人博客,于 ...

  6. python做游戏用什么软件_Python 与游戏测试 (小工具篇)

    最近在TesterHome游戏测试群里,有时候会看到有童鞋问,游戏测试人员学了Python,可以干点什么. 很多童鞋初学Python,学习了语法和基础类库后,开始迷茫如何实际使用到工作中去,其实Pyt ...

  7. python 怎么得到图像深度图 软件_Python/OpenCV:从立体图像计算深度图

    我有两个立体图像要用来计算深度图.虽然我不幸不知道C/C++,但我知道Python--所以当我发现this tutorial时,我是乐观的. 不幸的是,教程似乎有些过时了.它不仅需要调整以运行(将&q ...

  8. 用python做一个数据查询软件_Python实现功能简单的数据查询及可视化系统

    欢迎点击右上角关注小编,除了分享技术文章之外还有很多福利,私信学习资料可以领取包括不限于Python实战演练.PDF电子文档.面试集锦.学习资料等. image.png 前言 数据时代,数据的多源集成 ...

  9. python查看内存地址的内容_python中如何查看指定内存地址的内容

    python中一般并不需要查看内存内容,但作为从C/C++过来的人,有的时候还是想看看内存,有时是为了验证内容是否与预期一致,有时是为了探究下内存布局. from sys import getsize ...

最新文章

  1. Linux(9)用户、组和权限管理
  2. PHP简单的字符串加密与加密代码
  3. IOS将字符串转换为日期时间格式
  4. VUE:解决 [Vue warn]: Error in render: “TypeError: item.slice is not a function“ (取部分数据)
  5. 10个必会的 PyCharm 技巧,附高清大图
  6. kafka分区与分组原理_Kafka工作原理
  7. linux 内核编号含义_linux内核(kernel)版本号的意义
  8. ssh 本地转发 和远程转发 区别
  9. python excel筛选统计_如何用python对excel表格进行筛选
  10. OpenGl读取导入3D模型并且添加鼠标移动旋转显示
  11. 有量子计算机的山西高能小说,高能小说推荐-好看的高能类小说-高能小说排行榜-七零文学...
  12. 分析注释 sequence_input_layer.py
  13. java 清除stdin缓冲区_使用fflush(stdin)
  14. Solidity IDE Remix中文版使用手册
  15. 图像合成——套索工具初使用
  16. Prometheus 监控详解
  17. 20160803 - C:\WINDOWS\system32\config\systemprofile\Desktop 不可用的解决
  18. 计算机技术在图形图像处理中的应用,计算机技术在图形图像处理中的应用研究...
  19. 将VS编译器默认为X64
  20. 连接MySQL服务器

热门文章

  1. 公网mysql_(看图)为什么无法通过公网登录MySQL?
  2. 快速开发后台不用太多代码的 tp5_小程序·云开发优劣简述
  3. 使用mac以来的一些认识
  4. SSH putty Disconnected: Server protocol violation: unexpected SSH2_MSG_UNIMPLEMENTED packet
  5. c语言猜拳游戏思考,这是一个猜拳游戏的程序 大家有更好的解决方法么?
  6. linux中文系统换英文字体,linux系统下肿么切换字体?
  7. oracle32位11g中文乱码,win7 64位系统 Oracle32bit + PL/SQL访问Orale服务,Oracle 11g的安装,中文乱码问题的解决...
  8. 其中一个页签慢_Word中如何快速定位到页、行、表格、公式,查找与替换方法...
  9. 深度学习(26)随机梯度下降四: 损失函数的梯度
  10. 计算机体系结构---第二章---指令系统