/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/commands.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# TODO: Define arguments by objects, rather than just using names.
20
19
# Those objects can specify the expected type of the argument, which
26
25
import os
27
26
import sys
28
27
 
29
 
from . import (
30
 
    i18n,
31
 
    option,
32
 
    osutils,
33
 
    )
34
 
 
35
 
from .lazy_import import lazy_import
 
28
from bzrlib.lazy_import import lazy_import
36
29
lazy_import(globals(), """
 
30
import codecs
37
31
import errno
 
32
import threading
 
33
from warnings import warn
38
34
 
39
 
import breezy
40
 
from breezy import (
 
35
import bzrlib
 
36
from bzrlib import (
41
37
    cleanup,
42
38
    cmdline,
43
39
    debug,
 
40
    errors,
 
41
    option,
 
42
    osutils,
44
43
    trace,
45
44
    ui,
 
45
    win32utils,
46
46
    )
47
47
""")
48
48
 
49
 
from .hooks import Hooks
50
 
from .i18n import gettext
 
49
from bzrlib.hooks import HookPoint, Hooks
51
50
# Compatibility - Option used to be in commands.
52
 
from .option import Option
53
 
from .plugin import disable_plugins, load_plugins, plugin_name
54
 
from . import errors, registry
55
 
from .sixish import (
56
 
    string_types,
 
51
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,
57
58
    )
58
59
 
59
60
 
60
 
class BzrOptionError(errors.BzrCommandError):
61
 
 
62
 
    _fmt = "Error in command line options"
63
 
 
64
 
 
65
 
class CommandAvailableInPlugin(Exception):
66
 
 
67
 
    internal_error = False
68
 
 
69
 
    def __init__(self, cmd_name, plugin_metadata, provider):
70
 
 
71
 
        self.plugin_metadata = plugin_metadata
72
 
        self.cmd_name = cmd_name
73
 
        self.provider = provider
74
 
 
75
 
    def __str__(self):
76
 
 
77
 
        _fmt = ('"%s" is not a standard brz command. \n'
78
 
                'However, the following official plugin provides this command: %s\n'
79
 
                'You can install it by going to: %s'
80
 
                % (self.cmd_name, self.plugin_metadata['name'],
81
 
                    self.plugin_metadata['url']))
82
 
 
83
 
        return _fmt
84
 
 
85
 
 
86
61
class CommandInfo(object):
87
62
    """Information about a command."""
88
63
 
98
73
 
99
74
class CommandRegistry(registry.Registry):
100
75
    """Special registry mapping command names to command classes.
101
 
 
 
76
    
102
77
    :ivar overridden_registry: Look in this registry for commands being
103
78
        overridden by this registry.  This can be used to tell plugin commands
104
79
        about the builtin they're decorating.
147
122
        except KeyError:
148
123
            trace.warning('Two plugins defined the same command: %r' % k)
149
124
            trace.warning('Not loading the one in %r' %
150
 
                          sys.modules[cmd.__module__])
 
125
                sys.modules[cmd.__module__])
151
126
            trace.warning('Previously this command was registered from %r' %
152
 
                          sys.modules[previous.__module__])
 
127
                sys.modules[previous.__module__])
153
128
        for a in cmd.aliases:
154
129
            self._alias_dict[a] = k_unsquished
155
130
        return previous
176
151
def register_command(cmd, decorate=False):
177
152
    """Register a plugin command.
178
153
 
179
 
    Should generally be avoided in favor of lazy registration.
 
154
    Should generally be avoided in favor of lazy registration. 
180
155
    """
181
156
    global plugin_cmds
182
157
    return plugin_cmds.register(cmd, decorate)
187
162
 
188
163
 
189
164
def _unsquish_command_name(cmd):
190
 
    return cmd[4:].replace('_', '-')
 
165
    return cmd[4:].replace('_','-')
 
166
 
 
167
 
 
168
@deprecated_function(deprecated_in((2, 2, 0)))
 
169
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())
191
176
 
192
177
 
193
178
def _register_builtin_commands():
194
179
    if builtin_command_registry.keys():
195
180
        # only load once
196
181
        return
197
 
    import breezy.builtins
198
 
    for cmd_class in _scan_module_for_commands(breezy.builtins):
 
182
    import bzrlib.builtins
 
183
    for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
199
184
        builtin_command_registry.register(cmd_class)
200
 
    breezy.builtins._register_lazy_builtins()
 
185
    bzrlib.builtins._register_lazy_builtins()
201
186
 
202
187
 
203
188
def _scan_module_for_commands(module):
204
 
    module_dict = module.__dict__
205
 
    for name in module_dict:
 
189
    r = {}
 
190
    for name, obj in module.__dict__.iteritems():
206
191
        if name.startswith("cmd_"):
207
 
            yield module_dict[name]
 
192
            real_name = _unsquish_command_name(name)
 
193
            r[real_name] = obj
 
194
    return r
208
195
 
209
196
 
210
197
def _list_bzr_commands(names):
211
198
    """Find commands from bzr's core and plugins.
212
 
 
213
 
    This is not the public interface, just the default hook called by
214
 
    all_command_names.
 
199
    
 
200
    This is not the public interface, just the default hook called by all_command_names.
215
201
    """
216
202
    # to eliminate duplicates
217
203
    names.update(builtin_command_names())
232
218
 
233
219
def builtin_command_names():
234
220
    """Return list of builtin command names.
235
 
 
 
221
    
236
222
    Use of all_command_names() is encouraged rather than builtin_command_names
237
223
    and/or plugin_command_names.
238
224
    """
239
 
    _register_builtin_commands()
240
225
    return builtin_command_registry.keys()
241
226
 
242
227
 
245
230
    return plugin_cmds.keys()
246
231
 
247
232
 
248
 
# Overrides for common mispellings that heuristics get wrong
249
 
_GUESS_OVERRIDES = {
250
 
    'ic': {'ci': 0},  # heuristic finds nick
251
 
    }
252
 
 
253
 
 
254
 
def guess_command(cmd_name):
255
 
    """Guess what command a user typoed.
