The list of contributors in committers.py should be a separate JSON
[WebKit-https.git] / Tools / Scripts / webkitpy / pylintrc
1 # Copyright (c) 2012 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 [MASTER]
30
31 # Specify a configuration file.
32 #rcfile=
33
34 # Python code to execute, usually for sys.path manipulation such as
35 # pygtk.require().
36 #init-hook=
37
38 # Profiled execution.
39 profile=no
40
41 # Add files or directories to the blacklist. They should be base names, not
42 # paths.
43 ignore=CVS
44
45 # Pickle collected data for later comparisons.
46 persistent=yes
47
48 # List of plugins (as comma separated values of python modules names) to load,
49 # usually to register additional checkers.
50 load-plugins=
51
52
53 [MESSAGES CONTROL]
54
55 # Enable the message, report, category or checker with the given id(s). You can
56 # either give multiple identifier separated by comma (,) or put this option
57 # multiple time.
58 #enable=
59
60 # Disable the message, report, category or checker with the given id(s). You
61 # can either give multiple identifier separated by comma (,) or put this option
62 # multiple time (only on the command line, not in the configuration file where
63 # it should appear only once).
64 # CHANGED:
65 # C0103: Invalid name ""
66 # C0111: Missing docstring
67 # C0301: Line too long
68 # C0302: Too many lines in module (N)
69 # I0010: Unable to consider inline option ''
70 # I0011: Locally disabling WNNNN
71 #
72 # R0201: Method could be a function
73 # R0801: Similar lines in N files
74 # R0901: Too many ancestors (8/7)
75 # R0902: Too many instance attributes (N/7)
76 # R0903: Too few public methods (N/2)
77 # R0904: Too many public methods (N/20)
78 # R0911: Too many return statements (N/6)
79 # R0912: Too many branches (N/12)
80 # R0913: Too many arguments (N/5)
81 # R0914: Too many local variables (N/15)
82 # R0915: Too many statements (N/50)
83 # R0921: Abstract class not referenced
84 # R0922: Abstract class is only referenced 1 times
85 # W0122: Use of the exec statement
86 # W0141: Used builtin function ''
87 # W0212: Access to a protected member X of a client class
88 # W0142: Used * or ** magic
89 # W0401: Wildcard import X
90 # W0402: Uses of a deprecated module 'string'
91 # W0404: 41: Reimport 'XX' (imported line NN)
92 # W0511: TODO
93 # W0603: Using the global statement
94 # W0614: Unused import X from wildcard import
95 # W0703: Catch "Exception"
96 # W1201: Specify string format arguments as logging function parameters
97 disable=C0103,C0111,C0301,C0302,I0010,I0011,R0201,R0801,R0901,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,R0921,R0922,W0122,W0141,W0142,W0212,W0401,W0402,W0404,W0511,W0603,W0614,W0703,W1201
98
99
100 [REPORTS]
101
102 # Set the output format. Available formats are text, parseable, colorized, msvs
103 # (visual studio) and html
104 output-format=text
105
106 # Include message's id in output
107 include-ids=yes
108
109 # Put messages in a separate file for each module / package specified on the
110 # command line instead of printing them on stdout. Reports (if any) will be
111 # written in a file name "pylint_global.[txt|html]".
112 files-output=no
113
114 # Tells whether to display a full report or only the messages
115 # CHANGED:
116 reports=no
117
118 # Python expression which should return a note less than 10 (10 is the highest
119 # note). You have access to the variables errors warning, statement which
120 # respectively contain the number of errors / warnings messages and the total
121 # number of statements analyzed. This is used by the global evaluation report
122 # (RP0004).
123 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
124
125 # Add a comment according to your evaluation note. This is used by the global
126 # evaluation report (RP0004).
127 comment=no
128
129
130 [VARIABLES]
131
132 # Tells whether we should check for unused import in __init__ files.
133 init-import=no
134
135 # A regular expression matching the beginning of the name of dummy variables
136 # (i.e. not used).
137 dummy-variables-rgx=_|dummy
138
139 # List of additional names supposed to be defined in builtins. Remember that
140 # you should avoid to define new builtins when possible.
141 additional-builtins=
142
143
144 [TYPECHECK]
145
146 # Tells whether missing members accessed in mixin class should be ignored. A
147 # mixin class is detected if its name ends with "mixin" (case insensitive).
148 ignore-mixin-members=yes
149
150 # List of classes names for which member attributes should not be checked
151 # (useful for classes with attributes dynamically set).
152 ignored-classes=SQLObject,twisted.internet.reactor,hashlib,google.appengine.api.memcache
153
154 # When zope mode is activated, add a predefined set of Zope acquired attributes
155 # to generated-members.
156 zope=no
157
158 # List of members which are set dynamically and missed by pylint inference
159 # system, and so shouldn't trigger E0201 when accessed. Python regular
160 # expressions are accepted.
161 generated-members=REQUEST,acl_users,aq_parent
162
163
164 [MISCELLANEOUS]
165
166 # List of note tags to take in consideration, separated by a comma.
167 notes=FIXME,XXX,TODO
168
169
170 [SIMILARITIES]
171
172 # Minimum lines number of a similarity.
173 min-similarity-lines=4
174
175 # Ignore comments when computing similarities.
176 ignore-comments=yes
177
178 # Ignore docstrings when computing similarities.
179 ignore-docstrings=yes
180
181
182 [FORMAT]
183
184 # Maximum number of characters on a single line.
185 max-line-length=200
186
187 # Maximum number of lines in a module
188 max-module-lines=1000
189
190 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
191 # tab).
192 # CHANGED:
193 indent-string='    '
194
195
196 [BASIC]
197
198 # Required attributes for module, separated by a comma
199 required-attributes=
200
201 # List of builtins function names that should not be used, separated by a comma
202 bad-functions=map,filter,apply,input
203
204 # Regular expression which should only match correct module names
205 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
206
207 # Regular expression which should only match correct module level names
208 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
209
210 # Regular expression which should only match correct class names
211 class-rgx=[A-Z_][a-zA-Z0-9]+$
212
213 # Regular expression which should only match correct function names
214 function-rgx=[a-z_][a-z0-9_]{2,30}$
215
216 # Regular expression which should only match correct method names
217 method-rgx=[a-z_][a-z0-9_]{2,30}$
218
219 # Regular expression which should only match correct instance attribute names
220 attr-rgx=[a-z_][a-z0-9_]{2,30}$
221
222 # Regular expression which should only match correct argument names
223 argument-rgx=[a-z_][a-z0-9_]{2,30}$
224
225 # Regular expression which should only match correct variable names
226 variable-rgx=[a-z_][a-z0-9_]{2,30}$
227
228 # Regular expression which should only match correct list comprehension /
229 # generator expression variable names
230 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
231
232 # Good variable names which should always be accepted, separated by a comma
233 good-names=i,j,k,ex,Run,_
234
235 # Bad variable names which should always be refused, separated by a comma
236 bad-names=foo,bar,baz,toto,tutu,tata
237
238 # Regular expression which should only match functions or classes name which do
239 # not require a docstring
240 no-docstring-rgx=__.*__
241
242
243 [DESIGN]
244
245 # Maximum number of arguments for function / method
246 max-args=5
247
248 # Argument names that match this expression will be ignored. Default to name
249 # with leading underscore
250 ignored-argument-names=_.*
251
252 # Maximum number of locals for function / method body
253 max-locals=15
254
255 # Maximum number of return / yield for function / method body
256 max-returns=6
257
258 # Maximum number of branch for function / method body
259 max-branchs=12
260
261 # Maximum number of statements in function / method body
262 max-statements=50
263
264 # Maximum number of parents for a class (see R0901).
265 max-parents=7
266
267 # Maximum number of attributes for a class (see R0902).
268 max-attributes=7
269
270 # Minimum number of public methods for a class (see R0903).
271 min-public-methods=2
272
273 # Maximum number of public methods for a class (see R0904).
274 max-public-methods=20
275
276
277 [CLASSES]
278
279 # List of interface methods to ignore, separated by a comma. This is used for
280 # instance to not check methods defines in Zope's Interface base class.
281 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
282
283 # List of method names used to declare (i.e. assign) instance attributes.
284 defining-attr-methods=__init__,__new__,setUp
285
286 # List of valid names for the first argument in a class method.
287 valid-classmethod-first-arg=cls
288
289
290 [IMPORTS]
291
292 # Deprecated modules which should not be used, separated by a comma
293 deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
294
295 # Create a graph of every (i.e. internal and external) dependencies in the
296 # given file (report RP0402 must not be disabled)
297 import-graph=
298
299 # Create a graph of external dependencies in the given file (report RP0402 must
300 # not be disabled)
301 ext-import-graph=
302
303 # Create a graph of internal dependencies in the given file (report RP0402 must
304 # not be disabled)
305 int-import-graph=
306
307
308 [EXCEPTIONS]
309
310 # Exceptions that will emit a warning when being caught. Defaults to
311 # "Exception"
312 overgeneral-exceptions=Exception