/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-12 01:30:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050712013055-aafbf9db6df73c34
- fix up breakage of 'bzr log -v' by root_id patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
127
122
    return revs
128
123
 
129
124
 
130
 
def get_merge_type(typestring):
131
 
    """Attempt to find the merge class/factory associated with a string."""
132
 
    from merge import merge_types
133
 
    try:
134
 
        return merge_types[typestring][0]
135
 
    except KeyError:
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)
142
 
    
143
 
 
144
125
 
145
126
def _get_cmd_dict(plugins_override=True):
146
127
    d = {}
219
200
        assert isinstance(arguments, dict)
220
201
        cmdargs = options.copy()
221
202
        cmdargs.update(arguments)
222
 
        if self.__doc__ == Command.__doc__:
223
 
            from warnings import warn
224
 
            warn("No help message set for %r" % self)
 
203
        assert self.__doc__ != Command.__doc__, \
 
204
               ("No help message set for %r" % self)
225
205
        self.status = self.run(**cmdargs)
226
 
        if self.status is None:
227
 
            self.status = 0
228
206
 
229
207
    
230
208
    def run(self):
242
220
class ExternalCommand(Command):
243
221
    """Class to wrap external commands.
244
222
 
245
 
    We cheat a little here, when get_cmd_class() calls us we actually
246
 
    give it back an object we construct that has the appropriate path,
247
 
    help, options etc for the specified command.
248
 
 
249
 
    When run_bzr() tries to instantiate that 'class' it gets caught by
250
 
    the __call__ method, which we override to call the Command.__init__
251
 
    method. That then calls our run method which is pretty straight
252
 
    forward.
253
 
 
254
 
    The only wrinkle is that we have to map bzr's dictionary of options
255
 
    and arguments back into command line options and arguments for the
256
 
    script.
 
223
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
224
    an object we construct that has the appropriate path, help, options etc for the
 
225
    specified command.
 
226
 
 
227
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
228
    method, which we override to call the Command.__init__ method. That then calls
 
229
    our run method which is pretty straight forward.
 
230
 
 
231
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
232
    back into command line options and arguments for the script.
257
233
    """
258
234
 
259
235
    def find_command(cls, cmd):
433
409
    whether already versioned or not, are searched for files or
434
410
    subdirectories that are neither versioned or ignored, and these
435
411
    are added.  This search proceeds recursively into versioned
436
 
    directories.  If no names are given '.' is assumed.
 
412
    directories.
437
413
 
438
 
    Therefore simply saying 'bzr add' will version all files that
 
414
    Therefore simply saying 'bzr add .' will version all files that
439
415
    are currently unknown.
440
416
 
441
417
    TODO: Perhaps adding a file whose directly is not versioned should
442
418
    recursively add that parent, rather than giving an error?
443
419
    """
444
 
    takes_args = ['file*']
 
420
    takes_args = ['file+']
445
421
    takes_options = ['verbose', 'no-recurse']
446
422
    
447
423
    def run(self, file_list, verbose=False, no_recurse=False):
510
486
    def run(self, source_list, dest):
511
487
        b = find_branch('.')
512
488
 
513
 
        # TODO: glob expansion on windows?
514
489
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
515
490
 
516
491
 
536
511
 
537
512
 
538
513
 
539
 
class cmd_mv(Command):
540
 
    """Move or rename a file.
541
 
 
542
 
    usage:
543
 
        bzr mv OLDNAME NEWNAME
544
 
        bzr mv SOURCE... DESTINATION
545
 
 
546
 
    If the last argument is a versioned directory, all the other names
547
 
    are moved into it.  Otherwise, there must be exactly two arguments
548
 
    and the file is changed to a new name, which must not already exist.
549
 
 
550
 
    Files cannot be moved between branches.
551
 
    """
552
 
    takes_args = ['names*']
553
 
    def run(self, names_list):
554
 
        if len(names_list) < 2:
555
 
            raise BzrCommandError("missing file argument")
556
 
        b = find_branch(names_list[0])
557
 
 
558
 
        rel_names = [b.relpath(x) for x in names_list]
559
 
        
560
 
        if os.path.isdir(names_list[-1]):
561
 
            # move into existing directory
562
 
            b.move(rel_names[:-1], rel_names[-1])
563
 
        else:
564
 
            if len(names_list) != 2:
565
 
                raise BzrCommandError('to mv multiple files the destination '
566
 
                                      'must be a versioned directory')
567
 
            b.move(rel_names[0], rel_names[1])
568
 
            
569
 
    
570
514
 
571
515
 
572
516
class cmd_pull(Command):
639
583
    """
