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

   1 """Basic quilt-like functionality
   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 sys, os
  22 from optparse import OptionParser
  23
  24 import stgit.commands
  25
  26 #
  27 # The commands map
  28 #
  29 class Commands(dict):
  30     """Commands class. It performs on-demand module loading
  31     """
  32     def canonical_cmd(self, key):
  33         """Return the canonical name for a possibly-shortenned
  34         command name.
  35         """
  36         candidates = [cmd for cmd in self.keys() if cmd.startswith(key)]
  37
  38         if not candidates:
  39             print >> sys.stderr, 'Unknown command: %s' % key
  40             print >> sys.stderr, '  Try "%s help" for a list of ' \
  41                   'supported commands' % prog
  42             sys.exit(1)
  43         elif len(candidates) > 1:
  44             print >> sys.stderr, 'Ambiguous command: %s' % key
  45             print >> sys.stderr, '  Candidates are: %s' \
  46                   % ', '.join(candidates)
  47             sys.exit(1)
  48
  49         return candidates[0]
  50
  51     def __getitem__(self, key):
  52         """Return the command python module name based.
  53         """
  54         global prog
  55
  56         cmd_mod = self.get(key) or self.get(self.canonical_cmd(key))
  57
  58         __import__('stgit.commands.' + cmd_mod)
  59         return getattr(stgit.commands, cmd_mod)
  60
  61 commands = Commands({
  62     'add':              'add',
  63     'applied':          'applied',
  64     'assimilate':       'assimilate',
  65     'branch':           'branch',
  66     'delete':           'delete',
  67     'diff':             'diff',
  68     'clean':            'clean',
  69     'clone':            'clone',
  70     'commit':           'commit',
  71     'cp':               'copy',
  72     'export':           'export',
  73     'files':            'files',
  74     'float':            'float',
  75     'fold':             'fold',
  76     'goto':             'goto',
  77     'hide':             'hide',
  78     'id':               'id',
  79     'import':           'imprt',
  80     'init':             'init',
  81     'log':              'log',
  82     'mail':             'mail',
  83     'new':              'new',
  84     'patches':          'patches',
  85     'pick':             'pick',
  86     'pop':              'pop',
  87     'pull':             'pull',
  88     'push':             'push',
  89     'rebase':           'rebase',
  90     'refresh':          'refresh',
  91     'rename':           'rename',
  92     'resolved':         'resolved',
  93     'rm':               'rm',
  94     'series':           'series',
  95     'show':             'show',
  96     'status':           'status',
  97     'sync':             'sync',
  98     'top':              'top',
  99     'unapplied':        'unapplied',
 100     'uncommit':         'uncommit',
 101     'unhide':           'unhide'
 102     })
 103
 104 # classification: repository, stack, patch, working copy
 105 repocommands = (
 106     'clone',
 107     'id',
 108     )
 109 stackcommands = (
 110     'applied',
 111     'assimilate',
 112     'branch',
 113     'clean',
 114     'commit',
 115     'float',
 116     'goto',
 117     'hide',
 118     'init',
 119     'patches',
 120     'pop',
 121     'pull',
 122     'push',
 123     'rebase',
 124     'series',
 125     'top',
 126     'unapplied',
 127     'uncommit',
 128     'unhide',
 129     )
 130 patchcommands = (
 131     'delete',
 132     'export',
 133     'files',
 134     'fold',
 135     'import',
 136     'log',
 137     'mail',
 138     'new',
 139     'pick',
 140     'refresh',
 141     'rename',
 142     'show',
 143     'sync',
 144     )
 145 wccommands = (
 146     'add',
 147     'cp',
 148     'diff',
 149     'resolved',
 150     'rm',
 151     'status',
 152     )
 153
 154 def _print_helpstring(cmd):
 155     print '  ' + cmd + ' ' * (12 - len(cmd)) + commands[cmd].help
 156
 157 def print_help():
 158     print 'usage: %s <command> [options]' % os.path.basename(sys.argv[0])
 159     print
 160     print 'Generic commands:'
 161     print '  help        print the detailed command usage'
 162     print '  version     display version information'
 163     print '  copyright   display copyright information'
 164     # unclassified commands if any
 165     cmds = commands.keys()
 166     cmds.sort()
 167     for cmd in cmds:
 168         if not cmd in repocommands and not cmd in stackcommands \
 169                and not cmd in patchcommands and not cmd in wccommands:
 170             _print_helpstring(cmd)
 171     print
 172
 173     print 'Repository commands:'
 174     for cmd in repocommands:
 175         _print_helpstring(cmd)
 176     print
 177
 178     print 'Stack commands:'
 179     for cmd in stackcommands:
 180         _print_helpstring(cmd)
 181     print
 182
 183     print 'Patch commands:'
 184     for cmd in patchcommands:
 185         _print_helpstring(cmd)
 186     print
 187
 188     print 'Working-copy commands:'
 189     for cmd in wccommands:
 190         _print_helpstring(cmd)
 191
 192 #
 193 # The main function (command dispatcher)
 194 #
 195 def main():
 196     """The main function
 197     """
 198     global prog
 199
 200     prog = os.path.basename(sys.argv[0])
 201
 202     if len(sys.argv) < 2:
 203         print >> sys.stderr, 'usage: %s <command>' % prog
 204         print >> sys.stderr, \
 205               '  Try "%s --help" for a list of supported commands' % prog
 206         sys.exit(1)
 207
 208     cmd = sys.argv[1]
 209
 210     if cmd in ['-h', '--help']:
 211         if len(sys.argv) >= 3:
 212             cmd = commands.canonical_cmd(sys.argv[2])
 213             sys.argv[2] = '--help'
 214         else:
 215             print_help()
 216             sys.exit(0)
 217     if cmd == 'help':
 218         if len(sys.argv) == 3 and not sys.argv[2] in ['-h', '--help']:
 219             cmd = commands.canonical_cmd(sys.argv[2])
 220             if not cmd in commands:
 221                 print >> sys.stderr, '%s help: "%s" command unknown' \
 222                       % (prog, cmd)
 223                 sys.exit(1)
 224
 225             sys.argv[0] += ' %s' % cmd
 226             command = commands[cmd]
 227             parser = OptionParser(usage = command.usage,
 228                                   option_list = command.options)
 229             from pydoc import pager
 230             pager(parser.format_help())
 231         else:
 232             print_help()
 233         sys.exit(0)
 234     if cmd in ['-v', '--version', 'version']:
 235         from stgit.version import version
 236         print 'Stacked GIT %s' % version
 237         os.system('git --version')
 238         print 'Python version %s' % sys.version
 239         sys.exit(0)
 240     if cmd in ['copyright']:
 241         print __copyright__
 242         sys.exit(0)
 243
 244     # re-build the command line arguments
 245     sys.argv[0] += ' %s' % commands.canonical_cmd(cmd)
 246     del(sys.argv[1])
 247
 248     command = commands[cmd]
 249     usage = command.usage.split('\n')[0].strip()
 250     parser = OptionParser(usage = usage, option_list = command.options)
 251     options, args = parser.parse_args()
 252
 253     # These modules are only used from this point onwards and do not
 254     # need to be imported earlier
 255     from stgit.config import config_setup
 256     from ConfigParser import ParsingError, NoSectionError
 257     from stgit.stack import Series, StackException
 258     from stgit.git import GitException
 259     from stgit.commands.common import CmdException
 260     from stgit.gitmergeonefile import GitMergeException
 261     from stgit.utils import EditorException
 262
 263     try:
 264         debug_level = int(os.environ['STGIT_DEBUG_LEVEL'])
 265     except KeyError:
 266         debug_level = 0
 267     except ValueError:
 268         print >> sys.stderr, 'Invalid STGIT_DEBUG_LEVEL environment variable'
 269         sys.exit(1)
 270
 271     try:
 272         config_setup()
 273
 274         # 'clone' doesn't expect an already initialised GIT tree. A Series
 275         # object will be created after the GIT tree is cloned
 276         if cmd != 'clone':
 277             if hasattr(options, 'branch') and options.branch:
 278                 command.crt_series = Series(options.branch)
 279             else:
 280                 command.crt_series = Series()
 281             stgit.commands.common.crt_series = command.crt_series
 282
 283         command.func(parser, options, args)
 284     except (IOError, ParsingError, NoSectionError, CmdException,
 285             StackException, GitException, GitMergeException,
 286             EditorException), err:
 287         print >> sys.stderr, '%s %s: %s' % (prog, cmd, err)
 288         if debug_level:
 289             raise
 290         else:
 291             sys.exit(2)
 292     except KeyboardInterrupt:
 293         sys.exit(1)
 294
 295     sys.exit(0)