Enable pylint for distributed cloud client

The error codes detected by pylint are suppressed
and can be fixed by later submissions.

The get_parser methods were updated to fix the
arguments-differ error code, because the base method
defined in 'cliff' expects prog_name as its argument.

This also adds the pylint target to zuul.

Story: 2007082
Task: 39360
Change-Id: Idf7264fa7594e4c9a18603960a566601883865a8
Signed-off-by: albailey <Al.Bailey@windriver.com>

.zuul.yaml

@@ -8,11 +8,13 @@
         - openstack-tox-linters
         - stx-distcloud-client-tox-pep8
         - stx-distcloud-client-tox-py27
+        - stx-distcloud-client-tox-pylint
     gate:
       jobs:
         - openstack-tox-linters
         - stx-distcloud-client-tox-pep8
         - stx-distcloud-client-tox-py27
+        - stx-distcloud-client-tox-pylint
     post:
       jobs:
         - stx-distcloud-client-upload-git-mirror
@@ -25,6 +27,15 @@
       tox_envlist: py27
       tox_extra_args: -c distributedcloud-client/tox.ini
 
+- job:
+    name: stx-distcloud-client-tox-pylint
+    parent: tox
+    description: Run pylint for distcloud-client
+    vars:
+      tox_envlist: pylint
+      tox_extra_args: -c distributedcloud-client/tox.ini
+
+
 - job:
     name: stx-distcloud-client-tox-pep8
     parent: tox

distributedcloud-client/dcmanagerclient/commands/v1/alarm_manager.py

@@ -54,8 +54,8 @@ class ListAlarmSummary(base.DCManagerLister):
     def _get_format_function(self):
         return format
 
-    def get_parser(self, parsed_args):
-        parser = super(ListAlarmSummary, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ListAlarmSummary, self).get_parser(prog_name)
         return parser
 
     def _get_resources(self, parsed_args):

distributedcloud-client/dcmanagerclient/commands/v1/subcloud_manager.py

