blob: bf07c82ac740119e86d6bd475ab6aa3f26fb6b7e [file] [log] [blame]
# -*- coding: utf-8 -*-
__copyright__ = """
Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
Copyright (C) 2008, Karl Hasselström <kha@treskal.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
import os
from stgit import utils
def get_command(mod):
"""Import and return the given command module."""
return __import__(__name__ + '.' + mod, globals(), locals(), ['*'])
_kinds = [('repo', 'Repository commands'),
('stack', 'Stack (branch) commands'),
('patch', 'Patch commands'),
('wc', 'Index/worktree commands'),
('alias', 'Alias commands')]
_kind_order = [kind for kind, desc in _kinds]
_kinds = dict(_kinds)
def _find_commands():
for p in __path__:
for fn in os.listdir(p):
if not fn.endswith('.py'):
continue
mod = utils.strip_suffix('.py', fn)
m = get_command(mod)
if not hasattr(m, 'usage'):
continue
yield mod, m
def get_commands(allow_cached = True):
"""Return a map from command name to a tuple of module name, command
type, and one-line command help."""
if allow_cached:
try:
from stgit.commands.cmdlist import command_list
return command_list
except ImportError:
# cmdlist.py doesn't exist, so do it the expensive way.
pass
return dict((getattr(m, 'name', mod), (mod, _kinds[m.kind], m.help))
for mod, m in _find_commands())
def py_commands(commands, f):
f.write('command_list = {\n')
for key, val in sorted(commands.iteritems()):
f.write(' %r: %r,\n' % (key, val))
f.write(' }\n')
def _command_list(commands):
kinds = {}
for cmd, (mod, kind, help) in commands.iteritems():
kinds.setdefault(kind, {})[cmd] = help
for kind in _kind_order:
kind = _kinds[kind]
try:
yield kind, sorted(kinds[kind].iteritems())
except KeyError:
pass
def pretty_command_list(commands, f):
cmd_len = max(len(cmd) for cmd in commands.iterkeys())
sep = ''
for kind, cmds in _command_list(commands):
f.write(sep)
sep = '\n'
f.write('%s:\n' % kind)
for cmd, help in cmds:
f.write(' %*s %s\n' % (-cmd_len, cmd, help))
def _write_underlined(s, u, f):
f.write(s + '\n')
f.write(u*len(s) + '\n')
def asciidoc_command_list(commands, f):
for kind, cmds in _command_list(commands):
_write_underlined(kind, '~', f)
f.write('\n')
for cmd, help in cmds:
f.write('linkstgsub:%s[]::\n' % cmd)
f.write(' %s\n' % help)
f.write('\n')