/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: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

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,
133
134
            s = str(s)
134
135
        return s
135
136
 
136
 
    def __repr__(self):
137
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
138
 
 
139
137
    def _get_format_string(self):
140
138
        """Return format string for this exception or None"""
141
139
        fmt = getattr(self, '_fmt', None)
154
152
               )
155
153
 
156
154
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
 
155
        if self.__class__ != other.__class__:
158
156
            return NotImplemented
159
157
        return self.__dict__ == other.__dict__
160
158
 
265
263
 
266
264
 
267
265
class InvalidEntryName(InternalBzrError):
268
 
 
 
266
    
269
267
    _fmt = "Invalid entry name: %(name)s"
270
268
 
271
269
    def __init__(self, name):
274
272
 
275
273
 
276
274
class InvalidRevisionNumber(BzrError):
277
 
 
 
275
    
278
276
    _fmt = "Invalid revision number %(revno)s"
279
277
 
280
278
    def __init__(self, revno):
329
327
class NoSuchId(BzrError):
330
328
 
331
329
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
330
    
333
331
    def __init__(self, tree, file_id):
334
332
        BzrError.__init__(self)
335
333
        self.file_id = file_id
362
360
class NoWorkingTree(BzrError):
363
361
 
364
362
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
363
    
366
364
    def __init__(self, base):
367
365
        BzrError.__init__(self)
368
366
        self.base = base
477
475
    def __init__(self, name, value):
478
476
        BzrError.__init__(self, name=name, value=value)
479
477
 
480
 
 
 
478
    
481
479
class StrictCommitFailed(BzrError):
482
480
 
483
481
    _fmt = "Commit refused because there are unknown files in the tree"
486
484
# XXX: Should be unified with TransportError; they seem to represent the
487
485
# same thing
488
486
# 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
 
487
# - this is finer than a TransportError - and more useful as such. It 
490
488
# differentiates between 'transport has failed' and 'operation on a transport
491
489
# has failed.'
492
490
class PathError(BzrError):
493
 
 
 
491
    
494
492
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
493
 
496
494
    def __init__(self, path, extra=None):
550
548
 
551
549
 
552
550
class ReadingCompleted(InternalBzrError):
553
 
 
 
551
    
554
552
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
553
            "called upon it - the request has been completed and no more "
556
554
            "data may be read.")
636
634
        self.url = url
637
635
 
638
636
 
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
637
class UnstackableRepositoryFormat(BzrError):
650
638
 
651
639
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
658
646
 
659
647
 
660
648
class ReadError(PathError):
661
 
 
 
649
    
662
650
    _fmt = """Error reading from %(path)r."""
663
651
 
664
652
 
699
687
 
700
688
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
689
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
690
# TODO: Probably this behavior of should be a common superclass 
703
691
class NotBranchError(PathError):
704
692
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
693
    _fmt = 'Not a branch: "%(path)s".'
706
694
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
695
    def __init__(self, path):
708
696
       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)
 
697
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
698
 
732
699
 
733
700
class NoSubmitBranch(PathError):
795
762
 
796
763
 
797
764
class UnknownFormatError(BzrError):
798
 
 
 
765
    
799
766
    _fmt = "Unknown %(kind)s format: %(format)r"
800
767
 
801
768
    def __init__(self, format, kind='branch'):
804
771
 
805
772
 
806
773
class IncompatibleFormat(BzrError):
807
 
 
 
774
    
808
775
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
776
 
810
777
    def __init__(self, format, bzrdir_format):
814
781
 
815
782
 
816
783
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
784
 
824
785
    _fmt = "%(target)s\n" \
825
786
            "is not compatible with\n" \
833
794
 
834
795
 
835
796
class IncompatibleRevision(BzrError):
836
 
 
 
797
    
837
798
    _fmt = "Revision is not compatible with %(repo_format)s"
838
799
 
839
800
    def __init__(self, repo_format):
1040
1001
 
1041
1002
class LockContention(LockError):
1042
1003
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1004
    _fmt = 'Could not acquire lock "%(lock)s"'
1044
1005
    # TODO: show full url for lock, combining the transport and relative
1045
1006
    # bits?
1046
1007
 
1047
1008
    internal_error = False
1048
1009
 
1049
 
    def __init__(self, lock, msg=''):
 
1010
    def __init__(self, lock):
1050
1011
        self.lock = lock
1051
 
        self.msg = msg
1052
1012
 
1053
1013
 
1054
1014
class LockBroken(LockError):
1168
1128
 
1169
1129
class NoSuchRevisionInTree(NoSuchRevision):
1170
1130
    """When using Tree.revision_tree, and the revision is not accessible."""
