Changeset b6a3161

Timestamp:

05/09/2013 06:13:20 PM (12 years ago)

Author:

Calum Lind <calumlind+deluge@gmail.com>

Branches:

2.0.x, develop, master

Children:

7424cf

Parents:

daba92

git-author:

Calum Lind <calumlind+deluge@gmail.com> (05/09/2013 05:41:30 PM)

git-committer:

Calum Lind <calumlind+deluge@gmail.com> (05/09/2013 06:13:20 PM)

Message:

Add a get method to config so a default value can be returned

Location:

deluge

Files:

• config.py (modified) (1 diff)
• core/core.py (modified) (1 diff)
• tests/test_config.py (modified) (1 diff)

deluge/config.py

@@ -268 +268 @@
         else:
             return self.__config[key]
+
+
+    def get(self, key, default=None):
+        """
+        Gets the value of item 'key' if key is in the config, else default.
+        If default is not given, it defaults to None, so that this method
+        never raises a KeyError.
+
+        :param key: the item for which you want it's value
+        :param default: the default value if key is missing
+        :return: the value of item 'key' or default
+
+        **Usage**
+
+        >>> config = Config("test.conf", defaults={"test": 5})
+        >>> config.get("test", 10)
+        5
+        >>> config.get("bad_key", 10)
+        10
+
+        """
+        try:
+            return self.get_item(key)
+        except KeyError:
+            return default
+
 
     def __delitem__(self, key):

deluge/core/core.py

@@ -481 +481 @@
     def get_config_value(self, key):
         """Get the config value for key"""
-        try:
-            value = self.config[key]
-        except KeyError:
-            return None
-
-        return value
+        return self.config.get(key)
 
     @export
     def get_config_values(self, keys):
         """Get the config values for the entered keys"""
-        config = {}
-        for key in keys:
-            try:
-                config[key] = self.config[key]
-            except KeyError:
-                pass
-        return config
+        return {(key, self.config.get(key)) for key in keys}
 
     @export

deluge/tests/test_config.py

@@ -32 +32 @@
         config["unicode"] = u"ВИДЕОЀИЛЬМЫ"
         self.assertEquals(config["unicode"], u"ВИДЕОЀИЛЬМЫ")
-        
+
         config._save_timer.cancel()
+
+    def test_get(self):
+        config = Config("test.conf", config_dir=self.config_dir)
+        config["foo"] = 1
+        self.assertEquals(config.get("foo"), 1)
+        self.assertEquals(config.get("foobar"), None)
+        self.assertEquals(config.get("foobar", 2), 2)
+        config["foobar"] = 5
+        self.assertEquals(config.get("foobar", 2), 5)
 
     def test_load(self):