3 # Specify a configuration file.
6 # Python code to execute, usually for sys.path manipulation such as
10 # Add files or directories to the blacklist. They should be base names, not
14 # Add files or directories matching the regex patterns to the blacklist. The
15 # regex matches against base names, not paths.
18 # Pickle collected data for later comparisons.
21 # List of plugins (as comma separated values of python modules names) to load,
22 # usually to register additional checkers.
25 # Use multiple processes to speed up Pylint.
28 # Allow loading of arbitrary C extensions. Extensions are imported into the
29 # active Python interpreter and may run arbitrary code.
30 unsafe-load-any-extension=no
32 # A comma-separated list of package or module names from where C extensions may
33 # be loaded. Extensions are loading into the active Python interpreter and may
35 extension-pkg-whitelist=
37 # Allow optimization of some AST trees. This will activate a peephole AST
38 # optimizer, which will apply various small optimizations. For instance, it can
39 # be used to obtain the result of joining multiple strings with the addition
40 # operator. Joining a lot of strings can lead to a maximum recursion error in
41 # Pylint and this flag can prevent that. It has one side effect, the resulting
42 # AST will be different than the one from reality. This option is deprecated
43 # and it will be removed in Pylint 2.0.
49 # Only show warnings with the listed confidence levels. Leave empty to show
50 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
53 # Enable the message, report, category or checker with the given id(s). You can
54 # either give multiple identifier separated by comma (,) or put this option
55 # multiple time (only on the command line, not in the configuration file where
56 # it should appear only once). See also the "--disable" option for examples.
59 # Disable the message, report, category or checker with the given id(s). You
60 # can either give multiple identifiers separated by comma (,) or put this
61 # option multiple times (only on the command line, not in the configuration
62 # file where it should appear only once).You can also use "--disable=all" to
63 # disable everything first and then reenable specific checks. For example, if
64 # you want to run only the similarities checker, you can use "--disable=all
65 # --enable=similarities". If you want to run only the classes checker, but have
66 # no Warning level messages displayed, use"--disable=all --enable=classes
68 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,too-many-function-args, missing-docstring,too-few-public-methods,invalid-name,too-many-public-methods,too-many-locals,E402
73 # Set the output format. Available formats are text, parseable, colorized, msvs
74 # (visual studio) and html. You can also give a reporter class, eg
75 # mypackage.mymodule.MyReporterClass.
78 # Put messages in a separate file for each module / package specified on the
79 # command line instead of printing them on stdout. Reports (if any) will be
80 # written in a file name "pylint_global.[txt|html]". This option is deprecated
81 # and it will be removed in Pylint 2.0.
84 # Tells whether to display a full report or only the messages
87 # Python expression which should return a note less than 10 (10 is the highest
88 # note). You have access to the variables errors warning, statement which
89 # respectively contain the number of errors / warnings messages and the total
90 # number of statements analyzed. This is used by the global evaluation report
92 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
94 # Template used to display messages. This is a python new-style format string
95 # used to format the message information. See doc for all details
101 # Good variable names which should always be accepted, separated by a comma
102 good-names=i,j,k,ex,Run,_
104 # Bad variable names which should always be refused, separated by a comma
105 bad-names=foo,bar,baz,toto,tutu,tata
107 # Colon-delimited sets of names that determine each other's naming style when
108 # the name regexes allow several styles.
111 # Include a hint for the correct naming format with invalid-name
112 include-naming-hint=no
114 # List of decorators that produce properties, such as abc.abstractproperty. Add
115 # to this list to register other decorators that produce valid properties.
116 property-classes=abc.abstractproperty
118 # Regular expression matching correct function names
119 function-rgx=[a-z_][a-z0-9_]{2,30}$
121 # Naming hint for function names
122 function-name-hint=[a-z_][a-z0-9_]{2,30}$
124 # Regular expression matching correct variable names
125 variable-rgx=[a-z_][a-z0-9_]{2,30}$
127 # Naming hint for variable names
128 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
130 # Regular expression matching correct constant names
131 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
133 # Naming hint for constant names
134 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
136 # Regular expression matching correct attribute names
137 attr-rgx=[a-z_][a-z0-9_]{2,30}$
139 # Naming hint for attribute names
140 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
142 # Regular expression matching correct argument names
143 argument-rgx=[a-z_][a-z0-9_]{2,30}$
145 # Naming hint for argument names
146 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
148 # Regular expression matching correct class attribute names
149 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
151 # Naming hint for class attribute names
152 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
154 # Regular expression matching correct inline iteration names
155 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
157 # Naming hint for inline iteration names
158 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
160 # Regular expression matching correct class names
161 class-rgx=[A-Z_][a-zA-Z0-9]+$
163 # Naming hint for class names
164 class-name-hint=[A-Z_][a-zA-Z0-9]+$
166 # Regular expression matching correct module names
167 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
169 # Naming hint for module names
170 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
172 # Regular expression matching correct method names
173 method-rgx=[a-z_][a-z0-9_]{2,30}$
175 # Naming hint for method names
176 method-name-hint=[a-z_][a-z0-9_]{2,30}$
178 # Regular expression which should only match function or class names that do
179 # not require a docstring.
182 # Minimum line length for functions/classes that require docstrings, shorter
184 docstring-min-length=-1
189 # Maximum number of nested blocks for function / method body
195 # Maximum number of characters on a single line.
198 # Regexp for a line that is allowed to be longer than the limit.
199 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
201 # Allow the body of an if to be on the same line as the test if there is no
203 single-line-if-stmt=no
205 # List of optional constructs for which whitespace checking is disabled. `dict-
206 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
207 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
208 # `empty-line` allows space-only lines.
209 no-space-check=trailing-comma,dict-separator
211 # Maximum number of lines in a module
212 max-module-lines=1000
214 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
218 # Number of spaces of indent required inside a hanging or continued line.
221 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
222 expected-line-ending-format=
227 # Logging modules to check that the string format arguments are in logging
228 # function parameter format
229 logging-modules=logging
234 # List of note tags to take in consideration, separated by a comma.
240 # Minimum lines number of a similarity.
241 min-similarity-lines=4
243 # Ignore comments when computing similarities.
246 # Ignore docstrings when computing similarities.
247 ignore-docstrings=yes
249 # Ignore imports when computing similarities.
255 # Spelling dictionary name. Available dictionaries: none. To make it working
256 # install python-enchant package.
259 # List of comma separated words that should not be checked.
260 spelling-ignore-words=
262 # A path to a file that contains private dictionary; one word per line.
263 spelling-private-dict-file=
265 # Tells whether to store unknown words to indicated private dictionary in
266 # --spelling-private-dict-file option instead of raising a message.
267 spelling-store-unknown-words=no
272 # Tells whether missing members accessed in mixin class should be ignored. A
273 # mixin class is detected if its name ends with "mixin" (case insensitive).
274 ignore-mixin-members=yes
276 # List of module names for which member attributes should not be checked
277 # (useful for modules/projects where namespaces are manipulated during runtime
278 # and thus existing member attributes cannot be deduced by static analysis. It
279 # supports qualified module names, as well as Unix pattern matching.
282 # List of class names for which member attributes should not be checked (useful
283 # for classes with dynamically set attributes). This supports the use of
285 ignored-classes=optparse.Values,thread._local,_thread._local
287 # List of members which are set dynamically and missed by pylint inference
288 # system, and so shouldn't trigger E1101 when accessed. Python regular
289 # expressions are accepted.
292 # List of decorators that produce context managers, such as
293 # contextlib.contextmanager. Add to this list to register other decorators that
294 # produce valid context managers.
295 contextmanager-decorators=contextlib.contextmanager
300 # Tells whether we should check for unused import in __init__ files.
303 # A regular expression matching the name of dummy variables (i.e. expectedly
305 dummy-variables-rgx=(_+[a-zA-Z0-9]*?$)|dummy
307 # List of additional names supposed to be defined in builtins. Remember that
308 # you should avoid to define new builtins when possible.
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.
315 # List of qualified module names which can have objects that can redefine
317 redefining-builtins-modules=six.moves,future.builtins
322 # List of method names used to declare (i.e. assign) instance attributes.
323 defining-attr-methods=__init__,__new__,setUp
325 # List of valid names for the first argument in a class method.
326 valid-classmethod-first-arg=cls
328 # List of valid names for the first argument in a metaclass class method.
329 valid-metaclass-classmethod-first-arg=mcs
331 # List of member names, which should be excluded from the protected access
333 exclude-protected=_asdict,_fields,_replace,_source,_make
338 # Maximum number of arguments for function / method
341 # Argument names that match this expression will be ignored. Default to name
342 # with leading underscore
343 ignored-argument-names=_.*
345 # Maximum number of locals for function / method body
348 # Maximum number of return / yield for function / method body
351 # Maximum number of branch for function / method body
354 # Maximum number of statements in function / method body
357 # Maximum number of parents for a class (see R0901).
360 # Maximum number of attributes for a class (see R0902).
363 # Minimum number of public methods for a class (see R0903).
366 # Maximum number of public methods for a class (see R0904).
367 max-public-methods=20
369 # Maximum number of boolean expressions in a if statement
375 # Deprecated modules which should not be used, separated by a comma
376 deprecated-modules=regsub,TERMIOS,Bastion,rexec
378 # Create a graph of every (i.e. internal and external) dependencies in the
379 # given file (report RP0402 must not be disabled)
382 # Create a graph of external dependencies in the given file (report RP0402 must
386 # Create a graph of internal dependencies in the given file (report RP0402 must
390 # Force import order to recognize a module as part of the standard
391 # compatibility libraries.
392 known-standard-library=
394 # Force import order to recognize a module as part of a third party library.
395 known-third-party=enchant
397 # Analyse import fallback blocks. This can be used to support both Python 2 and
398 # 3 compatible code, which means that the block might have code that exists
399 # only in one or another interpreter, leading to false positives when analysed.
400 analyse-fallback-blocks=no
405 # Exceptions that will emit a warning when being caught. Defaults to
407 overgeneral-exceptions=Exception