← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2009-06-19 06:21:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090619062113-019bp0a3bl2y4nkx
Un-soft-deprecate _supports_progress - still useful

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
16
 
 
17
 
global_help = \
18
 
"""Bazaar-NG -- a free distributed version-control tool
19
 
http://bazaar-ng.org/
20
 
 
21
 
WARNING: This is an unstable development version.
22
 
         Please keep backups.
23
 
 
24
 
Basic commands:
25
 
 
26
 
  bzr init      makes this branch versioned
27
 
  bzr branch    make a copy of another branch
28
 
 
29
 
  bzr add       make files or directories versioned
30
 
  bzr ignore    ignore a file or pattern
31
 
  bzr mv        move or rename a versioned file
32
 
 
33
 
  bzr status    summarize changes in working copy
34
 
  bzr diff      show detailed diffs
35
 
 
36
 
  bzr merge     pull in changes from another branch
37
 
  bzr commit    
38
 
 
39
 
  bzr log       show history of changes
40
 
  bzr check     validate storage
41
 
 
42
 
Use e.g. 'bzr help init' for more details, or 'bzr help commands' for
43
 
all commands.
44
 
"""
45
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
# TODO: Some way to get a list of external commands (defined by shell
 
18
# scripts) so that they can be included in the help listing as well.
 
19
# It should be enough to just list the plugin directory and look for
 
20
# executable files with reasonable names.
 
21
 
 
22
# TODO: `help commands --all` should show hidden commands
46
23
 
47
24
import sys
48
 
 
49
 
 
50
 
def help(topic=None, outfile = None):
51
 
    if outfile == None:
52
 
        outfile = sys.stdout
53
 
    if topic == None:
54
 
        outfile.write(global_help)
55
 
    elif topic == 'commands':
56
 
        help_commands(outfile = outfile)
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    symbol_versioning,
 
34
    )
 
35
 
 
36
 
 
37
def help(topic=None, outfile=None):
 
38
    """Write the help for the specific topic to outfile"""
 
39
    if outfile is None:
 
40
        outfile = sys.stdout
 
41
 
 
42
    indices = HelpIndices()
 
43
 
 
44
    alias = _mod_commands.get_alias(topic)
 
45
    try:
 
46
        topics = indices.search(topic)
 
47
        shadowed_terms = []
 
48
        for index, topic in topics[1:]:
 
49
            shadowed_terms.append('%s%s' % (index.prefix,
 
50
                topic.get_help_topic()))
 
51
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
 
53
    except errors.NoHelpTopic:
 
54
        if alias is None:
 
55
            raise
 
56
 
 
57
    if alias is not None:
 
58
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
59
            " ".join(alias)))
 
60
 
 
61
 
 
62
def help_commands(outfile=None):
 
63
    """List all commands"""
 
64
    if outfile is None:
 
65
        outfile = sys.stdout
 
66
    outfile.write(_help_commands_to_text('commands'))
 
67
 
 
68
 
 
69
def _help_commands_to_text(topic):
 
70
    """Generate the help text for the list of commands"""
 
71
    out = []
 
72
    if topic == 'hidden-commands':
 
73
        hidden = True
57
74
    else:
58
 
        help_on_command(topic, outfile = outfile)
59
 
 
60
 
 
61
 
def command_usage(cmdname, cmdclass):
62
 
    """Return single-line grammar for command.
63
 
 
64
 
    Only describes arguments, not options.
 
75
        hidden = False
 
76
    names = list(_mod_commands.all_command_names())
 
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
79
    max_name = max(len(n) for n, o in shown_commands)
 
80
    indent = ' ' * (max_name + 1)
 
81
    width = osutils.terminal_width() - 1
 
82
 
 
83
    for cmd_name, cmd_object in sorted(shown_commands):
 
84
        plugin_name = cmd_object.plugin_name()
 
85
        if plugin_name is None:
 
86
            plugin_name = ''
 
87
        else:
 
88
            plugin_name = ' [%s]' % plugin_name
 
89
 
 
90
        cmd_help = cmd_object.help()
 
91
        if cmd_help:
 
92
            firstline = cmd_help.split('\n', 1)[0]
 
93
        else:
 
94
            firstline = ''
 
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
96
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
97
                              width=width)
 
98
        for line in lines:
 
99
            out.append(line + '\n')
 
100
    return ''.join(out)
 
101
 
 
102
 
 
103
help_topics.topic_registry.register("commands",
 
104
                                    _help_commands_to_text,
 
105
                                    "Basic help for all commands",
 
106
                                    help_topics.SECT_HIDDEN)
 
107
help_topics.topic_registry.register("hidden-commands",
 
108
                                    _help_commands_to_text,
 
109
                                    "All hidden commands",
 
110
                                    help_topics.SECT_HIDDEN)
 
111
 
 
112
 
 
113
class HelpIndices(object):
 
114
    """Maintainer of help topics across multiple indices.
 
