← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-11 09:27:55 UTC
  • mfrom: (5017.3.46 test-servers)
  • mto: This revision was merged to the branch mainline in revision 5030.
  • Revision ID: v.ladeuil+lp@free.fr-20100211092755-3vvu4vbwiwjjte3s
Move tests servers from bzrlib.transport to bzrlib.tests.test_server

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
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.
 
21
 
 
22
# TODO: `help commands --all` should show hidden commands
 
23
 
 
24
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    symbol_versioning,
 
34
    )
 
35
 
 
36
 
 
37
def help(topic=None, outfile=None):
 
38
    """Write the help for the specific topic to outfile"""
 
39
    if outfile is None:
 
40
        outfile = sys.stdout
 
41
 
 
42
    indices = HelpIndices()
 
43
 
 
44
    alias = _mod_commands.get_alias(topic)
 
45
    try:
 
46
        topics = indices.search(topic)
 
47
        shadowed_terms = []
 
48
        for index, topic in topics[1:]:
 
49
            shadowed_terms.append('%s%s' % (index.prefix,
 
50
                topic.get_help_topic()))
 
51
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
 
53
    except errors.NoHelpTopic:
 
54
        if alias is None:
 
55
            raise
 
56
 
 
57
    if alias is not None:
 
58
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
59
            " ".join(alias)))
 
60
 
 
61
 
 
62
def help_commands(outfile=None):
 
63
    """List all commands"""
 
64
    if outfile is None:
 
65
        outfile = sys.stdout
 
66
    outfile.write(_help_commands_to_text('commands'))
 
67
 
 
68
 
 
69
def _help_commands_to_text(topic):
 
70
    """Generate the help text for the list of commands"""
 
71
    out = []
 
72
    if topic == 'hidden-commands':
 
73
        hidden = True
 
74
    else:
 
75
        hidden = False
 
76
    names = list(_mod_commands.all_command_names())
 
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
79
    max_name = max(len(n) for n, o in shown_commands)
 
80
    indent = ' ' * (max_name + 1)
 
81
    width = osutils.terminal_width()
 
82
    if width is None:
 
83
        width = osutils.default_terminal_width
 
84
    # we need one extra space for terminals that wrap on last char
 
85
    width = width - 1
 
86
 
 
87
    for cmd_name, cmd_object in sorted(shown_commands):
 
88
        plugin_name = cmd_object.plugin_name()
 
89
        if plugin_name is None:
 
90
            plugin_name = ''
 
91
        else:
 
92
            plugin_name = ' [%s]' % plugin_name
 
93
 
 
94
        cmd_help = cmd_object.help()
 
95
        if cmd_help:
 
96
            firstline = cmd_help.split('\n', 1)[0]
 
97
        else:
 
98
            firstline = ''
 
99
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
100
        lines = textwrap.wrap(
 
101
            helpstring, subsequent_indent=indent,
 
102
            width=width,
 
103
            break_long_words=False)
 
104
        for line in lines:
 
105
            out.append(line + '\n')
 
106
    return ''.join(out)
 
107
 
 
108
 
 
109
help_topics.topic_registry.register("commands",
 
110
                                    _help_commands_to_text,
 
111
                                    "Basic help for all commands",
 
112
                                    help_topics.SECT_HIDDEN)
 
113
help_topics.topic_registry.register("hidden-commands",
 
114
                                    _help_commands_to_text,
 
115
                                    "All hidden commands",
 
116
                                    help_topics.SECT_HIDDEN)
 
117
 
 
118
 
 
119
class HelpIndices(object):
 
120
    """Maintainer of help topics across multiple indices.
 
121
 
 
122
    It is currently separate to the HelpTopicRegistry because of its ordered
 
123
    nature, but possibly we should instead structure it as a search within the
 
124
    registry and add ordering and searching facilities to the registry. The
 
125
    registry would probably need to be restructured to support that cleanly
 
126
    which is why this has been implemented in parallel even though it does as a
 
127
    result permit searching for help in indices which are not discoverable via
 
128
    'help topics'.
 
129
 
 
130
    Each index has a unique prefix string, such as "commands", and contains
 
131
    help topics which can be listed or searched.
 
132
    """
 
133
 
 
134
    def __init__(self):
 
135
        self.search_path = [
 
136
            help_topics.HelpTopicIndex(),
 
137
            _mod_commands.HelpCommandIndex(),
 
138
            plugin.PluginsHelpIndex(),
 
139
            ]
 
140
 
 
141
    def _check_prefix_uniqueness(self):
 
142
        """Ensure that the index collection is able to differentiate safely."""
 
143
        prefixes = {}
 
144
        for index in self.search_path:
 
145
            prefixes.setdefault(index.prefix, []).append(index)
 
146
        for prefix, indices in prefixes.items():
 
147
            if len(indices) > 1:
 
148
                raise errors.DuplicateHelpPrefix(prefix)
 
149
 
 
150
    def search(self, topic):
 
151
        """Search for topic across the help search path.
 
152
 
 
153
        :param topic: A string naming the help topic to search for.
 
154
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
155
        :return: A list of HelpTopics which matched 'topic'.
 
156
        """
 
157
        self._check_prefix_uniqueness()
 
158
        result = []
 
159
        for index in self.search_path:
 
160
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
161
        if not result:
 
162
            raise errors.NoHelpTopic(topic)
 
163
        else:
 
164
            return result