/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-11-25 17:15:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3851.
  • Revision ID: john@arbash-meinel.com-20081125171526-pi2g4m1w70pkie1f
Add a bit of help text when supplying --help.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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,
154
155
               )
155
156
 
156
157
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
 
158
        if self.__class__ != other.__class__:
158
159
            return NotImplemented
159
160
        return self.__dict__ == other.__dict__
160
161
 
265
266
 
266
267
 
267
268
class InvalidEntryName(InternalBzrError):
268
 
 
 
269
    
269
270
    _fmt = "Invalid entry name: %(name)s"
270
271
 
271
272
    def __init__(self, name):
274
275
 
275
276
 
276
277
class InvalidRevisionNumber(BzrError):
277
 
 
 
278
    
278
279
    _fmt = "Invalid revision number %(revno)s"
279
280
 
280
281
    def __init__(self, revno):
329
330
class NoSuchId(BzrError):
330
331
 
331
332
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
333
    
333
334
    def __init__(self, tree, file_id):
334
335
        BzrError.__init__(self)
335
336
        self.file_id = file_id
362
363
class NoWorkingTree(BzrError):
363
364
 
364
365
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
366
    
366
367
    def __init__(self, base):
367
368
        BzrError.__init__(self)
368
369
        self.base = base
477
478
    def __init__(self, name, value):
478
479
        BzrError.__init__(self, name=name, value=value)
479
480
 
480
 
 
 
481
    
481
482
class StrictCommitFailed(BzrError):
482
483
 
483
484
    _fmt = "Commit refused because there are unknown files in the tree"
486
487
# XXX: Should be unified with TransportError; they seem to represent the
487
488
# same thing
488
489
# 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
 
490
# - this is finer than a TransportError - and more useful as such. It 
490
491
# differentiates between 'transport has failed' and 'operation on a transport
491
492
# has failed.'
492
493
class PathError(BzrError):
493
 
 
 
494
    
494
495
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
496
 
496
497
    def __init__(self, path, extra=None):
550
551
 
551
552
 
552
553
class ReadingCompleted(InternalBzrError):
553
 
 
 
554
    
554
555
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
556
            "called upon it - the request has been completed and no more "
556
557
            "data may be read.")
636
637
        self.url = url
637
638
 
638
639
 
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
640
class UnstackableRepositoryFormat(BzrError):
650
641
 
651
642
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
658
649
 
659
650
 
660
651
class ReadError(PathError):
661
 
 
 
652
    
662
653
    _fmt = """Error reading from %(path)r."""
663
654
 
664
655
 
699
690
 
700
691
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
692
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
693
# TODO: Probably this behavior of should be a common superclass 
703
694
class NotBranchError(PathError):
704
695
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
696
    _fmt = 'Not a branch: "%(path)s".'
706
697
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
698
    def __init__(self, path):
708
699
       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)
 
700
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
701
 
732
702
 
733
703
class NoSubmitBranch(PathError):
795
765
 
796
766
 
797
767
class UnknownFormatError(BzrError):
798
 
 
 
768
    
799
769
    _fmt = "Unknown %(kind)s format: %(format)r"
800
770
 
801
771
    def __init__(self, format, kind='branch'):
804
774
 
805
775
 
806
776
class IncompatibleFormat(BzrError):
807
 
 
 
777
    
808
778
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
779
 
810
780
    def __init__(self, format, bzrdir_format):
814
784
 
815
785
 
816
786
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
787
 
824
788
    _fmt = "%(target)s\n" \
825
789
            "is not compatible with\n" \
833
797
 
834
798
 
835
799
class IncompatibleRevision(BzrError):
836
 
 
 
800
    
837
801
    _fmt = "Revision is not compatible with %(repo_format)s"
838
802
 
839
803
    def __init__(self, repo_format):
1040
1004
 
1041
1005
class LockContention(LockError):
1042
1006
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1007
    _fmt = 'Could not acquire lock "%(lock)s"'
1044
1008
    # TODO: show full url for lock, combining the transport and relative
1045
1009
    # bits?
1046
1010
 
1047
1011
    internal_error = False
1048
1012
 
1049
 
    def __init__(self, lock, msg=''):
 
1013
    def __init__(self, lock):
1050
1014
        self.lock = lock
1051
 
        self.msg = msg
1052
1015
 
1053
1016
 
1054
1017
class LockBroken(LockError):
1168
1131
 
