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
from warnings import warn
58
# based on Scott James Remnant's hct error classes
60
# TODO: is there any value in providing the .args field used by standard
61
# python exceptions? A list of values with no names seems less useful
64
# TODO: Perhaps convert the exception to a string at the moment it's
65
# constructed to make sure it will succeed. But that says nothing about
66
# exceptions that are never raised.
68
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
72
class BzrError(StandardError):
74
# XXX: Should we show the exception class in
75
# exceptions that don't provide their own message?
76
# maybe it should be done at a higher level
77
## n = self.__class__.__name__ + ': '
79
if len(self.args) == 1:
80
return str(self.args[0])
81
elif len(self.args) == 2:
82
# further explanation or suggestions
84
return n + '\n '.join([self.args[0]] + self.args[1])
86
return n + "%r" % self
88
return n + `self.args`
91
class BzrNewError(BzrError):
93
# base classes should override the docstring with their human-
94
# readable explanation
96
def __init__(self, **kwds):
97
for key, value in kwds.items():
98
setattr(self, key, value)
102
return self.__doc__ % self.__dict__
103
except (NameError, ValueError, KeyError), e:
104
return 'Unprintable exception %s: %s' \
105
% (self.__class__.__name__, str(e))
108
class BzrCheckError(BzrNewError):
109
"""Internal check failed: %(message)s"""
111
def __init__(self, message):
112
BzrNewError.__init__(self)
113
self.message = message
116
class InvalidEntryName(BzrNewError):
117
"""Invalid entry name: %(name)s"""
118
def __init__(self, name):
119
BzrNewError.__init__(self)
123
class InvalidRevisionNumber(BzrNewError):
124
"""Invalid revision number %(revno)d"""
125
def __init__(self, revno):
126
BzrNewError.__init__(self)
130
class InvalidRevisionId(BzrNewError):
131
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
132
def __init__(self, revision_id, branch):
133
BzrNewError.__init__(self)
134
self.revision_id = revision_id
138
class NoWorkingTree(BzrNewError):
139
"""No WorkingTree exists for %(base)s."""
141
def __init__(self, base):
142
BzrNewError.__init__(self)
146
class NotLocalUrl(BzrNewError):
147
"""%(url)s is not a local path."""
149
def __init__(self, url):
150
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
159
# I think it's a waste of effort to differentiate between errors that
160
# are not intended to be caught anyway. UI code need not subclass
161
# BzrCommandError, and non-UI code should not throw a subclass of
162
# BzrCommandError. ADHB 20051211
167
class BzrOptionError(BzrCommandError):
168
"""Some missing or otherwise incorrect option was supplied."""
171
class StrictCommitFailed(Exception):
172
"""Commit refused because there are unknowns in the tree."""
175
class PathError(BzrNewError):
176
"""Generic path error: %(path)r%(extra)s)"""
178
def __init__(self, path, extra=None):
179
BzrNewError.__init__(self)
182
self.extra = ': ' + str(extra)
187
class NoSuchFile(PathError):
188
"""No such file: %(path)r%(extra)s"""
191
class FileExists(PathError):
192
"""File exists: %(path)r%(extra)s"""
195
class DirectoryNotEmpty(PathError):
196
"""Directory not empty: %(path)r%(extra)s"""
199
class ResourceBusy(PathError):
200
"""Device or resource busy: %(path)r%(extra)s"""
203
class PermissionDenied(PathError):
204
"""Permission denied: %(path)r%(extra)s"""
207
class PathNotChild(BzrNewError):
208
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
209
def __init__(self, path, base, extra=None):
210
BzrNewError.__init__(self)
214
self.extra = ': ' + str(extra)
219
class NotBranchError(PathError):
220
"""Not a branch: %(path)s"""
223
class AlreadyBranchError(PathError):
224
"""Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
227
class NoRepositoryPresent(BzrNewError):
228
"""Not repository present: %(path)r"""
229
def __init__(self, bzrdir):
230
BzrNewError.__init__(self)
231
self.path = bzrdir.transport.clone('..').base
234
class FileInWrongBranch(BzrNewError):
235
"""File %(path)s in not in branch %(branch_base)s."""
237
def __init__(self, branch, path):
238
BzrNewError.__init__(self)
240
self.branch_base = branch.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]
256
class IncompatibleFormat(BzrNewError):
257
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
259
def __init__(self, format, bzrdir_format):
260
BzrNewError.__init__(self)
262
self.bzrdir = bzrdir_format
265
class NotVersionedError(BzrNewError):
266
"""%(path)s is not versioned"""
267
def __init__(self, path):
268
BzrNewError.__init__(self)
272
class PathsNotVersionedError(BzrNewError):
273
# used when reporting several paths are not versioned
274
"""Path(s) are not versioned: %(paths_as_string)s"""
276
def __init__(self, paths):
277
from bzrlib.osutils import quotefn
278
BzrNewError.__init__(self)
280
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
283
class PathsDoNotExist(BzrNewError):
284
# used when reporting that paths are neither versioned nor in the working
286
"""Path(s) do not exist: %(paths_as_string)s"""
288
def __init__(self, paths):
289
from bzrlib.osutils import quotefn
290
BzrNewError.__init__(self)
292
self.paths_as_string = ' '.join([quotefn(p) for p in paths])
296
class BadFileKindError(BzrError):
297
"""Specified file is of a kind that cannot be added.
299
(For example a symlink or device file.)"""
302
class ForbiddenFileError(BzrError):
303
"""Cannot operate on a file because it is a control file."""
306
class LockError(BzrNewError):
307
"""Lock error: %(message)s"""
308
# All exceptions from the lock/unlock functions should be from
309
# this exception class. They will be translated as necessary. The
310
# original exception is available as e.original_error
312
# New code should prefer to raise specific subclasses
313
def __init__(self, message):
314
self.message = message
317
class CommitNotPossible(LockError):
318
"""A commit was attempted but we do not have a write lock open."""
323
class AlreadyCommitted(LockError):
324
"""A rollback was requested, but is not able to be accomplished."""
329
class ReadOnlyError(LockError):
330
"""A write attempt was made in a read only transaction on %(obj)s"""
331
def __init__(self, obj):
335
class OutSideTransaction(BzrNewError):
336
"""A transaction related operation was attempted after the transaction finished."""
339
class ObjectNotLocked(LockError):
340
"""%(obj)r is not locked"""
341
# this can indicate that any particular object is not locked; see also
342
# LockNotHeld which means that a particular *lock* object is not held by
343
# the caller -- perhaps they should be unified.
344
def __init__(self, obj):
348
class ReadOnlyObjectDirtiedError(ReadOnlyError):
349
"""Cannot change object %(obj)r in read only transaction"""
350
def __init__(self, obj):
354
class UnlockableTransport(LockError):
355
"""Cannot lock: transport is read only: %(transport)s"""
356
def __init__(self, transport):
357
self.transport = transport
360
class LockContention(LockError):
361
"""Could not acquire lock %(lock)s"""
362
# TODO: show full url for lock, combining the transport and relative bits?
363
def __init__(self, lock):
367
class LockBroken(LockError):
368
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
369
def __init__(self, lock):
373
class LockBreakMismatch(LockError):
374
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
375
def __init__(self, lock, holder, target):
381
class LockNotHeld(LockError):
382
"""Lock not held: %(lock)s"""
383
def __init__(self, lock):
387
class PointlessCommit(BzrNewError):
388
"""No changes to commit"""
391
class UpgradeReadonly(BzrNewError):
392
"""Upgrade URL cannot work with readonly URL's."""
395
class UpToDateFormat(BzrNewError):
396
"""The branch format %(format)s is already at the most recent format."""
398
def __init__(self, format):
399
BzrNewError.__init__(self)
404
class StrictCommitFailed(Exception):
405
"""Commit refused because there are unknowns in the tree."""
408
class NoSuchRevision(BzrError):
409
def __init__(self, branch, revision):
411
self.revision = revision
412
msg = "Branch %s has no revision %s" % (branch, revision)
413
BzrError.__init__(self, msg)
416
class HistoryMissing(BzrError):
417
def __init__(self, branch, object_type, object_id):
419
BzrError.__init__(self,
420
'%s is missing %s {%s}'
421
% (branch, object_type, object_id))
424
class DivergedBranches(BzrError):
426
def __init__(self, branch1, branch2):
427
BzrError.__init__(self, "These branches have diverged. Try merge.")
428
self.branch1 = branch1
429
self.branch2 = branch2
432
class UnrelatedBranches(BzrCommandError):
434
msg = "Branches have no common ancestor, and no base revision"\
436
BzrCommandError.__init__(self, msg)
439
class NoCommonAncestor(BzrError):
440
def __init__(self, revision_a, revision_b):
441
msg = "Revisions have no common ancestor: %s %s." \
442
% (revision_a, revision_b)
443
BzrError.__init__(self, msg)
446
class NoCommonRoot(BzrError):
447
def __init__(self, revision_a, revision_b):
448
msg = "Revisions are not derived from the same root: %s %s." \
449
% (revision_a, revision_b)
450
BzrError.__init__(self, msg)
454
class NotAncestor(BzrError):
455
def __init__(self, rev_id, not_ancestor_id):
456
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
458
BzrError.__init__(self, msg)
460
self.not_ancestor_id = not_ancestor_id
463
class InstallFailed(BzrError):
464
def __init__(self, revisions):
465
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
466
BzrError.__init__(self, msg)
467
self.revisions = revisions
470
class AmbiguousBase(BzrError):
471
def __init__(self, bases):
472
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
474
msg = "The correct base is unclear, becase %s are all equally close" %\
476
BzrError.__init__(self, msg)
480
class NoCommits(BzrError):
481
def __init__(self, branch):
482
msg = "Branch %s has no commits." % branch
483
BzrError.__init__(self, msg)
486
class UnlistableStore(BzrError):
487
def __init__(self, store):
488
BzrError.__init__(self, "Store %s is not listable" % store)
492
class UnlistableBranch(BzrError):
493
def __init__(self, br):
494
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
497
class BoundBranchOutOfDate(BzrNewError):
498
"""Bound branch %(branch)s is out of date with master branch %(master)s."""
499
def __init__(self, branch, master):
500
BzrNewError.__init__(self)
505
class CommitToDoubleBoundBranch(BzrNewError):
506
"""Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
507
def __init__(self, branch, master, remote):
508
BzrNewError.__init__(self)
514
class OverwriteBoundBranch(BzrNewError):
515
"""Cannot pull --overwrite to a branch which is bound %(branch)s"""
516
def __init__(self, branch):
517
BzrNewError.__init__(self)
521
class BoundBranchConnectionFailure(BzrNewError):
522
"""Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
523
def __init__(self, branch, target, error):
524
BzrNewError.__init__(self)
530
class WeaveError(BzrNewError):
531
"""Error in processing weave: %(message)s"""
533
def __init__(self, message=None):
534
BzrNewError.__init__(self)
535
self.message = message
538
class WeaveRevisionAlreadyPresent(WeaveError):
539
"""Revision {%(revision_id)s} already present in %(weave)s"""
540
def __init__(self, revision_id, weave):
542
WeaveError.__init__(self)
543
self.revision_id = revision_id
547
class WeaveRevisionNotPresent(WeaveError):
548
"""Revision {%(revision_id)s} not present in %(weave)s"""
550
def __init__(self, revision_id, weave):
551
WeaveError.__init__(self)
552
self.revision_id = revision_id
556
class WeaveFormatError(WeaveError):
557
"""Weave invariant violated: %(what)s"""
559
def __init__(self, what):
560
WeaveError.__init__(self)
564
class WeaveParentMismatch(WeaveError):
565
"""Parents are mismatched between two revisions."""
568
class WeaveInvalidChecksum(WeaveError):
569
"""Text did not match it's checksum: %(message)s"""
572
class WeaveTextDiffers(WeaveError):
573
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
575
def __init__(self, revision_id, weave_a, weave_b):
576
WeaveError.__init__(self)
577
self.revision_id = revision_id
578
self.weave_a = weave_a
579
self.weave_b = weave_b
582
class WeaveTextDiffers(WeaveError):
583
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
585
def __init__(self, revision_id, weave_a, weave_b):
586
WeaveError.__init__(self)
587
self.revision_id = revision_id
588
self.weave_a = weave_a
589
self.weave_b = weave_b
592
class VersionedFileError(BzrNewError):
593
"""Versioned file error."""
596
class RevisionNotPresent(VersionedFileError):
597
"""Revision {%(revision_id)s} not present in %(file_id)s."""
599
def __init__(self, revision_id, file_id):
600
VersionedFileError.__init__(self)
601
self.revision_id = revision_id
602
self.file_id = file_id
605
class RevisionAlreadyPresent(VersionedFileError):
606
"""Revision {%(revision_id)s} already present in %(file_id)s."""
608
def __init__(self, revision_id, file_id):
609
VersionedFileError.__init__(self)
610
self.revision_id = revision_id
611
self.file_id = file_id
614
class KnitError(BzrNewError):
618
class KnitHeaderError(KnitError):
619
"""Knit header error: %(badline)r unexpected"""
621
def __init__(self, badline):
622
KnitError.__init__(self)
623
self.badline = badline
626
class KnitCorrupt(KnitError):
627
"""Knit %(filename)s corrupt: %(how)s"""
629
def __init__(self, filename, how):
630
KnitError.__init__(self)
631
self.filename = filename
635
class NoSuchExportFormat(BzrNewError):
636
"""Export format %(format)r not supported"""
637
def __init__(self, format):
638
BzrNewError.__init__(self)
642
class TransportError(BzrError):
643
"""All errors thrown by Transport implementations should derive
646
def __init__(self, msg=None, orig_error=None):
647
if msg is None and orig_error is not None:
648
msg = str(orig_error)
649
BzrError.__init__(self, msg)
651
self.orig_error = orig_error
654
# A set of semi-meaningful errors which can be thrown
655
class TransportNotPossible(TransportError):
656
"""This is for transports where a specific function is explicitly not
657
possible. Such as pushing files to an HTTP server.
662
class ConnectionError(TransportError):
663
"""A connection problem prevents file retrieval.
664
This does not indicate whether the file exists or not; it indicates that a
665
precondition for requesting the file was not met.
667
def __init__(self, msg=None, orig_error=None):
668
TransportError.__init__(self, msg=msg, orig_error=orig_error)
671
class ConnectionReset(TransportError):
672
"""The connection has been closed."""
676
class ConflictsInTree(BzrError):
678
BzrError.__init__(self, "Working tree has conflicts.")
681
class ParseConfigError(BzrError):
682
def __init__(self, errors, filename):
685
message = "Error(s) parsing config file %s:\n%s" % \
686
(filename, ('\n'.join(e.message for e in errors)))
687
BzrError.__init__(self, message)
690
class SigningFailed(BzrError):
691
def __init__(self, command_line):
692
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
696
class WorkingTreeNotRevision(BzrError):
697
def __init__(self, tree):
698
BzrError.__init__(self, "The working tree for %s has changed since"
699
" last commit, but weave merge requires that it be"
700
" unchanged." % tree.basedir)
703
class CantReprocessAndShowBase(BzrNewError):
704
"""Can't reprocess and show base.
705
Reprocessing obscures relationship of conflicting lines to base."""
708
class GraphCycleError(BzrNewError):
709
"""Cycle in graph %(graph)r"""
710
def __init__(self, graph):
711
BzrNewError.__init__(self)
715
class NotConflicted(BzrNewError):
716
"""File %(filename)s is not conflicted."""
718
def __init__(self, filename):
719
BzrNewError.__init__(self)
720
self.filename = filename
723
class MustUseDecorated(Exception):
724
"""A decorating function has requested its original command be used.
726
This should never escape bzr, so does not need to be printable.
730
class MissingText(BzrNewError):
731
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
733
def __init__(self, branch, text_revision, file_id):
734
BzrNewError.__init__(self)
736
self.base = branch.base
737
self.text_revision = text_revision
738
self.file_id = file_id
741
class DuplicateKey(BzrNewError):
742
"""Key %(key)s is already present in map"""
745
class MalformedTransform(BzrNewError):
746
"""Tree transform is malformed %(conflicts)r"""
749
class BzrBadParameter(BzrNewError):
750
"""A bad parameter : %(param)s is not usable.
752
This exception should never be thrown, but it is a base class for all
753
parameter-to-function errors.
755
def __init__(self, param):
756
BzrNewError.__init__(self)
760
class BzrBadParameterNotUnicode(BzrBadParameter):
761
"""Parameter %(param)s is neither unicode nor utf8."""
764
class ReusingTransform(BzrNewError):
765
"""Attempt to reuse a transform that has already been applied."""
768
class CantMoveRoot(BzrNewError):
769
"""Moving the root directory is not supported at this time"""
772
class BzrBadParameterNotString(BzrBadParameter):
773
"""Parameter %(param)s is not a string or unicode string."""
776
class BzrBadParameterMissing(BzrBadParameter):
777
"""Parameter $(param)s is required but not present."""
780
class DependencyNotPresent(BzrNewError):
781
"""Unable to import library "%(library)s": %(error)s"""
783
def __init__(self, library, error):
784
BzrNewError.__init__(self, library=library, error=error)
787
class ParamikoNotPresent(DependencyNotPresent):
788
"""Unable to import paramiko (required for sftp support): %(error)s"""
790
def __init__(self, error):
791
DependencyNotPresent.__init__(self, 'paramiko', error)
794
class UninitializableFormat(BzrNewError):
795
"""Format %(format)s cannot be initialised by this version of bzr."""
797
def __init__(self, format):
798
BzrNewError.__init__(self)
802
class NoDiff3(BzrNewError):
803
"""Diff3 is not installed on this machine."""
806
class ExistingLimbo(BzrNewError):
807
"""This tree contains left-over files from a failed operation.
808
Please examine %(limbo_dir)s to see if it contains any files you wish to
809
keep, and delete it when you are done.
811
def __init__(self, limbo_dir):
812
BzrNewError.__init__(self)
813
self.limbo_dir = limbo_dir
816
class ImmortalLimbo(BzrNewError):
817
"""Unable to delete transform temporary directory $(limbo_dir)s.
818
Please examine %(limbo_dir)s to see if it contains any files you wish to
819
keep, and delete it when you are done.
821
def __init__(self, limbo_dir):
822
BzrNewError.__init__(self)
823
self.limbo_dir = limbo_dir
826
class OutOfDateTree(BzrNewError):
827
"""Working tree is out of date, please run 'bzr update'."""
829
def __init__(self, tree):
830
BzrNewError.__init__(self)
834
class MergeModifiedFormatError(BzrNewError):
835
"""Error in merge modified format"""
838
class ConflictFormatError(BzrNewError):
839
"""Format error in conflict listings"""
842
class CorruptRepository(BzrNewError):
843
"""An error has been detected in the repository %(repo_path)s.
844
Please run bzr reconcile on this repository."""
846
def __init__(self, repo):
847
BzrNewError.__init__(self)
848
self.repo_path = repo.bzrdir.root_transport.base
851
class UpgradeRequired(BzrNewError):
852
"""To use this feature you must upgrade your branch at %(path)s."""
854
def __init__(self, path):
855
BzrNewError.__init__(self)
859
class LocalRequiresBoundBranch(BzrNewError):
860
"""Cannot perform local-only commits on unbound branches."""
863
class MissingProgressBarFinish(BzrNewError):
864
"""A nested progress bar was not 'finished' correctly."""
867
class UnsupportedOperation(BzrNewError):
868
"""The method %(mname)s is not supported on objects of type %(tname)s."""
869
def __init__(self, method, method_self):
871
self.mname = method.__name__
872
self.tname = type(method_self).__name__
added
removed
bzrlib/errors.py
