← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
 
20
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
61
62
    :cvar _fmt: Format string to display the error; this is expanded
62
63
    by the instance's dict.
63
64
    """
64
 
 
 
65
    
65
66
    internal_error = False
66
67
 
67
68
    def __init__(self, msg=None, **kwds):
72
73
        arguments can be given.  The first is for generic "user" errors which
73
74
        are not intended to be caught and so do not need a specific subclass.
74
75
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
76
        string to print the arguments.  
76
77
 
77
 
        Keyword arguments are taken as parameters to the error, which can
78
 
        be inserted into the format string template.  It's recommended
79
 
        that subclasses override the __init__ method to require specific
 
78
        Keyword arguments are taken as parameters to the error, which can 
 
79
        be inserted into the format string template.  It's recommended 
 
80
        that subclasses override the __init__ method to require specific 
80
81
        parameters.
81
82
 
82
83
        :param msg: If given, this is the literal complete text for the error,
83
 
           not subject to expansion. 'msg' is used instead of 'message' because
84
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
84
        not subject to expansion.
85
85
        """
86
86
        StandardError.__init__(self)
87
87
        if msg is not None:
102
102
            fmt = self._get_format_string()
103
103
            if fmt:
104
104
                d = dict(self.__dict__)
 
105
                # special case: python2.5 puts the 'message' attribute in a
 
106
                # slot, so it isn't seen in __dict__
 
107
                d['message'] = getattr(self, 'message', 'no message')
105
108
                s = fmt % d
106
109
                # __str__() should always return a 'str' object
107
110
                # never a 'unicode' object.
123
126
            # return a unicode object.
124
127
            u = unicode(u)
125
128
        return u
126
 
 
 
129
    
127
130
    def __str__(self):
128
131
        s = self._format()
129
132
        if isinstance(s, unicode):
133
136
            s = str(s)
134
137
        return s
135
138
 
136
 
    def __repr__(self):
137
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
138
 
 
139
139
    def _get_format_string(self):
140
140
        """Return format string for this exception or None"""
141
141
        fmt = getattr(self, '_fmt', None)
154
154
               )
155
155
 
156
156
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
 
157
        if self.__class__ != other.__class__:
158
158
            return NotImplemented
159
159
        return self.__dict__ == other.__dict__
160
160
 
204
204
 
205
205
 
206
206
class AlreadyBuilding(BzrError):
207
 
 
 
207
    
208
208
    _fmt = "The tree builder is already building a tree."
209
209
 
210
210
 
216
216
 
217
217
 
218
218
class BzrCheckError(InternalBzrError):
219
 
 
220
 
    _fmt = "Internal check failed: %(msg)s"
221
 
 
222
 
    def __init__(self, msg):
 
219
    
 
220
    _fmt = "Internal check failed: %(message)s"
 
221
 
 
222
    def __init__(self, message):
223
223
        BzrError.__init__(self)
224
 
        self.msg = msg
 
224
        self.message = message
225
225
 
226
226
 
227
227
class DirstateCorrupt(BzrError):
265
265
 
266
266
 
267
267
class InvalidEntryName(InternalBzrError):
268
 
 
 
268
    
269
269
    _fmt = "Invalid entry name: %(name)s"
270
270
 
271
271
    def __init__(self, name):
274
274
 
275
275
 
276
276
class InvalidRevisionNumber(BzrError):
277
 
 
 
277
    
278
278
    _fmt = "Invalid revision number %(revno)s"
279
279
 
280
280
    def __init__(self, revno):
329
329
class NoSuchId(BzrError):
330
330
 
331
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
332
    
333
333
    def __init__(self, tree, file_id):
334
334
        BzrError.__init__(self)
335
335
        self.file_id = file_id
362
362
class NoWorkingTree(BzrError):
363
363
 
364
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
365
    
366
366
    def __init__(self, base):
367
367
        BzrError.__init__(self)
368
368
        self.base = base
477
477
    def __init__(self, name, value):
478
478
        BzrError.__init__(self, name=name, value=value)
479
479
 
480
 
 
 
480
    
481
481
class StrictCommitFailed(BzrError):
482
482
 
483
483
    _fmt = "Commit refused because there are unknown files in the tree"
486
486
# XXX: Should be unified with TransportError; they seem to represent the
487
487
# same thing
488
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
 
# - this is finer than a TransportError - and more useful as such. It
 
489
# - this is finer than a TransportError - and more useful as such. It 
490
490
# differentiates between 'transport has failed' and 'operation on a transport
491
491
# has failed.'
492
492
class PathError(BzrError):
493
 
 
 
493
    
494
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
495
 
496
496
    def __init__(self, path, extra=None):
550
550
 
551
551
 
552
552
class ReadingCompleted(InternalBzrError):
553
 
 
 
553
    
554
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
555
            "called upon it - the request has been completed and no more "
556
556
            "data may be read.")
636
636
        self.url = url
