Refactor of clock module.

Reintroduces `pytz` dependency for time zone data.

i3pystatus/clock.py

@@ -1,6 +1,6 @@
 import os
 import locale
-import time
+from datetime import datetime
 
 from i3pystatus import IntervalModule
 
@@ -9,7 +9,10 @@ class Clock(IntervalModule):
     """
     This class shows a clock.
 
-    format can be passed in four different ways:
+    .. note:: Optionally requires `pytz` for time zone data when using time
+        zones other than local time.
+
+    Format can be passed in four different ways:
 
     - single string, no timezone, just the strftime-format
     - one two-tuple, first is the format, second the timezone
@@ -52,7 +55,6 @@ class Clock(IntervalModule):
     format = None
     color = "#ffffff"
     interval = 1
-    current_format_id = 0
     on_upscroll = ["scroll_format", 1]
     on_downscroll = ["scroll_format", -1]
 
@@ -70,7 +72,7 @@ class Clock(IntervalModule):
             lang = (None, None)
 
         if lang != locale.getlocale(locale.LC_TIME):
-            # affects time.strftime() in whole program
+            # affects language of *.strftime() in whole program
             locale.setlocale(locale.LC_TIME, lang)
 
         if self.format is None:
@@ -83,47 +85,24 @@ class Clock(IntervalModule):
 
         elif isinstance(self.format, str) or isinstance(self.format, tuple):
             self.format = [self.format]
-
+        self.format = [self._expand_format(fmt) for fmt in self.format]
-        self._local_tzname = self._get_local_tz()
+        self.current_format_id = 0
-        self._non_daylight_zone = time.tzname[0]
-        self.format = self.expand_formats(self.format)
 
     @staticmethod
-    def _get_local_tz():
+    def _expand_format(fmt):
-        '''
+        if isinstance(fmt, tuple):
-        Returns a string representing localtime, suitable for setting localtime
+            if len(fmt) == 1:
-        using time.tzset().
+                return (fmt[0], None)
-
-        https://docs.python.org/3/library/time.html#time.tzset
-        '''
-        hours_offset = time.timezone / 3600.0
-        plus_minus = '+' if hours_offset >= 0 else '-'
-        hh = int(hours_offset)
-        mm = 60 * (hours_offset % 1)
-        return '%s%s%02d:%02d%s' % (time.tzname[0], plus_minus,
-                                    hh, mm, time.tzname[1])
-
-    @staticmethod
-    def expand_formats(formats):
-        def expand_format(format_):
-            if isinstance(format_, tuple):
-                # check if timezone exists (man tzset)
-                if len(format_) > 1 and os.path.isfile('/usr/share/zoneinfo/' + format_[1]):
-                    return (format_[0], format_[1])
             else:
-                    return (format_[0], None)
+                try:
-            return (format_, None)
+                    from pytz import timezone
-
+                except ImportError as e:
-        return [expand_format(format_) for format_ in formats]
+                    raise RuntimeError("Need `pytz` for timezone data") from e
+                return (fmt[0], timezone(fmt[1]))
+        return (fmt, None)
 
     def run(self):
-        # set timezone
+        time = datetime.now(self.format[self.current_format_id][1])
-        target_tz = self.format[self.current_format_id][1]
-        if target_tz is None and time.tzname[0] != self._non_daylight_zone \
-                or target_tz is not None and time.tzname[0] != target_tz:
-            new_tz = self._local_tzname if target_tz is None else target_tz
-            os.environ.putenv('TZ', new_tz)
-            time.tzset()
 
         self.output = {
             "full_text": time.strftime(self.format[self.current_format_id][0]),