256
 
 
257
 
    :param cmd_name: Command to search for
258
 
    :return: None if no command was found, name of a command otherwise
259
 
    """
260
 
    names = set()
261
 
    for name in all_command_names():
262
 
        names.add(name)
263
 
        cmd = get_cmd_object(name)
264
 
        names.update(cmd.aliases)
265
 
    # candidate: modified levenshtein distance against cmd_name.
266
 
    costs = {}
267
 
    import patiencediff
268
 
    for name in sorted(names):
269
 
        matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
270
 
        distance = 0.0
271
 
        opcodes = matcher.get_opcodes()
272
 
        for opcode, l1, l2, r1, r2 in opcodes:
273
 
            if opcode == 'delete':
274
 
                distance += l2 - l1
275
 
            elif opcode == 'replace':
276
 
                distance += max(l2 - l1, r2 - l1)
277
 
            elif opcode == 'insert':
278
 
                distance += r2 - r1
279
 
            elif opcode == 'equal':
280
 
                # Score equal ranges lower, making similar commands of equal
281
 
                # length closer than arbitrary same length commands.
282
 
                distance -= 0.1 * (l2 - l1)
283
 
        costs[name] = distance
284
 
    costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
285
 
    costs = sorted((costs[key], key) for key in costs)
286
 
    if not costs:
287
 
        return
288
 
    if costs[0][0] > 4:
289
 
        return
290
 
    candidate = costs[0][1]
291
 
    return candidate
292
 
 
293
 
 
294
233
def get_cmd_object(cmd_name, plugins_override=True):
295
234
    """Return the command object for a command.
296
235
 
300
239
    try:
301
240
        return _get_cmd_object(cmd_name, plugins_override)
302
241
    except KeyError:
303
 
        # No command found, see if this was a typo
304
 
        candidate = guess_command(cmd_name)
305
 
        if candidate is not None:
306
 
            raise errors.BzrCommandError(
307
 
                gettext('unknown command "%s". Perhaps you meant "%s"')
308
 
                % (cmd_name, candidate))
309
 
        raise errors.BzrCommandError(gettext('unknown command "%s"')
310
 
                                     % cmd_name)
 
242
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
311
243
 
312
244
 
313
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
343
275
    # Allow plugins to extend commands
344
276
    for hook in Command.hooks['extend_command']:
345
277
        hook(cmd)
346
 
    if getattr(cmd, 'invoked_as', None) is None:
347
 
        cmd.invoked_as = cmd_name
348
278
    return cmd
349
279
 
350
280
 
351
 
class NoPluginAvailable(errors.BzrError):
352
 
    pass
353
 
 
354
 
 
355
281
def _try_plugin_provider(cmd_name):
356
282
    """Probe for a plugin provider having cmd_name."""
357
283
    try:
358
284
        plugin_metadata, provider = probe_for_provider(cmd_name)
359
 
        raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
360
 
    except NoPluginAvailable:
 
285
        raise errors.CommandAvailableInPlugin(cmd_name,
 
286
            plugin_metadata, provider)
 
287
    except errors.NoPluginAvailable:
361
288
        pass
362
289
 
363
290
 
372
299
    for provider in command_providers_registry:
373
300
        try:
374
301
            return provider.plugin_for_command(cmd_name), provider
375
 
        except NoPluginAvailable:
 
302
        except errors.NoPluginAvailable:
376
303
            pass
377
 
    raise NoPluginAvailable(cmd_name)
 
304
    raise errors.NoPluginAvailable(cmd_name)
378
305
 
379
306
 
380
307
def _get_bzr_command(cmd_or_None, cmd_name):
393
320
    # Only do external command lookups when no command is found so far.
394
321
    if cmd_or_None is not None:
395
322
        return cmd_or_None
396
 
    from breezy.externalcommand import ExternalCommand
 
323
    from bzrlib.externalcommand import ExternalCommand
397
324
    cmd_obj = ExternalCommand.find_command(cmd_name)
398
325
    if cmd_obj:
399
326
        return cmd_obj
400
327
 
401
328
 
402
329
def _get_plugin_command(cmd_or_None, cmd_name):
403
 
    """Get a command from brz's plugins."""
 
330
    """Get a command from bzr's plugins."""
404
331
    try:
405
332
        return plugin_cmds.get(cmd_name)()
406
333
    except KeyError:
