~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Vincent Ladeuil
  • Date: 2009-01-30 00:49:41 UTC
  • mto: (3982.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3983.
  • Revision ID: v.ladeuil+lp@free.fr-20090130004941-820fpd2ryyo127vv
Add more tests, fix pycurl double handling, revert previous tracking.

* bzrlib/tests/test_http.py:
(PredefinedRequestHandler): Renamed from
PreRecordedRequestHandler.
(PredefinedRequestHandler.handle_one_request): Get the canned
response from the test server directly.
(ActivityServerMixin): Make it a true object and intialize the
attributes in the constructor. Tests can now set the
canned_response attribute before querying the server.
(TestActivity.setUp, TestActivity.tearDown,
TestActivity.get_transport, TestActivity.assertActivitiesMatch):
Extracted from test_get to be able to write other tests.
(TestActivity.test_has, TestActivity.test_readv,
TestActivity.test_post): New tests, all cases should be covered
now.

* bzrlib/transport/http/response.py:
(RangeFile.__init__, RangeFile.read, handle_response): Revert
previous tracking, both http implementations can now report
activity from the socket.

* bzrlib/transport/http/_pycurl.py:
(PyCurlTransport._get_ranged, PyCurlTransport._post): Revert
previous tracking.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2008 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
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
# TODO: probably should say which arguments are candidates for glob
 
19
# expansion on windows and do that at the command level.
17
20
 
18
21
# TODO: Define arguments by objects, rather than just using names.
19
22
# Those objects can specify the expected type of the argument, which
22
25
 
23
26
# TODO: Specific "examples" property on commands for consistent formatting.
24
27
 
 
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
 
29
# the profile output behind so it can be interactively examined?
 
30
 
25
31
import os
26
32
import sys
27
33
 
29
35
lazy_import(globals(), """
30
36
import codecs
31
37
import errno
32
 
import threading
33
38
from warnings import warn
34
39
 
35
40
import bzrlib
36
41
from bzrlib import (
37
 
    cleanup,
38
 
    cmdline,
39
42
    debug,
40
43
    errors,
41
44
    option,
42
45
    osutils,
43
46
    trace,
44
 
    ui,
45
47
    win32utils,
46
48
    )
47
49
""")
48
50
 
49
 
from bzrlib.hooks import HookPoint, Hooks
50
 
# Compatibility - Option used to be in commands.
 
51
from bzrlib import registry
 
52
# Compatibility
51
53
from bzrlib.option import Option
52
 
from bzrlib.plugin import disable_plugins, load_plugins
53
 
from bzrlib import registry
54
 
from bzrlib.symbol_versioning import (
55
 
    deprecated_function,
56
 
    deprecated_in,
57
 
    deprecated_method,
58
 
    )
59
54
 
60
55
 
61
56
class CommandInfo(object):
72
67
 
73
68
 
74
69
class CommandRegistry(registry.Registry):
75
 
    """Special registry mapping command names to command classes.
76
 
    
77
 
    :ivar overridden_registry: Look in this registry for commands being
78
 
        overridden by this registry.  This can be used to tell plugin commands
79
 
        about the builtin they're decorating.
80
 
    """
81
 
 
82
 
    def __init__(self):
83
 
        registry.Registry.__init__(self)
84
 
        self.overridden_registry = None
85
 
        # map from aliases to the real command that implements the name
86
 
        self._alias_dict = {}
87
 
 
88
 
    def get(self, command_name):
89
 
        real_name = self._alias_dict.get(command_name, command_name)
90
 
        return registry.Registry.get(self, real_name)
91
70
 
92
71
    @staticmethod
93
72
    def _get_name(command_name):
109
88
        try:
110
89
            previous = self.get(k_unsquished)
111
90
        except KeyError:
112
 
            previous = None
113
 
            if self.overridden_registry:
114
 
                try:
115
 
                    previous = self.overridden_registry.get(k_unsquished)
116
 
                except KeyError:
117
 
                    pass
 
91
            previous = _builtin_commands().get(k_unsquished)
118
92
        info = CommandInfo.from_command(cmd)
119
93
        try:
120
94
            registry.Registry.register(self, k_unsquished, cmd,
121
95
                                       override_existing=decorate, info=info)
122
96
        except KeyError:
123
 
            trace.warning('Two plugins defined the same command: %r' % k)
124
 
            trace.warning('Not loading the one in %r' %
125
 
                sys.modules[cmd.__module__])
126
 
            trace.warning('Previously this command was registered from %r' %
127
 
                sys.modules[previous.__module__])
128
 
        for a in cmd.aliases:
129
 
            self._alias_dict[a] = k_unsquished
 
97
            trace.log_error('Two plugins defined the same command: %r' % k)
 
98
            trace.log_error('Not loading the one in %r' %
 
99
                            sys.modules[cmd.__module__])
 
100
            trace.log_error('Previously this command was registered from %r' %
 
101
                            sys.modules[previous.__module__])
130
102
        return previous
131
103
 
132
104
    def register_lazy(self, command_name, aliases, module_name):
139
111
        key = self._get_name(command_name)
140
112
        registry.Registry.register_lazy(self, key, module_name, command_name,
141
113
                                        info=CommandInfo(aliases))
142
 
        for a in aliases:
143
 
            self._alias_dict[a] = key
144
114
 
145
115
 
146
116
plugin_cmds = CommandRegistry()
147
 
builtin_command_registry = CommandRegistry()
148
 
plugin_cmds.overridden_registry = builtin_command_registry
149
117
 
150
118
 
151
119
def register_command(cmd, decorate=False):
152
 
    """Register a plugin command.
153
 
 
154
 
    Should generally be avoided in favor of lazy registration. 
155
 
    """
156
120
    global plugin_cmds
157
121
    return plugin_cmds.register(cmd, decorate)
158
122
 
165
129
    return cmd[4:].replace('_','-')
166
130
 
167
131
 
168
 
@deprecated_function(deprecated_in((2, 2, 0)))
169
132
def _builtin_commands():
170
 
    """Return a dict of {name: cmd_class} for builtin commands.
171
 
 
172
 
    :deprecated: Use the builtin_command_registry registry instead
173
 
    """
174
 
    # return dict(name: cmd_class)
175
 
    return dict(builtin_command_registry.items())
176
 
 
177
 
 
178
 
def _register_builtin_commands():
179
 
    if builtin_command_registry.keys():
180
 
        # only load once
181
 
        return
182
133
    import bzrlib.builtins
183
 
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
 
        builtin_command_registry.register(cmd_class)
185
 
    bzrlib.builtins._register_lazy_builtins()
186
 
 
187
 
 
188
 
def _scan_module_for_commands(module):
189
134
    r = {}
190
 
    for name, obj in module.__dict__.iteritems():
 
135
    builtins = bzrlib.builtins.__dict__
 
136
    for name in builtins:
191
137
        if name.startswith("cmd_"):
192
138
            real_name = _unsquish_command_name(name)
193
 
            r[real_name] = obj
 
139
            r[real_name] = builtins[name]
194
140
    return r
195
 
 
196
 
 
197
 
def _list_bzr_commands(names):
198
 
    """Find commands from bzr's core and plugins.
199
 
    
200
 
    This is not the public interface, just the default hook called by all_command_names.
201
 
    """
202
 
    # to eliminate duplicates
203
 
    names.update(builtin_command_names())
204
 
    names.update(plugin_command_names())
205
 
    return names
206
 
 
207
 
 
208
 
def all_command_names():
209
 
    """Return a set of all command names."""
210
 
    names = set()
211
 
    for hook in Command.hooks['list_commands']:
212
 
        names = hook(names)
213
 
        if names is None:
214
 
            raise AssertionError(
215
 
                'hook %s returned None' % Command.hooks.get_hook_name(hook))
216
 
    return names
217
 
 
 
141
            
218
142
 
219
143
def builtin_command_names():
220
 
    """Return list of builtin command names.
 
144
    """Return list of builtin command names."""
 
145
    return _builtin_commands().keys()
221
146
    
222
 
    Use of all_command_names() is encouraged rather than builtin_command_names
223
 
    and/or plugin_command_names.
224
 
    """
225
 
    return builtin_command_registry.keys()
226
 
 
227
147
 
228
148
def plugin_command_names():
229
 
    """Returns command names from commands registered by plugins."""
230
149
    return plugin_cmds.keys()
231
150
 
232
151
 
 
152
def _get_cmd_dict(plugins_override=True):
 
153
    """Return name->class mapping for all commands."""
 
154
    d = _builtin_commands()
 
155
    if plugins_override:
 
156
        d.update(plugin_cmds.iteritems())
 
157
    return d
 
158
 
 
159
    
 
160
def get_all_cmds(plugins_override=True):
 
161
    """Return canonical name and class for all registered commands."""
 
162
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
 
163
        yield k,v
 
164
 
 
165
 
233
166
def get_cmd_object(cmd_name, plugins_override=True):
234
 
    """Return the command object for a command.
 
167
    """Return the canonical name and command class for a command.
235
168
 
236
169
    plugins_override
237
170
        If true, plugin commands can override builtins.
242
175
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
176
 
244
177
 
245
 
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
 
    """Get a command object.
 
178
def _get_cmd_object(cmd_name, plugins_override=True):
 
179
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
 
180
    from bzrlib.externalcommand import ExternalCommand
247
181
 
248
 
    :param cmd_name: The name of the command.
249
 
    :param plugins_override: Allow plugins to override builtins.
250
 
    :param check_missing: Look up commands not found in the regular index via
251
 
        the get_missing_command hook.
252
 
    :return: A Command object instance
253
 
    :raises KeyError: If no command is found.
254
 
    """
255
182
    # We want only 'ascii' command names, but the user may have typed
256
183
    # in a Unicode name. In that case, they should just get a
257
184
    # 'command not found' error later.
258
185
    # In the future, we may actually support Unicode command names.
259
 
    cmd = None
260
 
    # Get a command
261
 
    for hook in Command.hooks['get_command']:
262
 
        cmd = hook(cmd, cmd_name)
263
 
        if cmd is not None and not plugins_override and not cmd.plugin_name():
264
 
            # We've found a non-plugin command, don't permit it to be
265
 
            # overridden.
266
 
            break
267
 
    if cmd is None and check_missing:
268
 
        for hook in Command.hooks['get_missing_command']:
269
 
            cmd = hook(cmd_name)
270
 
            if cmd is not None:
271
 
                break
272
 
    if cmd is None:
273
 
        # No command found.
274
 
        raise KeyError
275
 
    # Allow plugins to extend commands
276
 
    for hook in Command.hooks['extend_command']:
277
 
        hook(cmd)
278
 
    return cmd
279
 
 
280
 
 
281
 
def _try_plugin_provider(cmd_name):
282
 
    """Probe for a plugin provider having cmd_name."""
283
 
    try:
284
 
        plugin_metadata, provider = probe_for_provider(cmd_name)
285
 
        raise errors.CommandAvailableInPlugin(cmd_name,
286
 
            plugin_metadata, provider)
287
 
    except errors.NoPluginAvailable:
288
 
        pass
289
 
 
290
 
 
291
 
def probe_for_provider(cmd_name):
292
 
    """Look for a provider for cmd_name.
293
 
 
294
 
    :param cmd_name: The command name.
295
 
    :return: plugin_metadata, provider for getting cmd_name.
296
 
    :raises NoPluginAvailable: When no provider can supply the plugin.
297
 
    """
298
 
    # look for providers that provide this command but aren't installed
299
 
    for provider in command_providers_registry:
 
186
 
 
187
    # first look up this command under the specified name
 
188
    if plugins_override:
300
189
        try:
301
 
            return provider.plugin_for_command(cmd_name), provider
302
 
        except errors.NoPluginAvailable:
 
190
            return plugin_cmds.get(cmd_name)()
 
191
        except KeyError:
303
192
            pass
304
 
    raise errors.NoPluginAvailable(cmd_name)
305
 
 
306
 
 
307
 
def _get_bzr_command(cmd_or_None, cmd_name):
308
 
    """Get a command from bzr's core."""
 
193
    cmds = _get_cmd_dict(plugins_override=False)
309
194
    try:
310
 
        cmd_class = builtin_command_registry.get(cmd_name)
 
195
        return cmds[cmd_name]()
311
196
    except KeyError:
312
197
        pass
313
 
    else:
314
 
        return cmd_class()
315
 
    return cmd_or_None
316
 
 
317
 
 
318
 
def _get_external_command(cmd_or_None, cmd_name):
319
 
    """Lookup a command that is a shell script."""
320
 
    # Only do external command lookups when no command is found so far.
321
 
    if cmd_or_None is not None:
322
 
        return cmd_or_None
323
 
    from bzrlib.externalcommand import ExternalCommand
 
198
    if plugins_override:
 
199
        for key in plugin_cmds.keys():
 
200
            info = plugin_cmds.get_info(key)
 
201
            if cmd_name in info.aliases:
 
202
                return plugin_cmds.get(key)()
 
203
    # look for any command which claims this as an alias
 
204
    for real_cmd_name, cmd_class in cmds.iteritems():
 
205
        if cmd_name in cmd_class.aliases:
 
206
            return cmd_class()
 
207
 
324
208
    cmd_obj = ExternalCommand.find_command(cmd_name)
325
209
    if cmd_obj:
326
210
        return cmd_obj
327
211
 
 
212
    # look for plugins that provide this command but aren't installed
 
213
    for provider in command_providers_registry:
 
214
        try:
 
215
            plugin_metadata = provider.plugin_for_command(cmd_name)
 
216
        except errors.NoPluginAvailable:
 
217
            pass
 
218
        else:
 
219
            raise errors.CommandAvailableInPlugin(cmd_name, 
 
220
                                                  plugin_metadata, provider)
328
221
 
329
 
def _get_plugin_command(cmd_or_None, cmd_name):
330
 
    """Get a command from bzr's plugins."""
331
 
    try:
332
 
        return plugin_cmds.get(cmd_name)()
333
 
    except KeyError:
334
 
        pass
335
 
    for key in plugin_cmds.keys():
336
 
        info = plugin_cmds.get_info(key)
337
 
        if cmd_name in info.aliases:
338
 
            return plugin_cmds.get(key)()
339
 
    return cmd_or_None
 
222
    raise KeyError
340
223
 
341
224
 
342
225
class Command(object):
396
279
            sys.stdout is forced to be a binary stream, and line-endings
397
280
            will not mangled.
398
281
 
399
 
    :cvar hooks: An instance of CommandHooks.
400
282
    """
401
283
    aliases = []
402
284
    takes_args = []
404
286
    encoding_type = 'strict'
405
287
 
406
288
    hidden = False
407
 
 
 
289
    
408
290
    def __init__(self):
409
291
        """Construct an instance of this command."""
410
292
        if self.__doc__ == Command.__doc__:
411
293
            warn("No help message set for %r" % self)
412
294
        # List of standard options directly supported
413
295
        self.supported_std_options = []
414
 
        self._setup_run()
415
 
 
416
 
    def add_cleanup(self, cleanup_func, *args, **kwargs):
417
 
        """Register a function to call after self.run returns or raises.
418
 
 
419
 
        Functions will be called in LIFO order.
420
 
        """
421
 
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
422
 
 
423
 
    def cleanup_now(self):
424
 
        """Execute and empty pending cleanup functions immediately.
425
 
 
426
 
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
427
 
        may be called again after cleanup_now; these cleanups will be called
428
 
        after self.run returns or raises (or when cleanup_now is next called).
429
 
 
430
 
        This is useful for releasing expensive or contentious resources (such
431
 
        as write locks) before doing further work that does not require those
432
 
        resources (such as writing results to self.outf). Note though, that
433
 
        as it releases all resources, this may release locks that the command
434
 
        wants to hold, so use should be done with care.
435
 
        """
436
 
        self._operation.cleanup_now()
437
 
 
438
 
    @deprecated_method(deprecated_in((2, 1, 0)))
 
296
 
439
297
    def _maybe_expand_globs(self, file_list):
440
298
        """Glob expand file_list if the platform does not do that itself.
441
 
 
442
 
        Not used anymore, now that the bzr command-line parser globs on
443
 
        Windows.
444
 
 
 
299
        
445
300
        :return: A possibly empty list of unicode paths.
446
301
 
447
302
        Introduced in bzrlib 0.18.
448
303
        """
449
 
        return file_list
 
304
        if not file_list:
 
305
            file_list = []
 
306
        if sys.platform == 'win32':
 
307
            file_list = win32utils.glob_expand(file_list)
 
308
        return list(file_list)
450
309
 
451
310
    def _usage(self):
452
311
        """Return single-line grammar for this command.
467
326
        return s
468
327
 
469
328
    def get_help_text(self, additional_see_also=None, plain=True,
470
 
                      see_also_as_links=False, verbose=True):
 
329
                      see_also_as_links=False):