637
637
 
638
638
 
639
 
class UnstackableLocationError(BzrError):
640
 
 
641
 
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
642
 
 
643
 
    def __init__(self, branch_url, target_url):
644
 
        BzrError.__init__(self)
645
 
        self.branch_url = branch_url
646
 
        self.target_url = target_url
647
 
 
648
 
 
649
639
class UnstackableRepositoryFormat(BzrError):
650
640
 
651
641
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
658
648
 
659
649
 
660
650
class ReadError(PathError):
661
 
 
 
651
    
662
652
    _fmt = """Error reading from %(path)r."""
663
653
 
664
654
 
699
689
 
700
690
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
691
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
692
# TODO: Probably this behavior of should be a common superclass 
703
693
class NotBranchError(PathError):
704
694
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
695
    _fmt = 'Not a branch: "%(path)s".'
706
696
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
697
    def __init__(self, path):
708
698
       import bzrlib.urlutils as urlutils
709
 
       path = urlutils.unescape_for_display(path, 'ascii')
710
 
       if detail is not None:
711
 
           detail = ': ' + detail
712
 
       self.detail = detail
713
 
       self.bzrdir = bzrdir
714
 
       PathError.__init__(self, path=path)
715
 
 
716
 
    def _format(self):
717
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
 
        # Python 2.4 have to be old-style classes so properties don't work.
719
 
        # Instead we override _format.
720
 
        if self.detail is None:
721
 
            if self.bzrdir is not None:
722
 
                try:
723
 
                    self.bzrdir.open_repository()
724
 
                except NoRepositoryPresent:
725
 
                    self.detail = ''
726
 
                else:
727
 
                    self.detail = ': location is a repository'
728
 
            else:
729
 
                self.detail = ''
730
 
        return PathError._format(self)
 
699
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
700
 
732
701
 
733
702
class NoSubmitBranch(PathError):
795
764
 
796
765
 
797
766
class UnknownFormatError(BzrError):
798
 
 
 
767
    
799
768
    _fmt = "Unknown %(kind)s format: %(format)r"
800
769
 
801
770
    def __init__(self, format, kind='branch'):
804
773
 
805
774
 
806
775
class IncompatibleFormat(BzrError):
807
 
 
 
776
    
808
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
778
 
810
779
    def __init__(self, format, bzrdir_format):
814
783
 
815
784
 
816
785
class IncompatibleRepositories(BzrError):
817
 
    """Report an error that two repositories are not compatible.
818
 
 
819
 
    Note that the source and target repositories are permitted to be strings:
820
 
    this exception is thrown from the smart server and may refer to a
821
 
    repository the client hasn't opened.
822
 
    """
823
786
 
824
787
    _fmt = "%(target)s\n" \
825
788
            "is not compatible with\n" \
833
796
 
834
797
 
835
798
class IncompatibleRevision(BzrError):
836
 
 
 
799
    
837
800
    _fmt = "Revision is not compatible with %(repo_format)s"
838
801
 
839
802
    def __init__(self, repo_format):
1040
1003
 
1041
1004
class LockContention(LockError):
1042
1005
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1006
    _fmt = 'Could not acquire lock "%(lock)s"'
1044
1007
    # TODO: show full url for lock, combining the transport and relative
1045
1008
    # bits?
1046
1009
 
1047
1010
    internal_error = False
1048
1011
 
1049
 
    def __init__(self, lock, msg=''):
 
1012
    def __init__(self, lock):
1050
1013
        self.lock = lock
1051
 
        self.msg = msg
1052
1014
 
1053
1015
 
1054
1016
class LockBroken(LockError):
1168
1130
 
1169
1131
class NoSuchRevisionInTree(NoSuchRevision):
1170
1132
    """When using Tree.revision_tree, and the revision is not accessible."""
1171
 
 
 
1133
    
1172
1134
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1173
1135
 
1174
1136
    def __init__(self, tree, revision_id):
1179
1141
 
1180
1142
class InvalidRevisionSpec(BzrError):
1181
1143
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1144
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1145
            " %(branch)s%(extra)s")
1184
1146
 
1185
1147
    def __init__(self, spec, branch, extra=None):
1210
1172
class DivergedBranches(BzrError):
1211
1173
 
1212
1174
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1175
            " Use the merge command to reconcile them.")
1215
1176
 
1216
1177
    def __init__(self, branch1, branch2):
1217
1178
        self.branch1 = branch1
1239
1200
 
1240
1201
 
1241
1202
class NoCommonAncestor(BzrError):
1242
 
 
 
1203
    
1243
1204
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1205
 
1245
1206
    def __init__(self, revision_a, revision_b):
1265
1226
            not_ancestor_id=not_ancestor_id)
1266
1227
 
1267
1228
 
 
1229
class InstallFailed(BzrError):
 
1230
 
 
1231
    def __init__(self, revisions):
 
1232
        revision_str = ", ".join(str(r) for r in revisions)
 
