.pylintrc 14.3 KB
Newer Older
1
[MASTER]
Daniele Venzano's avatar
Daniele Venzano committed
2 3 4 5 6

# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code
extension-pkg-whitelist=
7 8 9 10 11

# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS

Daniele Venzano's avatar
Daniele Venzano committed
12 13 14 15 16 17 18 19 20 21
# Add files or directories matching the regex patterns to the blacklist. The
# regex matches against base names, not paths.
ignore-patterns=

# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=

# Use multiple processes to speed up Pylint.
jobs=4
22 23 24 25 26

# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
load-plugins=

Daniele Venzano's avatar
Daniele Venzano committed
27 28
# Pickle collected data for later comparisons.
persistent=yes
29

Daniele Venzano's avatar
Daniele Venzano committed
30 31 32 33 34 35
# Specify a configuration file.
#rcfile=

# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52


[MESSAGES CONTROL]

# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
confidence=

# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once).You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
53
disable=line-too-long,invalid-sequence-index,parameter-unpacking,unpacking-in-except,backtick,long-suffix,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,deprecated-pragma,no-self-use,too-many-instance-attributes,too-few-public-methods,too-many-public-methods,too-many-branches,too-many-statements,fixme,global-statement,logging-format-interpolation,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,len-as-condition,no-else-return,arguments-differ
Daniele Venzano's avatar
Daniele Venzano committed
54 55 56 57 58 59

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once). See also the "--disable" option for examples.
enable=
60 61 62 63


[REPORTS]

Daniele Venzano's avatar
Daniele Venzano committed
64 65 66 67 68 69 70 71 72 73 74 75 76
# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)

# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details
#msg-template=

# Set the output format. Available formats are text, parseable, colorized, json
# and msvs (visual studio).You can also give a reporter class, eg
77 78 79 80 81 82
# mypackage.mymodule.MyReporterClass.
output-format=text

# Tells whether to display a full report or only the messages
reports=no

Daniele Venzano's avatar
Daniele Venzano committed
83 84 85 86 87 88 89 90 91
# Activate the evaluation score.
score=yes


[REFACTORING]

# Maximum number of nested blocks for function / method body
max-nested-blocks=5

92 93 94

[VARIABLES]

Daniele Venzano's avatar
Daniele Venzano committed
95 96 97
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=
98

Daniele Venzano's avatar
Daniele Venzano committed
99 100
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes
101 102 103 104 105

# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=_cb

Daniele Venzano's avatar
Daniele Venzano committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
# A regular expression matching the name of dummy variables (i.e. expectedly
# not used).
dummy-variables-rgx=.*_$|dummy

# Argument names that match this expression will be ignored. Default to name
# with leading underscore
ignored-argument-names=.*_$

# Tells whether we should check for unused import in __init__ files.
init-import=no

# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,future.builtins


[SPELLING]

# Spelling dictionary name. Available dictionaries: none. To make it working
# install python-enchant package.
spelling-dict=

# List of comma separated words that should not be checked.
spelling-ignore-words=

# A path to a file that contains private dictionary; one word per line.
spelling-private-dict-file=

# Tells whether to store unknown words to indicated private dictionary in
# --spelling-private-dict-file option instead of raising a message.
spelling-store-unknown-words=no

138 139 140

[FORMAT]

Daniele Venzano's avatar
Daniele Venzano committed
141 142
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=LF
143 144 145 146

# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$

Daniele Venzano's avatar
Daniele Venzano committed
147 148 149 150 151 152 153 154 155 156 157 158
# Number of spaces of indent required inside a hanging  or continued line.
indent-after-paren=4

# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
# tab).
indent-string='    '

# Maximum number of characters on a single line.
max-line-length=100

# Maximum number of lines in a module
max-module-lines=1000
159 160 161 162 163 164 165

# List of optional constructs for which whitespace checking is disabled. `dict-
# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
# `empty-line` allows space-only lines.
no-space-check=trailing-comma,dict-separator

Daniele Venzano's avatar
Daniele Venzano committed
166 167 168
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
169

Daniele Venzano's avatar
Daniele Venzano committed
170 171 172
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
173 174


