← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2011 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., 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.
20
20
# executable files with reasonable names.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
 
import textwrap
24
 
 
25
 
global_help = \
26
 
"""Bazaar-NG -- a free distributed version-control tool
27
 
http://bazaar-vcs.org/
28
 
 
29
 
Basic commands:
30
 
 
31
 
  bzr init           makes this directory a versioned branch
32
 
  bzr branch         make a copy of another branch
33
 
 
34
 
  bzr add            make files or directories versioned
35
 
  bzr ignore         ignore a file or pattern
36
 
  bzr mv             move or rename a versioned file
37
 
 
38
 
  bzr status         summarize changes in working copy
39
 
  bzr diff           show detailed diffs
40
 
 
41
 
  bzr merge          pull in changes from another branch
42
 
  bzr commit         save some or all changes
43
 
 
44
 
  bzr log            show history of changes
45
 
  bzr check          validate storage
46
 
 
47
 
  bzr help init      more help on e.g. init command
48
 
  bzr help commands  list all commands
49
 
"""
50
 
 
51
23
 
52
24
import sys
53
25
 
54
 
 
55
 
def help(topic=None, outfile = None):
56
 
    if outfile == None:
57
 
        outfile = sys.stdout
58
 
    if topic == None:
59
 
        outfile.write(global_help)
60
 
    elif topic == 'commands':
61
 
        help_commands(outfile = outfile)
62
 
    else:
63
 
        help_on_command(topic, outfile = outfile)
64
 
 
65
 
 
66
 
def command_usage(cmd_object):
67
 
    """Return single-line grammar for command.
68
 
 
69
 
    Only describes arguments, not options.
70
 
    """
71
 
    s = 'bzr ' + cmd_object.name() + ' '
72
 
    for aname in cmd_object.takes_args:
73
 
        aname = aname.upper()
74
 
        if aname[-1] in ['$', '+']:
75
 
            aname = aname[:-1] + '...'
76
 
        elif aname[-1] == '?':
77
 
            aname = '[' + aname[:-1] + ']'
78
 
        elif aname[-1] == '*':
79
 
            aname = '[' + aname[:-1] + '...]'
80
 
        s += aname + ' '
81
 
            
82
 
    assert s[-1] == ' '
83
 
    s = s[:-1]
84
 
    
85
 
    return s
86
 
 
87
 
 
88
 
def help_on_command(cmdname, outfile=None):
89
 
    from bzrlib.commands import get_cmd_object
90
 
 
91
 
    cmdname = str(cmdname)
92
 
 
93
 
    if outfile == None:
94
 
        outfile = sys.stdout
95
 
 
96
 
    cmd_object = get_cmd_object(cmdname)
97
 
 
98
 
    doc = cmd_object.help()
99
 
    if doc == None:
100
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
101
 
 
102
 
    print >>outfile, 'usage:', command_usage(cmd_object) 
103
 
 
104
 
    if cmd_object.aliases:
105
 
        print >>outfile, 'aliases:',
106
 
        print >>outfile, ', '.join(cmd_object.aliases)
107
 
 
108
 
    print >>outfile
109
 
 
110
 
    outfile.write(doc)
111
 
    if doc[-1] != '\n':
112
 
        outfile.write('\n')
113
 
    help_on_command_options(cmd_object, outfile)
114
 
 
115
 
 
116
 
def help_on_command_options(cmd, outfile=None):
117
 
    from bzrlib.option import Option
118
 
    options = cmd.options()
119
 
    if not options:
120
 
        return
121
 
    if outfile == None:
122
 
        outfile = sys.stdout
123
 
    outfile.write('\noptions:\n')
124
 
    for option_name, option in sorted(options.items()):
125
 
        l = '    --' + option_name
126
 
        if option.type is not None:
127
 
            l += ' ' + option.argname.upper()
128
 
        short_name = option.short_name()
129
 
        if short_name:
130
 
            assert len(short_name) == 1
131
 
            l += ', -' + short_name
132
 
        l += (30 - len(l)) * ' ' + option.help
133
 
        # TODO: split help over multiple lines with correct indenting and 
134
 
        # wrapping
135
 
        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
136
 
        outfile.write(wrapped + '\n')
 
26
from bzrlib import (
 
27
    commands as _mod_commands,
 
28
    errors,
 
29
    help_topics,
 
30
    osutils,
 
31
    plugin,
 
32
    utextwrap,
 
33
    )
 
34
 
 
35
 
 
36
def help(topic=None, outfile=None):
 
37
    """Write the help for the specific topic to outfile"""
 
38
    if outfile is None:
 