1171
 
 
 
1131
    
1172
1132
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1173
1133
 
1174
1134
    def __init__(self, tree, revision_id):
1179
1139
 
1180
1140
class InvalidRevisionSpec(BzrError):
1181
1141
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1142
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1143
            " %(branch)s%(extra)s")
1184
1144
 
1185
1145
    def __init__(self, spec, branch, extra=None):
1210
1170
class DivergedBranches(BzrError):
1211
1171
 
1212
1172
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1173
            " Use the merge command to reconcile them.")
1215
1174
 
1216
1175
    def __init__(self, branch1, branch2):
1217
1176
        self.branch1 = branch1
1239
1198
 
1240
1199
 
1241
1200
class NoCommonAncestor(BzrError):
1242
 
 
 
1201
    
1243
1202
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1203
 
1245
1204
    def __init__(self, revision_a, revision_b):
1265
1224
            not_ancestor_id=not_ancestor_id)
1266
1225
 
1267
1226
 
 
1227
class InstallFailed(BzrError):
 
1228
 
 
1229
    def __init__(self, revisions):
 
1230
        revision_str = ", ".join(str(r) for r in revisions)
 
1231
        msg = "Could not install revisions:\n%s" % revision_str
 
1232
        BzrError.__init__(self, msg)
 
1233
        self.revisions = revisions
 
1234
 
 
1235
 
1268
1236
class AmbiguousBase(BzrError):
1269
1237
 
1270
1238
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1239
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1240
                DeprecationWarning)
1273
1241
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1242
                % ", ".join(bases))
1275
1243
        BzrError.__init__(self, msg)
1297
1265
class BoundBranchOutOfDate(BzrError):
1298
1266
 
1299
1267
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1268
            " %(master)s.")
1301
1269
 
1302
1270
    def __init__(self, branch, master):
1303
1271
        BzrError.__init__(self)
1304
1272
        self.branch = branch
1305
1273
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1274
 
 
1275
        
1309
1276
class CommitToDoubleBoundBranch(BzrError):
1310
1277
 
