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)
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
473
from shutil import rmtree
479
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
481
if e.errno != errno.ENOENT:
484
if stored_loc is None:
485
raise BzrCommandError("No pull location known or specified.")
487
print "Using last location: %s" % stored_loc
488
location = stored_loc
489
cache_root = tempfile.mkdtemp()
491
from branch import find_cached_branch, DivergedBranches
492
br_from = find_cached_branch(location, cache_root)
493
location = pull_loc(br_from)
494
old_revno = br_to.revno()
496
br_to.update_revisions(br_from)
497
except DivergedBranches:
498
raise BzrCommandError("These branches have diverged."
501
merge(('.', -1), ('.', old_revno), check_clean=False)
502
if location != stored_loc:
503
br_to.controlfile("x-pull", "wb").write(location + "\n")
509
class cmd_branch(Command):
510
"""Create a new copy of a branch.
512
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
513
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
515
To retrieve the branch as of a particular revision, supply the --revision
516
parameter, as in "branch foo/bar -r 5".
518
takes_args = ['from_location', 'to_location?']
519
takes_options = ['revision']
521
def run(self, from_location, to_location=None, revision=None):
523
from bzrlib.merge import merge
524
from branch import find_cached_branch, DivergedBranches, NoSuchRevision
525
from shutil import rmtree
526
from meta_store import CachedStore
528
cache_root = tempfile.mkdtemp()
531
br_from = find_cached_branch(from_location, cache_root)
533
if e.errno == errno.ENOENT:
534
raise BzrCommandError('Source location "%s" does not'
535
' exist.' % to_location)
539
if to_location is None:
540
to_location = os.path.basename(from_location.rstrip("/\\"))
543
os.mkdir(to_location)
545
if e.errno == errno.EEXIST:
546
raise BzrCommandError('Target directory "%s" already'
547
' exists.' % to_location)
548
if e.errno == errno.ENOENT:
549
raise BzrCommandError('Parent of "%s" does not exist.' %
553
br_to = Branch(to_location, init=True)
556
br_to.update_revisions(br_from, stop_revision=revision)
557
except NoSuchRevision:
559
msg = "The branch %s has no revision %d." % (from_location,
561
raise BzrCommandError(msg)
562
merge((to_location, -1), (to_location, 0), this_dir=to_location,
563
check_clean=False, ignore_zero=True)
564
from_location = pull_loc(br_from)
565
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
570
def pull_loc(branch):
571
# TODO: Should perhaps just make attribute be 'base' in
572
# RemoteBranch and Branch?
573
if hasattr(branch, "baseurl"):
574
return branch.baseurl
351
580
class cmd_renames(Command):
352
581
"""Show list of renamed files.
490
720
takes_args = ['file*']
491
takes_options = ['revision']
721
takes_options = ['revision', 'diff-options']
722
aliases = ['di', 'dif']
494
def run(self, revision=None, file_list=None):
724
def run(self, revision=None, file_list=None, diff_options=None):
495
725
from bzrlib.diff import show_diff
726
from bzrlib import find_branch
729
b = find_branch(file_list[0])
730
file_list = [b.relpath(f) for f in file_list]
731
if file_list == ['']:
732
# just pointing to top-of-tree
497
show_diff(Branch('.'), revision, file_list)
737
show_diff(b, revision, specific_files=file_list,
738
external_diff_options=diff_options)
584
825
class cmd_log(Command):
585
826
"""Show log of this branch.
587
TODO: Option to limit range.
828
To request a range of logs, you can use the command -r begin:end
829
-r revision requests a specific revision, -r :end or -r begin: are
589
TODO: Perhaps show most-recent first with an option for last.
832
TODO: Make --revision support uuid: and hash: [future tag:] notation.
591
836
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')
837
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
839
def run(self, filename=None, timezone='original',
844
from bzrlib import show_log, find_branch
845
from bzrlib.log import log_formatter
848
direction = (forward and 'forward') or 'reverse'
597
filename = b.relpath(filename)
598
bzrlib.show_log(b, filename,
599
show_timezone=timezone,
851
b = find_branch(filename)
852
fp = b.relpath(filename)
854
file_id = b.read_working_inventory().path2id(fp)
856
file_id = None # points to branch root
862
revision = [None, None]
863
elif isinstance(revision, int):
864
revision = [revision, revision]
869
assert len(revision) == 2
871
mutter('encoding log as %r' % bzrlib.user_encoding)
873
# use 'replace' so that we don't abort if trying to write out
874
# in e.g. the default C locale.
875
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
877
lf = log_formatter('short',
880
show_timezone=timezone)
887
start_revision=revision[0],
888
end_revision=revision[1])
605
892
class cmd_touching_revisions(Command):
606
"""Return revision-ids which affected a particular file."""
893
"""Return revision-ids which affected a particular file.
895
A more user-friendly interface is "bzr log FILE"."""
608
897
takes_args = ["filename"]
609
898
def run(self, filename):
610
b = Branch(filename, lock_mode='r')
611
900
inv = b.read_working_inventory()
612
901
file_id = inv.path2id(b.relpath(filename))
613
902
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
672
961
def run(self, name_pattern):
673
962
from bzrlib.atomicfile import AtomicFile
677
966
ifn = b.abspath('.bzrignore')
679
# FIXME: probably doesn't handle non-ascii patterns
681
968
if os.path.exists(ifn):
682
f = b.controlfile(ifn, 'rt')
971
igns = f.read().decode('utf-8')
977
# TODO: If the file already uses crlf-style termination, maybe
978
# we should use that for the newly added lines?
688
980
if igns and igns[-1] != '\n':
690
982
igns += name_pattern + '\n'
692
f = AtomicFile(ifn, 'wt')
985
f = AtomicFile(ifn, 'wt')
986
f.write(igns.encode('utf-8'))
696
991
inv = b.working_tree().inventory
697
992
if inv.path2id('.bzrignore'):
737
1032
class cmd_export(Command):
738
1033
"""Export past revision to destination directory.
740
If no revision is specified this exports the last committed revision."""
1035
If no revision is specified this exports the last committed revision.
1037
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1038
given, exports to a directory (equivalent to --format=dir)."""
1039
# TODO: list known exporters
741
1040
takes_args = ['dest']
742
takes_options = ['revision']
743
def run(self, dest, revision=None):
1041
takes_options = ['revision', 'format']
1042
def run(self, dest, revision=None, format='dir'):
745
1044
if revision == None:
746
1045
rh = b.revision_history()[-1]
748
1047
rh = b.lookup_revision(int(revision))
749
1048
t = b.revision_tree(rh)
1049
t.export(dest, format)
753
1052
class cmd_cat(Command):
774
1073
class cmd_commit(Command):
775
1074
"""Commit changes into a new revision.
777
TODO: Commit only selected files.
1076
If selected files are specified, only changes to those files are
1077
committed. If a directory is specified then its contents are also
1080
A selected-file commit may fail in some cases where the committed
1081
tree would be invalid, such as trying to commit a file in a
1082
newly-added directory that is not itself committed.
779
1084
TODO: Run hooks on tree to-be-committed, and after commit.
781
1086
TODO: Strict commit that fails if there are unknown or deleted files.
1088
takes_args = ['selected*']
783
1089
takes_options = ['message', 'file', 'verbose']
784
1090
aliases = ['ci', 'checkin']
786
def run(self, message=None, file=None, verbose=False):
1092
def run(self, message=None, file=None, verbose=True, selected_list=None):
1093
from bzrlib.commit import commit
1094
from bzrlib.osutils import get_text_message
787
1096
## Warning: shadows builtin file()
788
1097
if not message and not file:
789
raise BzrCommandError("please specify a commit message",
790
["use either --message or --file"])
1100
catcher = cStringIO.StringIO()
1101
sys.stdout = catcher
1102
cmd_status({"file_list":selected_list}, {})
1103
info = catcher.getvalue()
1105
message = get_text_message(info)
1108
raise BzrCommandError("please specify a commit message",
1109
["use either --message or --file"])
791
1110
elif message and file:
792
1111
raise BzrCommandError("please specify either --message or --file")
826
1164
"""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
1167
from bzrlib.selftest import selftest
1168
return int(not selftest())
853
1171
class cmd_version(Command):
854
"""Show version of bzr"""
1172
"""Show version of bzr."""
858
1176
def show_version():
859
1177
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1178
# is bzrlib itself in a branch?
1179
bzrrev = bzrlib.get_bzr_revision()
1181
print " (bzr checkout, revision %d {%s})" % bzrrev
860
1182
print bzrlib.__copyright__
861
1183
print "http://bazaar-ng.org/"
872
1194
print "it sure does!"
1196
def parse_spec(spec):
1198
>>> parse_spec(None)
1200
>>> parse_spec("./")
1202
>>> parse_spec("../@")
1204
>>> parse_spec("../f/@35")
1210
parsed = spec.split('/@')
1211
assert len(parsed) == 2
1215
parsed[1] = int(parsed[1])
1216
assert parsed[1] >=0
1218
parsed = [spec, None]
1223
class cmd_merge(Command):
1224
"""Perform a three-way merge of trees.
1226
The SPEC parameters are working tree or revision specifiers. Working trees
1227
are specified using standard paths or urls. No component of a directory
1228
path may begin with '@'.
1230
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1232
Revisions are specified using a dirname/@revno pair, where dirname is the
1233
branch directory and revno is the revision within that branch. If no revno
1234
is specified, the latest revision is used.
1236
Revision examples: './@127', 'foo/@', '../@1'
1238
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1239
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1242
merge refuses to run if there are any uncommitted changes, unless
1245
takes_args = ['other_spec', 'base_spec?']
1246
takes_options = ['force']
1248
def run(self, other_spec, base_spec=None, force=False):
1249
from bzrlib.merge import merge
1250
merge(parse_spec(other_spec), parse_spec(base_spec),
1251
check_clean=(not force))
1255
class cmd_revert(Command):
1256
"""Restore selected files from a previous revision.
1258
takes_args = ['file+']
1259
def run(self, file_list):
1260
from bzrlib.branch import find_branch
1265
b = find_branch(file_list[0])
1267
b.revert([b.relpath(f) for f in file_list])
1270
class cmd_merge_revert(Command):
1271
"""Reverse all changes since the last commit.
1273
Only versioned files are affected.
1275
TODO: Store backups of any files that will be reverted, so
1276
that the revert can be undone.
1278
takes_options = ['revision']
1280
def run(self, revision=-1):
1281
from bzrlib.merge import merge
1282
merge(('.', revision), parse_spec('.'),
875
1287
class cmd_assert_fail(Command):
876
1288
"""Test reporting of assertion failures"""
947
1373
(['status'], {'all': True})
948
1374
>>> parse_args('commit --message=biter'.split())
949
1375
(['commit'], {'message': u'biter'})
1376
>>> parse_args('log -r 500'.split())
1377
(['log'], {'revision': 500})
1378
>>> parse_args('log -r500:600'.split())
1379
(['log'], {'revision': [500, 600]})
1380
>>> parse_args('log -vr500:600'.split())
1381
(['log'], {'verbose': True, 'revision': [500, 600]})
1382
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1383
Traceback (most recent call last):
1385
ValueError: invalid literal for int(): v500
968
1404
if optname not in OPTIONS:
969
bailout('unknown long option %r' % a)
1405
raise BzrError('unknown long option %r' % a)
971
1407
shortopt = a[1:]
972
if shortopt not in SHORT_OPTIONS:
973
bailout('unknown short option %r' % a)
974
optname = SHORT_OPTIONS[shortopt]
1408
if shortopt in SHORT_OPTIONS:
1409
# Multi-character options must have a space to delimit
1411
optname = SHORT_OPTIONS[shortopt]
1413
# Single character short options, can be chained,
1414
# and have their value appended to their name
1416
if shortopt not in SHORT_OPTIONS:
1417
# We didn't find the multi-character name, and we
1418
# didn't find the single char name
1419
raise BzrError('unknown short option %r' % a)
1420
optname = SHORT_OPTIONS[shortopt]
1423
# There are extra things on this option
1424
# see if it is the value, or if it is another
1426
optargfn = OPTIONS[optname]
1427
if optargfn is None:
1428
# This option does not take an argument, so the
1429
# next entry is another short option, pack it back
1431
argv.insert(0, '-' + a[2:])
1433
# This option takes an argument, so pack it
976
1437
if optname in opts:
977
1438
# XXX: Do we ever want to support this, e.g. for -r?
978
bailout('repeated option %r' % a)
1439
raise BzrError('repeated option %r' % a)
980
1441
optargfn = OPTIONS[optname]
982
1443
if optarg == None:
984
bailout('option %r needs an argument' % a)
1445
raise BzrError('option %r needs an argument' % a)
986
1447
optarg = argv.pop(0)
987
1448
opts[optname] = optargfn(optarg)
989
1450
if optarg != None:
990
bailout('option %r takes no argument' % optname)
1451
raise BzrError('option %r takes no argument' % optname)
991
1452
opts[optname] = True
1505
def _parse_master_args(argv):
1506
"""Parse the arguments that always go with the original command.
1507
These are things like bzr --no-plugins, etc.
1509
There are now 2 types of option flags. Ones that come *before* the command,
1510
and ones that come *after* the command.
1511
Ones coming *before* the command are applied against all possible commands.
1512
And are generally applied before plugins are loaded.
1514
The current list are:
1515
--builtin Allow plugins to load, but don't let them override builtin commands,
1516
they will still be allowed if they do not override a builtin.
1517
--no-plugins Don't load any plugins. This lets you get back to official source
1519
--profile Enable the hotspot profile before running the command.
1520
For backwards compatibility, this is also a non-master option.
1521
--version Spit out the version of bzr that is running and exit.
1522
This is also a non-master option.
1523
--help Run help and exit, also a non-master option (I think that should stay, though)
1525
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1526
Traceback (most recent call last):
1528
BzrCommandError: Invalid master option: 'test'
1529
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1532
>>> print opts['version']
1534
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1536
['command', '--more-options']
1537
>>> print opts['profile']
1539
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1542
>>> print opts['no-plugins']
1544
>>> print opts['profile']
1546
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1548
['command', '--profile']
1549
>>> print opts['profile']
1552
master_opts = {'builtin':False,
1559
# This is the point where we could hook into argv[0] to determine
1560
# what front-end is supposed to be run
1561
# For now, we are just ignoring it.
1562
cmd_name = argv.pop(0)
1564
if arg[:2] != '--': # at the first non-option, we return the rest
1566
arg = arg[2:] # Remove '--'
1567
if arg not in master_opts:
1568
# We could say that this is not an error, that we should
1569
# just let it be handled by the main section instead
1570
raise BzrCommandError('Invalid master option: %r' % arg)
1571
argv.pop(0) # We are consuming this entry
1572
master_opts[arg] = True
1573
return argv, master_opts
1045
1577
def run_bzr(argv):
1046
1578
"""Execute a command.