← 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-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

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, get_optparser
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    )
 
34
 
 
35
 
 
36
def help(topic=None, outfile=None):
 
37
    """Write the help for the specific topic to outfile"""
132
38
    if outfile is None:
133
39
        outfile = sys.stdout
134
 
    options = cmd.options()
135
 
    outfile.write('\n')
136
 
    outfile.write(get_optparser(options).format_option_help())
 
40
 
 
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 in topics[1:]:
 
48
            shadowed_terms.append('%s%s' % (index.prefix,
 
49
                topic.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)))
137
59
 
138
60
 
139
61
def help_commands(outfile=None):
140
62
    """List all commands"""
141
 
    from bzrlib.commands import (builtin_command_names,
142
 
                                 plugin_command_names,
143
 
                                 get_cmd_object)
144
 
 
145
 
    if outfile == None:
 
63
    if outfile is None:
146
64
        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
 
 
 
65
    outfile.write(_help_commands_to_text('commands'))
 
66
 
 
67
 
 
68
def _help_commands_to_text(topic):
 
69
    """Generate the help text for the list of commands"""
 
70
    out = []
 
71
    if topic == 'hidden-commands':
 
72
        hidden = True
 
73
    else:
 
74
        hidden = False
 
75
    names = list(_mod_commands.all_command_names())
 
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
78
    max_name = max(len(n) for n, o in shown_commands)
 
79
    indent = ' ' * (max_name + 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
 
85
 
 
86
    for cmd_name, cmd_object in sorted(shown_commands):
160
87
        plugin_name = cmd_object.plugin_name()
161
 
        print_command_plugin(cmd_object, outfile, '        %s\n')
 
88
        if plugin_name is None:
 
89
            plugin_name = ''
 
90
        else:
 
91
            plugin_name = ' [%s]' % plugin_name
162
92
 
163
93
        cmd_help = cmd_object.help()
164
94
        if cmd_help:
165
95
            firstline = cmd_help.split('\n', 1)[0]
166
 
            print >>outfile, '        ' + firstline
167
 
        
 
96
        else:
 
97
            firstline = ''
 
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
99
        lines = textwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
 
103
        for line in lines:
 
104
            out.append(line + '\n')
 
105
    return ''.join(out)
 
106
 
 
107
 
 
108
help_topics.topic_registry.register("commands",
 
109
                                    _help_commands_to_text,
 
110
                                    "Basic help for all commands",
 
111
                                    help_topics.SECT_HIDDEN)
 
112
help_topics.topic_registry.register("hidden-commands",
 
113
                                    _help_commands_to_text,
 
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
            ]
 
139
 
 
140
    def _check_prefix_uniqueness(self):
 
141
        """Ensure that the index collection is able to differentiate safely."""
 
142
        prefixes = {}
 
143
        for index in self.search_path:
 
144
            prefixes.setdefault(index.prefix, []).append(index)
 
145
        for prefix, indices in prefixes.items():
 
146
            if len(indices) > 1:
 
147
                raise errors.DuplicateHelpPrefix(prefix)
 
148
 
 
149
    def search(self, topic):
 
150
        """Search for topic across the help search path.
 
151
 
 
152
        :param topic: A string naming the help topic to search for.
 
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
154
        :return: A list of HelpTopics which matched 'topic'.
 
155
        """
 
156
        self._check_prefix_uniqueness()
 
157
        result = []
 
158
        for index in self.search_path:
 
159
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
160
        if not result:
 
161
            raise errors.NoHelpTopic(topic)
 
162
        else:
 
163
            return result