1
1
# Copyright (C) 2005, 2006 Canonical
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Exceptions for bzr, and reporting of them.
19
There are 3 different classes of error:
21
* KeyboardInterrupt, and OSError with EPIPE - the program terminates
22
with an appropriate short message
24
* User errors, indicating a problem caused by the user such as a bad URL.
25
These are printed in a short form.
27
* Internal unexpected errors, including most Python builtin errors
28
and some raised from inside bzr. These are printed with a full
29
traceback and an invitation to report the bug.
19
31
Exceptions are caught at a high level to report errors to the user, and
20
32
might also be caught inside the program. Therefore it needs to be
21
33
possible to convert them to a meaningful string, and also for them to be
46
58
* create a new exception class for any class of error that can be
47
usefully distinguished.
49
* the printable form of an exception is generated by the base class
52
Exception strings should start with a capital letter and not have a final
59
usefully distinguished. If no callers are likely to want to catch
60
one but not another, don't worry about them.
62
* the __str__ method should generate something useful; BzrError provides
63
a good default implementation
65
Exception strings should start with a capital letter and should not have a
56
69
from warnings import warn
71
from bzrlib.patches import (PatchSyntax,
58
78
# based on Scott James Remnant's hct error classes
60
80
# TODO: is there any value in providing the .args field used by standard
93
120
# base classes should override the docstring with their human-
94
121
# readable explanation
96
def __init__(self, **kwds):
123
def __init__(self, *args, **kwds):
124
# XXX: Use the underlying BzrError to always generate the args attribute
125
# if it doesn't exist. We can't use super here, because exceptions are
126
# old-style classes in python2.4 (but new in 2.5). --bmc, 20060426
127
BzrError.__init__(self, *args)
97
128
for key, value in kwds.items():
98
129
setattr(self, key, value)
100
131
def __str__(self):
102
return self.__doc__ % self.__dict__
103
except (NameError, ValueError, KeyError), e:
104
return 'Unprintable exception %s: %s' \
105
% (self.__class__.__name__, str(e))
133
# __str__() should always return a 'str' object
134
# never a 'unicode' object.
135
s = self.__doc__ % self.__dict__
136
if isinstance(s, unicode):
137
return s.encode('utf8')
139
except (TypeError, NameError, ValueError, KeyError), e:
140
return 'Unprintable exception %s(%r): %s' \
141
% (self.__class__.__name__,
142
self.__dict__, str(e))
145
class AlreadyBuilding(BzrNewError):
146
"""The tree builder is already building a tree."""
108
149
class BzrCheckError(BzrNewError):
109
150
"""Internal check failed: %(message)s"""
152
is_user_error = False
111
154
def __init__(self, message):
112
155
BzrNewError.__init__(self)
113
156
self.message = message
130
176
class InvalidRevisionId(BzrNewError):
131
177
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
179
def __init__(self, revision_id, branch):
180
# branch can be any string or object with __str__ defined
133
181
BzrNewError.__init__(self)
134
182
self.revision_id = revision_id
135
183
self.branch = branch
186
class NoSuchId(BzrNewError):
187
"""The file id %(file_id)s is not present in the tree %(tree)s."""
189
def __init__(self, tree, file_id):
190
BzrNewError.__init__(self)
191
self.file_id = file_id
138
195
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
196
"""No WorkingTree exists for %(base)s."""
141
198
def __init__(self, base):
142
199
BzrNewError.__init__(self)
203
class NotBuilding(BzrNewError):
204
"""Not currently building a tree."""
146
207
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
208
"""%(url)s is not a local path."""
149
210
def __init__(self, url):
150
211
BzrNewError.__init__(self)
154
class BzrCommandError(BzrError):
155
# Error from malformed user command
156
# This is being misused as a generic exception
157
# pleae subclass. RBC 20051030
215
class BzrCommandError(BzrNewError):
216
"""Error from user command"""
220
# Error from malformed user command; please avoid raising this as a
221
# generic exception not caused by user input.
159
223
# I think it's a waste of effort to differentiate between errors that
160
224
# are not intended to be caught anyway. UI code need not subclass
161
225
# BzrCommandError, and non-UI code should not throw a subclass of
162
226
# BzrCommandError. ADHB 20051211
227
def __init__(self, msg):
228
# Object.__str__() must return a real string
229
# returning a Unicode string is a python error.
230
if isinstance(msg, unicode):
231
self.msg = msg.encode('utf8')
163
235
def __str__(self):
167
239
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
240
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
243
class StrictCommitFailed(BzrNewError):
244
"""Commit refused because there are unknown files in the tree"""
247
# XXX: Should be unified with TransportError; they seem to represent the
175
249
class PathError(BzrNewError):
176
250
"""Generic path error: %(path)r%(extra)s)"""
204
278
"""Permission denied: %(path)r%(extra)s"""
281
class InvalidURL(PathError):
282
"""Invalid url supplied to transport: %(path)r%(extra)s"""
285
class InvalidURLJoin(PathError):
286
"""Invalid URL join request: %(args)s%(extra)s"""
288
def __init__(self, msg, base, args):
289
PathError.__init__(self, base, msg)
290
self.args = [base] + list(args)
293
class UnsupportedProtocol(PathError):
294
"""Unsupported protocol for url "%(path)s"%(extra)s"""
296
def __init__(self, url, extra):
297
PathError.__init__(self, url, extra=extra)
300
class ShortReadvError(PathError):
301
"""readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
303
is_user_error = False
305
def __init__(self, path, offset, length, actual, extra=None):
306
PathError.__init__(self, path, extra=extra)
207
312
class PathNotChild(BzrNewError):
208
313
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
315
is_user_error = False
209
317
def __init__(self, path, base, extra=None):
210
318
BzrNewError.__init__(self)
327
class InvalidNormalization(PathError):
328
"""Path %(path)r is not unicode normalized"""
331
# TODO: This is given a URL; we try to unescape it but doing that from inside
332
# the exception object is a bit undesirable.
333
# TODO: Probably this behavior of should be a common superclass
219
334
class NotBranchError(PathError):
220
335
"""Not a branch: %(path)s"""
337
def __init__(self, path):
338
import bzrlib.urlutils as urlutils
339
self.path = urlutils.unescape_for_display(path, 'ascii')
223
342
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
343
"""Already a branch: %(path)s."""
346
class BranchExistsWithoutWorkingTree(PathError):
347
"""Directory contains a branch, but no working tree \
348
(use bzr checkout if you wish to build a working tree): %(path)s"""
351
class AtomicFileAlreadyClosed(PathError):
352
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
354
def __init__(self, path, function):
355
PathError.__init__(self, path=path, extra=None)
356
self.function = function
359
class InaccessibleParent(PathError):
360
"""Parent not accessible given base %(base)s and relative path %(path)s"""
362
def __init__(self, path, base):
363
PathError.__init__(self, path)
227
367
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
368
"""No repository present: %(path)r"""
229
369
def __init__(self, bzrdir):
230
370
BzrNewError.__init__(self)
231
371
self.path = bzrdir.transport.clone('..').base
280
416
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
283
class BadFileKindError(BzrError):
284
"""Specified file is of a kind that cannot be added.
286
(For example a symlink or device file.)"""
289
class ForbiddenFileError(BzrError):
290
"""Cannot operate on a file because it is a control file."""
419
class PathsDoNotExist(BzrNewError):
420
"""Path(s) do not exist: %(paths_as_string)s"""
422
# used when reporting that paths are neither versioned nor in the working
425
def __init__(self, paths):
427
from bzrlib.osutils import quotefn
428
BzrNewError.__init__(self)
430
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
433
class BadFileKindError(BzrNewError):
434
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
437
class ForbiddenControlFileError(BzrNewError):
438
"""Cannot operate on %(filename)s because it is a control file"""
293
441
class LockError(BzrNewError):
387
538
self.format = format
391
541
class StrictCommitFailed(Exception):
392
542
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
545
class NoSuchRevision(BzrNewError):
546
"""Branch %(branch)s has no revision %(revision)s"""
548
is_user_error = False
396
550
def __init__(self, branch, revision):
398
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
551
BzrNewError.__init__(self, branch=branch, revision=revision)
554
class NoSuchRevisionSpec(BzrNewError):
555
"""No namespace registered for string: %(spec)r"""
557
def __init__(self, spec):
558
BzrNewError.__init__(self, spec=spec)
561
class InvalidRevisionSpec(BzrNewError):
562
"""Requested revision: '%(spec)s' does not exist in branch:
563
%(branch)s%(extra)s"""
565
def __init__(self, spec, branch, extra=None):
566
BzrNewError.__init__(self, branch=branch, spec=spec)
568
self.extra = '\n' + str(extra)
403
573
class HistoryMissing(BzrError):
408
578
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
581
class DivergedBranches(BzrNewError):
582
"These branches have diverged. Use the merge command to reconcile them."""
413
586
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
587
self.branch1 = branch1
416
588
self.branch2 = branch2
419
class UnrelatedBranches(BzrCommandError):
421
msg = "Branches have no common ancestor, and no base revision"\
423
BzrCommandError.__init__(self, msg)
426
class NoCommonAncestor(BzrError):
591
class UnrelatedBranches(BzrNewError):
592
"Branches have no common ancestor, and no merge base revision was specified."
597
class NoCommonAncestor(BzrNewError):
598
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
600
def __init__(self, revision_a, revision_b):
428
msg = "Revisions have no common ancestor: %s %s." \
429
% (revision_a, revision_b)
430
BzrError.__init__(self, msg)
601
self.revision_a = revision_a
602
self.revision_b = revision_b
433
605
class NoCommonRoot(BzrError):
458
630
def __init__(self, bases):
459
631
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
632
DeprecationWarning)
461
msg = "The correct base is unclear, becase %s are all equally close" %\
633
msg = "The correct base is unclear, because %s are all equally close" %\
463
635
BzrError.__init__(self, msg)
464
636
self.bases = bases
467
class NoCommits(BzrError):
639
class NoCommits(BzrNewError):
640
"""Branch %(branch)s has no commits."""
468
642
def __init__(self, branch):
469
msg = "Branch %s has no commits." % branch
470
BzrError.__init__(self, msg)
643
BzrNewError.__init__(self, branch=branch)
473
646
class UnlistableStore(BzrError):
626
799
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
802
class TransportError(BzrNewError):
803
"""Transport error: %(msg)s %(orig_error)s"""
633
805
def __init__(self, msg=None, orig_error=None):
634
806
if msg is None and orig_error is not None:
635
807
msg = str(orig_error)
636
BzrError.__init__(self, msg)
808
if orig_error is None:
638
813
self.orig_error = orig_error
814
BzrNewError.__init__(self)
817
class SmartProtocolError(TransportError):
818
"""Generic bzr smart protocol error: %(details)s"""
820
def __init__(self, details):
821
self.details = details
641
824
# A set of semi-meaningful errors which can be thrown
642
825
class TransportNotPossible(TransportError):
643
"""This is for transports where a specific function is explicitly not
644
possible. Such as pushing files to an HTTP server.
826
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
829
class ConnectionError(TransportError):
650
"""A connection problem prevents file retrieval.
651
This does not indicate whether the file exists or not; it indicates that a
652
precondition for requesting the file was not met.
654
def __init__(self, msg=None, orig_error=None):
655
TransportError.__init__(self, msg=msg, orig_error=orig_error)
830
"""%(msg)s %(orig_error)s"""
658
833
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
834
"""Connection closed: %(msg)s %(orig_error)s"""
837
class InvalidRange(TransportError):
838
"""Invalid range access in %(path)s at %(offset)s."""
840
def __init__(self, path, offset):
841
TransportError.__init__(self, ("Invalid range access in %s at %d"
847
class InvalidHttpResponse(TransportError):
848
"""Invalid http response for %(path)s: %(msg)s"""
850
def __init__(self, path, msg, orig_error=None):
852
TransportError.__init__(self, msg, orig_error=orig_error)
855
class InvalidHttpRange(InvalidHttpResponse):
856
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
858
def __init__(self, path, range, msg):
860
InvalidHttpResponse.__init__(self, path, msg)
863
class InvalidHttpContentType(InvalidHttpResponse):
864
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
866
def __init__(self, path, ctype, msg):
868
InvalidHttpResponse.__init__(self, path, msg)
663
871
class ConflictsInTree(BzrError):
851
1102
"""A nested progress bar was not 'finished' correctly."""
1105
class InvalidProgressBarType(BzrNewError):
1106
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1107
Select one of: %(valid_types)s"""
1109
def __init__(self, bar_type, valid_types):
1110
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1113
class UnsupportedOperation(BzrNewError):
855
1114
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1115
def __init__(self, method, method_self):
857
1116
self.method = method
858
1117
self.mname = method.__name__
859
1118
self.tname = type(method_self).__name__
1121
class BinaryFile(BzrNewError):
1122
"""File is binary but should be text."""
1125
class IllegalPath(BzrNewError):
1126
"""The path %(path)s is not permitted on this platform"""
1128
def __init__(self, path):
1129
BzrNewError.__init__(self)
1133
class TestamentMismatch(BzrNewError):
1134
"""Testament did not match expected value.
1135
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1138
def __init__(self, revision_id, expected, measured):
1139
self.revision_id = revision_id
1140
self.expected = expected
1141
self.measured = measured
1144
class NotABundle(BzrNewError):
1145
"""Not a bzr revision-bundle: %(text)r"""
1147
def __init__(self, text):
1148
BzrNewError.__init__(self)
1152
class BadBundle(BzrNewError):
1153
"""Bad bzr revision-bundle: %(text)r"""
1155
def __init__(self, text):
1156
BzrNewError.__init__(self)
1160
class MalformedHeader(BadBundle):
1161
"""Malformed bzr revision-bundle header: %(text)r"""
1163
def __init__(self, text):
1164
BzrNewError.__init__(self)
1168
class MalformedPatches(BadBundle):
1169
"""Malformed patches in bzr revision-bundle: %(text)r"""
1171
def __init__(self, text):
1172
BzrNewError.__init__(self)
1176
class MalformedFooter(BadBundle):
1177
"""Malformed footer in bzr revision-bundle: %(text)r"""
1179
def __init__(self, text):
1180
BzrNewError.__init__(self)
1184
class UnsupportedEOLMarker(BadBundle):
1185
"""End of line marker was not \\n in bzr revision-bundle"""
1188
BzrNewError.__init__(self)
1191
class BadInventoryFormat(BzrNewError):
1192
"""Root class for inventory serialization errors"""
1195
class UnexpectedInventoryFormat(BadInventoryFormat):
1196
"""The inventory was not in the expected format:\n %(msg)s"""
1198
def __init__(self, msg):
1199
BadInventoryFormat.__init__(self, msg=msg)
1202
class NoSmartServer(NotBranchError):
1203
"""No smart server available at %(url)s"""
1205
def __init__(self, url):
1209
class UnknownSSH(BzrNewError):
1210
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1212
def __init__(self, vendor):
1213
BzrNewError.__init__(self)
1214
self.vendor = vendor
1217
class GhostRevisionUnusableHere(BzrNewError):
1218
"""Ghost revision {%(revision_id)s} cannot be used here."""
1220
def __init__(self, revision_id):
1221
BzrNewError.__init__(self)
1222
self.revision_id = revision_id
1225
class IllegalUseOfScopeReplacer(BzrNewError):
1226
"""ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
1228
is_user_error = False
1230
def __init__(self, name, msg, extra=None):
1231
BzrNewError.__init__(self)
1235
self.extra = ': ' + str(extra)
1240
class InvalidImportLine(BzrNewError):
1241
"""Not a valid import statement: %(msg)\n%(text)s"""
1243
is_user_error = False
1245
def __init__(self, text, msg):
1246
BzrNewError.__init__(self)
1251
class ImportNameCollision(BzrNewError):
1252
"""Tried to import an object to the same name as an existing object. %(name)s"""
1254
is_user_error = False
1256
def __init__(self, name):
1257
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
