Can globally specify default period and what value

bulletmark · bulletmark · commit 4e47ac967a9a · 2022-08-08T15:13:57.000+10:00
diff --git a/sleep-inhibitor.conf b/sleep-inhibitor.conf
@@ -7,6 +7,18 @@
 # explicitly here if you want, e.g. for custom config file for testing.
 # plugin_dir:
 #
+# Default global check period in minutes. Can be specified
+# for each plugin, or if not specified will the global default you
+# define here (or is 5 mins if not specified at all).
+# period: 5
+#
+# Default global "what" value. Can be specified for each plugin, or if
+# not specified will the global default you define here. Takes a
+# colon-separated list of one or more operations to inhibit. See the
+# description of the --what option in the man page for systemd-inhibit.
+# Defaults to the default value of that systemd-inhibit option.
+# what:
+#
 # Plugins are defined following. You can define as many plugins as you
 # require. Custom plugins are specified with an absolute path to your
 # own executable file. Standard plugins (i.e. those included in the
@@ -17,13 +29,12 @@
 #         plugins, or relative to the program distribution plugins/
 #         directory for standard plugins.
 # args:   Optional. Provides arguments to the above script if required.
-# period: Optional. Specifies period in minutes. Defaults to 5.
+# period: Optional. Specifies period in minutes. Defaults to global
+#         value, see above.
 # name:   Optional. Descriptive name for logging. Defaults to basename of
 #         path.
 # what:   Optional. Takes a colon-seperated list of one or more
-#         operations to inhibit. See the description of the --what
-#         option in the man page for systemd-inhibit. Defaults to the
-#         default value of that systemd-inhibit option.
+#         operations to inhibit. Defaults to global value, see above.
 
 # Comment/delete out or edit the following examples, or add your own.
 plugins:
diff --git a/sleep_inhibitor.py b/sleep_inhibitor.py
@@ -15,9 +15,6 @@
 # Return code which indicates plugin wants to inhibit suspend
 SUSP_CODE = 254
 
-# Default check period in minutes if not specified for plugin in config
-DEF_PERIOD = 5
-
 # On some non-systemd systems, systemd-inhibit emulators are used
 # instead. The first found below is the one we use:
 SYSTEMD_SLEEP_PROGS = (
@@ -30,7 +27,8 @@ class Plugin:
     loglock = threading.Lock()
     threads = []
 
-    def __init__(self, index, prog, progname, conf, plugin_dir, inhibitor_prog):
+    def __init__(self, index, prog, progname, def_period, def_what,
+            conf, plugin_dir, inhibitor_prog):
         'Constructor'
         pathstr = conf.get('path')
         if not pathstr:
@@ -51,7 +49,7 @@ def __init__(self, index, prog, progname, conf, plugin_dir, inhibitor_prog):
         if not path.exists():
             sys.exit(f'{self.name}: "{path}" does not exist')
 
-        period = float(conf.get('period', DEF_PERIOD))
+        period = float(conf.get('period', def_period))
         self.period = period * 60
         self.is_inhibiting = None
 
@@ -63,7 +61,7 @@ def __init__(self, index, prog, progname, conf, plugin_dir, inhibitor_prog):
         # The normal periodic check command
         self.cmd = shlex.split(cmd)
 
-        whatval = conf.get('what')
+        whatval = conf.get('what', def_what)
         what = f' --what="{whatval}"' if whatval else ''
 
         # While inhibiting, we run outself again via systemd-inhibit to
@@ -111,7 +109,6 @@ def log(cls, msg):
 
 def init():
     'Program initialisation'
-
     # Process command line options
     opt = argparse.ArgumentParser(description=__doc__.strip())
     opt.add_argument('-c', '--config',
@@ -187,9 +184,14 @@ def init():
     # Work out plugin dir
     plugin_dir = args.plugin_dir or conf.get('plugin_dir', plugin_dir)
 
+    # Get some global defaults
+    period = float(conf.get('period', 5))
+    what = conf.get('what')
+
     # Iterate to create each configured plugins
     for index, plugin in enumerate(plugins, 1):
-        Plugin(index, prog, progname, plugin, plugin_dir, inhibitor_prog)
+        Plugin(index, prog, progname, period, what, plugin, plugin_dir,
+                inhibitor_prog)
 
 def main():
     'Main entry'
