/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/errors.py

  • Committer: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
 
21
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
62
61
    :cvar _fmt: Format string to display the error; this is expanded
63
62
    by the instance's dict.
64
63
    """
65
 
    
 
64
 
66
65
    internal_error = False
67
66
 
68
67
    def __init__(self, msg=None, **kwds):
73
72
        arguments can be given.  The first is for generic "user" errors which
74
73
        are not intended to be caught and so do not need a specific subclass.
75
74
        The second case is for use with subclasses that provide a _fmt format
76
 
        string to print the arguments.  
 
75
        string to print the arguments.
77
76
 
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 
 
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
81
80
        parameters.
82
81
 
83
82
        :param msg: If given, this is the literal complete text for the error,
84
 
        not subject to expansion.
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
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')
108
105
                s = fmt % d
109
106
                # __str__() should always return a 'str' object
110
107
                # never a 'unicode' object.
126
123
            # return a unicode object.
127
124
            u = unicode(u)
128
125
        return u
129
 
    
 
126
 
130
127
    def __str__(self):
131
128
        s = self._format()
132
129
        if isinstance(s, unicode):
136
133
            s = str(s)
137
134
        return s
138
135
 
 
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__ != other.__class__:
 
157
        if self.__class__ is not 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: %(message)s"
221
 
 
222
 
    def __init__(self, message):
 
219
 
 
220
    _fmt = "Internal check failed: %(msg)s"
 
221
 
 
222
    def __init__(self, msg):
223
223
        BzrError.__init__(self)
224
 
        self.message = message
 
224
        self.msg = msg
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
 
639
649
class UnstackableRepositoryFormat(BzrError):
640
650
 
641
651
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
648
658
 
649
659
 
650
660
class ReadError(PathError):
651
 
    
 
661
 
652
662
    _fmt = """Error reading from %(path)r."""
653
663
 
654
664
 
689
699
 
690
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
691
701
# the exception object is a bit undesirable.
692
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
693
703
class NotBranchError(PathError):
694
704
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
706
 
697
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
698
708
       import bzrlib.urlutils as urlutils
699
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
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)
700
731
 
701
732
 
702
733
class NoSubmitBranch(PathError):
764
795
 
765
796
 
766
797
class UnknownFormatError(BzrError):
767
 
    
 
798
 
768
799
    _fmt = "Unknown %(kind)s format: %(format)r"
769
800
 
770
801
    def __init__(self, format, kind='branch'):
773
804
 
774
805
 
775
806
class IncompatibleFormat(BzrError):
776
 
    
 
807
 
777
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
778
809
 
779
810
    def __init__(self, format, bzrdir_format):
783
814
 
784
815
 
785
816
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
    """
786
823
 
787
824
    _fmt = "%(target)s\n" \
788
825
            "is not compatible with\n" \
796
833
 
797
834
 
798
835
class IncompatibleRevision(BzrError):
799
 
    
 
836
 
800
837
    _fmt = "Revision is not compatible with %(repo_format)s"
801
838
 
802
839
    def __init__(self, repo_format):
1003
1040
 
1004
1041
class LockContention(LockError):
1005
1042
 
1006
 
    _fmt = 'Could not acquire lock "%(lock)s"'
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
1044
    # TODO: show full url for lock, combining the transport and relative
1008
1045
    # bits?
1009
1046
 
1010
1047
    internal_error = False
1011
1048
 
1012
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
1013
1050
        self.lock = lock
 
1051
        self.msg = msg
1014
1052
 
1015
1053
 
1016
1054
class LockBroken(LockError):
1130
1168
 
1131
1169
class NoSuchRevisionInTree(NoSuchRevision):
1132
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
1133
 
    
 
1171
 
1134
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1135
1173
 
1136
1174
    def __init__(self, tree, revision_id):
1141
1179
 
1142
1180
class InvalidRevisionSpec(BzrError):
1143
1181
 
1144
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1145
1183
            " %(branch)s%(extra)s")
1146
1184
 
1147
1185
    def __init__(self, spec, branch, extra=None):
1172
1210
class DivergedBranches(BzrError):
1173
1211
 
1174
1212
    _fmt = ("These branches have diverged."
1175
 
            " Use the merge command to reconcile them.")
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
1176
1215
 
1177
1216
    def __init__(self, branch1, branch2):
1178
1217
        self.branch1 = branch1
1200
1239
 
1201
1240
 
1202
1241
class NoCommonAncestor(BzrError):
1203
 
    
 
1242
 
