/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: Martin Pool
  • Date: 2007-08-09 05:56:20 UTC
  • mfrom: (2658.3.6 111914)
  • mto: This revision was merged to the branch mainline in revision 2689.
  • Revision ID: mbp@sourcefrog.net-20070809055620-2tvrnr8v15h02fqh
https://launchpad.net/bugs/111914
Add selftest --strict

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