← 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: 2005-10-18 13:11:57 UTC
  • mfrom: (1185.16.72) (0.2.1)
  • Revision ID: robertc@robertcollins.net-20051018131157-76a9970aa78e927e
Merged Martin.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
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 directory a versioned branch
 
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
  bzr help init      more help on e.g. init command
 
50
  bzr help commands  list all commands
 
51
"""
 
52
 
 
53
 
24
54
import sys
25
 
import textwrap
26
 
 
27
 
from bzrlib import (
28
 
    help_topics,
29
 
    osutils,
30
 
    )
31
 
 
32
 
 
33
 
def help(topic=None, outfile=None):
34
 
    """Write the help for the specific topic to outfile"""
35
 
    if outfile is None:
 
55
 
 
56
 
 
57
def help(topic=None, outfile = None):
 
58
    if outfile == None:
36
59
        outfile = sys.stdout
37
 
 
38
 
    if topic is None:
39
 
        topic = 'basic'
40
 
 
41
 
    if topic in help_topics.topic_registry:
42
 
        txt = help_topics.topic_registry.get_detail(topic)
43
 
        outfile.write(txt)
 
60
    if topic == None:
 
61
        outfile.write(global_help)
 
62
    elif topic == 'commands':
 
63
        help_commands(outfile = outfile)
44
64
    else:
45
 
        help_on_command(topic, outfile=outfile)
 
65
        help_on_command(topic, outfile = outfile)
46
66
 
47
67
 
48
68
def command_usage(cmd_object):
67
87
    return s
68
88
 
69
89
 
70
 
def print_command_plugin(cmd_object, outfile, format):
71
 
    """Print the plugin that provides a command object, if any.
72
 
 
73
 
    If the cmd_object is provided by a plugin, prints the plugin name to
74
 
    outfile using the provided format string.
75
 
    """
76
 
    plugin_name = cmd_object.plugin_name()
77
 
    if plugin_name is not None:
78
 
        out_str = '(From plugin "%s")' % plugin_name
79
 
        outfile.write(format % out_str)
80
 
 
81
 
 
82
90
def help_on_command(cmdname, outfile=None):
83
91
    from bzrlib.commands import get_cmd_object
84
92
 
85
93
    cmdname = str(cmdname)
86
94
 
87
 
    if outfile is None:
 
95
    if outfile == None:
88
96
        outfile = sys.stdout
89
97
 
90
98
    cmd_object = get_cmd_object(cmdname)
91
99
 
92
100
    doc = cmd_object.help()
93
 
    if doc is None:
 
101
    if doc == None:
94
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
95
103
 
96
 
    print >>outfile, 'usage:', command_usage(cmd_object)
 
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
97
105
 
98
106
    if cmd_object.aliases:
99
107
        print >>outfile, 'aliases:',
101
109
 
102
110
    print >>outfile
103
111
 
104
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
105
 
 
106
112
    outfile.write(doc)
107
113
    if doc[-1] != '\n':
108
114
        outfile.write('\n')
109
 
    help_on_command_options(cmd_object, outfile)
 
115
    help_on_command_options(cmd_object, outfile=None)
110
116
 
111
117
 
112
118
def help_on_command_options(cmd, outfile=None):
113
 
    from bzrlib.option import Option, get_optparser
114
 
    if outfile is None:
115
 
        outfile = sys.stdout
 
119
    from bzrlib.option import Option
116
120
    options = cmd.options()
117
 
    outfile.write('\n')
118
 
    outfile.write(get_optparser(options).format_option_help())
 
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')
119
138
 
120
139
 
121
140
def help_commands(outfile=None):
122
141
    """List all commands"""
123
 
    if outfile is None:
124
 
        outfile = sys.stdout
125
 
    outfile.write(_help_commands_to_text('commands'))
126
 
 
127
 
 
128
 
def _help_commands_to_text(topic):
129
 
    """Generate the help text for the list of commands"""
130
142
    from bzrlib.commands import (builtin_command_names,
131
143
                                 plugin_command_names,
132
144
                                 get_cmd_object)
133
 
    out = []
134
 
    if topic == 'hidden-commands':
135
 
        hidden = True
136
 
    else:
137
 
        hidden = False
138
 
    names = set(builtin_command_names()) # to eliminate duplicates
 
145
 
 
146
    if outfile == None:
 
147
        outfile = sys.stdout
 
148
 
 
149
    names = set()                       # to eliminate duplicates
 
150
    names.update(builtin_command_names())
139
151
    names.update(plugin_command_names())
140
 
    commands = ((n, get_cmd_object(n)) for n in names)
141
 
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
 
    max_name = max(len(n) for n, o in shown_commands)
143
 
    indent = ' ' * (max_name + 1)
144
 
    width = osutils.terminal_width() - 1
145
 
 
146
 
    for cmd_name, cmd_object in sorted(shown_commands):
147
 
        plugin_name = cmd_object.plugin_name()
148
 
        if plugin_name is None:
149
 
            plugin_name = ''
150
 
        else:
151
 
            plugin_name = ' [%s]' % plugin_name
152
 
 
 
152
    names = list(names)
 
153
    names.sort()
 
154
 
 
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)
153
160
        cmd_help = cmd_object.help()
154
161
        if cmd_help:
155
162
            firstline = cmd_help.split('\n', 1)[0]
156
 
        else:
157
 
            firstline = ''
158
 
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
160
 
                              width=width)
161
 
        for line in lines:
162
 
            out.append(line + '\n')
163
 
    return ''.join(out)
164
 
 
165
 
 
166
 
help_topics.topic_registry.register("commands",
167
 
                                    _help_commands_to_text,
168
 
                                    "Basic help for all commands")
169
 
help_topics.topic_registry.register("hidden-commands", 
170
 
                                    _help_commands_to_text,
171
 
                                    "All hidden commands")
 
163
            print >>outfile, '    ' + firstline
 
164