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