19
import sys, os, time, os.path
23
22
from bzrlib.trace import mutter, note, log_error
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, \
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__])
32
46
def _squish_command_name(cmd):
37
51
assert cmd.startswith("cmd_")
38
52
return cmd[4:].replace('_','-')
41
"""Return canonical name and class for all registered commands."""
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
92
for k, v in globals().iteritems():
43
93
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(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):
47
112
"""Return the canonical name and command class for a command.
49
114
cmd = str(cmd) # not unicode
51
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
53
return cmd, globals()[_squish_command_name(cmd)]
119
return cmd, cmds[cmd]
57
123
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
124
for cmdname, cmdclass in cmds.iteritems():
59
125
if cmd in cmdclass.aliases:
60
126
return cmdname, cmdclass
145
212
def __init__(self, path):
148
# TODO: If either of these fail, we should detect that and
149
# assume that path is not really a bzr plugin after all.
151
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
216
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?
153
224
self.takes_args = pipe.readline().split()
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
156
229
pipe = os.popen('%s --bzr-help' % path, 'r')
157
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
160
234
def __call__(self, options, arguments):
161
235
Command.__init__(self, options, arguments)
281
357
recursively add that parent, rather than giving an error?
283
359
takes_args = ['file+']
284
takes_options = ['verbose']
360
takes_options = ['verbose', 'no-recurse']
286
def run(self, file_list, verbose=False):
287
bzrlib.add.smart_add(file_list, 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)
290
385
class cmd_relpath(Command):
291
386
"""Show path of a file relative to root"""
292
387
takes_args = ['filename']
294
390
def run(self, filename):
295
print Branch(filename).relpath(filename)
391
print find_branch(filename).relpath(filename)
299
395
class cmd_inventory(Command):
300
396
"""Show inventory of the current working copy or a revision."""
301
takes_options = ['revision']
397
takes_options = ['revision', 'show-ids']
303
def run(self, revision=None):
399
def run(self, revision=None, show_ids=False):
305
401
if revision == None:
306
402
inv = b.read_working_inventory()
308
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
310
for path, entry in inv.iter_entries():
311
print '%-50s %s' % (entry.file_id, path)
406
for path, entry in inv.entries():
408
print '%-50s %s' % (path, entry.file_id)
314
413
class cmd_move(Command):
343
442
takes_args = ['from_name', 'to_name']
345
444
def run(self, from_name, to_name):
347
446
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
351
583
class cmd_renames(Command):
352
584
"""Show list of renamed files.
421
652
takes_args = ['filename']
422
653
def run(self, filename):
654
b = find_branch(filename)
424
655
inv = b.inventory
425
656
fid = inv.path2id(b.relpath(filename))
427
bailout("%r is not a versioned file" % filename)
658
raise BzrError("%r is not a versioned file" % filename)
428
659
for fip in inv.get_idpath(fid):
432
663
class cmd_revision_history(Command):
433
664
"""Display list of revision ids on this branch."""
435
for patchid in Branch('.').revision_history():
667
for patchid in find_branch('.').revision_history():
439
671
class cmd_directories(Command):
440
672
"""Display list of versioned directories in this branch."""
442
for name, ie in Branch('.').read_working_inventory().directories():
674
for name, ie in find_branch('.').read_working_inventory().directories():
490
723
takes_args = ['file*']
491
takes_options = ['revision']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
494
def run(self, revision=None, file_list=None):
727
def run(self, revision=None, file_list=None, diff_options=None):
495
728
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
497
show_diff(Branch('.'), revision, specific_files=file_list)
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
584
826
class cmd_log(Command):
585
827
"""Show log of this branch.
587
TODO: Option to limit range.
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
589
TODO: Perhaps show most-recent first with an option for last.
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
591
837
takes_args = ['filename?']
592
takes_options = ['timezone', 'verbose', 'show-ids']
593
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
594
from branch import find_branch
595
b = find_branch((filename or '.'), lock_mode='r')
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
840
def run(self, filename=None, timezone='original',
846
from bzrlib.branch import find_branch
847
from bzrlib.log import log_formatter, show_log
850
direction = (forward and 'forward') or 'reverse'
597
filename = b.relpath(filename)
598
bzrlib.show_log(b, filename,
599
show_timezone=timezone,
853
b = find_branch(filename)
854
fp = b.relpath(filename)
856
file_id = b.read_working_inventory().path2id(fp)
858
file_id = None # points to branch root
864
revision = [None, None]
865
elif isinstance(revision, int):
866
revision = [revision, revision]
871
assert len(revision) == 2
873
mutter('encoding log as %r' % bzrlib.user_encoding)
875
# use 'replace' so that we don't abort if trying to write out
876
# in e.g. the default C locale.
877
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
883
lf = log_formatter(log_format,
886
show_timezone=timezone)
893
start_revision=revision[0],
894
end_revision=revision[1])
605
898
class cmd_touching_revisions(Command):
606
"""Return revision-ids which affected a particular file."""
899
"""Return revision-ids which affected a particular file.
901
A more user-friendly interface is "bzr log FILE"."""
608
903
takes_args = ["filename"]
609
904
def run(self, filename):
610
b = Branch(filename, lock_mode='r')
905
b = find_branch(filename)
611
906
inv = b.read_working_inventory()
612
907
file_id = inv.path2id(b.relpath(filename))
613
908
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
672
968
def run(self, name_pattern):
673
969
from bzrlib.atomicfile import AtomicFile
677
973
ifn = b.abspath('.bzrignore')
679
# FIXME: probably doesn't handle non-ascii patterns
681
975
if os.path.exists(ifn):
682
f = b.controlfile(ifn, 'rt')
978
igns = f.read().decode('utf-8')
984
# TODO: If the file already uses crlf-style termination, maybe
985
# we should use that for the newly added lines?
688
987
if igns and igns[-1] != '\n':
690
989
igns += name_pattern + '\n'
692
f = AtomicFile(ifn, 'wt')
992
f = AtomicFile(ifn, 'wt')
993
f.write(igns.encode('utf-8'))
696
998
inv = b.working_tree().inventory
697
999
if inv.path2id('.bzrignore'):
731
1033
except ValueError:
732
1034
raise BzrCommandError("not a valid revision-number: %r" % revno)
734
print Branch('.').lookup_revision(revno)
1036
print find_branch('.').lookup_revision(revno)
737
1039
class cmd_export(Command):
738
1040
"""Export past revision to destination directory.
740
If no revision is specified this exports the last committed revision."""
1042
If no revision is specified this exports the last committed revision.
1044
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, exports to a directory (equivalent to --format=dir).
1047
Root may be the top directory for tar, tgz and tbz2 formats."""
1048
# TODO: list known exporters
741
1049
takes_args = ['dest']
742
takes_options = ['revision']
743
def run(self, dest, revision=None):
1050
takes_options = ['revision', 'format', 'root']
1051
def run(self, dest, revision=None, format='dir', root=None):
1052
b = find_branch('.')
745
1053
if revision == None:
746
1054
rh = b.revision_history()[-1]
748
1056
rh = b.lookup_revision(int(revision))
749
1057
t = b.revision_tree(rh)
1058
t.export(dest, format, root)
753
1061
class cmd_cat(Command):
774
1082
class cmd_commit(Command):
775
1083
"""Commit changes into a new revision.
777
TODO: Commit only selected files.
1085
If selected files are specified, only changes to those files are
1086
committed. If a directory is specified then its contents are also
1089
A selected-file commit may fail in some cases where the committed
1090
tree would be invalid, such as trying to commit a file in a
1091
newly-added directory that is not itself committed.
779
1093
TODO: Run hooks on tree to-be-committed, and after commit.
781
1095
TODO: Strict commit that fails if there are unknown or deleted files.
1097
takes_args = ['selected*']
783
1098
takes_options = ['message', 'file', 'verbose']
784
1099
aliases = ['ci', 'checkin']
786
def run(self, message=None, file=None, verbose=False):
1101
def run(self, message=None, file=None, verbose=True, selected_list=None):
1102
from bzrlib.commit import commit
1103
from bzrlib.osutils import get_text_message
787
1105
## Warning: shadows builtin file()
788
1106
if not message and not file:
789
raise BzrCommandError("please specify a commit message",
790
["use either --message or --file"])
1109
catcher = cStringIO.StringIO()
1110
sys.stdout = catcher
1111
cmd_status({"file_list":selected_list}, {})
1112
info = catcher.getvalue()
1114
message = get_text_message(info)
1117
raise BzrCommandError("please specify a commit message",
1118
["use either --message or --file"])
791
1119
elif message and file:
792
1120
raise BzrCommandError("please specify either --message or --file")
826
1173
"""Run internal test suite"""
829
failures, tests = 0, 0
831
import doctest, bzrlib.store, bzrlib.tests
832
bzrlib.trace.verbose = False
834
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
835
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
836
mf, mt = doctest.testmod(m)
839
print '%-40s %3d tests' % (m.__name__, mt),
841
print '%3d FAILED!' % mf
845
print '%-40s %3d tests' % ('total', tests),
847
print '%3d FAILED!' % failures
1176
from bzrlib.selftest import selftest
1177
return int(not selftest())
853
1180
class cmd_version(Command):
854
"""Show version of bzr"""
1181
"""Show version of bzr."""
858
1185
def show_version():
859
1186
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1187
# is bzrlib itself in a branch?
1188
bzrrev = bzrlib.get_bzr_revision()
1190
print " (bzr checkout, revision %d {%s})" % bzrrev
860
1191
print bzrlib.__copyright__
861
1192
print "http://bazaar-ng.org/"
872
1203
print "it sure does!"
1205
def parse_spec(spec):
1207
>>> parse_spec(None)
1209
>>> parse_spec("./")
1211
>>> parse_spec("../@")
1213
>>> parse_spec("../f/@35")
1219
parsed = spec.split('/@')
1220
assert len(parsed) == 2
1224
parsed[1] = int(parsed[1])
1225
assert parsed[1] >=0
1227
parsed = [spec, None]
1232
class cmd_merge(Command):
1233
"""Perform a three-way merge of trees.
1235
The SPEC parameters are working tree or revision specifiers. Working trees
1236
are specified using standard paths or urls. No component of a directory
1237
path may begin with '@'.
1239
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1241
Revisions are specified using a dirname/@revno pair, where dirname is the
1242
branch directory and revno is the revision within that branch. If no revno
1243
is specified, the latest revision is used.
1245
Revision examples: './@127', 'foo/@', '../@1'
1247
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1248
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1251
merge refuses to run if there are any uncommitted changes, unless
1254
takes_args = ['other_spec', 'base_spec?']
1255
takes_options = ['force']
1257
def run(self, other_spec, base_spec=None, force=False):
1258
from bzrlib.merge import merge
1259
merge(parse_spec(other_spec), parse_spec(base_spec),
1260
check_clean=(not force))
1264
class cmd_revert(Command):
1265
"""Restore selected files from a previous revision.
1267
takes_args = ['file+']
1268
def run(self, file_list):
1269
from bzrlib.branch import find_branch
1274
b = find_branch(file_list[0])
1276
b.revert([b.relpath(f) for f in file_list])
1279
class cmd_merge_revert(Command):
1280
"""Reverse all changes since the last commit.
1282
Only versioned files are affected.
1284
TODO: Store backups of any files that will be reverted, so
1285
that the revert can be undone.
1287
takes_options = ['revision']
1289
def run(self, revision=-1):
1290
from bzrlib.merge import merge
1291
merge(('.', revision), parse_spec('.'),
875
1296
class cmd_assert_fail(Command):
876
1297
"""Test reporting of assertion failures"""
947
1385
(['status'], {'all': True})
948
1386
>>> parse_args('commit --message=biter'.split())
949
1387
(['commit'], {'message': u'biter'})
1388
>>> parse_args('log -r 500'.split())
1389
(['log'], {'revision': 500})
1390
>>> parse_args('log -r500:600'.split())
1391
(['log'], {'revision': [500, 600]})
1392
>>> parse_args('log -vr500:600'.split())
1393
(['log'], {'verbose': True, 'revision': [500, 600]})
1394
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1395
Traceback (most recent call last):
1397
ValueError: invalid literal for int(): v500
968
1416
if optname not in OPTIONS:
969
bailout('unknown long option %r' % a)
1417
raise BzrError('unknown long option %r' % a)
971
1419
shortopt = a[1:]
972
if shortopt not in SHORT_OPTIONS:
973
bailout('unknown short option %r' % a)
974
optname = SHORT_OPTIONS[shortopt]
1420
if shortopt in SHORT_OPTIONS:
1421
# Multi-character options must have a space to delimit
1423
optname = SHORT_OPTIONS[shortopt]
1425
# Single character short options, can be chained,
1426
# and have their value appended to their name
1428
if shortopt not in SHORT_OPTIONS:
1429
# We didn't find the multi-character name, and we
1430
# didn't find the single char name
1431
raise BzrError('unknown short option %r' % a)
1432
optname = SHORT_OPTIONS[shortopt]
1435
# There are extra things on this option
1436
# see if it is the value, or if it is another
1438
optargfn = OPTIONS[optname]
1439
if optargfn is None:
1440
# This option does not take an argument, so the
1441
# next entry is another short option, pack it back
1443
argv.insert(0, '-' + a[2:])
1445
# This option takes an argument, so pack it
976
1449
if optname in opts:
977
1450
# XXX: Do we ever want to support this, e.g. for -r?
978
bailout('repeated option %r' % a)
1451
raise BzrError('repeated option %r' % a)
980
1453
optargfn = OPTIONS[optname]
982
1455
if optarg == None:
984
bailout('option %r needs an argument' % a)
1457
raise BzrError('option %r needs an argument' % a)
986
1459
optarg = argv.pop(0)
987
1460
opts[optname] = optargfn(optarg)
989
1462
if optarg != None:
990
bailout('option %r takes no argument' % optname)
1463
raise BzrError('option %r takes no argument' % optname)
991
1464
opts[optname] = True
1517
def _parse_master_args(argv):
1518
"""Parse the arguments that always go with the original command.
1519
These are things like bzr --no-plugins, etc.
1521
There are now 2 types of option flags. Ones that come *before* the command,
1522
and ones that come *after* the command.
1523
Ones coming *before* the command are applied against all possible commands.
1524
And are generally applied before plugins are loaded.
1526
The current list are:
1527
--builtin Allow plugins to load, but don't let them override builtin commands,
1528
they will still be allowed if they do not override a builtin.
1529
--no-plugins Don't load any plugins. This lets you get back to official source
1531
--profile Enable the hotspot profile before running the command.
1532
For backwards compatibility, this is also a non-master option.
1533
--version Spit out the version of bzr that is running and exit.
1534
This is also a non-master option.
1535
--help Run help and exit, also a non-master option (I think that should stay, though)
1537
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1538
Traceback (most recent call last):
1540
BzrCommandError: Invalid master option: 'test'
1541
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1544
>>> print opts['version']
1546
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1548
['command', '--more-options']
1549
>>> print opts['profile']
1551
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1554
>>> print opts['no-plugins']
1556
>>> print opts['profile']
1558
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1560
['command', '--profile']
1561
>>> print opts['profile']
1564
master_opts = {'builtin':False,
1571
# This is the point where we could hook into argv[0] to determine
1572
# what front-end is supposed to be run
1573
# For now, we are just ignoring it.
1574
cmd_name = argv.pop(0)
1576
if arg[:2] != '--': # at the first non-option, we return the rest
1578
arg = arg[2:] # Remove '--'
1579
if arg not in master_opts:
1580
# We could say that this is not an error, that we should
1581
# just let it be handled by the main section instead
1582
raise BzrCommandError('Invalid master option: %r' % arg)
1583
argv.pop(0) # We are consuming this entry
1584
master_opts[arg] = True
1585
return argv, master_opts
1045
1589
def run_bzr(argv):
1046
1590
"""Execute a command.