base3: Move Date/Time-related Functions to a new "time3.py" Library (fixed #55)

Author: markuslf

base3.py

@@ -10,23 +10,21 @@
 
 """Provides very common every-day functions.
 
-The functions "to_text()" and "to_bytes()" are copied from 
+The functions "to_text()" and "to_bytes()" are copied from
 /usr/lib/python3.10/site-packages/ansible/module_utils/_text.py (BSD license).
 """
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
 __version__ = '2022021504'
 
 import collections
-import datetime
 import numbers
 import operator
 import os
 import re
 import shlex
 import subprocess
 import sys
-import time
 
 from traceback import format_exc # pylint: disable=C0413
 
@@ -92,16 +90,6 @@ def cu():
     sys.exit(STATE_UNKNOWN)
 
 
-def epoch2iso(timestamp):
-    """Returns the ISO representaton of a UNIX timestamp (epoch).
-
-    >>> epoch2iso(1620459129)
-    '2021-05-08 09:32:09'
-    """
-    timestamp = float(timestamp)
-    return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(timestamp))
-
-
 def get_command_output(cmd, regex=None):
     """Runs a shell command and returns its output. Optionally, applies a regex and just
     returns the first matching group. If the command is not found, an empty string is returned.
@@ -134,7 +122,7 @@ def get_command_output(cmd, regex=None):
         return stdout.strip()
 
 
-def get_perfdata(label, value, uom, warn, crit, min, max):
+def get_perfdata(label, value, uom, warn, crit, _min, _max):
     """Returns 'label'=value[UOM];[warn];[crit];[min];[max]
     """
     msg = "'{}'={}".format(label, value)
@@ -147,11 +135,11 @@ def get_perfdata(label, value, uom, warn, crit, min, max):
     if crit is not None:
         msg += str(crit)
     msg += ';'
-    if min is not None:
-        msg += str(min)
+    if _min is not None:
+        msg += str(_min)
     msg += ';'
-    if max is not None:
-        msg += str(max)
+    if _max is not None:
+        msg += str(_max)
     msg += ' '
     return msg
 
@@ -350,7 +338,8 @@ def get_worst(state1, state2):
 
 
 def guess_type(v, consumer='python'):
-    """Guess the type of a value (None, int, float or string) for different types of consumers (Python, SQLite etc.).
+    """Guess the type of a value (None, int, float or string) for different types of consumers
+    (Python, SQLite etc.).
     For Python, use isinstance() to check for example if a number is an integer.
 
     >>> guess_type('1')
@@ -373,34 +362,32 @@ def guess_type(v, consumer='python'):
     if consumer == 'python':
         if v is None:
             return None
-        else:
+        try:
+            return int(v)
+        except ValueError:
             try:
-                return int(v)
+                return float(v)
             except ValueError:
-                try:
-                    return float(v)
-                except ValueError:
-                    return str(v)
+                return str(v)
 
     if consumer == 'sqlite':
         if v is None:
             return 'string'
-        else:
+        try:
+            int(v)
+            return 'integer'
+        except ValueError:
             try:
-                int(v)
-                return 'integer'
+                float(v)
+                return 'real'
             except ValueError:
-                try:
-                    float(v)
-                    return 'real'
-                except ValueError:
-                    return 'text'
+                return 'text'
 
 
 def is_empty_list(l):
     """Check if a list only contains either empty elements or whitespace
     """
-    return all('' == s or s.isspace() for s in l)
+    return all(s == '' or s.isspace() for s in l)
 
 
 def is_numeric(value):
@@ -497,7 +484,7 @@ def parse_atom(atom, default):
     if not success:
         return (success, result)
     start, end, invert = result
-    if isinstance(value, str) or isinstance(value, bytes):
+    if isinstance(value, (str, bytes)):
         value = float(value.replace('%', ''))
     if value < start:
         return (True, False ^ invert)
@@ -506,29 +493,6 @@ def parse_atom(atom, default):
     return (True, True ^ invert)
 
 
-def now(as_type=''):
-    """Returns the current date and time as UNIX time in seconds (default), or
-    as a datetime object.
-
-    lib.base3.now()
-    >>> 1586422786
-
-    lib.base3.now(as_type='epoch')
-    >>> 1586422786
-
-    lib.base3.now(as_type='datetime')
-    >>> datetime.datetime(2020, 4, 9, 11, 1, 41, 228752)
-
-    lib.base3.now(as_type='iso')
-    >>> '2020-04-09 11:31:24'
-    """
-    if as_type == 'datetime':
-        return datetime.datetime.now()
-    if as_type == 'iso':
-        return time.strftime("%Y-%m-%d %H:%M:%S")
-    return int(time.time())
-
-
 def oao(msg, state=STATE_OK, perfdata='', always_ok=False):
     """Over and Out (OaO)
 
