• Python项目的最佳flake8扩展
  • 发布于 2个月前
  • 129 热度
    0 评论


正如我们所看到的,Flake8是几个工具的包装器,并且可以通过插件进行扩展:这意味着你可以添加自己的检查。我是Flake8的忠实用户,依赖一些插件来扩展Python中常见编程错误的检查范围。以下是我工作所必须的一些插件清单。作为奖励,你会在本文的末尾找到一个我的首选 tox.ini文件实例。
flake8-import-order
名称非常清楚:此扩展检查文件开头import语句的顺序。默认情况下,它使用了我喜欢的样式,看起来像:

import os
import sys
import requests
import yaml
import myproject
from myproject.utils import somemodule


内建模块被分为第一个组。紧接着每一个被引入的第三方模块作为一个分组。最后一个分组管理当前项目的模块。我发现这种组织模块引入的方式非常清晰易读。
为了确保flake8-import-order知道你项目模块的名称,你需要在tox.ini文件中以application-import-names的选项形式定义它。
如果你想尝试不同的样式,你可以通过设置import-order-style选项来使用flake8-import-order默认提供的其他样式。显然,你也可以提供自己的样式。


flake8-blind-except
flake8-blind-except扩展用来检查在没有定义异常类型的情况下不使用except语句。因此,下列摘录的语句被认为是无效的:

try:
    do_something()
except:
    pass


使用except而不指定任何异常类型的做法是不好的,因为它可能捕获不需要的异常。它迫使开发人员考虑什么类型的错误可能产生,并且应该被真正捕获。
在极少的情况下,任何异常才都需要被捕获,不管怎样,使用except  Exception仍然是可以的。


flake8-builtins
flake8-builtins插件检查你的代码和Python内建变量之间没有名称冲突。
例如,这段代码会触发一个错误:

def first(list):
    return list[0]


由于list是Python中的一个内建函数(用于创建一个列表!),在函数签名中使用list作为参数名来隐藏它的定义会触发来自flake8-builtins的警告。
虽然代码是有效的,但是重写Python内置函数是一个坏习惯。它可能会导致一些棘手的错误;在上面的例子中,如果你需要调用list(),那你将无法调用它。


flake8-logging-format
这个模块很方便,因为它仍然不时敲打我的手指。当使用logging模块时,它会阻止编写这类代码:

mylogger.info("Hello %s" % mystring)

虽然这是可行的,但它是次优的,因为它强制进行字符串插入。如果日志记录器被配置为只打印警告级别或更高级别的日志信息,那么在这里进行字符串插入是没有意义的。
因此,我们应该这样写:

mylogger.info("Hello %s", mystring)

如果你使用format模块来进行任何格式化,情况也是如此。
请注意,与其他flake8模块相反,这个模块在默认情况下不启用检查。你需要在你的tox.ini文件中添加enable-extensions=G来启用它。


flake8-docstrings
flake8-docstrings模块检查你的Python文档注释内容是否符合PEP 257。这个PEP包含了关于正确格式化文档注释的小细节,如果没有这样的工具,你将无法做到这一点。一个简单的例子是:

class Foobar:
    """A foobar"""

虽然这段代码看起来是有效的,但是在文档注释的末尾有一个缺失的地方。
相信我,特别是如果你正在编写一个被其他开发人员使用的库,那么这是一个必须拥有的扩展模块。


flake8-rst-docstrings
这个扩展是对flake8-docstrings的一个很好的补充:它检查你的文档注释内容是否有效。这很简单,所以我毫不犹豫地安装了它。同样,如果你的项目导出了使用Sphinx构建的文档化API,那么这个扩展是必须具备的。


我的标准tox.ini文件
这是一个我在我的大多数项目中使用的标准的tox.ini摘录。你可以复制粘贴并使用它。

[testenv:pep8]
deps = flake8
       flake8-import-order
       flake8-blind-except
       flake8-builtins
       flake8-docstrings
       flake8-rst-docstrings
       flake8-logging-format
commands = flake8

[flake8]
exclude = .tox
# If you need to ignore some error codes in the whole source code
# you can write them here
# ignore = D100,D101
show-source = true
enable-extensions=G
application-import-names = <myprojectname>

在为你的整个项目禁用错误代码之前,请记住,你可以通过在行尾添加# noqa标记来强制flake8忽略特定的错误实例。
如果你有任何你认为有用的flake8扩展,请在评论区告诉我!

用户评论