Merge into trunk : pluginsV2 : Code : Entertainer Media Center

Status:	Rejected
Rejected by:	Paul Hummer on 2008-11-30
Proposed branch:	lp:~joshuascotton/entertainer/pluginsV2
Merge into:	lp:entertainer
To merge this branch:	bzr merge lp:~joshuascotton/entertainer/pluginsV2
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Paul Hummer			Needs Fixing on 2008-11-30
Entertainer Release Team	preliminary	2008-10-31	Pending
Review via email: mp+1474@code.launchpad.net

Revision history for this message

Joshua Scotton (joshuascotton) wrote on 2008-10-31:

#

Download full text (5.6 KiB)

=== modified file 'entertainerlib/__init__.py'
--- entertainerlib/__init__.py 2008-06-22 05:08:20 +0000
+++ entertainerlib/__init__.py 2008-10-31 15:30:32 +0000
@@ -1,1 +1,3 @@
'''Entertainer libraries'''
+
+__version__ = 0.2

=== modified file 'entertainerlib/frontend/frontend_client.py'
--- entertainerlib/frontend/frontend_client.py 2008-08-14 23:53:09 +0000
+++ entertainerlib/frontend/frontend_client.py 2008-10-31 15:16:15 +0000
@@ -7,6 +7,7 @@

import sys

+from entertainerlib.utils.plugins import PluginManager
from entertainerlib.utils.configuration import Configuration
from entertainerlib.utils.logger import Logger
from entertainerlib.frontend.backend_connection import BackendConnection
@@ -48,6 +49,15 @@

         self.config = Configuration()
         self.logger = Logger().getLogger('frontend.FrontendClient')
+
+ self.pm = PluginManager()
+
+ print "Starting plugins..."
+
+ for plugin in self.pm.get_plugins():
+ print 'Starting %s...' % (plugin)
+ plugin.load()
+
         self.backend_connection = None # Connection to the backend server
         self.feed_library = None # Feed library
         self.music_library = None # Music library

=== modified file 'entertainerlib/frontend/gui/user_interface.py'
--- entertainerlib/frontend/gui/user_interface.py 2008-10-07 23:23:12 +0000
+++ entertainerlib/frontend/gui/user_interface.py 2008-10-31 15:06:37 +0000
@@ -495,6 +495,10 @@
         @param event: UserEvent object, defines what action has been taken
         """
         type = event.get_type()
+
+ for plugin in self.frontend.pm.get_plugins_by_capability(
+ 'EventPlugin'):
+ plugin.on_event(event)

if(type == UserEvent.PLAYER_PLAY_PAUSE):
if self.current.is_interested_in_play_action():

=== added directory 'entertainerlib/plugins'
=== added file 'entertainerlib/plugins/__init__.py'
=== added file 'entertainerlib/utils/plugins.py'
--- entertainerlib/utils/plugins.py 1970-01-01 00:00:00 +0000
+++ entertainerlib/utils/plugins.py 2008-10-31 15:49:50 +0000
@@ -0,0 +1,87 @@
+"""Plugin Manager Class and Base Plugin Class"""
+
+__licence__ = "GPLv2"
+__copyright__ = "2008, Joshua Scotton"
+__author__ = "Joshua Scotton <email address hidden>"
+
+import os
+
+import entertainerlib
+from entertainerlib import plugins as mod_plugins
+
+
+class PluginManager:
+ """
+ @author Joshua Scotton
+ """
+
+ PLUGIN_DIRS = [ os.path.join(os.path.dirname(__file__), "../../plugins"),
+ #"/usr/share/entertainer/plugins",
+ os.path.expanduser("~/.config/entertainer/plugins") ]
+
+ plugins = {}
+
+ def __init__(self):
+ self.load_plugins()
+
+ def load_plugins(self):
+ #setup plugin paths
+ mod_plugins.__path__ = self.PLUGIN_DIRS
+
+ #load plugin names
+ plugin_names = []
+ for dir in self.PLUGIN_DIRS:
+ for name in os.listdir(dir):
+ path = os.path.join(dir, name)
+ if os.path.isdir(path) and self.is_plugin_module(path):
+ plugin_...

=== modified file 'entertainerlib/__init__.py'
--- entertainerlib/__init__.py	2008-06-22 05:08:20 +0000
+++ entertainerlib/__init__.py	2008-10-31 15:30:32 +0000
@@ -1,1 +1,3 @@
 '''Entertainer libraries'''
+
+__version__ = 0.2

=== modified file 'entertainerlib/frontend/frontend_client.py'
--- entertainerlib/frontend/frontend_client.py	2008-08-14 23:53:09 +0000
+++ entertainerlib/frontend/frontend_client.py	2008-10-31 15:16:15 +0000
@@ -7,6 +7,7 @@
 
 import sys
 
+from entertainerlib.utils.plugins import PluginManager
 from entertainerlib.utils.configuration import Configuration
 from entertainerlib.utils.logger import Logger
 from entertainerlib.frontend.backend_connection import BackendConnection
@@ -48,6 +49,15 @@
 
         self.config = Configuration()
         self.logger = Logger().getLogger('frontend.FrontendClient')
+        
+        self.pm = PluginManager()
+        
+        print "Starting plugins..."
+        
+        for plugin in self.pm.get_plugins():
+            print 'Starting %s...' % (plugin)
+            plugin.load()
+        
         self.backend_connection = None    # Connection to the backend server
         self.feed_library = None          # Feed library
         self.music_library = None         # Music library

=== modified file 'entertainerlib/frontend/gui/user_interface.py'
--- entertainerlib/frontend/gui/user_interface.py	2008-10-07 23:23:12 +0000
+++ entertainerlib/frontend/gui/user_interface.py	2008-10-31 15:06:37 +0000
@@ -495,6 +495,10 @@
         @param event: UserEvent object, defines what action has been taken
         """
         type = event.get_type()
