栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

在python属性上放置文档字符串的正确方法是什么?

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

在python属性上放置文档字符串的正确方法是什么?

在getter上写文档字符串,因为1)就是

help(MyClass)
显示的内容,2)也是在Python文档中的完成方式-请参阅x.setter示例。

关于1):

class C(object):    @property    def x(self):        """Get x"""        return getattr(self, '_x', 42)    @x.setter    def x(self, value):        """Set x"""        self._x = value

接着:

>>> c = C()>>> help(c)Help on C in module __main__ object:class C(__builtin__.object) |  Data descriptors defined here: | |  __dict__ |      dictionary for instance variables (if defined) | |  __weakref__ |      list of weak references to the object (if defined) | |  x |      Get x>>>

请注意,设置者的文档字符串“ Set x”将被忽略。

因此,您应该在getter函数上为整个属性(getter和setter)编写docstring,以使其可见。一个好的属性文档字符串的示例可能是:

class Serial(object):    @property    def baudrate(self):        """Get or set the current baudrate. Setting the baudrate to a new value        will reconfigure the serial port automatically.        """        return self._baudrate    @baudrate.setter    def baudrate(self, value):        if self._baudrate != value: self._baudrate = value self._reconfigure_port()


转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/611215.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号