separate out ArgsParser to it's own file and subclass BareConfig

1 files changed, 49 insertions, 355 deletions

diff --git a/layman/config.py b/layman/config.py
index e8736ed..58e222a 100644
--- a/layman/config.py
+++ b/layman/config.py
@@ -1,52 +1,38 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-#################################################################################
-# LAYMAN CONFIGURATION
-#################################################################################
-# File:       config.py
-#
-#             Handles layman configuration
-#
-# Copyright:
-#             (c) 2005 - 2009 Gunnar Wrobel
-#             (c) 2009        Sebastian Pipping
-#             (c) 2010 - 2011 Brian Dolbec
-#             Distributed under the terms of the GNU General Public License v2
-#
-# Author(s):
-#             Gunnar Wrobel <wrobel@gentoo.org>
-#             Sebastian Pipping <sebastian@pipping.org>
-#             Brian Dolbec <brian.dolbec@gmail.com>
-#
-'''Defines the configuration options and provides parsing functionality.'''
-
-__version__ = "$Id: config.py 286 2007-01-09 17:48:23Z wrobel $"
-
-#===============================================================================
-#
-# Dependencies
-#
-#-------------------------------------------------------------------------------
-
-import sys, ConfigParser
-import os
 
-from optparse import OptionParser, OptionGroup
+"""
+ LAYMAN CONFIGURATION
 
-#from layman.debug import OUT
-from layman.output import Message
+ File:       config.py
+
+             Handles Basic layman configuration
+
+ Copyright:
+             (c) 2005 - 2009 Gunnar Wrobel
+             (c) 2009        Sebastian Pipping
+             (c) 2010 - 2011 Brian Dolbec
+             Distributed under the terms of the GNU General Public License v2
 
-from layman.constants import OFF
-from layman.version import VERSION
+ Author(s):
+             Gunnar Wrobel <wrobel@gentoo.org>
+             Sebastian Pipping <sebastian@pipping.org>
+             Brian Dolbec <brian.dolbec@gmail.com>
+"""
 
+'''Defines the configuration options.'''
+
+__version__ = "0.2"
+
+
+import sys
+import os
+import ConfigParser
 
-_USAGE = """
-  layman (-a|-d|-s|-i) (OVERLAY|ALL)
-  layman -f [-o URL]
-  layman (-l|-L|-S)"""
+from layman.output import Message
 
 
-def read_config(config=None, defaults=None):
+def read_layman_config(config=None, defaults=None):
     """reads the config file defined in defaults['config']
     and updates the config
 
@@ -68,11 +54,6 @@ def read_config(config=None, defaults=None):
                 overlays.update(["file://" + path])
         config.set('MAIN', 'overlays', '\n'.join(overlays))
 
-def t_f_check(option):
-    """evaluates the option and returns
-    True or False
-    """
-    return option.lower() in ['yes', 'true', 'y', 't']
 
 
 class BareConfig(object):
@@ -130,9 +111,13 @@ class BareConfig(object):
                     }
         self.config = None
         if read_configfile:
-            self.config = ConfigParser.ConfigParser(self._defaults)
+            self.read_config(self.get_defaults())
+
+
+    def read_config(self, defaults):
+            self.config = ConfigParser.ConfigParser(defaults)
             self.config.add_section('MAIN')
-            read_config(self.config, self._defaults)
+            read_layman_config(self.config, defaults)
 
 
     def keys(self):
@@ -149,12 +134,14 @@ class BareConfig(object):
 
     def get_defaults(self):
         """returns our defaults dictionary"""
-        return self._defaults
+        _defaults = self._defaults.copy()
+        _defaults['config'] = self._options['config']
+        return _defaults
 
 
     def get_option(self, key):
         """returns the current option's value"""
-        return self.__getitem__(key)
+        return self._get_(key)
 
 
     def set_option(self, option, value):
@@ -164,18 +151,22 @@ class BareConfig(object):
         if option == 'quiet':
             if self._options['quiet']:
                 self._set_quietness(1)
+                self._options['quietness'] = 0
             else:
                 self._set_quietness(4)
         if option == 'quietness':
-            self._set_quietness()
+            self._set_quietness(value)
 
     def _set_quietness(self, value):
             self._options['output'].set_info_level(int(self['quietness']))
             self._options['output'].set_warn_level(int(self['quietness']))
 
-
     def __getitem__(self, key):