Daniele Venzano's avatar
Daniele Venzano committed
175
[TYPECHECK]
176

Daniele Venzano's avatar
Daniele Venzano committed
177 178 179 180
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
181

Daniele Venzano's avatar
Daniele Venzano committed
182 183 184 185
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
186 187 188 189 190

# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes

Daniele Venzano's avatar
Daniele Venzano committed
191 192 193 194 195 196 197 198 199 200 201 202 203
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference
# can return multiple potential results while evaluating a Python object, but
# some branches might not be evaluated, which results in partial inference. In
# that case, it might be useful to still emit no-member and other checks for
# the rest of the inferred objects.
ignore-on-opaque-inference=yes

# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes=

204 205 206 207
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis. It
# supports qualified module names, as well as Unix pattern matching.
208
ignored-modules=zmq,ldap
209

Daniele Venzano's avatar
Daniele Venzano committed
210 211 212
# Show a hint with possible names when a member name was not found. The aspect
# of finding the hint is based on edit distance.
missing-member-hint=yes
213

Daniele Venzano's avatar
Daniele Venzano committed
214 215 216 217 218 219 220
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance=1

# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices=1
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240


[LOGGING]

# Logging modules to check that the string format arguments are in logging
# function parameter format
logging-modules=logging


[SIMILARITIES]

# Ignore comments when computing similarities.
ignore-comments=yes

# Ignore docstrings when computing similarities.
ignore-docstrings=yes

# Ignore imports when computing similarities.
ignore-imports=no

Daniele Venzano's avatar
Daniele Venzano committed
241 242 243
# Minimum lines number of a similarity.
min-similarity-lines=4

244 245 246

[BASIC]

Daniele Venzano's avatar
Daniele Venzano committed
247 248
# Naming hint for argument names
argument-name-hint=[a-z_][a-z0-9_]{2,30}$
249

Daniele Venzano's avatar
Daniele Venzano committed
250 251
# Regular expression matching correct argument names
argument-rgx=[a-z_][a-z0-9_]{2,30}$
252

Daniele Venzano's avatar
Daniele Venzano committed
253 254
# Naming hint for attribute names
attr-name-hint=([a-z_][a-z0-9_]{2,30}|id)$
255

Daniele Venzano's avatar
Daniele Venzano committed
256 257
# Regular expression matching correct attribute names
attr-rgx=([a-z_][a-z0-9_]{2,30}|id)$
258

Daniele Venzano's avatar
Daniele Venzano committed
259 260
# Bad variable names which should always be refused, separated by a comma
bad-names=foo,bar,baz,toto,tutu,tata
261

Daniele Venzano's avatar
Daniele Venzano committed
262 263
# Naming hint for class attribute names
class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
264

Daniele Venzano's avatar
Daniele Venzano committed
265 266
# Regular expression matching correct class attribute names
class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
267

Daniele Venzano's avatar
Daniele Venzano committed
268 269
# Naming hint for class names
class-name-hint=[A-Z_][a-zA-Z0-9]+$
270

Daniele Venzano's avatar
Daniele Venzano committed
271 272
# Regular expression matching correct class names
class-rgx=[A-Z_][a-zA-Z0-9]+$
273

Daniele Venzano's avatar
Daniele Venzano committed
274 275
# Naming hint for constant names
const-name-hint=(([A-Z_][A-Za-z0-9_]*)|(__.*__)|log|([A-Z][A-Za-z]*Type))$
276

Daniele Venzano's avatar
Daniele Venzano committed
277 278
# Regular expression matching correct constant names
const-rgx=(([A-Z_][A-Za-z0-9_]*)|(__.*__)|log|([A-Z][A-Za-z]*Type))$
279

Daniele Venzano's avatar
Daniele Venzano committed
280 281 282
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
283

Daniele Venzano's avatar
Daniele Venzano committed
284 285
# Naming hint for function names
function-name-hint=[a-z_][a-z0-9_]{2,30}$
286

Daniele Venzano's avatar
Daniele Venzano committed
287 288
# Regular expression matching correct function names
function-rgx=[a-z_][a-z0-9_]{2,30}$
289

Daniele Venzano's avatar
Daniele Venzano committed
290 291
# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,e,ex,th,q,ip
292

