]> kaliko git repositories - mpd-sima.git/commitdiff
Extract Tags control_config method from plugin
authorkaliko <kaliko@azylum.org>
Wed, 21 Apr 2021 13:31:55 +0000 (15:31 +0200)
committerkaliko <kaliko@azylum.org>
Wed, 21 Apr 2021 13:31:55 +0000 (15:31 +0200)
Ease reuse outside of plugin

sima/plugins/internal/tags.py

index 01a312501dbd541c6c4cb4a9363e8ef7bced210b..70d1a03e06609aaa774e94ade588ab98717d8cca 100644 (file)
@@ -22,6 +22,7 @@ Add titles based on tags
 """
 
 # standard library import
+import logging
 import random
 
 # third parties components
@@ -33,6 +34,26 @@ from ...lib.meta import Artist, MetaContainer
 from ...utils.utils import PluginException
 
 
+def control_config(tags_config):
+    log = logging.getLogger('sima')
+    sup_tags = Tags.supported_tags
+    config_tags = {k for k, v in tags_config.items()
+                   if (v and k in Tags.supported_tags)}
+    if not tags_config.get('filter', None) and \
+            config_tags.isdisjoint(sup_tags):
+        log.warning('Found no config for Tags plugin! '
+                  'Need at least "filter" or a supported tag')
+        log.info('Supported Tags are : %s', ', '.join(sup_tags))
+        # raise PluginException('plugin misconfiguration')
+        return False
+    if config_tags.difference(sup_tags):
+        log.error('Found unsupported tag in config: %s',
+                   config_tags.difference(sup_tags))
+        # raise PluginException('plugin misconfiguration')
+        return False
+    return True
+
+
 def forge_filter(cfg):
     tags = set(cfg.keys()) & Tags.supported_tags
     cfg_filter = cfg.get('filter', None)
@@ -57,7 +78,8 @@ class Tags(AdvancedPlugin):
     """Add track based on tags content
     """
     supported_tags = {'comment', 'date', 'genre', 'label', 'originaldate'}
-    options = {'queue_mode', 'priority', 'filter', 'track_to_add', 'album_to_add'}
+    # options = {'queue_mode', 'priority', 'filter', 'track_to_add',
+    #            'album_to_add'}
 
     def __init__(self, daemon):
         super().__init__(daemon)
@@ -67,18 +89,7 @@ class Tags(AdvancedPlugin):
         self.log.debug('mpd filter: %s', self.mpd_filter)
 
     def _control_conf(self):
-        sup_tags = Tags.supported_tags
-        config_tags = {k for k, v in self.plugin_conf.items()
-                       if (v and k not in Tags.options)}
-        if not self.plugin_conf.get('filter', None) and \
-                config_tags.isdisjoint(sup_tags):
-            self.log.error('Found no config for %s plugin! '
-                           'Need at least "filter" or a supported tag', self)
-            self.log.info('Supported Tags are : %s', ', '.join(sup_tags))
-            raise PluginException('plugin misconfiguration')
-        if config_tags.difference(sup_tags):
-            self.log.error('Found unsupported tag in config: %s',
-                           config_tags.difference(sup_tags))
+        if not control_config(self.plugin_conf):
             raise PluginException('plugin misconfiguration')
 
     def _setup_tagsneeded(self):