← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Ian Clatworthy
  • Date: 2007-06-06 05:56:03 UTC
  • mto: This revision was merged to the branch mainline in revision 2513.
  • Revision ID: ian.clatworthy@internode.on.net-20070606055603-monl116zotkbqn2y
commit.py clean-up including logging just to stderr, not bzr.log

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2010 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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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.
30
30
    help_topics,
31
31
    osutils,
32
32
    plugin,
 
33
    symbol_versioning,
33
34
    )
34
35
 
35
36
 
39
40
        outfile = sys.stdout
40
41
 
41
42
    indices = HelpIndices()
42
 
 
43
 
    alias = _mod_commands.get_alias(topic)
44
 
    try:
45
 
        topics = indices.search(topic)
46
 
        shadowed_terms = []
47
 
        for index, topic in topics[1:]:
48
 
            shadowed_terms.append('%s%s' % (index.prefix,
49
 
                topic.get_help_topic()))
50
 
        source = topics[0][1]
51
 
        outfile.write(source.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)))
 
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))
59
48
 
60
49
 
61
50
def help_commands(outfile=None):
65
54
    outfile.write(_help_commands_to_text('commands'))
66
55
 
67
56
 
 
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
58
def command_usage(cmd):
 
59
    return cmd._usage()
 
60
 
 
61
 
68
62
def _help_commands_to_text(topic):
69
63
    """Generate the help text for the list of commands"""
70
64
    out = []
72
66
        hidden = True
73
67
    else:
74
68
        hidden = False
75
 
    names = list(_mod_commands.all_command_names())
 
69
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
70
    names.update(_mod_commands.plugin_command_names())
76
71
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
77
72
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
78
73
    max_name = max(len(n) for n, o in shown_commands)
79
74
    indent = ' ' * (max_name + 1)
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
 
75
    width = osutils.terminal_width() - 1
85
76
 
86
77
    for cmd_name, cmd_object in sorted(shown_commands):
87
78
        plugin_name = cmd_object.plugin_name()
96
87
        else:
97
88
            firstline = ''
98
89
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
99
 
        lines = textwrap.wrap(
100
 
            helpstring, subsequent_indent=indent,
101
 
            width=width,
102
 
            break_long_words=False)
 
90
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
91
                              width=width)
103
92
        for line in lines:
104
93
            out.append(line + '\n')
105
94
    return ''.join(out)
107
96
 
108
97
help_topics.topic_registry.register("commands",
109
98
                                    _help_commands_to_text,
110
 
                                    "Basic help for all commands",
111
 
                                    help_topics.SECT_HIDDEN)
 
99
                                    "Basic help for all commands")
112
100
help_topics.topic_registry.register("hidden-commands",
113
101
                                    _help_commands_to_text,
114
 
                                    "All hidden commands",
115
 
                                    help_topics.SECT_HIDDEN)
 
102
                                    "All hidden commands")
116
103
 
117
104
 
118
105
class HelpIndices(object):
119
106
    """Maintainer of help topics across multiple indices.
120
 
 
 
107
    
121
108
    It is currently separate to the HelpTopicRegistry because of its ordered
122
109
    nature, but possibly we should instead structure it as a search within the
123
110
    registry and add ordering and searching facilities to the registry. The
148
135
 
149
136
    def search(self, topic):
150
137
        """Search for topic across the help search path.
151
 
 
 
138
        
152
139
        :param topic: A string naming the help topic to search for.
153
140
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
141
        :return: A list of HelpTopics which matched 'topic'.