Back to index

obnam  1.1
Public Member Functions | Public Attributes
obnamlib.pluginbase.ObnamPlugin Class Reference
Inheritance diagram for obnamlib.pluginbase.ObnamPlugin:
Inheritance graph
[legend]
Collaboration diagram for obnamlib.pluginbase.ObnamPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def name
def description
def version
def required_application_version
def enable_wrapper
def disable_wrapper
def enable
def disable

Public Attributes

 app

Detailed Description

Base class for plugins in Obnam.

Definition at line 20 of file pluginbase.py.


Constructor & Destructor Documentation

def obnamlib.pluginbase.ObnamPlugin.__init__ (   self,
  app 
)

Definition at line 24 of file pluginbase.py.

00024 
00025     def __init__(self, app):
00026         self.app = app
00027         

Member Function Documentation

def obnamlib.pluginmgr.Plugin.description (   self) [inherited]

Definition at line 79 of file pluginmgr.py.

00079 
00080     def description(self):
00081         return ''
        
def obnamlib.pluginmgr.Plugin.disable (   self) [inherited]
Disable the plugin.

Definition at line 111 of file pluginmgr.py.

00111 
00112     def disable(self):
00113         '''Disable the plugin.'''
00114         raise NotImplemented()
00115 

Here is the caller graph for this function:

def obnamlib.pluginmgr.Plugin.disable_wrapper (   self) [inherited]
Corresponds to enable_wrapper, but for disabling a plugin.

Definition at line 103 of file pluginmgr.py.

00103 
00104     def disable_wrapper(self):
00105         '''Corresponds to enable_wrapper, but for disabling a plugin.'''
00106         self.disable()
    

Here is the call graph for this function:

def obnamlib.pluginmgr.Plugin.enable (   self) [inherited]
Enable the plugin.

Definition at line 107 of file pluginmgr.py.

00107 
00108     def enable(self):
00109         '''Enable the plugin.'''
00110         raise NotImplemented()
    

Here is the caller graph for this function:

def obnamlib.pluginmgr.Plugin.enable_wrapper (   self) [inherited]
Enable plugin.

The plugin manager will call this method, which then calls the
enable method. Plugins should implement the enable method.
The wrapper method is there to allow an application to provide
an extended base class that does some application specific
magic when plugins are enabled or disabled.

Definition at line 90 of file pluginmgr.py.

00090 
00091     def enable_wrapper(self):
00092         '''Enable plugin.
00093         
00094         The plugin manager will call this method, which then calls the
00095         enable method. Plugins should implement the enable method.
00096         The wrapper method is there to allow an application to provide
00097         an extended base class that does some application specific
00098         magic when plugins are enabled or disabled.
00099         
00100         '''
00101         
00102         self.enable()

Here is the call graph for this function:

def obnamlib.pluginmgr.Plugin.name (   self) [inherited]

Definition at line 75 of file pluginmgr.py.

00075 
00076     def name(self):
00077         return self.__class__.__name__
        

Definition at line 87 of file pluginmgr.py.

00087 
00088     def required_application_version(self):
00089         return '0.0.0'
        
def obnamlib.pluginmgr.Plugin.version (   self) [inherited]

Definition at line 83 of file pluginmgr.py.

00083 
00084     def version(self):
00085         return '0.0.0'
        

Member Data Documentation

Definition at line 25 of file pluginbase.py.


The documentation for this class was generated from the following file: