• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[MASTER]
2
3# Control the amount of potential inferred values when inferring a single
4# object. This can help the performance when dealing with large functions or
5# complex, nested conditions.
6limit-inference-results=100
7
8# List of plugins (as comma separated values of python module names) to load,
9# usually to register additional checkers.
10load-plugins=pylint.extensions.docparams
11
12# Pickle collected data for later comparisons.
13persistent=yes
14
15# When enabled, pylint would attempt to guess common misconfiguration and emit
16# user-friendly hints instead of false-positive error messages.
17suggestion-mode=yes
18
19# Allow loading of arbitrary C extensions. Extensions are imported into the
20# active Python interpreter and may run arbitrary code.
21unsafe-load-any-extension=no
22
23# Ignore specific directories we don't author ourselves
24ignore=Test/DocSource
25
26[MESSAGES CONTROL]
27
28# Only show warnings with the listed confidence levels. Leave empty to show
29# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
30confidence=
31
32# Disable the message, report, category or checker with the given id(s). You
33# can either give multiple identifiers separated by comma (,) or put this
34# option multiple times (only on the command line, not in the configuration
35# file where it should appear only once). You can also use "--disable=all" to
36# disable everything first and then reenable specific checks. For example, if
37# you want to run only the similarities checker, you can use "--disable=all
38# --enable=similarities". If you want to run only the classes checker, but have
39# no Warning level messages displayed, use "--disable=all --enable=classes
40# --disable=W".
41disable=print-statement,
42        parameter-unpacking,
43        unpacking-in-except,
44        old-raise-syntax,
45        backtick,
46        long-suffix,
47        old-ne-operator,
48        old-octal-literal,
49        import-star-module-level,
50        non-ascii-bytes-literal,
51        raw-checker-failed,
52        bad-inline-option,
53        locally-disabled,
54        file-ignored,
55        suppressed-message,
56        useless-suppression,
57        deprecated-pragma,
58        use-symbolic-message-instead,
59        apply-builtin,
60        basestring-builtin,
61        buffer-builtin,
62        cmp-builtin,
63        coerce-builtin,
64        execfile-builtin,
65        file-builtin,
66        long-builtin,
67        raw_input-builtin,
68        reduce-builtin,
69        standarderror-builtin,
70        unicode-builtin,
71        xrange-builtin,
72        coerce-method,
73        delslice-method,
74        getslice-method,
75        setslice-method,
76        no-absolute-import,
77        old-division,
78        dict-iter-method,
79        dict-view-method,
80        next-method-called,
81        metaclass-assignment,
82        indexing-exception,
83        raising-string,
84        reload-builtin,
85        oct-method,
86        hex-method,
87        nonzero-method,
88        cmp-method,
89        input-builtin,
90        round-builtin,
91        intern-builtin,
92        unichr-builtin,
93        map-builtin-not-iterating,
94        zip-builtin-not-iterating,
95        range-builtin-not-iterating,
96        filter-builtin-not-iterating,
97        using-cmp-argument,
98        eq-without-hash,
99        div-method,
100        idiv-method,
101        rdiv-method,
102        exception-message-attribute,
103        invalid-str-codec,
104        sys-max-int,
105        bad-python3-import,
106        deprecated-string-function,
107        deprecated-str-translate-call,
108        deprecated-itertools-function,
109        deprecated-types-field,
110        next-method-defined,
111        dict-items-not-iterating,
112        dict-keys-not-iterating,
113        dict-values-not-iterating,
114        deprecated-operator-function,
115        deprecated-urllib-function,
116        xreadlines-attribute,
117        deprecated-sys-function,
118        exception-escape,
119        comprehension-escape
120
121# Enable the message, report, category or checker with the given id(s). You can
122# either give multiple identifier separated by comma (,) or put this option
123# multiple time (only on the command line, not in the configuration file where
124# it should appear only once). See also the "--disable" option for examples.
125enable=c-extension-no-member
126
127
128[REPORTS]
129
130# Python expression which should return a score less than or equal to 10. You
131# have access to the variables 'error', 'warning', 'refactor', and 'convention'
132# which contain the number of messages in each category, as well as 'statement'
133# which is the total number of statements analyzed. This score is used by the
134# global evaluation report (RP0004).
135evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
136
137# Set the output format. Available formats are text, parseable, colorized, json
138# and msvs (visual studio). You can also give a reporter class, e.g.
139# mypackage.mymodule.MyReporterClass.
140output-format=text
141
142# Tells whether to display a full report or only the messages.
143reports=no
144
145# Activate the evaluation score.
146score=yes
147
148
149[REFACTORING]
150
151# Maximum number of nested blocks for function / method body
152max-nested-blocks=5
153
154# Complete name of functions that never returns.
155never-returning-functions=sys.exit
156
157
158[BASIC]
159
160# Naming style matching correct argument names.
161argument-naming-style=camelCase
162
163# Regular expression matching correct argument names. Overrides argument-
164# naming-style.
165#argument-rgx=
166
167# Naming style matching correct attribute names.
168attr-naming-style=camelCase
169
170# Regular expression matching correct attribute names. Overrides attr-naming-
171# style.
172#attr-rgx=
173
174# Bad variable names which should always be refused, separated by a comma.
175bad-names=foo,
176          bar,
177          baz,
178          toto,
179          tutu,
180          tata
181
182# Naming style matching correct class attribute names.
183class-attribute-naming-style=any
184
185# Regular expression matching correct class attribute names. Overrides class-
186# attribute-naming-style.
187#class-attribute-rgx=
188
189# Naming style matching correct class names.
190class-naming-style=PascalCase
191
192# Regular expression matching correct class names. Overrides class-naming-
193# style.
194#class-rgx=
195
196# Naming style matching correct constant names.
197const-naming-style=UPPER_CASE
198
199# Regular expression matching correct constant names. Overrides const-naming-
200# style.
201#const-rgx=
202
203# Minimum line length for functions/classes that require docstrings, shorter
204# ones are exempt.
205docstring-min-length=-1
206
207# Naming style matching correct function names.
208function-naming-style=snake_case
209
210# Regular expression matching correct function names. Overrides function-
211# naming-style.
212#function-rgx=
213
214# Good variable names which should always be accepted, separated by a comma.
215good-names=i,j,k,x,y,z,w,r,g,b,a,ex,Run,_
216
217# Include a hint for the correct naming format with invalid-name.
218include-naming-hint=no
219
220# Naming style matching correct inline iteration names.
221inlinevar-naming-style=any
222
223# Regular expression matching correct inline iteration names. Overrides
224# inlinevar-naming-style.
225#inlinevar-rgx=
226
227# Naming style matching correct method names.
228method-naming-style=snake_case
229
230# Regular expression matching correct method names. Overrides method-naming-
231# style.
232#method-rgx=
233
234# Naming style matching correct module names.
235module-naming-style=snake_case
236
237# Regular expression matching correct module names. Overrides module-naming-
238# style.
239#module-rgx=
240
241# Colon-delimited sets of names that determine each other's naming style when
242# the name regexes allow several styles.
243name-group=
244
245# Regular expression which should only match function or class names that do
246# not require a docstring.
247no-docstring-rgx=^_
248
249# List of decorators that produce properties, such as abc.abstractproperty. Add
250# to this list to register other decorators that produce valid properties.
251# These decorators are taken in consideration only for invalid-name.
252property-classes=abc.abstractproperty
253
254# Naming style matching correct variable names.
255variable-naming-style=camelCase
256
257[FORMAT]
258
259# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
260expected-line-ending-format=
261
262# Regexp for a line that is allowed to be longer than the limit.
263ignore-long-lines=^\s*(# )?<?https?://\S+>?$
264
265# Number of spaces of indent required inside a hanging or continued line.
266indent-after-paren=4
267
268# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
269# tab).
270indent-string='    '
271
272# Maximum number of characters on a single line.
273max-line-length=79
274
275# Maximum number of lines in a module.
276max-module-lines=1000
277
278# Allow the body of a class to be on the same line as the declaration if body
279# contains single statement.
280single-line-class-stmt=no
281
282# Allow the body of an if to be on the same line as the test if there is no
283# else.
284single-line-if-stmt=no
285
286
287[LOGGING]
288
289# Format style used to check logging format string. `old` means using %
290# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings.
291logging-format-style=old
292
293# Logging modules to check that the string format arguments are in logging
294# function parameter format.
295logging-modules=logging
296
297
298[MISCELLANEOUS]
299
300# List of note tags to take in consideration, separated by a comma.
301notes=FIXME,XXX,TODO
302
303
304[SIMILARITIES]
305
306# Ignore comments when computing similarities.
307ignore-comments=yes
308
309# Ignore docstrings when computing similarities.
310ignore-docstrings=yes
311
312# Ignore imports when computing similarities.
313ignore-imports=no
314
315# Minimum lines number of a similarity.
316min-similarity-lines=4
317
318
319[SPELLING]
320
321# Limits count of emitted suggestions for spelling mistakes.
322max-spelling-suggestions=4
323
324# Spelling dictionary name. Available dictionaries: none. To make it work,
325# install the python-enchant package.
326spelling-dict=
327
328# List of comma separated words that should not be checked.
329spelling-ignore-words=
330
331# A path to a file that contains the private dictionary; one word per line.
332spelling-private-dict-file=
333
334# Tells whether to store unknown words to the private dictionary (see the
335# --spelling-private-dict-file option) instead of raising a message.
336spelling-store-unknown-words=no
337
338
339[STRING]
340
341# This flag controls whether the implicit-str-concat-in-sequence should
342# generate a warning on implicit string concatenation in sequences defined over
343# several lines.
344check-str-concat-over-line-jumps=no
345
346
347[TYPECHECK]
348
349# List of decorators that produce context managers, such as
350# contextlib.contextmanager. Add to this list to register other decorators that
351# produce valid context managers.
352contextmanager-decorators=contextlib.contextmanager
353
354# List of members which are set dynamically and missed by pylint inference
355# system, and so shouldn't trigger E1101 when accessed. Python regular
356# expressions are accepted.
357generated-members=
358
359# Tells whether missing members accessed in mixin class should be ignored. A
360# mixin class is detected if its name ends with "mixin" (case insensitive).
361ignore-mixin-members=yes
362
363# Tells whether to warn about missing members when the owner of the attribute
364# is inferred to be None.
365ignore-none=yes
366
367# This flag controls whether pylint should warn about no-member and similar
368# checks whenever an opaque object is returned when inferring. The inference
369# can return multiple potential results while evaluating a Python object, but
370# some branches might not be evaluated, which results in partial inference. In
371# that case, it might be useful to still emit no-member and other checks for
372# the rest of the inferred objects.
373ignore-on-opaque-inference=yes
374
375# List of class names for which member attributes should not be checked (useful
376# for classes with dynamically set attributes). This supports the use of
377# qualified names.
378ignored-classes=optparse.Values,thread._local,_thread._local
379
380# List of module names for which member attributes should not be checked
381# (useful for modules/projects where namespaces are manipulated during runtime
382# and thus existing member attributes cannot be deduced by static analysis). It
383# supports qualified module names, as well as Unix pattern matching.
384ignored-modules=signal
385
386# Show a hint with possible names when a member name was not found. The aspect
387# of finding the hint is based on edit distance.
388missing-member-hint=yes
389
390# The minimum edit distance a name should have in order to be considered a
391# similar match for a missing member name.
392missing-member-hint-distance=1
393
394# The total number of similar names that should be taken in consideration when
395# showing a hint for a missing member.
396missing-member-max-choices=1
397
398# List of decorators that change the signature of a decorated function.
399signature-mutators=
400
401
402[VARIABLES]
403
404# List of additional names supposed to be defined in builtins. Remember that
405# you should avoid defining new builtins when possible.
406additional-builtins=
407
408# Tells whether unused global variables should be treated as a violation.
409allow-global-unused-variables=yes
410
411# List of strings which can identify a callback function by name. A callback
412# name must start or end with one of those strings.
413callbacks=cb_,_cb
414
415# A regular expression matching the name of dummy variables (i.e. expected to
416# not be used).
417dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
418
419# Argument names that match this expression will be ignored. Default to name
420# with leading underscore.
421ignored-argument-names=_.*|^ignored_|^unused_
422
423# Tells whether we should check for unused import in __init__ files.
424init-import=no
425
426# List of qualified module names which can have objects that can redefine
427# builtins.
428redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
429
430
431[CLASSES]
432
433# List of method names used to declare (i.e. assign) instance attributes.
434defining-attr-methods=__init__,
435                      __new__,
436                      setUp,
437                      __post_init__
438
439# List of member names, which should be excluded from the protected access
440# warning.
441exclude-protected=_asdict,
442                  _fields,
443                  _replace,
444                  _source,
445                  _make
446
447# List of valid names for the first argument in a class method.
448valid-classmethod-first-arg=cls
449
450# List of valid names for the first argument in a metaclass class method.
451valid-metaclass-classmethod-first-arg=cls
452
453
454[DESIGN]
455
456# Maximum number of arguments for function / method.
457max-args=7
458
459# Maximum number of attributes for a class (see R0902).
460max-attributes=16
461
462# Maximum number of boolean expressions in an if statement (see R0916).
463max-bool-expr=5
464
465# Maximum number of branch for function / method body.
466max-branches=12
467
468# Maximum number of locals for function / method body.
469max-locals=16
470
471# Maximum number of parents for a class (see R0901).
472max-parents=7
473
474# Maximum number of public methods for a class (see R0904).
475max-public-methods=20
476
477# Maximum number of return / yield for function / method body.
478max-returns=6
479
480# Maximum number of statements in function / method body.
481max-statements=50
482
483# Minimum number of public methods for a class (see R0903).
484min-public-methods=0
485
486
487[IMPORTS]
488
489# List of modules that can be imported at any level, not just the top level
490# one.
491allow-any-import-level=
492
493# Allow wildcard imports from modules that define __all__.
494allow-wildcard-with-all=no
495
496# Analyse import fallback blocks. This can be used to support both Python 2 and
497# 3 compatible code, which means that the block might have code that exists
498# only in one or another interpreter, leading to false positives when analysed.
499analyse-fallback-blocks=no
500
501# Deprecated modules which should not be used, separated by a comma.
502deprecated-modules=optparse,tkinter.tix
503
504# Create a graph of external dependencies in the given file (report RP0402 must
505# not be disabled).
506ext-import-graph=
507
508# Create a graph of every (i.e. internal and external) dependencies in the
509# given file (report RP0402 must not be disabled).
510import-graph=
511
512# Create a graph of internal dependencies in the given file (report RP0402 must
513# not be disabled).
514int-import-graph=
515
516# Force import order to recognize a module as part of the standard
517# compatibility libraries.
518known-standard-library=
519
520# Force import order to recognize a module as part of a third party library.
521known-third-party=enchant
522
523# Couples of modules and preferred modules, separated by a comma.
524preferred-modules=
525
526
527[EXCEPTIONS]
528
529# Exceptions that will emit a warning when being caught. Defaults to
530# "BaseException, Exception".
531overgeneral-exceptions=BaseException,
532                       Exception
533