refactored handlers using decorators

Author: sudormrfbin

CHANGELOG.md

@@ -4,12 +4,11 @@ CHANGELOG
 v0.7.0
 ------
 
-- [ ] Batch tag files
+- [x] Batch tag files
 - [ ] Customizable keybindings
 - [ ] Autocomplete in genre tag field
 - [x] Filename field in tag editing view
 - [ ] Short description of preferences option in status line
-- [x] Use `l` to invoke a search box for searching for files(`n` for next match, 'N' for previous match
 
 v0.6.3
 ------

README.md

@@ -45,8 +45,7 @@ $ [sudo] pip install clid
 ### From Source
 
 ```shell
-$ git clone https://github.com
-$ /GokulSoumya/clid.git
+$ git clone https://github.com/GokulSoumya/clid.git
 $ cd clid
 $ [sudo] python3 setup.py install
 ```

clid/_const.py

@@ -212,8 +212,10 @@
     '%A': 'album_artist'
 }
 
+# for matching format specifiers
 FORMAT_PAT = re.compile(r'%.')
 
+# dict with  {name of textbox: name of field like artist. album, etc}
 TAG_FIELDS = {
     'tit': 'title',
     'alb': 'album',
@@ -224,7 +226,7 @@
     'ala': 'album_artist'
 }
 
- 
+# value of date must match this regex
 DATE_PATTERN = re.compile(r"""(?x)\s*
                 ((?P<year>[0-9]{4})       # YYYY
                 (-(?P<month>[01][0-9])    # -MM
@@ -236,3 +238,11 @@
                 (:(?P<sec>[0-6][0-9])     # :SS
                 )?)?)?\s*
                 """)
+
+# name of keypress handler which require a update of status line
+HANDLERS_REQUIRING_STATUS_UDPATE = (
+    'h_cursor_line_up',
+    'h_cursor_line_down',
+    'h_cursor_page_up',
+    'h_cursor_page_down'
+)

clid/base.py

@@ -250,7 +250,9 @@ def on_ok(self):   # char is for handlers
                 tag = track if field == 'track' else getattr(self, tbox).value   # get value to be written to file
                 setattr(meta, field, tag)
             meta.write(mp3)
-            # show the new tags in the status line
-            main_form.wMain.set_status(filename=os.path.basename(mp3), force=True)
+            # update meta cache
+            main_form.value.parse_meta_for_status(filename=os.path.basename(mp3), force=True)
 
+        # show the new tags in the status line
+        main_form.wMain.set_current_status()
         return True

clid/database.py

@@ -204,7 +204,8 @@ def music_dir(self):
     def preview_format(self):
         self.main_form.value.meta_cache = dict()
         self.main_form.value.load_preview_format()
-        self.main_form.wMain.set_status(self.main_form.wMain.get_selected())   # change current file's preview into new format
+        # change current file's preview into new format
+        self.main_form.wMain.set_current_status()
 
     def smooth_scroll(self):
         smooth = self.settings['smooth_scroll']

clid/main.py

@@ -10,6 +10,7 @@
 
 from . import base
 from . import pref
+from . import _const
 from . import database
 from . import editmeta
 
@@ -48,7 +49,27 @@ def search_for_files(self, command_line, widget_proxy, live):
 
         self.parent.after_search_now_filter_view = True
         self.parent.wMain.values = self.parent.value.get()
-        self.parent.wMain.display()
+        self.parent.display()
+        if self.parent.wMain.values:
+            self.parent.wMain.set_current_status()
+        else:   # search didn't match
+            self.parent.wStatus2.value = ' '
+            self.parent.display()
+
+
+def special_handler(handler):
+    """Decorator which accepts a handler as param and executes it
+       only if the window is not empty(if there are files to display)
+       If the handler requires the status line to be updated(like with
+       movement handlers like h_cursor_line_up to show metadata preview
+       of file under cursor), that is also done
+    """
+    def wrapper(self, char):
+        if self.values:
+            handler(self, char)
+            if handler.__name__ in _const.HANDLERS_REQUIRING_STATUS_UDPATE:
+                self.set_current_status()
+    return wrapper
 
 
 class ClidMultiline(npy.MultiLine):
