1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# TODO: Some way to get a list of external commands (defined by shell
# scripts) so that they can be included in the help listing as well.
# It should be enough to just list the plugin directory and look for
# executable files with reasonable names.
# TODO: `help commands --all` should show hidden commands
import sys
import textwrap
from bzrlib import (
help_topics,
osutils,
)
def help(topic=None, outfile=None):
"""Write the help for the specific topic to outfile"""
if outfile is None:
outfile = sys.stdout
if topic is None:
topic = 'basic'
if topic in help_topics.topic_registry:
txt = help_topics.topic_registry.get_detail(topic)
outfile.write(txt)
else:
help_on_command(topic, outfile=outfile)
def command_usage(cmd_object):
"""Return single-line grammar for command.
Only describes arguments, not options.
"""
s = 'bzr ' + cmd_object.name() + ' '
for aname in cmd_object.takes_args:
aname = aname.upper()
if aname[-1] in ['$', '+']:
aname = aname[:-1] + '...'
elif aname[-1] == '?':
aname = '[' + aname[:-1] + ']'
elif aname[-1] == '*':
aname = '[' + aname[:-1] + '...]'
s += aname + ' '
assert s[-1] == ' '
s = s[:-1]
return s
def print_command_plugin(cmd_object, outfile, format):
"""Print the plugin that provides a command object, if any.
If the cmd_object is provided by a plugin, prints the plugin name to
outfile using the provided format string.
"""
plugin_name = cmd_object.plugin_name()
if plugin_name is not None:
out_str = '(From plugin "%s")' % plugin_name
outfile.write(format % out_str)
def help_on_command(cmdname, outfile=None):
from bzrlib.commands import get_cmd_object
cmdname = str(cmdname)
if outfile is None:
outfile = sys.stdout
cmd_object = get_cmd_object(cmdname)
doc = cmd_object.help()
if doc is None:
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
print >>outfile, 'usage:', command_usage(cmd_object)
if cmd_object.aliases:
print >>outfile, 'aliases:',
print >>outfile, ', '.join(cmd_object.aliases)
print >>outfile
print_command_plugin(cmd_object, outfile, '%s\n\n')
outfile.write(doc)
if doc[-1] != '\n':
outfile.write('\n')
help_on_command_options(cmd_object, outfile)
def help_on_command_options(cmd, outfile=None):
from bzrlib.option import Option, get_optparser
if outfile is None:
outfile = sys.stdout
options = cmd.options()
outfile.write('\n')
outfile.write(get_optparser(options).format_option_help())
def help_commands(outfile=None):
"""List all commands"""
if outfile is None:
outfile = sys.stdout
outfile.write(_help_commands_to_text('commands'))
def _help_commands_to_text(topic):
"""Generate the help text for the list of commands"""
from bzrlib.commands import (builtin_command_names,
plugin_command_names,
get_cmd_object)
out = []
if topic == 'hidden-commands':
hidden = True
else:
hidden = False
names = set(builtin_command_names()) # to eliminate duplicates
names.update(plugin_command_names())
commands = ((n, get_cmd_object(n)) for n in names)
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
max_name = max(len(n) for n, o in shown_commands)
indent = ' ' * (max_name + 1)
width = osutils.terminal_width() - 1
for cmd_name, cmd_object in sorted(shown_commands):
plugin_name = cmd_object.plugin_name()
if plugin_name is None:
plugin_name = ''
else:
plugin_name = ' [%s]' % plugin_name
cmd_help = cmd_object.help()
if cmd_help:
firstline = cmd_help.split('\n', 1)[0]
else:
firstline = ''
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
width=width)
for line in lines:
out.append(line + '\n')
return ''.join(out)
help_topics.topic_registry.register("commands",
_help_commands_to_text,
"Basic help for all commands")
help_topics.topic_registry.register("hidden-commands",
_help_commands_to_text,
"All hidden commands")
|