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
130
162
class InvalidRevisionId(BzrNewError):
131
163
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
165
def __init__(self, revision_id, branch):
166
# branch can be any string or object with __str__ defined
133
167
BzrNewError.__init__(self)
134
168
self.revision_id = revision_id
135
169
self.branch = branch
138
172
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
173
"""No WorkingTree exists for %(base)s."""
141
175
def __init__(self, base):
142
176
BzrNewError.__init__(self)
146
180
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
181
"""%(url)s is not a local path."""
149
183
def __init__(self, url):
150
184
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
188
class BzrCommandError(BzrNewError):
189
"""Error from user command"""
193
# Error from malformed user command; please avoid raising this as a
194
# generic exception not caused by user input.
159
196
# I think it's a waste of effort to differentiate between errors that
160
197
# are not intended to be caught anyway. UI code need not subclass
161
198
# BzrCommandError, and non-UI code should not throw a subclass of
162
199
# BzrCommandError. ADHB 20051211
200
def __init__(self, msg):
163
203
def __str__(self):
167
207
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
208
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
211
class StrictCommitFailed(BzrNewError):
212
"""Commit refused because there are unknown files in the tree"""
215
# XXX: Should be unified with TransportError; they seem to represent the
175
217
class PathError(BzrNewError):
176
218
"""Generic path error: %(path)r%(extra)s)"""
204
246
"""Permission denied: %(path)r%(extra)s"""
249
class InvalidURL(PathError):
250
"""Invalid url supplied to transport: %(path)r%(extra)s"""
253
class InvalidURLJoin(PathError):
254
"""Invalid URL join request: %(args)s%(extra)s"""
256
def __init__(self, msg, base, args):
257
PathError.__init__(self, base, msg)
259
self.args.extend(args)
262
class UnsupportedProtocol(PathError):
263
"""Unsupported protocol for url "%(path)s"%(extra)s"""
265
def __init__(self, url, extra):
266
PathError.__init__(self, url, extra=extra)
207
269
class PathNotChild(BzrNewError):
208
270
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
272
is_user_error = False
209
274
def __init__(self, path, base, extra=None):
210
275
BzrNewError.__init__(self)
284
class InvalidNormalization(PathError):
285
"""Path %(path)r is not unicode normalized"""
288
# TODO: This is given a URL; we try to unescape it but doing that from inside
289
# the exception object is a bit undesirable.
290
# TODO: Probably this behavior of should be a common superclass
219
291
class NotBranchError(PathError):
220
292
"""Not a branch: %(path)s"""
294
def __init__(self, path):
295
import bzrlib.urlutils as urlutils
296
self.path = urlutils.unescape_for_display(path, 'ascii')
223
299
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
300
"""Already a branch: %(path)s."""
303
class BranchExistsWithoutWorkingTree(PathError):
304
"""Directory contains a branch, but no working tree \
305
(use bzr checkout if you wish to build a working tree): %(path)s"""
308
class AtomicFileAlreadyClosed(PathError):
309
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
311
def __init__(self, path, function):
312
PathError.__init__(self, path=path, extra=None)
313
self.function = function
316
class InaccessibleParent(PathError):
317
"""Parent not accessible given base %(base)s and relative path %(path)s"""
319
def __init__(self, path, base):
320
PathError.__init__(self, path)
227
324
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
325
"""No repository present: %(path)r"""
229
326
def __init__(self, bzrdir):
230
327
BzrNewError.__init__(self)
231
328
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]
341
class UnsupportedFormatError(BzrNewError):
342
"""Unsupported branch format: %(format)s"""
345
class UnknownFormatError(BzrNewError):
346
"""Unknown branch format: %(format)r"""
256
349
class IncompatibleFormat(BzrNewError):
280
373
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."""
376
class PathsDoNotExist(BzrNewError):
377
"""Path(s) do not exist: %(paths_as_string)s"""
379
# used when reporting that paths are neither versioned nor in the working
382
def __init__(self, paths):
384
from bzrlib.osutils import quotefn
385
BzrNewError.__init__(self)
387
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
390
class BadFileKindError(BzrNewError):
391
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
394
class ForbiddenControlFileError(BzrNewError):
395
"""Cannot operate on %(filename)s because it is a control file"""
293
398
class LockError(BzrNewError):
392
500
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
503
class NoSuchRevision(BzrNewError):
504
"""Branch %(branch)s has no revision %(revision)s"""
506
is_user_error = False
396
508
def __init__(self, branch, revision):
397
509
self.branch = branch
398
510
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
403
513
class HistoryMissing(BzrError):
408
518
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
521
class DivergedBranches(BzrNewError):
522
"These branches have diverged. Use the merge command to reconcile them."""
413
526
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
527
self.branch1 = branch1
416
528
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):
531
class UnrelatedBranches(BzrNewError):
532
"Branches have no common ancestor, and no merge base revision was specified."
537
class NoCommonAncestor(BzrNewError):
538
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
540
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)
541
self.revision_a = revision_a
542
self.revision_b = revision_b
433
545
class NoCommonRoot(BzrError):
626
738
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
741
class TransportError(BzrNewError):
742
"""Transport error: %(msg)s %(orig_error)s"""
633
744
def __init__(self, msg=None, orig_error=None):
634
745
if msg is None and orig_error is not None:
635
746
msg = str(orig_error)
636
BzrError.__init__(self, msg)
747
if orig_error is None:
638
752
self.orig_error = orig_error
753
BzrNewError.__init__(self)
641
756
# A set of semi-meaningful errors which can be thrown
642
757
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.
758
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
761
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)
762
"""Connection error: %(msg)s %(orig_error)s"""
658
765
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
766
"""Connection closed: %(msg)s %(orig_error)s"""
769
class InvalidRange(TransportError):
770
"""Invalid range access."""
772
def __init__(self, path, offset):
773
TransportError.__init__(self, ("Invalid range access in %s at %d"
777
class InvalidHttpResponse(TransportError):
778
"""Invalid http response for %(path)s: %(msg)s"""
780
def __init__(self, path, msg, orig_error=None):
782
TransportError.__init__(self, msg, orig_error=orig_error)
785
class InvalidHttpRange(InvalidHttpResponse):
786
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
788
def __init__(self, path, range, msg):
790
InvalidHttpResponse.__init__(self, path, msg)
793
class InvalidHttpContentType(InvalidHttpResponse):
794
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
796
def __init__(self, path, ctype, msg):
798
InvalidHttpResponse.__init__(self, path, msg)
663
801
class ConflictsInTree(BzrError):
855
class NoBundleFound(BzrNewError):
856
"""No bundle was found in %(filename)s"""
857
def __init__(self, filename):
858
BzrNewError.__init__(self)
859
self.filename = filename
862
class BundleNotSupported(BzrNewError):
863
"""Unable to handle bundle version %(version)s: %(msg)s"""
864
def __init__(self, version, msg):
865
BzrNewError.__init__(self)
866
self.version = version
717
870
class MissingText(BzrNewError):
718
871
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
851
1019
"""A nested progress bar was not 'finished' correctly."""
1022
class InvalidProgressBarType(BzrNewError):
1023
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1024
Select one of: %(valid_types)s"""
1026
def __init__(self, bar_type, valid_types):
1027
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1030
class UnsupportedOperation(BzrNewError):
855
1031
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1032
def __init__(self, method, method_self):
857
1033
self.method = method
858
1034
self.mname = method.__name__
859
1035
self.tname = type(method_self).__name__
1038
class BinaryFile(BzrNewError):
1039
"""File is binary but should be text."""
1042
class IllegalPath(BzrNewError):
1043
"""The path %(path)s is not permitted on this platform"""
1045
def __init__(self, path):
1046
BzrNewError.__init__(self)
1050
class TestamentMismatch(BzrNewError):
1051
"""Testament did not match expected value.
1052
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1055
def __init__(self, revision_id, expected, measured):
1056
self.revision_id = revision_id
1057
self.expected = expected
1058
self.measured = measured
1061
class NotABundle(BzrNewError):
1062
"""Not a bzr revision-bundle: %(text)r"""
1064
def __init__(self, text):
1065
BzrNewError.__init__(self)
1069
class BadBundle(BzrNewError):
1070
"""Bad bzr revision-bundle: %(text)r"""
1072
def __init__(self, text):
1073
BzrNewError.__init__(self)
1077
class MalformedHeader(BadBundle):
1078
"""Malformed bzr revision-bundle header: %(text)r"""
1080
def __init__(self, text):
1081
BzrNewError.__init__(self)
1085
class MalformedPatches(BadBundle):
1086
"""Malformed patches in bzr revision-bundle: %(text)r"""
1088
def __init__(self, text):
1089
BzrNewError.__init__(self)
1093
class MalformedFooter(BadBundle):
1094
"""Malformed footer in bzr revision-bundle: %(text)r"""
1096
def __init__(self, text):
1097
BzrNewError.__init__(self)
1101
class UnsupportedEOLMarker(BadBundle):
1102
"""End of line marker was not \\n in bzr revision-bundle"""
1105
BzrNewError.__init__(self)
1108
class GhostRevisionUnusableHere(BzrNewError):
1109
"""Ghost revision {%(revision_id)s} cannot be used here."""
1111
def __init__(self, revision_id):
1112
BzrNewError.__init__(self)
1113
self.revision_id = revision_id
added
removed
bzrlib/errors.py
