/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: John Arbash Meinel
  • Date: 2009-04-08 16:33:19 UTC
  • mfrom: (3735.2.187 brisbane-core)
  • mto: This revision was merged to the branch mainline in revision 4280.
  • Revision ID: john@arbash-meinel.com-20090408163319-jzin98xnzklj8vun
Merge the a couple rev older brisbane-core into bzr.dev, most things are resolve in favor of bzr.dev

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 = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
77
    names.update(_mod_commands.plugin_command_names())
 
78
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
79
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
80
    max_name = max(len(n) for n, o in shown_commands)
 
81
    indent = ' ' * (max_name + 1)
 
82
    width = osutils.terminal_width() - 1
 
83
 
 
84
    for cmd_name, cmd_object in sorted(shown_commands):
 
85
        plugin_name = cmd_object.plugin_name()
 
86
        if plugin_name is None:
 
87
            plugin_name = ''
 
88
        else:
 
89
            plugin_name = ' [%s]' % plugin_name
 
90
 
 
91
        cmd_help = cmd_object.help()
 
92
        if cmd_help:
 
93
            firstline = cmd_help.split('\n', 1)[0]
 
94
        else:
 
95
            firstline = ''
 
96
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
97
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
98
                              width=width)
 
99
        for line in lines:
 
100
            out.append(line + '\n')
 
101
    return ''.join(out)
 
102
 
 
103
 
 
104
help_topics.topic_registry.register("commands",
 
105
                                    _help_commands_to_text,
 
106
                                    "Basic help for all commands",
 
107
                                    help_topics.SECT_HIDDEN)
 
108
help_topics.topic_registry.register("hidden-commands",
 
109
                                    _help_commands_to_text,
 
110
                                    "All hidden commands",
 
111
                                    help_topics.SECT_HIDDEN)
 
112
 
 
113
 
 
114
class HelpIndices(object):
 
115
    """Maintainer of help topics across multiple indices.
 
116
 
 
117
    It is currently separate to the HelpTopicRegistry because of its ordered
 
118
    nature, but possibly we should instead structure it as a search within the
 
119
    registry and add ordering and searching facilities to the registry. The
 
120
    registry would probably need to be restructured to support that cleanly
 
121
    which is why this has been implemented in parallel even though it does as a
 
122
    result permit searching for help in indices which are not discoverable via
 
123
    'help topics'.
 
124
 
 
125
    Each index has a unique prefix string, such as "commands", and contains
 
126
    help topics which can be listed or searched.
 
127
    """
 
128
 
 
129
    def __init__(self):
 
130
        self.search_path = [
 
131
            help_topics.HelpTopicIndex(),
 
132
            _mod_commands.HelpCommandIndex(),
 
133
            plugin.PluginsHelpIndex(),
 
134
            ]
 
135
 
 
136
    def _check_prefix_uniqueness(self):
 
137
        """Ensure that the index collection is able to differentiate safely."""
 
138
        prefixes = {}
 
139
        for index in self.search_path:
 
140
            prefixes.setdefault(index.prefix, []).append(index)
 
141
        for prefix, indices in prefixes.items():
 
142
            if len(indices) > 1:
 
143
                raise errors.DuplicateHelpPrefix(prefix)
 
144
 
 
145
    def search(self, topic):
 
146
        """Search for topic across the help search path.
 
147
 
 
148
        :param topic: A string naming the help topic to search for.
 
149
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
150
        :return: A list of HelpTopics which matched 'topic'.
 
151
        """
 
152
        self._check_prefix_uniqueness()
 
153
        result = []
 
154
        for index in self.search_path:
 
155
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
156
        if not result:
 
157
            raise errors.NoHelpTopic(topic)
 
158
        else:
 
159
            return result