640
584
    takes_args = ['from_location', 'to_location?']
641
585
    takes_options = ['revision']
642
 
    aliases = ['get', 'clone']
643
586
 
644
587
    def run(self, from_location, to_location=None, revision=None):
645
588
        import errno
646
589
        from bzrlib.merge import merge
647
 
        from bzrlib.branch import DivergedBranches, \
 
590
        from bzrlib.branch import DivergedBranches, NoSuchRevision, \
648
591
             find_cached_branch, Branch
649
592
        from shutil import rmtree
650
593
        from meta_store import CachedStore
651
594
        import tempfile
652
595
        cache_root = tempfile.mkdtemp()
653
596
 
654
 
        if revision is None:
 
597
        if revision is not None:
 
598
            if len(revision) > 1:
 
599
                raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
 
600
        else:
655
601
            revision = [None]
656
 
        elif len(revision) > 1:
657
 
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
658
 
 
659
602
        try:
660
603
            try:
661
604
                br_from = find_cached_branch(from_location, cache_root)
685
628
            br_to.set_root_id(br_from.get_root_id())
686
629
 
687
630
            if revision:
688
 
                if revision[0] is None:
689
 
                    revno = br_from.revno()
690
 
                else:
691
 
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
631
                revno = br_to.lookup_revision(revision[0])
692
632
                try:
693
633
                    br_to.update_revisions(br_from, stop_revision=revno)
694
 
                except bzrlib.errors.NoSuchRevision:
 
634
                except NoSuchRevision:
695
635
                    rmtree(to_location)
696
636
                    msg = "The branch %s has no revision %d." % (from_location,
697
637
                                                                 revno)
912
852
    """List files modified in working tree."""
913
853
    hidden = True
914
854
    def run(self):
915
 
        from bzrlib.delta import compare_trees
 
855
        from bzrlib.diff import compare_trees
916
856
 
917
857
        b = find_branch('.')
918
858
        td = compare_trees(b.basis_tree(), b.working_tree())
1238
1178
 
1239
1179
class cmd_commit(Command):
1240
1180
    """Commit changes into a new revision.
1241
 
    
1242
 
    If no arguments are given, the entire tree is committed.
1243
1181
 
1244
1182
    If selected files are specified, only changes to those files are
1245
 
    committed.  If a directory is specified then the directory and everything 
1246
 
    within it is committed.
 
1183
    committed.  If a directory is specified then its contents are also
 
1184
    committed.
1247
1185
 
1248
1186
    A selected-file commit may fail in some cases where the committed
1249
1187
    tree would be invalid, such as trying to commit a file in a
1257
1195
    takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
1196
    aliases = ['ci', 'checkin']
1259
1197
 
1260
 
    # TODO: Give better message for -s, --summary, used by tla people
1261
 
    
1262
1198
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1263
1199
            unchanged=False):
1264
1200
        from bzrlib.errors import PointlessCommit
1266
1202
 
1267
1203
        ## Warning: shadows builtin file()
1268
1204
        if not message and not file:
1269
 
            # FIXME: Ugly; change status code to send to a provided function?
1270
 
            
1271
1205
            import cStringIO
1272
1206
            stdout = sys.stdout
1273
1207
            catcher = cStringIO.StringIO()
1288
1222
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1289
1223
 
1290
1224
        b = find_branch('.')
1291
 
        if selected_list:
1292
 
            selected_list = [b.relpath(s) for s in selected_list]
1293
 
            
 
1225
 
1294
1226
        try:
1295
1227
            b.commit(message, verbose=verbose,
1296
1228
                     specific_files=selected_list,
1319
1251
 
1320
1252
 
1321
1253
 
1322
 
class cmd_scan_cache(Command):
1323
 
    hidden = True
1324
 
    def run(self):
1325
 
        from bzrlib.hashcache import HashCache
1326
 
        import os
1327
 
 
1328
 
        c = HashCache('.')
1329
 
        c.read()
1330
 
        c.scan()
1331
 
            
1332
 
        print '%6d stats' % c.stat_count
1333
 
        print '%6d in hashcache' % len(c._cache)
1334
 
        print '%6d files removed from cache' % c.removed_count
1335
 
        print '%6d hashes updated' % c.update_count
1336
 
        print '%6d files changed too recently to cache' % c.danger_count
1337
 
 
1338
 
        if c.needs_write:
1339
 
            c.write()
1340
 
            
1341
 
 
1342
 
 
1343
1254
class cmd_upgrade(Command):
1344
1255
    """Upgrade branch storage to current format.
