Merge pull request #91 from wdpypere/more_cleanup

more fstring and pylint cleanup

Author: itkovian

lib/vsc/utils/cache.py

@@ -29,14 +29,15 @@
 @author: Andy Georges (Ghent University)
 """
 import gzip
-import jsonpickle
 import os
 import time
 import pickle
+import jsonpickle
+
 
 from vsc.utils import fancylogger
 
-class FileCache(object):
+class FileCache:
     """File cache with a timestamp safety.
 
     Stores data (something that can be pickled) into a dictionary
@@ -81,19 +82,19 @@ def __init__(self, filename, retain_old=True, raise_unpickable=False):
                 try:
                     g = gzip.GzipFile(mode='rb', fileobj=f)  # no context manager available in python 26 yet
                     s = g.read()
-                except (IOError) as err:
+                except (OSError) as _:
                     self.log.error("Cannot load data from cache file %s as gzipped json", self.filename)
                     try:
                         f.seek(0)
                         self.shelf = pickle.load(f)
                     except pickle.UnpicklingError as err:
-                        msg = "Problem loading pickle data from %s (corrupt data)" % (self.filename,)
+                        msg = f"Problem loading pickle data from {self.filename} (corrupt data)"
                         if raise_unpickable:
                             self.log.raiseException(msg)
                         else:
                             self.log.error("%s. Continue with empty shelf: %s", msg, err)
                             self.shelf = {}
-                    except (OSError, IOError):
+                    except OSError:
                         self.log.raiseException("Could not load pickle data from %s", self.filename)
                 else:
                     try:
@@ -105,7 +106,7 @@ def __init__(self, filename, retain_old=True, raise_unpickable=False):
                 finally:
                     g.close()
 
-        except (OSError, IOError, ValueError, FileNotFoundError) as err:
+        except (OSError, ValueError, FileNotFoundError) as err:
             self.log.warning("Could not access the file cache at %s [%s]", self.filename, err)
             self.shelf = {}
             self.log.info("Cache in %s starts with an empty shelf", (self.filename,))

lib/vsc/utils/fs_store.py

