summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/docker-publish.yml2
-rw-r--r--.github/workflows/meson-test.yml2
-rw-r--r--.github/workflows/pylint.yml8
-rw-r--r--Dockerfile2
-rw-r--r--NEWS.md6
-rw-r--r--doc/stafd.conf.xml2
-rw-r--r--etc/stas/stacd.conf2
-rw-r--r--etc/stas/sys.conf.doc6
-rw-r--r--meson.build3
-rwxr-xr-xstacd.py6
-rwxr-xr-xstafd.py10
-rw-r--r--staslib/avahi.py2
-rw-r--r--staslib/conf.py2
-rw-r--r--staslib/ctrl.py4
-rw-r--r--staslib/gutil.py2
-rw-r--r--staslib/iputil.py20
-rw-r--r--staslib/meson.build11
-rw-r--r--staslib/service.py2
-rw-r--r--staslib/stas.py6
-rw-r--r--test/meson.build8
-rw-r--r--test/pylint.rc804
-rwxr-xr-xtest/test-config.py6
-rwxr-xr-xtest/test-defs.py17
-rwxr-xr-xtest/test-udev.py2
24 files changed, 548 insertions, 387 deletions
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
index 3e183c0..d04aacd 100644
--- a/.github/workflows/docker-publish.yml
+++ b/.github/workflows/docker-publish.yml
@@ -55,7 +55,7 @@ jobs:
# Build and push Docker image with Buildx (don't push on PR)
# https://github.com/docker/build-push-action
- name: Build and push Docker image
- uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09
+ uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
diff --git a/.github/workflows/meson-test.yml b/.github/workflows/meson-test.yml
index 4b9662d..18db019 100644
--- a/.github/workflows/meson-test.yml
+++ b/.github/workflows/meson-test.yml
@@ -26,7 +26,7 @@ jobs:
run: |
sudo apt-get install --yes --quiet docbook-xml docbook-xsl xsltproc libglib2.0-dev libgirepository1.0-dev libsystemd-dev
sudo apt-get install --yes --quiet python3-systemd python3-pyudev python3-lxml
- python3 -m pip install --upgrade dasbus pylint pyflakes PyGObject
+ python3 -m pip install --upgrade dasbus pylint==2.17.7 pyflakes PyGObject
python3 -m pip install --upgrade vermin pyfakefs importlib-resources
- name: "INSTALL: libnvme dependencies"
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
index 9af1819..4ca014b 100644
--- a/.github/workflows/pylint.yml
+++ b/.github/workflows/pylint.yml
@@ -12,7 +12,7 @@ jobs:
docker-lint:
if: ${{ !github.event.act }} # skip during local actions testing
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: hadolint/hadolint-action@v3.1.0
@@ -21,12 +21,12 @@ jobs:
ignore: DL3041
python-lint:
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
- python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+ python-version: ["3.7", "3.8", "3.9", "3.10"]
steps:
- name: "CHECKOUT: nvme-stas"
@@ -42,7 +42,7 @@ jobs:
sudo apt update
sudo apt-get install --yes --quiet python3-pip cmake libgirepository1.0-dev libsystemd-dev python3-systemd swig libjson-c-dev || true
sudo python3 -m pip install --upgrade pip wheel meson ninja
- python3 -m pip install --upgrade dasbus pylint pyflakes PyGObject lxml pyudev
+ python3 -m pip install --upgrade dasbus pylint==2.17.7 pyflakes PyGObject lxml pyudev
- name: "BUILD: [libnvme, nvme-stas]"
uses: BSFishy/meson-build@v1.0.3
diff --git a/Dockerfile b/Dockerfile
index 040a655..e1d7b43 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,4 +1,4 @@
-FROM fedora:38
+FROM fedora:39
WORKDIR /root
diff --git a/NEWS.md b/NEWS.md
index 079a276..6b08878 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,5 +1,11 @@
# STorage Appliance Services (STAS)
+## Changes with release 2.3.1
+
+Bug fix:
+
+* Properly handle big-endian data in `iputils.py`. This fix ensures that `struct.[pack|unpack]` is invoked with the CPU's native endianness. This fix is required for nvme-stas to work properly on big-endian CPUs (little-endian CPUs are not affected).
+
## Changes with release 2.3
New features:
diff --git a/doc/stafd.conf.xml b/doc/stafd.conf.xml
index da0b842..d9c80b6 100644
--- a/doc/stafd.conf.xml
+++ b/doc/stafd.conf.xml
@@ -188,7 +188,7 @@
DNS-SD/mDNS.
</para>
<para>
- Discovery Controllers that support zeroconf advertize
+ Discovery Controllers that support zeroconf advertise
themselves over mDNS with the service type
<literal>_nvme-disc._tcp</literal>.
</para>
diff --git a/etc/stas/stacd.conf b/etc/stas/stacd.conf
index 4ae6d97..9fbc1c3 100644
--- a/etc/stas/stacd.conf
+++ b/etc/stas/stacd.conf
@@ -165,7 +165,7 @@
# before giving up. This value should never be
# set to 1. A value of 1 will automatically be
# increased to 2. That's because a single
-# failure may be normal and a mimimum of 2
+# failure may be normal and a minimum of 2
# attempts is required to conclude that a
# connection is not possible.
# Default: 0
diff --git a/etc/stas/sys.conf.doc b/etc/stas/sys.conf.doc
index 5850028..aa69f9b 100644
--- a/etc/stas/sys.conf.doc
+++ b/etc/stas/sys.conf.doc
@@ -16,7 +16,7 @@
# indicates that the Host NQN can be retrieved from a separate file.
# Typically, nvme-cli saves the Host NQN in /etc/nvme/hostnqn. For
# compatibility with nvme-cli, nvme-stas defaults to looking for the
-# existance of this file and will read the NQN from it. Otherwise, you
+# existence of this file and will read the NQN from it. Otherwise, you
# can overwrite the default NQN by specifying its value here or
# specifying another file that contains the Host NQN to use.
# Type: string
@@ -28,7 +28,7 @@
# indicates that the Host ID can be retrieved from a separate file.
# Typically, nvme-cli saves the Host ID in /etc/nvme/hostid. For
# compatibility with nvme-cli, nvme-stas defaults to looking for the
-# existance of this file and will read the ID from it. Otherwise, you
+# existence of this file and will read the ID from it. Otherwise, you
# can overwrite the default ID by specifying its value here or
# specifying another file that contains the Host ID to use.
# Type: string
@@ -41,7 +41,7 @@
# A value starting with "file://" indicates that the Host Key can
# be retrieved from a separate file. Typically, nvme-cli saves the
# Host Key in /etc/nvme/hostkey. For compatibility with nvme-cli,
-# nvme-stas defaults to looking for the existance of this file and
+# nvme-stas defaults to looking for the existence of this file and
# will read the Key from it. Otherwise, you can overwrite the default
# Key by specifying its value here or specifying another file that
# contains an alternate Host Key to use.
diff --git a/meson.build b/meson.build
index b648a86..5b42856 100644
--- a/meson.build
+++ b/meson.build
@@ -9,7 +9,7 @@
project(
'nvme-stas',
meson_version: '>= 0.53.0',
- version: '2.3',
+ version: '2.3.1',
license: 'Apache-2.0',
default_options: [
'buildtype=release',
@@ -133,6 +133,7 @@ endforeach
#===========================================================================
# Make a list of modules to lint
modules_to_lint = [stafd, stafctl, stacd, stacctl, stasadm]
+packages_to_lint = []
# Point Python Path to Current Build Dir.
diff --git a/stacd.py b/stacd.py
index b13904a..60bcab2 100755
--- a/stacd.py
+++ b/stacd.py
@@ -69,7 +69,7 @@ if __name__ == '__main__':
return STAC.tron
@tron.setter
- def tron(self, value): # pylint: disable=no-self-use
+ def tron(self, value):
'''@brief Set Trace ON property'''
STAC.tron = value
@@ -89,14 +89,14 @@ if __name__ == '__main__':
info.update(STAC.info())
return json.dumps(info)
- def controller_info( # pylint: disable=too-many-arguments,no-self-use
+ def controller_info( # pylint: disable=too-many-arguments
self, transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn
) -> str:
'''@brief D-Bus method used to return information about a controller'''
controller = STAC.get_controller(transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn)
return json.dumps(controller.info()) if controller else '{}'
- def list_controllers(self, detailed) -> list: # pylint: disable=no-self-use
+ def list_controllers(self, detailed) -> list:
'''@brief Return the list of I/O controller IDs'''
return [
controller.details() if detailed else controller.controller_id_dict()
diff --git a/stafd.py b/stafd.py
index 0777405..6701499 100755
--- a/stafd.py
+++ b/stafd.py
@@ -88,7 +88,7 @@ if __name__ == '__main__':
return STAF.tron
@tron.setter
- def tron(self, value): # pylint: disable=no-self-use
+ def tron(self, value):
'''@brief Set Trace ON property'''
STAF.tron = value
@@ -108,21 +108,21 @@ if __name__ == '__main__':
info.update(STAF.info())
return json.dumps(info)
- def controller_info( # pylint: disable=no-self-use,too-many-arguments
+ def controller_info( # pylint: disable=too-many-arguments
self, transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn
) -> str:
'''@brief D-Bus method used to return information about a controller'''
controller = STAF.get_controller(transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn)
return json.dumps(controller.info()) if controller else '{}'
- def get_log_pages( # pylint: disable=no-self-use,too-many-arguments
+ def get_log_pages( # pylint: disable=too-many-arguments
self, transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn
) -> list:
'''@brief D-Bus method used to retrieve the discovery log pages from one controller'''
controller = STAF.get_controller(transport, traddr, trsvcid, subsysnqn, host_traddr, host_iface, host_nqn)
return controller.log_pages() if controller else list()
- def get_all_log_pages(self, detailed) -> str: # pylint: disable=no-self-use
+ def get_all_log_pages(self, detailed) -> str:
'''@brief D-Bus method used to retrieve the discovery log pages from all controllers'''
log_pages = list()
for controller in STAF.get_controllers():
@@ -134,7 +134,7 @@ if __name__ == '__main__':
)
return json.dumps(log_pages)
- def list_controllers(self, detailed) -> list: # pylint: disable=no-self-use
+ def list_controllers(self, detailed) -> list:
'''@brief Return the list of discovery controller IDs'''
return [
controller.details() if detailed else controller.controller_id_dict()
diff --git a/staslib/avahi.py b/staslib/avahi.py
index f91e489..cd4d1f9 100644
--- a/staslib/avahi.py
+++ b/staslib/avahi.py
@@ -580,7 +580,7 @@ class Avahi: # pylint: disable=too-many-instance-attributes
self._check_for_duplicate_ips()
- def _failure_handler( # pylint: disable=no-self-use
+ def _failure_handler(
self,
_connection,
_sender_name: str,
diff --git a/staslib/conf.py b/staslib/conf.py
index 4497698..4dd411c 100644
--- a/staslib/conf.py
+++ b/staslib/conf.py
@@ -659,7 +659,7 @@ class NvmeOptions(metaclass=singleton.Singleton):
'dhchap_ctrl_secret': defs.KERNEL_VERSION >= defs.KERNEL_CTRLKEY_MIN_VERSION,
}
- # If some of the options are False, we need to check wether they can be
+ # If some of the options are False, we need to check whether they can be
# read from '/dev/nvme-fabrics'. This method allows us to determine that
# an older kernel actually supports a specific option because it was
# backported to that kernel.
diff --git a/staslib/ctrl.py b/staslib/ctrl.py
index 9f415b3..e4cda6b 100644
--- a/staslib/ctrl.py
+++ b/staslib/ctrl.py
@@ -425,7 +425,7 @@ class Dc(Controller):
@property
def origin(self):
- '''@brief Return how this controller came into existance. Was it
+ '''@brief Return how this controller came into existence. Was it
"discovered" through mDNS service discovery (TP8009), was it manually
"configured" in stafd.conf, or was it a "referral".
'''
@@ -853,6 +853,6 @@ class Ioc(Controller):
self._try_to_connect_deferred.schedule()
def _should_try_to_reconnect(self):
- '''@brief This is used to determine when it's time to stop trying toi connect'''
+ '''@brief This is used to determine when it's time to stop trying to connect'''
max_connect_attempts = conf.SvcConf().connect_attempts_on_ncc if self.ncc else 0
return max_connect_attempts == 0 or self._connect_attempts < max_connect_attempts
diff --git a/staslib/gutil.py b/staslib/gutil.py
index 7bdc117..4cdc087 100644
--- a/staslib/gutil.py
+++ b/staslib/gutil.py
@@ -250,7 +250,7 @@ class _TaskRunner(GObject.Object):
task.run_in_thread(in_thread_exec)
return task
- def communicate_finish(self, result): # pylint: disable=no-self-use
+ def communicate_finish(self, result):
'''@brief Use this function in your callback (see @cb_function) to
extract data from the result object.
diff --git a/staslib/iputil.py b/staslib/iputil.py
index d5e93dd..910ae65 100644
--- a/staslib/iputil.py
+++ b/staslib/iputil.py
@@ -42,7 +42,7 @@ def _nlmsghdr(nlmsg_type, nlmsg_flags, nlmsg_seq, nlmsg_pid, msg_len: int):
__u32 nlmsg_pid; /* Sending process port ID */
};
'''
- return struct.pack('<LHHLL', NLMSG_LENGTH(msg_len), nlmsg_type, nlmsg_flags, nlmsg_seq, nlmsg_pid)
+ return struct.pack('=LHHLL', NLMSG_LENGTH(msg_len), nlmsg_type, nlmsg_flags, nlmsg_seq, nlmsg_pid)
def _ifaddrmsg(family=0, prefixlen=0, flags=0, scope=0, index=0):
@@ -55,7 +55,7 @@ def _ifaddrmsg(family=0, prefixlen=0, flags=0, scope=0, index=0):
__u32 ifa_index; /* Link index */
};
'''
- return struct.pack('<BBBBL', family, prefixlen, flags, scope, index)
+ return struct.pack('=BBBBL', family, prefixlen, flags, scope, index)
def _ifinfomsg(family=0, dev_type=0, index=0, flags=0, change=0):
@@ -69,7 +69,7 @@ def _ifinfomsg(family=0, dev_type=0, index=0, flags=0, change=0):
unsigned int ifi_change; /* change mask: IFF_* */
};
'''
- return struct.pack('<BBHiII', family, 0, dev_type, index, flags, change)
+ return struct.pack('=BBHiII', family, 0, dev_type, index, flags, change)
def _nlmsg(nlmsg_type, nlmsg_flags, msg: bytes):
@@ -102,7 +102,7 @@ def mac2iface(mac: str): # pylint: disable=too-many-locals
nlmsg += sock.recv(8192)
nlmsghdr = nlmsg[nlmsg_idx : nlmsg_idx + NLMSG_HDRLEN]
- nlmsg_len, nlmsg_type, _, _, _ = struct.unpack('<LHHLL', nlmsghdr)
+ nlmsg_len, nlmsg_type, _, _, _ = struct.unpack('=LHHLL', nlmsghdr)
if nlmsg_type == NLMSG_DONE:
break
@@ -110,13 +110,13 @@ def mac2iface(mac: str): # pylint: disable=too-many-locals
if nlmsg_type == RTM_BASE:
msg_indx = nlmsg_idx + NLMSG_HDRLEN
msg = nlmsg[msg_indx : msg_indx + IFINFOMSG_SZ] # ifinfomsg
- _, _, ifi_type, ifi_index, _, _ = struct.unpack('<BBHiII', msg)
+ _, _, ifi_type, ifi_index, _, _ = struct.unpack('=BBHiII', msg)
if ifi_type in (ARPHRD_LOOPBACK, ARPHRD_ETHER):
rtattr_indx = msg_indx + IFINFOMSG_SZ
while rtattr_indx < (nlmsg_idx + nlmsg_len):
rtattr = nlmsg[rtattr_indx : rtattr_indx + RTATTR_SZ]
- rta_len, rta_type = struct.unpack('<HH', rtattr)
+ rta_len, rta_type = struct.unpack('=HH', rtattr)
if rta_type == IFLA_ADDRESS:
data = nlmsg[rtattr_indx + RTATTR_SZ : rtattr_indx + rta_len]
if _data_matches_mac(data, mac):
@@ -132,7 +132,7 @@ def mac2iface(mac: str): # pylint: disable=too-many-locals
# ******************************************************************************
def ip_equal(ip1, ip2):
- '''Check whther two IP addresses are equal.
+ '''Check whether two IP addresses are equal.
@param ip1: IPv4Address or IPv6Address object
@param ip2: IPv4Address or IPv6Address object
'''
@@ -206,7 +206,7 @@ def net_if_addrs(): # pylint: disable=too-many-locals
nlmsg += sock.recv(8192)
nlmsghdr = nlmsg[nlmsg_idx : nlmsg_idx + NLMSG_HDRLEN]
- nlmsg_len, nlmsg_type, _, _, _ = struct.unpack('<LHHLL', nlmsghdr)
+ nlmsg_len, nlmsg_type, _, _, _ = struct.unpack('=LHHLL', nlmsghdr)
if nlmsg_type == NLMSG_DONE:
break
@@ -214,7 +214,7 @@ def net_if_addrs(): # pylint: disable=too-many-locals
if nlmsg_type == RTM_NEWADDR:
msg_indx = nlmsg_idx + NLMSG_HDRLEN
msg = nlmsg[msg_indx : msg_indx + IFADDRMSG_SZ] # ifaddrmsg
- ifa_family, _, _, _, ifa_index = struct.unpack('<BBBBL', msg)
+ ifa_family, _, _, _, ifa_index = struct.unpack('=BBBBL', msg)
if ifa_family in (socket.AF_INET, socket.AF_INET6):
interfaces.setdefault(ifa_index, {4: [], 6: []})
@@ -222,7 +222,7 @@ def net_if_addrs(): # pylint: disable=too-many-locals
rtattr_indx = msg_indx + IFADDRMSG_SZ
while rtattr_indx < (nlmsg_idx + nlmsg_len):
rtattr = nlmsg[rtattr_indx : rtattr_indx + RTATTR_SZ]
- rta_len, rta_type = struct.unpack('<HH', rtattr)
+ rta_len, rta_type = struct.unpack('=HH', rtattr)
if rta_type == IFLA_IFNAME:
data = nlmsg[rtattr_indx + RTATTR_SZ : rtattr_indx + rta_len]
diff --git a/staslib/meson.build b/staslib/meson.build
index 1658d3c..1642e0f 100644
--- a/staslib/meson.build
+++ b/staslib/meson.build
@@ -49,13 +49,4 @@ python3.install_sources(
subdir: 'staslib',
)
-#===============================================================================
-# Make a list of modules to lint
-skip = ['stafd.idl', 'stacd.idl']
-foreach file: files_to_install
- fname = fs.name('@0@'.format(file))
- if fname not in skip
- modules_to_lint += file
- endif
-endforeach
-
+packages_to_lint += meson.current_build_dir()
diff --git a/staslib/service.py b/staslib/service.py
index 08a775a..19acec3 100644
--- a/staslib/service.py
+++ b/staslib/service.py
@@ -725,7 +725,7 @@ class Staf(Service):
'''@brief Finish discovery controllers configuration after
hostnames (if any) have been resolved. All the logic associated
with discovery controller creation/deletion is found here. To
- avoid calling this algorith repetitively for each and every events,
+ avoid calling this algorithm repetitively for each and every events,
it is called after a soaking period controlled by self._cfg_soak_tmr.
@param configured_ctrl_list: List of TIDs configured in stafd.conf with
diff --git a/staslib/stas.py b/staslib/stas.py
index 47ce5de..b2cb53e 100644
--- a/staslib/stas.py
+++ b/staslib/stas.py
@@ -29,7 +29,7 @@ except ImportError:
# Pre Python 3.9 backport of importlib.resources (if installed)
from importlib_resources import files
except ImportError:
- # Less efficient, but avalable on older versions of Python
+ # Less efficient, but available on older versions of Python
import pkg_resources
def load_idl(idl_fname):
@@ -248,7 +248,7 @@ class ControllerABC(abc.ABC):
self._try_to_connect_deferred.schedule()
return GLib.SOURCE_REMOVE
- def _should_try_to_reconnect(self): # pylint: disable=no-self-use
+ def _should_try_to_reconnect(self):
return True
def _try_to_connect(self):
@@ -537,7 +537,7 @@ class ServiceABC(abc.ABC): # pylint: disable=too-many-instance-attributes
# controllers with traddr specified as hostname instead of IP address.
# Because of this, we need to remove those excluded elements before
# running name resolution. And we will need to remove excluded
- # elements after name resolution is complete (i.e. in the calback
+ # elements after name resolution is complete (i.e. in the callback
# function _config_ctrls_finish)
logging.debug('ServiceABC._config_ctrls()')
configured_controllers = [
diff --git a/test/meson.build b/test/meson.build
index 086a3e8..ef31c63 100644
--- a/test/meson.build
+++ b/test/meson.build
@@ -46,6 +46,12 @@ if libnvme_location == '?'
else
#---------------------------------------------------------------------------
# pylint and pyflakes
+
+ # There's a bug with pylint 3.X. Tests should be run with pylint
+ # 2.17.7 (or less), which can be installed with:
+ # python3 -m pip install --upgrade pylint==2.17.7
+
+
if modules_to_lint.length() != 0
pylint = find_program('pylint', required: false)
pyflakes = find_program('pyflakes3', required: false)
@@ -59,7 +65,7 @@ else
rcfile = srce_dir / 'pylint.rc'
if pylint.found()
- test('pylint', pylint, args: ['--rcfile=' + rcfile] + modules_to_lint, env: test_env)
+ test('pylint', pylint, args: ['--rcfile=' + rcfile] + modules_to_lint + packages_to_lint, env: test_env)
else
warning('Skiping some of the tests because "pylint" is missing.')
endif
diff --git a/test/pylint.rc b/test/pylint.rc
index ce56f98..5f360a1 100644
--- a/test/pylint.rc
+++ b/test/pylint.rc
@@ -5,274 +5,334 @@
# This file is part of NVMe STorage Appliance Services (nvme-stas).
#
# Authors: Martin Belanger <Martin.Belanger@dell.com>
-[MASTER]
+[MAIN]
+
+# 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
+
+# Clear in-memory caches upon conclusion of linting. Useful if running pylint
+# in a server-like mode.
+clear-cache-post-run=no
+
+# Load and enable all available extensions. Use --list-extensions to see a list
+# all available extensions.
+#enable-all-extensions=
+
+# In error mode, messages with a category besides ERROR or FATAL are
+# suppressed, and no reports are done by default. Error mode is compatible with
+# disabling specific errors.
+#errors-only=
+
+# Always return a 0 (non-error) status code, even if lint errors are found.
+# This is primarily useful in continuous integration scripts.
+#exit-zero=
+
+# 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-allow-list=
# 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
+# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
+# for backward compatibility.)
extension-pkg-whitelist=
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
+# Return non-zero exit code if any of these messages/categories are detected,
+# even if score is above --fail-under value. Syntax same as enable. Messages
+# specified are enabled, while categories only check already-enabled messages.
+fail-on=
+
+# Specify a score threshold under which the program will exit with error.
+fail-under=10
+
+# Interpret the stdin as a python script, whose filename needs to be passed as
+# the module_or_package argument.
+#from-stdin=
+
+# Files or directories to be skipped. They should be base names, not paths.
ignore=CVS
-# Add files or directories matching the regex patterns to the blacklist. The
-# regex matches against base names, not paths.
+# Add files or directories matching the regular expressions patterns to the
+# ignore-list. The regex matches against paths and can be in Posix or Windows
+# format. Because '\\' represents the directory delimiter on Windows systems,
+# it can't be used as an escape character.
+ignore-paths=
+
+# Files or directories matching the regular expression patterns are skipped.
+# The regex matches against base names, not paths. The default value ignores
+# Emacs file locks
ignore-patterns=
+# 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=
+
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
-# Use multiple processes to speed up Pylint.
-jobs=1
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use, and will cap the count on Windows to
+# avoid hangs.
+jobs=0
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
-# List of plugins (as comma separated values of python modules names) to load,
+# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=
# Pickle collected data for later comparisons.
persistent=yes
-# Specify a configuration file.
-#rcfile=
+# Minimum Python version to use for version dependent checks. Will default to
+# the version used to run pylint.
+py-version=3.10
+
+# Discover python modules and packages in the file system subtree.
+recursive=no
+
+# Add paths to the list of the source roots. Supports globbing patterns. The
+# source root is an absolute path or a path relative to the current working
+# directory used to determine a package namespace for modules located under the
+# source root.
+source-roots=
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
+# In verbose mode, extra non-checker-related info will be displayed.
+#verbose=
-[MESSAGES CONTROL]
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
+[BASIC]
-# 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=print-statement,
- parameter-unpacking,
- unpacking-in-except,
- old-raise-syntax,
- backtick,
- long-suffix,
- old-ne-operator,
- old-octal-literal,
- import-star-module-level,
- raw-checker-failed,
- bad-inline-option,
- locally-disabled,
- locally-enabled,
- file-ignored,
- suppressed-message,
- useless-suppression,
- deprecated-pragma,
- apply-builtin,
- basestring-builtin,
- buffer-builtin,
- cmp-builtin,
- coerce-builtin,
- execfile-builtin,
- file-builtin,
- long-builtin,
- raw_input-builtin,
- reduce-builtin,
- standarderror-builtin,
- unicode-builtin,
- xrange-builtin,
- coerce-method,
- delslice-method,
- getslice-method,
- setslice-method,
- no-absolute-import,
- old-division,
- dict-iter-method,
- dict-view-method,
- next-method-called,
- metaclass-assignment,
- indexing-exception,
- raising-string,
- reload-builtin,
- oct-method,
- hex-method,
- nonzero-method,
- cmp-method,
- input-builtin,
- round-builtin,
- intern-builtin,
- unichr-builtin,
- map-builtin-not-iterating,
- zip-builtin-not-iterating,
- range-builtin-not-iterating,
- filter-builtin-not-iterating,
- using-cmp-argument,
- eq-without-hash,
- div-method,
- idiv-method,
- rdiv-method,
- exception-message-attribute,
- invalid-str-codec,
- sys-max-int,
- bad-python3-import,
- deprecated-string-function,
- deprecated-str-translate-call,
- use-list-literal,
- use-dict-literal,
- bad-option-value,
- R0801,
+# Naming style matching correct argument names.
+argument-naming-style=snake_case
-# 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=
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style. If left empty, argument names will be checked with the set
+# naming style.
+argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
-[REPORTS]
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style. If left empty, attribute names will be checked with the set naming
+# style.
+attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-# 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)
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+ bar,
+ baz,
+ toto,
+ tutu,
+ tata
-# 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=
+# Bad variable names regexes, separated by a comma. If names match any regex,
+# they will always be refused
+bad-names-rgxs=
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
-# Tells whether to display a full report or only the messages
-reports=no
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style. If left empty, class attribute names will be checked
+# with the set naming style.
+class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-# Activate the evaluation score.
-score=yes
+# Naming style matching correct class constant names.
+class-const-naming-style=UPPER_CASE
+# Regular expression matching correct class constant names. Overrides class-
+# const-naming-style. If left empty, class constant names will be checked with
+# the set naming style.
+#class-const-rgx=
-[REFACTORING]
+# Naming style matching correct class names.
+class-naming-style=PascalCase
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
+# Regular expression matching correct class names. Overrides class-naming-
+# style. If left empty, class names will be checked with the set naming style.
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
-[TYPECHECK]
+# Regular expression matching correct constant names. Overrides const-naming-
+# style. If left empty, constant names will be checked with the set naming
+# style.
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-# 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
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
-# 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=
+# Naming style matching correct function names.
+function-naming-style=snake_case
-# 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
+# Regular expression matching correct function names. Overrides function-
+# naming-style. If left empty, function names will be checked with the set
+# naming style.
+function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
+# Good variable names which should always be accepted, separated by a comma.
+good-names=i,
+ j,
+ k,
+ ex,
+ Run,
+ _,
+ op,
+ ls,
+ f,
+ ip,
+ id,
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs=
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
-# 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
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
-# 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=
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style. If left empty, inline iteration names will be checked
+# with the set naming style.
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
+# Naming style matching correct method names.
+method-naming-style=snake_case
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
+# Regular expression matching correct method names. Overrides method-naming-
+# style. If left empty, method names will be checked with the set naming style.
+method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
+# Naming style matching correct module names.
+module-naming-style=snake_case
+# Regular expression matching correct module names. Overrides module-naming-
+# style. If left empty, module names will be checked with the set naming style.
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-[SPELLING]
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
+# Regular expression matching correct type alias names. If left empty, type
+# alias names will be checked with the set naming style.
+#typealias-rgx=
-# 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
+# Regular expression matching correct type variable names. If left empty, type
+# variable names will be checked with the set naming style.
+#typevar-rgx=
+# Naming style matching correct variable names.
+variable-naming-style=snake_case
-[VARIABLES]
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style. If left empty, variable names will be checked with the set
+# naming style.
+variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
+[CLASSES]
-# 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
+# Warn about protected attribute access inside special methods
+check-protected-access-in-special-methods=no
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+ __new__,
+ setUp
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+ _fields,
+ _replace,
+ _source,
+ _make
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
-[SIMILARITIES]
+[DESIGN]
-# Ignore comments when computing similarities.
-ignore-comments=yes
+# List of regular expressions of class ancestor names to ignore when counting
+# public methods (see R0903)
+exclude-too-few-public-methods=
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
+# List of qualified class names to ignore when counting class parents (see
+# R0901)
+ignored-parents=
-# Ignore imports when computing similarities.
-ignore-imports=no
+# Maximum number of arguments for function / method.
+max-args=5
-# Minimum lines number of a similarity.
-min-similarity-lines=4
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement (see R0916).
+max-bool-expr=5
+
+# 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 caught.
+overgeneral-exceptions=builtins.Exception
[FORMAT]
@@ -283,7 +343,7 @@ expected-line-ending-format=
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-# Number of spaces of indent required inside a hanging or continued line.
+# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
@@ -293,15 +353,9 @@ indent-string=' '
# Maximum number of characters on a single line.
max-line-length=200
-# Maximum number of lines in a module
+# Maximum number of lines in a module.
max-module-lines=2000
-# 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
-
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
@@ -310,191 +364,289 @@ single-line-class-stmt=no
# else.
single-line-if-stmt=no
-[MISCELLANEOUS]
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+[IMPORTS]
+
+# List of modules that can be imported at any level, not just the top level
+# one.
+allow-any-import-level=
+
+# Allow explicit reexports by alias from a package __init__.
+allow-reexport-from-package=no
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=regsub,
+ TERMIOS,
+ Bastion,
+ rexec
+
+# Output a graph (.gv or any supported image format) of external dependencies
+# to the given file (report RP0402 must not be disabled).
+ext-import-graph=
+
+# Output a graph (.gv or any supported image format) of all (i.e. internal and
+# external) dependencies to the given file (report RP0402 must not be
+# disabled).
+import-graph=
+
+# Output a graph (.gv or any supported image format) of internal dependencies
+# to 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
+
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
[LOGGING]
+# The type of string formatting that logging methods do. `old` means using %
+# formatting, `new` is for `{}` formatting.
+logging-format-style=old
+
# Logging modules to check that the string format arguments are in logging
-# function parameter format
+# function parameter format.
logging-modules=logging
-[BASIC]
+[MESSAGES CONTROL]
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
+# UNDEFINED.
+confidence=HIGH,
+ CONTROL_FLOW,
+ INFERENCE,
+ INFERENCE_FAILURE,
+ UNDEFINED
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# 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 re-enable 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=raw-checker-failed,
+ bad-inline-option,
+ locally-disabled,
+ file-ignored,
+ suppressed-message,
+ useless-suppression,
+ deprecated-pragma,
+ use-symbolic-message-instead,
+ useless-option-value,
+ use-list-literal,
+ use-dict-literal,
+ R0801,
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# 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=c-extension-no-member
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
+[METHOD_ARGS]
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+# List of qualified names (i.e., library.method) which require a timeout
+# parameter e.g. 'requests.api.get,requests.api.post'
+timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-# Naming hint for class names
-class-name-hint=[A-Z_][a-zA-Z0-9]+$
+[MISCELLANEOUS]
-# Regular expression matching correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+ XXX,
+ TODO
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
+# Regular expression of note tags to take in consideration.
+notes-rgx=
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
+[REFACTORING]
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit,argparse.parse_error
-# Good variable names which should always be accepted, separated by a comma
-good-names=i,j,k,ex,Run,_,op,ls,f,ip,id
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
+[REPORTS]
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'fatal', 'error', 'warning', 'refactor',
+# 'convention', and 'info' which contain the number of messages in each
+# category, as well as 'statement' which is the total number of statements
+# analyzed. This score is used by the global evaluation report (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+# 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=
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+#output-format=
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Tells whether to display a full report or only the messages.
+reports=no
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+# Activate the evaluation score.
+score=yes
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
+[SIMILARITIES]
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
+# Comments are removed from the similarity computation
+ignore-comments=yes
-# 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
+# Docstrings are removed from the similarity computation
+ignore-docstrings=yes
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Imports are removed from the similarity computation
+ignore-imports=no
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
+# Signatures are removed from the similarity computation
+ignore-signatures=yes
+# Minimum lines number of a similarity.
+min-similarity-lines=4
-[DESIGN]
-# Maximum number of arguments for function / method
-max-args=5
+[SPELLING]
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
+# Spelling dictionary name. No available dictionaries : You need to install
+# both the python package and the system dependency for enchant to work.
+spelling-dict=
-# Maximum number of branch for function / method body
-max-branches=12
+# List of comma separated words that should be considered directives if they
+# appear at the beginning of a comment and should not be checked.
+spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
-# Maximum number of locals for function / method body
-max-locals=15
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
-# Maximum number of parents for a class (see R0901).
-max-parents=7
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
-# Maximum number of return / yield for function / method body
-max-returns=6
-# Maximum number of statements in function / method body
-max-statements=50
+[STRING]
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=no
+# This flag controls whether the implicit-str-concat should generate a warning
+# on implicit string concatenation in sequences defined over several lines.
+check-str-concat-over-line-jumps=no
-[CLASSES]
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
+[TYPECHECK]
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
+# 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
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
+# 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=
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
-[IMPORTS]
+# List of symbolic message names to ignore for Mixin members.
+ignored-checks-for-mixins=no-member,
+ not-async-context-manager,
+ not-context-manager,
+ attribute-defined-outside-init
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
+# 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
-# 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
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,TERMIOS,Bastion,rexec
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
+# Regex pattern to define which classes are considered mixins.
+mixin-class-rgx=.*[Mm]ixin
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
-# 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
+[VARIABLES]
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
-[EXCEPTIONS]
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of names allowed to shadow builtins
+allowed-redefined-builtins=
+
+# 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
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,future.builtins
diff --git a/test/test-config.py b/test/test-config.py
index 1ecae93..ed5b02e 100755
--- a/test/test-config.py
+++ b/test/test-config.py
@@ -194,9 +194,9 @@ class StasSysConfUnitTest(unittest.TestCase):
],
FNAME_4: [
'[Host]\n',
- 'nqn=file:///some/non/exisiting/file/!@#\n',
- 'id=file:///some/non/exisiting/file/!@#\n',
- 'symname=file:///some/non/exisiting/file/!@#\n',
+ 'nqn=file:///some/non/existing/file/!@#\n',
+ 'id=file:///some/non/existing/file/!@#\n',
+ 'symname=file:///some/non/existing/file/!@#\n',
],
}
diff --git a/test/test-defs.py b/test/test-defs.py
index 3f8b02b..9098ef0 100755
--- a/test/test-defs.py
+++ b/test/test-defs.py
@@ -1,4 +1,5 @@
#!/usr/bin/python3
+import contextlib
import os
import sys
import unittest
@@ -9,13 +10,17 @@ class MockLibnvmeTestCase(unittest.TestCase):
'''Testing defs.py by mocking the libnvme package'''
def test_libnvme_version(self):
- # For unknown reasons, this test does
- # not work when run from GitHub Actions.
- if not os.getenv('GITHUB_ACTIONS'):
- from staslib import defs
+ # Ensure that we re-import staslib & staslib.defs if the current Python
+ # process has them already imported.
+ with contextlib.suppress(KeyError):
+ sys.modules.pop('staslib.defs')
+ with contextlib.suppress(KeyError):
+ sys.modules.pop('staslib')
- libnvme_ver = defs.LIBNVME_VERSION
- self.assertEqual(libnvme_ver, '?.?')
+ from staslib import defs
+
+ libnvme_ver = defs.LIBNVME_VERSION
+ self.assertEqual(libnvme_ver, '?.?')
@classmethod
def setUpClass(cls): # called once before all the tests
diff --git a/test/test-udev.py b/test/test-udev.py
index be257d9..ba484e0 100755
--- a/test/test-udev.py
+++ b/test/test-udev.py
@@ -679,7 +679,7 @@ class Test(unittest.TestCase):
'host-nqn': '',
}
)
- match = len(ipv6_addrs) == 1 and iputil.get_ipaddress_obj(
+ match = len(ipv6_addrs) >= 1 and iputil.get_ipaddress_obj(
ipv6_addrs[0], ipv4_mapped_convert=True
) == iputil.get_ipaddress_obj(tid.host_traddr, ipv4_mapped_convert=True)
self.assertEqual(