summaryrefslogtreecommitdiffstats
path: root/src/lib/Bcfg2/Server/Plugin/base.py
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-09-19 11:40:52 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-09-20 11:37:55 -0400
commit92bc95f86a834b2853c77bbbfa1c0021213e1e17 (patch)
treefd0445f1434495e8cc7fc13af553889285d168a6 /src/lib/Bcfg2/Server/Plugin/base.py
parent52cee5a20d6981e35b9df1c7438dffd1210f5a78 (diff)
downloadbcfg2-92bc95f86a834b2853c77bbbfa1c0021213e1e17.tar.gz
bcfg2-92bc95f86a834b2853c77bbbfa1c0021213e1e17.tar.bz2
bcfg2-92bc95f86a834b2853c77bbbfa1c0021213e1e17.zip
documented Packages base class
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugin/base.py')
-rw-r--r--src/lib/Bcfg2/Server/Plugin/base.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib/Bcfg2/Server/Plugin/base.py b/src/lib/Bcfg2/Server/Plugin/base.py
index 6b75bd174..74ec6df39 100644
--- a/src/lib/Bcfg2/Server/Plugin/base.py
+++ b/src/lib/Bcfg2/Server/Plugin/base.py
@@ -3,6 +3,7 @@
import os
import logging
+
class Debuggable(object):
""" Mixin to add a debugging interface to an object and expose it
via XML-RPC on :class:`Bcfg2.Server.Plugin.base.Plugin` objects """
@@ -11,6 +12,14 @@ class Debuggable(object):
__rmi__ = ['toggle_debug']
def __init__(self, name=None):
+ """
+ :param name: The name of the logger object to get. If none is
+ supplied, the full name of the class (including
+ module) will be used.
+ :type name: string
+
+ .. autoattribute:: __rmi__
+ """
if name is None:
name = "%s.%s" % (self.__class__.__module__,
self.__class__.__name__)
@@ -92,6 +101,8 @@ class Plugin(Debuggable):
filesystem
:type datastore: string
:raises: :class:`Bcfg2.Server.Plugin.exceptions.PluginInitError`
+
+ .. autoattribute:: __rmi__
"""
object.__init__(self)
self.Entries = {}