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: Help messages for options.
21
23
# TODO: Define arguments by objects, rather than just using names.
22
24
# 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?
25
# would help with validation and shell completion.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
31
from warnings import warn
32
from inspect import getdoc
49
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
44
def register_command(cmd):
45
"Utility function to help register a command"
72
48
if k.startswith("cmd_"):
73
49
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
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__])
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
90
60
def _squish_command_name(cmd):
96
66
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
99
153
def _builtin_commands():
100
154
import bzrlib.builtins
102
156
builtins = bzrlib.builtins.__dict__
103
157
for name in builtins:
104
158
if name.startswith("cmd_"):
105
real_name = _unsquish_command_name(name)
159
real_name = _unsquish_command_name(name)
106
160
r[real_name] = builtins[name]
110
165
def builtin_command_names():
187
239
List of argument forms, marked with whether they are optional,
192
['to_location', 'from_branch?', 'file*']
194
'to_location' is required
195
'from_branch' is optional
196
'file' can be specified 0 or more times
199
List of options that may be given for this command. These can
200
be either strings, referring to globally-defined options,
201
or option objects. Retrieve through options().
243
List of options that may be given for this command.
204
246
If true, this command isn't advertised. This is typically
205
247
for commands intended for expert users.
208
Command objects will get a 'outf' attribute, which has been
209
setup to properly handle encoding of unicode strings.
210
encoding_type determines what will happen when characters cannot
212
strict - abort if we cannot decode
213
replace - put in a bogus character (typically '?')
214
exact - do not encode sys.stdout
219
252
takes_options = []
220
encoding_type = 'strict'
226
258
if self.__doc__ == Command.__doc__:
227
259
warn("No help message set for %r" % self)
230
"""Return dict of valid options for this command.
232
Maps from long option name to option object."""
234
r['help'] = option.Option.OPTIONS['help']
235
for o in self.takes_options:
236
if isinstance(o, basestring):
237
o = option.Option.OPTIONS[o]
241
def _setup_outf(self):
242
"""Return a file linked to stdout, which has proper encoding."""
243
assert self.encoding_type in ['strict', 'exact', 'replace']
245
# Originally I was using self.stdout, but that looks
246
# *way* too much like sys.stdout
247
if self.encoding_type == 'exact':
248
self.outf = sys.stdout
251
output_encoding = osutils.get_terminal_encoding()
253
# use 'replace' so that we don't abort if trying to write out
254
# in e.g. the default C locale.
255
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
256
# For whatever reason codecs.getwriter() does not advertise its encoding
257
# it just returns the encoding of the wrapped file, which is completely
258
# bogus. So set the attribute, so we can find the correct encoding later.
259
self.outf.encoding = output_encoding
261
@deprecated_method(zero_eight)
262
262
def run_argv(self, argv):
263
"""Parse command line and run.
265
See run_argv_aliases for the 0.8 and beyond api.
267
return self.run_argv_aliases(argv)
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
269
def run_argv_aliases(self, argv, alias_argv=None):
270
"""Parse the command line and run with extra aliases in alias_argv."""
272
warn("Passing None for [] is deprecated from bzrlib 0.10",
273
DeprecationWarning, stacklevel=2)
275
args, opts = parse_args(self, argv, alias_argv)
276
266
if 'help' in opts: # e.g. bzr add --help
277
267
from bzrlib.help import help_on_command
278
268
help_on_command(self.name())
271
# check options are reasonable
272
allowed = self.takes_options
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
280
278
# mix arguments and options into one dictionary
281
279
cmdargs = _match_argform(self.name(), self.takes_args, args)
359
341
parsed = [spec, None]
362
def parse_args(command, argv, alias_argv=None):
347
# list of all available options; the rhs can be either None for an
348
# option that takes no argument, or a constructor function that checks
361
'revision': _parse_revision_str,
373
'merge-type': get_merge_type,
387
def parse_args(argv):
363
388
"""Parse command line.
365
390
Arguments and options are parsed at this level before being passed
366
391
down to specific command handlers. This routine knows, from a
367
392
lookup table, something about the available options, what optargs
368
393
they take, and which commands will accept them.
395
>>> parse_args('--help'.split())
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
399
>>> parse_args('--version'.split())
400
([], {'version': True})
401
>>> parse_args('status --all'.split())
402
(['status'], {'all': True})
403
>>> parse_args('commit --message=biter'.split())
404
(['commit'], {'message': u'biter'})
405
>>> parse_args('log -r 500'.split())
406
(['log'], {'revision': [500]})
407
>>> parse_args('log -r500..600'.split())
408
(['log'], {'revision': [500, 600]})
409
>>> parse_args('log -vr500..600'.split())
410
(['log'], {'verbose': True, 'revision': [500, 600]})
411
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
(['log'], {'revision': ['v500', 600]})
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
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])
420
if not argsover and a[0] == '-':
421
# option names must not be unicode
426
# We've received a standalone -- No more flags
429
mutter(" got option %r" % a)
431
optname, optarg = a[2:].split('=', 1)
434
if optname not in OPTIONS:
435
raise BzrError('unknown long option %r' % a)
438
if shortopt in SHORT_OPTIONS:
439
# Multi-character options must have a space to delimit
441
optname = SHORT_OPTIONS[shortopt]
443
# Single character short options, can be chained,
444
# and have their value appended to their name
446
if shortopt not in SHORT_OPTIONS:
447
# We didn't find the multi-character name, and we
448
# didn't find the single char name
449
raise BzrError('unknown short option %r' % a)
450
optname = SHORT_OPTIONS[shortopt]
453
# There are extra things on this option
454
# see if it is the value, or if it is another
456
optargfn = OPTIONS[optname]
458
# This option does not take an argument, so the
459
# next entry is another short option, pack it back
461
argv.insert(0, '-' + a[2:])
463
# This option takes an argument, so pack it
468
# XXX: Do we ever want to support this, e.g. for -r?
469
raise BzrError('repeated option %r' % a)
471
optargfn = OPTIONS[optname]
475
raise BzrError('option %r needs an argument' % a)
478
opts[optname] = optargfn(optarg)
481
raise BzrError('option %r takes no argument' % optname)
380
486
return args, opts
383
491
def _match_argform(cmd, takes_args, args):
397
505
argdict[argname + '_list'] = None
398
506
elif ap[-1] == '+':
400
raise errors.BzrCommandError("command %r needs one or more %s"
401
% (cmd, argname.upper()))
508
raise BzrCommandError("command %r needs one or more %s"
509
% (cmd, argname.upper()))
403
511
argdict[argname + '_list'] = args[:]
405
513
elif ap[-1] == '$': # all but one
406
514
if len(args) < 2:
407
raise errors.BzrCommandError("command %r needs one or more %s"
408
% (cmd, argname.upper()))
515
raise BzrCommandError("command %r needs one or more %s"
516
% (cmd, argname.upper()))
409
517
argdict[argname + '_list'] = args[:-1]
412
520
# just a plain arg
415
raise errors.BzrCommandError("command %r requires argument %s"
416
% (cmd, argname.upper()))
523
raise BzrCommandError("command %r requires argument %s"
524
% (cmd, argname.upper()))
418
526
argdict[argname] = args.pop(0)
421
raise errors.BzrCommandError("extra argument to command %s: %s"
529
raise BzrCommandError("extra argument to command %s: %s"
436
543
ret = prof.runcall(the_callable, *args, **kwargs) or 0
439
548
stats = hotshot.stats.load(pfname)
441
stats.sort_stats('cum') # 'time'
550
stats.sort_stats('time')
442
551
## XXX: Might like to write to stderr or the trace file instead but
443
552
## print_stats seems hardcoded to stdout
444
553
stats.print_stats(20)
447
557
os.close(pffileno)
448
558
os.remove(pfname)
451
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
452
from bzrlib.lsprof import profile
454
ret, stats = profile(the_callable, *args, **kwargs)
460
cPickle.dump(stats, open(filename, 'w'), 2)
461
print 'Profile data written to %r.' % filename
466
"""Return an expanded alias, or None if no alias exists"""
468
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
470
return alias.split(' ')
474
561
def run_bzr(argv):
475
562
"""Execute a command.
491
576
Do not load plugin modules at all
497
579
Only use builtin commands. (Plugins are still allowed to change
498
580
other behaviour.)
501
Run under the Python hotshot profiler.
504
Run under the Python lsprof profiler.
583
Run under the Python profiler.
586
argv = [a.decode(bzrlib.user_encoding) for a in argv]
508
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
509
opt_no_aliases = False
510
opt_lsprof_file = None
588
opt_profile = opt_no_plugins = opt_builtin = False
512
590
# --no-plugins is handled specially at a very early stage. We need
513
591
# to load plugins before doing other command parsing so that they
514
592
# can override commands, but this needs to happen first.
520
595
if a == '--profile':
521
596
opt_profile = True
522
elif a == '--lsprof':
524
elif a == '--lsprof-file':
526
opt_lsprof_file = argv[i + 1]
528
597
elif a == '--no-plugins':
529
598
opt_no_plugins = True
530
elif a == '--no-aliases':
531
opt_no_aliases = True
532
599
elif a == '--builtin':
533
600
opt_builtin = True
534
elif a in ('--quiet', '-q'):
542
from bzrlib.builtins import cmd_help
543
cmd_help().run_argv_aliases([])
605
if (not argv) or (argv[0] == '--help'):
606
from bzrlib.help import help
546
613
if argv[0] == '--version':
547
from bzrlib.version import show_version
614
from bzrlib.builtins import show_version
551
618
if not opt_no_plugins:
552
619
from bzrlib.plugin import load_plugins
555
from bzrlib.plugin import disable_plugins
560
if not opt_no_aliases:
561
alias_argv = get_alias(argv[0])
563
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
564
argv[0] = alias_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.
622
cmd = str(argv.pop(0))
571
624
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
572
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
573
run = cmd_obj.run_argv
627
ret = apply_profiled(cmd_obj.run_argv, argv)
576
run = cmd_obj.run_argv_aliases
577
run_argv = [argv, alias_argv]
581
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
583
ret = apply_profiled(run, *run_argv)
588
# reset, in case we may do other commands later within the same process
589
trace.be_quiet(False)
591
def display_command(func):
592
"""Decorator that suppresses pipe/interrupt errors."""
593
def ignore_pipe(*args, **kwargs):
595
result = func(*args, **kwargs)
599
if getattr(e, 'errno', None) is None:
601
if e.errno != errno.EPIPE:
602
# Win32 raises IOError with errno=0 on a broken pipe
603
if sys.platform != 'win32' or e.errno != 0:
606
except KeyboardInterrupt:
629
ret = cmd_obj.run_argv(argv)
613
from bzrlib.ui.text import TextUIFactory
614
bzrlib.ui.ui_factory = TextUIFactory()
615
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
616
ret = run_bzr_catch_errors(argv)
617
trace.mutter("return code %d", ret)
621
def run_bzr_catch_errors(argv):
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
624
# do this here inside the exception wrappers to catch EPIPE
626
except (KeyboardInterrupt, Exception), e:
627
# used to handle AssertionError and KeyboardInterrupt
628
# specially here, but hopefully they're handled ok by the logger now
629
trace.report_exception(sys.exc_info(), sys.stderr)
630
if os.environ.get('BZR_PDB'):
631
print '**** entering debugger'
633
pdb.post_mortem(sys.exc_traceback)
640
return run_bzr(argv[1:])
642
# do this here inside the exception wrappers to catch EPIPE
644
except BzrCommandError, e:
645
# command line syntax error, etc
649
bzrlib.trace.log_exception()
651
except AssertionError, e:
652
bzrlib.trace.log_exception('assertion failed: ' + str(e))
654
except KeyboardInterrupt, e:
655
bzrlib.trace.note('interrupted')
659
if (isinstance(e, IOError)
660
and hasattr(e, 'errno')
661
and e.errno == errno.EPIPE):
662
bzrlib.trace.note('broken pipe')
665
bzrlib.trace.log_exception()
636
669
if __name__ == '__main__':
637
670
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
