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 ResourceBusy(PathError):
197
"""Device or resource busy: %(path)r%(extra)s"""
200
class PermissionDenied(PathError):
201
"""Permission denied: %(path)r%(extra)s"""
204
class PathNotChild(BzrNewError):
205
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
206
def __init__(self, path, base, extra=None):
207
BzrNewError.__init__(self)
211
self.extra = ': ' + str(extra)
216
class NotBranchError(BzrNewError):
217
"""Not a branch: %(path)s"""
218
def __init__(self, path):
219
BzrNewError.__init__(self)
223
class NoRepositoryPresent(BzrNewError):
224
"""Not repository present: %(path)r"""
225
def __init__(self, bzrdir):
226
BzrNewError.__init__(self)
227
self.path = bzrdir.transport.clone('..').base
230
class FileInWrongBranch(BzrNewError):
231
"""File %(path)s in not in branch %(branch_base)s."""
233
def __init__(self, branch, path):
234
BzrNewError.__init__(self)
236
self.branch_base = branch.base
240
class UnsupportedFormatError(BzrError):
241
"""Specified path is a bzr branch that we recognize but cannot read."""
243
return 'unsupported branch format: %s' % self.args[0]
246
class UnknownFormatError(BzrError):
247
"""Specified path is a bzr branch whose format we do not recognize."""
249
return 'unknown branch format: %s' % self.args[0]
252
class IncompatibleFormat(BzrNewError):
253
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
255
def __init__(self, format, bzrdir_format):
256
BzrNewError.__init__(self)
258
self.bzrdir = bzrdir_format
261
class NotVersionedError(BzrNewError):
262
"""%(path)s is not versioned"""
263
def __init__(self, path):
264
BzrNewError.__init__(self)
268
class PathsNotVersionedError(BzrNewError):
269
# used when reporting several paths are not versioned
270
"""Path(s) are not versioned: %(paths_as_string)s"""
272
def __init__(self, paths):
273
from bzrlib.osutils import quotefn
274
BzrNewError.__init__(self)
276
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
279
class BadFileKindError(BzrError):
280
"""Specified file is of a kind that cannot be added.
282
(For example a symlink or device file.)"""
285
class ForbiddenFileError(BzrError):
286
"""Cannot operate on a file because it is a control file."""
289
class LockError(BzrNewError):
290
"""Lock error: %(message)s"""
291
# All exceptions from the lock/unlock functions should be from
292
# this exception class. They will be translated as necessary. The
293
# original exception is available as e.original_error
295
# New code should prefer to raise specific subclasses
296
def __init__(self, message):
297
self.message = message
300
class CommitNotPossible(LockError):
301
"""A commit was attempted but we do not have a write lock open."""
306
class AlreadyCommitted(LockError):
307
"""A rollback was requested, but is not able to be accomplished."""
312
class ReadOnlyError(LockError):
313
"""A write attempt was made in a read only transaction on %(obj)s"""
314
def __init__(self, obj):
318
class OutSideTransaction(BzrNewError):
319
"""A transaction related operation was attempted after the transaction finished."""
322
class ObjectNotLocked(LockError):
323
"""%(obj)r is not locked"""
324
# this can indicate that any particular object is not locked; see also
325
# LockNotHeld which means that a particular *lock* object is not held by
326
# the caller -- perhaps they should be unified.
327
def __init__(self, obj):
331
class ReadOnlyObjectDirtiedError(ReadOnlyError):
332
"""Cannot change object %(obj)r in read only transaction"""
333
def __init__(self, obj):
337
class UnlockableTransport(LockError):
338
"""Cannot lock: transport is read only: %(transport)s"""
339
def __init__(self, transport):
340
self.transport = transport
343
class LockContention(LockError):
344
"""Could not acquire lock %(lock)s"""
345
# TODO: show full url for lock, combining the transport and relative bits?
346
def __init__(self, lock):
350
class LockBroken(LockError):
351
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
352
def __init__(self, lock):
356
class LockBreakMismatch(LockError):
357
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
358
def __init__(self, lock, holder, target):
364
class LockNotHeld(LockError):
365
"""Lock not held: %(lock)s"""
366
def __init__(self, lock):
370
class PointlessCommit(BzrNewError):
371
"""No changes to commit"""
374
class UpgradeReadonly(BzrNewError):
375
"""Upgrade URL cannot work with readonly URL's."""
378
class UpToDateFormat(BzrNewError):
379
"""The branch format %(format)s is already at the most recent format."""
381
def __init__(self, format):
382
BzrNewError.__init__(self)
387
class StrictCommitFailed(Exception):
388
"""Commit refused because there are unknowns in the tree."""
391
class NoSuchRevision(BzrError):
392
def __init__(self, branch, revision):
394
self.revision = revision
395
msg = "Branch %s has no revision %s" % (branch, revision)
396
BzrError.__init__(self, msg)
399
class HistoryMissing(BzrError):
400
def __init__(self, branch, object_type, object_id):
402
BzrError.__init__(self,
403
'%s is missing %s {%s}'
404
% (branch, object_type, object_id))
407
class DivergedBranches(BzrError):
409
def __init__(self, branch1, branch2):
410
BzrError.__init__(self, "These branches have diverged. Try merge.")
411
self.branch1 = branch1
412
self.branch2 = branch2
415
class UnrelatedBranches(BzrCommandError):
417
msg = "Branches have no common ancestor, and no base revision"\
419
BzrCommandError.__init__(self, msg)
422
class NoCommonAncestor(BzrError):
423
def __init__(self, revision_a, revision_b):
424
msg = "Revisions have no common ancestor: %s %s." \
425
% (revision_a, revision_b)
426
BzrError.__init__(self, msg)
429
class NoCommonRoot(BzrError):
430
def __init__(self, revision_a, revision_b):
431
msg = "Revisions are not derived from the same root: %s %s." \
432
% (revision_a, revision_b)
433
BzrError.__init__(self, msg)
437
class NotAncestor(BzrError):
438
def __init__(self, rev_id, not_ancestor_id):
439
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
441
BzrError.__init__(self, msg)
443
self.not_ancestor_id = not_ancestor_id
446
class InstallFailed(BzrError):
447
def __init__(self, revisions):
448
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
449
BzrError.__init__(self, msg)
450
self.revisions = revisions
453
class AmbiguousBase(BzrError):
454
def __init__(self, bases):
455
msg = "The correct base is unclear, becase %s are all equally close" %\
457
BzrError.__init__(self, msg)
461
class NoCommits(BzrError):
462
def __init__(self, branch):
463
msg = "Branch %s has no commits." % branch
464
BzrError.__init__(self, msg)
467
class UnlistableStore(BzrError):
468
def __init__(self, store):
469
BzrError.__init__(self, "Store %s is not listable" % store)
473
class UnlistableBranch(BzrError):
474
def __init__(self, br):
475
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
478
class BoundBranchOutOfDate(BzrNewError):
479
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
480
def __init__(self, branch, master):
481
BzrNewError.__init__(self)
486
class CommitToDoubleBoundBranch(BzrNewError):
487
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
488
def __init__(self, branch, master, remote):
489
BzrNewError.__init__(self)
495
class OverwriteBoundBranch(BzrNewError):
496
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
497
def __init__(self, branch):
498
BzrNewError.__init__(self)
502
class BoundBranchConnectionFailure(BzrNewError):
503
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
504
def __init__(self, branch, target, error):
505
BzrNewError.__init__(self)
511
class WeaveError(BzrNewError):
512
"""Error in processing weave: %(message)s"""
514
def __init__(self, message=None):
515
BzrNewError.__init__(self)
516
self.message = message
519
class WeaveRevisionAlreadyPresent(WeaveError):
520
"""Revision {%(revision_id)s} already present in %(weave)s"""
521
def __init__(self, revision_id, weave):
523
WeaveError.__init__(self)
524
self.revision_id = revision_id
528
class WeaveRevisionNotPresent(WeaveError):
529
"""Revision {%(revision_id)s} not present in %(weave)s"""
531
def __init__(self, revision_id, weave):
532
WeaveError.__init__(self)
533
self.revision_id = revision_id
537
class WeaveFormatError(WeaveError):
538
"""Weave invariant violated: %(what)s"""
540
def __init__(self, what):
541
WeaveError.__init__(self)
545
class WeaveParentMismatch(WeaveError):
546
"""Parents are mismatched between two revisions."""
549
class WeaveInvalidChecksum(WeaveError):
550
"""Text did not match it's checksum: %(message)s"""
553
class WeaveTextDiffers(WeaveError):
554
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
556
def __init__(self, revision_id, weave_a, weave_b):
557
WeaveError.__init__(self)
558
self.revision_id = revision_id
559
self.weave_a = weave_a
560
self.weave_b = weave_b
563
class WeaveTextDiffers(WeaveError):
564
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
566
def __init__(self, revision_id, weave_a, weave_b):
567
WeaveError.__init__(self)
568
self.revision_id = revision_id
569
self.weave_a = weave_a
570
self.weave_b = weave_b
573
class VersionedFileError(BzrNewError):
574
"""Versioned file error."""
577
class RevisionNotPresent(VersionedFileError):
578
"""Revision {%(revision_id)s} not present in %(file_id)s."""
580
def __init__(self, revision_id, file_id):
581
VersionedFileError.__init__(self)
582
self.revision_id = revision_id
583
self.file_id = file_id
586
class RevisionAlreadyPresent(VersionedFileError):
587
"""Revision {%(revision_id)s} already present in %(file_id)s."""
589
def __init__(self, revision_id, file_id):
590
VersionedFileError.__init__(self)
591
self.revision_id = revision_id
592
self.file_id = file_id
595
class KnitError(BzrNewError):
599
class KnitHeaderError(KnitError):
600
"""Knit header error: %(badline)r unexpected"""
602
def __init__(self, badline):
603
KnitError.__init__(self)
604
self.badline = badline
607
class KnitCorrupt(KnitError):
608
"""Knit %(filename)s corrupt: %(how)s"""
610
def __init__(self, filename, how):
611
KnitError.__init__(self)
612
self.filename = filename
616
class NoSuchExportFormat(BzrNewError):
617
"""Export format %(format)r not supported"""
618
def __init__(self, format):
619
BzrNewError.__init__(self)
623
class TransportError(BzrError):
624
"""All errors thrown by Transport implementations should derive
627
def __init__(self, msg=None, orig_error=None):
628
if msg is None and orig_error is not None:
629
msg = str(orig_error)
630
BzrError.__init__(self, msg)
632
self.orig_error = orig_error
635
# A set of semi-meaningful errors which can be thrown
636
class TransportNotPossible(TransportError):
637
"""This is for transports where a specific function is explicitly not
638
possible. Such as pushing files to an HTTP server.
643
class ConnectionError(TransportError):
644
"""A connection problem prevents file retrieval.
645
This does not indicate whether the file exists or not; it indicates that a
646
precondition for requesting the file was not met.
648
def __init__(self, msg=None, orig_error=None):
649
TransportError.__init__(self, msg=msg, orig_error=orig_error)
652
class ConnectionReset(TransportError):
653
"""The connection has been closed."""
657
class ConflictsInTree(BzrError):
659
BzrError.__init__(self, "Working tree has conflicts.")
662
class ParseConfigError(BzrError):
663
def __init__(self, errors, filename):
666
message = "Error(s) parsing config file %s:\n%s" % \
667
(filename, ('\n'.join(e.message for e in errors)))
668
BzrError.__init__(self, message)
671
class SigningFailed(BzrError):
672
def __init__(self, command_line):
673
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
677
class WorkingTreeNotRevision(BzrError):
678
def __init__(self, tree):
679
BzrError.__init__(self, "The working tree for %s has changed since"
680
" last commit, but weave merge requires that it be"
681
" unchanged." % tree.basedir)
684
class CantReprocessAndShowBase(BzrNewError):
685
"""Can't reprocess and show base.
686
Reprocessing obscures relationship of conflicting lines to base."""
689
class GraphCycleError(BzrNewError):
690
"""Cycle in graph %(graph)r"""
691
def __init__(self, graph):
692
BzrNewError.__init__(self)
696
class NotConflicted(BzrNewError):
697
"""File %(filename)s is not conflicted."""
699
def __init__(self, filename):
700
BzrNewError.__init__(self)
701
self.filename = filename
704
class MustUseDecorated(Exception):
705
"""A decorating function has requested its original command be used.
707
This should never escape bzr, so does not need to be printable.
711
class MissingText(BzrNewError):
712
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
714
def __init__(self, branch, text_revision, file_id):
715
BzrNewError.__init__(self)
717
self.base = branch.base
718
self.text_revision = text_revision
719
self.file_id = file_id
722
class DuplicateKey(BzrNewError):
723
"""Key %(key)s is already present in map"""
726
class MalformedTransform(BzrNewError):
727
"""Tree transform is malformed %(conflicts)r"""
730
class BzrBadParameter(BzrNewError):
731
"""A bad parameter : %(param)s is not usable.
733
This exception should never be thrown, but it is a base class for all
734
parameter-to-function errors.
736
def __init__(self, param):
737
BzrNewError.__init__(self)
741
class BzrBadParameterNotUnicode(BzrBadParameter):
742
"""Parameter %(param)s is neither unicode nor utf8."""
745
class ReusingTransform(BzrNewError):
746
"""Attempt to reuse a transform that has already been applied."""
749
class CantMoveRoot(BzrNewError):
750
"""Moving the root directory is not supported at this time"""
753
class BzrBadParameterNotString(BzrBadParameter):
754
"""Parameter %(param)s is not a string or unicode string."""
757
class BzrBadParameterMissing(BzrBadParameter):
758
"""Parameter $(param)s is required but not present."""
761
class DependencyNotPresent(BzrNewError):
762
"""Unable to import library "%(library)s": %(error)s"""
764
def __init__(self, library, error):
765
BzrNewError.__init__(self, library=library, error=error)
768
class ParamikoNotPresent(DependencyNotPresent):
769
"""Unable to import paramiko (required for sftp support): %(error)s"""
771
def __init__(self, error):
772
DependencyNotPresent.__init__(self, 'paramiko', error)
775
class UninitializableFormat(BzrNewError):
776
"""Format %(format)s cannot be initialised by this version of bzr."""
778
def __init__(self, format):
779
BzrNewError.__init__(self)
783
class NoDiff3(BzrNewError):
784
"""Diff3 is not installed on this machine."""
787
class ExistingLimbo(BzrNewError):
788
"""This tree contains left-over files from a failed operation.
789
Please examine %(limbo_dir)s to see if it contains any files you wish to
790
keep, and delete it when you are done.
792
def __init__(self, limbo_dir):
793
BzrNewError.__init__(self)
794
self.limbo_dir = limbo_dir
797
class ImmortalLimbo(BzrNewError):
798
"""Unable to delete transform temporary directory $(limbo_dir)s.
799
Please examine %(limbo_dir)s to see if it contains any files you wish to
800
keep, and delete it when you are done.
802
def __init__(self, limbo_dir):
803
BzrNewError.__init__(self)
804
self.limbo_dir = limbo_dir
807
class OutOfDateTree(BzrNewError):
808
"""Working tree is out of date, please run 'bzr update'."""
810
def __init__(self, tree):
811
BzrNewError.__init__(self)
815
class MergeModifiedFormatError(BzrNewError):
816
"""Error in merge modified format"""
819
class ConflictFormatError(BzrNewError):
820
"""Format error in conflict listings"""
823
class CorruptRepository(BzrNewError):
824
"""An error has been detected in the repository %(repo_path)s.
825
Please run bzr reconcile on this repository."""
827
def __init__(self, repo):
828
BzrNewError.__init__(self)
829
self.repo_path = repo.bzrdir.root_transport.base
832
class UpgradeRequired(BzrNewError):
833
"""To use this feature you must upgrade your branch at %(path)s."""
835
def __init__(self, path):
836
BzrNewError.__init__(self)
840
class LocalRequiresBoundBranch(BzrNewError):
841
"""Cannot perform local-only commits on unbound branches."""
844
class MissingProgressBarFinish(BzrNewError):
845
"""A nested progress bar was not 'finished' correctly."""
848
class UnsupportedOperation(BzrNewError):
849
"""The method %(mname)s is not supported on objects of type %(tname)s."""
850
def __init__(self, method, method_self):
852
self.mname = method.__name__
853
self.tname = type(method_self).__name__
added
removed
bzrlib/errors.py
