← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2005-08-30 04:47:42 UTC
  • Revision ID: mbp@sourcefrog.net-20050830044742-0437d5b674f9ccaf
- change conflict markers to suit smerge, etc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
18
 
 
19
 
# TODO: Some way to get a list of external commands (defined by shell
20
 
# scripts) so that they can be included in the help listing as well.
21
 
# It should be enough to just list the plugin directory and look for
22
 
# executable files with reasonable names.
23
 
 
24
 
# TODO: `help commands --all` should show hidden commands
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
global_help = \
 
18
"""Bazaar-NG -- a free distributed version-control tool
 
19
http://bazaar-ng.org/
 
20
 
 
21
WARNING: This is an unstable development version.
 
22
         Please keep backups.
 
23
 
 
24
Basic commands:
 
25
 
 
26
  bzr init      makes this branch versioned
 
27
  bzr branch    make a copy of another branch
 
28
 
 
29
  bzr add       make files or directories versioned
 
30
  bzr ignore    ignore a file or pattern
 
31
  bzr mv        move or rename a versioned file
 
32
 
 
33
  bzr status    summarize changes in working copy
 
34
  bzr diff      show detailed diffs
 
35
 
 
36
  bzr merge     pull in changes from another branch
 
37
  bzr commit    
 
38
 
 
39
  bzr log       show history of changes
 
40
  bzr check     validate storage
 
41
 
 
42
Use e.g. 'bzr help init' for more details, or
 
43
'bzr help commands' for all commands.
 
44
"""
 
45
 
25
46
 
26
47
import sys
27
48
 
28
 
from bzrlib import (
29
 
    commands as _mod_commands,
30
 
    errors,
31
 
    help_topics,
32
 
    osutils,
33
 
    plugin,
34
 
    utextwrap,
35
 
    )
36
 
 
37
 
 
38
 
def help(topic=None, outfile=None):
39
 
    """Write the help for the specific topic to outfile"""
40
 
    if outfile is None:
41
 
        outfile = sys.stdout
42
 
 
43
 
    indices = HelpIndices()
44
 
 
45
 
    alias = _mod_commands.get_alias(topic)
46
 
    try:
47
 
        topics = indices.search(topic)
48
 
        shadowed_terms = []
49
 
        for index, topic_obj in topics[1:]:
50
 
            shadowed_terms.append('%s%s' % (index.prefix,
51
 
                topic_obj.get_help_topic()))
52
 
        source = topics[0][1]
53
 
        outfile.write(source.get_help_text(shadowed_terms))
54
 
    except errors.NoHelpTopic:
55
 
        if alias is None:
56
 
            raise
57
 
 
58
 
    if alias is not None:
59
 
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
60
 
            " ".join(alias)))
61
 
 
62
 
 
63
 
def help_commands(outfile=None):
64
 
    """List all commands"""
65
 
    if outfile is None:
66
 
        outfile = sys.stdout
67
 
    outfile.write(_help_commands_to_text('commands'))
68
 
 
69
 
 
70
 
def _help_commands_to_text(topic):
71
 
    """Generate the help text for the list of commands"""
72
 
    out = []
73
 
    if topic == 'hidden-commands':
74
 
        hidden = True
 
49
 
 
50
def help(topic=None, outfile = None):
 
51
    if outfile == None:
 
52
        outfile = sys.stdout
 
53
    if topic == None:
 
54
        outfile.write(global_help)
 
55
    elif topic == 'commands':
 
56
        help_commands(outfile = outfile)
75
57
    else:
76
 
        hidden = False
77
 
    names = list(_mod_commands.all_command_names())
78
 
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
79
 
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
80
 
    max_name = max(len(n) for n, o in shown_commands)
81
 
    indent = ' ' * (max_name + 1)
82
 
    width = osutils.terminal_width()
83
 
    if width is None:
84
 
        width = osutils.default_terminal_width
85
 
    # we need one extra space for terminals that wrap on last char
86
 
    width = width - 1
87
 
 
88
 
    for cmd_name, cmd_object in sorted(shown_commands):
89
 
        plugin_name = cmd_object.plugin_name()
90
 
        if plugin_name is None:
91
 
            plugin_name = ''
92
 
        else:
93
 
            plugin_name = ' [%s]' % plugin_name
94
 
 
95
 
        cmd_help = cmd_object.help()
96
 
        if cmd_help:
97
 
            firstline = cmd_help.split('\n', 1)[0]
98
 
        else:
99
 
            firstline = ''
100
 
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
101
 
        lines = utextwrap.wrap(
102
 
            helpstring, subsequent_indent=indent,
103
 
            width=width,
104
 
            break_long_words=False)
105
 
        for line in lines:
106
 
            out.append(line + '\n')
107
 
    return ''.join(out)
108
 
 
109
 
 
110
 
help_topics.topic_registry.register("commands",
111
 
                                    _help_commands_to_text,
112
 
                                    "Basic help for all commands",
113
 
                                    help_topics.SECT_HIDDEN)
114
 
