← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
 
17
from __future__ import absolute_import
16
18
 
17
19
# TODO: Some way to get a list of external commands (defined by shell
18
20
# scripts) so that they can be included in the help listing as well.
22
24
# TODO: `help commands --all` should show hidden commands
23
25
 
24
26
import sys
25
 
import textwrap
26
27
 
27
28
from bzrlib import (
 
29
    commands as _mod_commands,
 
30
    errors,
28
31
    help_topics,
29
32
    osutils,
 
33
    plugin,
 
34
    utextwrap,
30
35
    )
31
36
 
32
37
 
35
40
    if outfile is None:
36
41
        outfile = sys.stdout
37
42
 
38
 
    if topic is None:
39
 
        topic = 'basic'
40
 
 
41
 
    if topic in help_topics.topic_registry:
42
 
        txt = help_topics.topic_registry.get_detail(topic)
43
 
        outfile.write(txt)
44
 
    else:
45
 
        help_on_command(topic, outfile=outfile)
46
 
 
47
 
 
48
 
def command_usage(cmd_object):
49
 
    """Return single-line grammar for command.
50
 
 
51
 
    Only describes arguments, not options.
52
 
    """
53
 
    s = 'bzr ' + cmd_object.name() + ' '
54
 
    for aname in cmd_object.takes_args:
55
 
        aname = aname.upper()
56
 
        if aname[-1] in ['$', '+']:
57
 
            aname = aname[:-1] + '...'
58
 
        elif aname[-1] == '?':
59
 
            aname = '[' + aname[:-1] + ']'
60
 
        elif aname[-1] == '*':
61
 
            aname = '[' + aname[:-1] + '...]'
62
 
        s += aname + ' '
63
 
            
64
 
    assert s[-1] == ' '
65
 
    s = s[:-1]
66
 
    
67
 
    return s
68
 
 
69
 
 
70
 
def print_command_plugin(cmd_object, outfile, format):
71
 
    """Print the plugin that provides a command object, if any.
72
 
 
73
 
    If the cmd_object is provided by a plugin, prints the plugin name to
74
 
    outfile using the provided format string.
75
 
    """
76
 
    plugin_name = cmd_object.plugin_name()
77
 
    if plugin_name is not None:
78
 
        out_str = '(From plugin "%s")' % plugin_name
79
 
        outfile.write(format % out_str)
80
 
 
81
 
 
82
 
def help_on_command(cmdname, outfile=None):
83
 
    from bzrlib.commands import get_cmd_object
84
 
 
85
 
    cmdname = str(cmdname)
86
 
 
87
 
    if outfile is None:
88
 
        outfile = sys.stdout
89
 
 
90
 
    cmd_object = get_cmd_object(cmdname)
91
 
 
92
 
    doc = cmd_object.help()
93
 
    if doc is None:
94
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
95
 
 
96
 
    print >>outfile, 'usage:', command_usage(cmd_object)
97
 
 
98
 
    if cmd_object.aliases:
99
 
        print >>outfile, 'aliases:',
100
 
        print >>outfile, ', '.join(cmd_object.aliases)
101
 
 
102
 
    print >>outfile
103
 
 
104
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
105
 
 
106
 
    outfile.write(doc)
107
 
    if doc[-1] != '\n':
108
 
        outfile.write('\n')
109
 
    help_on_command_options(cmd_object, outfile)
110
 
 
111
 
 
112
 
def help_on_command_options(cmd, outfile=None):
113
 
    from bzrlib.option import Option, get_optparser
114
 
    if outfile is None:
115
 
        outfile = sys.stdout
116
 
    options = cmd.options()
117
 
    outfile.write('\n')
118
 
    outfile.write(get_optparser(options).format_option_help())
 
43
    indices = HelpIndices()
 
44
 
 
45
    alias = _mod_commands.get_alias(topic)
 
46
    try:
 
47
        topics = indices.search(topic)
 
48
        shadowed_terms = []
 
49
        for index, topic_obj in topics[1:]:
 
50
            shadowed_terms.append('%s%s' % (index.prefix,
 
51
                topic_obj.get_help_topic()))
 
52
        source = topics[0][1]
 
53
        outfile.write(source.get_help_text(shadowed_terms))
 
54
    except errors.NoHelpTopic:
 
55
        if alias is None:
 
56
            raise
 