415
342
class Command(object):
416
343
    """Base class for commands.
417
344
 
418
 
    Commands are the heart of the command-line brz interface.
 
345
    Commands are the heart of the command-line bzr interface.
419
346
 
420
347
    The command object mostly handles the mapping of command-line
421
 
    parameters into one or more breezy operations, and of the results
 
348
    parameters into one or more bzrlib operations, and of the results
422
349
    into textual output.
423
350
 
424
351
    Commands normally don't have any state.  All their arguments are
430
357
    summary, then a complete description of the command.  A grammar
431
358
    description will be inserted.
432
359
 
433
 
    :cvar aliases: Other accepted names for this command.
434
 
 
435
 
    :cvar takes_args: List of argument forms, marked with whether they are
436
 
        optional, repeated, etc.  Examples::
437
 
 
438
 
            ['to_location', 'from_branch?', 'file*']
439
 
 
440
 
        * 'to_location' is required
441
 
        * 'from_branch' is optional
442
 
        * 'file' can be specified 0 or more times
443
 
 
444
 
    :cvar takes_options: List of options that may be given for this command.
445
 
        These can be either strings, referring to globally-defined options, or
446
 
        option objects.  Retrieve through options().
447
 
 
448
 
    :cvar hidden: If true, this command isn't advertised.  This is typically
 
360
    aliases
 
361
        Other accepted names for this command.
 
362
 
 
363
    takes_args
 
364
        List of argument forms, marked with whether they are optional,
 
365
        repeated, etc.
 
366
 
 
367
                Examples:
 
368
 
 
369
                ['to_location', 'from_branch?', 'file*']
 
370
 
 
371
                'to_location' is required
 
372
                'from_branch' is optional
 
373
                'file' can be specified 0 or more times
 
374
 
 
375
    takes_options
 
376
        List of options that may be given for this command.  These can
 
377
        be either strings, referring to globally-defined options,
 
378
        or option objects.  Retrieve through options().
 
379
 
 
380
    hidden
 
381
        If true, this command isn't advertised.  This is typically
449
382
        for commands intended for expert users.
450
383
 
451
 
    :cvar encoding_type: Command objects will get a 'outf' attribute, which has
452
 
        been setup to properly handle encoding of unicode strings.
453
 
        encoding_type determines what will happen when characters cannot be
454
 
        encoded:
455
 
 
456
 
        * strict - abort if we cannot decode
457
 
        * replace - put in a bogus character (typically '?')
458
 
        * exact - do not encode sys.stdout
459
 
 
460
 
        NOTE: by default on Windows, sys.stdout is opened as a text stream,
461
 
        therefore LF line-endings are converted to CRLF.  When a command uses
462
 
        encoding_type = 'exact', then sys.stdout is forced to be a binary
463
 
        stream, and line-endings will not mangled.
464
 
 
465
 
    :cvar invoked_as:
466
 
        A string indicating the real name under which this command was
467
 
        invoked, before expansion of aliases.
468
 
        (This may be None if the command was constructed and run in-process.)
 
384
    encoding_type
 
385
        Command objects will get a 'outf' attribute, which has been
 
386
        setup to properly handle encoding of unicode strings.
 
387
        encoding_type determines what will happen when characters cannot
 
388
        be encoded
 
389
            strict - abort if we cannot decode
 
390
            replace - put in a bogus character (typically '?')
 
391
            exact - do not encode sys.stdout
 
392
 
 
393
            NOTE: by default on Windows, sys.stdout is opened as a text
 
394
            stream, therefore LF line-endings are converted to CRLF.
 
395
            When a command uses encoding_type = 'exact', then
 
396
            sys.stdout is forced to be a binary stream, and line-endings
 
397
            will not mangled.
469
398
 
470
399
    :cvar hooks: An instance of CommandHooks.
471
 
 
472
 
    :cvar __doc__: The help shown by 'brz help command' for this command.
473
 
        This is set by assigning explicitly to __doc__ so that -OO can
474
 
        be used::
475
 
 
476
 
            class Foo(Command):
477
 
                __doc__ = "My help goes here"
478
400
    """
479
401
    aliases = []
480
402
    takes_args = []
481
403
    takes_options = []
482
404
    encoding_type = 'strict'
483
 
    invoked_as = None
484
 
    l10n = True
485
405
 
486
406
    hidden = False
487
407
 
488
408
    def __init__(self):
489
409
        """Construct an instance of this command."""
 
410
        if self.__doc__ == Command.__doc__:
 
411
            warn("No help message set for %r" % self)
490
412
        # List of standard options directly supported
491
413
        self.supported_std_options = []
492
414
        self._setup_run()
496
418
 
497
419
        Functions will be called in LIFO order.
498
420
        """
499
 
        self._exit_stack.callback(cleanup_func, *args, **kwargs)
 
421
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
500
422
 
501
423
    def cleanup_now(self):
502
424
        """Execute and empty pending cleanup functions immediately.
511
433
        as it releases all resources, this may release locks that the command
512
434
        wants to hold, so use should be done with care.
513
435
        """
514
 
        self._exit_stack.close()
515
 
 
516
 
    def enter_context(self, cm):
517
 
        return self._exit_stack.enter_context(cm)
 
436
        self._operation.cleanup_now()
 
437
 
 
438
    @deprecated_method(deprecated_in((2, 1, 0)))
 
439
    def _maybe_expand_globs(self, file_list):
 
440
        """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
 
 
445
        :return: A possibly empty list of unicode paths.
 
446
 
 
447
        Introduced in bzrlib 0.18.
 
448
        """
 
449
        return file_list
518
450
 
519
451
    def _usage(self):
520
452
        """Return single-line grammar for this command.
521
453
 
522
454
        Only describes arguments, not options.
523
455
        """
524
 
        s = 'brz ' + self.name() + ' '
 
456
        s = 'bzr ' + self.name() + ' '
525
457
        for aname in self.takes_args:
526
458
            aname = aname.upper()
527
459
            if aname[-1] in ['$', '+']:
549
481
            usage help (e.g. Purpose, Usage, Options) with a
550
482
            message explaining how to obtain full help.
551
483
        """
552
 
        if self.l10n:
553
 
            i18n.install()  # Install i18n only for get_help_text for now.
554
484
        doc = self.help()
555
 
        if doc:
556
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
557
 
            # be shown after "Description" section and we don't want to
558
 
            # translate the usage string.
559
 
            # Though, brz export-pot don't exports :Usage: section and it must
560
 
            # not be translated.
561
 
            doc = self.gettext(doc)
562
 
        else:
563
 
            doc = gettext("No help for this command.")
 
485
        if doc is None:
 
486
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
564
487
 
565
488
        # Extract the summary (purpose) and sections out from the text
566
 
        purpose, sections, order = self._get_help_parts(doc)
 
489
        purpose,sections,order = self._get_help_parts(doc)
567
490
 
568
491
        # If a custom usage section was provided, use it
569
 
        if 'Usage' in sections:
 
492
        if sections.has_key('Usage'):
570
493
            usage = sections.pop('Usage')
571
494
        else:
572
495
            usage = self._usage()
573
496
 
574
497
        # The header is the purpose and usage
575
498
        result = ""
576
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
499
        result += ':Purpose: %s\n' % purpose
577
500
        if usage.find('\n') >= 0:
578
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
501
            result += ':Usage:\n%s\n' % usage
579
502
        else:
580
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
503
            result += ':Usage:   %s\n' % usage
581
504
        result += '\n'
582
505
 
583
506
        # Add the options
585
508
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
586
509
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
587
510
        # 20090319