help_topics.topic_registry.register("hidden-commands",
115
 
                                    _help_commands_to_text,
116
 
                                    "All hidden commands",
117
 
                                    help_topics.SECT_HIDDEN)
118
 
 
119
 
 
120
 
class HelpIndices(object):
121
 
    """Maintainer of help topics across multiple indices.
122
 
 
123
 
    It is currently separate to the HelpTopicRegistry because of its ordered
124
 
    nature, but possibly we should instead structure it as a search within the
125
 
    registry and add ordering and searching facilities to the registry. The
126
 
    registry would probably need to be restructured to support that cleanly
127
 
    which is why this has been implemented in parallel even though it does as a
128
 
    result permit searching for help in indices which are not discoverable via
129
 
    'help topics'.
130
 
 
131
 
    Each index has a unique prefix string, such as "commands", and contains
132
 
    help topics which can be listed or searched.
 
58
        help_on_command(topic, outfile = outfile)
 
59
 
 
60
 
 
61
def command_usage(cmdname, cmdclass):
 
62
    """Return single-line grammar for command.
 
63
 
 
64
    Only describes arguments, not options.
133
65
    """
134
 
 
135
 
    def __init__(self):
136
 
        self.search_path = [
137
 
            help_topics.HelpTopicIndex(),
138
 
            _mod_commands.HelpCommandIndex(),
139
 
            plugin.PluginsHelpIndex(),
140
 
            help_topics.ConfigOptionHelpIndex(),
141
 
            ]
142
 
 
143
 
    def _check_prefix_uniqueness(self):
144
 
        """Ensure that the index collection is able to differentiate safely."""
145
 
        prefixes = {}
146
 
        for index in self.search_path:
147
 
            prefixes.setdefault(index.prefix, []).append(index)
148
 
        for prefix, indices in prefixes.items():
149
 
            if len(indices) > 1:
150
 
                raise errors.DuplicateHelpPrefix(prefix)
151
 
 
152
 
    def search(self, topic):
153
 
        """Search for topic across the help search path.
154
 
 
155
 
        :param topic: A string naming the help topic to search for.
156
 
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
157
 
        :return: A list of HelpTopics which matched 'topic'.
158
 
        """
159
 
        self._check_prefix_uniqueness()
160
 
        result = []
161
 
        for index in self.search_path:
162
 
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
163
 
        if not result:
164
 
            raise errors.NoHelpTopic(topic)
165
 
        else:
166
 
            return result
 
66
    s = cmdname + ' '
 
67
    for aname in cmdclass.takes_args:
 
68
        aname = aname.upper()
 
69
        if aname[-1] in ['$', '+']:
 
70
            aname = aname[:-1] + '...'
 
71
        elif aname[-1] == '?':
 
72
            aname = '[' + aname[:-1] + ']'
 
73
        elif aname[-1] == '*':
 
74
            aname = '[' + aname[:-1] + '...]'
 
75
        s += aname + ' '
 
76
            
 
77
    assert s[-1] == ' '
 
78
    s = s[:-1]
 
79
    
 
80
    return s
 
81
 
 
82
 
 
83
def help_on_command(cmdname, outfile = None):
 
84
    cmdname = str(cmdname)
 
85
 
 
86
    if outfile == None:
 
87
        outfile = sys.stdout
 
88
 
 
89
    from inspect import getdoc
 
90
    import commands
 
91
    topic, cmdclass = commands.get_cmd_class(cmdname)
 
92
 
 
93
    doc = getdoc(cmdclass)
 
94
    if doc == None:
 
95
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
96
 
 
97
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
 
98
 
 
99
    if cmdclass.aliases:
 
100
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
 
101
    
 
102
    outfile.write(doc)
 
103
    if doc[-1] != '\n':
 
104
        outfile.write('\n')
 
105
    
 
106
    help_on_option(cmdclass.takes_options, outfile = None)
 
107
 
 
108
 
 
109
def help_on_option(options, outfile = None):
 
110
    import commands
 
111
    
 
112
    if not options:
 
113
        return
 
114
    
 
115
    if outfile == None:
 
116
        outfile = sys.stdout
 
117
 
 
118
    outfile.write('\noptions:\n')
 
119
    for on in options:
 
120
        l = '    --' + on
 
121
        for shortname, longname in commands.SHORT_OPTIONS.items():
 
122
            if longname == on:
 
123
                l += ', -' + shortname
 
124
                break
 
125
        outfile.write(l + '\n')
 
126
 
 
127
 
 
128
def help_commands(outfile = None):
 
129
    """List all commands"""
 
130
    import inspect
 
131
    import commands
 
132
 
 
133
    if outfile == None:
 
134
        outfile = sys.stdout
 
135
    
 
136
    accu = []
 
137
    for cmdname, cmdclass in commands.get_all_cmds():
 
138
        accu.append((cmdname, cmdclass))
 
139
    accu.sort()
 
140
    for cmdname, cmdclass in accu:
 
141
        if cmdclass.hidden:
 
142
            continue
 
143
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
 
144
        help = inspect.getdoc(cmdclass)
 
145
        if help:
 
146
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
 
147
 
 
148
            
 
149