~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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 
23
25
 
24
26
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.
 
27
"""Bazaar -- a free distributed version-control tool
 
28
http://bazaar-vcs.org/
30
29
 
31
30
Basic commands:
32
31
 
55
54
 
56
55
 
57
56
def help(topic=None, outfile = None):
58
 
    if outfile == None:
 
57
    if outfile is None:
59
58
        outfile = sys.stdout
60
 
    if topic == None:
 
59
    if topic is None:
61
60
        outfile.write(global_help)
62
61
    elif topic == 'commands':
63
62
        help_commands(outfile = outfile)
87
86
    return s
88
87
 
89
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
 
90
101
def help_on_command(cmdname, outfile=None):
91
102
    from bzrlib.commands import get_cmd_object
92
103
 
93
104
    cmdname = str(cmdname)
94
105
 
95
 
    if outfile == None:
 
106
    if outfile is None:
96
107
        outfile = sys.stdout
97
108
 
98
109
    cmd_object = get_cmd_object(cmdname)
99
110
 
100
111
    doc = cmd_object.help()
101
 
    if doc == None:
 
112
    if doc is None:
102
113
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
103
114
 
104
115
    print >>outfile, 'usage:', command_usage(cmd_object) 
109
120
 
110
121
    print >>outfile
111
122
 
 
123
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
124
 
112
125
    outfile.write(doc)
113
126
    if doc[-1] != '\n':
114
127
        outfile.write('\n')
115
 
    help_on_command_options(cmd_object, outfile=None)
 
128
    help_on_command_options(cmd_object, outfile)
116
129
 
117
130
 
118
131
def help_on_command_options(cmd, outfile=None):
119
 
    from bzrlib.option import Option
 
132
    from bzrlib.option import Option, get_optparser
 
133
    if outfile is None:
 
134
        outfile = sys.stdout
120
135
    options = cmd.options()
121
 
    if not options:
122
 
        return
123
 
    if outfile == None:
124
 
        outfile = sys.stdout
125
 
    outfile.write('\noptions:\n')
126
 
    for option_name, option in sorted(options.items()):
127
 
        l = '    --' + option_name
128
 
        if option.type is not None:
129
 
            l += ' ' + option.argname.upper()
130
 
        short_name = option.short_name()
131
 
        if short_name:
132
 
            assert len(short_name) == 1
133
 
            l += ', -' + shortname
134
 
        l += (30 - len(l)) * ' ' + option.help
135
 
        # TODO: split help over multiple lines with correct indenting and 
136
 
        # wrapping
137
 
        outfile.write(l + '\n')
 
136
    outfile.write('\n')
 
137
    outfile.write(get_optparser(options).format_option_help())
138
138
 
139
139
 
140
140
def help_commands(outfile=None):
142
142
    from bzrlib.commands import (builtin_command_names,
143
143
                                 plugin_command_names,
144
144
                                 get_cmd_object)
145
 
 
146
 
    if outfile == None:
 
145
    if outfile is None:
147
146
        outfile = sys.stdout
148
 
 
149
 
    names = set()                       # to eliminate duplicates
150
 
    names.update(builtin_command_names())
 
147
    names = set(builtin_command_names()) # to eliminate duplicates
151
148
    names.update(plugin_command_names())
152
 
    names = list(names)
153
 
    names.sort()
 
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]
 
151
    max_name = max(len(n) for n, o in shown_commands)
 
152
    indent = ' ' * (max_name + 1)
 
153
    width = osutils.terminal_width() - 1
 
154
    for cmd_name, cmd_object in sorted(shown_commands):
 
155
        plugin_name = cmd_object.plugin_name()
 
156
        if plugin_name is None:
 
157
            plugin_name = ''
 
158
        else:
 
159
            plugin_name = ' [%s]' % plugin_name
154
160
 
155
 
    for cmd_name in names:
156
 
        cmd_object = get_cmd_object(cmd_name)
157
 
        if cmd_object.hidden:
158
 
            continue
159
 
        print >>outfile, command_usage(cmd_object)
160
161
        cmd_help = cmd_object.help()
161
162
        if cmd_help:
162
163
            firstline = cmd_help.split('\n', 1)[0]
163
 
            print >>outfile, '    ' + firstline
164
 
        
 
164
        else:
 
165
            firstline = ''
 
166
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
167
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
168
                              width=width)
 
169
        for line in lines:
 
170
            outfile.write(line + '\n')