v0.6.0

Author: sudormrfbin

CHANGELOG.md

@@ -4,7 +4,9 @@ CHANGELOG
 v0.5.4
 ------
 
-- [ ] Add preferences option for custom preview in main view
+- [x] Add Home/End for command line
+- [x] Use `set` command(to edit preferences) form main view
+- [x] Add preferences option for custom preview in main view
 
 
 v0.5.3

clid/_const.py

@@ -205,7 +205,7 @@
     '%y': 'date',
     '%l': 'album',
     '%t': 'title',
-    '%n': 'track',
+    # '%n': 'track',
     '%a': 'artist',
     '%c': 'comment',
     # '%g': 'genre',

clid/base.py

@@ -6,16 +6,21 @@
 
 import npyscreen as npy
 
-class ClidCommandLine(npy.ActionControllerSimple):
+class ClidActionController(npy.ActionControllerSimple):
     """Base class for the command line at the bootom of the screen"""
 
     def create(self):
         self.add_action('^:q$', self.exit_app, live=False)   # quit with ':q'
+        self.add_action('^:set .+', self.change_setting, live=False)
+
 
     def exit_app(self, command_line, widget_proxy, live):
         """Exit the app with ':q'"""
         exit()   # args are used internally by npyscreen
 
+    def change_setting(self, command_line, widget_proxy, live):
+        """Change a setting in the ini file"""
+        pass   # different for main and pref view; defined in respective files
 
 class ClidTextfield(npy.wgtextbox.Textfield):
     def set_up_handlers(self):
@@ -29,5 +34,10 @@ def h_home(self, char):
     def h_end(self, char):
         self.cursor_position = len(self.value)
 
+
 class ClidTitleText(npy.TitleText):
     _entry_type = ClidTextfield
+
+
+class ClidCommandLine(npy.fmFormMuttActive.TextCommandBoxTraditional, ClidTextfield):
+    pass   # for making home and end keys work

clid/database.py

@@ -7,7 +7,8 @@
 
 import stagger
 import npyscreen
-import configobj
+
+from . import _const
 
 CONFIG = os.path.expanduser('~/.clid.ini')
 
@@ -19,24 +20,45 @@ class Mp3DataBase(npyscreen.NPSFilteredDataBase):
             file_dict(dict):
                 dict with the filename as key and absolute path to
                 file as value. Used for displaying files and changing
-                metadata
+                metadata.
+            settings(configobj.ConfigObj):
+                used for accessing the ini file.
+            pre_format(str):
+                string with format specifiers used to display preview of
+                files' tags.
+            specifiers(list):
+                list of format specifiers in pre_format
+            meta_cache(dict):
+                cache which holds the metadata of files as they are selected.
+
     """
     def __init__(self):
         super().__init__()
 
-        self.load_files_and_set_values()   # set `file_dict` and `_values` attribute
-        self.meta_cache = dict()   # cache which holds the metadata of files as they are selected
+        self.settings = None   # set by main.ClidInterface
+        self.file_dict = None
+        self.meta_cache = dict()
 
  # IDEA: set_values and set_search_list for updating values and search_list when refreshed
 
+    def filter_data(self):
+        if self._filter and self._values:
+            return [mp3 for mp3 in self.get_all_values() if self._filter in mp3.lower()]
+        else:
+            return self.get_all_values()
+
+    def load_preview_format(self):
+        """Make approriate varibles to hold preview formats""" 
+        self.pre_format = self.settings['preview_format']
+        self.specifiers = _const.FORMAT_PAT.findall(self.pre_format)
 
     def load_files_and_set_values(self):
         """- Get a list of mp3 files in BASE_DIR recursively
            - Make a dict out of it
            - Assign it to `file_dict`
            - Set `_values` attribute
         """
-        base = configobj.ConfigObj(CONFIG)['music_dir']
+        base = self.settings['music_dir']
 
         ret_list = []
         for dir_tree in os.walk(base, followlinks=True):   # get all mp3 files in the dir and sub-dirs
@@ -46,11 +68,6 @@ def load_files_and_set_values(self):
         self.file_dict = dict([(os.path.basename(abspath), abspath) for abspath in ret_list])
         self._values = tuple(sorted(self.file_dict.keys()))   # sorted tuple of filenames
 
-    def filter_data(self):
-        if self._filter and self._values:
-            return [mp3 for mp3 in self.get_all_values() if self._filter in mp3.lower()]
-        else:
-            return self.get_all_values()
 
     def parse_meta_for_status(self, filename):
         """Make a string like 'artist - album - track_number. title' from a filename