1204
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1205
1244
 
1206
1245
    def __init__(self, revision_a, revision_b):
1226
1265
            not_ancestor_id=not_ancestor_id)
1227
1266
 
1228
1267
 
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
 
 
1238
1268
class AmbiguousBase(BzrError):
1239
1269
 
1240
1270
    def __init__(self, bases):
1241
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1242
 
                DeprecationWarning)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1243
1273
        msg = ("The correct base is unclear, because %s are all equally close"
1244
1274
                % ", ".join(bases))
1245
1275
        BzrError.__init__(self, msg)
1267
1297
class BoundBranchOutOfDate(BzrError):
1268
1298
 
1269
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1270
 
            " %(master)s.")
 
1300
            " %(master)s.%(extra_help)s")
1271
1301
 
1272
1302
    def __init__(self, branch, master):
1273
1303
        BzrError.__init__(self)
1274
1304
        self.branch = branch
1275
1305
        self.master = master
1276
 
 
1277
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
1278
1309
class CommitToDoubleBoundBranch(BzrError):
1279
1310
 
1280
1311
    _fmt = ("Cannot commit to branch %(branch)s."
1310
1341
 
1311
1342
class WeaveError(BzrError):
1312
1343
 
1313
 
    _fmt = "Error in processing weave: %(message)s"
 
1344
    _fmt = "Error in processing weave: %(msg)s"
1314
1345
 
1315
 
    def __init__(self, message=None):
 
1346
    def __init__(self, msg=None):
1316
1347
        BzrError.__init__(self)
1317
 
        self.message = message
 
1348
        self.msg = msg
1318
1349
 
1319
1350
 
1320
1351
class WeaveRevisionAlreadyPresent(WeaveError):
1350
1381
class WeaveParentMismatch(WeaveError):
1351
1382
 
1352
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1353
 
    
 
1384
 
1354
1385
 
1355
1386
class WeaveInvalidChecksum(WeaveError):
1356
1387
 
1382
1413
 
1383
1414
 
1384
1415
class VersionedFileError(BzrError):
1385
 
    
 
1416
 
1386
1417
    _fmt = "Versioned file error"
1387
1418
 
1388
1419
 
1389
1420
class RevisionNotPresent(VersionedFileError):
1390
 
    
 
1421
 
1391
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1392
1423
 
1393
1424
    def __init__(self, revision_id, file_id):
1397
1428
 
1398
1429
 
1399
1430
class RevisionAlreadyPresent(VersionedFileError):
1400
 
    
 
1431
 
1401
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1402
1433
 
1403
1434
    def __init__(self, revision_id, file_id):
1412
1443
 
1413
1444
 
1414
1445
class KnitError(InternalBzrError):
1415
 
    
 
1446
 
1416
1447
    _fmt = "Knit error"
1417
1448
 
1418
1449
 
1426
1457
        self.how = how
1427
1458
 
1428
1459
 
 
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
 
1429
1475
class KnitDataStreamIncompatible(KnitError):
1430
1476
    # Not raised anymore, as we can convert data streams.  In future we may
1431
1477
    # need it again for more exotic cases, so we're keeping it around for now.
1435
1481
    def __init__(self, stream_format, target_format):
1436
1482
        self.stream_format = stream_format
1437
1483
        self.target_format = target_format
1438
 
        
 
1484
 
1439
1485
 
1440
1486
class KnitDataStreamUnknown(KnitError):
1441
1487
    # Indicates a data stream we don't know how to handle.
1444
1490
 
1445
1491
    def __init__(self, stream_format):
1446
1492
        self.stream_format = stream_format
1447
 
        
 
1493
 
1448
1494
 
1449
1495
class KnitHeaderError(KnitError):
1450
1496
 
1460
1506
 
1461
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1462
1508
    """
1463
 
    
 
1509
 
1464
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1465
1511
            " in options: %(options)r")
1466
1512
 
1470
1516
        self.options = options
1471
1517
 
1472
1518
 
 
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
 
1473
1565
class NoSuchExportFormat(BzrError):
1474
 
    
 
1566
 
1475
1567
    _fmt = "Export format %(format)r not supported"
1476
1568
 
1477
1569
    def __init__(self, format):
1480
1572
 
1481
1573
 
1482
1574
class TransportError(BzrError):
1483
 
    
 
1575
 
1484
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1485
1577
 
1486
1578
    def __init__(self, msg=None, orig_error=None):
1531
1623
 
1532
1624
class SmartMessageHandlerError(InternalBzrError):
1533
1625
 
1534
 
    _fmt = "The message handler raised an exception: %(exc_value)s."
 
1626
    _fmt = ("The message handler raised an exception:\n"
 
1627
            "%(traceback_text)s")
1535
1628
 
1536
1629
    def __init__(self, exc_info):
1537
 
        self.exc_type, self.exc_value, self.tb = exc_info
1538
 
        
 
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
 
1539
1637
 
1540
1638
# A set of semi-meaningful errors which can be thrown
1541
1639
class TransportNotPossible(TransportError):
1567
1665
            self.port = ':%s' % port
1568
1666
 
1569
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1570
1670
class ConnectionReset(TransportError):
1571
1671
 
1572
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1613
1713
 
1614
1714
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1615
1715
 
1616
 
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1716
    def __init__(self, source, target, is_permanent=False):
1617
1717
        self.source = source
1618
1718
        self.target = target
1619
1719
        if is_permanent:
1620
1720
            self.permanently = ' permanently'
1621
1721
        else:
1622
1722
            self.permanently = ''
1623
 
        self._qualified_proto = qual_proto
1624
1723
        TransportError.__init__(self)
1625
1724
 
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
 
 
1659
1725
 
1660
1726
class TooManyRedirections(TransportError):
1661
1727
 
1673
1739
        if filename is None:
1674
1740
            filename = ""
1675
1741
        message = "Error(s) parsing config file %s:\n%s" % \
1676
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1742
            (filename, ('\n'.join(e.msg for e in errors)))
1677
1743
        BzrError.__init__(self, message)
1678
1744
 
1679
1745
 
1696
1762
 
1697
1763
class WorkingTreeNotRevision(BzrError):
1698
1764
 
1699
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1700
1766
            " the last commit, but weave merge requires that it be"
1701
1767
            " unchanged")
1702
1768
 
1864
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1865
1931
 
1866
1932
    def __init__(self, from_path='', to_path='', extra=None):
 
1933
        from bzrlib.osutils import splitpath
1867
1934
        BzrError.__init__(self)
1868
1935
        if extra:
1869
1936
            self.extra = ': ' + str(extra)
1873
1940
        has_from = len(from_path) > 0
1874
1941
        has_to = len(to_path) > 0
1875
1942
        if has_from:
1876
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1943
            self.from_path = splitpath(from_path)[-1]
1877
1944
        else:
1878
1945
            self.from_path = ''
1879
1946
 
1880
1947
        if has_to:
1881
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1948
            self.to_path = splitpath(to_path)[-1]
1882
1949
        else:
1883
1950
            self.to_path = ''
1884
1951
 
1967
2034
 
1968
2035
class BadConversionTarget(BzrError):
1969
2036
 
1970
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2037
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2038
            "    %(problem)s"
1971
2039
 
1972
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
1973
2041
        BzrError.__init__(self)
1974
2042
        self.problem = problem
1975
2043
        self.format = format
 
2044
        self.from_format = from_format or '(unspecified)'
1976
2045
 
1977
2046
 
1978
2047
class NoDiffFound(BzrError):
2015
2084
    _fmt = """This tree contains left-over files from a failed operation.
2016
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2017
2086
    keep, and delete it when you are done."""
2018
 
    
 
2087
 
2019
2088
    def __init__(self, limbo_dir):
2020
2089
       BzrError.__init__(self)
2021
2090
       self.limbo_dir = limbo_dir
2054
2123
 
2055
2124
class OutOfDateTree(BzrError):
2056
2125
 
2057
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2126
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2058
2127
 
2059
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
2060
2133
        BzrError.__init__(self)
2061
2134
        self.tree = tree
 
2135
        self.more = more
2062
2136
 
2063
2137
 
2064
2138
class PublicBranchOutOfDate(BzrError):
2102
2176
 
2103
2177
    def __init__(self, repo):
2104
2178
        BzrError.__init__(self)
2105
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2179
        self.repo_path = repo.user_url
2106
2180
 
2107
2181
 
2108
2182
class InconsistentDelta(BzrError):
2118
2192
        self.reason = reason
2119
2193
 
2120
2194
 
 
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
 
2121
2207
class UpgradeRequired(BzrError):
2122
2208
 
2123
2209
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2132
2218
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2133
2219
 
2134
2220
 
 
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
 
2135
2227
class LocalRequiresBoundBranch(BzrError):
2136
2228
 
2137
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
2138
2230
 
2139
2231
 
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
 
 
2154
2232
class UnsupportedOperation(BzrError):
2155
2233
 
2156
2234
    _fmt = ("The method %(mname)s is not supported on"
2173
2251
 
2174
2252
 
2175
2253
class BinaryFile(BzrError):
2176
 
    
 
2254
 
2177
2255
    _fmt = "File is binary but should be text."
2178
2256
 
2179
2257
 
2199
2277
 
2200
2278
 
2201
2279
class NotABundle(BzrError):
2202
 
    
 
2280
 
2203
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
2204
2282
 
2205
2283
    def __init__(self, text):
2207
2285
        self.text = text
2208
2286
 
2209
2287
 
2210
 
class BadBundle(BzrError): 
2211
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
2212
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
2213
2291
 
2214
2292
    def __init__(self, text):
2216
2294
        self.text = text
2217
2295
 
2218
2296
 
2219
 
class MalformedHeader(BadBundle): 
2220
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
2221
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2222
2300
 
2223
2301
 
2224
 
class MalformedPatches(BadBundle): 
2225
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
2226
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2227
2305
 
2228
2306
 
2229
 
class MalformedFooter(BadBundle): 
2230
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
2231
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2232
2310
 
2233
2311
 
2234
2312
class UnsupportedEOLMarker(BadBundle):
2235
 
    
2236
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2313
 
 
2314
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
2237
2315
 
2238
2316
    def __init__(self):
2239
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
2240
2318
        # but for this there is not
2241
2319
        BzrError.__init__(self)
2242
2320
 
2243
2321
 
2244
2322
class IncompatibleBundleFormat(BzrError):
2245
 
    
 
2323
 
2246
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2247
2325
 
2248
2326
    def __init__(self, bundle_format, other):
2252
2330
 
2253
2331
 
2254
2332
class BadInventoryFormat(BzrError):
2255
 
    
 
2333
 
2256
2334
    _fmt = "Root class for inventory serialization errors"
2257
2335
 
2258
2336
 
2277
2355
        self.transport = transport
2278
2356
 
2279
2357
 
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
 
 
2289
2358
class UnknownSSH(BzrError):
2290
2359
 
2291
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2311
2380
        self.revision_id = revision_id
2312
2381
        self.ghost_revision_id = ghost_revision_id
2313
2382
 
2314
 
        
 
2383
 
2315
2384
class GhostRevisionUnusableHere(BzrError):
2316
2385
 
2317
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2409
2478
 
2410
2479
 
2411
2480
class UnsupportedInventoryKind(BzrError):
2412
 
    
 
2481
 
2413
2482
    _fmt = """Unsupported entry kind %(kind)s"""
2414
2483
 
2415
2484
    def __init__(self, kind):
2427
2496
 
2428
2497
 
2429
2498
class SubsumeTargetNeedsUpgrade(BzrError):
2430
 
    
 
2499
 
2431
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2432
2501
 
2433
2502
    def __init__(self, other_tree):
2461
2530
    def __init__(self, branch):
2462
2531
        self.branch = branch
2463
2532
 
2464
 
        
 
2533
 
2465
2534
class TagAlreadyExists(BzrError):
2466
2535
 
2467
2536
    _fmt = "Tag %(tag_name)s already exists."
2472
2541
 
2473
2542
class MalformedBugIdentifier(BzrError):
2474
2543
 
2475
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2544
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2545
            'See "bzr help bugs" for more information on this feature.')
2476
2546
 
2477
2547
    def __init__(self, bug_id, reason):
2478
2548
        self.bug_id = bug_id
2499
2569
        self.branch = branch
2500
2570
 
2501
2571
 
 
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
 
2502
2588
class UnexpectedSmartServerResponse(BzrError):
2503
2589
 
2504
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2550
2636
        """
2551
2637
        self.error_from_smart_server = error_from_smart_server
2552
2638
        self.error_tuple = error_from_smart_server.error_tuple
2553
 
        
 
2639
 
2554
2640
 
2555
2641
class ContainerError(BzrError):
2556
2642
    """Base class of container errors."""
2559
2645
class UnknownContainerFormatError(ContainerError):
2560
2646
 
2561
2647
    _fmt = "Unrecognised container format: %(container_format)r"
2562
 
    
 
2648
 
2563
2649
    def __init__(self, container_format):
2564
2650
        self.container_format = container_format
2565
2651
 
2629
2715
 
2630
2716
class NoMailAddressSpecified(BzrError):
2631
2717
 
2632
 
    _fmt = "No mail-to address specified."
 
2718
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2633
2719
 
2634
2720
 
2635
2721
class UnknownMailClient(BzrError):
2668
2754
 
2669
2755
    def __init__(self, bzrdir):
2670
2756
        import bzrlib.urlutils as urlutils
2671
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2672
2758
                                                    'ascii')
