16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
67
from pprint import pprint
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
32
from warnings import warn
70
33
from inspect import getdoc
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
120
def cmd_status(all=False):
121
"""Display status summary.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
#import bzrlib.status
128
#bzrlib.status.tree_status(Branch('.'))
129
Branch('.').show_status(show_all=all)
133
######################################################################
135
def cmd_get_revision(revision_id):
136
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
def cmd_get_file_text(text_id):
140
"""Get contents of a file by hash."""
141
sf = Branch('.').text_store[text_id]
142
pumpfile(sf, sys.stdout)
146
######################################################################
151
"""Show number of revisions on this branch"""
152
print Branch('.').revno()
156
def cmd_add(file_list, verbose=False):
157
"""Add specified files or directories.
159
In non-recursive mode, all the named items are added, regardless
160
of whether they were previously ignored. A warning is given if
161
any of the named files are already versioned.
163
In recursive mode (the default), files are treated the same way
164
but the behaviour for directories is different. Directories that
165
are already versioned do not give a warning. All directories,
166
whether already versioned or not, are searched for files or
167
subdirectories that are neither versioned or ignored, and these
168
are added. This search proceeds recursively into versioned
171
Therefore simply saying 'bzr add .' will version all files that
172
are currently unknown.
174
bzrlib.add.smart_add(file_list, verbose)
177
def cmd_relpath(filename):
178
"""Show path of file relative to root"""
179
print Branch(filename).relpath(filename)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
198
# TODO: Maybe a 'mv' command that has the combined move/rename
199
# special behaviour of Unix?
201
def cmd_move(source_list, dest):
204
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
208
def cmd_rename(from_name, to_name):
209
"""Change the name of an entry.
211
usage: bzr rename FROM_NAME TO_NAME
214
bzr rename frob.c frobber.c
215
bzr rename src/frob.c lib/frob.c
217
It is an error if the destination name exists.
219
See also the 'move' command, which moves files into a different
220
directory without changing their name.
222
TODO: Some way to rename multiple files without invoking bzr for each
225
b.rename_one(b.relpath(from_name), b.relpath(to_name))
230
def cmd_renames(dir='.'):
231
"""Show list of renamed files.
233
usage: bzr renames [BRANCH]
235
TODO: Option to show renames between two historical versions.
237
TODO: Only show renames under dir, rather than in the whole branch.
240
old_inv = b.basis_tree().inventory
241
new_inv = b.read_working_inventory()
243
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
245
for old_name, new_name in renames:
246
print "%s => %s" % (old_name, new_name)
251
"""info: Show statistical information for this branch
255
info.show_info(Branch('.'))
259
def cmd_remove(file_list, verbose=False):
260
b = Branch(file_list[0])
261
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
265
def cmd_file_id(filename):
266
"""Print file_id of a particular file or directory.
268
usage: bzr file-id FILE
270
The file_id is assigned when the file is first added and remains the
271
same through all revisions where the file exists, even when it is
275
i = b.inventory.path2id(b.relpath(filename))
277
bailout("%r is not a versioned file" % filename)
282
def cmd_file_id_path(filename):
283
"""Print path of file_ids to a file or directory.
285
usage: bzr file-id-path FILE
287
This prints one line for each directory down to the target,
288
starting at the branch root."""
291
fid = inv.path2id(b.relpath(filename))
293
bailout("%r is not a versioned file" % filename)
294
for fip in inv.get_idpath(fid):
298
def cmd_revision_history():
299
for patchid in Branch('.').revision_history():
303
def cmd_directories():
304
for name, ie in Branch('.').read_working_inventory().directories():
312
for name, ie in Branch('.').working_tree().missing():
317
# TODO: Check we're not already in a working directory? At the
318
# moment you'll get an ugly error.
320
# TODO: What if we're in a subdirectory of a branch? Would like
321
# to allow that, but then the parent may need to understand that
322
# the children have disappeared, or should they be versioned in
325
# TODO: Take an argument/option for branch name.
326
Branch('.', init=True)
329
def cmd_diff(revision=None, file_list=None):
330
"""bzr diff: Show differences in working tree.
332
usage: bzr diff [-r REV] [FILE...]
335
Show changes since REV, rather than predecessor.
337
If files are listed, only the changes in those files are listed.
338
Otherwise, all changes for the tree are listed.
340
TODO: Given two revision arguments, show the difference between them.
342
TODO: Allow diff across branches.
344
TODO: Option to use external diff command; could be GNU diff, wdiff,
347
TODO: If a directory is given, diff everything under that.
349
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
352
## TODO: Shouldn't be in the cmd function.
357
old_tree = b.basis_tree()
359
old_tree = b.revision_tree(b.lookup_revision(revision))
361
new_tree = b.working_tree()
363
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
367
DEVNULL = '/dev/null'
368
# Windows users, don't panic about this filename -- it is a
369
# special signal to GNU patch that the file should be created or
370
# deleted respectively.
372
# TODO: Generation of pseudo-diffs for added/deleted files could
373
# be usefully made into a much faster special case.
375
# TODO: Better to return them in sorted order I think.
377
# FIXME: If given a file list, compare only those files rather
378
# than comparing everything and then throwing stuff away.
380
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
382
if file_list and new_name not in file_list:
385
# Don't show this by default; maybe do it if an option is passed
386
# idlabel = ' {%s}' % fid
389
# FIXME: Something about the diff format makes patch unhappy
390
# with newly-added files.
392
def diffit(oldlines, newlines, **kw):
393
# FIXME: difflib is wrong if there is no trailing newline.
395
# Special workaround for Python2.3, where difflib fails if
396
# both sequences are empty.
397
if oldlines or newlines:
398
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
401
if file_state in ['.', '?', 'I']:
403
elif file_state == 'A':
404
print '*** added %s %r' % (kind, new_name)
407
new_tree.get_file(fid).readlines(),
409
tofile=new_label + new_name + idlabel)
410
elif file_state == 'D':
411
assert isinstance(old_name, types.StringTypes)
412
print '*** deleted %s %r' % (kind, old_name)
414
diffit(old_tree.get_file(fid).readlines(), [],
415
fromfile=old_label + old_name + idlabel,
417
elif file_state in ['M', 'R']:
418
if file_state == 'M':
419
assert kind == 'file'
420
assert old_name == new_name
421
print '*** modified %s %r' % (kind, new_name)
422
elif file_state == 'R':
423
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
426
diffit(old_tree.get_file(fid).readlines(),
427
new_tree.get_file(fid).readlines(),
428
fromfile=old_label + old_name + idlabel,
429
tofile=new_label + new_name)
431
bailout("can't represent state %s {%s}" % (file_state, fid))
435
def cmd_deleted(show_ids=False):
436
"""List files deleted in the working tree.
438
TODO: Show files deleted since a previous revision, or between two revisions.
442
new = b.working_tree()
444
## TODO: Much more efficient way to do this: read in new
445
## directories with readdir, rather than stating each one. Same
446
## level of effort but possibly much less IO. (Or possibly not,
447
## if the directories are very large...)
449
for path, ie in old.inventory.iter_entries():
450
if not new.has_id(ie.file_id):
452
print '%-50s %s' % (path, ie.file_id)
458
def cmd_parse_inventory():
461
cElementTree.ElementTree().parse(file('.bzr/inventory'))
465
def cmd_load_inventory():
466
"""Load inventory for timing purposes"""
467
Branch('.').basis_tree().inventory
470
def cmd_dump_inventory():
471
Branch('.').read_working_inventory().write_xml(sys.stdout)
474
def cmd_dump_new_inventory():
475
import bzrlib.newinventory
476
inv = Branch('.').basis_tree().inventory
477
bzrlib.newinventory.write_inventory(inv, sys.stdout)
480
def cmd_load_new_inventory():
481
import bzrlib.newinventory
482
bzrlib.newinventory.read_new_inventory(sys.stdin)
485
def cmd_dump_slacker_inventory():
486
import bzrlib.newinventory
487
inv = Branch('.').basis_tree().inventory
488
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
492
def cmd_dump_text_inventory():
493
import bzrlib.textinv
494
inv = Branch('.').basis_tree().inventory
495
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
498
def cmd_load_text_inventory():
499
import bzrlib.textinv
500
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
501
print 'loaded %d entries' % len(inv)
505
def cmd_root(filename=None):
506
"""Print the branch root."""
507
print bzrlib.branch.find_branch_root(filename)
510
def cmd_log(timezone='original', verbose=False):
511
"""Show log of this branch.
513
TODO: Options for utc; to show ids; to limit range; etc.
515
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
518
def cmd_ls(revision=None, verbose=False):
519
"""List files in a tree.
521
TODO: Take a revision or remote path and list that tree instead.
525
tree = b.working_tree()
527
tree = b.revision_tree(b.lookup_revision(revision))
529
for fp, fc, kind, fid in tree.list_files():
531
if kind == 'directory':
538
print '%-8s %s%s' % (fc, fp, kindch)
545
"""List unknown files"""
546
for f in Branch('.').unknowns():
552
"""List ignored files and the patterns that matched them.
554
tree = Branch('.').working_tree()
555
for path, file_class, kind, file_id in tree.list_files():
556
if file_class != 'I':
558
## XXX: Slightly inefficient since this was already calculated
559
pat = tree.is_ignored(path)
560
print '%-50s %s' % (path, pat)
563
def cmd_lookup_revision(revno):
567
bailout("usage: lookup-revision REVNO",
568
["REVNO is a non-negative revision number for this branch"])
570
print Branch('.').lookup_revision(revno) or NONE_STRING
574
def cmd_export(revno, dest):
575
"""Export past revision to destination directory."""
577
rh = b.lookup_revision(int(revno))
578
t = b.revision_tree(rh)
581
def cmd_cat(revision, filename):
582
"""Print file to stdout."""
584
b.print_file(b.relpath(filename), int(revision))
587
######################################################################
588
# internal/test commands
592
"""Print a newly-generated UUID."""
593
print bzrlib.osutils.uuid()
597
def cmd_local_time_offset():
598
print bzrlib.osutils.local_time_offset()
602
def cmd_commit(message=None, verbose=False):
603
"""Commit changes to a new revision.
606
Description of changes in this revision; free form text.
607
It is recommended that the first line be a single-sentence
610
Show status of changed files,
612
TODO: Commit only selected files.
614
TODO: Run hooks on tree to-be-committed, and after commit.
616
TODO: Strict commit that fails if there are unknown or deleted files.
620
bailout("please specify a commit message")
621
Branch('.').commit(message, verbose=verbose)
624
def cmd_check(dir='.'):
625
"""check: Consistency check of branch history.
627
usage: bzr check [-v] [BRANCH]
630
--verbose, -v Show progress of checking.
632
This command checks various invariants about the branch storage to
633
detect data corruption or bzr bugs.
636
bzrlib.check.check(Branch(dir, find_root=False))
639
def cmd_is(pred, *rest):
640
"""Test whether PREDICATE is true."""
642
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
644
bailout("unknown predicate: %s" % quotefn(pred))
648
except BzrCheckError:
649
# by default we don't print the message so that this can
650
# be used from shell scripts without producing noise
657
TODO: Command to show only the email-address part as parsed out.
659
print bzrlib.osutils.username()
662
def cmd_gen_revision_id():
663
print bzrlib.branch._gen_revision_id(time.time())
667
"""Run internal test suite"""
668
## -v, if present, is seen by doctest; the argument is just here
669
## so our parser doesn't complain
671
## TODO: --verbose option
673
failures, tests = 0, 0
675
import doctest, bzrlib.store, bzrlib.tests
676
bzrlib.trace.verbose = False
678
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
679
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
680
mf, mt = doctest.testmod(m)
683
print '%-40s %3d tests' % (m.__name__, mt),
685
print '%3d FAILED!' % mf
689
print '%-40s %3d tests' % ('total', tests),
691
print '%3d FAILED!' % failures
698
cmd_doctest = cmd_selftest
701
######################################################################
705
def cmd_help(topic=None):
710
# otherwise, maybe the name of a command?
712
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
714
bailout("no help for %r" % topic)
718
bailout("sorry, no detailed help yet for %r" % topic)
726
print "bzr (bazaar-ng) %s" % bzrlib.__version__
727
print bzrlib.__copyright__
728
print "http://bazaar-ng.org/"
731
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
732
you may use, modify and redistribute it under the terms of the GNU
733
General Public License version 2 or later."""
737
"""Statement of optimism."""
738
print "it sure does!"
742
######################################################################
746
# list of all available options; the rhs can be either None for an
747
# option that takes no argument, or a constructor function that checks
767
# List of options that apply to particular commands; commands not
772
'commit': ['message', 'verbose'],
773
'deleted': ['show-ids'],
774
'diff': ['revision'],
775
'inventory': ['revision'],
776
'log': ['timezone', 'verbose'],
777
'ls': ['revision', 'verbose'],
778
'remove': ['verbose'],
788
'export': ['revno', 'dest'],
789
'file-id': ['filename'],
790
'file-id-path': ['filename'],
791
'get-file-text': ['text_id'],
792
'get-inventory': ['inventory_id'],
793
'get-revision': ['revision_id'],
794
'get-revision-inventory': ['revision_id'],
798
'lookup-revision': ['revno'],
799
'move': ['source$', 'dest'],
800
'relpath': ['filename'],
802
'rename': ['from_name', 'to_name'],
804
'root': ['filename?'],
809
def parse_args(argv):
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
46
def register_command(cmd):
47
"Utility function to help register a command"
50
if k.startswith("cmd_"):
51
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)
58
log_error('Two plugins defined the same command: %r' % k)
59
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
62
def _squish_command_name(cmd):
63
return 'cmd_' + cmd.replace('-', '_')
66
def _unsquish_command_name(cmd):
67
assert cmd.startswith("cmd_")
68
return cmd[4:].replace('_','-')
71
def _builtin_commands():
72
import bzrlib.builtins
74
builtins = bzrlib.builtins.__dict__
76
if name.startswith("cmd_"):
77
real_name = _unsquish_command_name(name)
78
r[real_name] = builtins[name]
83
def builtin_command_names():
84
"""Return list of builtin command names."""
85
return _builtin_commands().keys()
88
def plugin_command_names():
89
return plugin_cmds.keys()
92
def _get_cmd_dict(plugins_override=True):
93
"""Return name->class mapping for all commands."""
94
d = _builtin_commands()
100
def get_all_cmds(plugins_override=True):
101
"""Return canonical name and class for all registered commands."""
102
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
106
def get_cmd_object(cmd_name, plugins_override=True):
107
"""Return the canonical name and command class for a command.
110
If true, plugin commands can override builtins.
112
from bzrlib.externalcommand import ExternalCommand
114
cmd_name = str(cmd_name) # not unicode
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
return cmds[cmd_name]()
123
# look for any command which claims this as an alias
124
for real_cmd_name, cmd_class in cmds.iteritems():
125
if cmd_name in cmd_class.aliases:
128
cmd_obj = ExternalCommand.find_command(cmd_name)
132
raise BzrCommandError("unknown command %r" % cmd_name)
135
class Command(object):
136
"""Base class for commands.
138
Commands are the heart of the command-line bzr interface.
140
The command object mostly handles the mapping of command-line
141
parameters into one or more bzrlib operations, and of the results
144
Commands normally don't have any state. All their arguments are
145
passed in to the run method. (Subclasses may take a different
146
policy if the behaviour of the instance needs to depend on e.g. a
147
shell plugin and not just its Python class.)
149
The docstring for an actual command should give a single-line
150
summary, then a complete description of the command. A grammar
151
description will be inserted.
154
Other accepted names for this command.
157
List of argument forms, marked with whether they are optional,
161
List of options that may be given for this command. These can
162
be either strings, referring to globally-defined options,
163
or option objects. Retrieve through options().
166
If true, this command isn't advertised. This is typically
167
for commands intended for expert users.
176
"""Construct an instance of this command."""
177
if self.__doc__ == Command.__doc__:
178
warn("No help message set for %r" % self)
181
"""Return dict of valid options for this command.
183
Maps from long option name to option object."""
185
r['help'] = Option.OPTIONS['help']
186
for o in self.takes_options:
187
if not isinstance(o, Option):
188
o = Option.OPTIONS[o]
192
def run_argv(self, argv):
193
"""Parse command line and run."""
194
args, opts = parse_args(self, argv)
195
if 'help' in opts: # e.g. bzr add --help
196
from bzrlib.help import help_on_command
197
help_on_command(self.name())
199
# XXX: This should be handled by the parser
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()))
205
# mix arguments and options into one dictionary
206
cmdargs = _match_argform(self.name(), self.takes_args, args)
208
for k, v in opts.items():
209
cmdopts[k.replace('-', '_')] = v
211
all_cmd_args = cmdargs.copy()
212
all_cmd_args.update(cmdopts)
214
return self.run(**all_cmd_args)
218
"""Actually run the command.
220
This is invoked with the options and arguments bound to
223
Return 0 or None if the command was successful, or a non-zero
224
shell error code if not. It's OK for this method to allow
225
an exception to raise up.
227
raise NotImplementedError()
231
"""Return help message for this class."""
232
if self.__doc__ is Command.__doc__:
237
return _unsquish_command_name(self.__class__.__name__)
240
def parse_spec(spec):
246
>>> parse_spec("../@")
248
>>> parse_spec("../f/@35")
250
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
251
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
256
parsed = spec.split('/@')
257
assert len(parsed) == 2
262
parsed[1] = int(parsed[1])
264
pass # We can allow stuff like ./@revid:blahblahblah
268
parsed = [spec, None]
271
def parse_args(command, argv):
810
272
"""Parse command line.
812
274
Arguments and options are parsed at this level before being passed
813
275
down to specific command handlers. This routine knows, from a
814
276
lookup table, something about the available options, what optargs
815
277
they take, and which commands will accept them.
817
>>> parse_args('--help'.split())
819
>>> parse_args('--version'.split())
820
([], {'version': True})
821
>>> parse_args('status --all'.split())
822
(['status'], {'all': True})
823
>>> parse_args('commit --message=biter'.split())
824
(['commit'], {'message': u'biter'})
279
# TODO: chop up this beast; make it a method of the Command
829
# TODO: Maybe handle '--' to end options?
283
cmd_options = command.options()
291
# We've received a standalone -- No more flags
834
295
# option names must not be unicode
918
390
# just a plain arg
921
bailout("command %r requires argument %s"
393
raise BzrCommandError("command %r requires argument %s"
922
394
% (cmd, argname.upper()))
924
396
argdict[argname] = args.pop(0)
927
bailout("extra arguments to command %s: %r"
399
raise BzrCommandError("extra argument to command %s: %s"
406
def apply_profiled(the_callable, *args, **kwargs):
410
pffileno, pfname = tempfile.mkstemp()
412
prof = hotshot.Profile(pfname)
414
ret = prof.runcall(the_callable, *args, **kwargs) or 0
417
stats = hotshot.stats.load(pfname)
419
stats.sort_stats('cum') # 'time'
420
## XXX: Might like to write to stderr or the trace file instead but
421
## print_stats seems hardcoded to stdout
422
stats.print_stats(20)
934
429
def run_bzr(argv):
935
430
"""Execute a command.
937
432
This is similar to main(), but without all the trappings for
938
433
logging and error handling.
436
The command-line arguments, without the program name from argv[0]
438
Returns a command status or raises an exception.
440
Special master options: these must come before the command because
441
they control how the command is interpreted.
444
Do not load plugin modules at all
447
Only use builtin commands. (Plugins are still allowed to change
451
Run under the Python profiler.
453
# Load all of the transport methods
454
import bzrlib.transport.local, bzrlib.transport.http
941
456
argv = [a.decode(bzrlib.user_encoding) for a in argv]
944
args, opts = parse_args(argv[1:])
946
# TODO: pass down other arguments in case they asked for
947
# help on a command name?
953
elif 'version' in opts:
956
cmd = str(args.pop(0))
958
log_error('usage: bzr COMMAND')
959
log_error(' try "bzr help"')
963
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
965
bailout("unknown command " + `cmd`)
968
if 'profile' in opts:
974
# check options are reasonable
975
allowed = cmd_options.get(cmd, [])
977
if oname not in allowed:
978
bailout("option %r is not allowed for command %r"
981
# TODO: give an error if there are any mandatory options which are
982
# not specified? Or maybe there shouldn't be any "mandatory
983
# options" (it is an oxymoron)
985
# mix arguments and options into one dictionary
986
cmdargs = _match_args(cmd, args)
987
for k, v in opts.items():
988
cmdargs[k.replace('-', '_')] = v
992
pffileno, pfname = tempfile.mkstemp()
994
prof = hotshot.Profile(pfname)
995
ret = prof.runcall(cmd_handler, **cmdargs) or 0
999
stats = hotshot.stats.load(pfname)
1001
stats.sort_stats('time')
1002
## XXX: Might like to write to stderr or the trace file instead but
1003
## print_stats seems hardcoded to stdout
1004
stats.print_stats(20)
1012
return cmd_handler(**cmdargs) or 0
1016
def _report_exception(e, summary):
1018
log_error('bzr: ' + summary)
1019
bzrlib.trace.log_exception(e)
1020
tb = sys.exc_info()[2]
1021
exinfo = traceback.extract_tb(tb, 1)
1023
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[0][:3])
1024
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1027
def cmd_assert_fail():
1028
assert False, "always fails"
458
opt_profile = opt_no_plugins = opt_builtin = False
460
# --no-plugins is handled specially at a very early stage. We need
461
# to load plugins before doing other command parsing so that they
462
# can override commands, but this needs to happen first.
467
elif a == '--no-plugins':
468
opt_no_plugins = True
469
elif a == '--builtin':
475
if (not argv) or (argv[0] == '--help'):
476
from bzrlib.help import help
483
if argv[0] == '--version':
484
from bzrlib.builtins import show_version
488
if not opt_no_plugins:
489
from bzrlib.plugin import load_plugins
492
cmd = str(argv.pop(0))
494
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
497
ret = apply_profiled(cmd_obj.run_argv, argv)
499
ret = cmd_obj.run_argv(argv)
1032
bzrlib.trace.create_tracefile(argv)
505
bzrlib.trace.log_startup(argv)
506
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
508
return run_bzr_catch_errors(argv[1:])
511
def run_bzr_catch_errors(argv):
1039
_report_exception(e, 'error: ' + e.args[0])
1042
# some explanation or hints
1045
except AssertionError, e:
1046
msg = 'assertion failed'
1048
msg += ': ' + str(e)
1049
_report_exception(e, msg)
1050
except Exception, e:
1051
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1054
bzrlib.trace.close_trace()
1056
## TODO: Trap AssertionError
1058
# TODO: Maybe nicer handling of IOError especially for broken pipe.
516
# do this here inside the exception wrappers to catch EPIPE
518
except BzrCommandError, e:
519
# command line syntax error, etc
523
bzrlib.trace.log_exception()
525
except AssertionError, e:
526
bzrlib.trace.log_exception('assertion failed: ' + str(e))
528
except KeyboardInterrupt, e:
529
bzrlib.trace.log_exception('interrupted')
533
if (isinstance(e, IOError)
534
and hasattr(e, 'errno')
535
and e.errno == errno.EPIPE):
536
bzrlib.trace.note('broken pipe')
541
bzrlib.trace.log_exception()
1062
544
if __name__ == '__main__':
1063
545
sys.exit(main(sys.argv))