← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2010-05-06 07:48:22 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506074822-0bsgf2j4h8jx0xkk
Added ``bzrlib.tests.matchers`` as a place to put matchers, along with
our first in-tree matcher. See the module docstring for details.
(Robert Collins)

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
"""
31
31
 
32
32
 
33
33
# 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 
 
34
# python exceptions?   A list of values with no names seems less useful
35
35
# to me.
36
36
 
37
 
# 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
38
38
# constructed to make sure it will succeed.  But that says nothing about
39
39
# exceptions that are never raised.
40
40
 
61
61
    :cvar _fmt: Format string to display the error; this is expanded
62
62
    by the instance's dict.
63
63
    """
64
 
    
 
64
 
65
65
    internal_error = False
66
66
 
67
67
    def __init__(self, msg=None, **kwds):
72
72
        arguments can be given.  The first is for generic "user" errors which
73
73
        are not intended to be caught and so do not need a specific subclass.
74
74
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.  
 
75
        string to print the arguments.
76
76
 
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 
 
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
80
80
        parameters.
81
81
 
82
82
        :param msg: If given, this is the literal complete text for the error,
154
154
               )
155
155
 
156
156
    def __eq__(self, other):
157
 
        if self.__class__ != other.__class__:
 
157
        if self.__class__ is not other.__class__:
158
158
            return NotImplemented
159
159
        return self.__dict__ == other.__dict__
160
160
 
265
265
 
266
266
 
267
267
class InvalidEntryName(InternalBzrError):
268
 
    
 
268
 
269
269
    _fmt = "Invalid entry name: %(name)s"
270
270
 
271
271
    def __init__(self, name):
274
274
 
275
275
 
276
276
class InvalidRevisionNumber(BzrError):
277
 
    
 
277
 
278
278
    _fmt = "Invalid revision number %(revno)s"
279
279
 
280
280
    def __init__(self, revno):
329
329
class NoSuchId(BzrError):
330
330
 
331
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
    
 
332
 
333
333
    def __init__(self, tree, file_id):
334
334
        BzrError.__init__(self)
335
335
        self.file_id = file_id
362
362
class NoWorkingTree(BzrError):
363
363
 
364
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
    
 
365
 
366
366
    def __init__(self, base):
367
367
        BzrError.__init__(self)
368
368
        self.base = base
477
477
    def __init__(self, name, value):
478
478
        BzrError.__init__(self, name=name, value=value)
479
479
 
480
 
    
 
480
 
481
481
class StrictCommitFailed(BzrError):
482
482
 
483
483
    _fmt = "Commit refused because there are unknown files in the tree"
486
486
# XXX: Should be unified with TransportError; they seem to represent the
487
487
# same thing
488
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
 
# - this is finer than a TransportError - and more useful as such. It 
 
489
# - this is finer than a TransportError - and more useful as such. It
490
490
# differentiates between 'transport has failed' and 'operation on a transport
491
491
# has failed.'
492
492
class PathError(BzrError):
493
 
    
 
493
 
494
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
495
 
496
496
    def __init__(self, path, extra=None):
550
550
 
551
551
 
552
552
class ReadingCompleted(InternalBzrError):
553
 
    
 
553
 
554
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
555
            "called upon it - the request has been completed and no more "
556
556
            "data may be read.")
636
636
        self.url = url
637
637
 
638
638
 
 
639
class UnstackableLocationError(BzrError):
 
640
 
 
641
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
642
 
 
643
    def __init__(self, branch_url, target_url):
 
644
        BzrError.__init__(self)
 
645
        self.branch_url = branch_url
 
646
        self.target_url = target_url
 
647
 
 
648
 
639
649
class UnstackableRepositoryFormat(BzrError):
640
650
 
641
651
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
648
658
 
649
659
 
650
660
class ReadError(PathError):
651
 
    
 
661
 
652
662
    _fmt = """Error reading from %(path)r."""
653
663
 
654
664
 
689
699
 
690
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
691
701
# the exception object is a bit undesirable.
692
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
693
703
class NotBranchError(PathError):
694
704
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
706
 
697
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
698
708
       import bzrlib.urlutils as urlutils
699
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
709
       path = urlutils.unescape_for_display(path, 'ascii')
 
710
       if detail is not None:
 
711
           detail = ': ' + detail
 
712
       self.detail = detail
 
713
       self.bzrdir = bzrdir
 
714
       PathError.__init__(self, path=path)
 