471
330
        """Return a text string with help for this command.
472
 
 
 
331
        
473
332
        :param additional_see_also: Additional help topics to be
474
333
            cross-referenced.
475
334
        :param plain: if False, raw help (reStructuredText) is
476
335
            returned instead of plain text.
477
336
        :param see_also_as_links: if True, convert items in 'See also'
478
337
            list to internal links (used by bzr_man rstx generator)
479
 
        :param verbose: if True, display the full help, otherwise
480
 
            leave out the descriptive sections and just display
481
 
            usage help (e.g. Purpose, Usage, Options) with a
482
 
            message explaining how to obtain full help.
483
338
        """
484
339
        doc = self.help()
485
340
        if doc is None:
486
341
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
487
342
 
488
343
        # Extract the summary (purpose) and sections out from the text
489
 
        purpose,sections,order = self._get_help_parts(doc)
 
344
        purpose,sections = self._get_help_parts(doc)
490
345
 
491
346
        # If a custom usage section was provided, use it
492
347
        if sections.has_key('Usage'):
504
359
        result += '\n'
505
360
 
506
361
        # Add the options
507
 
        #
508
 
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
509
 
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
510
 
        # 20090319
511
362
        options = option.get_optparser(self.options()).format_option_help()
512
 
        # XXX: According to the spec, ReST option lists actually don't support 
