Updated the trac.config.Configuration.get*() and Section.get*() methods to be more consistent in their input and return values - with recommended default of string or 'base type' signified by method name, and always looking to return the 'base type'.

Introduces a `Configuration.has_option(section, option)` that checks for the existence of an option somewhere in project trac.ini file, inherited trac.ini file, or in the options registry.

Updated method documentation + added some tests.

Closing #4977.

git-svn-id: http://trac.edgewall.org/intertrac/log:/trunk@6280 af82e41b-90c4-0310-8c96-b1721e28e2e2

Author: osimons

trac/config.py

@@ -60,38 +60,47 @@ def __getitem__(self, name):
     def __repr__(self):
         return '<%s %r>' % (self.__class__.__name__, self.filename)
 
-    def get(self, section, name, default=None):
-        """Return the value of the specified option."""
+    def get(self, section, name, default=''):
+        """Return the value of the specified option.
+        
+        Valid default input is a string. Returns a string.
+        """
         return self[section].get(name, default)
 
-    def getbool(self, section, name, default=None):
+    def getbool(self, section, name, default=''):
         """Return the specified option as boolean value.
         
         If the value of the option is one of "yes", "true", "enabled", "on",
         or "1", this method wll return `True`, otherwise `False`.
         
+        Valid default input is a string or a bool. Returns a bool.
+        
         (since Trac 0.9.3, "enabled" added in 0.11)
         """
         return self[section].getbool(name, default)
 
-    def getint(self, section, name, default=None):
+    def getint(self, section, name, default=''):
         """Return the value of the specified option as integer.
         
         If the specified option can not be converted to an integer, a
         `ConfigurationError` exception is raised.
         
+        Valid default input is a string or an int. Returns an int.
+        
         (since Trac 0.10)
         """
         return self[section].getint(name, default)
 
-    def getlist(self, section, name, default=None, sep=',', keep_empty=False):
+    def getlist(self, section, name, default='', sep=',', keep_empty=False):
         """Return a list of values that have been specified as a single
         comma-separated option.
         
         A different separator can be specified using the `sep` parameter. If
         the `keep_empty` parameter is set to `True`, empty elements are
         included in the list.
         
+        Valid default input is a string or a list. Returns a string.
+        
         (since Trac 0.10)
         """
         return self[section].getlist(name, default, sep, keep_empty)
@@ -136,6 +145,27 @@ def sections(self):
             parent = parent.parent
         return sorted(sections)
 
+    def has_option(self, section, option):
+        """Returns True if option exists in section in either project or
+        parent trac.ini, or available through the Option registry.
+        
+        (since Trac 0.11)
+        """
+        # Check project trac.ini
+        for file_option, val in self.options(section):
+            if file_option == option:
+                return True
+        # Check parent trac.ini
+        if self.parent:
+            for parent_option, val in self.parent.options(section):
+                if parent_option == option:
+                    return True
+        # Check the registry
+        if (section, option) in Option.registry:
+            return True
+        # Not found
+        return False
+
     def save(self):
         """Write the configuration options to the primary file."""
         if not self.filename:
@@ -238,8 +268,11 @@ def __iter__(self):
     def __repr__(self):
         return '<Section [%s]>' % (self.name)
 
-    def get(self, name, default=None):
-        """Return the value of the specified option."""
+    def get(self, name, default=''):
+        """Return the value of the specified option.
+        
+        Valid default input is a string. Returns a string.
+        """
         if self.config.parser.has_option(self.name, name):
             value = self.config.parser.get(self.name, name)
         elif self.config.parent:
@@ -250,44 +283,55 @@ def get(self, name, default=None):
                 value = option.default or default
             else:
                 value = default
-        if value is None:
-            return ''
-        return to_unicode(value)
+        if not value:
+            return u''
+        elif isinstance(value, basestring):
+            return to_unicode(value)
+        else:
+            return value
 
-    def getbool(self, name, default=None):
+    def getbool(self, name, default=''):
         """Return the value of the specified option as boolean.
         
         This method returns `True` if the option value is one of "yes", "true",
         "enabled", "on", or "1", ignoring case. Otherwise `False` is returned.
+
+        Valid default input is a string or a bool. Returns a bool.
         """
         value = self.get(name, default)
         if isinstance(value, basestring):
             value = value.lower() in _TRUE_VALUES
         return bool(value)
 