2673
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2674
2760
 
2715
2801
    _fmt = "'%(display_url)s' is already standalone."
2716
2802
 
2717
2803
 
 
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
 
2718
2816
class ReconfigurationNotSupported(BzrDirError):
2719
2817
 
2720
2818
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2727
2825
 
2728
2826
class UncommittedChanges(BzrError):
2729
2827
 
2730
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2828
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2829
            ' (See bzr status).%(more)s')
2731
2830
 
2732
 
    def __init__(self, tree):
 
2831
    def __init__(self, tree, more=None):
 
2832
        if more is None:
 
2833
            more = ''
 
2834
        else:
 
2835
            more = ' ' + more
2733
2836
        import bzrlib.urlutils as urlutils
2734
2837
        display_url = urlutils.unescape_for_display(
2735
 
            tree.bzrdir.root_transport.base, 'ascii')
2736
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2838
            tree.user_url, 'ascii')
 
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2737
2840
 
2738
2841
 
2739
2842
class MissingTemplateVariable(BzrError):
2774
2877
 
2775
2878
 
2776
2879
class CommandAvailableInPlugin(StandardError):
2777
 
    
 
2880
 
2778
2881
    internal_error = False
2779
2882
 
2780
2883
    def __init__(self, cmd_name, plugin_metadata, provider):
