1
# Copyright (C) 2005, 2006 Canonical
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Exceptions for bzr, and reporting of them.
19
Exceptions are caught at a high level to report errors to the user, and
20
might also be caught inside the program. Therefore it needs to be
21
possible to convert them to a meaningful string, and also for them to be
22
interrogated by the program.
24
Exceptions are defined such that the arguments given to the constructor
25
are stored in the object as properties of the same name. When the
26
object is printed as a string, the doc string of the class is used as
27
a format string with the property dictionary available to it.
29
This means that exceptions can used like this:
33
... raise NotBranchError(path='/foo/bar')
35
... print sys.exc_type
36
... print sys.exc_value
37
... path = getattr(sys.exc_value, 'path')
38
... if path is not None:
40
bzrlib.errors.NotBranchError
41
Not a branch: /foo/bar
46
* 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
56
# based on Scott James Remnant's hct error classes
58
# TODO: is there any value in providing the .args field used by standard
59
# python exceptions? A list of values with no names seems less useful
62
# TODO: Perhaps convert the exception to a string at the moment it's
63
# constructed to make sure it will succeed. But that says nothing about
64
# exceptions that are never raised.
66
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
70
class BzrError(StandardError):
72
# XXX: Should we show the exception class in
73
# exceptions that don't provide their own message?
74
# maybe it should be done at a higher level
75
## n = self.__class__.__name__ + ': '
77
if len(self.args) == 1:
78
return str(self.args[0])
79
elif len(self.args) == 2:
80
# further explanation or suggestions
82
return n + '\n '.join([self.args[0]] + self.args[1])
84
return n + "%r" % self
86
return n + `self.args`
89
class BzrNewError(BzrError):
91
# base classes should override the docstring with their human-
92
# readable explanation
94
def __init__(self, **kwds):
95
for key, value in kwds.items():
96
setattr(self, key, value)
100
return self.__doc__ % self.__dict__
101
except (NameError, ValueError, KeyError), e:
102
return 'Unprintable exception %s: %s' \
103
% (self.__class__.__name__, str(e))
106
class BzrCheckError(BzrNewError):
107
"""Internal check failed: %(message)s"""
109
def __init__(self, message):
110
BzrNewError.__init__(self)
111
self.message = message
114
class InvalidEntryName(BzrNewError):
115
"""Invalid entry name: %(name)s"""
116
def __init__(self, name):
117
BzrNewError.__init__(self)
121
class InvalidRevisionNumber(BzrNewError):
122
"""Invalid revision number %(revno)d"""
123
def __init__(self, revno):
124
BzrNewError.__init__(self)
128
class InvalidRevisionId(BzrNewError):
129
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
130
def __init__(self, revision_id, branch):
131
BzrNewError.__init__(self)
132
self.revision_id = revision_id
136
class NoWorkingTree(BzrNewError):
137
"""No WorkingTree exists for %s(base)."""
139
def __init__(self, base):
140
BzrNewError.__init__(self)
144
class NotLocalUrl(BzrNewError):
145
"""%s(url) is not a local path."""
147
def __init__(self, url):
148
BzrNewError.__init__(self)
152
class BzrCommandError(BzrError):
153
# Error from malformed user command
154
# This is being misused as a generic exception
155
# pleae subclass. RBC 20051030
157
# I think it's a waste of effort to differentiate between errors that
158
# are not intended to be caught anyway. UI code need not subclass
159
# BzrCommandError, and non-UI code should not throw a subclass of
160
# BzrCommandError. ADHB 20051211
165
class BzrOptionError(BzrCommandError):
166
"""Some missing or otherwise incorrect option was supplied."""
169
class StrictCommitFailed(Exception):
170
"""Commit refused because there are unknowns in the tree."""
173
class PathError(BzrNewError):
174
"""Generic path error: %(path)r%(extra)s)"""
175
def __init__(self, path, extra=None):
176
BzrNewError.__init__(self)
179
self.extra = ': ' + str(extra)
184
class NoSuchFile(PathError):
185
"""No such file: %(path)r%(extra)s"""
188
class FileExists(PathError):
189
"""File exists: %(path)r%(extra)s"""
192
class DirectoryNotEmpty(PathError):
193
"""Directory not empty: %(path)r%(extra)s"""
196
class PermissionDenied(PathError):
197
"""Permission denied: %(path)r%(extra)s"""
200
class PathNotChild(BzrNewError):
201
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
202
def __init__(self, path, base, extra=None):
203
BzrNewError.__init__(self)
207
self.extra = ': ' + str(extra)
212
class NotBranchError(BzrNewError):
213
"""Not a branch: %(path)s"""
214
def __init__(self, path):
215
BzrNewError.__init__(self)
219
class NoRepositoryPresent(BzrNewError):
220
"""Not repository present: %(path)r"""
221
def __init__(self, bzrdir):
222
BzrNewError.__init__(self)
223
self.path = bzrdir.transport.clone('..').base
226
class FileInWrongBranch(BzrNewError):
227
"""File %(path)s in not in branch %(branch_base)s."""
229
def __init__(self, branch, path):
230
BzrNewError.__init__(self)
232
self.branch_base = branch.base
236
class UnsupportedFormatError(BzrError):
237
"""Specified path is a bzr branch that we recognize but cannot read."""
239
return 'unsupported branch format: %s' % self.args[0]
242
class UnknownFormatError(BzrError):
243
"""Specified path is a bzr branch whose format we do not recognize."""
245
return 'unknown branch format: %s' % self.args[0]
248
class IncompatibleFormat(BzrNewError):
249
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
251
def __init__(self, format, bzrdir_format):
252
BzrNewError.__init__(self)
254
self.bzrdir = bzrdir_format
257
class UnknownSplatFormat(BzrNewError):
258
"""The splat format %(format)s is unknown"""
259
def __init__(self, format):
262
class MalformedSplatDict(BzrNewError):
263
"""Splat dict has %(val_len)d values, instead of 2. (%(values)r)"""
264
def __init__(self, values):
266
self.val_len = len(values)
268
class NotVersionedError(BzrNewError):
269
"""%(path)s is not versioned"""
270
def __init__(self, path):
271
BzrNewError.__init__(self)
275
class BadFileKindError(BzrError):
276
"""Specified file is of a kind that cannot be added.
278
(For example a symlink or device file.)"""
281
class ForbiddenFileError(BzrError):
282
"""Cannot operate on a file because it is a control file."""
285
class LockError(BzrNewError):
286
"""Lock error: %(message)s"""
287
# All exceptions from the lock/unlock functions should be from
288
# this exception class. They will be translated as necessary. The
289
# original exception is available as e.original_error
291
# New code should prefer to raise specific subclasses
292
def __init__(self, message):
293
self.message = message
296
class CommitNotPossible(LockError):
297
"""A commit was attempted but we do not have a write lock open."""
302
class AlreadyCommitted(LockError):
303
"""A rollback was requested, but is not able to be accomplished."""
308
class ReadOnlyError(LockError):
309
"""A write attempt was made in a read only transaction on %(obj)s"""
310
def __init__(self, obj):
314
class BranchNotLocked(LockError):
315
"""Branch %(branch)r is not locked"""
316
def __init__(self, branch):
317
# XXX: sometimes called with a LockableFiles instance not a Branch
321
class ReadOnlyObjectDirtiedError(ReadOnlyError):
322
"""Cannot change object %(obj)r in read only transaction"""
323
def __init__(self, obj):
327
class UnlockableTransport(LockError):
328
"""Cannot lock: transport is read only: %(transport)s"""
329
def __init__(self, transport):
330
self.transport = transport
333
class LockContention(LockError):
334
"""Could not acquire lock %(lock)s"""
335
# TODO: show full url for lock, combining the transport and relative bits?
336
def __init__(self, lock):
340
class LockBroken(LockError):
341
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
342
def __init__(self, lock):
346
class LockBreakMismatch(LockError):
347
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
348
def __init__(self, lock, holder, target):
354
class LockNotHeld(LockError):
355
"""Lock not held: %(lock)s"""
356
def __init__(self, lock):
360
class BranchNotLocked(LockError):
361
"""Branch %(branch)r not locked"""
362
def __init__(self, branch):
366
class PointlessCommit(BzrNewError):
367
"""No changes to commit"""
370
class UpgradeReadonly(BzrNewError):
371
"""Upgrade URL cannot work with readonly URL's."""
374
class UpToDateFormat(BzrNewError):
375
"""The branch format %(format)s is already at the most recent format."""
377
def __init__(self, format):
378
BzrNewError.__init__(self)
382
class StrictCommitFailed(Exception):
383
"""Commit refused because there are unknowns in the tree."""
385
class NoSuchRevision(BzrError):
386
def __init__(self, branch, revision):
388
self.revision = revision
389
msg = "Branch %s has no revision %s" % (branch, revision)
390
BzrError.__init__(self, msg)
393
class HistoryMissing(BzrError):
394
def __init__(self, branch, object_type, object_id):
396
BzrError.__init__(self,
397
'%s is missing %s {%s}'
398
% (branch, object_type, object_id))
401
class DivergedBranches(BzrError):
402
def __init__(self, branch1, branch2):
403
BzrError.__init__(self, "These branches have diverged. Try merge.")
404
self.branch1 = branch1
405
self.branch2 = branch2
408
class UnrelatedBranches(BzrCommandError):
410
msg = "Branches have no common ancestor, and no base revision"\
412
BzrCommandError.__init__(self, msg)
415
class NoCommonAncestor(BzrError):
416
def __init__(self, revision_a, revision_b):
417
msg = "Revisions have no common ancestor: %s %s." \
418
% (revision_a, revision_b)
419
BzrError.__init__(self, msg)
422
class NoCommonRoot(BzrError):
423
def __init__(self, revision_a, revision_b):
424
msg = "Revisions are not derived from the same root: %s %s." \
425
% (revision_a, revision_b)
426
BzrError.__init__(self, msg)
429
class NotAncestor(BzrError):
430
def __init__(self, rev_id, not_ancestor_id):
431
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
433
BzrError.__init__(self, msg)
435
self.not_ancestor_id = not_ancestor_id
438
class InstallFailed(BzrError):
439
def __init__(self, revisions):
440
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
441
BzrError.__init__(self, msg)
442
self.revisions = revisions
445
class AmbiguousBase(BzrError):
446
def __init__(self, bases):
447
msg = "The correct base is unclear, becase %s are all equally close" %\
449
BzrError.__init__(self, msg)
453
class NoCommits(BzrError):
454
def __init__(self, branch):
455
msg = "Branch %s has no commits." % branch
456
BzrError.__init__(self, msg)
459
class UnlistableStore(BzrError):
460
def __init__(self, store):
461
BzrError.__init__(self, "Store %s is not listable" % store)
464
class UnlistableBranch(BzrError):
465
def __init__(self, br):
466
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
469
class WeaveError(BzrNewError):
470
"""Error in processing weave: %(message)s"""
471
def __init__(self, message=None):
472
BzrNewError.__init__(self)
473
self.message = message
476
class WeaveRevisionAlreadyPresent(WeaveError):
477
"""Revision {%(revision_id)s} already present in %(weave)s"""
478
def __init__(self, revision_id, weave):
479
WeaveError.__init__(self)
480
self.revision_id = revision_id
484
class WeaveRevisionNotPresent(WeaveError):
485
"""Revision {%(revision_id)s} not present in %(weave)s"""
486
def __init__(self, revision_id, weave):
487
WeaveError.__init__(self)
488
self.revision_id = revision_id
492
class WeaveFormatError(WeaveError):
493
"""Weave invariant violated: %(what)s"""
494
def __init__(self, what):
495
WeaveError.__init__(self)
499
class WeaveParentMismatch(WeaveError):
500
"""Parents are mismatched between two revisions."""
503
class WeaveInvalidChecksum(WeaveError):
504
"""Text did not match it's checksum: %(message)s"""
507
class WeaveTextDiffers(WeaveError):
508
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
510
def __init__(self, revision_id, weave_a, weave_b):
511
WeaveError.__init__(self)
512
self.revision_id = revision_id
513
self.weave_a = weave_a
514
self.weave_b = weave_b
517
class WeaveTextDiffers(WeaveError):
518
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
520
def __init__(self, revision_id, weave_a, weave_b):
521
WeaveError.__init__(self)
522
self.revision_id = revision_id
523
self.weave_a = weave_a
524
self.weave_b = weave_b
527
class NoSuchExportFormat(BzrNewError):
528
"""Export format %(format)r not supported"""
529
def __init__(self, format):
530
BzrNewError.__init__(self)
534
class TransportError(BzrError):
535
"""All errors thrown by Transport implementations should derive
538
def __init__(self, msg=None, orig_error=None):
539
if msg is None and orig_error is not None:
540
msg = str(orig_error)
541
BzrError.__init__(self, msg)
543
self.orig_error = orig_error
546
# A set of semi-meaningful errors which can be thrown
547
class TransportNotPossible(TransportError):
548
"""This is for transports where a specific function is explicitly not
549
possible. Such as pushing files to an HTTP server.
554
class ConnectionError(TransportError):
555
"""A connection problem prevents file retrieval.
556
This does not indicate whether the file exists or not; it indicates that a
557
precondition for requesting the file was not met.
559
def __init__(self, msg=None, orig_error=None):
560
TransportError.__init__(self, msg=msg, orig_error=orig_error)
563
class ConnectionReset(TransportError):
564
"""The connection has been closed."""
568
class ConflictsInTree(BzrError):
570
BzrError.__init__(self, "Working tree has conflicts.")
573
class ParseConfigError(BzrError):
574
def __init__(self, errors, filename):
577
message = "Error(s) parsing config file %s:\n%s" % \
578
(filename, ('\n'.join(e.message for e in errors)))
579
BzrError.__init__(self, message)
582
class SigningFailed(BzrError):
583
def __init__(self, command_line):
584
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
588
class WorkingTreeNotRevision(BzrError):
589
def __init__(self, tree):
590
BzrError.__init__(self, "The working tree for %s has changed since"
591
" last commit, but weave merge requires that it be"
592
" unchanged." % tree.basedir)
595
class CantReprocessAndShowBase(BzrNewError):
596
"""Can't reprocess and show base.
597
Reprocessing obscures relationship of conflicting lines to base."""
600
class GraphCycleError(BzrNewError):
601
"""Cycle in graph %(graph)r"""
602
def __init__(self, graph):
603
BzrNewError.__init__(self)
607
class NotConflicted(BzrNewError):
608
"""File %(filename)s is not conflicted."""
610
def __init__(self, filename):
611
BzrNewError.__init__(self)
612
self.filename = filename
615
class MustUseDecorated(Exception):
616
"""A decorating function has requested its original command be used.
618
This should never escape bzr, so does not need to be printable.
622
class MissingText(BzrNewError):
623
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
625
def __init__(self, branch, text_revision, file_id):
626
BzrNewError.__init__(self)
628
self.base = branch.base
629
self.text_revision = text_revision
630
self.file_id = file_id
632
class DuplicateKey(BzrNewError):
633
"""Key %(key)s is already present in map"""
635
class MalformedTransform(BzrNewError):
636
"""Tree transform is malformed %(conflicts)r"""
639
class BzrBadParameter(BzrNewError):
640
"""A bad parameter : %(param)s is not usable.
642
This exception should never be thrown, but it is a base class for all
643
parameter-to-function errors.
645
def __init__(self, param):
646
BzrNewError.__init__(self)
650
class BzrBadParameterNotUnicode(BzrBadParameter):
651
"""Parameter %(param)s is neither unicode nor utf8."""
654
class ReusingTransform(BzrNewError):
655
"""Attempt to reuse a transform that has already been applied."""
658
class CantMoveRoot(BzrNewError):
659
"""Moving the root directory is not supported at this time"""
662
class BzrBadParameterNotString(BzrBadParameter):
663
"""Parameter %(param)s is not a string or unicode string."""
666
class BzrBadParameterMissing(BzrBadParameter):
667
"""Parameter $(param)s is required but not present."""
670
class DependencyNotPresent(BzrNewError):
671
"""Unable to import library: %(library)s, %(error)s"""
673
def __init__(self, library, error):
674
BzrNewError.__init__(self, library=library, error=error)
677
class ParamikoNotPresent(DependencyNotPresent):
678
"""Unable to import paramiko (required for sftp support): %(error)s"""
680
def __init__(self, error):
681
DependencyNotPresent.__init__(self, 'paramiko', error)
684
class UninitializableFormat(BzrNewError):
685
"""Format %(format)s cannot be initialised by this version of bzr."""
687
def __init__(self, format):
688
BzrNewError.__init__(self)
692
class NoDiff3(BzrNewError):
693
"""Diff3 is not installed on this machine."""
696
class ExistingLimbo(BzrNewError):
697
"""This tree contains left-over files from a failed operation.
698
Please examine %(limbo_dir)s to see if it contains any files you wish to
699
keep, and delete it when you are done.
701
def __init__(self, limbo_dir):
702
BzrNewError.__init__(self)
703
self.limbo_dir = limbo_dir
706
class ImmortalLimbo(BzrNewError):
707
"""Unable to delete transform temporary directory $(limbo_dir)s.
708
Please examine %(limbo_dir)s to see if it contains any files you wish to
709
keep, and delete it when you are done.
711
def __init__(self, limbo_dir):
712
BzrNewError.__init__(self)
713
self.limbo_dir = limbo_dir
716
class OutOfDateTree(BzrNewError):
717
"""Working tree is out of date, please run 'bzr update'."""
719
def __init__(self, tree):
720
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