@@ -70,7 +91,6 @@ class ClidMultiline(npy.MultiLine):
             self.parent refers to ClidInterface -> class
             self.parent.value refers to database.Mp3DataBase -> class
     """
-
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.allow_filtering = False   # does NOT refer to search invoked with '/'
@@ -79,49 +99,45 @@ def __init__(self, *args, **kwargs):
         smooth = self.parent.parentApp.settings['smooth_scroll']   # is smooth scroll enabled ?
         self.slow_scroll = True if smooth == 'true' else False
 
-    def set_up_handlers(self):
-        super().set_up_handlers()
         self.handlers.update({
             'u':              self.h_reload_files,
             '2':              self.h_switch_to_settings,
             curses.ascii.SP:  self.h_multi_select,
             curses.ascii.ESC: self.h_revert_escape,
         })
 
-        self.h_cursor_line_down = self.handler_with_status_updating(self.h_cursor_line_down)
-        self.h_cursor_line_up = self.handler_with_status_updating(self.h_cursor_line_up)
-        self.h_cursor_page_down = self.handler_with_status_updating(self.h_cursor_page_down)
-        self.h_cursor_page_up = self.handler_with_status_updating(self.h_cursor_page_up)
+        # self.h_cursor_line_up = special_handler(self.h_cursor_line_up)
+        # self.h_cursor_line_down = special_handler(self.h_cursor_line_down)
+        # self.h_cursor_page_up = special_handler(self.h_cursor_page_up)
+        # self.h_cursor_page_down = special_handler(self.h_cursor_page_down)
 
+    # Movement Handlers
+    @special_handler
+    def h_cursor_page_up(self, char):
+        super().h_cursor_page_up(char)
 
-    def run_only_if_window_is_not_empty(handler):
-        """Decorator which accepts a handler as param and executes it
-           only if the window is not empty(if there are files to display)
-        """
-        def wrapper(self, char):
-            if self.values:
-                handler(self, char)
-        return wrapper
-
-    @staticmethod
-    def handler_with_status_updating(handler):
-        """Decorator which adds status line updating(set status line's value
-           according to tags of file undef cursor) and `run_only_if_window_is_not_empty`
-           functionality to movement handler(up, down, page up, etc)
-        """
-        def wrapper(self, char):
-            if self.values:
-                handler(self, char)
-                self.set_status(self.get_selected())
-        return wrapper
+    @special_handler
+    def h_cursor_page_down(self, char):
+        super().h_cursor_page_down(char)
+
+    @special_handler
+    def h_cursor_line_up(self, char):
+        super().h_cursor_line_up(char)
+
+    @special_handler
+    def h_cursor_line_down(self, char):
+        super().h_cursor_line_down(char)
 
     @property
     def _relative_index_of_space_selected_values(self):
-        return [self.values.index(file) for file in self.space_selected_values if file in self.values]
-
-    def set_status(self, filename, **kwargs):
-        """Set the the value of self.parent.wStatus2 with metadata of file under cursor."""
-        self.parent.wStatus2.value = self.parent.value.parse_meta_for_status(filename=filename, **kwargs)
+        return [self.values.index(file) for file in self.space_selected_values\
+                if file in self.values]
+
+    def set_current_status(self, *args, **kwargs):
+        """Show metadata(preview) of file under cursor in the status line"""
+        s = self.parent.value.parse_meta_for_status(
+            filename=self.get_selected(), *args, **kwargs)
+        self.parent.wStatus2.value = s
         self.parent.display()
 
     def get_selected(self):
@@ -154,7 +170,7 @@ def h_switch_to_settings(self, char):
         self.parent.parentApp.switchForm("SETTINGS")
 
 
-    @run_only_if_window_is_not_empty
+    @special_handler
     def h_select(self, char):
         app = self.parent.parentApp
         file_dict = self.parent.value.file_dict
@@ -171,7 +187,7 @@ def h_select(self, char):
             self.parent.parentApp.current_files = [file_dict[file_under_cursor]]
             self.parent.parentApp.switchForm("SINGLEEDIT")
 
-    @run_only_if_window_is_not_empty
+    @special_handler
     def h_multi_select(self, char):
         """Add or remove current line from list of lines
            to be highlighted, when <Space> is pressed.