51
56
assert cmd.startswith("cmd_")
52
57
return cmd[4:].replace('_','-')
54
60
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' -> ?
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
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])
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
148
return merge_types[typestring][0]
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
90
159
def _get_cmd_dict(plugins_override=True):
184
256
class ExternalCommand(Command):
185
257
"""Class to wrap external commands.
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
259
We cheat a little here, when get_cmd_class() calls us we actually
260
give it back an object we construct that has the appropriate path,
261
help, options etc for the specified command.
263
When run_bzr() tries to instantiate that 'class' it gets caught by
264
the __call__ method, which we override to call the Command.__init__
265
method. That then calls our run method which is pretty straight
268
The only wrinkle is that we have to map bzr's dictionary of options
269
and arguments back into command line options and arguments for the
199
273
def find_command(cls, cmd):
553
class cmd_mv(Command):
554
"""Move or rename a file.
557
bzr mv OLDNAME NEWNAME
558
bzr mv SOURCE... DESTINATION
560
If the last argument is a versioned directory, all the other names
561
are moved into it. Otherwise, there must be exactly two arguments
562
and the file is changed to a new name, which must not already exist.
564
Files cannot be moved between branches.
566
takes_args = ['names*']
567
def run(self, names_list):
568
if len(names_list) < 2:
569
raise BzrCommandError("missing file argument")
570
b = find_branch(names_list[0])
572
rel_names = [b.relpath(x) for x in names_list]
574
if os.path.isdir(names_list[-1]):
575
# move into existing directory
576
b.move(rel_names[:-1], rel_names[-1])
578
if len(names_list) != 2:
579
raise BzrCommandError('to mv multiple files the destination '
580
'must be a versioned directory')
581
b.move(rel_names[0], rel_names[1])
452
586
class cmd_pull(Command):
520
654
takes_args = ['from_location', 'to_location?']
521
655
takes_options = ['revision']
656
aliases = ['get', 'clone']
523
658
def run(self, from_location, to_location=None, revision=None):
525
660
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
661
from bzrlib.branch import DivergedBranches, \
527
662
find_cached_branch, Branch
528
663
from shutil import rmtree
529
664
from meta_store import CachedStore
531
666
cache_root = tempfile.mkdtemp()
670
elif len(revision) > 1:
671
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
534
675
br_from = find_cached_branch(from_location, cache_root)
556
697
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)
699
br_to.set_root_id(br_from.get_root_id())
702
if revision[0] is None:
703
revno = br_from.revno()
705
revno, rev_id = br_from.get_revision_info(revision[0])
707
br_to.update_revisions(br_from, stop_revision=revno)
708
except bzrlib.errors.NoSuchRevision:
710
msg = "The branch %s has no revision %d." % (from_location,
712
raise BzrCommandError(msg)
565
714
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
715
check_clean=False, ignore_zero=True)
567
716
from_location = pull_loc(br_from)
770
932
"""List files modified in working tree."""
935
from bzrlib.delta import compare_trees
774
937
b = find_branch('.')
775
inv = b.read_working_inventory()
776
sc = statcache.update_cache(b, inv)
777
basis = b.basis_tree()
778
basis_inv = basis.inventory
780
# We used to do this through iter_entries(), but that's slow
781
# when most of the files are unmodified, as is usually the
782
# case. So instead we iterate by inventory entry, and only
783
# calculate paths as necessary.
938
td = compare_trees(b.basis_tree(), b.working_tree())
785
for file_id in basis_inv:
786
cacheentry = sc.get(file_id)
787
if not cacheentry: # deleted
789
ie = basis_inv[file_id]
790
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
791
path = inv.id2path(file_id)
940
for path, id, kind in td.modified:
830
979
-r revision requests a specific revision, -r :end or -r begin: are
982
--message allows you to give a regular expression, which will be evaluated
983
so that only matching entries will be displayed.
833
985
TODO: Make --revision support uuid: and hash: [future tag:] notation.
837
989
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
'long', 'message', 'short',]
840
993
def run(self, filename=None, timezone='original',
846
1001
from bzrlib.branch import find_branch
847
1002
from bzrlib.log import log_formatter, show_log
1042
1204
If no revision is specified this exports the last committed revision.
1044
1206
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, exports to a directory (equivalent to --format=dir)."""
1207
given, try to find the format with the extension. If no extension
1208
is found exports to a directory (equivalent to --format=dir).
1210
Root may be the top directory for tar, tgz and tbz2 formats. If none
1211
is given, the top directory will be the root name of the file."""
1046
1212
# TODO: list known exporters
1047
1213
takes_args = ['dest']
1048
takes_options = ['revision', 'format']
1049
def run(self, dest, revision=None, format='dir'):
1214
takes_options = ['revision', 'format', 'root']
1215
def run(self, dest, revision=None, format=None, root=None):
1050
1217
b = find_branch('.')
1051
if revision == None:
1052
rh = b.revision_history()[-1]
1218
if revision is None:
1219
rev_id = b.last_patch()
1054
rh = b.lookup_revision(int(revision))
1055
t = b.revision_tree(rh)
1056
t.export(dest, format)
1221
if len(revision) != 1:
1222
raise BzrError('bzr export --revision takes exactly 1 argument')
1223
revno, rev_id = b.get_revision_info(revision[0])
1224
t = b.revision_tree(rev_id)
1225
root, ext = os.path.splitext(dest)
1227
if ext in (".tar",):
1229
elif ext in (".gz", ".tgz"):
1231
elif ext in (".bz2", ".tbz2"):
1235
t.export(dest, format, root)
1059
1238
class cmd_cat(Command):
1093
1276
TODO: Strict commit that fails if there are unknown or deleted files.
1095
1278
takes_args = ['selected*']
1096
takes_options = ['message', 'file', 'verbose']
1279
takes_options = ['message', 'file', 'verbose', 'unchanged']
1097
1280
aliases = ['ci', 'checkin']
1099
def run(self, message=None, file=None, verbose=True, selected_list=None):
1100
from bzrlib.commit import commit
1282
# TODO: Give better message for -s, --summary, used by tla people
1284
def run(self, message=None, file=None, verbose=True, selected_list=None,
1286
from bzrlib.errors import PointlessCommit
1101
1287
from bzrlib.osutils import get_text_message
1103
1289
## Warning: shadows builtin file()
1104
1290
if not message and not file:
1291
# FIXME: Ugly; change status code to send to a provided function?
1105
1293
import cStringIO
1106
1294
stdout = sys.stdout
1107
1295
catcher = cStringIO.StringIO()
1161
1381
takes_options = ['email']
1163
1383
def run(self, email=False):
1385
b = bzrlib.branch.find_branch('.')
1165
print bzrlib.osutils.user_email()
1390
print bzrlib.osutils.user_email(b)
1167
print bzrlib.osutils.username()
1392
print bzrlib.osutils.username(b)
1170
1395
class cmd_selftest(Command):
1171
1396
"""Run internal test suite"""
1398
takes_options = ['verbose']
1399
def run(self, verbose=False):
1174
1400
from bzrlib.selftest import selftest
1175
return int(not selftest())
1401
return int(not selftest(verbose=verbose))
1178
1404
class cmd_version(Command):
1230
1462
class cmd_merge(Command):
1231
"""Perform a three-way merge of trees.
1233
The SPEC parameters are working tree or revision specifiers. Working trees
1234
are specified using standard paths or urls. No component of a directory
1235
path may begin with '@'.
1237
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1239
Revisions are specified using a dirname/@revno pair, where dirname is the
1240
branch directory and revno is the revision within that branch. If no revno
1241
is specified, the latest revision is used.
1243
Revision examples: './@127', 'foo/@', '../@1'
1245
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1246
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1463
"""Perform a three-way merge.
1465
The branch is the branch you will merge from. By default, it will merge
1466
the latest revision. If you specify a revision, that revision will be
1467
merged. If you specify two revisions, the first will be used as a BASE,
1468
and the second one as OTHER. Revision numbers are always relative to the
1473
To merge the latest revision from bzr.dev
1474
bzr merge ../bzr.dev
1476
To merge changes up to and including revision 82 from bzr.dev
1477
bzr merge -r 82 ../bzr.dev
1479
To merge the changes introduced by 82, without previous changes:
1480
bzr merge -r 81..82 ../bzr.dev
1249
1482
merge refuses to run if there are any uncommitted changes, unless
1250
1483
--force is given.
1252
takes_args = ['other_spec', 'base_spec?']
1253
takes_options = ['force']
1485
takes_args = ['branch?']
1486
takes_options = ['revision', 'force', 'merge-type']
1255
def run(self, other_spec, base_spec=None, force=False):
1488
def run(self, branch='.', revision=None, force=False,
1256
1490
from bzrlib.merge import merge
1257
merge(parse_spec(other_spec), parse_spec(base_spec),
1258
check_clean=(not force))
1491
from bzrlib.merge_core import ApplyMerge3
1492
if merge_type is None:
1493
merge_type = ApplyMerge3
1495
if revision is None or len(revision) < 1:
1497
other = (branch, -1)
1499
if len(revision) == 1:
1500
other = (branch, revision[0])
1503
assert len(revision) == 2
1504
if None in revision:
1505
raise BzrCommandError(
1506
"Merge doesn't permit that revision specifier.")
1507
base = (branch, revision[0])
1508
other = (branch, revision[1])
1510
merge(other, base, check_clean=(not force), merge_type=merge_type)
1262
1513
class cmd_revert(Command):
1263
"""Restore selected files from a previous revision.
1265
takes_args = ['file+']
1266
def run(self, file_list):
1267
from bzrlib.branch import find_branch
1272
b = find_branch(file_list[0])
1274
b.revert([b.relpath(f) for f in file_list])
1277
class cmd_merge_revert(Command):
1278
1514
"""Reverse all changes since the last commit.
1280
Only versioned files are affected.
1282
TODO: Store backups of any files that will be reverted, so
1283
that the revert can be undone.
1516
Only versioned files are affected. Specify filenames to revert only
1517
those files. By default, any files that are changed will be backed up
1518
first. Backup files have a '~' appended to their name.
1285
takes_options = ['revision']
1520
takes_options = ['revision', 'no-backup']
1521
takes_args = ['file*']
1522
aliases = ['merge-revert']
1287
def run(self, revision=-1):
1524
def run(self, revision=None, no_backup=False, file_list=None):
1288
1525
from bzrlib.merge import merge
1289
merge(('.', revision), parse_spec('.'),
1526
if file_list is not None:
1527
if len(file_list) == 0:
1528
raise BzrCommandError("No files specified")
1529
if revision is None:
1531
elif len(revision) != 1:
1532
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1533
merge(('.', revision[0]), parse_spec('.'),
1290
1534
check_clean=False,
1536
backup_files=not no_backup,
1537
file_list=file_list)
1294
1540
class cmd_assert_fail(Command):
1310
1556
help.help(topic)
1313
class cmd_update_stat_cache(Command):
1314
"""Update stat-cache mapping inodes to SHA-1 hashes.
1559
class cmd_shell_complete(Command):
1560
"""Show appropriate completions for context.
1316
For testing only."""
1562
For a list of all available commands, say 'bzr shell-complete'."""
1563
takes_args = ['context?']
1567
def run(self, context=None):
1568
import shellcomplete
1569
shellcomplete.shellcomplete(context)
1572
class cmd_missing(Command):
1573
"""What is missing in this branch relative to other branch.
1575
takes_args = ['remote?']
1576
aliases = ['mis', 'miss']
1577
# We don't have to add quiet to the list, because
1578
# unknown options are parsed as booleans
1579
takes_options = ['verbose', 'quiet']
1581
def run(self, remote=None, verbose=False, quiet=False):
1582
from bzrlib.branch import find_branch, DivergedBranches
1583
from bzrlib.errors import BzrCommandError
1584
from bzrlib.missing import get_parent, show_missing
1586
if verbose and quiet:
1587
raise BzrCommandError('Cannot pass both quiet and verbose')
1320
1589
b = find_branch('.')
1321
statcache.update_cache(b.base, b.read_working_inventory())
1590
parent = get_parent(b)
1593
raise BzrCommandError("No missing location known or specified.")
1596
print "Using last location: %s" % parent
1598
elif parent is None:
1599
# We only update x-pull if it did not exist, missing should not change the parent
1600
b.controlfile('x-pull', 'wb').write(remote + '\n')
1601
br_remote = find_branch(remote)
1603
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1325
1606
class cmd_plugins(Command):
1383
1676
>>> parse_args('commit --message=biter'.split())
1384
1677
(['commit'], {'message': u'biter'})
1385
1678
>>> parse_args('log -r 500'.split())
1386
(['log'], {'revision': 500})
1387
>>> parse_args('log -r500:600'.split())
1679
(['log'], {'revision': [500]})
1680
>>> parse_args('log -r500..600'.split())
1388
1681
(['log'], {'revision': [500, 600]})
1389
>>> parse_args('log -vr500:600'.split())
1682
>>> parse_args('log -vr500..600'.split())
1390
1683
(['log'], {'verbose': True, 'revision': [500, 600]})
1391
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1392
Traceback (most recent call last):
1394
ValueError: invalid literal for int(): v500
1684
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1685
(['log'], {'revision': ['v500', 600]})
1514
def _parse_master_args(argv):
1515
"""Parse the arguments that always go with the original command.
1516
These are things like bzr --no-plugins, etc.
1518
There are now 2 types of option flags. Ones that come *before* the command,
1519
and ones that come *after* the command.
1520
Ones coming *before* the command are applied against all possible commands.
1521
And are generally applied before plugins are loaded.
1523
The current list are:
1524
--builtin Allow plugins to load, but don't let them override builtin commands,
1525
they will still be allowed if they do not override a builtin.
1526
--no-plugins Don't load any plugins. This lets you get back to official source
1528
--profile Enable the hotspot profile before running the command.
1529
For backwards compatibility, this is also a non-master option.
1530
--version Spit out the version of bzr that is running and exit.
1531
This is also a non-master option.
1532
--help Run help and exit, also a non-master option (I think that should stay, though)
1534
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1535
Traceback (most recent call last):
1537
BzrCommandError: Invalid master option: 'test'
1538
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1541
>>> print opts['version']
1543
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1545
['command', '--more-options']
1546
>>> print opts['profile']
1548
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1551
>>> print opts['no-plugins']
1553
>>> print opts['profile']
1555
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1557
['command', '--profile']
1558
>>> print opts['profile']
1561
master_opts = {'builtin':False,
1568
# This is the point where we could hook into argv[0] to determine
1569
# what front-end is supposed to be run
1570
# For now, we are just ignoring it.
1571
cmd_name = argv.pop(0)
1573
if arg[:2] != '--': # at the first non-option, we return the rest
1575
arg = arg[2:] # Remove '--'
1576
if arg not in master_opts:
1577
# We could say that this is not an error, that we should
1578
# just let it be handled by the main section instead
1579
raise BzrCommandError('Invalid master option: %r' % arg)
1580
argv.pop(0) # We are consuming this entry
1581
master_opts[arg] = True
1582
return argv, master_opts
1586
1806
def run_bzr(argv):
1587
1807
"""Execute a command.
1589
1809
This is similar to main(), but without all the trappings for
1590
1810
logging and error handling.
1813
The command-line arguments, without the program name from argv[0]
1815
Returns a command status or raises an exception.
1817
Special master options: these must come before the command because
1818
they control how the command is interpreted.
1821
Do not load plugin modules at all
1824
Only use builtin commands. (Plugins are still allowed to change
1828
Run under the Python profiler.
1592
1831
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1833
opt_profile = opt_no_plugins = opt_builtin = False
1835
# --no-plugins is handled specially at a very early stage. We need
1836
# to load plugins before doing other command parsing so that they
1837
# can override commands, but this needs to happen first.
1840
if a == '--profile':
1842
elif a == '--no-plugins':
1843
opt_no_plugins = True
1844
elif a == '--builtin':
1850
if not opt_no_plugins:
1851
from bzrlib.plugin import load_plugins
1854
args, opts = parse_args(argv)
1857
from bzrlib.help import help
1864
if 'version' in opts:
1595
# some options like --builtin and --no-plugins have special effects
1596
argv, master_opts = _parse_master_args(argv)
1597
if not master_opts['no-plugins']:
1598
from bzrlib.plugin import load_plugins
1601
args, opts = parse_args(argv)
1603
if master_opts['help']:
1604
from bzrlib.help import help
1612
from bzrlib.help import help
1618
elif 'version' in opts:
1621
elif args and args[0] == 'builtin':
1622
include_plugins=False
1624
cmd = str(args.pop(0))
1869
print >>sys.stderr, "please try 'bzr help' for help"
1631
plugins_override = not (master_opts['builtin'])
1632
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1634
profile = master_opts['profile']
1635
# For backwards compatibility, I would rather stick with --profile being a
1636
# master/global option
1637
if 'profile' in opts:
1872
cmd = str(args.pop(0))
1874
canonical_cmd, cmd_class = \
1875
get_cmd_class(cmd, plugins_override=not opt_builtin)
1641
1877
# check options are reasonable
1642
1878
allowed = cmd_class.takes_options