Allow periods to be specified in seconds or hours

bulletmark · bulletmark · commit eff3fc7bbb02 · 2022-08-27T10:27:59.000+10:00
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@
 
 setup(
     name=name,
-    version='1.15',
+    version='1.16',
     description='Program to run plugins to inhibit system '
     'sleep/suspend/hibernate',
     long_description=here.joinpath('README.md').read_text(),
diff --git a/sleep-inhibitor.conf b/sleep-inhibitor.conf
@@ -6,6 +6,11 @@
 # /usr/local/share/sleep-inhibitor/plugins) but you can define it
 # explicitly here if you want, e.g. for custom config file for testing.
 #
+# Note period values in this file are specified in minutes by default.
+# E.g. "2" is 2 minutes. However, you can append an "s", "m", or "h" to
+# specify in seconds, minutes, or hours, e.g. "2s" is 2 seconds, "2m" is
+# 2 minutes (i.e. same as "2"), or "2h" is 2 hours.
+#
 # plugin_dir:
 #
 # Default global check period in minutes. Can be specified for each
diff --git a/sleep_inhibitor.py b/sleep_inhibitor.py
@@ -22,6 +22,26 @@
     'systemd-inhibit',
 )
 
+def gettime(conf, field, default=None):
+    'Read time value from given conf.'
+    val = conf.get(field, default)
+    if val is None:
+        return None
+
+    if isinstance(val, str):
+        if val.endswith('s'):
+            num = float(val[:-1]) / 60
+        elif val.endswith('m'):
+            num = float(val[:-1])
+        elif val.endswith('h'):
+            num = float(val[:-1]) * 60
+        else:
+            sys.exit(f'Invalid time value "{field}: {val}".')
+    else:
+        num = float(val)
+
+    return num
+
 class Plugin:
     'Class to manage each plugin'
     loglock = threading.Lock()
@@ -49,15 +69,14 @@ def __init__(self, index, prog, progname, def_period, def_period_on,
         if not path.exists():
             sys.exit(f'{self.name}: "{path}" does not exist')
 
-        per = conf.get('period')
-        if per is None:
+        period = gettime(conf, 'period')
+        if period is None:
             period = def_period
             period_on_def = def_period_on
         else:
-            period = float(per)
             period_on_def = period
 
-        period_on = float(conf.get('period_on', period_on_def))
+        period_on = gettime(conf, 'period_on', period_on_def)
         self.period = period * 60
         self.is_inhibiting = None
 
@@ -78,7 +97,9 @@ def __init__(self, index, prog, progname, def_period, def_period_on,
         self.icmd = shlex.split(f'{inhibitor_prog}{what} --who="{progname}" '
                 f'--why="{self.name}" {prog} -s {period_on * 60} -i "{cmd}"')
 
-        print(f'{self.name} [{path}] configured @ {period}/{period_on} minutes')
+        per = round(period, 3)
+        per_on = round(period_on, 3)
+        print(f'{self.name} [{path}] configured @ {per}/{per_on} minutes')
 
         # Each plugin periodic check runs in it's own thread
         thread = threading.Thread(target=self.run)
@@ -193,8 +214,8 @@ def init():
     plugin_dir = args.plugin_dir or conf.get('plugin_dir', plugin_dir)
 
     # Get some global defaults
-    period = float(conf.get('period', 5))
-    period_on = float(conf.get('period_on', period))
+    period = gettime(conf, 'period', 5)
+    period_on = gettime(conf, 'period_on', period)
     what = conf.get('what')
 
     # Iterate to create each configured plugins

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,11 @@`
`6`	`6`	`# /usr/local/share/sleep-inhibitor/plugins) but you can define it`
`7`	`7`	`# explicitly here if you want, e.g. for custom config file for testing.`
`8`	`8`	`#`
	`9`	`+# Note period values in this file are specified in minutes by default.`
	`10`	`+# E.g. "2" is 2 minutes. However, you can append an "s", "m", or "h" to`
	`11`	`+# specify in seconds, minutes, or hours, e.g. "2s" is 2 seconds, "2m" is`
	`12`	`+# 2 minutes (i.e. same as "2"), or "2h" is 2 hours.`
	`13`	`+#`
`9`	`14`	`# plugin_dir:`
`10`	`15`	`#`
`11`	`16`	`# Default global check period in minutes. Can be specified for each`