588
 
        parser = option.get_optparser(
589
 
            [v for k, v in sorted(self.options().items())])
590
 
        options = parser.format_option_help()
591
 
        # FIXME: According to the spec, ReST option lists actually don't
592
 
        # support options like --1.14 so that causes syntax errors (in Sphinx
593
 
        # at least).  As that pattern always appears in the commands that
594
 
        # break, we trap on that and then format that block of 'format' options
595
 
        # as a literal block. We use the most recent format still listed so we
596
 
        # don't have to do that too often -- vila 20110514
597
 
        if not plain and options.find('  --1.14  ') != -1:
 
511
        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:
598
518
            options = options.replace(' format:\n', ' format::\n\n', 1)
599
519
        if options.startswith('Options:'):
600
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
520
            result += ':' + options
 
521
        elif options.startswith('options:'):
 
522
            # Python 2.4 version of optparse
 
523
            result += ':Options:' + options[len('options:'):]
601
524
        else:
602
525
            result += options
603
526
        result += '\n'
605
528
        if verbose:
606
529
            # Add the description, indenting it 2 spaces
607
530
            # to match the indentation of the options
608
 
            if None in sections:
 
531
            if sections.has_key(None):
609
532
                text = sections.pop(None)
610
533
                text = '\n  '.join(text.splitlines())
611
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
534
                result += ':%s:\n  %s\n\n' % ('Description',text)
612
535
 
613
536
            # Add the custom sections (e.g. Examples). Note that there's no need
614
537
            # to indent these as they must be indented already in the source.
615
538
            if sections:
616
539
                for label in order:
617
 
                    if label in sections:
618
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
540
                    if sections.has_key(label):
 
541
                        result += ':%s:\n%s\n' % (label,sections[label])
619
542
                result += '\n'
620
543
        else:
621
 
            result += (gettext("See brz help %s for more details and examples.\n\n")
622
 
                       % self.name())
 
544
            result += ("See bzr help %s for more details and examples.\n\n"
 
545
                % self.name())
623
546
 
624
547
        # Add the aliases, source (plug-in) and see also links, if any
625
548
        if self.aliases:
626
 
            result += gettext(':Aliases:  ')
 
549
            result += ':Aliases:  '
627
550
            result += ', '.join(self.aliases) + '\n'
628
551
        plugin_name = self.plugin_name()
629
552
        if plugin_name is not None:
630
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
553
            result += ':From:     plugin "%s"\n' % plugin_name
631
554
        see_also = self.get_see_also(additional_see_also)
632
555
        if see_also:
633
556
            if not plain and see_also_as_links:
639
562
                        see_also_links.append(item)
640
563
                    else:
641
564
                        # Use a Sphinx link for this entry
642
 
                        link_text = gettext(":doc:`{0} <{1}-help>`").format(
643
 
                            item, item)
 
565
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
644
566
                        see_also_links.append(link_text)
645
567
                see_also = see_also_links
646
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
568
            result += ':See also: '
 
569
            result += ', '.join(see_also) + '\n'
647
570
 
648
571
        # If this will be rendered as plain text, convert it
649
572
        if plain:
650
 
            import breezy.help_topics
651
 
            result = breezy.help_topics.help_as_plain_text(result)
 
573
            import bzrlib.help_topics
 
574
            result = bzrlib.help_topics.help_as_plain_text(result)
652
575
        return result
653
576
 
654
577
    @staticmethod
665
588
        """
666
589
        def save_section(sections, order, label, section):
667
590
            if len(section) > 0:
668
 
                if label in sections:
 
591
                if sections.has_key(label):
669
592
                    sections[label] += '\n' + section
670
593
                else:
671
594
                    order.append(label)
675
598
        summary = lines.pop(0)
676
599
        sections = {}
677
600
        order = []
678
 
        label, section = None, ''
 
601
        label,section = None,''
679
602
        for line in lines:
680
603
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
681
604
                save_section(sections, order, label, section)
682
 
                label, section = line[1:-1], ''
683
 
            elif (label is not None and len(line) > 1 and
684
 
                    not line[0].isspace()):
 
605
                label,section = line[1:-1],''
 
606
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
685
607
                save_section(sections, order, label, section)
686
 
                label, section = None, line
 
608
                label,section = None,line
687
609
            else:
688
610
                if len(section) > 0:
689
611
                    section += '\n' + line
714
636
 
715
637
        Maps from long option name to option object."""
716
638
        r = Option.STD_OPTIONS.copy()
717
 
        std_names = set(r)
 
639
        std_names = r.keys()
718
640
        for o in self.takes_options:
719
 
            if isinstance(o, string_types):
 
641
            if isinstance(o, basestring):
720
642
                o = option.Option.OPTIONS[o]
721
643
            r[o.name] = o
722
644
            if o.name in std_names:
731
653
    def run_argv_aliases(self, argv, alias_argv=None):
732
654
        """Parse the command line and run with extra aliases in alias_argv."""
733
655
        args, opts = parse_args(self, argv, alias_argv)
734
 
        self._setup_outf()
735
656
 
736
657
        # Process the standard options
737
 
        if 'help' in opts:  # e.g. brz add --help
738
 
            self.outf.write(self.get_help_text())
 
658
        if 'help' in opts:  # e.g. bzr add --help
 
659
            sys.stdout.write(self.get_help_text())
739
660
            return 0
740
 
        if 'usage' in opts:  # e.g. brz add --usage
741
 
            self.outf.write(self.get_help_text(verbose=False))
 
661
        if 'usage' in opts:  # e.g. bzr add --usage
 
662
            sys.stdout.write(self.get_help_text(verbose=False))
742
663
            return 0
743
664
        trace.set_verbosity_level(option._verbosity_level)
744
665
        if 'verbose' in self.supported_std_options:
745
666
            opts['verbose'] = trace.is_verbose()
746
 
        elif 'verbose' in opts:
 
667
        elif opts.has_key('verbose'):
747
668
            del opts['verbose']