715
 
 
716
    def _format(self):
 
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
718
        # Python 2.4 have to be old-style classes so properties don't work.
 
719
        # Instead we override _format.
 
720
        if self.detail is None:
 
721
            if self.bzrdir is not None:
 
722
                try:
 
723
                    self.bzrdir.open_repository()
 
724
                except NoRepositoryPresent:
 
725
                    self.detail = ''
 
726
                else:
 
727
                    self.detail = ': location is a repository'
 
728
            else:
 
729
                self.detail = ''
 
730
        return PathError._format(self)
700
731
 
701
732
 
702
733
class NoSubmitBranch(PathError):
764
795
 
765
796
 
766
797
class UnknownFormatError(BzrError):
767
 
    
 
798
 
768
799
    _fmt = "Unknown %(kind)s format: %(format)r"
769
800
 
770
801
    def __init__(self, format, kind='branch'):
773
804
 
774
805
 
775
806
class IncompatibleFormat(BzrError):
776
 
    
 
807
 
777
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
778
809
 
779
810
    def __init__(self, format, bzrdir_format):
783
814
 
784
815
 
785
816
class IncompatibleRepositories(BzrError):
 
817
    """Report an error that two repositories are not compatible.
 
818
 
 
819
    Note that the source and target repositories are permitted to be strings:
 
820
    this exception is thrown from the smart server and may refer to a
 
821
    repository the client hasn't opened.
 
822
    """
786
823
 
787
824
    _fmt = "%(target)s\n" \
788
825
            "is not compatible with\n" \
796
833
 
797
834
 
798
835
class IncompatibleRevision(BzrError):
799
 
    
 
836
 
800
837
    _fmt = "Revision is not compatible with %(repo_format)s"
801
838
 
802
839
    def __init__(self, repo_format):
1003
1040
 
1004
1041
class LockContention(LockError):
1005
1042
 
1006
 
    _fmt = 'Could not acquire lock "%(lock)s"'
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
1044
    # TODO: show full url for lock, combining the transport and relative
1008
1045
    # bits?
1009
1046
 
1010
1047
    internal_error = False
1011
1048
 
1012
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
1013
1050
        self.lock = lock
 
1051
        self.msg = msg
1014
1052
 
1015
1053
 
1016
1054
class LockBroken(LockError):
1130
1168
 
1131
1169
class NoSuchRevisionInTree(NoSuchRevision):
1132
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
1133
 
    
 
1171
 
1134
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1135
1173
 
1136
1174
    def __init__(self, tree, revision_id):
1141
1179
 
1142
1180
class InvalidRevisionSpec(BzrError):
1143
1181
 
1144
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1145
1183
            " %(branch)s%(extra)s")
1146
1184
 
1147
1185
    def __init__(self, spec, branch, extra=None):
1172
1210
class DivergedBranches(BzrError):
1173
1211
 
1174
1212
    _fmt = ("These branches have diverged."
1175
 
            " Use the merge command to reconcile them.")
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
1176
1215
 
1177
1216
    def __init__(self, branch1, branch2):
1178
1217
        self.branch1 = branch1
1200
1239
 
1201
1240
 
1202
1241
class NoCommonAncestor(BzrError):
1203
 
    
 
1242
 
1204
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1205
1244
 
1206
1245
    def __init__(self, revision_a, revision_b):
1226
1265
            not_ancestor_id=not_ancestor_id)
1227
1266
 
1228
1267
 
1229
 
class InstallFailed(BzrError):
1230
 
 
1231
 
    def __init__(self, revisions):
1232
 
        revision_str = ", ".join(str(r) for r in revisions)
1233
 
        msg = "Could not install revisions:\n%s" % revision_str
1234
 
        BzrError.__init__(self, msg)
1235
 
        self.revisions = revisions
1236
 
 
1237
 
 
1238
1268
class AmbiguousBase(BzrError):
1239
1269
 
1240
1270
    def __init__(self, bases):
1241
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1242
 
                DeprecationWarning)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1243
1273
        msg = ("The correct base is unclear, because %s are all equally close"
1244
1274
                % ", ".join(bases))
1245
1275
        BzrError.__init__(self, msg)
1267
1297
class BoundBranchOutOfDate(BzrError):
1268
1298
 
1269
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1270
 
            " %(master)s.")
 
1300
            " %(master)s.%(extra_help)s")
1271
1301
 
1272
1302
    def __init__(self, branch, master):
1273
1303
        BzrError.__init__(self)
1274
1304
        self.branch = branch
