Debian Codegraph @

pylintrc

raw
1 [MAIN]
2
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
7
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
11
12 # Load and enable all available extensions. Use --list-extensions to see a list
13 # all available extensions.
14 #enable-all-extensions=
15
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.
19 #errors-only=
20
21 # Always return a 0 (non-error) status code, even if lint errors are found.
22 # This is primarily useful in continuous integration scripts.
23 #exit-zero=
24
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
27 # run arbitrary code.
28 extension-pkg-allow-list=
29
30 # A comma-separated list of package or module names from where C extensions may
31 # be loaded. Extensions are loading into the active Python interpreter and may
32 # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
33 # for backward compatibility.)
34 extension-pkg-whitelist=
35
36 # Return non-zero exit code if any of these messages/categories are detected,
37 # even if score is above --fail-under value. Syntax same as enable. Messages
38 # specified are enabled, while categories only check already-enabled messages.
39 fail-on=
40
41 # Specify a score threshold under which the program will exit with error.
42 fail-under=10
43
44 # Interpret the stdin as a python script, whose filename needs to be passed as
45 # the module_or_package argument.
46 #from-stdin=
47
48 # Files or directories to be skipped. They should be base names, not paths.
49 ignore=CVS
50
51 # Add files or directories matching the regular expressions patterns to the
52 # ignore-list. The regex matches against paths and can be in Posix or Windows
53 # format. Because '\\' represents the directory delimiter on Windows systems,
54 # it can't be used as an escape character.
55 ignore-paths=
56
57 # Files or directories matching the regular expression patterns are skipped.
58 # The regex matches against base names, not paths. The default value ignores
59 # Emacs file locks
60 ignore-patterns=^\.#
61
62 # List of module names for which member attributes should not be checked and
63 # will not be imported (useful for modules/projects where namespaces are
64 # manipulated during runtime and thus existing member attributes cannot be
65 # deduced by static analysis). It supports qualified module names, as well as
66 # Unix pattern matching.
67 ignored-modules=
68
69 # Python code to execute, usually for sys.path manipulation such as
70 # pygtk.require().
71 #init-hook=
72
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
75 # avoid hangs.
76 jobs=1
77
78 # Control the amount of potential inferred values when inferring a single
79 # object. This can help the performance when dealing with large functions or
80 # complex, nested conditions.
81 limit-inference-results=100
82
83 # List of plugins (as comma separated values of python module names) to load,
84 # usually to register additional checkers.
85 load-plugins=
86
87 # Pickle collected data for later comparisons.
88 persistent=yes
89
90 # Resolve imports to .pyi stubs if available. May reduce no-member messages and
91 # increase not-an-iterable messages.
92 prefer-stubs=no
93
94 # Minimum Python version to use for version dependent checks. Will default to
95 # the version used to run pylint.
96 py-version=3.12
97
98 # Discover python modules and packages in the file system subtree.
99 recursive=no
100
101 # Add paths to the list of the source roots. Supports globbing patterns. The
102 # source root is an absolute path or a path relative to the current working
103 # directory used to determine a package namespace for modules located under the
104 # source root.
105 source-roots=
106
107 # Allow loading of arbitrary C extensions. Extensions are imported into the
108 # active Python interpreter and may run arbitrary code.
109 unsafe-load-any-extension=no
110
111 # In verbose mode, extra non-checker-related info will be displayed.
112 #verbose=
113
114
115 [BASIC]
116
117 # Naming style matching correct argument names.
118 argument-naming-style=snake_case
119
120 # Regular expression matching correct argument names. Overrides argument-
121 # naming-style. If left empty, argument names will be checked with the set
122 # naming style.
123 #argument-rgx=
124
125 # Naming style matching correct attribute names.
126 attr-naming-style=snake_case
127
128 # Regular expression matching correct attribute names. Overrides attr-naming-
129 # style. If left empty, attribute names will be checked with the set naming
130 # style.
131 #attr-rgx=
132
133 # Bad variable names which should always be refused, separated by a comma.
134 bad-names=foo,
135 bar,
136 baz,
137 toto,
138 tutu,
139 tata
140
141 # Bad variable names regexes, separated by a comma. If names match any regex,
142 # they will always be refused
143 bad-names-rgxs=
144
145 # Naming style matching correct class attribute names.
146 class-attribute-naming-style=any
147
148 # Regular expression matching correct class attribute names. Overrides class-
149 # attribute-naming-style. If left empty, class attribute names will be checked
150 # with the set naming style.
151 #class-attribute-rgx=
152
153 # Naming style matching correct class constant names.
154 class-const-naming-style=UPPER_CASE
155
156 # Regular expression matching correct class constant names. Overrides class-
157 # const-naming-style. If left empty, class constant names will be checked with
158 # the set naming style.
159 #class-const-rgx=
160
161 # Naming style matching correct class names.
162 class-naming-style=PascalCase
163
164 # Regular expression matching correct class names. Overrides class-naming-
165 # style. If left empty, class names will be checked with the set naming style.
166 #class-rgx=
167
168 # Naming style matching correct constant names.
169 const-naming-style=UPPER_CASE
170
171 # Regular expression matching correct constant names. Overrides const-naming-
172 # style. If left empty, constant names will be checked with the set naming
173 # style.
174 #const-rgx=
175
176 # Minimum line length for functions/classes that require docstrings, shorter
177 # ones are exempt.
178 docstring-min-length=-1
179
180 # Naming style matching correct function names.
181 function-naming-style=snake_case
182
183 # Regular expression matching correct function names. Overrides function-
184 # naming-style. If left empty, function names will be checked with the set
185 # naming style.
186 #function-rgx=
187
188 # Good variable names which should always be accepted, separated by a comma.
189 good-names=i,
190 j,
191 k,
192 ex,
193 Run,
194 _
195
196 # Good variable names regexes, separated by a comma. If names match any regex,
197 # they will always be accepted
198 good-names-rgxs=
199
200 # Include a hint for the correct naming format with invalid-name.
201 include-naming-hint=no
202
203 # Naming style matching correct inline iteration names.
204 inlinevar-naming-style=any
205
206 # Regular expression matching correct inline iteration names. Overrides
207 # inlinevar-naming-style. If left empty, inline iteration names will be checked
208 # with the set naming style.
209 #inlinevar-rgx=
210
211 # Naming style matching correct method names.
212 method-naming-style=snake_case
213
214 # Regular expression matching correct method names. Overrides method-naming-
215 # style. If left empty, method names will be checked with the set naming style.
216 #method-rgx=
217
218 # Naming style matching correct module names.
219 module-naming-style=snake_case
220
221 # Regular expression matching correct module names. Overrides module-naming-
222 # style. If left empty, module names will be checked with the set naming style.
223 #module-rgx=
224
225 # Colon-delimited sets of names that determine each other's naming style when
226 # the name regexes allow several styles.
227 name-group=
228
229 # Regular expression which should only match function or class names that do
230 # not require a docstring.
231 no-docstring-rgx=^_
232
233 # Regular expression matching correct parameter specification variable names.
234 # If left empty, parameter specification variable names will be checked with
235 # the set naming style.
236 #paramspec-rgx=
237
238 # List of decorators that produce properties, such as abc.abstractproperty. Add
239 # to this list to register other decorators that produce valid properties.
240 # These decorators are taken in consideration only for invalid-name.
241 property-classes=abc.abstractproperty
242
243 # Regular expression matching correct type alias names. If left empty, type
244 # alias names will be checked with the set naming style.
245 #typealias-rgx=
246
247 # Regular expression matching correct type variable names. If left empty, type
248 # variable names will be checked with the set naming style.
249 #typevar-rgx=
250
251 # Regular expression matching correct type variable tuple names. If left empty,
252 # type variable tuple names will be checked with the set naming style.
253 #typevartuple-rgx=
254
255 # Naming style matching correct variable names.
256 variable-naming-style=snake_case
257
258 # Regular expression matching correct variable names. Overrides variable-
259 # naming-style. If left empty, variable names will be checked with the set
260 # naming style.
261 #variable-rgx=
262
263
264 [CLASSES]
265
266 # Warn about protected attribute access inside special methods
267 check-protected-access-in-special-methods=no
268
269 # List of method names used to declare (i.e. assign) instance attributes.
270 defining-attr-methods=__init__,
271 __new__,
272 setUp,
273 asyncSetUp,
274 __post_init__
275
276 # List of member names, which should be excluded from the protected access
277 # warning.
278 exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
279
280 # List of valid names for the first argument in a class method.
281 valid-classmethod-first-arg=cls
282
283 # List of valid names for the first argument in a metaclass class method.
284 valid-metaclass-classmethod-first-arg=mcs
285
286
287 [DESIGN]
288
289 # List of regular expressions of class ancestor names to ignore when counting
290 # public methods (see R0903)
291 exclude-too-few-public-methods=
292
293 # List of qualified class names to ignore when counting class parents (see
294 # R0901)
295 ignored-parents=
296
297 # Maximum number of arguments for function / method.
298 max-args=5
299
300 # Maximum number of attributes for a class (see R0902).
301 max-attributes=7
302
303 # Maximum number of boolean expressions in an if statement (see R0916).
304 max-bool-expr=5
305
306 # Maximum number of branch for function / method body.
307 max-branches=12
308
309 # Maximum number of locals for function / method body.
310 max-locals=15
311
312 # Maximum number of parents for a class (see R0901).
313 max-parents=7
314
315 # Maximum number of positional arguments for function / method.
316 max-positional-arguments=5
317
318 # Maximum number of public methods for a class (see R0904).
319 max-public-methods=20
320
321 # Maximum number of return / yield for function / method body.
322 max-returns=6
323
324 # Maximum number of statements in function / method body.
325 max-statements=50
326
327 # Minimum number of public methods for a class (see R0903).
328 min-public-methods=2
329
330
331 [EXCEPTIONS]
332
333 # Exceptions that will emit a warning when caught.
334 overgeneral-exceptions=builtins.BaseException,builtins.Exception
335
336
337 [FORMAT]
338
339 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
340 expected-line-ending-format=
341
342 # Regexp for a line that is allowed to be longer than the limit.
343 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
344
345 # Number of spaces of indent required inside a hanging or continued line.
346 indent-after-paren=4
347
348 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
349 # tab).
350 indent-string=' '
351
352 # Maximum number of characters on a single line. Pylint's default of 100 is
353 # based on PEP 8's guidance that teams may choose line lengths up to 99
354 # characters.
355 max-line-length=200
356
357 # Maximum number of lines in a module.
358 max-module-lines=1000
359
360 # Allow the body of a class to be on the same line as the declaration if body
361 # contains single statement.
362 single-line-class-stmt=no
363
364 # Allow the body of an if to be on the same line as the test if there is no
365 # else.
366 single-line-if-stmt=no
367
368
369 [IMPORTS]
370
371 # List of modules that can be imported at any level, not just the top level
372 # one.
373 allow-any-import-level=
374
375 # Allow explicit reexports by alias from a package __init__.
376 allow-reexport-from-package=no
377
378 # Allow wildcard imports from modules that define __all__.
379 allow-wildcard-with-all=no
380
381 # Deprecated modules which should not be used, separated by a comma.
382 deprecated-modules=
383
384 # Output a graph (.gv or any supported image format) of external dependencies
385 # to the given file (report RP0402 must not be disabled).
386 ext-import-graph=
387
388 # Output a graph (.gv or any supported image format) of all (i.e. internal and
389 # external) dependencies to the given file (report RP0402 must not be
390 # disabled).
391 import-graph=
392
393 # Output a graph (.gv or any supported image format) of internal dependencies
394 # to the given file (report RP0402 must not be disabled).
395 int-import-graph=
396
397 # Force import order to recognize a module as part of the standard
398 # compatibility libraries.
399 known-standard-library=
400
401 # Force import order to recognize a module as part of a third party library.
402 known-third-party=enchant
403
404 # Couples of modules and preferred modules, separated by a comma.
405 preferred-modules=
406
407
408 [LOGGING]
409
410 # The type of string formatting that logging methods do. `old` means using %
411 # formatting, `new` is for `{}` formatting.
412 logging-format-style=old
413
414 # Logging modules to check that the string format arguments are in logging
415 # function parameter format.
416 logging-modules=logging
417
418
419 [MESSAGES CONTROL]
420
421 # Only show warnings with the listed confidence levels. Leave empty to show
422 # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
423 # UNDEFINED.
424 confidence=HIGH,
425 CONTROL_FLOW,
426 INFERENCE,
427 INFERENCE_FAILURE,
428 UNDEFINED
429
430 # Disable the message, report, category or checker with the given id(s). You
431 # can either give multiple identifiers separated by comma (,) or put this
432 # option multiple times (only on the command line, not in the configuration
433 # file where it should appear only once). You can also use "--disable=all" to
434 # disable everything first and then re-enable specific checks. For example, if
435 # you want to run only the similarities checker, you can use "--disable=all
436 # --enable=similarities". If you want to run only the classes checker, but have
437 # no Warning level messages displayed, use "--disable=all --enable=classes
438 # --disable=W".
439 disable=raw-checker-failed,
440 bad-inline-option,
441 locally-disabled,
442 file-ignored,
443 suppressed-message,
444 useless-suppression,
445 deprecated-pragma,
446 use-symbolic-message-instead,
447 use-implicit-booleaness-not-comparison-to-string,
448 use-implicit-booleaness-not-comparison-to-zero,
449 missing-module-docstring,
450 missing-function-docstring
451
452 # Enable the message, report, category or checker with the given id(s). You can
453 # either give multiple identifier separated by comma (,) or put this option
454 # multiple time (only on the command line, not in the configuration file where
455 # it should appear only once). See also the "--disable" option for examples.
456 enable=
457
458
459 [METHOD_ARGS]
460
461 # List of qualified names (i.e., library.method) which require a timeout
462 # parameter e.g. 'requests.api.get,requests.api.post'
463 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
464
465
466 [MISCELLANEOUS]
467
468 # Whether or not to search for fixme's in docstrings.
469 check-fixme-in-docstring=no
470
471 # List of note tags to take in consideration, separated by a comma.
472 notes=FIXME,
473 XXX,
474 TODO
475
476 # Regular expression of note tags to take in consideration.
477 notes-rgx=
478
479
480 [REFACTORING]
481
482 # Maximum number of nested blocks for function / method body
483 max-nested-blocks=5
484
485 # Complete name of functions that never returns. When checking for
486 # inconsistent-return-statements if a never returning function is called then
487 # it will be considered as an explicit return statement and no message will be
488 # printed.
489 never-returning-functions=sys.exit,argparse.parse_error
490
491 # Let 'consider-using-join' be raised when the separator to join on would be
492 # non-empty (resulting in expected fixes of the type: ``"- " + " -
493 # ".join(items)``)
494 suggest-join-with-non-empty-separator=yes
495
496
497 [REPORTS]
498
499 # Python expression which should return a score less than or equal to 10. You
500 # have access to the variables 'fatal', 'error', 'warning', 'refactor',
501 # 'convention', and 'info' which contain the number of messages in each
502 # category, as well as 'statement' which is the total number of statements
503 # analyzed. This score is used by the global evaluation report (RP0004).
504 evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
505
506 # Template used to display messages. This is a python new-style format string
507 # used to format the message information. See doc for all details.
508 msg-template=
509
510 # Set the output format. Available formats are: 'text', 'parseable',
511 # 'colorized', 'json2' (improved json format), 'json' (old json format), msvs
512 # (visual studio) and 'github' (GitHub actions). You can also give a reporter
513 # class, e.g. mypackage.mymodule.MyReporterClass.
514 #output-format=
515
516 # Tells whether to display a full report or only the messages.
517 reports=no
518
519 # Activate the evaluation score.
520 score=yes
521
522
523 [SIMILARITIES]
524
525 # Comments are removed from the similarity computation
526 ignore-comments=yes
527
528 # Docstrings are removed from the similarity computation
529 ignore-docstrings=yes
530
531 # Imports are removed from the similarity computation
532 ignore-imports=yes
533
534 # Signatures are removed from the similarity computation
535 ignore-signatures=yes
536
537 # Minimum lines number of a similarity.
538 min-similarity-lines=4
539
540
541 [SPELLING]
542
543 # Limits count of emitted suggestions for spelling mistakes.
544 max-spelling-suggestions=4
545
546 # Spelling dictionary name. No available dictionaries : You need to install
547 # both the python package and the system dependency for enchant to work.
548 spelling-dict=
549
550 # List of comma separated words that should be considered directives if they
551 # appear at the beginning of a comment and should not be checked.
552 spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
553
554 # List of comma separated words that should not be checked.
555 spelling-ignore-words=
556
557 # A path to a file that contains the private dictionary; one word per line.
558 spelling-private-dict-file=
559
560 # Tells whether to store unknown words to the private dictionary (see the
561 # --spelling-private-dict-file option) instead of raising a message.
562 spelling-store-unknown-words=no
563
564
565 [STRING]
566
567 # This flag controls whether inconsistent-quotes generates a warning when the
568 # character used as a quote delimiter is used inconsistently within a module.
569 check-quote-consistency=no
570
571 # This flag controls whether the implicit-str-concat should generate a warning
572 # on implicit string concatenation in sequences defined over several lines.
573 check-str-concat-over-line-jumps=no
574
575
576 [TYPECHECK]
577
578 # List of decorators that produce context managers, such as
579 # contextlib.contextmanager. Add to this list to register other decorators that
580 # produce valid context managers.
581 contextmanager-decorators=contextlib.contextmanager
582
583 # List of members which are set dynamically and missed by pylint inference
584 # system, and so shouldn't trigger E1101 when accessed. Python regular
585 # expressions are accepted.
586 generated-members=
587
588 # Tells whether to warn about missing members when the owner of the attribute
589 # is inferred to be None.
590 ignore-none=yes
591
592 # This flag controls whether pylint should warn about no-member and similar
593 # checks whenever an opaque object is returned when inferring. The inference
594 # can return multiple potential results while evaluating a Python object, but
595 # some branches might not be evaluated, which results in partial inference. In
596 # that case, it might be useful to still emit no-member and other checks for
597 # the rest of the inferred objects.
598 ignore-on-opaque-inference=yes
599
600 # List of symbolic message names to ignore for Mixin members.
601 ignored-checks-for-mixins=no-member,
602 not-async-context-manager,
603 not-context-manager,
604 attribute-defined-outside-init
605
606 # List of class names for which member attributes should not be checked (useful
607 # for classes with dynamically set attributes). This supports the use of
608 # qualified names.
609 ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
610
611 # Show a hint with possible names when a member name was not found. The aspect
612 # of finding the hint is based on edit distance.
613 missing-member-hint=yes
614
615 # The maximum edit distance a name should have in order to be considered a
616 # similar match for a missing member name.
617 missing-member-hint-distance=1
618
619 # The total number of similar names that should be taken in consideration when
620 # showing a hint for a missing member.
621 missing-member-max-choices=1
622
623 # Regex pattern to define which classes are considered mixins.
624 mixin-class-rgx=.*[Mm]ixin
625
626 # List of decorators that change the signature of a decorated function.
627 signature-mutators=
628
629
630 [VARIABLES]
631
632 # List of additional names supposed to be defined in builtins. Remember that
633 # you should avoid defining new builtins when possible.
634 additional-builtins=
635
636 # Tells whether unused global variables should be treated as a violation.
637 allow-global-unused-variables=yes
638
639 # List of names allowed to shadow builtins
640 allowed-redefined-builtins=
641
642 # List of strings which can identify a callback function by name. A callback
643 # name must start or end with one of those strings.
644 callbacks=cb_,
645 _cb
646
647 # A regular expression matching the name of dummy variables (i.e. expected to
648 # not be used).
649 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
650
651 # Argument names that match this expression will be ignored.
652 ignored-argument-names=_.*|^ignored_|^unused_
653
654 # Tells whether we should check for unused import in __init__ files.
655 init-import=no
656
657 # List of qualified module names which can have objects that can redefine
658 # builtins.
659 redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io