3
# Specify a configuration file.
6
# Python code to execute, usually for sys.path manipulation such as
10
# Add files or directories to the blacklist. They should be base names, not
14
# Pickle collected data for later comparisons.
17
# List of plugins (as comma separated values of python modules names) to load,
18
# usually to register additional checkers.
21
# Use multiple processes to speed up Pylint.
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
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
31
extension-pkg-whitelist=
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.
44
# Only show warnings with the listed confidence levels. Leave empty to show
45
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
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.
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
63
disable=missing-docstring,no-else-return,logging-not-lazy
68
# Set the output format. Available formats are text, parseable, colorized, msvs
69
# (visual studio) and html. You can also give a reporter class, eg
70
# mypackage.mymodule.MyReporterClass.
73
# Put messages in a separate file for each module / package specified on the
74
# command line instead of printing them on stdout. Reports (if any) will be
75
# written in a file name "pylint_global.[txt|html]".
78
# Tells whether to display a full report or only the messages
81
# Python expression which should return a note less than 10 (10 is the highest
82
# note). You have access to the variables errors warning, statement which
83
# respectively contain the number of errors / warnings messages and the total
84
# number of statements analyzed. This is used by the global evaluation report
86
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
88
# Template used to display messages. This is a python new-style format string
89
# used to format the message information. See doc for all details
95
# Logging modules to check that the string format arguments are in logging
96
# function parameter format
97
logging-modules=logging
102
# List of builtins function names that should not be used, separated by a comma
103
bad-functions=map,filter
105
# Good variable names which should always be accepted, separated by a comma
106
good-names=i,j,k,ex,Run,_
108
# Bad variable names which should always be refused, separated by a comma
109
bad-names=foo,bar,baz,toto,tutu,tata
111
# Colon-delimited sets of names that determine each other's naming style when
112
# the name regexes allow several styles.
115
# Include a hint for the correct naming format with invalid-name
116
include-naming-hint=no
118
# Regular expression matching correct argument names
119
argument-rgx=[a-z_][a-z0-9_]{0,30}$
121
# Naming hint for argument names
122
argument-name-hint=[a-z_][a-z0-9_]{0,30}$
124
# Regular expression matching correct function names
125
function-rgx=[a-z_][a-z0-9_]{2,45}$
127
# Naming hint for function names
128
function-name-hint=[a-z_][a-z0-9_]{2,45}$
130
# Regular expression matching correct variable names
131
variable-rgx=[a-z_][a-z0-9_]{0,45}$
133
# Naming hint for variable names
134
variable-name-hint=[a-z_][a-z0-9_]{0,45}$
136
# Regular expression matching correct attribute names
137
attr-rgx=[a-z_][a-z0-9_]{1,30}$
139
# Naming hint for attribute names
140
attr-name-hint=[a-z_][a-z0-9_]{1,30}$
142
# Regular expression matching correct class names
143
class-rgx=[A-Z_][a-zA-Z0-9]+$
145
# Naming hint for class names
146
class-name-hint=[A-Z_][a-zA-Z0-9]+$
148
# Regular expression matching correct inline iteration names
149
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
151
# Naming hint for inline iteration names
152
inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
154
# Regular expression matching correct method names
155
method-rgx=[a-z_][a-z0-9_]{2,45}$
157
# Naming hint for method names
158
method-name-hint=[a-z_][a-z0-9_]{2,45}$
160
# Regular expression matching correct constant names
161
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
163
# Naming hint for constant names
164
const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
166
# Regular expression matching correct class attribute names
167
class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
169
# Naming hint for class attribute names
170
class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
172
# Regular expression matching correct module names
173
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
175
# Naming hint for module names
176
module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
178
# Regular expression which should only match function or class names that do
179
# not require a docstring.
182
# Minimum line length for functions/classes that require docstrings, shorter
184
docstring-min-length=-1
189
# Maximum number of nested blocks for function / method body
195
# List of note tags to take in consideration, separated by a comma.
201
# Minimum lines number of a similarity.
202
min-similarity-lines=4
204
# Ignore comments when computing similarities.
207
# Ignore docstrings when computing similarities.
208
ignore-docstrings=yes
210
# Ignore imports when computing similarities.
216
# Tells whether missing members accessed in mixin class should be ignored. A
217
# mixin class is detected if its name ends with "mixin" (case insensitive).
218
ignore-mixin-members=yes
220
# List of module names for which member attributes should not be checked
221
# (useful for modules/projects where namespaces are manipulated during runtime
222
# and thus existing member attributes cannot be deduced by static analysis. It
223
# supports qualified module names, as well as Unix pattern matching.
226
# List of classes names for which member attributes should not be checked
227
# (useful for classes with attributes dynamically set). This supports can work
228
# with qualified names.
229
ignored-classes=LexResult
231
# List of members which are set dynamically and missed by pylint inference
232
# system, and so shouldn't trigger E1101 when accessed. Python regular
233
# expressions are accepted.
239
# Tells whether we should check for unused import in __init__ files.
242
# A regular expression matching the name of dummy variables (i.e. expectedly
244
dummy-variables-rgx=_$|dummy
246
# List of additional names supposed to be defined in builtins. Remember that
247
# you should avoid to define new builtins when possible.
250
# List of strings which can identify a callback function by name. A callback
251
# name must start or end with one of those strings.
257
# Maximum number of characters on a single line.
260
# Regexp for a line that is allowed to be longer than the limit.
261
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
263
# Allow the body of an if to be on the same line as the test if there is no
265
single-line-if-stmt=no
267
# List of optional constructs for which whitespace checking is disabled. `dict-
268
# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
269
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
270
# `empty-line` allows space-only lines.
271
no-space-check=trailing-comma,dict-separator
273
# Maximum number of lines in a module
274
max-module-lines=3500
276
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
280
# Number of spaces of indent required inside a hanging or continued line.
283
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
284
expected-line-ending-format=
289
# Spelling dictionary name. Available dictionaries: none. To make it working
290
# install python-enchant package.
293
# List of comma separated words that should not be checked.
294
spelling-ignore-words=
296
# A path to a file that contains private dictionary; one word per line.
297
spelling-private-dict-file=
299
# Tells whether to store unknown words to indicated private dictionary in
300
# --spelling-private-dict-file option instead of raising a message.
301
spelling-store-unknown-words=no
306
# Deprecated modules which should not be used, separated by a comma
307
deprecated-modules=optparse
309
# Create a graph of every (i.e. internal and external) dependencies in the
310
# given file (report RP0402 must not be disabled)
313
# Create a graph of external dependencies in the given file (report RP0402 must
317
# Create a graph of internal dependencies in the given file (report RP0402 must
324
# List of method names used to declare (i.e. assign) instance attributes.
325
defining-attr-methods=__init__,__new__,setUp
327
# List of valid names for the first argument in a class method.
328
valid-classmethod-first-arg=cls
330
# List of valid names for the first argument in a metaclass class method.
331
valid-metaclass-classmethod-first-arg=mcs
333
# List of member names, which should be excluded from the protected access
335
exclude-protected=_asdict,_fields,_replace,_source,_make
340
# Maximum number of arguments for function / method
343
# Argument names that match this expression will be ignored. Default to name
344
# with leading underscore
345
ignored-argument-names=_.*
347
# Maximum number of locals for function / method body
350
# Maximum number of return / yield for function / method body
353
# Maximum number of branch for function / method body
356
# Maximum number of statements in function / method body
359
# Maximum number of parents for a class (see R0901).
362
# Maximum number of attributes for a class (see R0902).
365
# Minimum number of public methods for a class (see R0903).
368
# Maximum number of public methods for a class (see R0904).
369
max-public-methods=20
371
# Maximum number of boolean expressions in a if statement
377
# Exceptions that will emit a warning when being caught. Defaults to
379
overgeneral-exceptions=Exception