1275
1305
        self.master = master
1276
 
 
1277
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
1278
1309
class CommitToDoubleBoundBranch(BzrError):
1279
1310
 
1280
1311
    _fmt = ("Cannot commit to branch %(branch)s."
1350
1381
class WeaveParentMismatch(WeaveError):
1351
1382
 
1352
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1353
 
    
 
1384
 
1354
1385
 
1355
1386
class WeaveInvalidChecksum(WeaveError):
1356
1387
 
1382
1413
 
1383
1414
 
1384
1415
class VersionedFileError(BzrError):
1385
 
    
 
1416
 
1386
1417
    _fmt = "Versioned file error"
1387
1418
 
1388
1419
 
1389
1420
class RevisionNotPresent(VersionedFileError):
1390
 
    
 
1421
 
1391
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1392
1423
 
1393
1424
    def __init__(self, revision_id, file_id):
1397
1428
 
1398
1429
 
1399
1430
class RevisionAlreadyPresent(VersionedFileError):
1400
 
    
 
1431
 
1401
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1402
1433
 
1403
1434
    def __init__(self, revision_id, file_id):
1412
1443
 
1413
1444
 
1414
1445
class KnitError(InternalBzrError):
1415
 
    
 
1446
 
1416
1447
    _fmt = "Knit error"
1417
1448
 
1418
1449
 
1450
1481
    def __init__(self, stream_format, target_format):
1451
1482
        self.stream_format = stream_format
1452
1483
        self.target_format = target_format
1453
 
        
 
1484
 
1454
1485
 
1455
1486
class KnitDataStreamUnknown(KnitError):
1456
1487
    # Indicates a data stream we don't know how to handle.
1459
1490
 
1460
1491
    def __init__(self, stream_format):
1461
1492
        self.stream_format = stream_format
1462
 
        
 
1493
 
1463
1494
 
1464
1495
class KnitHeaderError(KnitError):
1465
1496
 
1475
1506
 
1476
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1477
1508
    """
1478
 
    
 
1509
 
1479
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1480
1511
            " in options: %(options)r")
1481
1512
 
1532
1563
 
1533
1564
 
1534
1565
class NoSuchExportFormat(BzrError):
1535
 
    
 
1566
 
1536
1567
    _fmt = "Export format %(format)r not supported"
1537
1568
 
1538
1569
    def __init__(self, format):
1541
1572
 
1542
1573
 
1543
1574
class TransportError(BzrError):
1544
 
    
 
1575
 
1545
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1546
1577
 
1547
1578
    def __init__(self, msg=None, orig_error=None):
1634
1665
            self.port = ':%s' % port
1635
1666
 
1636
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1637
1670
class ConnectionReset(TransportError):
1638
1671
 
1639
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1729
1762
 
1730
1763
class WorkingTreeNotRevision(BzrError):
1731
1764
 
1732
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1733
1766
            " the last commit, but weave merge requires that it be"
1734
1767
            " unchanged")
1735
1768
 
2001
2034
 
2002
2035
class BadConversionTarget(BzrError):
2003
2036
 
2004
 
    _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"
2005
2039
 
2006
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
2007
2041
        BzrError.__init__(self)
2008
2042
        self.problem = problem
2009
2043
        self.format = format
 
2044
        self.from_format = from_format or '(unspecified)'
2010
2045
 
2011
2046
 
2012
2047
class NoDiffFound(BzrError):
2049
2084
    _fmt = """This tree contains left-over files from a failed operation.
2050
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2051
2086
    keep, and delete it when you are done."""
2052
 
    
 
2087
 
2053
2088
    def __init__(self, limbo_dir):
2054
2089
       BzrError.__init__(self)
2055
2090
       self.limbo_dir = limbo_dir
2088
2123
 
2089
2124
class OutOfDateTree(BzrError):
2090
2125
 
2091
 
    _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"
2092
2127
 
2093
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
2094
2133
        BzrError.__init__(self)
2095
2134
        self.tree = tree
 
2135
        self.more = more
2096
2136
 
2097
2137
 
2098
2138
class PublicBranchOutOfDate(BzrError):
2136
2176
 
2137
2177
    def __init__(self, repo):
2138
2178
        BzrError.__init__(self)
2139
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2179
        self.repo_path = repo.user_url
2140
2180
 
2141
2181
 
2142
2182
class InconsistentDelta(BzrError):
2152
2192
        self.reason = reason
2153
2193
 
2154
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
 
2155
2207
class UpgradeRequired(BzrError):
2156
2208
 
2157
2209
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2166
2218
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2167
2219
 
2168
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
 
2169
2227
class LocalRequiresBoundBranch(BzrError):
2170
2228
 
2171
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
2172
2230
 
2173
2231
 
2174
 
class InvalidProgressBarType(BzrError):
2175
 
 
2176
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2177
 
            " is not a supported type Select one of: %(valid_types)s")
2178
 
 
2179
 
    def __init__(self, bar_type, valid_types):
2180
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2181
 
 
2182
 
 
2183
2232
class UnsupportedOperation(BzrError):
2184
2233
 
2185
2234
    _fmt = ("The method %(mname)s is not supported on"
2202
2251
 
2203
2252
 
2204
2253
class BinaryFile(BzrError):
2205
 
    
 
2254
 
2206
2255
    _fmt = "File is binary but should be text."
2207
2256
 
2208
2257
 
2228
2277
 
2229
2278
 
2230
2279
class NotABundle(BzrError):
2231
 
    
 
2280
 
2232
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
2233
2282
 
2234
2283
    def __init__(self, text):
2236
2285
        self.text = text
2237
2286
 
2238
2287
 
2239
 
class BadBundle(BzrError): 
2240
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
2241
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
2242
2291
 
2243
2292
    def __init__(self, text):
2245
2294
        self.text = text
2246
2295
 
2247
2296
 
2248
 
class MalformedHeader(BadBundle): 
2249
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
2250
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2251
2300
 
2252
2301
 
2253
 
class MalformedPatches(BadBundle): 
2254
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
2255
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2256
2305
 
2257
2306
 
2258
 
class MalformedFooter(BadBundle): 
2259
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
2260
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2261
2310
 
2262
2311
 
2263
2312
class UnsupportedEOLMarker(BadBundle):
2264
 
    
2265
 
    _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"
2266
2315
 
2267
2316
    def __init__(self):
2268
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
2269
2318
        # but for this there is not
2270
2319
        BzrError.__init__(self)
2271
2320
 
2272
2321
 
2273
2322
class IncompatibleBundleFormat(BzrError):
2274
 
    
 
2323
 
2275
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2276
2325
 
2277
2326
    def __init__(self, bundle_format, other):
2281
2330
 
2282
2331
 
2283
2332
class BadInventoryFormat(BzrError):
2284
 
    
 
2333
 
2285
2334
    _fmt = "Root class for inventory serialization errors"
2286
2335
 
2287
2336
 
2306
2355
        self.transport = transport
2307
2356
 
2308
2357
 
2309
 
class NoSmartServer(NotBranchError):
2310
 
 
2311
 
    _fmt = "No smart server available at %(url)s"
2312
 
 
2313
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
2314
 
    def __init__(self, url):
2315
 
        self.url = url
2316
 
 
2317
 
 
2318
2358
class UnknownSSH(BzrError):
2319
2359
 
2320
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2340
2380
        self.revision_id = revision_id
2341
2381
        self.ghost_revision_id = ghost_revision_id
2342
2382
 
2343
 
        
 
2383
 
2344
2384
class GhostRevisionUnusableHere(BzrError):
2345
2385
 
2346
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2438
2478
 
2439
2479
 
2440
2480
class UnsupportedInventoryKind(BzrError):
2441
 
    
 
2481
 
2442
2482
    _fmt = """Unsupported entry kind %(kind)s"""
2443
2483
 
2444
2484
    def __init__(self, kind):
2456
2496
 
2457
2497
 
2458
2498
class SubsumeTargetNeedsUpgrade(BzrError):
2459
 
    
 
2499
 
2460
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2461
2501
 
2462
2502
    def __init__(self, other_tree):
2490
2530
    def __init__(self, branch):
2491
2531
        self.branch = branch
2492
2532
 
2493
 
        
 
2533
 
2494
2534
class TagAlreadyExists(BzrError):
2495
2535
 
2496
2536
    _fmt = "Tag %(tag_name)s already exists."
2501
2541
 
2502
2542
class MalformedBugIdentifier(BzrError):
2503
2543
 
2504
 
    _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.')
2505
2546
 
2506
2547
    def __init__(self, bug_id, reason):
2507
2548
        self.bug_id = bug_id
2528
2569
        self.branch = branch
2529
2570
 
2530
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
 
2531
2588
class UnexpectedSmartServerResponse(BzrError):
2532
2589
 
2533
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2579
2636
        """
2580
2637
        self.error_from_smart_server = error_from_smart_server
2581
2638
        self.error_tuple = error_from_smart_server.error_tuple
2582
 
        
 
2639
 
2583
2640
 
2584
2641
class ContainerError(BzrError):
2585
2642
    """Base class of container errors."""
2588
2645
class UnknownContainerFormatError(ContainerError):
2589
2646
 
2590
2647
    _fmt = "Unrecognised container format: %(container_format)r"
2591
 
    
 
2648
 
2592
2649
    def __init__(self, container_format):
2593
2650
        self.container_format = container_format
2594
2651
 
2697
2754
 
2698
2755
    def __init__(self, bzrdir):
2699
2756
        import bzrlib.urlutils as urlutils
2700
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2701
2758
                                                    'ascii')