115
 
 
116
    It is currently separate to the HelpTopicRegistry because of its ordered
 
117
    nature, but possibly we should instead structure it as a search within the
 
118
    registry and add ordering and searching facilities to the registry. The
 
119
    registry would probably need to be restructured to support that cleanly
 
120
    which is why this has been implemented in parallel even though it does as a
 
121
    result permit searching for help in indices which are not discoverable via
 
122
    'help topics'.
 
123
 
 
124
    Each index has a unique prefix string, such as "commands", and contains
 
125
    help topics which can be listed or searched.
65
126
    """
66
 
    s = cmdname + ' '
67
 
    for aname in cmdclass.takes_args:
68
 
        aname = aname.upper()
69
 
        if aname[-1] in ['$', '+']:
70
 
            aname = aname[:-1] + '...'
71
 
        elif aname[-1] == '?':
72
 
            aname = '[' + aname[:-1] + ']'
73
 
        elif aname[-1] == '*':
74
 
            aname = '[' + aname[:-1] + '...]'
75
 
        s += aname + ' '
76
 
            
77
 
    assert s[-1] == ' '
78
 
    s = s[:-1]
79
 
    
80
 
    return s
81
 
 
82
 
 
83
 
def help_on_command(cmdname, outfile = None):
84
 
    cmdname = str(cmdname)
85
 
 
86
 
    if outfile == None:
87
 
        outfile = sys.stdout
88
 
 
89
 
    from inspect import getdoc
90
 
    import commands
91
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
92
 
 
93
 
    doc = getdoc(cmdclass)
94
 
    if doc == None:
95
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
 
 
97
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
98
 
 
99
 
    if cmdclass.aliases:
100
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
101
 
    
102
 
    outfile.write(doc)
103
 
    if doc[-1] != '\n':
104
 
        outfile.write('\n')
105
 
    
106
 
    help_on_option(cmdclass.takes_options, outfile = None)
107
 
 
108
 
 
109
 
def help_on_option(options, outfile = None):
110
 
    import commands
111
 
    
112
 
    if not options:
113
 
        return
114
 
    
115
 
    if outfile == None:
116
 
        outfile = sys.stdout
117
 
 
118
 
    outfile.write('\noptions:\n')
119
 
    for on in options:
120
 
        l = '    --' + on
121
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
122
 
            if longname == on:
123
 
                l += ', -' + shortname
124
 
                break
125
 
        outfile.write(l + '\n')
126
 
 
127
 
 
128
 
def help_commands(outfile = None):
129
 
    """List all commands"""
130
 
    import inspect
131
 
    import commands
132
 
 
133
 
    if outfile == None:
134
 
        outfile = sys.stdout
135
 
    
136
 
    accu = []
137
 
    for cmdname, cmdclass in commands.get_all_cmds():
138
 
        accu.append((cmdname, cmdclass))
139
 
    accu.sort()
140
 
    for cmdname, cmdclass in accu:
141
 
        if cmdclass.hidden:
142
 
            continue
143
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
144
 
        help = inspect.getdoc(cmdclass)
145
 
        if help:
146
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
147
 
 
148
 
            
149
 
 
 
127
 
 
128
    def __init__(self):
 
129
        self.search_path = [
 
130
            help_topics.HelpTopicIndex(),
 
131
            _mod_commands.HelpCommandIndex(),
 
132
            plugin.PluginsHelpIndex(),
 
133
            ]
 
134
 
 
135
    def _check_prefix_uniqueness(self):
 
136
        """Ensure that the index collection is able to differentiate safely."""
 
137
        prefixes = {}
 
138
        for index in self.search_path:
 
139
            prefixes.setdefault(index.prefix, []).append(index)
 
140
        for prefix, indices in prefixes.items():
 
141
            if len(indices) > 1:
 
142
                raise errors.DuplicateHelpPrefix(prefix)
 
143
 
 
144
    def search(self, topic):
 
145
        """Search for topic across the help search path.
 
146
 
 
147
        :param topic: A string naming the help topic to search for.
 
148
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
149
        :return: A list of HelpTopics which matched 'topic'.
 
150
        """
 
151
        self._check_prefix_uniqueness()
 
152
        result = []
 
153
        for index in self.search_path:
 
154
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
155
        if not result:
 
156
            raise errors.NoHelpTopic(topic)
 
157
        else:
 
158
            return result