~bzr-pqm/bzr/bzr.dev

6059.3.1 by Vincent Ladeuil
Provide per-config option help
1
# Copyright (C) 2005-2011 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
351 by Martin Pool
- Split out help functions into bzrlib.help
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
351 by Martin Pool
- Split out help functions into bzrlib.help
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
351 by Martin Pool
- Split out help functions into bzrlib.help
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
351 by Martin Pool
- Split out help functions into bzrlib.help
16
6379.6.3 by Jelmer Vernooij
Use absolute_import.
17
from __future__ import absolute_import
18
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
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
351 by Martin Pool
- Split out help functions into bzrlib.help
25
635 by Martin Pool
- manpage generator by Hans Ulrich Niedermann
26
import sys
2023.1.1 by ghigo
add topics help
27
2070.4.3 by John Arbash Meinel
code and doc cleanup
28
from bzrlib import (
2432.1.3 by Robert Collins
Create a HelpContexts object to do help lookups.
29
    commands as _mod_commands,
2432.1.5 by Robert Collins
Initial stub for topic searching.
30
    errors,
2070.4.3 by John Arbash Meinel
code and doc cleanup
31
    help_topics,
32
    osutils,
2432.1.24 by Robert Collins
Add plugins as a help index.
33
    plugin,
5875.3.1 by INADA Naoki
Implement command help l10n.
34
    utextwrap,
2070.4.3 by John Arbash Meinel
code and doc cleanup
35
    )
1993.4.4 by John Arbash Meinel
cleanup help.py
36
37
3984.4.5 by Ian Clatworthy
help xxx is full help; xxx -h is concise help
38
def help(topic=None, outfile=None):
2070.4.3 by John Arbash Meinel
code and doc cleanup
39
    """Write the help for the specific topic to outfile"""
1993.4.4 by John Arbash Meinel
cleanup help.py
40
    if outfile is None:
635 by Martin Pool
- manpage generator by Hans Ulrich Niedermann
41
        outfile = sys.stdout
2070.4.13 by John Arbash Meinel
Switch help_topics to use a Registry.
42
2432.1.16 by Robert Collins
Correct spelling of Indexs to Indices.
43
    indices = HelpIndices()
2743.2.3 by Daniel Watkins
If an alias exists, it is displayed regardless of help also to be displayed.
44
45
    alias = _mod_commands.get_alias(topic)
2743.2.1 by Daniel Watkins
Modified bzrlib.help to show the alias of a command if a NoHelpTopic exception is raised, reraising it if no alias exists.
46
    try:
47
        topics = indices.search(topic)
48
        shadowed_terms = []
5255.3.1 by Parth Malwankar
bzrlib.help.help function was overwriting a topic arg
49
        for index, topic_obj in topics[1:]:
2762.1.1 by Ian Clatworthy
(Daniel Watkins) teach bzr help to recognize aliases
50
            shadowed_terms.append('%s%s' % (index.prefix,
5255.3.1 by Parth Malwankar
bzrlib.help.help function was overwriting a topic arg
51
                topic_obj.get_help_topic()))
3984.4.2 by Ian Clatworthy
make help on commands concise by default
52
        source = topics[0][1]
3984.4.5 by Ian Clatworthy
help xxx is full help; xxx -h is concise help
53
        outfile.write(source.get_help_text(shadowed_terms))
2743.2.1 by Daniel Watkins
Modified bzrlib.help to show the alias of a command if a NoHelpTopic exception is raised, reraising it if no alias exists.
54
    except errors.NoHelpTopic:
2743.2.5 by Daniel Watkins
Modified bzrlib.help as per abentley's comments.
55
        if alias is None:
56
            raise
57
58
    if alias is not None:
2762.1.1 by Ian Clatworthy
(Daniel Watkins) teach bzr help to recognize aliases
59
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
60
            " ".join(alias)))
635 by Martin Pool
- manpage generator by Hans Ulrich Niedermann
61
62
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
63
def help_commands(outfile=None):
351 by Martin Pool
- Split out help functions into bzrlib.help
64
    """List all commands"""
2070.4.13 by John Arbash Meinel
Switch help_topics to use a Registry.
65
    if outfile is None:
66
        outfile = sys.stdout
67
    outfile.write(_help_commands_to_text('commands'))
68
69
70
def _help_commands_to_text(topic):
71
    """Generate the help text for the list of commands"""
72
    out = []
1551.9.14 by Aaron Bentley
Change topic to hidden-commands
73
    if topic == 'hidden-commands':
1551.9.13 by Aaron Bentley
add "hidden" topic
74
        hidden = True
75
    else:
76
        hidden = False
4119.3.4 by Robert Collins
Add Command lookup hooks: list_commands and get_command.
77
    names = list(_mod_commands.all_command_names())
2432.1.3 by Robert Collins
Create a HelpContexts object to do help lookups.
78
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
1551.9.13 by Aaron Bentley
add "hidden" topic
79
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
2034.1.3 by Aaron Bentley
Changes from review and tweaks
80
    max_name = max(len(n) for n, o in shown_commands)
81
    indent = ' ' * (max_name + 1)
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
82
    width = osutils.terminal_width()
83
    if width is None:
84
        width = osutils.default_terminal_width
85
    # we need one extra space for terminals that wrap on last char
86
    width = width - 1
2070.4.13 by John Arbash Meinel
Switch help_topics to use a Registry.
87
2034.1.3 by Aaron Bentley
Changes from review and tweaks
88
    for cmd_name, cmd_object in sorted(shown_commands):