2702
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2703
2760
 
2768
2825
 
2769
2826
class UncommittedChanges(BzrError):
2770
2827
 
2771
 
    _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')
2772
2830
 
2773
 
    def __init__(self, tree):
 
2831
    def __init__(self, tree, more=None):
 
2832
        if more is None:
 
2833
            more = ''
 
2834
        else:
 
2835
            more = ' ' + more
2774
2836
        import bzrlib.urlutils as urlutils
2775
2837
        display_url = urlutils.unescape_for_display(
2776
 
            tree.bzrdir.root_transport.base, 'ascii')
2777
 
        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)
2778
2840
 
2779
2841
 
2780
2842
class MissingTemplateVariable(BzrError):
2815
2877
 
2816
2878
 
2817
2879
class CommandAvailableInPlugin(StandardError):
2818
 
    
 
2880
 
2819
2881
    internal_error = False
2820
2882
 
2821
2883
    def __init__(self, cmd_name, plugin_metadata, provider):
2822
 
        
 
2884
 
2823
2885
        self.plugin_metadata = plugin_metadata
2824
2886
        self.cmd_name = cmd_name
2825
2887
        self.provider = provider
2826
2888
 
2827
2889
    def __str__(self):
2828
2890
 
2829
 
        _fmt = ('"%s" is not a standard bzr command. \n' 
 
2891
        _fmt = ('"%s" is not a standard bzr command. \n'
2830
2892
                'However, the following official plugin provides this command: %s\n'
2831
2893
                'You can install it by going to: %s'
2832
 
                % (self.cmd_name, self.plugin_metadata['name'], 
 
2894
                % (self.cmd_name, self.plugin_metadata['name'],
2833
2895
                    self.plugin_metadata['url']))
2834
2896
 
2835
2897
        return _fmt
2836
2898
 
2837
2899
 
2838
2900
class NoPluginAvailable(BzrError):
2839
 
    pass    
2840
 
 
2841
 
 
2842
 
class NotATerminal(BzrError):
2843
 
 
2844
 
    _fmt = 'Unable to ask for a password without real terminal.'
 
2901
    pass
2845
2902
 
2846
2903
 
2847
2904
class UnableEncodePath(BzrError):
2891
2948
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2892
2949
 
2893
2950
    def __init__(self, host, port, orig_error):
 
2951
        # nb: in python2.4 socket.error doesn't have a useful repr
2894
2952
        BzrError.__init__(self, host=host, port=port,
2895
 
            orig_error=orig_error[1])
 
2953
            orig_error=repr(orig_error.args))
2896
2954
 
2897
2955
 
2898
2956
class UnknownRules(BzrError):
2906
2964
class HookFailed(BzrError):
2907
2965
    """Raised when a pre_change_branch_tip hook function fails anything other
2908
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.
2909
2970
    """
2910
2971
 
2911
2972
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2912
2973
            "%(traceback_text)s%(exc_value)s")
2913
2974
 
2914
 
    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)
2915
2979
        import traceback
2916
2980
        self.hook_stage = hook_stage
2917
2981
        self.hook_name = hook_name
2926
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
2927
2991
    explicitly abort a change to a branch tip.
2928
2992
    """
2929
 
    
 
2993
 
2930
2994
    _fmt = u"Tip change rejected: %(msg)s"
2931
2995
 
2932
2996
    def __init__(self, msg):
2954
3018
        BzrError.__init__(self, invalid_id=invalid_id)
2955
3019
 
2956
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
 
2957
3029
class UserAbort(BzrError):
2958
3030
 
2959
3031
    _fmt = 'The user aborted the operation.'
2965
3037
 
2966
3038
    def __init__(self, format, url):
2967
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