~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-12 01:44:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050712014423-1d95eb47ce7ab510
- add simple test case for bzr status

- show_status takes to_file argument

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
125
 
159
126
def _get_cmd_dict(plugins_override=True):
160
127
    d = {}
233
200
        assert isinstance(arguments, dict)
234
201
        cmdargs = options.copy()
235
202
        cmdargs.update(arguments)
236
 
        if self.__doc__ == Command.__doc__:
237
 
            from warnings import warn
238
 
            warn("No help message set for %r" % self)
 
203
        assert self.__doc__ != Command.__doc__, \
 
204
               ("No help message set for %r" % self)
239
205
        self.status = self.run(**cmdargs)
240
 
        if self.status is None:
241
 
            self.status = 0
242
206
 
243
207
    
244
208
    def run(self):
256
220
class ExternalCommand(Command):
257
221
    """Class to wrap external commands.
258
222
 
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.
 
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.
271
233
    """
272
234
 
273
235
    def find_command(cls, cmd):
447
409
    whether already versioned or not, are searched for files or
448
410
    subdirectories that are neither versioned or ignored, and these
449
411
    are added.  This search proceeds recursively into versioned
450
 
    directories.  If no names are given '.' is assumed.
 
412
    directories.
451
413
 
452
 
    Therefore simply saying 'bzr add' will version all files that
 
414
    Therefore simply saying 'bzr add .' will version all files that
453
415
    are currently unknown.
454
416
 
455
417
    TODO: Perhaps adding a file whose directly is not versioned should
456
418
    recursively add that parent, rather than giving an error?
457
419
    """
458
 
    takes_args = ['file*']
 
420
    takes_args = ['file+']
459
421
    takes_options = ['verbose', 'no-recurse']
460
422
    
461
423
    def run(self, file_list, verbose=False, no_recurse=False):
524
486
    def run(self, source_list, dest):
525
487
        b = find_branch('.')
526
488
 
527
 
        # TODO: glob expansion on windows?
528
489
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
529
490
 
530
491
 
550
511
 
551
512
 
552
513
 
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
514
 
585
515
 
586
516
class cmd_pull(Command):
653
583
    """
654
584
    takes_args = ['from_location', 'to_location?']
655
585
    takes_options = ['revision']
656
 
    aliases = ['get', 'clone']
657
586
 
658
587
    def run(self, from_location, to_location=None, revision=None):
659
588
        import errno
660
589
        from bzrlib.merge import merge
661
 
        from bzrlib.branch import DivergedBranches, \
 
590
        from bzrlib.branch import DivergedBranches, NoSuchRevision, \
662
591
             find_cached_branch, Branch
663
592
        from shutil import rmtree
664
593
        from meta_store import CachedStore
665
594
        import tempfile
666
595
        cache_root = tempfile.mkdtemp()
667
596
 
668
 
        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:
669
601
            revision = [None]
670
 
        elif len(revision) > 1:
671
 
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
672
 
 
673
602
        try:
674
603
            try:
675
604
                br_from = find_cached_branch(from_location, cache_root)
699
628
            br_to.set_root_id(br_from.get_root_id())
700
629
 
701
630
            if revision:
702
 
                if revision[0] is None:
703
 
                    revno = br_from.revno()
704
 
                else:
705
 
                    revno, rev_id = br_from.get_revision_info(revision[0])
 
631
                revno = br_to.lookup_revision(revision[0])
706
632
                try:
707
633
                    br_to.update_revisions(br_from, stop_revision=revno)
708
 
                except bzrlib.errors.NoSuchRevision:
 
634
                except NoSuchRevision:
709
635
                    rmtree(to_location)
710
636
                    msg = "The branch %s has no revision %d." % (from_location,
711
637
                                                                 revno)
851
777
    If files are listed, only the changes in those files are listed.
852
778
    Otherwise, all changes for the tree are listed.
853
779
 
 
780
    TODO: Given two revision arguments, show the difference between them.
 
781
 
854
782
    TODO: Allow diff across branches.
855
783
 
856
784
    TODO: Option to use external diff command; could be GNU diff, wdiff,
865
793
          deleted files.
866
794
 
867
795
    TODO: This probably handles non-Unix newlines poorly.
868
 
 
869
 
    examples:
870
 
        bzr diff
871
 
        bzr diff -r1
872
 
        bzr diff -r1:2