1233
        msg = "Could not install revisions:\n%s" % revision_str
 
1234
        BzrError.__init__(self, msg)
 
1235
        self.revisions = revisions
 
1236
 
 
1237
 
1268
1238
class AmbiguousBase(BzrError):
1269
1239
 
1270
1240
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1241
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1242
                DeprecationWarning)
1273
1243
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1244
                % ", ".join(bases))
1275
1245
        BzrError.__init__(self, msg)
1297
1267
class BoundBranchOutOfDate(BzrError):
1298
1268
 
1299
1269
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1270
            " %(master)s.")
1301
1271
 
1302
1272
    def __init__(self, branch, master):
1303
1273
        BzrError.__init__(self)
1304
1274
        self.branch = branch
1305
1275
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1276
 
 
1277
        
1309
1278
class CommitToDoubleBoundBranch(BzrError):
1310
1279
 
1311
1280
    _fmt = ("Cannot commit to branch %(branch)s."
1341
1310
 
1342
1311
class WeaveError(BzrError):
1343
1312
 
1344
 
    _fmt = "Error in processing weave: %(msg)s"
 
1313
    _fmt = "Error in processing weave: %(message)s"
1345
1314
 
1346
 
    def __init__(self, msg=None):
 
1315
    def __init__(self, message=None):
1347
1316
        BzrError.__init__(self)
1348
 
        self.msg = msg
 
1317
        self.message = message
1349
1318
 
1350
1319
 
1351
1320
class WeaveRevisionAlreadyPresent(WeaveError):
1381
1350
class WeaveParentMismatch(WeaveError):
1382
1351
 
1383
1352
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1353
    
1385
1354
 
1386
1355
class WeaveInvalidChecksum(WeaveError):
1387
1356
 
1413
1382
 
1414
1383
 
1415
1384
class VersionedFileError(BzrError):
1416
 
 
 
1385
    
1417
1386
    _fmt = "Versioned file error"
1418
1387
 
1419
1388
 
1420
1389
class RevisionNotPresent(VersionedFileError):
1421
 
 
 
1390
    
1422
1391
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1423
1392
 
1424
1393
    def __init__(self, revision_id, file_id):
1428
1397
 
1429
1398
 
1430
1399
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
 
1400
    
1432
1401
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1433
1402
 
1434
1403
    def __init__(self, revision_id, file_id):
1443
1412
 
1444
1413
 
1445
1414
class KnitError(InternalBzrError):
1446
 
 
 
1415
    
1447
1416
    _fmt = "Knit error"
1448
1417
 
1449
1418
 
1457
1426
        self.how = how
1458
1427
 
1459
1428
 
1460
 
class SHA1KnitCorrupt(KnitCorrupt):
1461
 
 
1462
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1463
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1464
 
        "sha %(actual)s")
1465
 
 
1466
 
    def __init__(self, filename, actual, expected, key, content):
1467
 
        KnitError.__init__(self)
1468
 
        self.filename = filename
1469
 
        self.actual = actual
1470
 
        self.expected = expected
1471
 
        self.key = key
1472
 
        self.content = content
1473
 
 
1474
 
 
1475
1429
class KnitDataStreamIncompatible(KnitError):
1476
1430
    # Not raised anymore, as we can convert data streams.  In future we may
1477
1431
    # need it again for more exotic cases, so we're keeping it around for now.
1481
1435
    def __init__(self, stream_format, target_format):
1482
1436
        self.stream_format = stream_format
1483
1437
        self.target_format = target_format
1484
 
 
 
1438
        
1485
1439
 
1486
1440
class KnitDataStreamUnknown(KnitError):
1487
1441
    # Indicates a data stream we don't know how to handle.
1490
1444
 
1491
1445
    def __init__(self, stream_format):
1492
1446
        self.stream_format = stream_format
1493
 
 
 
1447
        
1494
1448
 
1495
1449
class KnitHeaderError(KnitError):
1496
1450
 
1506
1460
 
1507
1461
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1462
    """
1509
 
 
 
1463
    
1510
1464
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1465
            " in options: %(options)r")
1512
1466
 
1516
1470
        self.options = options
1517
1471
 
1518
1472
 
1519
 
class RetryWithNewPacks(BzrError):
1520
 
    """Raised when we realize that the packs on disk have changed.
1521
 
 
1522
 
    This is meant as more of a signaling exception, to trap between where a
1523
 
    local error occurred and the code that can actually handle the error and
1524
 
    code that can retry appropriately.
1525
 
    """
1526
 
 
1527
 
    internal_error = True
1528
 
 
1529
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1530
 
            " %(orig_error)s")
1531
 
 
1532
 
    def __init__(self, context, reload_occurred, exc_info):
1533
 
        """create a new RetryWithNewPacks error.
1534
 
 
1535
 
        :param reload_occurred: Set to True if we know that the packs have
