doc: bsdtar
[rarfile.git] / .pylintrc
blobac5854c38337d551efe3604e1954e9fc3535ca08
1 [MASTER]
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.
6 extension-pkg-whitelist=
8 # Add files or directories to the blacklist. They should be base names, not
9 # paths.
10 ignore=CVS,tmp,dist
12 # Add files or directories matching the regex patterns to the blacklist. The
13 # regex matches against base names, not paths.
14 ignore-patterns=
16 # Python code to execute, usually for sys.path manipulation such as
17 # pygtk.require().
18 #init-hook=
20 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
21 # number of processors available to use.
22 jobs=1
24 # Control the amount of potential inferred values when inferring a single
25 # object. This can help the performance when dealing with large functions or
26 # complex, nested conditions.
27 limit-inference-results=100
29 # List of plugins (as comma separated values of python modules names) to load,
30 # usually to register additional checkers.
31 load-plugins=
33 # Pickle collected data for later comparisons.
34 persistent=yes
36 # Specify a configuration file.
37 #rcfile=
39 # When enabled, pylint would attempt to guess common misconfiguration and emit
40 # user-friendly hints instead of false-positive error messages.
41 suggestion-mode=yes
43 # Allow loading of arbitrary C extensions. Extensions are imported into the
44 # active Python interpreter and may run arbitrary code.
45 unsafe-load-any-extension=no
48 [MESSAGES CONTROL]
50 # Only show warnings with the listed confidence levels. Leave empty to show
51 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
52 confidence=
54 # Disable the message, report, category or checker with the given id(s). You
55 # can either give multiple identifiers separated by comma (,) or put this
56 # option multiple times (only on the command line, not in the configuration
57 # file where it should appear only once). You can also use "--disable=all" to
58 # disable everything first and then reenable specific checks. For example, if
59 # you want to run only the similarities checker, you can use "--disable=all
60 # --enable=similarities". If you want to run only the classes checker, but have
61 # no Warning level messages displayed, use "--disable=all --enable=classes
62 # --disable=W".
63 disable=bare-except,
64         broad-except,
65         consider-using-f-string,
66         consider-using-in,
67         consider-using-ternary,
68         consider-using-with,
69         fixme,
70         global-statement,
71         invalid-name,
72         missing-docstring,
73         no-else-raise,
74         no-else-return,
75         trailing-newlines,
76         unused-argument,
77         unused-variable,
78         protected-access,
79         ungrouped-imports,
80         chained-comparison,
81         len-as-condition,
82         redefined-builtin,
83         import-outside-toplevel,
84         duplicate-code,
85         unnecessary-pass
87 # Enable the message, report, category or checker with the given id(s). You can
88 # either give multiple identifier separated by comma (,) or put this option
89 # multiple time (only on the command line, not in the configuration file where
90 # it should appear only once). See also the "--disable" option for examples.
91 enable=c-extension-no-member
94 [REPORTS]
96 # Python expression which should return a note less than 10 (10 is the highest
97 # note). You have access to the variables errors warning, statement which
98 # respectively contain the number of errors / warnings messages and the total
99 # number of statements analyzed. This is used by the global evaluation report
100 # (RP0004).
101 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
103 # Template used to display messages. This is a python new-style format string
104 # used to format the message information. See doc for all details.
105 #msg-template=
107 # Set the output format. Available formats are text, parseable, colorized, json
108 # and msvs (visual studio). You can also give a reporter class, e.g.
109 # mypackage.mymodule.MyReporterClass.
110 output-format=colorized
112 # Tells whether to display a full report or only the messages.
113 reports=no
115 # Activate the evaluation score.
116 score=no
119 [REFACTORING]
121 # Maximum number of nested blocks for function / method body
122 max-nested-blocks=10
124 # Complete name of functions that never returns. When checking for
125 # inconsistent-return-statements if a never returning function is called then
126 # it will be considered as an explicit return statement and no message will be
127 # printed.
128 never-returning-functions=sys.exit
131 [LOGGING]
133 # Format style used to check logging format string. `old` means using %
134 # formatting, while `new` is for `{}` formatting.
135 logging-format-style=old
137 # Logging modules to check that the string format arguments are in logging
138 # function parameter format.
139 logging-modules=logging
142 [MISCELLANEOUS]
144 # List of note tags to take in consideration, separated by a comma.
145 notes=FIXME,
146       XXX,
147       TODO
150 [SPELLING]
152 # Limits count of emitted suggestions for spelling mistakes.
153 max-spelling-suggestions=4
155 # Spelling dictionary name. Available dictionaries: none. To make it working
156 # install python-enchant package..
157 #spelling-dict=en_US
159 # List of comma separated words that should not be checked.
160 spelling-ignore-words=usr,bin,env
162 # A path to a file that contains private dictionary; one word per line.
163 spelling-private-dict-file=.local.dict
165 # Tells whether to store unknown words to indicated private dictionary in
166 # --spelling-private-dict-file option instead of raising a message.
167 spelling-store-unknown-words=no
170 [BASIC]
172 # Naming style matching correct argument names.
173 argument-naming-style=snake_case
175 # Regular expression matching correct argument names. Overrides argument-
176 # naming-style.
177 #argument-rgx=
179 # Naming style matching correct attribute names.
180 attr-naming-style=snake_case
182 # Regular expression matching correct attribute names. Overrides attr-naming-
183 # style.
184 #attr-rgx=
186 # Bad variable names which should always be refused, separated by a comma.
187 bad-names=foo,
188           bar,
189           baz,
190           toto,
191           tutu,
192           tata
194 # Naming style matching correct class attribute names.
195 class-attribute-naming-style=any
197 # Regular expression matching correct class attribute names. Overrides class-
198 # attribute-naming-style.
199 #class-attribute-rgx=
201 # Naming style matching correct class names.
202 class-naming-style=PascalCase
204 # Regular expression matching correct class names. Overrides class-naming-
205 # style.
206 #class-rgx=
208 # Naming style matching correct constant names.
209 const-naming-style=UPPER_CASE
211 # Regular expression matching correct constant names. Overrides const-naming-
212 # style.
213 #const-rgx=
215 # Minimum line length for functions/classes that require docstrings, shorter
216 # ones are exempt.
217 docstring-min-length=-1
219 # Naming style matching correct function names.
220 function-naming-style=snake_case
222 # Regular expression matching correct function names. Overrides function-
223 # naming-style.
224 #function-rgx=
226 # Good variable names which should always be accepted, separated by a comma.
227 good-names=i,
228            j,
229            k,
230            ex,
231            Run,
232            _
234 # Include a hint for the correct naming format with invalid-name.
235 include-naming-hint=no
237 # Naming style matching correct inline iteration names.
238 inlinevar-naming-style=any
240 # Regular expression matching correct inline iteration names. Overrides
241 # inlinevar-naming-style.
242 #inlinevar-rgx=
244 # Naming style matching correct method names.
245 method-naming-style=snake_case
247 # Regular expression matching correct method names. Overrides method-naming-
248 # style.
249 #method-rgx=
251 # Naming style matching correct module names.
252 module-naming-style=snake_case
254 # Regular expression matching correct module names. Overrides module-naming-
255 # style.
256 #module-rgx=
258 # Colon-delimited sets of names that determine each other's naming style when
259 # the name regexes allow several styles.
260 name-group=
262 # Regular expression which should only match function or class names that do
263 # not require a docstring.
264 no-docstring-rgx=^_
266 # List of decorators that produce properties, such as abc.abstractproperty. Add
267 # to this list to register other decorators that produce valid properties.
268 # These decorators are taken in consideration only for invalid-name.
269 property-classes=abc.abstractproperty
271 # Naming style matching correct variable names.
272 variable-naming-style=snake_case
274 # Regular expression matching correct variable names. Overrides variable-
275 # naming-style.
276 #variable-rgx=
279 [STRING]
281 # This flag controls whether the implicit-str-concat-in-sequence should
282 # generate a warning on implicit string concatenation in sequences defined over
283 # several lines.
284 check-str-concat-over-line-jumps=no
287 [SIMILARITIES]
289 # Ignore comments when computing similarities.
290 ignore-comments=yes
292 # Ignore docstrings when computing similarities.
293 ignore-docstrings=yes
295 # Ignore imports when computing similarities.
296 ignore-imports=no
298 # Minimum lines number of a similarity.
299 min-similarity-lines=4
302 [VARIABLES]
304 # List of additional names supposed to be defined in builtins. Remember that
305 # you should avoid defining new builtins when possible.
306 additional-builtins=
308 # Tells whether unused global variables should be treated as a violation.
309 allow-global-unused-variables=yes
311 # List of strings which can identify a callback function by name. A callback
312 # name must start or end with one of those strings.
313 callbacks=cb_,
314           _cb
316 # A regular expression matching the name of dummy variables (i.e. expected to
317 # not be used).
318 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
320 # Argument names that match this expression will be ignored. Default to name
321 # with leading underscore.
322 ignored-argument-names=_.*|^ignored_|^unused_
324 # Tells whether we should check for unused import in __init__ files.
325 init-import=no
327 # List of qualified module names which can have objects that can redefine
328 # builtins.
329 redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
332 [TYPECHECK]
334 # List of decorators that produce context managers, such as
335 # contextlib.contextmanager. Add to this list to register other decorators that
336 # produce valid context managers.
337 contextmanager-decorators=contextlib.contextmanager
339 # List of members which are set dynamically and missed by pylint inference
340 # system, and so shouldn't trigger E1101 when accessed. Python regular
341 # expressions are accepted.
342 generated-members=
344 # Tells whether missing members accessed in mixin class should be ignored. A
345 # mixin class is detected if its name ends with "mixin" (case insensitive).
346 ignore-mixin-members=yes
348 # Tells whether to warn about missing members when the owner of the attribute
349 # is inferred to be None.
350 ignore-none=yes
352 # This flag controls whether pylint should warn about no-member and similar
353 # checks whenever an opaque object is returned when inferring. The inference
354 # can return multiple potential results while evaluating a Python object, but
355 # some branches might not be evaluated, which results in partial inference. In
356 # that case, it might be useful to still emit no-member and other checks for
357 # the rest of the inferred objects.
358 ignore-on-opaque-inference=yes
360 # List of class names for which member attributes should not be checked (useful
361 # for classes with dynamically set attributes). This supports the use of
362 # qualified names.
363 ignored-classes=optparse.Values,thread._local,_thread._local
365 # List of module names for which member attributes should not be checked
366 # (useful for modules/projects where namespaces are manipulated during runtime
367 # and thus existing member attributes cannot be deduced by static analysis. It
368 # supports qualified module names, as well as Unix pattern matching.
369 ignored-modules=
371 # Show a hint with possible names when a member name was not found. The aspect
372 # of finding the hint is based on edit distance.
373 missing-member-hint=yes
375 # The minimum edit distance a name should have in order to be considered a
376 # similar match for a missing member name.
377 missing-member-hint-distance=1
379 # The total number of similar names that should be taken in consideration when
380 # showing a hint for a missing member.
381 missing-member-max-choices=1
384 [FORMAT]
386 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
387 expected-line-ending-format=LF
389 # Regexp for a line that is allowed to be longer than the limit.
390 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
392 # Number of spaces of indent required inside a hanging or continued line.
393 indent-after-paren=4
395 # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
396 # tab).
397 indent-string='    '
399 # Maximum number of characters on a single line.
400 max-line-length=160
402 # Maximum number of lines in a module.
403 max-module-lines=10000
405 # Allow the body of a class to be on the same line as the declaration if body
406 # contains single statement.
407 single-line-class-stmt=no
409 # Allow the body of an if to be on the same line as the test if there is no
410 # else.
411 single-line-if-stmt=no
414 [CLASSES]
416 # List of method names used to declare (i.e. assign) instance attributes.
417 defining-attr-methods=__init__,
418                       __new__,
419                       setUp
421 # List of member names, which should be excluded from the protected access
422 # warning.
423 exclude-protected=_asdict,
424                   _fields,
425                   _replace,
426                   _source,
427                   _make
429 # List of valid names for the first argument in a class method.
430 valid-classmethod-first-arg=cls
432 # List of valid names for the first argument in a metaclass class method.
433 valid-metaclass-classmethod-first-arg=cls
436 [DESIGN]
438 # Maximum number of arguments for function / method.
439 max-args=15
441 # Maximum number of attributes for a class (see R0902).
442 max-attributes=17
444 # Maximum number of boolean expressions in an if statement.
445 max-bool-expr=5
447 # Maximum number of branch for function / method body.
448 max-branches=50
450 # Maximum number of locals for function / method body.
451 max-locals=45
453 # Maximum number of parents for a class (see R0901).
454 max-parents=7
456 # Maximum number of public methods for a class (see R0904).
457 max-public-methods=420
459 # Maximum number of return / yield for function / method body.
460 max-returns=16
462 # Maximum number of statements in function / method body.
463 max-statements=150
465 # Minimum number of public methods for a class (see R0903).
466 min-public-methods=0
469 [IMPORTS]
471 # Allow wildcard imports from modules that define __all__.
472 allow-wildcard-with-all=no
474 # Analyse import fallback blocks. This can be used to support both Python 2 and
475 # 3 compatible code, which means that the block might have code that exists
476 # only in one or another interpreter, leading to false positives when analysed.
477 analyse-fallback-blocks=no
479 # Deprecated modules which should not be used, separated by a comma.
480 deprecated-modules=optparse,tkinter.tix
482 # Create a graph of external dependencies in the given file (report RP0402 must
483 # not be disabled).
484 ext-import-graph=
486 # Create a graph of every (i.e. internal and external) dependencies in the
487 # given file (report RP0402 must not be disabled).
488 import-graph=
490 # Create a graph of internal dependencies in the given file (report RP0402 must
491 # not be disabled).
492 int-import-graph=
494 # Force import order to recognize a module as part of the standard
495 # compatibility libraries.
496 known-standard-library=
498 # Force import order to recognize a module as part of a third party library.
499 known-third-party=enchant
502 [EXCEPTIONS]
504 # Exceptions that will emit a warning when being caught. Defaults to
505 # "BaseException, Exception".
506 overgeneral-exceptions=builtins.BaseException,
507                        builtins.Exception