1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Some way to get a list of external commands (defined by shell
18
# scripts) so that they can be included in the help listing as well.
19
# It should be enough to just list the plugin directory and look for
20
# executable files with reasonable names.
22
# TODO: `help commands --all` should show hidden commands
28
commands as _mod_commands,
37
def help(topic=None, outfile=None):
38
"""Write the help for the specific topic to outfile"""
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))
50
def help_commands(outfile=None):
51
"""List all commands"""
54
outfile.write(_help_commands_to_text('commands'))
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
def command_usage(cmd):
62
def _help_commands_to_text(topic):
63
"""Generate the help text for the list of commands"""
65
if topic == 'hidden-commands':
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)
72
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
73
max_name = max(len(n) for n, o in shown_commands)
74
indent = ' ' * (max_name + 1)
75
width = osutils.terminal_width() - 1
77
for cmd_name, cmd_object in sorted(shown_commands):
78
plugin_name = cmd_object.plugin_name()
79
if plugin_name is None:
82
plugin_name = ' [%s]' % plugin_name
84
cmd_help = cmd_object.help()
86
firstline = cmd_help.split('\n', 1)[0]
89
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
90
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
93
out.append(line + '\n')
97
help_topics.topic_registry.register("commands",
98
_help_commands_to_text,
99
"Basic help for all commands")
100
help_topics.topic_registry.register("hidden-commands",
101
_help_commands_to_text,
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
