mdw@git.distorted.org.uk Git - stgit/blob - stgit/commands/__init__.py

   1 # -*- coding: utf-8 -*-
   2
   3 __copyright__ = """
   4 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
   5 Copyright (C) 2008, Karl Hasselström <kha@treskal.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
  22 from stgit import utils
  23
  24 def get_command(mod):
  25     """Import and return the given command module."""
  26     return __import__(__name__ + '.' + mod, globals(), locals(), ['*'])
  27
  28 _kinds = [('repo', 'Repository commands'),
  29           ('stack', 'Stack (branch) commands'),
  30           ('patch', 'Patch commands'),
  31           ('wc', 'Index/worktree commands'),
  32           ('alias', 'Alias commands')]
  33 _kind_order = [kind for kind, desc in _kinds]
  34 _kinds = dict(_kinds)
  35
  36 def _find_commands():
  37     for p in __path__:
  38         for fn in os.listdir(p):
  39             if not fn.endswith('.py'):
  40                 continue
  41             mod = utils.strip_suffix('.py', fn)
  42             m = get_command(mod)
  43             if not hasattr(m, 'usage'):
  44                 continue
  45             yield mod, m
  46
  47 def get_commands(allow_cached = True):
  48     """Return a map from command name to a tuple of module name, command
  49     type, and one-line command help."""
  50     if allow_cached:
  51         try:
  52             from stgit.commands.cmdlist import command_list
  53             return command_list
  54         except ImportError:
  55             # cmdlist.py doesn't exist, so do it the expensive way.
  56             pass
  57     return dict((getattr(m, 'name', mod), (mod, _kinds[m.kind], m.help))
  58                 for mod, m in _find_commands())
  59
  60 def py_commands(commands, f):
  61     f.write('command_list = {\n')
  62     for key, val in sorted(commands.iteritems()):
  63         f.write('    %r: %r,\n' % (key, val))
  64     f.write('    }\n')
  65
  66 def _command_list(commands):
  67     kinds = {}
  68     for cmd, (mod, kind, help) in commands.iteritems():
  69         kinds.setdefault(kind, {})[cmd] = help
  70     for kind in _kind_order:
  71         kind = _kinds[kind]
  72         yield kind, sorted(kinds[kind].iteritems())
  73
  74 def pretty_command_list(commands, f):
  75     cmd_len = max(len(cmd) for cmd in commands.iterkeys())
  76     sep = ''
  77     for kind, cmds in _command_list(commands):
  78         f.write(sep)
  79         sep = '\n'
  80         f.write('%s:\n' % kind)
  81         for cmd, help in cmds:
  82             f.write('  %*s  %s\n' % (-cmd_len, cmd, help))
  83
  84 def _write_underlined(s, u, f):
  85     f.write(s + '\n')
  86     f.write(u*len(s) + '\n')
  87
  88 def asciidoc_command_list(commands, f):
  89     for kind, cmds in _command_list(commands):
  90         _write_underlined(kind, '~', f)
  91         f.write('\n')
  92         for cmd, help in cmds:
  93             f.write('linkstgsub:%s[]::\n' % cmd)
  94             f.write('    %s\n' % help)
  95         f.write('\n')