3 # Specify a configuration file.
6 # Python code to execute, usually for sys.path manipulation such as
13 # Add files or directories to the blacklist. They should be base names, not
17 # Pickle collected data for later comparisons.
20 # List of plugins (as comma separated values of python modules names) to load,
21 # usually to register additional checkers.
24 # Use multiple processes to speed up Pylint.
27 # Allow loading of arbitrary C extensions. Extensions are imported into the
28 # active Python interpreter and may run arbitrary code.
29 unsafe-load-any-extension=no
31 # A comma-separated list of package or module names from where C extensions may
32 # be loaded. Extensions are loading into the active Python interpreter and may
34 extension-pkg-whitelist=
36 # Allow optimization of some AST trees. This will activate a peephole AST
37 # optimizer, which will apply various small optimizations. For instance, it can
38 # be used to obtain the result of joining multiple strings with the addition
39 # operator. Joining a lot of strings can lead to a maximum recursion error in
40 # Pylint and this flag can prevent that. It has one side effect, the resulting
41 # AST will be different than the one from reality.
47 # Only show warnings with the listed confidence levels. Leave empty to show
48 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
51 # Enable the message, report, category or checker with the given id(s). You can
52 # either give multiple identifier separated by comma (,) or put this option
53 # multiple time. See also the "--disable" option for examples.
56 # Disable the message, report, category or checker with the given id(s). You
57 # can either give multiple identifiers separated by comma (,) or put this
58 # option multiple times (only on the command line, not in the configuration
59 # file where it should appear only once).You can also use "--disable=all" to
60 # disable everything first and then reenable specific checks. For example, if
61 # you want to run only the similarities checker, you can use "--disable=all
62 # --enable=similarities". If you want to run only the classes checker, but have
63 # no Warning level messages displayed, use"--disable=all --enable=classes
65 disable=E1602,E1603,E1601,E1606,E1607,E1604,E1605,E1608,W0401,W1604,W1605,W1606,W1607,W1601,W1602,W1603,W1622,W1623,W1620,W1621,W1608,W1609,W1624,W1625,W1618,W1626,W1627,I0021,I0020,W0704,R0903,W1613,W1638,W1611,W1610,W1617,W1616,W1615,W1614,W1630,W1619,W1632,W1635,W1634,W1637,W1636,W1639,W1612,W1628,W1633,W1629,I0011,W1640
70 # Set the output format. Available formats are text, parseable, colorized, msvs
71 # (visual studio) and html. You can also give a reporter class, eg
72 # mypackage.mymodule.MyReporterClass.
75 # Put messages in a separate file for each module / package specified on the
76 # command line instead of printing them on stdout. Reports (if any) will be
77 # written in a file name "pylint_global.[txt|html]".
80 # Tells whether to display a full report or only the messages
83 # Python expression which should return a note less than 10 (10 is the highest
84 # note). You have access to the variables errors warning, statement which
85 # respectively contain the number of errors / warnings messages and the total
86 # number of statements analyzed. This is used by the global evaluation report
88 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
90 # Add a comment according to your evaluation note. This is used by the global
91 # evaluation report (RP0004).
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 # Required attributes for module, separated by a comma
104 # List of builtins function names that should not be used, separated by a comma
105 bad-functions=filter,apply,file
107 # Good variable names which should always be accepted, separated by a comma
108 good-names=i,j,k,ex,Run,_
110 # Bad variable names which should always be refused, separated by a comma
111 bad-names=foo,bar,baz,toto,tutu,tata
113 # Colon-delimited sets of names that determine each other's naming style when
114 # the name regexes allow several styles.
117 # Include a hint for the correct naming format with invalid-name
118 include-naming-hint=yes
120 # Regular expression matching correct inline iteration names
121 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
123 # Naming hint for inline iteration names
124 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
126 # Regular expression matching correct class attribute names
127 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{1,30}|(__.*__))$
129 # Naming hint for class attribute names
130 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{1,30}|(__.*__))$
132 # Regular expression matching correct argument names
133 argument-rgx=[a-z_][a-z0-9_]{2,30}$
135 # Naming hint for argument names
136 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
138 # Regular expression matching correct variable names
139 variable-rgx=[a-z_][a-z0-9_]{2,30}$
141 # Naming hint for variable names
142 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
144 # Regular expression matching correct module names
145 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
147 # Naming hint for module names
148 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
150 # Regular expression matching correct class names
151 class-rgx=[A-Z_][a-zA-Z0-9]+$
153 # Naming hint for class names
154 class-name-hint=[A-Z_][a-zA-Z0-9]+$
156 # Regular expression matching correct function names
157 function-rgx=[a-z_][a-z0-9_]{2,30}$
159 # Naming hint for function names
160 function-name-hint=[a-z_][a-z0-9_]{2,30}$
162 # Regular expression matching correct method names
163 method-rgx=[a-z_][a-z0-9_]{2,30}$
165 # Naming hint for method names
166 method-name-hint=[a-z_][a-z0-9_]{2,30}$
168 # Regular expression matching correct attribute names
169 attr-rgx=[a-z_][a-z0-9_]{2,30}$
171 # Naming hint for attribute names
172 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
174 # Regular expression matching correct constant names
175 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
177 # Naming hint for constant names
178 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
180 # Regular expression which should only match function or class names that do
181 # not require a docstring.
182 no-docstring-rgx=__.*__
184 # Minimum line length for functions/classes that require docstrings, shorter
186 docstring-min-length=-1
191 # Maximum number of characters on a single line.
194 # Regexp for a line that is allowed to be longer than the limit.
195 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
197 # Allow the body of an if to be on the same line as the test if there is no
199 single-line-if-stmt=no
201 # List of optional constructs for which whitespace checking is disabled
202 no-space-check=trailing-comma,dict-separator
204 # Maximum number of lines in a module
205 max-module-lines=1000
207 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
211 # Number of spaces of indent required inside a hanging or continued line.
214 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
215 expected-line-ending-format=
220 # Logging modules to check that the string format arguments are in logging
221 # function parameter format
222 logging-modules=logging
227 # List of note tags to take in consideration, separated by a comma.
233 # Minimum lines number of a similarity.
234 min-similarity-lines=4
236 # Ignore comments when computing similarities.
239 # Ignore docstrings when computing similarities.
240 ignore-docstrings=yes
242 # Ignore imports when computing similarities.
248 # Spelling dictionary name. Available dictionaries: none. To make it working
249 # install python-enchant package.
252 # List of comma separated words that should not be checked.
253 spelling-ignore-words=
255 # A path to a file that contains private dictionary; one word per line.
256 spelling-private-dict-file=
258 # Tells whether to store unknown words to indicated private dictionary in
259 # --spelling-private-dict-file option instead of raising a message.
260 spelling-store-unknown-words=no
265 # Tells whether missing members accessed in mixin class should be ignored. A
266 # mixin class is detected if its name ends with "mixin" (case insensitive).
267 ignore-mixin-members=yes
269 # List of module names for which member attributes should not be checked
270 # (useful for modules/projects where namespaces are manipulated during runtime
271 # and thus existing member attributes cannot be deduced by static analysis
274 # List of classes names for which member attributes should not be checked
275 # (useful for classes with attributes dynamically set).
276 ignored-classes=SQLObject
278 # When zope mode is activated, add a predefined set of Zope acquired attributes
279 # to generated-members.
282 # List of members which are set dynamically and missed by pylint inference
283 # system, and so shouldn't trigger E0201 when accessed. Python regular
284 # expressions are accepted.
285 generated-members=REQUEST,acl_users,aq_parent
290 # Tells whether we should check for unused import in __init__ files.
293 # A regular expression matching the name of dummy variables (i.e. expectedly
295 dummy-variables-rgx=_$|dummy
297 # List of additional names supposed to be defined in builtins. Remember that
298 # you should avoid to define new builtins when possible.
301 # List of strings which can identify a callback function by name. A callback
302 # name must start or end with one of those strings.
308 # List of interface methods to ignore, separated by a comma. This is used for
309 # instance to not check methods defines in Zope's Interface base class.
310 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
312 # List of method names used to declare (i.e. assign) instance attributes.
313 defining-attr-methods=__init__,__new__,setUp
315 # List of valid names for the first argument in a class method.
316 valid-classmethod-first-arg=cls
318 # List of valid names for the first argument in a metaclass class method.
319 valid-metaclass-classmethod-first-arg=mcs
321 # List of member names, which should be excluded from the protected access
323 exclude-protected=_asdict,_fields,_replace,_source,_make
328 # Maximum number of arguments for function / method
331 # Argument names that match this expression will be ignored. Default to name
332 # with leading underscore
333 ignored-argument-names=_.*
335 # Maximum number of locals for function / method body
338 # Maximum number of return / yield for function / method body
341 # Maximum number of branch for function / method body
344 # Maximum number of statements in function / method body
347 # Maximum number of parents for a class (see R0901).
350 # Maximum number of attributes for a class (see R0902).
353 # Minimum number of public methods for a class (see R0903).
356 # Maximum number of public methods for a class (see R0904).
357 max-public-methods=20
362 # Deprecated modules which should not be used, separated by a comma
363 deprecated-modules=regsub,TERMIOS,Bastion,rexec
365 # Create a graph of every (i.e. internal and external) dependencies in the
366 # given file (report RP0402 must not be disabled)
369 # Create a graph of external dependencies in the given file (report RP0402 must
373 # Create a graph of internal dependencies in the given file (report RP0402 must
380 # Exceptions that will emit a warning when being caught. Defaults to
382 overgeneral-exceptions=Exception