/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: 2020-09-02 16:35:18 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902163518-sy9f4unbboljphgu
Handle duplicate directories entries for git.

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