chiark - git - mdw - stgit/blob - stgit/config.py

   1 """Handles the Stacked GIT configuration files
   2 """
   3
   4 __copyright__ = """
   5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License version 2 as
   9 published by the Free Software Foundation.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19 """
  20
  21 import os, re
  22 from stgit import basedir
  23 from stgit.exception import *
  24 from stgit.run import *
  25
  26 class GitConfigException(StgException):
  27     pass
  28
  29 class GitConfig:
  30     __defaults={
  31         'stgit.autoresolved':   'no',
  32         'stgit.smtpserver':     'localhost:25',
  33         'stgit.smtpdelay':      '5',
  34         'stgit.pullcmd':        'git pull',
  35         'stgit.fetchcmd':       'git fetch',
  36         'stgit.pull-policy':    'pull',
  37         'stgit.autoimerge':     'no',
  38         'stgit.keepoptimized':  'no',
  39         'stgit.extensions':     '.ancestor .current .patched',
  40         'stgit.shortnr':         '5'
  41         }
  42
  43     __cache={}
  44
  45     def get(self, name):
  46         if self.__cache.has_key(name):
  47             return self.__cache[name]
  48         try:
  49             value = Run('git', 'config', '--get', name).output_one_line()
  50         except RunException:
  51             value = self.__defaults.get(name, None)
  52         self.__cache[name] = value
  53         return value
  54
  55     def getall(self, name):
  56         if self.__cache.has_key(name):
  57             return self.__cache[name]
  58         values = Run('git', 'config', '--get-all', name
  59                      ).returns([0, 1]).output_lines()
  60         self.__cache[name] = values
  61         return values
  62
  63     def getint(self, name):
  64         value = self.get(name)
  65         if value == None:
  66             return None
  67         elif value.isdigit():
  68             return int(value)
  69         else:
  70             raise GitConfigException, 'Value for "%s" is not an integer: "%s"' % (name, value)
  71
  72     def rename_section(self, from_name, to_name):
  73         """Rename a section in the config file. Silently do nothing if
  74         the section doesn't exist."""
  75         Run('git', 'config', '--rename-section', from_name, to_name
  76             ).returns([0, 1, 128]).run()
  77         self.__cache.clear()
  78
  79     def remove_section(self, name):
  80         """Remove a section in the config file. Silently do nothing if
  81         the section doesn't exist."""
  82         Run('git', 'config', '--remove-section', name
  83             ).returns([0, 1, 128]).discard_stderr().discard_output()
  84         self.__cache.clear()
  85
  86     def set(self, name, value):
  87         Run('git', 'config', name, value).run()
  88         self.__cache[name] = value
  89
  90     def unset(self, name):
  91         Run('git', 'config', '--unset', name)
  92         self.__cache[name] = None
  93
  94     def sections_matching(self, regexp):
  95         """Takes a regexp with a single group, matches it against all
  96         config variables, and returns a list whose members are the
  97         group contents, for all variable names matching the regexp.
  98         """
  99         result = []
 100         for line in Run('git', 'config', '--get-regexp', '"^%s$"' % regexp
 101                         ).returns([0, 1]).output_lines():
 102             m = re.match('^%s ' % regexp, line)
 103             if m:
 104                 result.append(m.group(1))
 105         return result
 106
 107 config=GitConfig()
 108
 109 def config_setup():
 110     global config
 111
 112     # Set the PAGER environment to the config value (if any)
 113     pager = config.get('stgit.pager')
 114     if pager:
 115         os.environ['PAGER'] = pager
 116     # FIXME: handle EDITOR the same way ?
 117
 118 class ConfigOption:
 119     """Delayed cached reading of a configuration option.
 120     """
 121     def __init__(self, section, option):
 122         self.__section = section
 123         self.__option = option
 124         self.__value = None
 125
 126     def __str__(self):
 127         if not self.__value:
 128             self.__value = config.get(self.__section + '.' + self.__option)
 129         return self.__value
 130
 131
 132 # cached extensions
 133 __extensions = None
 134
 135 def file_extensions():
 136     """Returns a dictionary with the conflict file extensions
 137     """
 138     global __extensions
 139
 140     if not __extensions:
 141         cfg_ext = config.get('stgit.extensions').split()
 142         if len(cfg_ext) != 3:
 143             raise CmdException, '"extensions" configuration error'
 144
 145         __extensions = { 'ancestor': cfg_ext[0],
 146                          'current':  cfg_ext[1],
 147                          'patched':  cfg_ext[2] }
 148
 149     return __extensions