1169
1132
class NoSuchRevisionInTree(NoSuchRevision):
1170
1133
    """When using Tree.revision_tree, and the revision is not accessible."""
1171
 
 
 
1134
    
1172
1135
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1173
1136
 
1174
1137
    def __init__(self, tree, revision_id):
1179
1142
 
1180
1143
class InvalidRevisionSpec(BzrError):
1181
1144
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1145
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1146
            " %(branch)s%(extra)s")
1184
1147
 
1185
1148
    def __init__(self, spec, branch, extra=None):
1210
1173
class DivergedBranches(BzrError):
1211
1174
 
1212
1175
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1176
            " Use the merge command to reconcile them.")
1215
1177
 
1216
1178
    def __init__(self, branch1, branch2):
1217
1179
        self.branch1 = branch1
1239
1201
 
1240
1202
 
1241
1203
class NoCommonAncestor(BzrError):
1242
 
 
 
1204
    
1243
1205
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1206
 
1245
1207
    def __init__(self, revision_a, revision_b):
1265
1227
            not_ancestor_id=not_ancestor_id)
1266
1228
 
1267
1229
 
 
1230
class InstallFailed(BzrError):
 
1231
 
 
1232
    def __init__(self, revisions):
 
1233
        revision_str = ", ".join(str(r) for r in revisions)
 
1234
        msg = "Could not install revisions:\n%s" % revision_str
 
1235
        BzrError.__init__(self, msg)
 
1236
        self.revisions = revisions
 
1237
 
 
1238
 
1268
1239
class AmbiguousBase(BzrError):
1269
1240
 
1270
1241
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1242
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1243
                DeprecationWarning)
1273
1244
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1245
                % ", ".join(bases))
1275
1246
        BzrError.__init__(self, msg)
1297
1268
class BoundBranchOutOfDate(BzrError):
1298
1269
 
1299
1270
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1271
            " %(master)s.")
1301
1272
 
1302
1273
    def __init__(self, branch, master):
1303
1274
        BzrError.__init__(self)
1304
1275
        self.branch = branch
1305
1276
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1277
 
 
1278
        
1309
1279
class CommitToDoubleBoundBranch(BzrError):
1310
1280
 
