19
import sys, os, time, os.path
22
23
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
31
def register_command(cmd):
32
"Utility function to help register a command"
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
27
from bzrlib.revision import Revision
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
30
from bzrlib import merge
46
33
def _squish_command_name(cmd):
51
38
assert cmd.startswith("cmd_")
52
39
return cmd[4:].replace('_','-')
54
def _parse_revision_str(revstr):
55
"""This handles a revision string -> revno.
57
There are several possibilities:
60
'234:345' -> [234, 345]
64
In the future we will also support:
65
'uuid:blah-blah-blah' -> ?
66
'hash:blahblahblah' -> ?
70
if revstr.find(':') != -1:
71
revs = revstr.split(':')
73
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
78
revs[0] = int(revs[0])
83
revs[1] = int(revs[1])
90
def _get_cmd_dict(plugins_override=True):
42
"""Return canonical name and class for all registered commands."""
92
43
for k, v in globals().iteritems():
93
44
if k.startswith("cmd_"):
94
d[_unsquish_command_name(k)] = v
95
# If we didn't load plugins, the plugin_cmds dict will be empty
99
d2 = plugin_cmds.copy()
105
def get_all_cmds(plugins_override=True):
106
"""Return canonical name and class for all registered commands."""
107
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
111
def get_cmd_class(cmd, plugins_override=True):
45
yield _unsquish_command_name(k), v
47
def get_cmd_class(cmd):
112
48
"""Return the canonical name and command class for a command.
114
50
cmd = str(cmd) # not unicode
116
52
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
return cmd, cmds[cmd]
54
return cmd, globals()[_squish_command_name(cmd)]
123
58
# look for any command which claims this as an alias
124
for cmdname, cmdclass in cmds.iteritems():
59
for cmdname, cmdclass in get_all_cmds():
125
60
if cmd in cmdclass.aliases:
126
61
return cmdname, cmdclass
212
146
def __init__(self, path):
149
# TODO: If either of these fail, we should detect that and
150
# assume that path is not really a bzr plugin after all.
215
152
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
153
self.takes_options = pipe.readline().split()
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
223
# TODO: Is there any way to check takes_args is valid here?
224
154
self.takes_args = pipe.readline().split()
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
229
157
pipe = os.popen('%s --bzr-help' % path, 'r')
230
158
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
234
161
def __call__(self, options, arguments):
235
162
Command.__init__(self, options, arguments)
357
282
recursively add that parent, rather than giving an error?
359
284
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
285
takes_options = ['verbose']
362
def run(self, file_list, verbose=False, no_recurse=False):
363
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
371
This is equivalent to creating the directory and then adding it.
373
takes_args = ['dir+']
375
def run(self, dir_list):
382
b.add([d], verbose=True)
287
def run(self, file_list, verbose=False):
288
bzrlib.add.smart_add(file_list, verbose)
385
291
class cmd_relpath(Command):
386
292
"""Show path of a file relative to root"""
387
293
takes_args = ['filename']
390
295
def run(self, filename):
391
print find_branch(filename).relpath(filename)
296
print Branch(filename).relpath(filename)
395
300
class cmd_inventory(Command):
396
301
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
302
takes_options = ['revision']
399
def run(self, revision=None, show_ids=False):
304
def run(self, revision=None):
401
306
if revision == None:
402
307
inv = b.read_working_inventory()
404
309
inv = b.get_revision_inventory(b.lookup_revision(revision))
406
for path, entry in inv.entries():
408
print '%-50s %s' % (path, entry.file_id)
311
for path, entry in inv.iter_entries():
312
print '%-50s %s' % (entry.file_id, path)
413
315
class cmd_move(Command):
442
344
takes_args = ['from_name', 'to_name']
444
346
def run(self, from_name, to_name):
446
348
b.rename_one(b.relpath(from_name), b.relpath(to_name))
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
466
takes_args = ['location?']
468
def run(self, location=None):
469
from bzrlib.merge import merge
471
from shutil import rmtree
474
br_to = find_branch('.')
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if e.errno != errno.ENOENT:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
523
def run(self, from_location, to_location=None, revision=None):
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
531
cache_root = tempfile.mkdtemp()
534
br_from = find_cached_branch(from_location, cache_root)
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
546
os.mkdir(to_location)
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
556
br_to = Branch(to_location, init=True)
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
562
msg = "The branch %s has no revision %d." % (from_location,
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
583
352
class cmd_renames(Command):
584
353
"""Show list of renamed files.
652
422
takes_args = ['filename']
653
423
def run(self, filename):
654
b = find_branch(filename)
655
425
inv = b.inventory
656
426
fid = inv.path2id(b.relpath(filename))
658
raise BzrError("%r is not a versioned file" % filename)
428
bailout("%r is not a versioned file" % filename)
659
429
for fip in inv.get_idpath(fid):
663
433
class cmd_revision_history(Command):
664
434
"""Display list of revision ids on this branch."""
667
for patchid in find_branch('.').revision_history():
436
for patchid in Branch('.').revision_history():
671
440
class cmd_directories(Command):
672
441
"""Display list of versioned directories in this branch."""
674
for name, ie in find_branch('.').read_working_inventory().directories():
443
for name, ie in Branch('.').read_working_inventory().directories():
723
491
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
492
takes_options = ['revision']
727
def run(self, revision=None, file_list=None, diff_options=None):
495
def run(self, revision=None, file_list=None):
728
496
from bzrlib.diff import show_diff
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
498
show_diff(Branch('.'), revision, specific_files=file_list)
826
585
class cmd_log(Command):
827
586
"""Show log of this branch.
829
To request a range of logs, you can use the command -r begin:end
830
-r revision requests a specific revision, -r :end or -r begin: are
588
TODO: Option to limit range.
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
590
TODO: Perhaps show most-recent first with an option for last.
837
592
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
840
def run(self, filename=None, timezone='original',
845
from bzrlib.branch import find_branch
846
from bzrlib.log import log_formatter, show_log
849
direction = (forward and 'forward') or 'reverse'
593
takes_options = ['timezone', 'verbose', 'show-ids']
594
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
595
from branch import find_branch
596
b = find_branch((filename or '.'), lock_mode='r')
852
b = find_branch(filename)
853
fp = b.relpath(filename)
855
file_id = b.read_working_inventory().path2id(fp)
857
file_id = None # points to branch root
863
revision = [None, None]
864
elif isinstance(revision, int):
865
revision = [revision, revision]
870
assert len(revision) == 2
872
mutter('encoding log as %r' % bzrlib.user_encoding)
874
# use 'replace' so that we don't abort if trying to write out
875
# in e.g. the default C locale.
876
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
878
lf = log_formatter('short',
881
show_timezone=timezone)
888
start_revision=revision[0],
889
end_revision=revision[1])
598
filename = b.relpath(filename)
599
bzrlib.show_log(b, filename,
600
show_timezone=timezone,
893
606
class cmd_touching_revisions(Command):
894
"""Return revision-ids which affected a particular file.
896
A more user-friendly interface is "bzr log FILE"."""
607
"""Return revision-ids which affected a particular file."""
898
609
takes_args = ["filename"]
899
610
def run(self, filename):
900
b = find_branch(filename)
611
b = Branch(filename, lock_mode='r')
901
612
inv = b.read_working_inventory()
902
613
file_id = inv.path2id(b.relpath(filename))
903
614
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1028
735
except ValueError:
1029
736
raise BzrCommandError("not a valid revision-number: %r" % revno)
1031
print find_branch('.').lookup_revision(revno)
738
print Branch('.').lookup_revision(revno)
1034
741
class cmd_export(Command):
1035
742
"""Export past revision to destination directory.
1037
If no revision is specified this exports the last committed revision.
1039
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1040
given, exports to a directory (equivalent to --format=dir)."""
1041
# TODO: list known exporters
744
If no revision is specified this exports the last committed revision."""
1042
745
takes_args = ['dest']
1043
takes_options = ['revision', 'format']
1044
def run(self, dest, revision=None, format='dir'):
1045
b = find_branch('.')
746
takes_options = ['revision']
747
def run(self, dest, revision=None):
1046
749
if revision == None:
1047
750
rh = b.revision_history()[-1]
1049
752
rh = b.lookup_revision(int(revision))
1050
753
t = b.revision_tree(rh)
1051
t.export(dest, format)
1054
757
class cmd_cat(Command):
1094
797
def run(self, message=None, file=None, verbose=True, selected_list=None):
1095
798
from bzrlib.commit import commit
1096
from bzrlib.osutils import get_text_message
1098
800
## Warning: shadows builtin file()
1099
801
if not message and not file:
1102
catcher = cStringIO.StringIO()
1103
sys.stdout = catcher
1104
cmd_status({"file_list":selected_list}, {})
1105
info = catcher.getvalue()
1107
message = get_text_message(info)
1110
raise BzrCommandError("please specify a commit message",
1111
["use either --message or --file"])
802
raise BzrCommandError("please specify a commit message",
803
["use either --message or --file"])
1112
804
elif message and file:
1113
805
raise BzrCommandError("please specify either --message or --file")
1166
840
"""Run internal test suite"""
1169
from bzrlib.selftest import selftest
1170
return int(not selftest())
843
failures, tests = 0, 0
845
import doctest, bzrlib.store, bzrlib.tests
846
bzrlib.trace.verbose = False
848
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
849
bzrlib.tree, bzrlib.commands, bzrlib.add:
850
mf, mt = doctest.testmod(m)
853
print '%-40s %3d tests' % (m.__name__, mt),
855
print '%3d FAILED!' % mf
859
print '%-40s %3d tests' % ('total', tests),
861
print '%3d FAILED!' % failures
1173
869
class cmd_version(Command):
1174
"""Show version of bzr."""
870
"""Show version of bzr"""
1178
874
def show_version():
1179
875
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1180
# is bzrlib itself in a branch?
1181
bzrrev = bzrlib.get_bzr_revision()
1183
print " (bzr checkout, revision %d {%s})" % bzrrev
1184
876
print bzrlib.__copyright__
1185
877
print "http://bazaar-ng.org/"
1220
900
parsed = [spec, None]
1225
903
class cmd_merge(Command):
1226
"""Perform a three-way merge of trees.
1228
The SPEC parameters are working tree or revision specifiers. Working trees
1229
are specified using standard paths or urls. No component of a directory
1230
path may begin with '@'.
1232
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1234
Revisions are specified using a dirname/@revno pair, where dirname is the
1235
branch directory and revno is the revision within that branch. If no revno
1236
is specified, the latest revision is used.
1238
Revision examples: './@127', 'foo/@', '../@1'
1240
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1241
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1244
merge refuses to run if there are any uncommitted changes, unless
1247
takes_args = ['other_spec', 'base_spec?']
1248
takes_options = ['force']
1250
def run(self, other_spec, base_spec=None, force=False):
1251
from bzrlib.merge import merge
1252
merge(parse_spec(other_spec), parse_spec(base_spec),
1253
check_clean=(not force))
1257
class cmd_revert(Command):
1258
"""Restore selected files from a previous revision.
1260
takes_args = ['file+']
1261
def run(self, file_list):
1262
from bzrlib.branch import find_branch
1267
b = find_branch(file_list[0])
1269
b.revert([b.relpath(f) for f in file_list])
1272
class cmd_merge_revert(Command):
1273
"""Reverse all changes since the last commit.
1275
Only versioned files are affected.
1277
TODO: Store backups of any files that will be reverted, so
1278
that the revert can be undone.
1280
takes_options = ['revision']
1282
def run(self, revision=-1):
1283
from bzrlib.merge import merge
1284
merge(('.', revision), parse_spec('.'),
904
"""Perform a three-way merge of trees."""
905
takes_args = ['other_spec', 'base_spec']
907
def run(self, other_spec, base_spec):
908
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
1289
910
class cmd_assert_fail(Command):
1290
911
"""Test reporting of assertion failures"""
1375
982
(['status'], {'all': True})
1376
983
>>> parse_args('commit --message=biter'.split())
1377
984
(['commit'], {'message': u'biter'})
1378
>>> parse_args('log -r 500'.split())
1379
(['log'], {'revision': 500})
1380
>>> parse_args('log -r500:600'.split())
1381
(['log'], {'revision': [500, 600]})
1382
>>> parse_args('log -vr500:600'.split())
1383
(['log'], {'verbose': True, 'revision': [500, 600]})
1384
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1385
Traceback (most recent call last):
1387
ValueError: invalid literal for int(): v500
1405
1002
optname = a[2:]
1406
1003
if optname not in OPTIONS:
1407
raise BzrError('unknown long option %r' % a)
1004
bailout('unknown long option %r' % a)
1409
1006
shortopt = a[1:]
1410
if shortopt in SHORT_OPTIONS:
1411
# Multi-character options must have a space to delimit
1413
optname = SHORT_OPTIONS[shortopt]
1415
# Single character short options, can be chained,
1416
# and have their value appended to their name
1418
if shortopt not in SHORT_OPTIONS:
1419
# We didn't find the multi-character name, and we
1420
# didn't find the single char name
1421
raise BzrError('unknown short option %r' % a)
1422
optname = SHORT_OPTIONS[shortopt]
1425
# There are extra things on this option
1426
# see if it is the value, or if it is another
1428
optargfn = OPTIONS[optname]
1429
if optargfn is None:
1430
# This option does not take an argument, so the
1431
# next entry is another short option, pack it back
1433
argv.insert(0, '-' + a[2:])
1435
# This option takes an argument, so pack it
1007
if shortopt not in SHORT_OPTIONS:
1008
bailout('unknown short option %r' % a)
1009
optname = SHORT_OPTIONS[shortopt]
1439
1011
if optname in opts:
1440
1012
# XXX: Do we ever want to support this, e.g. for -r?
1441
raise BzrError('repeated option %r' % a)
1013
bailout('repeated option %r' % a)
1443
1015
optargfn = OPTIONS[optname]
1445
1017
if optarg == None:
1447
raise BzrError('option %r needs an argument' % a)
1019
bailout('option %r needs an argument' % a)
1449
1021
optarg = argv.pop(0)
1450
1022
opts[optname] = optargfn(optarg)
1452
1024
if optarg != None:
1453
raise BzrError('option %r takes no argument' % optname)
1025
bailout('option %r takes no argument' % optname)
1454
1026
opts[optname] = True
1507
def _parse_master_args(argv):
1508
"""Parse the arguments that always go with the original command.
1509
These are things like bzr --no-plugins, etc.
1511
There are now 2 types of option flags. Ones that come *before* the command,
1512
and ones that come *after* the command.
1513
Ones coming *before* the command are applied against all possible commands.
1514
And are generally applied before plugins are loaded.
1516
The current list are:
1517
--builtin Allow plugins to load, but don't let them override builtin commands,
1518
they will still be allowed if they do not override a builtin.
1519
--no-plugins Don't load any plugins. This lets you get back to official source
1521
--profile Enable the hotspot profile before running the command.
1522
For backwards compatibility, this is also a non-master option.
1523
--version Spit out the version of bzr that is running and exit.
1524
This is also a non-master option.
1525
--help Run help and exit, also a non-master option (I think that should stay, though)
1527
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1528
Traceback (most recent call last):
1530
BzrCommandError: Invalid master option: 'test'
1531
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1534
>>> print opts['version']
1536
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1538
['command', '--more-options']
1539
>>> print opts['profile']
1541
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1544
>>> print opts['no-plugins']
1546
>>> print opts['profile']
1548
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1550
['command', '--profile']
1551
>>> print opts['profile']
1554
master_opts = {'builtin':False,
1561
# This is the point where we could hook into argv[0] to determine
1562
# what front-end is supposed to be run
1563
# For now, we are just ignoring it.
1564
cmd_name = argv.pop(0)
1566
if arg[:2] != '--': # at the first non-option, we return the rest
1568
arg = arg[2:] # Remove '--'
1569
if arg not in master_opts:
1570
# We could say that this is not an error, that we should
1571
# just let it be handled by the main section instead
1572
raise BzrCommandError('Invalid master option: %r' % arg)
1573
argv.pop(0) # We are consuming this entry
1574
master_opts[arg] = True
1575
return argv, master_opts
1579
1080
def run_bzr(argv):
1580
1081
"""Execute a command.