是否可以为短函数和方法禁用 pylint 缺少文档字符串错误？

Question

Pylint 为每个没有文档字符串的函数和方法（__init__ 除外）报告错误。

这通常是可取的，所以我不想全局禁用它（在pylintrc 或文件级别）。

但是，在我看来，有些情况下文档字符串是不必要的，甚至是有害的。例如：

def get_foo(self, foo_id):
    """Gets foo by its id."""
    return foos[foo_id]

这个方法是一个简单的getter，完全由它的签名来描述。必须编写文档字符串是有害的，因为如果更改方法，它会产生重复的维护。

我希望能够设置（例如在pylintrc 中）类似docstring_threshold=3 的内容，以在函数或方法少于 3 行代码时抑制丢失的文档字符串错误。有什么办法吗？

Answer 1

例如，使用 pylint 1.3.1 向您添加一行 pylintrc docstring-min-length=10。

在生成的pylintrcpylint --generate-rcfile文件中描述为

需要文档字符串的函数/类的最小行长度，较短的除外。

Documentation reference.