/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: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

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.
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,
 
33
    symbol_versioning,
36
34
    )
37
35
 
38
36
 
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
37
def help(topic=None, outfile=None):
49
38
    """Write the help for the specific topic to outfile"""
50
39
    if outfile is None:
51
 
        outfile = ui.ui_factory.make_output_stream()
 
40
        outfile = sys.stdout
52
41
 
53
42
    indices = HelpIndices()
54
43
 
56
45
    try:
57
46
        topics = indices.search(topic)
58
47
        shadowed_terms = []
59
 
        for index, topic_obj in topics[1:]:
 
48
        for index, topic in topics[1:]:
60
49
            shadowed_terms.append('%s%s' % (index.prefix,
61
 
                topic_obj.get_help_topic()))
62
 
        source = topics[0][1]
63
 
        outfile.write(source.get_help_text(shadowed_terms))
64
 
    except NoHelpTopic:
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
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
 
84
72
        hidden = True
85
73
    else:
86
74
        hidden = False
87
 
    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())
88
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
89
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
90
79
    max_name = max(len(n) for n, o in shown_commands)
91
80
    indent = ' ' * (max_name + 1)
92
 
    width = osutils.terminal_width()
93
 
    if width is None:
94
 
        width = osutils.default_terminal_width
95
 
    # we need one extra space for terminals that wrap on last char
96
 
    width = width - 1
 
81
    width = osutils.terminal_width() - 1
97
82
 
98
83
    for cmd_name, cmd_object in sorted(shown_commands):
99
84
        plugin_name = cmd_object.plugin_name()
108
93
        else:
109
94
            firstline = ''
110
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
111
 
        lines = utextwrap.wrap(
112
 
            helpstring, subsequent_indent=indent,
113
 
            width=width,
114
 
            break_long_words=False)
 
96
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
97
                              width=width)
115
98
        for line in lines:
116
99
            out.append(line + '\n')
117
100
    return ''.join(out)
129
112
 
130
113
class HelpIndices(object):
131
114
    """Maintainer of help topics across multiple indices.
132
 
 
 
115
    
133
116
    It is currently separate to the HelpTopicRegistry because of its ordered
134
117
    nature, but possibly we should instead structure it as a search within the
135
118
    registry and add ordering and searching facilities to the registry. The
147
130
            help_topics.HelpTopicIndex(),
148
131
            _mod_commands.HelpCommandIndex(),
149
132
            plugin.PluginsHelpIndex(),
150
 
            help_topics.ConfigOptionHelpIndex(),
151
133
            ]
152
134
 
153
135
    def _check_prefix_uniqueness(self):
154
136
        """Ensure that the index collection is able to differentiate safely."""
155
 
        prefixes = set()
 
137
        prefixes = {}
156
138
        for index in self.search_path:
157
 
            prefix = index.prefix
158
 
            if prefix in prefixes:
 
139
            prefixes.setdefault(index.prefix, []).append(index)
 
140
        for prefix, indices in prefixes.items():
 
141
            if len(indices) > 1:
159
142
                raise errors.DuplicateHelpPrefix(prefix)
160
 
            prefixes.add(prefix)
161
143
 
162
144
    def search(self, topic):
163
145
        """Search for topic across the help search path.
164
 
 
 
146
        
165
147
        :param topic: A string naming the help topic to search for.
166
148
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
167
149
        :return: A list of HelpTopics which matched 'topic'.
171
153
        for index in self.search_path:
172
154
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
173
155
        if not result:
174
 
            raise NoHelpTopic(topic)
 
156
            raise errors.NoHelpTopic(topic)
175
157
        else:
176
158
            return result