/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 03:54:06 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420035406-e68xf089otkpo7xx
Teach Command.get_help_text to show additional help cross references when supplied.

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