← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Andrew Bennetts
  • Date: 2007-03-26 06:24:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2376.
  • Revision ID: andrew.bennetts@canonical.com-20070326062401-k3nbefzje5332jaf
Deal with review comments from Robert:

  * Add my name to the NEWS file
  * Move the test case to a new module in branch_implementations
  * Remove revision_history cruft from identitymap and test_identitymap
  * Improve some docstrings

Also, this fixes a bug where revision_history was not returning a copy of the
cached data, allowing the cache to be corrupted.

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,
30
28
    help_topics,
31
29
    osutils,
32
 
    plugin,
33
 
    symbol_versioning,
34
30
    )
35
31
 
36
32
 
39
35
    if outfile is None:
40
36
        outfile = sys.stdout
41
37
 
42
 
    indices = HelpIndices()
43
 
 
44
 
    alias = _mod_commands.get_alias(topic)
45
 
    try:
46
 
        topics = indices.search(topic)
47
 
        shadowed_terms = []
48
 
        for index, topic in topics[1:]:
49
 
            shadowed_terms.append('%s%s' % (index.prefix,
50
 
                topic.get_help_topic()))
51
 
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
52
 
    except errors.NoHelpTopic:
53
 
        if alias is None:
54
 
            raise
55
 
 
56
 
    if alias is not None:
57
 
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
58
 
            " ".join(alias)))
 
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())
59
119
 
60
120
 
61
121
def help_commands(outfile=None):
67
127
 
68
128
def _help_commands_to_text(topic):
69
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)
70
133
    out = []
71
134
    if topic == 'hidden-commands':
72
135
        hidden = True
73
136
    else:
74
137
        hidden = False
75
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
76
 
    names.update(_mod_commands.plugin_command_names())
77
 
    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)
78
141
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
79
142
    max_name = max(len(n) for n, o in shown_commands)
80
143
    indent = ' ' * (max_name + 1)
102
165
 
103
166
help_topics.topic_registry.register("commands",
104
167
                                    _help_commands_to_text,
105
 
                                    "Basic help for all commands",
106
 
                                    help_topics.SECT_HIDDEN)
107
 
help_topics.topic_registry.register("hidden-commands",
 
168
                                    "Basic help for all commands")
 
169
help_topics.topic_registry.register("hidden-commands", 
108
170
                                    _help_commands_to_text,
109
 
                                    "All hidden commands",
110
 
                                    help_topics.SECT_HIDDEN)
111
 
 
112
 
 
113
 
class HelpIndices(object):
114
 
    """Maintainer of help topics across multiple indices.
115
 
    
116
 
    It is currently separate to the HelpTopicRegistry because of its ordered
117
 
    nature, but possibly we should instead structure it as a search within the
118
 
    registry and add ordering and searching facilities to the registry. The
119
 
    registry would probably need to be restructured to support that cleanly
120
 
    which is why this has been implemented in parallel even though it does as a
121
 
    result permit searching for help in indices which are not discoverable via
122
 
    'help topics'.
123
 
 
124
 
    Each index has a unique prefix string, such as "commands", and contains
125
 
    help topics which can be listed or searched.
126
 
    """
127
 
 
128
 
    def __init__(self):
129
 
        self.search_path = [
130
 
            help_topics.HelpTopicIndex(),
131
 
            _mod_commands.HelpCommandIndex(),
132
 
            plugin.PluginsHelpIndex(),
133
 
            ]
134
 
 
135
 
    def _check_prefix_uniqueness(self):
136
 
        """Ensure that the index collection is able to differentiate safely."""
137
 
        prefixes = {}
138
 
        for index in self.search_path:
139
 
            prefixes.setdefault(index.prefix, []).append(index)
140
 
        for prefix, indices in prefixes.items():
141
 
            if len(indices) > 1:
142
 
                raise errors.DuplicateHelpPrefix(prefix)
143
 
 
144
 
    def search(self, topic):
145
 
        """Search for topic across the help search path.
146
 
        
147
 
        :param topic: A string naming the help topic to search for.
148
 
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
149
 
        :return: A list of HelpTopics which matched 'topic'.
150
 
        """
151
 
        self._check_prefix_uniqueness()
152
 
        result = []
153
 
        for index in self.search_path:
154
 
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
155
 
        if not result:
156
 
            raise errors.NoHelpTopic(topic)
157
 
        else:
158
 
            return result
 
171
                                    "All hidden commands")