1536
 
            already been reloaded, and we are failing because of an in-memory
1537
 
            cache miss. If set to True then we will ignore if a reload says
1538
 
            nothing has changed, because we assume it has already reloaded. If
1539
 
            False, then a reload with nothing changed will force an error.
1540
 
        :param exc_info: The original exception traceback, so if there is a
1541
 
            problem we can raise the original error (value from sys.exc_info())
1542
 
        """
1543
 
        BzrError.__init__(self)
1544
 
        self.reload_occurred = reload_occurred
1545
 
        self.exc_info = exc_info
1546
 
        self.orig_error = exc_info[1]
1547
 
        # TODO: The global error handler should probably treat this by
1548
 
        #       raising/printing the original exception with a bit about
1549
 
        #       RetryWithNewPacks also not being caught
1550
 
 
1551
 
 
1552
 
class RetryAutopack(RetryWithNewPacks):
1553
 
    """Raised when we are autopacking and we find a missing file.
1554
 
 
1555
 
    Meant as a signaling exception, to tell the autopack code it should try
1556
 
    again.
1557
 
    """
1558
 
 
1559
 
    internal_error = True
1560
 
 
1561
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1562
 
            " context: %(context)s %(orig_error)s")
1563
 
 
1564
 
 
1565
1473
class NoSuchExportFormat(BzrError):
1566
 
 
 
1474
    
1567
1475
    _fmt = "Export format %(format)r not supported"
1568
1476
 
1569
1477
    def __init__(self, format):
1572
1480
 
1573
1481
 
1574
1482
class TransportError(BzrError):
1575
 
 
 
1483
    
1576
1484
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1485
 
1578
1486
    def __init__(self, msg=None, orig_error=None):
1623
1531
 
1624
1532
class SmartMessageHandlerError(InternalBzrError):
1625
1533
 
1626
 
    _fmt = ("The message handler raised an exception:\n"
1627
 
            "%(traceback_text)s")
 
1534
    _fmt = "The message handler raised an exception: %(exc_value)s."
1628
1535
 
1629
1536
    def __init__(self, exc_info):
1630
 
        import traceback
1631
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1632
 
        self.exc_info = exc_info
1633
 
        traceback_strings = traceback.format_exception(
1634
 
                self.exc_type, self.exc_value, self.exc_tb)
1635
 
        self.traceback_text = ''.join(traceback_strings)
1636
 
 
 
1537
        self.exc_type, self.exc_value, self.tb = exc_info
 
1538
        
1637
1539
 
1638
1540
# A set of semi-meaningful errors which can be thrown
1639
1541
class TransportNotPossible(TransportError):
1665
1567
            self.port = ':%s' % port
1666
1568
 
1667
1569
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1570
class ConnectionReset(TransportError):
1671
1571
 
1672
1572
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1713
1613
 
1714
1614
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1615
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1616
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1617
        self.source = source
1718
1618
        self.target = target
1719
1619
        if is_permanent:
1720
1620
            self.permanently = ' permanently'
1721
1621
        else:
1722
1622
            self.permanently = ''
 
1623
        self._qualified_proto = qual_proto
1723
1624
        TransportError.__init__(self)
1724
1625
 
 
1626
    def _requalify_url(self, url):
 
1627
        """Restore the qualified proto in front of the url"""
 
1628
        # When this exception is raised, source and target are in
 
1629
        # user readable format. But some transports may use a
 
1630
        # different proto (http+urllib:// will present http:// to
 
1631
        # the user. If a qualified proto is specified, the code
 
1632
        # trapping the exception can get the qualified urls to
 
1633
        # properly handle the redirection themself (creating a
 
1634
        # new transport object from the target url for example).
 
1635
        # But checking that the scheme of the original and
 
1636
        # redirected urls are the same can be tricky. (see the
 
1637
        # FIXME in BzrDir.open_from_transport for the unique use
 
1638
        # case so far).
 
1639
        if self._qualified_proto is None:
 
1640
            return url
 
1641
 
 
1642
        # The TODO related to NotBranchError mention that doing
 
1643
        # that kind of manipulation on the urls may not be the
 
1644
        # exception object job. On the other hand, this object is
 
1645
        # the interface between the code and the user so
 
1646
        # presenting the urls in different ways is indeed its
 
1647
        # job...
 
1648
        import urlparse
 
1649
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1650
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1651
                                   query, fragment))
 
1652
 
 
1653
    def get_source_url(self):
 
1654
        return self._requalify_url(self.source)
 
1655
 
 
1656
    def get_target_url(self):
 
1657
        return self._requalify_url(self.target)
 
1658
 
1725
1659
 
1726
1660
class TooManyRedirections(TransportError):
1727
1661
 
1739
1673
        if filename is None:
1740
1674
            filename = ""
1741
1675
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1676
            (filename, ('\n'.join(e.message for e in errors)))
1743
1677
        BzrError.__init__(self, message)
1744
1678
 
1745
1679
 
1762
1696
 
1763
1697
class WorkingTreeNotRevision(BzrError):
1764
1698
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1699
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1700
            " the last commit, but weave merge requires that it be"
1767
1701
            " unchanged")
1768
1702
 
1930
1864
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1931
1865
 
1932
1866
    def __init__(self, from_path='', to_path='', extra=None):
1933
 
        from bzrlib.osutils import splitpath
1934
1867
        BzrError.__init__(self)
1935
1868
        if extra:
1936
1869
            self.extra = ': ' + str(extra)
1940
1873
        has_from = len(from_path) > 0
1941
1874
        has_to = len(to_path) > 0
1942
1875
        if has_from:
1943
 
            self.from_path = splitpath(from_path)[-1]
 
1876
            self.from_path = osutils.splitpath(from_path)[-1]
1944
1877
        else:
1945
1878
            self.from_path = ''
1946
1879
 
1947
1880
        if has_to:
1948
 
            self.to_path = splitpath(to_path)[-1]
 
1881
            self.to_path = osutils.splitpath(to_path)[-1]
1949
1882
        else:
1950
1883
            self.to_path = ''
1951
1884
 
2034
1967
 
2035
1968
class BadConversionTarget(BzrError):
2036
1969
 
2037
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2038
 
            "    %(problem)s"
 
1970
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2039
1971
 
2040
 
    def __init__(self, problem, format, from_format=None):
 
1972
    def __init__(self, problem, format):
2041
1973
        BzrError.__init__(self)
2042
1974
        self.problem = problem
2043
1975
        self.format = format
2044
 
        self.from_format = from_format or '(unspecified)'
2045
1976
 
2046
1977
 
2047
1978
class NoDiffFound(BzrError):
2084
2015
    _fmt = """This tree contains left-over files from a failed operation.
