96
37
assert cmd.startswith("cmd_")
97
38
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):
129
41
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
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):
135
47
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
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.
49
cmd = str(cmd) # not unicode
147
51
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
53
return cmd, globals()[_squish_command_name(cmd)]
154
57
# look for any command which claims this as an alias
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):
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)
167
66
"""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.)
180
68
The docstring for an actual command should give a single-line
181
69
summary, then a complete description of the command. A grammar
182
70
description will be inserted.
185
Other accepted names for this command.
188
73
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
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().
77
List of options that may be given for this command.
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
80
If true, this command isn't advertised.
226
85
takes_options = []
227
encoding_type = 'strict'
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
@deprecated_method(zero_eight)
275
def run_argv(self, 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)
289
if 'help' in opts: # e.g. bzr add --help
290
from bzrlib.help import help_on_command
291
help_on_command(self.name())
293
# mix arguments and options into one dictionary
294
cmdargs = _match_argform(self.name(), self.takes_args, args)
296
for k, v in opts.items():
297
cmdopts[k.replace('-', '_')] = v
299
all_cmd_args = cmdargs.copy()
300
all_cmd_args.update(cmdopts)
304
return self.run(**all_cmd_args)
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)
307
"""Actually run the command.
103
"""Override this in sub-classes.
309
105
This is invoked with the options and arguments bound to
310
106
keyword parameters.
312
Return 0 or None if the command was successful, or a non-zero
313
shell error code if not. It's OK for this method to allow
314
an exception to raise up.
316
raise NotImplementedError('no implementation of command %r'
320
"""Return help message for this class."""
321
from inspect import getdoc
322
if self.__doc__ is Command.__doc__:
327
return _unsquish_command_name(self.__class__.__name__)
329
def plugin_name(self):
330
"""Get the name of the plugin that provides this command.
332
:return: The name of the plugin or None if the command is builtin.
334
mod_parts = self.__module__.split('.')
335
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
341
# Technically, this function hasn't been use in a *really* long time
342
# but we are only deprecating it now.
343
@deprecated_function(zero_eleven)
344
def parse_spec(spec):
350
>>> parse_spec("../@")
352
>>> parse_spec("../f/@35")
354
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
355
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
360
parsed = spec.split('/@')
361
assert len(parsed) == 2
366
parsed[1] = int(parsed[1])
368
pass # We can allow stuff like ./@revid:blahblahblah
372
parsed = [spec, None]
375
def parse_args(command, argv, alias_argv=None):
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_args = ['file*']
123
takes_options = ['all']
124
aliases = ['st', 'stat']
126
def run(self, all=False, file_list=None):
127
b = Branch('.', lock_mode='r')
128
b.show_status(show_all=all, file_list=file_list)
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):
489
from bzrlib.atomicfile import AtomicFile
493
ifn = b.abspath('.bzrignore')
495
# FIXME: probably doesn't handle non-ascii patterns
497
if os.path.exists(ifn):
498
f = b.controlfile(ifn, 'rt')
504
if igns and igns[-1] != '\n':
506
igns += name_pattern + '\n'
508
f = AtomicFile(ifn, 'wt')
512
inv = b.working_tree().inventory
513
if inv.path2id('.bzrignore'):
514
mutter('.bzrignore is already versioned')
516
mutter('need to make new .bzrignore file versioned')
517
b.add(['.bzrignore'])
521
class cmd_ignored(Command):
522
"""List ignored files and the patterns that matched them."""
524
tree = Branch('.').working_tree()
525
for path, file_class, kind, file_id in tree.list_files():
526
if file_class != 'I':
528
## XXX: Slightly inefficient since this was already calculated
529
pat = tree.is_ignored(path)
530
print '%-50s %s' % (path, pat)
533
class cmd_lookup_revision(Command):
534
"""Lookup the revision-id from a revision-number
537
bzr lookup-revision 33
540
takes_args = ['revno']
542
def run(self, revno):
546
raise BzrCommandError("not a valid revision-number: %r" % revno)
548
print Branch('.').lookup_revision(revno)
551
class cmd_export(Command):
552
"""Export past revision to destination directory.
554
If no revision is specified this exports the last committed revision."""
555
takes_args = ['dest']
556
takes_options = ['revision']
557
def run(self, dest, revision=None):
560
rh = b.revision_history()[-1]
562
rh = b.lookup_revision(int(revision))
563
t = b.revision_tree(rh)
567
class cmd_cat(Command):
568
"""Write a file's text from a previous revision."""
570
takes_options = ['revision']
571
takes_args = ['filename']
573
def run(self, filename, revision=None):
575
raise BzrCommandError("bzr cat requires a revision number")
577
b.print_file(b.relpath(filename), int(revision))
580
class cmd_local_time_offset(Command):
581
"""Show the offset in seconds from GMT to local time."""
584
print bzrlib.osutils.local_time_offset()
588
class cmd_commit(Command):
589
"""Commit changes into a new revision.
591
TODO: Commit only selected files.
593
TODO: Run hooks on tree to-be-committed, and after commit.
595
TODO: Strict commit that fails if there are unknown or deleted files.
597
takes_options = ['message', 'file', 'verbose']
598
aliases = ['ci', 'checkin']
600
def run(self, message=None, file=None, verbose=False):
601
## Warning: shadows builtin file()
602
if not message and not file:
603
raise BzrCommandError("please specify a commit message",
604
["use either --message or --file"])
605
elif message and file:
606
raise BzrCommandError("please specify either --message or --file")
610
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
612
Branch('.').commit(message, verbose=verbose)
615
class cmd_check(Command):
616
"""Validate consistency of branch history.
618
This command checks various invariants about the branch storage to
619
detect data corruption or bzr bugs.
621
takes_args = ['dir?']
622
def run(self, dir='.'):
624
bzrlib.check.check(Branch(dir, find_root=False))
628
class cmd_whoami(Command):
629
"""Show bzr user id."""
630
takes_options = ['email']
632
def run(self, email=False):
634
print bzrlib.osutils.user_email()
636
print bzrlib.osutils.username()
639
class cmd_selftest(Command):
640
"""Run internal test suite"""
643
failures, tests = 0, 0
645
import doctest, bzrlib.store, bzrlib.tests
646
bzrlib.trace.verbose = False
648
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
649
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
650
mf, mt = doctest.testmod(m)
653
print '%-40s %3d tests' % (m.__name__, mt),
655
print '%3d FAILED!' % mf
659
print '%-40s %3d tests' % ('total', tests),
661
print '%3d FAILED!' % failures
667
class cmd_version(Command):
668
"""Show version of bzr"""
673
print "bzr (bazaar-ng) %s" % bzrlib.__version__
674
print bzrlib.__copyright__
675
print "http://bazaar-ng.org/"
677
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
678
print "you may use, modify and redistribute it under the terms of the GNU"
679
print "General Public License version 2 or later."
682
class cmd_rocks(Command):
683
"""Statement of optimism."""
686
print "it sure does!"
689
class cmd_assert_fail(Command):
690
"""Test reporting of assertion failures"""
693
assert False, "always fails"
696
class cmd_help(Command):
697
"""Show help on a command or other topic.
699
For a list of all available commands, say 'bzr help commands'."""
700
takes_args = ['topic?']
703
def run(self, topic=None):
708
######################################################################
712
# list of all available options; the rhs can be either None for an
713
# option that takes no argument, or a constructor function that checks
737
def parse_args(argv):
376
738
"""Parse command line.
378
740
Arguments and options are parsed at this level before being passed
379
741
down to specific command handlers. This routine knows, from a
380
742
lookup table, something about the available options, what optargs
381
743
they take, and which commands will accept them.
745
>>> parse_args('--help'.split())
747
>>> parse_args('--version'.split())
748
([], {'version': True})
749
>>> parse_args('status --all'.split())
750
(['status'], {'all': True})
751
>>> parse_args('commit --message=biter'.split())
752
(['commit'], {'message': u'biter'})
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])
757
# TODO: Maybe handle '--' to end options?
762
# option names must not be unicode
766
mutter(" got option %r" % a)
768
optname, optarg = a[2:].split('=', 1)
771
if optname not in OPTIONS:
772
bailout('unknown long option %r' % a)
775
if shortopt not in SHORT_OPTIONS:
776
bailout('unknown short option %r' % a)
777
optname = SHORT_OPTIONS[shortopt]
780
# XXX: Do we ever want to support this, e.g. for -r?
781
bailout('repeated option %r' % a)
783
optargfn = OPTIONS[optname]
787
bailout('option %r needs an argument' % a)
790
opts[optname] = optargfn(optarg)
793
bailout('option %r takes no argument' % optname)
393
798
return args, opts
396
803
def _match_argform(cmd, takes_args, args):
410
817
argdict[argname + '_list'] = None
411
818
elif ap[-1] == '+':
413
raise errors.BzrCommandError("command %r needs one or more %s"
414
% (cmd, argname.upper()))
820
raise BzrCommandError("command %r needs one or more %s"
821
% (cmd, argname.upper()))
416
823
argdict[argname + '_list'] = args[:]
418
825
elif ap[-1] == '$': # all but one
419
826
if len(args) < 2:
420
raise errors.BzrCommandError("command %r needs one or more %s"
421
% (cmd, argname.upper()))
827
raise BzrCommandError("command %r needs one or more %s"
828
% (cmd, argname.upper()))
422
829
argdict[argname + '_list'] = args[:-1]
425
832
# just a plain arg
428
raise errors.BzrCommandError("command %r requires argument %s"
429
% (cmd, argname.upper()))
835
raise BzrCommandError("command %r requires argument %s"
836
% (cmd, argname.upper()))
431
838
argdict[argname] = args.pop(0)
434
raise errors.BzrCommandError("extra argument to command %s: %s"
841
raise BzrCommandError("extra argument to command %s: %s"
441
def apply_profiled(the_callable, *args, **kwargs):
445
pffileno, pfname = tempfile.mkstemp()
447
prof = hotshot.Profile(pfname)
449
ret = prof.runcall(the_callable, *args, **kwargs) or 0
452
stats = hotshot.stats.load(pfname)
454
stats.sort_stats('cum') # 'time'
455
## XXX: Might like to write to stderr or the trace file instead but
456
## print_stats seems hardcoded to stdout
457
stats.print_stats(20)
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'))]
498
848
def run_bzr(argv):
499
849
"""Execute a command.
501
851
This is similar to main(), but without all the trappings for
502
852
logging and error handling.
505
The command-line arguments, without the program name from argv[0]
506
These should already be decoded. All library/test code calling
507
run_bzr should be passing valid strings (don't need decoding).
509
Returns a command status or raises an exception.
511
Special master options: these must come before the command because
512
they control how the command is interpreted.
515
Do not load plugin modules at all
521
Only use builtin commands. (Plugins are still allowed to change
525
Run under the Python hotshot profiler.
528
Run under the Python lsprof profiler.
531
trace.mutter("bzr arguments: %r", argv)
533
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
534
opt_no_aliases = False
535
opt_lsprof_file = None
537
# --no-plugins is handled specially at a very early stage. We need
538
# to load plugins before doing other command parsing so that they
539
# can override commands, but this needs to happen first.
547
elif a == '--lsprof':
549
elif a == '--lsprof-file':
551
opt_lsprof_file = argv[i + 1]
553
elif a == '--no-plugins':
554
opt_no_plugins = True
555
elif a == '--no-aliases':
556
opt_no_aliases = True
557
elif a == '--builtin':
559
elif a in ('--quiet', '-q'):
561
elif a.startswith('-D'):
562
debug.debug_flags.add(a[2:])
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
573
if argv[0] == '--version':
574
from bzrlib.version import show_version
578
if not opt_no_plugins:
579
from bzrlib.plugin import load_plugins
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.
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
854
argv = [a.decode(bzrlib.user_encoding) for a in 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):
857
args, opts = parse_args(argv[1:])
865
elif 'version' in opts:
868
cmd = str(args.pop(0))
870
log_error('usage: bzr COMMAND')
871
log_error(' try "bzr help"')
874
canonical_cmd, cmd_class = get_cmd_class(cmd)
877
if 'profile' in opts:
883
# check options are reasonable
884
allowed = cmd_class.takes_options
886
if oname not in allowed:
887
raise BzrCommandError("option '--%s' is not allowed for command %r"
890
# mix arguments and options into one dictionary
891
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
893
for k, v in opts.items():
894
cmdopts[k.replace('-', '_')] = v
897
import hotshot, tempfile
898
pffileno, pfname = tempfile.mkstemp()
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:
900
prof = hotshot.Profile(pfname)
901
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
905
stats = hotshot.stats.load(pfname)
907
stats.sort_stats('time')
908
## XXX: Might like to write to stderr or the trace file instead but
909
## print_stats seems hardcoded to stdout
910
stats.print_stats(20)
918
cmdobj = cmd_class(cmdopts, cmdargs).status
921
def _report_exception(summary, quiet=False):
923
log_error('bzr: ' + summary)
924
bzrlib.trace.log_exception()
927
tb = sys.exc_info()[2]
928
exinfo = traceback.extract_tb(tb)
930
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
931
sys.stderr.write(' see ~/.bzr.log for debug information\n')
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)
648
def run_bzr_catch_errors(argv):
938
bzrlib.open_tracefile(argv)
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)
945
# do this here inside the exception wrappers to catch EPIPE
948
quiet = isinstance(e, (BzrCommandError))
949
_report_exception('error: ' + e.args[0], quiet=quiet)
952
# some explanation or hints
955
except AssertionError, e:
956
msg = 'assertion failed'
959
_report_exception(msg)
961
except KeyboardInterrupt, e:
962
_report_exception('interrupted', quiet=True)
966
if isinstance(e, IOError) and e.errno == errno.EPIPE:
970
msg = str(e).rstrip('\n')
971
_report_exception(msg, quiet)
974
bzrlib.trace.close_trace()
663
977
if __name__ == '__main__':
664
978
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
