handlers: Make create_action pass any kwargs to the constructor.

[matthijs/projects/backupninja.git] / src / lib / backupninja / handlers / __init__.py

diff --git a/src/lib/backupninja/handlers/__init__.py b/src/lib/backupninja/handlers/__init__.py
index dbc403e04585e21f167410da25d8da99f938bd06..50abb41307c9078444200c86c731e9de284a1cb7 100644 (file)
--- a/src/lib/backupninja/handlers/__init__.py
+++ b/src/lib/backupninja/handlers/__init__.py
@@ -24,6 +24,20 @@ import logging as log
 
 from backupninja import config
 
 
 from backupninja import config
 

+def fail_on_exception(f):
+    """
+    This is a decorator meant for methods on the Action class. It
+    catches any exceptions thrown, sets the failed attribute to True and
+    rethrows the exception.
+    """
+    def inner(self, *args, **kwargs):
+        try:
+            f(self, *args, **kwargs)
+        except:
+            self.failed = True
+            raise
+    return inner
+

 class Action(object):
     """
     Subclasses of Action represent handlers for various action types.
 class Action(object):
     """
     Subclasses of Action represent handlers for various action types.


@@ -41,6 +55,10 @@ class Action(object):
         # Assume we'll run succesfully. If anything fails in the
         # meanwhile, set this to True.
         self.failed = False
         # Assume we'll run succesfully. If anything fails in the
         # meanwhile, set this to True.
         self.failed = False

+        # A logger object for this action. In the future, this might
+        # become a specific logger, that includes the action name and
+        # type.
+        self.log = log

 
     def run(self, **kwargs):
         """
 
     def run(self, **kwargs):
         """


@@ -89,10 +107,11 @@ class Action(object):
         except ConfigParser.NoOptionError:
             raise config.ConfigError("Option '%s' in section '%s' is mandatory, please configure it" % (option, section))
 
         except ConfigParser.NoOptionError:
             raise config.ConfigError("Option '%s' in section '%s' is mandatory, please configure it" % (option, section))
 

-def create_action(ty):
+def create_action(ty, **kwargs):

     """
     Create a new (subclass of) Action object for an action with the
     """
     Create a new (subclass of) Action object for an action with the

-    given type.
+    given type. Any extra keyword arguments are passed to the
+    constructor.

 
     If the handler class for this type cannot be loaded, an exception is
     thrown.
 
     If the handler class for this type cannot be loaded, an exception is
     thrown.


@@ -119,7 +138,7 @@ def create_action(ty):
                           % (module.__file__))
 
     # Call the "handler" function to create the actual action
                           % (module.__file__))
 
     # Call the "handler" function to create the actual action

-    action = module.handler()
+    action = module.handler(**kwargs)

    
     # Check if the handler returned is really a subclass of Action
     if not isinstance(action, Action):
    
     # Check if the handler returned is really a subclass of Action
     if not isinstance(action, Action):