← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
20
20
# executable files with reasonable names.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
 
23
 
 
24
import sys
23
25
import textwrap
24
26
 
25
 
global_help = \
26
 
"""Bazaar -- a free distributed version-control tool
27
 
http://bazaar-vcs.org/
28
 
 
29
 
Basic commands:
30
 
 
31
 
  bzr init           makes this directory a versioned branch
32
 
  bzr branch         make a copy of another branch
33
 
 
34
 
  bzr add            make files or directories versioned
35
 
  bzr ignore         ignore a file or pattern
36
 
  bzr mv             move or rename a versioned file
37
 
 
38
 
  bzr status         summarize changes in working copy
39
 
  bzr diff           show detailed diffs
40
 
 
41
 
  bzr merge          pull in changes from another branch
42
 
  bzr commit         save some or all changes
43
 
 
44
 
  bzr log            show history of changes
45
 
  bzr check          validate storage
46
 
 
47
 
  bzr help init      more help on e.g. init command
48
 
  bzr help commands  list all commands
49
 
"""
50
 
 
51
 
 
52
 
import sys
53
 
 
54
 
 
55
 
def help(topic=None, outfile = None):
56
 
    if outfile == None:
57
 
        outfile = sys.stdout
58
 
    if topic == None:
59
 
        outfile.write(global_help)
60
 
    elif topic == 'commands':
61
 
        help_commands(outfile = outfile)
62
 
    else:
63
 
        help_on_command(topic, outfile = outfile)
64
 
 
65
 
 
66
 
def command_usage(cmd_object):
67
 
    """Return single-line grammar for command.
68
 
 
69
 
    Only describes arguments, not options.
70
 
    """
71
 
    s = 'bzr ' + cmd_object.name() + ' '
72
 
    for aname in cmd_object.takes_args:
73
 
        aname = aname.upper()
74
 
        if aname[-1] in ['$', '+']:
75
 
            aname = aname[:-1] + '...'
76
 
        elif aname[-1] == '?':
77
 
            aname = '[' + aname[:-1] + ']'
78
 
        elif aname[-1] == '*':
79
 
            aname = '[' + aname[:-1] + '...]'
80
 
        s += aname + ' '
81
 
            
82
 
    assert s[-1] == ' '
83
 
    s = s[:-1]
84
 
    
85
 
    return s
86
 
 
87
 
 
88
 
def print_command_plugin(cmd_object, outfile, format):
89
 
    """Print the plugin that provides a command object, if any.
90
 
 
91
 
    If the cmd_object is provided by a plugin, prints the plugin name to
92
 
    outfile using the provided format string.
93
 
    """
94
 
    plugin_name = cmd_object.plugin_name()
95
 
    if plugin_name is not None:
96
 
        out_str = '(From plugin "%s")' % plugin_name
97
 
        outfile.write(format % out_str)
98
 
 
99
 
 
100
 
def help_on_command(cmdname, outfile=None):
101
 
    from bzrlib.commands import get_cmd_object
102
 
 
103
 
    cmdname = str(cmdname)
104
 
 
105
 
    if outfile == None:
106
 
        outfile = sys.stdout
107
 
 
108
 
    cmd_object = get_cmd_object(cmdname)
109
 
 
110
 
    doc = cmd_object.help()
111
 
    if doc == None:
112
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
113
 
 
114
 
    print >>outfile, 'usage:', command_usage(cmd_object) 
115
 
 
116
 
    if cmd_object.aliases:
117
 
        print >>outfile, 'aliases:',
118
 
        print >>outfile, ', '.join(cmd_object.aliases)
119
 
 
120
 
    print >>outfile
121
 
 
122
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
123
 
 
124
 
    outfile.write(doc)
125
 
    if doc[-1] != '\n':
126
 
        outfile.write('\n')
127
 
    help_on_command_options(cmd_object, outfile)
128
 
 
129
 
 
130
 
def help_on_command_options(cmd, outfile=None):
131
 
    from bzrlib.option import Option
132
 
    options = cmd.options()
133
 
    if not options:
134
 
        return
135
 
    if outfile == None:
136
 
        outfile = sys.stdout
137
 
    outfile.write('\noptions:\n')
138
 
    for option_name, option in sorted(options.items()):
139
 
        l = '    --' + option_name
140
 
        if option.type is not None:
141
 
            l += ' ' + option.argname.upper()
142
 
        short_name = option.short_name()
143
 
        if short_name:
144
 
            assert len(short_name) == 1
145
 
            l += ', -' + short_name
146
 
        l += (30 - len(l)) * ' ' + option.help
147
 
        # TODO: split help over multiple lines with correct indenting and 
148
 
        # wrapping
149
 
        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
150
 
        outfile.write(wrapped + '\n')
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    symbol_versioning,
 
34
    )
 
35
 
 
36
 
 
37
def help(topic=None, outfile=None):
 
38
    """Write the help for the specific topic to outfile"""
 
39
    if outfile is None:
 
40
        outfile = sys.stdout
 
41
 
 
42
    indices = HelpIndices()
 
43
 
 
44
    alias = _mod_commands.get_alias(topic)
 
45
    try:
 
46
        topics = indices.search(topic)
 
47
        shadowed_terms = []
 
