annotate pylintrc @ 0:1d1b9e1b2e2f draft

Uploaded
author petr-novak
date Thu, 19 Dec 2019 10:24:45 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
1 [MASTER]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
2
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
3 # Specify a configuration file.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
4 #rcfile=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
5
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
6 # Python code to execute, usually for sys.path manipulation such as
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
7 # pygtk.require().
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
8
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
9 init-hook='import sys; sys.path.append(".")'
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
10
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
11 # Add files or directories to the blacklist. They should be base names, not
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
12 # paths.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
13 ignore=CVS
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
14
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
15 # Pickle collected data for later comparisons.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
16 persistent=yes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
17
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
18 # List of plugins (as comma separated values of python modules names) to load,
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
19 # usually to register additional checkers.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
20 load-plugins=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
21
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
22 # Use multiple processes to speed up Pylint.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
23 jobs=1
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
24
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
25 # Allow loading of arbitrary C extensions. Extensions are imported into the
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
26 # active Python interpreter and may run arbitrary code.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
27 unsafe-load-any-extension=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
28
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
29 # A comma-separated list of package or module names from where C extensions may
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
30 # be loaded. Extensions are loading into the active Python interpreter and may
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
31 # run arbitrary code
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
32 extension-pkg-whitelist=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
33
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
34 # Allow optimization of some AST trees. This will activate a peephole AST
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
35 # optimizer, which will apply various small optimizations. For instance, it can
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
36 # be used to obtain the result of joining multiple strings with the addition
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
37 # operator. Joining a lot of strings can lead to a maximum recursion error in
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
38 # Pylint and this flag can prevent that. It has one side effect, the resulting
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
39 # AST will be different than the one from reality.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
40 optimize-ast=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
41
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
42
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
43 [MESSAGES CONTROL]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
44
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
45 # Only show warnings with the listed confidence levels. Leave empty to show
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
46 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
47 confidence=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
48
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
49 # Enable the message, report, category or checker with the given id(s). You can
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
50 # either give multiple identifier separated by comma (,) or put this option
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
51 # multiple time (only on the command line, not in the configuration file where
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
52 # it should appear only once). See also the "--disable" option for examples.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
53 #enable=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
54
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
55 # Disable the message, report, category or checker with the given id(s). You
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
56 # can either give multiple identifiers separated by comma (,) or put this
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
57 # option multiple times (only on the command line, not in the configuration
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
58 # file where it should appear only once).You can also use "--disable=all" to
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
59 # disable everything first and then reenable specific checks. For example, if
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
60 # you want to run only the similarities checker, you can use "--disable=all
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
61 # --enable=similarities". If you want to run only the classes checker, but have
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
62 # no Warning level messages displayed, use"--disable=all --enable=classes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
63 # --disable=W"
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
64 disable=parameter-unpacking,suppressed-message,intern-builtin,hex-method,next-method-called,useless-suppression,no-absolute-import,execfile-builtin,metaclass-assignment,setslice-method,unichr-builtin,round-builtin,getslice-method,coerce-method,apply-builtin,print-statement,old-ne-operator,cmp-method,long-builtin,cmp-builtin,reload-builtin,filter-builtin-not-iterating,standarderror-builtin,file-builtin,buffer-builtin,indexing-exception,raising-string,old-octal-literal,range-builtin-not-iterating,oct-method,old-raise-syntax,xrange-builtin,zip-builtin-not-iterating,reduce-builtin,unicode-builtin,raw_input-builtin,coerce-builtin,dict-iter-method,basestring-builtin,long-suffix,delslice-method,dict-view-method,old-division,input-builtin,unpacking-in-except,map-builtin-not-iterating,nonzero-method,import-star-module-level,using-cmp-argument,backtick,W1202
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
65
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
66
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
67 [REPORTS]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
68
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
69 # Set the output format. Available formats are text, parseable, colorized, msvs
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
70 # (visual studio) and html. You can also give a reporter class, eg
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
71 # mypackage.mymodule.MyReporterClass.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
72 output-format=text
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
73
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
74 # Put messages in a separate file for each module / package specified on the
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
75 # command line instead of printing them on stdout. Reports (if any) will be
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
76 # written in a file name "pylint_global.[txt|html]".
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
77 files-output=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
78
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
79 # Tells whether to display a full report or only the messages
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
80 reports=yes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
81
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
82 # Python expression which should return a note less than 10 (10 is the highest
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
83 # note). You have access to the variables errors warning, statement which
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
84 # respectively contain the number of errors / warnings messages and the total
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
85 # number of statements analyzed. This is used by the global evaluation report
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
86 # (RP0004).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
87 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
88
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
89 # Template used to display messages. This is a python new-style format string
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
90 # used to format the message information. See doc for all details
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
91 #msg-template=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
92
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
93
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
94 [MISCELLANEOUS]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
95
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
96 # List of note tags to take in consideration, separated by a comma.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
97 notes=FIXME,XXX,TODO
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
98
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
99
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
100 [BASIC]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
101
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
102 # List of builtins function names that should not be used, separated by a comma
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
103 bad-functions=map,filter
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
104
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
105 # Good variable names which should always be accepted, separated by a comma
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
106 good-names=a,b,c,d,p,f,n,s,i,j,k,ex,Run,_
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
107
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
108 # Bad variable names which should always be refused, separated by a comma
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
109 bad-names=foo,bar,baz,toto,tutu,tata
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
110
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
111 # Colon-delimited sets of names that determine each other's naming style when
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
112 # the name regexes allow several styles.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
113 name-group=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
114
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
115 # Include a hint for the correct naming format with invalid-name
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
116 include-naming-hint=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
117
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
118 # Regular expression matching correct method names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
119 method-rgx=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
120
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
121 # Naming hint for method names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
122 method-name-hint=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
123
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
124 # Regular expression matching correct variable names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
125 variable-rgx=[a-z_][a-z0-9_]{1,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
126
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
127 # Naming hint for variable names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
128 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
129
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
130 # Regular expression matching correct constant names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
131 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
132
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
133 # Naming hint for constant names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
134 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
135
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
136 # Regular expression matching correct class names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
137 class-rgx=[A-Z_][a-zA-Z0-9]+$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
138
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
139 # Naming hint for class names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
140 class-name-hint=[A-Z_][a-zA-Z0-9]+$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
141
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
142 # Regular expression matching correct argument names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
143 argument-rgx=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
144
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
145 # Naming hint for argument names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
146 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
147
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
148 # Regular expression matching correct inline iteration names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
149 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
150
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
151 # Naming hint for inline iteration names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
152 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
153
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
154 # Regular expression matching correct module names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
155 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
156
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
157 # Naming hint for module names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
158 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
159
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
160 # Regular expression matching correct class attribute names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
161 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
162
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
163 # Naming hint for class attribute names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
164 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
165
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
166 # Regular expression matching correct function names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
167 function-rgx=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
168
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
169 # Naming hint for function names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
170 function-name-hint=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
171
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
172 # Regular expression matching correct attribute names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
173 attr-rgx=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
174
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
175 # Naming hint for attribute names
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
176 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
177
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
178 # Regular expression which should only match function or class names that do
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
179 # not require a docstring.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
180 no-docstring-rgx=^_
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
181
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
182 # Minimum line length for functions/classes that require docstrings, shorter
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
183 # ones are exempt.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
184 docstring-min-length=-1
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
185
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
186
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
187 [ELIF]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
188
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
189 # Maximum number of nested blocks for function / method body
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
190 max-nested-blocks=5
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
191
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
192
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
193 [SPELLING]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
194
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
195 # Spelling dictionary name. Available dictionaries: none. To make it working
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
196 # install python-enchant package.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
197 spelling-dict=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
198
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
199 # List of comma separated words that should not be checked.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
200 spelling-ignore-words=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
201
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
202 # A path to a file that contains private dictionary; one word per line.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
203 spelling-private-dict-file=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
204
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
205 # Tells whether to store unknown words to indicated private dictionary in
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
206 # --spelling-private-dict-file option instead of raising a message.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
207 spelling-store-unknown-words=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
208
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
209
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
210 [TYPECHECK]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
211
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
212 # Tells whether missing members accessed in mixin class should be ignored. A
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
213 # mixin class is detected if its name ends with "mixin" (case insensitive).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
214 ignore-mixin-members=yes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
215
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
216 # List of module names for which member attributes should not be checked
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
217 # (useful for modules/projects where namespaces are manipulated during runtime
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
218 # and thus existing member attributes cannot be deduced by static analysis. It
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
219 # supports qualified module names, as well as Unix pattern matching.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
220 ignored-modules=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
221
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
222 # List of classes names for which member attributes should not be checked
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
223 # (useful for classes with attributes dynamically set). This supports can work
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
224 # with qualified names.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
225 ignored-classes=DataFiles,R
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
226
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
227 # List of members which are set dynamically and missed by pylint inference
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
228 # system, and so shouldn't trigger E1101 when accessed. Python regular
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
229 # expressions are accepted.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
230 generated-members=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
231
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
232
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
233 [FORMAT]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
234
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
235 # Maximum number of characters on a single line.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
236 max-line-length=100
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
237
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
238 # Regexp for a line that is allowed to be longer than the limit.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
239 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
240
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
241 # Allow the body of an if to be on the same line as the test if there is no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
242 # else.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
243 single-line-if-stmt=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
244
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
245 # List of optional constructs for which whitespace checking is disabled. `dict-
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
246 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
247 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
248 # `empty-line` allows space-only lines.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
249 no-space-check=trailing-comma,dict-separator
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
250
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
251 # Maximum number of lines in a module
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
252 max-module-lines=1000
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
253
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
254 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
255 # tab).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
256 indent-string=' '
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
257
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
258 # Number of spaces of indent required inside a hanging or continued line.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
259 indent-after-paren=4
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
260
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
261 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
262 expected-line-ending-format=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
263
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
264
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
265 [LOGGING]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
266
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
267 # Logging modules to check that the string format arguments are in logging
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
268 # function parameter format
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
269 logging-modules=logging
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
270
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
271
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
272 [SIMILARITIES]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
273
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
274 # Minimum lines number of a similarity.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
275 min-similarity-lines=4
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
276
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
277 # Ignore comments when computing similarities.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
278 ignore-comments=yes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
279
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
280 # Ignore docstrings when computing similarities.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
281 ignore-docstrings=yes
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
282
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
283 # Ignore imports when computing similarities.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
284 ignore-imports=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
285
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
286
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
287 [VARIABLES]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
288
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
289 # Tells whether we should check for unused import in __init__ files.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
290 init-import=no
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
291
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
292 # A regular expression matching the name of dummy variables (i.e. expectedly
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
293 # not used).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
294 dummy-variables-rgx=_$|dummy
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
295
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
296 # List of additional names supposed to be defined in builtins. Remember that
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
297 # you should avoid to define new builtins when possible.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
298 additional-builtins=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
299
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
300 # List of strings which can identify a callback function by name. A callback
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
301 # name must start or end with one of those strings.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
302 callbacks=cb_,_cb
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
303
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
304
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
305 [IMPORTS]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
306
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
307 # Deprecated modules which should not be used, separated by a comma
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
308 deprecated-modules=optparse
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
309
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
310 # Create a graph of every (i.e. internal and external) dependencies in the
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
311 # given file (report RP0402 must not be disabled)
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
312 import-graph=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
313
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
314 # Create a graph of external dependencies in the given file (report RP0402 must
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
315 # not be disabled)
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
316 ext-import-graph=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
317
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
318 # Create a graph of internal dependencies in the given file (report RP0402 must
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
319 # not be disabled)
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
320 int-import-graph=
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
321
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
322
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
323 [DESIGN]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
324
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
325 # Maximum number of arguments for function / method
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
326 max-args=20
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
327
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
328 # Argument names that match this expression will be ignored. Default to name
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
329 # with leading underscore
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
330 ignored-argument-names=_.*
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
331
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
332 # Maximum number of locals for function / method body
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
333 max-locals=20
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
334
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
335 # Maximum number of return / yield for function / method body
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
336 max-returns=6
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
337
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
338 # Maximum number of branch for function / method body
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
339 max-branches=12
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
340
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
341 # Maximum number of statements in function / method body
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
342 max-statements=50
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
343
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
344 # Maximum number of parents for a class (see R0901).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
345 max-parents=7
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
346
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
347 # Maximum number of attributes for a class (see R0902).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
348 max-attributes=30
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
349
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
350 # Minimum number of public methods for a class (see R0903).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
351 min-public-methods=0
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
352
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
353 # Maximum number of public methods for a class (see R0904).
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
354 max-public-methods=20
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
355
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
356 # Maximum number of boolean expressions in a if statement
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
357 max-bool-expr=5
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
358
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
359
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
360 [CLASSES]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
361
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
362 # List of method names used to declare (i.e. assign) instance attributes.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
363 defining-attr-methods=__init__,__new__,setUp
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
364
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
365 # List of valid names for the first argument in a class method.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
366 valid-classmethod-first-arg=cls
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
367
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
368 # List of valid names for the first argument in a metaclass class method.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
369 valid-metaclass-classmethod-first-arg=mcs
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
370
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
371 # List of member names, which should be excluded from the protected access
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
372 # warning.
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
373 exclude-protected=_asdict,_fields,_replace,_source,_make
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
374
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
375
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
376 [EXCEPTIONS]
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
377
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
378 # Exceptions that will emit a warning when being caught. Defaults to
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
379 # "Exception"
1d1b9e1b2e2f Uploaded
petr-novak
parents:
diff changeset
380 overgeneral-exceptions=Exception