← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by 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., 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.
23
21
 
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
 
24
global_help = \
 
25
"""Bazaar-NG -- a free distributed version-control tool
 
26
http://bazaar-ng.org/
 
27
 
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
 
30
 
 
31
Basic commands:
 
32
 
 
33
  bzr init      makes this branch versioned
 
34
  bzr branch    make a copy of another branch
 
35
 
 
36
  bzr add       make files or directories versioned
 
37
  bzr ignore    ignore a file or pattern
 
38
  bzr mv        move or rename a versioned file
 
39
 
 
40
  bzr status    summarize changes in working copy
 
41
  bzr diff      show detailed diffs
 
42
 
 
43
  bzr merge     pull in changes from another branch
 
44
  bzr commit    save some or all changes
 
45
 
 
46
  bzr log       show history of changes
 
47
  bzr check     validate storage
 
48
 
 
49
Use e.g. 'bzr help init' for more details, or
 
50
'bzr help commands' for all commands.
 
51
"""
 
52
 
 
53
 
26
54
import sys
27
55
 
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"""
41
 
    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)))
 
56
 
 
57
def help(topic=None, outfile = None):
 
58
    if outfile == None:
 
59
        outfile = sys.stdout
 
60
    if topic == None:
 
61
        outfile.write(global_help)
 
62
    elif topic == 'commands':
 
63
        help_commands(outfile = outfile)
 
64
    else:
 
65
        help_on_command(topic, outfile = outfile)
 
66
 
 
67
 
 
68
def command_usage(cmd_object):
 
69
    """Return single-line grammar for command.
 
70
 
 
71
    Only describes arguments, not options.
 
72
    """
 
73
    s = 'bzr ' + cmd_object.name() + ' '
 
74
    for aname in cmd_object.takes_args:
 
75
        aname = aname.upper()
 
76
        if aname[-1] in ['$', '+']:
 
77
            aname = aname[:-1] + '...'
 
78
        elif aname[-1] == '?':
 
79
            aname = '[' + aname[:-1] + ']'
 
80
        elif aname[-1] == '*':
 
81
            aname = '[' + aname[:-1] + '...]'
 
82
        s += aname + ' '
 
83
            
 
84
    assert s[-1] == ' '
 
85
    s = s[:-1]
 
86
    
 
87
    return s
 
88
 
 
89
 
 
90
def help_on_command(cmdname, outfile=None):
 
91
    from bzrlib.commands import get_cmd_object
 
92
 
 
93
    cmdname = str(cmdname)
 
94
 
 
95
    if outfile == None:
 
96
        outfile = sys.stdout
 
97
 
 
98
    cmd_object = get_cmd_object(cmdname)
 
99
 
 
100
    doc = cmd_object.help()
 
101
    if doc == None:
 
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
103
 
 
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
105
 
 
106
    if cmd_object.aliases:
 
107
        print >>outfile, 'aliases:',
 
108
        print >>outfile, ', '.join(cmd_object.aliases)
 
109
 
 
110
    print >>outfile
 
111
 
 
112
    outfile.write(doc)
 
113
    if doc[-1] != '\n':
 
114
        outfile.write('\n')
 
115
    
 
116
    help_on_options(cmd_object.takes_options, outfile=None)
 
117
 
 
118
 
 
119
def help_on_options(options, outfile=None):
 
120
    from bzrlib.commands import SHORT_OPTIONS
 
121
    
 
122
    if not options:
 
123
        return
 
124
    
 
125
    if outfile == None:
 
126
        outfile = sys.stdout
 
127
 
 
128
    outfile.write('\noptions:\n')
 
129
    for on in options:
 
130
        l = '    --' + on
 
131
        for shortname, longname in SHORT_OPTIONS.items():
 
132
            if longname == on:
 
133
                l += ', -' + shortname
 
134
                break
 
135
        outfile.write(l + '\n')
62
136
 
63
137
 
64
138
def help_commands(outfile=None):
65
139
    """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):
90
 
        plugin_name = cmd_object.plugin_name()
91
 
        if plugin_name is None:
92
 
            plugin_name = ''
93
 
        else:
94
 
            plugin_name = ' [%s]' % plugin_name
95
 
 
 
140
    from bzrlib.commands import (builtin_command_names,
 
141
                                 plugin_command_names,
 
142
                                 get_cmd_object)
 
143
 
 
144
    if outfile == None:
 
145
        outfile = sys.stdout
 
146
 
 
147
    names = set()                       # to eliminate duplicates
 
148
    names.update(builtin_command_names())
 
149
    names.update(plugin_command_names())
 
150
    names = list(names)
 
151
    names.sort()
 
152
 
 
153
    for cmd_name in names:
 
154
        cmd_object = get_cmd_object(cmd_name)
 
155
        if cmd_object.hidden:
 
156
            continue
 
157
        print >>outfile, command_usage(cmd_object)
96
158
        cmd_help = cmd_object.help()
97
159
        if cmd_help:
98
160
            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
 
161
            print >>outfile, '    ' + firstline
 
162