1345
1256
 
1368
1279
class cmd_selftest(Command):
1369
1280
    """Run internal test suite"""
1370
1281
    hidden = True
1371
 
    takes_options = ['verbose']
1372
 
    def run(self, verbose=False):
 
1282
    def run(self):
1373
1283
        from bzrlib.selftest import selftest
1374
 
        return int(not selftest(verbose=verbose))
 
1284
        return int(not selftest())
1375
1285
 
1376
1286
 
1377
1287
class cmd_version(Command):
1455
1365
    --force is given.
1456
1366
    """
1457
1367
    takes_args = ['other_spec', 'base_spec?']
1458
 
    takes_options = ['force', 'merge-type']
 
1368
    takes_options = ['force']
1459
1369
 
1460
 
    def run(self, other_spec, base_spec=None, force=False, merge_type=None):
 
1370
    def run(self, other_spec, base_spec=None, force=False):
1461
1371
        from bzrlib.merge import merge
1462
 
        from bzrlib.merge_core import ApplyMerge3
1463
 
        if merge_type is None:
1464
 
            merge_type = ApplyMerge3
1465
1372
        merge(parse_spec(other_spec), parse_spec(base_spec),
1466
 
              check_clean=(not force), merge_type=merge_type)
 
1373
              check_clean=(not force))
 
1374
 
1467
1375
 
1468
1376
 
1469
1377
class cmd_revert(Command):
 
1378
    """Restore selected files from a previous revision.
 
1379
    """
 
1380
    takes_args = ['file+']
 
1381
    def run(self, file_list):
 
1382
        from bzrlib.branch import find_branch
 
1383
        
 
1384
        if not file_list:
 
1385
            file_list = ['.']
 
1386
            
 
1387
        b = find_branch(file_list[0])
 
1388
 
 
1389
        b.revert([b.relpath(f) for f in file_list])
 
1390
 
 
1391
 
 
1392
class cmd_merge_revert(Command):
1470
1393
    """Reverse all changes since the last commit.
1471
1394
 
1472
 
    Only versioned files are affected.  Specify filenames to revert only 
1473
 
    those files.  By default, any files that are changed will be backed up
1474
 
    first.  Backup files have a '~' appended to their name.
 
1395
    Only versioned files are affected.
 
1396
 
 
1397
    TODO: Store backups of any files that will be reverted, so
 
1398
          that the revert can be undone.          
1475
1399
    """
1476
 
    takes_options = ['revision', 'no-backup']
1477
 
    takes_args = ['file*']
1478
 
    aliases = ['merge-revert']
 
1400
    takes_options = ['revision']
1479
1401
 
1480
 
    def run(self, revision=None, no_backup=False, file_list=None):
 
1402
    def run(self, revision=None):
1481
1403
        from bzrlib.merge import merge
1482
 
        if file_list is not None:
1483
 
            if len(file_list) == 0:
1484
 
                raise BzrCommandError("No files specified")
1485
1404
        if revision is None:
1486
 
            revision = [-1]
 
1405
            revision = -1
1487
1406
        elif len(revision) != 1:
1488
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1407
            raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1489
1408
        merge(('.', revision[0]), parse_spec('.'),
1490
1409
              check_clean=False,
1491
 
              ignore_zero=True,
1492
 
              backup_files=not no_backup,
1493
 
              file_list=file_list)
 
1410
              ignore_zero=True)
1494
1411
 
1495
1412
 
1496
1413
class cmd_assert_fail(Command):
1555
1472
    'update':                 None,
1556
1473
    'long':                   None,
1557
1474
    'root':                   str,
1558
 
    'no-backup':              None,
1559
 
    'merge-type':             get_merge_type,
1560
1475
    }
1561
1476
 
1562
1477
SHORT_OPTIONS = {
1712
1627
    return argdict
1713
1628
 
1714
1629
 
 
1630
def _parse_master_args(argv):
 
1631
    """Parse the arguments that always go with the original command.
 