2085
2016
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2086
2017
    keep, and delete it when you are done."""
2087
 
 
 
2018
    
2088
2019
    def __init__(self, limbo_dir):
2089
2020
       BzrError.__init__(self)
2090
2021
       self.limbo_dir = limbo_dir
2123
2054
 
2124
2055
class OutOfDateTree(BzrError):
2125
2056
 
2126
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2057
    _fmt = "Working tree is out of date, please run 'bzr update'."
2127
2058
 
2128
 
    def __init__(self, tree, more=None):
2129
 
        if more is None:
2130
 
            more = ''
2131
 
        else:
2132
 
            more = ' ' + more
 
2059
    def __init__(self, tree):
2133
2060
        BzrError.__init__(self)
2134
2061
        self.tree = tree
2135
 
        self.more = more
2136
2062
 
2137
2063
 
2138
2064
class PublicBranchOutOfDate(BzrError):
2176
2102
 
2177
2103
    def __init__(self, repo):
2178
2104
        BzrError.__init__(self)
2179
 
        self.repo_path = repo.user_url
 
2105
        self.repo_path = repo.bzrdir.root_transport.base
2180
2106
 
2181
2107
 
2182
2108
class InconsistentDelta(BzrError):
2192
2118
        self.reason = reason
2193
2119
 
2194
2120
 
2195
 
class InconsistentDeltaDelta(InconsistentDelta):
2196
 
    """Used when we get a delta that is not valid."""
2197
 
 
2198
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2199
 
            "\nreason: %(reason)s")
2200
 
 
2201
 
    def __init__(self, delta, reason):
2202
 
        BzrError.__init__(self)
2203
 
        self.delta = delta
2204
 
        self.reason = reason
2205
 
 
2206
 
 
2207
2121
class UpgradeRequired(BzrError):
2208
2122
 
2209
2123
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2218
2132
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2219
2133
 
2220
2134
 
2221
 
class RichRootUpgradeRequired(UpgradeRequired):
2222
 
 
2223
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2224
 
           " a format which supports rich roots.")
2225
 
 
2226
 
 
2227
2135
class LocalRequiresBoundBranch(BzrError):
2228
2136
 
2229
2137
    _fmt = "Cannot perform local-only commits on unbound branches."
2230
2138
 
2231
2139
 
 
2140
class MissingProgressBarFinish(BzrError):
 
2141
 
 
2142
    _fmt = "A nested progress bar was not 'finished' correctly."
 
2143
 
 
2144
 
 
2145
class InvalidProgressBarType(BzrError):
 
2146
 
 
2147
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2148
            " is not a supported type Select one of: %(valid_types)s")
 
2149
 
 
2150
    def __init__(self, bar_type, valid_types):
 
2151
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2152
 
 
2153
 
2232
2154
class UnsupportedOperation(BzrError):
2233
2155
 
2234
2156
    _fmt = ("The method %(mname)s is not supported on"
2251
2173
 
2252
2174
 
2253
2175
class BinaryFile(BzrError):
2254
 
 
 
2176
    
2255
2177
    _fmt = "File is binary but should be text."
2256
2178
 
2257
2179
 
2277
2199
 
2278
2200
 
2279
2201
class NotABundle(BzrError):
2280
 
 
 
2202
    
2281
2203
    _fmt = "Not a bzr revision-bundle: %(text)r"
2282
2204
 
2283
2205
    def __init__(self, text):
2285
2207
        self.text = text
2286
2208
 
2287
2209
 
2288
 
class BadBundle(BzrError):
2289
 
 
 
2210
class BadBundle(BzrError): 
 
2211
    
2290
2212
    _fmt = "Bad bzr revision-bundle: %(text)r"
2291
2213
 
2292
2214
    def __init__(self, text):
2294
2216
        self.text = text
2295
2217
 
2296
2218
 
2297
 
class MalformedHeader(BadBundle):
2298
 
 
 
2219
class MalformedHeader(BadBundle): 
 
2220
    
2299
2221
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2300
2222
 
2301
2223
 
2302
 
class MalformedPatches(BadBundle):
2303
 
 
 
2224
class MalformedPatches(BadBundle): 
 
2225
    
2304
2226
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2305
2227
 
2306
2228
 
2307
 
class MalformedFooter(BadBundle):
2308
 
 
 
2229
class MalformedFooter(BadBundle): 
 
2230
    
2309
2231
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2310
2232
 
2311
2233
 
2312
2234
class UnsupportedEOLMarker(BadBundle):
2313
 
 
2314
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2235
    
 
2236
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2315
2237
 
2316
2238
    def __init__(self):
2317
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2239
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2318
2240
        # but for this there is not
2319
2241
        BzrError.__init__(self)
2320
2242
 
2321
2243
 
2322
2244
class IncompatibleBundleFormat(BzrError):
2323
 
 
 
2245
    
2324
2246
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2325
2247
 
2326
2248
    def __init__(self, bundle_format, other):
2330
2252
 
2331
2253
 
2332
2254
class BadInventoryFormat(BzrError):
2333
 
 
 
2255
    
2334
2256
    _fmt = "Root class for inventory serialization errors"
2335
2257
 
2336
2258
 
2355
2277
        self.transport = transport
2356
2278
 
2357
2279
 
 
2280
class NoSmartServer(NotBranchError):
 
2281
 
 
2282
    _fmt = "No smart server available at %(url)s"
 
2283
 
 
2284
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
2285
    def __init__(self, url):
 
2286
        self.url = url
 
2287
 
 
2288
 
2358
2289
class UnknownSSH(BzrError):
2359
2290
 
2360
2291
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2380
2311
        self.revision_id = revision_id
2381
2312
        self.ghost_revision_id = ghost_revision_id
2382
2313
 
2383
 
 
 
2314
        
2384
2315
class GhostRevisionUnusableHere(BzrError):
2385
2316
 
2386
2317
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2478
2409
 
2479
2410
 
2480
2411
class UnsupportedInventoryKind(BzrError):
2481
 
 
 
2412
    
2482
2413
    _fmt = """Unsupported entry kind %(kind)s"""
2483
2414
 
2484
2415
    def __init__(self, kind):
2496
2427
 
2497
2428
 
2498
2429
class SubsumeTargetNeedsUpgrade(BzrError):
2499
 
 
 
2430
    
2500
2431
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2501
2432
 
2502
2433
    def __init__(self, other_tree):
2530
2461
    def __init__(self, branch):
2531
2462
        self.branch = branch
2532
2463
 
2533
 
 
 
2464
        
2534
2465
class TagAlreadyExists(BzrError):
2535
2466
 
2536
2467
    _fmt = "Tag %(tag_name)s already exists."
2541
2472
 
2542
2473
class MalformedBugIdentifier(BzrError):
2543
2474
 
2544
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2545
 
            'See "bzr help bugs" for more information on this feature.')
 
2475
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2546
2476
 
2547
2477
    def __init__(self, bug_id, reason):
2548
2478
        self.bug_id = bug_id
2569
2499
        self.branch = branch
2570
2500
 
2571
2501
 
2572
 
class InvalidLineInBugsProperty(BzrError):
2573
 
 
2574
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2575
 
 
2576
 
    def __init__(self, line):
2577
 
        self.line = line
2578
 
 
2579
 
 
2580
 
class InvalidBugStatus(BzrError):
2581
 
 
2582
 
    _fmt = ("Invalid bug status: '%(status)s'")
2583
 
 
2584
 
    def __init__(self, status):
2585
 
        self.status = status
2586
 
 
2587
 
 
2588
2502
class UnexpectedSmartServerResponse(BzrError):
2589
2503
 
2590
2504
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2636
2550
        """
