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__])
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, \
46
29
def _squish_command_name(cmd):
51
34
assert cmd.startswith("cmd_")
52
35
return cmd[4:].replace('_','-')
55
37
def _parse_revision_str(revstr):
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')
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' -> ?
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('..'):
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])
126
def _get_cmd_dict(plugins_override=True):
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
128
145
for k, v in globals().iteritems():
129
146
if k.startswith("cmd_"):
130
147
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()
149
d.update(_find_plugins())
141
def get_all_cmds(plugins_override=True):
152
def get_all_cmds(include_plugins=True):
142
153
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
158
def get_cmd_class(cmd,include_plugins=True):
148
159
"""Return the canonical name and command class for a command.
150
161
cmd = str(cmd) # not unicode
152
163
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
155
166
return cmd, cmds[cmd]
257
265
for opt in self.takes_options:
258
266
if not opt in OPTIONS:
259
raise BzrError("Unknown option '%s' returned by external command %s"
267
bailout("Unknown option '%s' returned by external command %s"
262
270
# TODO: Is there any way to check takes_args is valid here?
263
271
self.takes_args = pipe.readline().split()
265
273
if pipe.close() is not None:
266
raise BzrError("Failed funning '%s --bzr-usage'" % path)
274
bailout("Failed funning '%s --bzr-usage'" % path)
268
276
pipe = os.popen('%s --bzr-help' % path, 'r')
269
277
self.__doc__ = pipe.read()
270
278
if pipe.close() is not None:
271
raise BzrError("Failed funning '%s --bzr-help'" % path)
279
bailout("Failed funning '%s --bzr-help'" % path)
273
281
def __call__(self, options, arguments):
274
282
Command.__init__(self, options, arguments)
335
343
directory is shown. Otherwise, only the status of the specified
336
344
files or directories is reported. If a directory is given, status
337
345
is reported for everything inside that directory.
339
If a revision is specified, the changes since that revision are shown.
341
347
takes_args = ['file*']
342
takes_options = ['all', 'show-ids', 'revision']
348
takes_options = ['all', 'show-ids']
343
349
aliases = ['st', 'stat']
345
351
def run(self, all=False, show_ids=False, file_list=None):
347
b = find_branch(file_list[0])
353
b = Branch(file_list[0])
348
354
file_list = [b.relpath(x) for x in file_list]
349
355
# special case: only one path was given and it's the root
351
357
if file_list == ['']:
356
from bzrlib.status import show_status
357
show_status(b, show_unchanged=all, show_ids=show_ids,
358
specific_files=file_list)
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
361
366
class cmd_cat_revision(Command):
412
394
whether already versioned or not, are searched for files or
413
395
subdirectories that are neither versioned or ignored, and these
414
396
are added. This search proceeds recursively into versioned
415
directories. If no names are given '.' is assumed.
417
Therefore simply saying 'bzr add' will version all files that
399
Therefore simply saying 'bzr add .' will version all files that
418
400
are currently unknown.
420
402
TODO: Perhaps adding a file whose directly is not versioned should
421
403
recursively add that parent, rather than giving an error?
423
takes_args = ['file*']
405
takes_args = ['file+']
424
406
takes_options = ['verbose', 'no-recurse']
426
408
def run(self, file_list, verbose=False, no_recurse=False):
427
from bzrlib.add import smart_add
428
smart_add(file_list, verbose, not no_recurse)
432
class cmd_mkdir(Command):
433
"""Create a new versioned directory.
435
This is equivalent to creating the directory and then adding it.
437
takes_args = ['dir+']
439
def run(self, dir_list):
446
b.add([d], verbose=True)
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
449
412
class cmd_relpath(Command):
535
495
def run(self, location=None):
536
496
from bzrlib.merge import merge
538
from shutil import rmtree
541
br_to = find_branch('.')
542
500
stored_loc = None
544
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
545
503
except IOError, e:
546
if e.errno != errno.ENOENT:
504
if errno == errno.ENOENT:
548
506
if location is None:
549
if stored_loc is None:
550
raise BzrCommandError("No pull location known or specified.")
552
print "Using last location: %s" % stored_loc
553
location = stored_loc
554
cache_root = tempfile.mkdtemp()
555
from bzrlib.branch import DivergedBranches
507
location = stored_loc
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
556
511
br_from = find_branch(location)
557
512
location = pull_loc(br_from)
558
513
old_revno = br_to.revno()
560
from branch import find_cached_branch, DivergedBranches
561
br_from = find_cached_branch(location, cache_root)
562
location = pull_loc(br_from)
563
old_revno = br_to.revno()
565
br_to.update_revisions(br_from)
566
except DivergedBranches:
567
raise BzrCommandError("These branches have diverged."
570
merge(('.', -1), ('.', old_revno), check_clean=False)
571
if location != stored_loc:
572
br_to.controlfile("x-pull", "wb").write(location + "\n")
515
br_to.update_revisions(br_from)
516
except DivergedBranches:
517
raise BzrCommandError("These branches have diverged. Try merge.")
519
merge(('.', -1), ('.', old_revno), check_clean=False)
520
if location != stored_loc:
521
br_to.controlfile("x-pull", "wb").write(location + "\n")
590
537
def run(self, from_location, to_location=None, revision=None):
592
539
from bzrlib.merge import merge
593
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
594
find_cached_branch, Branch
540
from branch import find_branch, DivergedBranches, NoSuchRevision
595
541
from shutil import rmtree
596
from meta_store import CachedStore
598
cache_root = tempfile.mkdtemp()
602
elif len(revision) > 1:
603
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
607
br_from = find_cached_branch(from_location, cache_root)
609
if e.errno == errno.ENOENT:
610
raise BzrCommandError('Source location "%s" does not'
611
' exist.' % to_location)
615
if to_location is None:
616
to_location = os.path.basename(from_location.rstrip("/\\"))
619
os.mkdir(to_location)
621
if e.errno == errno.EEXIST:
622
raise BzrCommandError('Target directory "%s" already'
623
' exists.' % to_location)
624
if e.errno == errno.ENOENT:
625
raise BzrCommandError('Parent of "%s" does not exist.' %
629
br_to = Branch(to_location, init=True)
631
br_to.set_root_id(br_from.get_root_id())
634
if revision[0] is None:
635
revno = br_from.revno()
637
revno, rev_id = br_from.get_revision_info(revision[0])
639
br_to.update_revisions(br_from, stop_revision=revno)
640
except NoSuchRevision:
642
msg = "The branch %s has no revision %d." % (from_location,
644
raise BzrCommandError(msg)
646
merge((to_location, -1), (to_location, 0), this_dir=to_location,
647
check_clean=False, ignore_zero=True)
648
from_location = pull_loc(br_from)
649
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
543
br_from = find_branch(from_location)
545
if e.errno == errno.ENOENT:
546
raise BzrCommandError('Source location "%s" does not exist.' %
551
if to_location is None:
552
to_location = os.path.basename(from_location.rstrip("/\\"))
555
os.mkdir(to_location)
557
if e.errno == errno.EEXIST:
558
raise BzrCommandError('Target directory "%s" already exists.' %
560
if e.errno == errno.ENOENT:
561
raise BzrCommandError('Parent of "%s" does not exist.' %
565
br_to = Branch(to_location, init=True)
568
br_to.update_revisions(br_from, stop_revision=revision)
569
except NoSuchRevision:
571
msg = "The branch %s has no revision %d." % (from_location,
573
raise BzrCommandError(msg)
574
merge((to_location, -1), (to_location, 0), this_dir=to_location,
576
from_location = pull_loc(br_from)
577
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
654
580
def pull_loc(branch):
858
778
"""List files modified in working tree."""
861
from bzrlib.diff import compare_trees
864
td = compare_trees(b.basis_tree(), b.working_tree())
866
for path, id, kind in td.modified:
783
inv = b.read_working_inventory()
784
sc = statcache.update_cache(b, inv)
785
basis = b.basis_tree()
786
basis_inv = basis.inventory
788
# We used to do this through iter_entries(), but that's slow
789
# when most of the files are unmodified, as is usually the
790
# case. So instead we iterate by inventory entry, and only
791
# calculate paths as necessary.
793
for file_id in basis_inv:
794
cacheentry = sc.get(file_id)
795
if not cacheentry: # deleted
797
ie = basis_inv[file_id]
798
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
799
path = inv.id2path(file_id)
905
839
-r revision requests a specific revision, -r :end or -r begin: are
908
--message allows you to give a regular expression, which will be evaluated
909
so that only matching entries will be displayed.
911
842
TODO: Make --revision support uuid: and hash: [future tag:] notation.
915
846
takes_args = ['filename?']
916
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
918
849
def run(self, filename=None, timezone='original',
925
from bzrlib.branch import find_branch
926
from bzrlib.log import log_formatter, show_log
854
from bzrlib import show_log, find_branch
929
857
direction = (forward and 'forward') or 'reverse'
1128
1040
If no revision is specified this exports the last committed revision.
1130
1042
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1131
given, try to find the format with the extension. If no extension
1132
is found exports to a directory (equivalent to --format=dir).
1134
Root may be the top directory for tar, tgz and tbz2 formats. If none
1135
is given, the top directory will be the root name of the file."""
1043
given, exports to a directory (equivalent to --format=dir)."""
1136
1044
# TODO: list known exporters
1137
1045
takes_args = ['dest']
1138
takes_options = ['revision', 'format', 'root']
1139
def run(self, dest, revision=None, format=None, root=None):
1141
b = find_branch('.')
1142
if revision is None:
1143
rev_id = b.last_patch()
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1145
if len(revision) != 1:
1146
raise BzrError('bzr export --revision takes exactly 1 argument')
1147
revno, rev_id = b.get_revision_info(revision[0])
1148
t = b.revision_tree(rev_id)
1149
root, ext = os.path.splitext(dest)
1151
if ext in (".tar",):
1153
elif ext in (".gz", ".tgz"):
1155
elif ext in (".bz2", ".tbz2"):
1159
t.export(dest, format, root)
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1162
1057
class cmd_cat(Command):
1198
1091
TODO: Strict commit that fails if there are unknown or deleted files.
1200
1093
takes_args = ['selected*']
1201
takes_options = ['message', 'file', 'verbose', 'unchanged']
1094
takes_options = ['message', 'file', 'verbose']
1202
1095
aliases = ['ci', 'checkin']
1204
def run(self, message=None, file=None, verbose=True, selected_list=None,
1206
from bzrlib.errors import PointlessCommit
1207
from bzrlib.osutils import get_text_message
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1209
1100
## Warning: shadows builtin file()
1210
1101
if not message and not file:
1213
catcher = cStringIO.StringIO()
1214
sys.stdout = catcher
1215
cmd_status({"file_list":selected_list}, {})
1216
info = catcher.getvalue()
1218
message = get_text_message(info)
1221
raise BzrCommandError("please specify a commit message",
1222
["use either --message or --file"])
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1223
1104
elif message and file:
1224
1105
raise BzrCommandError("please specify either --message or --file")
1250
1122
to help ensure data consistency.
1252
1124
takes_args = ['dir?']
1254
def run(self, dir='.'):
1255
from bzrlib.check import check
1256
check(find_branch(dir))
1260
class cmd_scan_cache(Command):
1263
from bzrlib.hashcache import HashCache
1270
print '%6d stats' % c.stat_count
1271
print '%6d in hashcache' % len(c._cache)
1272
print '%6d files removed from cache' % c.removed_count
1273
print '%6d hashes updated' % c.update_count
1274
print '%6d files changed too recently to cache' % c.danger_count
1281
class cmd_upgrade(Command):
1282
"""Upgrade branch storage to current format.
1284
This should normally be used only after the check command tells
1287
takes_args = ['dir?']
1289
def run(self, dir='.'):
1290
from bzrlib.upgrade import upgrade
1291
upgrade(find_branch(dir))
1125
takes_options = ['update']
1127
def run(self, dir='.', update=False):
1129
bzrlib.check.check(Branch(dir), update=update)
1529
1333
>>> parse_args('commit --message=biter'.split())
1530
1334
(['commit'], {'message': u'biter'})
1531
1335
>>> parse_args('log -r 500'.split())
1532
(['log'], {'revision': [500]})
1533
>>> parse_args('log -r500..600'.split())
1336
(['log'], {'revision': 500})
1337
>>> parse_args('log -r500:600'.split())
1534
1338
(['log'], {'revision': [500, 600]})
1535
>>> parse_args('log -vr500..600'.split())
1339
>>> parse_args('log -vr500:600'.split())
1536
1340
(['log'], {'verbose': True, 'revision': [500, 600]})
1537
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1538
(['log'], {'revision': ['v500', 600]})
1341
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1342
Traceback (most recent call last):
1344
ValueError: invalid literal for int(): v500
1658
def _parse_master_args(argv):
1659
"""Parse the arguments that always go with the original command.
1660
These are things like bzr --no-plugins, etc.
1662
There are now 2 types of option flags. Ones that come *before* the command,
1663
and ones that come *after* the command.
1664
Ones coming *before* the command are applied against all possible commands.
1665
And are generally applied before plugins are loaded.
1667
The current list are:
1668
--builtin Allow plugins to load, but don't let them override builtin commands,
1669
they will still be allowed if they do not override a builtin.
1670
--no-plugins Don't load any plugins. This lets you get back to official source
1672
--profile Enable the hotspot profile before running the command.
1673
For backwards compatibility, this is also a non-master option.
1674
--version Spit out the version of bzr that is running and exit.
1675
This is also a non-master option.
1676
--help Run help and exit, also a non-master option (I think that should stay, though)
1678
>>> argv, opts = _parse_master_args(['--test'])
1679
Traceback (most recent call last):
1681
BzrCommandError: Invalid master option: 'test'
1682
>>> argv, opts = _parse_master_args(['--version', 'command'])
1685
>>> print opts['version']
1687
>>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
1689
['command', '--more-options']
1690
>>> print opts['profile']
1692
>>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
1695
>>> print opts['no-plugins']
1697
>>> print opts['profile']
1699
>>> argv, opts = _parse_master_args(['command', '--profile'])
1701
['command', '--profile']
1702
>>> print opts['profile']
1705
master_opts = {'builtin':False,
1713
if arg[:2] != '--': # at the first non-option, we return the rest
1715
arg = arg[2:] # Remove '--'
1716
if arg not in master_opts:
1717
# We could say that this is not an error, that we should
1718
# just let it be handled by the main section instead
1719
raise BzrCommandError('Invalid master option: %r' % arg)
1720
argv.pop(0) # We are consuming this entry
1721
master_opts[arg] = True
1722
return argv, master_opts
1726
1465
def run_bzr(argv):
1727
1466
"""Execute a command.
1729
1468
This is similar to main(), but without all the trappings for
1730
1469
logging and error handling.
1733
The command-line arguments, without the program name.
1735
Returns a command status or raises an exception.
1737
1471
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1739
# some options like --builtin and --no-plugins have special effects
1740
argv, master_opts = _parse_master_args(argv)
1741
if not master_opts['no-plugins']:
1742
from bzrlib.plugin import load_plugins
1745
args, opts = parse_args(argv)
1747
if master_opts.get('help') or 'help' in opts:
1748
from bzrlib.help import help
1755
if 'version' in opts:
1759
if args and args[0] == 'builtin':
1760
include_plugins=False
1473
include_plugins=True
1475
args, opts = parse_args(argv[1:])
1483
elif 'version' in opts:
1486
elif args and args[0] == 'builtin':
1487
include_plugins=False
1764
1489
cmd = str(args.pop(0))
1765
1490
except IndexError:
1766
print >>sys.stderr, "please try 'bzr help' for help"
1769
plugins_override = not (master_opts['builtin'])
1770
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1772
profile = master_opts['profile']
1773
# For backwards compatibility, I would rather stick with --profile being a
1774
# master/global option
1496
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1775
1499
if 'profile' in opts:
1777
1501
del opts['profile']
1779
1505
# check options are reasonable
1780
1506
allowed = cmd_class.takes_options