/ .pylintrc
.pylintrc
1 [MASTER] 2 3 # A comma-separated list of package or module names from where C extensions may 4 # be loaded. Extensions are loading into the active Python interpreter and may 5 # run arbitrary code 6 extension-pkg-whitelist= 7 8 # Add files or directories to the blacklist. They should be base names, not 9 # paths. 10 ignore=CVS 11 12 # Add files or directories matching the regex patterns to the blacklist. The 13 # regex matches against base names, not paths. 14 ignore-patterns= 15 16 # Python code to execute, usually for sys.path manipulation such as 17 # pygtk.require(). 18 #init-hook= 19 20 # Use multiple processes to speed up Pylint. 21 # jobs=1 22 jobs=2 23 24 # List of plugins (as comma separated values of python modules names) to load, 25 # usually to register additional checkers. 26 load-plugins= 27 28 # Pickle collected data for later comparisons. 29 persistent=yes 30 31 # Specify a configuration file. 32 #rcfile= 33 34 # Allow loading of arbitrary C extensions. Extensions are imported into the 35 # active Python interpreter and may run arbitrary code. 36 unsafe-load-any-extension=no 37 38 39 [MESSAGES CONTROL] 40 41 # Only show warnings with the listed confidence levels. Leave empty to show 42 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED 43 confidence= 44 45 # Disable the message, report, category or checker with the given id(s). You 46 # can either give multiple identifiers separated by comma (,) or put this 47 # option multiple times (only on the command line, not in the configuration 48 # file where it should appear only once).You can also use "--disable=all" to 49 # disable everything first and then reenable specific checks. For example, if 50 # you want to run only the similarities checker, you can use "--disable=all 51 # --enable=similarities". If you want to run only the classes checker, but have 52 # no Warning level messages displayed, use"--disable=all --enable=classes 53 # --disable=W" 54 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,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,raising-string,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,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call 55 disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,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,raising-string,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,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error 56 57 # Enable the message, report, category or checker with the given id(s). You can 58 # either give multiple identifier separated by comma (,) or put this option 59 # multiple time (only on the command line, not in the configuration file where 60 # it should appear only once). See also the "--disable" option for examples. 61 enable= 62 63 64 [REPORTS] 65 66 # Python expression which should return a note less than 10 (10 is the highest 67 # note). You have access to the variables errors warning, statement which 68 # respectively contain the number of errors / warnings messages and the total 69 # number of statements analyzed. This is used by the global evaluation report 70 # (RP0004). 71 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) 72 73 # Template used to display messages. This is a python new-style format string 74 # used to format the message information. See doc for all details 75 #msg-template= 76 77 # Set the output format. Available formats are text, parseable, colorized, json 78 # and msvs (visual studio).You can also give a reporter class, eg 79 # mypackage.mymodule.MyReporterClass. 80 output-format=text 81 82 # Tells whether to display a full report or only the messages 83 reports=no 84 85 # Activate the evaluation score. 86 score=yes 87 88 89 [REFACTORING] 90 91 # Maximum number of nested blocks for function / method body 92 max-nested-blocks=5 93 94 95 [LOGGING] 96 97 # Logging modules to check that the string format arguments are in logging 98 # function parameter format 99 logging-modules=logging 100 101 102 [SPELLING] 103 104 # Spelling dictionary name. Available dictionaries: none. To make it working 105 # install python-enchant package. 106 spelling-dict= 107 108 # List of comma separated words that should not be checked. 109 spelling-ignore-words= 110 111 # A path to a file that contains private dictionary; one word per line. 112 spelling-private-dict-file= 113 114 # Tells whether to store unknown words to indicated private dictionary in 115 # --spelling-private-dict-file option instead of raising a message. 116 spelling-store-unknown-words=no 117 118 119 [MISCELLANEOUS] 120 121 # List of note tags to take in consideration, separated by a comma. 122 notes=FIXME,XXX,TODO 123 124 125 [TYPECHECK] 126 127 # List of decorators that produce context managers, such as 128 # contextlib.contextmanager. Add to this list to register other decorators that 129 # produce valid context managers. 130 contextmanager-decorators=contextlib.contextmanager 131 132 # List of members which are set dynamically and missed by pylint inference 133 # system, and so shouldn't trigger E1101 when accessed. Python regular 134 # expressions are accepted. 135 generated-members= 136 137 # Tells whether missing members accessed in mixin class should be ignored. A 138 # mixin class is detected if its name ends with "mixin" (case insensitive). 139 ignore-mixin-members=yes 140 141 # This flag controls whether pylint should warn about no-member and similar 142 # checks whenever an opaque object is returned when inferring. The inference 143 # can return multiple potential results while evaluating a Python object, but 144 # some branches might not be evaluated, which results in partial inference. In 145 # that case, it might be useful to still emit no-member and other checks for 146 # the rest of the inferred objects. 147 ignore-on-opaque-inference=yes 148 149 # List of class names for which member attributes should not be checked (useful 150 # for classes with dynamically set attributes). This supports the use of 151 # qualified names. 152 ignored-classes=optparse.Values,thread._local,_thread._local 153 154 # List of module names for which member attributes should not be checked 155 # (useful for modules/projects where namespaces are manipulated during runtime 156 # and thus existing member attributes cannot be deduced by static analysis. It 157 # supports qualified module names, as well as Unix pattern matching. 158 ignored-modules=board 159 160 # Show a hint with possible names when a member name was not found. The aspect 161 # of finding the hint is based on edit distance. 162 missing-member-hint=yes 163 164 # The minimum edit distance a name should have in order to be considered a 165 # similar match for a missing member name. 166 missing-member-hint-distance=1 167 168 # The total number of similar names that should be taken in consideration when 169 # showing a hint for a missing member. 170 missing-member-max-choices=1 171 172 173 [VARIABLES] 174 175 # List of additional names supposed to be defined in builtins. Remember that 176 # you should avoid to define new builtins when possible. 177 additional-builtins= 178 179 # Tells whether unused global variables should be treated as a violation. 180 allow-global-unused-variables=yes 181 182 # List of strings which can identify a callback function by name. A callback 183 # name must start or end with one of those strings. 184 callbacks=cb_,_cb 185 186 # A regular expression matching the name of dummy variables (i.e. expectedly 187 # not used). 188 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 189 190 # Argument names that match this expression will be ignored. Default to name 191 # with leading underscore 192 ignored-argument-names=_.*|^ignored_|^unused_ 193 194 # Tells whether we should check for unused import in __init__ files. 195 init-import=no 196 197 # List of qualified module names which can have objects that can redefine 198 # builtins. 199 redefining-builtins-modules=six.moves,future.builtins 200 201 202 [FORMAT] 203 204 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 205 # expected-line-ending-format= 206 expected-line-ending-format=LF 207 208 # Regexp for a line that is allowed to be longer than the limit. 209 ignore-long-lines=^\s*(# )?<?https?://\S+>?$ 210 211 # Number of spaces of indent required inside a hanging or continued line. 212 indent-after-paren=4 213 214 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 215 # tab). 216 indent-string=' ' 217 218 # Maximum number of characters on a single line. 219 max-line-length=100 220 221 # Maximum number of lines in a module 222 max-module-lines=1000 223 224 # List of optional constructs for which whitespace checking is disabled. `dict- 225 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. 226 # `trailing-comma` allows a space between comma and closing bracket: (a, ). 227 # `empty-line` allows space-only lines. 228 no-space-check=trailing-comma,dict-separator 229 230 # Allow the body of a class to be on the same line as the declaration if body 231 # contains single statement. 232 single-line-class-stmt=no 233 234 # Allow the body of an if to be on the same line as the test if there is no 235 # else. 236 single-line-if-stmt=no 237 238 239 [SIMILARITIES] 240 241 # Ignore comments when computing similarities. 242 ignore-comments=yes 243 244 # Ignore docstrings when computing similarities. 245 ignore-docstrings=yes 246 247 # Ignore imports when computing similarities. 248 ignore-imports=no 249 250 # Minimum lines number of a similarity. 251 min-similarity-lines=4 252 253 254 [BASIC] 255 256 # Naming hint for argument names 257 argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 258 259 # Regular expression matching correct argument names 260 argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 261 262 # Naming hint for attribute names 263 attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 264 265 # Regular expression matching correct attribute names 266 attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 267 268 # Bad variable names which should always be refused, separated by a comma 269 bad-names=foo,bar,baz,toto,tutu,tata 270 271 # Naming hint for class attribute names 272 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 273 274 # Regular expression matching correct class attribute names 275 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 276 277 # Naming hint for class names 278 # class-name-hint=[A-Z_][a-zA-Z0-9]+$ 279 class-name-hint=[A-Z_][a-zA-Z0-9_]+$ 280 281 # Regular expression matching correct class names 282 # class-rgx=[A-Z_][a-zA-Z0-9]+$ 283 class-rgx=[A-Z_][a-zA-Z0-9_]+$ 284 285 # Naming hint for constant names 286 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 287 288 # Regular expression matching correct constant names 289 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 290 291 # Minimum line length for functions/classes that require docstrings, shorter 292 # ones are exempt. 293 docstring-min-length=-1 294 295 # Naming hint for function names 296 function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 297 298 # Regular expression matching correct function names 299 function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 300 301 # Good variable names which should always be accepted, separated by a comma 302 # good-names=i,j,k,ex,Run,_ 303 good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ 304 305 # Include a hint for the correct naming format with invalid-name 306 include-naming-hint=no 307 308 # Naming hint for inline iteration names 309 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ 310 311 # Regular expression matching correct inline iteration names 312 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ 313 314 # Naming hint for method names 315 method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 316 317 # Regular expression matching correct method names 318 method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 319 320 # Naming hint for module names 321 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 322 323 # Regular expression matching correct module names 324 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 325 326 # Colon-delimited sets of names that determine each other's naming style when 327 # the name regexes allow several styles. 328 name-group= 329 330 # Regular expression which should only match function or class names that do 331 # not require a docstring. 332 no-docstring-rgx=^_ 333 334 # List of decorators that produce properties, such as abc.abstractproperty. Add 335 # to this list to register other decorators that produce valid properties. 336 property-classes=abc.abstractproperty 337 338 # Naming hint for variable names 339 variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 340 341 # Regular expression matching correct variable names 342 variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 343 344 345 [IMPORTS] 346 347 # Allow wildcard imports from modules that define __all__. 348 allow-wildcard-with-all=no 349 350 # Analyse import fallback blocks. This can be used to support both Python 2 and 351 # 3 compatible code, which means that the block might have code that exists 352 # only in one or another interpreter, leading to false positives when analysed. 353 analyse-fallback-blocks=no 354 355 # Deprecated modules which should not be used, separated by a comma 356 deprecated-modules=optparse,tkinter.tix 357 358 # Create a graph of external dependencies in the given file (report RP0402 must 359 # not be disabled) 360 ext-import-graph= 361 362 # Create a graph of every (i.e. internal and external) dependencies in the 363 # given file (report RP0402 must not be disabled) 364 import-graph= 365 366 # Create a graph of internal dependencies in the given file (report RP0402 must 367 # not be disabled) 368 int-import-graph= 369 370 # Force import order to recognize a module as part of the standard 371 # compatibility libraries. 372 known-standard-library= 373 374 # Force import order to recognize a module as part of a third party library. 375 known-third-party=enchant 376 377 378 [CLASSES] 379 380 # List of method names used to declare (i.e. assign) instance attributes. 381 defining-attr-methods=__init__,__new__,setUp 382 383 # List of member names, which should be excluded from the protected access 384 # warning. 385 exclude-protected=_asdict,_fields,_replace,_source,_make 386 387 # List of valid names for the first argument in a class method. 388 valid-classmethod-first-arg=cls 389 390 # List of valid names for the first argument in a metaclass class method. 391 valid-metaclass-classmethod-first-arg=mcs 392 393 394 [DESIGN] 395 396 # Maximum number of arguments for function / method 397 max-args=5 398 399 # Maximum number of attributes for a class (see R0902). 400 # max-attributes=7 401 max-attributes=11 402 403 # Maximum number of boolean expressions in a if statement 404 max-bool-expr=5 405 406 # Maximum number of branch for function / method body 407 max-branches=12 408 409 # Maximum number of locals for function / method body 410 max-locals=15 411 412 # Maximum number of parents for a class (see R0901). 413 max-parents=7 414 415 # Maximum number of public methods for a class (see R0904). 416 max-public-methods=20 417 418 # Maximum number of return / yield for function / method body 419 max-returns=6 420 421 # Maximum number of statements in function / method body 422 max-statements=50 423 424 # Minimum number of public methods for a class (see R0903). 425 min-public-methods=1 426 427 428 [EXCEPTIONS] 429 430 # Exceptions that will emit a warning when being caught. Defaults to 431 # "Exception" 432 overgeneral-exceptions=Exception