1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2006 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.
23
21
# TODO: Define arguments by objects, rather than just using names.
24
22
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
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.
27
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
32
38
from warnings import warn
33
from inspect import getdoc
37
from bzrlib.trace import mutter, note, log_error, warning
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
from bzrlib.revisionspec import RevisionSpec
40
from bzrlib import BZRDIR
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
45
def register_command(cmd):
46
"Utility function to help register a command"
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.
49
73
if k.startswith("cmd_"):
50
74
k_unsquished = _unsquish_command_name(k)
53
if not plugin_cmds.has_key(k_unsquished):
54
plugin_cmds[k_unsquished] = cmd
55
mutter('registered plugin command %s', k_unsquished)
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
57
log_error('Two plugins defined the same command: %r' % k)
58
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
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__])
61
91
def _squish_command_name(cmd):
67
97
return cmd[4:].replace('_','-')
70
def _parse_revision_str(revstr):
71
"""This handles a revision string -> revno.
73
This always returns a list. The list will have one element for
76
>>> _parse_revision_str('234')
77
[<RevisionSpec_int 234>]
78
>>> _parse_revision_str('234..567')
79
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
80
>>> _parse_revision_str('..')
81
[<RevisionSpec None>, <RevisionSpec None>]
82
>>> _parse_revision_str('..234')
83
[<RevisionSpec None>, <RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..')
85
[<RevisionSpec_int 234>, <RevisionSpec None>]
86
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
88
>>> _parse_revision_str('234....789') # Error?
89
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
90
>>> _parse_revision_str('revid:test@other.com-234234')
91
[<RevisionSpec_revid revid:test@other.com-234234>]
92
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
94
>>> _parse_revision_str('revid:test@other.com-234234..23')
95
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
96
>>> _parse_revision_str('date:2005-04-12')
97
[<RevisionSpec_date date:2005-04-12>]
98
>>> _parse_revision_str('date:2005-04-12 12:24:33')
99
[<RevisionSpec_date date:2005-04-12 12:24:33>]
100
>>> _parse_revision_str('date:2005-04-12T12:24:33')
101
[<RevisionSpec_date date:2005-04-12T12:24:33>]
102
>>> _parse_revision_str('date:2005-04-12,12:24:33')
103
[<RevisionSpec_date date:2005-04-12,12:24:33>]
104
>>> _parse_revision_str('-5..23')
105
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
106
>>> _parse_revision_str('-5')
107
[<RevisionSpec_int -5>]
108
>>> _parse_revision_str('123a')
109
Traceback (most recent call last):
111
BzrError: No namespace registered for string: '123a'
112
>>> _parse_revision_str('abc')
113
Traceback (most recent call last):
115
BzrError: No namespace registered for string: 'abc'
118
old_format_re = re.compile('\d*:\d*')
119
m = old_format_re.match(revstr)
122
warning('Colon separator for revision numbers is deprecated.'
124
for rev in revstr.split(':'):
126
revs.append(RevisionSpec(int(rev)))
128
revs.append(RevisionSpec(None))
130
for x in revstr.split('..'):
132
revs.append(RevisionSpec(None))
134
revs.append(RevisionSpec(x))
138
100
def _builtin_commands():
139
101
import bzrlib.builtins
141
103
builtins = bzrlib.builtins.__dict__
142
104
for name in builtins:
143
105
if name.startswith("cmd_"):
144
real_name = _unsquish_command_name(name)
106
real_name = _unsquish_command_name(name)
145
107
r[real_name] = builtins[name]
150
111
def builtin_command_names():
224
188
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
228
List of options that may be given for this command.
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().
231
205
If true, this command isn't advertised. This is typically
232
206
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
237
226
takes_options = []
227
encoding_type = 'strict'
243
233
if self.__doc__ == Command.__doc__:
244
234
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)
247
275
def run_argv(self, argv):
248
"""Parse command line and run."""
249
args, opts = parse_args(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)
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)
251
289
if 'help' in opts: # e.g. bzr add --help
252
290
from bzrlib.help import help_on_command
253
291
help_on_command(self.name())
256
# check options are reasonable
257
allowed = self.takes_options
259
if oname not in allowed:
260
raise BzrCommandError("option '--%s' is not allowed for command %r"
261
% (oname, self.name()))
263
293
# mix arguments and options into one dictionary
264
294
cmdargs = _match_argform(self.name(), self.takes_args, args)
326
372
parsed = [spec, None]
330
# list of all available options; the rhs can be either None for an
331
# option that takes no argument, or a constructor function that checks
345
'revision': _parse_revision_str,
371
def parse_args(argv):
375
def parse_args(command, argv, alias_argv=None):
372
376
"""Parse command line.
374
378
Arguments and options are parsed at this level before being passed
375
379
down to specific command handlers. This routine knows, from a
376
380
lookup table, something about the available options, what optargs
377
381
they take, and which commands will accept them.
379
>>> parse_args('--help'.split())
381
>>> parse_args('help -- --invalidcmd'.split())
382
(['help', '--invalidcmd'], {})
383
>>> parse_args('--version'.split())
384
([], {'version': True})
385
>>> parse_args('status --all'.split())
386
(['status'], {'all': True})
387
>>> parse_args('commit --message=biter'.split())
388
(['commit'], {'message': u'biter'})
389
>>> parse_args('log -r 500'.split())
390
(['log'], {'revision': [<RevisionSpec_int 500>]})
391
>>> parse_args('log -r500..600'.split())
392
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
393
>>> parse_args('log -vr500..600'.split())
394
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
395
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
396
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
404
if not argsover and a[0] == '-':
405
# option names must not be unicode
410
# We've received a standalone -- No more flags
413
mutter(" got option %r" % a)
415
optname, optarg = a[2:].split('=', 1)
418
if optname not in OPTIONS:
419
raise BzrError('unknown long option %r' % a)
422
if shortopt in SHORT_OPTIONS:
423
# Multi-character options must have a space to delimit
425
optname = SHORT_OPTIONS[shortopt]
427
# Single character short options, can be chained,
428
# and have their value appended to their name
430
if shortopt not in SHORT_OPTIONS:
431
# We didn't find the multi-character name, and we
432
# didn't find the single char name
433
raise BzrError('unknown short option %r' % a)
434
optname = SHORT_OPTIONS[shortopt]
437
# There are extra things on this option
438
# see if it is the value, or if it is another
440
optargfn = OPTIONS[optname]
442
# This option does not take an argument, so the
443
# next entry is another short option, pack it back
445
argv.insert(0, '-' + a[2:])
447
# This option takes an argument, so pack it
452
# XXX: Do we ever want to support this, e.g. for -r?
453
raise BzrError('repeated option %r' % a)
455
optargfn = OPTIONS[optname]
459
raise BzrError('option %r needs an argument' % a)
462
opts[optname] = optargfn(optarg)
465
raise BzrError('option %r takes no argument' % optname)
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])
470
393
return args, opts
475
396
def _match_argform(cmd, takes_args, args):
489
410
argdict[argname + '_list'] = None
490
411
elif ap[-1] == '+':
492
raise BzrCommandError("command %r needs one or more %s"
493
% (cmd, argname.upper()))
413
raise errors.BzrCommandError("command %r needs one or more %s"
414
% (cmd, argname.upper()))
495
416
argdict[argname + '_list'] = args[:]
497
418
elif ap[-1] == '$': # all but one
498
419
if len(args) < 2:
499
raise BzrCommandError("command %r needs one or more %s"
500
% (cmd, argname.upper()))
420
raise errors.BzrCommandError("command %r needs one or more %s"
421
% (cmd, argname.upper()))
501
422
argdict[argname + '_list'] = args[:-1]
504
425
# just a plain arg
507
raise BzrCommandError("command %r requires argument %s"
508
% (cmd, argname.upper()))
428
raise errors.BzrCommandError("command %r requires argument %s"
429
% (cmd, argname.upper()))
510
431
argdict[argname] = args.pop(0)
513
raise BzrCommandError("extra argument to command %s: %s"
434
raise errors.BzrCommandError("extra argument to command %s: %s"
540
461
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'))]
543
498
def run_bzr(argv):
544
499
"""Execute a command.
558
515
Do not load plugin modules at all
561
521
Only use builtin commands. (Plugins are still allowed to change
562
522
other behaviour.)
565
Run under the Python profiler.
525
Run under the Python hotshot profiler.
528
Run under the Python lsprof profiler.
567
# Load all of the transport methods
568
import bzrlib.transport.local, bzrlib.transport.http
570
argv = [a.decode(bzrlib.user_encoding) for a in argv]
531
trace.mutter("bzr arguments: %r", argv)
572
opt_profile = opt_no_plugins = opt_builtin = False
533
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
534
opt_no_aliases = False
535
opt_lsprof_file = None
574
537
# --no-plugins is handled specially at a very early stage. We need
575
538
# to load plugins before doing other command parsing so that they
576
539
# can override commands, but this needs to happen first.
579
545
if a == '--profile':
580
546
opt_profile = True
547
elif a == '--lsprof':
549
elif a == '--lsprof-file':
551
opt_lsprof_file = argv[i + 1]
581
553
elif a == '--no-plugins':
582
554
opt_no_plugins = True
555
elif a == '--no-aliases':
556
opt_no_aliases = True
583
557
elif a == '--builtin':
584
558
opt_builtin = True
559
elif a in ('--quiet', '-q'):
561
elif a.startswith('-D'):
562
debug.debug_flags.add(a[2:])
589
if (not argv) or (argv[0] == '--help'):
590
from bzrlib.help import help
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
597
573
if argv[0] == '--version':
598
from bzrlib.builtins import show_version
574
from bzrlib.version import show_version
602
578
if not opt_no_plugins:
603
579
from bzrlib.plugin import load_plugins
606
cmd = str(argv.pop(0))
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.
608
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
611
ret = apply_profiled(cmd_obj.run_argv, argv)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
613
ret = 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:
619
bzrlib.trace.log_startup(argv)
620
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
622
return run_bzr_catch_errors(argv[1:])
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)
625
648
def run_bzr_catch_errors(argv):
630
# do this here inside the exception wrappers to catch EPIPE
632
except BzrCommandError, e:
633
# command line syntax error, etc
637
bzrlib.trace.log_exception()
639
except AssertionError, e:
640
bzrlib.trace.log_exception('assertion failed: ' + str(e))
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)
642
except KeyboardInterrupt, e:
643
bzrlib.trace.log_exception('interrupted')
647
if (isinstance(e, IOError)
648
and hasattr(e, 'errno')
649
and e.errno == errno.EPIPE):
650
bzrlib.trace.note('broken pipe')
655
bzrlib.trace.log_exception()
658
663
if __name__ == '__main__':
659
664
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
