Action: Add config accessor functions.

[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 72b30179a3a0017f9bfe3447b60d9e5d5365922a..f6559f9b692294b401244f7dc65eb47c203a8779 100644 (file)
--- a/src/lib/backupninja/handlers/__init__.py
+++ b/src/lib/backupninja/handlers/__init__.py
@@ -19,7 +19,7 @@
 
 """ Action superclass with common functionality """
 
-import sys
+import sys, ConfigParser
 import logging as log
 
 from backupninja import config
@@ -59,7 +59,32 @@ class Action(object):
         """
         self.conf = config.load_config(filename, self.default_config)
 
-        
+    def get_config_optional(self, section, option):
+        """
+        Returns the value of the given option. If the option was not set
+        (and no default was set in self.default_config), return None.
+
+        This is a convenience wrapper for ConfigParser.get(), since that
+        throws an exception on unset options.
+        """
+        try:
+            return self.conf.get(section, option)
+        except ConfigParser.NoOptionError:
+            return None
+
+    def get_config_mandatory(self, section, option):
+        """
+        Returns the value of the given option. If the option was not set
+        (and no default was set in self.default_config), raises a
+        backupninja.config.ConfigError.
+
+        This is a convenience wrapper for ConfigParser.get(), since that
+        has a very generic exception message on unknown options.
+        """
+        try:
+            return self.conf.get(section, option)
+        except ConfigParser.NoOptionError:
+            raise config.ConfigError("Option '%s' in section '%s' is mandatory, please configure it" % (option, section))
 
 def create_action(ty):
     """