513
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
514
 
        # As that pattern always appears in the commands that break, we trap
515
 
        # on that and then format that block of 'format' options as a literal
516
 
        # block.
517
 
        if not plain and options.find('  --1.9  ') != -1:
518
 
            options = options.replace(' format:\n', ' format::\n\n', 1)
519
363
        if options.startswith('Options:'):
520
364
            result += ':' + options
521
365
        elif options.startswith('options:'):
525
369
            result += options
526
370
        result += '\n'
527
371
 
528
 
        if verbose:
529
 
            # Add the description, indenting it 2 spaces
530
 
            # to match the indentation of the options
531
 
            if sections.has_key(None):
532
 
                text = sections.pop(None)
533
 
                text = '\n  '.join(text.splitlines())
534
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
372
        # Add the description, indenting it 2 spaces
 
373
        # to match the indentation of the options
 
374
        if sections.has_key(None):
 
375
            text = sections.pop(None)
 
376
            text = '\n  '.join(text.splitlines())
 
377
            result += ':%s:\n  %s\n\n' % ('Description',text)
535
378
 
536
 
            # Add the custom sections (e.g. Examples). Note that there's no need
537
 
            # to indent these as they must be indented already in the source.
538
 
            if sections:
539
 
                for label in order:
540
 
                    if sections.has_key(label):
