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 # 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=
36 # Enable the message, report, category or checker with the given id(s). You can
37 # either give multiple identifier separated by comma (,) or put this option
38 # multiple time. See also the "--disable" option for examples.
41 # Disable the message, report, category or checker with the given id(s). You
42 # can either give multiple identifiers separated by comma (,) or put this
43 # option multiple times (only on the command line, not in the configuration
44 # file where it should appear only once).You can also use "--disable=all" to
45 # disable everything first and then reenable specific checks. For example, if
46 # you want to run only the similarities checker, you can use "--disable=all
47 # --enable=similarities". If you want to run only the classes checker, but have
48 # no Warning level messages displayed, use"--disable=all --enable=classes
50 disable=bad-continuation, missing-docstring, invalid-name, locally-disabled,
51 too-few-public-methods, too-many-arguments, fixme, duplicate-code
56 # Set the output format. Available formats are text, parseable, colorized, msvs
57 # (visual studio) and html. You can also give a reporter class, eg
58 # mypackage.mymodule.MyReporterClass.
61 # Put messages in a separate file for each module / package specified on the
62 # command line instead of printing them on stdout. Reports (if any) will be
63 # written in a file name "pylint_global.[txt|html]".
66 # Tells whether to display a full report or only the messages
69 # Python expression which should return a note less than 10 (10 is the highest
70 # note). You have access to the variables errors warning, statement which
71 # respectively contain the number of errors / warnings messages and the total
72 # number of statements analyzed. This is used by the global evaluation report
74 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
76 # Add a comment according to your evaluation note. This is used by the global
77 # evaluation report (RP0004).
80 # Template used to display messages. This is a python new-style format string
81 # used to format the message information. See doc for all details
87 # List of note tags to take in consideration, separated by a comma.
93 # Minimum lines number of a similarity.
94 min-similarity-lines=4
96 # Ignore comments when computing similarities.
99 # Ignore docstrings when computing similarities.
100 ignore-docstrings=yes
102 # Ignore imports when computing similarities.
108 # Tells whether we should check for unused import in __init__ files.
111 # A regular expression matching the name of dummy variables (i.e. expectedly
113 dummy-variables-rgx=_$|dummy
115 # List of additional names supposed to be defined in builtins. Remember that
116 # you should avoid to define new builtins when possible.
122 # Tells whether missing members accessed in mixin class should be ignored. A
123 # mixin class is detected if its name ends with "mixin" (case insensitive).
124 ignore-mixin-members=yes
126 # List of module names for which member attributes should not be checked
127 # (useful for modules/projects where namespaces are manipulated during runtime
128 # and thus existing member attributes cannot be deduced by static analysis
131 # List of classes names for which member attributes should not be checked
132 # (useful for classes with attributes dynamically set).
133 ignored-classes=SQLObject
135 # When zope mode is activated, add a predefined set of Zope acquired attributes
136 # to generated-members.
139 # List of members which are set dynamically and missed by pylint inference
140 # system, and so shouldn't trigger E0201 when accessed. Python regular
141 # expressions are accepted.
142 generated-members=REQUEST,acl_users,aq_parent
147 # Maximum number of characters on a single line.
150 # Regexp for a line that is allowed to be longer than the limit.
151 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
153 # Allow the body of an if to be on the same line as the test if there is no
155 single-line-if-stmt=no
157 # List of optional constructs for which whitespace checking is disabled
158 no-space-check=trailing-comma,dict-separator
160 # Maximum number of lines in a module
161 max-module-lines=1000
163 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
167 # Number of spaces of indent required inside a hanging or continued line.
173 # Logging modules to check that the string format arguments are in logging
174 # function parameter format
175 logging-modules=logging
180 # Required attributes for module, separated by a comma
181 #required-attributes=
183 # List of builtins function names that should not be used, separated by a comma
184 bad-functions=map,filter,apply,input,file
186 # Good variable names which should always be accepted, separated by a comma
187 good-names=i,j,k,ex,Run,_
189 # Bad variable names which should always be refused, separated by a comma
190 bad-names=foo,bar,baz,toto,tutu,tata
192 # Colon-delimited sets of names that determine each other's naming style when
193 # the name regexes allow several styles.
196 # Include a hint for the correct naming format with invalid-name
197 include-naming-hint=no
199 # Regular expression matching correct function names
200 function-rgx=[a-z_][a-z0-9_]{2,30}$
202 # Naming hint for function names
203 function-name-hint=[a-z_][a-z0-9_]{2,30}$
205 # Regular expression matching correct variable names
206 variable-rgx=[a-z_][a-z0-9_]{2,30}$
208 # Naming hint for variable names
209 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
211 # Regular expression matching correct constant names
212 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
214 # Naming hint for constant names
215 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
217 # Regular expression matching correct attribute names
218 attr-rgx=[a-z_][a-z0-9_]{2,30}$
220 # Naming hint for attribute names
221 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
223 # Regular expression matching correct argument names
224 argument-rgx=[a-z_][a-z0-9_]{2,30}$
226 # Naming hint for argument names
227 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
229 # Regular expression matching correct class attribute names
230 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
232 # Naming hint for class attribute names
233 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
235 # Regular expression matching correct inline iteration names
236 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
238 # Naming hint for inline iteration names
239 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
241 # Regular expression matching correct class names
242 class-rgx=[A-Z_][a-zA-Z0-9]+$
244 # Naming hint for class names
245 class-name-hint=[A-Z_][a-zA-Z0-9]+$
247 # Regular expression matching correct module names
248 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
250 # Naming hint for module names
251 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
253 # Regular expression matching correct method names
254 method-rgx=[a-z_][a-z0-9_]{2,30}$
256 # Naming hint for method names
257 method-name-hint=[a-z_][a-z0-9_]{2,30}$
259 # Regular expression which should only match function or class names that do
260 # not require a docstring.
261 no-docstring-rgx=__.*__
263 # Minimum line length for functions/classes that require docstrings, shorter
265 docstring-min-length=-1
270 # Deprecated modules which should not be used, separated by a comma
271 deprecated-modules=regsub,TERMIOS,Bastion,rexec
273 # Create a graph of every (i.e. internal and external) dependencies in the
274 # given file (report RP0402 must not be disabled)
277 # Create a graph of external dependencies in the given file (report RP0402 must
281 # Create a graph of internal dependencies in the given file (report RP0402 must
288 # List of interface methods to ignore, separated by a comma. This is used for
289 # instance to not check methods defines in Zope's Interface base class.
290 #ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
292 # List of method names used to declare (i.e. assign) instance attributes.
293 defining-attr-methods=__init__,__new__,setUp
295 # List of valid names for the first argument in a class method.
296 valid-classmethod-first-arg=cls
298 # List of valid names for the first argument in a metaclass class method.
299 valid-metaclass-classmethod-first-arg=mcs
304 # Maximum number of arguments for function / method
307 # Argument names that match this expression will be ignored. Default to name
308 # with leading underscore
309 ignored-argument-names=_.*
311 # Maximum number of locals for function / method body
314 # Maximum number of return / yield for function / method body
317 # Maximum number of branch for function / method body
320 # Maximum number of statements in function / method body
323 # Maximum number of parents for a class (see R0901).
326 # Maximum number of attributes for a class (see R0902).
329 # Minimum number of public methods for a class (see R0903).
332 # Maximum number of public methods for a class (see R0904).
333 max-public-methods=20
338 # Exceptions that will emit a warning when being caught. Defaults to
340 overgeneral-exceptions=Exception