1
# Copyright (C) 2006 by 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.
25
# would help with validation and shell completion.
28
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
28
# the profile output behind so it can be interactively examined?
34
32
from warnings import warn
33
from inspect import getdoc
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
43
from bzrlib import option
44
from bzrlib.option import Option
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
36
import bzrlib.trace
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
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
53
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
45
def register_command(cmd):
46
"Utility function to help register a command"
63
49
if k.startswith("cmd_"):
64
50
k_unsquished = _unsquish_command_name(k)
67
if k_unsquished not in plugin_cmds:
68
plugin_cmds[k_unsquished] = cmd
69
mutter('registered plugin command %s', k_unsquished)
70
if decorate and k_unsquished in builtin_command_names():
71
return _builtin_commands()[k_unsquished]
73
result = plugin_cmds[k_unsquished]
74
plugin_cmds[k_unsquished] = cmd
53
if not plugin_cmds.has_key(k_unsquished):
54
plugin_cmds[k_unsquished] = cmd
55
mutter('registered plugin command %s', k_unsquished)
77
57
log_error('Two plugins defined the same command: %r' % k)
78
58
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
87
67
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))
90
138
def _builtin_commands():
91
139
import bzrlib.builtins
93
141
builtins = bzrlib.builtins.__dict__
94
142
for name in builtins:
95
143
if name.startswith("cmd_"):
96
real_name = _unsquish_command_name(name)
144
real_name = _unsquish_command_name(name)
97
145
r[real_name] = builtins[name]
101
150
def builtin_command_names():
178
224
List of argument forms, marked with whether they are optional,
183
['to_location', 'from_branch?', 'file*']
185
'to_location' is required
186
'from_branch' is optional
187
'file' can be specified 0 or more times
190
List of options that may be given for this command. These can
191
be either strings, referring to globally-defined options,
192
or option objects. Retrieve through options().
228
List of options that may be given for this command.
195
231
If true, this command isn't advertised. This is typically
196
232
for commands intended for expert users.
199
Command objects will get a 'outf' attribute, which has been
200
setup to properly handle encoding of unicode strings.
201
encoding_type determines what will happen when characters cannot
203
strict - abort if we cannot decode
204
replace - put in a bogus character (typically '?')
205
exact - do not encode sys.stdout
210
237
takes_options = []
211
encoding_type = 'strict'
217
243
if self.__doc__ == Command.__doc__:
218
244
warn("No help message set for %r" % self)
221
"""Return dict of valid options for this command.
223
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
226
for o in self.takes_options:
227
if isinstance(o, basestring):
228
o = Option.OPTIONS[o]
232
def _setup_outf(self):
233
"""Return a file linked to stdout, which has proper encoding."""
234
assert self.encoding_type in ['strict', 'exact', 'replace']
236
# Originally I was using self.stdout, but that looks
237
# *way* too much like sys.stdout
238
if self.encoding_type == 'exact':
239
self.outf = sys.stdout
242
output_encoding = bzrlib.osutils.get_terminal_encoding()
244
# use 'replace' so that we don't abort if trying to write out
245
# in e.g. the default C locale.
246
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
247
# For whatever reason codecs.getwriter() does not advertise its encoding
248
# it just returns the encoding of the wrapped file, which is completely
249
# bogus. So set the attribute, so we can find the correct encoding later.
250
self.outf.encoding = output_encoding
252
@deprecated_method(zero_eight)
253
247
def run_argv(self, argv):
254
"""Parse command line and run.
256
See run_argv_aliases for the 0.8 and beyond api.
258
return self.run_argv_aliases(argv)
248
"""Parse command line and run."""
249
args, opts = parse_args(argv)
260
def run_argv_aliases(self, argv, alias_argv=None):
261
"""Parse the command line and run with extra aliases in alias_argv."""
263
warn("Passing None for [] is deprecated from bzrlib 0.10",
264
DeprecationWarning, stacklevel=2)
266
args, opts = parse_args(self, argv, alias_argv)
267
251
if 'help' in opts: # e.g. bzr add --help
268
252
from bzrlib.help import help_on_command
269
253
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()))
271
263
# mix arguments and options into one dictionary
272
264
cmdargs = _match_argform(self.name(), self.takes_args, args)
347
326
parsed = [spec, None]
350
def parse_args(command, argv, alias_argv=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):
351
372
"""Parse command line.
353
374
Arguments and options are parsed at this level before being passed
354
375
down to specific command handlers. This routine knows, from a
355
376
lookup table, something about the available options, what optargs
356
377
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>]})
358
# TODO: make it a method of the Command?
359
parser = option.get_optparser(command.options())
360
if alias_argv is not None:
361
args = alias_argv + argv
365
options, args = parser.parse_args(args)
366
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
367
v is not option.OptionParser.DEFAULT_VALUE])
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)
368
470
return args, opts
371
475
def _match_argform(cmd, takes_args, args):
479
558
Do not load plugin modules at all
485
561
Only use builtin commands. (Plugins are still allowed to change
486
562
other behaviour.)
489
Run under the Python hotshot profiler.
492
Run under the Python lsprof profiler.
565
Run under the Python 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]
496
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
497
opt_no_aliases = False
498
opt_lsprof_file = None
572
opt_profile = opt_no_plugins = opt_builtin = False
500
574
# --no-plugins is handled specially at a very early stage. We need
501
575
# to load plugins before doing other command parsing so that they
502
576
# can override commands, but this needs to happen first.
508
579
if a == '--profile':
509
580
opt_profile = True
510
elif a == '--lsprof':
512
elif a == '--lsprof-file':
514
opt_lsprof_file = argv[i + 1]
516
581
elif a == '--no-plugins':
517
582
opt_no_plugins = True
518
elif a == '--no-aliases':
519
opt_no_aliases = True
520
583
elif a == '--builtin':
521
584
opt_builtin = True
522
elif a in ('--quiet', '-q'):
530
from bzrlib.builtins import cmd_help
531
cmd_help().run_argv_aliases([])
589
if (not argv) or (argv[0] == '--help'):
590
from bzrlib.help import help
534
597
if argv[0] == '--version':
535
from bzrlib.version import show_version
598
from bzrlib.builtins import show_version
539
602
if not opt_no_plugins:
540
603
from bzrlib.plugin import load_plugins
543
from bzrlib.plugin import disable_plugins
548
if not opt_no_aliases:
549
alias_argv = get_alias(argv[0])
551
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
552
argv[0] = alias_argv.pop(0)
555
# We want only 'ascii' command names, but the user may have typed
556
# in a Unicode name. In that case, they should just get a
557
# 'command not found' error later.
606
cmd = str(argv.pop(0))
559
608
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
560
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
561
run = cmd_obj.run_argv
611
ret = apply_profiled(cmd_obj.run_argv, argv)
564
run = cmd_obj.run_argv_aliases
565
run_argv = [argv, alias_argv]
569
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
571
ret = apply_profiled(run, *run_argv)
576
# reset, in case we may do other commands later within the same process
579
def display_command(func):
580
"""Decorator that suppresses pipe/interrupt errors."""
581
def ignore_pipe(*args, **kwargs):
583
result = func(*args, **kwargs)
587
if getattr(e, 'errno', None) is None:
589
if e.errno != errno.EPIPE:
590
# Win32 raises IOError with errno=0 on a broken pipe
591
if sys.platform != 'win32' or e.errno != 0:
594
except KeyboardInterrupt:
613
ret = cmd_obj.run_argv(argv)
601
from bzrlib.ui.text import TextUIFactory
602
bzrlib.ui.ui_factory = TextUIFactory()
603
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
604
ret = run_bzr_catch_errors(argv)
605
mutter("return code %d", ret)
619
bzrlib.trace.log_startup(argv)
620
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
622
return run_bzr_catch_errors(argv[1:])
609
625
def run_bzr_catch_errors(argv):
612
# do this here inside the exception wrappers to catch EPIPE
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))
642
except KeyboardInterrupt, e:
643
bzrlib.trace.log_exception('interrupted')
614
645
except Exception, e:
615
# used to handle AssertionError and KeyboardInterrupt
616
# specially here, but hopefully they're handled ok by the logger now
617
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
618
if os.environ.get('BZR_PDB'):
619
print '**** entering debugger'
621
pdb.post_mortem(sys.exc_traceback)
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()
624
658
if __name__ == '__main__':
625
659
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
