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
138
177
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
178
"""No WorkingTree exists for %(base)s."""
141
180
def __init__(self, base):
142
181
BzrNewError.__init__(self)
146
185
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
186
"""%(url)s is not a local path."""
149
188
def __init__(self, url):
150
189
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
193
class BzrCommandError(BzrNewError):
194
"""Error from user command"""
198
# Error from malformed user command; please avoid raising this as a
199
# generic exception not caused by user input.
159
201
# I think it's a waste of effort to differentiate between errors that
160
202
# are not intended to be caught anyway. UI code need not subclass
161
203
# BzrCommandError, and non-UI code should not throw a subclass of
162
204
# BzrCommandError. ADHB 20051211
205
def __init__(self, msg):
206
# Object.__str__() must return a real string
207
# returning a Unicode string is a python error.
208
if isinstance(msg, unicode):
209
self.msg = msg.encode('utf8')
163
213
def __str__(self):
167
217
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
218
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
221
class StrictCommitFailed(BzrNewError):
222
"""Commit refused because there are unknown files in the tree"""
225
# XXX: Should be unified with TransportError; they seem to represent the
175
227
class PathError(BzrNewError):
176
228
"""Generic path error: %(path)r%(extra)s)"""
204
256
"""Permission denied: %(path)r%(extra)s"""
259
class InvalidURL(PathError):
260
"""Invalid url supplied to transport: %(path)r%(extra)s"""
263
class InvalidURLJoin(PathError):
264
"""Invalid URL join request: %(args)s%(extra)s"""
266
def __init__(self, msg, base, args):
267
PathError.__init__(self, base, msg)
269
self.args.extend(args)
272
class UnsupportedProtocol(PathError):
273
"""Unsupported protocol for url "%(path)s"%(extra)s"""
275
def __init__(self, url, extra):
276
PathError.__init__(self, url, extra=extra)
207
279
class PathNotChild(BzrNewError):
208
280
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
282
is_user_error = False
209
284
def __init__(self, path, base, extra=None):
210
285
BzrNewError.__init__(self)
294
class InvalidNormalization(PathError):
295
"""Path %(path)r is not unicode normalized"""
298
# TODO: This is given a URL; we try to unescape it but doing that from inside
299
# the exception object is a bit undesirable.
300
# TODO: Probably this behavior of should be a common superclass
219
301
class NotBranchError(PathError):
220
302
"""Not a branch: %(path)s"""
304
def __init__(self, path):
305
import bzrlib.urlutils as urlutils
306
self.path = urlutils.unescape_for_display(path, 'ascii')
223
309
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
310
"""Already a branch: %(path)s."""
313
class BranchExistsWithoutWorkingTree(PathError):
314
"""Directory contains a branch, but no working tree \
315
(use bzr checkout if you wish to build a working tree): %(path)s"""
318
class AtomicFileAlreadyClosed(PathError):
319
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
321
def __init__(self, path, function):
322
PathError.__init__(self, path=path, extra=None)
323
self.function = function
326
class InaccessibleParent(PathError):
327
"""Parent not accessible given base %(base)s and relative path %(path)s"""
329
def __init__(self, path, base):
330
PathError.__init__(self, path)
227
334
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
335
"""No repository present: %(path)r"""
229
336
def __init__(self, bzrdir):
230
337
BzrNewError.__init__(self)
231
338
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]
351
class UnsupportedFormatError(BzrNewError):
352
"""Unsupported branch format: %(format)s"""
355
class UnknownFormatError(BzrNewError):
356
"""Unknown branch format: %(format)r"""
256
359
class IncompatibleFormat(BzrNewError):
280
383
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."""
386
class PathsDoNotExist(BzrNewError):
387
"""Path(s) do not exist: %(paths_as_string)s"""
389
# used when reporting that paths are neither versioned nor in the working
392
def __init__(self, paths):
394
from bzrlib.osutils import quotefn
395
BzrNewError.__init__(self)
397
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
400
class BadFileKindError(BzrNewError):
401
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
404
class ForbiddenControlFileError(BzrNewError):
405
"""Cannot operate on %(filename)s because it is a control file"""
293
408
class LockError(BzrNewError):
392
510
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
513
class NoSuchRevision(BzrNewError):
514
"""Branch %(branch)s has no revision %(revision)s"""
516
is_user_error = False
396
518
def __init__(self, branch, revision):
397
519
self.branch = branch
398
520
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
403
523
class HistoryMissing(BzrError):
408
528
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
531
class DivergedBranches(BzrNewError):
532
"These branches have diverged. Use the merge command to reconcile them."""
413
536
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
537
self.branch1 = branch1
416
538
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):
541
class UnrelatedBranches(BzrNewError):
542
"Branches have no common ancestor, and no merge base revision was specified."
547
class NoCommonAncestor(BzrNewError):
548
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
550
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)
551
self.revision_a = revision_a
552
self.revision_b = revision_b
433
555
class NoCommonRoot(BzrError):
626
748
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
751
class TransportError(BzrNewError):
752
"""Transport error: %(msg)s %(orig_error)s"""
633
754
def __init__(self, msg=None, orig_error=None):
634
755
if msg is None and orig_error is not None:
635
756
msg = str(orig_error)
636
BzrError.__init__(self, msg)
757
if orig_error is None:
638
762
self.orig_error = orig_error
763
BzrNewError.__init__(self)
641
766
# A set of semi-meaningful errors which can be thrown
642
767
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.
768
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
771
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)
772
"""Connection error: %(msg)s %(orig_error)s"""
658
775
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
776
"""Connection closed: %(msg)s %(orig_error)s"""
779
class InvalidRange(TransportError):
780
"""Invalid range access."""
782
def __init__(self, path, offset):
783
TransportError.__init__(self, ("Invalid range access in %s at %d"
787
class InvalidHttpResponse(TransportError):
788
"""Invalid http response for %(path)s: %(msg)s"""
790
def __init__(self, path, msg, orig_error=None):
792
TransportError.__init__(self, msg, orig_error=orig_error)
795
class InvalidHttpRange(InvalidHttpResponse):
796
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
798
def __init__(self, path, range, msg):
800
InvalidHttpResponse.__init__(self, path, msg)
803
class InvalidHttpContentType(InvalidHttpResponse):
804
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
806
def __init__(self, path, ctype, msg):
808
InvalidHttpResponse.__init__(self, path, msg)
663
811
class ConflictsInTree(BzrError):
865
class NoBundleFound(BzrNewError):
866
"""No bundle was found in %(filename)s"""
867
def __init__(self, filename):
868
BzrNewError.__init__(self)
869
self.filename = filename
872
class BundleNotSupported(BzrNewError):
873
"""Unable to handle bundle version %(version)s: %(msg)s"""
874
def __init__(self, version, msg):
875
BzrNewError.__init__(self)
876
self.version = version
717
880
class MissingText(BzrNewError):
718
881
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
851
1029
"""A nested progress bar was not 'finished' correctly."""
1032
class InvalidProgressBarType(BzrNewError):
1033
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1034
Select one of: %(valid_types)s"""
1036
def __init__(self, bar_type, valid_types):
1037
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1040
class UnsupportedOperation(BzrNewError):
855
1041
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1042
def __init__(self, method, method_self):
857
1043
self.method = method
858
1044
self.mname = method.__name__
859
1045
self.tname = type(method_self).__name__
1048
class BinaryFile(BzrNewError):
1049
"""File is binary but should be text."""
1052
class IllegalPath(BzrNewError):
1053
"""The path %(path)s is not permitted on this platform"""
1055
def __init__(self, path):
1056
BzrNewError.__init__(self)
1060
class TestamentMismatch(BzrNewError):
1061
"""Testament did not match expected value.
1062
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1065
def __init__(self, revision_id, expected, measured):
1066
self.revision_id = revision_id
1067
self.expected = expected
1068
self.measured = measured
1071
class NotABundle(BzrNewError):
1072
"""Not a bzr revision-bundle: %(text)r"""
1074
def __init__(self, text):
1075
BzrNewError.__init__(self)
1079
class BadBundle(BzrNewError):
1080
"""Bad bzr revision-bundle: %(text)r"""
1082
def __init__(self, text):
1083
BzrNewError.__init__(self)
1087
class MalformedHeader(BadBundle):
1088
"""Malformed bzr revision-bundle header: %(text)r"""
1090
def __init__(self, text):
1091
BzrNewError.__init__(self)
1095
class MalformedPatches(BadBundle):
1096
"""Malformed patches in bzr revision-bundle: %(text)r"""
1098
def __init__(self, text):
1099
BzrNewError.__init__(self)
1103
class MalformedFooter(BadBundle):
1104
"""Malformed footer in bzr revision-bundle: %(text)r"""
1106
def __init__(self, text):
1107
BzrNewError.__init__(self)
1111
class UnsupportedEOLMarker(BadBundle):
1112
"""End of line marker was not \\n in bzr revision-bundle"""
1115
BzrNewError.__init__(self)
1118
class UnknownSSH(BzrNewError):
1119
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1121
def __init__(self, vendor):
1122
BzrNewError.__init__(self)
1123
self.vendor = vendor
1126
class GhostRevisionUnusableHere(BzrNewError):
1127
"""Ghost revision {%(revision_id)s} cannot be used here."""
1129
def __init__(self, revision_id):
1130
BzrNewError.__init__(self)
1131
self.revision_id = revision_id
added
removed
bzrlib/errors.py
