| [MESSAGES CONTROL] |
| |
| # Only show warnings with the listed confidence levels. Leave empty to show |
| # all. |
| confidence= |
| |
| # 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" |
| disable=design,similarities,no-self-use,attribute-defined-outside-init,locally-disabled,star-args,pointless-except,bad-option-value,global-statement,fixme,suppressed-message,useless-suppression |
| |
| # 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= |
| |
| |
| [MODES] |
| |
| # DEPRECATED. |
| disable-docstring=no |
| |
| # DEPRECATED, use --mode=base |
| google=no |
| |
| # The configuration modes to activate (default: base). |
| mode=base |
| |
| # The mode to use when import path setup fails (default: style). |
| safe-mode=base |
| |
| # DEPRECATED, use --mode=style |
| single-file=no |
| |
| # DEPRECATED, use --mode=test |
| test=no |
| |
| # A pattern for file names that should activate test mode. |
| test-filename-pattern=_(unit|reg)?test\.py$ |
| |
| # The configuration mode to use for tests (default: test). |
| test-mode=test |
| |
| |
| [PATHS] |
| |
| # Directories to add to sys.path. |
| #import-paths= |
| |
| # Inject some known modules. |
| inject-known-modules=no |
| |
| # The import path resolver |
| resolver=blaze |
| |
| |
| [REPORTS] |
| |
| # Add a comment according to your evaluation note. This is used by the global |
| # evaluation report (RP0004). |
| comment=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) |
| |
| # 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 |
| |
| # String to print as the module footer. |
| #module-footer-template= |
| |
| # Template for the module header. %(filename)s will be replaced with the name |
| # of the file under analysis. |
| #module-header-template= |
| |
| # 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= |
| |
| # 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=sorted-text |
| |
| # Tells whether to display a full report or only the messages |
| reports=no |
| |
| |
| [BASIC] |
| |
| # Regular expression which should only match correct argument names |
| argument-rgx=^[a-z][a-z0-9_]*$ |
| |
| # Regular expression which should only match correct instance attribute names |
| attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ |
| |
| # List of builtins function names that should not be used, separated by a comma |
| bad-functions=input,apply,reduce |
| |
| # Bad variable names which should always be refused, separated by a comma |
| bad-names= |
| |
| # Regular expression which should only match correct attribute names in class |
| # bodies |
| 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 module level names |
| const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ |
| |
| # Minimum line length for functions/classes that require docstrings, shorter |
| # ones are exempt. |
| docstring-min-length=10 |
| |
| # Regular expression which should only match correct function names |
| # function-rgx=^(?:(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$ |
| function-rgx=^(?:(?P<snake_case>_?[a-z][a-z0-9_]*))$ |
| |
| # Good variable names which should always be accepted, separated by a comma |
| good-names=main,_ |
| |
| # Regular expression which should only match correct list comprehension / |
| # generator expression variable names |
| inlinevar-rgx=^[a-z][a-z0-9_]*$ |
| |
| # Regular expression which should only match correct method names |
| # 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_]*))$ |
| method-rgx=^(?:(?P<exempt>__[a-z0-9_]+__|next)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$ |
| |
| # Regular expression which should only match correct module names |
| module-rgx=^(_?[a-z][a-z0-9_]*)|__init__|PRESUBMIT|PRESUBMIT_unittest$ |
| |
| # Colon delimited types of objects which should have the same naming style, |
| # separated by a comma |
| name-group=function:method |
| |
| # Regular expression which should only match function or class names that do |
| # not require a docstring. |
| no-docstring-rgx=(__.*__|main) |
| |
| # Required attributes for module, separated by a comma |
| required-attributes= |
| |
| # Regular expression which should only match correct variable names |
| variable-rgx=^[a-z][a-z0-9_]*$ |
| |
| |
| [CLASSES] |
| |
| # List of method names used to declare (i.e. assign) instance attributes. |
| defining-attr-methods=__init__,__new__,setUp |
| |
| # List of interface methods to ignore, separated by a comma. This is used for |
| # instance to not check methods defines in Zope's Interface base class. |
| ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by |
| |
| # List of valid names for the first argument in a class method. |
| valid-classmethod-first-arg=cls,class_ |
| |
| # List of valid names for the first argument in a metaclass class method. |
| valid-metaclass-classmethod-first-arg=mcs |
| |
| |
| [DESIGN] |
| |
| # Argument names that match this expression will be ignored. Default to name |
| # with leading underscore |
| ignored-argument-names=_.* |
| |
| # Maximum number of arguments for function / method |
| max-args=5 |
| |
| # Maximum number of attributes for a class (see R0902). |
| max-attributes=7 |
| |
| # Maximum number of branch for function / method body |
| max-branches=12 |
| |
| # Maximum number of locals for function / method body |
| max-locals=15 |
| |
| # Maximum number of parents for a class (see R0901). |
| max-parents=7 |
| |
| # Maximum number of public methods for a class (see R0904). |
| max-public-methods=20 |
| |
| # Maximum number of return / yield for function / method body |
| max-returns=6 |
| |
| # Maximum number of statements in function / method body |
| max-statements=50 |
| |
| # Minimum number of public methods for a class (see R0903). |
| min-public-methods=2 |
| |
| |
| [EXCEPTIONS] |
| |
| # Exceptions that will emit a warning when being caught. Defaults to |
| # "Exception" |
| overgeneral-exceptions=StandardError,Exception |
| |
| |
| [FORMAT] |
| |
| # Regexp for a line that is allowed to be longer than the limit. |
| ignore-long-lines=(^\s*(import|from)\s|^__version__\s=\s['"]\$Id:|^\s*(# )?<?https?://\S+>?$) |
| |
| # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 |
| # tab). |
| indent-string=' ' |
| |
| # Maximum number of characters on a single line. |
| max-line-length=80 |
| |
| # Maximum number of lines in a module |
| max-module-lines=99999 |
| |
| # List of optional constructs for which whitespace checking is disabled |
| no-space-check= |
| |
| # Allow the body of an if to be on the same line as the test if there is no |
| # else. |
| single-line-if-stmt=yes |
| |
| |
| [GOOGLE AST] |
| |
| # List of module members that should be marked as deprecated. |
| deprecated-members=string.atof,string.atoi,string.atol,string.capitalize,string.expandtabs,string.find,string.rfind,string.index,string.rindex,string.count,string.lower,string.split,string.rsplit,string.splitfields,string.join,string.joinfields,string.lstrip,string.rstrip,string.strip,string.swapcase,string.translate,string.upper,string.ljust,string.rjust,string.center,string.zfill,string.replace,sys.exitfunc |
| |
| # Maximum line length for lambdas. |
| short-func-length=1 |
| |
| |
| [GOOGLE DOCSTRING] |
| |
| # List of exceptions that do not need to be mentioned in the Raises section of |
| # a docstring. |
| ignore-exceptions=NotImplementedError,StopIteration |
| |
| |
| [GOOGLE IMPORTS] |
| |
| # List of modules that should be ignored if unused. |
| ignore-unused-imports=google3 |
| |
| |
| [GOOGLE LINES] |
| |
| # Regexp for a proper copyright notice. |
| copyright=Copyright \d{4} Google Inc\. +All Rights Reserved\. |
| |
| |
| [GOOGLE TOKENS] |
| |
| # A regex for finding comments that do not have a space between leading comment |
| # separators and textual content. |
| comment-starts-without-space=\A#[^\s\w]*\w |
| |
| # Regexp for a proper TODO comment; the uid group, if any, should match the |
| # user ID of the relevant person |
| good-todo=# ?TODO\((?P<uid>[a-z][a-z0-9-]*)|b/(?P<bugid>[0-9]+)\):? |
| |
| # Number of spaces of indent required when the last token on the preceding line |
| # is an open (, [, or {. |
| indent-after-paren=8 |
| |
| # Minimum number of spaces between the end of a line and an inline comment. |
| min-comment-space=2 |
| |
| # Regexp for a TODO comment, which may be incorrect. |
| todo=(?i)#\s*todo |
| |
| |
| [IMPORTS] |
| |
| # Deprecated modules which should not be used, separated by a comma |
| deprecated-modules=regsub,TERMIOS,Bastion,rexec |
| |
| # Create a graph of external dependencies in the given file (report RP0402 must |
| # not be disabled) |
| ext-import-graph= |
| |
| # 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 internal dependencies in the given file (report RP0402 must |
| # not be disabled) |
| int-import-graph= |
| |
| |
| [LOGGING] |
| |
| # Logging modules to check that the string format arguments are in logging |
| # function parameter format |
| logging-modules=logging,google3.pyglib.logging |
| |
| |
| [MASTER] |
| |
| # Add files or directories to the blacklist. They should be base names, not |
| # paths. |
| ignore=CVS |
| |
| # Arbitrary Python code to execute before linting. |
| #init-hook= |
| |
| # List of plugins (as comma separated values of python modules names) to load, |
| # usually to register additional checkers. |
| load-plugins= |
| |
| # Pickle collected data for later comparisons. |
| persistent=no |
| |
| # Use a custom configuration file for linting. |
| #rcfile= |
| |
| |
| [MISCELLANEOUS] |
| |
| # List of note tags to take in consideration, separated by a comma. |
| notes= |
| |
| |
| [SIMILARITIES] |
| |
| # Ignore comments when computing similarities. |
| ignore-comments=yes |
| |
| # Ignore docstrings when computing similarities. |
| ignore-docstrings=yes |
| |
| # Ignore imports when computing similarities. |
| ignore-imports=no |
| |
| # Minimum lines number of a similarity. |
| min-similarity-lines=4 |
| |
| |
| [TYPECHECK] |
| |
| # List of members which are set dynamically and missed by pylint inference |
| # system, and so shouldn't trigger E0201 when accessed. Python regular |
| # expressions are accepted. |
| generated-members=REQUEST,acl_users,aq_parent |
| |
| # 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 classes names for which member attributes should not be checked |
| # (useful for classes with attributes dynamically set). |
| ignored-classes=SQLObject |
| |
| # When zope mode is activated, add a predefined set of Zope acquired attributes |
| # to generated-members. |
| zope=no |
| |
| |
| [VARIABLES] |
| |
| # List of additional names supposed to be defined in builtins. Remember that |
| # you should avoid to define new builtins when possible. |
| additional-builtins= |
| |
| # A regular expression matching the beginning of the name of dummy variables |
| # (i.e. not used). |
| dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) |
| |
| # Tells whether we should check for unused import in __init__ files. |
| init-import=no |