Chore: Code formatting and linting

Run Black, isort, and ruff on the core machinery.

Author: amotl

mqttwarn/__init__.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 # (c) 2014-2018 The mqttwarn developers
 
-__version__   = '0.29.1'
+__version__ = "0.29.1"
 
-__author__    = 'Jan-Piet Mens <jpmens()gmail.com>, Ben Jones <ben.jones12()gmail.com>'
-__copyright__ = 'Copyright 2014-2022 Jan-Piet Mens'
-__license__   = 'Eclipse Public License - v 2.0 (http://www.eclipse.org/legal/epl-2.0/)'
+__author__ = "Jan-Piet Mens <jpmens()gmail.com>, Ben Jones <ben.jones12()gmail.com>"
+__copyright__ = "Copyright 2014-2022 Jan-Piet Mens"
+__license__ = "Eclipse Public License - v 2.0 (http://www.eclipse.org/legal/epl-2.0/)"

mqttwarn/commands.py

@@ -1,23 +1,24 @@
 # -*- coding: utf-8 -*-
 # (c) 2014-2019 The mqttwarn developers
 from __future__ import print_function
-import os
-import sys
-import json
+
 import codecs
-import signal
+import json
 import logging
+import os
+import signal
+import sys
 
 from docopt import docopt
 
 from mqttwarn import __version__
-from mqttwarn.configuration import load_configuration, Config
-from mqttwarn.core import bootstrap, subscribe_forever, cleanup, run_plugin
+from mqttwarn.configuration import Config, load_configuration
+from mqttwarn.core import bootstrap, cleanup, run_plugin, subscribe_forever
 from mqttwarn.util import get_resource_content
 
 logger = logging.getLogger(__name__)
 
-APP_NAME = 'mqttwarn'
+APP_NAME = "mqttwarn"
 
 
 def run():
@@ -57,32 +58,33 @@ def run():
     commandline_schema = run.__doc__.format(program=APP_NAME)
 
     # Read commandline options
-    options = docopt(commandline_schema, version=APP_NAME + ' ' + __version__)
+    options = docopt(commandline_schema, version=APP_NAME + " " + __version__)
 
     # TODO: Review this. Why do we need it?
-    utf8_writer = codecs.getwriter('utf-8')
+    utf8_writer = codecs.getwriter("utf-8")
     sys.stdout = utf8_writer(sys.stdout.buffer)
 
-    if options['make-config']:
-        payload = get_resource_content('mqttwarn.examples', 'basic/mqttwarn.ini')
+    if options["make-config"]:
+        payload = get_resource_content("mqttwarn.examples", "basic/mqttwarn.ini")
         print(payload)
 
-    elif options['make-samplefuncs']:
-        payload = get_resource_content('mqttwarn.examples', 'basic/samplefuncs.py')
+    elif options["make-samplefuncs"]:
+        payload = get_resource_content("mqttwarn.examples", "basic/samplefuncs.py")
         print(payload)
 
-    elif options['--plugin'] and options['--options']:
+    elif options["--plugin"] and options["--options"]:
 
         # Decode arguments
-        arg_plugin = options['--plugin']
-        arg_options = json.loads(options['--options'])
+        arg_plugin = options["--plugin"]
+        arg_options = json.loads(options["--options"])
         arg_config = None
-        if "--config" in options and options['--config'] is not None:
-            arg_config = json.loads(options['--config'])
+        if "--config" in options and options["--config"] is not None:
+            arg_config = json.loads(options["--config"])
 
         # Launch service plugin in standalone mode
-        launch_plugin_standalone(arg_plugin, arg_options, configfile=options.get("--config-file"), config_more=arg_config)
-
+        launch_plugin_standalone(
+            arg_plugin, arg_options, configfile=options.get("--config-file"), config_more=arg_config
+        )
 
     # Run mqttwarn in service mode when no command line arguments are given
     else:
@@ -154,8 +156,8 @@ def setup_logging(config):
     if not LOGFILE:
         pass
 