-        self._options['output'].debug('Retrieving BareConfig option', 8)
+        return self._get_(key)
+
+    def _get_(self, key):
+        self._options['output'].debug(
+            'Retrieving BareConfig option: %s' % key, 8)
         if key == 'overlays':
             overlays = ''
             if (key in self._options
@@ -199,307 +190,10 @@ class BareConfig(object):
             return self._defaults[key]
         return None
 
+    @staticmethod
+    def t_f_check(option):
+        """evaluates the option and returns
+        True or False
+        """
+        return option.lower() in ['yes', 'true', 'y', 't']
 
-class ArgsParser(object):
-    '''Handles the configuration and option parser.'''
-
-    def __init__(self, args=None, output=None,
-        stdout=None, stdin=None, stderr=None):
-        '''
-        Creates and describes all possible polymeraZe options and creates
-        a debugging object.
-
-        >>> import os.path
-        >>> here = os.path.dirname(os.path.realpath(__file__))
-        >>> sys.argv.append('--config')
-        >>> sys.argv.append(here + '/../etc/layman.cfg')
-        >>> a = ArgsParser()
-        >>> a['overlays']
-        '\\nhttp://www.gentoo.org/proj/en/overlays/repositories.xml'
-        >>> sorted(a.keys())
-        ['bzr_command', 'cache', 'config', 'cvs_command', 'darcs_command',
-        'git_command', 'local_list', 'make_conf', 'mercurial_command',
-        'nocheck', 'overlays', 'proxy', 'quietness', 'rsync_command', 'storage',
-        'svn_command', 'tar_command', 'umask', 'width']
-        '''
-        if args == None:
-            args = sys.argv
-
-        self.stdout = stdout if stdout else sys.stdout
-        self.stderr = stderr if stderr else sys.stderr
-        self.stdin = stdin if stdin else sys.stdin
-        self.output = output if output else Message()
-
-        bare_config = BareConfig(self.output, self.stdout,
-            self.stdin, self.stderr)
-        self.defaults = bare_config.get_defaults()
-        #print self.defaults
-
-        self.parser = OptionParser(
-            usage   = _USAGE,
-            version = VERSION)
-
-        #-----------------------------------------------------------------
-        # Main Options
-
-        group = OptionGroup(self.parser,
-                            '<Actions>')
-
-        group.add_option('-a',
-                         '--add',
-                         action = 'append',
-                         help = 'Add the given overlay from the cached remote li'
-                         'st to your locally installed overlays.. Specify "ALL" '
-                         'to add all overlays from the remote list.')
-
-        group.add_option('-d',
-                         '--delete',
-                         action = 'append',
-                         help = 'Remove the given overlay from your locally inst'
-                         'alled overlays. Specify "ALL" to remove all overlays')
-
-        group.add_option('-s',
-                         '--sync',
-                         action = 'append',
-                         help = 'Update the specified overlay. Use "ALL" as para'
-                         'meter to synchronize all overlays')
-
-        group.add_option('-i',
-                         '--info',
-                         action = 'append',
-                         help = 'Display information about the specified overlay'
-                         '.')
-
-        group.add_option('-S',
-                         '--sync-all',
-                         action = 'store_true',
-                         help = 'Update all overlays.')
-
-        group.add_option('-L',
-                         '--list',
-                         action = 'store_true',
-                         help = 'List the contents of the remote list.')
-
-        group.add_option('-l',
-                         '--list-local',
-                         action = 'store_true',
-                         help = 'List the locally installed overlays.')
-
-        group.add_option('-f',
-                         '--fetch',
-                         action = 'store_true',
-                         help = 'Fetch a remote list of overlays. This option is'
-                         ' deprecated. The fetch operation will be performed by '
-                         'default when you run sync, sync-all, or list.')
-
-        group.add_option('-n',
-                         '--nofetch',
-                         action = 'store_true',
-                         help = 'Do not fetch a remote list of overlays.')
-
-        group.add_option('-p',
-                         '--priority',
-                         action = 'store',
-                         help = 'Use this with the --add switch to set the prior'
-                         'ity of the added overlay. This will influence the sort'
-                         'ing order of the overlays in the PORTDIR_OVERLAY varia'
-                         'ble.')
-
-        self.parser.add_option_group(group)
-
-        #-----------------------------------------------------------------
-        # Additional Options
-
-        group = OptionGroup(self.parser,
-                            '<Path options>')
-
-        group.add_option('-c',
-                         '--config',
-                         action = 'store',
-                         help = 'Path to the config file [default: ' \
-                         + self.defaults['config'] + '].')
-
-        group.add_option('-o',
-                         '--overlays',
-                         action = 'append',
-                         help = 'The list of overlays [default: ' \
-                         + self.defaults['overlays'] + '].')
-
-        self.parser.add_option_group(group)
-
-        #-----------------------------------------------------------------
-        # Output Options
-
-        group = OptionGroup(self.parser,
-                            '<Output options>')
-
-        group.add_option('-v',
-                         '--verbose',
-                         action = 'store_true',
-                         help = 'Increase the amount of output and describe the '
-                         'overlays.')
-
-        group.add_option('-q',
-                         '--quiet',
-                         action = 'store_true',
-                         help = 'Yield no output. Please be careful with this op'
-                         'tion: If the processes spawned by layman when adding o'
-                         'r synchronizing overlays require any input layman will'
-                         ' hang without telling you why. This might happen for e'
-                         'xample if your overlay resides in subversion and the S'
-                         'SL certificate of the server needs acceptance.')
-
-        group.add_option('-N',
-                         '--nocolor',
-                         action = 'store_true',
-                         help = 'Remove color codes from the layman output.')
-
-        group.add_option('-Q',
-                         '--quietness',
-                         action = 'store',
-                         type = 'int',
-                         default = '4',
-                         help = 'Set the level of output (0-4). Default: 4. Once'
-                         ' you set this below 2 the same warning as given for --'
-                         'quiet applies! ')
-
-        group.add_option('-W',
-                         '--width',
-                         action = 'store',
-                         type = 'int',
-                         default = '0',
-                         help = 'Sets the screen width. This setting is usually '
-                         'not required as layman is capable of detecting the '
-                         'available number of columns automatically.')
-
-        group.add_option('-k',
-                         '--nocheck',
-                         action = 'store_true',
-                         help = 'Do not check overlay definitions and do not i'
-                         'ssue a warning if description or contact information'
-                         ' are missing.')
-
-        self.parser.add_option_group(group)
-
-        #-----------------------------------------------------------------
-        # Debug Options
-
-        #self.output.cli_opts(self.parser)
-
-        # Parse the command line first since we need to get the config
-        # file option.
-        if len(args) == 1:
-            print 'Usage:%s' % _USAGE
-            sys.exit(0)
-
-        (self.options, remain_args) = self.parser.parse_args(args)
-        # remain_args starts with something like "bin/layman" ...
-        if len(remain_args) > 1:
-            self.parser.error("Unhandled parameters: %s"
-                % ', '.join(('"%s"' % e) for e in remain_args[1:]))
-
-        # handle debugging
-        #self.output.cli_handle(self.options)
-
-        # add output to the options
-        self.options.__dict__['output'] = self.output
-
-        # add the std in/out/err to the options
-        self.options.__dict__['stdout'] = self.stdout
-        self.options.__dict__['stdin'] = self.stdin
-        self.options.__dict__['stderr'] = self.stderr
-
-
-        if self.options.__dict__['nocolor']:
-            self.output.set_colorize(OFF)
-
-        # Fetch only an alternate config setting from the options
-        if not self.options.__dict__['config'] is None:
-            self.defaults['config'] = self.options.__dict__['config']
-
-            #self.output.debug('Got config file at ' + self.defaults['config'], 8)
-
-        # Now parse the config file
-        self.config = ConfigParser.ConfigParser(self.defaults)
-        self.config.add_section('MAIN')
-
-        # handle quietness
-        if self['quiet']:
-            self.output.set_info_level(1)
-            self.output.set_warn_level(1)
-            self.defaults['quietness'] = 0
-        elif 'quietness' in self.keys():
-            self.output.set_info_level(int(self['quietness']))
-            self.output.set_warn_level(int(self['quietness']))
-
-        #self.output.debug('Reading config file at ' + self.defaults['config'], 8)
-
-        read_config(self.config, self.defaults)
-
-    def __getitem__(self, key):
-
-        if key == 'overlays':
-            overlays = ''
-            if (key in self.options.__dict__.keys()
-                and not self.options.__dict__[key] is None):
-                overlays = '\n'.join(self.options.__dict__[key])
-            if self.config.has_option('MAIN', 'overlays'):
-                overlays += '\n' + self.config.get('MAIN', 'overlays')
-            if overlays:
-                return  overlays
-
-        self.output.debug('Retrieving option', 8)
-
-        if (key in self.options.__dict__.keys()
-            and not self.options.__dict__[key] is None):
-            return self.options.__dict__[key]
-
-        self.output.debug('Retrieving option', 8)
-
-        if self.config.has_option('MAIN', key):
-            if key in self.defaults['T/F_options']:
-                return t_f_check(self.config.get('MAIN', key))
-            return self.config.get('MAIN', key)
-
-        self.output.debug('Retrieving option', 8)
-
-        if key in self.defaults.keys():
-            return self.defaults[key]
-
-        self.output.debug('Retrieving option', 8)
-
-        return None
-
-
-    def keys(self):
-        '''Special handler for the configuration keys.'''
-
-        self.output.debug('Retrieving keys', 8)
-
-        keys = [i for i in self.options.__dict__.keys()
-                if not self.options.__dict__[i] is None]
-
-        self.output.debug('Retrieving keys', 8)
-
-        keys += [name for name, _ in self.config.items('MAIN')
-                 if not name in keys]
-
-        self.output.debug('Retrieving keys', 8)
-
-        keys += [i for i in self.defaults.keys()
-                 if not i in keys]
-
-        self.output.debug('Retrieving keys', 8)
-
-        return keys
-
-
-#===============================================================================
-#
-# Testing
-#
-#-------------------------------------------------------------------------------
-
-if __name__ == '__main__':
-    import doctest
-    doctest.testmod(sys.modules[__name__])