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
6 extension-pkg-whitelist=
8 # Add files or directories to the blacklist. They should be base names, not
12 # Add files or directories matching the regex patterns to the blacklist. The
13 # regex matches against base names, not paths.
16 # Python code to execute, usually for sys.path manipulation such as
20 # Use multiple processes to speed up Pylint.
23 # List of plugins (as comma separated values of python modules names) to load,
24 # usually to register additional checkers.
27 # Pickle collected data for later comparisons.
30 # Specify a configuration file.
33 # Allow loading of arbitrary C extensions. Extensions are imported into the
34 # active Python interpreter and may run arbitrary code.
35 unsafe-load-any-extension=no
40 # Only show warnings with the listed confidence levels. Leave empty to show
41 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
44 # Disable the message, report, category or checker with the given id(s). You
45 # can either give multiple identifiers separated by comma (,) or put this
46 # option multiple times (only on the command line, not in the configuration
47 # file where it should appear only once).You can also use "--disable=all" to
48 # disable everything first and then reenable specific checks. For example, if
49 # you want to run only the similarities checker, you can use "--disable=all
50 # --enable=similarities". If you want to run only the classes checker, but have
51 # no Warning level messages displayed, use"--disable=all --enable=classes
53 disable=unused-argument,global-statement,too-many-statements,too-many-arguments,too-many-branches,catching-non-exception,relative-import,too-many-locals,invalid-name,broad-except,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,import-star-module-level,raw-checker-failed,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,missing-docstring,redefined-builtin,no-name-in-module,no-self-use,no-member,arguments-differ,attribute-defined-outside-init,non-iterator-returned,eval-used,unexpected-keyword-arg,pointless-string-statement,no-value-for-parameter,useless-object-inheritance,import-outside-toplevel,wrong-import-order
55 # Enable the message, report, category or checker with the given id(s). You can
56 # either give multiple identifier separated by comma (,) or put this option
57 # multiple time (only on the command line, not in the configuration file where
58 # it should appear only once). See also the "--disable" option for examples.
64 # Python expression which should return a note less than 10 (10 is the highest
65 # note). You have access to the variables errors warning, statement which
66 # respectively contain the number of errors / warnings messages and the total
67 # number of statements analyzed. This is used by the global evaluation report
69 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
71 # Template used to display messages. This is a python new-style format string
72 # used to format the message information. See doc for all details
75 # Set the output format. Available formats are text, parseable, colorized, json
76 # and msvs (visual studio).You can also give a reporter class, eg
77 # mypackage.mymodule.MyReporterClass.
80 # Tells whether to display a full report or only the messages
83 # Activate the evaluation score.
89 # Maximum number of nested blocks for function / method body
95 # Naming hint for argument names
96 argument-name-hint=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
98 # Regular expression matching correct argument names
99 argument-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
101 # Naming hint for attribute names
102 attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
104 # Regular expression matching correct attribute names
105 attr-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
107 # Bad variable names which should always be refused, separated by a comma
108 bad-names=foo,bar,baz,toto,tutu,tata
110 # Naming hint for class attribute names
111 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
113 # Regular expression matching correct class attribute names
114 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,50}|(__.*__))$
116 # Naming hint for class names
117 class-name-hint=[A-Z_][a-zA-Z0-9]+$
119 # Regular expression matching correct class names
120 class-rgx=[A-Z_][a-zA-Z0-9]+$
122 # Naming hint for constant names
123 const-name-hint=(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$
125 # Regular expression matching correct constant names
126 const-rgx=(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$
128 # Minimum line length for functions/classes that require docstrings, shorter
130 docstring-min-length=-1
132 # Naming hint for function names
133 function-name-hint=(([a-z][a-zA-Z0-9_]{2,50})|(_[a-z0-9_]*))$
135 # Regular expression matching correct function names
136 function-rgx=(([a-z][a-zA-Z0-9_]{2,50})|(_[a-z0-9_]*))$
138 # Good variable names which should always be accepted, separated by a comma
139 good-names=i,j,k,ex,Run,_
141 # Include a hint for the correct naming format with invalid-name
142 include-naming-hint=no
144 # Naming hint for inline iteration names
145 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
147 # Regular expression matching correct inline iteration names
148 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
150 # Naming hint for method names
151 method-name-hint=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
153 # Regular expression matching correct method names
154 method-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
156 # Naming hint for module names
157 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
159 # Regular expression matching correct module names
160 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
162 # Colon-delimited sets of names that determine each other's naming style when
163 # the name regexes allow several styles.
166 # Regular expression which should only match function or class names that do
167 # not require a docstring.
170 # List of decorators that produce properties, such as abc.abstractproperty. Add
171 # to this list to register other decorators that produce valid properties.
172 property-classes=abc.abstractproperty
174 # Naming hint for variable names
175 variable-name-hint=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
177 # Regular expression matching correct variable names
178 variable-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
183 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
184 expected-line-ending-format=
186 # Regexp for a line that is allowed to be longer than the limit.
187 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
189 # Number of spaces of indent required inside a hanging or continued line.
192 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
196 # Maximum number of characters on a single line.
199 # Maximum number of lines in a module
200 max-module-lines=1600
202 # List of optional constructs for which whitespace checking is disabled. `dict-
203 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
204 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
205 # `empty-line` allows space-only lines.
206 no-space-check=trailing-comma,dict-separator
208 # Allow the body of a class to be on the same line as the declaration if body
209 # contains single statement.
210 single-line-class-stmt=no
212 # Allow the body of an if to be on the same line as the test if there is no
214 single-line-if-stmt=no
219 # Logging modules to check that the string format arguments are in logging
220 # function parameter format
221 logging-modules=logging
226 # List of note tags to take in consideration, separated by a comma.
232 # Ignore comments when computing similarities.
235 # Ignore docstrings when computing similarities.
236 ignore-docstrings=yes
238 # Ignore imports when computing similarities.
241 # Minimum lines number of a similarity.
242 min-similarity-lines=4
247 # Spelling dictionary name. Available dictionaries: none. To make it working
248 # install python-enchant package.
251 # List of comma separated words that should not be checked.
252 spelling-ignore-words=
254 # A path to a file that contains private dictionary; one word per line.
255 spelling-private-dict-file=
257 # Tells whether to store unknown words to indicated private dictionary in
258 # --spelling-private-dict-file option instead of raising a message.
259 spelling-store-unknown-words=no
264 # List of decorators that produce context managers, such as
265 # contextlib.contextmanager. Add to this list to register other decorators that
266 # produce valid context managers.
267 contextmanager-decorators=contextlib.contextmanager
269 # List of members which are set dynamically and missed by pylint inference
270 # system, and so shouldn't trigger E1101 when accessed. Python regular
271 # expressions are accepted.
274 # Tells whether missing members accessed in mixin class should be ignored. A
275 # mixin class is detected if its name ends with "mixin" (case insensitive).
276 ignore-mixin-members=yes
278 # This flag controls whether pylint should warn about no-member and similar
279 # checks whenever an opaque object is returned when inferring. The inference
280 # can return multiple potential results while evaluating a Python object, but
281 # some branches might not be evaluated, which results in partial inference. In
282 # that case, it might be useful to still emit no-member and other checks for
283 # the rest of the inferred objects.
284 ignore-on-opaque-inference=yes
286 # List of class names for which member attributes should not be checked (useful
287 # for classes with dynamically set attributes). This supports the use of
289 ignored-classes=optparse.Values,thread._local,_thread._local
291 # List of module names for which member attributes should not be checked
292 # (useful for modules/projects where namespaces are manipulated during runtime
293 # and thus existing member attributes cannot be deduced by static analysis. It
294 # supports qualified module names, as well as Unix pattern matching.
297 # Show a hint with possible names when a member name was not found. The aspect
298 # of finding the hint is based on edit distance.
299 missing-member-hint=yes
301 # The minimum edit distance a name should have in order to be considered a
302 # similar match for a missing member name.
303 missing-member-hint-distance=1
305 # The total number of similar names that should be taken in consideration when
306 # showing a hint for a missing member.
307 missing-member-max-choices=1
312 # List of additional names supposed to be defined in builtins. Remember that
313 # you should avoid to define new builtins when possible.
316 # Tells whether unused global variables should be treated as a violation.
317 allow-global-unused-variables=yes
319 # List of strings which can identify a callback function by name. A callback
320 # name must start or end with one of those strings.
323 # A regular expression matching the name of dummy variables (i.e. expectedly
325 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
327 # Argument names that match this expression will be ignored. Default to name
328 # with leading underscore
329 ignored-argument-names=_.*|^ignored_|^unused_
331 # Tells whether we should check for unused import in __init__ files.
334 # List of qualified module names which can have objects that can redefine
336 redefining-builtins-modules=six.moves,future.builtins
341 # List of method names used to declare (i.e. assign) instance attributes.
342 defining-attr-methods=__init__,__new__,setUp
344 # List of member names, which should be excluded from the protected access
346 exclude-protected=_asdict,_fields,_replace,_source,_make
348 # List of valid names for the first argument in a class method.
349 valid-classmethod-first-arg=cls
351 # List of valid names for the first argument in a metaclass class method.
352 valid-metaclass-classmethod-first-arg=mcs
357 # Maximum number of arguments for function / method
360 # Maximum number of attributes for a class (see R0902).
363 # Maximum number of boolean expressions in a if statement
366 # Maximum number of branch for function / method body
369 # Maximum number of locals for function / method body
372 # Maximum number of parents for a class (see R0901).
375 # Maximum number of public methods for a class (see R0904).
376 max-public-methods=40
378 # Maximum number of return / yield for function / method body
381 # Maximum number of statements in function / method body
384 # Minimum number of public methods for a class (see R0903).
392 # Allow wildcard imports from modules that define __all__.
393 allow-wildcard-with-all=no
395 # Analyse import fallback blocks. This can be used to support both Python 2 and
396 # 3 compatible code, which means that the block might have code that exists
397 # only in one or another interpreter, leading to false positives when analysed.
398 analyse-fallback-blocks=no
400 # Deprecated modules which should not be used, separated by a comma
401 deprecated-modules=regsub,TERMIOS,Bastion,rexec
403 # Create a graph of external dependencies in the given file (report RP0402 must
407 # Create a graph of every (i.e. internal and external) dependencies in the
408 # given file (report RP0402 must not be disabled)
411 # Create a graph of internal dependencies in the given file (report RP0402 must
415 # Force import order to recognize a module as part of the standard
416 # compatibility libraries.
417 known-standard-library=
419 # Force import order to recognize a module as part of a third party library.
420 known-third-party=enchant
425 # Exceptions that will emit a warning when being caught. Defaults to
427 overgeneral-exceptions=Exception