541
 
                        result += ':%s:\n%s\n' % (label,sections[label])
542
 
                result += '\n'
543
 
        else:
544
 
            result += ("See bzr help %s for more details and examples.\n\n"
545
 
                % self.name())
 
379
        # Add the custom sections (e.g. Examples). Note that there's no need
 
380
        # to indent these as they must be indented already in the source.
 
381
        if sections:
 
382
            labels = sorted(sections.keys())
 
383
            for label in labels:
 
384
                result += ':%s:\n%s\n\n' % (label,sections[label])
546
385
 
547
386
        # Add the aliases, source (plug-in) and see also links, if any
548
387
        if self.aliases:
561
400
                        # so don't create a real link
562
401
                        see_also_links.append(item)
563
402
                    else:
564
 
                        # Use a Sphinx link for this entry
565
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
566
 
                        see_also_links.append(link_text)
 
403
                        # Use a reST link for this entry
 
404
                        see_also_links.append("`%s`_" % (item,))
567
405
                see_also = see_also_links
568
406
            result += ':See also: '
569
407
            result += ', '.join(see_also) + '\n'
578
416
    def _get_help_parts(text):
579
417
        """Split help text into a summary and named sections.
580
418
 
581
 
        :return: (summary,sections,order) where summary is the top line and
 
419
        :return: (summary,sections) where summary is the top line and
582
420
            sections is a dictionary of the rest indexed by section name.
583
 
            order is the order the section appear in the text.
584
421
            A section starts with a heading line of the form ":xxx:".
585
422
            Indented text on following lines is the section value.
586
423
            All text found outside a named section is assigned to the
587
424
            default section which is given the key of None.
588
425
        """
