1
# Copyright (C) 2005, 2006 Canonical
1
# Copyright (C) 2005, 2006 Canonical Ltd
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
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 InventoryModified(BzrNewError):
187
"""The current inventory for the tree %(tree)r has been modified, so a clean inventory cannot be read without data loss."""
189
def __init__(self, tree):
190
BzrNewError.__init__(self)
194
class NoSuchId(BzrNewError):
195
"""The file id %(file_id)s is not present in the tree %(tree)s."""
197
def __init__(self, tree, file_id):
198
BzrNewError.__init__(self)
199
self.file_id = file_id
138
203
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
204
"""No WorkingTree exists for %(base)s."""
141
206
def __init__(self, base):
142
207
BzrNewError.__init__(self)
211
class NotBuilding(BzrNewError):
212
"""Not currently building a tree."""
146
215
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
216
"""%(url)s is not a local path."""
149
218
def __init__(self, url):
150
219
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
223
class NotWriteLocked(BzrNewError):
224
"""%(not_locked)r is not write locked but needs to be."""
226
def __init__(self, not_locked):
227
BzrNewError.__init__(self)
228
self.not_locked = not_locked
231
class BzrCommandError(BzrNewError):
232
"""Error from user command"""
236
# Error from malformed user command; please avoid raising this as a
237
# generic exception not caused by user input.
159
239
# I think it's a waste of effort to differentiate between errors that
160
240
# are not intended to be caught anyway. UI code need not subclass
161
241
# BzrCommandError, and non-UI code should not throw a subclass of
162
242
# BzrCommandError. ADHB 20051211
243
def __init__(self, msg):
244
# Object.__str__() must return a real string
245
# returning a Unicode string is a python error.
246
if isinstance(msg, unicode):
247
self.msg = msg.encode('utf8')
163
251
def __str__(self):
167
255
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
256
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
259
class StrictCommitFailed(BzrNewError):
260
"""Commit refused because there are unknown files in the tree"""
263
# XXX: Should be unified with TransportError; they seem to represent the
175
265
class PathError(BzrNewError):
176
266
"""Generic path error: %(path)r%(extra)s)"""
204
304
"""Permission denied: %(path)r%(extra)s"""
307
class InvalidURL(PathError):
308
"""Invalid url supplied to transport: %(path)r%(extra)s"""
311
class InvalidURLJoin(PathError):
312
"""Invalid URL join request: %(args)s%(extra)s"""
314
def __init__(self, msg, base, args):
315
PathError.__init__(self, base, msg)
316
self.args = [base] + list(args)
319
class UnsupportedProtocol(PathError):
320
"""Unsupported protocol for url "%(path)s"%(extra)s"""
322
def __init__(self, url, extra):
323
PathError.__init__(self, url, extra=extra)
326
class ShortReadvError(PathError):
327
"""readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
329
is_user_error = False
331
def __init__(self, path, offset, length, actual, extra=None):
332
PathError.__init__(self, path, extra=extra)
207
338
class PathNotChild(BzrNewError):
208
339
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
341
is_user_error = False
209
343
def __init__(self, path, base, extra=None):
210
344
BzrNewError.__init__(self)
353
class InvalidNormalization(PathError):
354
"""Path %(path)r is not unicode normalized"""
357
# TODO: This is given a URL; we try to unescape it but doing that from inside
358
# the exception object is a bit undesirable.
359
# TODO: Probably this behavior of should be a common superclass
219
360
class NotBranchError(PathError):
220
361
"""Not a branch: %(path)s"""
363
def __init__(self, path):
364
import bzrlib.urlutils as urlutils
365
self.path = urlutils.unescape_for_display(path, 'ascii')
223
368
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
369
"""Already a branch: %(path)s."""
372
class BranchExistsWithoutWorkingTree(PathError):
373
"""Directory contains a branch, but no working tree \
374
(use bzr checkout if you wish to build a working tree): %(path)s"""
377
class AtomicFileAlreadyClosed(PathError):
378
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
380
def __init__(self, path, function):
381
PathError.__init__(self, path=path, extra=None)
382
self.function = function
385
class InaccessibleParent(PathError):
386
"""Parent not accessible given base %(base)s and relative path %(path)s"""
388
def __init__(self, path, base):
389
PathError.__init__(self, path)
227
393
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
394
"""No repository present: %(path)r"""
229
395
def __init__(self, bzrdir):
230
396
BzrNewError.__init__(self)
231
397
self.path = bzrdir.transport.clone('..').base
280
450
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."""
453
class PathsDoNotExist(BzrNewError):
454
"""Path(s) do not exist: %(paths_as_string)s"""
456
# used when reporting that paths are neither versioned nor in the working
459
def __init__(self, paths):
461
from bzrlib.osutils import quotefn
462
BzrNewError.__init__(self)
464
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
467
class BadFileKindError(BzrNewError):
468
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
471
class ForbiddenControlFileError(BzrNewError):
472
"""Cannot operate on %(filename)s because it is a control file"""
293
475
class LockError(BzrNewError):
387
572
self.format = format
391
575
class StrictCommitFailed(Exception):
392
576
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
579
class NoSuchRevision(BzrNewError):
580
"""Branch %(branch)s has no revision %(revision)s"""
582
is_user_error = False
396
584
def __init__(self, branch, revision):
398
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
585
BzrNewError.__init__(self, branch=branch, revision=revision)
588
class NoSuchRevisionSpec(BzrNewError):
589
"""No namespace registered for string: %(spec)r"""
591
def __init__(self, spec):
592
BzrNewError.__init__(self, spec=spec)
595
class InvalidRevisionSpec(BzrNewError):
596
"""Requested revision: '%(spec)s' does not exist in branch:
597
%(branch)s%(extra)s"""
599
def __init__(self, spec, branch, extra=None):
600
BzrNewError.__init__(self, branch=branch, spec=spec)
602
self.extra = '\n' + str(extra)
403
607
class HistoryMissing(BzrError):
408
612
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
615
class DivergedBranches(BzrNewError):
616
"These branches have diverged. Use the merge command to reconcile them."""
413
620
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
621
self.branch1 = branch1
416
622
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):
625
class UnrelatedBranches(BzrNewError):
626
"Branches have no common ancestor, and no merge base revision was specified."
631
class NoCommonAncestor(BzrNewError):
632
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
634
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)
635
self.revision_a = revision_a
636
self.revision_b = revision_b
433
639
class NoCommonRoot(BzrError):
458
664
def __init__(self, bases):
459
665
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
666
DeprecationWarning)
461
msg = "The correct base is unclear, becase %s are all equally close" %\
667
msg = "The correct base is unclear, because %s are all equally close" %\
463
669
BzrError.__init__(self, msg)
464
670
self.bases = bases
467
class NoCommits(BzrError):
673
class NoCommits(BzrNewError):
674
"""Branch %(branch)s has no commits."""
468
676
def __init__(self, branch):
469
msg = "Branch %s has no commits." % branch
470
BzrError.__init__(self, msg)
677
BzrNewError.__init__(self, branch=branch)
473
680
class UnlistableStore(BzrError):
622
829
class NoSuchExportFormat(BzrNewError):
623
830
"""Export format %(format)r not supported"""
624
832
def __init__(self, format):
625
833
BzrNewError.__init__(self)
626
834
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
838
class TooManyConcurrentRequests(BzrNewError):
839
"""The medium '%(medium)s' has reached its concurrent request limit. Be sure to finish_writing and finish_reading on the current request that is open."""
841
def __init__(self, medium):
842
BzrNewError.__init__(self)
846
class TransportError(BzrNewError):
847
"""Transport error: %(msg)s %(orig_error)s"""
633
849
def __init__(self, msg=None, orig_error=None):
634
850
if msg is None and orig_error is not None:
635
851
msg = str(orig_error)
636
BzrError.__init__(self, msg)
852
if orig_error is None:
638
857
self.orig_error = orig_error
858
BzrNewError.__init__(self)
861
class SmartProtocolError(TransportError):
862
"""Generic bzr smart protocol error: %(details)s"""
864
def __init__(self, details):
865
self.details = details
641
868
# A set of semi-meaningful errors which can be thrown
642
869
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.
870
"""Transport operation not possible: %(msg)s %(orig_error)s"""
649
873
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)
874
"""Connection error: %(msg)s %(orig_error)s"""
658
877
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
878
"""Connection closed: %(msg)s %(orig_error)s"""
881
class InvalidRange(TransportError):
882
"""Invalid range access in %(path)s at %(offset)s."""
884
def __init__(self, path, offset):
885
TransportError.__init__(self, ("Invalid range access in %s at %d"
891
class InvalidHttpResponse(TransportError):
892
"""Invalid http response for %(path)s: %(msg)s"""
894
def __init__(self, path, msg, orig_error=None):
896
TransportError.__init__(self, msg, orig_error=orig_error)
899
class InvalidHttpRange(InvalidHttpResponse):
900
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
902
def __init__(self, path, range, msg):
904
InvalidHttpResponse.__init__(self, path, msg)
907
class InvalidHttpContentType(InvalidHttpResponse):
908
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
910
def __init__(self, path, ctype, msg):
912
InvalidHttpResponse.__init__(self, path, msg)
663
915
class ConflictsInTree(BzrError):
851
1194
"""A nested progress bar was not 'finished' correctly."""
1197
class InvalidProgressBarType(BzrNewError):
1198
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1199
Select one of: %(valid_types)s"""
1201
def __init__(self, bar_type, valid_types):
1202
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1205
class UnsupportedOperation(BzrNewError):
855
1206
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1207
def __init__(self, method, method_self):
857
1208
self.method = method
858
1209
self.mname = method.__name__
859
1210
self.tname = type(method_self).__name__
1213
class BinaryFile(BzrNewError):
1214
"""File is binary but should be text."""
1217
class IllegalPath(BzrNewError):
1218
"""The path %(path)s is not permitted on this platform"""
1220
def __init__(self, path):
1221
BzrNewError.__init__(self)
1225
class TestamentMismatch(BzrNewError):
1226
"""Testament did not match expected value.
1227
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1230
def __init__(self, revision_id, expected, measured):
1231
self.revision_id = revision_id
1232
self.expected = expected
1233
self.measured = measured
1236
class NotABundle(BzrNewError):
1237
"""Not a bzr revision-bundle: %(text)r"""
1239
def __init__(self, text):
1240
BzrNewError.__init__(self)
1244
class BadBundle(BzrNewError):
1245
"""Bad bzr revision-bundle: %(text)r"""
1247
def __init__(self, text):
1248
BzrNewError.__init__(self)
1252
class MalformedHeader(BadBundle):
1253
"""Malformed bzr revision-bundle header: %(text)r"""
1255
def __init__(self, text):
1256
BzrNewError.__init__(self)
1260
class MalformedPatches(BadBundle):
1261
"""Malformed patches in bzr revision-bundle: %(text)r"""
1263
def __init__(self, text):
1264
BzrNewError.__init__(self)
1268
class MalformedFooter(BadBundle):
1269
"""Malformed footer in bzr revision-bundle: %(text)r"""
1271
def __init__(self, text):
1272
BzrNewError.__init__(self)
1276
class UnsupportedEOLMarker(BadBundle):
1277
"""End of line marker was not \\n in bzr revision-bundle"""
1280
BzrNewError.__init__(self)
1283
class IncompatibleFormat(BzrNewError):
1284
"""Bundle format %(bundle_format)s is incompatible with %(other)s"""
1286
def __init__(self, bundle_format, other):
1287
BzrNewError.__init__(self)
1288
self.bundle_format = bundle_format
1292
class BadInventoryFormat(BzrNewError):
1293
"""Root class for inventory serialization errors"""
1296
class UnexpectedInventoryFormat(BadInventoryFormat):
1297
"""The inventory was not in the expected format:\n %(msg)s"""
1299
def __init__(self, msg):
1300
BadInventoryFormat.__init__(self, msg=msg)
1303
class NoSmartMedium(BzrNewError):
1304
"""The transport '%(transport)s' cannot tunnel the smart protocol."""
1306
def __init__(self, transport):
1307
BzrNewError.__init__(self)
1308
self.transport = transport
1311
class NoSmartServer(NotBranchError):
1312
"""No smart server available at %(url)s"""
1314
def __init__(self, url):
1318
class UnknownSSH(BzrNewError):
1319
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1321
def __init__(self, vendor):
1322
BzrNewError.__init__(self)
1323
self.vendor = vendor
1326
class GhostRevisionUnusableHere(BzrNewError):
1327
"""Ghost revision {%(revision_id)s} cannot be used here."""
1329
def __init__(self, revision_id):
1330
BzrNewError.__init__(self)
1331
self.revision_id = revision_id
1334
class IllegalUseOfScopeReplacer(BzrNewError):
1335
"""ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
1337
is_user_error = False
1339
def __init__(self, name, msg, extra=None):
1340
BzrNewError.__init__(self)
1344
self.extra = ': ' + str(extra)
1349
class InvalidImportLine(BzrNewError):
1350
"""Not a valid import statement: %(msg)\n%(text)s"""
1352
is_user_error = False
1354
def __init__(self, text, msg):
1355
BzrNewError.__init__(self)
1360
class ImportNameCollision(BzrNewError):
1361
"""Tried to import an object to the same name as an existing object. %(name)s"""
1363
is_user_error = False
1365
def __init__(self, name):
1366
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
