/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 breezy/help.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/help.py
 
1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
# TODO: Some way to get a list of external commands (defined by shell
 
20
# scripts) so that they can be included in the help listing as well.
 
21
# It should be enough to just list the plugin directory and look for
 
22
# executable files with reasonable names.
 
23
 
 
24
# TODO: `help commands --all` should show hidden commands
 
25
 
 
26
import sys
 
27
 
 
28
from . import (
 
29
    commands as _mod_commands,
 
30
    errors,
 
31
    help_topics,
 
32
    osutils,
 
33
    plugin,
 
34
    ui,
 
35
    utextwrap,
 
36
    )
 
37
 
 
38
 
 
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
def help(topic=None, outfile=None):
 
49
    """Write the help for the specific topic to outfile"""
 
50
    if outfile is None:
 
51
        outfile = ui.ui_factory.make_output_stream()
 
52
 
 
53
    indices = HelpIndices()
 
54
 
 
55
    alias = _mod_commands.get_alias(topic)
 
56
    try:
 
57
        topics = indices.search(topic)
 
58
        shadowed_terms = []
 
59
        for index, topic_obj in topics[1:]:
 
60
            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:
 
65
        if alias is None:
 
66
            raise
 
67
 
 
68
    if alias is not None:
 
69
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
 
70
            " ".join(alias)))
 
71
 
 
72
 
 
73
def help_commands(outfile=None):
 
74
    """List all commands"""
 
75
    if outfile is None:
 
76
        outfile = ui.ui_factory.make_output_stream()
 
77
    outfile.write(_help_commands_to_text('commands'))
 
78
 
 
79
 
 
80
def _help_commands_to_text(topic):
 
81
    """Generate the help text for the list of commands"""
 
82
    out = []
 
83
    if topic == 'hidden-commands':
 
84
        hidden = True
 
85
    else:
 
86
        hidden = False
 
87
    names = list(_mod_commands.all_command_names())
 
88
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
89
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
90
    max_name = max(len(n) for n, o in shown_commands)
 
91
    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
 
97
 
 
98
    for cmd_name, cmd_object in sorted(shown_commands):
 
99
        plugin_name = cmd_object.plugin_name()
 
100
        if plugin_name is None:
 
101
            plugin_name = ''
 
102
        else:
 
103
            plugin_name = ' [%s]' % plugin_name
 
104
 
 
105
        cmd_help = cmd_object.help()
 
106
        if cmd_help:
 
107
            firstline = cmd_help.split('\n', 1)[0]
 
108
        else:
 
109
            firstline = ''
 
110
        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)
 
115
        for line in lines:
 
116
            out.append(line + '\n')
 
117
    return ''.join(out)
 
118
 
 
119
 
 
120
help_topics.topic_registry.register("commands",
 
121
                                    _help_commands_to_text,
 
122
                                    "Basic help for all commands",
 
123
                                    help_topics.SECT_HIDDEN)
 
124
help_topics.topic_registry.register("hidden-commands",
 
125
                                    _help_commands_to_text,
 
126
                                    "All hidden commands",
 
127
                                    help_topics.SECT_HIDDEN)
 
128
 
 
129
 
 
130
class HelpIndices(object):
 
131
    """Maintainer of help topics across multiple indices.
 
132
 
 
133
    It is currently separate to the HelpTopicRegistry because of its ordered
 
134
    nature, but possibly we should instead structure it as a search within the
 
135
    registry and add ordering and searching facilities to the registry. The
 
136
    registry would probably need to be restructured to support that cleanly
 
137
    which is why this has been implemented in parallel even though it does as a
 
138
    result permit searching for help in indices which are not discoverable via
 
139
    'help topics'.
 
140
 
 
141
    Each index has a unique prefix string, such as "commands", and contains
 
142
    help topics which can be listed or searched.
 
143
    """
 
144
 
 
145
    def __init__(self):
 
146
        self.search_path = [
 
147
            help_topics.HelpTopicIndex(),
 
148
            _mod_commands.HelpCommandIndex(),
 
149
            plugin.PluginsHelpIndex(),
 
150
            help_topics.ConfigOptionHelpIndex(),
 
151
            ]
 
152
 
 
153
    def _check_prefix_uniqueness(self):
 
154
        """Ensure that the index collection is able to differentiate safely."""
 
155
        prefixes = set()
 
156
        for index in self.search_path:
 
157
            prefix = index.prefix
 
158
            if prefix in prefixes:
 
159
                raise errors.DuplicateHelpPrefix(prefix)
 
160
            prefixes.add(prefix)
 
161
 
 
162
    def search(self, topic):
 
163
        """Search for topic across the help search path.
 
164
 
 
165
        :param topic: A string naming the help topic to search for.
 
166
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
167
        :return: A list of HelpTopics which matched 'topic'.
 
168
        """
 
169
        self._check_prefix_uniqueness()
 
170
        result = []
 
171
        for index in self.search_path:
 
172
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
173
        if not result:
 
174
            raise NoHelpTopic(topic)
 
175
        else:
 
176
            return result