← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: wang
  • Date: 2006-10-29 13:41:32 UTC
  • mto: (2104.4.1 wang_65714)
  • mto: This revision was merged to the branch mainline in revision 2109.
  • Revision ID: wang@ubuntu-20061029134132-3d7f4216f20c4aef
Replace python's difflib by patiencediff because the worst case 
performance is cubic for difflib and people commiting large data 
files are often hurt by this. The worst case performance of patience is 
quadratic. Fix bug 65714.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
1
 
# Copyright (C) 2006 by Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
28
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
29
29
# the profile output behind so it can be interactively examined?
30
30
 
 
31
import os
31
32
import sys
32
 
import os
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
import codecs
 
37
import errno
33
38
from warnings import warn
34
 
import errno
35
 
import codecs
36
39
 
37
40
import bzrlib
38
 
import bzrlib.errors as errors
39
 
from bzrlib.errors import (BzrError,
40
 
                           BzrCommandError,
41
 
                           BzrCheckError,
42
 
                           NotBranchError)
 
41
from bzrlib import (
 
42
    errors,
 
43
    option,
 
44
    osutils,
 
45
    trace,
 
46
    )
 
47
""")
 
48
 
 
49
from bzrlib.symbol_versioning import (
 
50
    deprecated_function,
 
51
    deprecated_method,
 
52
    zero_eight,
 
53
    zero_eleven,
 
54
    )
 
55
# Compatibility
43
56
from bzrlib.option import Option
44
 
import bzrlib.osutils
45
 
from bzrlib.revisionspec import RevisionSpec
46
 
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
 
import bzrlib.trace
48
 
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
 
57
 
49
58
 
50
59
plugin_cmds = {}
51
60
 
64
73
        k_unsquished = _unsquish_command_name(k)
65
74
    else:
66
75
        k_unsquished = k
67
 
    if not plugin_cmds.has_key(k_unsquished):
 
76
    if k_unsquished not in plugin_cmds:
68
77
        plugin_cmds[k_unsquished] = cmd
69
 
        mutter('registered plugin command %s', k_unsquished)
 
78
        trace.mutter('registered plugin command %s', k_unsquished)
70
79
        if decorate and k_unsquished in builtin_command_names():
71
80
            return _builtin_commands()[k_unsquished]
72
81
    elif decorate:
74
83
        plugin_cmds[k_unsquished] = cmd
75
84
        return result
76
85
    else:
77
 
        log_error('Two plugins defined the same command: %r' % k)
78
 
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
86
        trace.log_error('Two plugins defined the same command: %r' % k)
 
87
        trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
79
88
 
80
89
 
81
90
def _squish_command_name(cmd):
129
138
    """
130
139
    from bzrlib.externalcommand import ExternalCommand
131
140
 
132
 
    cmd_name = str(cmd_name)            # not unicode
 
141
    # We want only 'ascii' command names, but the user may have typed
 
142
    # in a Unicode name. In that case, they should just get a
 
143
    # 'command not found' error later.
 
144
    # In the future, we may actually support Unicode command names.
133
145
 
134
146
    # first look up this command under the specified name
135
147
    cmds = _get_cmd_dict(plugins_override=plugins_override)
147
159
    if cmd_obj:
148
160
        return cmd_obj
149
161
 
150
 
    raise BzrCommandError('unknown command "%s"' % cmd_name)
 
162
    raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
151
163
 
152
164
 
153
165
class Command(object):
219
231
 
220
232
        Maps from long option name to option object."""
221
233
        r = dict()
222
 
        r['help'] = Option.OPTIONS['help']
 
234
        r['help'] = option.Option.OPTIONS['help']
223
235
        for o in self.takes_options:
224
 
            if not isinstance(o, Option):
225
 
                o = Option.OPTIONS[o]
 
236
            if isinstance(o, basestring):
 
237
                o = option.Option.OPTIONS[o]
226
238
            r[o.name] = o
227
239
        return r
228
240
 
236
248
            self.outf = sys.stdout
237
249
            return
238
250
 
239
 
        output_encoding = bzrlib.osutils.get_terminal_encoding()
 
251
        output_encoding = osutils.get_terminal_encoding()
240
252
 
241
253
        # use 'replace' so that we don't abort if trying to write out
242
254
        # in e.g. the default C locale.
256
268
 
257
269
    def run_argv_aliases(self, argv, alias_argv=None):
258
270
        """Parse the command line and run with extra aliases in alias_argv."""
 
271
        if argv is None:
 
272
            warn("Passing None for [] is deprecated from bzrlib 0.10", 
 
273
                 DeprecationWarning, stacklevel=2)
 
274
            argv = []
259
275
        args, opts = parse_args(self, argv, alias_argv)
260
276
        if 'help' in opts:  # e.g. bzr add --help
261
277
            from bzrlib.help import help_on_command
262
278
            help_on_command(self.name())
263
279
            return 0
264
 
        # XXX: This should be handled by the parser
265
 
        allowed_names = self.options().keys()
266
 
        for oname in opts:
267
 
            if oname not in allowed_names:
268
 
                raise BzrOptionError("option '--%s' is not allowed for"
269
 
                                " command %r" % (oname, self.name()))
270
280
        # mix arguments and options into one dictionary
271
281
        cmdargs = _match_argform(self.name(), self.takes_args, args)
272
282
        cmdopts = {}
315
325
            return None
316
326
 
317
327
 
 
328
# Technically, this function hasn't been use in a *really* long time
 
329
# but we are only deprecating it now.
 
330
@deprecated_function(zero_eleven)
318
331
def parse_spec(spec):
319
332
    """
