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
68
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
91
# TODO: The pattern (from hct) of using classes docstrings as message
92
# templates is cute but maybe not such a great idea - perhaps should have a
93
# separate static message_template.
72
96
class BzrError(StandardError):
73
100
def __str__(self):
74
101
# XXX: Should we show the exception class in
75
102
# exceptions that don't provide their own message?
130
162
class InvalidRevisionId(BzrNewError):
131
163
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
164
def __init__(self, revision_id, branch):
165
# branch can be any string or object with __str__ defined
133
166
BzrNewError.__init__(self)
134
167
self.revision_id = revision_id
135
168
self.branch = branch
138
171
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %s(base)."""
172
"""No WorkingTree exists for %(base)s."""
141
174
def __init__(self, base):
142
175
BzrNewError.__init__(self)
146
179
class NotLocalUrl(BzrNewError):
147
"""%s(url) is not a local path."""
180
"""%(url)s is not a local path."""
149
182
def __init__(self, url):
150
183
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
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.
159
195
# I think it's a waste of effort to differentiate between errors that
160
196
# are not intended to be caught anyway. UI code need not subclass
161
197
# BzrCommandError, and non-UI code should not throw a subclass of
162
198
# BzrCommandError. ADHB 20051211
199
def __init__(self, msg):
163
202
def __str__(self):
167
206
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
207
"""Error in command line options"""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
210
class StrictCommitFailed(BzrNewError):
211
"""Commit refused because there are unknown files in the tree"""
214
# XXX: Should be unified with TransportError; they seem to represent the
175
216
class PathError(BzrNewError):
176
217
"""Generic path error: %(path)r%(extra)s)"""
204
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)
261
class UnsupportedProtocol(PathError):
262
"""Unsupported protocol for url "%(path)s"%(extra)s"""
264
def __init__(self, url, extra):
265
PathError.__init__(self, url, extra=extra)
207
268
class PathNotChild(BzrNewError):
208
269
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
271
is_user_error = False
209
273
def __init__(self, path, base, extra=None):
210
274
BzrNewError.__init__(self)
283
class InvalidNormalization(PathError):
284
"""Path %(path)r is not unicode normalized"""
287
# TODO: This is given a URL; we try to unescape it but doing that from inside
288
# the exception object is a bit undesirable.
289
# TODO: Probably this behavior of should be a common superclass
219
290
class NotBranchError(PathError):
220
291
"""Not a branch: %(path)s"""
293
def __init__(self, path):
294
import bzrlib.urlutils as urlutils
295
self.path = urlutils.unescape_for_display(path, 'ascii')
223
298
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
299
"""Already a branch: %(path)s."""
302
class BranchExistsWithoutWorkingTree(PathError):
303
"""Directory contains a branch, but no working tree \
304
(use bzr checkout if you wish to build a working tree): %(path)s"""
227
307
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
308
"""No repository present: %(path)r"""
229
309
def __init__(self, bzrdir):
230
310
BzrNewError.__init__(self)
231
311
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]
324
class UnsupportedFormatError(BzrNewError):
325
"""Unsupported branch format: %(format)s"""
328
class UnknownFormatError(BzrNewError):
329
"""Unknown branch format: %(format)r"""
256
332
class IncompatibleFormat(BzrNewError):
280
356
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."""
359
class PathsDoNotExist(BzrNewError):
360
"""Path(s) do not exist: %(paths_as_string)s"""
362
# used when reporting that paths are neither versioned nor in the working
365
def __init__(self, paths):
367
from bzrlib.osutils import quotefn
368
BzrNewError.__init__(self)
370
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
373
class BadFileKindError(BzrNewError):
374
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
377
class ForbiddenControlFileError(BzrNewError):
378
"""Cannot operate on %(filename)s because it is a control file"""
293
381
class LockError(BzrNewError):
392
483
"""Commit refused because there are unknowns in the tree."""
395
class NoSuchRevision(BzrError):
486
class NoSuchRevision(BzrNewError):
487
"""Branch %(branch)s has no revision %(revision)s"""
489
is_user_error = False
396
491
def __init__(self, branch, revision):
397
492
self.branch = branch
398
493
self.revision = revision
399
msg = "Branch %s has no revision %s" % (branch, revision)
400
BzrError.__init__(self, msg)
403
496
class HistoryMissing(BzrError):
408
501
% (branch, object_type, object_id))
411
class DivergedBranches(BzrError):
504
class DivergedBranches(BzrNewError):
505
"These branches have diverged. Use the merge command to reconcile them."""
413
509
def __init__(self, branch1, branch2):
414
BzrError.__init__(self, "These branches have diverged. Try merge.")
415
510
self.branch1 = branch1
416
511
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):
514
class UnrelatedBranches(BzrNewError):
515
"Branches have no common ancestor, and no merge base revision was specified."
520
class NoCommonAncestor(BzrNewError):
521
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
427
523
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)
524
self.revision_a = revision_a
525
self.revision_b = revision_b
433
528
class NoCommonRoot(BzrError):
458
553
def __init__(self, bases):
459
554
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
555
DeprecationWarning)
461
msg = "The correct base is unclear, becase %s are all equally close" %\
556
msg = "The correct base is unclear, because %s are all equally close" %\
463
558
BzrError.__init__(self, msg)
464
559
self.bases = bases
626
721
self.format = format
629
class TransportError(BzrError):
630
"""All errors thrown by Transport implementations should derive
724
class TransportError(BzrNewError):
725
"""Transport error: %(msg)s %(orig_error)s"""
633
727
def __init__(self, msg=None, orig_error=None):
634
728
if msg is None and orig_error is not None:
635
729
msg = str(orig_error)
636
BzrError.__init__(self, msg)
730
if orig_error is None:
638
735
self.orig_error = orig_error
736
BzrNewError.__init__(self)
641
739
# A set of semi-meaningful errors which can be thrown
642
740
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.
741
"""Transport operation not possible: %(msg)s %(orig_error)%"""
649
744
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)
745
"""Connection error: %(msg)s %(orig_error)s"""
658
748
class ConnectionReset(TransportError):
659
"""The connection has been closed."""
749
"""Connection closed: %(msg)s %(orig_error)s"""
752
class InvalidRange(TransportError):
753
"""Invalid range access."""
755
def __init__(self, path, offset):
756
TransportError.__init__(self, ("Invalid range access in %s at %d"
760
class InvalidHttpResponse(TransportError):
761
"""Invalid http response for %(path)s: %(msg)s"""
763
def __init__(self, path, msg, orig_error=None):
765
TransportError.__init__(self, msg, orig_error=orig_error)
768
class InvalidHttpRange(InvalidHttpResponse):
769
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
771
def __init__(self, path, range, msg):
773
InvalidHttpResponse.__init__(self, path, msg)
776
class InvalidHttpContentType(InvalidHttpResponse):
777
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
779
def __init__(self, path, ctype, msg):
781
InvalidHttpResponse.__init__(self, path, msg)
663
784
class ConflictsInTree(BzrError):
838
class NoBundleFound(BzrNewError):
839
"""No bundle was found in %(filename)s"""
840
def __init__(self, filename):
841
BzrNewError.__init__(self)
842
self.filename = filename
845
class BundleNotSupported(BzrNewError):
846
"""Unable to handle bundle version %(version)s: %(msg)s"""
847
def __init__(self, version, msg):
848
BzrNewError.__init__(self)
849
self.version = version
717
853
class MissingText(BzrNewError):
718
854
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
764
900
"""Parameter $(param)s is required but not present."""
903
class BzrBadParameterUnicode(BzrBadParameter):
904
"""Parameter %(param)s is unicode but only byte-strings are permitted."""
907
class BzrBadParameterContainsNewline(BzrBadParameter):
908
"""Parameter %(param)s contains a newline."""
767
911
class DependencyNotPresent(BzrNewError):
768
912
"""Unable to import library "%(library)s": %(error)s"""
851
1002
"""A nested progress bar was not 'finished' correctly."""
1005
class InvalidProgressBarType(BzrNewError):
1006
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1007
Select one of: %(valid_types)s"""
1009
def __init__(self, bar_type, valid_types):
1010
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
854
1013
class UnsupportedOperation(BzrNewError):
855
1014
"""The method %(mname)s is not supported on objects of type %(tname)s."""
856
1015
def __init__(self, method, method_self):
857
1016
self.method = method
858
1017
self.mname = method.__name__
859
1018
self.tname = type(method_self).__name__
1021
class BinaryFile(BzrNewError):
1022
"""File is binary but should be text."""
1025
class IllegalPath(BzrNewError):
1026
"""The path %(path)s is not permitted on this platform"""
1028
def __init__(self, path):
1029
BzrNewError.__init__(self)
1033
class TestamentMismatch(BzrNewError):
1034
"""Testament did not match expected value.
1035
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1038
def __init__(self, revision_id, expected, measured):
1039
self.revision_id = revision_id
1040
self.expected = expected
1041
self.measured = measured
1044
class NotABundle(BzrNewError):
1045
"""Not a bzr revision-bundle: %(text)r"""
1047
def __init__(self, text):
1051
class BadBundle(Exception): pass
1054
class MalformedHeader(BadBundle): pass
1057
class MalformedPatches(BadBundle): pass
1060
class MalformedFooter(BadBundle): pass
added
removed
bzrlib/errors.py