873
796
    """
874
797
    
875
798
    takes_args = ['file*']
888
811
        else:
889
812
            b = find_branch('.')
890
813
 
 
814
        # TODO: Make show_diff support taking 2 arguments
 
815
        base_rev = None
891
816
        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)
 
817
            if len(revision) != 1:
 
818
                raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
 
819
            base_rev = revision[0]
 
820
    
 
821
        show_diff(b, base_rev, specific_files=file_list,
 
822
                  external_diff_options=diff_options)
 
823
 
904
824
 
905
825
        
906
826
 
932
852
    """List files modified in working tree."""
933
853
    hidden = True
934
854
    def run(self):
935
 
        from bzrlib.delta import compare_trees
 
855
        from bzrlib.diff import compare_trees
936
856
 
937
857
        b = find_branch('.')
938
858
        td = compare_trees(b.basis_tree(), b.working_tree())
987
907
    """
988
908
 
989
909
    takes_args = ['filename?']
990
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
 
                     'long', 'message', 'short',]
 
910
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
992
911
    
993
912
    def run(self, filename=None, timezone='original',
994
913
            verbose=False,
996
915
            forward=False,
997
916
            revision=None,
998
917
            message=None,
999
 
            long=False,
1000
 
            short=False):
 
918
            long=False):
1001
919
        from bzrlib.branch import find_branch
1002
920
        from bzrlib.log import log_formatter, show_log
1003
921
        import codecs
1037
955
        # in e.g. the default C locale.
1038
956
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1039
957
 
1040
 
        if not short:
 
958
        if long:
1041
959
            log_format = 'long'
1042
960
        else:
1043
961
            log_format = 'short'
1260
1178
 
1261
1179
class cmd_commit(Command):
1262
1180
    """Commit changes into a new revision.
1263
 
    
1264
 
    If no arguments are given, the entire tree is committed.
1265
1181
 
1266
1182
    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.
 
1183
    committed.  If a directory is specified then its contents are also
 
1184
    committed.
1269
1185
 
1270
1186
    A selected-file commit may fail in some cases where the committed
1271
1187
    tree would be invalid, such as trying to commit a file in a
1279
1195
    takes_options = ['message', 'file', 'verbose', 'unchanged']
1280
1196
    aliases = ['ci', 'checkin']
1281
1197
 
1282
 
    # TODO: Give better message for -s, --summary, used by tla people
1283
 
    
1284
1198
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1285
1199
            unchanged=False):
1286
1200
        from bzrlib.errors import PointlessCommit
1288
1202
 
1289
1203
        ## Warning: shadows builtin file()
1290
1204
        if not message and not file:
1291
 
            # FIXME: Ugly; change status code to send to a provided function?
1292
 
            
1293
1205
            import cStringIO
1294
1206
            stdout = sys.stdout
1295
1207
            catcher = cStringIO.StringIO()
1310
1222
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1311
1223
 
1312
1224
        b = find_branch('.')
1313
 
        if selected_list:
1314
 
            selected_list = [b.relpath(s) for s in selected_list]
1315
 
            
 
1225
 
1316
1226
        try:
1317
1227
            b.commit(message, verbose=verbose,
1318
1228
                     specific_files=selected_list,
1341
1251
 
1342
1252
 
1343
1253
 
1344
 
class cmd_scan_cache(Command):
1345
 
    hidden = True
1346
 
    def run(self):
1347
 
        from bzrlib.hashcache import HashCache
1348
 
        import os
1349
 
 
1350
 
        c = HashCache('.')
1351
 
        c.read()
1352
 
        c.scan()
1353
 
            
1354
 
        print '%6d stats' % c.stat_count
1355
 
        print '%6d in hashcache' % len(c._cache)
1356
 
        print '%6d files removed from cache' % c.removed_count
1357
 
        print '%6d hashes updated' % c.update_count
1358
 
        print '%6d files changed too recently to cache' % c.danger_count
1359
 
 
1360
 
        if c.needs_write:
1361
 
            c.write()
1362
 
            
1363
 
 
1364
 
 
1365
1254
class cmd_upgrade(Command):
1366
1255
    """Upgrade branch storage to current format.
1367
1256
 
1390
1279
class cmd_selftest(Command):
1391
1280
    """Run internal test suite"""
1392
1281
    hidden = True
1393
 
    takes_options = ['verbose']
1394
 
    def run(self, verbose=False):
 
1282
    def run(self):
1395
1283
        from bzrlib.selftest import selftest
1396
 
        return int(not selftest(verbose=verbose))
 
1284
        return int(not selftest())
1397
1285
 
1398
1286
 
1399
1287
class cmd_version(Command):
1455
1343
 
1456
1344
 