-    def getint(self, name, default=None):
+    def getint(self, name, default=''):
         """Return the value of the specified option as integer.
         
         If the specified option can not be converted to an integer, a
         `ConfigurationError` exception is raised.
+        
+        Valid default input is a string or an int. Returns an int.
         """
         value = self.get(name, default)
-        if value == '':
-            return default
+        if not value:
+            return 0
         try:
             return int(value)
         except ValueError:
             raise ConfigurationError('expected integer, got %s' % repr(value))
 
-    def getlist(self, name, default=None, sep=',', keep_empty=True):
+    def getlist(self, name, default='', sep=',', keep_empty=True):
         """Return a list of values that have been specified as a single
         comma-separated option.
         
         A different separator can be specified using the `sep` parameter. If
-        the `skip_empty` parameter is set to `True`, empty elements are omitted
+        the `keep_empty` parameter is set to `False`, empty elements are omitted
         from the list.
+        
+        Valid default input is a string or a list. Returns a list.
         """
         value = self.get(name, default)
+        if not value:
+            return []
         if isinstance(value, basestring):
             items = [item.strip() for item in value.split(sep)]
         else:
@@ -296,9 +340,11 @@ def getlist(self, name, default=None, sep=',', keep_empty=True):
             items = filter(None, items)
         return items
 
-    def getpath(self, name, default=None):
+    def getpath(self, name, default=''):
         """Return the value of the specified option as a path name, relative to
         the location of the configuration file the option is defined in.
+
+        Valid default input is a string. Returns a string with normalised path.
         """
         if self.config.parser.has_option(self.name, name):
             path = self.config.parser.get(self.name, name)

trac/tests/config.py

@@ -68,7 +68,7 @@ class Foo(object):
     def test_default_int(self):
         config = self._read()
         self.assertRaises(ConfigurationError, config.getint, 'a', 'option', 'b')
-        self.assertEquals(None, config.getint('a', 'option'))
+        self.assertEquals(0, config.getint('a', 'option'))
         self.assertEquals(1, config.getint('a', 'option', '1'))
         self.assertEquals(1, config.getint('a', 'option', 1))
 
@@ -82,24 +82,37 @@ def test_read_and_get(self):
         config = self._read()
         self.assertEquals('x', config.get('a', 'option'))
         self.assertEquals('x', config.get('a', 'option', 'y'))
+        self.assertEquals('y', config.get('b', 'option2', 'y'))
 
     def test_read_and_getbool(self):
         self._write(['[a]', 'option = yes'])
         config = self._read()
         self.assertEquals(True, config.getbool('a', 'option'))
         self.assertEquals(True, config.getbool('a', 'option', False))
+        self.assertEquals(False, config.getbool('b', 'option2'))
+        self.assertEquals(False, config.getbool('b', 'option2', False))
+        self.assertEquals(False, config.getbool('b', 'option2', 'disabled'))
 
     def test_read_and_getint(self):
         self._write(['[a]', 'option = 42'])
         config = self._read()
         self.assertEquals(42, config.getint('a', 'option'))
         self.assertEquals(42, config.getint('a', 'option', 25))
+        self.assertEquals(0, config.getint('b', 'option2'))
+        self.assertEquals(25, config.getint('b', 'option2', 25))
+        self.assertEquals(25, config.getint('b', 'option2', '25'))
 
     def test_read_and_getlist(self):
         self._write(['[a]', 'option = foo, bar, baz'])
         config = self._read()
         self.assertEquals(['foo', 'bar', 'baz'],
                           config.getlist('a', 'option'))
+        self.assertEquals([],
+                          config.getlist('b', 'option2'))
+        self.assertEquals(['foo', 'bar', 'baz'],
+                    config.getlist('b', 'option2', ['foo', 'bar', 'baz']))
+        self.assertEquals(['foo', 'bar', 'baz'],
+                    config.getlist('b', 'option2', 'foo, bar, baz'))
 
     def test_read_and_getlist_sep(self):
         self._write(['[a]', 'option = foo | bar | baz'])
@@ -159,6 +172,13 @@ def test_options(self):
         self.assertEquals(('option', 'y'), iter(config.options('b')).next())
         self.assertRaises(StopIteration, iter(config.options('c')).next)
 
+    def test_has_option(self):
+        config = self._read()
+        self.assertEquals(False, config.has_option('a', 'option'))
+        self._write(['[a]', 'option = x'])
+        config = self._read()
+        self.assertEquals(True, config.has_option('a', 'option'))
+
     def test_reparse(self):
         self._write(['[a]', 'option = x'])
         config = self._read()