Python 如何使用getter在sphinx中为属性添加typehint

我使用sphinx从文档字符串和类型提示生成“自动”文档。但是，我很难用getter显示（在生成的文档中）属性的类型

---

对于简单属性，我可以获得所需的文档：

class Cls:
    def __init__(self):
        self.prop: int = 42

将生成此（所需）文档：

class Cls:
    def __init__(self):
        self.prop: int = 42

道具：int

---

对于一种方法，我们将得到类似的有用结果：

class Cls:
    def mth(self) -> int:
        return 42

mth（）→ int

---

但是，如果我们想使用getter（

@property

decorator），我无法在那里获取类型：

class Cls:
    @property
    def prop(self) -> int:
        return 42

属性prop

注意，没有类型提示

---

---

您知道如何在最后一种情况下将类型提示添加到文档中吗？

这将在sphinx 4中修复。见和

狮身人面像4尚未发布，但已经有（现在发布）产生：

class Cls:
@财产
def prop（自）->int：
返回42

属性属性：int

你可以使用这个预发布版本，如果它没有破坏你的任何东西