1457
1345
class cmd_merge(Command):
1458
 
    """Perform a three-way merge.
1459
 
    
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
1464
 
    specified branch.
1465
 
    
1466
 
    Examples:
1467
 
 
1468
 
    To merge the latest revision from bzr.dev
1469
 
    bzr merge ../bzr.dev
1470
 
 
1471
 
    To merge changes up to and including revision 82 from bzr.dev
1472
 
    bzr merge -r 82 ../bzr.dev
1473
 
 
1474
 
    To merge the changes introduced by 82, without previous changes:
1475
 
    bzr merge -r 81..82 ../bzr.dev
1476
 
    
 
1346
    """Perform a three-way merge of trees.
 
1347
    
 
1348
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1349
    are specified using standard paths or urls.  No component of a directory
 
1350
    path may begin with '@'.
 
1351
    
 
1352
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1353
 
 
1354
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1355
    branch directory and revno is the revision within that branch.  If no revno
 
1356
    is specified, the latest revision is used.
 
1357
 
 
1358
    Revision examples: './@127', 'foo/@', '../@1'
 
1359
 
 
1360
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1361
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1362
    as the BASE.
 
1363
 
1477
1364
    merge refuses to run if there are any uncommitted changes, unless
1478
1365
    --force is given.
1479
1366
    """
1480
 
    takes_args = ['branch?']
1481
 
    takes_options = ['revision', 'force', 'merge-type']
 
1367
    takes_args = ['other_spec', 'base_spec?']
 
1368
    takes_options = ['force']
1482
1369
 
1483
 
    def run(self, branch='.', revision=None, force=False, 
1484
 
            merge_type=None):
 
1370
    def run(self, other_spec, base_spec=None, force=False):
1485
1371
        from bzrlib.merge import merge
1486
 
        from bzrlib.merge_core import ApplyMerge3
1487
 
        if merge_type is None:
1488
 
            merge_type = ApplyMerge3
 
1372
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1373
              check_clean=(not force))
1489
1374
 
1490
 
        if revision is None or len(revision) < 1:
1491
 
            base = (None, None)
1492
 
            other = (branch, -1)
1493
 
        else:
1494
 
            if len(revision) == 1:
1495
 
                other = (branch, revision[0])
1496
 
                base = (None, None)
1497
 
            else:
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])
1504
 
            
1505
 
        merge(other, base, check_clean=(not force), merge_type=merge_type)
1506
1375
 
1507
1376
 
1508
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):
1509
1393
    """Reverse all changes since the last commit.
1510
1394
 
1511
 
    Only versioned files are affected.  Specify filenames to revert only 
1512
 
    those files.  By default, any files that are changed will be backed up
1513
 
    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.          
1514
1399
    """
1515
 
    takes_options = ['revision', 'no-backup']
1516
 
    takes_args = ['file*']
1517
 
    aliases = ['merge-revert']
 
1400
    takes_options = ['revision']
1518
1401
 
1519
 
    def run(self, revision=None, no_backup=False, file_list=None):
 
1402
    def run(self, revision=None):
1520
1403
        from bzrlib.merge import merge
1521
 
        if file_list is not None:
1522
 
            if len(file_list) == 0:
1523
 
                raise BzrCommandError("No files specified")
1524
1404
        if revision is None:
1525
 
            revision = [-1]
 
1405
            revision = -1
1526
1406
        elif len(revision) != 1:
1527
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1407
            raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1528
1408
        merge(('.', revision[0]), parse_spec('.'),
1529
1409
              check_clean=False,
1530
 
              ignore_zero=True,
1531
 
              backup_files=not no_backup,
1532
 
              file_list=file_list)
 
1410
              ignore_zero=True)
1533
1411
 
1534
1412
 
1535
1413
class cmd_assert_fail(Command):
1553
1431
 
1554
1432
 
1555
1433
 
1556
 
class cmd_missing(Command):
1557
 
    """What is missing in this branch relative to other branch.
1558
 
    """
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']
1564
 
 
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
1569
 
 
1570
 
        if verbose and quiet:
1571
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1572
 
 
1573
 
        b = find_branch('.')
1574
 
        parent = get_parent(b)
1575
 
        if remote is None:
1576
 
            if parent is None:
1577
 
                raise BzrCommandError("No missing location known or specified.")
1578
 
            else:
1579
 
                if not quiet:
1580
 
                    print "Using last location: %s" % parent
1581
 
                remote = 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)
1586
 
 
1587
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1588
 
 
1589
 
 
1590
1434
class cmd_plugins(Command):
1591
1435
    """List plugins"""
1592
1436
    hidden = True
1619
1463
    'no-recurse':             None,
1620
1464
    'profile':                None,
1621
1465
    'revision':               _parse_revision_str,
1622
 
    'short':                  None,
1623
1466
    'show-ids':               None,
1624
1467
    'timezone':               str,
1625
1468
    'verbose':                None,
1629
1472
    'update':                 None,
1630
1473
    'long':                   None,
1631
1474
    'root':                   str,
1632
 
    'no-backup':              None,
1633
 
    'merge-type':             get_merge_type,
1634
1475
    }
1635
1476
 
1636
1477
SHORT_OPTIONS = {
1786
1627
    return argdict
1787
1628
 
1788
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
 
1789
1701
 
1790
1702
def run_bzr(argv):
1791
1703
    """Execute a command.
