# Copyright 2016 Google Inc. All rights reserved. # # 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. [REPORTS] # 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 # Disable the report(s) with the given id(s). disable-report=R0001,R0002,R0003,R0004,R0101,R0102,R0201,R0202,R0220,R0401,R0402,R0701,R0801,R0901,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,R0921,R0922,R0923 [MESSAGES CONTROL] # List of checkers and warnings to enable. enable=old-raise-syntax # List of checkers and warnings to disable. disable=abstract-method,access-member-before-definition,arguments-differ,attribute-defined-outside-init,bad-option-value,design,file-ignored,fixme,global-statement,import-error,interface-is-not-class,locally-disabled,locally-enabled,maybe-no-member,method-hidden,missing-interface-method,no-init,no-member,no-name-in-module,no-self-use,pointless-except,relative-import,signature-differs,similarities,star-args,suppressed-message,unresolved-interface,unused-wildcard-import,useless-suppression confidence=HIGH,INFERENCE,UNDEFINED [BASIC] # Regular expression which should only match the name # of functions or classes which do not require a docstring. no-docstring-rgx=(__.*__|main) # Min length in lines of a function that requires a docstring. docstring-min-length=10 # Regular expression which should only match correct module names. The # leading underscore is sanctioned for private modules by Google's style # guide. # # There are exceptions to the basic rule (_?[a-z][a-z0-9_]*) to cover # requirements of Python's module system and of the presubmit framework. module-rgx=^(_?[a-z][a-z0-9_]*)|__init__|PRESUBMIT|PRESUBMIT_unittest$ # 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_]*)$ # 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_]*)$ # Regular expression which should only match correct class names class-rgx=^_?[A-Z][a-zA-Z0-9]*$ # 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_?[A-Z][a-zA-Z0-9]*)|(?P_?[a-z][a-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__[a-z0-9_]+__|next)|(?P_{0,2}[A-Z][a-zA-Z0-9]*)|(?P_{0,2}[a-z][a-z0-9_]*))$ # Regular expression which should only match correct instance attribute names attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ # Regular expression which should only match correct argument names argument-rgx=^[a-z][a-z0-9_]*$ # Regular expression which should only match correct variable names variable-rgx=^[a-z][a-z0-9_]*$ # Regular expression which should only match correct list comprehension / # generator expression variable names inlinevar-rgx=^[a-z][a-z0-9_]*$ # Good variable names which should always be accepted, separated by a comma good-names=main,_ # Bad variable names which should always be refused, separated by a comma bad-names= # List of builtins function names that should not be used, separated by a comma # # TODO(robankeny) is this a valid function to leave in or remove? bad-functions=input,apply,reduce # List of decorators that define properties, such as abc.abstractproperty. property-classes=abc.abstractproperty [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 decorators that create context managers from functions, such as # contextlib.contextmanager. contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager [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= [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 [EXCEPTIONS] overgeneral-exceptions=StandardError,Exception,BaseException [IMPORTS] # Deprecated modules which should not be used, separated by a comma. # Many of the functions in the string module are deprecated in # favor of string methods, but there are non-deprecated things in that module # too. deprecated-modules=regsub,TERMIOS,Bastion,rexec [FORMAT] # Maximum number of characters on a single line. max-line-length=80 # 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) p4 expansion $Id$ lines # (3) 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. # (4) 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 |\$Id:\s\/\/depot\/.+#\d+\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=' ' # Do not warn about multiple statements on a single line for constructs like # if test: stmt single-line-if-stmt=y # Make sure : in dicts and trailing commas are checked for whitespace. no-space-check= [LOGGING] logging-modules=logging [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. notes=