@@ -746,32 +710,6 @@ def state2str(state, empty_ok=True, prefix='', suffix=''):
     return state
 
 
-def timestr2datetime(timestr, pattern='%Y-%m-%d %H:%M:%S'):
-    """Takes a string (default: ISO format) and returns a
-    datetime object.
-    """
-    return datetime.datetime.strptime(timestr, pattern)
-
-
-def timestrdiff(timestr1, timestr2, pattern1='%Y-%m-%d %H:%M:%S', pattern2='%Y-%m-%d %H:%M:%S'):
-    """Returns the difference between two datetime strings in seconds. This
-    function expects two ISO timestamps, by default each in ISO format.
-    """
-    timestr1 = timestr2datetime(timestr1, pattern1)
-    timestr2 = timestr2datetime(timestr2, pattern2)
-    timedelta = abs(timestr1 - timestr2)
-    return timedelta.total_seconds()
-
-
-def utc_offset():
-    """Returns the current local UTC offset, for example '+0200'.
-
-    utc_offset()
-    >>> '+0200'
-    """
-    return time.strftime("%z")
-
-
 def version(v):
     """Use this function to compare string-based version numbers.
 
@@ -813,5 +751,4 @@ def version2float(v):
     v = v.split('.')
     if len(v) > 1:
         return float('{}.{}'.format(v[0], ''.join(v[1:])))
-    else:
-        return float(''.join(v))
+    return float(''.join(v))

cache3.py

@@ -15,7 +15,7 @@
 
 >>> cache3.get('session-key')
 False
->>> cache3.set('session-key', '123abc', expire=base.now() + 5)
+>>> cache3.set('session-key', '123abc', expire=time3.now() + 5)
 True
 >>> cache3.get('session-key')
 u'123abc'
@@ -25,9 +25,9 @@
 """
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2021100801'
+__version__ = '2022021501'
 
-from . import base3
+from . import time3
 from . import db_sqlite3
 
 
@@ -65,13 +65,13 @@ def get(key, as_dict=False, path='', filename='linuxfabrik-plugin-cache.db'):
         db_sqlite3.close(conn)
         return False
 
-    if result['timestamp'] != 0 and result['timestamp'] <= base3.now():
+    if result['timestamp'] != 0 and result['timestamp'] <= time3.now():
         # key was found, but timstamp was set and has expired:
         # delete all expired keys and return false
         data = {'key' : result['key']}
         success, result = db_sqlite3.delete(
             conn,
-            sql='DELETE FROM cache WHERE timestamp <= {};'.format(base3.now())
+            sql='DELETE FROM cache WHERE timestamp <= {};'.format(time3.now())
         )
         success, result = db_sqlite3.commit(conn)
         db_sqlite3.close(conn)

feedparser3.py

@@ -19,19 +19,19 @@
     print('Python module "BeautifulSoup4" is not installed.')
     exit(3)
 
-from . import base3
+from . import time3
 from . import url3
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2021050601'
+__version__ = '2022021501'
 
 
 def parse_atom(soup):
     result = {}
     result['title'] = soup.title.string
     result['updated'] = soup.updated.string
     # cut the timezone part
-    result['updated_parsed'] = base3.timestr2datetime(result['updated'][0:19], pattern='%Y-%m-%dT%H:%M:%S')
+    result['updated_parsed'] = time3.timestr2datetime(result['updated'][0:19], pattern='%Y-%m-%dT%H:%M:%S')
 
     result['entries'] = []
     for entry in soup.find_all('entry'):
@@ -40,7 +40,7 @@ def parse_atom(soup):
         tmp['id'] = entry.id.string
         tmp['updated'] = entry.updated.string
         # cut the timezone part
-        tmp['updated_parsed'] = base3.timestr2datetime(tmp['updated'][0:19], pattern='%Y-%m-%dT%H:%M:%S')
+        tmp['updated_parsed'] = time3.timestr2datetime(tmp['updated'][0:19], pattern='%Y-%m-%dT%H:%M:%S')
         try:
             soup = BeautifulSoup(entry.summary.string, 'lxml')
             tmp['summary'] = soup.get_text()
@@ -59,7 +59,7 @@ def parse_rss(soup):
     result['title'] = soup.rss.channel.title.string
     result['updated'] = soup.rss.channel.pubDate.string
     # cut the timezone part
