sima/lib/plugin.py

   1 # -*- coding: utf-8 -*-
   2
   3 class Plugin():
   4     """
   5     First non-empty line of the docstring is used as description
   6     Rest of the docstring at your convenience.
   7
   8     The plugin Name MUST be the same as the module (file name), case
   9     insensitive: for instance plugin.py → Plugin
  10     It eases plugins discovery and simplifies the code to handle them,
  11     IMHO, it's a fair trade-off.
  12     """
  13
  14     @classmethod
  15     def info(cls):
  16         """self documenting class method
  17         """
  18         doc = 'Undocumented plugin! Fill "{}" docstring'.format(cls.__name__)
  19         if cls.__doc__:
  20             doc = cls.__doc__.strip(' \n').splitlines()[0]
  21         return {'name': cls.__name__,
  22                 'doc': doc,
  23                 }
  24
  25     def __init__(self, daemon):
  26         self.log = daemon.log
  27         self.__daemon = daemon
  28         self.plugin_conf = None
  29         self.__get_config()
  30
  31     def __str__(self):
  32         return self.__class__.__name__
  33
  34     def __get_config(self):
  35         """Get plugin's specific configuration from global applications's config
  36         """
  37         conf = self.__daemon.config
  38         for sec in conf.sections():
  39             if sec.lower() == self.__class__.__name__.lower():
  40                 self.plugin_conf = dict(conf.items(sec))
  41         #if self.plugin_conf:
  42         #    self.log.debug('Got config for {0}: {1}'.format(self,
  43         #                                                    self.plugin_conf))
  44
  45     def callback_player(self):
  46         """
  47         Called on player changes, stopped, paused, skipped
  48         """
  49         pass
  50
  51     def callback_player_database(self):
  52         """
  53         Called on player music library changes
  54         """
  55         pass
  56
  57     def callback_playlist(self):
  58         """
  59         Called on playlist changes
  60
  61         Not returning data
  62         """
  63         pass
  64
  65     def callback_next_song(self):
  66         """Not returning data,
  67         Could be use to scrobble, maintain an history…
  68         """
  69         pass
  70
  71     def callback_need_track(self):
  72         """Returns a list of Track objects to add
  73         """
  74         pass
  75
  76     def callback_need_track_fb(self):
  77         """Called when callback_next_song failled to find tracks to queue
  78         Returns a list of Track objects to add
  79         """
  80         pass
  81
  82     def shutdown(self):
  83         pass
  84
  85
  86 # VIM MODLINE
  87 # vim: ai ts=4 sw=4 sts=4 expandtab