+        
+        for plugin in self.frontend.pm.get_plugins_by_capability(
+            'EventPlugin'):
+            plugin.on_event(event)
 
         if(type == UserEvent.PLAYER_PLAY_PAUSE):
             if self.current.is_interested_in_play_action():

=== added directory 'entertainerlib/plugins'
=== added file 'entertainerlib/plugins/__init__.py'
=== added file 'entertainerlib/utils/plugins.py'
--- entertainerlib/utils/plugins.py	1970-01-01 00:00:00 +0000
+++ entertainerlib/utils/plugins.py	2008-10-31 15:49:50 +0000
@@ -0,0 +1,87 @@
+"""Plugin Manager Class and Base Plugin Class"""
+
+__licence__ = "GPLv2"
+__copyright__ = "2008, Joshua Scotton"
+__author__ = "Joshua Scotton <joshuascotton@gmail.com>"
+
+import os
+
+import entertainerlib
+from entertainerlib import plugins as mod_plugins
+
+
+class PluginManager:
+    """
+    @author Joshua Scotton
+    """
+
+    PLUGIN_DIRS = [ os.path.join(os.path.dirname(__file__), "../../plugins"),
+                   #"/usr/share/entertainer/plugins",
+                   os.path.expanduser("~/.config/entertainer/plugins") ]
+    
+    plugins = {}
+    
+    def __init__(self):
+        self.load_plugins()
+
+    def load_plugins(self):
+        #setup plugin paths
+        mod_plugins.__path__ = self.PLUGIN_DIRS
+        
+        #load plugin names
+        plugin_names = []
+        for dir in self.PLUGIN_DIRS:
+            for name in os.listdir(dir):
+                path = os.path.join(dir, name)
+                if os.path.isdir(path) and self.is_plugin_module(path):
+                    plugin_names.append(name)
+                    
+        #import plugins
+        for name in plugin_names:
+            exec "import entertainerlib.plugins.%s" % name
+        
+        #init plugin class
+        for name in plugin_names:
+            plugin = None
+            exec "plugin = entertainerlib.plugins.%s.get_plugin()" % name
+            if plugin.compatible_version():
+                for c in plugin.capabilities:
+                    self.plugins.setdefault(c, []).append(plugin)
+            else:
+                print "Plugin \"" + name + "\" needs version " + \
+                      str(plugin.__requires__) + " however the current " + \
+                      "version is " + str(entertainerlib.__version__)
+
+    def get_plugins_by_capability(self, capability):
+        """
+        From http://lucumr.pocoo.org/blogarchive/setuptools-plugins
+        @author Armin Ronacher
+        """
+        return self.plugins.get(capability, [])
+
+    def get_plugins(self):
+        """
+        From http://lucumr.pocoo.org/blogarchive/setuptools-plugins
+        @author Armin Ronacher
+        """
+        result = set()
+        for p in self.plugins.itervalues():
+            for plugin in p:
+                result.add(plugin)
+        return list(result)
+    
+    def is_plugin_module(self, path):
+        return os.path.isfile(os.path.join(path, "__init__.py"))
+        
+class EntertainerPlugin:
+    """Base class for all Entertainer Plugins"""
+    capabilities = []
+    
+    __requires__ = 0.0
+    
+    def __init__(self):
+        pass
+    
+    def compatible_version(self):
+        return entertainerlib.__version__ >= self.__requires__
+