589
 
        def save_section(sections, order, label, section):
 
426
        def save_section(sections, label, section):
590
427
            if len(section) > 0:
591
428
                if sections.has_key(label):
592
429
                    sections[label] += '\n' + section
593
430
                else:
594
 
                    order.append(label)
595
431
                    sections[label] = section
596
432
 
597
433
        lines = text.rstrip().splitlines()
598
434
        summary = lines.pop(0)
599
435
        sections = {}
600
 
        order = []
601
436
        label,section = None,''
602
437
        for line in lines:
603
438
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
 
                save_section(sections, order, label, section)
 
439
                save_section(sections, label, section)
605
440
                label,section = line[1:-1],''
606
441
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
 
                save_section(sections, order, label, section)
 
442
                save_section(sections, label, section)
608
443
                label,section = None,line
609
444
            else:
610
445
                if len(section) > 0:
611
446
                    section += '\n' + line
612
447
                else:
613
448
                    section = line
614
 
        save_section(sections, order, label, section)
615
 
        return summary, sections, order
 
449
        save_section(sections, label, section)
 
450
        return summary, sections
616
451
 
617
452
    def get_help_topic(self):
618
453
        """Return the commands help topic - its name."""
620
455
 
621
456
    def get_see_also(self, additional_terms=None):
622
457
        """Return a list of help topics that are related to this command.
623
 
 
 
458
        
624
459
        The list is derived from the content of the _see_also attribute. Any
625
460
        duplicates are removed and the result is in lexical order.
626
461
        :param additional_terms: Additional help topics to cross-reference.
647
482
 
648
483
    def _setup_outf(self):
649
484
        """Return a file linked to stdout, which has proper encoding."""
650
 
        self.outf = ui.ui_factory.make_output_stream(
651
 
            encoding_type=self.encoding_type)
 
485
        # Originally I was using self.stdout, but that looks
 
486
        # *way* too much like sys.stdout
 
487
        if self.encoding_type == 'exact':
 
488
            # force sys.stdout to be binary stream on win32
 
489
            if sys.platform == 'win32':
 
490
                fileno = getattr(sys.stdout, 'fileno', None)
 
491
                if fileno:
 
492
                    import msvcrt
 
493
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
494
            self.outf = sys.stdout
 
495
            return
 
496
 
 
497
        output_encoding = osutils.get_terminal_encoding()
 
498
 
 
499
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
 
500
                        errors=self.encoding_type)
 
501
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
502
        # it just returns the encoding of the wrapped file, which is completely
 
503
        # bogus. So set the attribute, so we can find the correct encoding later.
 
504
        self.outf.encoding = output_encoding
652
505
 
653
506
    def run_argv_aliases(self, argv, alias_argv=None):
654
507
        """Parse the command line and run with extra aliases in alias_argv."""
 
508
        if argv is None:
 
509
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
510
                 DeprecationWarning, stacklevel=2)
 
511
            argv = []
655
512
        args, opts = parse_args(self, argv, alias_argv)
656
513
 
657
514
        # Process the standard options
658
515
        if 'help' in opts:  # e.g. bzr add --help
659
516
            sys.stdout.write(self.get_help_text())
660
517
            return 0
661
 
        if 'usage' in opts:  # e.g. bzr add --usage
662
 
            sys.stdout.write(self.get_help_text(verbose=False))
663
 
            return 0
664
518
        trace.set_verbosity_level(option._verbosity_level)
665
519
        if 'verbose' in self.supported_std_options:
666
520
            opts['verbose'] = trace.is_verbose()
684
538
 
685
539
        return self.run(**all_cmd_args)
686
540
 
687
 
    def _setup_run(self):
688
 
        """Wrap the defined run method on self with a cleanup.
689
 
 
690
 
        This is called by __init__ to make the Command be able to be run
691
 
        by just calling run(), as it could be before cleanups were added.
692
 
 
693
 
        If a different form of cleanups are in use by your Command subclass,
694
 
        you can override this method.
695
 
        """
696
 
        class_run = self.run
697
 
        def run(*args, **kwargs):
698
 
            self._operation = cleanup.OperationWithCleanups(class_run)
699
 
            try:
700
 
                return self._operation.run_simple(*args, **kwargs)
701
 
            finally:
702
 
                del self._operation
703
 
        self.run = run
704
 
 
705
 
    @deprecated_method(deprecated_in((2, 2, 0)))
706
 
    def run_direct(self, *args, **kwargs):
707
 
        """Deprecated thunk from bzrlib 2.1."""
708
 
        return self.run(*args, **kwargs)
709
 
 
710
541
    def run(self):
711
542
        """Actually run the command.
712
543
 
716
547
        Return 0 or None if the command was successful, or a non-zero
717
548
        shell error code if not.  It's OK for this method to allow
718
549
        an exception to raise up.
719
 
 
720
 
        This method is automatically wrapped by Command.__init__ with a 
721
 
        cleanup operation, stored as self._operation. This can be used
722
 
        via self.add_cleanup to perform automatic cleanups at the end of
723
 
        run().