-    result['updated_parsed'] = base3.timestr2datetime(result['updated'][0:25], pattern='%a, %d %b %Y %H:%M:%S')
+    result['updated_parsed'] = time3.timestr2datetime(result['updated'][0:25], pattern='%a, %d %b %Y %H:%M:%S')
 
     result['entries'] = []
     for entry in soup.find_all('item'):
@@ -68,7 +68,7 @@ def parse_rss(soup):
         tmp['id'] = entry.guid.string
         tmp['updated'] = entry.pubDate.string
         # cut the timezone part
-        tmp['updated_parsed'] = base3.timestr2datetime(tmp['updated'][0:25], pattern='%a, %d %b %Y %H:%M:%S')
+        tmp['updated_parsed'] = time3.timestr2datetime(tmp['updated'][0:25], pattern='%a, %d %b %Y %H:%M:%S')
         try:
             soup = BeautifulSoup(entry.description.string, 'lxml')
             tmp['summary'] = soup.get_text()

huawei3.py

@@ -9,17 +9,19 @@
 # https://git.linuxfabrik.ch/linuxfabrik-icinga-plugins/checks-linux/-/blob/master/CONTRIBUTING.md
 
 """This library collects some LibreNMS related functions that are
-needed by LibreNMS check plugins."""
+needed by LibreNMS check plugins.
+"""
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2022012101'
+__version__ = '2022021501'
 
 import time
 
 from .globals3 import STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN
 
 from . import base3
 from . import cache3
+from . import time3
 from . import url3
 
 
@@ -53,7 +55,7 @@ def get_creds(args):
     ibasetoken = result.get('response_json').get('data').get('iBaseToken')
     # In Python 3, getheader() should be get()
     cookie = result.get('response_header').get('Set-Cookie')
-    expire = base3.now() + args.CACHE_EXPIRE*60
+    expire = time3.now() + args.CACHE_EXPIRE*60
     cache3.set('huawei-{}-ibasetoken'.format(args.DEVICE_ID), ibasetoken, expire)
     cache3.set('huawei-{}-cookie'.format(args.DEVICE_ID), cookie, expire)
     return ibasetoken, cookie

time3.py

@@ -0,0 +1,77 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8; py-indent-offset: 4 -*-
+#
+# Author:  Linuxfabrik GmbH, Zurich, Switzerland
+# Contact: info (at) linuxfabrik (dot) ch
+#          https://www.linuxfabrik.ch/
+# License: The Unlicense, see LICENSE file.
+
+# https://git.linuxfabrik.ch/linuxfabrik-icinga-plugins/checks-linux/-/blob/master/CONTRIBUTING.md
+
+"""Provides datetime functions.
+"""
+
+__author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
+__version__ = '2022021501'
+
+import datetime
+import time
+
+
+def epoch2iso(timestamp):
+    """Returns the ISO representaton of a UNIX timestamp (epoch).
+
+    >>> epoch2iso(1620459129)
+    '2021-05-08 09:32:09'
+    """
+    timestamp = float(timestamp)
+    return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(timestamp))
+
+
+def now(as_type=''):
+    """Returns the current date and time as UNIX time in seconds (default), or
+    as a datetime object.
+
+    lib.base3.now()
+    >>> 1586422786
+
+    lib.base3.now(as_type='epoch')
+    >>> 1586422786
+
+    lib.base3.now(as_type='datetime')
+    >>> datetime.datetime(2020, 4, 9, 11, 1, 41, 228752)
+
+    lib.base3.now(as_type='iso')
+    >>> '2020-04-09 11:31:24'
+    """
+    if as_type == 'datetime':
+        return datetime.datetime.now()
+    if as_type == 'iso':
+        return time.strftime("%Y-%m-%d %H:%M:%S")
+    return int(time.time())
+
+
+def timestr2datetime(timestr, pattern='%Y-%m-%d %H:%M:%S'):
+    """Takes a string (default: ISO format) and returns a
+    datetime object.
+    """
+    return datetime.datetime.strptime(timestr, pattern)
+
+
+def timestrdiff(timestr1, timestr2, pattern1='%Y-%m-%d %H:%M:%S', pattern2='%Y-%m-%d %H:%M:%S'):
+    """Returns the difference between two datetime strings in seconds. This
+    function expects two ISO timestamps, by default each in ISO format.
+    """
+    timestr1 = timestr2datetime(timestr1, pattern1)
+    timestr2 = timestr2datetime(timestr2, pattern2)
+    timedelta = abs(timestr1 - timestr2)
+    return timedelta.total_seconds()
+
+
+def utc_offset():
+    """Returns the current local UTC offset, for example '+0200'.
+
+    utc_offset()
+    >>> '+0200'
+    """
+    return time.strftime("%z")