@@ -96,7 +96,3 @@ def store_on_gpfs(user_name, path, key, information, gpfs, login_mount_point, gp
             gpfs.ignorerealpathmismatch = False
 
         logger.info("Stored user %s %s information at %s", user_name, key, filename)
-
-
-
-

lib/vsc/utils/lock.py

@@ -55,11 +55,11 @@ def lock_or_bork(lockfile, simple_nagios):
         lockfile.acquire()
     except LockFailed:
         logger.critical('Unable to obtain lock: lock failed')
-        simple_nagios.critical("failed to take lock on %s" % (lockfile.path))
+        simple_nagios.critical(f"failed to take lock on {lockfile.path}")
         sys.exit(NAGIOS_EXIT_CRITICAL)
     except LockError:
         logger.critical("Unable to obtain lock: could not read previous lock file %s", lockfile.path)
-        simple_nagios.critical("failed to read lockfile %s" % (lockfile.path))
+        simple_nagios.critical(f"failed to read lockfile {lockfile.path}")
         sys.exit(NAGIOS_EXIT_CRITICAL)
 
 
@@ -79,9 +79,9 @@ def release_or_bork(lockfile, simple_nagios):
         lockfile.release()
     except NotLocked:
         logger.critical('Lock release failed: was not locked.')
-        simple_nagios.critical("Lock release failed on %s" % (lockfile.path,))
+        simple_nagios.critical(f"Lock release failed on {lockfile.path}")
         sys.exit(NAGIOS_EXIT_CRITICAL)
     except NotMyLock:
         logger.error('Lock release failed: not my lock')
-        simple_nagios.critical("Lock release failed on %s" % (lockfile.path,))
+        simple_nagios.critical(f"Lock release failed on {lockfile.path}")
         sys.exit(NAGIOS_EXIT_CRITICAL)

lib/vsc/utils/nagios.py

@@ -1,5 +1,3 @@
-
-# -*- encoding: utf-8 -*-
 #
 # Copyright 2012-2023 Ghent University
 #
@@ -143,7 +141,7 @@ def exit_from_errorcode(errorcode, msg, error_map=None):
         unknown_exit(f"{msg} (errorcode {errorcode} not found in {e_map}")
 
 
-class NagiosRange(object):
+class NagiosRange:
     """Implement Nagios ranges"""
     DEFAULT_START = 0
     def __init__(self, nrange):
@@ -244,7 +242,7 @@ def alert(self, test):
         return not self.range_fn(test)
 
 
-class NagiosReporter(object):
+class NagiosReporter:
     """Reporting class for Nagios/Icinga reports.
 
     Can cache the result in a gzipped JSON file and print the result out at some later point.
@@ -282,7 +280,7 @@ def report_and_exit(self):
         """
         try:
             nagios_cache = FileCache(self.filename, True)
-        except (IOError, OSError):
+        except OSError:
             self.log.critical("Error opening file %s for reading", self.filename)
             unknown_exit(f"{self.header} nagios gzipped JSON file unavailable ({self.filename})")
 
@@ -309,7 +307,7 @@ def cache(self, nagios_exit, nagios_message):
             nagios_cache.update('nagios', (nagios_exit, nagios_message), 0)  # always update
             nagios_cache.close()
             self.log.info("Wrote nagios check cache file %s at about %s", self.filename, time.ctime(time.time()))
-        except (IOError, OSError) as exc:
+        except OSError as exc:
             # raising an error is ok, since we usually do this as the very last thing in the script
             msg = f"Cannot save to the nagios gzipped JSON file ({self.filename})"
             self.log.exception(msg)
@@ -336,7 +334,7 @@ def cache(self, nagios_exit, nagios_message):
         return True
 
 
-class NagiosResult(object):
+class NagiosResult:
     """Class representing the results of an Icinga/Nagios check.
 
     It will contain a field with the message to be printed.  And the
@@ -370,7 +368,7 @@ class NagiosResult(object):
     Nagios checks, please refer to
     U{http://docs.icinga.org/latest/en/perfdata.html}
     """
-    RESERVED_WORDS = set(['message'])
+    RESERVED_WORDS = {'message'}
     NAME_REG = re.compile(r'^(?P<name>.*?)(?:_(?P<option>warning|critical))?$')
 
     def __init__(self, message, **kwargs):
@@ -442,8 +440,8 @@ class SimpleNagios(NagiosResult):
     """
 
     USE_HEADER = True
-    RESERVED_WORDS = set(['message', 'ok', 'warning', 'critical', 'unknown',
-                         '_exit', '_cache', '_cache_user', '_final', '_final_state', '_report', '_threshold'])
+    RESERVED_WORDS = {'message', 'ok', 'warning', 'critical', 'unknown',
+                         '_exit', '_cache', '_cache_user', '_final', '_final_state', '_report', '_threshold'}
 
     def __init__(self, **kwargs):
         """Initialise message and perfdata"""

lib/vsc/utils/pickle_files.py

@@ -40,7 +40,7 @@
 import stat
 import pickle
 
-class TimestampPickle(object):
+class TimestampPickle:
     """Stores a timestamp in some format in a file."""
 
     def __init__(self, filename):
@@ -59,7 +59,7 @@ def read(self):
         try:
             with open (self.filename, "rb") as fih:
                 timestamp = pickle.load(fih)
-        except (IOError, OSError, FileNotFoundError):
+        except (OSError, FileNotFoundError):
             logging.exception("Failed to load timestamp pickle from filename %s.", self.filename)
             return None
 

lib/vsc/utils/rest_oauth.py

@@ -53,7 +53,7 @@ def make_api_request(opener, path, method='GET', payload="", access_token=""):
     """
     request = Request(path, payload)
     request.add_header('Content-Type', 'application/json')
-    request.add_header('Authorization', "Bearer %s" % (access_token,))
+    request.add_header('Authorization', f"Bearer {access_token}")
     request.get_method = lambda: method
     uri = opener.open(request)
     response = uri.read()

lib/vsc/utils/script_tools.py

@@ -333,7 +333,7 @@ def do(self, dry_run):  # pylint: disable=unused-argument
         """
         logging.error("`do` method not implemented")
         raise NotImplementedError("Not implemented")
-        return "Not implemented"
+        return "Not Implemented"
 
     def make_time(self):
         """

lib/vsc/utils/timestamp_pid_lockfile.py

@@ -44,7 +44,7 @@ class LockFileReadError(Exception):
     pass
 
 
-class TimestampedPidLockfile(LockBase, object):
+class TimestampedPidLockfile(LockBase):
     '''Basic lock file implementation.
     '''
 
@@ -124,20 +124,20 @@ def _read_pid_timestamp_file(path):
     Returns (pid :: Int, timestamp :: Int).
     '''
     try:
-        with open(path, 'r') as pidfp:
-            pidLine = pidfp.readline().strip()
-            timestampLine = pidfp.readline().strip()
-            pid = int(pidLine)
-            timestamp = int(timestampLine)
+        with open(path, encoding='utf8') as pidfp:
+            pidline = pidfp.readline().strip()
+            timestampline = pidfp.readline().strip()
+            pid = int(pidline)
+            timestamp = int(timestampline)
             return (pid, timestamp)
 
-    except IOError as err:
+    except OSError as err:
         if err.errno == errno.ENOENT:
             return None
         else:
             raise LockFileReadError('Cannot get the information from the pid file.')
     except ValueError:
-        raise LockFileReadError("Contents of pid file %s invalid" % (path))
+        raise LockFileReadError(f"Contents of pid file {path} invalid")
 
 
 def _write_pid_timestamp_file(path):
@@ -147,7 +147,7 @@ def _write_pid_timestamp_file(path):
     '''
     pidfp = os.open(path, os.O_CREAT | os.O_EXCL | os.O_WRONLY)
     pidfile = os.fdopen(pidfp, 'w')
-    pidfile.write("%s\n%d\n" % (os.getpid(), int(time.time())))
+    pidfile.write(f"{os.getpid()}\n{int(int(time.time()))}\n")
     pidfile.flush()
     pidfile.close()
 
@@ -156,8 +156,8 @@ def _find_and_kill(pid):
     '''See if the process corresponding to the given PID is still running. If so,
     kill it (gently).
     '''
-    for psLine in os.popen('ps ax'):
-        fields = psLine.split()
+    for psline in os.popen('ps ax'):
+        fields = psline.split()
         if fields[0] == pid:
             os.kill(pid, signal.SIGHUP)
             return True

setup.py

@@ -41,7 +41,7 @@
 ]
 
 PACKAGE = {
-    'version': '2.2.3',
+    'version': '2.2.5',
     'author': [ag, sdw],
     'maintainer': [ag, sdw],
     'excluded_pkgs_rpm': ['vsc', 'vsc.utils'],  # vsc is default, vsc.utils is provided by vsc-base

test/cache.py

@@ -30,13 +30,13 @@
 """
 
 import gzip
-import mock
 import os
 import tempfile
 import time
 import shutil
 import sys
 import random
+import mock
 
 from vsc.install.testing import TestCase
 from vsc.utils.cache import FileCache
@@ -48,7 +48,7 @@ def get_rand_data():
     """Returns a random dict with between 0 and LIST_LEN elements  and a random threshold"""
     length = random.randint(0, LIST_LEN)
     data = {}
-    for x in range(length):
+    for _ in range(length):
         data[random.randint(0, sys.maxsize)] = random.randint(0, sys.maxsize)
     threshold = random.randint(0, sys.maxsize)
     return data, threshold
@@ -69,11 +69,11 @@ def test_contents(self):
             cache.update(key, value, threshold)
 
         now = time.time()
-        for key in data.keys():
+        for key, content in data.items():
             info = cache.load(key)
             self.assertFalse(info is None)
             (ts, value) = info
-            self.assertTrue(value == data[key])
+            self.assertTrue(value == content)
             self.assertTrue(ts <= now)
 
     def test_save_and_load(self):
@@ -92,11 +92,11 @@ def test_save_and_load(self):
 
         now = time.time()
         new_cache = FileCache(filename)
-        for key in data.keys():
+        for key, content in data.items():
             info = cache.load(key)
             self.assertTrue(info is not None)
             (ts, value) = info
-            self.assertTrue(value == data[key])
+            self.assertTrue(value == content)
             self.assertTrue(ts <= now)
         new_cache.close()