1311
1281
    _fmt = ("Cannot commit to branch %(branch)s."
1381
1351
class WeaveParentMismatch(WeaveError):
1382
1352
 
1383
1353
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1354
    
1385
1355
 
1386
1356
class WeaveInvalidChecksum(WeaveError):
1387
1357
 
1413
1383
 
1414
1384
 
1415
1385
class VersionedFileError(BzrError):
1416
 
 
 
1386
    
1417
1387
    _fmt = "Versioned file error"
1418
1388
 
1419
1389
 
1420
1390
class RevisionNotPresent(VersionedFileError):
1421
 
 
 
1391
    
1422
1392
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1423
1393
 
1424
1394
    def __init__(self, revision_id, file_id):
1428
1398
 
1429
1399
 
1430
1400
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
 
1401
    
1432
1402
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1433
1403
 
1434
1404
    def __init__(self, revision_id, file_id):
1443
1413
 
1444
1414
 
1445
1415
class KnitError(InternalBzrError):
1446
 
 
 
1416
    
1447
1417
    _fmt = "Knit error"
1448
1418
 
1449
1419
 
1481
1451
    def __init__(self, stream_format, target_format):
1482
1452
        self.stream_format = stream_format
1483
1453
        self.target_format = target_format
1484
 
 
 
1454
        
1485
1455
 
1486
1456
class KnitDataStreamUnknown(KnitError):
1487
1457
    # Indicates a data stream we don't know how to handle.
1490
1460
 
1491
1461
    def __init__(self, stream_format):
1492
1462
        self.stream_format = stream_format
1493
 
 
 
1463
        
1494
1464
 
1495
1465
class KnitHeaderError(KnitError):
1496
1466
 
1506
1476
 
1507
1477
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1478
    """
1509
 
 
 
1479
    
1510
1480
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1481
            " in options: %(options)r")
1512
1482
 
1516
1486
        self.options = options
1517
1487
 
1518
1488
 
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
1489
class NoSuchExportFormat(BzrError):
1566
 
 
 
1490
    
1567
1491
    _fmt = "Export format %(format)r not supported"
1568
1492
 
1569
1493
    def __init__(self, format):
1572
1496
 
1573
1497
 
1574
1498
class TransportError(BzrError):
1575
 
 
 
1499
    
1576
1500
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1501
 
1578
1502
    def __init__(self, msg=None, orig_error=None):
1623
1547
 
1624
1548
class SmartMessageHandlerError(InternalBzrError):
1625
1549
 
1626
 
    _fmt = ("The message handler raised an exception:\n"
1627
 
            "%(traceback_text)s")
 
1550
    _fmt = "The message handler raised an exception: %(exc_value)s."
1628
1551
 
1629
1552
    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
 
 
 
1553
        self.exc_type, self.exc_value, self.tb = exc_info
 
1554
        
1637
1555
 
1638
1556
# A set of semi-meaningful errors which can be thrown
1639
1557
class TransportNotPossible(TransportError):
1665
1583
            self.port = ':%s' % port
1666
1584
 
1667
1585
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1586
class ConnectionReset(TransportError):
1671
1587
 
1672
1588
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1713
1629
 
1714
1630
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1631
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1632
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1633
        self.source = source
1718
1634
        self.target = target
1719
1635
        if is_permanent:
1720
1636
            self.permanently = ' permanently'
1721
1637
        else:
1722
1638
            self.permanently = ''
 
1639
        self._qualified_proto = qual_proto
1723
1640
        TransportError.__init__(self)
1724
1641
 
 
1642
    def _requalify_url(self, url):
 
1643
        """Restore the qualified proto in front of the url"""
 
1644
        # When this exception is raised, source and target are in
 
1645
        # user readable format. But some transports may use a
 
1646
        # different proto (http+urllib:// will present http:// to
 
1647
        # the user. If a qualified proto is specified, the code
 
1648
        # trapping the exception can get the qualified urls to
 
1649
        # properly handle the redirection themself (creating a
 
1650
        # new transport object from the target url for example).
 
1651
        # But checking that the scheme of the original and
 
1652
        # redirected urls are the same can be tricky. (see the
 
1653
        # FIXME in BzrDir.open_from_transport for the unique use
 
1654
        # case so far).
 
1655
        if self._qualified_proto is None:
 
1656
            return url
 
1657
 
 
1658
        # The TODO related to NotBranchError mention that doing
 
1659
        # that kind of manipulation on the urls may not be the
 
1660
        # exception object job. On the other hand, this object is
 
1661
        # the interface between the code and the user so
 
1662
        # presenting the urls in different ways is indeed its
 
1663
        # job...
 
1664
        import urlparse
 
1665
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1666
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1667
                                   query, fragment))
 
1668
 
 
1669
    def get_source_url(self):
 
1670
        return self._requalify_url(self.source)
 
1671
 
 
1672
    def get_target_url(self):
 
1673
        return self._requalify_url(self.target)
 
1674
 
1725
1675
 
1726
1676
class TooManyRedirections(TransportError):
1727
1677
 
1762
1712
 
1763
1713
class WorkingTreeNotRevision(BzrError):
1764
1714
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1715
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1716
            " the last commit, but weave merge requires that it be"
1767
1717
            " unchanged")
1768
1718
 
1923
1873
class CantMoveRoot(BzrError):
1924
1874
 
1925
1875
    _fmt = "Moving the root directory is not supported at this time"
1926
 
    
1927
 
    
1928
 
class TransformRenameFailed(BzrError):
1929
 
 
1930
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1931
 
    
1932
 
    def __init__(self, from_path, to_path, why, errno):
1933
 
        self.from_path = from_path
1934
 
        self.to_path = to_path
1935
 
        self.why = why
1936
 
        self.errno = errno
1937
1876
 
1938
1877
 
1939
1878
class BzrMoveFailedError(BzrError):
2045
1984
 
2046
1985
class BadConversionTarget(BzrError):
2047
1986
 
2048
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2049
 
            "    %(problem)s"
 
1987
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2050
1988
 
2051
 
    def __init__(self, problem, format, from_format=None):
 
1989
    def __init__(self, problem, format):
2052
1990
        BzrError.__init__(self)
2053
1991
        self.problem = problem
2054
1992
        self.format = format
2055
 
        self.from_format = from_format or '(unspecified)'
2056
1993
 
2057
1994
 
2058
1995
class NoDiffFound(BzrError):
2095
2032
    _fmt = """This tree contains left-over files from a failed operation.
2096
2033
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2097
2034
    keep, and delete it when you are done."""
2098
 
 
 
2035
    
2099
2036
    def __init__(self, limbo_dir):
2100
2037
       BzrError.__init__(self)
2101
2038
       self.limbo_dir = limbo_dir
2134
2071
 
2135
2072
class OutOfDateTree(BzrError):
2136
2073
 
2137
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2074
    _fmt = "Working tree is out of date, please run 'bzr update'."
2138
2075
 
2139
 
    def __init__(self, tree, more=None):
2140
 
        if more is None:
2141
 
            more = ''
2142
 
        else:
2143
 
            more = ' ' + more
 
2076
    def __init__(self, tree):
2144
2077
        BzrError.__init__(self)
2145
2078
        self.tree = tree
2146
 
        self.more = more
2147
2079
 
2148
2080
 
2149
2081
class PublicBranchOutOfDate(BzrError):
2187
2119
 
2188
2120
    def __init__(self, repo):
2189
2121
        BzrError.__init__(self)
2190
 
        self.repo_path = repo.user_url
 
2122
        self.repo_path = repo.bzrdir.root_transport.base
2191
2123
 
2192
2124
 
2193
2125
class InconsistentDelta(BzrError):
2203
2135
        self.reason = reason
2204
2136
 
2205
2137
 
2206
 
class InconsistentDeltaDelta(InconsistentDelta):
2207
 
    """Used when we get a delta that is not valid."""
2208
 
 
2209
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2210
 
            "\nreason: %(reason)s")
2211
 
 
2212
 
    def __init__(self, delta, reason):
2213
 
        BzrError.__init__(self)
2214
 
        self.delta = delta
2215
 
        self.reason = reason
2216
 
 
2217
 
 
2218
2138
class UpgradeRequired(BzrError):
2219
2139
 
2220
2140
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2229
2149
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2230
2150
 
2231
2151
 
2232
 
class RichRootUpgradeRequired(UpgradeRequired):
2233
 
 
2234
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2235
 
           " a format which supports rich roots.")
2236
 
 
2237
 
 
2238
2152
class LocalRequiresBoundBranch(BzrError):
2239
2153
 
2240
2154
    _fmt = "Cannot perform local-only commits on unbound branches."
2241
2155
 
2242
2156
 
 
2157
class MissingProgressBarFinish(BzrError):
 
2158
 
 
2159
    _fmt = "A nested progress bar was not 'finished' correctly."
 
2160
 
 
2161
 
 
2162
class InvalidProgressBarType(BzrError):
 
2163
 
 
2164
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2165
            " is not a supported type Select one of: %(valid_types)s")
 
2166
 
 
2167
    def __init__(self, bar_type, valid_types):
 
2168
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2169
 
 
2170
 
2243
2171
class UnsupportedOperation(BzrError):
2244
2172
 
2245
2173
    _fmt = ("The method %(mname)s is not supported on"
2262
2190
 
2263
2191
 
2264
2192
class BinaryFile(BzrError):
2265
 
 
 
2193
    
2266
2194
    _fmt = "File is binary but should be text."
2267
2195
 
2268
2196
 
2288
2216
 
2289
2217
 
2290
2218
class NotABundle(BzrError):
2291
 
 
 
2219
    
2292
2220
    _fmt = "Not a bzr revision-bundle: %(text)r"
2293
2221
 
2294
2222
    def __init__(self, text):
2296
2224
        self.text = text
2297
2225
 
2298
2226
 
2299
 
class BadBundle(BzrError):
2300
 
 
 
2227
class BadBundle(BzrError): 
 
2228
    
2301
2229
    _fmt = "Bad bzr revision-bundle: %(text)r"
2302
2230
 
2303
2231
    def __init__(self, text):
2305
2233
        self.text = text
2306
2234
 
2307
2235
 
2308
 
class MalformedHeader(BadBundle):
2309
 
 
 
2236
class MalformedHeader(BadBundle): 
 
2237
    
2310
2238
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2311
2239
 
2312
2240
 
2313
 
class MalformedPatches(BadBundle):
2314
 
 
 
2241
class MalformedPatches(BadBundle): 
 
2242
    
2315
2243
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2316
2244
 
2317
2245
 
2318
 
class MalformedFooter(BadBundle):
2319
 
 
 
2246
class MalformedFooter(BadBundle): 
 
2247
    
2320
2248
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2321
2249
 
2322
2250
 
2323
2251
class UnsupportedEOLMarker(BadBundle):
2324
 
 
2325
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2252
    
 
2253
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2326
2254
 
2327
2255
    def __init__(self):
2328
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2256
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2329
2257
        # but for this there is not
2330
2258
        BzrError.__init__(self)
2331
2259
 
2332
2260
 
2333
2261
class IncompatibleBundleFormat(BzrError):
2334
 
 
 
2262
    
2335
2263
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2336
2264
 
2337
2265
    def __init__(self, bundle_format, other):
2341
2269
 
2342
2270
 
2343
2271
class BadInventoryFormat(BzrError):
2344
 
 
 
2272
    
2345
2273
    _fmt = "Root class for inventory serialization errors"
2346
2274
 
2347
2275
 
2366
2294
        self.transport = transport
2367
2295
 
2368
2296
 
 
2297
class NoSmartServer(NotBranchError):
 
2298
 
 
2299
    _fmt = "No smart server available at %(url)s"
 
2300
 
 
2301
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
2302
    def __init__(self, url):
 
2303
        self.url = url
 
2304
 
 
2305
 
2369
2306
class UnknownSSH(BzrError):
2370
2307
 
2371
2308
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2391
2328
        self.revision_id = revision_id
2392
2329
        self.ghost_revision_id = ghost_revision_id
2393
2330
 
2394
 
 
 
2331
        
2395
2332
class GhostRevisionUnusableHere(BzrError):
2396
2333
 
2397
2334
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2489
2426
 
2490
2427
 
2491
2428
class UnsupportedInventoryKind(BzrError):
2492
 
 
 
2429
    
2493
2430
    _fmt = """Unsupported entry kind %(kind)s"""
2494
2431
 
2495
2432
    def __init__(self, kind):
2507
2444
 
2508
2445
 
2509
2446
class SubsumeTargetNeedsUpgrade(BzrError):
2510
 
 
 
2447
    
2511
2448
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2512
2449
 
2513
2450
    def __init__(self, other_tree):
2541
2478
    def __init__(self, branch):
2542
2479
        self.branch = branch
2543
2480
 
2544
 
 
 
2481
        
2545
2482
class TagAlreadyExists(BzrError):
2546
2483
 
2547
2484
    _fmt = "Tag %(tag_name)s already exists."
2552
2489
 
2553
2490
class MalformedBugIdentifier(BzrError):
2554
2491
 
2555
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2556
 
            'See "bzr help bugs" for more information on this feature.')
 
2492
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2557
2493
 
2558
2494
    def __init__(self, bug_id, reason):
2559
2495
        self.bug_id = bug_id
2580
2516
        self.branch = branch
2581
2517
 
2582
2518
 
2583
 
class InvalidLineInBugsProperty(BzrError):
2584
 
 
2585
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2586
 
 
2587
 
    def __init__(self, line):
2588
 
        self.line = line
2589
 
 
2590
 
 
2591
 
class InvalidBugStatus(BzrError):
2592
 
 
2593
 
    _fmt = ("Invalid bug status: '%(status)s'")
2594
 
 
2595
 
    def __init__(self, status):
2596
 
        self.status = status
2597
 
 
2598
 
 
2599
2519
class UnexpectedSmartServerResponse(BzrError):
2600
2520
 
2601
2521
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2647
2567
        """
2648
2568
        self.error_from_smart_server = error_from_smart_server
2649
2569
        self.error_tuple = error_from_smart_server.error_tuple
2650
 
 
 
2570
        
2651
2571
 
2652
2572
class ContainerError(BzrError):
2653
2573
    """Base class of container errors."""
2656
2576
class UnknownContainerFormatError(ContainerError):
2657
2577
 
2658
2578
    _fmt = "Unrecognised container format: %(container_format)r"
2659
 
 
 
2579
    
2660
2580
    def __init__(self, container_format):
2661
2581
        self.container_format = container_format
2662
2582
 
2726
2646
 
2727
2647
class NoMailAddressSpecified(BzrError):
2728
2648
 
2729
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2649
    _fmt = "No mail-to address specified."
2730
2650
 
2731
2651
 
2732
2652
class UnknownMailClient(BzrError):
2765
2685
 
2766
2686
    def __init__(self, bzrdir):
2767
2687
        import bzrlib.urlutils as urlutils
2768
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2688
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2769
2689
                                                    'ascii')