-    elif LOGFILE.startswith('stream://'):
-        LOGFILE = LOGFILE.replace('stream://', '')
+    elif LOGFILE.startswith("stream://"):
+        LOGFILE = LOGFILE.replace("stream://", "")
         logging.basicConfig(stream=eval(LOGFILE), level=LOGLEVEL, format=LOGFORMAT)
 
     # Send log messages to file by configuring "logfile = 'mqttwarn.log'"

mqttwarn/configuration.py

@@ -1,30 +1,31 @@
 # -*- coding: utf-8 -*-
-# (c) 2014-2021 The mqttwarn developers
-import os
-import sys
+# (c) 2014-2022 The mqttwarn developers
 import ast
 import codecs
 import logging
-from configparser import RawConfigParser, NoOptionError
+import os
+import sys
+from configparser import NoOptionError, RawConfigParser
+
+from mqttwarn.util import load_functions
 
 HAVE_TLS = True
 try:
     import ssl
 except ImportError:
     HAVE_TLS = False
 
-from mqttwarn.util import load_functions
 
 logger = logging.getLogger(__name__)
 
 
 class Config(RawConfigParser):
 
     specials = {
-            'TRUE'  : True,
-            'FALSE' : False,
-            'NONE'  : None,
-        }
+        "TRUE": True,
+        "FALSE": False,
+        "NONE": None,
+    }
 
     def __init__(self, configuration_file=None, defaults=None):
 
@@ -34,39 +35,39 @@ def __init__(self, configuration_file=None, defaults=None):
 
         RawConfigParser.__init__(self)
         if configuration_file is not None:
-            f = codecs.open(configuration_file, 'r', encoding='utf-8')
+            f = codecs.open(configuration_file, "r", encoding="utf-8")
             self.read_file(f)
             f.close()
 
             self.configuration_path = os.path.dirname(configuration_file)
 
-        ''' set defaults '''
-        self.hostname     = 'localhost'
-        self.port         = 1883
-        self.username     = None
-        self.password     = None
-        self.clientid     = None
-        self.lwt          = None
+        """ set defaults """
+        self.hostname = "localhost"
+        self.port = 1883
+        self.username = None
+        self.password = None
+        self.clientid = None
+        self.lwt = None
         self.skipretained = False
         self.cleansession = False
-        self.protocol     = 3
+        self.protocol = 3
 
-        self.logformat    = '%(asctime)-15s %(levelname)-8s [%(name)-26s] %(message)s'
-        self.logfile      = "stream://sys.stderr"
-        self.loglevel     = 'DEBUG'
+        self.logformat = "%(asctime)-15s %(levelname)-8s [%(name)-26s] %(message)s"
+        self.logfile = "stream://sys.stderr"
+        self.loglevel = "DEBUG"
 
-        self.functions    = None
-        self.num_workers  = 1
+        self.functions = None
+        self.num_workers = 1
 
-        self.ca_certs     = None
-        self.tls_version  = None
-        self.certfile     = None
-        self.keyfile      = None
+        self.ca_certs = None
+        self.tls_version = None
+        self.certfile = None
+        self.keyfile = None
         self.tls_insecure = False
-        self.tls          = False
+        self.tls = False
 
         self.__dict__.update(defaults)
-        self.__dict__.update(self.config('defaults'))
+        self.__dict__.update(self.config("defaults"))
 
         if HAVE_TLS is False:
             logger.error("TLS parameters set but no TLS available (SSL)")
@@ -77,13 +78,13 @@ def __init__(self, configuration_file=None, defaults=None):
             self.tls = True
 
         if self.tls_version is not None:
-            if self.tls_version == 'tlsv1_2':
+            if self.tls_version == "tlsv1_2":
                 self.tls_version = ssl.PROTOCOL_TLSv1_2
-            if self.tls_version == 'tlsv1_1':
+            if self.tls_version == "tlsv1_1":
                 self.tls_version = ssl.PROTOCOL_TLSv1_1
-            if self.tls_version == 'tlsv1':
+            if self.tls_version == "tlsv1":
                 self.tls_version = ssl.PROTOCOL_TLSv1