48
        for index, topic in topics[1:]:
 
49
            shadowed_terms.append('%s%s' % (index.prefix,
 
50
                topic.get_help_topic()))
 
51
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
 
53
    except errors.NoHelpTopic:
 
54
        if alias is None:
 
55
            raise
 
56
 
 
57
    if alias is not None:
 
58
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
59
            " ".join(alias)))
151
60
 
152
61
 
153
62
def help_commands(outfile=None):
154
63
    """List all commands"""
155
 
    from bzrlib.commands import (builtin_command_names,
156
 
                                 plugin_command_names,
157
 
                                 get_cmd_object)
158
 
 
159
 
    if outfile == None:
 
64
    if outfile is None:
160
65
        outfile = sys.stdout
161
 
 
162
 
    names = set()                       # to eliminate duplicates
163
 
    names.update(builtin_command_names())
164
 
    names.update(plugin_command_names())
165
 
    names = list(names)
166
 
    names.sort()
167
 
 
168
 
    for cmd_name in names:
169
 
        cmd_object = get_cmd_object(cmd_name)
170
 
        if cmd_object.hidden:
171
 
            continue
172
 
        print >>outfile, command_usage(cmd_object)
173
 
 
 
66
    outfile.write(_help_commands_to_text('commands'))
 
67
 
 
68
 
 
69
def _help_commands_to_text(topic):
 
70
    """Generate the help text for the list of commands"""
 
71
    out = []
 
72
    if topic == 'hidden-commands':
 
73
        hidden = True
 
74
    else:
 
75
        hidden = False
 
76
    names = list(_mod_commands.all_command_names())
 
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
79
    max_name = max(len(n) for n, o in shown_commands)
 
80
    indent = ' ' * (max_name + 1)
 
81
    width = osutils.terminal_width()
 
82
    if width is None:
 
83
        width = osutils.default_terminal_width
 
84
    # we need one extra space for terminals that wrap on last char
 
85
    width = width - 1
 
86
 
 
87
    for cmd_name, cmd_object in sorted(shown_commands):
174
88
        plugin_name = cmd_object.plugin_name()
175
 
        print_command_plugin(cmd_object, outfile, '        %s\n')
 
89
        if plugin_name is None:
 
90
            plugin_name = ''
 
91
        else:
 
92
            plugin_name = ' [%s]' % plugin_name
176
93
 
177
94
        cmd_help = cmd_object.help()
178
95
        if cmd_help:
179
96
            firstline = cmd_help.split('\n', 1)[0]
180
 
            print >>outfile, '        ' + firstline
181
 
        
 
97
        else:
 
98
            firstline = ''
 
99
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
100
        lines = textwrap.wrap(
 
101
            helpstring, subsequent_indent=indent,
 
102
            width=width,
 
103
            break_long_words=False)
 
104
        for line in lines:
 
105
            out.append(line + '\n')
 
106
    return ''.join(out)
 
107
 
 
108
 
 
109
help_topics.topic_registry.register("commands",
 
110
                                    _help_commands_to_text,
 
111
                                    "Basic help for all commands",
 
112
                                    help_topics.SECT_HIDDEN)
 
113
help_topics.topic_registry.register("hidden-commands",
 
114
                                    _help_commands_to_text,
 
115
                                    "All hidden commands",
 
116
                                    help_topics.SECT_HIDDEN)
 
117
 
 
118
 
 
119
class HelpIndices(object):
 
120
    """Maintainer of help topics across multiple indices.
 
121
 
 
122
    It is currently separate to the HelpTopicRegistry because of its ordered
 
123
    nature, but possibly we should instead structure it as a search within the
 
124
    registry and add ordering and searching facilities to the registry. The
 
125
    registry would probably need to be restructured to support that cleanly
 
126
    which is why this has been implemented in parallel even though it does as a
 
127
    result permit searching for help in indices which are not discoverable via
 
128
    'help topics'.
 
129
 
 
130
    Each index has a unique prefix string, such as "commands", and contains
 
131
    help topics which can be listed or searched.
 
132
    """
 
133
 
 
134
    def __init__(self):
 
135
        self.search_path = [
 
136
            help_topics.HelpTopicIndex(),
 
137
            _mod_commands.HelpCommandIndex(),
 
138
            plugin.PluginsHelpIndex(),
 
139
            ]
 
140
 
 
141
    def _check_prefix_uniqueness(self):
 
142
        """Ensure that the index collection is able to differentiate safely."""
 
143
        prefixes = {}
 
144
        for index in self.search_path:
 
145
            prefixes.setdefault(index.prefix, []).append(index)
 
146
        for prefix, indices in prefixes.items():
 
147
            if len(indices) > 1:
 
148
                raise errors.DuplicateHelpPrefix(prefix)
 
149
 
 
150
    def search(self, topic):
 
151
        """Search for topic across the help search path.
 
152
 
 
153
        :param topic: A string naming the help topic to search for.
 
154
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
155
        :return: A list of HelpTopics which matched 'topic'.
 
156
        """
 
157
        self._check_prefix_uniqueness()
 
158
        result = []
 
159
        for index in self.search_path:
 
160
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
161
        if not result:
 
162
            raise errors.NoHelpTopic(topic)
 
163
        else:
 
164
            return result