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
100
127
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))
129
# __str__() should always return a 'str' object
130
# never a 'unicode' object.
131
s = self.__doc__ % self.__dict__
132
if isinstance(s, unicode):
133
return s.encode('utf8')
135
except (TypeError, NameError, ValueError, KeyError), e:
136
return 'Unprintable exception %s(%r): %s' \
137
% (self.__class__.__name__,
138
self.__dict__, str(e))
108
141
class BzrCheckError(BzrNewError):
109
142
"""Internal check failed: %(message)s"""
144
is_user_error = False
111
146
def __init__(self, message):
112
147
BzrNewError.__init__(self)
113
148
self.message = message
130
168
class InvalidRevisionId(BzrNewError):
131
169
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
171
def __init__(self, revision_id, branch):
172
# branch can be any string or object with __str__ defined
133
173
BzrNewError.__init__(self)
134
174
self.revision_id = revision_id
135
175
self.branch = branch
178
class NoSuchId(BzrNewError):
179
"""The file id %(file_id)s is not present in the tree %(tree)s."""
181
def __init__(self, tree, file_id):
182
BzrNewError.__init__(self)
183
self.file_id = file_id
138
187
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
188
"""No WorkingTree exists for %(base)s."""
141
190
def __init__(self, base):
142
191
BzrNewError.__init__(self)
146
195
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
196
"""%(url)s is not a local path."""
149
198
def __init__(self, url):
150
199
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
203
class BzrCommandError(BzrNewError):
204
"""Error from user command"""
208
# Error from malformed user command; please avoid raising this as a
209
# generic exception not caused by user input.
159
211
# I think it's a waste of effort to differentiate between errors that
160
212
# are not intended to be caught anyway. UI code need not subclass
161
213
# BzrCommandError, and non-UI code should not throw a subclass of
162
214
# BzrCommandError. ADHB 20051211
215
def __init__(self, msg):
216
# Object.__str__() must return a real string
217
# returning a Unicode string is a python error.
218
if isinstance(msg, unicode):
219
self.msg = msg.encode('utf8')
163
223
def __str__(self):
167
227
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
228
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
231
class StrictCommitFailed(BzrNewError):
232
"""Commit refused because there are unknown files in the tree"""
235
# XXX: Should be unified with TransportError; they seem to represent the
175
237
class PathError(BzrNewError):
176
238
"""Generic path error: %(path)r%(extra)s)"""
204
266
"""Permission denied: %(path)r%(extra)s"""
269
class InvalidURL(PathError):
270
"""Invalid url supplied to transport: %(path)r%(extra)s"""
273
class InvalidURLJoin(PathError):
274
"""Invalid URL join request: %(args)s%(extra)s"""
276
def __init__(self, msg, base, args):
277
PathError.__init__(self, base, msg)
279
self.args.extend(args)
282
class UnsupportedProtocol(PathError):
283
"""Unsupported protocol for url "%(path)s"%(extra)s"""
285
def __init__(self, url, extra):
286
PathError.__init__(self, url, extra=extra)
289
class ShortReadvError(PathError):
290
"""readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
292
is_user_error = False
294
def __init__(self, path, offset, length, actual, extra=None):
295
PathError.__init__(self, path, extra=extra)
207
301
class PathNotChild(BzrNewError):
208
302
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
304
is_user_error = False
209
306
def __init__(self, path, base, extra=None):
210
307
BzrNewError.__init__(self)
316
class InvalidNormalization(PathError):
317
"""Path %(path)r is not unicode normalized"""
320
# TODO: This is given a URL; we try to unescape it but doing that from inside
321
# the exception object is a bit undesirable.
322
# TODO: Probably this behavior of should be a common superclass
219
323
class NotBranchError(PathError):
220
324
"""Not a branch: %(path)s"""
326
def __init__(self, path):
327
import bzrlib.urlutils as urlutils
328
self.path = urlutils.unescape_for_display(path, 'ascii')
223
331
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
332
"""Already a branch: %(path)s."""
335
class BranchExistsWithoutWorkingTree(PathError):
336
"""Directory contains a branch, but no working tree \
337
(use bzr checkout if you wish to build a working tree): %(path)s"""
340
class AtomicFileAlreadyClosed(PathError):
341
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
343
def __init__(self, path, function):
344
PathError.__init__(self, path=path, extra=None)
345
self.function = function
348
class InaccessibleParent(PathError):
349
"""Parent not accessible given base %(base)s and relative path %(path)s"""
351
def __init__(self, path, base):
352
PathError.__init__(self, path)
227
356
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
357
"""No repository present: %(path)r"""
229
358
def __init__(self, bzrdir):
230
359
BzrNewError.__init__(self)
231
360
self.path = bzrdir.transport.clone('..').base
280
405
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."""
408
class PathsDoNotExist(BzrNewError):
409
"""Path(s) do not exist: %(paths_as_string)s"""
411
# used when reporting that paths are neither versioned nor in the working
414
def __init__(self, paths):
416
from bzrlib.osutils import quotefn
417
BzrNewError.__init__(self)
419
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
422
class BadFileKindError(BzrNewError):
423
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
426
class ForbiddenControlFileError(BzrNewError):
427
"""Cannot operate on %(filename)s because it is a control file"""
293
430
class LockError(BzrNewError):
387
527
self.format = format
391
530
class StrictCommitFailed(Exception):
392
531
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
534
class NoSuchRevision(BzrNewError):
535
"""Branch %(branch)s has no revision %(revision)s"""
537
is_user_error = False
396
539
def __init__(self, branch, revision):
398
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
540
BzrNewError.__init__(self, branch=branch, revision=revision)
543
class NoSuchRevisionSpec(BzrNewError):
544
"""No namespace registered for string: %(spec)r"""
546
def __init__(self, spec):
547
BzrNewError.__init__(self, spec=spec)
550
class InvalidRevisionSpec(BzrNewError):
551
"""Requested revision: '%(spec)s' does not exist in branch:
552
%(branch)s%(extra)s"""
554
def __init__(self, spec, branch, extra=None):
555
BzrNewError.__init__(self, branch=branch, spec=spec)
557
self.extra = '\n' + str(extra)
403
562
class HistoryMissing(BzrError):
408
567
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
570
class DivergedBranches(BzrNewError):
571
"These branches have diverged. Use the merge command to reconcile them."""
413
575
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
576
self.branch1 = branch1
416
577
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):
580
class UnrelatedBranches(BzrNewError):
581
"Branches have no common ancestor, and no merge base revision was specified."
586
class NoCommonAncestor(BzrNewError):
587
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
589
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)
590
self.revision_a = revision_a
591
self.revision_b = revision_b
433
594
class NoCommonRoot(BzrError):
458
619
def __init__(self, bases):
459
620
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
621
DeprecationWarning)
461
msg = "The correct base is unclear, becase %s are all equally close" %\
622
msg = "The correct base is unclear, because %s are all equally close" %\
463
624
BzrError.__init__(self, msg)
464
625
self.bases = bases
467
class NoCommits(BzrError):
628
class NoCommits(BzrNewError):
629
"""Branch %(branch)s has no commits."""
468
631
def __init__(self, branch):
469
msg = "Branch %s has no commits." % branch
470
BzrError.__init__(self, msg)
632
BzrNewError.__init__(self, branch=branch)
473
635
class UnlistableStore(BzrError):
626
788
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
791
class TransportError(BzrNewError):
792
"""Transport error: %(msg)s %(orig_error)s"""
633
794
def __init__(self, msg=None, orig_error=None):
634
795
if msg is None and orig_error is not None:
635
796
msg = str(orig_error)
636
BzrError.__init__(self, msg)
797
if orig_error is None:
638
802
self.orig_error = orig_error
803
BzrNewError.__init__(self)
806
class SmartProtocolError(TransportError):
807
"""Generic bzr smart protocol error: %(details)s"""
809
def __init__(self, details):
810
self.details = details
641
813
# A set of semi-meaningful errors which can be thrown
642
814
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.
815
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
818
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)
819
"""Connection error: %(msg)s %(orig_error)s"""
658
822
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
823
"""Connection closed: %(msg)s %(orig_error)s"""
826
class InvalidRange(TransportError):
827
"""Invalid range access in %(path)s at %(offset)s."""
829
def __init__(self, path, offset):
830
TransportError.__init__(self, ("Invalid range access in %s at %d"
836
class InvalidHttpResponse(TransportError):
837
"""Invalid http response for %(path)s: %(msg)s"""
839
def __init__(self, path, msg, orig_error=None):
841
TransportError.__init__(self, msg, orig_error=orig_error)
844
class InvalidHttpRange(InvalidHttpResponse):
845
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
847
def __init__(self, path, range, msg):
849
InvalidHttpResponse.__init__(self, path, msg)
852
class InvalidHttpContentType(InvalidHttpResponse):
853
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
855
def __init__(self, path, ctype, msg):
857
InvalidHttpResponse.__init__(self, path, msg)
663
860
class ConflictsInTree(BzrError):
851
1091
"""A nested progress bar was not 'finished' correctly."""
1094
class InvalidProgressBarType(BzrNewError):
1095
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1096
Select one of: %(valid_types)s"""
1098
def __init__(self, bar_type, valid_types):
1099
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1102
class UnsupportedOperation(BzrNewError):
855
1103
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1104
def __init__(self, method, method_self):
857
1105
self.method = method
858
1106
self.mname = method.__name__
859
1107
self.tname = type(method_self).__name__
1110
class BinaryFile(BzrNewError):
1111
"""File is binary but should be text."""
1114
class IllegalPath(BzrNewError):
1115
"""The path %(path)s is not permitted on this platform"""
1117
def __init__(self, path):
1118
BzrNewError.__init__(self)
1122
class TestamentMismatch(BzrNewError):
1123
"""Testament did not match expected value.
1124
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1127
def __init__(self, revision_id, expected, measured):
1128
self.revision_id = revision_id
1129
self.expected = expected
1130
self.measured = measured
1133
class NotABundle(BzrNewError):
1134
"""Not a bzr revision-bundle: %(text)r"""
1136
def __init__(self, text):
1137
BzrNewError.__init__(self)
1141
class BadBundle(BzrNewError):
1142
"""Bad bzr revision-bundle: %(text)r"""
1144
def __init__(self, text):
1145
BzrNewError.__init__(self)
1149
class MalformedHeader(BadBundle):
1150
"""Malformed bzr revision-bundle header: %(text)r"""
1152
def __init__(self, text):
1153
BzrNewError.__init__(self)
1157
class MalformedPatches(BadBundle):
1158
"""Malformed patches in bzr revision-bundle: %(text)r"""
1160
def __init__(self, text):
1161
BzrNewError.__init__(self)
1165
class MalformedFooter(BadBundle):
1166
"""Malformed footer in bzr revision-bundle: %(text)r"""
1168
def __init__(self, text):
1169
BzrNewError.__init__(self)
1173
class UnsupportedEOLMarker(BadBundle):
1174
"""End of line marker was not \\n in bzr revision-bundle"""
1177
BzrNewError.__init__(self)
1180
class BadInventoryFormat(BzrNewError):
1181
"""Root class for inventory serialization errors"""
1184
class UnexpectedInventoryFormat(BadInventoryFormat):
1185
"""The inventory was not in the expected format:\n %(msg)s"""
1187
def __init__(self, msg):
1188
BadInventoryFormat.__init__(self, msg=msg)
1191
class NoSmartServer(NotBranchError):
1192
"""No smart server available at %(url)s"""
1194
def __init__(self, url):
1198
class UnknownSSH(BzrNewError):
1199
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1201
def __init__(self, vendor):
1202
BzrNewError.__init__(self)
1203
self.vendor = vendor
1206
class GhostRevisionUnusableHere(BzrNewError):
1207
"""Ghost revision {%(revision_id)s} cannot be used here."""
1209
def __init__(self, revision_id):
1210
BzrNewError.__init__(self)
1211
self.revision_id = revision_id
1214
class IllegalUseOfScopeReplacer(BzrNewError):
1215
"""ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
1217
is_user_error = False
1219
def __init__(self, name, msg, extra=None):
1220
BzrNewError.__init__(self)
1224
self.extra = ': ' + str(extra)
1229
class InvalidImportLine(BzrNewError):
1230
"""Not a valid import statement: %(msg)\n%(text)s"""
1232
is_user_error = False
1234
def __init__(self, text, msg):
1235
BzrNewError.__init__(self)
1240
class ImportNameCollision(BzrNewError):
1241
"""Tried to import an object to the same name as an existing object. %(name)s"""
1243
is_user_error = False
1245
def __init__(self, name):
1246
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
