From cf4986853e758d24369848af4ba3e1d4e1fbf515 Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Tue, 25 Jun 2019 16:36:44 -0700 Subject: [PATCH] change: tighten pylint config and expand C and R exceptions This commit tightens the pylint config with inspiration from several of Google's pylint configs. This commit also expands the C and R exceptions and disables the specific rules that cause issues in this package. --- .pylintrc | 449 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 406 insertions(+), 43 deletions(-) diff --git a/.pylintrc b/.pylintrc index 34a54ce0ec..5699045bec 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,56 +1,232 @@ +# This config based on a few of Google's pylint configurations: +# * https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/refs/heads/master/pylintrc +# * https://github.com/google/seq2seq/blob/master/pylintrc +# * https://github.com/google/pygtrie/blob/master/.pylintrc + [MASTER] -ignore= - tensorflow_serving +# 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,tensorflow_serving + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# 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=numpy + +# 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. This option is deprecated +# and it will be removed in Pylint 2.0. +optimize-ast=no [MESSAGES CONTROL] +# 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 (only on the command line, not in the configuration file where +# it should appear only once). 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" disable= - C, # convention - R, # refactor - too-many-arguments, # We should fix the offending ones soon. - too-many-lines, # Some files are too big, we should fix this too - too-few-public-methods, - too-many-instance-attributes, + C0330, # Black disagrees with and explicitly violates this: https://github.com/python/black/issues/48 too-many-locals, - len-as-condition, # Nice to have in the future - bad-indentation, - line-too-long, # We let Flake8 take care of this - logging-format-interpolation, - useless-object-inheritance, # We still support python2 so inheriting from object is ok - invalid-name, - import-error, - logging-not-lazy, - fixme, - no-self-use, - attribute-defined-outside-init, - protected-access, - invalid-all-object, arguments-differ, - abstract-method, - signature-differs + too-many-lines, + fixme, + too-many-arguments, + invalid-name, + too-many-instance-attributes, + line-too-long, # We let Flake8 take care of this # TODO: Fix these and stop relying on flake8 + len-as-condition, # TODO: Use if seq: and if not seq: instead + logging-format-interpolation, # TODO: Fix logging so as to remove this. + import-error, # TODO: Fix import errors + logging-not-lazy, # TODO: Fix logging + attribute-defined-outside-init, # TODO: Fix scope + protected-access, # TODO: Fix access + abstract-method, # TODO: Fix abstract methods + signature-differs, # TODO: Fix signature overrides + unidiomatic-typecheck, # TODO: Fix typechecks + wrong-import-order, # TODO: Fix import order + no-else-return, # TODO: Remove unnecessary elses + useless-object-inheritance, # TODO: Remove unnecessary imports + cyclic-import, # TODO: Resolve cyclic imports + no-else-raise, # TODO: Remove unnecessary elses + no-self-use, # TODO: Convert methods to functions where appropriate + inconsistent-return-statements, # TODO: Make returns consistent + consider-merging-isinstance, # TODO: Merge isinstance where appropriate + consider-using-in, # TODO: Consider merging comparisons with "in" + simplifiable-if-expression, # TODO: Simplify expressions + too-many-public-methods, # TODO: Resolve + ungrouped-imports, # TODO: Group imports + wrong-import-position, # TODO: Correct import positions + consider-using-ternary, # TODO: Consider ternary expressions + chained-comparison, # TODO: Simplify chained comparison between operands + simplifiable-if-statement, # TODO: Simplify ifs + too-many-branches, # TODO: Simplify or ignore as appropriate + superfluous-parens, # TODO: Remove unnecessary parens + missing-docstring, # TODO: Fix missing docstring [REPORTS] # Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. output-format=colorized +# 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]". This option is deprecated +# and it will be removed in Pylint 2.0. +files-output=no + # Tells whether to display a full report or only the messages -# CHANGE: No report. reports=no -[FORMAT] -# Maximum number of characters on a single line. -max-line-length=100 -# Maximum number of lines in a module -#max-module-lines=1000 -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). -indent-string=' ' +# 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) + +# Add a comment according to your evaluation note. This is used by the global +# evaluation report (RP0004). +comment=no [BASIC] +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ + +# 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 + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Regular expression matching correct variable names +variable-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for variable names +variable-name-hint=[a-z_][a-z0-9_]{2,30}$ + # Required attributes for module, separated by a comma #required-attributes= + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct argument names +argument-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for argument names +argument-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct method names +method-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for method names +method-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct function names +function-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for function names +function-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct attribute names +attr-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for attribute names +attr-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching 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 function or class names that do +# not require a docstring. +no-docstring-rgx=^test_ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + # List of builtins function names that should not be used, separated by a comma. # XXX: Should we ban map() & filter() for list comprehensions? # exit & quit are for the interactive interpreter shell only. @@ -61,30 +237,217 @@ bad-functions= input, quit, +[ELIF] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +[FORMAT] +# Maximum number of characters on a single line. +max-line-length=100 + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=n + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Maximum number of lines in a module +max-module-lines=1000 + +# 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 + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX,TODO + [SIMILARITIES] + # Minimum lines number of a similarity. -min-similarity-lines=5 +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 + +[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 + + +[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=distutils + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,matplotlib.cm,tensorflow.python,tensorflow,tensorflow.train.Example,RunOptions + +# 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=set_shape,np.float32 + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + [VARIABLES] + # Tells whether we should check for unused import in __init__ files. init-import=no -# A regular expression matching the beginning of the name of dummy variables -# (i.e. not used). + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). dummy-variables-rgx=_|unused_ # List of additional names supposed to be defined in builtins. Remember that # you should avoid to define new builtins when possible. -#additional-builtins= +additional-builtins= -[LOGGING] -# Apply logging string format checks to calls on these modules. -logging-modules= - logging +# 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 -[TYPECHECK] -ignored-modules= - distutils +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.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 + +# 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 + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=10 + +# 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=30 + +# 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=100 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of attributes for a class (see R0902). +max-attributes=10 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=0 + +# 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 + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=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= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception