/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: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
 
21
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
62
61
    :cvar _fmt: Format string to display the error; this is expanded
63
62
    by the instance's dict.
64
63
    """
65
 
    
 
64
 
66
65
    internal_error = False
67
66
 
68
67
    def __init__(self, msg=None, **kwds):
73
72
        arguments can be given.  The first is for generic "user" errors which
74
73
        are not intended to be caught and so do not need a specific subclass.
75
74
        The second case is for use with subclasses that provide a _fmt format
76
 
        string to print the arguments.  
 
75
        string to print the arguments.
77
76
 
78
 
        Keyword arguments are taken as parameters to the error, which can 
79
 
        be inserted into the format string template.  It's recommended 
80
 
        that subclasses override the __init__ method to require specific 
 
77
        Keyword arguments are taken as parameters to the error, which can
 
78
        be inserted into the format string template.  It's recommended
 
79
        that subclasses override the __init__ method to require specific
81
80
        parameters.
82
81
 
83
82
        :param msg: If given, this is the literal complete text for the error,
84
 
        not subject to expansion.
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
85
85
        """
86
86
        StandardError.__init__(self)
87
87
        if msg is not None:
93
93
            for key, value in kwds.items():
94
94
                setattr(self, key, value)
95
95
 
96
 
    def __str__(self):
 
96
    def _format(self):
97
97
        s = getattr(self, '_preformatted_string', None)
98
98
        if s is not None:
99
 
            # contains a preformatted message; must be cast to plain str
100
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
101
101
        try:
102
102
            fmt = self._get_format_string()
103
103
            if fmt:
104
104
                d = dict(self.__dict__)
105
 
                # special case: python2.5 puts the 'message' attribute in a
106
 
                # slot, so it isn't seen in __dict__
107
 
                d['message'] = getattr(self, 'message', 'no message')
108
105
                s = fmt % d
109
106
                # __str__() should always return a 'str' object
110
107
                # never a 'unicode' object.
111
 
                if isinstance(s, unicode):
112
 
                    return s.encode('utf8')
113
108
                return s
114
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
115
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
118
113
                   getattr(self, '_fmt', None),
119
114
                   e)
120
115
 
 
116
    def __unicode__(self):
 
117
        u = self._format()
 
118
        if isinstance(u, str):
 
119
            # Try decoding the str using the default encoding.
 
120
            u = unicode(u)
 
121
        elif not isinstance(u, unicode):
 
122
            # Try to make a unicode object from it, because __unicode__ must
 
123
            # return a unicode object.
 
124
            u = unicode(u)
 
125
        return u
 
126
 
 
127
    def __str__(self):
 
128
        s = self._format()
 
129
        if isinstance(s, unicode):
 
130
            s = s.encode('utf8')
 
131
        else:
 
132
            # __str__ must return a str.
 
133
            s = str(s)
 
134
        return s
 
135
 
 
136
    def __repr__(self):
 
137
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
138
 
121
139
    def _get_format_string(self):
122
140
        """Return format string for this exception or None"""
123
141
        fmt = getattr(self, '_fmt', None)
135
153
               getattr(self, '_fmt', None),
136
154
               )
137
155
 
 
156
    def __eq__(self, other):
 
157
        if self.__class__ is not other.__class__:
 
158
            return NotImplemented
 
159
        return self.__dict__ == other.__dict__
 
160
 
138
161
 
139
162
class InternalBzrError(BzrError):
140
163
    """Base class for errors that are internal in nature.
181
204
 
182
205
 
183
206
class AlreadyBuilding(BzrError):
184
 
    
 
207
 
185
208
    _fmt = "The tree builder is already building a tree."
186
209
 
187
210
 
193
216
 
194
217
 
195
218
class BzrCheckError(InternalBzrError):
196
 
    
197
 
    _fmt = "Internal check failed: %(message)s"
198
 
 
199
 
    def __init__(self, message):
200
 
        BzrError.__init__(self)
201
 
        self.message = message
 
219
 
 
220
    _fmt = "Internal check failed: %(msg)s"
 
221
 
 
222
    def __init__(self, msg):
 
223
        BzrError.__init__(self)
 
224
        self.msg = msg
 
225
 
 
226
 
 
227
class DirstateCorrupt(BzrError):
 
228
 
 
229
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
230
 
 
231
    def __init__(self, state, msg):
 
232
        BzrError.__init__(self)
 
233
        self.state = state
 
234
        self.msg = msg
202
235
 
203
236
 
204
237
class DisabledMethod(InternalBzrError):
232
265
 
233
266
 
234
267
class InvalidEntryName(InternalBzrError):
235
 
    
 
268
 
236
269
    _fmt = "Invalid entry name: %(name)s"
237
270
 
238
271
    def __init__(self, name):
241
274
 
242
275
 
243
276
class InvalidRevisionNumber(BzrError):
244
 
    
 
277
 
245
278
    _fmt = "Invalid revision number %(revno)s"
246
279
 
247
280
    def __init__(self, revno):
296
329
class NoSuchId(BzrError):
297
330
 
298
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
299
 
    
 
332
 
300
333
    def __init__(self, tree, file_id):
301
334
        BzrError.__init__(self)
302
335
        self.file_id = file_id
329
362
class NoWorkingTree(BzrError):
330
363
 
331
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
332
 
    
 
365
 
333
366
    def __init__(self, base):
334
367
        BzrError.__init__(self)
335
368
        self.base = base
366
399
    # are not intended to be caught anyway.  UI code need not subclass
367
400
    # BzrCommandError, and non-UI code should not throw a subclass of
368
401
    # BzrCommandError.  ADHB 20051211
369
 
    def __init__(self, msg):
370
 
        # Object.__str__() must return a real string
371
 
        # returning a Unicode string is a python error.
372
 
        if isinstance(msg, unicode):
373
 
            self.msg = msg.encode('utf8')
374
 
        else:
375
 
            self.msg = msg
376
 
 
377
 
    def __str__(self):
378
 
        return self.msg
379
402
 
380
403
 
381
404
class NotWriteLocked(BzrError):
454
477
    def __init__(self, name, value):
455
478
        BzrError.__init__(self, name=name, value=value)
456
479
 
457
 
    
 
480
 
458
481
class StrictCommitFailed(BzrError):
459
482
 
460
483
    _fmt = "Commit refused because there are unknown files in the tree"
463
486
# XXX: Should be unified with TransportError; they seem to represent the
464
487
# same thing
465
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
466
 
# - 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
467
490
# differentiates between 'transport has failed' and 'operation on a transport
468
491
# has failed.'
469
492
class PathError(BzrError):
470
 
    
 
493
 
471
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
472
495
 
473
496
    def __init__(self, path, extra=None):
527
550
 
528
551
 
529
552
class ReadingCompleted(InternalBzrError):
530
 
    
 
553
 
531
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
532
555
            "called upon it - the request has been completed and no more "
533
556
            "data may be read.")
562
585
        PathError.__init__(self, base, reason)
563
586
 
564
587
 
 
588
class InvalidRebaseURLs(PathError):
 
589
 
 
590
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
591
 
 
592
    def __init__(self, from_, to):
 
593
        self.from_ = from_
 
594
        self.to = to
 
595
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
596
 
 
597
 
565
598
class UnavailableRepresentation(InternalBzrError):
566
599
 
567
600
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
603
636
        self.url = url
604
637
 
605
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
 
606
649
class UnstackableRepositoryFormat(BzrError):
607
650
 
608
651
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
615
658
 
616
659
 
617
660
class ReadError(PathError):
618
 
    
 
661
 
619
662
    _fmt = """Error reading from %(path)r."""
620
663
 
621
664
 
656
699
 
657
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
658
701
# the exception object is a bit undesirable.
659
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
660
703
class NotBranchError(PathError):
661
704
 
662
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
663
706
 
664
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
665
708
       import bzrlib.urlutils as urlutils
666
 
       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)
667
731
 
668
732
 
669
733
class NoSubmitBranch(PathError):
731
795
 
732
796
 
733
797
class UnknownFormatError(BzrError):
734
 
    
 
798
 
735
799
    _fmt = "Unknown %(kind)s format: %(format)r"
736
800
 
737
801
    def __init__(self, format, kind='branch'):
740
804
 
741
805
 
742
806
class IncompatibleFormat(BzrError):
743
 
    
 
807
 
744
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
745
809
 
746
810
    def __init__(self, format, bzrdir_format):
750
814
 
751
815
 
752
816
class IncompatibleRepositories(BzrError):
753
 
 
754
 
    _fmt = "Repository %(target)s is not compatible with repository"\
755
 
        " %(source)s"
756
 
 
757
 
    def __init__(self, source, target):
758
 
        BzrError.__init__(self, target=target, source=source)
 
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
 
 
824
    _fmt = "%(target)s\n" \
 
825
            "is not compatible with\n" \
 
826
            "%(source)s\n" \
 
827
            "%(details)s"
 
828
 
 
829
    def __init__(self, source, target, details=None):
 
830
        if details is None:
 
831
            details = "(no details)"
 
832
        BzrError.__init__(self, target=target, source=source, details=details)
759
833
 
760
834
 
761
835
class IncompatibleRevision(BzrError):
762
 
    
 
836
 
763
837
    _fmt = "Revision is not compatible with %(repo_format)s"
764
838
 
765
839
    def __init__(self, repo_format):
848
922
        BzrError.__init__(self, filename=filename, kind=kind)
849
923
 
850
924
 
 
925
class BadFilenameEncoding(BzrError):
 
926
 
 
927
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
928
            ' encoding %(fs_encoding)s')
 
929
 
 
930
    def __init__(self, filename, fs_encoding):
 
931
        BzrError.__init__(self)
 
932
        self.filename = filename
 
933
        self.fs_encoding = fs_encoding
 
934
 
 
935
 
851
936
class ForbiddenControlFileError(BzrError):
852
937
 
853
938
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
955
1040
 
956
1041
class LockContention(LockError):
957
1042
 
958
 
    _fmt = 'Could not acquire lock "%(lock)s"'
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
959
1044
    # TODO: show full url for lock, combining the transport and relative
960
1045
    # bits?
961
1046
 
962
1047
    internal_error = False
963
1048
 
964
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
965
1050
        self.lock = lock
 
1051
        self.msg = msg
966
1052
 
967
1053
 
968
1054
class LockBroken(LockError):
1082
1168
 
1083
1169
class NoSuchRevisionInTree(NoSuchRevision):
1084
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
1085
 
    
 
1171
 
1086
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1087
1173
 
1088
1174
    def __init__(self, tree, revision_id):
1093
1179
 
1094
1180
class InvalidRevisionSpec(BzrError):
1095
1181
 
1096
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1097
1183
            " %(branch)s%(extra)s")
1098
1184
 
1099
1185
    def __init__(self, spec, branch, extra=None):
1124
1210
class DivergedBranches(BzrError):
1125
1211
 
1126
1212
    _fmt = ("These branches have diverged."
1127
 
            " Use the merge command to reconcile them.")
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
1128
1215
 
1129
1216
    def __init__(self, branch1, branch2):
1130
1217
        self.branch1 = branch1
1152
1239
 
1153
1240
 
1154
1241
class NoCommonAncestor(BzrError):
1155
 
    
 
1242
 
1156
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1157
1244
 
1158
1245
    def __init__(self, revision_a, revision_b):
1178
1265
            not_ancestor_id=not_ancestor_id)
1179
1266
 
1180
1267
 
1181
 
class InstallFailed(BzrError):
1182
 
 
1183
 
    def __init__(self, revisions):
1184
 
        revision_str = ", ".join(str(r) for r in revisions)
1185
 
        msg = "Could not install revisions:\n%s" % revision_str
1186
 
        BzrError.__init__(self, msg)
1187
 
        self.revisions = revisions
1188
 
 
1189
 
 
1190
1268
class AmbiguousBase(BzrError):
1191
1269
 
1192
1270
    def __init__(self, bases):
1193
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1194
 
                DeprecationWarning)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1195
1273
        msg = ("The correct base is unclear, because %s are all equally close"
1196
1274
                % ", ".join(bases))
1197
1275
        BzrError.__init__(self, msg)
1219
1297
class BoundBranchOutOfDate(BzrError):
1220
1298
 
1221
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1222
 
            " %(master)s.")
 
1300
            " %(master)s.%(extra_help)s")
1223
1301
 
1224
1302
    def __init__(self, branch, master):
1225
1303
        BzrError.__init__(self)
1226
1304
        self.branch = branch
1227
1305
        self.master = master
1228
 
 
1229
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
1230
1309
class CommitToDoubleBoundBranch(BzrError):
1231
1310
 
1232
1311
    _fmt = ("Cannot commit to branch %(branch)s."
1262
1341
 
1263
1342
class WeaveError(BzrError):
1264
1343
 
1265
 
    _fmt = "Error in processing weave: %(message)s"
 
1344
    _fmt = "Error in processing weave: %(msg)s"
1266
1345
 
1267
 
    def __init__(self, message=None):
 
1346
    def __init__(self, msg=None):
1268
1347
        BzrError.__init__(self)
1269
 
        self.message = message
 
1348
        self.msg = msg
1270
1349
 
1271
1350
 
1272
1351
class WeaveRevisionAlreadyPresent(WeaveError):
1302
1381
class WeaveParentMismatch(WeaveError):
1303
1382
 
1304
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1305
 
    
 
1384
 
1306
1385
 
1307
1386
class WeaveInvalidChecksum(WeaveError):
1308
1387
 
1334
1413
 
1335
1414
 
1336
1415
class VersionedFileError(BzrError):
1337
 
    
 
1416
 
1338
1417
    _fmt = "Versioned file error"
1339
1418
 
1340
1419
 
1341
1420
class RevisionNotPresent(VersionedFileError):
1342
 
    
 
1421
 
1343
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1344
1423
 
1345
1424
    def __init__(self, revision_id, file_id):
1349
1428
 
1350
1429
 
1351
1430
class RevisionAlreadyPresent(VersionedFileError):
1352
 
    
 
1431
 
1353
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1354
1433
 
1355
1434
    def __init__(self, revision_id, file_id):
1364
1443
 
1365
1444
 
1366
1445
class KnitError(InternalBzrError):
1367
 
    
 
1446
 
1368
1447
    _fmt = "Knit error"
1369
1448
 
1370
1449
 
1378
1457
        self.how = how
1379
1458
 
1380
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
 
1381
1475
class KnitDataStreamIncompatible(KnitError):
1382
1476
    # Not raised anymore, as we can convert data streams.  In future we may
1383
1477
    # need it again for more exotic cases, so we're keeping it around for now.
1387
1481
    def __init__(self, stream_format, target_format):
1388
1482
        self.stream_format = stream_format
1389
1483
        self.target_format = target_format
1390
 
        
 
1484
 
1391
1485
 
1392
1486
class KnitDataStreamUnknown(KnitError):
1393
1487
    # Indicates a data stream we don't know how to handle.
1396
1490
 
1397
1491
    def __init__(self, stream_format):
1398
1492
        self.stream_format = stream_format
1399
 
        
 
1493
 
1400
1494
 
1401
1495
class KnitHeaderError(KnitError):
1402
1496
 
1412
1506
 
1413
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1414
1508
    """
1415
 
    
 
1509
 
1416
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1417
1511
            " in options: %(options)r")
1418
1512
 
1422
1516
        self.options = options
1423
1517
 
1424
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
 
1425
1565
class NoSuchExportFormat(BzrError):
1426
 
    
 
1566
 
1427
1567
    _fmt = "Export format %(format)r not supported"
1428
1568
 
1429
1569
    def __init__(self, format):
1432
1572
 
1433
1573
 
1434
1574
class TransportError(BzrError):
1435
 
    
 
1575
 
1436
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1437
1577
 
1438
1578
    def __init__(self, msg=None, orig_error=None):
1483
1623
 
1484
1624
class SmartMessageHandlerError(InternalBzrError):
1485
1625
 
1486
 
    _fmt = "The message handler raised an exception: %(exc_value)s."
 
1626
    _fmt = ("The message handler raised an exception:\n"
 
1627
            "%(traceback_text)s")
1487
1628
 
1488
1629
    def __init__(self, exc_info):
1489
 
        self.exc_type, self.exc_value, self.tb = exc_info
1490
 
        
 
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
 
1491
1637
 
1492
1638
# A set of semi-meaningful errors which can be thrown
1493
1639
class TransportNotPossible(TransportError):
1519
1665
            self.port = ':%s' % port
1520
1666
 
1521
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1522
1670
class ConnectionReset(TransportError):
1523
1671
 
1524
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1565
1713
 
1566
1714
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1567
1715
 
1568
 
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1716
    def __init__(self, source, target, is_permanent=False):
1569
1717
        self.source = source
1570
1718
        self.target = target
1571
1719
        if is_permanent:
1572
1720
            self.permanently = ' permanently'
1573
1721
        else:
1574
1722
            self.permanently = ''
1575
 
        self._qualified_proto = qual_proto
1576
1723
        TransportError.__init__(self)
1577
1724
 
1578
 
    def _requalify_url(self, url):
1579
 
        """Restore the qualified proto in front of the url"""
1580
 
        # When this exception is raised, source and target are in
1581
 
        # user readable format. But some transports may use a
1582
 
        # different proto (http+urllib:// will present http:// to
1583
 
        # the user. If a qualified proto is specified, the code
1584
 
        # trapping the exception can get the qualified urls to
1585
 
        # properly handle the redirection themself (creating a
1586
 
        # new transport object from the target url for example).
1587
 
        # But checking that the scheme of the original and
1588
 
        # redirected urls are the same can be tricky. (see the
1589
 
        # FIXME in BzrDir.open_from_transport for the unique use
1590
 
        # case so far).
1591
 
        if self._qualified_proto is None:
1592
 
            return url
1593
 
 
1594
 
        # The TODO related to NotBranchError mention that doing
1595
 
        # that kind of manipulation on the urls may not be the
1596
 
        # exception object job. On the other hand, this object is
1597
 
        # the interface between the code and the user so
1598
 
        # presenting the urls in different ways is indeed its
1599
 
        # job...
1600
 
        import urlparse
1601
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1602
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1603
 
                                   query, fragment))
1604
 
 
1605
 
    def get_source_url(self):
1606
 
        return self._requalify_url(self.source)
1607
 
 
1608
 
    def get_target_url(self):
1609
 
        return self._requalify_url(self.target)
1610
 
 
1611
1725
 
1612
1726
class TooManyRedirections(TransportError):
1613
1727
 
1625
1739
        if filename is None:
1626
1740
            filename = ""
1627
1741
        message = "Error(s) parsing config file %s:\n%s" % \
1628
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1742
            (filename, ('\n'.join(e.msg for e in errors)))
1629
1743
        BzrError.__init__(self, message)
1630
1744
 
1631
1745
 
1648
1762
 
1649
1763
class WorkingTreeNotRevision(BzrError):
1650
1764
 
1651
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1652
1766
            " the last commit, but weave merge requires that it be"
1653
1767
            " unchanged")
1654
1768
 
1816
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1817
1931
 
1818
1932
    def __init__(self, from_path='', to_path='', extra=None):
 
1933
        from bzrlib.osutils import splitpath
1819
1934
        BzrError.__init__(self)
1820
1935
        if extra:
1821
1936
            self.extra = ': ' + str(extra)
1825
1940
        has_from = len(from_path) > 0
1826
1941
        has_to = len(to_path) > 0
1827
1942
        if has_from:
1828
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1943
            self.from_path = splitpath(from_path)[-1]
1829
1944
        else:
1830
1945
            self.from_path = ''
1831
1946
 
1832
1947
        if has_to:
1833
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1948
            self.to_path = splitpath(to_path)[-1]
1834
1949
        else:
1835
1950
            self.to_path = ''
1836
1951
 
1919
2034
 
1920
2035
class BadConversionTarget(BzrError):
1921
2036
 
1922
 
    _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"
1923
2039
 
1924
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
1925
2041
        BzrError.__init__(self)
1926
2042
        self.problem = problem
1927
2043
        self.format = format
 
2044
        self.from_format = from_format or '(unspecified)'
1928
2045
 
1929
2046
 
1930
2047
class NoDiffFound(BzrError):
1967
2084
    _fmt = """This tree contains left-over files from a failed operation.
1968
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1969
2086
    keep, and delete it when you are done."""
1970
 
    
 
2087
 
1971
2088
    def __init__(self, limbo_dir):
1972
2089
       BzrError.__init__(self)
1973
2090
       self.limbo_dir = limbo_dir
2006
2123
 
2007
2124
class OutOfDateTree(BzrError):
2008
2125
 
2009
 
    _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"
2010
2127
 
2011
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
2012
2133
        BzrError.__init__(self)
2013
2134
        self.tree = tree
 
2135
        self.more = more
2014
2136
 
2015
2137
 
2016
2138
class PublicBranchOutOfDate(BzrError):
2054
2176
 
2055
2177
    def __init__(self, repo):
2056
2178
        BzrError.__init__(self)
2057
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2179
        self.repo_path = repo.user_url
2058
2180
 
2059
2181
 
2060
2182
class InconsistentDelta(BzrError):
2070
2192
        self.reason = reason
2071
2193
 
2072
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
 
2073
2207
class UpgradeRequired(BzrError):
2074
2208
 
2075
2209
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2084
2218
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2085
2219
 
2086
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
 
2087
2227
class LocalRequiresBoundBranch(BzrError):
2088
2228
 
2089
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
2090
2230
 
2091
2231
 
2092
 
class MissingProgressBarFinish(BzrError):
2093
 
 
2094
 
    _fmt = "A nested progress bar was not 'finished' correctly."
2095
 
 
2096
 
 
2097
 
class InvalidProgressBarType(BzrError):
2098
 
 
2099
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2100
 
            " is not a supported type Select one of: %(valid_types)s")
2101
 
 
2102
 
    def __init__(self, bar_type, valid_types):
2103
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2104
 
 
2105
 
 
2106
2232
class UnsupportedOperation(BzrError):
2107
2233
 
2108
2234
    _fmt = ("The method %(mname)s is not supported on"
2125
2251
 
2126
2252
 
2127
2253
class BinaryFile(BzrError):
2128
 
    
 
2254
 
2129
2255
    _fmt = "File is binary but should be text."
2130
2256
 
2131
2257
 
2151
2277
 
2152
2278
 
2153
2279
class NotABundle(BzrError):
2154
 
    
 
2280
 
2155
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
2156
2282
 
2157
2283
    def __init__(self, text):
2159
2285
        self.text = text
2160
2286
 
2161
2287
 
2162
 
class BadBundle(BzrError): 
2163
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
2164
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
2165
2291
 
2166
2292
    def __init__(self, text):
2168
2294
        self.text = text
2169
2295
 
2170
2296
 
2171
 
class MalformedHeader(BadBundle): 
2172
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
2173
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2174
2300
 
2175
2301
 
2176
 
class MalformedPatches(BadBundle): 
2177
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
2178
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2179
2305
 
2180
2306
 
2181
 
class MalformedFooter(BadBundle): 
2182
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
2183
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2184
2310
 
2185
2311
 
2186
2312
class UnsupportedEOLMarker(BadBundle):
2187
 
    
2188
 
    _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"
2189
2315
 
2190
2316
    def __init__(self):
2191
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
2192
2318
        # but for this there is not
2193
2319
        BzrError.__init__(self)
2194
2320
 
2195
2321
 
2196
2322
class IncompatibleBundleFormat(BzrError):
2197
 
    
 
2323
 
2198
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2199
2325
 
2200
2326
    def __init__(self, bundle_format, other):
2204
2330
 
2205
2331
 
2206
2332
class BadInventoryFormat(BzrError):
2207
 
    
 
2333
 
2208
2334
    _fmt = "Root class for inventory serialization errors"
2209
2335
 
2210
2336
 
2229
2355
        self.transport = transport
2230
2356
 
2231
2357
 
2232
 
class NoSmartServer(NotBranchError):
2233
 
 
2234
 
    _fmt = "No smart server available at %(url)s"
2235
 
 
2236
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
2237
 
    def __init__(self, url):
2238
 
        self.url = url
2239
 
 
2240
 
 
2241
2358
class UnknownSSH(BzrError):
2242
2359
 
2243
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2263
2380
        self.revision_id = revision_id
2264
2381
        self.ghost_revision_id = ghost_revision_id
2265
2382
 
2266
 
        
 
2383
 
2267
2384
class GhostRevisionUnusableHere(BzrError):
2268
2385
 
2269
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2347
2464
        self.patch_type = patch_type
2348
2465
 
2349
2466
 
 
2467
class TargetNotBranch(BzrError):
 
2468
    """A merge directive's target branch is required, but isn't a branch"""
 
2469
 
 
2470
    _fmt = ("Your branch does not have all of the revisions required in "
 
2471
            "order to merge this merge directive and the target "
 
2472
            "location specified in the merge directive is not a branch: "
 
2473
            "%(location)s.")
 
2474
 
 
2475
    def __init__(self, location):
 
2476
        BzrError.__init__(self)
 
2477
        self.location = location
 
2478
 
 
2479
 
2350
2480
class UnsupportedInventoryKind(BzrError):
2351
 
    
 
2481
 
2352
2482
    _fmt = """Unsupported entry kind %(kind)s"""
2353
2483
 
2354
2484
    def __init__(self, kind):
2366
2496
 
2367
2497
 
2368
2498
class SubsumeTargetNeedsUpgrade(BzrError):
2369
 
    
 
2499
 
2370
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2371
2501
 
2372
2502
    def __init__(self, other_tree):
2395
2525
class TagsNotSupported(BzrError):
2396
2526
 
2397
2527
    _fmt = ("Tags not supported by %(branch)s;"
2398
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2528
            " you may be able to use bzr upgrade.")
2399
2529
 
2400
2530
    def __init__(self, branch):
2401
2531
        self.branch = branch
2402
2532
 
2403
 
        
 
2533
 
2404
2534
class TagAlreadyExists(BzrError):
2405
2535
 
2406
2536
    _fmt = "Tag %(tag_name)s already exists."
2411
2541
 
2412
2542
class MalformedBugIdentifier(BzrError):
2413
2543
 
2414
 
    _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.')
2415
2546
 
2416
2547
    def __init__(self, bug_id, reason):
2417
2548
        self.bug_id = bug_id
2438
2569
        self.branch = branch
2439
2570
 
2440
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
 
2441
2588
class UnexpectedSmartServerResponse(BzrError):
2442
2589
 
2443
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2447
2594
 
2448
2595
 
2449
2596
class ErrorFromSmartServer(BzrError):
 
2597
    """An error was received from a smart server.
 
2598
 
 
2599
    :seealso: UnknownErrorFromSmartServer
 
2600
    """
2450
2601
 
2451
2602
    _fmt = "Error received from smart server: %(error_tuple)r"
2452
2603
 
2461
2612
        self.error_args = error_tuple[1:]
2462
2613
 
2463
2614
 
 
2615
class UnknownErrorFromSmartServer(BzrError):
 
2616
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2617
    error.
 
2618
 
 
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2620
    distinguish between the following two cases:
 
2621
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2622
        and so should provoke a traceback to the user.
 
2623
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2624
        translated.  This is probably because the server sent us garbage, and
 
2625
        should not provoke a traceback.
 
2626
    """
 
2627
 
 
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2629
 
 
2630
    internal_error = False
 
2631
 
 
2632
    def __init__(self, error_from_smart_server):
 
2633
        """Constructor.
 
2634
 
 
2635
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2636
        """
 
2637
        self.error_from_smart_server = error_from_smart_server
 
2638
        self.error_tuple = error_from_smart_server.error_tuple
 
2639
 
 
2640
 
2464
2641
class ContainerError(BzrError):
2465
2642
    """Base class of container errors."""
2466
2643
 
2468
2645
class UnknownContainerFormatError(ContainerError):
2469
2646
 
2470
2647
    _fmt = "Unrecognised container format: %(container_format)r"
2471
 
    
 
2648
 
2472
2649
    def __init__(self, container_format):
2473
2650
        self.container_format = container_format
2474
2651
 
2538
2715
 
2539
2716
class NoMailAddressSpecified(BzrError):
2540
2717
 
2541
 
    _fmt = "No mail-to address specified."
 
2718
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2542
2719
 
2543
2720
 
2544
2721
class UnknownMailClient(BzrError):
2577
2754
 
2578
2755
    def __init__(self, bzrdir):
2579
2756
        import bzrlib.urlutils as urlutils
2580
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2581
2758
                                                    'ascii')
2582
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2583
2760
 
2624
2801
    _fmt = "'%(display_url)s' is already standalone."
2625
2802
 
2626
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
 
2627
2816
class ReconfigurationNotSupported(BzrDirError):
2628
2817
 
2629
2818
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2636
2825
 
2637
2826
class UncommittedChanges(BzrError):
2638
2827
 
2639
 
    _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')
2640
2830
 
2641
 
    def __init__(self, tree):
 
2831
    def __init__(self, tree, more=None):
 
2832
        if more is None:
 
2833
            more = ''
 
2834
        else:
 
2835
            more = ' ' + more
2642
2836
        import bzrlib.urlutils as urlutils
2643
2837
        display_url = urlutils.unescape_for_display(
2644
 
            tree.bzrdir.root_transport.base, 'ascii')
2645
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2838
            tree.user_url, 'ascii')
 
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2646
2840
 
2647
2841
 
2648
2842
class MissingTemplateVariable(BzrError):
2683
2877
 
2684
2878
 
2685
2879
class CommandAvailableInPlugin(StandardError):
2686
 
    
 
2880
 
2687
2881
    internal_error = False
2688
2882
 
2689
2883
    def __init__(self, cmd_name, plugin_metadata, provider):
2690
 
        
 
2884
 
2691
2885
        self.plugin_metadata = plugin_metadata
2692
2886
        self.cmd_name = cmd_name
2693
2887
        self.provider = provider
2694
2888
 
2695
2889
    def __str__(self):
2696
2890
 
2697
 
        _fmt = ('"%s" is not a standard bzr command. \n' 
 
2891
        _fmt = ('"%s" is not a standard bzr command. \n'
2698
2892
                'However, the following official plugin provides this command: %s\n'
2699
2893
                'You can install it by going to: %s'
2700
 
                % (self.cmd_name, self.plugin_metadata['name'], 
 
2894
                % (self.cmd_name, self.plugin_metadata['name'],
2701
2895
                    self.plugin_metadata['url']))
2702
2896
 
2703
2897
        return _fmt
2704
2898
 
2705
2899
 
2706
2900
class NoPluginAvailable(BzrError):
2707
 
    pass    
2708
 
 
2709
 
 
2710
 
class NotATerminal(BzrError):
2711
 
 
2712
 
    _fmt = 'Unable to ask for a password without real terminal.'
 
2901
    pass
2713
2902
 
2714
2903
 
2715
2904
class UnableEncodePath(BzrError):
2718
2907
            'user encoding %(user_encoding)s')
2719
2908
 
2720
2909
    def __init__(self, path, kind):
 
2910
        from bzrlib.osutils import get_user_encoding
2721
2911
        self.path = path
2722
2912
        self.kind = kind
2723
2913
        self.user_encoding = osutils.get_user_encoding()
2731
2921
        BzrError.__init__(self, alias_name=alias_name)
2732
2922
 
2733
2923
 
 
2924
class DirectoryLookupFailure(BzrError):
 
2925
    """Base type for lookup errors."""
 
2926
 
 
2927
    pass
 
2928
 
 
2929
 
 
2930
class InvalidLocationAlias(DirectoryLookupFailure):
 
2931
 
 
2932
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2933
 
 
2934
    def __init__(self, alias_name):
 
2935
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2936
 
 
2937
 
 
2938
class UnsetLocationAlias(DirectoryLookupFailure):
 
2939
 
 
2940
    _fmt = 'No %(alias_name)s location assigned.'
 
2941
 
 
2942
    def __init__(self, alias_name):
 
2943
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2944
 
 
2945
 
2734
2946
class CannotBindAddress(BzrError):
2735
2947
 
2736
2948
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2737
2949
 
2738
2950
    def __init__(self, host, port, orig_error):
 
2951
        # nb: in python2.4 socket.error doesn't have a useful repr
2739
2952
        BzrError.__init__(self, host=host, port=port,
2740
 
            orig_error=orig_error[1])
 
2953
            orig_error=repr(orig_error.args))
 
2954
 
 
2955
 
 
2956
class UnknownRules(BzrError):
 
2957
 
 
2958
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2959
 
 
2960
    def __init__(self, unknowns):
 
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2962
 
 
2963
 
 
2964
class HookFailed(BzrError):
 
2965
    """Raised when a pre_change_branch_tip hook function fails anything other
 
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.
 
2970
    """
 
2971
 
 
2972
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2973
            "%(traceback_text)s%(exc_value)s")
 
2974
 
 
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)
 
2979
        import traceback
 
2980
        self.hook_stage = hook_stage
 
2981
        self.hook_name = hook_name
 
2982
        self.exc_info = exc_info
 
2983
        self.exc_type = exc_info[0]
 
2984
        self.exc_value = exc_info[1]
 
2985
        self.exc_tb = exc_info[2]
 
2986
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2987
 
 
2988
 
 
2989
class TipChangeRejected(BzrError):
 
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2991
    explicitly abort a change to a branch tip.
 
2992
    """
 
2993
 
 
2994
    _fmt = u"Tip change rejected: %(msg)s"
 
2995
 
 
2996
    def __init__(self, msg):
 
2997
        self.msg = msg
 
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