748
669
        if 'quiet' in self.supported_std_options:
749
670
            opts['quiet'] = trace.is_quiet()
750
 
        elif 'quiet' in opts:
 
671
        elif opts.has_key('quiet'):
751
672
            del opts['quiet']
 
673
 
752
674
        # mix arguments and options into one dictionary
753
675
        cmdargs = _match_argform(self.name(), self.takes_args, args)
754
676
        cmdopts = {}
758
680
        all_cmd_args = cmdargs.copy()
759
681
        all_cmd_args.update(cmdopts)
760
682
 
761
 
        try:
762
 
            return self.run(**all_cmd_args)
763
 
        finally:
764
 
            # reset it, so that other commands run in the same process won't
765
 
            # inherit state. Before we reset it, log any activity, so that it
766
 
            # gets properly tracked.
767
 
            ui.ui_factory.log_transport_activity(
768
 
                display=('bytes' in debug.debug_flags))
769
 
            trace.set_verbosity_level(0)
 
683
        self._setup_outf()
 
684
 
 
685
        return self.run(**all_cmd_args)
770
686
 
771
687
    def _setup_run(self):
772
688
        """Wrap the defined run method on self with a cleanup.
778
694
        you can override this method.
779
695
        """
780
696
        class_run = self.run
781
 
 
782
697
        def run(*args, **kwargs):
783
 
            for hook in Command.hooks['pre_command']:
784
 
                hook(self)
 
698
            self._operation = cleanup.OperationWithCleanups(class_run)
785
699
            try:
786
 
                with cleanup.ExitStack() as self._exit_stack:
787
 
                    return class_run(*args, **kwargs)
 
700
                return self._operation.run_simple(*args, **kwargs)
788
701
            finally:
789
 
                for hook in Command.hooks['post_command']:
790
 
                    hook(self)
 
702
                del self._operation
791
703
        self.run = run
792
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
 
793
710
    def run(self):
794
711
        """Actually run the command.
795
712
 
800
717
        shell error code if not.  It's OK for this method to allow
801
718
        an exception to raise up.
802
719
 
803
 
        This method is automatically wrapped by Command.__init__ with a
804
 
        ExitStack, stored as self._exit_stack. This can be used
 
720
        This method is automatically wrapped by Command.__init__ with a 
 
721
        cleanup operation, stored as self._operation. This can be used
805
722
        via self.add_cleanup to perform automatic cleanups at the end of
806
723
        run().
807
724
 
821
738
            return None
822
739
        return getdoc(self)
823
740
 
824
 
    def gettext(self, message):
825
 
        """Returns the gettext function used to translate this command's help.
826
 
 
827
 
        Commands provided by plugins should override this to use their
828
 
        own i18n system.
829
 
        """
830
 
        return i18n.gettext_per_paragraph(message)
831
 
 
832
741
    def name(self):
833
 
        """Return the canonical name for this command.
834
 
 
835
 
        The name under which it was actually invoked is available in invoked_as
836
 
        """
837
742
        return _unsquish_command_name(self.__class__.__name__)
838
743
 
839
744
    def plugin_name(self):
841
746
 
842
747
        :return: The name of the plugin or None if the command is builtin.
843
748
        """
844
 
        return plugin_name(self.__module__)
 
749
        mod_parts = self.__module__.split('.')
 
750
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
751
            return mod_parts[2]
 
752
        else:
 
753
            return None
845
754
 
846
755
 
847
756
class CommandHooks(Hooks):
853
762
        These are all empty initially, because by default nothing should get
854
763
        notified.
855
764
        """
856
 
        Hooks.__init__(self, "breezy.commands", "Command.hooks")
857
 
        self.add_hook(
858
 
            'extend_command',
 
765
        Hooks.__init__(self)
 
766
        self.create_hook(HookPoint('extend_command',
859
767
            "Called after creating a command object to allow modifications "
860
768
            "such as adding or removing options, docs etc. Called with the "
861
 
            "new breezy.commands.Command object.", (1, 13))
862
 
        self.add_hook(
863
 
            'get_command',
 
769
            "new bzrlib.commands.Command object.", (1, 13), None))
 
770
        self.create_hook(HookPoint('get_command',
864
771
            "Called when creating a single command. Called with "
865
772
            "(cmd_or_None, command_name). get_command should either return "
866
773
            "the cmd_or_None parameter, or a replacement Command object that "
867
774
            "should be used for the command. Note that the Command.hooks "
868
775
            "hooks are core infrastructure. Many users will prefer to use "
869
 
            "breezy.commands.register_command or plugin_cmds.register_lazy.",
870
 
            (1, 17))
871
 
        self.add_hook(
872
 
            'get_missing_command',
 
776
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
 
777
            (1, 17), None))
 
778
        self.create_hook(HookPoint('get_missing_command',
873
779
            "Called when creating a single command if no command could be "
874
780
            "found. Called with (command_name). get_missing_command should "
875
781
            "either return None, or a Command object to be used for the "
876
 
            "command.", (1, 17))
877
 
        self.add_hook(
878
 
            'list_commands',
 
782
            "command.", (1, 17), None))
 
783
        self.create_hook(HookPoint('list_commands',
879
784
            "Called when enumerating commands. Called with a set of "
880
785
            "cmd_name strings for all the commands found so far. This set "
881
786
            " is safe to mutate - e.g. to remove a command. "
882
787
            "list_commands should return the updated set of command names.",
883
 
            (1, 17))
884
 
        self.add_hook(
885
 
            'pre_command',
886
 
            "Called prior to executing a command. Called with the command "
887
 
            "object.", (2, 6))
888
 
        self.add_hook(
889
 
            'post_command',
890
 
            "Called after executing a command. Called with the command "
891
 
            "object.", (2, 6))
892
 
 
 
788
            (1, 17), None))
893
789
 
894
790
Command.hooks = CommandHooks()
895
791
 
903
799
    they take, and which commands will accept them.
904
800
    """
905
801
    # TODO: make it a method of the Command?
