Adding pylint zuul job

This adds a pylint tox target and zuul job.

There are many pylint warnings and errors suppressed
in the pylint.rc file that can be examined and
fixed by subsequent reviews.

Change-Id: Ibcf4c5f6763c97ef84eaa82a80bc130fa2e591f0
Story: 2004515
Task: 35987
Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
This commit is contained in:
Al Bailey 2019-07-25 11:32:36 -05:00
parent a8c228d5de
commit 0386cc2e40
4 changed files with 267 additions and 0 deletions

View File

@ -6,7 +6,9 @@
jobs:
- build-openstack-releasenotes
- openstack-tox-pep8
- openstack-tox-pylint
gate:
jobs:
- build-openstack-releasenotes
- openstack-tox-pep8
- openstack-tox-pylint

259
pylint.rc Normal file
View File

@ -0,0 +1,259 @@
[MASTER]
# Specify a configuration file.
rcfile=pylint.rc
# Python code to execute, usually for sys.path manipulation such as pygtk.require().
#init-hook=
# Add files or directories to the blacklist. They should be base names, not paths.
ignore=
# 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=
[MESSAGES CONTROL]
# 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.
#enable=
# Disable 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).
#
# W0102 dangerous-default-value
# W0105 pointless-string-statement
# W0107 unnecessary-pass
# W0120 useless-else-on-loop
# W0123 eval-used
# W0150 lost-exception
# W0201 attribute-defined-outside-init
# W0212 protected-access
# W0221 arguments-differ
# W0235 useless-super-delegation
# W0401 wildcard-import
# W0402 deprecated-module
# W0404 reimported
# W0511 fixme
# W0601 global-variable-undefined
# W0603 global-statement
# W0611 unused-import
# W0612 unused-variable
# W0613 unused-argument
# W0621 redefined-outer-name
# W0622 redefined-builtin
# W0632 unbalanced-tuple-unpacking
# W0702 bare-except
# W0703 broad except warning
# W0706 try-except-raise
# W1113 keyword-arg-before-vararg
# W1302 bad-format-string
# W1308 duplicate-string-formatting-argument
# W1401 anomalous-backslash-in-string
#
# E0102 function-redefined
# E0401 import-error
# E0611 no-name-in-module
# E0711 notimplemented-raised
# E1102 not-callable
# E1120 no-value-for-parameter
# E1305 too-many-format-args
#
disable=C,R,
W0102,W0105,W0107,W0120,W0123,W0150,
W0201,W0212,W0221,W0235,
W0401,W0402,W0404,
W0511,
W0601,W0603,W0611,W0612,W0613,W0621,W0622,W0632,
W0702,W0703,W0706,
W1113,W1302,W1308,W1401,
E0102,E0401,E0611,E0711,E1102,E1120,E1305
[REPORTS]
# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html
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)
[SIMILARITIES]
# Minimum lines number of a similarity.
min-similarity-lines=4
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
[FORMAT]
# Maximum number of characters on a single line.
max-line-length=85
# 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=' '
[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 classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set).
ignored-classes=
# 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=
[BASIC]
# List of builtins function names that should not be used, separated by a comma
bad-functions=map,filter,apply,input
# Regular expression which should only match correct module names
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
# Regular expression which should only match correct module level names
const-rgx=(([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
function-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct method names
method-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct instance attribute names
attr-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct argument names
argument-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct variable names
variable-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct list comprehension /
# generator expression variable names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
# 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
# Regular expression which should only match functions or classes name which do
# not require a docstring
no-docstring-rgx=__.*__
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX,TODO
[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).
dummy-variables-rgx=_|dummy
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=
[IMPORTS]
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
# 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=
[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=7
# 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
[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]
# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception

View File

@ -1,4 +1,5 @@
hacking>=1.1.0,<1.2.0 # Apache-2.0
pylint
PyYAML>=3.1.0
yamllint>=0.5.2
doc8

View File

@ -30,6 +30,11 @@ commands =
-print0 | xargs -0 yamllint"
doc8 doc/source
[testenv:pylint]
basepython = python3
recreate = True
commands = pylint --rcfile=pylint.rc automated-pytest-suite
[testenv:pep8]
basepython = python3
commands = flake8 {posargs}