← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-10-16 10:03:21 UTC
  • mfrom: (1988.4.6 dotted-revno-input.)
  • Revision ID: pqm@pqm.ubuntu.com-20061016100321-c4951c9fc020dbd0
(Robert Collins) Output dotted decimal revision numbers during log, and accept them as revision specifiers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
import textwrap
 
24
from bzrlib import osutils 
 
25
 
 
26
global_help = \
 
27
"""Bazaar -- a free distributed version-control tool
 
28
http://bazaar-vcs.org/
 
29
 
 
30
Basic commands:
 
31
 
 
32
  bzr init           makes this directory a versioned branch
 
33
  bzr branch         make a copy of another branch
 
34
 
 
35
  bzr add            make files or directories versioned
 
36
  bzr ignore         ignore a file or pattern
 
37
  bzr mv             move or rename a versioned file
 
38
 
 
39
  bzr status         summarize changes in working copy
 
40
  bzr diff           show detailed diffs
 
41
 
 
42
  bzr merge          pull in changes from another branch
 
43
  bzr commit         save some or all changes
 
44
 
 
45
  bzr log            show history of changes
 
46
  bzr check          validate storage
 
47
 
 
48
  bzr help init      more help on e.g. init command
 
49
  bzr help commands  list all commands
 
50
"""
 
51
 
23
52
 
24
53
import sys
25
 
import textwrap
26
 
 
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"""
38
 
    if outfile is None:
39
 
        outfile = sys.stdout
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)))
 
54
 
 
55
 
 
56
def help(topic=None, outfile = None):
 
57
    if outfile is None:
 
58
        outfile = sys.stdout
 
59
    if topic is None:
 
60
        outfile.write(global_help)
 
61
    elif topic == 'commands':
 
62
        help_commands(outfile = outfile)
 
63
    else:
 
64
        help_on_command(topic, outfile = outfile)
 
65
 
 
66
 
 
67
def command_usage(cmd_object):
 
68
    """Return single-line grammar for command.
 
69
 
 
70
    Only describes arguments, not options.
 
71
    """
 
72
    s = 'bzr ' + cmd_object.name() + ' '
 
73
    for aname in cmd_object.takes_args:
 
74
        aname = aname.upper()
 
75
        if aname[-1] in ['$', '+']:
 
76
            aname = aname[:-1] + '...'
 
77
        elif aname[-1] == '?':
 
78
            aname = '[' + aname[:-1] + ']'
 
79
        elif aname[-1] == '*':
 
80
            aname = '[' + aname[:-1] + '...]'
 
81
        s += aname + ' '
 
82
            
 
83
    assert s[-1] == ' '
 
84
    s = s[:-1]
 
85
    
 
86
    return s
 
87
 
 
88
 
 
89
def print_command_plugin(cmd_object, outfile, format):
 
90
    """Print the plugin that provides a command object, if any.
 
91
 
 
92
    If the cmd_object is provided by a plugin, prints the plugin name to
 
93
    outfile using the provided format string.
 
94
    """
 
95
    plugin_name = cmd_object.plugin_name()
 
96
    if plugin_name is not None:
 
97
        out_str = '(From plugin "%s")' % plugin_name
 
98
        outfile.write(format % out_str)
 
99
 
 
100
 
 
101
def help_on_command(cmdname, outfile=None):
 
102
    from bzrlib.commands import get_cmd_object
 
103
 
 
104
    cmdname = str(cmdname)
 
105
 
 
106
    if outfile is None:
 
107
        outfile = sys.stdout
 
108
 
 
109
    cmd_object = get_cmd_object(cmdname)
 
110
 
 
111
    doc = cmd_object.help()
 
112
    if doc is None:
 
113
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
114
 
 
115
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
116
 
 
117
    if cmd_object.aliases:
 
118
        print >>outfile, 'aliases:',
 
119
        print >>outfile, ', '.join(cmd_object.aliases)
 
120
 
 
121
    print >>outfile
 
122
 
 
123
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
124
 
 
125
    outfile.write(doc)
 
126
    if doc[-1] != '\n':
 
127
        outfile.write('\n')
 
128
    help_on_command_options(cmd_object, outfile)
 
129
 
 
130
 
 
131
def help_on_command_options(cmd, outfile=None):
 
132
    from bzrlib.option import Option, get_optparser
 
133
    if outfile is None:
 
134
        outfile = sys.stdout
 
135
    options = cmd.options()
 
136
    outfile.write('\n')
 
137
    outfile.write(get_optparser(options).format_option_help())
59
138
 
60
139
 
61
140
def help_commands(outfile=None):
62
141
    """List all commands"""
 
142
    from bzrlib.commands import (builtin_command_names,
 
143
                                 plugin_command_names,
 
144
                                 get_cmd_object)
63
145
    if outfile is None:
64
146
        outfile = sys.stdout
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]
 
147
    names = set(builtin_command_names()) # to eliminate duplicates
 
148
    names.update(plugin_command_names())
 
149
    commands = ((n, get_cmd_object(n)) for n in names)
 
150
    shown_commands = [(n, o) for n, o in commands if not o.hidden]
78
151
    max_name = max(len(n) for n, o in shown_commands)
79
152
    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
 
 
 
153
    width = osutils.terminal_width() - 1
86
154
    for cmd_name, cmd_object in sorted(shown_commands):
87
155
        plugin_name = cmd_object.plugin_name()
88
156
        if plugin_name is None:
96
164
        else:
97
165
            firstline = ''
98
166
        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)
 
167
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
168
                              width=width)
103
169
        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
 
170
            outfile.write(line + '\n')