python - PyCharm 中 Django 文档字符串中未解析的引用

Question

我使用 Google 风格的 Python 文档字符串 like in this Example对于我的 Django 项目。当我创建一个类并在文档字符串中使用属性表示法时，Pycharm 总是说 - “未解析的引用”。

class Post(models.Model):
    """
    Class for posts.

    Attributes:
        title(str): Post title.
    """
    title = models.CharField(max_length=120)

我知道 PyCharm 没有看到 title 和 def __init__() 函数的 self 并写入此错误，但在 Django 中我从未见过对从 models 继承的类使用 def __init__()。

我该怎么办？这是我的错误还是 PyCharm 在这种情况下看不到上下文？我应该使用 def __init__() 或其他东西或以其他方式编写文档吗？

Answer 1

PyCharm 目前似乎不支持此功能。 JetBrains 问题跟踪器中的活跃问题是 https://youtrack.jetbrains.com/issue/PY-16760 ，请考虑投票以修复它。如果您想避免在文档字符串中看到这些“未解析的引用”错误，唯一的解决方法是在“首选项”>“编辑器”>“检查”>“未解析的引用”中禁用检查。

我过去尝试过的另一个选项是删除“Attributes:” header ，并在与文档字符串其余部分相同的缩进级别上编写我的属性文档。这不再向您发出警告，但您不再 100% 遵守 Google 文档字符串样式指南。