1792
1704
 
1793
1705
    This is similar to main(), but without all the trappings for
1794
1706
    logging and error handling.  
1795
 
    
1796
 
    argv
1797
 
       The command-line arguments, without the program name from argv[0]
1798
 
    
1799
 
    Returns a command status or raises an exception.
1800
 
 
1801
 
    Special master options: these must come before the command because
1802
 
    they control how the command is interpreted.
1803
 
 
1804
 
    --no-plugins
1805
 
        Do not load plugin modules at all
1806
 
 
1807
 
    --builtin
1808
 
        Only use builtin commands.  (Plugins are still allowed to change
1809
 
        other behaviour.)
1810
 
 
1811
 
    --profile
1812
 
        Run under the Python profiler.
1813
1707
    """
1814
 
    
1815
1708
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1816
 
 
1817
 
    opt_profile = opt_no_plugins = opt_builtin = False
1818
 
 
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.
1822
 
 
1823
 
    for a in argv[:]:
1824
 
        if a == '--profile':
1825
 
            opt_profile = True
1826
 
        elif a == '--no-plugins':
1827
 
            opt_no_plugins = True
1828
 
        elif a == '--builtin':
1829
 
            opt_builtin = True
1830
 
        else:
1831
 
            break
1832
 
        argv.remove(a)
1833
 
 
1834
 
    if not opt_no_plugins:
1835
 
        from bzrlib.plugin import load_plugins
1836
 
        load_plugins()
1837
 
 
1838
 
    args, opts = parse_args(argv)
1839
 
 
1840
 
    if 'help' in opts:
1841
 
        from bzrlib.help import help
1842
 
        if args:
1843
 
            help(args[0])
1844
 
        else:
1845
 
            help()
1846
 
        return 0            
1847
 
        
1848
 
    if 'version' in opts:
1849
 
        show_version()
1850
 
        return 0
1851
1709
    
1852
 
    if not args:
1853
 
        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()
1854
1744
        return 1
1855
 
    
1856
 
    cmd = str(args.pop(0))
1857
 
 
1858
 
    canonical_cmd, cmd_class = \
1859
 
                   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']
1860
1756
 
1861
1757
    # check options are reasonable
1862
1758
    allowed = cmd_class.takes_options
1871
1767
    for k, v in opts.items():
1872
1768
        cmdopts[k.replace('-', '_')] = v
1873
1769
 
1874
 
    if opt_profile:
 
1770
    if profile:
1875
1771
        import hotshot, tempfile
1876
1772
        pffileno, pfname = tempfile.mkstemp()
1877
1773
        try:
1898
1794
 
1899
1795
def _report_exception(summary, quiet=False):
1900
1796
    import traceback
1901
 
    
1902
1797
    log_error('bzr: ' + summary)
1903
1798
    bzrlib.trace.log_exception()
1904
1799
 
1905
 
    if os.environ.get('BZR_DEBUG'):
1906
 
        traceback.print_exc()
1907
 
 
1908
1800
    if not quiet:
1909
 
        sys.stderr.write('\n')
1910
1801
        tb = sys.exc_info()[2]
1911
1802
        exinfo = traceback.extract_tb(tb)
1912
1803
        if exinfo:
1922
1813
    try:
1923
1814
        try:
1924
1815
            try:
1925
 
                return run_bzr(argv[1:])
 
1816
                return run_bzr(argv)
1926
1817
            finally:
1927
1818
                # do this here inside the exception wrappers to catch EPIPE
1928
1819
                sys.stdout.flush()
1929
1820
        except BzrError, e:
1930
1821
            quiet = isinstance(e, (BzrCommandError))
1931
 
            _report_exception('error: ' + str(e), quiet=quiet)
 
1822
            _report_exception('error: ' + e.args[0], quiet=quiet)
1932
1823
            if len(e.args) > 1:
1933
1824
                for h in e.args[1]:
1934
1825
                    # some explanation or hints