add support for bytes and time to lgc.configuration

3 files changed, 46 insertions, 37 deletions

diff --git a/configuration.py b/configuration.py
index e90a0f2..0fdff3a 100644
--- a/configuration.py
+++ b/configuration.py
@@ -103,10 +103,7 @@ from ConfigParser import ConfigParser, NoOptionError, NoSectionError, \
 
 from logilab.common.compat import set
 from logilab.common.textutils import normalize_text, unquote
-from logilab.common.optik_ext import OptionParser, OptionGroup, Values, \
-     OptionValueError, OptionError, HelpFormatter, generate_manpage, check_date, \
-     check_yn, check_csv, check_file, check_color, check_named, check_password,\
-     NO_DEFAULT, OPTPARSE_FORMAT_DEFAULT
+from logilab.common import optik_ext as opt
 
 REQUIRED = []
 
@@ -134,50 +131,58 @@ def choice_validator(opt_dict, name, value):
     """
     if not value in opt_dict['choices']:
         msg = "option %s: invalid value: %r, should be in %s"
-        raise OptionValueError(msg % (name, value, opt_dict['choices']))
+        raise opt.OptionValueError(msg % (name, value, opt_dict['choices']))
     return value
 
 def multiple_choice_validator(opt_dict, name, value):
     """validate and return a converted value for option of type 'choice'
     """
     choices = opt_dict['choices']
-    values = check_csv(None, name, value)
+    values = opt.check_csv(None, name, value)
     for value in values:
         if not value in choices:
             msg = "option %s: invalid value: %r, should be in %s"
-            raise OptionValueError(msg % (name, value, choices))
+            raise opt.OptionValueError(msg % (name, value, choices))
     return values
 
 def csv_validator(opt_dict, name, value):
     """validate and return a converted value for option of type 'csv'
     """
-    return check_csv(None, name, value)
+    return opt.check_csv(None, name, value)
 
 def yn_validator(opt_dict, name, value):
     """validate and return a converted value for option of type 'yn'
     """
-    return check_yn(None, name, value)
+    return opt.check_yn(None, name, value)
 
 def named_validator(opt_dict, name, value):
     """validate and return a converted value for option of type 'named'
     """
-    return check_named(None, name, value)
+    return opt.check_named(None, name, value)
 
 def file_validator(opt_dict, name, value):
     """validate and return a filepath for option of type 'file'"""
-    return check_file(None, name, value)
+    return opt.check_file(None, name, value)
 
 def color_validator(opt_dict, name, value):
     """validate and return a valid color for option of type 'color'"""
-    return check_color(None, name, value)
+    return opt.check_color(None, name, value)
 
 def password_validator(opt_dict, name, value):
     """validate and return a string for option of type 'password'"""
-    return check_password(None, name, value)
+    return opt.check_password(None, name, value)
 
 def date_validator(opt_dict, name, value):
     """validate and return a mx DateTime object for option of type 'date'"""
-    return check_date(None, name, value)
+    return opt.check_date(None, name, value)
+
+def time_validator(opt_dict, name, value):
+    """validate and return a time object for option of type 'time'"""
+    return opt.check_time(None, name, value)
+
+def bytes_validator(opt_dict, name, value):
+    """validate and return an integer for option of type 'bytes'"""
+    return opt.check_bytes(None, name, value)
 
 
 VALIDATORS = {'string' : unquote,
@@ -193,6 +198,8 @@ VALIDATORS = {'string' : unquote,
               'named': named_validator,
               'password': password_validator,
               'date': date_validator,
+              'time': time_validator,
+              'bytes': bytes_validator,
               'choice': choice_validator,
               'multiple_choice': multiple_choice_validator,
               }
@@ -205,10 +212,10 @@ def _call_validator(opttype, optdict, option, value):
     except TypeError:
         try:
             return VALIDATORS[opttype](value)
-        except OptionValueError:
+        except opt.OptionValueError:
             raise
         except:
-            raise OptionValueError('%s value (%r) should be of type %s' %
+            raise opt.OptionValueError('%s value (%r) should be of type %s' %
                                    (option, value, opttype))
 
 # user input functions ########################################################
@@ -234,7 +241,7 @@ def _make_input_function(opttype):
                 return None
             try:
                 return _call_validator(opttype, optdict, None, value)
-            except OptionValueError, ex:
+            except opt.OptionValueError, ex:
                 msg = str(ex).split(':', 1)[-1].strip()
                 print 'bad value: %s' % msg
     return input_validator
@@ -264,7 +271,7 @@ def expand_default(self, option):
         optname = provider.option_name(optname, optdict)
         value = getattr(provider.config, optname, optdict)
         value = format_option_value(optdict, value)
-    if value is NO_DEFAULT or not value:
+    if value is opt.NO_DEFAULT or not value:
         value = self.NO_DEFAULT_VALUE
     return option.help.replace(self.default_tag, str(value))
 
@@ -367,7 +374,7 @@ class OptionsManagerMixIn(object):
         # configuration file parser
         self._config_parser = ConfigParser()
         # command line parser
-        self._optik_parser = OptionParser(usage=usage, version=version)
+        self._optik_parser = opt.OptionParser(usage=usage, version=version)
         self._optik_parser.options_manager = self
 
     def register_options_provider(self, provider, own_group=True):
@@ -413,7 +420,7 @@ class OptionsManagerMixIn(object):
             self._mygroups.add(group_name)
         # add option group to the command line parser
         if options:
-            group = OptionGroup(self._optik_parser,
+            group = opt.OptionGroup(self._optik_parser,
                                 title=group_name.capitalize())
             self._optik_parser.add_option_group(group)
         # add provider's specific options
@@ -437,7 +444,7 @@ class OptionsManagerMixIn(object):
         # default is handled here and *must not* be given to optik if you
         # want the whole machinery to work
         if 'default' in opt_dict:
-            if (OPTPARSE_FORMAT_DEFAULT and 'help' in opt_dict and
+            if (opt.OPTPARSE_FORMAT_DEFAULT and 'help' in opt_dict and
                 opt_dict.get('default') is not None and
                 not opt_dict['action'] in ('store_true', 'store_false')):
                 opt_dict['help'] += ' [current: %default]'
@@ -504,8 +511,8 @@ class OptionsManagerMixIn(object):
         """
         self._monkeypatch_expand_default()
         try:
