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 NotVersionedError(BzrNewError):
258
"""%(path)s is not versioned"""
259
def __init__(self, path):
260
BzrNewError.__init__(self)
264
class BadFileKindError(BzrError):
265
"""Specified file is of a kind that cannot be added.
267
(For example a symlink or device file.)"""
270
class ForbiddenFileError(BzrError):
271
"""Cannot operate on a file because it is a control file."""
274
class LockError(BzrNewError):
275
"""Lock error: %(message)s"""
276
# All exceptions from the lock/unlock functions should be from
277
# this exception class. They will be translated as necessary. The
278
# original exception is available as e.original_error
280
# New code should prefer to raise specific subclasses
281
def __init__(self, message):
282
self.message = message
285
class CommitNotPossible(LockError):
286
"""A commit was attempted but we do not have a write lock open."""
291
class AlreadyCommitted(LockError):
292
"""A rollback was requested, but is not able to be accomplished."""
297
class ReadOnlyError(LockError):
298
"""A write attempt was made in a read only transaction on %(obj)s"""
299
def __init__(self, obj):
303
class ObjectNotLocked(LockError):
304
"""%(obj)r is not locked"""
305
# this can indicate that any particular object is not locked; see also
306
# LockNotHeld which means that a particular *lock* object is not held by
307
# the caller -- perhaps they should be unified.
308
def __init__(self, obj):
312
class ReadOnlyObjectDirtiedError(ReadOnlyError):
313
"""Cannot change object %(obj)r in read only transaction"""
314
def __init__(self, obj):
318
class UnlockableTransport(LockError):
319
"""Cannot lock: transport is read only: %(transport)s"""
320
def __init__(self, transport):
321
self.transport = transport
324
class LockContention(LockError):
325
"""Could not acquire lock %(lock)s"""
326
# TODO: show full url for lock, combining the transport and relative bits?
327
def __init__(self, lock):
331
class LockBroken(LockError):
332
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
333
def __init__(self, lock):
337
class LockBreakMismatch(LockError):
338
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
339
def __init__(self, lock, holder, target):
345
class LockNotHeld(LockError):
346
"""Lock not held: %(lock)s"""
347
def __init__(self, lock):
351
class PointlessCommit(BzrNewError):
352
"""No changes to commit"""
355
class UpgradeReadonly(BzrNewError):
356
"""Upgrade URL cannot work with readonly URL's."""
359
class UpToDateFormat(BzrNewError):
360
"""The branch format %(format)s is already at the most recent format."""
362
def __init__(self, format):
363
BzrNewError.__init__(self)
367
class StrictCommitFailed(Exception):
368
"""Commit refused because there are unknowns in the tree."""
370
class NoSuchRevision(BzrError):
371
def __init__(self, branch, revision):
373
self.revision = revision
374
msg = "Branch %s has no revision %s" % (branch, revision)
375
BzrError.__init__(self, msg)
378
class HistoryMissing(BzrError):
379
def __init__(self, branch, object_type, object_id):
381
BzrError.__init__(self,
382
'%s is missing %s {%s}'
383
% (branch, object_type, object_id))
386
class DivergedBranches(BzrError):
387
def __init__(self, branch1, branch2):
388
BzrError.__init__(self, "These branches have diverged. Try merge.")
389
self.branch1 = branch1
390
self.branch2 = branch2
393
class UnrelatedBranches(BzrCommandError):
395
msg = "Branches have no common ancestor, and no base revision"\
397
BzrCommandError.__init__(self, msg)
400
class NoCommonAncestor(BzrError):
401
def __init__(self, revision_a, revision_b):
402
msg = "Revisions have no common ancestor: %s %s." \
403
% (revision_a, revision_b)
404
BzrError.__init__(self, msg)
407
class NoCommonRoot(BzrError):
408
def __init__(self, revision_a, revision_b):
409
msg = "Revisions are not derived from the same root: %s %s." \
410
% (revision_a, revision_b)
411
BzrError.__init__(self, msg)
414
class NotAncestor(BzrError):
415
def __init__(self, rev_id, not_ancestor_id):
416
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
418
BzrError.__init__(self, msg)
420
self.not_ancestor_id = not_ancestor_id
423
class InstallFailed(BzrError):
424
def __init__(self, revisions):
425
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
426
BzrError.__init__(self, msg)
427
self.revisions = revisions
430
class AmbiguousBase(BzrError):
431
def __init__(self, bases):
432
msg = "The correct base is unclear, becase %s are all equally close" %\
434
BzrError.__init__(self, msg)
438
class NoCommits(BzrError):
439
def __init__(self, branch):
440
msg = "Branch %s has no commits." % branch
441
BzrError.__init__(self, msg)
444
class UnlistableStore(BzrError):
445
def __init__(self, store):
446
BzrError.__init__(self, "Store %s is not listable" % store)
449
class UnlistableBranch(BzrError):
450
def __init__(self, br):
451
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
454
class WeaveError(BzrNewError):
455
"""Error in processing weave: %(message)s"""
456
def __init__(self, message=None):
457
BzrNewError.__init__(self)
458
self.message = message
461
class WeaveRevisionAlreadyPresent(WeaveError):
462
"""Revision {%(revision_id)s} already present in %(weave)s"""
463
def __init__(self, revision_id, weave):
464
WeaveError.__init__(self)
465
self.revision_id = revision_id
469
class WeaveRevisionNotPresent(WeaveError):
470
"""Revision {%(revision_id)s} not present in %(weave)s"""
471
def __init__(self, revision_id, weave):
472
WeaveError.__init__(self)
473
self.revision_id = revision_id
477
class WeaveFormatError(WeaveError):
478
"""Weave invariant violated: %(what)s"""
479
def __init__(self, what):
480
WeaveError.__init__(self)
484
class WeaveParentMismatch(WeaveError):
485
"""Parents are mismatched between two revisions."""
488
class WeaveInvalidChecksum(WeaveError):
489
"""Text did not match it's checksum: %(message)s"""
492
class WeaveTextDiffers(WeaveError):
493
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
495
def __init__(self, revision_id, weave_a, weave_b):
496
WeaveError.__init__(self)
497
self.revision_id = revision_id
498
self.weave_a = weave_a
499
self.weave_b = weave_b
502
class WeaveTextDiffers(WeaveError):
503
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
505
def __init__(self, revision_id, weave_a, weave_b):
506
WeaveError.__init__(self)
507
self.revision_id = revision_id
508
self.weave_a = weave_a
509
self.weave_b = weave_b
512
class NoSuchExportFormat(BzrNewError):
513
"""Export format %(format)r not supported"""
514
def __init__(self, format):
515
BzrNewError.__init__(self)
519
class TransportError(BzrError):
520
"""All errors thrown by Transport implementations should derive
523
def __init__(self, msg=None, orig_error=None):
524
if msg is None and orig_error is not None:
525
msg = str(orig_error)
526
BzrError.__init__(self, msg)
528
self.orig_error = orig_error
531
# A set of semi-meaningful errors which can be thrown
532
class TransportNotPossible(TransportError):
533
"""This is for transports where a specific function is explicitly not
534
possible. Such as pushing files to an HTTP server.
539
class ConnectionError(TransportError):
540
"""A connection problem prevents file retrieval.
541
This does not indicate whether the file exists or not; it indicates that a
542
precondition for requesting the file was not met.
544
def __init__(self, msg=None, orig_error=None):
545
TransportError.__init__(self, msg=msg, orig_error=orig_error)
548
class ConnectionReset(TransportError):
549
"""The connection has been closed."""
553
class ConflictsInTree(BzrError):
555
BzrError.__init__(self, "Working tree has conflicts.")
558
class ParseConfigError(BzrError):
559
def __init__(self, errors, filename):
562
message = "Error(s) parsing config file %s:\n%s" % \
563
(filename, ('\n'.join(e.message for e in errors)))
564
BzrError.__init__(self, message)
567
class SigningFailed(BzrError):
568
def __init__(self, command_line):
569
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
573
class WorkingTreeNotRevision(BzrError):
574
def __init__(self, tree):
575
BzrError.__init__(self, "The working tree for %s has changed since"
576
" last commit, but weave merge requires that it be"
577
" unchanged." % tree.basedir)
580
class CantReprocessAndShowBase(BzrNewError):
581
"""Can't reprocess and show base.
582
Reprocessing obscures relationship of conflicting lines to base."""
585
class GraphCycleError(BzrNewError):
586
"""Cycle in graph %(graph)r"""
587
def __init__(self, graph):
588
BzrNewError.__init__(self)
592
class NotConflicted(BzrNewError):
593
"""File %(filename)s is not conflicted."""
595
def __init__(self, filename):
596
BzrNewError.__init__(self)
597
self.filename = filename
600
class MustUseDecorated(Exception):
601
"""A decorating function has requested its original command be used.
603
This should never escape bzr, so does not need to be printable.
607
class MissingText(BzrNewError):
608
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
610
def __init__(self, branch, text_revision, file_id):
611
BzrNewError.__init__(self)
613
self.base = branch.base
614
self.text_revision = text_revision
615
self.file_id = file_id
617
class DuplicateKey(BzrNewError):
618
"""Key %(key)s is already present in map"""
620
class MalformedTransform(BzrNewError):
621
"""Tree transform is malformed %(conflicts)r"""
624
class BzrBadParameter(BzrNewError):
625
"""A bad parameter : %(param)s is not usable.
627
This exception should never be thrown, but it is a base class for all
628
parameter-to-function errors.
630
def __init__(self, param):
631
BzrNewError.__init__(self)
635
class BzrBadParameterNotUnicode(BzrBadParameter):
636
"""Parameter %(param)s is neither unicode nor utf8."""
639
class ReusingTransform(BzrNewError):
640
"""Attempt to reuse a transform that has already been applied."""
643
class CantMoveRoot(BzrNewError):
644
"""Moving the root directory is not supported at this time"""
647
class BzrBadParameterNotString(BzrBadParameter):
648
"""Parameter %(param)s is not a string or unicode string."""
651
class BzrBadParameterMissing(BzrBadParameter):
652
"""Parameter $(param)s is required but not present."""
655
class DependencyNotPresent(BzrNewError):
656
"""Unable to import library: %(library)s, %(error)s"""
658
def __init__(self, library, error):
659
BzrNewError.__init__(self, library=library, error=error)
662
class ParamikoNotPresent(DependencyNotPresent):
663
"""Unable to import paramiko (required for sftp support): %(error)s"""
665
def __init__(self, error):
666
DependencyNotPresent.__init__(self, 'paramiko', error)
669
class UninitializableFormat(BzrNewError):
670
"""Format %(format)s cannot be initialised by this version of bzr."""
672
def __init__(self, format):
673
BzrNewError.__init__(self)
677
class NoDiff3(BzrNewError):
678
"""Diff3 is not installed on this machine."""
681
class ExistingLimbo(BzrNewError):
682
"""This tree contains left-over files from a failed operation.
683
Please examine %(limbo_dir)s to see if it contains any files you wish to
684
keep, and delete it when you are done.
686
def __init__(self, limbo_dir):
687
BzrNewError.__init__(self)
688
self.limbo_dir = limbo_dir
691
class ImmortalLimbo(BzrNewError):
692
"""Unable to delete transform temporary directory $(limbo_dir)s.
693
Please examine %(limbo_dir)s to see if it contains any files you wish to
694
keep, and delete it when you are done.
696
def __init__(self, limbo_dir):
697
BzrNewError.__init__(self)
698
self.limbo_dir = limbo_dir
701
class OutOfDateTree(BzrNewError):
702
"""Working tree is out of date, please run 'bzr update'."""
704
def __init__(self, tree):
705
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
