/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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