=== added directory 'plugins'
=== added directory 'plugins/hello_world'
=== added file 'plugins/hello_world/__init__.py'
--- plugins/hello_world/__init__.py	1970-01-01 00:00:00 +0000
+++ plugins/hello_world/__init__.py	2008-10-31 15:50:09 +0000
@@ -0,0 +1,23 @@
+"""Demo plugin for plugin system"""
+
+__licence__ = "GPLv2"
+__copyright__ = "2008, Joshua Scotton"
+__author__ = "Joshua Scotton <joshuascotton@gmail.com>"
+__version__ = "0.1"
+
+from entertainerlib.utils.plugins import EntertainerPlugin
+
+def get_plugin():
+    return HelloWorld()
+
+class HelloWorld (EntertainerPlugin):
+    """Demo plugin for plugin system"""
+    __requires__ = 0.2
+    
+    capabilities = ['EventPlugin']
+    
+    def on_event(self, event):
+        print "Received event: " + str(event)
+        
+    def load(self):
+        print "Hello World"

Revision history for this message

Paul Hummer (rockstar) wrote on 2008-11-05:

#

Download full text (6.8 KiB)

Good work. It's coming along, which I'm excited about. There are still
a few niggling things still. When this gets completed, I'd like to see
if we can't port the Weather stuff to a plugin.

> === modified file 'entertainerlib/__init__.py'
> --- entertainerlib/__init__.py 2008-06-22 05:08:20 +0000
> +++ entertainerlib/__init__.py 2008-10-31 15:30:32 +0000
> @@ -1,1 +1,3 @@
> '''Entertainer libraries'''
> +
> +__version__ = 0.2
>
> === modified file 'entertainerlib/frontend/frontend_client.py'
> --- entertainerlib/frontend/frontend_client.py 2008-08-14 23:53:09 +0000
> +++ entertainerlib/frontend/frontend_client.py 2008-10-31 15:16:15 +0000
> @@ -7,6 +7,7 @@
>
> import sys
>
> +from entertainerlib.utils.plugins import PluginManager
> from entertainerlib.utils.configuration import Configuration
> from entertainerlib.utils.logger import Logger
> from entertainerlib.frontend.backend_connection import BackendConnection
> @@ -48,6 +49,15 @@
>
> self.config = Configuration()
> self.logger = Logger().getLogger('frontend.FrontendClient')
> +
> + self.pm = PluginManager()
> +
> + print "Starting plugins..."
> +
> + for plugin in self.pm.get_plugins():
> + print 'Starting %s...' % (plugin)
> + plugin.load()
> +
> self.backend_connection = None # Connection to the backend server
> self.feed_library = None # Feed library
> self.music_library = None # Music library
>

No print statements please. It's better to log them.