@@ -61,16 +78,14 @@ def parse_meta_for_status(self, filename):
         """
         if not filename in self.meta_cache:
             try:
-                metadata = stagger.read_tag(self.file_dict[filename])
-                self.meta_cache[filename] = '{art} - {alb} - {tno}. {title} '.format(
-                    art=metadata.artist,
-                    alb=metadata.album,
-                    # stagger saves track number as 0 if it is not given(won't be shown in players)
-                    tno=metadata.track if metadata.track != 0 else ' ',
-                    title=metadata.title
-                    )
+                meta = stagger.read_tag(self.file_dict[filename])
+                temp = self.pre_format   # make a copy of format and replace specifiers with tags
+
+                for spec in self.specifiers:
+                    temp = temp.replace(spec, getattr(meta, _const.FORMAT[spec]))
+                self.meta_cache[filename] = temp
             except stagger.errors.NoTagError:
-                self.meta_cache[filename] = ' - - . '
+                self.meta_cache[filename] = _const.FORMAT_PAT.sub('', self.specifiers)
 
         return self.meta_cache[filename]
 
@@ -82,9 +97,9 @@ class SettingsDataBase(object):
     """Class to manage the settings/config file.
 
        Attributes:
-            _settings(configobj.ConfigObj):
+            settings(configobj.ConfigObj):
                 `ConfigObj` object for the clid.ini file
-            parent(pref.PreferencesView):
+            parent(npyscreen.FormMuttActiveTraditional):
                 used to refer to parent form(pref.PreferencesView)
             disp_strings(list):
                 list of formatted strings which will be used to display settings in the window
@@ -94,31 +109,36 @@ class SettingsDataBase(object):
     """
     def __init__(self):
         self.parent = None   # set by parent; see docstring
+        self.settings = None   # also set by parent
         self.when_changed = {
             'music_dir': self.music_dir,
             'preview_format': self.preview_format
         }
 
-        self._settings = configobj.ConfigObj(CONFIG)
-        self.make_strings()
 
     def make_strings(self):
         """Make a list of strings which will be used to display the settings
            in the editing window
         """
-        self.disp_strings = [key + '  ' + value for key, value in self._settings.items()]
+        self.disp_strings = [key + '  ' + value for key, value in self.settings.items()]
 
     def change_setting(self, key, new):
         """Change a setting in the clid.ini"""
-        if key in self._settings:
-            self._settings[key] = new
-            self._settings.write()
+        if key in self.settings:
+            self.settings[key] = new
+            self.settings.write()
             self.when_changed[key]()
 
     def music_dir(self):
+        """To be executed when `music_dir` option is changed"""
         main_form = self.parent.parentApp.getForm("MAIN")
         main_form.value.load_files_and_set_values()
         main_form.load_files()
 
     def preview_format(self):
-        pass
+        """To be executed when `preview_format` option is changed"""
+        main_form = self.parent.parentApp.getForm("MAIN")
+        main_form.value.meta_cache = dict()
+        main_form.value.load_preview_format()
+        main_form.wMain.set_status(main_form.wMain.get_selected())   # change current file's preview into new format
+

clid/main.py

@@ -1,8 +1,11 @@
 #!/usr/bin/env python3
 
-__version__ = '0.5.3'
+__version__ = '0.6.0'
 
+import os
 import curses
+
+import configobj
 import npyscreen as npy
 
 from . import base
@@ -11,8 +14,9 @@
 from . import editmeta
 
 
-class CommandLine(base.ClidCommandLine):
-    """Command line at the bottom.
+class MainActionController(base.ClidActionController):
+    """Object that recieves recieves inpout in command line
+       at the bottom.
 
        Note:
             self.parent refers to ClidInterface -> class
@@ -22,6 +26,16 @@ def create(self):
         super().create()
         self.add_action('^/.+', self.search_for_files, live=True)   # search with '/'
 
+    def change_setting(self, command_line, widget_proxy, live):
+        setting = command_line[5:].split(sep='=')
+        pref_form = self.parent.parentApp.getForm("SETTINGS")
+        pref_form.value.change_setting(setting[0], setting[1])   # writes to the ini file
+        pref_form.value.when_changed[setting[0]]()
+
+        pref_form.load_pref()
+        pref_form.wMain.display()
+
+
     def search_for_files(self, command_line, widget_proxy, live):
         """Search for files while given a string"""
         if len(command_line[1:]) > 2:   # first char will be '/'
@@ -122,18 +136,21 @@ class ClidInterface(npy.FormMuttActiveTraditional):
        Note:
             self.value refers to an instance of DATA_CONTROLER
     """
-    ACTION_CONTROLLER = CommandLine
-    MAIN_WIDGET_CLASS = ClidMultiline
     DATA_CONTROLER = database.Mp3DataBase