724
 
 
725
 
        The argument for run are assembled by introspection. So for instance,
726
 
        if your command takes an argument files, you would declare::
727
 
 
728
 
            def run(self, files=None):
729
 
                pass
730
550
        """
731
551
        raise NotImplementedError('no implementation of command %r'
732
552
                                  % self.name())
753
573
            return None
754
574
 
755
575
 
756
 
class CommandHooks(Hooks):
757
 
    """Hooks related to Command object creation/enumeration."""
758
 
 
759
 
    def __init__(self):
760
 
        """Create the default hooks.
761
 
 
762
 
        These are all empty initially, because by default nothing should get
763
 
        notified.
764
 
        """
765
 
        Hooks.__init__(self)
766
 
        self.create_hook(HookPoint('extend_command',
767
 
            "Called after creating a command object to allow modifications "
768
 
            "such as adding or removing options, docs etc. Called with the "
769
 
            "new bzrlib.commands.Command object.", (1, 13), None))
770
 
        self.create_hook(HookPoint('get_command',
771
 
            "Called when creating a single command. Called with "
772
 
            "(cmd_or_None, command_name). get_command should either return "
773
 
            "the cmd_or_None parameter, or a replacement Command object that "
774
 
            "should be used for the command. Note that the Command.hooks "
775
 
            "hooks are core infrastructure. Many users will prefer to use "
776
 
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
777
 
            (1, 17), None))
778
 
        self.create_hook(HookPoint('get_missing_command',
779
 
            "Called when creating a single command if no command could be "
780
 
            "found. Called with (command_name). get_missing_command should "
781
 
            "either return None, or a Command object to be used for the "
782
 
            "command.", (1, 17), None))
783
 
        self.create_hook(HookPoint('list_commands',
784
 
            "Called when enumerating commands. Called with a set of "
785
 
            "cmd_name strings for all the commands found so far. This set "
786
 
            " is safe to mutate - e.g. to remove a command. "
787
 
            "list_commands should return the updated set of command names.",
788
 
            (1, 17), None))
789
 
 
790
 
Command.hooks = CommandHooks()
791
 
 
792
 
 
793
576
def parse_args(command, argv, alias_argv=None):
794
577
    """Parse command line.
795
 
 
 
578
    
796
579
    Arguments and options are parsed at this level before being passed
797
580
    down to specific command handlers.  This routine knows, from a
798
581
    lookup table, something about the available options, what optargs
847
630
                               % (cmd, argname.upper()))
848
631
            else:
849
632
                argdict[argname] = args.pop(0)
850
 
 
 
633
            
851
634
    if args:
852
635
        raise errors.BzrCommandError("extra argument to command %s: %s"
853
636
                                     % (cmd, args[0]))
861
644
 
862
645
    tracer = trace.Trace(count=1, trace=0)
863
646
    sys.settrace(tracer.globaltrace)
864
 
    threading.settrace(tracer.globaltrace)
865
 
 
866
 
    try:
867
 
        return exception_to_return_code(the_callable, *args, **kwargs)
868
 
    finally:
869
 
        sys.settrace(None)
870
 
        results = tracer.results()
871
 
        results.write_results(show_missing=1, summary=False,
872
 
                              coverdir=dirname)
 
647
 
 
648
    ret = the_callable(*args, **kwargs)
 
649
 
 
650
    sys.settrace(None)
 
651
    results = tracer.results()
 
652
    results.write_results(show_missing=1, summary=False,
 
653
                          coverdir=dirname)
873
654
 
874
655
 
875
656
def apply_profiled(the_callable, *args, **kwargs):
880
661
    try:
881
662
        prof = hotshot.Profile(pfname)
882
663
        try:
883
 
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
884
 
                **kwargs) or 0
 
664
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
885
665
        finally:
886
666
            prof.close()
887
667
        stats = hotshot.stats.load(pfname)
896
676
        os.remove(pfname)
897
677
 
898
678
 
899
 
def exception_to_return_code(the_callable, *args, **kwargs):
900
 
    """UI level helper for profiling and coverage.
901
 
 
902
 
    This transforms exceptions into a return value of 3. As such its only
903
 
    relevant to the UI layer, and should never be called where catching
904
 
    exceptions may be desirable.
905
 
    """
906
 
    try:
907
 
        return the_callable(*args, **kwargs)
908
 
    except (KeyboardInterrupt, Exception), e:
909
 
        # used to handle AssertionError and KeyboardInterrupt
910
 
        # specially here, but hopefully they're handled ok by the logger now
911
 
        exc_info = sys.exc_info()
912
 
        exitcode = trace.report_exception(exc_info, sys.stderr)
913
 
        if os.environ.get('BZR_PDB'):
914
 
            print '**** entering debugger'
915
 
            tb = exc_info[2]
916
 
            import pdb
917
 
            if sys.version_info[:2] < (2, 6):
918
 
                # XXX: we want to do
919
 
                #    pdb.post_mortem(tb)
920
 
                # but because pdb.post_mortem gives bad results for tracebacks
921
 
                # from inside generators, we do it manually.
922
 
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
923
 
 
924
 
                # Setup pdb on the traceback
925
 
                p = pdb.Pdb()
926
 
                p.reset()
927
 
                p.setup(tb.tb_frame, tb)
928
 
                # Point the debugger at the deepest frame of the stack
