22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
22
from bzrlib.trace import mutter, note, log_error, warning
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__])
29
46
def _squish_command_name(cmd):
34
51
assert cmd.startswith("cmd_")
35
52
return cmd[4:].replace('_','-')
37
55
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
56
"""This handles a revision string -> revno.
58
This always returns a list. The list will have one element for
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
63
>>> _parse_revision_str('234')
65
>>> _parse_revision_str('234..567')
67
>>> _parse_revision_str('..')
69
>>> _parse_revision_str('..234')
71
>>> _parse_revision_str('234..')
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
75
>>> _parse_revision_str('234....789') # Error?
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
93
>>> _parse_revision_str('-5')
95
>>> _parse_revision_str('123a')
97
>>> _parse_revision_str('abc')
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
104
warning('Colon separator for revision numbers is deprecated.'
107
for rev in revstr.split(':'):
109
revs.append(int(rev))
114
for x in revstr.split('..'):
72
"""Return canonical name and class for all registered commands."""
126
def _get_cmd_dict(plugins_override=True):
73
128
for k, v in globals().iteritems():
74
129
if k.startswith("cmd_"):
75
yield _unsquish_command_name(k), v
77
def get_cmd_class(cmd):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
135
d2 = plugin_cmds.copy()
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
78
148
"""Return the canonical name and command class for a command.
80
150
cmd = str(cmd) # not unicode
82
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
84
return cmd, globals()[_squish_command_name(cmd)]
155
return cmd, cmds[cmd]
88
159
# look for any command which claims this as an alias
89
for cmdname, cmdclass in get_all_cmds():
160
for cmdname, cmdclass in cmds.iteritems():
90
161
if cmd in cmdclass.aliases:
91
162
return cmdname, cmdclass
177
248
def __init__(self, path):
180
# TODO: If either of these fail, we should detect that and
181
# assume that path is not really a bzr plugin after all.
183
251
pipe = os.popen('%s --bzr-usage' % path, 'r')
184
252
self.takes_options = pipe.readline().split()
254
for opt in self.takes_options:
255
if not opt in OPTIONS:
256
raise BzrError("Unknown option '%s' returned by external command %s"
259
# TODO: Is there any way to check takes_args is valid here?
185
260
self.takes_args = pipe.readline().split()
262
if pipe.close() is not None:
263
raise BzrError("Failed funning '%s --bzr-usage'" % path)
188
265
pipe = os.popen('%s --bzr-help' % path, 'r')
189
266
self.__doc__ = pipe.read()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-help'" % path)
192
270
def __call__(self, options, arguments):
193
271
Command.__init__(self, options, arguments)
253
332
directory is shown. Otherwise, only the status of the specified
254
333
files or directories is reported. If a directory is given, status
255
334
is reported for everything inside that directory.
336
If a revision is specified, the changes since that revision are shown.
257
338
takes_args = ['file*']
258
takes_options = ['all', 'show-ids']
339
takes_options = ['all', 'show-ids', 'revision']
259
340
aliases = ['st', 'stat']
261
342
def run(self, all=False, show_ids=False, file_list=None):
263
b = Branch(file_list[0])
344
b = find_branch(file_list[0])
264
345
file_list = [b.relpath(x) for x in file_list]
265
346
# special case: only one path was given and it's the root
267
348
if file_list == ['']:
272
status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
specific_files=file_list)
353
from bzrlib.status import show_status
354
show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
276
358
class cmd_cat_revision(Command):
379
506
takes_args = ['from_name', 'to_name']
381
508
def run(self, from_name, to_name):
383
510
b.rename_one(b.relpath(from_name), b.relpath(to_name))
516
class cmd_pull(Command):
517
"""Pull any changes from another branch into the current one.
519
If the location is omitted, the last-used location will be used.
520
Both the revision history and the working directory will be
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if both branches have had commits without first
525
pulling from the other.
527
If branches have diverged, you can use 'bzr merge' to pull the text changes
528
from one into the other.
530
takes_args = ['location?']
532
def run(self, location=None):
533
from bzrlib.merge import merge
535
from shutil import rmtree
538
br_to = find_branch('.')
541
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
543
if e.errno != errno.ENOENT:
546
if stored_loc is None:
547
raise BzrCommandError("No pull location known or specified.")
549
print "Using last location: %s" % stored_loc
550
location = stored_loc
551
cache_root = tempfile.mkdtemp()
552
from bzrlib.branch import DivergedBranches
553
br_from = find_branch(location)
554
location = pull_loc(br_from)
555
old_revno = br_to.revno()
557
from branch import find_cached_branch, DivergedBranches
558
br_from = find_cached_branch(location, cache_root)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
br_to.update_revisions(br_from)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
567
merge(('.', -1), ('.', old_revno), check_clean=False)
568
if location != stored_loc:
569
br_to.controlfile("x-pull", "wb").write(location + "\n")
575
class cmd_branch(Command):
576
"""Create a new copy of a branch.
578
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
579
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
581
To retrieve the branch as of a particular revision, supply the --revision
582
parameter, as in "branch foo/bar -r 5".
584
takes_args = ['from_location', 'to_location?']
585
takes_options = ['revision']
587
def run(self, from_location, to_location=None, revision=None):
589
from bzrlib.merge import merge
590
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
591
find_cached_branch, Branch
592
from shutil import rmtree
593
from meta_store import CachedStore
595
cache_root = tempfile.mkdtemp()
599
elif len(revision) > 1:
600
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
604
br_from = find_cached_branch(from_location, cache_root)
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Source location "%s" does not'
608
' exist.' % to_location)
612
if to_location is None:
613
to_location = os.path.basename(from_location.rstrip("/\\"))
616
os.mkdir(to_location)
618
if e.errno == errno.EEXIST:
619
raise BzrCommandError('Target directory "%s" already'
620
' exists.' % to_location)
621
if e.errno == errno.ENOENT:
622
raise BzrCommandError('Parent of "%s" does not exist.' %
626
br_to = Branch(to_location, init=True)
628
br_to.set_root_id(br_from.get_root_id())
631
if revision[0] is None:
632
revno = br_from.revno()
634
revno, rev_id = br_from.get_revision_info(revision[0])
636
br_to.update_revisions(br_from, stop_revision=revno)
637
except NoSuchRevision:
639
msg = "The branch %s has no revision %d." % (from_location,
641
raise BzrCommandError(msg)
643
merge((to_location, -1), (to_location, 0), this_dir=to_location,
644
check_clean=False, ignore_zero=True)
645
from_location = pull_loc(br_from)
646
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
651
def pull_loc(branch):
652
# TODO: Should perhaps just make attribute be 'base' in
653
# RemoteBranch and Branch?
654
if hasattr(branch, "baseurl"):
655
return branch.baseurl
387
661
class cmd_renames(Command):
388
662
"""Show list of renamed files.
575
855
"""List files modified in working tree."""
580
inv = b.read_working_inventory()
581
sc = statcache.update_cache(b, inv)
582
basis = b.basis_tree()
583
basis_inv = basis.inventory
585
# We used to do this through iter_entries(), but that's slow
586
# when most of the files are unmodified, as is usually the
587
# case. So instead we iterate by inventory entry, and only
588
# calculate paths as necessary.
590
for file_id in basis_inv:
591
cacheentry = sc.get(file_id)
592
if not cacheentry: # deleted
594
ie = basis_inv[file_id]
595
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
596
path = inv.id2path(file_id)
858
from bzrlib.diff import compare_trees
861
td = compare_trees(b.basis_tree(), b.working_tree())
863
for path, id, kind in td.modified:
636
902
-r revision requests a specific revision, -r :end or -r begin: are
905
--message allows you to give a regular expression, which will be evaluated
906
so that only matching entries will be displayed.
639
908
TODO: Make --revision support uuid: and hash: [future tag:] notation.
643
912
takes_args = ['filename?']
644
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
913
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
646
915
def run(self, filename=None, timezone='original',
651
from bzrlib import show_log, find_branch
922
from bzrlib.branch import find_branch
923
from bzrlib.log import log_formatter, show_log
654
926
direction = (forward and 'forward') or 'reverse'
828
1116
except ValueError:
829
1117
raise BzrCommandError("not a valid revision-number: %r" % revno)
831
print Branch('.').lookup_revision(revno)
1119
print find_branch('.').lookup_revision(revno)
834
1122
class cmd_export(Command):
835
1123
"""Export past revision to destination directory.
837
If no revision is specified this exports the last committed revision."""
1125
If no revision is specified this exports the last committed revision.
1127
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1128
given, try to find the format with the extension. If no extension
1129
is found exports to a directory (equivalent to --format=dir).
1131
Root may be the top directory for tar, tgz and tbz2 formats. If none
1132
is given, the top directory will be the root name of the file."""
1133
# TODO: list known exporters
838
1134
takes_args = ['dest']
839
takes_options = ['revision']
840
def run(self, dest, revision=None):
843
rh = b.revision_history()[-1]
1135
takes_options = ['revision', 'format', 'root']
1136
def run(self, dest, revision=None, format=None, root=None):
1138
b = find_branch('.')
1139
if revision is None:
1140
rev_id = b.last_patch()
845
rh = b.lookup_revision(int(revision))
846
t = b.revision_tree(rh)
1142
if len(revision) != 1:
1143
raise BzrError('bzr export --revision takes exactly 1 argument')
1144
revno, rev_id = b.get_revision_info(revision[0])
1145
t = b.revision_tree(rev_id)
1146
root, ext = os.path.splitext(dest)
1148
if ext in (".tar",):
1150
elif ext in (".gz", ".tgz"):
1152
elif ext in (".bz2", ".tbz2"):
1156
t.export(dest, format, root)
850
1159
class cmd_cat(Command):
884
1195
TODO: Strict commit that fails if there are unknown or deleted files.
886
1197
takes_args = ['selected*']
887
takes_options = ['message', 'file', 'verbose']
1198
takes_options = ['message', 'file', 'verbose', 'unchanged']
888
1199
aliases = ['ci', 'checkin']
890
def run(self, message=None, file=None, verbose=True, selected_list=None):
891
from bzrlib.commit import commit
1201
def run(self, message=None, file=None, verbose=True, selected_list=None,
1203
from bzrlib.errors import PointlessCommit
1204
from bzrlib.osutils import get_text_message
893
1206
## Warning: shadows builtin file()
894
1207
if not message and not file:
895
raise BzrCommandError("please specify a commit message",
896
["use either --message or --file"])
1210
catcher = cStringIO.StringIO()
1211
sys.stdout = catcher
1212
cmd_status({"file_list":selected_list}, {})
1213
info = catcher.getvalue()
1215
message = get_text_message(info)
1218
raise BzrCommandError("please specify a commit message",
1219
["use either --message or --file"])
897
1220
elif message and file:
898
1221
raise BzrCommandError("please specify either --message or --file")
911
1243
This command checks various invariants about the branch storage to
912
1244
detect data corruption or bzr bugs.
914
takes_args = ['dir?']
915
def run(self, dir='.'):
917
bzrlib.check.check(Branch(dir))
1246
If given the --update flag, it will update some optional fields
1247
to help ensure data consistency.
1249
takes_args = ['dir?']
1251
def run(self, dir='.'):
1252
from bzrlib.check import check
1253
check(find_branch(dir))
1257
class cmd_scan_cache(Command):
1260
from bzrlib.hashcache import HashCache
1267
print '%6d stats' % c.stat_count
1268
print '%6d in hashcache' % len(c._cache)
1269
print '%6d files removed from cache' % c.removed_count
1270
print '%6d hashes updated' % c.update_count
1271
print '%6d files changed too recently to cache' % c.danger_count
1278
class cmd_upgrade(Command):
1279
"""Upgrade branch storage to current format.
1281
This should normally be used only after the check command tells
1284
takes_args = ['dir?']
1286
def run(self, dir='.'):
1287
from bzrlib.upgrade import upgrade
1288
upgrade(find_branch(dir))
1009
1385
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1010
1386
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1389
merge refuses to run if there are any uncommitted changes, unless
1013
1392
takes_args = ['other_spec', 'base_spec?']
1393
takes_options = ['force']
1015
def run(self, other_spec, base_spec=None):
1395
def run(self, other_spec, base_spec=None, force=False):
1016
1396
from bzrlib.merge import merge
1017
merge(parse_spec(other_spec), parse_spec(base_spec))
1397
merge(parse_spec(other_spec), parse_spec(base_spec),
1398
check_clean=(not force))
1020
1402
class cmd_revert(Command):
1403
"""Restore selected files from a previous revision.
1022
Reverse all changes since the last commit. Only versioned files are
1405
takes_args = ['file+']
1406
def run(self, file_list):
1407
from bzrlib.branch import find_branch
1412
b = find_branch(file_list[0])
1414
b.revert([b.relpath(f) for f in file_list])
1417
class cmd_merge_revert(Command):
1418
"""Reverse all changes since the last commit.
1420
Only versioned files are affected.
1422
TODO: Store backups of any files that will be reverted, so
1423
that the revert can be undone.
1025
1425
takes_options = ['revision']
1027
def run(self, revision=-1):
1028
merge.merge(('.', revision), parse_spec('.'), no_changes=False,
1427
def run(self, revision=None):
1428
from bzrlib.merge import merge
1429
if revision is None:
1431
elif len(revision) != 1:
1432
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1433
merge(('.', revision[0]), parse_spec('.'),
1032
1438
class cmd_assert_fail(Command):
1105
1525
(['status'], {'all': True})
1106
1526
>>> parse_args('commit --message=biter'.split())
1107
1527
(['commit'], {'message': u'biter'})
1528
>>> parse_args('log -r 500'.split())
1529
(['log'], {'revision': [500]})
1530
>>> parse_args('log -r500..600'.split())
1531
(['log'], {'revision': [500, 600]})
1532
>>> parse_args('log -vr500..600'.split())
1533
(['log'], {'verbose': True, 'revision': [500, 600]})
1534
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1535
(['log'], {'revision': ['v500', 600]})
1125
1553
optname = a[2:]
1126
1554
if optname not in OPTIONS:
1127
bailout('unknown long option %r' % a)
1555
raise BzrError('unknown long option %r' % a)
1129
1557
shortopt = a[1:]
1130
if shortopt not in SHORT_OPTIONS:
1131
bailout('unknown short option %r' % a)
1132
optname = SHORT_OPTIONS[shortopt]
1558
if shortopt in SHORT_OPTIONS:
1559
# Multi-character options must have a space to delimit
1561
optname = SHORT_OPTIONS[shortopt]
1563
# Single character short options, can be chained,
1564
# and have their value appended to their name
1566
if shortopt not in SHORT_OPTIONS:
1567
# We didn't find the multi-character name, and we
1568
# didn't find the single char name
1569
raise BzrError('unknown short option %r' % a)
1570
optname = SHORT_OPTIONS[shortopt]
1573
# There are extra things on this option
1574
# see if it is the value, or if it is another
1576
optargfn = OPTIONS[optname]
1577
if optargfn is None:
1578
# This option does not take an argument, so the
1579
# next entry is another short option, pack it back
1581
argv.insert(0, '-' + a[2:])
1583
# This option takes an argument, so pack it
1134
1587
if optname in opts:
1135
1588
# XXX: Do we ever want to support this, e.g. for -r?
1136
bailout('repeated option %r' % a)
1589
raise BzrError('repeated option %r' % a)
1138
1591
optargfn = OPTIONS[optname]
1140
1593
if optarg == None:
1142
bailout('option %r needs an argument' % a)
1595
raise BzrError('option %r needs an argument' % a)
1144
1597
optarg = argv.pop(0)
1145
1598
opts[optname] = optargfn(optarg)
1147
1600
if optarg != None:
1148
bailout('option %r takes no argument' % optname)
1601
raise BzrError('option %r takes no argument' % optname)
1149
1602
opts[optname] = True
1655
def _parse_master_args(argv):
1656
"""Parse the arguments that always go with the original command.
1657
These are things like bzr --no-plugins, etc.
1659
There are now 2 types of option flags. Ones that come *before* the command,
1660
and ones that come *after* the command.
1661
Ones coming *before* the command are applied against all possible commands.
1662
And are generally applied before plugins are loaded.
1664
The current list are:
1665
--builtin Allow plugins to load, but don't let them override builtin commands,
1666
they will still be allowed if they do not override a builtin.
1667
--no-plugins Don't load any plugins. This lets you get back to official source
1669
--profile Enable the hotspot profile before running the command.
1670
For backwards compatibility, this is also a non-master option.
1671
--version Spit out the version of bzr that is running and exit.
1672
This is also a non-master option.
1673
--help Run help and exit, also a non-master option (I think that should stay, though)
1675
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1676
Traceback (most recent call last):
1678
BzrCommandError: Invalid master option: 'test'
1679
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1682
>>> print opts['version']
1684
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1686
['command', '--more-options']
1687
>>> print opts['profile']
1689
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1692
>>> print opts['no-plugins']
1694
>>> print opts['profile']
1696
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1698
['command', '--profile']
1699
>>> print opts['profile']
1702
master_opts = {'builtin':False,
1709
# This is the point where we could hook into argv[0] to determine
1710
# what front-end is supposed to be run
1711
# For now, we are just ignoring it.
1712
cmd_name = argv.pop(0)
1714
if arg[:2] != '--': # at the first non-option, we return the rest
1716
arg = arg[2:] # Remove '--'
1717
if arg not in master_opts:
1718
# We could say that this is not an error, that we should
1719
# just let it be handled by the main section instead
1720
raise BzrCommandError('Invalid master option: %r' % arg)
1721
argv.pop(0) # We are consuming this entry
1722
master_opts[arg] = True
1723
return argv, master_opts
1203
1727
def run_bzr(argv):
1204
1728
"""Execute a command.