← 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: 2011-08-19 22:34:02 UTC
  • mto: This revision was merged to the branch mainline in revision 6089.
  • Revision ID: jelmer@samba.org-20110819223402-wjywqb0fa1xxx522
Use get_transport_from_{url,path} in more 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
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.
22
22
# TODO: `help commands --all` should show hidden commands
23
23
 
24
24
import sys
25
 
import textwrap
26
25
 
27
26
from bzrlib import (
 
27
    commands as _mod_commands,
 
28
    errors,
28
29
    help_topics,
29
30
    osutils,
 
31
    plugin,
 
32
    utextwrap,
30
33
    )
31
34
 
32
35
 
35
38
    if outfile is None:
36
39
        outfile = sys.stdout
37
40
 
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())
 
41
    indices = HelpIndices()
 
42
 
 
43
    alias = _mod_commands.get_alias(topic)
 
44
    try:
 
45
        topics = indices.search(topic)
 
46
        shadowed_terms = []
 
47
        for index, topic_obj in topics[1:]:
 
48
            shadowed_terms.append('%s%s' % (index.prefix,
 
49
                topic_obj.get_help_topic()))
 
50
        source = topics[0][1]
 
51
        outfile.write(source.get_help_text(shadowed_terms))
 
52
    except errors.NoHelpTopic:
 
53
        if alias is None:
 
54
            raise
 
55
 
 
56
    if alias is not None:
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
58
            " ".join(alias)))
119
59
 
120
60
 
121
61
def help_commands(outfile=None):
127
67
 
128
68
def _help_commands_to_text(topic):
129
69
    """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
70
    out = []
134
71
    if topic == 'hidden-commands':
135
72
        hidden = True
136
73
    else:
137
74
        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)
 
75
    names = list(_mod_commands.all_command_names())
 
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
141
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
78
    max_name = max(len(n) for n, o in shown_commands)
143
79
    indent = ' ' * (max_name + 1)
144
 
    width = osutils.terminal_width() - 1
 
80
    width = osutils.terminal_width()
 
81
    if width is None:
 
82
        width = osutils.default_terminal_width
 
83
    # we need one extra space for terminals that wrap on last char
 
84
    width = width - 1
145
85
 
146
86
    for cmd_name, cmd_object in sorted(shown_commands):
147
87
        plugin_name = cmd_object.plugin_name()
156
96
        else:
157
97
            firstline = ''
158
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
160
 
                              width=width)
 
99
        lines = utextwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
161
103
        for line in lines:
162
104
            out.append(line + '\n')
163
105
    return ''.join(out)
165
107
 
166
108
help_topics.topic_registry.register("commands",
167
109
                                    _help_commands_to_text,
168
 
                                    "Basic help for all commands")
169
 
help_topics.topic_registry.register("hidden-commands", 
 
110
                                    "Basic help for all commands",
 
111
                                    help_topics.SECT_HIDDEN)
 
112
help_topics.topic_registry.register("hidden-commands",
170
113
                                    _help_commands_to_text,
171
 
                                    "All hidden commands")
 
114
                                    "All hidden commands",
 
115
                                    help_topics.SECT_HIDDEN)
 
116
 
 
117
 
 
118
class HelpIndices(object):
 
119
    """Maintainer of help topics across multiple indices.
 
120
 
 
121
    It is currently separate to the HelpTopicRegistry because of its ordered
 
122
    nature, but possibly we should instead structure it as a search within the
 
123
    registry and add ordering and searching facilities to the registry. The
 
124
    registry would probably need to be restructured to support that cleanly
 
125
    which is why this has been implemented in parallel even though it does as a
 
126
    result permit searching for help in indices which are not discoverable via
 
127
    'help topics'.
 
128
 
 
129
    Each index has a unique prefix string, such as "commands", and contains
 
130
    help topics which can be listed or searched.
 
131
    """
 
132
 
 
133
    def __init__(self):
 
134
        self.search_path = [
 
135
            help_topics.HelpTopicIndex(),
 
136
            _mod_commands.HelpCommandIndex(),
 
137
            plugin.PluginsHelpIndex(),
 
138
            help_topics.ConfigOptionHelpIndex(),
 
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