1311
1278
    _fmt = ("Cannot commit to branch %(branch)s."
1381
1348
class WeaveParentMismatch(WeaveError):
1382
1349
 
1383
1350
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1351
    
1385
1352
 
1386
1353
class WeaveInvalidChecksum(WeaveError):
1387
1354
 
1413
1380
 
1414
1381
 
1415
1382
class VersionedFileError(BzrError):
1416
 
 
 
1383
    
1417
1384
    _fmt = "Versioned file error"
1418
1385
 
1419
1386
 
1420
1387
class RevisionNotPresent(VersionedFileError):
1421
 
 
 
1388
    
1422
1389
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1423
1390
 
1424
1391
    def __init__(self, revision_id, file_id):
1428
1395
 
1429
1396
 
1430
1397
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
 
1398
    
1432
1399
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1433
1400
 
1434
1401
    def __init__(self, revision_id, file_id):
1443
1410
 
1444
1411
 
1445
1412
class KnitError(InternalBzrError):
1446
 
 
 
1413
    
1447
1414
    _fmt = "Knit error"
1448
1415
 
1449
1416
 
1457
1424
        self.how = how
1458
1425
 
1459
1426
 
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
1427
class KnitDataStreamIncompatible(KnitError):
1476
1428
    # Not raised anymore, as we can convert data streams.  In future we may
1477
1429
    # need it again for more exotic cases, so we're keeping it around for now.
1481
1433
    def __init__(self, stream_format, target_format):
1482
1434
        self.stream_format = stream_format
1483
1435
        self.target_format = target_format
1484
 
 
 
1436
        
1485
1437
 
1486
1438
class KnitDataStreamUnknown(KnitError):
1487
1439
    # Indicates a data stream we don't know how to handle.
1490
1442
 
1491
1443
    def __init__(self, stream_format):
1492
1444
        self.stream_format = stream_format
1493
 
 
 
1445
        
1494
1446
 
1495
1447
class KnitHeaderError(KnitError):
1496
1448
 
1506
1458
 
1507
1459
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1460
    """
1509
 
 
 
1461
    
1510
1462
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1463
            " in options: %(options)r")
1512
1464
 
1516
1468
        self.options = options
1517
1469
 
1518
1470
 
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
1471
class NoSuchExportFormat(BzrError):
1566
 
 
 
1472
    
1567
1473
    _fmt = "Export format %(format)r not supported"
1568
1474
 
1569
1475
    def __init__(self, format):
1572
1478
 
1573
1479
 
1574
1480
class TransportError(BzrError):
1575
 
 
 
1481
    
1576
1482
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1483
 
1578
1484
    def __init__(self, msg=None, orig_error=None):
1623
1529
 
1624
1530
class SmartMessageHandlerError(InternalBzrError):
1625
1531
 
1626
 
    _fmt = ("The message handler raised an exception:\n"
1627
 
            "%(traceback_text)s")
 
1532
    _fmt = "The message handler raised an exception: %(exc_value)s."
1628
1533
 
1629
1534
    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
 
 
 
1535
        self.exc_type, self.exc_value, self.tb = exc_info
 
1536
        
1637
1537
 
1638
1538
# A set of semi-meaningful errors which can be thrown
1639
1539
class TransportNotPossible(TransportError):
1665
1565
            self.port = ':%s' % port
1666
1566
 
1667
1567
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1568
class ConnectionReset(TransportError):
1671
1569
 
1672
1570
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1713
1611
 
1714
1612
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1613
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1614
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1615
        self.source = source
1718
1616
        self.target = target
1719
1617
        if is_permanent:
1720
1618
            self.permanently = ' permanently'
1721
1619
        else:
1722
1620
            self.permanently = ''
 
1621
        self._qualified_proto = qual_proto
1723
1622
        TransportError.__init__(self)
1724
1623
 
 
1624
    def _requalify_url(self, url):
 
1625
        """Restore the qualified proto in front of the url"""
 
1626
        # When this exception is raised, source and target are in
 
1627
        # user readable format. But some transports may use a
 
1628
        # different proto (http+urllib:// will present http:// to
 
1629
        # the user. If a qualified proto is specified, the code
 
1630
        # trapping the exception can get the qualified urls to
 
1631
        # properly handle the redirection themself (creating a
 
1632
        # new transport object from the target url for example).
 
1633
        # But checking that the scheme of the original and
 
1634
        # redirected urls are the same can be tricky. (see the
 
1635
        # FIXME in BzrDir.open_from_transport for the unique use
 
1636
        # case so far).
 
1637
        if self._qualified_proto is None:
 
1638
            return url
 
1639
 
 
1640
        # The TODO related to NotBranchError mention that doing
 
1641
        # that kind of manipulation on the urls may not be the
 
1642
        # exception object job. On the other hand, this object is
 
1643
        # the interface between the code and the user so
 
1644
        # presenting the urls in different ways is indeed its
 
1645
        # job...
 
1646
        import urlparse
 
1647
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1648
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1649
                                   query, fragment))
 
1650
 
 
1651
    def get_source_url(self):
 
1652
        return self._requalify_url(self.source)
 
1653
 
 
1654
    def get_target_url(self):
 
1655
        return self._requalify_url(self.target)
 
1656
 
1725
1657
 
1726
1658
class TooManyRedirections(TransportError):
1727
1659
 
1762
1694
 
1763
1695
class WorkingTreeNotRevision(BzrError):
1764
1696
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1697
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1698
            " the last commit, but weave merge requires that it be"
1767
1699
            " unchanged")
1768
1700
 
2034
1966
 
2035
1967
class BadConversionTarget(BzrError):
2036
1968
 
2037
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2038
 
            "    %(problem)s"
 
1969
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2039
1970
 
2040
 
    def __init__(self, problem, format, from_format=None):
 
1971
    def __init__(self, problem, format):
2041
1972
        BzrError.__init__(self)
2042
1973
        self.problem = problem
2043
1974
        self.format = format
2044
 
        self.from_format = from_format or '(unspecified)'
2045
1975
 
2046
1976
 
2047
1977
class NoDiffFound(BzrError):
2084
2014
    _fmt = """This tree contains left-over files from a failed operation.
2085
2015
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2086
2016
    keep, and delete it when you are done."""
2087
 
 
 
2017
    
2088
2018
    def __init__(self, limbo_dir):
2089
2019
       BzrError.__init__(self)
2090
2020
       self.limbo_dir = limbo_dir
2123
2053
 
2124
2054
class OutOfDateTree(BzrError):
2125
2055
 
2126
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2056
    _fmt = "Working tree is out of date, please run 'bzr update'."
2127
2057
 
2128
 
    def __init__(self, tree, more=None):
2129
 
        if more is None:
2130
 
            more = ''
2131
 
        else:
2132
 
            more = ' ' + more
 
2058
    def __init__(self, tree):
2133
2059
        BzrError.__init__(self)
2134
2060
        self.tree = tree
2135
 
        self.more = more
2136
2061
 
2137
2062
 
2138
2063
class PublicBranchOutOfDate(BzrError):
2176
2101
 
2177
2102
    def __init__(self, repo):
2178
2103
        BzrError.__init__(self)
2179
 
        self.repo_path = repo.user_url
 
2104
        self.repo_path = repo.bzrdir.root_transport.base
2180
2105
 
2181
2106
 
2182
2107
class InconsistentDelta(BzrError):
2192
2117
        self.reason = reason
2193
2118
 
2194
2119
 
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
2120
class UpgradeRequired(BzrError):
2208
2121
 
2209
2122
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2218
2131
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2219
2132
 
2220
2133
 
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
2134
class LocalRequiresBoundBranch(BzrError):
2228
2135
 
2229
2136
    _fmt = "Cannot perform local-only commits on unbound branches."
2230
2137
 
2231
2138
 
 
2139
class MissingProgressBarFinish(BzrError):
 
2140
 
 
2141
    _fmt = "A nested progress bar was not 'finished' correctly."
 
2142
 
 
2143
 
 
2144
class InvalidProgressBarType(BzrError):
 
2145
 
 
2146
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2147
            " is not a supported type Select one of: %(valid_types)s")
 
2148
 
 
2149
    def __init__(self, bar_type, valid_types):
 
2150
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2151
 
 
2152
 
2232
2153
class UnsupportedOperation(BzrError):
2233
2154
 
2234
2155
    _fmt = ("The method %(mname)s is not supported on"
2251
2172
 
2252
2173
 
2253
2174
class BinaryFile(BzrError):
2254
 
 
 
2175
    
2255
2176
    _fmt = "File is binary but should be text."
2256
2177
 
2257
2178
 
2277
2198
 
2278
2199
 
2279
2200
class NotABundle(BzrError):
2280
 
 
 
2201
    
2281
2202
    _fmt = "Not a bzr revision-bundle: %(text)r"
2282
2203
 
2283
2204
    def __init__(self, text):
2285
2206
        self.text = text
2286
2207
 
2287
2208
 
2288
 
class BadBundle(BzrError):
2289
 
 
 
2209
class BadBundle(BzrError): 
 
2210
    
2290
2211
    _fmt = "Bad bzr revision-bundle: %(text)r"
2291
2212
 
2292
2213
    def __init__(self, text):
2294
2215
        self.text = text
2295
2216
 
2296
2217
 
2297
 
class MalformedHeader(BadBundle):
2298
 
 
 
2218
class MalformedHeader(BadBundle): 
 
2219
    
2299
2220
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2300
2221
 
2301
2222
 
2302
 
class MalformedPatches(BadBundle):
2303
 
 
 
2223
class MalformedPatches(BadBundle): 
 
2224
    
2304
2225
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2305
2226
 
2306
2227
 
2307
 
class MalformedFooter(BadBundle):
2308
 
 
 
2228
class MalformedFooter(BadBundle): 
 
2229
    
2309
2230
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2310
2231
 
2311
2232
 
2312
2233
class UnsupportedEOLMarker(BadBundle):
2313
 
 
2314
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2234
    
 
2235
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2315
2236
 
2316
2237
    def __init__(self):
2317
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2238
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2318
2239
        # but for this there is not
2319
2240
        BzrError.__init__(self)
2320
2241
 
2321
2242
 
2322
2243
class IncompatibleBundleFormat(BzrError):
2323
 
 
 
2244
    
2324
2245
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2325
2246
 
2326
2247
    def __init__(self, bundle_format, other):
2330
2251
 
2331
2252
 
2332
2253
class BadInventoryFormat(BzrError):
2333
 
 
 
2254
    
2334
2255
    _fmt = "Root class for inventory serialization errors"
2335
2256
 
2336
2257
 
2355
2276
        self.transport = transport
2356
2277
 
2357
2278
 
 
2279
class NoSmartServer(NotBranchError):
 
2280
 
 
2281
    _fmt = "No smart server available at %(url)s"
 
2282
 
 
2283
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
2284
    def __init__(self, url):
 
2285
        self.url = url
 
2286
 
 
2287
 
2358
2288
class UnknownSSH(BzrError):
2359
2289
 
2360
2290
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2380
2310
        self.revision_id = revision_id
2381
2311
        self.ghost_revision_id = ghost_revision_id
2382
2312
 
2383
 
 
 
2313
        
2384
2314
class GhostRevisionUnusableHere(BzrError):
2385
2315
 
2386
2316
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2478
2408
 
2479
2409
 
2480
2410
class UnsupportedInventoryKind(BzrError):
2481
 
 
 
2411
    
2482
2412
    _fmt = """Unsupported entry kind %(kind)s"""
2483
2413
 
2484
2414
    def __init__(self, kind):
2496
2426
 
2497
2427
 
2498
2428
class SubsumeTargetNeedsUpgrade(BzrError):
2499
 
 
 
2429
    
2500
2430
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2501
2431
 
2502
2432
    def __init__(self, other_tree):
2530
2460
    def __init__(self, branch):
2531
2461
        self.branch = branch
2532
2462
 
2533
 
 
 
2463
        
2534
2464
class TagAlreadyExists(BzrError):
2535
2465
 
2536
2466
    _fmt = "Tag %(tag_name)s already exists."
2541
2471
 
2542
2472
class MalformedBugIdentifier(BzrError):
2543
2473
 
2544
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2545
 
            'See "bzr help bugs" for more information on this feature.')
 
2474
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2546
2475
 
2547
2476
    def __init__(self, bug_id, reason):
2548
2477
        self.bug_id = bug_id
2569
2498
        self.branch = branch
2570
2499
 
2571
2500
 
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
2501
class UnexpectedSmartServerResponse(BzrError):
2589
2502
 
2590
2503
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2636
2549
        """
2637
2550
        self.error_from_smart_server = error_from_smart_server
2638
2551
        self.error_tuple = error_from_smart_server.error_tuple
2639
 
 
 
2552
        
2640
2553
 
2641
2554
class ContainerError(BzrError):
2642
2555
    """Base class of container errors."""
2645
2558
class UnknownContainerFormatError(ContainerError):
2646
2559
 
2647
2560
    _fmt = "Unrecognised container format: %(container_format)r"
2648
 
 
 
2561
    
2649
2562
    def __init__(self, container_format):
2650
2563
        self.container_format = container_format
2651
2564
 
2715
2628
 
2716
2629
class NoMailAddressSpecified(BzrError):
2717
2630
 
2718
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2631
    _fmt = "No mail-to address specified."
2719
2632
 
2720
2633
 
2721
2634
class UnknownMailClient(BzrError):
2754
2667
 
2755
2668
    def __init__(self, bzrdir):
2756
2669
        import bzrlib.urlutils as urlutils
2757
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2670
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2758
2671
                                                    'ascii')
