如何给namedtuple添加docstring

在Python中，我们可以使用纯字符串来记录方法，类和模块。然后，此字符串可作为名为的特殊属性使用__doc__。话虽这么说，我们如何向我们的Color namedtuple添加docstring的？

我们可以通过两种方式做到这一点。第一个（比较麻烦）是使用包装器扩展元组。这样，我们便可以docstring在此包装器中定义。例如，请考虑以下代码片段：

_Color = namedtuple("Color", "r g b alpha")class Color(_Color):"""A namedtuple that represents a color.It has 4 fields:r - redg - greenb - bluealpha - the alpha channel""">>> print(Color.__doc__)
A namedtuple that represents a color.It has 4 fields:r - redg - greenb - bluealpha - the alpha channel
>>> help(Color)
Help on class Color in module __main__:class Color(Color)|  Color(r, g, b, alpha)|  |  A namedtuple that represents a color.|  It has 4 fields:|  r - red|  g - green|  b - blue|  alpha - the alpha channel|  |  Method resolution order:|      Color|      Color|      builtins.tuple|      builtins.object|  |  Data descriptors defined here:|  |  __dict__|      dictionary for instance variables (if defined)
复制代码

如上，通过继承_Color元组，我们为namedtupe添加了一个__doc__属性。

添加的第二种方法，直接设置__doc__属性。这种方法不需要扩展元组。

>>> Color.__doc__ = """A namedtuple that represents a color.It has 4 fields:r - redg - greenb - bluealpha - the alpha channel"""
复制代码

注意，这些方法仅适用于Python 3+。

如何给namedtuple添加docstring相关推荐

看例子，学 Python（二）
看例子,学 Python(二) 看例子,学 Python(一) 看例子,学 Python(三) 模块文件 mymath.py 定义了函数 fib 和 fac,mymath.py 就是一个模块. A ...
python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...
python代码_如何使用 Sphinx 给 Python 代码写文档
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...
【Python】单元测试框架unitest及其高级应用
Unittest Unittest是python的一个单元测试框架,但是它不仅适用于单元测试,还适用自动化测试用例的开发与执行.我们可以很方便的使用它组织执行测试用例,使用它提供的丰富的断言方法进行测 ...
[Python]PEP8 编码规范及开发中的一些惯例和建议
为什么要有编码规范编码是给人看的还是给机器看的? 美观是重点吗? 美观可读性可维护性健壮性团队内最好的代码状态: 所有人写出的代码像一个人写出来的代码编排: 缩进 4 个空格, 禁止空格与 ...
unittest + HTMLTestRunner
unittest + HTMLTestRunner (仅作为个人笔记,如有雷同,请联系删除..) nose/nosetests,按照匹配规则收集测试 – [ 先收集,再执行 ] 1.unittest单 ...
第八章函数中的类型提示
应该强调的是,Python 仍将是一种动态类型的语言,即使按照惯例,作者也不希望强制类型提示 --Guido van Rossum, Jukka Lehtosalo, and Łukasz Langa ...
《流畅的Python第二版》读书笔记——函数中的类型注解
引言这是<流畅的Python第二版>抢先版的读书笔记.Python版本暂时用的是python3.10.为了使开发更简单.快捷,本文使用了JupyterLab. 本章关注于Python在函 ...
Python 进阶之知识点记忆
Python 进阶 PEP8 编码规范, 及开发中的一些惯例和建议练习: 规范化这段代码 from django.conf import settings from user.models impo ...

如何给namedtuple添加docstring

如何给namedtuple添加docstring相关推荐

最新文章

热门文章