在帮助文档中显示@property数据描述符的类型提示

时间:2018-05-16 16:12:08

标签: python-3.5 python-3.6

以下课程:

class Book:

    def __init__(self, title, author):
        self._title = title
        self._author = author

    @property
    def title(self) -> str:
        """Retrieve the book's title"""
        return self._title

    def author(self) -> str:
        """Retrieve the book's author"""
        return self._author

调用help(Book)会返回以下文档(缩写):

class Book(builtins.object)
 |  Methods defined here:
 |  
 |  author(self) -> str
 |      Retrieve the book's author
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  title
 |      Retrieve the book's title

请注意,author方法会显示类型提示-> str,让用户知道作者姓名是字符串。另一方面,title属性没有显示这样的提示。

除了简单地将属性的类型添加到属性的docstring中,这允许代码和文档发散,是他们以任何方式将类型提示添加到属性,以便{{1}将显示属性的类型?

0 个答案:

没有答案