Move TTS formatting functions to new module

The new `pluginutils` module contains the TTS formatting functions
previously only defined in the Dark Sky plugin.  This change comes
because these functions are of general utility, and may eventually
be configurable in one centralized place for all of Kaylee.

kayleevc/plugins/darksky.py

@@ -30,6 +30,7 @@ import time
 
 import requests
 
+from kayleevc.pluginutils import *
 from . import PluginBase, Handler
 
 
@@ -112,37 +113,6 @@ class DarkSkyHandler(Handler):
         with open(self._cache_filename, 'r') as f:
             return json.load(f)
 
-    def _format_temperature(self, temperature, unit='Fahrenheit'):
-        """Format a temperature for the TTS system"""
-        return f'{temperature:.{self._temp_precision}f} degrees {unit}'
-
-    def _format_percent(self, value):
-        """Format a percentage value for the TTS system"""
-        return f'{100*value:.0f} percent'
-
-    def _format_time(self, epoch_time):
-        """Format a time in seconds since the epoch for the TTS system"""
-        t = time.localtime(epoch_time)
-
-        # Format each part of the time to be pronounced nicely
-        hour = time.strftime('%I', t)
-        if hour[0] == '0':
-            hour = hour[1]
-
-        minute = time.strftime('%M', t)
-        if minute[0] == '0':
-            if minute[1] == '0':
-                minute = "o'clock"
-            else:
-                minute = 'O' + minute[1]
-
-        ante_post = time.strftime('%p', t)
-        if ante_post[0] == 'A':
-            ante_post = 'AE ' + ante_post[1]
-
-        # Put the parts together
-        return f'{hour} {minute} {ante_post}'
-
     def __call__(self, tts):
         """Update the cache if necessary and load it"""
         self._update_cache_if_stale()
@@ -155,7 +125,8 @@ class DarkSkyTemperatureHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak the current temperature"""
         super().__call__(tts)
-        tts(self._format_temperature(self.cache['currently']['temperature']))
+        tts(format_temperature(self.cache['currently']['temperature'],
+            self._temp_precision))
 
 
 class DarkSkyTodaysHighHandler(DarkSkyHandler):
@@ -164,8 +135,9 @@ class DarkSkyTodaysHighHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak today's high"""
         super().__call__(tts)
-        tts(self._format_temperature(
-            self.cache['daily']['data'][0]['temperatureMax']))
+        tts(format_temperature(
+            self.cache['daily']['data'][0]['temperatureMax'],
+            self._temp_precision))
 
 
 class DarkSkyTodaysLowHandler(DarkSkyHandler):
@@ -174,8 +146,9 @@ class DarkSkyTodaysLowHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak today's low"""
         super().__call__(tts)
-        tts(self._format_temperature(
-            self.cache['daily']['data'][0]['temperatureMin']))
+        tts(format_temperature(
+            self.cache['daily']['data'][0]['temperatureMin'],
+            self._temp_precision))
 
 
 class DarkSkyTomorrowsHighHandler(DarkSkyHandler):
@@ -184,8 +157,9 @@ class DarkSkyTomorrowsHighHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak tomorrow's high"""
         super().__call__(tts)
-        tts(self._format_temperature(
-            self.cache['daily']['data'][1]['temperatureMax']))
+        tts(format_temperature(
+            self.cache['daily']['data'][1]['temperatureMax'],
+            self._temp_precision))
 
 
 class DarkSkyHumidityHandler(DarkSkyHandler):
@@ -194,7 +168,7 @@ class DarkSkyHumidityHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak the current relative humidity"""
         super().__call__(tts)
-        tts(self._format_percent(self.cache['currently']['humidity']))
+        tts(format_percent(self.cache['currently']['humidity']))
 
 
 class DarkSkyCurrentConditionsHandler(DarkSkyHandler):
@@ -204,9 +178,9 @@ class DarkSkyCurrentConditionsHandler(DarkSkyHandler):
         """Speak the current weather conditions"""
         super().__call__(tts)
         summary = self.cache['currently']['summary']
-        temperature = self._format_temperature(
-                self.cache['currently']['temperature'])
-        humidity = self._format_percent(self.cache['currently']['humidity'])
+        temperature = format_temperature(
+                self.cache['currently']['temperature'], self._temp_precision)
+        humidity = format_percent(self.cache['currently']['humidity'])
         tts(f'{summary}, {temperature}, relative humidity {humidity}')
 
 
@@ -216,7 +190,7 @@ class DarkSkySunsetHandler(DarkSkyHandler):
     def __call__(self, tts):
         """Speak the time of sunset"""
         super().__call__(tts)
-        tts(self._format_time(self.cache['daily']['data'][0]['sunsetTime']))
+        tts(format_time(self.cache['daily']['data'][0]['sunsetTime']))
 
 
 class DarkSkyProviderHandler(DarkSkyHandler):

kayleevc/pluginutils.py

@@ -0,0 +1,42 @@
+# This is part of Kaylee
+# -- this code is licensed GPLv3
+# Copyright 2015-2017 Clayton G. Hobbs
+# Portions Copyright 2013 Jezra
+
+"""Helper utilities for Kaylee plugins"""
+
+import time
+
+
+def format_temperature(temperature, precision, unit='degrees Fahrenheit'):
+    """Format a temperature for the TTS system"""
+    return f'{temperature:.{precision}f} {unit}'
+
+def format_percent(value):
+    """Format a floating-point value as a percentage for the TTS system"""
+    return f'{100*value:.0f} percent'
+
+def format_time(seconds=None):
+    """Format a time in seconds since the Epoch for the TTS system"""
+    t = time.localtime(seconds)
+
+    # Format each part of the time to be pronounced nicely
+    hour = time.strftime('%I', t)
+    if hour[0] == '0':
+        hour = hour[1]
+
+    minute = time.strftime('%M', t)
+    if minute[0] == '0':
+        if minute[1] == '0':
+            minute = "o'clock"
+        else:
+            minute = 'O' + minute[1]
+
+    ante_post = time.strftime('%p', t)
+    if ante_post[0] == 'A':
+        ante_post = 'AE ' + ante_post[1]
+    elif ante_post[0] == 'P':
+        ante_post = 'P ' + ante_post[1]
+
+    # Put the parts together
+    return f'{hour} {minute} {ante_post}'