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.
27 # Enable the message, report, category or checker with the given id(s). You can
28 # either give multiple identifier separated by comma (,) or put this option
29 # multiple time. See also the "--disable" option for examples.
32 # Disable the message, report, category or checker with the given id(s). You
33 # can either give multiple identifiers separated by comma (,) or put this
34 # option multiple times (only on the command line, not in the configuration
35 # file where it should appear only once).You can also use "--disable=all" to
36 # disable everything first and then reenable specific checks. For example, if
37 # you want to run only the similarities checker, you can use "--disable=all
38 # --enable=similarities". If you want to run only the classes checker, but have
39 # no Warning level messages displayed, use"--disable=all --enable=classes
46 # Set the output format. Available formats are text, parseable, colorized, msvs
47 # (visual studio) and html. You can also give a reporter class, eg
48 # mypackage.mymodule.MyReporterClass.
51 # Put messages in a separate file for each module / package specified on the
52 # command line instead of printing them on stdout. Reports (if any) will be
53 # written in a file name "pylint_global.[txt|html]".
56 # Tells whether to display a full report or only the messages
59 # Python expression which should return a note less than 10 (10 is the highest
60 # note). You have access to the variables errors warning, statement which
61 # respectively contain the number of errors / warnings messages and the total
62 # number of statements analyzed. This is used by the global evaluation report
64 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
66 # Add a comment according to your evaluation note. This is used by the global
67 # evaluation report (RP0004).
70 # Template used to display messages. This is a python new-style format string
71 # used to format the message information. See doc for all details
77 # Maximum number of characters on a single line.
80 # Regexp for a line that is allowed to be longer than the limit.
81 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
83 # Allow the body of an if to be on the same line as the test if there is no
85 single-line-if-stmt=no
87 # List of optional constructs for which whitespace checking is disabled
88 no-space-check=trailing-comma,dict-separator
90 # Maximum number of lines in a module
93 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
100 # List of note tags to take in consideration, separated by a comma.
106 # Tells whether missing members accessed in mixin class should be ignored. A
107 # mixin class is detected if its name ends with "mixin" (case insensitive).
108 ignore-mixin-members=yes
110 # List of classes names for which member attributes should not be checked
111 # (useful for classes with attributes dynamically set).
112 ignored-classes=SQLObject
114 # When zope mode is activated, add a predefined set of Zope acquired attributes
115 # to generated-members.
118 # List of members which are set dynamically and missed by pylint inference
119 # system, and so shouldn't trigger E0201 when accessed. Python regular
120 # expressions are accepted.
121 generated-members=REQUEST,acl_users,aq_parent
126 # Minimum lines number of a similarity.
127 min-similarity-lines=4
129 # Ignore comments when computing similarities.
132 # Ignore docstrings when computing similarities.
133 ignore-docstrings=yes
135 # Ignore imports when computing similarities.
141 # Required attributes for module, separated by a comma
144 # List of builtins function names that should not be used, separated by a comma
145 bad-functions=map,filter,apply,input
147 # Regular expression which should only match correct module names
148 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
150 # Regular expression which should only match correct module level names
151 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
153 # Regular expression which should only match correct class names
154 class-rgx=[A-Z_][a-zA-Z0-9]+$
156 # Regular expression which should only match correct function names
157 function-rgx=[a-z_][a-z0-9_]{2,30}$
159 # Regular expression which should only match correct method names
160 method-rgx=[a-z_][a-z0-9_]{2,30}$
162 # Regular expression which should only match correct instance attribute names
163 attr-rgx=[a-z_][a-z0-9_]{2,30}$
165 # Regular expression which should only match correct argument names
166 argument-rgx=[a-z_][a-z0-9_]{2,30}$
168 # Regular expression which should only match correct variable names
169 variable-rgx=[a-z_][a-z0-9_]{2,30}$
171 # Regular expression which should only match correct attribute names in class
173 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
175 # Regular expression which should only match correct list comprehension /
176 # generator expression variable names
177 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
179 # Good variable names which should always be accepted, separated by a comma
180 good-names=i,j,k,ex,Run,_
182 # Bad variable names which should always be refused, separated by a comma
183 bad-names=foo,bar,baz,toto,tutu,tata
185 # Regular expression which should only match function or class names that do
186 # not require a docstring.
187 no-docstring-rgx=__.*__
189 # Minimum line length for functions/classes that require docstrings, shorter
191 docstring-min-length=-1
196 # Tells whether we should check for unused import in __init__ files.
199 # A regular expression matching the beginning of the name of dummy variables
201 dummy-variables-rgx=_$|dummy
203 # List of additional names supposed to be defined in builtins. Remember that
204 # you should avoid to define new builtins when possible.
210 # Maximum number of arguments for function / method
213 # Argument names that match this expression will be ignored. Default to name
214 # with leading underscore
215 ignored-argument-names=_.*
217 # Maximum number of locals for function / method body
220 # Maximum number of return / yield for function / method body
223 # Maximum number of branch for function / method body
226 # Maximum number of statements in function / method body
229 # Maximum number of parents for a class (see R0901).
232 # Maximum number of attributes for a class (see R0902).
235 # Minimum number of public methods for a class (see R0903).
238 # Maximum number of public methods for a class (see R0904).
239 max-public-methods=20
244 # List of interface methods to ignore, separated by a comma. This is used for
245 # instance to not check methods defines in Zope's Interface base class.
246 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
248 # List of method names used to declare (i.e. assign) instance attributes.
249 defining-attr-methods=__init__,__new__,setUp
251 # List of valid names for the first argument in a class method.
252 valid-classmethod-first-arg=cls
254 # List of valid names for the first argument in a metaclass class method.
255 valid-metaclass-classmethod-first-arg=mcs
260 # Deprecated modules which should not be used, separated by a comma
261 deprecated-modules=regsub,TERMIOS,Bastion,rexec
263 # Create a graph of every (i.e. internal and external) dependencies in the
264 # given file (report RP0402 must not be disabled)
267 # Create a graph of external dependencies in the given file (report RP0402 must
271 # Create a graph of internal dependencies in the given file (report RP0402 must
278 # Exceptions that will emit a warning when being caught. Defaults to
280 overgeneral-exceptions=Exception