+    MAIN_WIDGET_CLASS = ClidMultiline
+    ACTION_CONTROLLER = MainActionController
+    COMMAND_WIDGET_CLASS = base.ClidCommandLine
 
-    def create(self):
-        super().create()   # so that status widgets are created
-        self.set_value(self.DATA_CONTROLER())   # isn't automatically done(open issue ?)
-
-        # used to revert screen(ESC) to standard view after a search(see class ClidMultiline)
-        self.after_search_now_filter_view = False
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.set_value(self.DATA_CONTROLER())
+        self.value.settings = self.parentApp.settings
+        self.value.load_files_and_set_values()
+        self.value.load_preview_format()
 
         self.load_files()
+
+        # widgets are created by self.create() in super()
         self.wStatus1.value = 'clid v' + __version__ + ' '
 
         try:
@@ -142,17 +159,33 @@ def create(self):
             self.wStatus2.value = 'No Files Found In Directory'
             self.wMain.values = []
 
+        self.after_search_now_filter_view = False
+        # used to revert screen(ESC) to standard view after a search(see class ClidMultiline)
+
     # change to `load_pref`
     def load_files(self):
         """Set the mp3 files that will be displayed"""
         self.wMain.values = self.value.get_all_values()
 
 
 class ClidApp(npy.NPSAppManaged):
-    def onStart(self):
+    """Class used by npyscreen to manage forms.
+
+       Attributes:
+            current_file(str):
+                file selected when in main_view(path)
+            settings(configobj.ConfigObj):
+                object used to read and write preferences
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         npy.setTheme(npy.Themes.ElegantTheme)
 
         self.current_file = None   # changed when a file is selected in main screen
+        self.settings = configobj.ConfigObj(os.path.expanduser('~/.clid.ini'))
+
+    def onStart(self):
         self.addForm("MAIN", ClidInterface)
         self.addForm("SETTINGS", pref.PreferencesView)
         self.addFormClass("EDIT", editmeta.EditMeta)   # addFormClass to create a new instance every time

clid/pref.py

@@ -8,11 +8,7 @@
 from . import database
 
 
-class PrefCommandLine(base.ClidCommandLine):
-    def create(self):
-        super().create()
-        self.add_action('^:set .+', self.change_setting, live=False)
-
+class PrefActionController(base.ClidActionController):
     def change_setting(self, command_line, widget_proxy, live):
         setting = command_line[5:].split(sep='=')
         self.parent.value.change_setting(setting[0], setting[1])   # writes to the ini file
@@ -25,7 +21,7 @@ def change_setting(self, command_line, widget_proxy, live):
 class PrefMultiline(npy.MultiLine):
     def set_up_handlers(self):
         super().set_up_handlers()
-        
+
         self.handlers['1'] = self.switch_to_main
 
     def switch_to_main(self, char):
@@ -41,17 +37,17 @@ def h_select(self, char):
 class PreferencesView(npy.FormMuttActiveTraditional):
     """View for editing preferences/settings"""
     MAIN_WIDGET_CLASS = PrefMultiline
-    ACTION_CONTROLLER = PrefCommandLine
+    ACTION_CONTROLLER = PrefActionController
+    COMMAND_WIDGET_CLASS = base.ClidCommandLine
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.set_value(database.SettingsDataBase())
         self.value.parent = self
+        self.value.settings = self.parentApp.settings
+        self.value.make_strings()
         self.load_pref()
 
-
-    def create(self):
-        super().create()
         self.wStatus1.value = 'Preferences '
 
     def load_pref(self):

sdf

@@ -7,3 +7,17 @@ multiline: <clid.database.SettingsDataBase object at 0xb6b1978c>
 PrefCommandLine
 <weakproxy at 0xb6af8fcc to PreferencesView at 0xb6b025cc>
 <clid.database.SettingsDataBase object at 0xb6b1978c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bb9a0c>
+multiline: <clid.database.SettingsDataBase object at 0xb6b418ec>
+multiline: <clid.database.SettingsDataBase object at 0xb6b10fac>
+multiline: <clid.database.SettingsDataBase object at 0xb6adb3ac>
+multiline: <clid.database.SettingsDataBase object at 0xb6b2ffac>
+multiline: <clid.database.SettingsDataBase object at 0xb6b2ffac>
+multiline: <clid.database.SettingsDataBase object at 0xb6b8dc6c>
+multiline: <clid.database.SettingsDataBase object at 0xb6b0304c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bacc4c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bacc4c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bacc4c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bacc6c>
+multiline: <clid.database.SettingsDataBase object at 0xb6bacc6c>
+multiline: <clid.database.SettingsDataBase object at 0xb6becd4c>