57
 
 
58
    if alias is not None:
 
59
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
60
            " ".join(alias)))
119
61
 
120
62
 
121
63
def help_commands(outfile=None):
127
69
 
128
70
def _help_commands_to_text(topic):
129
71
    """Generate the help text for the list of commands"""
130
 
    from bzrlib.commands import (builtin_command_names,
131
 
                                 plugin_command_names,
132
 
                                 get_cmd_object)
133
72
    out = []
134
73
    if topic == 'hidden-commands':
135
74
        hidden = True
136
75
    else:
137
76
        hidden = False
138
 
    names = set(builtin_command_names()) # to eliminate duplicates
139
 
    names.update(plugin_command_names())
140
 
    commands = ((n, get_cmd_object(n)) for n in names)
 
77
    names = list(_mod_commands.all_command_names())
 
78
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
141
79
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
80
    max_name = max(len(n) for n, o in shown_commands)
143
81
    indent = ' ' * (max_name + 1)
144
 
    width = osutils.terminal_width() - 1
 
82
    width = osutils.terminal_width()
 
83
    if width is None:
 
84
        width = osutils.default_terminal_width
 
85
    # we need one extra space for terminals that wrap on last char
 
86
    width = width - 1
145
87
 
146
88
    for cmd_name, cmd_object in sorted(shown_commands):
147
89
        plugin_name = cmd_object.plugin_name()
156
98
        else:
157
99
            firstline = ''
158
100
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
160
 
                              width=width)
 
101
        lines = utextwrap.wrap(
 
102
            helpstring, subsequent_indent=indent,
 
103
            width=width,
 
104
            break_long_words=False)
161
105
        for line in lines:
162
106
            out.append(line + '\n')
163
107
    return ''.join(out)
165
109
 
166
110
help_topics.topic_registry.register("commands",
167
111
                                    _help_commands_to_text,
168
 
                                    "Basic help for all commands")
169
 
help_topics.topic_registry.register("hidden-commands", 
 
112
                                    "Basic help for all commands",
 
113
                                    help_topics.SECT_HIDDEN)
 
114
help_topics.topic_registry.register("hidden-commands",
170
115
                                    _help_commands_to_text,
171
 
                                    "All hidden commands")
 
116
                                    "All hidden commands",
 
117
                                    help_topics.SECT_HIDDEN)
 
118
 
 
119
 
 
120
class HelpIndices(object):
 
121
    """Maintainer of help topics across multiple indices.
 
122
 
 
123
    It is currently separate to the HelpTopicRegistry because of its ordered
 
124
    nature, but possibly we should instead structure it as a search within the
 
125
    registry and add ordering and searching facilities to the registry. The
 
126
    registry would probably need to be restructured to support that cleanly
 
127
    which is why this has been implemented in parallel even though it does as a
 
128
    result permit searching for help in indices which are not discoverable via
 
129
    'help topics'.
 
130
 
 
131
    Each index has a unique prefix string, such as "commands", and contains
 
132
    help topics which can be listed or searched.
 
133
    """
 
134
 
 
135
    def __init__(self):
 
136
        self.search_path = [
 
137
            help_topics.HelpTopicIndex(),
 
138
            _mod_commands.HelpCommandIndex(),
 
139
            plugin.PluginsHelpIndex(),
 
140
            help_topics.ConfigOptionHelpIndex(),
 
141
            ]
 
142
 
 
143
    def _check_prefix_uniqueness(self):
 
144
        """Ensure that the index collection is able to differentiate safely."""
 
145
        prefixes = {}
 
146
        for index in self.search_path:
 
147
            prefixes.setdefault(index.prefix, []).append(index)
 
148
        for prefix, indices in prefixes.items():
 
149
            if len(indices) > 1:
 
150
                raise errors.DuplicateHelpPrefix(prefix)
 
151
 
 
152
    def search(self, topic):
 
153
        """Search for topic across the help search path.
 
154
 
 
155
        :param topic: A string naming the help topic to search for.
 
156
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
157
        :return: A list of HelpTopics which matched 'topic'.
 
158
        """
 
159
        self._check_prefix_uniqueness()
 
160
        result = []
 
161
        for index in self.search_path:
 
162
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
163
        if not result:
 
164
            raise errors.NoHelpTopic(topic)
 
165
        else:
 
166
            return result