← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2005-10-18 07:38:53 UTC
  • mfrom: (0.2.1)
  • mto: This revision was merged to the branch mainline in revision 1463.
  • Revision ID: robertc@robertcollins.net-20051018073853-1206e813d89ba440
config.Config has a 'get_user_option' call that accepts an option name.

This will be looked up in branches.conf and bazaar.conf as normal.
It is intended that this be used by plugins to support options - 
options of built in programs should have specific methods on the config.
(Robert Collins)

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
 
 
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)))
 
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
    help_on_command_options(cmd_object, outfile=None)
 
116
 
 
117
 
 
118
def help_on_command_options(cmd, outfile=None):
 
119
    from bzrlib.option import Option
 
120
    options = cmd.options()
 
121
    if not options:
 
122
        return
 
123
    if outfile == None:
 
124
        outfile = sys.stdout
 
125
    outfile.write('\noptions:\n')
 
126
    for option_name, option in sorted(options.items()):
 
127
        l = '    --' + option_name
 
128
        if option.type is not None:
 
129
            l += ' ' + option.argname.upper()
 
130
        short_name = option.short_name()
 
131
        if short_name:
 
132
            assert len(short_name) == 1
 
133
            l += ', -' + shortname
 
134
        l += (30 - len(l)) * ' ' + option.help
 
135
        # TODO: split help over multiple lines with correct indenting and 
 
136
        # wrapping
 
137
        outfile.write(l + '\n')
59
138
 
60
139
 
61
140
def help_commands(outfile=None):
62
141
    """List all commands"""
63
 
    if outfile is None:
 
142
    from bzrlib.commands import (builtin_command_names,
 
143
                                 plugin_command_names,
 
144
                                 get_cmd_object)
 
145
 
 
146
    if outfile == None:
64
147
        outfile = sys.stdout
65
 
    outfile.write(_help_commands_to_text('commands'))
66
 
 
67
 
 
68
 
def _help_commands_to_text(topic):
69
 
    """Generate the help text for the list of commands"""
70
 
    out = []
71
 
    if topic == 'hidden-commands':
72
 
        hidden = True
73
 
    else:
74
 
        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)
78
 
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
79
 
    max_name = max(len(n) for n, o in shown_commands)
80
 
    indent = ' ' * (max_name + 1)
81
 
    width = osutils.terminal_width() - 1
82
 
 
83
 
    for cmd_name, cmd_object in sorted(shown_commands):
84
 
        plugin_name = cmd_object.plugin_name()
85
 
        if plugin_name is None:
86
 
            plugin_name = ''
87
 
        else:
88
 
            plugin_name = ' [%s]' % plugin_name
89
 
 
 
148
 
 
149
    names = set()                       # to eliminate duplicates
 
150
    names.update(builtin_command_names())
 
151
    names.update(plugin_command_names())
 
152
    names = list(names)
 
153
    names.sort()
 
154
 
 
155
    for cmd_name in names:
 
156
        cmd_object = get_cmd_object(cmd_name)
 
157
        if cmd_object.hidden:
 
158
            continue
 
159
        print >>outfile, command_usage(cmd_object)
90
160
        cmd_help = cmd_object.help()
91
161
        if cmd_help:
92
162
            firstline = cmd_help.split('\n', 1)[0]
93
 
        else:
94
 
            firstline = ''
95
 
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
96
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
97
 
                              width=width)
98
 
        for line in lines:
99
 
            out.append(line + '\n')
100
 
    return ''.join(out)
101
 
 
102
 
 
103
 
help_topics.topic_registry.register("commands",
104
 
                                    _help_commands_to_text,
105
 
                                    "Basic help for all commands",
106
 
                                    help_topics.SECT_HIDDEN)
107
 
help_topics.topic_registry.register("hidden-commands",
108
 
                                    _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.
 
163
            print >>outfile, '    ' + firstline
146
164
        
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