← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Merge bzr.dev (and fix NEWS)

Show diffs side-by-side

added added

removed removed

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