> === modified file 'entertainerlib/frontend/gui/user_interface.py'
> --- entertainerlib/frontend/gui/user_interface.py 2008-10-07 23:23:12 +0000
> +++ entertainerlib/frontend/gui/user_interface.py 2008-10-31 15:06:37 +0000
> @@ -495,6 +495,10 @@
> @param event: UserEvent object, defines what action has been taken
> """
> type = event.get_type()
> +
> + for plugin in self.frontend.pm.get_plugins_by_capability(
> + 'EventPlugin'):
> + plugin.on_event(event)
>
> if(type == UserEvent.PLAYER_PLAY_PAUSE):
> if self.current.is_interested_in_play_action():
>
> === added directory 'entertainerlib/plugins'
> === added file 'entertainerlib/plugins/__init__.py'
> === added file 'entertainerlib/utils/plugins.py'
> --- entertainerlib/utils/plugins.py 1970-01-01 00:00:00 +0000
> +++ entertainerlib/utils/plugins.py 2008-10-31 15:49:50 +0000
> @@ -0,0 +1,87 @@
> +"""Plugin Manager Class and Base Plugin Class"""
> +
> +__licence__ = "GPLv2"
> +__copyright__ = "2008, Joshua Scotton"
> +__author__ = "Joshua Scotton <email address hidden>"
> +
> +import os
> +
> +import entertainerlib
> +from entertainerlib import plugins as mod_plugins
> +
> +
> +class PluginManager:
> + """
> + @author Joshua Scotton
> + """
> +
> + PLUGIN_DIRS = [ os.path.join(os.path.dirname(__file__), "../../plugins"),
> + #"/usr/share/entertainer/plugins",
> + os.path.expanduser("~/.config/entertainer/plugins") ]
> +
> + plugins = {}
> +
> + def __init__(self):
> + self.load...

Good work.  It's coming along, which I'm excited about.  There are still
a few niggling things still.  When this gets completed, I'd like to see
if we can't port the Weather stuff to a plugin.

> === modified file 'entertainerlib/__init__.py'
> --- entertainerlib/__init__.py	2008-06-22 05:08:20 +0000
> +++ entertainerlib/__init__.py	2008-10-31 15:30:32 +0000
> @@ -1,1 +1,3 @@
>  '''Entertainer libraries'''
> +
> +__version__ = 0.2
> 
> === modified file 'entertainerlib/frontend/frontend_client.py'
> --- entertainerlib/frontend/frontend_client.py	2008-08-14 23:53:09 +0000
> +++ entertainerlib/frontend/frontend_client.py	2008-10-31 15:16:15 +0000
> @@ -7,6 +7,7 @@
>  
>  import sys
>  
> +from entertainerlib.utils.plugins import PluginManager
>  from entertainerlib.utils.configuration import Configuration
>  from entertainerlib.utils.logger import Logger
>  from entertainerlib.frontend.backend_connection import BackendConnection
> @@ -48,6 +49,15 @@
>  
>          self.config = Configuration()
>          self.logger = Logger().getLogger('frontend.FrontendClient')
> +        
> +        self.pm = PluginManager()
> +        
> +        print "Starting plugins..."
> +        
> +        for plugin in self.pm.get_plugins():
> +            print 'Starting %s...' % (plugin)
> +            plugin.load()
> +        
>          self.backend_connection = None    # Connection to the backend server
>          self.feed_library = None          # Feed library
>          self.music_library = None         # Music library
>

No print statements please. It's better to log them.

> === modified file 'entertainerlib/frontend/gui/user_interface.py'
> --- entertainerlib/frontend/gui/user_interface.py	2008-10-07 23:23:12 +0000
> +++ entertainerlib/frontend/gui/user_interface.py	2008-10-31 15:06:37 +0000
> @@ -495,6 +495,10 @@
>          @param event: UserEvent object, defines what action has been taken
>          """
>          type = event.get_type()
> +        
> +        for plugin in self.frontend.pm.get_plugins_by_capability(
> +            'EventPlugin'):
> +            plugin.on_event(event)
>  
>          if(type == UserEvent.PLAYER_PLAY_PAUSE):
>              if self.current.is_interested_in_play_action():
> 
> === added directory 'entertainerlib/plugins'
> === added file 'entertainerlib/plugins/__init__.py'
> === added file 'entertainerlib/utils/plugins.py'
> --- entertainerlib/utils/plugins.py	1970-01-01 00:00:00 +0000
> +++ entertainerlib/utils/plugins.py	2008-10-31 15:49:50 +0000
> @@ -0,0 +1,87 @@
> +"""Plugin Manager Class and Base Plugin Class"""
> +
> +__licence__ = "GPLv2"
> +__copyright__ = "2008, Joshua Scotton"
> +__author__ = "Joshua Scotton <joshuascotton@gmail.com>"
> +
> +import os
> +
> +import entertainerlib
> +from entertainerlib import plugins as mod_plugins
> +
> +
> +class PluginManager:
> +    """
> +    @author Joshua Scotton
> +    """
> +
> +    PLUGIN_DIRS = [ os.path.join(os.path.dirname(__file__), "../../plugins"),
> +                   #"/usr/share/entertainer/plugins",
> +                   os.path.expanduser("~/.config/entertainer/plugins") ]
> +    
> +    plugins = {}
> +    
> +    def __init__(self):
> +        self.load_plugins()
> +
> +    def load_plugins(self):
> +        #setup plugin paths
> +        mod_plugins.__path__ = self.PLUGIN_DIRS
> +        
> +        #load plugin names
> +        plugin_names = []
> +        for dir in self.PLUGIN_DIRS:
> +            for name in os.listdir(dir):
> +                path = os.path.join(dir, name)
> +                if os.path.isdir(path) and self.is_plugin_module(path):
> +                    plugin_names.append(name)
> +                    
> +        #import plugins
> +        for name in plugin_names:
> +            exec "import entertainerlib.plugins.%s" % name
> +        
> +        #init plugin class
> +        for name in plugin_names:
> +            plugin = None
> +            exec "plugin = entertainerlib.plugins.%s.get_plugin()" % name
> +            if plugin.compatible_version():
> +                for c in plugin.capabilities:
> +                    self.plugins.setdefault(c, []).append(plugin)
> +            else:
> +                print "Plugin \"" + name + "\" needs version " + \
> +                      str(plugin.__requires__) + " however the current " + \
> +                      "version is " + str(entertainerlib.__version__)
> +
> +    def get_plugins_by_capability(self, capability):
> +        """
> +        From http://lucumr.pocoo.org/blogarchive/setuptools-plugins
> +        @author Armin Ronacher
> +        """
> +        return self.plugins.get(capability, [])
> +
> +    def get_plugins(self):
> +        """
> +        From http://lucumr.pocoo.org/blogarchive/setuptools-plugins
> +        @author Armin Ronacher
> +        """
> +        result = set()
> +        for p in self.plugins.itervalues():
> +            for plugin in p:
> +                result.add(plugin)
> +        return list(result)
> +    
> +    def is_plugin_module(self, path):
> +        return os.path.isfile(os.path.join(path, "__init__.py"))
> +        
> +class EntertainerPlugin:
> +    """Base class for all Entertainer Plugins"""
> +    capabilities = []
> +    
> +    __requires__ = 0.0
> +    
> +    def __init__(self):
> +        pass
> +    
> +    def compatible_version(self):
> +        return entertainerlib.__version__ >= self.__requires__
> +    
>

