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.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
32
def register_command(cmd):
33
"Utility function to help register a command"
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
32
47
def _squish_command_name(cmd):
33
48
return 'cmd_' + cmd.replace('-', '_')
37
52
assert cmd.startswith("cmd_")
38
53
return cmd[4:].replace('_','-')
41
"""Return canonical name and class for all registered commands."""
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
91
def _get_cmd_dict(plugins_override=True):
42
93
for k, v in globals().iteritems():
43
94
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
100
d2 = plugin_cmds.copy()
106
def get_all_cmds(plugins_override=True):
107
"""Return canonical name and class for all registered commands."""
108
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
112
def get_cmd_class(cmd, plugins_override=True):
47
113
"""Return the canonical name and command class for a command.
49
115
cmd = str(cmd) # not unicode
51
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
53
return cmd, globals()[_squish_command_name(cmd)]
120
return cmd, cmds[cmd]
57
124
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
125
for cmdname, cmdclass in cmds.iteritems():
59
126
if cmd in cmdclass.aliases:
60
127
return cmdname, cmdclass
145
213
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
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
153
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
156
230
pipe = os.popen('%s --bzr-help' % path, 'r')
157
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
160
235
def __call__(self, options, arguments):
161
236
Command.__init__(self, options, arguments)
229
305
def run(self, all=False, show_ids=False, file_list=None):
231
b = Branch(file_list[0], lock_mode='r')
307
b = Branch(file_list[0])
232
308
file_list = [b.relpath(x) for x in file_list]
233
309
# special case: only one path was given and it's the root
235
311
if file_list == ['']:
238
b = Branch('.', lock_mode='r')
240
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
244
320
class cmd_cat_revision(Command):
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
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
367
class cmd_mkdir(Command):
368
"""Create a new versioned directory.
370
This is equivalent to creating the directory and then adding it.
372
takes_args = ['dir+']
374
def run(self, dir_list):
383
b = bzrlib.branch.Branch(d)
384
b.add([d], verbose=True)
290
387
class cmd_relpath(Command):
291
388
"""Show path of a file relative to root"""
292
389
takes_args = ['filename']
294
392
def run(self, filename):
295
393
print Branch(filename).relpath(filename)
299
397
class cmd_inventory(Command):
300
398
"""Show inventory of the current working copy or a revision."""
301
takes_options = ['revision']
399
takes_options = ['revision', 'show-ids']
303
def run(self, revision=None):
401
def run(self, revision=None, show_ids=False):
305
403
if revision == None:
306
404
inv = b.read_working_inventory()
308
406
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)
408
for path, entry in inv.entries():
410
print '%-50s %s' % (path, entry.file_id)
314
415
class cmd_move(Command):
454
class cmd_pull(Command):
455
"""Pull any changes from another branch into the current one.
457
If the location is omitted, the last-used location will be used.
458
Both the revision history and the working directory will be
461
This command only works on branches that have not diverged. Branches are
462
considered diverged if both branches have had commits without first
463
pulling from the other.
465
If branches have diverged, you can use 'bzr merge' to pull the text changes
466
from one into the other.
468
takes_args = ['location?']
470
def run(self, location=None):
471
from bzrlib.merge import merge
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if 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
from branch import find_branch, DivergedBranches
488
br_from = find_branch(location)
489
location = pull_loc(br_from)
490
old_revno = br_to.revno()
492
br_to.update_revisions(br_from)
493
except DivergedBranches:
494
raise BzrCommandError("These branches have diverged. Try merge.")
496
merge(('.', -1), ('.', old_revno), check_clean=False)
497
if location != stored_loc:
498
br_to.controlfile("x-pull", "wb").write(location + "\n")
502
class cmd_branch(Command):
503
"""Create a new copy of a branch.
505
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
506
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
508
To retrieve the branch as of a particular revision, supply the --revision
509
parameter, as in "branch foo/bar -r 5".
511
takes_args = ['from_location', 'to_location?']
512
takes_options = ['revision']
514
def run(self, from_location, to_location=None, revision=None):
516
from bzrlib.merge import merge
517
from branch import find_branch, DivergedBranches, NoSuchRevision
518
from shutil import rmtree
520
br_from = find_branch(from_location)
522
if e.errno == errno.ENOENT:
523
raise BzrCommandError('Source location "%s" does not exist.' %
528
if to_location is None:
529
to_location = os.path.basename(from_location.rstrip("/\\"))
532
os.mkdir(to_location)
534
if e.errno == errno.EEXIST:
535
raise BzrCommandError('Target directory "%s" already exists.' %
537
if e.errno == errno.ENOENT:
538
raise BzrCommandError('Parent of "%s" does not exist.' %
542
br_to = Branch(to_location, init=True)
545
br_to.update_revisions(br_from, stop_revision=revision)
546
except NoSuchRevision:
548
msg = "The branch %s has no revision %d." % (from_location,
550
raise BzrCommandError(msg)
551
merge((to_location, -1), (to_location, 0), this_dir=to_location,
552
check_clean=False, ignore_zero=True)
553
from_location = pull_loc(br_from)
554
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
557
def pull_loc(branch):
558
# TODO: Should perhaps just make attribute be 'base' in
559
# RemoteBranch and Branch?
560
if hasattr(branch, "baseurl"):
561
return branch.baseurl
351
567
class cmd_renames(Command):
352
568
"""Show list of renamed files.
490
707
takes_args = ['file*']
491
takes_options = ['revision']
708
takes_options = ['revision', 'diff-options']
709
aliases = ['di', 'dif']
494
def run(self, revision=None, file_list=None):
711
def run(self, revision=None, file_list=None, diff_options=None):
495
712
from bzrlib.diff import show_diff
713
from bzrlib import find_branch
716
b = find_branch(file_list[0])
717
file_list = [b.relpath(f) for f in file_list]
718
if file_list == ['']:
719
# just pointing to top-of-tree
497
show_diff(Branch('.'), revision, file_list)
724
show_diff(b, revision, specific_files=file_list,
725
external_diff_options=diff_options)
584
812
class cmd_log(Command):
585
813
"""Show log of this branch.
587
TODO: Option to limit range.
815
To request a range of logs, you can use the command -r begin:end
816
-r revision requests a specific revision, -r :end or -r begin: are
589
TODO: Perhaps show most-recent first with an option for last.
819
TODO: Make --revision support uuid: and hash: [future tag:] notation.
591
823
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')
824
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
826
def run(self, filename=None, timezone='original',
831
from bzrlib import show_log, find_branch
834
direction = (forward and 'forward') or 'reverse'
597
filename = b.relpath(filename)
598
bzrlib.show_log(b, filename,
599
show_timezone=timezone,
837
b = find_branch(filename)
838
fp = b.relpath(filename)
840
file_id = b.read_working_inventory().path2id(fp)
842
file_id = None # points to branch root
848
revision = [None, None]
849
elif isinstance(revision, int):
850
revision = [revision, revision]
855
assert len(revision) == 2
857
mutter('encoding log as %r' % bzrlib.user_encoding)
859
# use 'replace' so that we don't abort if trying to write out
860
# in e.g. the default C locale.
861
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
864
show_timezone=timezone,
869
start_revision=revision[0],
870
end_revision=revision[1])
605
874
class cmd_touching_revisions(Command):
606
"""Return revision-ids which affected a particular file."""
875
"""Return revision-ids which affected a particular file.
877
A more user-friendly interface is "bzr log FILE"."""
608
879
takes_args = ["filename"]
609
880
def run(self, filename):
610
b = Branch(filename, lock_mode='r')
611
882
inv = b.read_working_inventory()
612
883
file_id = inv.path2id(b.relpath(filename))
613
884
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
672
943
def run(self, name_pattern):
673
944
from bzrlib.atomicfile import AtomicFile
677
948
ifn = b.abspath('.bzrignore')
679
# FIXME: probably doesn't handle non-ascii patterns
681
950
if os.path.exists(ifn):
682
f = b.controlfile(ifn, 'rt')
953
igns = f.read().decode('utf-8')
959
# TODO: If the file already uses crlf-style termination, maybe
960
# we should use that for the newly added lines?
688
962
if igns and igns[-1] != '\n':
690
964
igns += name_pattern + '\n'
692
f = AtomicFile(ifn, 'wt')
967
f = AtomicFile(ifn, 'wt')
968
f.write(igns.encode('utf-8'))
696
973
inv = b.working_tree().inventory
697
974
if inv.path2id('.bzrignore'):
737
1014
class cmd_export(Command):
738
1015
"""Export past revision to destination directory.
740
If no revision is specified this exports the last committed revision."""
1017
If no revision is specified this exports the last committed revision.
1019
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1020
given, exports to a directory (equivalent to --format=dir)."""
1021
# TODO: list known exporters
741
1022
takes_args = ['dest']
742
takes_options = ['revision']
743
def run(self, dest, revision=None):
1023
takes_options = ['revision', 'format']
1024
def run(self, dest, revision=None, format='dir'):
745
1026
if revision == None:
746
1027
rh = b.revision_history()[-1]
748
1029
rh = b.lookup_revision(int(revision))
749
1030
t = b.revision_tree(rh)
1031
t.export(dest, format)
753
1034
class cmd_cat(Command):
774
1055
class cmd_commit(Command):
775
1056
"""Commit changes into a new revision.
777
TODO: Commit only selected files.
1058
If selected files are specified, only changes to those files are
1059
committed. If a directory is specified then its contents are also
1062
A selected-file commit may fail in some cases where the committed
1063
tree would be invalid, such as trying to commit a file in a
1064
newly-added directory that is not itself committed.
779
1066
TODO: Run hooks on tree to-be-committed, and after commit.
781
1068
TODO: Strict commit that fails if there are unknown or deleted files.
1070
takes_args = ['selected*']
783
1071
takes_options = ['message', 'file', 'verbose']
784
1072
aliases = ['ci', 'checkin']
786
def run(self, message=None, file=None, verbose=False):
1074
def run(self, message=None, file=None, verbose=True, selected_list=None):
1075
from bzrlib.commit import commit
1076
from bzrlib.osutils import get_text_message
787
1078
## Warning: shadows builtin file()
788
1079
if not message and not file:
789
raise BzrCommandError("please specify a commit message",
790
["use either --message or --file"])
1082
catcher = cStringIO.StringIO()
1083
sys.stdout = catcher
1084
cmd_status({"file_list":selected_list}, {})
1085
info = catcher.getvalue()
1087
message = get_text_message(info)
1090
raise BzrCommandError("please specify a commit message",
1091
["use either --message or --file"])
791
1092
elif message and file:
792
1093
raise BzrCommandError("please specify either --message or --file")
804
1106
This command checks various invariants about the branch storage to
805
1107
detect data corruption or bzr bugs.
1109
If given the --update flag, it will update some optional fields
1110
to help ensure data consistency.
807
1112
takes_args = ['dir?']
808
1114
def run(self, dir='.'):
809
1115
import bzrlib.check
810
bzrlib.check.check(Branch(dir, find_root=False))
1116
bzrlib.check.check(Branch(dir))
1120
class cmd_upgrade(Command):
1121
"""Upgrade branch storage to current format.
1123
This should normally be used only after the check command tells
1126
takes_args = ['dir?']
1128
def run(self, dir='.'):
1129
from bzrlib.upgrade import upgrade
1130
upgrade(Branch(dir))
826
1146
"""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
1149
from bzrlib.selftest import selftest
1150
return int(not selftest())
853
1153
class cmd_version(Command):
854
"""Show version of bzr"""
1154
"""Show version of bzr."""
858
1158
def show_version():
859
1159
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1160
# is bzrlib itself in a branch?
1161
bzrrev = bzrlib.get_bzr_revision()
1163
print " (bzr checkout, revision %d {%s})" % bzrrev
860
1164
print bzrlib.__copyright__
861
1165
print "http://bazaar-ng.org/"
872
1176
print "it sure does!"
1178
def parse_spec(spec):
1180
>>> parse_spec(None)
1182
>>> parse_spec("./")
1184
>>> parse_spec("../@")
1186
>>> parse_spec("../f/@35")
1192
parsed = spec.split('/@')
1193
assert len(parsed) == 2
1197
parsed[1] = int(parsed[1])
1198
assert parsed[1] >=0
1200
parsed = [spec, None]
1205
class cmd_merge(Command):
1206
"""Perform a three-way merge of trees.
1208
The SPEC parameters are working tree or revision specifiers. Working trees
1209
are specified using standard paths or urls. No component of a directory
1210
path may begin with '@'.
1212
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1214
Revisions are specified using a dirname/@revno pair, where dirname is the
1215
branch directory and revno is the revision within that branch. If no revno
1216
is specified, the latest revision is used.
1218
Revision examples: './@127', 'foo/@', '../@1'
1220
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1221
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1224
merge refuses to run if there are any uncommitted changes, unless
1227
takes_args = ['other_spec', 'base_spec?']
1228
takes_options = ['force']
1230
def run(self, other_spec, base_spec=None, force=False):
1231
from bzrlib.merge import merge
1232
merge(parse_spec(other_spec), parse_spec(base_spec),
1233
check_clean=(not force))
1237
class cmd_revert(Command):
1238
"""Restore selected files from a previous revision.
1240
takes_args = ['file+']
1241
def run(self, file_list):
1242
from bzrlib.branch import find_branch
1247
b = find_branch(file_list[0])
1249
b.revert([b.relpath(f) for f in file_list])
1252
class cmd_merge_revert(Command):
1253
"""Reverse all changes since the last commit.
1255
Only versioned files are affected.
1257
TODO: Store backups of any files that will be reverted, so
1258
that the revert can be undone.
1260
takes_options = ['revision']
1262
def run(self, revision=-1):
1263
from bzrlib.merge import merge
1264
merge(('.', revision), parse_spec('.'),
875
1269
class cmd_assert_fail(Command):
876
1270
"""Test reporting of assertion failures"""
947
1355
(['status'], {'all': True})
948
1356
>>> parse_args('commit --message=biter'.split())
949
1357
(['commit'], {'message': u'biter'})
1358
>>> parse_args('log -r 500'.split())
1359
(['log'], {'revision': 500})
1360
>>> parse_args('log -r500:600'.split())
1361
(['log'], {'revision': [500, 600]})
1362
>>> parse_args('log -vr500:600'.split())
1363
(['log'], {'verbose': True, 'revision': [500, 600]})
1364
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1365
Traceback (most recent call last):
1367
ValueError: invalid literal for int(): v500
968
1386
if optname not in OPTIONS:
969
bailout('unknown long option %r' % a)
1387
raise BzrError('unknown long option %r' % a)
971
1389
shortopt = a[1:]
972
if shortopt not in SHORT_OPTIONS:
973
bailout('unknown short option %r' % a)
974
optname = SHORT_OPTIONS[shortopt]
1390
if shortopt in SHORT_OPTIONS:
1391
# Multi-character options must have a space to delimit
1393
optname = SHORT_OPTIONS[shortopt]
1395
# Single character short options, can be chained,
1396
# and have their value appended to their name
1398
if shortopt not in SHORT_OPTIONS:
1399
# We didn't find the multi-character name, and we
1400
# didn't find the single char name
1401
raise BzrError('unknown short option %r' % a)
1402
optname = SHORT_OPTIONS[shortopt]
1405
# There are extra things on this option
1406
# see if it is the value, or if it is another
1408
optargfn = OPTIONS[optname]
1409
if optargfn is None:
1410
# This option does not take an argument, so the
1411
# next entry is another short option, pack it back
1413
argv.insert(0, '-' + a[2:])
1415
# This option takes an argument, so pack it
976
1419
if optname in opts:
977
1420
# XXX: Do we ever want to support this, e.g. for -r?
978
bailout('repeated option %r' % a)
1421
raise BzrError('repeated option %r' % a)
980
1423
optargfn = OPTIONS[optname]
982
1425
if optarg == None:
984
bailout('option %r needs an argument' % a)
1427
raise BzrError('option %r needs an argument' % a)
986
1429
optarg = argv.pop(0)
987
1430
opts[optname] = optargfn(optarg)
989
1432
if optarg != None:
990
bailout('option %r takes no argument' % optname)
1433
raise BzrError('option %r takes no argument' % optname)
991
1434
opts[optname] = True
1487
def _parse_master_args(argv):
1488
"""Parse the arguments that always go with the original command.
1489
These are things like bzr --no-plugins, etc.
1491
There are now 2 types of option flags. Ones that come *before* the command,
1492
and ones that come *after* the command.
1493
Ones coming *before* the command are applied against all possible commands.
1494
And are generally applied before plugins are loaded.
1496
The current list are:
1497
--builtin Allow plugins to load, but don't let them override builtin commands,
1498
they will still be allowed if they do not override a builtin.
1499
--no-plugins Don't load any plugins. This lets you get back to official source
1501
--profile Enable the hotspot profile before running the command.
1502
For backwards compatibility, this is also a non-master option.
1503
--version Spit out the version of bzr that is running and exit.
1504
This is also a non-master option.
1505
--help Run help and exit, also a non-master option (I think that should stay, though)
1507
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1508
Traceback (most recent call last):
1510
BzrCommandError: Invalid master option: 'test'
1511
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1514
>>> print opts['version']
1516
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1518
['command', '--more-options']
1519
>>> print opts['profile']
1521
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1524
>>> print opts['no-plugins']
1526
>>> print opts['profile']
1528
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1530
['command', '--profile']
1531
>>> print opts['profile']
1534
master_opts = {'builtin':False,
1541
# This is the point where we could hook into argv[0] to determine
1542
# what front-end is supposed to be run
1543
# For now, we are just ignoring it.
1544
cmd_name = argv.pop(0)
1546
if arg[:2] != '--': # at the first non-option, we return the rest
1548
arg = arg[2:] # Remove '--'
1549
if arg not in master_opts:
1550
# We could say that this is not an error, that we should
1551
# just let it be handled by the main section instead
1552
raise BzrCommandError('Invalid master option: %r' % arg)
1553
argv.pop(0) # We are consuming this entry
1554
master_opts[arg] = True
1555
return argv, master_opts
1045
1559
def run_bzr(argv):
1046
1560
"""Execute a command.