« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 623
- compare with another revision
- download diff
- download tarball
- view history from revision 623
- Committer: Martin Pool
- Date: 2005-06-06 04:47:33 UTC
- Revision ID: mbp@sourcefrog.net-20050606044733-e902b05ac1747cd2
- fix invocation of testbzr when giving explicit bzr location
- files removed:
- bzr-man.py
- bzrlib/selftest
- plugins
- plugins/changeset
- files renamed:
- bzrlib/selftest/__init__.py => bzrlib/selftest.py
- bzrlib/selftest/whitebox.py => bzrlib/whitebox.py
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
20
20
21
21
import bzrlib
22
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
24
from bzrlib.osutils import quotefn
25
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
26
26
format_date
27
27
28
28
29
plugin_cmds = {}
30
31
32
def register_command(cmd):
33
"Utility function to help register a command"
34
global plugin_cmds
35
k = cmd.__name__
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
38
else:
39
k_unsquished = k
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
42
else:
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
45
46
47
29
def _squish_command_name(cmd):
48
30
return 'cmd_' + cmd.replace('-', '_')
49
31
86
68
revs = int(revstr)
87
69
return revs
88
70
89
90
91
def _get_cmd_dict(plugins_override=True):
92
d = {}
71
def get_all_cmds():
72
"""Return canonical name and class for all registered commands."""
93
73
for k, v in globals().iteritems():
94
74
if k.startswith("cmd_"):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
97
if plugins_override:
98
d.update(plugin_cmds)
99
else:
100
d2 = plugin_cmds.copy()
101
d2.update(d)
102
d = d2
103
return d
104
105
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():
109
yield k,v
110
111
112
def get_cmd_class(cmd, plugins_override=True):
75
yield _unsquish_command_name(k), v
76
77
def get_cmd_class(cmd):
113
78
"""Return the canonical name and command class for a command.
114
79
"""
115
80
cmd = str(cmd) # not unicode
116
81
117
82
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
83
try:
120
return cmd, cmds[cmd]
84
return cmd, globals()[_squish_command_name(cmd)]
121
85
except KeyError:
122
86
pass
123
87
124
88
# look for any command which claims this as an alias
125
for cmdname, cmdclass in cmds.iteritems():
89
for cmdname, cmdclass in get_all_cmds():
126
90
if cmd in cmdclass.aliases:
127
91
return cmdname, cmdclass
128
92
201
165
import os.path
202
166
bzrpath = os.environ.get('BZRPATH', '')
203
167
204
for dir in bzrpath.split(os.pathsep):
168
for dir in bzrpath.split(':'):
205
169
path = os.path.join(dir, cmd)
206
170
if os.path.isfile(path):
207
171
return ExternalCommand(path)
213
177
def __init__(self, path):
214
178
self.path = path
215
179
180
# TODO: If either of these fail, we should detect that and
181
# assume that path is not really a bzr plugin after all.
182
216
183
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
184
self.takes_options = pipe.readline().split()
218
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
222
% (opt, path))
223
224
# TODO: Is there any way to check takes_args is valid here?
225
185
self.takes_args = pipe.readline().split()
226
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
186
pipe.close()
229
187
230
188
pipe = os.popen('%s --bzr-help' % path, 'r')
231
189
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
190
pipe.close()
234
191
235
192
def __call__(self, options, arguments):
236
193
Command.__init__(self, options, arguments)
243
200
keys = kargs.keys()
244
201
keys.sort()
245
202
for name in keys:
246
optname = name.replace('_','-')
247
203
value = kargs[name]
248
if OPTIONS.has_key(optname):
204
if OPTIONS.has_key(name):
249
205
# it's an option
250
opts.append('--%s' % optname)
206
opts.append('--%s' % name)
251
207
if value is not None and value is not True:
252
208
opts.append(str(value))
253
209
else:
363
319
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
364
320
365
321
366
367
class cmd_mkdir(Command):
368
"""Create a new versioned directory.
369
370
This is equivalent to creating the directory and then adding it.
371
"""
372
takes_args = ['dir+']
373
374
def run(self, dir_list):
375
import os
376
import bzrlib.branch
377
378
b = None
379
380
for d in dir_list:
381
os.mkdir(d)
382
if not b:
383
b = bzrlib.branch.Branch(d)
384
b.add([d], verbose=True)
385
386
387
322
class cmd_relpath(Command):
388
323
"""Show path of a file relative to root"""
389
324
takes_args = ['filename']
449
384
450
385
451
386
452
453
454
class cmd_pull(Command):
455
"""Pull any changes from another branch into the current one.
456
457
If the location is omitted, the last-used location will be used.
458
Both the revision history and the working directory will be
459
updated.
460
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.
464
465
If branches have diverged, you can use 'bzr merge' to pull the text changes
466
from one into the other.
467
"""
468
takes_args = ['location?']
469
470
def run(self, location=None):
471
from bzrlib.merge import merge
472
import errno
473
474
br_to = Branch('.')
475
stored_loc = None
476
try:
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
478
except IOError, e:
479
if errno == errno.ENOENT:
480
raise
481
if location is None:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
484
else:
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
from branch import find_branch, DivergedBranches
488
br_from = find_branch(location)
489
location = pull_loc(br_from)
490
old_revno = br_to.revno()
491
try:
492
br_to.update_revisions(br_from)
493
except DivergedBranches:
494
raise BzrCommandError("These branches have diverged. Try merge.")
495
496
merge(('.', -1), ('.', old_revno), check_clean=False)
497
if location != stored_loc:
498
br_to.controlfile("x-pull", "wb").write(location + "\n")
499
500
501
502
class cmd_branch(Command):
503
"""Create a new copy of a branch.
504
505
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
506
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
507
508
To retrieve the branch as of a particular revision, supply the --revision
509
parameter, as in "branch foo/bar -r 5".
510
"""
511
takes_args = ['from_location', 'to_location?']
512
takes_options = ['revision']
513
514
def run(self, from_location, to_location=None, revision=None):
515
import errno
516
from bzrlib.merge import merge
517
from branch import find_branch, DivergedBranches, NoSuchRevision
518
from shutil import rmtree
519
try:
520
br_from = find_branch(from_location)
521
except OSError, e:
522
if e.errno == errno.ENOENT:
523
raise BzrCommandError('Source location "%s" does not exist.' %
524
to_location)
525
else:
526
raise
527
528
if to_location is None:
529
to_location = os.path.basename(from_location.rstrip("/\\"))
530
531
try:
532
os.mkdir(to_location)
533
except OSError, e:
534
if e.errno == errno.EEXIST:
535
raise BzrCommandError('Target directory "%s" already exists.' %
536
to_location)
537
if e.errno == errno.ENOENT:
538
raise BzrCommandError('Parent of "%s" does not exist.' %
539
to_location)
540
else:
541
raise
542
br_to = Branch(to_location, init=True)
543
544
try:
545
br_to.update_revisions(br_from, stop_revision=revision)
546
except NoSuchRevision:
547
rmtree(to_location)
548
msg = "The branch %s has no revision %d." % (from_location,
549
revision)
550
raise BzrCommandError(msg)
551
merge((to_location, -1), (to_location, 0), this_dir=to_location,
552
check_clean=False, ignore_zero=True)
553
from_location = pull_loc(br_from)
554
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
555
556
557
def pull_loc(branch):
558
# TODO: Should perhaps just make attribute be 'base' in
559
# RemoteBranch and Branch?
560
if hasattr(branch, "baseurl"):
561
return branch.baseurl
562
else:
563
return branch.base
564
565
566
567
387
class cmd_renames(Command):
568
388
"""Show list of renamed files.
569
389
623
443
b = Branch(filename)
624
444
i = b.inventory.path2id(b.relpath(filename))
625
445
if i == None:
626
raise BzrError("%r is not a versioned file" % filename)
446
bailout("%r is not a versioned file" % filename)
627
447
else:
628
448
print i
629
449
640
460
inv = b.inventory
641
461
fid = inv.path2id(b.relpath(filename))
642
462
if fid == None:
643
raise BzrError("%r is not a versioned file" % filename)
463
bailout("%r is not a versioned file" % filename)
644
464
for fip in inv.get_idpath(fid):
645
465
print fip
646
466
706
526
707
527
takes_args = ['file*']
708
528
takes_options = ['revision', 'diff-options']
709
aliases = ['di', 'dif']
529
aliases = ['di']
710
530
711
531
def run(self, revision=None, file_list=None, diff_options=None):
712
532
from bzrlib.diff import show_diff
914
734
915
735
916
736
class cmd_unknowns(Command):
917
"""List unknown files."""
737
"""List unknown files"""
918
738
def run(self):
919
739
for f in Branch('.').unknowns():
920
740
print quotefn(f)
922
742
923
743
924
744
class cmd_ignore(Command):
925
"""Ignore a command or pattern.
745
"""Ignore a command or pattern
926
746
927
747
To remove patterns from the ignore list, edit the .bzrignore file.
928
748
1014
834
class cmd_export(Command):
1015
835
"""Export past revision to destination directory.
1016
836
1017
If no revision is specified this exports the last committed revision.
1018
1019
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1020
given, exports to a directory (equivalent to --format=dir)."""
1021
# TODO: list known exporters
837
If no revision is specified this exports the last committed revision."""
1022
838
takes_args = ['dest']
1023
takes_options = ['revision', 'format']
1024
def run(self, dest, revision=None, format='dir'):
839
takes_options = ['revision']
840
def run(self, dest, revision=None):
1025
841
b = Branch('.')
1026
842
if revision == None:
1027
843
rh = b.revision_history()[-1]
1028
844
else:
1029
845
rh = b.lookup_revision(int(revision))
1030
846
t = b.revision_tree(rh)
1031
t.export(dest, format)
847
t.export(dest)
1032
848
1033
849
1034
850
class cmd_cat(Command):
1094
910
1095
911
This command checks various invariants about the branch storage to
1096
912
detect data corruption or bzr bugs.
1097
1098
If given the --update flag, it will update some optional fields
1099
to help ensure data consistency.
1100
913
"""
1101
914
takes_args = ['dir?']
1102
1103
915
def run(self, dir='.'):
1104
916
import bzrlib.check
1105
917
bzrlib.check.check(Branch(dir))
1106
918
1107
919
1108
920
1109
class cmd_upgrade(Command):
1110
"""Upgrade branch storage to current format.
1111
1112
This should normally be used only after the check command tells
1113
you to run it.
1114
"""
1115
takes_args = ['dir?']
1116
1117
def run(self, dir='.'):
1118
from bzrlib.upgrade import upgrade
1119
upgrade(Branch(dir))
1120
1121
1122
1123
921
class cmd_whoami(Command):
1124
922
"""Show bzr user id."""
1125
923
takes_options = ['email']
1136
934
hidden = True
1137
935
def run(self):
1138
936
from bzrlib.selftest import selftest
1139
return int(not selftest())
937
if selftest():
938
return 0
939
else:
940
return 1
941
1140
942
1141
943
1142
944
class cmd_version(Command):
1143
"""Show version of bzr."""
945
"""Show version of bzr"""
1144
946
def run(self):
1145
947
show_version()
1146
948
1189
991
parsed = [spec, None]
1190
992
return parsed
1191
993
1192
1193
1194
994
class cmd_merge(Command):
1195
995
"""Perform a three-way merge of trees.
1196
996
1209
1009
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1210
1010
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1211
1011
as the BASE.
1212
1213
merge refuses to run if there are any uncommitted changes, unless
1214
--force is given.
1215
1012
"""
1216
1013
takes_args = ['other_spec', 'base_spec?']
1217
takes_options = ['force']
1218
1014
1219
def run(self, other_spec, base_spec=None, force=False):
1015
def run(self, other_spec, base_spec=None):
1220
1016
from bzrlib.merge import merge
1221
merge(parse_spec(other_spec), parse_spec(base_spec),
1222
check_clean=(not force))
1017
merge(parse_spec(other_spec), parse_spec(base_spec))
1223
1018
1224
1019
1225
1020
class cmd_revert(Command):
1226
"""Reverse all changes since the last commit.
1227
1228
Only versioned files are affected.
1229
1230
TODO: Store backups of any files that will be reverted, so
1231
that the revert can be undone.
1021
"""
1022
Reverse all changes since the last commit. Only versioned files are
1023
affected.
1232
1024
"""
1233
1025
takes_options = ['revision']
1234
1026
1235
1027
def run(self, revision=-1):
1236
from bzrlib.merge import merge
1237
merge(('.', revision), parse_spec('.'),
1238
check_clean=False,
1239
ignore_zero=True)
1028
merge.merge(('.', revision), parse_spec('.'), no_changes=False,
1029
ignore_zero=True)
1240
1030
1241
1031
1242
1032
class cmd_assert_fail(Command):
1270
1060
1271
1061
1272
1062
1273
class cmd_plugins(Command):
1274
"""List plugins"""
1275
hidden = True
1276
def run(self):
1277
import bzrlib.plugin
1278
from pprint import pprint
1279
pprint(bzrlib.plugin.all_plugins)
1280
1281
1282
1283
1063
# list of all available options; the rhs can be either None for an
1284
1064
# option that takes no argument, or a constructor function that checks
1285
1065
# the type.
1288
1068
'diff-options': str,
1289
1069
'help': None,
1290
1070
'file': unicode,
1291
'force': None,
1292
'format': unicode,
1293
1071
'forward': None,
1294
1072
'message': unicode,
1295
1073
'no-recurse': None,
1300
1078
'verbose': None,
1301
1079
'version': None,
1302
1080
'email': None,
1303
'update': None,
1304
1081
}
1305
1082
1306
1083
SHORT_OPTIONS = {
1328
1105
(['status'], {'all': True})
1329
1106
>>> parse_args('commit --message=biter'.split())
1330
1107
(['commit'], {'message': u'biter'})
1331
>>> parse_args('log -r 500'.split())
1332
(['log'], {'revision': 500})
1333
>>> parse_args('log -r500:600'.split())
1334
(['log'], {'revision': [500, 600]})
1335
>>> parse_args('log -vr500:600'.split())
1336
(['log'], {'verbose': True, 'revision': [500, 600]})
1337
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1338
Traceback (most recent call last):
1339
...
1340
ValueError: invalid literal for int(): v500
1341
1108
"""
1342
1109
args = []
1343
1110
opts = {}
1357
1124
else:
1358
1125
optname = a[2:]
1359
1126
if optname not in OPTIONS:
1360
raise BzrError('unknown long option %r' % a)
1127
bailout('unknown long option %r' % a)
1361
1128
else:
1362
1129
shortopt = a[1:]
1363
if shortopt in SHORT_OPTIONS:
1364
# Multi-character options must have a space to delimit
1365
# their value
1366
optname = SHORT_OPTIONS[shortopt]
1367
else:
1368
# Single character short options, can be chained,
1369
# and have their value appended to their name
1370
shortopt = a[1:2]
1371
if shortopt not in SHORT_OPTIONS:
1372
# We didn't find the multi-character name, and we
1373
# didn't find the single char name
1374
raise BzrError('unknown short option %r' % a)
1375
optname = SHORT_OPTIONS[shortopt]
1376
1377
if a[2:]:
1378
# There are extra things on this option
1379
# see if it is the value, or if it is another
1380
# short option
1381
optargfn = OPTIONS[optname]
1382
if optargfn is None:
1383
# This option does not take an argument, so the
1384
# next entry is another short option, pack it back
1385
# into the list
1386
argv.insert(0, '-' + a[2:])
1387
else:
1388
# This option takes an argument, so pack it
1389
# into the array
1390
optarg = a[2:]
1130
if shortopt not in SHORT_OPTIONS:
1131
bailout('unknown short option %r' % a)
1132
optname = SHORT_OPTIONS[shortopt]
1391
1133
1392
1134
if optname in opts:
1393
1135
# XXX: Do we ever want to support this, e.g. for -r?
1394
raise BzrError('repeated option %r' % a)
1136
bailout('repeated option %r' % a)
1395
1137
1396
1138
optargfn = OPTIONS[optname]
1397
1139
if optargfn:
1398
1140
if optarg == None:
1399
1141
if not argv:
1400
raise BzrError('option %r needs an argument' % a)
1142
bailout('option %r needs an argument' % a)
1401
1143
else:
1402
1144
optarg = argv.pop(0)
1403
1145
opts[optname] = optargfn(optarg)
1404
1146
else:
1405
1147
if optarg != None:
1406
raise BzrError('option %r takes no argument' % optname)
1148
bailout('option %r takes no argument' % optname)
1407
1149
opts[optname] = True
1408
1150
else:
1409
1151
args.append(a)
1457
1199
return argdict
1458
1200
1459
1201
1460
def _parse_master_args(argv):
1461
"""Parse the arguments that always go with the original command.
1462
These are things like bzr --no-plugins, etc.
1463
1464
There are now 2 types of option flags. Ones that come *before* the command,
1465
and ones that come *after* the command.
1466
Ones coming *before* the command are applied against all possible commands.
1467
And are generally applied before plugins are loaded.
1468
1469
The current list are:
1470
--builtin Allow plugins to load, but don't let them override builtin commands,
1471
they will still be allowed if they do not override a builtin.
1472
--no-plugins Don't load any plugins. This lets you get back to official source
1473
behavior.
1474
--profile Enable the hotspot profile before running the command.
1475
For backwards compatibility, this is also a non-master option.
1476
--version Spit out the version of bzr that is running and exit.
1477
This is also a non-master option.
1478
--help Run help and exit, also a non-master option (I think that should stay, though)
1479
1480
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1481
Traceback (most recent call last):
1482
...
1483
BzrCommandError: Invalid master option: 'test'
1484
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1485
>>> print argv
1486
['command']
1487
>>> print opts['version']
1488
True
1489
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1490
>>> print argv
1491
['command', '--more-options']
1492
>>> print opts['profile']
1493
True
1494
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1495
>>> print argv
1496
['command']
1497
>>> print opts['no-plugins']
1498
True
1499
>>> print opts['profile']
1500
False
1501
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1502
>>> print argv
1503
['command', '--profile']
1504
>>> print opts['profile']
1505
False
1506
"""
1507
master_opts = {'builtin':False,
1508
'no-plugins':False,
1509
'version':False,
1510
'profile':False,
1511
'help':False
1512
}
1513
1514
# This is the point where we could hook into argv[0] to determine
1515
# what front-end is supposed to be run
1516
# For now, we are just ignoring it.
1517
cmd_name = argv.pop(0)
1518
for arg in argv[:]:
1519
if arg[:2] != '--': # at the first non-option, we return the rest
1520
break
1521
arg = arg[2:] # Remove '--'
1522
if arg not in master_opts:
1523
# We could say that this is not an error, that we should
1524
# just let it be handled by the main section instead
1525
raise BzrCommandError('Invalid master option: %r' % arg)
1526
argv.pop(0) # We are consuming this entry
1527
master_opts[arg] = True
1528
return argv, master_opts
1529
1530
1531
1202
1532
1203
def run_bzr(argv):
1533
1204
"""Execute a command.
1538
1209
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1539
1210
1540
1211
try:
1541
# some options like --builtin and --no-plugins have special effects
1542
argv, master_opts = _parse_master_args(argv)
1543
if not master_opts['no-plugins']:
1544
bzrlib.load_plugins()
1545
1546
args, opts = parse_args(argv)
1547
1548
if master_opts['help']:
1549
from bzrlib.help import help
1550
if argv:
1551
help(argv[0])
1552
else:
1553
help()
1554
return 0
1555
1212
args, opts = parse_args(argv[1:])
1556
1213
if 'help' in opts:
1557
from bzrlib.help import help
1214
import help
1558
1215
if args:
1559
help(args[0])
1216
help.help(args[0])
1560
1217
else:
1561
help()
1218
help.help()
1562
1219
return 0
1563
1220
elif 'version' in opts:
1564
1221
show_version()
1565
1222
return 0
1566
elif args and args[0] == 'builtin':
1567
include_plugins=False
1568
args = args[1:]
1569
1223
cmd = str(args.pop(0))
1570
1224
except IndexError:
1571
1225
import help
1573
1227
return 1
1574
1228
1575
1229
1576
plugins_override = not (master_opts['builtin'])
1577
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1230
canonical_cmd, cmd_class = get_cmd_class(cmd)
1578
1231
1579
profile = master_opts['profile']
1580
# For backwards compatibility, I would rather stick with --profile being a
1581
# master/global option
1232
# global option
1582
1233
if 'profile' in opts:
1583
1234
profile = True
1584
1235
del opts['profile']
1236
else:
1237
profile = False
1585
1238
1586
1239
# check options are reasonable
1587
1240
allowed = cmd_class.takes_options
Loggerhead is a web-based interface for Breezy
Version: 2.0.1