← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: abentley
  • Date: 2005-10-14 03:50:50 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@lappy-20051014035050-d779472ccb599a51
semi-broke merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
23
 
 
24
global_help = \
 
25
"""Bazaar-NG -- a free distributed version-control tool
 
26
http://bazaar-ng.org/
 
27
 
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
 
30
 
 
31
Basic commands:
 
32
 
 
33
  bzr init           makes this directory a versioned branch
 
34
  bzr branch         make a copy of another branch
 
35
 
 
36
  bzr add            make files or directories versioned
 
37
  bzr ignore         ignore a file or pattern
 
38
  bzr mv             move or rename a versioned file
 
39
 
 
40
  bzr status         summarize changes in working copy
 
41
  bzr diff           show detailed diffs
 
42
 
 
43
  bzr merge          pull in changes from another branch
 
44
  bzr commit         save some or all changes
 
45
 
 
46
  bzr log            show history of changes
 
47
  bzr check          validate storage
 
48
 
 
49
  bzr help init      more help on e.g. init command
 
50
  bzr help commands  list all commands
 
51
"""
 
52
 
 
53
 
24
54
import sys
25
 
import textwrap
26
 
 
27
 
from bzrlib import (
28
 
    commands as _mod_commands,
29
 
    errors,
30
 
    help_topics,
31
 
    osutils,
32
 
    plugin,
33
 
    symbol_versioning,
34
 
    )
35
 
 
36
 
 
37
 
def help(topic=None, outfile=None):
38
 
    """Write the help for the specific topic to outfile"""
39
 
    if outfile is None:
40
 
        outfile = sys.stdout
41
 
 
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))
 
55
 
 
56
 
 
57
def help(topic=None, outfile = None):
 
58
    if outfile == None:
 
59
        outfile = sys.stdout
 
60
    if topic == None:
 
61
        outfile.write(global_help)
 
62
    elif topic == 'commands':
 
63
        help_commands(outfile = outfile)
 
64
    else:
 
65
        help_on_command(topic, outfile = outfile)
 
66
 
 
67
 
 
68
def command_usage(cmd_object):
 
69
    """Return single-line grammar for command.
 
70
 
 
71
    Only describes arguments, not options.
 
72
    """
 
73
    s = 'bzr ' + cmd_object.name() + ' '
 
74
    for aname in cmd_object.takes_args:
 
75
        aname = aname.upper()
 
76
        if aname[-1] in ['$', '+']:
 
77
            aname = aname[:-1] + '...'
 
78
        elif aname[-1] == '?':
 
79
            aname = '[' + aname[:-1] + ']'
 
80
        elif aname[-1] == '*':
 
81
            aname = '[' + aname[:-1] + '...]'
 
82
        s += aname + ' '
 
83
            
 
84
    assert s[-1] == ' '
 
85
    s = s[:-1]
 
86
    
 
87
    return s
 
88
 
 
89
 
 
90
def help_on_command(cmdname, outfile=None):
 
91
    from bzrlib.commands import get_cmd_object
 
92
 
 
93
    cmdname = str(cmdname)
 
94
 
 
95
    if outfile == None:
 
96
        outfile = sys.stdout
 
97
 
 
98
    cmd_object = get_cmd_object(cmdname)
 
99
 
 
100
    doc = cmd_object.help()
 
101
    if doc == None:
 
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
103
 
 
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
105
 
 
106
    if cmd_object.aliases:
 
107
        print >>outfile, 'aliases:',
 
108
        print >>outfile, ', '.join(cmd_object.aliases)
 
109
 
 
110
    print >>outfile
 
111
 
 
112
    outfile.write(doc)
 
113
    if doc[-1] != '\n':
 
114
        outfile.write('\n')
 
115
    
 
116
    help_on_options(cmd_object.takes_options, outfile=None)
 
117
 
 
118
 
 
119
def help_on_options(options, outfile=None):
 
120
    from bzrlib.commands import SHORT_OPTIONS
 
121
    
 
122
    if not options:
 
123
        return
 
124
    
 
125
    if outfile == None:
 
126
        outfile = sys.stdout
 
127
 
 
128
    outfile.write('\noptions:\n')
 
129
    for on in options:
 
130
        l = '    --' + on
 
131
        for shortname, longname in SHORT_OPTIONS.items():
 
132
            if longname == on:
 
133
                l += ', -' + shortname
 
134
                break
 
135
        outfile.write(l + '\n')
48
136
 
49
137
 
50
138
def help_commands(outfile=None):
51
139
    """List all commands"""
52
 
    if outfile is None:
 
140
    from bzrlib.commands import (builtin_command_names,
 
141
                                 plugin_command_names,
 
142
                                 get_cmd_object)
 
143
 
 
144
    if outfile == None:
53
145
        outfile = sys.stdout
54
 
    outfile.write(_help_commands_to_text('commands'))
55
 
 
56
 
 
57
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
 
def command_usage(cmd):
59
 
    return cmd._usage()
60
 
 
61
 
 
62
 
def _help_commands_to_text(topic):
63
 
    """Generate the help text for the list of commands"""
64
 
    out = []
65
 
    if topic == 'hidden-commands':
66
 
        hidden = True
67
 
    else:
68
 
        hidden = False
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)
72
 
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
73
 
    max_name = max(len(n) for n, o in shown_commands)
74
 
    indent = ' ' * (max_name + 1)
75
 
    width = osutils.terminal_width() - 1
76
 
 
77
 
    for cmd_name, cmd_object in sorted(shown_commands):
78
 
        plugin_name = cmd_object.plugin_name()
79
 
        if plugin_name is None:
80
 
            plugin_name = ''
81
 
        else:
82
 
            plugin_name = ' [%s]' % plugin_name
83
 
 
 
146
 
 
147
    names = set()                       # to eliminate duplicates
 
148
    names.update(builtin_command_names())
 
149
    names.update(plugin_command_names())
 
150
    names = list(names)
 
151
    names.sort()
 
152
 
 
153
    for cmd_name in names:
 
154
        cmd_object = get_cmd_object(cmd_name)
 
155
        if cmd_object.hidden:
 
156
            continue
 
157
        print >>outfile, command_usage(cmd_object)
84
158
        cmd_help = cmd_object.help()
85
159
        if cmd_help:
86
160
            firstline = cmd_help.split('\n', 1)[0]
87
 
        else:
88
 
            firstline = ''
89
 
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
90
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
91
 
                              width=width)
92
 
        for line in lines:
93
 
            out.append(line + '\n')
94
 
    return ''.join(out)
95
 
 
96
 
 
97
 
help_topics.topic_registry.register("commands",
98
 
                                    _help_commands_to_text,
99
 
                                    "Basic help for all commands")
100
 
help_topics.topic_registry.register("hidden-commands",
101
 
                                    _help_commands_to_text,
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.
 
161
            print >>outfile, '    ' + firstline
138
162
        
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