929
 
                p.curindex = len(p.stack) - 1
930
 
                p.curframe = p.stack[p.curindex][0]
931
 
                # Start the pdb prompt.
932
 
                p.print_stack_entry(p.stack[p.curindex])
933
 
                p.execRcLines()
934
 
                p.cmdloop()
935
 
            else:
936
 
                pdb.post_mortem(tb)
937
 
        return exitcode
938
 
 
939
 
 
940
679
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
680
    from bzrlib.lsprof import profile
942
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
681
    ret, stats = profile(the_callable, *args, **kwargs)
943
682
    stats.sort()
944
683
    if filename is None:
945
684
        stats.pprint()
949
688
    return ret
950
689
 
951
690
 
952
 
@deprecated_function(deprecated_in((2, 2, 0)))
953
691
def shlex_split_unicode(unsplit):
954
 
    return cmdline.split(unsplit)
 
692
    import shlex
 
693
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
955
694
 
956
695
 
957
696
def get_alias(cmd, config=None):
969
708
        config = bzrlib.config.GlobalConfig()
970
709
    alias = config.get_alias(cmd)
971
710
    if (alias):
972
 
        return cmdline.split(alias)
 
711
        return shlex_split_unicode(alias)
973
712
    return None
974
713
 
975
714
 
976
 
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
 
715
def run_bzr(argv):
977
716
    """Execute a command.
978
717
 
979
 
    :param argv: The command-line arguments, without the program name from
980
 
        argv[0] These should already be decoded. All library/test code calling
981
 
        run_bzr should be passing valid strings (don't need decoding).
982
 
    :param load_plugins: What function to call when triggering plugin loading.
983
 
        This function should take no arguments and cause all plugins to be
984
 
        loaded.
985
 
    :param disable_plugins: What function to call when disabling plugin
986
 
        loading. This function should take no arguments and cause all plugin
987
 
        loading to be prohibited (so that code paths in your application that
988
 
        know about some plugins possibly being present will fail to import
989
 
        those plugins even if they are installed.)
990
 
    :return: Returns a command exit code or raises an exception.
 
718
    argv
 
719
       The command-line arguments, without the program name from argv[0]
 
720
       These should already be decoded. All library/test code calling
 
721
       run_bzr should be passing valid strings (don't need decoding).
 
722
    
 
723
    Returns a command status or raises an exception.
991
724
 
992
725
    Special master options: these must come before the command because
993
726
    they control how the command is interpreted.
1010
743
 
1011
744
    --coverage
1012
745
        Generate line coverage report in the specified directory.
1013
 
 
1014
 
    --concurrency
1015
 
        Specify the number of processes that can be run concurrently (selftest).
1016
746
    """
1017
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
1018
747
    argv = list(argv)
1019
748
    trace.mutter("bzr arguments: %r", argv)
1020
749
 
1044
773
            opt_no_aliases = True
1045
774
        elif a == '--builtin':
1046
775
            opt_builtin = True
1047
 
        elif a == '--concurrency':
1048
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1049
 
            i += 1
1050
776
        elif a == '--coverage':
1051
777
            opt_coverage_dir = argv[i + 1]
1052
778
            i += 1
1056
782
            argv_copy.append(a)
1057
783
        i += 1
1058
784
 
1059
 
    debug.set_debug_flags_from_config()
 
785
    argv = argv_copy
 
786
    if (not argv):
 
787
        from bzrlib.builtins import cmd_help
 
788
        cmd_help().run_argv_aliases([])
 
789
        return 0
 
790
 
 
791
    if argv[0] == '--version':
 
792
        from bzrlib.builtins import cmd_version
 
793
        cmd_version().run_argv_aliases([])
 
794
        return 0
1060
795
 
1061
796
    if not opt_no_plugins:
 
797
        from bzrlib.plugin import load_plugins
1062
798
        load_plugins()
1063
799
    else:
 
800
        from bzrlib.plugin import disable_plugins
1064
801
        disable_plugins()
1065
802
 
1066
 
    argv = argv_copy
1067
 
    if (not argv):
1068
 
        get_cmd_object('help').run_argv_aliases([])
1069
 
        return 0
1070
 
 
1071
 
    if argv[0] == '--version':
1072
 
        get_cmd_object('version').run_argv_aliases([])
1073
 
        return 0
1074
 
 
1075
803
    alias_argv = None
1076
804
 
1077
805
    if not opt_no_aliases:
1109
837
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1110
838
        else:
1111
839
            ret = run(*run_argv)
 
840
        if 'memory' in debug.debug_flags:
 
841
            trace.debug_memory('Process status after command:', short=False)
1112
842
        return ret or 0
1113
843
    finally:
1114
844
        # reset, in case we may do other commands later within the same
1115
845
        # process. Commands that want to execute sub-commands must propagate
1116
846
        # --verbose in their own way.
1117
 
        if 'memory' in debug.debug_flags:
1118
 
            trace.debug_memory('Process status after command:', short=False)
1119
847
        option._verbosity_level = saved_verbosity_level
1120
848
 
1121
 
 
1122
849
def display_command(func):
1123
850
    """Decorator that suppresses pipe/interrupt errors."""
1124
851
    def ignore_pipe(*args, **kwargs):
1139
866
    return ignore_pipe
1140
867
 
1141
868
 
1142
 
