pylint 用法大全 | Google Python 代码检查规范

Lint

Tip

用 pylintrc 运行 pylint，以检查你的代码。

定义：

pylint 是在 Python 代码中寻找 bug 和格式问题的工具。它寻找的问题就像 C 和 C++ 这些更静态的（译者注: 原文是less dynamic）语言中编译器捕捉的问题。出于 Python 的动态特性，部分警告可能有误。不过，误报应该不常见。

优点：

可以发现疏忽，例如拼写错误，使用未赋值的变量等。

缺点：

pylint 不完美。要利用其优势，我们有时侯需要: a) 绕过它 b) 抑制它的警告 或者 c) 改进它。

结论：

一定要用 pylint 检查你的代码。

抑制不恰当的警告，以免其他问题被警告淹没。你可以用行注释来抑制警告。例如：

def do_PUT(self):  # WSGI 接口名，所以 pylint: disable=invalid-name
    ...

pylint 的警告均以符号名(如 empty-docstring )来区分。谷歌特有的警告以 g- 为前缀。

如果警告的符号名不够见名知意，那么请添加注释。

这种抑制方式的好处是，我们可以轻易搜索并重新评判这些注释。

你可以用命令 pylint --list-msgs 来列出 pylint 的所有警告。你可以用命令 pylint --help-msg=invalid-name 来查询某个警告的详情。

相较于旧的格式 pylint: disable-msg ，本文推荐使用 pylint: disable 。

如果有“参数未使用”的警告，你可以在函数体开头删除无用的变量，以消除警告。一定要用注释说明你为什么删除这些变量。注明“未使用”即可。

例如：

def viking_cafe_order(spam: str, beans: str, eggs: str | None = None) -> str:
    del beans, eggs  # 未被维京人使用.
    return spam + spam + spam

（译者注：Viking 意为维京人。）

其他避免这种警告的常用方法还有： 用_作为未使用参数的名称；给这些参数名加上前缀 unused_；或者把它们赋值给变量 _。我们允许但是不再推荐这些方法。这会导致调用者无法通过参数名来传参，也不能保证变量确实没被引用。