/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: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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.
23
21
 
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
 
from . import (
27
 
    commands as _mod_commands,
28
 
    errors,
 
24
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
29
28
    help_topics,
30
29
    osutils,
31
 
    plugin,
32
 
    ui,
33
 
    utextwrap,
34
30
    )
35
31
 
36
32
 
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
33
def help(topic=None, outfile=None):
47
34
    """Write the help for the specific topic to outfile"""
48
35
    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)))
 
36
        outfile = sys.stdout
 
37
 
 
38
    if topic is None:
 
39
        topic = 'basic'
 
40
 
 
41
    if topic in help_topics.topic_registry:
 
42
        txt = help_topics.topic_registry.get_detail(topic)
 
43
        outfile.write(txt)
 
44
    else:
 
45
        help_on_command(topic, outfile=outfile)
 
46
 
 
47
 
 
48
def command_usage(cmd_object):
 
49
    """Return single-line grammar for command.
 
50
 
 
51
    Only describes arguments, not options.
 
52
    """
 
53
    s = 'bzr ' + cmd_object.name() + ' '
 
54
    for aname in cmd_object.takes_args:
 
55
        aname = aname.upper()
 
56
        if aname[-1] in ['$', '+']:
 
57
            aname = aname[:-1] + '...'
 
58
        elif aname[-1] == '?':
 
59
            aname = '[' + aname[:-1] + ']'
 
60
        elif aname[-1] == '*':
 
61
            aname = '[' + aname[:-1] + '...]'
 
62
        s += aname + ' '
 
63
            
 
64
    assert s[-1] == ' '
 
65
    s = s[:-1]
 
66
    
 
67
    return s
 
68
 
 
69
 
 
70
def print_command_plugin(cmd_object, outfile, format):
 
71
    """Print the plugin that provides a command object, if any.
 
72
 
 
73
    If the cmd_object is provided by a plugin, prints the plugin name to
 
74
    outfile using the provided format string.
 
75
    """
 
76
    plugin_name = cmd_object.plugin_name()
 
77
    if plugin_name is not None:
 
78
        out_str = '(From plugin "%s")' % plugin_name
 
79
        outfile.write(format % out_str)
 
80
 
 
81
 
 
82
def help_on_command(cmdname, outfile=None):
 
83
    from bzrlib.commands import get_cmd_object
 
84
 
 
85
    cmdname = str(cmdname)
 
86
 
 
87
    if outfile is None:
 
88
        outfile = sys.stdout
 
89
 
 
90
    cmd_object = get_cmd_object(cmdname)
 
91
 
 
92
    doc = cmd_object.help()
 
93
    if doc is None:
 
94
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
95
 
 
96
    print >>outfile, 'usage:', command_usage(cmd_object)
 
97
 
 
98
    if cmd_object.aliases:
 
99
        print >>outfile, 'aliases:',
 
100
        print >>outfile, ', '.join(cmd_object.aliases)
 
101
 
 
102
    print >>outfile
 
103
 
 
104
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
105
 
 
106
    outfile.write(doc)
 
107
    if doc[-1] != '\n':
 
108
        outfile.write('\n')
 
109
    help_on_command_options(cmd_object, outfile)
 
110
 
 
111
 
 
112
def help_on_command_options(cmd, outfile=None):
 
113
    from bzrlib.option import Option, get_optparser
 
114
    if outfile is None:
 
115
        outfile = sys.stdout
 
116
    options = cmd.options()
 
117
    outfile.write('\n')
 
118
    outfile.write(get_optparser(options).format_option_help())
69
119
 
70
120
 
71
121
def help_commands(outfile=None):
72
122
    """List all commands"""
73
123
    if outfile is None:
74
 
        outfile = ui.ui_factory.make_output_stream()
 
124
        outfile = sys.stdout
75
125
    outfile.write(_help_commands_to_text('commands'))
76
126
 
77
127
 
78
128
def _help_commands_to_text(topic):
79
129
    """Generate the help text for the list of commands"""
 
130
    from bzrlib.commands import (builtin_command_names,
 
131
                                 plugin_command_names,
 
132
                                 get_cmd_object)
80
133
    out = []
81
134
    if topic == 'hidden-commands':
82
135
        hidden = True
83
136
    else:
84
137
        hidden = False
85
 
    names = list(_mod_commands.all_command_names())
86
 
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
138
    names = set(builtin_command_names()) # to eliminate duplicates
 
139
    names.update(plugin_command_names())
 
140
    commands = ((n, get_cmd_object(n)) for n in names)
87
141
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
88
142
    max_name = max(len(n) for n, o in shown_commands)
89
143
    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
 
144
    width = osutils.terminal_width() - 1
95
145
 
96
146
    for cmd_name, cmd_object in sorted(shown_commands):
97
147
        plugin_name = cmd_object.plugin_name()
106
156
        else:
107
157
            firstline = ''
108
158
        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)
 
159
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
160
                              width=width)
113
161
        for line in lines:
114
162
            out.append(line + '\n')
115
163
    return ''.join(out)
117
165
 
118
166
help_topics.topic_registry.register("commands",
119
167
                                    _help_commands_to_text,
120
 
                                    "Basic help for all commands",
121
 
                                    help_topics.SECT_HIDDEN)
122
 
help_topics.topic_registry.register("hidden-commands",
 
168
                                    "Basic help for all commands")
 
169
help_topics.topic_registry.register("hidden-commands", 
123
170
                                    _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
 
171
                                    "All hidden commands")