python学习笔记-为自定义类或者函数编写help文档,以及进行文档测试
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了python学习笔记-为自定义类或者函数编写help文档,以及进行文档测试,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含1902字,纯文字阅读大概需要3分钟。
内容图文
在python中我们可以利用help("模块名")或者help(类名)的方式来查看类或者函数的文档。但是它们是如何编写的呢?其实它们在类最前面或者方法的最前面用"""三个双引号包裹了多行注释。这些内容就会被Python当成帮助文档。那帮助文档一般会写什么内容呢?主要包括以下内容:
该类或者函数的主要作用
传入的值和输出的值
一些特殊情况的说明
文档测试内容
以上内容是个人的总结,但是并没有看到相关的资料。
我们来举一个例子:
class Apple(object): """ This is an Apple Class""" def get_color(self): """ Get the Color of Apple. get_color(self) -> str """ return "red"
在python terminal输入
>>> from CallDemo import Apple >>> help(Apple) Help on class Apple in module CallDemo: class Apple(__builtin__.object) | This is an Apple Class | | Methods defined here: | | get_color(self) | Get the Color of Apple. | get_color(self) -> str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined)
利用doctest进行文档测试
我们在注释中我们也可以doctest模块进行文档测试。
例如,我们添加了文档测试内容后如下所示:
class Apple(object): """ This is an Apple Class Example: >>> apple = Apple() >>> apple.get_color() 'red' >>> apple.set_count(20) >>> apple.get_count() 400 """ def get_color(self): """ Get the Color of Apple. get_color(self) -> str """ return "red" def set_count(self, count): self._count = count def get_count(self): return self._count * self._countif __name__ == '__main__': import doctest
doctest.testmod()
由于我们写了
if __name__ == '__main__': import doctest doctest.testmod()
所以以上文档测试只有在以入口文件执行的时候才会进行文档测试。因此并不会在实际应用在执行文档测试。
以上就是python学习笔记-为自定义类或者函数编写help文档,以及进行文档测试的内容,更多相关内容请关注PHP中文网(www.gxlcms.com)!
内容总结
以上是互联网集市为您收集整理的python学习笔记-为自定义类或者函数编写help文档,以及进行文档测试全部内容,希望文章能够帮你解决python学习笔记-为自定义类或者函数编写help文档,以及进行文档测试所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。