知识卡片
帮助报表结合文档与对象结构
help(obj)使用pydoc整理docstring及可取得的签名、成员等信息,比单独打印doc更便于浏览。把对象作为参数时,应先能取得该对象;help(str.replace)与只写对象名的引用不同。报表质量仍取决于实际文档和可内省的信息,不代表接口已被测试。
docstr的help报表除文档字符串外,还列出模块、文件、类、方法与函数结构,所以帮助信息不是仅把doc原样拼接。报告内容依当前导入对象及运行环境,旧版示例不应当作现代所有环境的固定输出。
787复述PyDoc把docstring与对象信息组织成帮助,链接第15章已学用法;有帮助报表不等于接口已通过测试。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 帮助报表结合文档与对象结构
- · 回顾文档字符串
- · 大型项目的开发工具
原书出处 · 3 处
- · 查看原书依据
查看对象内部而收集的结构化信息。你也可以对内置函数、方法以及类型使用help。要取得内置类型的help信息,就使用其类型名称(例如,字典为dict,字符串为str,列表为list)。你会得到大量的显示内容,说明该类型可用的方法。 最后,help函数也能用在模块上,就像内置工具一样。在这里是对之前所写的docstrings.py文件生成报表。同样的,其中有些是
- · 查看原书依据
PyDoc工具,该工具知道如何格式化报表中的所有这些字符串。如下是在Python 2.6下运行我们代码的情况(Python 3.0还显示从新式类模式的隐含object超类继承来的额外属性,请自己在Python 3.0下运行它,关于其差别的更多讨论参见第31章): 文档字符串在运行时可用,但是,它们从语法上比#注释(它可以出现在程序中的任何地方)要缺乏灵活性。
- · 查看原书依据
PyDoc为模块和对象提供了一个文档系统,并整合了Python的文档字符串功能。这是Python系统的标准部分,参考库手册以获得更多细节。请确认返回查看了第4章所列举的文档资源的提示,以了解其他Python资源的信息。 PyChecker和Pylint 因为Python是的一门动态语言,所以有些程序设计的错误在程序运行前不会报错(例如,当文件执行或导入时,语