2637
2551
        self.error_from_smart_server = error_from_smart_server
2638
2552
        self.error_tuple = error_from_smart_server.error_tuple
2639
 
 
 
2553
        
2640
2554
 
2641
2555
class ContainerError(BzrError):
2642
2556
    """Base class of container errors."""
2645
2559
class UnknownContainerFormatError(ContainerError):
2646
2560
 
2647
2561
    _fmt = "Unrecognised container format: %(container_format)r"
2648
 
 
 
2562
    
2649
2563
    def __init__(self, container_format):
2650
2564
        self.container_format = container_format
2651
2565
 
2715
2629
 
2716
2630
class NoMailAddressSpecified(BzrError):
2717
2631
 
2718
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2632
    _fmt = "No mail-to address specified."
2719
2633
 
2720
2634
 
2721
2635
class UnknownMailClient(BzrError):
2754
2668
 
2755
2669
    def __init__(self, bzrdir):
2756
2670
        import bzrlib.urlutils as urlutils
2757
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2671
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2758
2672
                                                    'ascii')
2759
2673
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2760
2674
 
2801
2715
    _fmt = "'%(display_url)s' is already standalone."
2802
2716
 
2803
2717
 
2804
 
class AlreadyWithTrees(BzrDirError):
2805
 
 
2806
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2807
 
            "working trees.")
