Deluge Forum

• The plugin manager adds the plugin directories to the python path
• The plugin manager then scans the root of each directory and imports each module
• The module __init__.py contains some standard-named variables that plugin manager can register the plugin with (description, author, etc).
• The __init__.py would also contain 'enable', 'disable' and 'configure' functions that would invoked at the appropriate points.

    _plugins = {}
    def loadPlugins(self, pdir='plugins'):
        sys.path.append(pdir)
        for path, dirs, files in os.walk(pdir):
            if '__init__.py' in files:
                elems = path.split('/')
                modname = '.'.join(elems)

                # Import the found module. Note that the last
                # parameter is important otherwise only the base
                # modules (ie. 'plugins') is imported.  This appears
                # to be by design.
                mod = __import__(modname, globals(), locals(), [''])
                if 'init' in dir(mod):
                    plugin = mod.init(self)
                    if plugin:
                        self._plugins[modname] = plugin

tarka wrote:Currently plugins are implemented as directory which contains a 'plugin.py' file, which is executed when the plugin loads. This registers the plugin class and defines some parameters. However this tends impose artificial limitations on the plugin (e.g. normal imports don't work as expected), and makes breaking the module up into smaller pieces more difficult (because any other *.py files in the module are not on the python path and therefore can't be imported).

I'd like to propose that the plugin structure be changed such that each plugin is a standalone python module. It would work like this:

• The plugin manager adds the plugin directories to the python path
• The plugin manager then scans the root of each directory and imports each module
• The module __init__.py contains some standard-named variables that plugin manager can register the plugin with (description, author, etc).
• The __init__.py would also contain 'enable', 'disable' and 'configure' functions that would invoked at the appropriate points.

I'd be happy to do this, including porting the existing included plugins to the system. I've already implemented something similar for an experimental Jabber client I wrote a while ago. The code to do this is actually pretty simple (the following is ripped straight from that code and doesn't completely match the above, but you get the idea):

Code: Select all

    _plugins = {}
    def loadPlugins(self, pdir='plugins'):
        sys.path.append(pdir)
        for path, dirs, files in os.walk(pdir):
            if '__init__.py' in files:
                elems = path.split('/')
                modname = '.'.join(elems)

                # Import the found module. Note that the last
                # parameter is important otherwise only the base
                # modules (ie. 'plugins') is imported.  This appears
                # to be by design.
                mod = __import__(modname, globals(), locals(), [''])
                if 'init' in dir(mod):
                    plugin = mod.init(self)
                    if plugin:
                        self._plugins[modname] = plugin

andar wrote: This sounds cool.. I was thinking of redoing the plugin system myself, but if you have already started then please feel free to send us a patch.

markybob wrote:

andar wrote: This sounds cool.. I was thinking of redoing the plugin system myself, but if you have already started then please feel free to send us a patch.

i'm with andar. feel free to shoot me an email markybob@gmail.com

tarka wrote:Patch attached to this ticket: http://dev.deluge-torrent.org/ticket/315

reader = PGReader(self.blockfile)
   File "/usr/share/deluge/plugins/BlocklistImport/peerguardian.py", line 21, in __init__
     hdr = unpack("l", buf)[0]
struct.error: unpack str size does not match format
terminate called after throwing an instance of 'asio::system_error'
  what():  Transport endpoint is not connected
Aborted

  File "/usr/lib/python2.4/site-packages/deluge/plugins.py", line 88, in update_active_plugins
    plugin.update()
  File "/usr/share/deluge/plugins/NetworkGraph/plugin.py", line 114, in update
    import common
ImportError: No module named common

shirish wrote:No developer here, but please see http://dev.deluge-torrent.org/changeset/567 that was when markybob tried to do the new plugin system & it didn't work.