[TOC]
英语官方文档 http://flake8.pycqa.org/en/latest/index.html
https://pypi.python.org/pypi/flake8/
安装
# 安装到特定版本
sudo python<version> -m pip install flake8
# 安装到默认python
python -m install flake8
不同版本的python一定要安装对应的版本的flake8
使用flake8
我们能通过多种方法使用flake8,例如:
- 在命令行里面引用
- 通过python使用
- 在git或者Mercurial在commit的时候调用flake8
引用flake8
在大多数情况下,你一般会这样子用flake8:
$ flake8 ...
你能在你terminal里面简单地运行本地的flake8.有些时候,尽管你已经安装可多个版本的python(e.g.,pthon2.7 和python3.5),但是你必须指定你要调用的版本。在这种情况下,这样子使用会更好:
$ python2.7 -m flake8
或者
$ python3.5 -m flake8
这样子你能使用确切版本的python去调用flake8.
也能直接给flake8直接制定命令行选项:
$ flake8 --select E123
或者
$ python<version> -m flake8 --select E123
可以指定你想要检查的路径和目录来限制flake8的检查范围。假设你有一个my_project目录,里面有python文件和子目录,子目录里面也有python文件(或者有更多层级的子目录)。如果你只想要检查my_project下面的文件,我们可以这样子做:
$ flake8 my_project
如果你只想检查这些文件的特定的错误类型(e.g., E123),你也可以:
$ flake8 --select E123 my_project
r如果你想要看跟多的选项,你可以使用 --help选项:
$ flake8 --help
配置flake8
在你学会引用flake8之后,你就会想这怎么去配置flake8,这样子你就不要用每次引用的时候都要指定一眼的选项了。
这个部分我们会给你展示如何做到
$ flake8
就能使用到你想要的特定选项,而不用写成
$ flake --select E123,W456 --enable-extensions H111
本地配置
flake8 支持把你的配置保存在下列地方:
- 你的用户的最高级别的目录
- 你的一个带有setup.cfg,tox.ini,或者.flake8的工程
"用户"配置
flake8允许用户使用"global"配置文件去保存选项参数。用户配置文件会保存在用户的家目录。
- 在windows下,家目录类似
c:\\Users\abel # 或者是写成 ~\
- 在linux系统那么就是
~/
用户配置和工程配置使用一样的语法。往下看你会看到语法
工程配置
待续。。。。