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