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
143
179
class NotLocalUrl(BzrNewError):
144
"""%s(url) is not a local path."""
180
"""%(url)s is not a local path."""
146
182
def __init__(self, url):
147
183
BzrNewError.__init__(self)
151
class BzrCommandError(BzrError):
152
# Error from malformed user command
153
# This is being misused as a generic exception
154
# 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.
156
195
# I think it's a waste of effort to differentiate between errors that
157
196
# are not intended to be caught anyway. UI code need not subclass
158
197
# BzrCommandError, and non-UI code should not throw a subclass of
159
198
# BzrCommandError. ADHB 20051211
199
def __init__(self, msg):
160
202
def __str__(self):
164
206
class BzrOptionError(BzrCommandError):
165
"""Some missing or otherwise incorrect option was supplied."""
207
"""Error in command line options"""
168
class StrictCommitFailed(Exception):
169
"""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
172
216
class PathError(BzrNewError):
173
217
"""Generic path error: %(path)r%(extra)s)"""
174
219
def __init__(self, path, extra=None):
175
220
BzrNewError.__init__(self)
188
233
"""File exists: %(path)r%(extra)s"""
236
class DirectoryNotEmpty(PathError):
237
"""Directory not empty: %(path)r%(extra)s"""
240
class ResourceBusy(PathError):
241
"""Device or resource busy: %(path)r%(extra)s"""
191
244
class PermissionDenied(PathError):
192
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)
195
268
class PathNotChild(BzrNewError):
196
269
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
271
is_user_error = False
197
273
def __init__(self, path, base, extra=None):
198
274
BzrNewError.__init__(self)
207
class NotBranchError(BzrNewError):
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
290
class NotBranchError(PathError):
208
291
"""Not a branch: %(path)s"""
209
293
def __init__(self, path):
210
BzrNewError.__init__(self)
294
import bzrlib.urlutils as urlutils
295
self.path = urlutils.unescape_for_display(path, 'ascii')
298
class AlreadyBranchError(PathError):
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"""
307
class AtomicFileAlreadyClosed(PathError):
308
"""'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
310
def __init__(self, path, function):
311
PathError.__init__(self, path=path, extra=None)
312
self.function = function
315
class InaccessibleParent(PathError):
316
"""Parent not accessible given base %(base)s and relative path %(path)s"""
318
def __init__(self, path, base):
319
PathError.__init__(self, path)
214
323
class NoRepositoryPresent(BzrNewError):
215
"""Not repository present: %(path)r"""
324
"""No repository present: %(path)r"""
216
325
def __init__(self, bzrdir):
217
326
BzrNewError.__init__(self)
218
327
self.path = bzrdir.transport.clone('..').base
259
class BadFileKindError(BzrError):
260
"""Specified file is of a kind that cannot be added.
262
(For example a symlink or device file.)"""
265
class ForbiddenFileError(BzrError):
266
"""Cannot operate on a file because it is a control file."""
269
class LockError(Exception):
364
class PathsNotVersionedError(BzrNewError):
365
# used when reporting several paths are not versioned
366
"""Path(s) are not versioned: %(paths_as_string)s"""
368
def __init__(self, paths):
369
from bzrlib.osutils import quotefn
370
BzrNewError.__init__(self)
372
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
375
class PathsDoNotExist(BzrNewError):
376
"""Path(s) do not exist: %(paths_as_string)s"""
378
# used when reporting that paths are neither versioned nor in the working
381
def __init__(self, paths):
383
from bzrlib.osutils import quotefn
384
BzrNewError.__init__(self)
386
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
389
class BadFileKindError(BzrNewError):
390
"""Cannot operate on %(filename)s of unsupported kind %(kind)s"""
393
class ForbiddenControlFileError(BzrNewError):
394
"""Cannot operate on %(filename)s because it is a control file"""
397
class LockError(BzrNewError):
398
"""Lock error: %(message)s"""
271
399
# All exceptions from the lock/unlock functions should be from
272
400
# this exception class. They will be translated as necessary. The
273
401
# original exception is available as e.original_error
403
# New code should prefer to raise specific subclasses
404
def __init__(self, message):
405
self.message = message
276
408
class CommitNotPossible(LockError):
277
409
"""A commit was attempted but we do not have a write lock open."""
280
414
class AlreadyCommitted(LockError):
281
415
"""A rollback was requested, but is not able to be accomplished."""
284
420
class ReadOnlyError(LockError):
285
"""A write attempt was made in a read only transaction."""
421
"""A write attempt was made in a read only transaction on %(obj)s"""
422
def __init__(self, obj):
426
class OutSideTransaction(BzrNewError):
427
"""A transaction related operation was attempted after the transaction finished."""
430
class ObjectNotLocked(LockError):
431
"""%(obj)r is not locked"""
433
is_user_error = False
435
# this can indicate that any particular object is not locked; see also
436
# LockNotHeld which means that a particular *lock* object is not held by
437
# the caller -- perhaps they should be unified.
438
def __init__(self, obj):
442
class ReadOnlyObjectDirtiedError(ReadOnlyError):
443
"""Cannot change object %(obj)r in read only transaction"""
444
def __init__(self, obj):
448
class UnlockableTransport(LockError):
449
"""Cannot lock: transport is read only: %(transport)s"""
450
def __init__(self, transport):
451
self.transport = transport
454
class LockContention(LockError):
455
"""Could not acquire lock %(lock)s"""
456
# TODO: show full url for lock, combining the transport and relative bits?
457
def __init__(self, lock):
461
class LockBroken(LockError):
462
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
463
def __init__(self, lock):
467
class LockBreakMismatch(LockError):
468
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
469
def __init__(self, lock, holder, target):
475
class LockNotHeld(LockError):
476
"""Lock not held: %(lock)s"""
477
def __init__(self, lock):
288
481
class PointlessCommit(BzrNewError):
313
517
% (branch, object_type, object_id))
316
class DivergedBranches(BzrError):
520
class DivergedBranches(BzrNewError):
521
"These branches have diverged. Use the merge command to reconcile them."""
317
525
def __init__(self, branch1, branch2):
318
BzrError.__init__(self, "These branches have diverged. Try merge.")
319
526
self.branch1 = branch1
320
527
self.branch2 = branch2
323
class UnrelatedBranches(BzrCommandError):
325
msg = "Branches have no common ancestor, and no base revision"\
327
BzrCommandError.__init__(self, msg)
329
class NoCommonAncestor(BzrError):
530
class UnrelatedBranches(BzrNewError):
531
"Branches have no common ancestor, and no merge base revision was specified."
536
class NoCommonAncestor(BzrNewError):
537
"Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
330
539
def __init__(self, revision_a, revision_b):
331
msg = "Revisions have no common ancestor: %s %s." \
332
% (revision_a, revision_b)
333
BzrError.__init__(self, msg)
540
self.revision_a = revision_a
541
self.revision_b = revision_b
335
544
class NoCommonRoot(BzrError):
336
545
def __init__(self, revision_a, revision_b):
357
568
class AmbiguousBase(BzrError):
358
569
def __init__(self, bases):
359
msg = "The correct base is unclear, becase %s are all equally close" %\
570
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
572
msg = "The correct base is unclear, because %s are all equally close" %\
361
574
BzrError.__init__(self, msg)
362
575
self.bases = bases
364
578
class NoCommits(BzrError):
365
579
def __init__(self, branch):
366
580
msg = "Branch %s has no commits." % branch
367
581
BzrError.__init__(self, msg)
369
584
class UnlistableStore(BzrError):
370
585
def __init__(self, store):
371
586
BzrError.__init__(self, "Store %s is not listable" % store)
373
590
class UnlistableBranch(BzrError):
374
591
def __init__(self, br):
375
592
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
595
class BoundBranchOutOfDate(BzrNewError):
596
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
597
def __init__(self, branch, master):
598
BzrNewError.__init__(self)
603
class CommitToDoubleBoundBranch(BzrNewError):
604
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
605
def __init__(self, branch, master, remote):
606
BzrNewError.__init__(self)
612
class OverwriteBoundBranch(BzrNewError):
613
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
614
def __init__(self, branch):
615
BzrNewError.__init__(self)
619
class BoundBranchConnectionFailure(BzrNewError):
620
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
621
def __init__(self, branch, target, error):
622
BzrNewError.__init__(self)
378
628
class WeaveError(BzrNewError):
379
629
"""Error in processing weave: %(message)s"""
380
631
def __init__(self, message=None):
381
632
BzrNewError.__init__(self)
382
633
self.message = message
423
677
self.weave_b = weave_b
680
class WeaveTextDiffers(WeaveError):
681
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
683
def __init__(self, revision_id, weave_a, weave_b):
684
WeaveError.__init__(self)
685
self.revision_id = revision_id
686
self.weave_a = weave_a
687
self.weave_b = weave_b
690
class VersionedFileError(BzrNewError):
691
"""Versioned file error."""
694
class RevisionNotPresent(VersionedFileError):
695
"""Revision {%(revision_id)s} not present in %(file_id)s."""
697
def __init__(self, revision_id, file_id):
698
VersionedFileError.__init__(self)
699
self.revision_id = revision_id
700
self.file_id = file_id
703
class RevisionAlreadyPresent(VersionedFileError):
704
"""Revision {%(revision_id)s} already present in %(file_id)s."""
706
def __init__(self, revision_id, file_id):
707
VersionedFileError.__init__(self)
708
self.revision_id = revision_id
709
self.file_id = file_id
712
class KnitError(BzrNewError):
716
class KnitHeaderError(KnitError):
717
"""Knit header error: %(badline)r unexpected"""
719
def __init__(self, badline):
720
KnitError.__init__(self)
721
self.badline = badline
724
class KnitCorrupt(KnitError):
725
"""Knit %(filename)s corrupt: %(how)s"""
727
def __init__(self, filename, how):
728
KnitError.__init__(self)
729
self.filename = filename
426
733
class NoSuchExportFormat(BzrNewError):
427
734
"""Export format %(format)r not supported"""
428
735
def __init__(self, format):
430
737
self.format = format
433
class TransportError(BzrError):
434
"""All errors thrown by Transport implementations should derive
740
class TransportError(BzrNewError):
741
"""Transport error: %(msg)s %(orig_error)s"""
437
743
def __init__(self, msg=None, orig_error=None):
438
744
if msg is None and orig_error is not None:
439
745
msg = str(orig_error)
440
BzrError.__init__(self, msg)
746
if orig_error is None:
442
751
self.orig_error = orig_error
752
BzrNewError.__init__(self)
444
755
# A set of semi-meaningful errors which can be thrown
445
756
class TransportNotPossible(TransportError):
446
"""This is for transports where a specific function is explicitly not
447
possible. Such as pushing files to an HTTP server.
757
"""Transport operation not possible: %(msg)s %(orig_error)%"""
452
760
class ConnectionError(TransportError):
453
"""A connection problem prevents file retrieval.
454
This does not indicate whether the file exists or not; it indicates that a
455
precondition for requesting the file was not met.
457
def __init__(self, msg=None, orig_error=None):
458
TransportError.__init__(self, msg=msg, orig_error=orig_error)
761
"""Connection error: %(msg)s %(orig_error)s"""
461
764
class ConnectionReset(TransportError):
462
"""The connection has been closed."""
765
"""Connection closed: %(msg)s %(orig_error)s"""
768
class InvalidRange(TransportError):
769
"""Invalid range access."""
771
def __init__(self, path, offset):
772
TransportError.__init__(self, ("Invalid range access in %s at %d"
776
class InvalidHttpResponse(TransportError):
777
"""Invalid http response for %(path)s: %(msg)s"""
779
def __init__(self, path, msg, orig_error=None):
781
TransportError.__init__(self, msg, orig_error=orig_error)
784
class InvalidHttpRange(InvalidHttpResponse):
785
"""Invalid http range "%(range)s" for %(path)s: %(msg)s"""
787
def __init__(self, path, range, msg):
789
InvalidHttpResponse.__init__(self, path, msg)
792
class InvalidHttpContentType(InvalidHttpResponse):
793
"""Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
795
def __init__(self, path, ctype, msg):
797
InvalidHttpResponse.__init__(self, path, msg)
465
800
class ConflictsInTree(BzrError):
466
801
def __init__(self):
467
802
BzrError.__init__(self, "Working tree has conflicts.")
469
805
class ParseConfigError(BzrError):
470
806
def __init__(self, errors, filename):
471
807
if filename is None:
474
810
(filename, ('\n'.join(e.message for e in errors)))
475
811
BzrError.__init__(self, message)
477
814
class SigningFailed(BzrError):
478
815
def __init__(self, command_line):
479
816
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
482
820
class WorkingTreeNotRevision(BzrError):
483
821
def __init__(self, tree):
484
822
BzrError.__init__(self, "The working tree for %s has changed since"
485
823
" last commit, but weave merge requires that it be"
486
824
" unchanged." % tree.basedir)
488
827
class CantReprocessAndShowBase(BzrNewError):
489
828
"""Can't reprocess and show base.
490
829
Reprocessing obscures relationship of conflicting lines to base."""
492
832
class GraphCycleError(BzrNewError):
493
833
"""Cycle in graph %(graph)r"""
494
834
def __init__(self, graph):
565
944
def __init__(self, format):
566
945
BzrNewError.__init__(self)
567
946
self.format = format
949
class NoDiff(BzrNewError):
950
"""Diff is not installed on this machine: %(msg)s"""
952
def __init__(self, msg):
953
BzrNewError.__init__(self, msg=msg)
956
class NoDiff3(BzrNewError):
957
"""Diff3 is not installed on this machine."""
960
class ExistingLimbo(BzrNewError):
961
"""This tree contains left-over files from a failed operation.
962
Please examine %(limbo_dir)s to see if it contains any files you wish to
963
keep, and delete it when you are done.
965
def __init__(self, limbo_dir):
966
BzrNewError.__init__(self)
967
self.limbo_dir = limbo_dir
970
class ImmortalLimbo(BzrNewError):
971
"""Unable to delete transform temporary directory $(limbo_dir)s.
972
Please examine %(limbo_dir)s to see if it contains any files you wish to
973
keep, and delete it when you are done.
975
def __init__(self, limbo_dir):
976
BzrNewError.__init__(self)
977
self.limbo_dir = limbo_dir
980
class OutOfDateTree(BzrNewError):
981
"""Working tree is out of date, please run 'bzr update'."""
983
def __init__(self, tree):
984
BzrNewError.__init__(self)
988
class MergeModifiedFormatError(BzrNewError):
989
"""Error in merge modified format"""
992
class ConflictFormatError(BzrNewError):
993
"""Format error in conflict listings"""
996
class CorruptRepository(BzrNewError):
997
"""An error has been detected in the repository %(repo_path)s.
998
Please run bzr reconcile on this repository."""
1000
def __init__(self, repo):
1001
BzrNewError.__init__(self)
1002
self.repo_path = repo.bzrdir.root_transport.base
1005
class UpgradeRequired(BzrNewError):
1006
"""To use this feature you must upgrade your branch at %(path)s."""
1008
def __init__(self, path):
1009
BzrNewError.__init__(self)
1013
class LocalRequiresBoundBranch(BzrNewError):
1014
"""Cannot perform local-only commits on unbound branches."""
1017
class MissingProgressBarFinish(BzrNewError):
1018
"""A nested progress bar was not 'finished' correctly."""
1021
class InvalidProgressBarType(BzrNewError):
1022
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1023
Select one of: %(valid_types)s"""
1025
def __init__(self, bar_type, valid_types):
1026
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1029
class UnsupportedOperation(BzrNewError):
1030
"""The method %(mname)s is not supported on objects of type %(tname)s."""
1031
def __init__(self, method, method_self):
1032
self.method = method
1033
self.mname = method.__name__
1034
self.tname = type(method_self).__name__
1037
class BinaryFile(BzrNewError):
1038
"""File is binary but should be text."""
1041
class IllegalPath(BzrNewError):
1042
"""The path %(path)s is not permitted on this platform"""
1044
def __init__(self, path):
1045
BzrNewError.__init__(self)
1049
class TestamentMismatch(BzrNewError):
1050
"""Testament did not match expected value.
1051
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1054
def __init__(self, revision_id, expected, measured):
1055
self.revision_id = revision_id
1056
self.expected = expected
1057
self.measured = measured
1060
class NotABundle(BzrNewError):
1061
"""Not a bzr revision-bundle: %(text)r"""
1063
def __init__(self, text):
1064
BzrNewError.__init__(self)
1068
class BadBundle(BzrNewError):
1069
"""Bad bzr revision-bundle: %(text)r"""
1071
def __init__(self, text):
1072
BzrNewError.__init__(self)
1076
class MalformedHeader(BadBundle):
1077
"""Malformed bzr revision-bundle header: %(text)r"""
1079
def __init__(self, text):
1080
BzrNewError.__init__(self)
1084
class MalformedPatches(BadBundle):
1085
"""Malformed patches in bzr revision-bundle: %(text)r"""
1087
def __init__(self, text):
1088
BzrNewError.__init__(self)
1092
class MalformedFooter(BadBundle):
1093
"""Malformed footer in bzr revision-bundle: %(text)r"""
1095
def __init__(self, text):
1096
BzrNewError.__init__(self)
1099
class UnsupportedEOLMarker(BadBundle):
1100
"""End of line marker was not \\n in bzr revision-bundle"""
1103
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