906
 
    parser = option.get_optparser(
907
 
        [v for k, v in sorted(command.options().items())])
 
802
    parser = option.get_optparser(command.options())
908
803
    if alias_argv is not None:
909
804
        args = alias_argv + argv
910
805
    else:
911
806
        args = argv
912
807
 
913
 
    # python 2's optparse raises this exception if a non-ascii
914
 
    # option name is given.  See http://bugs.python.org/issue2931
915
 
    try:
916
 
        options, args = parser.parse_args(args)
917
 
    except UnicodeEncodeError:
918
 
        raise errors.BzrCommandError(
919
 
            gettext('Only ASCII permitted in option names'))
920
 
 
921
 
    opts = dict((k, v) for k, v in options.__dict__.items() if
922
 
                v is not option.OptionParser.DEFAULT_VALUE)
 
808
    options, args = parser.parse_args(args)
 
809
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
 
810
                 v is not option.OptionParser.DEFAULT_VALUE])
923
811
    return args, opts
924
812
 
925
813
 
932
820
        if ap[-1] == '?':
933
821
            if args:
934
822
                argdict[argname] = args.pop(0)
935
 
        elif ap[-1] == '*':  # all remaining arguments
 
823
        elif ap[-1] == '*': # all remaining arguments
936
824
            if args:
937
825
                argdict[argname + '_list'] = args[:]
938
826
                args = []
940
828
                argdict[argname + '_list'] = None
941
829
        elif ap[-1] == '+':
942
830
            if not args:
943
 
                raise errors.BzrCommandError(gettext(
944
 
                    "command {0!r} needs one or more {1}").format(
945
 
                    cmd, argname.upper()))
 
831
                raise errors.BzrCommandError("command %r needs one or more %s"
 
832
                                             % (cmd, argname.upper()))
946
833
            else:
947
834
                argdict[argname + '_list'] = args[:]
948
835
                args = []
949
 
        elif ap[-1] == '$':  # all but one
 
836
        elif ap[-1] == '$': # all but one
950
837
            if len(args) < 2:
951
 
                raise errors.BzrCommandError(
952
 
                    gettext("command {0!r} needs one or more {1}").format(
953
 
                        cmd, argname.upper()))
 
838
                raise errors.BzrCommandError("command %r needs one or more %s"
 
839
                                             % (cmd, argname.upper()))
954
840
            argdict[argname + '_list'] = args[:-1]
955
841
            args[:-1] = []
956
842
        else:
957
843
            # just a plain arg
958
844
            argname = ap
959
845
            if not args:
960
 
                raise errors.BzrCommandError(
961
 
                    gettext("command {0!r} requires argument {1}").format(
962
 
                        cmd, argname.upper()))
 
846
                raise errors.BzrCommandError("command %r requires argument %s"
 
847
                               % (cmd, argname.upper()))
963
848
            else:
964
849
                argdict[argname] = args.pop(0)
965
850
 
966
851
    if args:
967
 
        raise errors.BzrCommandError(gettext(
968
 
            "extra argument to command {0}: {1}").format(
969
 
            cmd, args[0]))
 
852
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
853
                                     % (cmd, args[0]))
970
854
 
971
855
    return argdict
972
856
 
973
 
 
974
 
def apply_coveraged(the_callable, *args, **kwargs):
975
 
    import coverage
976
 
    cov = coverage.Coverage()
977
 
    try:
978
 
        config_file = cov.config.config_file
979
 
    except AttributeError:  # older versions of coverage
980
 
        config_file = cov.config_file
981
 
    os.environ['COVERAGE_PROCESS_START'] = config_file
982
 
    cov.start()
 
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
 
858
    # Cannot use "import trace", as that would import bzrlib.trace instead of
 
859
    # the standard library's trace.
 
860
    trace = __import__('trace')
 
861
 
 
862
    tracer = trace.Trace(count=1, trace=0)
 
863
    sys.settrace(tracer.globaltrace)
 
864
    threading.settrace(tracer.globaltrace)
 
865
 
983
866
    try:
984
867
        return exception_to_return_code(the_callable, *args, **kwargs)
985
868
    finally:
986
 
        cov.stop()
987
 
        cov.save()
 
869
        sys.settrace(None)
 
870
        results = tracer.results()
 
871
        results.write_results(show_missing=1, summary=False,
 
872
                              coverdir=dirname)
988
873
 
989
874
 
990
875
def apply_profiled(the_callable, *args, **kwargs):
996
881
        prof = hotshot.Profile(pfname)
997
882
        try:
998
883
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
999
 
                               **kwargs) or 0
 
884
                **kwargs) or 0
1000
885
        finally:
1001
886
            prof.close()
1002
887
        stats = hotshot.stats.load(pfname)
1003
888
        stats.strip_dirs()
1004
889
        stats.sort_stats('cum')   # 'time'
1005
 
        # XXX: Might like to write to stderr or the trace file instead but
1006
 
        # print_stats seems hardcoded to stdout
 
890
        ## XXX: Might like to write to stderr or the trace file instead but
 
891
        ## print_stats seems hardcoded to stdout
1007
892
        stats.print_stats(20)
1008
893
        return ret
1009
894
    finally:
1020
905
    """
1021
906
    try:
1022
907
        return the_callable(*args, **kwargs)
1023
 
    except (KeyboardInterrupt, Exception):
 
908
    except (KeyboardInterrupt, Exception), e:
1024
909
        # used to handle AssertionError and KeyboardInterrupt
1025
910
        # specially here, but hopefully they're handled ok by the logger now
1026
911
        exc_info = sys.exc_info()
1027
912
        exitcode = trace.report_exception(exc_info, sys.stderr)
1028
 
        if os.environ.get('BRZ_PDB'):
1029
 
            print('**** entering debugger')
 
913
        if os.environ.get('BZR_PDB'):
 
914
            print '**** entering debugger'
 
915
            tb = exc_info[2]
1030
916
            import pdb
1031
 
            pdb.post_mortem(exc_info[2])
 
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)
1032
937
        return exitcode
1033
938
 
1034
939
 
1035
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1036
 
    from breezy.lsprof import profile
1037
 
    ret, stats = profile(exception_to_return_code, the_callable,
1038
 
                         *args, **kwargs)
 
941
    from bzrlib.lsprof import profile
 
942
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1039
943
    stats.sort()
1040
944
    if filename is None:
1041
945
        stats.pprint()
1042
946
    else:
1043
947
        stats.save(filename)
1044
 
        trace.note(gettext('Profile data written to "%s".'), filename)
 
948
        trace.note('Profile data written to "%s".', filename)
1045
949
    return ret
1046
950
 
1047
951
 
 
952
@deprecated_function(deprecated_in((2, 2, 0)))
 
953
def shlex_split_unicode(unsplit):
 
954
    return cmdline.split(unsplit)
 
955
 
 
956
 
1048
957
def get_alias(cmd, config=None):
1049
958
    """Return an expanded alias, or None if no alias exists.
1050
959
 
1056
965
        If it is unspecified, the global config will be used.
1057
966
    """
1058
967
    if config is None:
1059
 
        import breezy.config
1060
 
        config = breezy.config.GlobalConfig()
 
968
        import bzrlib.config
 
969
        config = bzrlib.config.GlobalConfig()
1061
970
    alias = config.get_alias(cmd)
1062
971
    if (alias):
1063
972
        return cmdline.split(alias)
1100
1009
        Run under the Python lsprof profiler.
1101
1010
 
1102
1011
    --coverage
1103
 
        Generate code coverage report
 
1012
        Generate line coverage report in the specified directory.
1104
1013
 
1105
1014
    --concurrency
1106
 
        Specify the number of processes that can be run concurrently
1107
 
        (selftest).
 
1015
        Specify the number of processes that can be run concurrently (selftest).
1108
1016
    """
1109
 
    trace.mutter("breezy version: " + breezy.__version__)
1110
 
    argv = _specified_or_unicode_argv(argv)
1111
 
    trace.mutter("brz arguments: %r", argv)
 
1017
    trace.mutter("bazaar version: " + bzrlib.__version__)
 
1018
    argv = list(argv)
 
1019
    trace.mutter("bzr arguments: %r", argv)
1112
1020
 
1113
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1114
 
        opt_coverage = opt_no_l10n = opt_no_aliases = False
1115
 
    opt_lsprof_file = None
 
1021
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1022
                opt_no_aliases = False
 
1023
    opt_lsprof_file = opt_coverage_dir = None
1116
1024
 
1117
1025
    # --no-plugins is handled specially at a very early stage. We need
1118
1026
    # to load plugins before doing other command parsing so that they
1120
1028
 
1121
1029
    argv_copy = []
1122
1030
    i = 0
1123
 
    override_config = []
1124
1031
    while i < len(argv):
1125
1032
        a = argv[i]
1126
1033
        if a == '--profile':
1135
1042
            opt_no_plugins = True
1136
1043
        elif a == '--no-aliases':
1137
1044
            opt_no_aliases = True
1138
 
        elif a == '--no-l10n':
1139
 
            opt_no_l10n = True
1140
1045
        elif a == '--builtin':
1141
1046
            opt_builtin = True
1142
1047
        elif a == '--concurrency':
1143
 
            os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
 
1048
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1144
1049
            i += 1
1145
1050
        elif a == '--coverage':
1146
 
            opt_coverage = True
1147
 
        elif a == '--profile-imports':
1148
 
            pass  # already handled in startup script Bug #588277
 
1051
            opt_coverage_dir = argv[i + 1]
 
1052
            i += 1
1149
1053
        elif a.startswith('-D'):
1150
1054
            debug.debug_flags.add(a[2:])
1151
 
        elif a.startswith('-O'):
1152
 
            override_config.append(a[2:])
1153
1055
        else:
1154
1056
            argv_copy.append(a)
1155
1057
        i += 1
1156
1058
 
1157
 
    cmdline_overrides = breezy.get_global_state().cmdline_overrides
1158
 
    cmdline_overrides._from_cmdline(override_config)
1159
 
 
1160
1059
    debug.set_debug_flags_from_config()
1161
1060
 
1162
1061
    if not opt_no_plugins:
1178
1077
    if not opt_no_aliases:
1179
1078
        alias_argv = get_alias(argv[0])
1180
1079
        if alias_argv:
 
1080
            user_encoding = osutils.get_user_encoding()
 
1081
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
1181
1082
            argv[0] = alias_argv.pop(0)
1182
1083
 
1183
1084
    cmd = argv.pop(0)
 
1085
    # We want only 'ascii' command names, but the user may have typed
 
1086
    # in a Unicode name. In that case, they should just get a
 
1087
    # 'command not found' error later.
 
1088
 
1184
1089
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1185
 
    if opt_no_l10n:
1186
 
        cmd_obj.l10n = False
1187
1090
    run = cmd_obj.run_argv_aliases
1188
1091
    run_argv = [argv, alias_argv]
1189
1092
 
1193
1096
        saved_verbosity_level = option._verbosity_level
1194
1097
        option._verbosity_level = 0
1195
1098
        if opt_lsprof:
1196
 
            if opt_coverage:
 
1099
            if opt_coverage_dir:
1197
1100
                trace.warning(
1198
1101
                    '--coverage ignored, because --lsprof is in use.')
1199
1102
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1200
1103
        elif opt_profile:
1201
 
            if opt_coverage:
 
1104
            if opt_coverage_dir:
1202
1105
                trace.warning(
1203
1106
                    '--coverage ignored, because --profile is in use.')
1204
1107
            ret = apply_profiled(run, *run_argv)
1205
 
        elif opt_coverage:
1206
 
            ret = apply_coveraged(run, *run_argv)
 
1108
        elif opt_coverage_dir:
 
1109
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1207
1110
        else:
1208
1111
            ret = run(*run_argv)
1209
1112
        return ret or 0
1214
1117
        if 'memory' in debug.debug_flags:
1215
1118
            trace.debug_memory('Process status after command:', short=False)
1216
1119
        option._verbosity_level = saved_verbosity_level
1217
 
        # Reset the overrides
1218
 
        cmdline_overrides._reset()
1219
1120
 
1220
1121
 
1221
1122
def display_command(func):
1225
1126
            result = func(*args, **kwargs)
1226
1127
            sys.stdout.flush()
1227
1128
            return result
1228
 
        except IOError as e:
 
1129
        except IOError, e:
1229
1130
            if getattr(e, 'errno', None) is None:
1230
1131
                raise
1231
1132
            if e.errno != errno.EPIPE:
1243
1144
    if _list_bzr_commands in Command.hooks["list_commands"]:
1244
1145
        return
1245
1146
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1246
 
                                     "bzr commands")
 
1147
        "bzr commands")
1247
1148
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1248
 
                                     "bzr commands")
 
1149
        "bzr commands")
1249
1150
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1250
 
                                     "bzr plugin commands")
 
1151
        "bzr plugin commands")
1251
1152
    Command.hooks.install_named_hook("get_command", _get_external_command,
1252
 
                                     "bzr external command lookup")
1253
 
    Command.hooks.install_named_hook("get_missing_command",
1254
 
                                     _try_plugin_provider,
1255
 
                                     "bzr plugin-provider-db check")
 
1153
        "bzr external command lookup")
 
1154
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
 
1155
        "bzr plugin-provider-db check")
 
1156
 
1256
1157
 
1257
1158
 
1258
1159
def _specified_or_unicode_argv(argv):
1260
1161
    # the process arguments in a unicode-safe way.
1261
1162
    if argv is None:
1262
1163
        return osutils.get_unicode_argv()
1263
 
    new_argv = []
1264
 
    try:
1265
 
        # ensure all arguments are unicode strings
1266
 
        for a in argv:
1267
 
            if not isinstance(a, string_types):
1268
 
                raise ValueError('not native str or unicode: %r' % (a,))
1269
 
            if isinstance(a, bytes):
1270
 
                # For Python 2 only allow ascii native strings
1271
 
                a = a.decode('ascii')
1272
 
            new_argv.append(a)
1273
 
    except (ValueError, UnicodeDecodeError):
1274
 
        raise errors.BzrError("argv should be list of unicode strings.")
1275
 
    return new_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
1276
1176
 
1277
1177
 
1278
1178
def main(argv=None):
1279
1179
    """Main entry point of command-line interface.
1280
1180
 
1281
 
    Typically `breezy.initialize` should be called first.
 
1181
    Typically `bzrlib.initialize` should be called first.
1282
1182
 
1283
1183
    :param argv: list of unicode command-line arguments similar to sys.argv.
1284
1184
        argv[0] is script name usually, it will be ignored.
1285
1185
        Don't pass here sys.argv because this list contains plain strings
1286
1186
        and not unicode; pass None instead.
1287
1187
 
1288
 
    :return: exit code of brz command.
 
1188
    :return: exit code of bzr command.
1289
1189
    """
1290
 
    if argv is not None:
1291
 
        argv = argv[1:]
 
1190
    argv = _specified_or_unicode_argv(argv)
1292
1191
    _register_builtin_commands()
1293
1192
    ret = run_bzr_catch_errors(argv)
 
1193
    bzrlib.ui.ui_factory.log_transport_activity(
 
1194
        display=('bytes' in debug.debug_flags))
1294
1195
    trace.mutter("return code %d", ret)
1295
1196
    return ret
1296
1197
 
1299
1200
    """Run a bzr command with parameters as described by argv.
1300
1201
 
1301
1202
    This function assumed that that UI layer is setup, that symbol deprecations
1302
 
    are already applied, and that unicode decoding has already been performed
1303
 
    on argv.
 
1203
    are already applied, and that unicode decoding has already been performed on argv.
1304
1204
    """
1305
1205
    # done here so that they're covered for every test run
1306
1206
    install_bzr_command_hooks()
1308
1208
 
1309
1209
 
1310
1210
def run_bzr_catch_user_errors(argv):
1311
 
    """Run brz and report user errors, but let internal errors propagate.
 
1211
    """Run bzr and report user errors, but let internal errors propagate.
1312
1212
 
1313
1213
    This is used for the test suite, and might be useful for other programs
1314
1214
    that want to wrap the commandline interface.
1317
1217
    install_bzr_command_hooks()
1318
1218
    try:
1319
1219
        return run_bzr(argv)
1320
 
    except Exception as e:
 
1220
    except Exception, e:
1321
1221
        if (isinstance(e, (OSError, IOError))
1322
 
                or not getattr(e, 'internal_error', True)):
 
1222
            or not getattr(e, 'internal_error', True)):
1323
1223
            trace.report_exception(sys.exc_info(), sys.stderr)
1324
1224
            return 3
1325
1225
        else:
1350
1250
 
1351
1251
 
1352
1252
class Provider(object):
1353
 
    """Generic class to be overriden by plugins"""
 
1253
    '''Generic class to be overriden by plugins'''
1354
1254
 
1355
1255
    def plugin_for_command(self, cmd_name):
1356
 
        """Takes a command and returns the information for that plugin
 
1256
        '''Takes a command and returns the information for that plugin
1357
1257
 
1358
1258
        :return: A dictionary with all the available information
1359
 
            for the requested plugin
1360
 
        """
 
1259
        for the requested plugin
 
1260
        '''
1361
1261
        raise NotImplementedError
1362
1262
 
1363
1263
 
1364
1264
class ProvidersRegistry(registry.Registry):
1365
 
    """This registry exists to allow other providers to exist"""
 
1265
    '''This registry exists to allow other providers to exist'''
1366
1266
 
1367
1267
    def __iter__(self):
1368
 
        for key, provider in self.items():
 
1268
        for key, provider in self.iteritems():
1369
1269
            yield provider
1370
1270
 
1371
 
 
1372
1271
command_providers_registry = ProvidersRegistry()