def install_bzr_command_hooks():
1143
 
    """Install the hooks to supply bzr's own commands."""
1144
 
    if _list_bzr_commands in Command.hooks["list_commands"]:
1145
 
        return
1146
 
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1147
 
        "bzr commands")
1148
 
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1149
 
        "bzr commands")
1150
 
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
 
        "bzr plugin commands")
1152
 
    Command.hooks.install_named_hook("get_command", _get_external_command,
1153
 
        "bzr external command lookup")
1154
 
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
 
        "bzr plugin-provider-db check")
1156
 
 
1157
 
 
1158
 
 
1159
 
def _specified_or_unicode_argv(argv):
1160
 
    # For internal or testing use, argv can be passed.  Otherwise, get it from
1161
 
    # the process arguments in a unicode-safe way.
1162
 
    if argv is None:
1163
 
        return osutils.get_unicode_argv()
1164
 
    else:
1165
 
        new_argv = []
1166
 
        try:
1167
 
            # ensure all arguments are unicode strings
1168
 
            for a in argv[1:]:
1169
 
                if isinstance(a, unicode):
1170
 
                    new_argv.append(a)
1171
 
                else:
1172
 
                    new_argv.append(a.decode('ascii'))
1173
 
        except UnicodeDecodeError:
1174
 
            raise errors.BzrError("argv should be list of unicode strings.")
1175
 
        return new_argv
1176
 
 
1177
 
 
1178
 
def main(argv=None):
1179
 
    """Main entry point of command-line interface.
1180
 
 
1181
 
    Typically `bzrlib.initialize` should be called first.
1182
 
 
1183
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1184
 
        argv[0] is script name usually, it will be ignored.
1185
 
        Don't pass here sys.argv because this list contains plain strings
1186
 
        and not unicode; pass None instead.
1187
 
 
1188
 
    :return: exit code of bzr command.
1189
 
    """
1190
 
    argv = _specified_or_unicode_argv(argv)
1191
 
    _register_builtin_commands()
 
869
def main(argv):
 
870
    import bzrlib.ui
 
871
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
 
872
        sys.stdin, sys.stdout, sys.stderr)
 
873
 
 
874
    # Is this a final release version? If so, we should suppress warnings
 
875
    if bzrlib.version_info[3] == 'final':
 
876
        from bzrlib import symbol_versioning
 
877
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
878
    try:
 
879
        user_encoding = osutils.get_user_encoding()
 
880
        argv = [a.decode(user_encoding) for a in argv[1:]]
 
881
    except UnicodeDecodeError:
 
882
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
883
                                                            "encoding." % a))
1192
884
    ret = run_bzr_catch_errors(argv)
1193
 
    bzrlib.ui.ui_factory.log_transport_activity(
1194
 
        display=('bytes' in debug.debug_flags))
1195
885
    trace.mutter("return code %d", ret)
1196
886
    return ret
1197
887
 
1198
888
 
1199
889
def run_bzr_catch_errors(argv):
1200
 
    """Run a bzr command with parameters as described by argv.
1201
 
 
1202
 
    This function assumed that that UI layer is setup, that symbol deprecations
1203
 
    are already applied, and that unicode decoding has already been performed on argv.
1204
 
    """
1205
 
    # done here so that they're covered for every test run
1206
 
    install_bzr_command_hooks()
1207
 
    return exception_to_return_code(run_bzr, argv)
 
890
    # Note: The except clause logic below should be kept in sync with the
 
891
    # profile() routine in lsprof.py.
 
892
    try:
 
893
        return run_bzr(argv)
 
894
    except (KeyboardInterrupt, Exception), e:
 
895
        # used to handle AssertionError and KeyboardInterrupt
 
896
        # specially here, but hopefully they're handled ok by the logger now
 
897
        exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
 
898
        if os.environ.get('BZR_PDB'):
 
899
            print '**** entering debugger'
 
900
            import pdb
 
901
            pdb.post_mortem(sys.exc_traceback)
 
902
        return exitcode
1208
903
 
1209
904
 
1210
905
def run_bzr_catch_user_errors(argv):
1213
908
    This is used for the test suite, and might be useful for other programs
1214
909
    that want to wrap the commandline interface.
1215
910
    """
1216
 
    # done here so that they're covered for every test run
1217
 
    install_bzr_command_hooks()
1218
911
    try:
1219
912
        return run_bzr(argv)
1220
913
    except Exception, e:
1242
935
        if topic and topic.startswith(self.prefix):
1243
936
            topic = topic[len(self.prefix):]
1244
937
        try:
1245
 
            cmd = _get_cmd_object(topic, check_missing=False)
 
938
            cmd = _get_cmd_object(topic)
1246
939
        except KeyError:
1247
940
            return []
1248
941
        else:
1254
947
 
1255
948
    def plugin_for_command(self, cmd_name):
1256
949
        '''Takes a command and returns the information for that plugin
1257
 
 
1258
 
        :return: A dictionary with all the available information
 
950
        
 
951
        :return: A dictionary with all the available information 
1259
952
        for the requested plugin
1260
953
        '''
1261
954
        raise NotImplementedError
1269
962
            yield provider
1270
963
 
1271
964
command_providers_registry = ProvidersRegistry()
 
965
 
 
966
 
 
967
if __name__ == '__main__':
 
968
    sys.exit(main(sys.argv))