15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Split the command framework away from the actual commands.
20
# TODO: probably should say which arguments are candidates for glob
21
# expansion on windows and do that at the command level.
27
from bzrlib.trace import mutter, note, log_error, warning
22
from bzrlib.trace import mutter, note, log_error
28
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
36
def register_command(cmd):
32
def register_plugin_command(cmd):
37
33
"Utility function to help register a command"
56
52
assert cmd.startswith("cmd_")
57
53
return cmd[4:].replace('_','-')
60
55
def _parse_revision_str(revstr):
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')
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
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('..'):
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
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)
159
91
def _get_cmd_dict(plugins_override=True):
256
185
class ExternalCommand(Command):
257
186
"""Class to wrap external commands.
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
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
273
200
def find_command(cls, cmd):
370
297
directory is shown. Otherwise, only the status of the specified
371
298
files or directories is reported. If a directory is given, status
372
299
is reported for everything inside that directory.
374
If a revision is specified, the changes since that revision are shown.
376
301
takes_args = ['file*']
377
takes_options = ['all', 'show-ids', 'revision']
302
takes_options = ['all', 'show-ids']
378
303
aliases = ['st', 'stat']
380
305
def run(self, all=False, show_ids=False, file_list=None):
382
b = find_branch(file_list[0])
307
b = Branch(file_list[0])
383
308
file_list = [b.relpath(x) for x in file_list]
384
309
# special case: only one path was given and it's the root
386
311
if file_list == ['']:
391
from bzrlib.status import show_status
392
show_status(b, show_unchanged=all, show_ids=show_ids,
393
specific_files=file_list)
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
396
320
class cmd_cat_revision(Command):
447
348
whether already versioned or not, are searched for files or
448
349
subdirectories that are neither versioned or ignored, and these
449
350
are added. This search proceeds recursively into versioned
450
directories. If no names are given '.' is assumed.
452
Therefore simply saying 'bzr add' will version all files that
353
Therefore simply saying 'bzr add .' will version all files that
453
354
are currently unknown.
455
356
TODO: Perhaps adding a file whose directly is not versioned should
456
357
recursively add that parent, rather than giving an error?
458
takes_args = ['file*']
359
takes_args = ['file+']
459
360
takes_options = ['verbose', 'no-recurse']
461
362
def run(self, file_list, verbose=False, no_recurse=False):
462
from bzrlib.add import smart_add
463
smart_add(file_list, verbose, not no_recurse)
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
545
444
takes_args = ['from_name', 'to_name']
547
446
def run(self, from_name, to_name):
549
448
b.rename_one(b.relpath(from_name), b.relpath(to_name))
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])
586
454
class cmd_pull(Command):
619
485
print "Using last location: %s" % stored_loc
620
486
location = stored_loc
621
cache_root = tempfile.mkdtemp()
622
from bzrlib.branch import DivergedBranches
487
from branch import find_branch, DivergedBranches
623
488
br_from = find_branch(location)
624
489
location = pull_loc(br_from)
625
490
old_revno = br_to.revno()
627
from branch import find_cached_branch, DivergedBranches
628
br_from = find_cached_branch(location, cache_root)
629
location = pull_loc(br_from)
630
old_revno = br_to.revno()
632
br_to.update_revisions(br_from)
633
except DivergedBranches:
634
raise BzrCommandError("These branches have diverged."
637
merge(('.', -1), ('.', old_revno), check_clean=False)
638
if location != stored_loc:
639
br_to.controlfile("x-pull", "wb").write(location + "\n")
492
br_to.update_revisions(br_from)
493
except DivergedBranches:
494
raise BzrCommandError("These branches have diverged. Try merge.")
496
merge(('.', -1), ('.', old_revno), check_clean=False)
497
if location != stored_loc:
498
br_to.controlfile("x-pull", "wb").write(location + "\n")
654
511
takes_args = ['from_location', 'to_location?']
655
512
takes_options = ['revision']
656
aliases = ['get', 'clone']
658
514
def run(self, from_location, to_location=None, revision=None):
660
516
from bzrlib.merge import merge
661
from bzrlib.branch import DivergedBranches, \
662
find_cached_branch, Branch
517
from branch import find_branch, DivergedBranches, NoSuchRevision
663
518
from shutil import rmtree
664
from meta_store import CachedStore
666
cache_root = tempfile.mkdtemp()
670
elif len(revision) > 1:
671
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
675
br_from = find_cached_branch(from_location, cache_root)
677
if e.errno == errno.ENOENT:
678
raise BzrCommandError('Source location "%s" does not'
679
' exist.' % to_location)
683
if to_location is None:
684
to_location = os.path.basename(from_location.rstrip("/\\"))
687
os.mkdir(to_location)
689
if e.errno == errno.EEXIST:
690
raise BzrCommandError('Target directory "%s" already'
691
' exists.' % to_location)
692
if e.errno == errno.ENOENT:
693
raise BzrCommandError('Parent of "%s" does not exist.' %
697
br_to = Branch(to_location, init=True)
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)
714
merge((to_location, -1), (to_location, 0), this_dir=to_location,
715
check_clean=False, ignore_zero=True)
716
from_location = pull_loc(br_from)
717
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
520
br_from = find_branch(from_location)
522
if e.errno == errno.ENOENT:
523
raise BzrCommandError('Source location "%s" does not exist.' %
528
if to_location is None:
529
to_location = os.path.basename(from_location.rstrip("/\\"))
532
os.mkdir(to_location)
534
if e.errno == errno.EEXIST:
535
raise BzrCommandError('Target directory "%s" already exists.' %
537
if e.errno == errno.ENOENT:
538
raise BzrCommandError('Parent of "%s" does not exist.' %
542
br_to = Branch(to_location, init=True)
545
br_to.update_revisions(br_from, stop_revision=revision)
546
except NoSuchRevision:
548
msg = "The branch %s has no revision %d." % (from_location,
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")
722
557
def pull_loc(branch):
886
719
# just pointing to top-of-tree
724
show_diff(b, revision, specific_files=file_list,
725
external_diff_options=diff_options)
891
if revision is not None:
892
if len(revision) == 1:
893
show_diff(b, revision[0], specific_files=file_list,
894
external_diff_options=diff_options)
895
elif len(revision) == 2:
896
show_diff(b, revision[0], specific_files=file_list,
897
external_diff_options=diff_options,
898
revision2=revision[1])
900
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
902
show_diff(b, None, specific_files=file_list,
903
external_diff_options=diff_options)
932
755
"""List files modified in working tree."""
935
from bzrlib.delta import compare_trees
938
td = compare_trees(b.basis_tree(), b.working_tree())
940
for path, id, kind in td.modified:
760
inv = b.read_working_inventory()
761
sc = statcache.update_cache(b, inv)
762
basis = b.basis_tree()
763
basis_inv = basis.inventory
765
# We used to do this through iter_entries(), but that's slow
766
# when most of the files are unmodified, as is usually the
767
# case. So instead we iterate by inventory entry, and only
768
# calculate paths as necessary.
770
for file_id in basis_inv:
771
cacheentry = sc.get(file_id)
772
if not cacheentry: # deleted
774
ie = basis_inv[file_id]
775
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
776
path = inv.id2path(file_id)
979
816
-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.
985
819
TODO: Make --revision support uuid: and hash: [future tag:] notation.
989
823
takes_args = ['filename?']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
'long', 'message', 'short',]
824
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
993
826
def run(self, filename=None, timezone='original',
1001
from bzrlib.branch import find_branch
1002
from bzrlib.log import log_formatter, show_log
831
from bzrlib import show_log, find_branch
1005
834
direction = (forward and 'forward') or 'reverse'
1204
1017
If no revision is specified this exports the last committed revision.
1206
1019
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
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."""
1020
given, exports to a directory (equivalent to --format=dir)."""
1212
1021
# TODO: list known exporters
1213
1022
takes_args = ['dest']
1214
takes_options = ['revision', 'format', 'root']
1215
def run(self, dest, revision=None, format=None, root=None):
1217
b = find_branch('.')
1218
if revision is None:
1219
rev_id = b.last_patch()
1023
takes_options = ['revision', 'format']
1024
def run(self, dest, revision=None, format='dir'):
1026
if revision == None:
1027
rh = b.revision_history()[-1]
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)
1029
rh = b.lookup_revision(int(revision))
1030
t = b.revision_tree(rh)
1031
t.export(dest, format)
1238
1034
class cmd_cat(Command):
1276
1068
TODO: Strict commit that fails if there are unknown or deleted files.
1278
1070
takes_args = ['selected*']
1279
takes_options = ['message', 'file', 'verbose', 'unchanged']
1071
takes_options = ['message', 'file', 'verbose']
1280
1072
aliases = ['ci', 'checkin']
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
1287
from bzrlib.osutils import get_text_message
1074
def run(self, message=None, file=None, verbose=True, selected_list=None):
1075
from bzrlib.commit import commit
1289
1077
## Warning: shadows builtin file()
1290
1078
if not message and not file:
1291
# FIXME: Ugly; change status code to send to a provided function?
1295
catcher = cStringIO.StringIO()
1296
sys.stdout = catcher
1297
cmd_status({"file_list":selected_list}, {})
1298
info = catcher.getvalue()
1300
message = get_text_message(info)
1303
raise BzrCommandError("please specify a commit message",
1304
["use either --message or --file"])
1079
raise BzrCommandError("please specify a commit message",
1080
["use either --message or --file"])
1305
1081
elif message and file:
1306
1082
raise BzrCommandError("please specify either --message or --file")
1310
1086
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1312
b = find_branch('.')
1314
selected_list = [b.relpath(s) for s in selected_list]
1317
b.commit(message, verbose=verbose,
1318
specific_files=selected_list,
1319
allow_pointless=unchanged)
1320
except PointlessCommit:
1321
# FIXME: This should really happen before the file is read in;
1322
# perhaps prepare the commit; get the message; then actually commit
1323
raise BzrCommandError("no changes to commit",
1324
["use --unchanged to commit anyhow"])
1089
commit(b, message, verbose=verbose, specific_files=selected_list)
1327
1092
class cmd_check(Command):
1381
1125
takes_options = ['email']
1383
1127
def run(self, email=False):
1385
b = bzrlib.branch.find_branch('.')
1390
print bzrlib.osutils.user_email(b)
1129
print bzrlib.osutils.user_email()
1392
print bzrlib.osutils.username(b)
1131
print bzrlib.osutils.username()
1395
1134
class cmd_selftest(Command):
1396
1135
"""Run internal test suite"""
1398
takes_options = ['verbose']
1399
def run(self, verbose=False):
1400
1138
from bzrlib.selftest import selftest
1401
return int(not selftest(verbose=verbose))
1139
return int(not selftest())
1404
1142
class cmd_version(Command):
1462
1194
class cmd_merge(Command):
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
1195
"""Perform a three-way merge of trees.
1197
The SPEC parameters are working tree or revision specifiers. Working trees
1198
are specified using standard paths or urls. No component of a directory
1199
path may begin with '@'.
1201
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1203
Revisions are specified using a dirname/@revno pair, where dirname is the
1204
branch directory and revno is the revision within that branch. If no revno
1205
is specified, the latest revision is used.
1207
Revision examples: './@127', 'foo/@', '../@1'
1209
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1210
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1482
1213
merge refuses to run if there are any uncommitted changes, unless
1483
1214
--force is given.
1485
takes_args = ['branch?']
1486
takes_options = ['revision', 'force', 'merge-type']
1216
takes_args = ['other_spec', 'base_spec?']
1217
takes_options = ['force']
1488
def run(self, branch='.', revision=None, force=False,
1219
def run(self, other_spec, base_spec=None, force=False):
1490
1220
from bzrlib.merge import merge
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)
1221
merge(parse_spec(other_spec), parse_spec(base_spec),
1222
check_clean=(not force))
1513
1225
class cmd_revert(Command):
1514
1226
"""Reverse all changes since the last commit.
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.
1228
Only versioned files are affected.
1230
TODO: Store backups of any files that will be reverted, so
1231
that the revert can be undone.
1520
takes_options = ['revision', 'no-backup']
1521
takes_args = ['file*']
1522
aliases = ['merge-revert']
1233
takes_options = ['revision']
1524
def run(self, revision=None, no_backup=False, file_list=None):
1235
def run(self, revision=-1):
1525
1236
from bzrlib.merge import merge
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('.'),
1237
merge(('.', revision), parse_spec('.'),
1534
1238
check_clean=False,
1536
backup_files=not no_backup,
1537
file_list=file_list)
1540
1242
class cmd_assert_fail(Command):
1556
1258
help.help(topic)
1559
class cmd_shell_complete(Command):
1560
"""Show appropriate completions for context.
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')
1589
b = find_branch('.')
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)
1606
class cmd_plugins(Command):
1261
class cmd_update_stat_cache(Command):
1262
"""Update stat-cache mapping inodes to SHA-1 hashes.
1264
For testing only."""
1610
import bzrlib.plugin
1611
from inspect import getdoc
1612
from pprint import pprint
1613
for plugin in bzrlib.plugin.all_plugins:
1614
print plugin.__path__[0]
1617
print '\t', d.split('\n')[0]
1619
#pprint(bzrlib.plugin.all_plugins)
1269
statcache.update_cache(b.base, b.read_working_inventory())
1676
1319
>>> parse_args('commit --message=biter'.split())
1677
1320
(['commit'], {'message': u'biter'})
1678
1321
>>> parse_args('log -r 500'.split())
1679
(['log'], {'revision': [500]})
1680
>>> parse_args('log -r500..600'.split())
1322
(['log'], {'revision': 500})
1323
>>> parse_args('log -r500:600'.split())
1681
1324
(['log'], {'revision': [500, 600]})
1682
>>> parse_args('log -vr500..600'.split())
1325
>>> parse_args('log -vr500:600'.split())
1683
1326
(['log'], {'verbose': True, 'revision': [500, 600]})
1684
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1685
(['log'], {'revision': ['v500', 600]})
1327
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1328
Traceback (most recent call last):
1330
ValueError: invalid literal for int(): v500
1450
def _parse_master_args(argv):
1451
"""Parse the arguments that always go with the original command.
1452
These are things like bzr --no-plugins, etc.
1454
There are now 2 types of option flags. Ones that come *before* the command,
1455
and ones that come *after* the command.
1456
Ones coming *before* the command are applied against all possible commands.
1457
And are generally applied before plugins are loaded.
1459
The current list are:
1460
--builtin Allow plugins to load, but don't let them override builtin commands,
1461
they will still be allowed if they do not override a builtin.
1462
--no-plugins Don't load any plugins. This lets you get back to official source
1464
--profile Enable the hotspot profile before running the command.
1465
For backwards compatibility, this is also a non-master option.
1466
--version Spit out the version of bzr that is running and exit.
1467
This is also a non-master option.
1468
--help Run help and exit, also a non-master option (I think that should stay, though)
1470
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1471
Traceback (most recent call last):
1473
BzrCommandError: Invalid master option: 'test'
1474
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1477
>>> print opts['version']
1479
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1481
['command', '--more-options']
1482
>>> print opts['profile']
1484
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1487
>>> print opts['no-plugins']
1489
>>> print opts['profile']
1491
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1493
['command', '--profile']
1494
>>> print opts['profile']
1497
master_opts = {'builtin':False,
1504
# This is the point where we could hook into argv[0] to determine
1505
# what front-end is supposed to be run
1506
# For now, we are just ignoring it.
1507
cmd_name = argv.pop(0)
1509
if arg[:2] != '--': # at the first non-option, we return the rest
1511
arg = arg[2:] # Remove '--'
1512
if arg not in master_opts:
1513
# We could say that this is not an error, that we should
1514
# just let it be handled by the main section instead
1515
raise BzrCommandError('Invalid master option: %r' % arg)
1516
argv.pop(0) # We are consuming this entry
1517
master_opts[arg] = True
1518
return argv, master_opts
1806
1522
def run_bzr(argv):
1807
1523
"""Execute a command.
1809
1525
This is similar to main(), but without all the trappings for
1810
1526
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.
1831
1528
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:
1869
print >>sys.stderr, "please try 'bzr help' for help"
1531
# some options like --builtin and --no-plugins have special effects
1532
argv, master_opts = _parse_master_args(argv)
1533
if 'no-plugins' not in master_opts:
1534
bzrlib.load_plugins()
1536
args, opts = parse_args(argv)
1538
if master_opts['help']:
1539
from bzrlib.help import help
1547
from bzrlib.help import help
1553
elif 'version' in opts:
1556
elif args and args[0] == 'builtin':
1557
include_plugins=False
1559
cmd = str(args.pop(0))
1872
cmd = str(args.pop(0))
1874
canonical_cmd, cmd_class = \
1875
get_cmd_class(cmd, plugins_override=not opt_builtin)
1566
plugins_override = not (master_opts['builtin'])
1567
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1569
profile = master_opts['profile']
1570
# For backwards compatibility, I would rather stick with --profile being a
1571
# master/global option
1572
if 'profile' in opts:
1877
1576
# check options are reasonable
1878
1577
allowed = cmd_class.takes_options