/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: Canonical.com Patch Queue Manager
  • Date: 2007-04-23 02:09:44 UTC
  • mfrom: (2432.1.33 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070423020944-lcu3twk2zj27bw5a
(robertc) Fix bugs 107656 and 50408 by creating multiple help indices and cross referencing between them when user help requests are ambiguous. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
25
25
import textwrap
26
26
 
27
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
28
30
    help_topics,
29
31
    osutils,
 
32
    plugin,
 
33
    symbol_versioning,
30
34
    )
31
35
 
32
36
 
35
39
    if outfile is None:
36
40
        outfile = sys.stdout
37
41
 
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
 
    cmd_object = get_cmd_object(cmdname)
87
 
 
88
 
    return help_on_command_object(cmd_object, cmdname, outfile)
89
 
 
90
 
 
91
 
def help_on_command_object(cmd_object, cmdname, outfile=None):
92
 
    """Generate help on the cmd_object with a supplied name of cmdname.
93
 
 
94
 
    :param cmd_object: An instance of a Command.
95
 
    :param cmdname: The user supplied name. This might be an alias for example.
96
 
    :param outfile: A stream to write the help to.
97
 
    """
98
 
    if outfile is None:
99
 
        outfile = sys.stdout
100
 
 
101
 
    doc = cmd_object.help()
102
 
    if doc is None:
103
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
104
 
 
105
 
    print >>outfile, 'usage:', command_usage(cmd_object)
106
 
 
107
 
    if cmd_object.aliases:
108
 
        print >>outfile, 'aliases:',
109
 
        print >>outfile, ', '.join(cmd_object.aliases)
110
 
 
111
 
    print >>outfile
112
 
 
113
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
114
 
 
115
 
    outfile.write(doc)
116
 
    if doc[-1] != '\n':
117
 
        outfile.write('\n')
118
 
    help_on_command_options(cmd_object, outfile)
119
 
    see_also = cmd_object.get_see_also()
120
 
    if see_also:
121
 
        outfile.write('\nSee also: ')
122
 
        outfile.write(', '.join(see_also))
123
 
        outfile.write('\n')
124
 
 
125
 
 
126
 
def help_on_command_options(cmd, outfile=None):
127
 
    from bzrlib.option import Option, get_optparser
128
 
    if outfile is None:
129
 
        outfile = sys.stdout
130
 
    options = cmd.options()
131
 
    outfile.write('\n')
132
 
    outfile.write(get_optparser(options).format_option_help())
 
42
    indices = HelpIndices()
 
43
    topics = indices.search(topic)
 
44
    shadowed_terms = []
 
45
    for index, topic in topics[1:]:
 
46
        shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
 
47
    outfile.write(topics[0][1].get_help_text(shadowed_terms))
133
48
 
134
49
 
135
50
def help_commands(outfile=None):
139
54
    outfile.write(_help_commands_to_text('commands'))
140
55
 
141
56
 
 
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
58
def command_usage(cmd):
 
59
    return cmd._usage()
 
60
 
 
61
 
142
62
def _help_commands_to_text(topic):
143
63
    """Generate the help text for the list of commands"""
144
 
    from bzrlib.commands import (builtin_command_names,
145
 
                                 plugin_command_names,
146
 
                                 get_cmd_object)
147
64
    out = []
148
65
    if topic == 'hidden-commands':
149
66
        hidden = True
150
67
    else:
151
68
        hidden = False
152
 
    names = set(builtin_command_names()) # to eliminate duplicates
153
 
    names.update(plugin_command_names())
154
 
    commands = ((n, get_cmd_object(n)) for n in names)
 
69
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
70
    names.update(_mod_commands.plugin_command_names())
 
71
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
155
72
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
156
73
    max_name = max(len(n) for n, o in shown_commands)
157
74
    indent = ' ' * (max_name + 1)
180
97
help_topics.topic_registry.register("commands",
181
98
                                    _help_commands_to_text,
182
99
                                    "Basic help for all commands")
183
 
help_topics.topic_registry.register("hidden-commands", 
 
100
help_topics.topic_registry.register("hidden-commands",
184
101
                                    _help_commands_to_text,
185
102
                                    "All hidden commands")
 
103
 
 
104
 
 
105
class HelpIndices(object):
 
106
    """Maintainer of help topics across multiple indices.
 
107
    
 
108
    It is currently separate to the HelpTopicRegistry because of its ordered
 
109
    nature, but possibly we should instead structure it as a search within the
 
110
    registry and add ordering and searching facilities to the registry. The
 
111
    registry would probably need to be restructured to support that cleanly
 
112
    which is why this has been implemented in parallel even though it does as a
 
113
    result permit searching for help in indices which are not discoverable via
 
114
    'help topics'.
 
115
 
 
116
    Each index has a unique prefix string, such as "commands", and contains
 
117
    help topics which can be listed or searched.
 
118
    """
 
119
 
 
120
    def __init__(self):
 
121
        self.search_path = [
 
122
            help_topics.HelpTopicIndex(),
 
123
            _mod_commands.HelpCommandIndex(),
 
124
            plugin.PluginsHelpIndex(),
 
125
            ]
 
126
 
 
127
    def _check_prefix_uniqueness(self):
 
128
        """Ensure that the index collection is able to differentiate safely."""
 
129
        prefixes = {}
 
130
        for index in self.search_path:
 
131
            prefixes.setdefault(index.prefix, []).append(index)
 
132
        for prefix, indices in prefixes.items():
 
133
            if len(indices) > 1:
 
134
                raise errors.DuplicateHelpPrefix(prefix)
 
135
 
 
136
    def search(self, topic):
 
137
        """Search for topic across the help search path.
 
138
        
 
139
        :param topic: A string naming the help topic to search for.
 
140
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
141
        :return: A list of HelpTopics which matched 'topic'.
 
142
        """
 
143
        self._check_prefix_uniqueness()
 
144
        result = []
 
145
        for index in self.search_path:
 
146
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
147
        if not result:
 
148
            raise errors.NoHelpTopic(topic)
 
149
        else:
 
150
            return result