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,
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
43
from bzrlib import option
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
44
46
from bzrlib.option import Option
46
from bzrlib.revisionspec import RevisionSpec
47
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
49
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
54
51
def register_command(cmd, decorate=False):
55
"""Utility function to help register a command
57
:param cmd: Command subclass to register
58
:param decorate: If true, allow overriding an existing command
59
of the same name; the old command is returned by this function.
60
Otherwise it is an error to try to override an existing command.
52
"Utility function to help register a command"
64
55
if k.startswith("cmd_"):
131
123
from bzrlib.externalcommand import ExternalCommand
133
# We want only 'ascii' command names, but the user may have typed
134
# in a Unicode name. In that case, they should just get a
135
# 'command not found' error later.
136
# In the future, we may actually support Unicode command names.
125
cmd_name = str(cmd_name) # not unicode
138
127
# first look up this command under the specified name
139
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
179
168
List of argument forms, marked with whether they are optional,
184
['to_location', 'from_branch?', 'file*']
186
'to_location' is required
187
'from_branch' is optional
188
'file' can be specified 0 or more times
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
191
180
List of options that may be given for this command. These can
196
185
If true, this command isn't advertised. This is typically
197
186
for commands intended for expert users.
200
Command objects will get a 'outf' attribute, which has been
201
setup to properly handle encoding of unicode strings.
202
encoding_type determines what will happen when characters cannot
204
strict - abort if we cannot decode
205
replace - put in a bogus character (typically '?')
206
exact - do not encode sys.stdout
211
190
takes_options = []
212
encoding_type = 'strict'
226
204
r['help'] = Option.OPTIONS['help']
227
205
for o in self.takes_options:
228
if isinstance(o, basestring):
206
if not isinstance(o, Option):
229
207
o = Option.OPTIONS[o]
233
def _setup_outf(self):
234
"""Return a file linked to stdout, which has proper encoding."""
235
assert self.encoding_type in ['strict', 'exact', 'replace']
237
# Originally I was using self.stdout, but that looks
238
# *way* too much like sys.stdout
239
if self.encoding_type == 'exact':
240
self.outf = sys.stdout
243
output_encoding = bzrlib.osutils.get_terminal_encoding()
245
# use 'replace' so that we don't abort if trying to write out
246
# in e.g. the default C locale.
247
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
248
# For whatever reason codecs.getwriter() does not advertise its encoding
249
# it just returns the encoding of the wrapped file, which is completely
250
# bogus. So set the attribute, so we can find the correct encoding later.
251
self.outf.encoding = output_encoding
253
@deprecated_method(zero_eight)
254
211
def run_argv(self, argv):
255
"""Parse command line and run.
257
See run_argv_aliases for the 0.8 and beyond api.
259
return self.run_argv_aliases(argv)
261
def run_argv_aliases(self, argv, alias_argv=None):
262
"""Parse the command line and run with extra aliases in alias_argv."""
264
warn("Passing None for [] is deprecated from bzrlib 0.10",
265
DeprecationWarning, stacklevel=2)
267
args, opts = parse_args(self, argv, alias_argv)
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
268
214
if 'help' in opts: # e.g. bzr add --help
269
215
from bzrlib.help import help_on_command
270
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
272
224
# mix arguments and options into one dictionary
273
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
356
294
lookup table, something about the available options, what optargs
357
295
they take, and which commands will accept them.
359
# TODO: make it a method of the Command?
360
parser = option.get_optparser(command.options())
361
if alias_argv is not None:
362
args = alias_argv + argv
366
options, args = parser.parse_args(args)
367
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
368
v is not option.OptionParser.DEFAULT_VALUE])
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
313
# option names must not be unicode
317
mutter(" got option %r", a)
319
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
333
# Single character short options, can be chained,
334
# and have their value appended to their name
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
343
# There are extra things on this option
344
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
351
argv.insert(0, '-' + a[2:])
353
# This option takes an argument, so pack it
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
361
# XXX: Do we ever want to support this, e.g. for -r?
362
raise BzrError('repeated option %r' % a)
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
369
raise BzrError('option %r needs an argument' % a)
372
opts[optname] = optargfn(optarg)
375
raise BzrError('option %r takes no argument' % optname)
369
379
return args, opts
437
447
os.remove(pfname)
440
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
450
def apply_lsprofiled(the_callable, *args, **kwargs):
441
451
from bzrlib.lsprof import profile
443
ret, stats = profile(the_callable, *args, **kwargs)
452
ret,stats = profile(the_callable,*args,**kwargs)
449
cPickle.dump(stats, open(filename, 'w'), 2)
450
print 'Profile data written to %r.' % filename
455
"""Return an expanded alias, or None if no alias exists"""
457
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
459
return alias.split(' ')
463
457
def run_bzr(argv):
464
458
"""Execute a command.
493
482
Run under the Python lsprof profiler.
484
argv = [a.decode(bzrlib.user_encoding) for a in argv]
497
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
498
opt_no_aliases = False
499
opt_lsprof_file = None
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
501
488
# --no-plugins is handled specially at a very early stage. We need
502
489
# to load plugins before doing other command parsing so that they
503
490
# can override commands, but this needs to happen first.
509
493
if a == '--profile':
510
494
opt_profile = True
511
495
elif a == '--lsprof':
512
496
opt_lsprof = True
513
elif a == '--lsprof-file':
515
opt_lsprof_file = argv[i + 1]
517
497
elif a == '--no-plugins':
518
498
opt_no_plugins = True
519
elif a == '--no-aliases':
520
opt_no_aliases = True
521
499
elif a == '--builtin':
522
500
opt_builtin = True
523
501
elif a in ('--quiet', '-q'):
531
from bzrlib.builtins import cmd_help
532
cmd_help().run_argv_aliases([])
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
535
515
if argv[0] == '--version':
536
from bzrlib.version import show_version
516
from bzrlib.builtins import show_version
540
520
if not opt_no_plugins:
541
521
from bzrlib.plugin import load_plugins
544
from bzrlib.plugin import disable_plugins
549
if not opt_no_aliases:
550
alias_argv = get_alias(argv[0])
552
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
553
argv[0] = alias_argv.pop(0)
556
# We want only 'ascii' command names, but the user may have typed
557
# in a Unicode name. In that case, they should just get a
558
# 'command not found' error later.
524
cmd = str(argv.pop(0))
560
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
561
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
562
run = cmd_obj.run_argv
565
run = cmd_obj.run_argv_aliases
566
run_argv = [argv, alias_argv]
570
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
571
531
elif opt_profile:
572
ret = apply_profiled(run, *run_argv)
532
ret = apply_profiled(cmd_obj.run_argv, argv)
534
ret = cmd_obj.run_argv(argv)
577
537
# reset, in case we may do other commands later within the same process
602
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
603
563
bzrlib.ui.ui_factory = TextUIFactory()
604
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
605
ret = run_bzr_catch_errors(argv)
564
ret = run_bzr_catch_errors(argv[1:])
606
565
mutter("return code %d", ret)
610
569
def run_bzr_catch_errors(argv):
613
# do this here inside the exception wrappers to catch EPIPE
574
# do this here inside the exception wrappers to catch EPIPE
615
576
except Exception, e:
616
577
# used to handle AssertionError and KeyboardInterrupt
617
578
# specially here, but hopefully they're handled ok by the logger now
618
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
619
if os.environ.get('BZR_PDB'):
620
print '**** entering debugger'
622
pdb.post_mortem(sys.exc_traceback)
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
625
593
if __name__ == '__main__':
626
594
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