2770
2690
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2771
2691
 
2812
2732
    _fmt = "'%(display_url)s' is already standalone."
2813
2733
 
2814
2734
 
2815
 
class AlreadyWithTrees(BzrDirError):
2816
 
 
2817
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2818
 
            "working trees.")
2819
 
 
2820
 
 
2821
 
class AlreadyWithNoTrees(BzrDirError):
2822
 
 
2823
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2824
 
            "working trees.")
2825
 
 
2826
 
 
2827
2735
class ReconfigurationNotSupported(BzrDirError):
2828
2736
 
2829
2737
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2836
2744
 
2837
2745
class UncommittedChanges(BzrError):
2838
2746
 
2839
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2840
 
            ' (See bzr status).%(more)s')
 
2747
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2841
2748
 
2842
 
    def __init__(self, tree, more=None):
2843
 
        if more is None:
2844
 
            more = ''
2845
 
        else:
2846
 
            more = ' ' + more
 
2749
    def __init__(self, tree):
2847
2750
        import bzrlib.urlutils as urlutils
2848
2751
        display_url = urlutils.unescape_for_display(
2849
 
            tree.user_url, 'ascii')
2850
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2752
            tree.bzrdir.root_transport.base, 'ascii')
 
2753
        BzrError.__init__(self, tree=tree, display_url=display_url)
2851
2754
 
2852
2755
 
2853
2756
class MissingTemplateVariable(BzrError):
2888
2791
 
2889
2792
 
2890
2793
class CommandAvailableInPlugin(StandardError):
2891
 
 
 
2794
    
2892
2795
    internal_error = False
2893
2796
 
2894
2797
    def __init__(self, cmd_name, plugin_metadata, provider):
2895
 
 
 
2798
        
2896
2799
        self.plugin_metadata = plugin_metadata
2897
2800
        self.cmd_name = cmd_name
2898
2801
        self.provider = provider
2899
2802
 
2900
2803
    def __str__(self):
2901
2804
 
2902
 
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2805
        _fmt = ('"%s" is not a standard bzr command. \n' 
2903
2806
                'However, the following official plugin provides this command: %s\n'
2904
2807
                'You can install it by going to: %s'
2905
 
                % (self.cmd_name, self.plugin_metadata['name'],
 
2808
                % (self.cmd_name, self.plugin_metadata['name'], 
2906
2809
                    self.plugin_metadata['url']))
2907
2810
 
2908
2811
        return _fmt
2909
2812
 
2910
2813
 
2911
2814
class NoPluginAvailable(BzrError):
2912
 
    pass
 
2815
    pass    
 
2816
 
 
2817
 
 
2818
class NotATerminal(BzrError):
 
2819
 
 
2820
    _fmt = 'Unable to ask for a password without real terminal.'
2913
2821
 
2914
2822
 
2915
2823
class UnableEncodePath(BzrError):
2959
2867
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2960
2868
 
2961
2869
    def __init__(self, host, port, orig_error):
2962
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2963
2870
        BzrError.__init__(self, host=host, port=port,
2964
 
            orig_error=repr(orig_error.args))
 
2871
            orig_error=orig_error[1])
2965
2872
 
2966
2873
 
2967
2874
class UnknownRules(BzrError):
2975
2882
class HookFailed(BzrError):
2976
2883
    """Raised when a pre_change_branch_tip hook function fails anything other
2977
2884
    than TipChangeRejected.
2978
 
 
2979
 
    Note that this exception is no longer raised, and the import is only left
2980
 
    to be nice to code which might catch it in a plugin.
2981
2885
    """
2982
2886
 
2983
2887
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2984
2888
            "%(traceback_text)s%(exc_value)s")
2985
2889
 
2986
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2987
 
        if warn:
2988
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2989
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2890
    def __init__(self, hook_stage, hook_name, exc_info):
2990
2891
        import traceback
2991
2892
        self.hook_stage = hook_stage
2992
2893
        self.hook_name = hook_name
3001
2902
    """A pre_change_branch_tip hook function may raise this to cleanly and
3002
2903
    explicitly abort a change to a branch tip.
3003
2904
    """
3004
 
 
 
2905
    
3005
2906
    _fmt = u"Tip change rejected: %(msg)s"
3006
2907
 
3007
2908
    def __init__(self, msg):
3021
2922
        BzrError.__init__(self, shelf_id=shelf_id)
3022
2923
 
3023
2924
 
3024
 
class InvalidShelfId(BzrError):
3025
 
 
3026
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3027
 
 
3028
 
    def __init__(self, invalid_id):
3029
 
        BzrError.__init__(self, invalid_id=invalid_id)
3030
 
 
3031
 
 
3032
 
class JailBreak(BzrError):
3033
 
 
3034
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3035
 
 
3036
 
    def __init__(self, url):
3037
 
        BzrError.__init__(self, url=url)
3038
 
 
3039
 
 
3040
2925
class UserAbort(BzrError):
3041
2926
 
3042
2927
    _fmt = 'The user aborted the operation.'
3043
 
 
3044
 
 
3045
 
class MustHaveWorkingTree(BzrError):
3046
 
 
3047
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3048
 
 
3049
 
    def __init__(self, format, url):
3050
 
        BzrError.__init__(self, format=format, url=url)
3051
 
 
3052
 
 
3053
 
class NoSuchView(BzrError):
3054
 
    """A view does not exist.
3055
 
    """
3056
 
 
3057
 
    _fmt = u"No such view: %(view_name)s."
3058
 
 
3059
 
    def __init__(self, view_name):
3060
 
        self.view_name = view_name
3061
 
 
3062
 
 
3063
 
class ViewsNotSupported(BzrError):
3064
 
    """Views are not supported by a tree format.
3065
 
    """
3066
 
 
3067
 
    _fmt = ("Views are not supported by %(tree)s;"
3068
 
            " use 'bzr upgrade' to change your tree to a later format.")
3069
 
 
3070
 
    def __init__(self, tree):
3071
 
        self.tree = tree
3072
 
 
3073
 
 
3074
 
class FileOutsideView(BzrError):
3075
 
 
3076
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3077
 
            '%(view_str)s')
3078
 
 
3079
 
    def __init__(self, file_name, view_files):
3080
 
        self.file_name = file_name
3081
 
        self.view_str = ", ".join(view_files)
3082
 
 
3083
 
 
3084
 
class UnresumableWriteGroup(BzrError):
3085
 
 
3086
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3087
 
            "%(write_groups)r: %(reason)s")
3088
 
 
3089
 
    internal_error = True
3090
 
 
3091
 
    def __init__(self, repository, write_groups, reason):
3092
 
        self.repository = repository
3093
 
        self.write_groups = write_groups
3094
 
        self.reason = reason
3095
 
 
3096
 
 
3097
 
class UnsuspendableWriteGroup(BzrError):
3098
 
 
3099
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3100
 
 
3101
 
    internal_error = True
3102
 
 
3103
 
    def __init__(self, repository):
3104
 
        self.repository = repository
3105
 
 
3106
 
 
3107
 
class LossyPushToSameVCS(BzrError):
3108
 
 
3109
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3110
 
            "%(target_branch)r that are in the same VCS.")
3111
 
 
3112
 
    internal_error = True
3113
 
 
3114
 
    def __init__(self, source_branch, target_branch):
3115
 
        self.source_branch = source_branch
3116
 
        self.target_branch = target_branch
3117
 
 
3118
 
 
3119
 
class NoRoundtrippingSupport(BzrError):
3120
 
 
3121
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3122
 
            "%(target_branch)r.")
3123
 
 
3124
 
    internal_error = True
3125
 
 
3126
 
    def __init__(self, source_branch, target_branch):
3127
 
        self.source_branch = source_branch
3128
 
        self.target_branch = target_branch
3129
 
 
3130
 
 
3131
 
class FileTimestampUnavailable(BzrError):
3132
 
 
3133
 
    _fmt = "The filestamp for %(path)s is not available."
3134
 
 
3135
 
    internal_error = True
3136
 
 
3137
 
    def __init__(self, path):
3138
 
        self.path = path
3139
 
 
3140
 
 
3141
 
class NoColocatedBranchSupport(BzrError):
3142
 
 
3143
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3144
 
 
3145
 
    def __init__(self, bzrdir):
3146
 
        self.bzrdir = bzrdir
3147
 
 
3148
 
class NoWhoami(BzrError):
3149
 
 
3150
 
    _fmt = ('Unable to determine your name.\n'
3151
 
        "Please, set your name with the 'whoami' command.\n"
3152
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3153
 
 
3154