3 # Analyse import fallback blocks. This can be used to support both Python 2 and
4 # 3 compatible code, which means that the block might have code that exists
5 # only in one or another interpreter, leading to false positives when analysed.
6 analyse-fallback-blocks=no
8 # Clear in-memory caches upon conclusion of linting. Useful if running pylint
9 # in a server-like mode.
10 clear-cache-post-run=no
12 # Load and enable all available extensions. Use --list-extensions to see a list
13 # all available extensions.
14 #enable-all-extensions=
16 # In error mode, messages with a category besides ERROR or FATAL are
17 # suppressed, and no reports are done by default. Error mode is compatible with
18 # disabling specific errors.
21 # Always return a 0 (non-error) status code, even if lint errors are found.
22 # This is primarily useful in continuous integration scripts.
25 # A comma-separated list of package or module names from where C extensions may
26 # be loaded. Extensions are loading into the active Python interpreter and may
28 #extension-pkg-allow-list=
29 extension-pkg-allow-list=numpy,scipy
31 # A comma-separated list of package or module names from where C extensions may
32 # be loaded. Extensions are loading into the active Python interpreter and may
33 # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
34 # for backward compatibility.)
35 extension-pkg-whitelist=
37 # Return non-zero exit code if any of these messages/categories are detected,
38 # even if score is above --fail-under value. Syntax same as enable. Messages
39 # specified are enabled, while categories only check already-enabled messages.
42 # Specify a score threshold under which the program will exit with error.
45 # Interpret the stdin as a python script, whose filename needs to be passed as
46 # the module_or_package argument.
49 # Files or directories to be skipped. They should be base names, not paths.
52 # Add files or directories matching the regular expressions patterns to the
53 # ignore-list. The regex matches against paths and can be in Posix or Windows
54 # format. Because '\\' represents the directory delimiter on Windows systems,
55 # it can't be used as an escape character.
58 # Files or directories matching the regular expression patterns are skipped.
59 # The regex matches against base names, not paths. The default value ignores
63 # List of module names for which member attributes should not be checked
64 # (useful for modules/projects where namespaces are manipulated during runtime
65 # and thus existing member attributes cannot be deduced by static analysis). It
66 # supports qualified module names, as well as Unix pattern matching.
69 # Python code to execute, usually for sys.path manipulation such as
73 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
74 # number of processors available to use, and will cap the count on Windows to
77 # 0 would be faster, but log from that has "unsorted" modules.
79 # Control the amount of potential inferred values when inferring a single
80 # object. This can help the performance when dealing with large functions or
81 # complex, nested conditions.
82 limit-inference-results=100
84 # List of plugins (as comma separated values of python module names) to load,
85 # usually to register additional checkers.
88 # Pickle collected data for later comparisons.
91 # Minimum Python version to use for version dependent checks. Will default to
92 # the version used to run pylint.
95 # Discover python modules and packages in the file system subtree.
98 # Add paths to the list of the source roots. Supports globbing patterns. The
99 # source root is an absolute path or a path relative to the current working
100 # directory used to determine a package namespace for modules located under the
104 # When enabled, pylint would attempt to guess common misconfiguration and emit
105 # user-friendly hints instead of false-positive error messages.
108 # Allow loading of arbitrary C extensions. Extensions are imported into the
109 # active Python interpreter and may run arbitrary code.
110 unsafe-load-any-extension=no
112 # In verbose mode, extra non-checker-related info will be displayed.
118 # Naming style matching correct argument names.
119 argument-naming-style=snake_case
121 # Regular expression matching correct argument names. Overrides argument-
122 # naming-style. If left empty, argument names will be checked with the set
126 # Naming style matching correct attribute names.
127 attr-naming-style=snake_case
129 # Regular expression matching correct attribute names. Overrides attr-naming-
130 # style. If left empty, attribute names will be checked with the set naming
134 # Bad variable names which should always be refused, separated by a comma.
142 # Bad variable names regexes, separated by a comma. If names match any regex,
143 # they will always be refused
146 # Naming style matching correct class attribute names.
147 class-attribute-naming-style=any
149 # Regular expression matching correct class attribute names. Overrides class-
150 # attribute-naming-style. If left empty, class attribute names will be checked
151 # with the set naming style.
152 #class-attribute-rgx=
154 # Naming style matching correct class constant names.
155 class-const-naming-style=UPPER_CASE
157 # Regular expression matching correct class constant names. Overrides class-
158 # const-naming-style. If left empty, class constant names will be checked with
159 # the set naming style.
162 # Naming style matching correct class names.
163 class-naming-style=PascalCase
165 # Regular expression matching correct class names. Overrides class-naming-
166 # style. If left empty, class names will be checked with the set naming style.
169 # Naming style matching correct constant names.
170 const-naming-style=UPPER_CASE
172 # Regular expression matching correct constant names. Overrides const-naming-
173 # style. If left empty, constant names will be checked with the set naming
177 # Minimum line length for functions/classes that require docstrings, shorter
179 docstring-min-length=-1
181 # Naming style matching correct function names.
182 function-naming-style=snake_case
184 # Regular expression matching correct function names. Overrides function-
185 # naming-style. If left empty, function names will be checked with the set
189 # Good variable names which should always be accepted, separated by a comma.
197 # Good variable names regexes, separated by a comma. If names match any regex,
198 # they will always be accepted
201 # Include a hint for the correct naming format with invalid-name.
202 include-naming-hint=no
204 # Naming style matching correct inline iteration names.
205 inlinevar-naming-style=any
207 # Regular expression matching correct inline iteration names. Overrides
208 # inlinevar-naming-style. If left empty, inline iteration names will be checked
209 # with the set naming style.
212 # Naming style matching correct method names.
213 method-naming-style=snake_case
215 # Regular expression matching correct method names. Overrides method-naming-
216 # style. If left empty, method names will be checked with the set naming style.
219 # Naming style matching correct module names.
220 module-naming-style=snake_case
222 # Regular expression matching correct module names. Overrides module-naming-
223 # style. If left empty, module names will be checked with the set naming style.
226 # Colon-delimited sets of names that determine each other's naming style when
227 # the name regexes allow several styles.
230 # Regular expression which should only match function or class names that do
231 # not require a docstring.
234 # List of decorators that produce properties, such as abc.abstractproperty. Add
235 # to this list to register other decorators that produce valid properties.
236 # These decorators are taken in consideration only for invalid-name.
237 property-classes=abc.abstractproperty
239 # Regular expression matching correct type alias names. If left empty, type
240 # alias names will be checked with the set naming style.
243 # Regular expression matching correct type variable names. If left empty, type
244 # variable names will be checked with the set naming style.
247 # Naming style matching correct variable names.
248 variable-naming-style=snake_case
250 # Regular expression matching correct variable names. Overrides variable-
251 # naming-style. If left empty, variable names will be checked with the set
258 # Warn about protected attribute access inside special methods
259 check-protected-access-in-special-methods=no
261 # List of method names used to declare (i.e. assign) instance attributes.
262 defining-attr-methods=__init__,
268 # List of member names, which should be excluded from the protected access
270 exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
272 # List of valid names for the first argument in a class method.
273 valid-classmethod-first-arg=cls
275 # List of valid names for the first argument in a metaclass class method.
276 valid-metaclass-classmethod-first-arg=mcs
281 # List of regular expressions of class ancestor names to ignore when counting
282 # public methods (see R0903)
283 exclude-too-few-public-methods=
285 # List of qualified class names to ignore when counting class parents (see
289 # Maximum number of arguments for function / method.
292 # Maximum number of attributes for a class (see R0902).
295 # Maximum number of boolean expressions in an if statement (see R0916).
298 # Maximum number of branch for function / method body.
301 # Maximum number of locals for function / method body.
304 # Maximum number of parents for a class (see R0901).
307 # Maximum number of public methods for a class (see R0904).
308 max-public-methods=20
310 # Maximum number of return / yield for function / method body.
313 # Maximum number of statements in function / method body.
316 # Minimum number of public methods for a class (see R0903).
322 # Exceptions that will emit a warning when caught.
323 overgeneral-exceptions=builtins.BaseException,builtins.Exception
328 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
329 expected-line-ending-format=
331 # Regexp for a line that is allowed to be longer than the limit.
332 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
334 # Number of spaces of indent required inside a hanging or continued line.
337 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
341 # Maximum number of characters on a single line.
344 # Maximum number of lines in a module.
345 max-module-lines=2000
347 # Allow the body of a class to be on the same line as the declaration if body
348 # contains single statement.
349 single-line-class-stmt=no
351 # Allow the body of an if to be on the same line as the test if there is no
353 single-line-if-stmt=no
358 # List of modules that can be imported at any level, not just the top level
360 allow-any-import-level=
362 # Allow explicit reexports by alias from a package __init__.
363 allow-reexport-from-package=no
365 # Allow wildcard imports from modules that define __all__.
366 allow-wildcard-with-all=no
368 # Deprecated modules which should not be used, separated by a comma.
371 # Output a graph (.gv or any supported image format) of external dependencies
372 # to the given file (report RP0402 must not be disabled).
375 # Output a graph (.gv or any supported image format) of all (i.e. internal and
376 # external) dependencies to the given file (report RP0402 must not be
380 # Output a graph (.gv or any supported image format) of internal dependencies
381 # to the given file (report RP0402 must not be disabled).
384 # Force import order to recognize a module as part of the standard
385 # compatibility libraries.
386 known-standard-library=
388 # Force import order to recognize a module as part of a third party library.
389 known-third-party=enchant
391 # Couples of modules and preferred modules, separated by a comma.
397 # The type of string formatting that logging methods do. `old` means using %
398 # formatting, `new` is for `{}` formatting.
399 #logging-format-style=old
400 logging-format-style=new
402 # Logging modules to check that the string format arguments are in logging
403 # function parameter format.
404 logging-modules=logging
409 # Only show warnings with the listed confidence levels. Leave empty to show
410 # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
418 # Disable the message, report, category or checker with the given id(s). You
419 # can either give multiple identifiers separated by comma (,) or put this
420 # option multiple times (only on the command line, not in the configuration
421 # file where it should appear only once). You can also use "--disable=all" to
422 # disable everything first and then re-enable specific checks. For example, if
423 # you want to run only the similarities checker, you can use "--disable=all
424 # --enable=similarities". If you want to run only the classes checker, but have
425 # no Warning level messages displayed, use "--disable=all --enable=classes
427 #disable=raw-checker-failed,
431 # suppressed-message,
432 # useless-suppression,
434 # use-symbolic-message-instead,
435 # use-implicit-booleaness-not-comparison-to-string,
436 # use-implicit-booleaness-not-comparison-to-zero
437 disable=redundant-u-string-prefix,
441 # Enable the message, report, category or checker with the given id(s). You can
442 # either give multiple identifier separated by comma (,) or put this option
443 # multiple time (only on the command line, not in the configuration file where
444 # it should appear only once). See also the "--disable" option for examples.
450 # List of qualified names (i.e., library.method) which require a timeout
451 # parameter e.g. 'requests.api.get,requests.api.post'
452 timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
457 # List of note tags to take in consideration, separated by a comma.
460 # Regular expression of note tags to take in consideration.
466 # Maximum number of nested blocks for function / method body
469 # Complete name of functions that never returns. When checking for
470 # inconsistent-return-statements if a never returning function is called then
471 # it will be considered as an explicit return statement and no message will be
473 never-returning-functions=sys.exit,argparse.parse_error
478 # Python expression which should return a score less than or equal to 10. You
479 # have access to the variables 'fatal', 'error', 'warning', 'refactor',
480 # 'convention', and 'info' which contain the number of messages in each
481 # category, as well as 'statement' which is the total number of statements
482 # analyzed. This score is used by the global evaluation report (RP0004).
483 evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
485 # Template used to display messages. This is a python new-style format string
486 # used to format the message information. See doc for all details.
489 # Set the output format. Available formats are: text, parseable, colorized,
490 # json2 (improved json format), json (old json format) and msvs (visual
491 # studio). You can also give a reporter class, e.g.
492 # mypackage.mymodule.MyReporterClass.
495 # Tells whether to display a full report or only the messages.
498 # Activate the evaluation score.
504 # Comments are removed from the similarity computation
507 # Docstrings are removed from the similarity computation
508 ignore-docstrings=yes
510 # Imports are removed from the similarity computation
513 # Signatures are removed from the similarity computation
514 ignore-signatures=yes
516 # Minimum lines number of a similarity.
517 min-similarity-lines=4
522 # Limits count of emitted suggestions for spelling mistakes.
523 max-spelling-suggestions=4
525 # Spelling dictionary name. No available dictionaries : You need to install
526 # both the python package and the system dependency for enchant to work.
529 # List of comma separated words that should be considered directives if they
530 # appear at the beginning of a comment and should not be checked.
531 spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
533 # List of comma separated words that should not be checked.
534 spelling-ignore-words=
536 # A path to a file that contains the private dictionary; one word per line.
537 spelling-private-dict-file=
539 # Tells whether to store unknown words to the private dictionary (see the
540 # --spelling-private-dict-file option) instead of raising a message.
541 spelling-store-unknown-words=no
546 # This flag controls whether inconsistent-quotes generates a warning when the
547 # character used as a quote delimiter is used inconsistently within a module.
548 #check-quote-consistency=no
549 check-quote-consistency=yes
551 # This flag controls whether the implicit-str-concat should generate a warning
552 # on implicit string concatenation in sequences defined over several lines.
553 check-str-concat-over-line-jumps=no
558 # List of decorators that produce context managers, such as
559 # contextlib.contextmanager. Add to this list to register other decorators that
560 # produce valid context managers.
561 contextmanager-decorators=contextlib.contextmanager
563 # List of members which are set dynamically and missed by pylint inference
564 # system, and so shouldn't trigger E1101 when accessed. Python regular
565 # expressions are accepted.
568 # Tells whether to warn about missing members when the owner of the attribute
569 # is inferred to be None.
572 # This flag controls whether pylint should warn about no-member and similar
573 # checks whenever an opaque object is returned when inferring. The inference
574 # can return multiple potential results while evaluating a Python object, but
575 # some branches might not be evaluated, which results in partial inference. In
576 # that case, it might be useful to still emit no-member and other checks for
577 # the rest of the inferred objects.
578 ignore-on-opaque-inference=yes
580 # List of symbolic message names to ignore for Mixin members.
581 ignored-checks-for-mixins=no-member,
582 not-async-context-manager,
584 attribute-defined-outside-init
586 # List of class names for which member attributes should not be checked (useful
587 # for classes with dynamically set attributes). This supports the use of
589 ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
591 # Show a hint with possible names when a member name was not found. The aspect
592 # of finding the hint is based on edit distance.
593 missing-member-hint=yes
595 # The minimum edit distance a name should have in order to be considered a
596 # similar match for a missing member name.
597 missing-member-hint-distance=1
599 # The total number of similar names that should be taken in consideration when
600 # showing a hint for a missing member.
601 missing-member-max-choices=1
603 # Regex pattern to define which classes are considered mixins.
604 mixin-class-rgx=.*[Mm]ixin
606 # List of decorators that change the signature of a decorated function.
612 # List of additional names supposed to be defined in builtins. Remember that
613 # you should avoid defining new builtins when possible.
616 # Tells whether unused global variables should be treated as a violation.
617 allow-global-unused-variables=yes
619 # List of names allowed to shadow builtins
620 allowed-redefined-builtins=
622 # List of strings which can identify a callback function by name. A callback
623 # name must start or end with one of those strings.
627 # A regular expression matching the name of dummy variables (i.e. expected to
629 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
631 # Argument names that match this expression will be ignored.
632 ignored-argument-names=_.*|^ignored_|^unused_
634 # Tells whether we should check for unused import in __init__ files.
637 # List of qualified module names which can have objects that can redefine
639 redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io