首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何打印class属性/元素的docstring?

如何打印class属性/元素的docstring?
EN

Stack Overflow用户
提问于 2020-01-23 22:35:25
回答 2查看 283关注 0票数 5

我有一门课:

代码语言:javascript
复制
class Holiday(ActivitiesBaseClass):
    """Holiday is an activity that involves taking time off work"""

    Hotel = models.CharField(max_length=255)
    """ Name of hotel """

我可以通过键入以下命令来打印类docstring:

代码语言:javascript
复制
print(Holiday.__doc__)

输出结果为:

代码语言:javascript
复制
Holiday is an activity that involves taking time off work 

如何打印酒店的docstring,它是一个Class属性/元素?

我尝试过的

代码语言:javascript
复制
print(Holiday.Hotel.__doc__)

返回:

代码语言:javascript
复制
A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

我还尝试了help()函数,但没有用。

N.B

Sphinx似乎能够提取class属性的文档字符串,并将它们包含在readthedocs中,所以我希望有一种方法

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2020-01-23 22:40:17

不认为可以为特定字段添加文档字符串,但可以使用字段的help_text参数:

代码语言:javascript
复制
Hotel = models.CharField(max_length=255, help_text="Name of hotel")
票数 5
EN

Stack Overflow用户

发布于 2020-01-23 22:41:09

不幸的是,目前在Python中还没有这样的属性文档字符串实现。有一个PEP建议实现此功能,但被拒绝了。

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/59880963

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档