1733.2.5 by Michael Ellerman
Show which plugin (if any) provides a command.
89
        plugin_name = cmd_object.plugin_name()
2034.1.1 by Aaron Bentley
Condense command help text
90
        if plugin_name is None:
91
            plugin_name = ''
92
        else:
2034.1.4 by Aaron Bentley
Change angle brackets to square brackets
93
            plugin_name = ' [%s]' % plugin_name
1733.2.5 by Michael Ellerman
Show which plugin (if any) provides a command.
94
1162 by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to
95
        cmd_help = cmd_object.help()
96
        if cmd_help:
97
            firstline = cmd_help.split('\n', 1)[0]
2034.1.1 by Aaron Bentley
Condense command help text
98
        else:
99
            firstline = ''
2034.1.3 by Aaron Bentley
Changes from review and tweaks
100
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
5875.3.1 by INADA Naoki
Implement command help l10n.
101
        lines = utextwrap.wrap(
4070.11.2 by Martin Pool
Ask textwrap not to break long words or on hyphens
102
            helpstring, subsequent_indent=indent,
103
            width=width,
4070.11.5 by Martin Pool
textwrap break_on_hyphens option is not available in python2.5
104
            break_long_words=False)
2034.1.1 by Aaron Bentley
Condense command help text
105
        for line in lines:
2070.4.13 by John Arbash Meinel
Switch help_topics to use a Registry.
106
            out.append(line + '\n')
107
    return ''.join(out)
108
109
110
help_topics.topic_registry.register("commands",
111
                                    _help_commands_to_text,
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
112
                                    "Basic help for all commands",
113
                                    help_topics.SECT_HIDDEN)
2432.1.1 by Robert Collins
Add a HelpTopicContext object.
114
help_topics.topic_registry.register("hidden-commands",
1551.9.13 by Aaron Bentley
add "hidden" topic
115
                                    _help_commands_to_text,
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
116
                                    "All hidden commands",
117
                                    help_topics.SECT_HIDDEN)
2432.1.3 by Robert Collins
Create a HelpContexts object to do help lookups.
118
119
2432.1.16 by Robert Collins
Correct spelling of Indexs to Indices.
120
class HelpIndices(object):
2432.1.31 by Robert Collins
Review feedback and put help.command_usage back in as a deprecated function.
121
    """Maintainer of help topics across multiple indices.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
122
2432.1.31 by Robert Collins
Review feedback and put help.command_usage back in as a deprecated function.
123
    It is currently separate to the HelpTopicRegistry because of its ordered
124
    nature, but possibly we should instead structure it as a search within the
125
    registry and add ordering and searching facilities to the registry. The
126
    registry would probably need to be restructured to support that cleanly
127
    which is why this has been implemented in parallel even though it does as a
128
    result permit searching for help in indices which are not discoverable via
2432.1.9 by Robert Collins
Expand HelpContexts documentation.
129
    'help topics'.
2432.1.31 by Robert Collins
Review feedback and put help.command_usage back in as a deprecated function.
130
131
    Each index has a unique prefix string, such as "commands", and contains
132
    help topics which can be listed or searched.
2432.1.9 by Robert Collins
Expand HelpContexts documentation.
133
    """
2432.1.3 by Robert Collins
Create a HelpContexts object to do help lookups.
134
135
    def __init__(self):
136
        self.search_path = [
2432.1.15 by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name.
137
            help_topics.HelpTopicIndex(),
138
            _mod_commands.HelpCommandIndex(),
2432.1.24 by Robert Collins
Add plugins as a help index.
139
            plugin.PluginsHelpIndex(),
6059.3.1 by Vincent Ladeuil
Provide per-config option help
140
            help_topics.ConfigOptionHelpIndex(),
2432.1.3 by Robert Collins
Create a HelpContexts object to do help lookups.
141
            ]
2432.1.5 by Robert Collins
Initial stub for topic searching.
142
2432.1.19 by Robert Collins
Ensure each HelpIndex has a unique prefix.
143
    def _check_prefix_uniqueness(self):
144
        """Ensure that the index collection is able to differentiate safely."""
145
        prefixes = {}
146
        for index in self.search_path:
147
            prefixes.setdefault(index.prefix, []).append(index)
148
        for prefix, indices in prefixes.items():
149
            if len(indices) > 1:
150
                raise errors.DuplicateHelpPrefix(prefix)
151
2432.1.5 by Robert Collins
Initial stub for topic searching.
152
    def search(self, topic):
153
        """Search for topic across the help search path.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
154
2432.1.5 by Robert Collins
Initial stub for topic searching.
155
        :param topic: A string naming the help topic to search for.
2432.1.15 by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name.
156
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
2432.1.7 by Robert Collins
HelpContexts.search now returns the found topics.
157
        :return: A list of HelpTopics which matched 'topic'.
2432.1.5 by Robert Collins
Initial stub for topic searching.
158
        """
2432.1.19 by Robert Collins
Ensure each HelpIndex has a unique prefix.
159
        self._check_prefix_uniqueness()
2432.1.6 by Robert Collins
HelpContexts.search now invokes get_topics on each context.
160
        result = []
2432.1.15 by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name.
161
        for index in self.search_path:
2432.1.20 by Robert Collins
Modify the result of HelpIndices.search to include the index each result was found in.
162
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
2432.1.6 by Robert Collins
HelpContexts.search now invokes get_topics on each context.
163
        if not result:
164
            raise errors.NoHelpTopic(topic)
2432.1.7 by Robert Collins
HelpContexts.search now returns the found topics.
165
        else:
166
            return result