summaryrefslogtreecommitdiff
path: root/portato/plugin.py
diff options
context:
space:
mode:
authornecoro <>2007-07-07 08:50:33 +0000
committernecoro <>2007-07-07 08:50:33 +0000
commit6d9340ebbb5b942b0996053b0479827c1cf81b5a (patch)
treec7099063b564511a37b63f07a03a2fbb4217201f /portato/plugin.py
parent91225d6ff5bc70cd76d0cf54f35a1cf6186b538b (diff)
downloadportato-6d9340ebbb5b942b0996053b0479827c1cf81b5a.tar.gz
portato-6d9340ebbb5b942b0996053b0479827c1cf81b5a.tar.bz2
portato-6d9340ebbb5b942b0996053b0479827c1cf81b5a.zip
some more documentation
Diffstat (limited to 'portato/plugin.py')
-rw-r--r--portato/plugin.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/portato/plugin.py b/portato/plugin.py
index 8a54c11..abdf86c 100644
--- a/portato/plugin.py
+++ b/portato/plugin.py
@@ -10,6 +10,8 @@
#
# Written by René 'Necoro' Neumann <necoro@necoro.net>
+"""A module containing the management of the plugin system."""
+
import os, os.path
from xml.dom.minidom import parse
@@ -505,11 +507,19 @@ class PluginQueue:
__plugins = None
def load_plugins(frontend):
+ """Loads the plugins for a given frontend.
+ @param frontend: The frontend. See L{constants.FRONTENDS} for the correct list of values.
+ @type frontend: string"""
+
global __plugins
if __plugins is None or __plugins.frontend != frontend:
__plugins = PluginQueue(frontend)
def get_plugin_queue():
+ """Returns the actual L{PluginQueue}. If it is C{None}, they are not being loaded yet.
+
+ @returns: the actual L{PluginQueue} or C{None}
+ @rtype: PluginQueue"""
return __plugins
def hook(hook, *args, **kwargs):