35
39
if outfile is None:
36
40
outfile = sys.stdout
41
if topic in help_topics.topic_registry:
42
txt = help_topics.topic_registry.get_detail(topic)
45
help_on_command(topic, outfile=outfile)
48
def command_usage(cmd_object):
49
"""Return single-line grammar for command.
51
Only describes arguments, not options.
53
s = 'bzr ' + cmd_object.name() + ' '
54
for aname in cmd_object.takes_args:
56
if aname[-1] in ['$', '+']:
57
aname = aname[:-1] + '...'
58
elif aname[-1] == '?':
59
aname = '[' + aname[:-1] + ']'
60
elif aname[-1] == '*':
61
aname = '[' + aname[:-1] + '...]'
70
def print_command_plugin(cmd_object, outfile, format):
71
"""Print the plugin that provides a command object, if any.
73
If the cmd_object is provided by a plugin, prints the plugin name to
74
outfile using the provided format string.
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)
82
def help_on_command(cmdname, outfile=None):
83
from bzrlib.commands import get_cmd_object
85
cmdname = str(cmdname)
90
cmd_object = get_cmd_object(cmdname)
92
doc = cmd_object.help()
94
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
print >>outfile, 'usage:', command_usage(cmd_object)
98
if cmd_object.aliases:
99
print >>outfile, 'aliases:',
100
print >>outfile, ', '.join(cmd_object.aliases)
104
print_command_plugin(cmd_object, outfile, '%s\n\n')
109
help_on_command_options(cmd_object, outfile)
112
def help_on_command_options(cmd, outfile=None):
113
from bzrlib.option import Option, get_optparser
116
options = cmd.options()
118
outfile.write(get_optparser(options).format_option_help())
42
indices = HelpIndices()
43
topics = indices.search(topic)
45
for index, topic in topics[1:]:
46
shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
47
outfile.write(topics[0][1].get_help_text(shadowed_terms))
121
50
def help_commands(outfile=None):
125
54
outfile.write(_help_commands_to_text('commands'))
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
def command_usage(cmd):
128
62
def _help_commands_to_text(topic):
129
63
"""Generate the help text for the list of commands"""
130
from bzrlib.commands import (builtin_command_names,
131
plugin_command_names,
134
65
if topic == 'hidden-commands':
138
names = set(builtin_command_names()) # to eliminate duplicates
139
names.update(plugin_command_names())
140
commands = ((n, get_cmd_object(n)) for n in names)
69
names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
70
names.update(_mod_commands.plugin_command_names())
71
commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
141
72
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
73
max_name = max(len(n) for n, o in shown_commands)
143
74
indent = ' ' * (max_name + 1)
166
97
help_topics.topic_registry.register("commands",
167
98
_help_commands_to_text,
168
99
"Basic help for all commands")
169
help_topics.topic_registry.register("hidden-commands",
100
help_topics.topic_registry.register("hidden-commands",
170
101
_help_commands_to_text,
171
102
"All hidden commands")
105
class HelpIndices(object):
106
"""Maintainer of help topics across multiple indices.
108
It is currently separate to the HelpTopicRegistry because of its ordered
109
nature, but possibly we should instead structure it as a search within the
110
registry and add ordering and searching facilities to the registry. The
111
registry would probably need to be restructured to support that cleanly
112
which is why this has been implemented in parallel even though it does as a
113
result permit searching for help in indices which are not discoverable via
116
Each index has a unique prefix string, such as "commands", and contains
117
help topics which can be listed or searched.
122
help_topics.HelpTopicIndex(),
123
_mod_commands.HelpCommandIndex(),
124
plugin.PluginsHelpIndex(),
127
def _check_prefix_uniqueness(self):
128
"""Ensure that the index collection is able to differentiate safely."""
130
for index in self.search_path:
131
prefixes.setdefault(index.prefix, []).append(index)
132
for prefix, indices in prefixes.items():
134
raise errors.DuplicateHelpPrefix(prefix)
136
def search(self, topic):
137
"""Search for topic across the help search path.
139
:param topic: A string naming the help topic to search for.
140
:raises: NoHelpTopic if none of the indexs in search_path have topic.
141
:return: A list of HelpTopics which matched 'topic'.
143
self._check_prefix_uniqueness()
145
for index in self.search_path:
146
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
148
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
