/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: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
# TODO: Some way to get a list of external commands (defined by shell
20
18
# scripts) so that they can be included in the help listing as well.
21
19
# It should be enough to just list the plugin directory and look for
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
24
import sys
 
25
import textwrap
27
26
 
28
 
from . import (
 
27
from bzrlib import (
29
28
    commands as _mod_commands,
30
29
    errors,
31
30
    help_topics,
32
31
    osutils,
33
32
    plugin,
34
 
    ui,
35
 
    utextwrap,
36
33
    )
37
34
 
38
35
 
39
 
class NoHelpTopic(errors.BzrError):
40
 
 
41
 
    _fmt = ("No help could be found for '%(topic)s'. "
42
 
        "Please use 'brz help topics' to obtain a list of topics.")
43
 
 
44
 
    def __init__(self, topic):
45
 
        self.topic = topic
46
 
 
47
 
 
48
36
def help(topic=None, outfile=None):
49
37
    """Write the help for the specific topic to outfile"""
50
38
    if outfile is None:
51
 
        outfile = ui.ui_factory.make_output_stream()
 
39
        outfile = sys.stdout
52
40
 
53
41
    indices = HelpIndices()
54
42
 
56
44
    try:
57
45
        topics = indices.search(topic)
58
46
        shadowed_terms = []
59
 
        for index, topic_obj in topics[1:]:
 
47
        for index, topic in topics[1:]:
60
48
            shadowed_terms.append('%s%s' % (index.prefix,
61
 
                topic_obj.get_help_topic()))
 
49
                topic.get_help_topic()))
62
50
        source = topics[0][1]
63
51
        outfile.write(source.get_help_text(shadowed_terms))
64
 
    except NoHelpTopic:
 
52
    except errors.NoHelpTopic:
65
53
        if alias is None:
66
54
            raise
67
55
 
68
56
    if alias is not None:
69
 
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
70
58
            " ".join(alias)))
71
59
 
72
60
 
73
61
def help_commands(outfile=None):
74
62
    """List all commands"""
75
63
    if outfile is None:
76
 
        outfile = ui.ui_factory.make_output_stream()
 
64
        outfile = sys.stdout
77
65
    outfile.write(_help_commands_to_text('commands'))
78
66
 
79
67
 
108
96
        else:
109
97
            firstline = ''
110
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
111
 
        lines = utextwrap.wrap(
 
99
        lines = textwrap.wrap(
112
100
            helpstring, subsequent_indent=indent,
113
101
            width=width,
114
102
            break_long_words=False)
147
135
            help_topics.HelpTopicIndex(),
148
136
            _mod_commands.HelpCommandIndex(),
149
137
            plugin.PluginsHelpIndex(),
150
 
            help_topics.ConfigOptionHelpIndex(),
151
138
            ]
152
139
 
153
140
    def _check_prefix_uniqueness(self):
154
141
        """Ensure that the index collection is able to differentiate safely."""
155
 
        prefixes = set()
 
142
        prefixes = {}
156
143
        for index in self.search_path:
157
 
            prefix = index.prefix
158
 
            if prefix in prefixes:
 
144
            prefixes.setdefault(index.prefix, []).append(index)
 
145
        for prefix, indices in prefixes.items():
 
146
            if len(indices) > 1:
159
147
                raise errors.DuplicateHelpPrefix(prefix)
160
 
            prefixes.add(prefix)
161
148
 
162
149
    def search(self, topic):
163
150
        """Search for topic across the help search path.
171
158
        for index in self.search_path:
172
159
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
173
160
        if not result:
174
 
            raise NoHelpTopic(topic)
 
161
            raise errors.NoHelpTopic(topic)
175
162
        else:
176
163
            return result