2759
2672
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2760
2673
 
2801
2714
    _fmt = "'%(display_url)s' is already standalone."
2802
2715
 
2803
2716
 
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
2717
class ReconfigurationNotSupported(BzrDirError):
2817
2718
 
2818
2719
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2825
2726
 
2826
2727
class UncommittedChanges(BzrError):
2827
2728
 
2828
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
 
            ' (See bzr status).%(more)s')
 
2729
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2830
2730
 
2831
 
    def __init__(self, tree, more=None):
2832
 
        if more is None:
2833
 
            more = ''
2834
 
        else:
2835
 
            more = ' ' + more
 
2731
    def __init__(self, tree):
2836
2732
        import bzrlib.urlutils as urlutils
2837
2733
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
2839
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2734
            tree.bzrdir.root_transport.base, 'ascii')
 
2735
        BzrError.__init__(self, tree=tree, display_url=display_url)
2840
2736
 
2841
2737
 
2842
2738
class MissingTemplateVariable(BzrError):
2877
2773
 
2878
2774
 
2879
2775
class CommandAvailableInPlugin(StandardError):
2880
 
 
 
2776
    
2881
2777
    internal_error = False
2882
2778
 
2883
2779
    def __init__(self, cmd_name, plugin_metadata, provider):
2884
 
 
 
2780
        
2885
2781
        self.plugin_metadata = plugin_metadata
2886
2782
        self.cmd_name = cmd_name
2887
2783
        self.provider = provider
2888
2784
 
2889
2785
    def __str__(self):
2890
2786
 
2891
 
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2787
        _fmt = ('"%s" is not a standard bzr command. \n' 
2892
2788
                'However, the following official plugin provides this command: %s\n'
2893
2789
                'You can install it by going to: %s'
2894
 
                % (self.cmd_name, self.plugin_metadata['name'],
 
2790
                % (self.cmd_name, self.plugin_metadata['name'], 
2895
2791
                    self.plugin_metadata['url']))
2896
2792
 
2897
2793
        return _fmt
2898
2794
 
2899
2795
 
2900
2796
class NoPluginAvailable(BzrError):
2901
 
    pass
 
2797
    pass    
 
2798
 
 
2799
 
 
2800
class NotATerminal(BzrError):
 
2801
 
 
2802
    _fmt = 'Unable to ask for a password without real terminal.'
2902
2803
 
2903
2804
 
2904
2805
class UnableEncodePath(BzrError):
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