1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
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?
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
28
# TODO: Help messages for options.
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
38
from warnings import warn
39
from inspect import getdoc
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib import BZRDIR
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
51
def register_command(cmd):
52
"Utility function to help register a command"
73
55
if k.startswith("cmd_"):
74
56
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
67
def _squish_command_name(cmd):
97
73
return cmd[4:].replace('_','-')
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
79
This always returns a list. The list will have one element for
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
121
BzrError: No namespace registered for string: 'abc'
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
128
warning('Colon separator for revision numbers is deprecated.'
130
for rev in revstr.split(':'):
132
revs.append(RevisionSpec(int(rev)))
134
revs.append(RevisionSpec(None))
136
for x in revstr.split('..'):
138
revs.append(RevisionSpec(None))
140
revs.append(RevisionSpec(x))
100
144
def _builtin_commands():
101
145
import bzrlib.builtins
103
147
builtins = bzrlib.builtins.__dict__
104
148
for name in builtins:
105
149
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
150
real_name = _unsquish_command_name(name)
107
151
r[real_name] = builtins[name]
111
156
def builtin_command_names():
188
230
List of argument forms, marked with whether they are optional,
193
['to_location', 'from_branch?', 'file*']
195
'to_location' is required
196
'from_branch' is optional
197
'file' can be specified 0 or more times
200
List of options that may be given for this command. These can
201
be either strings, referring to globally-defined options,
202
or option objects. Retrieve through options().
234
List of options that may be given for this command.
205
237
If true, this command isn't advertised. This is typically
206
238
for commands intended for expert users.
209
Command objects will get a 'outf' attribute, which has been
210
setup to properly handle encoding of unicode strings.
211
encoding_type determines what will happen when characters cannot
213
strict - abort if we cannot decode
214
replace - put in a bogus character (typically '?')
215
exact - do not encode sys.stdout
217
NOTE: by default on Windows, sys.stdout is opened as a text
218
stream, therefore LF line-endings are converted to CRLF.
219
When a command uses encoding_type = 'exact', then
220
sys.stdout is forced to be a binary stream, and line-endings
226
243
takes_options = []
227
encoding_type = 'strict'
233
249
if self.__doc__ == Command.__doc__:
234
250
warn("No help message set for %r" % self)
237
"""Return dict of valid options for this command.
239
Maps from long option name to option object."""
241
r['help'] = option.Option.OPTIONS['help']
242
for o in self.takes_options:
243
if isinstance(o, basestring):
244
o = option.Option.OPTIONS[o]
248
def _setup_outf(self):
249
"""Return a file linked to stdout, which has proper encoding."""
250
assert self.encoding_type in ['strict', 'exact', 'replace']
252
# Originally I was using self.stdout, but that looks
253
# *way* too much like sys.stdout
254
if self.encoding_type == 'exact':
255
# force sys.stdout to be binary stream on win32
256
if sys.platform == 'win32':
257
fileno = getattr(sys.stdout, 'fileno', None)
260
msvcrt.setmode(fileno(), os.O_BINARY)
261
self.outf = sys.stdout
264
output_encoding = osutils.get_terminal_encoding()
266
# use 'replace' so that we don't abort if trying to write out
267
# in e.g. the default C locale.
268
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
269
# For whatever reason codecs.getwriter() does not advertise its encoding
270
# it just returns the encoding of the wrapped file, which is completely
271
# bogus. So set the attribute, so we can find the correct encoding later.
272
self.outf.encoding = output_encoding
274
@deprecated_method(zero_eight)
275
253
def run_argv(self, argv):
276
"""Parse command line and run.
278
See run_argv_aliases for the 0.8 and beyond api.
280
return self.run_argv_aliases(argv)
254
"""Parse command line and run."""
255
args, opts = parse_args(argv)
282
def run_argv_aliases(self, argv, alias_argv=None):
283
"""Parse the command line and run with extra aliases in alias_argv."""
285
warn("Passing None for [] is deprecated from bzrlib 0.10",
286
DeprecationWarning, stacklevel=2)
288
args, opts = parse_args(self, argv, alias_argv)
289
257
if 'help' in opts: # e.g. bzr add --help
290
258
from bzrlib.help import help_on_command
291
259
help_on_command(self.name())
262
# check options are reasonable
263
allowed = self.takes_options
265
if oname not in allowed:
266
raise BzrCommandError("option '--%s' is not allowed for command %r"
267
% (oname, self.name()))
293
269
# mix arguments and options into one dictionary
294
270
cmdargs = _match_argform(self.name(), self.takes_args, args)
372
332
parsed = [spec, None]
375
def parse_args(command, argv, alias_argv=None):
336
# list of all available options; the rhs can be either None for an
337
# option that takes no argument, or a constructor function that checks
351
'revision': _parse_revision_str,
376
def parse_args(argv):
376
377
"""Parse command line.
378
379
Arguments and options are parsed at this level before being passed
379
380
down to specific command handlers. This routine knows, from a
380
381
lookup table, something about the available options, what optargs
381
382
they take, and which commands will accept them.
384
>>> parse_args('--help'.split())
386
>>> parse_args('help -- --invalidcmd'.split())
387
(['help', '--invalidcmd'], {})
388
>>> parse_args('--version'.split())
389
([], {'version': True})
390
>>> parse_args('status --all'.split())
391
(['status'], {'all': True})
392
>>> parse_args('commit --message=biter'.split())
393
(['commit'], {'message': u'biter'})
394
>>> parse_args('log -r 500'.split())
395
(['log'], {'revision': [<RevisionSpec_int 500>]})
396
>>> parse_args('log -r500..600'.split())
397
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
398
>>> parse_args('log -vr500..600'.split())
399
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
400
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
401
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
383
# TODO: make it a method of the Command?
384
parser = option.get_optparser(command.options())
385
if alias_argv is not None:
386
args = alias_argv + argv
390
options, args = parser.parse_args(args)
391
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
392
v is not option.OptionParser.DEFAULT_VALUE])
409
if not argsover and a[0] == '-':
410
# option names must not be unicode
415
# We've received a standalone -- No more flags
418
mutter(" got option %r" % a)
420
optname, optarg = a[2:].split('=', 1)
423
if optname not in OPTIONS:
424
raise BzrError('unknown long option %r' % a)
427
if shortopt in SHORT_OPTIONS:
428
# Multi-character options must have a space to delimit
430
optname = SHORT_OPTIONS[shortopt]
432
# Single character short options, can be chained,
433
# and have their value appended to their name
435
if shortopt not in SHORT_OPTIONS:
436
# We didn't find the multi-character name, and we
437
# didn't find the single char name
438
raise BzrError('unknown short option %r' % a)
439
optname = SHORT_OPTIONS[shortopt]
442
# There are extra things on this option
443
# see if it is the value, or if it is another
445
optargfn = OPTIONS[optname]
447
# This option does not take an argument, so the
448
# next entry is another short option, pack it back
450
argv.insert(0, '-' + a[2:])
452
# This option takes an argument, so pack it
457
# XXX: Do we ever want to support this, e.g. for -r?
458
raise BzrError('repeated option %r' % a)
460
optargfn = OPTIONS[optname]
464
raise BzrError('option %r needs an argument' % a)
467
opts[optname] = optargfn(optarg)
470
raise BzrError('option %r takes no argument' % optname)
393
475
return args, opts
396
480
def _match_argform(cmd, takes_args, args):
410
494
argdict[argname + '_list'] = None
411
495
elif ap[-1] == '+':
413
raise errors.BzrCommandError("command %r needs one or more %s"
414
% (cmd, argname.upper()))
497
raise BzrCommandError("command %r needs one or more %s"
498
% (cmd, argname.upper()))
416
500
argdict[argname + '_list'] = args[:]
418
502
elif ap[-1] == '$': # all but one
419
503
if len(args) < 2:
420
raise errors.BzrCommandError("command %r needs one or more %s"
421
% (cmd, argname.upper()))
504
raise BzrCommandError("command %r needs one or more %s"
505
% (cmd, argname.upper()))
422
506
argdict[argname + '_list'] = args[:-1]
425
509
# just a plain arg
428
raise errors.BzrCommandError("command %r requires argument %s"
429
% (cmd, argname.upper()))
512
raise BzrCommandError("command %r requires argument %s"
513
% (cmd, argname.upper()))
431
515
argdict[argname] = args.pop(0)
434
raise errors.BzrCommandError("extra argument to command %s: %s"
518
raise BzrCommandError("extra argument to command %s: %s"
449
532
ret = prof.runcall(the_callable, *args, **kwargs) or 0
452
537
stats = hotshot.stats.load(pfname)
454
stats.sort_stats('cum') # 'time'
539
stats.sort_stats('time')
455
540
## XXX: Might like to write to stderr or the trace file instead but
456
541
## print_stats seems hardcoded to stdout
457
542
stats.print_stats(20)
460
546
os.close(pffileno)
461
547
os.remove(pfname)
464
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
465
from bzrlib.lsprof import profile
467
ret, stats = profile(the_callable, *args, **kwargs)
473
cPickle.dump(stats, open(filename, 'w'), 2)
474
print 'Profile data written to %r.' % filename
478
def get_alias(cmd, config=None):
479
"""Return an expanded alias, or None if no alias exists.
482
Command to be checked for an alias.
484
Used to specify an alternative config to use,
485
which is especially useful for testing.
486
If it is unspecified, the global config will be used.
490
config = bzrlib.config.GlobalConfig()
491
alias = config.get_alias(cmd)
494
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
498
550
def run_bzr(argv):
499
551
"""Execute a command.
515
565
Do not load plugin modules at all
521
568
Only use builtin commands. (Plugins are still allowed to change
522
569
other behaviour.)
525
Run under the Python hotshot profiler.
528
Run under the Python lsprof profiler.
572
Run under the Python profiler.
531
trace.mutter("bzr arguments: %r", argv)
574
# Load all of the transport methods
575
import bzrlib.transport.local, bzrlib.transport.http
577
argv = [a.decode(bzrlib.user_encoding) for a in argv]
533
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
534
opt_no_aliases = False
535
opt_lsprof_file = None
579
opt_profile = opt_no_plugins = opt_builtin = False
537
581
# --no-plugins is handled specially at a very early stage. We need
538
582
# to load plugins before doing other command parsing so that they
539
583
# can override commands, but this needs to happen first.
545
586
if a == '--profile':
546
587
opt_profile = True
547
elif a == '--lsprof':
549
elif a == '--lsprof-file':
551
opt_lsprof_file = argv[i + 1]
553
588
elif a == '--no-plugins':
554
589
opt_no_plugins = True
555
elif a == '--no-aliases':
556
opt_no_aliases = True
557
590
elif a == '--builtin':
558
591
opt_builtin = True
559
elif a in ('--quiet', '-q'):
561
elif a.startswith('-D'):
562
debug.debug_flags.add(a[2:])
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
596
if (not argv) or (argv[0] == '--help'):
597
from bzrlib.help import help
573
604
if argv[0] == '--version':
574
from bzrlib.version import show_version
605
from bzrlib.builtins import show_version
578
609
if not opt_no_plugins:
579
610
from bzrlib.plugin import load_plugins
582
from bzrlib.plugin import disable_plugins
587
if not opt_no_aliases:
588
alias_argv = get_alias(argv[0])
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
591
argv[0] = alias_argv.pop(0)
594
# We want only 'ascii' command names, but the user may have typed
595
# in a Unicode name. In that case, they should just get a
596
# 'command not found' error later.
613
cmd = str(argv.pop(0))
598
615
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
618
ret = apply_profiled(cmd_obj.run_argv, argv)
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
616
trace.be_quiet(False)
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
622
result = func(*args, **kwargs)
626
if getattr(e, 'errno', None) is None:
628
if e.errno != errno.EPIPE:
629
# Win32 raises IOError with errno=0 on a broken pipe
630
if sys.platform != 'win32' or e.errno != 0:
633
except KeyboardInterrupt:
620
ret = cmd_obj.run_argv(argv)
640
from bzrlib.ui.text import TextUIFactory
641
bzrlib.ui.ui_factory = TextUIFactory()
642
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
643
ret = run_bzr_catch_errors(argv)
644
trace.mutter("return code %d", ret)
626
bzrlib.trace.log_startup(argv)
627
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
629
return run_bzr_catch_errors(argv[1:])
648
632
def run_bzr_catch_errors(argv):
651
# do this here inside the exception wrappers to catch EPIPE
653
except (KeyboardInterrupt, Exception), e:
654
# used to handle AssertionError and KeyboardInterrupt
655
# specially here, but hopefully they're handled ok by the logger now
656
trace.report_exception(sys.exc_info(), sys.stderr)
657
if os.environ.get('BZR_PDB'):
658
print '**** entering debugger'
660
pdb.post_mortem(sys.exc_traceback)
638
# do this here inside the exception wrappers to catch EPIPE
640
#wrap common errors as CommandErrors.
641
except (NotBranchError,), e:
642
raise BzrCommandError(str(e))
643
except BzrCommandError, e:
644
# command line syntax error, etc
648
bzrlib.trace.log_exception()
650
except AssertionError, e:
651
bzrlib.trace.log_exception('assertion failed: ' + str(e))
653
except KeyboardInterrupt, e:
654
bzrlib.trace.log_exception('interrupted')
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
664
bzrlib.trace.log_exception()
663
667
if __name__ == '__main__':
664
668
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