Daniele Venzano's avatar
Daniele Venzano committed
293 294
# Include a hint for the correct naming format with invalid-name
include-naming-hint=no
295 296 297 298

# Naming hint for inline iteration names
inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$

Daniele Venzano's avatar
Daniele Venzano committed
299 300
# Regular expression matching correct inline iteration names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
301

Daniele Venzano's avatar
Daniele Venzano committed
302 303
# Naming hint for method names
method-name-hint=[a-z_][a-z0-9_]{2,30}$
304

Daniele Venzano's avatar
Daniele Venzano committed
305 306
# Regular expression matching correct method names
method-rgx=[a-z_][a-z0-9_]{2,30}$
307

Daniele Venzano's avatar
Daniele Venzano committed
308 309
# Naming hint for module names
module-name-hint=(([a-z_][a-z0-9_\-]*)|([A-Z][a-zA-Z0-9_\-]+))$
310

Daniele Venzano's avatar
Daniele Venzano committed
311 312
# Regular expression matching correct module names
module-rgx=(([a-z_][a-z0-9_\-]*)|([A-Z][a-zA-Z0-9_\-]+))$
313

Daniele Venzano's avatar
Daniele Venzano committed
314 315 316
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
317 318 319 320 321

# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_

Daniele Venzano's avatar
Daniele Venzano committed
322 323 324
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
property-classes=abc.abstractproperty
325

Daniele Venzano's avatar
Daniele Venzano committed
326 327
# Naming hint for variable names
variable-name-hint=[a-z_][a-z0-9_]{2,30}$
328

Daniele Venzano's avatar
Daniele Venzano committed
329 330
# Regular expression matching correct variable names
variable-rgx=[a-z_][a-z0-9_]{2,30}$
331 332 333 334 335 336 337 338 339 340 341


[MISCELLANEOUS]

# List of note tags to take in consideration, separated by a comma.
notes=FIXME,TODO


[DESIGN]

# Maximum number of arguments for function / method
342
max-args=7
343

Daniele Venzano's avatar
Daniele Venzano committed
344 345
# Maximum number of attributes for a class (see R0902).
max-attributes=7
346

Daniele Venzano's avatar
Daniele Venzano committed
347 348
# Maximum number of boolean expressions in a if statement
max-bool-expr=5
349 350 351 352

# Maximum number of branch for function / method body
max-branches=12

Daniele Venzano's avatar
Daniele Venzano committed
353 354
# Maximum number of locals for function / method body
max-locals=15
355 356 357 358

# Maximum number of parents for a class (see R0901).
max-parents=7

Daniele Venzano's avatar
Daniele Venzano committed
359 360 361 362 363 364 365 366
# Maximum number of public methods for a class (see R0904).
max-public-methods=20

# Maximum number of return / yield for function / method body
max-returns=6

# Maximum number of statements in function / method body
max-statements=50
367 368 369 370 371

# Minimum number of public methods for a class (see R0903).
min-public-methods=2


Daniele Venzano's avatar
Daniele Venzano committed
372
[IMPORTS]
373

Daniele Venzano's avatar
Daniele Venzano committed
374 375
# Allow wildcard imports from modules that define __all__.
allow-wildcard-with-all=no
376

Daniele Venzano's avatar
Daniele Venzano committed
377 378 379 380
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
381 382 383 384 385 386 387 388

# Deprecated modules which should not be used, separated by a comma
deprecated-modules=optparse

# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled)
ext-import-graph=

Daniele Venzano's avatar
Daniele Venzano committed
389 390 391 392
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled)
import-graph=

393 394 395 396
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled)
int-import-graph=

Daniele Venzano's avatar
Daniele Venzano committed
397 398 399 400 401 402 403
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=

# Force import order to recognize a module as part of a third party library.
known-third-party=enchant

404 405 406 407

[CLASSES]

# List of method names used to declare (i.e. assign) instance attributes.
408
defining-attr-methods=__init__,initialize
409

Daniele Venzano's avatar
Daniele Venzano committed
410 411 412 413
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=

414 415 416 417 418 419 420 421 422 423 424 425
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls

# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=mcs


[EXCEPTIONS]

# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=BaseException