/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: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

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) 2004, 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
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.
23
21
 
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
 
from . import (
 
24
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
27
28
    commands as _mod_commands,
28
29
    errors,
29
30
    help_topics,
30
31
    osutils,
31
32
    plugin,
32
 
    ui,
33
 
    utextwrap,
 
33
    symbol_versioning,
34
34
    )
35
35
 
36
36
 
37
 
class NoHelpTopic(errors.BzrError):
38
 
 
39
 
    _fmt = ("No help could be found for '%(topic)s'. "
40
 
            "Please use 'brz help topics' to obtain a list of topics.")
41
 
 
42
 
    def __init__(self, topic):
43
 
        self.topic = topic
44
 
 
45
 
 
46
37
def help(topic=None, outfile=None):
47
38
    """Write the help for the specific topic to outfile"""
48
39
    if outfile is None:
49
 
        outfile = ui.ui_factory.make_output_stream()
 
40
        outfile = sys.stdout
50
41
 
51
42
    indices = HelpIndices()
52
43
 
54
45
    try:
55
46
        topics = indices.search(topic)
56
47
        shadowed_terms = []
57
 
        for index, topic_obj in topics[1:]:
 
48
        for index, topic in topics[1:]:
58
49
            shadowed_terms.append('%s%s' % (index.prefix,
59
 
                                            topic_obj.get_help_topic()))
60
 
        source = topics[0][1]
61
 
        outfile.write(source.get_help_text(shadowed_terms))
62
 
    except NoHelpTopic:
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
52
    except errors.NoHelpTopic:
63
53
        if alias is None:
64
54
            raise
65
55
 
66
56
    if alias is not None:
67
 
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
68
 
                                                                " ".join(alias)))
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
58
            " ".join(alias)))
69
59
 
70
60
 
71
61
def help_commands(outfile=None):
72
62
    """List all commands"""
73
63
    if outfile is None:
74
 
        outfile = ui.ui_factory.make_output_stream()
 
64
        outfile = sys.stdout
75
65
    outfile.write(_help_commands_to_text('commands'))
76
66
 
77
67
 
82
72
        hidden = True
83
73
    else:
84
74
        hidden = False
85
 
    names = list(_mod_commands.all_command_names())
 
75
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
76
    names.update(_mod_commands.plugin_command_names())
86
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
87
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
88
79
    max_name = max(len(n) for n, o in shown_commands)
89
80
    indent = ' ' * (max_name + 1)
90
 
    width = osutils.terminal_width()
91
 
    if width is None:
92
 
        width = osutils.default_terminal_width
93
 
    # we need one extra space for terminals that wrap on last char
94
 
    width = width - 1
 
81
    width = osutils.terminal_width() - 1
95
82
 
96
83
    for cmd_name, cmd_object in sorted(shown_commands):
97
84
        plugin_name = cmd_object.plugin_name()
106
93
        else:
107
94
            firstline = ''
108
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
109
 
        lines = utextwrap.wrap(
110
 
            helpstring, subsequent_indent=indent,
111
 
            width=width,
112
 
            break_long_words=False)
 
96
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
97
                              width=width)
113
98
        for line in lines:
114
99
            out.append(line + '\n')
115
100
    return ''.join(out)
127
112
 
128
113
class HelpIndices(object):
129
114
    """Maintainer of help topics across multiple indices.
130
 
 
 
115
    
131
116
    It is currently separate to the HelpTopicRegistry because of its ordered
132
117
    nature, but possibly we should instead structure it as a search within the
133
118
    registry and add ordering and searching facilities to the registry. The
145
130
            help_topics.HelpTopicIndex(),
146
131
            _mod_commands.HelpCommandIndex(),
147
132
            plugin.PluginsHelpIndex(),
148
 
            help_topics.ConfigOptionHelpIndex(),
149
133
            ]
150
134
 
151
135
    def _check_prefix_uniqueness(self):
152
136
        """Ensure that the index collection is able to differentiate safely."""
153
 
        prefixes = set()
 
137
        prefixes = {}
154
138
        for index in self.search_path:
155
 
            prefix = index.prefix
156
 
            if prefix in prefixes:
 
139
            prefixes.setdefault(index.prefix, []).append(index)
 
140
        for prefix, indices in prefixes.items():
 
141
            if len(indices) > 1:
157
142
                raise errors.DuplicateHelpPrefix(prefix)
158
 
            prefixes.add(prefix)
159
143
 
160
144
    def search(self, topic):
161
145
        """Search for topic across the help search path.
162
 
 
 
146
        
163
147
        :param topic: A string naming the help topic to search for.
164
148
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
165
149
        :return: A list of HelpTopics which matched 'topic'.
167
151
        self._check_prefix_uniqueness()
168
152
        result = []
169
153
        for index in self.search_path:
170
 
            result.extend([(index, _topic)
171
 
                           for _topic in index.get_topics(topic)])
 
154
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
172
155
        if not result:
173
 
            raise NoHelpTopic(topic)
 
156
            raise errors.NoHelpTopic(topic)
174
157
        else:
175
158
            return result