|  | # Copyright 2016 The Android Open Source Project | 
|  | # | 
|  | # Licensed under the Apache License, Version 2.0 (the "License"); | 
|  | # you may not use this file except in compliance with the License. | 
|  | # You may obtain a copy of the License at | 
|  | # | 
|  | #      http://www.apache.org/licenses/LICENSE-2.0 | 
|  | # | 
|  | # Unless required by applicable law or agreed to in writing, software | 
|  | # distributed under the License is distributed on an "AS IS" BASIS, | 
|  | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 
|  | # See the License for the specific language governing permissions and | 
|  | # limitations under the License. | 
|  |  | 
|  | [MASTER] | 
|  |  | 
|  | # Specify a configuration file. | 
|  | #rcfile= | 
|  |  | 
|  | # Python code to execute, usually for sys.path manipulation such as | 
|  | # pygtk.require(). | 
|  | #init-hook= | 
|  |  | 
|  | # Profiled execution. | 
|  | profile=no | 
|  |  | 
|  | # Add files or directories to the blacklist. They should be base names, not | 
|  | # paths. | 
|  | ignore=CVS,.svn,.git,update_metadata_pb2.py | 
|  |  | 
|  | # Pickle collected data for later comparisons. | 
|  | persistent=yes | 
|  |  | 
|  | # List of plugins (as comma separated values of python modules names) to load, | 
|  | # usually to register additional checkers. | 
|  | load-plugins= | 
|  |  | 
|  | # Use multiple processes to speed up Pylint. | 
|  | jobs=1 | 
|  |  | 
|  | # Allow loading of arbitrary C extensions. Extensions are imported into the | 
|  | # active Python interpreter and may run arbitrary code. | 
|  | unsafe-load-any-extension=no | 
|  |  | 
|  | # 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= | 
|  |  | 
|  | # Allow optimization of some AST trees. This will activate a peephole AST | 
|  | # optimizer, which will apply various small optimizations. For instance, it can | 
|  | # be used to obtain the result of joining multiple strings with the addition | 
|  | # operator. Joining a lot of strings can lead to a maximum recursion error in | 
|  | # Pylint and this flag can prevent that. It has one side effect, the resulting | 
|  | # AST will be different than the one from reality. | 
|  | optimize-ast=no | 
|  |  | 
|  |  | 
|  | [MESSAGES CONTROL] | 
|  |  | 
|  | # List of checkers and warnings to enable. | 
|  | enable=old-raise-syntax | 
|  |  | 
|  | # Only show warnings with the listed confidence levels. Leave empty to show | 
|  | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED | 
|  | confidence= | 
|  |  | 
|  | # 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. See also the "--disable" option for examples. | 
|  | #enable= | 
|  |  | 
|  | # 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" | 
|  | # We leave many of the style warnings to judgement/peer review. | 
|  | disable= | 
|  | fixme, | 
|  | locally-disabled, | 
|  | locally-enabled, | 
|  | no-self-use, | 
|  | star-args, | 
|  | too-few-public-methods, | 
|  | too-many-arguments, | 
|  | too-many-branches, | 
|  | too-many-instance-attributes, | 
|  | too-many-lines, | 
|  | too-many-locals, | 
|  | too-many-public-methods, | 
|  | too-many-return-statements, | 
|  | too-many-statements, | 
|  |  | 
|  |  | 
|  | [REPORTS] | 
|  |  | 
|  | # Set the output format. Available formats are text, parseable, colorized, msvs | 
|  | # (visual studio) and html. You can also give a reporter class, eg | 
|  | # mypackage.mymodule.MyReporterClass. | 
|  | output-format=text | 
|  |  | 
|  | # Put messages in a separate file for each module / package specified on the | 
|  | # command line instead of printing them on stdout. Reports (if any) will be | 
|  | # written in a file name "pylint_global.[txt|html]". | 
|  | files-output=no | 
|  |  | 
|  | # Tells whether to display a full report or only the messages | 
|  | reports=no | 
|  |  | 
|  | # 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= | 
|  |  | 
|  |  | 
|  | [SIMILARITIES] | 
|  |  | 
|  | # Minimum lines number of a similarity. | 
|  | min-similarity-lines=20 | 
|  |  | 
|  | # Ignore comments when computing similarities. | 
|  | ignore-comments=yes | 
|  |  | 
|  | # Ignore docstrings when computing similarities. | 
|  | ignore-docstrings=yes | 
|  |  | 
|  | # Ignore imports when computing similarities. | 
|  | ignore-imports=no | 
|  |  | 
|  |  | 
|  | [TYPECHECK] | 
|  |  | 
|  | # 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 | 
|  |  | 
|  | # 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. | 
|  | ignored-modules=update_payload.update_metadata_pb2 | 
|  |  | 
|  | # List of classes names for which member attributes should not be checked | 
|  | # (useful for classes with attributes dynamically set). This supports can work | 
|  | # with qualified names. | 
|  | ignored-classes=hashlib,numpy | 
|  |  | 
|  | # 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= | 
|  |  | 
|  | # List of decorators that create context managers from functions, such as | 
|  | # contextlib.contextmanager. | 
|  | contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager | 
|  |  | 
|  |  | 
|  | [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 | 
|  |  | 
|  |  | 
|  | [LOGGING] | 
|  |  | 
|  | # Logging modules to check that the string format arguments are in logging | 
|  | # function parameter format | 
|  | logging-modules=logging | 
|  |  | 
|  |  | 
|  | [VARIABLES] | 
|  |  | 
|  | # Tells whether we should check for unused import in __init__ files. | 
|  | init-import=no | 
|  |  | 
|  | # A regular expression matching names used for dummy variables (i.e. not used). | 
|  | dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) | 
|  |  | 
|  | # List of additional names supposed to be defined in builtins. Remember that | 
|  | # you should avoid to define new builtins when possible. | 
|  | additional-builtins= | 
|  |  | 
|  | # 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_,_cb | 
|  |  | 
|  |  | 
|  | [FORMAT] | 
|  |  | 
|  | # Maximum number of characters on a single line. | 
|  | max-line-length=80 | 
|  |  | 
|  | # 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 | 
|  |  | 
|  | # Regexp for a line that is allowed to be longer than the limit. | 
|  | # This "ignore" regex is today composed of 4 independent parts: | 
|  | # (1) Long import lines | 
|  | # (2) URLs in comments or pydocs. Detecting URLs by regex is a hard problem and | 
|  | #     no amount of tweaking will make a perfect regex AFAICT. This one is a good | 
|  | #     compromise. | 
|  | # (3) Constant string literals at the start of files don't need to be broken | 
|  | #     across lines. Allowing long paths, streamz and urls to be on a single | 
|  | #     line. Also requires that the string not be a triplequoted string. | 
|  | ignore-long-lines=(?x) | 
|  | (^\s*(import|from)\s | 
|  | |^\s*(\#\ )?<?(https?|ftp):\/\/[^\s\/$.?#].[^\s]*>?$ | 
|  | |^[a-zA-Z_][a-zA-Z0-9_]*\s*=\s*("[^"]\S+"|'[^']\S+') | 
|  | ) | 
|  |  | 
|  | # Maximum number of lines in a module | 
|  | max-module-lines=99999 | 
|  |  | 
|  | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 | 
|  | # tab). | 
|  | indent-string='  ' | 
|  |  | 
|  | # Number of spaces of indent required inside a hanging  or continued line. | 
|  | indent-after-paren=4 | 
|  |  | 
|  | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. | 
|  | expected-line-ending-format=LF | 
|  |  | 
|  | # Make sure : in dicts and trailing commas are checked for whitespace. | 
|  | no-space-check= | 
|  |  | 
|  |  | 
|  | [MISCELLANEOUS] | 
|  |  | 
|  | # List of note tags to take in consideration, separated by a comma. | 
|  | notes=FIXME,XXX,TODO | 
|  |  | 
|  |  | 
|  | [BASIC] | 
|  |  | 
|  | # Required attributes for module, separated by a comma | 
|  | required-attributes= | 
|  |  | 
|  | # List of builtins function names that should not be used, separated by a comma | 
|  | bad-functions=map,filter,input,apply,reduce | 
|  |  | 
|  | # Good variable names which should always be accepted, separated by a comma | 
|  | good-names=i,j,k,ex,x,_,main | 
|  |  | 
|  | # Bad variable names which should always be refused, separated by a comma | 
|  | bad-names=foo,bar,baz,toto,tutu,tata | 
|  |  | 
|  | # Colon-delimited sets of names that determine each other's naming style when | 
|  | # the name regexes allow several styles. | 
|  | name-group= | 
|  |  | 
|  | # Include a hint for the correct naming format with invalid-name | 
|  | include-naming-hint=no | 
|  |  | 
|  | # Regular expression which should only match correct function names. | 
|  | # 'camel_case' and 'snake_case' group names are used for consistency of naming | 
|  | # styles across functions and methods. | 
|  | function-rgx=^(?:(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$ | 
|  |  | 
|  | # Naming hint for function names | 
|  | function-name-hint=[a-z_][a-z0-9_]{2,30}$ | 
|  |  | 
|  | # Regular expression which should only match correct variable names | 
|  | variable-rgx=^[a-z][a-z0-9_]*$ | 
|  |  | 
|  | # Naming hint for variable names | 
|  | variable-name-hint=[a-z_][a-z0-9_]{2,30}$ | 
|  |  | 
|  | # Regular expression which should only match correct module level names | 
|  | const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ | 
|  |  | 
|  | # Naming hint for constant names | 
|  | const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ | 
|  |  | 
|  | # Regular expression which should only match correct instance attribute names | 
|  | attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ | 
|  |  | 
|  | # Naming hint for attribute names | 
|  | attr-name-hint=[a-z_][a-z0-9_]{2,30}$ | 
|  |  | 
|  | # Regular expression which should only match correct argument names | 
|  | argument-rgx=^[a-z][a-z0-9_]*$ | 
|  |  | 
|  | # Naming hint for argument names | 
|  | argument-name-hint=[a-z_][a-z0-9_]{2,30}$ | 
|  |  | 
|  | # Regular expression which should only match correct class attribute | 
|  | class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ | 
|  |  | 
|  | # Naming hint for class attribute names | 
|  | class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ | 
|  |  | 
|  | # Regular expression which should only match correct list comprehension / | 
|  | # generator expression variable names | 
|  | inlinevar-rgx=^[a-z][a-z0-9_]*$ | 
|  |  | 
|  | # Naming hint for inline iteration names | 
|  | inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ | 
|  |  | 
|  | # Regular expression which should only match correct class names | 
|  | class-rgx=^_?[A-Z][a-zA-Z0-9]*$ | 
|  |  | 
|  | # Naming hint for class names | 
|  | class-name-hint=[A-Z_][a-zA-Z0-9]+$ | 
|  |  | 
|  | # Regular expression which should only match correct module names. The | 
|  | # leading underscore is sanctioned for private modules by Google's style | 
|  | # guide. | 
|  | module-rgx=^(_?[a-z][a-z0-9_]*)|__init__$ | 
|  |  | 
|  | # Naming hint for module names | 
|  | module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ | 
|  |  | 
|  | # Regular expression which should only match correct method names. | 
|  | # 'camel_case' and 'snake_case' group names are used for consistency of naming | 
|  | # styles across functions and methods. 'exempt' indicates a name which is | 
|  | # consistent with all naming styles. | 
|  | method-rgx=^(?:(?P<exempt>__[a-z0-9_]+__|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$ | 
|  |  | 
|  | # Naming hint for method names | 
|  | method-name-hint=[a-z_][a-z0-9_]{2,30}$ | 
|  |  | 
|  | # Regular expression which should only match function or class names that do | 
|  | # not require a docstring. | 
|  | no-docstring-rgx=(__.*__|main) | 
|  |  | 
|  | # Minimum line length for functions/classes that require docstrings, shorter | 
|  | # ones are exempt. | 
|  | docstring-min-length=10 | 
|  |  | 
|  | # List of decorators that define properties, such as abc.abstractproperty. | 
|  | property-classes=abc.abstractproperty | 
|  |  | 
|  |  | 
|  | [ELIF] | 
|  |  | 
|  | # Maximum number of nested blocks for function / method body | 
|  | max-nested-blocks=5 | 
|  |  | 
|  |  | 
|  | [DESIGN] | 
|  |  | 
|  | # Maximum number of arguments for function / method | 
|  | max-args=5 | 
|  |  | 
|  | # Argument names that match this expression will be ignored. Default to name | 
|  | # with leading underscore | 
|  | ignored-argument-names=_.* | 
|  |  | 
|  | # Maximum number of locals for function / method body | 
|  | max-locals=15 | 
|  |  | 
|  | # Maximum number of return / yield for function / method body | 
|  | max-returns=6 | 
|  |  | 
|  | # Maximum number of branch for function / method body | 
|  | max-branches=12 | 
|  |  | 
|  | # Maximum number of statements in function / method body | 
|  | max-statements=50 | 
|  |  | 
|  | # Maximum number of parents for a class (see R0901). | 
|  | max-parents=10 | 
|  |  | 
|  | # Maximum number of attributes for a class (see R0902). | 
|  | max-attributes=7 | 
|  |  | 
|  | # Minimum number of public methods for a class (see R0903). | 
|  | min-public-methods=2 | 
|  |  | 
|  | # Maximum number of public methods for a class (see R0904). | 
|  | max-public-methods=20 | 
|  |  | 
|  | # Maximum number of boolean expressions in a if statement | 
|  | max-bool-expr=5 | 
|  |  | 
|  |  | 
|  | [CLASSES] | 
|  |  | 
|  | # List of method names used to declare (i.e. assign) instance attributes. | 
|  | defining-attr-methods=__init__,__new__,setUp | 
|  |  | 
|  | # 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 | 
|  |  | 
|  | # List of member names, which should be excluded from the protected access | 
|  | # warning. | 
|  | exclude-protected=_asdict,_fields,_replace,_source,_make | 
|  |  | 
|  |  | 
|  | [IMPORTS] | 
|  |  | 
|  | # Deprecated modules which should not be used, separated by a comma | 
|  | deprecated-modules=regsub,TERMIOS,Bastion,rexec,optparse | 
|  |  | 
|  | # Create a graph of every (i.e. internal and external) dependencies in the | 
|  | # given file (report RP0402 must not be disabled) | 
|  | import-graph= | 
|  |  | 
|  | # Create a graph of external dependencies in the given file (report RP0402 must | 
|  | # not be disabled) | 
|  | ext-import-graph= | 
|  |  | 
|  | # Create a graph of internal dependencies in the given file (report RP0402 must | 
|  | # not be disabled) | 
|  | int-import-graph= | 
|  |  | 
|  |  | 
|  | [EXCEPTIONS] | 
|  |  | 
|  | # Exceptions that will emit a warning when being caught. Defaults to | 
|  | # "Exception" | 
|  | overgeneral-exceptions=StandardError,Exception,BaseException |