如何在Pylint的文件级别禁用“缺少文档字符串”警告？

Pylint引发错误，指出某些文件缺少文档字符串。我尝试为每个类，方法和函数添加docstring，但是Pylint似乎还在检查文件的开头是否应该有docstring。我可以以某种方式禁用它吗？我想在类，函数或方法中缺少文档字符串的通知，但对于具有文档字符串的文件，这不是强制性的。

（是否在专有源文件的开头经常出现法律术语？是否有任何示例？我不知道单独发布这样一个琐碎的问题是否可以。）

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

在pylint 2.4及更高版本中，您可以missing-docstring通过使用以下三个子消息来区分各种类型：

• C0114（missing-module-docstring）
• C0115（missing-class-docstring）
• C0116（missing-function-docstring）

因此以下.pylintrc文件应该工作：

[MASTER]
disable=
    C0114, # missing-module-docstring

对于以前的Pylint版本，它没有针对文档字符串可能出现的各个位置的单独代码，因此您只能禁用C0111。问题是，如果您在模块范围内禁用此功能，那么它将在模块中的所有位置都被禁用（即，由于缺少函数/类/方法文档字符串，您将不会得到任何C行。这可能不太好。

因此，我建议添加一个小的缺少的文档字符串，例如：

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

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

已经很晚了，但我仍然觉得它很有用。所以分享。在这里找到这个。

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

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

"python.linting.pylintArgs": []

如

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

而且你很好！

我认为在不禁用此功能的情况下，修复相对容易。

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

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

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

因此，作为pylint不允许您指定文档字符串类型不同的事实的解决方法，您可以执行以下操作：

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

您必须更新msg-template，以便在grep时仍会知道文件名。这将返回除模块以外的所有其他缺少文档字符串类型。

然后，您可以修复所有这些错误，然后运行：

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

否。Pylint当前不允许您区分文档字符串警告。

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

使用pip安装doc字符串扩展名（内部使用pydocstyle）。

pip install flake8_docstrings

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

只需将以下行放在要禁用这些警告的任何文件的开头。

# pylint: disable=missing-module-docstring
# pylint: disable=missing-class-docstring
# pylint: disable=missing-function-docstring

在pylint 2.4及更高版本中，您可以missing-docstring通过使用以下三个子消息来区分各种类型：

• C0114（missing-module-docstring）
• C0115（missing-class-docstring）
• C0116（missing-function-docstring）

因此以下.pylintrc文件应该工作：

[MASTER]
disable=
    C0114, # missing-module-docstring

编辑“ C：\ Users \您的User \ AppData \ Roaming \ Code \ User \ settings.json”，并将这些python.linting.pylintArgs行添加到末尾，如下所示：

{
    "team.showWelcomeMessage": false,
    "python.dataScience.sendSelectionToInteractiveWindow": true,
    "git.enableSmartCommit": true,
    "powershell.codeFormatting.useCorrectCasing": true,
    "files.autoSave": "onWindowChange",
    "python.linting.pylintArgs": [
        "--load-plugins=pylint_django",
        "--errors-only"
    ],
}

（1）CTRL + SHIFT + P（2）然后键入并单击> preferences：配置特定于语言的设置（3），然后在代码后键入python

{
"python.linting.pylintArgs": [
    "--load-plugins=pylint_django","--errors-only"
],

}

就我而言，使用pylint 2.6.0，即使显式禁用了missing-module-docstring，missing-class-docstring并且missing-function-docstring在我的.pylintrc文件中，丢失的docstring消息也不会消失。最后，以下配置对我有用：

[MESSAGES CONTROL]

disable=missing-docstring,empty-docstring

显然，除非同时禁用两个检查，否则pylint 2.6.0仍将验证文档字符串。

转到“ settings.json”并禁用python pydocstyle

"python.linting.pydocstyleEnabled": false