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__
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')
103
135
except (NameError, ValueError, KeyError), e:
104
136
return 'Unprintable exception %s: %s' \
105
137
% (self.__class__.__name__, str(e))
130
167
class InvalidRevisionId(BzrNewError):
131
168
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
170
def __init__(self, revision_id, branch):
171
# branch can be any string or object with __str__ defined
133
172
BzrNewError.__init__(self)
134
173
self.revision_id = revision_id
135
174
self.branch = branch
177
class NoSuchId(BzrNewError):
178
"""The file id %(file_id)s is not present in the tree %(tree)s."""
180
def __init__(self, tree, file_id):
181
BzrNewError.__init__(self)
182
self.file_id = file_id
138
186
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
187
"""No WorkingTree exists for %(base)s."""
141
189
def __init__(self, base):
142
190
BzrNewError.__init__(self)
146
194
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
195
"""%(url)s is not a local path."""
149
197
def __init__(self, url):
150
198
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
202
class BzrCommandError(BzrNewError):
203
"""Error from user command"""
207
# Error from malformed user command; please avoid raising this as a
208
# generic exception not caused by user input.
159
210
# I think it's a waste of effort to differentiate between errors that
160
211
# are not intended to be caught anyway. UI code need not subclass
161
212
# BzrCommandError, and non-UI code should not throw a subclass of
162
213
# BzrCommandError. ADHB 20051211
214
def __init__(self, msg):
215
# Object.__str__() must return a real string
216
# returning a Unicode string is a python error.
217
if isinstance(msg, unicode):
218
self.msg = msg.encode('utf8')
163
222
def __str__(self):
167
226
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
227
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
230
class StrictCommitFailed(BzrNewError):
231
"""Commit refused because there are unknown files in the tree"""
234
# XXX: Should be unified with TransportError; they seem to represent the
175
236
class PathError(BzrNewError):
176
237
"""Generic path error: %(path)r%(extra)s)"""
204
265
"""Permission denied: %(path)r%(extra)s"""
268
class InvalidURL(PathError):
269
"""Invalid url supplied to transport: %(path)r%(extra)s"""
272
class InvalidURLJoin(PathError):
273
"""Invalid URL join request: %(args)s%(extra)s"""
275
def __init__(self, msg, base, args):
276
PathError.__init__(self, base, msg)
278
self.args.extend(args)
281
class UnsupportedProtocol(PathError):
282
"""Unsupported protocol for url "%(path)s"%(extra)s"""
284
def __init__(self, url, extra):
285
PathError.__init__(self, url, extra=extra)
207
288
class PathNotChild(BzrNewError):
208
289
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
291
is_user_error = False
209
293
def __init__(self, path, base, extra=None):
210
294
BzrNewError.__init__(self)
303
class InvalidNormalization(PathError):
304
"""Path %(path)r is not unicode normalized"""
307
# TODO: This is given a URL; we try to unescape it but doing that from inside
308
# the exception object is a bit undesirable.
309
# TODO: Probably this behavior of should be a common superclass
219
310
class NotBranchError(PathError):
220
311
"""Not a branch: %(path)s"""
313
def __init__(self, path):
314
import bzrlib.urlutils as urlutils
315
self.path = urlutils.unescape_for_display(path, 'ascii')
223
318
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
319
"""Already a branch: %(path)s."""
322
class BranchExistsWithoutWorkingTree(PathError):
323
"""Directory contains a branch, but no working tree \
324
(use bzr checkout if you wish to build a working tree): %(path)s"""
327
class AtomicFileAlreadyClosed(PathError):
328
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
330
def __init__(self, path, function):
331
PathError.__init__(self, path=path, extra=None)
332
self.function = function
335
class InaccessibleParent(PathError):
336
"""Parent not accessible given base %(base)s and relative path %(path)s"""
338
def __init__(self, path, base):
339
PathError.__init__(self, path)
227
343
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
344
"""No repository present: %(path)r"""
229
345
def __init__(self, bzrdir):
230
346
BzrNewError.__init__(self)
231
347
self.path = bzrdir.transport.clone('..').base
244
class UnsupportedFormatError(BzrError):
245
"""Specified path is a bzr branch that we recognize but cannot read."""
247
return 'unsupported branch format: %s' % self.args[0]
250
class UnknownFormatError(BzrError):
251
"""Specified path is a bzr branch whose format we do not recognize."""
253
return 'unknown branch format: %s' % self.args[0]
360
class UnsupportedFormatError(BzrNewError):
361
"""Unsupported branch format: %(format)s"""
364
class UnknownFormatError(BzrNewError):
365
"""Unknown branch format: %(format)r"""
256
368
class IncompatibleFormat(BzrNewError):
280
392
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."""
395
class PathsDoNotExist(BzrNewError):
396
"""Path(s) do not exist: %(paths_as_string)s"""
398
# used when reporting that paths are neither versioned nor in the working
401
def __init__(self, paths):
403
from bzrlib.osutils import quotefn
404
BzrNewError.__init__(self)
406
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
409
class BadFileKindError(BzrNewError):
410
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
413
class ForbiddenControlFileError(BzrNewError):
414
"""Cannot operate on %(filename)s because it is a control file"""
293
417
class LockError(BzrNewError):
387
514
self.format = format
391
517
class StrictCommitFailed(Exception):
392
518
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
521
class NoSuchRevision(BzrNewError):
522
"""Branch %(branch)s has no revision %(revision)s"""
524
is_user_error = False
396
526
def __init__(self, branch, revision):
398
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
527
BzrNewError.__init__(self, branch=branch, revision=revision)
530
class NoSuchRevisionInTree(NoSuchRevision):
531
"""The revision id %(revision_id)s is not present in the tree %(tree)s."""
533
def __init__(self, tree, revision_id):
534
BzrNewError.__init__(self)
536
self.revision_id = revision_id
539
class NoSuchRevisionSpec(BzrNewError):
540
"""No namespace registered for string: %(spec)r"""
542
def __init__(self, spec):
543
BzrNewError.__init__(self, spec=spec)
546
class InvalidRevisionSpec(BzrNewError):
547
"""Requested revision: '%(spec)s' does not exist in branch:
548
%(branch)s%(extra)s"""
550
def __init__(self, spec, branch, extra=None):
551
BzrNewError.__init__(self, branch=branch, spec=spec)
553
self.extra = '\n' + str(extra)
403
558
class HistoryMissing(BzrError):
408
563
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
566
class DivergedBranches(BzrNewError):
567
"These branches have diverged. Use the merge command to reconcile them."""
413
571
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
572
self.branch1 = branch1
416
573
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):
576
class UnrelatedBranches(BzrNewError):
577
"Branches have no common ancestor, and no merge base revision was specified."
582
class NoCommonAncestor(BzrNewError):
583
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
585
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)
586
self.revision_a = revision_a
587
self.revision_b = revision_b
433
590
class NoCommonRoot(BzrError):
458
615
def __init__(self, bases):
459
616
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
617
DeprecationWarning)
461
msg = "The correct base is unclear, becase %s are all equally close" %\
618
msg = "The correct base is unclear, because %s are all equally close" %\
463
620
BzrError.__init__(self, msg)
464
621
self.bases = bases
467
class NoCommits(BzrError):
624
class NoCommits(BzrNewError):
625
"""Branch %(branch)s has no commits."""
468
627
def __init__(self, branch):
469
msg = "Branch %s has no commits." % branch
470
BzrError.__init__(self, msg)
628
BzrNewError.__init__(self, branch=branch)
473
631
class UnlistableStore(BzrError):
626
784
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
787
class TransportError(BzrNewError):
788
"""Transport error: %(msg)s %(orig_error)s"""
633
790
def __init__(self, msg=None, orig_error=None):
634
791
if msg is None and orig_error is not None:
635
792
msg = str(orig_error)
636
BzrError.__init__(self, msg)
793
if orig_error is None:
638
798
self.orig_error = orig_error
799
BzrNewError.__init__(self)
641
802
# A set of semi-meaningful errors which can be thrown
642
803
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.
804
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
807
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)
808
"""Connection error: %(msg)s %(orig_error)s"""
658
811
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
812
"""Connection closed: %(msg)s %(orig_error)s"""
815
class InvalidRange(TransportError):
816
"""Invalid range access in %(path)s at %(offset)s."""
818
def __init__(self, path, offset):
819
TransportError.__init__(self, ("Invalid range access in %s at %d"
825
class InvalidHttpResponse(TransportError):
826
"""Invalid http response for %(path)s: %(msg)s"""
828
def __init__(self, path, msg, orig_error=None):
830
TransportError.__init__(self, msg, orig_error=orig_error)
833
class InvalidHttpRange(InvalidHttpResponse):
834
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
836
def __init__(self, path, range, msg):
838
InvalidHttpResponse.__init__(self, path, msg)
841
class InvalidHttpContentType(InvalidHttpResponse):
842
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
844
def __init__(self, path, ctype, msg):
846
InvalidHttpResponse.__init__(self, path, msg)
663
849
class ConflictsInTree(BzrError):
903
class NoBundleFound(BzrNewError):
904
"""No bundle was found in %(filename)s"""
905
def __init__(self, filename):
906
BzrNewError.__init__(self)
907
self.filename = filename
910
class BundleNotSupported(BzrNewError):
911
"""Unable to handle bundle version %(version)s: %(msg)s"""
912
def __init__(self, version, msg):
913
BzrNewError.__init__(self)
914
self.version = version
717
918
class MissingText(BzrNewError):
718
919
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
851
1071
"""A nested progress bar was not 'finished' correctly."""
1074
class InvalidProgressBarType(BzrNewError):
1075
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1076
Select one of: %(valid_types)s"""
1078
def __init__(self, bar_type, valid_types):
1079
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1082
class UnsupportedOperation(BzrNewError):
855
1083
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1084
def __init__(self, method, method_self):
857
1085
self.method = method
858
1086
self.mname = method.__name__
859
1087
self.tname = type(method_self).__name__
1090
class BinaryFile(BzrNewError):
1091
"""File is binary but should be text."""
1094
class IllegalPath(BzrNewError):
1095
"""The path %(path)s is not permitted on this platform"""
1097
def __init__(self, path):
1098
BzrNewError.__init__(self)
1102
class TestamentMismatch(BzrNewError):
1103
"""Testament did not match expected value.
1104
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1107
def __init__(self, revision_id, expected, measured):
1108
self.revision_id = revision_id
1109
self.expected = expected
1110
self.measured = measured
1113
class NotABundle(BzrNewError):
1114
"""Not a bzr revision-bundle: %(text)r"""
1116
def __init__(self, text):
1117
BzrNewError.__init__(self)
1121
class BadBundle(BzrNewError):
1122
"""Bad bzr revision-bundle: %(text)r"""
1124
def __init__(self, text):
1125
BzrNewError.__init__(self)
1129
class MalformedHeader(BadBundle):
1130
"""Malformed bzr revision-bundle header: %(text)r"""
1132
def __init__(self, text):
1133
BzrNewError.__init__(self)
1137
class MalformedPatches(BadBundle):
1138
"""Malformed patches in bzr revision-bundle: %(text)r"""
1140
def __init__(self, text):
1141
BzrNewError.__init__(self)
1145
class MalformedFooter(BadBundle):
1146
"""Malformed footer in bzr revision-bundle: %(text)r"""
1148
def __init__(self, text):
1149
BzrNewError.__init__(self)
1153
class UnsupportedEOLMarker(BadBundle):
1154
"""End of line marker was not \\n in bzr revision-bundle"""
1157
BzrNewError.__init__(self)
1160
class UnknownSSH(BzrNewError):
1161
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1163
def __init__(self, vendor):
1164
BzrNewError.__init__(self)
1165
self.vendor = vendor
1168
class GhostRevisionUnusableHere(BzrNewError):
1169
"""Ghost revision {%(revision_id)s} cannot be used here."""
1171
def __init__(self, revision_id):
1172
BzrNewError.__init__(self)
1173
self.revision_id = revision_id
added
removed
bzrlib/errors.py
