37
96
assert cmd.startswith("cmd_")
38
97
return cmd[4:].replace('_','-')
100
def _builtin_commands():
101
import bzrlib.builtins
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
105
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
111
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
116
def plugin_command_names():
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
41
129
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
47
135
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
49
cmd = str(cmd) # not unicode
140
from bzrlib.externalcommand import ExternalCommand
142
# We want only 'ascii' command names, but the user may have typed
143
# in a Unicode name. In that case, they should just get a
144
# 'command not found' error later.
145
# In the future, we may actually support Unicode command names.
51
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
53
return cmd, globals()[_squish_command_name(cmd)]
150
return cmds[cmd_name]()
57
154
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
raise BzrCommandError("unknown command %r" % cmd)
155
for real_cmd_name, cmd_class in cmds.iteritems():
156
if cmd_name in cmd_class.aliases:
159
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
166
class Command(object):
66
167
"""Base class for commands.
169
Commands are the heart of the command-line bzr interface.
171
The command object mostly handles the mapping of command-line
172
parameters into one or more bzrlib operations, and of the results
175
Commands normally don't have any state. All their arguments are
176
passed in to the run method. (Subclasses may take a different
177
policy if the behaviour of the instance needs to depend on e.g. a
178
shell plugin and not just its Python class.)
68
180
The docstring for an actual command should give a single-line
69
181
summary, then a complete description of the command. A grammar
70
182
description will be inserted.
185
Other accepted names for this command.
73
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
77
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().
80
If true, this command isn't advertised.
205
If true, this command isn't advertised. This is typically
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
85
226
takes_options = []
227
encoding_type = 'strict'
89
def __init__(self, options, arguments):
90
"""Construct and run the command.
92
Sets self.status to the return value of run()."""
93
assert isinstance(options, dict)
94
assert isinstance(arguments, dict)
95
cmdargs = options.copy()
96
cmdargs.update(arguments)
97
assert self.__doc__ != Command.__doc__, \
98
("No help message set for %r" % self)
99
self.status = self.run(**cmdargs)
232
"""Construct an instance of this command."""
233
if self.__doc__ == Command.__doc__:
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
def run_argv_aliases(self, argv, alias_argv=None):
275
"""Parse the command line and run with extra aliases in alias_argv."""
277
warn("Passing None for [] is deprecated from bzrlib 0.10",
278
DeprecationWarning, stacklevel=2)
280
args, opts = parse_args(self, argv, alias_argv)
281
if 'help' in opts: # e.g. bzr add --help
282
from bzrlib.help import help_on_command
283
help_on_command(self.name())
285
# mix arguments and options into one dictionary
286
cmdargs = _match_argform(self.name(), self.takes_args, args)
288
for k, v in opts.items():
289
cmdopts[k.replace('-', '_')] = v
291
all_cmd_args = cmdargs.copy()
292
all_cmd_args.update(cmdopts)
296
return self.run(**all_cmd_args)
103
"""Override this in sub-classes.
299
"""Actually run the command.
105
301
This is invoked with the options and arguments bound to
106
302
keyword parameters.
108
Return 0 or None if the command was successful, or a shell
115
class cmd_status(Command):
116
"""Display status summary.
118
For each file there is a single line giving its file state and name.
119
The name is that in the current revision unless it is deleted or
120
missing, in which case the old name is shown.
122
takes_options = ['all']
123
aliases = ['st', 'stat']
125
def run(self, all=False):
126
#import bzrlib.status
127
#bzrlib.status.tree_status(Branch('.'))
128
Branch('.').show_status(show_all=all)
131
class cmd_cat_revision(Command):
132
"""Write out metadata for a revision."""
135
takes_args = ['revision_id']
137
def run(self, revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
class cmd_revno(Command):
142
"""Show current revision number.
144
This is equal to the number of revisions on this branch."""
146
print Branch('.').revno()
149
class cmd_add(Command):
150
"""Add specified files or directories.
152
In non-recursive mode, all the named items are added, regardless
153
of whether they were previously ignored. A warning is given if
154
any of the named files are already versioned.
156
In recursive mode (the default), files are treated the same way
157
but the behaviour for directories is different. Directories that
158
are already versioned do not give a warning. All directories,
159
whether already versioned or not, are searched for files or
160
subdirectories that are neither versioned or ignored, and these
161
are added. This search proceeds recursively into versioned
164
Therefore simply saying 'bzr add .' will version all files that
165
are currently unknown.
167
TODO: Perhaps adding a file whose directly is not versioned should
168
recursively add that parent, rather than giving an error?
170
takes_args = ['file+']
171
takes_options = ['verbose']
173
def run(self, file_list, verbose=False):
174
bzrlib.add.smart_add(file_list, verbose)
177
class cmd_relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ['filename']
181
def run(self, filename):
182
print Branch(filename).relpath(filename)
186
class cmd_inventory(Command):
187
"""Show inventory of the current working copy or a revision."""
188
takes_options = ['revision']
190
def run(self, revision=None):
193
inv = b.read_working_inventory()
195
inv = b.get_revision_inventory(b.lookup_revision(revision))
197
for path, entry in inv.iter_entries():
198
print '%-50s %s' % (entry.file_id, path)
201
class cmd_move(Command):
202
"""Move files to a different directory.
207
The destination must be a versioned directory in the same branch.
209
takes_args = ['source$', 'dest']
210
def run(self, source_list, dest):
213
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
216
class cmd_rename(Command):
217
"""Change the name of an entry.
220
bzr rename frob.c frobber.c
221
bzr rename src/frob.c lib/frob.c
223
It is an error if the destination name exists.
225
See also the 'move' command, which moves files into a different
226
directory without changing their name.
228
TODO: Some way to rename multiple files without invoking bzr for each
230
takes_args = ['from_name', 'to_name']
232
def run(self, from_name, to_name):
234
b.rename_one(b.relpath(from_name), b.relpath(to_name))
238
class cmd_renames(Command):
239
"""Show list of renamed files.
241
TODO: Option to show renames between two historical versions.
243
TODO: Only show renames under dir, rather than in the whole branch.
245
takes_args = ['dir?']
247
def run(self, dir='.'):
249
old_inv = b.basis_tree().inventory
250
new_inv = b.read_working_inventory()
252
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
254
for old_name, new_name in renames:
255
print "%s => %s" % (old_name, new_name)
258
class cmd_info(Command):
259
"""Show statistical information for this branch"""
262
info.show_info(Branch('.'))
265
class cmd_remove(Command):
266
"""Make a file unversioned.
268
This makes bzr stop tracking changes to a versioned file. It does
269
not delete the working copy.
271
takes_args = ['file+']
272
takes_options = ['verbose']
274
def run(self, file_list, verbose=False):
275
b = Branch(file_list[0])
276
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
279
class cmd_file_id(Command):
280
"""Print file_id of a particular file or directory.
282
The file_id is assigned when the file is first added and remains the
283
same through all revisions where the file exists, even when it is
287
takes_args = ['filename']
288
def run(self, filename):
290
i = b.inventory.path2id(b.relpath(filename))
292
bailout("%r is not a versioned file" % filename)
297
class cmd_file_path(Command):
298
"""Print path of file_ids to a file or directory.
300
This prints one line for each directory down to the target,
301
starting at the branch root."""
303
takes_args = ['filename']
304
def run(self, filename):
307
fid = inv.path2id(b.relpath(filename))
309
bailout("%r is not a versioned file" % filename)
310
for fip in inv.get_idpath(fid):
314
class cmd_revision_history(Command):
315
"""Display list of revision ids on this branch."""
317
for patchid in Branch('.').revision_history():
321
class cmd_directories(Command):
322
"""Display list of versioned directories in this branch."""
324
for name, ie in Branch('.').read_working_inventory().directories():
331
class cmd_init(Command):
332
"""Make a directory into a versioned branch.
334
Use this to create an empty branch, or before importing an
337
Recipe for importing a tree of files:
342
bzr commit -m 'imported project'
345
Branch('.', init=True)
348
class cmd_diff(Command):
349
"""Show differences in working tree.
351
If files are listed, only the changes in those files are listed.
352
Otherwise, all changes for the tree are listed.
354
TODO: Given two revision arguments, show the difference between them.
356
TODO: Allow diff across branches.
358
TODO: Option to use external diff command; could be GNU diff, wdiff,
361
TODO: Python difflib is not exactly the same as unidiff; should
362
either fix it up or prefer to use an external diff.
364
TODO: If a directory is given, diff everything under that.
366
TODO: Selected-file diff is inefficient and doesn't show you
369
TODO: This probably handles non-Unix newlines poorly.
372
takes_args = ['file*']
373
takes_options = ['revision']
376
def run(self, revision=None, file_list=None):
377
from bzrlib.diff import show_diff
379
show_diff(Branch('.'), revision, file_list)
382
class cmd_deleted(Command):
383
"""List files deleted in the working tree.
385
TODO: Show files deleted since a previous revision, or between two revisions.
387
def run(self, show_ids=False):
390
new = b.working_tree()
392
## TODO: Much more efficient way to do this: read in new
393
## directories with readdir, rather than stating each one. Same
394
## level of effort but possibly much less IO. (Or possibly not,
395
## if the directories are very large...)
397
for path, ie in old.inventory.iter_entries():
398
if not new.has_id(ie.file_id):
400
print '%-50s %s' % (path, ie.file_id)
404
class cmd_root(Command):
405
"""Show the tree root directory.
407
The root is the nearest enclosing directory with a .bzr control
409
takes_args = ['filename?']
410
def run(self, filename=None):
411
"""Print the branch root."""
412
print bzrlib.branch.find_branch_root(filename)
416
class cmd_log(Command):
417
"""Show log of this branch.
419
TODO: Option to limit range.
421
TODO: Perhaps show most-recent first with an option for last.
423
takes_args = ['filename?']
424
takes_options = ['timezone', 'verbose', 'show-ids']
425
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
426
b = Branch((filename or '.'), lock_mode='r')
428
filename = b.relpath(filename)
429
bzrlib.show_log(b, filename,
430
show_timezone=timezone,
436
class cmd_touching_revisions(Command):
437
"""Return revision-ids which affected a particular file."""
439
takes_args = ["filename"]
440
def run(self, filename):
441
b = Branch(filename, lock_mode='r')
442
inv = b.read_working_inventory()
443
file_id = inv.path2id(b.relpath(filename))
444
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
445
print "%6d %s" % (revno, what)
448
class cmd_ls(Command):
449
"""List files in a tree.
451
TODO: Take a revision or remote path and list that tree instead.
454
def run(self, revision=None, verbose=False):
457
tree = b.working_tree()
459
tree = b.revision_tree(b.lookup_revision(revision))
461
for fp, fc, kind, fid in tree.list_files():
463
if kind == 'directory':
470
print '%-8s %s%s' % (fc, fp, kindch)
476
class cmd_unknowns(Command):
477
"""List unknown files"""
479
for f in Branch('.').unknowns():
484
class cmd_ignore(Command):
485
"""Ignore a command or pattern"""
486
takes_args = ['name_pattern']
488
def run(self, name_pattern):
491
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
492
f = open(b.abspath('.bzrignore'), 'at')
493
f.write(name_pattern + '\n')
496
inv = b.working_tree().inventory
497
if inv.path2id('.bzrignore'):
498
mutter('.bzrignore is already versioned')
500
mutter('need to make new .bzrignore file versioned')
501
b.add(['.bzrignore'])
505
class cmd_ignored(Command):
506
"""List ignored files and the patterns that matched them."""
508
tree = Branch('.').working_tree()
509
for path, file_class, kind, file_id in tree.list_files():
510
if file_class != 'I':
512
## XXX: Slightly inefficient since this was already calculated
513
pat = tree.is_ignored(path)
514
print '%-50s %s' % (path, pat)
517
class cmd_lookup_revision(Command):
518
"""Lookup the revision-id from a revision-number
521
bzr lookup-revision 33
524
takes_args = ['revno']
526
def run(self, revno):
530
raise BzrCommandError("not a valid revision-number: %r" % revno)
532
print Branch('.').lookup_revision(revno)
535
class cmd_export(Command):
536
"""Export past revision to destination directory.
538
If no revision is specified this exports the last committed revision."""
539
takes_args = ['dest']
540
takes_options = ['revision']
541
def run(self, dest, revision=None):
544
rh = b.revision_history()[-1]
546
rh = b.lookup_revision(int(revision))
547
t = b.revision_tree(rh)
551
class cmd_cat(Command):
552
"""Write a file's text from a previous revision."""
554
takes_options = ['revision']
555
takes_args = ['filename']
557
def run(self, filename, revision=None):
559
raise BzrCommandError("bzr cat requires a revision number")
561
b.print_file(b.relpath(filename), int(revision))
564
class cmd_local_time_offset(Command):
565
"""Show the offset in seconds from GMT to local time."""
568
print bzrlib.osutils.local_time_offset()
572
class cmd_commit(Command):
573
"""Commit changes into a new revision.
575
TODO: Commit only selected files.
577
TODO: Run hooks on tree to-be-committed, and after commit.
579
TODO: Strict commit that fails if there are unknown or deleted files.
581
takes_options = ['message', 'file', 'verbose']
582
aliases = ['ci', 'checkin']
584
def run(self, message=None, file=None, verbose=False):
585
## Warning: shadows builtin file()
586
if not message and not file:
587
raise BzrCommandError("please specify a commit message",
588
["use either --message or --file"])
589
elif message and file:
590
raise BzrCommandError("please specify either --message or --file")
594
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
596
Branch('.').commit(message, verbose=verbose)
599
class cmd_check(Command):
600
"""Validate consistency of branch history.
602
This command checks various invariants about the branch storage to
603
detect data corruption or bzr bugs.
605
takes_args = ['dir?']
606
def run(self, dir='.'):
608
bzrlib.check.check(Branch(dir, find_root=False))
612
class cmd_whoami(Command):
613
"""Show bzr user id."""
614
takes_options = ['email']
616
def run(self, email=False):
618
print bzrlib.osutils.user_email()
620
print bzrlib.osutils.username()
623
class cmd_selftest(Command):
624
"""Run internal test suite"""
627
failures, tests = 0, 0
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
637
print '%-40s %3d tests' % (m.__name__, mt),
639
print '%3d FAILED!' % mf
643
print '%-40s %3d tests' % ('total', tests),
645
print '%3d FAILED!' % failures
651
class cmd_version(Command):
652
"""Show version of bzr"""
657
print "bzr (bazaar-ng) %s" % bzrlib.__version__
658
print bzrlib.__copyright__
659
print "http://bazaar-ng.org/"
661
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
662
print "you may use, modify and redistribute it under the terms of the GNU"
663
print "General Public License version 2 or later."
666
class cmd_rocks(Command):
667
"""Statement of optimism."""
670
print "it sure does!"
673
class cmd_assert_fail(Command):
674
"""Test reporting of assertion failures"""
677
assert False, "always fails"
680
class cmd_help(Command):
681
"""Show help on a command or other topic.
683
For a list of all available commands, say 'bzr help commands'."""
684
takes_args = ['topic?']
687
def run(self, topic=None):
692
######################################################################
696
# list of all available options; the rhs can be either None for an
697
# option that takes no argument, or a constructor function that checks
721
def parse_args(argv):
304
Return 0 or None if the command was successful, or a non-zero
305
shell error code if not. It's OK for this method to allow
306
an exception to raise up.
308
raise NotImplementedError('no implementation of command %r'
312
"""Return help message for this class."""
313
from inspect import getdoc
314
if self.__doc__ is Command.__doc__:
319
return _unsquish_command_name(self.__class__.__name__)
321
def plugin_name(self):
322
"""Get the name of the plugin that provides this command.
324
:return: The name of the plugin or None if the command is builtin.
326
mod_parts = self.__module__.split('.')
327
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
333
# Technically, this function hasn't been use in a *really* long time
334
# but we are only deprecating it now.
335
@deprecated_function(zero_eleven)
336
def parse_spec(spec):
342
>>> parse_spec("../@")
344
>>> parse_spec("../f/@35")
346
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
347
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
352
parsed = spec.split('/@')
353
assert len(parsed) == 2
358
parsed[1] = int(parsed[1])
360
pass # We can allow stuff like ./@revid:blahblahblah
364
parsed = [spec, None]
367
def parse_args(command, argv, alias_argv=None):
722
368
"""Parse command line.
724
370
Arguments and options are parsed at this level before being passed
725
371
down to specific command handlers. This routine knows, from a
726
372
lookup table, something about the available options, what optargs
727
373
they take, and which commands will accept them.
729
>>> parse_args('--help'.split())
731
>>> parse_args('--version'.split())
732
([], {'version': True})
733
>>> parse_args('status --all'.split())
734
(['status'], {'all': True})
735
>>> parse_args('commit --message=biter'.split())
736
(['commit'], {'message': u'biter'})
741
# TODO: Maybe handle '--' to end options?
746
# option names must not be unicode
750
mutter(" got option %r" % a)
752
optname, optarg = a[2:].split('=', 1)
755
if optname not in OPTIONS:
756
bailout('unknown long option %r' % a)
759
if shortopt not in SHORT_OPTIONS:
760
bailout('unknown short option %r' % a)
761
optname = SHORT_OPTIONS[shortopt]
764
# XXX: Do we ever want to support this, e.g. for -r?
765
bailout('repeated option %r' % a)
767
optargfn = OPTIONS[optname]
771
bailout('option %r needs an argument' % a)
774
opts[optname] = optargfn(optarg)
777
bailout('option %r takes no argument' % optname)
375
# TODO: make it a method of the Command?
376
parser = option.get_optparser(command.options())
377
if alias_argv is not None:
378
args = alias_argv + argv
382
options, args = parser.parse_args(args)
383
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
384
v is not option.OptionParser.DEFAULT_VALUE])
782
385
return args, opts
787
388
def _match_argform(cmd, takes_args, args):
801
402
argdict[argname + '_list'] = None
802
403
elif ap[-1] == '+':
804
raise BzrCommandError("command %r needs one or more %s"
805
% (cmd, argname.upper()))
405
raise errors.BzrCommandError("command %r needs one or more %s"
406
% (cmd, argname.upper()))
807
408
argdict[argname + '_list'] = args[:]
809
410
elif ap[-1] == '$': # all but one
810
411
if len(args) < 2:
811
raise BzrCommandError("command %r needs one or more %s"
812
% (cmd, argname.upper()))
412
raise errors.BzrCommandError("command %r needs one or more %s"
413
% (cmd, argname.upper()))
813
414
argdict[argname + '_list'] = args[:-1]
816
417
# just a plain arg
819
raise BzrCommandError("command %r requires argument %s"
820
% (cmd, argname.upper()))
420
raise errors.BzrCommandError("command %r requires argument %s"
421
% (cmd, argname.upper()))
822
423
argdict[argname] = args.pop(0)
825
raise BzrCommandError("extra argument to command %s: %s"
426
raise errors.BzrCommandError("extra argument to command %s: %s"
433
def apply_profiled(the_callable, *args, **kwargs):
437
pffileno, pfname = tempfile.mkstemp()
439
prof = hotshot.Profile(pfname)
441
ret = prof.runcall(the_callable, *args, **kwargs) or 0
444
stats = hotshot.stats.load(pfname)
446
stats.sort_stats('cum') # 'time'
447
## XXX: Might like to write to stderr or the trace file instead but
448
## print_stats seems hardcoded to stdout
449
stats.print_stats(20)
456
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
457
from bzrlib.lsprof import profile
459
ret, stats = profile(the_callable, *args, **kwargs)
465
cPickle.dump(stats, open(filename, 'w'), 2)
466
print 'Profile data written to %r.' % filename
470
def get_alias(cmd, config=None):
471
"""Return an expanded alias, or None if no alias exists.
474
Command to be checked for an alias.
476
Used to specify an alternative config to use,
477
which is especially useful for testing.
478
If it is unspecified, the global config will be used.
482
config = bzrlib.config.GlobalConfig()
483
alias = config.get_alias(cmd)
486
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
832
490
def run_bzr(argv):
833
491
"""Execute a command.
835
493
This is similar to main(), but without all the trappings for
836
494
logging and error handling.
497
The command-line arguments, without the program name from argv[0]
498
These should already be decoded. All library/test code calling
499
run_bzr should be passing valid strings (don't need decoding).
501
Returns a command status or raises an exception.
503
Special master options: these must come before the command because
504
they control how the command is interpreted.
507
Do not load plugin modules at all
513
Only use builtin commands. (Plugins are still allowed to change
517
Run under the Python hotshot profiler.
520
Run under the Python lsprof profiler.
838
argv = [a.decode(bzrlib.user_encoding) for a in argv]
523
trace.mutter("bzr arguments: %r", argv)
525
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
526
opt_no_aliases = False
527
opt_lsprof_file = None
529
# --no-plugins is handled specially at a very early stage. We need
530
# to load plugins before doing other command parsing so that they
531
# can override commands, but this needs to happen first.
539
elif a == '--lsprof':
541
elif a == '--lsprof-file':
543
opt_lsprof_file = argv[i + 1]
545
elif a == '--no-plugins':
546
opt_no_plugins = True
547
elif a == '--no-aliases':
548
opt_no_aliases = True
549
elif a == '--builtin':
551
elif a in ('--quiet', '-q'):
553
elif a.startswith('-D'):
554
debug.debug_flags.add(a[2:])
561
from bzrlib.builtins import cmd_help
562
cmd_help().run_argv_aliases([])
565
if argv[0] == '--version':
566
from bzrlib.version import show_version
570
if not opt_no_plugins:
571
from bzrlib.plugin import load_plugins
574
from bzrlib.plugin import disable_plugins
579
if not opt_no_aliases:
580
alias_argv = get_alias(argv[0])
582
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
583
argv[0] = alias_argv.pop(0)
586
# We want only 'ascii' command names, but the user may have typed
587
# in a Unicode name. In that case, they should just get a
588
# 'command not found' error later.
590
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
591
run = cmd_obj.run_argv_aliases
592
run_argv = [argv, alias_argv]
841
args, opts = parse_args(argv[1:])
849
elif 'version' in opts:
852
cmd = str(args.pop(0))
854
log_error('usage: bzr COMMAND')
855
log_error(' try "bzr help"')
858
canonical_cmd, cmd_class = get_cmd_class(cmd)
861
if 'profile' in opts:
867
# check options are reasonable
868
allowed = cmd_class.takes_options
870
if oname not in allowed:
871
raise BzrCommandError("option '--%s' is not allowed for command %r"
874
# mix arguments and options into one dictionary
875
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
877
for k, v in opts.items():
878
cmdopts[k.replace('-', '_')] = v
881
import hotshot, tempfile
882
pffileno, pfname = tempfile.mkstemp()
596
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
598
ret = apply_profiled(run, *run_argv)
603
# reset, in case we may do other commands later within the same process
604
trace.be_quiet(False)
606
def display_command(func):
607
"""Decorator that suppresses pipe/interrupt errors."""
608
def ignore_pipe(*args, **kwargs):
884
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
889
stats = hotshot.stats.load(pfname)
891
stats.sort_stats('time')
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
902
cmdobj = cmd_class(cmdopts, cmdargs).status
905
def _report_exception(summary, quiet=False):
907
log_error('bzr: ' + summary)
908
bzrlib.trace.log_exception()
911
tb = sys.exc_info()[2]
912
exinfo = traceback.extract_tb(tb)
914
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
915
sys.stderr.write(' see ~/.bzr.log for debug information\n')
610
result = func(*args, **kwargs)
614
if getattr(e, 'errno', None) is None:
616
if e.errno != errno.EPIPE:
617
# Win32 raises IOError with errno=0 on a broken pipe
618
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
621
except KeyboardInterrupt:
922
bzrlib.open_tracefile(argv)
628
from bzrlib.ui.text import TextUIFactory
629
bzrlib.ui.ui_factory = TextUIFactory()
630
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
631
ret = run_bzr_catch_errors(argv)
632
trace.mutter("return code %d", ret)
636
def run_bzr_catch_errors(argv):
929
# do this here inside the exception wrappers to catch EPIPE
932
quiet = isinstance(e, (BzrCommandError))
933
_report_exception('error: ' + e.args[0], quiet=quiet)
936
# some explanation or hints
939
except AssertionError, e:
940
msg = 'assertion failed'
943
_report_exception(msg)
945
except KeyboardInterrupt, e:
946
_report_exception('interrupted', quiet=True)
950
if isinstance(e, IOError) and e.errno == errno.EPIPE:
954
msg = str(e).rstrip('\n')
955
_report_exception(msg, quiet)
958
bzrlib.trace.close_trace()
639
# do this here inside the exception wrappers to catch EPIPE
641
except (KeyboardInterrupt, Exception), e:
642
# used to handle AssertionError and KeyboardInterrupt
643
# specially here, but hopefully they're handled ok by the logger now
644
trace.report_exception(sys.exc_info(), sys.stderr)
645
if os.environ.get('BZR_PDB'):
646
print '**** entering debugger'
648
pdb.post_mortem(sys.exc_traceback)
961
651
if __name__ == '__main__':
962
652
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
