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
22
from bzrlib.trace import mutter, note, log_error, warning
141
136
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
140
def _get_cmd_dict(plugins_override=True):
256
237
class ExternalCommand(Command):
257
238
"""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
240
We cheat a little here, when get_cmd_class() calls us we actually give it back
241
an object we construct that has the appropriate path, help, options etc for the
244
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
245
method, which we override to call the Command.__init__ method. That then calls
246
our run method which is pretty straight forward.
248
The only wrinkle is that we have to map bzr's dictionary of options and arguments
249
back into command line options and arguments for the script.
273
252
def find_command(cls, cmd):
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
533
class cmd_pull(Command):
654
601
takes_args = ['from_location', 'to_location?']
655
602
takes_options = ['revision']
656
aliases = ['get', 'clone']
658
604
def run(self, from_location, to_location=None, revision=None):
660
606
from bzrlib.merge import merge
661
from bzrlib.branch import DivergedBranches, \
607
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
662
608
find_cached_branch, Branch
663
609
from shutil import rmtree
664
610
from meta_store import CachedStore
889
832
b = find_branch('.')
834
# TODO: Make show_diff support taking 2 arguments
891
836
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)
837
if len(revision) != 1:
838
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
839
base_rev = revision[0]
841
show_diff(b, base_rev, specific_files=file_list,
842
external_diff_options=diff_options)
989
929
takes_args = ['filename?']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
'long', 'message', 'short',]
930
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
993
932
def run(self, filename=None, timezone='original',
1261
1199
class cmd_commit(Command):
1262
1200
"""Commit changes into a new revision.
1264
If no arguments are given, the entire tree is committed.
1266
1202
If selected files are specified, only changes to those files are
1267
committed. If a directory is specified then the directory and everything
1268
within it is committed.
1203
committed. If a directory is specified then its contents are also
1270
1206
A selected-file commit may fail in some cases where the committed
1271
1207
tree would be invalid, such as trying to commit a file in a
1279
1215
takes_options = ['message', 'file', 'verbose', 'unchanged']
1280
1216
aliases = ['ci', 'checkin']
1282
# TODO: Give better message for -s, --summary, used by tla people
1284
1218
def run(self, message=None, file=None, verbose=True, selected_list=None,
1285
1219
unchanged=False):
1286
1220
from bzrlib.errors import PointlessCommit
1457
1387
class cmd_merge(Command):
1458
"""Perform a three-way merge.
1460
The branch is the branch you will merge from. By default, it will merge
1461
the latest revision. If you specify a revision, that revision will be
1462
merged. If you specify two revisions, the first will be used as a BASE,
1463
and the second one as OTHER. Revision numbers are always relative to the
1468
To merge the latest revision from bzr.dev
1469
bzr merge ../bzr.dev
1471
To merge changes up to and including revision 82 from bzr.dev
1472
bzr merge -r 82 ../bzr.dev
1474
To merge the changes introduced by 82, without previous changes:
1475
bzr merge -r 81..82 ../bzr.dev
1388
"""Perform a three-way merge of trees.
1390
The SPEC parameters are working tree or revision specifiers. Working trees
1391
are specified using standard paths or urls. No component of a directory
1392
path may begin with '@'.
1394
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1396
Revisions are specified using a dirname/@revno pair, where dirname is the
1397
branch directory and revno is the revision within that branch. If no revno
1398
is specified, the latest revision is used.
1400
Revision examples: './@127', 'foo/@', '../@1'
1402
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1403
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1477
1406
merge refuses to run if there are any uncommitted changes, unless
1478
1407
--force is given.
1480
takes_args = ['branch?']
1481
takes_options = ['revision', 'force', 'merge-type']
1409
takes_args = ['other_spec', 'base_spec?']
1410
takes_options = ['force', 'merge-type']
1483
def run(self, branch='.', revision=None, force=False,
1412
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1485
1413
from bzrlib.merge import merge
1486
1414
from bzrlib.merge_core import ApplyMerge3
1487
1415
if merge_type is None:
1488
1416
merge_type = ApplyMerge3
1490
if revision is None or len(revision) < 1:
1492
other = (branch, -1)
1494
if len(revision) == 1:
1495
other = (branch, revision[0])
1498
assert len(revision) == 2
1499
if None in revision:
1500
raise BzrCommandError(
1501
"Merge doesn't permit that revision specifier.")
1502
base = (branch, revision[0])
1503
other = (branch, revision[1])
1505
merge(other, base, check_clean=(not force), merge_type=merge_type)
1417
merge(parse_spec(other_spec), parse_spec(base_spec),
1418
check_clean=(not force), merge_type=merge_type)
1508
1421
class cmd_revert(Command):
1556
class cmd_missing(Command):
1557
"""What is missing in this branch relative to other branch.
1559
takes_args = ['remote?']
1560
aliases = ['mis', 'miss']
1561
# We don't have to add quiet to the list, because
1562
# unknown options are parsed as booleans
1563
takes_options = ['verbose', 'quiet']
1565
def run(self, remote=None, verbose=False, quiet=False):
1566
from bzrlib.branch import find_branch, DivergedBranches
1567
from bzrlib.errors import BzrCommandError
1568
from bzrlib.missing import get_parent, show_missing
1570
if verbose and quiet:
1571
raise BzrCommandError('Cannot pass both quiet and verbose')
1573
b = find_branch('.')
1574
parent = get_parent(b)
1577
raise BzrCommandError("No missing location known or specified.")
1580
print "Using last location: %s" % parent
1582
elif parent is None:
1583
# We only update x-pull if it did not exist, missing should not change the parent
1584
b.controlfile('x-pull', 'wb').write(remote + '\n')
1585
br_remote = find_branch(remote)
1587
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1590
1469
class cmd_plugins(Command):
1591
1470
"""List plugins"""
1667
def _parse_master_args(argv):
1668
"""Parse the arguments that always go with the original command.
1669
These are things like bzr --no-plugins, etc.
1671
There are now 2 types of option flags. Ones that come *before* the command,
1672
and ones that come *after* the command.
1673
Ones coming *before* the command are applied against all possible commands.
1674
And are generally applied before plugins are loaded.
1676
The current list are:
1677
--builtin Allow plugins to load, but don't let them override builtin commands,
1678
they will still be allowed if they do not override a builtin.
1679
--no-plugins Don't load any plugins. This lets you get back to official source
1681
--profile Enable the hotspot profile before running the command.
1682
For backwards compatibility, this is also a non-master option.
1683
--version Spit out the version of bzr that is running and exit.
1684
This is also a non-master option.
1685
--help Run help and exit, also a non-master option (I think that should stay, though)
1687
>>> argv, opts = _parse_master_args(['--test'])
1688
Traceback (most recent call last):
1690
BzrCommandError: Invalid master option: 'test'
1691
>>> argv, opts = _parse_master_args(['--version', 'command'])
1694
>>> print opts['version']
1696
>>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
1698
['command', '--more-options']
1699
>>> print opts['profile']
1701
>>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
1704
>>> print opts['no-plugins']
1706
>>> print opts['profile']
1708
>>> argv, opts = _parse_master_args(['command', '--profile'])
1710
['command', '--profile']
1711
>>> print opts['profile']
1714
master_opts = {'builtin':False,
1722
if arg[:2] != '--': # at the first non-option, we return the rest
1724
arg = arg[2:] # Remove '--'
1725
if arg not in master_opts:
1726
# We could say that this is not an error, that we should
1727
# just let it be handled by the main section instead
1728
raise BzrCommandError('Invalid master option: %r' % arg)
1729
argv.pop(0) # We are consuming this entry
1730
master_opts[arg] = True
1731
return argv, master_opts
1790
1735
def run_bzr(argv):
1791
1736
"""Execute a command.
1794
1739
logging and error handling.
1797
The command-line arguments, without the program name from argv[0]
1742
The command-line arguments, without the program name.
1799
1744
Returns a command status or raises an exception.
1801
Special master options: these must come before the command because
1802
they control how the command is interpreted.
1805
Do not load plugin modules at all
1808
Only use builtin commands. (Plugins are still allowed to change
1812
Run under the Python profiler.
1815
1746
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1817
opt_profile = opt_no_plugins = opt_builtin = False
1819
# --no-plugins is handled specially at a very early stage. We need
1820
# to load plugins before doing other command parsing so that they
1821
# can override commands, but this needs to happen first.
1824
if a == '--profile':
1826
elif a == '--no-plugins':
1827
opt_no_plugins = True
1828
elif a == '--builtin':
1834
if not opt_no_plugins:
1748
# some options like --builtin and --no-plugins have special effects
1749
argv, master_opts = _parse_master_args(argv)
1750
if not master_opts['no-plugins']:
1835
1751
from bzrlib.plugin import load_plugins
1838
1754
args, opts = parse_args(argv)
1756
if master_opts.get('help') or 'help' in opts:
1841
1757
from bzrlib.help import help
1768
if args and args[0] == 'builtin':
1769
include_plugins=False
1773
cmd = str(args.pop(0))
1853
1775
print >>sys.stderr, "please try 'bzr help' for help"
1856
cmd = str(args.pop(0))
1858
canonical_cmd, cmd_class = \
1859
get_cmd_class(cmd, plugins_override=not opt_builtin)
1778
plugins_override = not (master_opts['builtin'])
1779
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1781
profile = master_opts['profile']
1782
# For backwards compatibility, I would rather stick with --profile being a
1783
# master/global option
1784
if 'profile' in opts:
1861
1788
# check options are reasonable
1862
1789
allowed = cmd_class.takes_options