【问题标题】:Return type for __init__ in docstrings文档字符串中 __init__ 的返回类型
【发布时间】:2016-02-03 22:04:57
【问题描述】:

我最近开始使用 PyCharm,它使用我想开始使用的文档字符串支持 Python 2.x 的类型提示。 类Foo__init__ 方法的:return: 值应该是多少? 我找不到答案是否应该是 FooNone、什么都没有,还是删除 PyCharm 在文档字符串模板中为我创建的属性?

【问题讨论】:

  • __init__ 不应该返回任何东西,也不太可能被分配,所以你放什么并不重要。如果您的方法不是return,您可以删除:return: 条目,因为它始终是None。事实上,我通常记录类本身而不是__init__,它通常不需要自己的文档字符串。

标签: python python-2.7 docstring


【解决方案1】:

(问题信用的答案应该去@ppperry)

因为所有__init__ 方法都返回None,所以不需要关于返回类型的文档字符串。

【讨论】:

    【解决方案2】:

    __init__ 方法应返回 None。如果您尝试返回任何其他内容,Python 将在实例化对象时引发错误。注意:如果你没有明确告诉 Python 函数应该返回什么,它会返回 None。因此,我从不需要在我的任何__init__ 方法中使用 return 语句。

    【讨论】:

    • 我明白,我的问题是关于 __init__ 方法的 docstring,而不是返回值本身。
    • @JosepValls 因此,因为所有__init__ 方法都返回None,所以不需要关于返回类型的文档。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-06-14
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-02-03
    相关资源
    最近更新 更多