I'd rather have EntertainerPlugin be found in
entertainer.plugins.__init__ or entertainer.plugins.plugin or something
similar to that.

> === added directory 'plugins'
> === added directory 'plugins/hello_world'
> === added file 'plugins/hello_world/__init__.py'
> --- plugins/hello_world/__init__.py	1970-01-01 00:00:00 +0000
> +++ plugins/hello_world/__init__.py	2008-10-31 15:50:09 +0000
> @@ -0,0 +1,23 @@
> +"""Demo plugin for plugin system"""
> +
> +__licence__ = "GPLv2"
> +__copyright__ = "2008, Joshua Scotton"
> +__author__ = "Joshua Scotton <joshuascotton@gmail.com>"
> +__version__ = "0.1"
> +
> +from entertainerlib.utils.plugins import EntertainerPlugin
> +
> +def get_plugin():
> +    return HelloWorld()
> +
> +class HelloWorld (EntertainerPlugin):
> +    """Demo plugin for plugin system"""
> +    __requires__ = 0.2
> +    
> +    capabilities = ['EventPlugin']
> +    
> +    def on_event(self, event):
> +        print "Received event: " + str(event)
> +        
> +    def load(self):
> +        print "Hello World"
> 
>

I'd like plugins to always be imported from entertainerlib.plugins, no
matter where they are on the file system.  Once again, bzr's plugin
system does this.  I'm sure it'll just require some import magic in the
PluginManager.

The basic idea is that a user drops a directory into the plugins folder,
and that directory happens to be a valid python package.  The plugin
loader should then monkeypatch entertainer.plugins to have that plugin
available, and load it.

Revision history for this message

Paul Hummer (rockstar) on 2008-11-30:

#

review: Needs Fixing

Unmerged revisions

293. By Joshua Scotton on 2008-10-31: initial work on plugin framework and demo HelloWorld plugin

Entertainer Media Center

Merge lp:~joshuascotton/entertainer/pluginsV2 into lp:entertainer

Commit message

Description of the change

Unmerged revisions

Subscribers