/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: Robert Collins
  • Date: 2007-04-20 05:44:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420054437-5txpyqld8y7cl3k5
Fix the ModuleHelpTopic get_help_topic to be tested with closer to real world data and strip the bzrlib.plugins. prefix from the name.

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
    )
 
34
 
 
35
 
 
36
def help(topic=None, outfile=None):
 
37
    """Write the help for the specific topic to outfile"""
 
38
    if outfile is None:
 
39
        outfile = sys.stdout
 
40
 
 
41
    indices = HelpIndices()
 
42
    topics = indices.search(topic)
 
43
    shadowed_terms = []
 
44
    for index, topic in topics[1:]:
 
45
        shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
 
46
    outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
47
 
 
48
 
 
49
def help_commands(outfile=None):
 
50
    """List all commands"""
 
51
    if outfile is None:
 
52
        outfile = sys.stdout
 
53
    outfile.write(_help_commands_to_text('commands'))
 
54
 
 
55
 
 
56
def _help_commands_to_text(topic):
 
57
    """Generate the help text for the list of commands"""
 
58
    out = []
 
59
    if topic == 'hidden-commands':
 
60
        hidden = True
 
61
    else:
 
62
        hidden = False
 
63
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
64
    names.update(_mod_commands.plugin_command_names())
 
65
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
66
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
67
    max_name = max(len(n) for n, o in shown_commands)
 
68
    indent = ' ' * (max_name + 1)
 
69
    width = osutils.terminal_width() - 1
 
70
 
 
71
    for cmd_name, cmd_object in sorted(shown_commands):
 
72
        plugin_name = cmd_object.plugin_name()
 
73
        if plugin_name is None:
 
74
            plugin_name = ''
 
75
        else:
 
76
            plugin_name = ' [%s]' % plugin_name
 
77
 
 
78
        cmd_help = cmd_object.help()
 
79
        if cmd_help:
 
80
            firstline = cmd_help.split('\n', 1)[0]
 
81
        else:
 
82
            firstline = ''
 
83
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
84
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
85
                              width=width)
 
86
        for line in lines:
 
87
            out.append(line + '\n')
 
88
    return ''.join(out)
 
89
 
 
90
 
 
91
help_topics.topic_registry.register("commands",
 
92
                                    _help_commands_to_text,
 
93
                                    "Basic help for all commands")
 
94
help_topics.topic_registry.register("hidden-commands",
 
95
                                    _help_commands_to_text,
 
96
                                    "All hidden commands")
 
97
 
 
98
 
 
99
class HelpIndices(object):
 
100
    """An object to manage help in multiple indices.
 
101
    
 
102
    This maintains a list of places to search for help. It is currently
 
103
    separate to the HelpTopicRegistry because of its ordered nature, but
 
104
    possibly we should instread structure it as a search within the registry
 
105
    and add ordering and searching facilities to the registry. The registry
 
106
    would probably need to be restructured to support that cleanly which is
 
107
    why this has been implemented in parallel even though it does as a result
 
108
    permit searching for help in indexs which are not discoverable via
 
109
    'help topics'.
 
110
    """
 
111
 
 
112
    def __init__(self):
 
113
        self.search_path = [
 
114
            help_topics.HelpTopicIndex(),
 
115
            _mod_commands.HelpCommandIndex(),
 
116
            plugin.PluginsHelpIndex(),
 
117
            ]
 
118
 
 
119
    def _check_prefix_uniqueness(self):
 
120
        """Ensure that the index collection is able to differentiate safely."""
 
121
        prefixes = {}
 
122
        for index in self.search_path:
 
123
            prefixes.setdefault(index.prefix, []).append(index)
 
124
        for prefix, indices in prefixes.items():
 
125
            if len(indices) > 1:
 
126
                raise errors.DuplicateHelpPrefix(prefix)
 
127
 
 
128
    def search(self, topic):
 
129
        """Search for topic across the help search path.
 
130
        
 
131
        :param topic: A string naming the help topic to search for.
 
132
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
133
        :return: A list of HelpTopics which matched 'topic'.
 
134
        """
 
135
        self._check_prefix_uniqueness()
 
136
        result = []
 
137
        for index in self.search_path:
 
138
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
139
        if not result:
 
140
            raise errors.NoHelpTopic(topic)
 
141
        else:
 
142
            return result