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
"""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):
126
def _get_cmd_dict(plugins_override=True):
145
128
for k, v in globals().iteritems():
146
129
if k.startswith("cmd_"):
147
130
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
135
d2 = plugin_cmds.copy()
152
def get_all_cmds(include_plugins=True):
141
def get_all_cmds(plugins_override=True):
153
142
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
147
def get_cmd_class(cmd, plugins_override=True):
159
148
"""Return the canonical name and command class for a command.
161
150
cmd = str(cmd) # not unicode
163
152
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
166
155
return cmd, cmds[cmd]
231
223
class ExternalCommand(Command):
232
224
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
226
We cheat a little here, when get_cmd_class() calls us we actually
227
give it back an object we construct that has the appropriate path,
228
help, options etc for the specified command.
230
When run_bzr() tries to instantiate that 'class' it gets caught by
231
the __call__ method, which we override to call the Command.__init__
232
method. That then calls our run method which is pretty straight
235
The only wrinkle is that we have to map bzr's dictionary of options
236
and arguments back into command line options and arguments for the
246
240
def find_command(cls, cmd):
265
259
for opt in self.takes_options:
266
260
if not opt in OPTIONS:
267
bailout("Unknown option '%s' returned by external command %s"
261
raise BzrError("Unknown option '%s' returned by external command %s"
270
264
# TODO: Is there any way to check takes_args is valid here?
271
265
self.takes_args = pipe.readline().split()
273
267
if pipe.close() is not None:
274
bailout("Failed funning '%s --bzr-usage'" % path)
268
raise BzrError("Failed funning '%s --bzr-usage'" % path)
276
270
pipe = os.popen('%s --bzr-help' % path, 'r')
277
271
self.__doc__ = pipe.read()
278
272
if pipe.close() is not None:
279
bailout("Failed funning '%s --bzr-help'" % path)
273
raise BzrError("Failed funning '%s --bzr-help'" % path)
281
275
def __call__(self, options, arguments):
282
276
Command.__init__(self, options, arguments)
343
337
directory is shown. Otherwise, only the status of the specified
344
338
files or directories is reported. If a directory is given, status
345
339
is reported for everything inside that directory.
341
If a revision is specified, the changes since that revision are shown.
347
343
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
344
takes_options = ['all', 'show-ids', 'revision']
349
345
aliases = ['st', 'stat']
351
347
def run(self, all=False, show_ids=False, file_list=None):
353
b = Branch(file_list[0])
349
b = find_branch(file_list[0])
354
350
file_list = [b.relpath(x) for x in file_list]
355
351
# special case: only one path was given and it's the root
357
353
if file_list == ['']:
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
358
from bzrlib.status import show_status
359
show_status(b, show_unchanged=all, show_ids=show_ids,
360
specific_files=file_list)
366
363
class cmd_cat_revision(Command):
394
414
whether already versioned or not, are searched for files or
395
415
subdirectories that are neither versioned or ignored, and these
396
416
are added. This search proceeds recursively into versioned
417
directories. If no names are given '.' is assumed.
399
Therefore simply saying 'bzr add .' will version all files that
419
Therefore simply saying 'bzr add' will version all files that
400
420
are currently unknown.
402
422
TODO: Perhaps adding a file whose directly is not versioned should
403
423
recursively add that parent, rather than giving an error?
405
takes_args = ['file+']
425
takes_args = ['file*']
406
426
takes_options = ['verbose', 'no-recurse']
408
428
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
429
from bzrlib.add import smart_add
430
smart_add(file_list, verbose, not no_recurse)
434
class cmd_mkdir(Command):
435
"""Create a new versioned directory.
437
This is equivalent to creating the directory and then adding it.
439
takes_args = ['dir+']
441
def run(self, dir_list):
448
b.add([d], verbose=True)
412
451
class cmd_relpath(Command):
495
537
def run(self, location=None):
496
538
from bzrlib.merge import merge
540
from shutil import rmtree
543
br_to = find_branch('.')
500
544
stored_loc = None
502
546
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
503
547
except IOError, e:
504
if errno == errno.ENOENT:
548
if e.errno != errno.ENOENT:
506
550
if location is None:
507
location = stored_loc
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
551
if stored_loc is None:
552
raise BzrCommandError("No pull location known or specified.")
554
print "Using last location: %s" % stored_loc
555
location = stored_loc
556
cache_root = tempfile.mkdtemp()
557
from bzrlib.branch import DivergedBranches
511
558
br_from = find_branch(location)
512
559
location = pull_loc(br_from)
513
560
old_revno = br_to.revno()
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")
562
from branch import find_cached_branch, DivergedBranches
563
br_from = find_cached_branch(location, cache_root)
564
location = pull_loc(br_from)
565
old_revno = br_to.revno()
567
br_to.update_revisions(br_from)
568
except DivergedBranches:
569
raise BzrCommandError("These branches have diverged."
572
merge(('.', -1), ('.', old_revno), check_clean=False)
573
if location != stored_loc:
574
br_to.controlfile("x-pull", "wb").write(location + "\n")
537
592
def run(self, from_location, to_location=None, revision=None):
539
594
from bzrlib.merge import merge
540
from branch import find_branch, DivergedBranches, NoSuchRevision
595
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
596
find_cached_branch, Branch
541
597
from shutil import rmtree
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")
598
from meta_store import CachedStore
600
cache_root = tempfile.mkdtemp()
604
elif len(revision) > 1:
605
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
609
br_from = find_cached_branch(from_location, cache_root)
611
if e.errno == errno.ENOENT:
612
raise BzrCommandError('Source location "%s" does not'
613
' exist.' % to_location)
617
if to_location is None:
618
to_location = os.path.basename(from_location.rstrip("/\\"))
621
os.mkdir(to_location)
623
if e.errno == errno.EEXIST:
624
raise BzrCommandError('Target directory "%s" already'
625
' exists.' % to_location)
626
if e.errno == errno.ENOENT:
627
raise BzrCommandError('Parent of "%s" does not exist.' %
631
br_to = Branch(to_location, init=True)
633
br_to.set_root_id(br_from.get_root_id())
636
if revision[0] is None:
637
revno = br_from.revno()
639
revno, rev_id = br_from.get_revision_info(revision[0])
641
br_to.update_revisions(br_from, stop_revision=revno)
642
except NoSuchRevision:
644
msg = "The branch %s has no revision %d." % (from_location,
646
raise BzrCommandError(msg)
648
merge((to_location, -1), (to_location, 0), this_dir=to_location,
649
check_clean=False, ignore_zero=True)
650
from_location = pull_loc(br_from)
651
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
580
656
def pull_loc(branch):
778
860
"""List files modified in working tree."""
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)
863
from bzrlib.diff import compare_trees
866
td = compare_trees(b.basis_tree(), b.working_tree())
868
for path, id, kind in td.modified:
839
907
-r revision requests a specific revision, -r :end or -r begin: are
910
--message allows you to give a regular expression, which will be evaluated
911
so that only matching entries will be displayed.
842
913
TODO: Make --revision support uuid: and hash: [future tag:] notation.
846
917
takes_args = ['filename?']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
918
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
849
920
def run(self, filename=None, timezone='original',
854
from bzrlib import show_log, find_branch
927
from bzrlib.branch import find_branch
928
from bzrlib.log import log_formatter, show_log
857
931
direction = (forward and 'forward') or 'reverse'
1040
1130
If no revision is specified this exports the last committed revision.
1042
1132
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1043
given, exports to a directory (equivalent to --format=dir)."""
1133
given, try to find the format with the extension. If no extension
1134
is found exports to a directory (equivalent to --format=dir).
1136
Root may be the top directory for tar, tgz and tbz2 formats. If none
1137
is given, the top directory will be the root name of the file."""
1044
1138
# TODO: list known exporters
1045
1139
takes_args = ['dest']
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1140
takes_options = ['revision', 'format', 'root']
1141
def run(self, dest, revision=None, format=None, root=None):
1143
b = find_branch('.')
1144
if revision is None:
1145
rev_id = b.last_patch()
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1147
if len(revision) != 1:
1148
raise BzrError('bzr export --revision takes exactly 1 argument')
1149
revno, rev_id = b.get_revision_info(revision[0])
1150
t = b.revision_tree(rev_id)
1151
root, ext = os.path.splitext(dest)
1153
if ext in (".tar",):
1155
elif ext in (".gz", ".tgz"):
1157
elif ext in (".bz2", ".tbz2"):
1161
t.export(dest, format, root)
1057
1164
class cmd_cat(Command):
1091
1202
TODO: Strict commit that fails if there are unknown or deleted files.
1093
1204
takes_args = ['selected*']
1094
takes_options = ['message', 'file', 'verbose']
1205
takes_options = ['message', 'file', 'verbose', 'unchanged']
1095
1206
aliases = ['ci', 'checkin']
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1208
# TODO: Give better message for -s, --summary, used by tla people
1210
def run(self, message=None, file=None, verbose=True, selected_list=None,
1212
from bzrlib.errors import PointlessCommit
1213
from bzrlib.osutils import get_text_message
1100
1215
## Warning: shadows builtin file()
1101
1216
if not message and not file:
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1217
# FIXME: Ugly; change status code to send to a provided function?
1221
catcher = cStringIO.StringIO()
1222
sys.stdout = catcher
1223
cmd_status({"file_list":selected_list}, {})
1224
info = catcher.getvalue()
1226
message = get_text_message(info)
1229
raise BzrCommandError("please specify a commit message",
1230
["use either --message or --file"])
1104
1231
elif message and file:
1105
1232
raise BzrCommandError("please specify either --message or --file")
1122
1260
to help ensure data consistency.
1124
1262
takes_args = ['dir?']
1125
takes_options = ['update']
1127
def run(self, dir='.', update=False):
1129
bzrlib.check.check(Branch(dir), update=update)
1264
def run(self, dir='.'):
1265
from bzrlib.check import check
1266
check(find_branch(dir))
1270
class cmd_scan_cache(Command):
1273
from bzrlib.hashcache import HashCache
1280
print '%6d stats' % c.stat_count
1281
print '%6d in hashcache' % len(c._cache)
1282
print '%6d files removed from cache' % c.removed_count
1283
print '%6d hashes updated' % c.update_count
1284
print '%6d files changed too recently to cache' % c.danger_count
1291
class cmd_upgrade(Command):
1292
"""Upgrade branch storage to current format.
1294
This should normally be used only after the check command tells
1297
takes_args = ['dir?']
1299
def run(self, dir='.'):
1300
from bzrlib.upgrade import upgrade
1301
upgrade(find_branch(dir))
1333
1539
>>> parse_args('commit --message=biter'.split())
1334
1540
(['commit'], {'message': u'biter'})
1335
1541
>>> parse_args('log -r 500'.split())
1336
(['log'], {'revision': 500})
1337
>>> parse_args('log -r500:600'.split())
1542
(['log'], {'revision': [500]})
1543
>>> parse_args('log -r500..600'.split())
1338
1544
(['log'], {'revision': [500, 600]})
1339
>>> parse_args('log -vr500:600'.split())
1545
>>> parse_args('log -vr500..600'.split())
1340
1546
(['log'], {'verbose': True, 'revision': [500, 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
1547
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1548
(['log'], {'revision': ['v500', 600]})
1468
1672
This is similar to main(), but without all the trappings for
1469
1673
logging and error handling.
1676
The command-line arguments, without the program name from argv[0]
1678
Returns a command status or raises an exception.
1680
Special master options: these must come before the command because
1681
they control how the command is interpreted.
1684
Do not load plugin modules at all
1687
Only use builtin commands. (Plugins are still allowed to change
1691
Run under the Python profiler.
1471
1694
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1696
opt_profile = opt_no_plugins = opt_builtin = False
1698
# --no-plugins is handled specially at a very early stage. We need
1699
# to load plugins before doing other command parsing so that they
1700
# can override commands, but this needs to happen first.
1703
if a == '--profile':
1705
elif a == '--no-plugins':
1706
opt_no_plugins = True
1707
elif a == '--builtin':
1713
if not opt_no_plugins:
1714
from bzrlib.plugin import load_plugins
1717
args, opts = parse_args(argv)
1720
from bzrlib.help import help
1727
if 'version' in opts:
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
1489
cmd = str(args.pop(0))
1732
print >>sys.stderr, "please try 'bzr help' for help"
1496
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1499
if 'profile' in opts:
1735
cmd = str(args.pop(0))
1737
canonical_cmd, cmd_class = \
1738
get_cmd_class(cmd, plugins_override=not opt_builtin)
1505
1740
# check options are reasonable
1506
1741
allowed = cmd_class.takes_options