Merge "testpmd_pvp: Adds pkt_fwd to allow pvp topology testing"
[vswitchperf.git] / pylintrc
1 # Copyright 2015 Intel Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #   http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 [MASTER]
16
17 # Specify a configuration file.
18 #rcfile=
19
20 # Python code to execute, usually for sys.path manipulation such as
21 # pygtk.require().
22 #init-hook=
23
24 # Profiled execution.
25 profile=no
26
27 # Add files or directories to the blacklist. They should be base names, not
28 # paths.
29 ignore=CVS,docs,conf
30
31 # Pickle collected data for later comparisons.
32 persistent=yes
33
34 # List of plugins (as comma separated values of python modules names) to load,
35 # usually to register additional checkers.
36 load-plugins=
37
38 # Use multiple processes to speed up Pylint.
39 jobs=1
40
41 # Allow loading of arbitrary C extensions. Extensions are imported into the
42 # active Python interpreter and may run arbitrary code.
43 unsafe-load-any-extension=no
44
45 # A comma-separated list of package or module names from where C extensions may
46 # be loaded. Extensions are loading into the active Python interpreter and may
47 # run arbitrary code
48 extension-pkg-whitelist=
49
50 # Allow optimization of some AST trees. This will activate a peephole AST
51 # optimizer, which will apply various small optimizations. For instance, it can
52 # be used to obtain the result of joining multiple strings with the addition
53 # operator. Joining a lot of strings can lead to a maximum recursion error in
54 # Pylint and this flag can prevent that. It has one side effect, the resulting
55 # AST will be different than the one from reality.
56 optimize-ast=no
57
58
59 [MESSAGES CONTROL]
60
61 # Only show warnings with the listed confidence levels. Leave empty to show
62 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
63 confidence=
64
65 # Enable the message, report, category or checker with the given id(s). You can
66 # either give multiple identifier separated by comma (,) or put this option
67 # multiple time. See also the "--disable" option for examples.
68 #enable=
69
70 # Disable the message, report, category or checker with the given id(s). You
71 # can either give multiple identifiers separated by comma (,) or put this
72 # option multiple times (only on the command line, not in the configuration
73 # file where it should appear only once).You can also use "--disable=all" to
74 # disable everything first and then reenable specific checks. For example, if
75 # you want to run only the similarities checker, you can use "--disable=all
76 # --enable=similarities". If you want to run only the classes checker, but have
77 # no Warning level messages displayed, use"--disable=all --enable=classes
78 # --disable=W"
79 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
80
81
82 [REPORTS]
83
84 # Set the output format. Available formats are text, parseable, colorized, msvs
85 # (visual studio) and html. You can also give a reporter class, eg
86 # mypackage.mymodule.MyReporterClass.
87 output-format=text
88
89 # Put messages in a separate file for each module / package specified on the
90 # command line instead of printing them on stdout. Reports (if any) will be
91 # written in a file name "pylint_global.[txt|html]".
92 files-output=no
93
94 # Tells whether to display a full report or only the messages
95 reports=yes
96
97 # Python expression which should return a note less than 10 (10 is the highest
98 # note). You have access to the variables errors warning, statement which
99 # respectively contain the number of errors / warnings messages and the total
100 # number of statements analyzed. This is used by the global evaluation report
101 # (RP0004).
102 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
103
104 # Add a comment according to your evaluation note. This is used by the global
105 # evaluation report (RP0004).
106 comment=no
107
108 # Template used to display messages. This is a python new-style format string
109 # used to format the message information. See doc for all details
110 #msg-template=
111
112
113 [BASIC]
114
115 # Required attributes for module, separated by a comma
116 required-attributes=
117
118 # List of builtins function names that should not be used, separated by a comma
119 bad-functions=filter,apply,file
120
121 # Good variable names which should always be accepted, separated by a comma
122 good-names=i,j,k,ex,Run,_
123
124 # Bad variable names which should always be refused, separated by a comma
125 bad-names=foo,bar,baz,toto,tutu,tata
126
127 # Colon-delimited sets of names that determine each other's naming style when
128 # the name regexes allow several styles.
129 name-group=
130
131 # Include a hint for the correct naming format with invalid-name
132 include-naming-hint=yes
133
134 # Regular expression matching correct inline iteration names
135 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
136
137 # Naming hint for inline iteration names
138 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
139
140 # Regular expression matching correct class attribute names
141 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{1,30}|(__.*__))$
142
143 # Naming hint for class attribute names
144 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{1,30}|(__.*__))$
145
146 # Regular expression matching correct argument names
147 argument-rgx=[a-z_][a-z0-9_]{2,30}$
148
149 # Naming hint for argument names
150 argument-name-hint=[a-z_][a-z0-9_]{2,30}$
151
152 # Regular expression matching correct variable names
153 variable-rgx=[a-z_][a-z0-9_]{2,30}$
154
155 # Naming hint for variable names
156 variable-name-hint=[a-z_][a-z0-9_]{2,30}$
157
158 # Regular expression matching correct module names
159 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
160
161 # Naming hint for module names
162 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
163
164 # Regular expression matching correct class names
165 class-rgx=[A-Z_][a-zA-Z0-9]+$
166
167 # Naming hint for class names
168 class-name-hint=[A-Z_][a-zA-Z0-9]+$
169
170 # Regular expression matching correct function names
171 function-rgx=[a-z_][a-z0-9_]{2,30}$
172
173 # Naming hint for function names
174 function-name-hint=[a-z_][a-z0-9_]{2,30}$
175
176 # Regular expression matching correct method names
177 method-rgx=[a-z_][a-z0-9_]{2,30}$
178
179 # Naming hint for method names
180 method-name-hint=[a-z_][a-z0-9_]{2,30}$
181
182 # Regular expression matching correct attribute names
183 attr-rgx=[a-z_][a-z0-9_]{2,30}$
184
185 # Naming hint for attribute names
186 attr-name-hint=[a-z_][a-z0-9_]{2,30}$
187
188 # Regular expression matching correct constant names
189 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
190
191 # Naming hint for constant names
192 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
193
194 # Regular expression which should only match function or class names that do
195 # not require a docstring.
196 no-docstring-rgx=__.*__
197
198 # Minimum line length for functions/classes that require docstrings, shorter
199 # ones are exempt.
200 docstring-min-length=-1
201
202
203 [FORMAT]
204
205 # Maximum number of characters on a single line.
206 max-line-length=120
207
208 # Regexp for a line that is allowed to be longer than the limit.
209 ignore-long-lines=^\s*(# )?<?https?://\S+>?$
210
211 # Allow the body of an if to be on the same line as the test if there is no
212 # else.
213 single-line-if-stmt=no
214
215 # List of optional constructs for which whitespace checking is disabled
216 no-space-check=trailing-comma,dict-separator
217
218 # Maximum number of lines in a module
219 max-module-lines=1000
220
221 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
222 # tab).
223 indent-string='    '
224
225 # Number of spaces of indent required inside a hanging or continued line.
226 indent-after-paren=4
227
228 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
229 expected-line-ending-format=
230
231
232 [LOGGING]
233
234 # Logging modules to check that the string format arguments are in logging
235 # function parameter format
236 logging-modules=logging
237
238
239 [MISCELLANEOUS]
240
241 # List of note tags to take in consideration, separated by a comma.
242 notes=FIXME,XXX,TODO
243
244
245 [SIMILARITIES]
246
247 # Minimum lines number of a similarity.
248 min-similarity-lines=4
249
250 # Ignore comments when computing similarities.
251 ignore-comments=yes
252
253 # Ignore docstrings when computing similarities.
254 ignore-docstrings=yes
255
256 # Ignore imports when computing similarities.
257 ignore-imports=no
258
259
260 [SPELLING]
261
262 # Spelling dictionary name. Available dictionaries: none. To make it working
263 # install python-enchant package.
264 spelling-dict=
265
266 # List of comma separated words that should not be checked.
267 spelling-ignore-words=
268
269 # A path to a file that contains private dictionary; one word per line.
270 spelling-private-dict-file=
271
272 # Tells whether to store unknown words to indicated private dictionary in
273 # --spelling-private-dict-file option instead of raising a message.
274 spelling-store-unknown-words=no
275
276
277 [TYPECHECK]
278
279 # Tells whether missing members accessed in mixin class should be ignored. A
280 # mixin class is detected if its name ends with "mixin" (case insensitive).
281 ignore-mixin-members=yes
282
283 # List of module names for which member attributes should not be checked
284 # (useful for modules/projects where namespaces are manipulated during runtime
285 # and thus existing member attributes cannot be deduced by static analysis
286 ignored-modules=
287
288 # List of classes names for which member attributes should not be checked
289 # (useful for classes with attributes dynamically set).
290 ignored-classes=SQLObject
291
292 # When zope mode is activated, add a predefined set of Zope acquired attributes
293 # to generated-members.
294 zope=no
295
296 # List of members which are set dynamically and missed by pylint inference
297 # system, and so shouldn't trigger E0201 when accessed. Python regular
298 # expressions are accepted.
299 generated-members=REQUEST,acl_users,aq_parent
300
301
302 [VARIABLES]
303
304 # Tells whether we should check for unused import in __init__ files.
305 init-import=no
306
307 # A regular expression matching the name of dummy variables (i.e. expectedly
308 # not used).
309 dummy-variables-rgx=_$|dummy
310
311 # List of additional names supposed to be defined in builtins. Remember that
312 # you should avoid to define new builtins when possible.
313 additional-builtins=
314
315 # List of strings which can identify a callback function by name. A callback
316 # name must start or end with one of those strings.
317 callbacks=cb_,_cb
318
319
320 [CLASSES]
321
322 # List of interface methods to ignore, separated by a comma. This is used for
323 # instance to not check methods defines in Zope's Interface base class.
324 ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
325
326 # List of method names used to declare (i.e. assign) instance attributes.
327 defining-attr-methods=__init__,__new__,setUp
328
329 # List of valid names for the first argument in a class method.
330 valid-classmethod-first-arg=cls
331
332 # List of valid names for the first argument in a metaclass class method.
333 valid-metaclass-classmethod-first-arg=mcs
334
335 # List of member names, which should be excluded from the protected access
336 # warning.
337 exclude-protected=_asdict,_fields,_replace,_source,_make
338
339
340 [DESIGN]
341
342 # Maximum number of arguments for function / method
343 max-args=6
344
345 # Argument names that match this expression will be ignored. Default to name
346 # with leading underscore
347 ignored-argument-names=_.*
348
349 # Maximum number of locals for function / method body
350 max-locals=20
351
352 # Maximum number of return / yield for function / method body
353 max-returns=6
354
355 # Maximum number of branch for function / method body
356 max-branches=15
357
358 # Maximum number of statements in function / method body
359 max-statements=70
360
361 # Maximum number of parents for a class (see R0901).
362 max-parents=7
363
364 # Maximum number of attributes for a class (see R0902).
365 max-attributes=15
366
367 # Minimum number of public methods for a class (see R0903).
368 min-public-methods=2
369
370 # Maximum number of public methods for a class (see R0904).
371 max-public-methods=20
372
373
374 [IMPORTS]
375
376 # Deprecated modules which should not be used, separated by a comma
377 deprecated-modules=regsub,TERMIOS,Bastion,rexec
378
379 # Create a graph of every (i.e. internal and external) dependencies in the
380 # given file (report RP0402 must not be disabled)
381 import-graph=
382
383 # Create a graph of external dependencies in the given file (report RP0402 must
384 # not be disabled)
385 ext-import-graph=
386
387 # Create a graph of internal dependencies in the given file (report RP0402 must
388 # not be disabled)
389 int-import-graph=
390
391
392 [EXCEPTIONS]
393
394 # Exceptions that will emit a warning when being caught. Defaults to
395 # "Exception"
396 overgeneral-exceptions=Exception