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 # Pickle collected data for later comparisons.
17 # List of plugins (as comma separated values of python modules names) to load,
18 # usually to register additional checkers.
21 # Use multiple processes to speed up Pylint.
24 # Allow loading of arbitrary C extensions. Extensions are imported into the
25 # active Python interpreter and may run arbitrary code.
26 unsafe-load-any-extension=no
28 # A comma-separated list of package or module names from where C extensions may
29 # be loaded. Extensions are loading into the active Python interpreter and may
31 extension-pkg-whitelist=
33 # Allow optimization of some AST trees. This will activate a peephole AST
34 # optimizer, which will apply various small optimizations. For instance, it can
35 # be used to obtain the result of joining multiple strings with the addition
36 # operator. Joining a lot of strings can lead to a maximum recursion error in
37 # Pylint and this flag can prevent that. It has one side effect, the resulting
38 # AST will be different than the one from reality.
44 # Only show warnings with the listed confidence levels. Leave empty to show
45 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
48 # Enable the message, report, category or checker with the given id(s). You can
49 # either give multiple identifier separated by comma (,) or put this option
50 # multiple time. See also the "--disable" option for examples.
53 # Disable the message, report, category or checker with the given id(s). You
54 # can either give multiple identifiers separated by comma (,) or put this
55 # option multiple times (only on the command line, not in the configuration
56 # file where it should appear only once).You can also use "--disable=all" to
57 # disable everything first and then reenable specific checks. For example, if
58 # you want to run only the similarities checker, you can use "--disable=all
59 # --enable=similarities". If you want to run only the classes checker, but have
60 # no Warning level messages displayed, use"--disable=all --enable=classes
62 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,max-line-length,missing-docstring,logging-too-many-args,import-error, line-too-long,no-name-in-module
67 # Set the output format. Available formats are text, parseable, colorized, msvs
68 # (visual studio) and html. You can also give a reporter class, eg
69 # mypackage.mymodule.MyReporterClass.
72 # Put messages in a separate file for each module / package specified on the
73 # command line instead of printing them on stdout. Reports (if any) will be
74 # written in a file name "pylint_global.[txt|html]".
77 # Tells whether to display a full report or only the messages
80 # Python expression which should return a note less than 10 (10 is the highest
81 # note). You have access to the variables errors warning, statement which
82 # respectively contain the number of errors / warnings messages and the total
83 # number of statements analyzed. This is used by the global evaluation report
85 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
87 # Template used to display messages. This is a python new-style format string
88 # used to format the message information. See doc for all details
94 # Logging modules to check that the string format arguments are in logging
95 # function parameter format
96 logging-modules=logging
101 # List of builtins function names that should not be used, separated by a comma
102 bad-functions=map,filter,input
104 # Good variable names which should always be accepted, separated by a comma
105 good-names=i,j,k,ex,Run,_
107 # Bad variable names which should always be refused, separated by a comma
108 bad-names=foo,bar,baz,toto,tutu,tata
110 # Colon-delimited sets of names that determine each other's naming style when
111 # the name regexes allow several styles.
114 # Include a hint for the correct naming format with invalid-name
115 include-naming-hint=no
117 # Regular expression matching correct function names
118 function-rgx=[a-z_][a-z0-9_]{2,30}$
120 # Naming hint for function names
121 function-name-hint=[a-z_][a-z0-9_]{2,30}$
123 # Regular expression matching correct variable names
124 variable-rgx=[a-z_][a-z0-9_]{2,30}$
126 # Naming hint for variable names
127 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
129 # Regular expression matching correct constant names
130 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
132 # Naming hint for constant names
133 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
135 # Regular expression matching correct attribute names
136 attr-rgx=[a-z_][a-z0-9_]{2,30}$
138 # Naming hint for attribute names
139 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
141 # Regular expression matching correct argument names
142 argument-rgx=[a-z_][a-z0-9_]{2,30}$
144 # Naming hint for argument names
145 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
147 # Regular expression matching correct class attribute names
148 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
150 # Naming hint for class attribute names
151 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
153 # Regular expression matching correct inline iteration names
154 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
156 # Naming hint for inline iteration names
157 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
159 # Regular expression matching correct class names
160 class-rgx=[A-Z_][a-zA-Z0-9]+$
162 # Naming hint for class names
163 class-name-hint=[A-Z_][a-zA-Z0-9]+$
165 # Regular expression matching correct module names
166 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
168 # Naming hint for module names
169 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
171 # Regular expression matching correct method names
172 method-rgx=[a-z_][a-z0-9_]{2,30}$
174 # Naming hint for method names
175 method-name-hint=[a-z_][a-z0-9_]{2,30}$
177 # Regular expression which should only match function or class names that do
178 # not require a docstring.
181 # Minimum line length for functions/classes that require docstrings, shorter
183 docstring-min-length=-1
188 # Maximum number of nested blocks for function / method body
194 # Maximum number of characters on a single line.
197 # Regexp for a line that is allowed to be longer than the limit.
198 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
200 # Allow the body of an if to be on the same line as the test if there is no
202 single-line-if-stmt=no
204 # List of optional constructs for which whitespace checking is disabled. `dict-
205 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
206 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
207 # `empty-line` allows space-only lines.
208 no-space-check=trailing-comma,dict-separator
210 # Maximum number of lines in a module
211 max-module-lines=1000
213 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
217 # Number of spaces of indent required inside a hanging or continued line.
220 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
221 expected-line-ending-format=
226 # Minimum lines number of a similarity.
227 min-similarity-lines=4
229 # Ignore comments when computing similarities.
232 # Ignore docstrings when computing similarities.
233 ignore-docstrings=yes
235 # Ignore imports when computing similarities.
241 # Tells whether we should check for unused import in __init__ files.
244 # A regular expression matching the name of dummy variables (i.e. expectedly
246 dummy-variables-rgx=_$|dummy
248 # List of additional names supposed to be defined in builtins. Remember that
249 # you should avoid to define new builtins when possible.
252 # List of strings which can identify a callback function by name. A callback
253 # name must start or end with one of those strings.
259 # Spelling dictionary name. Available dictionaries: none. To make it working
260 # install python-enchant package.
263 # List of comma separated words that should not be checked.
264 spelling-ignore-words=
266 # A path to a file that contains private dictionary; one word per line.
267 spelling-private-dict-file=
269 # Tells whether to store unknown words to indicated private dictionary in
270 # --spelling-private-dict-file option instead of raising a message.
271 spelling-store-unknown-words=no
276 # List of note tags to take in consideration, separated by a comma.
282 # Tells whether missing members accessed in mixin class should be ignored. A
283 # mixin class is detected if its name ends with "mixin" (case insensitive).
284 ignore-mixin-members=yes
286 # List of module names for which member attributes should not be checked
287 # (useful for modules/projects where namespaces are manipulated during runtime
288 # and thus existing member attributes cannot be deduced by static analysis. It
289 # supports qualified module names, as well as Unix pattern matching.
292 # List of classes names for which member attributes should not be checked
293 # (useful for classes with attributes dynamically set). This supports can work
294 # with qualified names.
297 # List of members which are set dynamically and missed by pylint inference
298 # system, and so shouldn't trigger E1101 when accessed. Python regular
299 # expressions are accepted.
305 # Deprecated modules which should not be used, separated by a comma
306 deprecated-modules=regsub,TERMIOS,Bastion,rexec
308 # Create a graph of every (i.e. internal and external) dependencies in the
309 # given file (report RP0402 must not be disabled)
312 # Create a graph of external dependencies in the given file (report RP0402 must
316 # Create a graph of internal dependencies in the given file (report RP0402 must
323 # List of method names used to declare (i.e. assign) instance attributes.
324 defining-attr-methods=__init__,__new__,setUp
326 # List of valid names for the first argument in a class method.
327 valid-classmethod-first-arg=cls
329 # List of valid names for the first argument in a metaclass class method.
330 valid-metaclass-classmethod-first-arg=mcs
332 # List of member names, which should be excluded from the protected access
334 exclude-protected=_asdict,_fields,_replace,_source,_make
339 # Maximum number of arguments for function / method
342 # Argument names that match this expression will be ignored. Default to name
343 # with leading underscore
344 ignored-argument-names=_.*
346 # Maximum number of locals for function / method body
349 # Maximum number of return / yield for function / method body
352 # Maximum number of branch for function / method body
355 # Maximum number of statements in function / method body
358 # Maximum number of parents for a class (see R0901).
361 # Maximum number of attributes for a class (see R0902).
364 # Minimum number of public methods for a class (see R0903).
367 # Maximum number of public methods for a class (see R0904).
368 max-public-methods=20
370 # Maximum number of boolean expressions in a if statement
376 # Exceptions that will emit a warning when being caught. Defaults to
378 overgeneral-exceptions=Exception