1632
    These are things like bzr --no-plugins, etc.
 
1633
 
 
1634
    There are now 2 types of option flags. Ones that come *before* the command,
 
1635
    and ones that come *after* the command.
 
1636
    Ones coming *before* the command are applied against all possible commands.
 
1637
    And are generally applied before plugins are loaded.
 
1638
 
 
1639
    The current list are:
 
1640
        --builtin   Allow plugins to load, but don't let them override builtin commands,
 
1641
                    they will still be allowed if they do not override a builtin.
 
1642
        --no-plugins    Don't load any plugins. This lets you get back to official source
 
1643
                        behavior.
 
1644
        --profile   Enable the hotspot profile before running the command.
 
1645
                    For backwards compatibility, this is also a non-master option.
 
1646
        --version   Spit out the version of bzr that is running and exit.
 
1647
                    This is also a non-master option.
 
1648
        --help      Run help and exit, also a non-master option (I think that should stay, though)
 
1649
 
 
1650
    >>> argv, opts = _parse_master_args(['bzr', '--test'])
 
1651
    Traceback (most recent call last):
 
1652
    ...
 
1653
    BzrCommandError: Invalid master option: 'test'
 
1654
    >>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
 
1655
    >>> print argv
 
1656
    ['command']
 
1657
    >>> print opts['version']
 
1658
    True
 
1659
    >>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
 
1660
    >>> print argv
 
1661
    ['command', '--more-options']
 
1662
    >>> print opts['profile']
 
1663
    True
 
1664
    >>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
 
1665
    >>> print argv
 
1666
    ['command']
 
1667
    >>> print opts['no-plugins']
 
1668
    True
 
1669
    >>> print opts['profile']
 
1670
    False
 
1671
    >>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
 
1672
    >>> print argv
 
1673
    ['command', '--profile']
 
1674
    >>> print opts['profile']
 
1675
    False
 
1676
    """
 
1677
    master_opts = {'builtin':False,
 
1678
        'no-plugins':False,
 
1679
        'version':False,
 
1680
        'profile':False,
 
1681
        'help':False
 
1682
    }
 
1683
 
 
1684
    # This is the point where we could hook into argv[0] to determine
 
1685
    # what front-end is supposed to be run
 
1686
    # For now, we are just ignoring it.
 
1687
    cmd_name = argv.pop(0)
 
1688
    for arg in argv[:]:
 
1689
        if arg[:2] != '--': # at the first non-option, we return the rest
 
1690
            break
 
1691
        arg = arg[2:] # Remove '--'
 
1692
        if arg not in master_opts:
 
1693
            # We could say that this is not an error, that we should
 
1694
            # just let it be handled by the main section instead
 
1695
            raise BzrCommandError('Invalid master option: %r' % arg)
 
1696
        argv.pop(0) # We are consuming this entry
 
1697
        master_opts[arg] = True
 
1698
    return argv, master_opts
 
1699
 
 
1700
 
1715
1701
 
1716
1702
def run_bzr(argv):
1717
1703
    """Execute a command.
1718
1704
 
1719
1705
    This is similar to main(), but without all the trappings for
1720
1706
    logging and error handling.  
1721
 
    
1722
 
    argv
1723
 
       The command-line arguments, without the program name from argv[0]
1724
 
    
1725
 
    Returns a command status or raises an exception.
1726
 
 
1727
 
    Special master options: these must come before the command because
1728
 
    they control how the command is interpreted.
1729
 
 
1730
 
    --no-plugins
1731
 
        Do not load plugin modules at all
1732
 
 
1733
 
    --builtin
1734
 
        Only use builtin commands.  (Plugins are still allowed to change
1735
 
        other behaviour.)
1736
 
 
1737
 
    --profile
1738
 
        Run under the Python profiler.
