file_status: allow several paths, new format

py3status/modules/file_status.py

@@ -1,22 +1,45 @@
 # -*- coding: utf-8 -*-
 """
-Display if a file or directory exists.
+Display if a files or directories exists.
 
 Configuration parameters:
     cache_timeout: how often to run the check (default 10)
-    format: format of the output. (default '{icon}')
-    icon_available: icon to display when available (default '●')
-    icon_unavailable: icon to display when unavailable (default '■')
-    path: the path to a file or dir to check if it exists (default None)
+    format: format of the output. (default '\?color=paths [\?if=paths ●|■]')
+    format_path: format of the path output. (default '{basename}')
+    format_path_separator: show separator if more than one (default ' ')
+    path: the path(s) to a file or dir to check if it exists, take a list (default None)
+    thresholds: specify color thresholds to use (default [(0, 'bad'), (1, 'good')])
 
 Color options:
     color_bad: Error or file/directory does not exist
     color_good: File or directory exists
 
 Format placeholders:
-    {icon} icon for the current availability
-
-@author obb, Moritz Lüdecke
+    {format_path} paths of matching files
+    {paths} number of paths, eg 1, 2, 3
+
+format_path path placeholders:
+    {basename} basename of matching files
+    {fullpath} fullpath of matching files
+
+Examples:
+```
+# check files with wildcard, or contain user path, full paths
+file_status {
+    path = ['/tmp/test*', '~user/test1']
+    format = u'\?if=paths ● {format_path}|■ no files found'
+    format_path = '{fullpath}'
+}
+
+# change color on files match
+file_status {
+    path = ['/tmp/test*', '~user/test1']
+    format = u'\?color=paths ●'
+    thresholds = [(0, 'bad'), (1, 'good')]
+}
+```
+
+@author obb, Moritz Lüdecke, Cyril Levis (@cyrinux), @lasers
 
 SAMPLE OUTPUT
 {'color': '#00FF00', 'full_text': u'\u25cf'}
@@ -25,20 +48,23 @@
 {'color': '#FF0000', 'full_text': u'\u25a0'}
 """
 
-from os.path import expanduser, exists
+from glob import glob
+from os.path import basename, expanduser
 
 ERR_NO_PATH = 'no path given'
+DEFAULT_FORMAT = u'\?color=paths [\?if=paths ●|■]'
 
 
 class Py3status:
     """
     """
     # available configuration parameters
     cache_timeout = 10
-    format = '{icon}'
-    icon_available = u'●'
-    icon_unavailable = u'■'
+    format = DEFAULT_FORMAT
+    format_path = u'{basename}'
+    format_path_separator = u' '
     path = None
+    thresholds = [(0, 'bad'), (1, 'good')]
 
     class Meta:
         deprecated = {
@@ -57,8 +83,25 @@ class Meta:
         }
 
     def post_config_hook(self):
+        # deprecation
+        on = getattr(self, 'icon_available', None)
+        off = getattr(self, 'icon_unavailable', None)
+        if self.format == DEFAULT_FORMAT and (on or off):
+            self.format = u'\?if=paths {}|{}'.format(on or u'●', off or u'■')
+            msg = 'DEPRECATION: you are using old style configuration '
+            msg += 'parameters you should update to use the new format.'
+            self.py3.log(msg)
+
         if self.path:
-            self.path = expanduser(self.path)
+            # backward compatibility, str to list
+            if not isinstance(self.path, list):
+                self.path = [self.path]
+            # expand user paths
+            self.path = list(map(expanduser, self.path))
+
+            self.init = {
+                'format_path': self.py3.get_placeholders_list(self.format_path)
+            }
 
     def file_status(self):
         if self.path is None:
@@ -68,17 +111,40 @@ def file_status(self):
                 'cached_until': self.py3.CACHE_FOREVER,
             }
 
-        if exists(self.path):
-            icon = self.icon_available
-            color = self.py3.COLOR_GOOD
-        else:
-            icon = self.icon_unavailable
-            color = self.py3.COLOR_BAD
+        # init datas
+        paths = sorted([files for path in self.path for files in glob(path)])
+        paths_number = len(paths)
+
+        # get thresholds
+        if self.thresholds:
+            self.py3.threshold_get_color(paths_number, 'paths')
+
+        # format paths
+        if self.init['format_path']:
+            format_path = {}
+            format_path_separator = self.py3.safe_format(
+                self.format_path_separator)
+
+            for key in self.init['format_path']:
+                if key == 'basename':
+                    temps_paths = map(basename, paths)
+                elif key == 'fullpath':
+                    temps_paths = paths
+                else:
+                    continue
+                format_path[key] = self.py3.composite_join(
+                    format_path_separator, temps_paths)
+
+            format_path = self.py3.safe_format(self.format_path, format_path)
 
         response = {
-            'cached_until': self.py3.time_in(self.cache_timeout),
-            'full_text': self.py3.safe_format(self.format, {'icon': icon}),
-            'color': color
+            'cached_until':
+            self.py3.time_in(self.cache_timeout),
+            'full_text':
+            self.py3.safe_format(self.format, {
+                'paths': paths_number,
+                'format_path': format_path
+            })
         }
 
         return response