-            generate_manpage(self._optik_parser, pkginfo,
-                             section, stream=stream or sys.stdout)
+            opt.generate_manpage(self._optik_parser, pkginfo,
+                                 section, stream=stream or sys.stdout)
         finally:
             self._unmonkeypatch_expand_default()
 
@@ -605,7 +612,7 @@ class OptionsManagerMixIn(object):
 
     def add_help_section(self, title, description):
         """add a dummy option section for help purpose """
-        group = OptionGroup(self._optik_parser,
+        group = opt.OptionGroup(self._optik_parser,
                             title=title.capitalize(),
                             description=description)
         self._optik_parser.add_option_group(group)
@@ -613,16 +620,16 @@ class OptionsManagerMixIn(object):
     def _monkeypatch_expand_default(self):
         # monkey patch optparse to deal with our default values
         try:
-            self.__expand_default_backup = HelpFormatter.expand_default
-            HelpFormatter.expand_default = expand_default
+            self.__expand_default_backup = opt.HelpFormatter.expand_default
+            opt.HelpFormatter.expand_default = expand_default
         except AttributeError:
             # python < 2.4: nothing to be done
             pass
     def _unmonkeypatch_expand_default(self):
         # remove monkey patch
-        if hasattr(HelpFormatter, 'expand_default'):
+        if hasattr(opt.HelpFormatter, 'expand_default'):
             # unpatch optparse to avoid side effects
-            HelpFormatter.expand_default = self.__expand_default_backup
+            opt.HelpFormatter.expand_default = self.__expand_default_backup
 
     def help(self):
         """return the usage string for available options """
@@ -660,7 +667,7 @@ class OptionsProviderMixIn(object):
     options = ()
 
     def __init__(self):
-        self.config = Values()
+        self.config = opt.Values()
         for option in self.options:
             try:
                 option, optdict = option
@@ -772,7 +779,7 @@ class OptionsProviderMixIn(object):
         for opt in self.options:
             if opt[0] == opt_name:
                 return opt[1]
-        raise OptionError('no such option in section %r' % self.name, opt_name)
+        raise opt.OptionError('no such option in section %r' % self.name, opt_name)
 
 
     def all_options(self):
@@ -840,7 +847,7 @@ class ConfigurationMixIn(OptionsManagerMixIn, OptionsProviderMixIn):
     def __getitem__(self, key):
         try:
             return getattr(self.config, self.option_name(key))
-        except (OptionValueError, AttributeError):
+        except (opt.OptionValueError, AttributeError):
             raise KeyError(key)
 
     def __setitem__(self, key, value):
@@ -849,7 +856,7 @@ class ConfigurationMixIn(OptionsManagerMixIn, OptionsProviderMixIn):
     def get(self, key, default=None):
         try:
             return getattr(self.config, self.option_name(key))
-        except (OptionError, AttributeError):
+        except (opt.OptionError, AttributeError):
             return default
 
 
diff --git a/optik_ext.py b/optik_ext.py
index 7966d36..0b1a1b6 100644
--- a/optik_ext.py
+++ b/optik_ext.py
@@ -141,6 +141,7 @@ def check_file(option, opt, value):
     msg = "option %s: file %r does not exist"
     raise OptionValueError(msg % (opt, value))
 
+# XXX use python datetime
 def check_date(option, opt, value):
     """check a file value
     return the filepath
@@ -169,11 +170,15 @@ def check_color(option, opt, value):
 
 def check_time(option, opt, value):
     from logilab.common.textutils import TIME_UNITS, apply_units
-    apply_units(value, TIME_UNITS)
+    if isinstance(value, (int, long)):
+        return value
+    return apply_units(value, TIME_UNITS)
 
 def check_bytes(option, opt, value):
     from logilab.common.textutils import BYTE_UNITS, apply_units
-    apply_units(value, BYTE_UNITS)
+    if instance(value, (int, long)):
+        return value
+    return apply_units(value, BYTE_UNITS)
 
 import types
 
diff --git a/textutils.py b/textutils.py
index 1c24c70..3c40dda 100644
--- a/textutils.py
+++ b/textutils.py
@@ -280,8 +280,6 @@ def apply_units( string, units, inter=None, final=float, blank_reg=_BLANK_RE,
     """
     if inter is None:
         inter = final
-
-
     string = _BLANK_RE.sub('',string)
     values = []
     for match in value_reg.finditer(string):
@@ -293,7 +291,6 @@ def apply_units( string, units, inter=None, final=float, blank_reg=_BLANK_RE,
         if unit is not None:
             value *= units[unit]
         values.append(value)
-
     return final(sum(values))
 
 _LINE_RGX = re.compile('\r\n|\r+|\n')