1739
1707
    """
1740
 
    
1741
1708
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1742
 
 
1743
 
    opt_profile = opt_no_plugins = opt_builtin = False
1744
 
 
1745
 
    # --no-plugins is handled specially at a very early stage. We need
1746
 
    # to load plugins before doing other command parsing so that they
1747
 
    # can override commands, but this needs to happen first.
1748
 
 
1749
 
    for a in argv[:]:
1750
 
        if a == '--profile':
1751
 
            opt_profile = True
1752
 
        elif a == '--no-plugins':
1753
 
            opt_no_plugins = True
1754
 
        elif a == '--builtin':
1755
 
            opt_builtin = True
1756
 
        else:
1757
 
            break
1758
 
        argv.remove(a)
1759
 
 
1760
 
    if not opt_no_plugins:
1761
 
        from bzrlib.plugin import load_plugins
1762
 
        load_plugins()
1763
 
 
1764
 
    args, opts = parse_args(argv)
1765
 
 
1766
 
    if 'help' in opts:
1767
 
        from bzrlib.help import help
1768
 
        if args:
1769
 
            help(args[0])
1770
 
        else:
1771
 
            help()
1772
 
        return 0            
1773
 
        
1774
 
    if 'version' in opts:
1775
 
        show_version()
1776
 
        return 0
1777
1709
    
1778
 
    if not args:
1779
 
        print >>sys.stderr, "please try 'bzr help' for help"
 
1710
    try:
 
1711
        # some options like --builtin and --no-plugins have special effects
 
1712
        argv, master_opts = _parse_master_args(argv)
 
1713
        if not master_opts['no-plugins']:
 
1714
            from bzrlib.plugin import load_plugins
 
1715
            load_plugins()
 
1716
 
 
1717
        args, opts = parse_args(argv)
 
1718
 
 
1719
        if master_opts['help']:
 
1720
            from bzrlib.help import help
 
1721
            if argv:
 
1722
                help(argv[0])
 
1723
            else:
 
1724
                help()
 
1725
            return 0            
 
1726
            
 
1727
        if 'help' in opts:
 
1728
            from bzrlib.help import help
 
1729
            if args:
 
1730
                help(args[0])
 
1731
            else:
 
1732
                help()
 
1733
            return 0
 
1734
        elif 'version' in opts:
 
1735
            show_version()
 
1736
            return 0
 
1737
        elif args and args[0] == 'builtin':
 
1738
            include_plugins=False
 
1739
            args = args[1:]
 
1740
        cmd = str(args.pop(0))
 
1741
    except IndexError:
 
1742
        import help
 
1743
        help.help()
1780
1744
        return 1
1781
 
    
1782
 
    cmd = str(args.pop(0))
1783
 
 
1784
 
    canonical_cmd, cmd_class = \
1785
 
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
1745
          
 
1746
 
 
1747
    plugins_override = not (master_opts['builtin'])
 
1748
    canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
 
1749
 
 
1750
    profile = master_opts['profile']
 
1751
    # For backwards compatibility, I would rather stick with --profile being a
 
1752
    # master/global option
 
1753
    if 'profile' in opts:
 
1754
        profile = True
 
1755
        del opts['profile']
1786
1756
 
1787
1757
    # check options are reasonable
1788
1758
    allowed = cmd_class.takes_options
1797
1767
    for k, v in opts.items():
1798
1768
        cmdopts[k.replace('-', '_')] = v
1799
1769
 
1800
 
    if opt_profile:
 
1770
    if profile:
1801
1771
        import hotshot, tempfile
1802
1772
        pffileno, pfname = tempfile.mkstemp()
1803
1773
        try:
1824
1794
 
1825
1795
def _report_exception(summary, quiet=False):
1826
1796
    import traceback
1827
 
    
1828
1797
    log_error('bzr: ' + summary)
1829
1798
    bzrlib.trace.log_exception()
1830
1799
 
1831
 
    if os.environ.get('BZR_DEBUG'):
1832
 
        traceback.print_exc()
1833
 
 
1834
1800
    if not quiet:
1835
 
        sys.stderr.write('\n')
1836
1801
        tb = sys.exc_info()[2]
1837
1802
        exinfo = traceback.extract_tb(tb)
1838
1803
        if exinfo:
1848
1813
    try:
1849
1814
        try:
1850
1815
            try:
1851
 
                return run_bzr(argv[1:])
 
1816
                return run_bzr(argv)
1852
1817
            finally:
1853
1818
                # do this here inside the exception wrappers to catch EPIPE
1854
1819
                sys.stdout.flush()
1855
1820
        except BzrError, e:
1856
1821
            quiet = isinstance(e, (BzrCommandError))
1857
 
            _report_exception('error: ' + str(e), quiet=quiet)
 
1822
            _report_exception('error: ' + e.args[0], quiet=quiet)
1858
1823
            if len(e.args) > 1:
1859
1824
                for h in e.args[1]:
1860
1825
                    # some explanation or hints