« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 974.1.19
- compare with another revision
- download diff
- download tarball
- view history from revision 974.1.19
- Committer: Aaron Bentley
- Date: 2005-08-10 17:39:16 UTC
- mto: (1092.1.41) (1185.3.4) (974.1.47)
- mto: This revision was merged to the branch mainline in revision 1110.
- Revision ID: abentley@panoramicfeedback.com-20050810173916-77580019d21a0e82
Removed MergeTree.inventory
- files added:
- plugins/changeset
- files removed:
- HACKING
- bzrlib/util
- contrib/emacs
- files renamed:
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
# TODO: Split the command framework away from the actual commands.
19
20
# TODO: probably should say which arguments are candidates for glob
21
# expansion on windows and do that at the command level.
22
23
import sys
24
import os
18
19
import sys, os
25
20
26
21
import bzrlib
27
22
from bzrlib.trace import mutter, note, log_error, warning
141
136
raise BzrCommandError(msg)
142
137
143
138
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
147
try:
148
return merge_types[typestring][0]
149
except KeyError:
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)
156
157
158
139
159
140
def _get_cmd_dict(plugins_override=True):
160
141
d = {}
256
237
class ExternalCommand(Command):
257
238
"""Class to wrap external commands.
258
239
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.
262
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
266
forward.
267
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
270
script.
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
242
specified command.
243
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.
247
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.
271
250
"""
272
251
273
252
def find_command(cls, cmd):
524
503
def run(self, source_list, dest):
525
504
b = find_branch('.')
526
505
527
# TODO: glob expansion on windows?
528
506
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
529
507
530
508
550
528
551
529
552
530
553
class cmd_mv(Command):
554
"""Move or rename a file.
555
556
usage:
557
bzr mv OLDNAME NEWNAME
558
bzr mv SOURCE... DESTINATION
559
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.
563
564
Files cannot be moved between branches.
565
"""
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])
571
572
rel_names = [b.relpath(x) for x in names_list]
573
574
if os.path.isdir(names_list[-1]):
575
# move into existing directory
576
b.move(rel_names[:-1], rel_names[-1])
577
else:
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])
582
583
584
531
585
532
586
533
class cmd_pull(Command):
653
600
"""
654
601
takes_args = ['from_location', 'to_location?']
655
602
takes_options = ['revision']
656
aliases = ['get', 'clone']
657
603
658
604
def run(self, from_location, to_location=None, revision=None):
659
605
import errno
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
705
651
revno, rev_id = br_from.get_revision_info(revision[0])
706
652
try:
707
653
br_to.update_revisions(br_from, stop_revision=revno)
708
except bzrlib.errors.NoSuchRevision:
654
except NoSuchRevision:
709
655
rmtree(to_location)
710
656
msg = "The branch %s has no revision %d." % (from_location,
711
657
revno)
851
797
If files are listed, only the changes in those files are listed.
852
798
Otherwise, all changes for the tree are listed.
853
799
800
TODO: Given two revision arguments, show the difference between them.
801
854
802
TODO: Allow diff across branches.
855
803
856
804
TODO: Option to use external diff command; could be GNU diff, wdiff,
865
813
deleted files.
866
814
867
815
TODO: This probably handles non-Unix newlines poorly.
868
869
examples:
870
bzr diff
871
bzr diff -r1
872
bzr diff -r1:2
873
816
"""
874
817
875
818
takes_args = ['file*']
888
831
else:
889
832
b = find_branch('.')
890
833
834
# TODO: Make show_diff support taking 2 arguments
835
base_rev = None
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])
899
else:
900
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
901
else:
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]
840
841
show_diff(b, base_rev, specific_files=file_list,
842
external_diff_options=diff_options)
843
904
844
905
845
906
846
932
872
"""List files modified in working tree."""
933
873
hidden = True
934
874
def run(self):
935
from bzrlib.delta import compare_trees
875
from bzrlib.diff import compare_trees
936
876
937
877
b = find_branch('.')
938
878
td = compare_trees(b.basis_tree(), b.working_tree())
987
927
"""
988
928
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']
992
931
993
932
def run(self, filename=None, timezone='original',
994
933
verbose=False,
996
935
forward=False,
997
936
revision=None,
998
937
message=None,
999
long=False,
1000
short=False):
938
long=False):
1001
939
from bzrlib.branch import find_branch
1002
940
from bzrlib.log import log_formatter, show_log
1003
941
import codecs
1037
975
# in e.g. the default C locale.
1038
976
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1039
977
1040
if not short:
978
if long:
1041
979
log_format = 'long'
1042
980
else:
1043
981
log_format = 'short'
1260
1198
1261
1199
class cmd_commit(Command):
1262
1200
"""Commit changes into a new revision.
1263
1264
If no arguments are given, the entire tree is committed.
1265
1201
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
1204
committed.
1269
1205
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']
1281
1217
1282
# TODO: Give better message for -s, --summary, used by tla people
1283
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
1288
1222
1289
1223
## Warning: shadows builtin file()
1290
1224
if not message and not file:
1291
# FIXME: Ugly; change status code to send to a provided function?
1292
1293
1225
import cStringIO
1294
1226
stdout = sys.stdout
1295
1227
catcher = cStringIO.StringIO()
1310
1242
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1311
1243
1312
1244
b = find_branch('.')
1313
if selected_list:
1314
selected_list = [b.relpath(s) for s in selected_list]
1315
1245
1316
1246
try:
1317
1247
b.commit(message, verbose=verbose,
1318
1248
specific_files=selected_list,
1381
1311
takes_options = ['email']
1382
1312
1383
1313
def run(self, email=False):
1384
try:
1385
b = bzrlib.branch.find_branch('.')
1386
except:
1387
b = None
1388
1389
1314
if email:
1390
print bzrlib.osutils.user_email(b)
1315
print bzrlib.osutils.user_email()
1391
1316
else:
1392
print bzrlib.osutils.username(b)
1317
print bzrlib.osutils.username()
1393
1318
1394
1319
1395
1320
class cmd_selftest(Command):
1460
1385
1461
1386
1462
1387
class cmd_merge(Command):
1463
"""Perform a three-way merge.
1464
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
1469
specified branch.
1470
1471
Examples:
1472
1473
To merge the latest revision from bzr.dev
1474
bzr merge ../bzr.dev
1475
1476
To merge changes up to and including revision 82 from bzr.dev
1477
bzr merge -r 82 ../bzr.dev
1478
1479
To merge the changes introduced by 82, without previous changes:
1480
bzr merge -r 81..82 ../bzr.dev
1481
1388
"""Perform a three-way merge of trees.
1389
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 '@'.
1393
1394
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1395
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.
1399
1400
Revision examples: './@127', 'foo/@', '../@1'
1401
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
1404
as the BASE.
1405
1482
1406
merge refuses to run if there are any uncommitted changes, unless
1483
1407
--force is given.
1484
1408
"""
1485
takes_args = ['branch?']
1486
takes_options = ['revision', 'force', 'merge-type']
1409
takes_args = ['other_spec', 'base_spec?']
1410
takes_options = ['force', 'merge-type']
1487
1411
1488
def run(self, branch='.', revision=None, force=False,
1489
merge_type=None):
1412
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1490
1413
from bzrlib.merge import merge
1491
1414
from bzrlib.merge_core import ApplyMerge3
1492
1415
if merge_type is None:
1493
1416
merge_type = ApplyMerge3
1494
1495
if revision is None or len(revision) < 1:
1496
base = (None, None)
1497
other = (branch, -1)
1498
else:
1499
if len(revision) == 1:
1500
other = (branch, revision[0])
1501
base = (None, None)
1502
else:
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])
1509
1510
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)
1511
1419
1512
1420
1513
1421
class cmd_revert(Command):
1556
1464
help.help(topic)
1557
1465
1558
1466
1559
class cmd_shell_complete(Command):
1560
"""Show appropriate completions for context.
1561
1562
For a list of all available commands, say 'bzr shell-complete'."""
1563
takes_args = ['context?']
1564
aliases = ['s-c']
1565
hidden = True
1566
1567
def run(self, context=None):
1568
import shellcomplete
1569
shellcomplete.shellcomplete(context)
1570
1571
1572
class cmd_missing(Command):
1573
"""What is missing in this branch relative to other branch.
1574
"""
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']
1580
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
1585
1586
if verbose and quiet:
1587
raise BzrCommandError('Cannot pass both quiet and verbose')
1588
1589
b = find_branch('.')
1590
parent = get_parent(b)
1591
if remote is None:
1592
if parent is None:
1593
raise BzrCommandError("No missing location known or specified.")
1594
else:
1595
if not quiet:
1596
print "Using last location: %s" % parent
1597
remote = 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)
1602
1603
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1604
1467
1605
1468
1606
1469
class cmd_plugins(Command):
1635
1498
'no-recurse': None,
1636
1499
'profile': None,
1637
1500
'revision': _parse_revision_str,
1638
'short': None,
1639
1501
'show-ids': None,
1640
1502
'timezone': str,
1641
1503
'verbose': None,
1802
1664
return argdict
1803
1665
1804
1666
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.
1670
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.
1675
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
1680
behavior.
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)
1686
1687
>>> argv, opts = _parse_master_args(['--test'])
1688
Traceback (most recent call last):
1689
...
1690
BzrCommandError: Invalid master option: 'test'
1691
>>> argv, opts = _parse_master_args(['--version', 'command'])
1692
>>> print argv
1693
['command']
1694
>>> print opts['version']
1695
True
1696
>>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
1697
>>> print argv
1698
['command', '--more-options']
1699
>>> print opts['profile']
1700
True
1701
>>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
1702
>>> print argv
1703
['command']
1704
>>> print opts['no-plugins']
1705
True
1706
>>> print opts['profile']
1707
False
1708
>>> argv, opts = _parse_master_args(['command', '--profile'])
1709
>>> print argv
1710
['command', '--profile']
1711
>>> print opts['profile']
1712
False
1713
"""
1714
master_opts = {'builtin':False,
1715
'no-plugins':False,
1716
'version':False,
1717
'profile':False,
1718
'help':False
1719
}
1720
1721
for arg in argv[:]:
1722
if arg[:2] != '--': # at the first non-option, we return the rest
1723
break
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
1732
1733
1805
1734
1806
1735
def run_bzr(argv):
1807
1736
"""Execute a command.
1810
1739
logging and error handling.
1811
1740
1812
1741
argv
1813
The command-line arguments, without the program name from argv[0]
1742
The command-line arguments, without the program name.
1814
1743
1815
1744
Returns a command status or raises an exception.
1816
1817
Special master options: these must come before the command because
1818
they control how the command is interpreted.
1819
1820
--no-plugins
1821
Do not load plugin modules at all
1822
1823
--builtin
1824
Only use builtin commands. (Plugins are still allowed to change
1825
other behaviour.)
1826
1827
--profile
1828
Run under the Python profiler.
1829
1745
"""
1830
1831
1746
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1832
1747
1833
opt_profile = opt_no_plugins = opt_builtin = False
1834
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.
1838
1839
for a in argv[:]:
1840
if a == '--profile':
1841
opt_profile = True
1842
elif a == '--no-plugins':
1843
opt_no_plugins = True
1844
elif a == '--builtin':
1845
opt_builtin = True
1846
else:
1847
break
1848
argv.remove(a)
1849
1850
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']:
1851
1751
from bzrlib.plugin import load_plugins
1852
1752
load_plugins()
1853
1753
1854
1754
args, opts = parse_args(argv)
1855
1755
1856
if 'help' in opts:
1756
if master_opts.get('help') or 'help' in opts:
1857
1757
from bzrlib.help import help
1858
if args:
1859
help(args[0])
1758
if argv:
1759
help(argv[0])
1860
1760
else:
1861
1761
help()
1862
1762
return 0
1865
1765
show_version()
1866
1766
return 0
1867
1767
1868
if not args:
1768
if args and args[0] == 'builtin':
1769
include_plugins=False
1770
args = args[1:]
1771
1772
try:
1773
cmd = str(args.pop(0))
1774
except IndexError:
1869
1775
print >>sys.stderr, "please try 'bzr help' for help"
1870
1776
return 1
1871
1872
cmd = str(args.pop(0))
1873
1874
canonical_cmd, cmd_class = \
1875
get_cmd_class(cmd, plugins_override=not opt_builtin)
1777
1778
plugins_override = not (master_opts['builtin'])
1779
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1780
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:
1785
profile = True
1786
del opts['profile']
1876
1787
1877
1788
# check options are reasonable
1878
1789
allowed = cmd_class.takes_options
1887
1798
for k, v in opts.items():
1888
1799
cmdopts[k.replace('-', '_')] = v
1889
1800
1890
if opt_profile:
1801
if profile:
1891
1802
import hotshot, tempfile
1892
1803
pffileno, pfname = tempfile.mkstemp()
1893
1804
try:
1914
1825
1915
1826
def _report_exception(summary, quiet=False):
1916
1827
import traceback
1917
1918
1828
log_error('bzr: ' + summary)
1919
1829
bzrlib.trace.log_exception()
1920
1830
1921
if os.environ.get('BZR_DEBUG'):
1922
traceback.print_exc()
1923
1924
1831
if not quiet:
1925
sys.stderr.write('\n')
1926
1832
tb = sys.exc_info()[2]
1927
1833
exinfo = traceback.extract_tb(tb)
1928
1834
if exinfo:
1944
1850
sys.stdout.flush()
1945
1851
except BzrError, e:
1946
1852
quiet = isinstance(e, (BzrCommandError))
1947
_report_exception('error: ' + str(e), quiet=quiet)
1853
_report_exception('error: ' + e.args[0], quiet=quiet)
1948
1854
if len(e.args) > 1:
1949
1855
for h in e.args[1]:
1950
1856
# some explanation or hints
Loggerhead is a web-based interface for Breezy
Version: 2.0.1