meta-stx: re-name and re-org to align with upstream
[pti/rtp.git] / meta-starlingx / meta-stx-flock / stx-update / files / 0003-Cleaning-up-pylint-settings-for-cgcs-patch.patch
diff --git a/meta-starlingx/meta-stx-flock/stx-update/files/0003-Cleaning-up-pylint-settings-for-cgcs-patch.patch b/meta-starlingx/meta-stx-flock/stx-update/files/0003-Cleaning-up-pylint-settings-for-cgcs-patch.patch
new file mode 100644 (file)
index 0000000..b5e8c7a
--- /dev/null
@@ -0,0 +1,441 @@
+From de774c85653692b2a901123b5653d0e2101c5353 Mon Sep 17 00:00:00 2001
+From: Al Bailey <Al.Bailey@windriver.com>
+Date: Fri, 4 Oct 2019 12:29:03 -0500
+Subject: [PATCH] Cleaning up pylint settings for cgcs patch
+
+This also adds cgcs_make_patch folder for  pylint
+
+pylint is invoked with two different pylint.rc files
+so that different codes can be suppressed for the
+two different code structures.
+
+Change-Id: I0d7a87ed435ed716a3c1ea98f5d7badfd2adac7d
+Story: 2004515
+Task: 37701
+Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
+
+---
+ cgcs-patch/cgcs-patch/pylint.rc            |  14 +-
+ cgcs-patch/cgcs-patch/pylint_make_patch.rc | 352 +++++++++++++++++++++++++++++
+ cgcs-patch/cgcs-patch/tox.ini              |   6 +-
+ 3 files changed, 365 insertions(+), 7 deletions(-)
+ create mode 100644 cgcs-patch/cgcs-patch/pylint_make_patch.rc
+
+diff --git a/cgcs-patch/cgcs-patch/pylint.rc b/cgcs-patch/cgcs-patch/pylint.rc
+index dc20bb0..812b6b5 100644
+--- a/cgcs-patch/cgcs-patch/pylint.rc
++++ b/cgcs-patch/cgcs-patch/pylint.rc
+@@ -44,8 +44,16 @@ symbols=no
+ # --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=
+-disable=C, R, W0603, W0613, W0702, W0703, W1201
++# E1111 assignment-from-no-return
++# W0107 unnecessary-pass
++# W0603 global-statement
++# W0612 unused-variable
++# W0613 unused-argument
++# W0703 broad-except
++# W0705 duplicate-except
++# W1201 logging-not-lazy
++# W1505, deprecated-method
++disable=C, R, E1111, W0107, W0603, W0612, W0613, W0703, W0705, W1201, W1505
+ [REPORTS]
+@@ -61,7 +69,7 @@ output-format=text
+ files-output=no
+ # Tells whether to display a full report or only the messages
+-reports=yes
++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
+diff --git a/cgcs-patch/cgcs-patch/pylint_make_patch.rc b/cgcs-patch/cgcs-patch/pylint_make_patch.rc
+new file mode 100644
+index 0000000..ef4e838
+--- /dev/null
++++ b/cgcs-patch/cgcs-patch/pylint_make_patch.rc
+@@ -0,0 +1,352 @@
++[MASTER]
++
++# 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
++
++# 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=
++
++# DEPRECATED
++include-ids=no
++
++# DEPRECATED
++symbols=no
++
++
++[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. 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"
++# The following are suppressed due to pylint warnings in cgcs_make_patch
++# fixme Use of fixme, todo, etc..
++# E1101 no-member
++# W0101 unreachable
++# W0104 pointless-statement
++# W0107 unnecessary-pass
++# W0212 protected-access
++# W0231 super-init-not-called
++# W0603 global-statement
++# W0612 unused-variable
++# W0613 unused-argument
++# W0622 redefined-builtin
++# W0703 broad-except
++# W1401 anomalous-backslash-in-string
++# W1505, deprecated-method
++disable=C, R, fixme, E1101,
++        W0101, W0104, W0107, W0212, W0231, W0603, W0612, W0613, W0622, W0703,
++        W1401, W1505
++
++[REPORTS]
++
++# 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=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)
++
++# Add a comment according to your evaluation note. This is used by the global
++# evaluation report (RP0004).
++comment=no
++
++# 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=
++
++
++[BASIC]
++
++# Required attributes for module, separated by a comma
++required-attributes=
++
++# List of builtins function names that should not be used, separated by a comma
++bad-functions=map,filter,apply,input,file
++
++# 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
++
++# 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 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}$
++
++# 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 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 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 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 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 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 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 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 which should only match function or class names that do
++# not require a docstring.
++no-docstring-rgx=__.*__
++
++# Minimum line length for functions/classes that require docstrings, shorter
++# ones are exempt.
++docstring-min-length=-1
++
++
++[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.
++ignore-long-lines=^\s*(# )?<?https?://\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=no
++
++# List of optional constructs for which whitespace checking is disabled
++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
++
++
++[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=4
++
++# Ignore comments when computing similarities.
++ignore-comments=yes
++
++# Ignore docstrings when computing similarities.
++ignore-docstrings=yes
++
++# Ignore imports when computing similarities.
++ignore-imports=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
++ignored-modules=
++
++# List of classes names for which member attributes should not be checked
++# (useful for classes with attributes dynamically set).
++ignored-classes=rpm,PKCS1_PSS
++
++# When zope mode is activated, add a predefined set of Zope acquired attributes
++# to generated-members.
++zope=no
++
++# 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
++
++
++[VARIABLES]
++
++# Tells whether we should check for unused import in __init__ files.
++init-import=no
++
++# A regular expression matching the name of dummy variables (i.e. expectedly
++# 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=
++
++
++[CLASSES]
++
++# 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 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
++
++
++[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
++
++
++[IMPORTS]
++
++# Deprecated modules which should not be used, separated by a comma
++deprecated-modules=regsub,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=
++
++
++[EXCEPTIONS]
++
++# Exceptions that will emit a warning when being caught. Defaults to
++# "Exception"
++overgeneral-exceptions=Exception
+diff --git a/cgcs-patch/cgcs-patch/tox.ini b/cgcs-patch/cgcs-patch/tox.ini
+index ba9c568..88e5723 100644
+--- a/cgcs-patch/cgcs-patch/tox.ini
++++ b/cgcs-patch/cgcs-patch/tox.ini
+@@ -76,7 +76,6 @@ exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,release-tag-*
+ enable-extensions = H106 H203 H904
+ max-line-length = 120
+-
+ [testenv:flake8]
+ basepython = python3
+ usedevelop = False
+@@ -85,13 +84,12 @@ commands =
+     flake8 {posargs} .
+ [testenv:pylint]
++basepython = python3
+ deps = {[testenv]deps}
+        pylint
+-
+-basepython = python2.7
+ sitepackages = False
+-
+ commands = pylint cgcs_patch --rcfile=./pylint.rc
++           pylint cgcs_make_patch --rcfile=./pylint_make_patch.rc
+ [testenv:cover]
+ setenv =