← 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: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
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.
25
25
import textwrap
26
26
 
27
27
from bzrlib import (
28
 
    commands as _mod_commands,
29
 
    errors,
30
28
    help_topics,
31
29
    osutils,
32
 
    plugin,
33
 
    symbol_versioning,
34
30
    )
35
31
 
36
32
 
39
35
    if outfile is None:
40
36
        outfile = sys.stdout
41
37
 
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
 
        source = topics[0][1]
52
 
        outfile.write(source.get_help_text(shadowed_terms))
53
 
    except errors.NoHelpTopic:
54
 
        if alias is None:
55
 
            raise
56
 
 
57
 
    if alias is not None:
58
 
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
59
 
            " ".join(alias)))
 
38
    if topic is None:
 
39
        topic = 'basic'
 
40
 
 
41
    if topic in help_topics.topic_registry:
 
42
        txt = help_topics.topic_registry.get_detail(topic)
 
43
        outfile.write(txt)
 
44
    else:
 
45
        help_on_command(topic, outfile=outfile)
 
46
 
 
47
 
 
48
def command_usage(cmd_object):
 
49
    """Return single-line grammar for command.
 
50
 
 
51
    Only describes arguments, not options.
 
52
    """
 
53
    s = 'bzr ' + cmd_object.name() + ' '
 
54
    for aname in cmd_object.takes_args:
 
55
        aname = aname.upper()
 
56
        if aname[-1] in ['$', '+']:
 
57
            aname = aname[:-1] + '...'
 
58
        elif aname[-1] == '?':
 
59
            aname = '[' + aname[:-1] + ']'
 
60
        elif aname[-1] == '*':
 
61
            aname = '[' + aname[:-1] + '...]'
 
62
        s += aname + ' '
 
63
            
 
64
    assert s[-1] == ' '
 
65
    s = s[:-1]
 
66
    
 
67
    return s
 
68
 
 
69
 
 
70
def print_command_plugin(cmd_object, outfile, format):
 
71
    """Print the plugin that provides a command object, if any.
 
72
 
 
73
    If the cmd_object is provided by a plugin, prints the plugin name to
 
74
    outfile using the provided format string.
 
75
    """
 
76
    plugin_name = cmd_object.plugin_name()
 
77
    if plugin_name is not None:
 
78
        out_str = '(From plugin "%s")' % plugin_name
 
79
        outfile.write(format % out_str)
 
80
 
 
81
 
 
82
def help_on_command(cmdname, outfile=None):
 
83
    from bzrlib.commands import get_cmd_object
 
84
 
 
85
    cmdname = str(cmdname)
 
86
 
 
87
    if outfile is None:
 
88
        outfile = sys.stdout
 
89
 
 
90
    cmd_object = get_cmd_object(cmdname)
 
91
 
 
92
    doc = cmd_object.help()
 
93
    if doc is None:
 
94
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
95
 
 
96
    print >>outfile, 'usage:', command_usage(cmd_object)
 
97
 
 
98
    if cmd_object.aliases:
 
99
        print >>outfile, 'aliases:',
 
100
        print >>outfile, ', '.join(cmd_object.aliases)
 
101
 
 
102
    print >>outfile
 
103
 
 
104
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
105
 
 
106
    outfile.write(doc)
 
107
    if doc[-1] != '\n':
 
108
        outfile.write('\n')
 
109
    help_on_command_options(cmd_object, outfile)
 
110
 
 
111
 
 
112
def help_on_command_options(cmd, outfile=None):
 
113
    from bzrlib.option import Option, get_optparser
 
114
    if outfile is None:
 
115
        outfile = sys.stdout
 
116
    options = cmd.options()
 
117
    outfile.write('\n')
 
118
    outfile.write(get_optparser(options).format_option_help())
60
119
 
61
120
 
62
121
def help_commands(outfile=None):
68
127
 
69
128
def _help_commands_to_text(topic):
70
129
    """Generate the help text for the list of commands"""
 
130
    from bzrlib.commands import (builtin_command_names,
 
131
                                 plugin_command_names,
 
132
                                 get_cmd_object)
71
133
    out = []
72
134
    if topic == 'hidden-commands':
73
135
        hidden = True
74
136
    else:
75
137
        hidden = False
76
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
77
 
    names.update(_mod_commands.plugin_command_names())
78
 
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
138
    names = set(builtin_command_names()) # to eliminate duplicates
 
139
    names.update(plugin_command_names())
 
140
    commands = ((n, get_cmd_object(n)) for n in names)
79
141
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
80
142
    max_name = max(len(n) for n, o in shown_commands)
81
143
    indent = ' ' * (max_name + 1)
103
165
 
104
166
help_topics.topic_registry.register("commands",
105
167
                                    _help_commands_to_text,
106
 
                                    "Basic help for all commands",
107
 
                                    help_topics.SECT_HIDDEN)
108
 
help_topics.topic_registry.register("hidden-commands",
 
168
                                    "Basic help for all commands")
 
169
help_topics.topic_registry.register("hidden-commands", 
109
170
                                    _help_commands_to_text,
110
 
                                    "All hidden commands",
111
 
                                    help_topics.SECT_HIDDEN)
112
 
 
113
 
 
114
 
class HelpIndices(object):
115
 
    """Maintainer of help topics across multiple indices.
116
 
 
117
 
    It is currently separate to the HelpTopicRegistry because of its ordered
118
 
    nature, but possibly we should instead structure it as a search within the
119
 
    registry and add ordering and searching facilities to the registry. The
120
 
    registry would probably need to be restructured to support that cleanly
121
 
    which is why this has been implemented in parallel even though it does as a
122
 
    result permit searching for help in indices which are not discoverable via
123
 
    'help topics'.
124
 
 
125
 
    Each index has a unique prefix string, such as "commands", and contains
126
 
    help topics which can be listed or searched.
127
 
    """
128
 
 
129
 
    def __init__(self):
130
 
        self.search_path = [
131
 
            help_topics.HelpTopicIndex(),
132
 
            _mod_commands.HelpCommandIndex(),
133
 
            plugin.PluginsHelpIndex(),
134
 
            ]
135
 
 
136
 
    def _check_prefix_uniqueness(self):
137
 
        """Ensure that the index collection is able to differentiate safely."""
138
 
        prefixes = {}
139
 
        for index in self.search_path:
140
 
            prefixes.setdefault(index.prefix, []).append(index)
141
 
        for prefix, indices in prefixes.items():
142
 
            if len(indices) > 1:
143
 
                raise errors.DuplicateHelpPrefix(prefix)
144
 
 
145
 
    def search(self, topic):
146
 
        """Search for topic across the help search path.
147
 
 
148
 
        :param topic: A string naming the help topic to search for.
149
 
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
150
 
        :return: A list of HelpTopics which matched 'topic'.
151
 
        """
152
 
        self._check_prefix_uniqueness()
153
 
        result = []
154
 
        for index in self.search_path:
155
 
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
156
 
        if not result:
157
 
            raise errors.NoHelpTopic(topic)
158
 
        else:
159
 
            return result
 
171
                                    "All hidden commands")