@@ -119,8 +119,8 @@ class AddSubcloud(base.DCManagerShowOne):
     def _get_format_function(self):
         return detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(AddSubcloud, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(AddSubcloud, self).get_parser(prog_name)
 
         parser.add_argument(
             '--bootstrap-address',
@@ -275,8 +275,8 @@ class ListSubcloud(base.DCManagerLister):
     def _get_format_function(self):
         return format
 
-    def get_parser(self, parsed_args):
-        parser = super(ListSubcloud, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ListSubcloud, self).get_parser(prog_name)
         return parser
 
     def _get_resources(self, parsed_args):
@@ -290,8 +290,8 @@ class ShowSubcloud(base.DCManagerShowOne):
     def _get_format_function(self):
         return detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ShowSubcloud, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ShowSubcloud, self).get_parser(prog_name)
 
         parser.add_argument(
             'subcloud',

distributedcloud-client/dcmanagerclient/commands/v1/sw_update_manager.py

@@ -110,8 +110,8 @@ class CreatePatchStrategy(base.DCManagerShowOne):
     def _get_format_function(self):
         return detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(CreatePatchStrategy, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(CreatePatchStrategy, self).get_parser(prog_name)
 
         parser.add_argument(
             '--subcloud-apply-type',
@@ -165,8 +165,8 @@ class ShowPatchStrategy(base.DCManagerShowOne):
     def _get_format_function(self):
         return detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ShowPatchStrategy, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ShowPatchStrategy, self).get_parser(prog_name)
         return parser
 
     def _get_resources(self, parsed_args):
@@ -240,8 +240,8 @@ class ListStrategyStep(base.DCManagerLister):
     def _get_format_function(self):
         return strategy_step_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ListStrategyStep, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ListStrategyStep, self).get_parser(prog_name)
         return parser
 
     def _get_resources(self, parsed_args):
@@ -255,8 +255,8 @@ class ShowStrategyStep(base.DCManagerShowOne):
     def _get_format_function(self):
         return detail_strategy_step_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ShowStrategyStep, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ShowStrategyStep, self).get_parser(prog_name)
 
         parser.add_argument(
             'cloud_name',

distributedcloud-client/dcmanagerclient/commands/v1/sw_update_options_manager.py

@@ -89,8 +89,8 @@ class UpdateSwUpdateOptions(base.DCManagerShowOne):
     def _get_format_function(self):
         return options_detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(UpdateSwUpdateOptions, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(UpdateSwUpdateOptions, self).get_parser(prog_name)
 
         parser.add_argument(
             '--storage-apply-type',
@@ -163,8 +163,8 @@ class ListSwUpdateOptions(base.DCManagerLister):
     def _get_format_function(self):
         return options_list_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ListSwUpdateOptions, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ListSwUpdateOptions, self).get_parser(prog_name)
         return parser
 
     def _get_resources(self, parsed_args):
@@ -179,8 +179,8 @@ class ShowSwUpdateOptions(base.DCManagerShowOne):
     def _get_format_function(self):
         return options_detail_format
 
-    def get_parser(self, parsed_args):
-        parser = super(ShowSwUpdateOptions, self).get_parser(parsed_args)
+    def get_parser(self, prog_name):
+        parser = super(ShowSwUpdateOptions, self).get_parser(prog_name)
 
         parser.add_argument(
             'subcloud',

distributedcloud-client/pylint.rc

@@ -0,0 +1,244 @@
+[MASTER]
+# Specify a configuration file.
+rcfile=pylint.rc
+
+# 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=greenlet
+
+# 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=tests
+
+# 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).
+# http://pylint.pycqa.org/en/latest/technical_reference/features.html
+#
+# fixme: warning note, todo, etc..
+# R detect Refactor for a "good practice" metric violation
+# C detect Convention for coding standard violation
+# W0102: dangerous-default-value
+# W0201: attribute-defined-outside-init
+# W0212: protected-access
+# W0231: super-init-not-called
+# W0403: relative-import (typically caused by six)
+# W0603: global-statement
+# W0612: unused-variable
+# W0613: unused-argument
+# W0621: redefined-outer-name
+# W0622: redefined-builtin
+# W0703: broad-except
+# W1201: logging-not-lazy
+# W1113: keyword-arg-before-vararg
+# E1102: not-callable
+disable=fixme,C,R,
+        W0102,W0201,W0212,W0231,W0403,
+        W0612,W0613,W0603,W0621,W0622,W0703,W1201,W1113,
+        E1102
+
+[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 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
+ignored-modules=distutils,eventlet.green.subprocess,six,six.moves
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+# pylint is confused by sqlalchemy Table, as well as sqlalchemy Enum types
+ignored-classes=SQLObject,Table
+
+# 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
+
+
+[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-branchs=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

distributedcloud-client/test-requirements.txt

@@ -2,7 +2,8 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-pylint==1.4.5 # GPLv2
+pylint==1.9.2;python_version<"3.0" # GPLv2
+pylint==2.3.1;python_version>="3.0" # GPLv2
 python-openstackclient>=3.3.0 # Apache-2.0
 sphinx>=1.5.1 # BSD
 unittest2 # BSD
@@ -11,6 +12,5 @@ mock>=2.0 # BSD
 nose # LGPL
 tempest>=14.0.0 # Apache-2.0
 testtools>=1.4.0 # MIT
-
 PyYAML>=3.1.0
 yamllint>=0.5.2

distributedcloud-client/tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 2.3
-envlist = py27,pep8
+envlist = py27,pep8,pylint
 skipsdist = True
 
 toxworkdir = /tmp/{env:USER}_dc_client_tox
@@ -36,6 +36,13 @@ commands =
 basepython = python3
 commands = flake8 {posargs}
 
+[testenv:pylint]
+basepython = python2.7
+sitepackages = False
+deps = {[testenv]deps}
+commands =
+     pylint {posargs} dcmanagerclient --rcfile=./pylint.rc
+
 [testenv:venv]
 basepython = python3
 commands = {posargs}