1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2006 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.
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?
32
34
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)
36
47
import bzrlib.trace
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
41
from bzrlib.option import Option
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
46
def register_command(cmd):
47
"Utility function to help register a command"
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.
50
63
if k.startswith("cmd_"):
51
64
k_unsquished = _unsquish_command_name(k)
54
if not plugin_cmds.has_key(k_unsquished):
55
plugin_cmds[k_unsquished] = cmd
56
mutter('registered plugin command %s', k_unsquished)
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
58
77
log_error('Two plugins defined the same command: %r' % k)
59
78
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
183
223
Maps from long option name to option object."""
225
r['help'] = Option.OPTIONS['help']
185
226
for o in self.takes_options:
186
if not isinstance(o, Option):
227
if isinstance(o, basestring):
187
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)
191
253
def run_argv(self, argv):
192
"""Parse command line and run."""
193
args, opts = parse_args(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)
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)
195
267
if 'help' in opts: # e.g. bzr add --help
196
268
from bzrlib.help import help_on_command
197
269
help_on_command(self.name())
200
allowed_names = self.options().keys()
202
if oname not in allowed_names:
203
raise BzrCommandError("option '--%s' is not allowed for command %r"
204
% (oname, self.name()))
206
271
# mix arguments and options into one dictionary
207
272
cmdargs = _match_argform(self.name(), self.takes_args, args)
269
347
parsed = [spec, None]
272
def parse_args(argv):
350
def parse_args(command, argv, alias_argv=None):
273
351
"""Parse command line.
275
353
Arguments and options are parsed at this level before being passed
276
354
down to specific command handlers. This routine knows, from a
277
355
lookup table, something about the available options, what optargs
278
356
they take, and which commands will accept them.
280
>>> parse_args('--help'.split())
282
>>> parse_args('help -- --invalidcmd'.split())
283
(['help', '--invalidcmd'], {})
284
>>> parse_args('--version'.split())
285
([], {'version': True})
286
>>> parse_args('status --all'.split())
287
(['status'], {'all': True})
288
>>> parse_args('commit --message=biter'.split())
289
(['commit'], {'message': u'biter'})
290
>>> parse_args('log -r 500'.split())
291
(['log'], {'revision': [<RevisionSpec_int 500>]})
292
>>> parse_args('log -r500..600'.split())
293
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
294
>>> parse_args('log -vr500..600'.split())
295
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
296
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
297
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
299
# TODO: chop up this beast
306
if not argsover and a[0] == '-':
307
# option names must not be unicode
312
# We've received a standalone -- No more flags
315
mutter(" got option %r" % a)
317
optname, optarg = a[2:].split('=', 1)
320
if optname not in Option.OPTIONS:
321
raise BzrError('unknown long option %r' % a)
324
if shortopt in Option.SHORT_OPTIONS:
325
# Multi-character options must have a space to delimit
327
# ^^^ what does this mean? mbp 20051014
328
optname = Option.SHORT_OPTIONS[shortopt].name
330
# Single character short options, can be chained,
331
# and have their value appended to their name
333
if shortopt not in Option.SHORT_OPTIONS:
334
# We didn't find the multi-character name, and we
335
# didn't find the single char name
336
raise BzrError('unknown short option %r' % a)
337
optname = Option.SHORT_OPTIONS[shortopt].name
340
# There are extra things on this option
341
# see if it is the value, or if it is another
343
optargfn = Option.OPTIONS[optname].type
345
# This option does not take an argument, so the
346
# next entry is another short option, pack it back
348
argv.insert(0, '-' + a[2:])
350
# This option takes an argument, so pack it
355
# XXX: Do we ever want to support this, e.g. for -r?
356
raise BzrError('repeated option %r' % a)
358
optargfn = Option.OPTIONS[optname].type
362
raise BzrError('option %r needs an argument' % a)
365
opts[optname] = optargfn(optarg)
368
raise BzrError('option %r takes no argument' % optname)
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])
373
368
return args, opts
378
371
def _match_argform(cmd, takes_args, args):
461
479
Do not load plugin modules at all
464
485
Only use builtin commands. (Plugins are still allowed to change
465
486
other behaviour.)
468
Run under the Python profiler.
489
Run under the Python hotshot profiler.
492
Run under the Python lsprof profiler.
470
# Load all of the transport methods
471
import bzrlib.transport.local, bzrlib.transport.http
473
argv = [a.decode(bzrlib.user_encoding) for a in argv]
475
opt_profile = opt_no_plugins = opt_builtin = False
496
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
497
opt_no_aliases = False
498
opt_lsprof_file = None
477
500
# --no-plugins is handled specially at a very early stage. We need
478
501
# to load plugins before doing other command parsing so that they
479
502
# can override commands, but this needs to happen first.
482
508
if a == '--profile':
483
509
opt_profile = True
510
elif a == '--lsprof':
512
elif a == '--lsprof-file':
514
opt_lsprof_file = argv[i + 1]
484
516
elif a == '--no-plugins':
485
517
opt_no_plugins = True
518
elif a == '--no-aliases':
519
opt_no_aliases = True
486
520
elif a == '--builtin':
487
521
opt_builtin = True
522
elif a in ('--quiet', '-q'):
492
if (not argv) or (argv[0] == '--help'):
493
from bzrlib.help import help
530
from bzrlib.builtins import cmd_help
531
cmd_help().run_argv_aliases([])
500
534
if argv[0] == '--version':
501
from bzrlib.builtins import show_version
535
from bzrlib.version import show_version
505
539
if not opt_no_plugins:
506
540
from bzrlib.plugin import load_plugins
509
cmd = str(argv.pop(0))
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.
511
559
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
514
ret = apply_profiled(cmd_obj.run_argv, argv)
560
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
561
run = cmd_obj.run_argv
516
ret = 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:
522
bzrlib.trace.log_startup(argv)
523
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
525
return run_bzr_catch_errors(argv[1:])
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)
528
609
def run_bzr_catch_errors(argv):
533
# do this here inside the exception wrappers to catch EPIPE
535
except BzrCommandError, e:
536
# command line syntax error, etc
540
bzrlib.trace.log_exception()
542
except AssertionError, e:
543
bzrlib.trace.log_exception('assertion failed: ' + str(e))
612
# do this here inside the exception wrappers to catch EPIPE
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)
545
except KeyboardInterrupt, e:
546
bzrlib.trace.log_exception('interrupted')
550
if (isinstance(e, IOError)
551
and hasattr(e, 'errno')
552
and e.errno == errno.EPIPE):
553
bzrlib.trace.note('broken pipe')
558
bzrlib.trace.log_exception()
561
624
if __name__ == '__main__':
562
625
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