2808
 
 
2809
 
 
2810
 
class AlreadyWithNoTrees(BzrDirError):
2811
 
 
2812
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2813
 
            "working trees.")
2814
 
 
2815
 
 
2816
2718
class ReconfigurationNotSupported(BzrDirError):
2817
2719
 
2818
2720
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2825
2727
 
2826
2728
class UncommittedChanges(BzrError):
2827
2729
 
2828
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
 
            ' (See bzr status).%(more)s')
 
2730
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2830
2731
 
2831
 
    def __init__(self, tree, more=None):
2832
 
        if more is None:
2833
 
            more = ''
2834
 
        else:
2835
 
            more = ' ' + more
 
2732
    def __init__(self, tree):
2836
2733
        import bzrlib.urlutils as urlutils
2837
2734
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
2839
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2735
            tree.bzrdir.root_transport.base, 'ascii')
 
2736
        BzrError.__init__(self, tree=tree, display_url=display_url)
2840
2737
 
2841
2738
 
2842
2739
class MissingTemplateVariable(BzrError):
2877
2774
 
2878
2775
 
2879
2776
class CommandAvailableInPlugin(StandardError):
2880
 
 
 
2777
    
2881
2778
    internal_error = False
2882
2779
 
2883
2780
    def __init__(self, cmd_name, plugin_metadata, provider):
2884
 
 
 
2781
        
2885
2782
        self.plugin_metadata = plugin_metadata
2886
2783
        self.cmd_name = cmd_name
2887
2784
        self.provider = provider
2888
2785
 
2889
2786
    def __str__(self):
2890
2787
 
2891
 
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2788
        _fmt = ('"%s" is not a standard bzr command. \n' 
2892
2789
                'However, the following official plugin provides this command: %s\n'
2893
2790
                'You can install it by going to: %s'
2894
 
                % (self.cmd_name, self.plugin_metadata['name'],
 
2791
                % (self.cmd_name, self.plugin_metadata['name'], 
2895
2792
                    self.plugin_metadata['url']))
2896
2793
 
2897
2794
        return _fmt
2898
2795
 
2899
2796
 
2900
2797
class NoPluginAvailable(BzrError):
2901
 
    pass
 
2798
    pass    
 
2799
 
 
2800
 
 
2801
class NotATerminal(BzrError):
 
2802
 
 
2803
    _fmt = 'Unable to ask for a password without real terminal.'
2902
2804
 
2903
2805
 
2904
2806
class UnableEncodePath(BzrError):
2907
2809
            'user encoding %(user_encoding)s')
2908
2810
 
2909
2811
    def __init__(self, path, kind):
2910
 
        from bzrlib.osutils import get_user_encoding
2911
2812
        self.path = path
2912
2813
        self.kind = kind
2913
2814
        self.user_encoding = osutils.get_user_encoding()
2948
2849
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2949
2850
 
2950
2851
    def __init__(self, host, port, orig_error):
2951
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2952
2852
        BzrError.__init__(self, host=host, port=port,
2953
 
            orig_error=repr(orig_error.args))
 
2853
            orig_error=orig_error[1])
2954
2854
 
2955
2855
 
2956
2856
class UnknownRules(BzrError):
2964
2864
class HookFailed(BzrError):
2965
2865
    """Raised when a pre_change_branch_tip hook function fails anything other
2966
2866
    than TipChangeRejected.
2967
 
 
2968
 
    Note that this exception is no longer raised, and the import is only left
2969
 
    to be nice to code which might catch it in a plugin.
2970
2867
    """
2971
2868
 
2972
2869
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
2870
            "%(traceback_text)s%(exc_value)s")
2974
2871
 
2975
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2976
 
        if warn:
2977
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2978
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2872
    def __init__(self, hook_stage, hook_name, exc_info):
2979
2873
        import traceback
2980
2874
        self.hook_stage = hook_stage
