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
119
135
class BzrCheckError(BzrNewError):
120
136
"""Internal check failed: %(message)s"""
138
is_user_error = False
122
140
def __init__(self, message):
123
141
BzrNewError.__init__(self)
124
142
self.message = message
127
145
class InvalidEntryName(BzrNewError):
128
146
"""Invalid entry name: %(name)s"""
148
is_user_error = False
129
150
def __init__(self, name):
130
151
BzrNewError.__init__(self)
166
class BzrCommandError(BzrError):
167
# Error from malformed user command
168
# This is being misused as a generic exception
169
# pleae subclass. RBC 20051030
187
class BzrCommandError(BzrNewError):
188
"""Error from user command"""
192
# Error from malformed user command; please avoid raising this as a
193
# generic exception not caused by user input.
171
195
# I think it's a waste of effort to differentiate between errors that
172
196
# are not intended to be caught anyway. UI code need not subclass
173
197
# BzrCommandError, and non-UI code should not throw a subclass of
174
198
# BzrCommandError. ADHB 20051211
199
def __init__(self, msg):
175
202
def __str__(self):
179
206
class BzrOptionError(BzrCommandError):
180
"""Some missing or otherwise incorrect option was supplied."""
207
"""Error in command line options"""
183
class StrictCommitFailed(Exception):
184
"""Commit refused because there are unknowns in the tree."""
210
class StrictCommitFailed(BzrNewError):
211
"""Commit refused because there are unknown files in the tree"""
187
214
# XXX: Should be unified with TransportError; they seem to represent the
218
245
"""Permission denied: %(path)r%(extra)s"""
248
class InvalidURL(PathError):
249
"""Invalid url supplied to transport: %(path)r%(extra)s"""
252
class InvalidURLJoin(PathError):
253
"""Invalid URL join request: %(args)s%(extra)s"""
255
def __init__(self, msg, base, args):
256
PathError.__init__(self, base, msg)
258
self.args.extend(args)
221
261
class PathNotChild(BzrNewError):
222
262
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
264
is_user_error = False
223
266
def __init__(self, path, base, extra=None):
224
267
BzrNewError.__init__(self)
276
# TODO: This is given a URL; we try to unescape it but doing that from inside
277
# the exception object is a bit undesirable.
278
# TODO: Probably this behavior of should be a common superclass
233
279
class NotBranchError(PathError):
234
280
"""Not a branch: %(path)s"""
282
def __init__(self, path):
283
import bzrlib.urlutils as urlutils
284
self.path = urlutils.unescape_for_display(path, 'ascii')
237
287
class AlreadyBranchError(PathError):
238
288
"""Already a branch: %(path)s."""
263
class UnsupportedFormatError(BzrError):
264
"""Specified path is a bzr branch that we recognize but cannot read."""
266
return 'unsupported branch format: %s' % self.args[0]
269
class UnknownFormatError(BzrError):
270
"""Specified path is a bzr branch whose format we do not recognize."""
272
return 'unknown branch format: %s' % self.args[0]
313
class UnsupportedFormatError(BzrNewError):
314
"""Unsupported branch format: %(format)s"""
317
class UnknownFormatError(BzrNewError):
318
"""Unknown branch format: %(format)r"""
275
321
class IncompatibleFormat(BzrNewError):
313
359
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
316
class BadFileKindError(BzrError):
317
"""Specified file is of a kind that cannot be added.
319
(For example a symlink or device file.)"""
322
class ForbiddenFileError(BzrError):
323
"""Cannot operate on a file because it is a control file."""
362
class BadFileKindError(BzrNewError):
363
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
366
class ForbiddenControlFileError(BzrNewError):
367
"""Cannot operate on %(filename)s because it is a control file"""
326
370
class LockError(BzrNewError):
359
403
class ObjectNotLocked(LockError):
360
404
"""%(obj)r is not locked"""
406
is_user_error = False
361
408
# this can indicate that any particular object is not locked; see also
362
409
# LockNotHeld which means that a particular *lock* object is not held by
363
410
# the caller -- perhaps they should be unified.
425
472
"""Commit refused because there are unknowns in the tree."""
428
class NoSuchRevision(BzrError):
475
class NoSuchRevision(BzrNewError):
476
"""Branch %(branch)s has no revision %(revision)s"""
478
is_user_error = False
429
480
def __init__(self, branch, revision):
430
481
self.branch = branch
431
482
self.revision = revision
432
msg = "Branch %s has no revision %s" % (branch, revision)
433
BzrError.__init__(self, msg)
436
485
class HistoryMissing(BzrError):
441
490
% (branch, object_type, object_id))
444
class DivergedBranches(BzrError):
493
class DivergedBranches(BzrNewError):
494
"These branches have diverged. Use the merge command to reconcile them."""
446
498
def __init__(self, branch1, branch2):
447
BzrError.__init__(self, "These branches have diverged. Try merge.")
448
499
self.branch1 = branch1
449
500
self.branch2 = branch2
452
class UnrelatedBranches(BzrCommandError):
454
msg = "Branches have no common ancestor, and no base revision"\
456
BzrCommandError.__init__(self, msg)
459
class NoCommonAncestor(BzrError):
503
class UnrelatedBranches(BzrNewError):
504
"Branches have no common ancestor, and no merge base revision was specified."
509
class NoCommonAncestor(BzrNewError):
510
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
460
512
def __init__(self, revision_a, revision_b):
461
msg = "Revisions have no common ancestor: %s %s." \
462
% (revision_a, revision_b)
463
BzrError.__init__(self, msg)
513
self.revision_a = revision_a
514
self.revision_b = revision_b
466
517
class NoCommonRoot(BzrError):
491
542
def __init__(self, bases):
492
543
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
493
544
DeprecationWarning)
494
msg = "The correct base is unclear, becase %s are all equally close" %\
545
msg = "The correct base is unclear, because %s are all equally close" %\
496
547
BzrError.__init__(self, msg)
497
548
self.bases = bases
842
893
self.format = format
896
class NoDiff(BzrNewError):
897
"""Diff is not installed on this machine: %(msg)s"""
899
def __init__(self, msg):
900
super(NoDiff, self).__init__(msg=msg)
845
903
class NoDiff3(BzrNewError):
846
904
"""Diff3 is not installed on this machine."""
938
996
self.measured = measured
999
class NotABundle(BzrNewError):
1000
"""Not a bzr revision-bundle: %(text)r"""
1002
def __init__(self, text):
941
1006
class BadBundle(Exception): pass
added
removed
bzrlib/errors.py
