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
|
.TH PYCODESTYLE "1" "November 2016" "pycodestyle 2.0.0" "User Commands"
.SH NAME
pycodestyle \- A tool to check your Python code against some of the style conventions in PEP 8.
.SH SYNOPSIS
.B pycodestyle
[\fIoptions\fR] \fIinput \fR...
.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 status messages, or debug with \fB\-vv\fR
.TP
\fB\-q\fR, \fB\-\-quiet\fR
report only file names, or nothing with \fB\-qq\fR
.TP
\fB\-\-exclude\fR=\fIpatterns\fR
exclude files or directories which match these comma separated patterns (default: .svn,CVS,.bzr,.hg,.git,__pycache__,.tox)
.TP
\fB\-\-filename\fR=\fIpatterns\fR
when parsing directories, only check filenames matching these comma separated patterns (default: *.py)
.TP
\fB\-\-select\fR=\fIerrors\fR
select errors and warning (e.g. E,W6)
.TP
\fB\-\-ignore\fR=\fIerrors\fR
skip errors and warnings (e.g. E4,W)
(default: E121,E123,E126,E226,E24,E704,W503)
.TP
\fB\-\-first\fR
show first occurrence of each error
.TP
\fB\-r\fR, \fB\-\-repeat\fR
(obsolete) show all occurrences of the same error
.TP
\fB\-\-show\-source\fR
show source code for each error
.TP
\fB\-\-show\-pep8\fR
show text of PEP 8 for each error (implies \-\-first)
.TP
\fB\-\-statistics\fR
count errors and warnings
.TP
\fB\-\-count\fR
print total number of errors and warnings to standard error and set exit code to 1 if total is not null
.TP
\fB\-\-max\-line\-length\fR=\fIn\fR
set maximum allowed line length (default: 79)
.TP
\fB\-\-hang-closing\fR
hang closing bracket instead of matching indentation of opening bracket's line
.TP
\fB\-\-format\fR=\fIformat\fR
set the error format [default|pylint|<custom>]
.TP
\fB\-\-diff\fR
report only lines changed according to the unified diff received on STDIN
.TP
\fB\-\-benchmark\fR
measure processing speed
.TP
\fB\-\-config\fR=\fIpath\fR
user config file location (default: $HOME/.config/pycodestyle)
.TP
.SH "USAGE EXAMPLES"
.TP
Display how often each error was found:
.sp
% pycodestyle \-\-statistics \-qq example/lib/
.TP
Show source code and more verbose explanation from PEP 8:
.sp
% pycodestyle \-\-show-source \-\-show-pep8 foo.py
.SH AUTHOR
This manual page was written by David Watson <dwatson@debian.org>, Michael Prokop <mika@debian.org> and Ondřej Nový <onovy@debian.org>.
|
