1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
.TH FLAKE8 "1" "November 2016"
.SH NAME
flake8 \- code checker using pycodestyle and pyflakes
.SH SYNOPSIS
.B flake8
[\fIoptions\fR] \fIinput \fR...
.SH DESCRIPTION
.sp
\fBflake8\fP is a command\-line utility for enforcing style consistency across
Python projects. By default it includes lint checks provided by the PyFlakes
project, PEP\-0008 inspired style checks provided by the PyCodeStyle project,
and McCabe complexity checking provided by the McCabe project. It will also
run third\-party extensions if they are found and installed.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
print more information about what is happening in
flake8. This option is repeatable and will increase
verbosity each time it is repeated.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
report only file names, or nothing. This option is
repeatable.
.TP
\fB\-\-count\fR
print total number of errors and warnings to standard
error and set the exit code to 1 if total is not
empty.
.TP
\fB\-\-diff\fR
report changes only within line number ranges in the
unified diff provided on standard in by the user.
.TP
\fB\-\-exclude\fR=\fI\,patterns\/\fR
comma\-separated list of files or directories to
exclude. (Default:
\&.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg)
.TP
\fB\-\-filename\fR=\fI\,patterns\/\fR
only check for filenames matching the patterns in this
comma\-separated list. (Default: *.py)
.TP
\fB\-\-stdin\-display\-name\fR=\fI\,STDIN_DISPLAY_NAME\/\fR
the name used when reporting errors from code passed
via stdin. This is useful for editors piping the file
contents to flake8. (Default: stdin)
.TP
\fB\-\-format\fR=\fI\,format\/\fR
format errors according to the chosen formatter.
.TP
\fB\-\-hang\-closing\fR
hang closing bracket instead of matching indentation
of opening bracket's line.
.TP
\fB\-\-ignore\fR=\fI\,errors\/\fR
comma\-separated list of errors and warnings to ignore
(or skip). For example, \fB\-\-ignore\fR=E4,E51,W234.
(Default: E121,E123,E126,E226,E24,E704,W503,W504)
.TP
\fB\-\-max\-line\-length\fR=\fI\,n\/\fR
maximum allowed line length for the entirety of this
run. (Default: 79)
.TP
\fB\-\-select\fR=\fI\,errors\/\fR
comma\-separated list of errors and warnings to enable.
For example, \fB\-\-select\fR=E4,E51,W234. (Default: E,F,W,C90)
.TP
\fB\-\-disable\-noqa\fR
disable the effect of "# noqa". This will report
errors on lines with "# noqa" at the end.
.TP
\fB\-\-show\-source\fR
show the source generate each error or warning.
.TP
\fB\-\-statistics\fR
count errors and warnings.
.TP
\fB\-\-enable\-extensions\fR=\fI\,ENABLE_EXTENSIONS\/\fR
enable plugins and extensions that are otherwise
disabled by default
.TP
\fB\-\-exit\-zero\fR
exit with status code "0" even if there are errors.
.TP
\fB\-\-install\-hook\fR=\fI\,INSTALL_HOOK\/\fR
install a hook that is run prior to a commit for the
supported version control systema.
.TP
\fB\-j\fR \fIJOBS\fR, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
number of subprocesses to use to run checks in
parallel. This is ignored on Windows. The default,
"auto", will auto\-detect the number of processors
available to use. (Default: auto)
.TP
\fB\-\-output\-file\fR=\fI\,OUTPUT_FILE\/\fR
redirect report to a file.
.TP
\fB\-\-tee\fR
write to stdout and output\-file.
.TP
\fB\-\-append\-config\fR=\fI\,APPEND_CONFIG\/\fR
provide extra config files to parse in addition to the
files found by Flake8 by default. These files are the
last ones read and so they take the highest precedence
when multiple files provide the same option.
.TP
\fB\-\-config\fR=\fI\,CONFIG\/\fR
path to the config file that will be the authoritative
config source. This will cause Flake8 to ignore all
other configuration files.
.TP
\fB\-\-isolated\fR
ignore all found configuration files.
.TP
\fB\-\-benchmark\fR
print benchmark information about this run of Flake8
.TP
\fB\-\-max\-complexity\fR=\fI\,MAX_COMPLEXITY\/\fR
McCabe complexity threshold
\fB\-\-bug\-report\fR
print information necessary when preparing a bug report
.TP
\fB\-\-builtins\fR=\fI\,BUILTINS\/\fR
define more built\-ins, comma separated
.TP
\fB\-\-doctests\fR
check syntax of the doctests
.TP
\fB\-\-include\-in\-doctest\fR=\fI\,INCLUDE_IN_DOCTEST\/\fR
run doctests only on these files
.TP
\fB\-\-exclude\-from\-doctest\fR=\fI\,EXCLUDE_FROM_DOCTEST\/\fR
skip these files when running doctests
.PP
.SH "CONFIGURATION"
The project options are read from the [flake8] section of the tox.ini
file or the setup.cfg file located in any parent folder of the path(s)
being processed. Allowed options are: exclude, filename, select,
ignore, max\-line\-length, hang\-closing, count, format, quiet, showpep8, show\-source, statistics, verbose, max\-complexity, builtins.
|
