/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 von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

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