39
        outfile = sys.stdout
 
40
 
 
41
    indices = HelpIndices()
 
42
 
 
43
    alias = _mod_commands.get_alias(topic)
 
44
    try:
 
45
        topics = indices.search(topic)
 
46
        shadowed_terms = []
 
47
        for index, topic_obj in topics[1:]:
 
48
            shadowed_terms.append('%s%s' % (index.prefix,
 
49
                topic_obj.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)))
137
59
 
138
60
 
139
61
def help_commands(outfile=None):
140
62
    """List all commands"""
141
 
    from bzrlib.commands import (builtin_command_names,
142
 
                                 plugin_command_names,
143
 
                                 get_cmd_object)
144
 
 
145
 
    if outfile == None:
 
63
    if outfile is None:
146
64
        outfile = sys.stdout
147
 
 
148
 
    names = set()                       # to eliminate duplicates
149
 
    names.update(builtin_command_names())
150
 
    names.update(plugin_command_names())
151
 
    names = list(names)
152
 
    names.sort()
153
 
 
154
 
    for cmd_name in names:
155
 
        cmd_object = get_cmd_object(cmd_name)
156
 
        if cmd_object.hidden:
157
 
            continue
158
 
        print >>outfile, command_usage(cmd_object)
 
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 = list(_mod_commands.all_command_names())
 
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
78
    max_name = max(len(n) for n, o in shown_commands)
 
79
    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
 
85
 
 
86
    for cmd_name, cmd_object in sorted(shown_commands):
 
87
        plugin_name = cmd_object.plugin_name()
 
88
        if plugin_name is None:
 
89
            plugin_name = ''
 
90
        else:
 
91
            plugin_name = ' [%s]' % plugin_name
 
92
 
159
93
        cmd_help = cmd_object.help()
160
94
        if cmd_help:
161
95
            firstline = cmd_help.split('\n', 1)[0]
162
 
            print >>outfile, '        ' + firstline
163
 
        
 
96
        else:
 
97
            firstline = ''
 
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
99
        lines = utextwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
 
103
        for line in lines:
 
104
            out.append(line + '\n')
 
105
    return ''.join(out)
 
106
 
 
107
 
 
108
help_topics.topic_registry.register("commands",
 
109
                                    _help_commands_to_text,
 
110
                                    "Basic help for all commands",
 
111
                                    help_topics.SECT_HIDDEN)
 
112
help_topics.topic_registry.register("hidden-commands",
 
113
                                    _help_commands_to_text,
 
114
                                    "All hidden commands",
 
115
                                    help_topics.SECT_HIDDEN)
 
116
 
 
117
 
 
118
class HelpIndices(object):
 
119
    """Maintainer of help topics across multiple indices.
 
120
 
 
121
    It is currently separate to the HelpTopicRegistry because of its ordered
 
122
    nature, but possibly we should instead structure it as a search within the
 
123
    registry and add ordering and searching facilities to the registry. The
 
124
    registry would probably need to be restructured to support that cleanly
 
125
    which is why this has been implemented in parallel even though it does as a
 
126
    result permit searching for help in indices which are not discoverable via
 
127
    'help topics'.
 
128
 
 
129
    Each index has a unique prefix string, such as "commands", and contains
 
130
    help topics which can be listed or searched.
 
131
    """
 
132
 
 
133
    def __init__(self):
 
134
        self.search_path = [
 
135
            help_topics.HelpTopicIndex(),
 
136
            _mod_commands.HelpCommandIndex(),
 
137
            plugin.PluginsHelpIndex(),
 
138
            help_topics.ConfigOptionHelpIndex(),
 
139
            ]
 
140
 
 
141
    def _check_prefix_uniqueness(self):
 
142
        """Ensure that the index collection is able to differentiate safely."""
 
143
        prefixes = {}
 
144
        for index in self.search_path:
 
145
            prefixes.setdefault(index.prefix, []).append(index)
 
146
        for prefix, indices in prefixes.items():
 
147
            if len(indices) > 1:
 
148
                raise errors.DuplicateHelpPrefix(prefix)
 
149
 
 
150
    def search(self, topic):
 
151
        """Search for topic across the help search path.
 
152
 
 
153
        :param topic: A string naming the help topic to search for.
 
154
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
155
        :return: A list of HelpTopics which matched 'topic'.
 
156
        """
 
157
        self._check_prefix_uniqueness()
 
158
        result = []
 
159
        for index in self.search_path:
 
160
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
161
        if not result:
 
162
            raise errors.NoHelpTopic(topic)
 
163
        else:
 
164
            return result