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