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 # Add files or directories matching the regex patterns to the blacklist. The
15 # regex matches against base names, not paths.
18 # Pickle collected data for later comparisons.
21 # List of plugins (as comma separated values of python modules names) to load,
22 # usually to register additional checkers.
25 # Use multiple processes to speed up Pylint.
28 # Allow loading of arbitrary C extensions. Extensions are imported into the
29 # active Python interpreter and may run arbitrary code.
30 unsafe-load-any-extension=no
32 # A comma-separated list of package or module names from where C extensions may
33 # be loaded. Extensions are loading into the active Python interpreter and may
35 extension-pkg-whitelist=
37 # Allow optimization of some AST trees. This will activate a peephole AST
38 # optimizer, which will apply various small optimizations. For instance, it can
39 # be used to obtain the result of joining multiple strings with the addition
40 # operator. Joining a lot of strings can lead to a maximum recursion error in
41 # Pylint and this flag can prevent that. It has one side effect, the resulting
42 # AST will be different than the one from reality. This option is deprecated
43 # and it will be removed in Pylint 2.0.
49 # Only show warnings with the listed confidence levels. Leave empty to show
50 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
53 # Enable the message, report, category or checker with the given id(s). You can
54 # either give multiple identifier separated by comma (,) or put this option
55 # multiple time (only on the command line, not in the configuration file where
56 # it should appear only once). See also the "--disable" option for examples.
59 # Disable the message, report, category or checker with the given id(s). You
60 # can either give multiple identifiers separated by comma (,) or put this
61 # option multiple times (only on the command line, not in the configuration
62 # file where it should appear only once).You can also use "--disable=all" to
63 # disable everything first and then reenable specific checks. For example, if
64 # you want to run only the similarities checker, you can use "--disable=all
65 # --enable=similarities". If you want to run only the classes checker, but have
66 # no Warning level messages displayed, use"--disable=all --enable=classes
68 disable= missing-docstring, locally-disabled
72 # Set the output format. Available formats are text, parseable, colorized, msvs
73 # (visual studio) and html. You can also give a reporter class, eg
74 # mypackage.mymodule.MyReporterClass.
77 # Put messages in a separate file for each module / package specified on the
78 # command line instead of printing them on stdout. Reports (if any) will be
79 # written in a file name "pylint_global.[txt|html]". This option is deprecated
80 # and it will be removed in Pylint 2.0.
83 # Tells whether to display a full report or only the messages
86 # Python expression which should return a note less than 10 (10 is the highest
87 # note). You have access to the variables errors warning, statement which
88 # respectively contain the number of errors / warnings messages and the total
89 # number of statements analyzed. This is used by the global evaluation report
91 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
93 # Template used to display messages. This is a python new-style format string
94 # used to format the message information. See doc for all details
100 # Good variable names which should always be accepted, separated by a comma
101 good-names=i,j,k,ex,Run,_
103 # Bad variable names which should always be refused, separated by a comma
104 bad-names=foo,bar,baz,toto,tutu,tata
106 # Colon-delimited sets of names that determine each other's naming style when
107 # the name regexes allow several styles.
110 # Include a hint for the correct naming format with invalid-name
111 include-naming-hint=no
113 # List of decorators that produce properties, such as abc.abstractproperty. Add
114 # to this list to register other decorators that produce valid properties.
115 property-classes=abc.abstractproperty
117 # Regular expression matching correct function names
118 function-rgx=[a-z_][a-z0-9_]{2,65}$
120 # Naming hint for function names
121 function-name-hint=[a-z_][a-z0-9_]{2,65}$
123 # Regular expression matching correct variable names
124 variable-rgx=[a-z_]|[a-z_][a-z0-9_]{2,30}$
126 # Naming hint for variable names
127 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
129 # Regular expression matching correct constant names
130 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
132 # Naming hint for constant names
133 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
135 # Regular expression matching correct attribute names
136 attr-rgx=[a-z_][a-z0-9_]{2,30}$
138 # Naming hint for attribute names
139 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
141 # Regular expression matching correct argument names
142 argument-rgx=[a-z_][a-z0-9_]{2,30}$
144 # Naming hint for argument names
145 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
147 # Regular expression matching correct class attribute names
148 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
150 # Naming hint for class attribute names
151 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
153 # Regular expression matching correct inline iteration names
154 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
156 # Naming hint for inline iteration names
157 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
159 # Regular expression matching correct class names
160 class-rgx=[A-Z_][a-zA-Z0-9]+$
162 # Naming hint for class names
163 class-name-hint=[A-Z_][a-zA-Z0-9]+$
165 # Regular expression matching correct module names
166 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
168 # Naming hint for module names
169 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
171 # Regular expression matching correct method names
172 method-rgx=[a-z_][a-z0-9_]{2,30}$
174 # Naming hint for method names
175 method-name-hint=[a-z_][a-z0-9_]{2,30}$
177 # Regular expression which should only match function or class names that do
178 # not require a docstring.
181 # Minimum line length for functions/classes that require docstrings, shorter
183 docstring-min-length=-1
188 # Maximum number of nested blocks for function / method body
194 # Maximum number of characters on a single line.
197 # Regexp for a line that is allowed to be longer than the limit.
198 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
200 # Allow the body of an if to be on the same line as the test if there is no
202 single-line-if-stmt=no
204 # List of optional constructs for which whitespace checking is disabled. `dict-
205 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
206 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
207 # `empty-line` allows space-only lines.
208 no-space-check=trailing-comma,dict-separator
210 # Maximum number of lines in a module
211 max-module-lines=1000
213 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
217 # Number of spaces of indent required inside a hanging or continued line.
220 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
221 expected-line-ending-format=
226 # Logging modules to check that the string format arguments are in logging
227 # function parameter format
228 logging-modules=logging
233 # List of note tags to take in consideration, separated by a comma.
239 # Minimum lines number of a similarity.
240 min-similarity-lines=4
242 # Ignore comments when computing similarities.
245 # Ignore docstrings when computing similarities.
246 ignore-docstrings=yes
248 # Ignore imports when computing similarities.
254 # Spelling dictionary name. Available dictionaries: none. To make it working
255 # install python-enchant package.
258 # List of comma separated words that should not be checked.
259 spelling-ignore-words=
261 # A path to a file that contains private dictionary; one word per line.
262 spelling-private-dict-file=
264 # Tells whether to store unknown words to indicated private dictionary in
265 # --spelling-private-dict-file option instead of raising a message.
266 spelling-store-unknown-words=no
271 # Tells whether missing members accessed in mixin class should be ignored. A
272 # mixin class is detected if its name ends with "mixin" (case insensitive).
273 ignore-mixin-members=yes
275 # List of module names for which member attributes should not be checked
276 # (useful for modules/projects where namespaces are manipulated during runtime
277 # and thus existing member attributes cannot be deduced by static analysis. It
278 # supports qualified module names, as well as Unix pattern matching.
281 # List of class names for which member attributes should not be checked (useful
282 # for classes with dynamically set attributes). This supports the use of
284 ignored-classes=optparse.Values,thread._local,_thread._local
286 # List of members which are set dynamically and missed by pylint inference
287 # system, and so shouldn't trigger E1101 when accessed. Python regular
288 # expressions are accepted.
291 # List of decorators that produce context managers, such as
292 # contextlib.contextmanager. Add to this list to register other decorators that
293 # produce valid context managers.
294 contextmanager-decorators=contextlib.contextmanager
299 # Tells whether we should check for unused import in __init__ files.
302 # A regular expression matching the name of dummy variables (i.e. expectedly
304 dummy-variables-rgx=(_+[a-zA-Z0-9]*?$)|dummy
306 # List of additional names supposed to be defined in builtins. Remember that
307 # you should avoid to define new builtins when possible.
310 # List of strings which can identify a callback function by name. A callback
311 # name must start or end with one of those strings.
314 # List of qualified module names which can have objects that can redefine
316 redefining-builtins-modules=six.moves,future.builtins
321 # List of method names used to declare (i.e. assign) instance attributes.
322 defining-attr-methods=__init__,__new__,setUp
324 # List of valid names for the first argument in a class method.
325 valid-classmethod-first-arg=cls
327 # List of valid names for the first argument in a metaclass class method.
328 valid-metaclass-classmethod-first-arg=mcs
330 # List of member names, which should be excluded from the protected access
332 exclude-protected=_asdict,_fields,_replace,_source,_make
337 # Maximum number of arguments for function / method
340 # Argument names that match this expression will be ignored. Default to name
341 # with leading underscore
342 ignored-argument-names=_.*
344 # Maximum number of locals for function / method body
347 # Maximum number of return / yield for function / method body
350 # Maximum number of branch for function / method body
353 # Maximum number of statements in function / method body
356 # Maximum number of parents for a class (see R0901).
359 # Maximum number of attributes for a class (see R0902).
362 # Minimum number of public methods for a class (see R0903).
365 # Maximum number of public methods for a class (see R0904).
366 max-public-methods=20
368 # Maximum number of boolean expressions in a if statement
374 # Deprecated modules which should not be used, separated by a comma
375 deprecated-modules=regsub,TERMIOS,Bastion,rexec
377 # Create a graph of every (i.e. internal and external) dependencies in the
378 # given file (report RP0402 must not be disabled)
381 # Create a graph of external dependencies in the given file (report RP0402 must
385 # Create a graph of internal dependencies in the given file (report RP0402 must
389 # Force import order to recognize a module as part of the standard
390 # compatibility libraries.
391 known-standard-library=
393 # Force import order to recognize a module as part of a third party library.
394 known-third-party=enchant
396 # Analyse import fallback blocks. This can be used to support both Python 2 and
397 # 3 compatible code, which means that the block might have code that exists
398 # only in one or another interpreter, leading to false positives when analysed.
399 analyse-fallback-blocks=no
404 # Exceptions that will emit a warning when being caught. Defaults to
406 overgeneral-exceptions=Exception