← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
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
 
 
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())
 
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
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
 
53
    except errors.NoHelpTopic:
 
54
        if alias is None:
 
55
            raise
 
56
 
 
57
    if alias is not None:
 
58
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
59
            " ".join(alias)))
119
60
 
120
61
 
121
62
def help_commands(outfile=None):
127
68
 
128
69
def _help_commands_to_text(topic):
129
70
    """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)
133
71
    out = []
134
72
    if topic == 'hidden-commands':
135
73
        hidden = True
136
74
    else:
137
75
        hidden = False
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)
 
76
    names = list(_mod_commands.all_command_names())
 
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
141
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
79
    max_name = max(len(n) for n, o in shown_commands)
143
80
    indent = ' ' * (max_name + 1)
156
93
        else:
157
94
            firstline = ''
158
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
160
 
                              width=width)
 
96
        lines = textwrap.wrap(
 
97
            helpstring, subsequent_indent=indent,
 
98
            width=width,
 
99
            break_long_words=False)
161
100
        for line in lines:
162
101
            out.append(line + '\n')
163
102
    return ''.join(out)
165
104
 
166
105
help_topics.topic_registry.register("commands",
167
106
                                    _help_commands_to_text,
168
 
                                    "Basic help for all commands")
169
 
help_topics.topic_registry.register("hidden-commands", 
 
107
                                    "Basic help for all commands",
 
108
                                    help_topics.SECT_HIDDEN)
 
109
help_topics.topic_registry.register("hidden-commands",
170
110
                                    _help_commands_to_text,
171
 
                                    "All hidden commands")
 
111
                                    "All hidden commands",
 
112
                                    help_topics.SECT_HIDDEN)
 
113
 
 
114
 
 
115
class HelpIndices(object):
 
116
    """Maintainer of help topics across multiple indices.
 
117
 
 
118
    It is currently separate to the HelpTopicRegistry because of its ordered
 
119
    nature, but possibly we should instead structure it as a search within the
 
120
    registry and add ordering and searching facilities to the registry. The
 
121
    registry would probably need to be restructured to support that cleanly
 
122
    which is why this has been implemented in parallel even though it does as a
 
123
    result permit searching for help in indices which are not discoverable via
 
124
    'help topics'.
 
125
 
 
126
    Each index has a unique prefix string, such as "commands", and contains
 
127
    help topics which can be listed or searched.
 
128
    """
 
129
 
 
130
    def __init__(self):
 
131
        self.search_path = [
 
132
            help_topics.HelpTopicIndex(),
 
133
            _mod_commands.HelpCommandIndex(),
 
134
            plugin.PluginsHelpIndex(),
 
135
            ]
 
136
 
 
137
    def _check_prefix_uniqueness(self):
 
138
        """Ensure that the index collection is able to differentiate safely."""
 
139
        prefixes = {}
 
140
        for index in self.search_path:
 
141
            prefixes.setdefault(index.prefix, []).append(index)
 
142
        for prefix, indices in prefixes.items():
 
143
            if len(indices) > 1:
 
144
                raise errors.DuplicateHelpPrefix(prefix)
 
145
 
 
146
    def search(self, topic):
 
147
        """Search for topic across the help search path.
 
148
 
 
149
        :param topic: A string naming the help topic to search for.
 
150
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
151
        :return: A list of HelpTopics which matched 'topic'.
 
152
        """
 
153
        self._check_prefix_uniqueness()
 
154
        result = []
 
155
        for index in self.search_path:
 
156
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
157
        if not result:
 
158
            raise errors.NoHelpTopic(topic)
 
159
        else:
 
160
            return result