From 92bc95f86a834b2853c77bbbfa1c0021213e1e17 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 19 Sep 2012 11:40:52 -0400 Subject: documented Packages base class --- src/lib/Bcfg2/Server/Plugin/base.py | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/lib/Bcfg2/Server/Plugin/base.py') 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 = {} -- cgit v1.2.3-1-g7c22