320
333
    >>> parse_spec(None)
354
367
    lookup table, something about the available options, what optargs
355
368
    they take, and which commands will accept them.
356
369
    """
357
 
    # TODO: chop up this beast; make it a method of the Command
358
 
    args = []
359
 
    opts = {}
360
 
    alias_opts = {}
361
 
 
362
 
    cmd_options = command.options()
363
 
    argsover = False
364
 
    proc_aliasarg = True # Are we processing alias_argv now?
365
 
    for proc_argv in alias_argv, argv:
366
 
        while proc_argv:
367
 
            a = proc_argv.pop(0)
368
 
            if argsover:
369
 
                args.append(a)
370
 
                continue
371
 
            elif a == '-':
372
 
                args.append(a)
373
 
                continue
374
 
            elif a == '--':
375
 
                # We've received a standalone -- No more flags
376
 
                argsover = True
377
 
                continue
378
 
            if a[0] == '-':
379
 
                # option names must not be unicode
380
 
                a = str(a)
381
 
                optarg = None
382
 
                if a[1] == '-':
383
 
                    mutter("  got option %r", a)
384
 
                    if '=' in a:
385
 
                        optname, optarg = a[2:].split('=', 1)
386
 
                    else:
387
 
                        optname = a[2:]
388
 
                    if optname not in cmd_options:
389
 
                        raise BzrCommandError('unknown option "%s"' % a)
390
 
                else:
391
 
                    shortopt = a[1:]
392
 
                    if shortopt in Option.SHORT_OPTIONS:
393
 
                        # Multi-character options must have a space to delimit
394
 
                        # their value
395
 
                        # ^^^ what does this mean? mbp 20051014
396
 
                        optname = Option.SHORT_OPTIONS[shortopt].name
397
 
                    else:
398
 
                        # Single character short options, can be chained,
399
 
                        # and have their value appended to their name
400
 
                        shortopt = a[1:2]
401
 
                        if shortopt not in Option.SHORT_OPTIONS:
402
 
                            # We didn't find the multi-character name, and we
403
 
                            # didn't find the single char name
404
 
                            raise BzrCommandError('unknown option "%s"' % a)
405
 
                        optname = Option.SHORT_OPTIONS[shortopt].name
406
 
 
407
 
                        if a[2:]:
408
 
                            # There are extra things on this option
409
 
                            # see if it is the value, or if it is another
410
 
                            # short option
411
 
                            optargfn = Option.OPTIONS[optname].type
412
 
                            if optargfn is None:
413
 
                                # This option does not take an argument, so the
414
 
                                # next entry is another short option, pack it
415
 
                                # back into the list
416
 
                                proc_argv.insert(0, '-' + a[2:])
417
 
                            else:
418
 
                                # This option takes an argument, so pack it
419
 
                                # into the array
420
 
                                optarg = a[2:]
421
 
                    if optname not in cmd_options:
422
 
                        raise BzrCommandError('unknown option "%s"' % shortopt)
423
 
                if optname in opts:
424
 
                    # XXX: Do we ever want to support this, e.g. for -r?
425
 
                    if proc_aliasarg:
426
 
                        raise BzrCommandError('repeated option %r' % a)
427
 
                    elif optname in alias_opts:
428
 
                        # Replace what's in the alias with what's in the real
429
 
                        # argument
430
 
                        del alias_opts[optname]
431
 
                        del opts[optname]
432
 
                        proc_argv.insert(0, a)
433
 
                        continue
434
 
                    else:
435
 
                        raise BzrCommandError('repeated option %r' % a)
436
 
                    
437
 
                option_obj = cmd_options[optname]
438
 
                optargfn = option_obj.type
439
 
                if optargfn:
440
 
                    if optarg == None:
441
 
                        if not proc_argv:
442
 
                            raise BzrCommandError('option %r needs an argument' % a)
443
 
                        else:
444
 
                            optarg = proc_argv.pop(0)
445
 
                    opts[optname] = optargfn(optarg)
446
 
                    if proc_aliasarg:
447
 
                        alias_opts[optname] = optargfn(optarg)
448
 
                else:
449
 
                    if optarg != None:
450
 
                        raise BzrCommandError('option %r takes no argument' % optname)
451
 
                    opts[optname] = True
452
 
                    if proc_aliasarg:
453
 
                        alias_opts[optname] = True
454
 
            else:
455
 
                args.append(a)
456
 
        proc_aliasarg = False # Done with alias argv
 
370
    # TODO: make it a method of the Command?
 
371
    parser = option.get_optparser(command.options())
 
372
    if alias_argv is not None:
 
373
        args = alias_argv + argv
 
374
    else:
 
375
        args = argv
 
376
 
 
377
    options, args = parser.parse_args(args)
 
378
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if 
 
379
                 v is not option.OptionParser.DEFAULT_VALUE])
457
380
    return args, opts
458
381
 
459
382
 
474
397
                argdict[argname + '_list'] = None
475
398
        elif ap[-1] == '+':
476
399
            if not args:
477
 
                raise BzrCommandError("command %r needs one or more %s"
478
 
                        % (cmd, argname.upper()))
 
400
                raise errors.BzrCommandError("command %r needs one or more %s"
 
401
                                             % (cmd, argname.upper()))
479
402
            else:
480
403
                argdict[argname + '_list'] = args[:]
481
404
                args = []
482
405
        elif ap[-1] == '$': # all but one
483
406
            if len(args) < 2:
484
 
                raise BzrCommandError("command %r needs one or more %s"
485
 
                        % (cmd, argname.upper()))
 
407
                raise errors.BzrCommandError("command %r needs one or more %s"
 
408
                                             % (cmd, argname.upper()))
486
409
            argdict[argname + '_list'] = args[:-1]
487
410
            args[:-1] = []
488
411
        else:
489
412
            # just a plain arg
490
413
            argname = ap
491
414
            if not args:
492
 
                raise BzrCommandError("command %r requires argument %s"
493
 
                        % (cmd, argname.upper()))
 
415
                raise errors.BzrCommandError("command %r requires argument %s"
 
416
                               % (cmd, argname.upper()))
494
417
            else:
495
418
                argdict[argname] = args.pop(0)
496
419
            
497
420
    if args:
498
 
        raise BzrCommandError("extra argument to command %s: %s"
499
 
                              % (cmd, args[0]))
 
421
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
422
                                     % (cmd, args[0]))
500
423
 
501
424
    return argdict
502
425
 
609
532
        elif a == '--builtin':
610
533
            opt_builtin = True
611
534
        elif a in ('--quiet', '-q'):
612
 
            be_quiet()
 
535
            trace.be_quiet()
613
536
        else:
614
537
            argv_copy.append(a)
615
538
        i += 1
621
544
        return 0
622
545
 
623
546
    if argv[0] == '--version':
624
 
        from bzrlib.builtins import show_version
 
547
        from bzrlib.version import show_version
625
548
        show_version()
626
549
        return 0
627
550
        
640
563
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
641
564
            argv[0] = alias_argv.pop(0)
642
565
 
643
 
    cmd = str(argv.pop(0))
 
566
    cmd = argv.pop(0)
 
567
    # We want only 'ascii' command names, but the user may have typed
 
568
    # in a Unicode name. In that case, they should just get a
 
569
    # 'command not found' error later.
644
570
 
645
571
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
646
572
    if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
660
586
        return ret or 0
661
587
    finally:
662
588
        # reset, in case we may do other commands later within the same process
663
 
        be_quiet(False)
 
589
        trace.be_quiet(False)
664
590
 
665
591
def display_command(func):
666
592
    """Decorator that suppresses pipe/interrupt errors."""
670
596
            sys.stdout.flush()
671
597
            return result
672
598
        except IOError, e:
673
 
            if not hasattr(e, 'errno'):
 
599
            if getattr(e, 'errno', None) is None:
674
600
                raise
675
601
            if e.errno != errno.EPIPE:
676
602
                # Win32 raises IOError with errno=0 on a broken pipe
688
614
    bzrlib.ui.ui_factory = TextUIFactory()
689
615
    argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
690
616
    ret = run_bzr_catch_errors(argv)
691
 
    mutter("return code %d", ret)
 
617
    trace.mutter("return code %d", ret)
692
618
    return ret
693
619
 
694
620
 
697
623
        return run_bzr(argv)
698
624
        # do this here inside the exception wrappers to catch EPIPE
699
625
        sys.stdout.flush()
700
 
    except Exception, e:
 
626
    except (KeyboardInterrupt, Exception), e:
701
627
        # used to handle AssertionError and KeyboardInterrupt
702
628
        # specially here, but hopefully they're handled ok by the logger now
703
 
        bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
 
629
        trace.report_exception(sys.exc_info(), sys.stderr)
704
630
        if os.environ.get('BZR_PDB'):
705
631
            print '**** entering debugger'
706
632
            import pdb