2981
2875
        self.hook_name = hook_name
2990
2884
    """A pre_change_branch_tip hook function may raise this to cleanly and
2991
2885
    explicitly abort a change to a branch tip.
2992
2886
    """
2993
 
 
 
2887
    
2994
2888
    _fmt = u"Tip change rejected: %(msg)s"
2995
2889
 
2996
2890
    def __init__(self, msg):
2997
2891
        self.msg = msg
2998
2892
 
2999
 
 
3000
 
class ShelfCorrupt(BzrError):
3001
 
 
3002
 
    _fmt = "Shelf corrupt."
3003
 
 
3004
 
 
3005
 
class NoSuchShelfId(BzrError):
3006
 
 
3007
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3008
 
 
3009
 
    def __init__(self, shelf_id):
3010
 
        BzrError.__init__(self, shelf_id=shelf_id)
3011
 
 
3012
 
 
3013
 
class InvalidShelfId(BzrError):
3014
 
 
3015
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3016
 
 
3017
 
    def __init__(self, invalid_id):
3018
 
        BzrError.__init__(self, invalid_id=invalid_id)
3019
 
 
3020
 
 
3021
 
class JailBreak(BzrError):
3022
 
 
3023
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3024
 
 
3025
 
    def __init__(self, url):
3026
 
        BzrError.__init__(self, url=url)
3027
 
 
3028
 
 
3029
 
class UserAbort(BzrError):
3030
 
 
3031
 
    _fmt = 'The user aborted the operation.'
3032
 
 
3033
 
 
3034
 
class MustHaveWorkingTree(BzrError):
3035
 
 
3036
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3037
 
 
3038
 
    def __init__(self, format, url):
3039
 
        BzrError.__init__(self, format=format, url=url)
3040
 
 
3041
 
 
3042
 
class NoSuchView(BzrError):
3043
 
    """A view does not exist.
3044
 
    """
3045
 
 
3046
 
    _fmt = u"No such view: %(view_name)s."
3047
 
 
3048
 
    def __init__(self, view_name):
3049
 
        self.view_name = view_name
3050
 
 
3051
 
 
3052
 
class ViewsNotSupported(BzrError):
3053
 
    """Views are not supported by a tree format.
3054
 
    """
3055
 
 
3056
 
    _fmt = ("Views are not supported by %(tree)s;"
3057
 
            " use 'bzr upgrade' to change your tree to a later format.")
3058
 
 
3059
 
    def __init__(self, tree):
3060
 
        self.tree = tree
3061
 
 
3062
 
 
3063
 
class FileOutsideView(BzrError):
3064
 
 
3065
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3066
 
            '%(view_str)s')
3067
 
 
3068
 
    def __init__(self, file_name, view_files):
3069
 
        self.file_name = file_name
3070
 
        self.view_str = ", ".join(view_files)
3071
 
 
3072
 
 
3073
 
class UnresumableWriteGroup(BzrError):
3074
 
 
3075
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3076
 
            "%(write_groups)r: %(reason)s")
3077
 
 
3078
 
    internal_error = True
3079
 
 
3080
 
    def __init__(self, repository, write_groups, reason):
3081
 
        self.repository = repository
3082
 
        self.write_groups = write_groups
3083
 
        self.reason = reason
3084
 
 
3085
 
 
3086
 
class UnsuspendableWriteGroup(BzrError):
3087
 
 
3088
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3089
 
 
3090
 
    internal_error = True
3091
 
 
3092
 
    def __init__(self, repository):
3093
 
        self.repository = repository
3094
 
 
3095
 
 
3096
 
class LossyPushToSameVCS(BzrError):
3097
 
 
3098
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3099
 
            "%(target_branch)r that are in the same VCS.")
3100
 
 
3101
 
    internal_error = True
3102
 
 
3103
 
    def __init__(self, source_branch, target_branch):
3104
 
        self.source_branch = source_branch
3105
 
        self.target_branch = target_branch
3106
 
 
3107
 
 
3108
 
class NoRoundtrippingSupport(BzrError):
3109
 
 
3110
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3111
 
            "%(target_branch)r.")
3112
 
 
3113
 
    internal_error = True
3114
 
 
3115
 
    def __init__(self, source_branch, target_branch):
3116
 
        self.source_branch = source_branch
3117
 
        self.target_branch = target_branch
3118
 
 
3119
 
 
3120
 
class FileTimestampUnavailable(BzrError):
3121
 
 
3122
 
    _fmt = "The filestamp for %(path)s is not available."
3123
 
 
3124
 
    internal_error = True
3125
 
 
3126
 
    def __init__(self, path):
3127
 
        self.path = path
3128
 
 
3129
 
 
3130
 
class NoColocatedBranchSupport(BzrError):
3131
 
 
3132
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3133
 
 
3134
 
    def __init__(self, bzrdir):
3135
 
        self.bzrdir = bzrdir
3136