2781
 
        
 
2884
 
2782
2885
        self.plugin_metadata = plugin_metadata
2783
2886
        self.cmd_name = cmd_name
2784
2887
        self.provider = provider
2785
2888
 
2786
2889
    def __str__(self):
2787
2890
 
2788
 
        _fmt = ('"%s" is not a standard bzr command. \n' 
 
2891
        _fmt = ('"%s" is not a standard bzr command. \n'
2789
2892
                'However, the following official plugin provides this command: %s\n'
2790
2893
                'You can install it by going to: %s'
2791
 
                % (self.cmd_name, self.plugin_metadata['name'], 
 
2894
                % (self.cmd_name, self.plugin_metadata['name'],
2792
2895
                    self.plugin_metadata['url']))
2793
2896
 
2794
2897
        return _fmt
2795
2898
 
2796
2899
 
2797
2900
class NoPluginAvailable(BzrError):
2798
 
    pass    
2799
 
 
2800
 
 
2801
 
class NotATerminal(BzrError):
2802
 
 
2803
 
    _fmt = 'Unable to ask for a password without real terminal.'
 
2901
    pass
2804
2902
 
2805
2903
 
2806
2904
class UnableEncodePath(BzrError):
2809
2907
            'user encoding %(user_encoding)s')
2810
2908
 
2811
2909
    def __init__(self, path, kind):
 
2910
        from bzrlib.osutils import get_user_encoding
2812
2911
        self.path = path
2813
2912
        self.kind = kind
2814
2913
        self.user_encoding = osutils.get_user_encoding()
2849
2948
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2850
2949
 
2851
2950
    def __init__(self, host, port, orig_error):
 
2951
        # nb: in python2.4 socket.error doesn't have a useful repr
2852
2952
        BzrError.__init__(self, host=host, port=port,
2853
 
            orig_error=orig_error[1])
 
2953
            orig_error=repr(orig_error.args))
2854
2954
 
2855
2955
 
2856
2956
class UnknownRules(BzrError):
2864
2964
class HookFailed(BzrError):
2865
2965
    """Raised when a pre_change_branch_tip hook function fails anything other
2866
2966
    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.
2867
2970
    """
2868
2971
 
2869
2972
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2870
2973
            "%(traceback_text)s%(exc_value)s")
2871
2974
 
2872
 
    def __init__(self, hook_stage, hook_name, exc_info):
 
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)
2873
2979
        import traceback
2874
2980
        self.hook_stage = hook_stage
2875
2981
        self.hook_name = hook_name
2884
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
2885
2991
    explicitly abort a change to a branch tip.
2886
2992
    """
2887
 
    
 
2993
 
2888
2994
    _fmt = u"Tip change rejected: %(msg)s"
2889
2995
 
2890
2996
    def __init__(self, msg):
2891
2997
        self.msg = msg
2892
2998
 
 
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