-            if self.tls_version == 'sslv3':
+            if self.tls_version == "sslv3":
                 self.tls_version = ssl.PROTOCOL_SSLv3
 
         self.loglevelnumber = self.level2number(self.loglevel)
@@ -109,18 +110,17 @@ def __init__(self, configuration_file=None, defaults=None):
     def level2number(self, level):
 
         levels = {
-            'CRITICAL' : 50,
-            'DEBUG' : 10,
-            'ERROR' : 40,
-            'FATAL' : 50,
-            'INFO' : 20,
-            'NOTSET' : 0,
-            'WARN' : 30,
-            'WARNING' : 30,
+            "CRITICAL": 50,
+            "DEBUG": 10,
+            "ERROR": 40,
+            "FATAL": 50,
+            "INFO": 20,
+            "NOTSET": 0,
+            "WARN": 30,
+            "WARNING": 30,
         }
 
-        return levels.get(level.upper(), levels['DEBUG'])
-
+        return levels.get(level.upper(), levels["DEBUG"])
 
     def g(self, section, key, default=None):
         try:
@@ -130,7 +130,7 @@ def g(self, section, key, default=None):
             return ast.literal_eval(val)
         except NoOptionError:
             return default
-        except ValueError:   # e.g. %(xxx)s in string
+        except ValueError:  # e.g. %(xxx)s in string
             return val
         except SyntaxError:  # If not python value, e.g. list of targets coma separated
             return val
@@ -139,12 +139,12 @@ def g(self, section, key, default=None):
             return val
 
     def getlist(self, section, key):
-        ''' Return a list, fail if it isn't a list '''
+        """Return a list, fail if it isn't a list"""
 
         val = None
         try:
             val = self.get(section, key)
-            val = [s.strip() for s in val.split(',')]
+            val = [s.strip() for s in val.split(",")]
         except Exception as e:
             logger.warning("Expecting a list in section `%s', key `%s' (%s)" % (section, key, e))
 
@@ -159,43 +159,42 @@ def getdict(self, section, key):
             return None
 
     def config(self, section):
-        ''' Convert a whole section's options (except the options specified
-            explicitly below) into a dict, turning
+        """Convert a whole section's options (except the options specified
+        explicitly below) into a dict, turning
 
-                [config:mqtt]
-                host = 'localhost'
-                username = None
-                list = [1, 'aaa', 'bbb', 4]
+            [config:mqtt]
+            host = 'localhost'
+            username = None
+            list = [1, 'aaa', 'bbb', 4]
 
-            into
+        into
 
-                {u'username': None, u'host': 'localhost', u'list': [1, 'aaa', 'bbb', 4]}
+            {u'username': None, u'host': 'localhost', u'list': [1, 'aaa', 'bbb', 4]}
 
-            Cannot use config.items() because I want each value to be
-            retrieved with g() as above '''
+        Cannot use config.items() because I want each value to be
+        retrieved with g() as above"""
 
         d = {}
         if self.has_section(section):
-            d = dict((key, self.g(section, key))
-                for (key) in self.options(section) if key not in ['targets', 'module'])
+            d = dict((key, self.g(section, key)) for (key) in self.options(section) if key not in ["targets", "module"])
         return d
 
 
-def load_configuration(configfile=None, name='mqttwarn'):
+def load_configuration(configfile=None, name="mqttwarn"):
 
     if configfile is None:
-        configfile = os.getenv(name.upper() + 'INI', name + '.ini')
+        configfile = os.getenv(name.upper() + "INI", name + ".ini")
 
     if not os.path.exists(configfile):
         raise FileNotFoundError('Configuration file "{}" does not exist'.format(configfile))
 
     # TODO: There should be a factory method which creates a `Config` instance,
     #       including defaults, but without loading a configuration file.
     defaults = {
-        'clientid': name,
-        'lwt': 'clients/{}'.format(name),
-        'lwt_alive': '1',
-        'lwt_dead': '0',
+        "clientid": name,
+        "lwt": "clients/{}".format(name),
+        "lwt_alive": "1",
+        "lwt_dead": "0",
     }
 
     return Config(configfile, defaults=defaults)