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