/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: Vincent Ladeuil
  • Date: 2007-11-24 14:20:59 UTC
  • mto: (3928.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3929.
  • Revision ID: v.ladeuil+lp@free.fr-20071124142059-2114qtsgfdv8g9p1
Ssl files needed for the test https server.

* bzrlib/tests/ssl_certs/create_ssls.py: 
Script to create the ssl keys and certificates.

* bzrlib/tests/ssl_certs/server.crt: 
Server certificate signed by the certificate authority.

* bzrlib/tests/ssl_certs/server.csr: 
Server certificate signing request.

* bzrlib/tests/ssl_certs/server_without_pass.key: 
Server key usable without password.

* bzrlib/tests/ssl_certs/server_with_pass.key: 
Server key.

* bzrlib/tests/ssl_certs/ca.key: 
Certificate authority private key.

* bzrlib/tests/ssl_certs/ca.crt: 
Certificate authority certificate.

* bzrlib/tests/ssl_certs/__init__.py: 
Provide access to ssl files (keys and certificates). 

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
2
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
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
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
# TODO: Some way to get a list of external commands (defined by shell
20
18
# scripts) so that they can be included in the help listing as well.
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
24
import sys
 
25
import textwrap
27
26
 
28
 
from . import (
 
27
from bzrlib import (
29
28
    commands as _mod_commands,
30
29
    errors,
31
30
    help_topics,
32
31
    osutils,
33
32
    plugin,
34
 
    ui,
35
 
    utextwrap,
 
33
    symbol_versioning,
36
34
    )
37
35
 
38
36
 
39
 
class NoHelpTopic(errors.BzrError):
40
 
 
41
 
    _fmt = ("No help could be found for '%(topic)s'. "
42
 
        "Please use 'brz help topics' to obtain a list of topics.")
43
 
 
44
 
    def __init__(self, topic):
45
 
        self.topic = topic
46
 
 
47
 
 
48
37
def help(topic=None, outfile=None):
49
38
    """Write the help for the specific topic to outfile"""
50
39
    if outfile is None:
51
 
        outfile = ui.ui_factory.make_output_stream()
 
40
        outfile = sys.stdout
52
41
 
53
42
    indices = HelpIndices()
54
43
 
56
45
    try:
57
46
        topics = indices.search(topic)
58
47
        shadowed_terms = []
59
 
        for index, topic_obj in topics[1:]:
 
48
        for index, topic in topics[1:]:
60
49
            shadowed_terms.append('%s%s' % (index.prefix,
61
 
                topic_obj.get_help_topic()))
62
 
        source = topics[0][1]
63
 
        outfile.write(source.get_help_text(shadowed_terms))
64
 
    except NoHelpTopic:
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
52
    except errors.NoHelpTopic:
65
53
        if alias is None:
66
54
            raise
67
55
 
68
56
    if alias is not None:
69
 
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
70
58
            " ".join(alias)))
71
59
 
72
60
 
73
61
def help_commands(outfile=None):
74
62
    """List all commands"""
75
63
    if outfile is None:
76
 
        outfile = ui.ui_factory.make_output_stream()
 
64
        outfile = sys.stdout
77
65
    outfile.write(_help_commands_to_text('commands'))
78
66
 
79
67
 
 
68
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
69
def command_usage(cmd):
 
70
    return cmd._usage()
 
71
 
 
72
 
80
73
def _help_commands_to_text(topic):
81
74
    """Generate the help text for the list of commands"""
82
75
    out = []
84
77
        hidden = True
85
78
    else:
86
79
        hidden = False
87
 
    names = list(_mod_commands.all_command_names())
 
80
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
81
    names.update(_mod_commands.plugin_command_names())
88
82
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
89
83
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
90
84
    max_name = max(len(n) for n, o in shown_commands)
91
85
    indent = ' ' * (max_name + 1)
92
 
    width = osutils.terminal_width()
93
 
    if width is None:
94
 
        width = osutils.default_terminal_width
95
 
    # we need one extra space for terminals that wrap on last char
96
 
    width = width - 1
 
86
    width = osutils.terminal_width() - 1
97
87
 
98
88
    for cmd_name, cmd_object in sorted(shown_commands):
99
89
        plugin_name = cmd_object.plugin_name()
108
98
        else:
109
99
            firstline = ''
110
100
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
111
 
        lines = utextwrap.wrap(
112
 
            helpstring, subsequent_indent=indent,
113
 
            width=width,
114
 
            break_long_words=False)
 
101
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
102
                              width=width)
115
103
        for line in lines:
116
104
            out.append(line + '\n')
117
105
    return ''.join(out)
129
117
 
130
118
class HelpIndices(object):
131
119
    """Maintainer of help topics across multiple indices.
132
 
 
 
120
    
133
121
    It is currently separate to the HelpTopicRegistry because of its ordered
134
122
    nature, but possibly we should instead structure it as a search within the
135
123
    registry and add ordering and searching facilities to the registry. The
147
135
            help_topics.HelpTopicIndex(),
148
136
            _mod_commands.HelpCommandIndex(),
149
137
            plugin.PluginsHelpIndex(),
150
 
            help_topics.ConfigOptionHelpIndex(),
151
138
            ]
152
139
 
153
140
    def _check_prefix_uniqueness(self):
154
141
        """Ensure that the index collection is able to differentiate safely."""
155
 
        prefixes = set()
 
142
        prefixes = {}
156
143
        for index in self.search_path:
157
 
            prefix = index.prefix
158
 
            if prefix in prefixes:
 
144
            prefixes.setdefault(index.prefix, []).append(index)
 
145
        for prefix, indices in prefixes.items():
 
146
            if len(indices) > 1:
159
147
                raise errors.DuplicateHelpPrefix(prefix)
160
 
            prefixes.add(prefix)
161
148
 
162
149
    def search(self, topic):
163
150
        """Search for topic across the help search path.
164
 
 
 
151
        
165
152
        :param topic: A string naming the help topic to search for.
166
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
167
154
        :return: A list of HelpTopics which matched 'topic'.
171
158
        for index in self.search_path:
172
159
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
173
160
        if not result:
174
 
            raise NoHelpTopic(topic)
 
161
            raise errors.NoHelpTopic(topic)
175
162
        else:
176
163
            return result