1 # Licensed to the Apache Software Foundation (ASF) under one or more
2 # contributor license agreements. See the NOTICE file distributed with
3 # this work for additional information regarding copyright ownership.
4 # The ASF licenses this file to You under the Apache License, Version 2.0
5 # (the "License"); you may not use this file except in compliance with
6 # the License. You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
18 # Python code to execute, usually for sys.path manipulation such as
22 # Add files or directories to the blacklist. They should be base names, not
26 # Add files or directories matching the regex patterns to the blacklist. The
27 # regex matches against base names, not paths.
30 # Pickle collected data for later comparisons.
33 # List of plugins (as comma separated values of python modules names) to load,
34 # usually to register additional checkers.
37 # Use multiple processes to speed up Pylint.
40 # Allow loading of arbitrary C extensions. Extensions are imported into the
41 # active Python interpreter and may run arbitrary code.
42 unsafe-load-any-extension=no
44 # A comma-separated list of package or module names from where C extensions may
45 # be loaded. Extensions are loading into the active Python interpreter and may
47 extension-pkg-whitelist=
49 # Allow optimization of some AST trees. This will activate a peephole AST
50 # optimizer, which will apply various small optimizations. For instance, it can
51 # be used to obtain the result of joining multiple strings with the addition
52 # operator. Joining a lot of strings can lead to a maximum recursion error in
53 # Pylint and this flag can prevent that. It has one side effect, the resulting
54 # AST will be different than the one from reality. This option is deprecated
55 # and it will be removed in Pylint 2.0.
61 # Only show warnings with the listed confidence levels. Leave empty to show
62 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
65 # Enable the message, report, category or checker with the given id(s). You can
66 # either give multiple identifier separated by comma (,) or put this option
67 # multiple time (only on the command line, not in the configuration file where
68 # it should appear only once). See also the "--disable" option for examples.
71 # Disable the message, report, category or checker with the given id(s). You
72 # can either give multiple identifiers separated by comma (,) or put this
73 # option multiple times (only on the command line, not in the configuration
74 # file where it should appear only once).You can also use "--disable=all" to
75 # disable everything first and then reenable specific checks. For example, if
76 # you want to run only the similarities checker, you can use "--disable=all
77 # --enable=similarities". If you want to run only the classes checker, but have
78 # no Warning level messages displayed, use"--disable=all --enable=classes
80 disable=import-star-module-level,old-octal-literal,oct-method,print-statement,unpacking-in-except,parameter-unpacking,backtick,old-raise-syntax,old-ne-operator,long-suffix,dict-view-method,dict-iter-method,metaclass-assignment,next-method-called,raising-string,indexing-exception,raw_input-builtin,long-builtin,file-builtin,execfile-builtin,coerce-builtin,cmp-builtin,buffer-builtin,basestring-builtin,apply-builtin,filter-builtin-not-iterating,using-cmp-argument,useless-suppression,range-builtin-not-iterating,suppressed-message,no-absolute-import,old-division,cmp-method,reload-builtin,zip-builtin-not-iterating,intern-builtin,unichr-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,input-builtin,round-builtin,hex-method,nonzero-method,map-builtin-not-iterating,redefined-builtin,no-self-use,missing-docstring,attribute-defined-outside-init,redefined-outer-name,import-error,redefined-variable-type,broad-except,protected-access,global-statement,too-many-locals,abstract-method,no-member,unused-argument
84 # Set the output format. Available formats are text, parseable, colorized, msvs
85 # (visual studio) and html. You can also give a reporter class, eg
86 # mypackage.mymodule.MyReporterClass.
87 output-format=colorized
89 # Put messages in a separate file for each module / package specified on the
90 # command line instead of printing them on stdout. Reports (if any) will be
91 # written in a file name "pylint_global.[txt|html]". This option is deprecated
92 # and it will be removed in Pylint 2.0.
95 # Tells whether to display a full report or only the messages
98 # Python expression which should return a note less than 10 (10 is the highest
99 # note). You have access to the variables errors warning, statement which
100 # respectively contain the number of errors / warnings messages and the total
101 # number of statements analyzed. This is used by the global evaluation report
103 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
105 # Template used to display messages. This is a python new-style format string
106 # used to format the message information. See doc for all details
112 # Tells whether we should check for unused import in __init__ files.
115 # A regular expression matching the name of dummy variables (i.e. expectedly
117 dummy-variables-rgx=(_+[a-zA-Z0-9]*?$)|dummy|args|kwargs
119 # List of additional names supposed to be defined in builtins. Remember that
120 # you should avoid to define new builtins when possible.
123 # List of strings which can identify a callback function by name. A callback
124 # name must start or end with one of those strings.
127 # List of qualified module names which can have objects that can redefine
129 redefining-builtins-modules=six.moves,future.builtins
134 # Spelling dictionary name. Available dictionaries: none. To make it working
135 # install python-enchant package.
138 # List of comma separated words that should not be checked.
139 spelling-ignore-words=
141 # A path to a file that contains private dictionary; one word per line.
142 spelling-private-dict-file=
144 # Tells whether to store unknown words to indicated private dictionary in
145 # --spelling-private-dict-file option instead of raising a message.
146 spelling-store-unknown-words=no
151 # List of note tags to take in consideration, separated by a comma.
157 # Logging modules to check that the string format arguments are in logging
158 # function parameter format
159 logging-modules=logging
164 # Good variable names which should always be accepted, separated by a comma
165 good-names=i,j,k,v,f,ex,e,_,id
167 # Bad variable names which should always be refused, separated by a comma
168 bad-names=foo,bar,baz,toto,tutu,tata
170 # Colon-delimited sets of names that determine each other's naming style when
171 # the name regexes allow several styles.
174 # Include a hint for the correct naming format with invalid-name
175 include-naming-hint=no
177 # List of decorators that produce properties, such as abc.abstractproperty. Add
178 # to this list to register other decorators that produce valid properties.
179 property-classes=abc.abstractproperty
181 # Regular expression matching correct function names
182 function-rgx=[a-z_][a-z0-9_]*$
184 # Naming hint for function names
185 function-name-hint=[a-z_][a-z0-9_]*$
187 # Regular expression matching correct variable names
188 variable-rgx=[a-z_][a-z0-9_]*$
190 # Naming hint for variable names
191 variable-name-hint=[a-z_][a-z0-9_]*$
193 # Regular expression matching correct constant names
194 const-rgx=(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$
196 # Naming hint for constant names
197 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
199 # Regular expression matching correct attribute names
200 attr-rgx=[a-z_][a-z0-9_]*$
202 # Naming hint for attribute names
203 attr-name-hint=[a-z_][a-z0-9_]*$
205 # Regular expression matching correct argument names
206 argument-rgx=[a-z_][a-z0-9_]*$
208 # Naming hint for argument names
209 argument-name-hint=[a-z_][a-z0-9_]*$
211 # Regular expression matching correct class attribute names
212 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]*|(__.*__))$
214 # Naming hint for class attribute names
215 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]*|(__.*__))$
217 # Regular expression matching correct inline iteration names
218 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
220 # Naming hint for inline iteration names
221 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
223 # Regular expression matching correct class names
224 class-rgx=[A-Z_][a-zA-Z0-9]+$
226 # Naming hint for class names
227 class-name-hint=[A-Z_][a-zA-Z0-9]+$
229 # Regular expression matching correct module names
230 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
232 # Naming hint for module names
233 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
235 # Regular expression matching correct method names
236 method-rgx=[a-z_][a-z0-9_]*$
238 # Naming hint for method names
239 method-name-hint=[a-z_][a-z0-9_]*$
241 # Regular expression which should only match function or class names that do
242 # not require a docstring.
245 # Minimum line length for functions/classes that require docstrings, shorter
247 docstring-min-length=-1
252 # Maximum number of nested blocks for function / method body
258 # Minimum lines number of a similarity.
259 min-similarity-lines=4
261 # Ignore comments when computing similarities.
264 # Ignore docstrings when computing similarities.
265 ignore-docstrings=yes
267 # Ignore imports when computing similarities.
273 # Tells whether missing members accessed in mixin class should be ignored. A
274 # mixin class is detected if its name ends with "mixin" (case insensitive).
275 ignore-mixin-members=yes
277 # List of module names for which member attributes should not be checked
278 # (useful for modules/projects where namespaces are manipulated during runtime
279 # and thus existing member attributes cannot be deduced by static analysis. It
280 # supports qualified module names, as well as Unix pattern matching.
283 # List of class names for which member attributes should not be checked (useful
284 # for classes with dynamically set attributes). This supports the use of
286 ignored-classes=optparse.Values,thread._local,_thread._local
288 # List of members which are set dynamically and missed by pylint inference
289 # system, and so shouldn't trigger E1101 when accessed. Python regular
290 # expressions are accepted.
293 # List of decorators that produce context managers, such as
294 # contextlib.contextmanager. Add to this list to register other decorators that
295 # produce valid context managers.
296 contextmanager-decorators=contextlib.contextmanager
301 # Maximum number of characters on a single line.
304 # Regexp for a line that is allowed to be longer than the limit.
305 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
307 # Allow the body of an if to be on the same line as the test if there is no
309 single-line-if-stmt=no
311 # List of optional constructs for which whitespace checking is disabled. `dict-
312 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
313 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
314 # `empty-line` allows space-only lines.
315 no-space-check=trailing-comma,dict-separator
317 # Maximum number of lines in a module
318 max-module-lines=1500
320 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
324 # Number of spaces of indent required inside a hanging or continued line.
327 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
328 expected-line-ending-format=
333 # List of method names used to declare (i.e. assign) instance attributes.
334 defining-attr-methods=__init__,__new__,setUp
336 # List of valid names for the first argument in a class method.
337 valid-classmethod-first-arg=cls
339 # List of valid names for the first argument in a metaclass class method.
340 valid-metaclass-classmethod-first-arg=mcs
342 # List of member names, which should be excluded from the protected access
344 exclude-protected=_asdict,_fields,_replace,_source,_make
349 # Maximum number of arguments for function / method
352 # Argument names that match this expression will be ignored. Default to name
353 # with leading underscore
354 ignored-argument-names=_.*
356 # Maximum number of locals for function / method body
359 # Maximum number of return / yield for function / method body
362 # Maximum number of branch for function / method body
365 # Maximum number of statements in function / method body
368 # Maximum number of parents for a class (see R0901).
371 # Maximum number of attributes for a class (see R0902).
374 # Minimum number of public methods for a class (see R0903).
377 # Maximum number of public methods for a class (see R0904).
378 max-public-methods=50
380 # Maximum number of boolean expressions in a if statement
386 # Deprecated modules which should not be used, separated by a comma
387 deprecated-modules=regsub,TERMIOS,Bastion,rexec
389 # Create a graph of every (i.e. internal and external) dependencies in the
390 # given file (report RP0402 must not be disabled)
393 # Create a graph of external dependencies in the given file (report RP0402 must
397 # Create a graph of internal dependencies in the given file (report RP0402 must
401 # Force import order to recognize a module as part of the standard
402 # compatibility libraries.
403 known-standard-library=
405 # Force import order to recognize a module as part of a third party library.
406 known-third-party=enchant
408 # Analyse import fallback blocks. This can be used to support both Python 2 and
409 # 3 compatible code, which means that the block might have code that exists
410 # only in one or another interpreter, leading to false positives when analysed.
411 analyse-fallback-blocks=no
416 # Exceptions that will emit a warning when being caught. Defaults to
418 overgeneral-exceptions=Exception