如何在Pylint中的文件级别禁用“缺少docstring”警告？

Question

Pylint会抛出某些文件缺少文档字符串的错误。我尝试将docstrings添加到每个类，方法和函数，但似乎Pylint还检查文件应该在文档字符串的开头。我可以以某种方式禁用它吗？我希望收到有关类，函数或方法中缺少docstring的通知，但对于文件来说，文件字符串不应该是强制性的。

（在专有源文件的开头是否有一个法律术语的术语？任何例子？我不知道是否可以单独发布这样一个微不足道的问题。）

Answer 1

Python模块有一个文档字符串很好，解释了模块的功能，它提供了什么，以及如何使用类的示例。这与您经常在文件开头提供版权和许可信息时看到的评论不同，IMO不应该在文档字符串中（有些人甚至认为它们应该完全消失，参见例如.http://hackerboss.com/get-rid-of-templates/）

Pylint没有单独的代码用于可以发生文档字符串的各个位置，因此您所能做的就是禁用C0111。问题是，如果你在模块范围禁用它，那么它将在模块中的任何地方被禁用（即你不会得到任何C行缺少函数/类/方法docstring。这可能是不好的，你可能想要如果它困扰你，为这个pylint issue on github做贡献。

所以我建议添加一些小的缺失docstring，说：

"""
high level support for doing this and that.
"""

很快，您将找到有用的东西放在那里，例如提供如何使用模块的各种类/函数的示例，这些类/函数不一定属于类/函数的各个文档字符串（例如如何互动，或类似快速入门指南的东西）。

Answer 2

现在已经很晚了，但我发现它很有用。所以分享。发现这个here。

您可以为pylint添加“--errors-only”标志以禁用警告。

为此，请转到设置。编辑以下行：

"python.linting.pylintArgs": []

如

"python.linting.pylintArgs": ["--errors-only"]

你很高兴去！

Answer 3

我来寻找答案是因为，正如@cerin所说，在Django项目中，将模块文档字符串添加到django在创建新应用程序时自动生成的每个文件时都很麻烦且多余。

因此，作为pylint不允许您在docstring类型中指定差异的事实的解决方法，您可以这样做：

pylint */*.py --msg-template='{path}: {C}:{line:3d},{column:2d}: {msg}' | grep docstring | grep -v module

你必须更新msg-template，这样当你grep时你仍然会知道文件名。这将返回除模块之外的所有其他missing-docstring类型。

然后你可以解决所有这些错误，然后运行：

pylint */*.py --disable=missing-docstring

Answer 4

不，Pylint目前不允许您区分doc-string警告。

但是，您可以使用flake8进行所有python代码检查以及doc-string扩展，以忽略此警告。

使用pip安装doc-string扩展名（内部使用pydocstyle）。

pip install flake8_docstrings

然后你可以使用--ignore D100开关。例如flake8 file.py --ignore D100

Answer 5

我认为修复相对容易而不会禁用此功能。

def kos_root():
    """Return the pathname of the KOS root directory."""
    global _kos_root
    if _kos_root: return _kos_root

您需要做的就是在每个函数中添加三重双引号字符串。