/ .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,bad-continuation 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 notes=FIXME,XXX 124 125 126 [TYPECHECK] 127 128 # List of decorators that produce context managers, such as 129 # contextlib.contextmanager. Add to this list to register other decorators that 130 # produce valid context managers. 131 contextmanager-decorators=contextlib.contextmanager 132 133 # List of members which are set dynamically and missed by pylint inference 134 # system, and so shouldn't trigger E1101 when accessed. Python regular 135 # expressions are accepted. 136 generated-members= 137 138 # Tells whether missing members accessed in mixin class should be ignored. A 139 # mixin class is detected if its name ends with "mixin" (case insensitive). 140 ignore-mixin-members=yes 141 142 # This flag controls whether pylint should warn about no-member and similar 143 # checks whenever an opaque object is returned when inferring. The inference 144 # can return multiple potential results while evaluating a Python object, but 145 # some branches might not be evaluated, which results in partial inference. In 146 # that case, it might be useful to still emit no-member and other checks for 147 # the rest of the inferred objects. 148 ignore-on-opaque-inference=yes 149 150 # List of class names for which member attributes should not be checked (useful 151 # for classes with dynamically set attributes). This supports the use of 152 # qualified names. 153 ignored-classes=optparse.Values,thread._local,_thread._local 154 155 # List of module names for which member attributes should not be checked 156 # (useful for modules/projects where namespaces are manipulated during runtime 157 # and thus existing member attributes cannot be deduced by static analysis. It 158 # supports qualified module names, as well as Unix pattern matching. 159 ignored-modules=board,RPi.GPIO 160 161 # Show a hint with possible names when a member name was not found. The aspect 162 # of finding the hint is based on edit distance. 163 missing-member-hint=yes 164 165 # The minimum edit distance a name should have in order to be considered a 166 # similar match for a missing member name. 167 missing-member-hint-distance=1 168 169 # The total number of similar names that should be taken in consideration when 170 # showing a hint for a missing member. 171 missing-member-max-choices=1 172 173 174 [VARIABLES] 175 176 # List of additional names supposed to be defined in builtins. Remember that 177 # you should avoid to define new builtins when possible. 178 additional-builtins= 179 180 # Tells whether unused global variables should be treated as a violation. 181 allow-global-unused-variables=yes 182 183 # List of strings which can identify a callback function by name. A callback 184 # name must start or end with one of those strings. 185 callbacks=cb_,_cb 186 187 # A regular expression matching the name of dummy variables (i.e. expectedly 188 # not used). 189 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 190 191 # Argument names that match this expression will be ignored. Default to name 192 # with leading underscore 193 ignored-argument-names=_.*|^ignored_|^unused_ 194 195 # Tells whether we should check for unused import in __init__ files. 196 init-import=no 197 198 # List of qualified module names which can have objects that can redefine 199 # builtins. 200 redefining-builtins-modules=six.moves,future.builtins 201 202 203 [FORMAT] 204 205 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 206 # expected-line-ending-format= 207 expected-line-ending-format=LF 208 209 # Regexp for a line that is allowed to be longer than the limit. 210 ignore-long-lines=^\s*(# )?<?https?://\S+>?$ 211 212 # Number of spaces of indent required inside a hanging or continued line. 213 indent-after-paren=4 214 215 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 216 # tab). 217 indent-string=' ' 218 219 # Maximum number of characters on a single line. 220 max-line-length=100 221 222 # Maximum number of lines in a module 223 max-module-lines=1000 224 225 # List of optional constructs for which whitespace checking is disabled. `dict- 226 # separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. 227 # `trailing-comma` allows a space between comma and closing bracket: (a, ). 228 # `empty-line` allows space-only lines. 229 no-space-check=trailing-comma,dict-separator 230 231 # Allow the body of a class to be on the same line as the declaration if body 232 # contains single statement. 233 single-line-class-stmt=no 234 235 # Allow the body of an if to be on the same line as the test if there is no 236 # else. 237 single-line-if-stmt=no 238 239 240 [SIMILARITIES] 241 242 # Ignore comments when computing similarities. 243 ignore-comments=yes 244 245 # Ignore docstrings when computing similarities. 246 ignore-docstrings=yes 247 248 # Ignore imports when computing similarities. 249 ignore-imports=no 250 251 # Minimum lines number of a similarity. 252 min-similarity-lines=4 253 254 255 [BASIC] 256 257 # Naming hint for argument names 258 argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 259 260 # Regular expression matching correct argument names 261 argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 262 263 # Naming hint for attribute names 264 attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 265 266 # Regular expression matching correct attribute names 267 attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 268 269 # Bad variable names which should always be refused, separated by a comma 270 bad-names=foo,bar,baz,toto,tutu,tata 271 272 # Naming hint for class attribute names 273 class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 274 275 # Regular expression matching correct class attribute names 276 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 277 278 # Naming hint for class names 279 # class-name-hint=[A-Z_][a-zA-Z0-9]+$ 280 class-name-hint=[A-Z_][a-zA-Z0-9_]+$ 281 282 # Regular expression matching correct class names 283 # class-rgx=[A-Z_][a-zA-Z0-9]+$ 284 class-rgx=[A-Z_][a-zA-Z0-9_]+$ 285 286 # Naming hint for constant names 287 const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 288 289 # Regular expression matching correct constant names 290 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 291 292 # Minimum line length for functions/classes that require docstrings, shorter 293 # ones are exempt. 294 docstring-min-length=-1 295 296 # Naming hint for function names 297 function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 298 299 # Regular expression matching correct function names 300 function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 301 302 # Good variable names which should always be accepted, separated by a comma 303 # good-names=i,j,k,ex,Run,_ 304 good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ 305 306 # Include a hint for the correct naming format with invalid-name 307 include-naming-hint=no 308 309 # Naming hint for inline iteration names 310 inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ 311 312 # Regular expression matching correct inline iteration names 313 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ 314 315 # Naming hint for method names 316 method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 317 318 # Regular expression matching correct method names 319 method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 320 321 # Naming hint for module names 322 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 323 324 # Regular expression matching correct module names 325 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 326 327 # Colon-delimited sets of names that determine each other's naming style when 328 # the name regexes allow several styles. 329 name-group= 330 331 # Regular expression which should only match function or class names that do 332 # not require a docstring. 333 no-docstring-rgx=^_ 334 335 # List of decorators that produce properties, such as abc.abstractproperty. Add 336 # to this list to register other decorators that produce valid properties. 337 property-classes=abc.abstractproperty 338 339 # Naming hint for variable names 340 variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 341 342 # Regular expression matching correct variable names 343 variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ 344 345 346 [IMPORTS] 347 348 # Allow wildcard imports from modules that define __all__. 349 allow-wildcard-with-all=no 350 351 # Analyse import fallback blocks. This can be used to support both Python 2 and 352 # 3 compatible code, which means that the block might have code that exists 353 # only in one or another interpreter, leading to false positives when analysed. 354 analyse-fallback-blocks=no 355 356 # Deprecated modules which should not be used, separated by a comma 357 deprecated-modules=optparse,tkinter.tix 358 359 # Create a graph of external dependencies in the given file (report RP0402 must 360 # not be disabled) 361 ext-import-graph= 362 363 # Create a graph of every (i.e. internal and external) dependencies in the 364 # given file (report RP0402 must not be disabled) 365 import-graph= 366 367 # Create a graph of internal dependencies in the given file (report RP0402 must 368 # not be disabled) 369 int-import-graph= 370 371 # Force import order to recognize a module as part of the standard 372 # compatibility libraries. 373 known-standard-library= 374 375 # Force import order to recognize a module as part of a third party library. 376 known-third-party=enchant 377 378 379 [CLASSES] 380 381 # List of method names used to declare (i.e. assign) instance attributes. 382 defining-attr-methods=__init__,__new__,setUp 383 384 # List of member names, which should be excluded from the protected access 385 # warning. 386 exclude-protected=_asdict,_fields,_replace,_source,_make 387 388 # List of valid names for the first argument in a class method. 389 valid-classmethod-first-arg=cls 390 391 # List of valid names for the first argument in a metaclass class method. 392 valid-metaclass-classmethod-first-arg=mcs 393 394 395 [DESIGN] 396 397 # Maximum number of arguments for function / method 398 max-args=5 399 400 # Maximum number of attributes for a class (see R0902). 401 # max-attributes=7 402 max-attributes=11 403 404 # Maximum number of boolean expressions in a if statement 405 max-bool-expr=5 406 407 # Maximum number of branch for function / method body 408 max-branches=12 409 410 # Maximum number of locals for function / method body 411 max-locals=15 412 413 # Maximum number of parents for a class (see R0901). 414 max-parents=7 415 416 # Maximum number of public methods for a class (see R0904). 417 max-public-methods=20 418 419 # Maximum number of return / yield for function / method body 420 max-returns=6 421 422 # Maximum number of statements in function / method body 423 max-statements=50 424 425 # Minimum number of public methods for a class (see R0903). 426 min-public-methods=1 427 428 429 [EXCEPTIONS] 430 431 # Exceptions that will emit a warning when being caught. Defaults to 432 # "Exception" 433 overgeneral-exceptions=Exception