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 BranchNotLocked(LockError):
304
"""Branch %(branch)r is not locked"""
305
def __init__(self, branch):
306
# XXX: sometimes called with a LockableFiles instance not a Branch
310
class ReadOnlyObjectDirtiedError(ReadOnlyError):
311
"""Cannot change object %(obj)r in read only transaction"""
312
def __init__(self, obj):
316
class UnlockableTransport(LockError):
317
"""Cannot lock: transport is read only: %(transport)s"""
318
def __init__(self, transport):
319
self.transport = transport
322
class LockContention(LockError):
323
"""Could not acquire lock %(lock)s"""
324
# TODO: show full url for lock, combining the transport and relative bits?
325
def __init__(self, lock):
329
class LockBroken(LockError):
330
"""Lock was broken while still open: %(lock)s - check storage consistency!"""
331
def __init__(self, lock):
335
class LockBreakMismatch(LockError):
336
"""Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
337
def __init__(self, lock, holder, target):
343
class LockNotHeld(LockError):
344
"""Lock not held: %(lock)s"""
345
def __init__(self, lock):
349
class BranchNotLocked(LockError):
350
"""Branch %(branch)r not locked"""
351
def __init__(self, branch):
355
class PointlessCommit(BzrNewError):
356
"""No changes to commit"""
359
class UpgradeReadonly(BzrNewError):
360
"""Upgrade URL cannot work with readonly URL's."""
363
class UpToDateFormat(BzrNewError):
364
"""The branch format %(format)s is already at the most recent format."""
366
def __init__(self, format):
367
BzrNewError.__init__(self)
371
class StrictCommitFailed(Exception):
372
"""Commit refused because there are unknowns in the tree."""
374
class NoSuchRevision(BzrError):
375
def __init__(self, branch, revision):
377
self.revision = revision
378
msg = "Branch %s has no revision %s" % (branch, revision)
379
BzrError.__init__(self, msg)
382
class HistoryMissing(BzrError):
383
def __init__(self, branch, object_type, object_id):
385
BzrError.__init__(self,
386
'%s is missing %s {%s}'
387
% (branch, object_type, object_id))
390
class DivergedBranches(BzrError):
391
def __init__(self, branch1, branch2):
392
BzrError.__init__(self, "These branches have diverged. Try merge.")
393
self.branch1 = branch1
394
self.branch2 = branch2
397
class UnrelatedBranches(BzrCommandError):
399
msg = "Branches have no common ancestor, and no base revision"\
401
BzrCommandError.__init__(self, msg)
404
class NoCommonAncestor(BzrError):
405
def __init__(self, revision_a, revision_b):
406
msg = "Revisions have no common ancestor: %s %s." \
407
% (revision_a, revision_b)
408
BzrError.__init__(self, msg)
411
class NoCommonRoot(BzrError):
412
def __init__(self, revision_a, revision_b):
413
msg = "Revisions are not derived from the same root: %s %s." \
414
% (revision_a, revision_b)
415
BzrError.__init__(self, msg)
418
class NotAncestor(BzrError):
419
def __init__(self, rev_id, not_ancestor_id):
420
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
422
BzrError.__init__(self, msg)
424
self.not_ancestor_id = not_ancestor_id
427
class InstallFailed(BzrError):
428
def __init__(self, revisions):
429
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
430
BzrError.__init__(self, msg)
431
self.revisions = revisions
434
class AmbiguousBase(BzrError):
435
def __init__(self, bases):
436
msg = "The correct base is unclear, becase %s are all equally close" %\
438
BzrError.__init__(self, msg)
442
class NoCommits(BzrError):
443
def __init__(self, branch):
444
msg = "Branch %s has no commits." % branch
445
BzrError.__init__(self, msg)
448
class UnlistableStore(BzrError):
449
def __init__(self, store):
450
BzrError.__init__(self, "Store %s is not listable" % store)
453
class UnlistableBranch(BzrError):
454
def __init__(self, br):
455
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
458
class WeaveError(BzrNewError):
459
"""Error in processing weave: %(message)s"""
460
def __init__(self, message=None):
461
BzrNewError.__init__(self)
462
self.message = message
465
class WeaveRevisionAlreadyPresent(WeaveError):
466
"""Revision {%(revision_id)s} already present in %(weave)s"""
467
def __init__(self, revision_id, weave):
468
WeaveError.__init__(self)
469
self.revision_id = revision_id
473
class WeaveRevisionNotPresent(WeaveError):
474
"""Revision {%(revision_id)s} not present in %(weave)s"""
475
def __init__(self, revision_id, weave):
476
WeaveError.__init__(self)
477
self.revision_id = revision_id
481
class WeaveFormatError(WeaveError):
482
"""Weave invariant violated: %(what)s"""
483
def __init__(self, what):
484
WeaveError.__init__(self)
488
class WeaveParentMismatch(WeaveError):
489
"""Parents are mismatched between two revisions."""
492
class WeaveInvalidChecksum(WeaveError):
493
"""Text did not match it's checksum: %(message)s"""
496
class WeaveTextDiffers(WeaveError):
497
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
499
def __init__(self, revision_id, weave_a, weave_b):
500
WeaveError.__init__(self)
501
self.revision_id = revision_id
502
self.weave_a = weave_a
503
self.weave_b = weave_b
506
class WeaveTextDiffers(WeaveError):
507
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
509
def __init__(self, revision_id, weave_a, weave_b):
510
WeaveError.__init__(self)
511
self.revision_id = revision_id
512
self.weave_a = weave_a
513
self.weave_b = weave_b
516
class NoSuchExportFormat(BzrNewError):
517
"""Export format %(format)r not supported"""
518
def __init__(self, format):
519
BzrNewError.__init__(self)
523
class TransportError(BzrError):
524
"""All errors thrown by Transport implementations should derive
527
def __init__(self, msg=None, orig_error=None):
528
if msg is None and orig_error is not None:
529
msg = str(orig_error)
530
BzrError.__init__(self, msg)
532
self.orig_error = orig_error
535
# A set of semi-meaningful errors which can be thrown
536
class TransportNotPossible(TransportError):
537
"""This is for transports where a specific function is explicitly not
538
possible. Such as pushing files to an HTTP server.
543
class ConnectionError(TransportError):
544
"""A connection problem prevents file retrieval.
545
This does not indicate whether the file exists or not; it indicates that a
546
precondition for requesting the file was not met.
548
def __init__(self, msg=None, orig_error=None):
549
TransportError.__init__(self, msg=msg, orig_error=orig_error)
552
class ConnectionReset(TransportError):
553
"""The connection has been closed."""
557
class ConflictsInTree(BzrError):
559
BzrError.__init__(self, "Working tree has conflicts.")
562
class ParseConfigError(BzrError):
563
def __init__(self, errors, filename):
566
message = "Error(s) parsing config file %s:\n%s" % \
567
(filename, ('\n'.join(e.message for e in errors)))
568
BzrError.__init__(self, message)
571
class SigningFailed(BzrError):
572
def __init__(self, command_line):
573
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
577
class WorkingTreeNotRevision(BzrError):
578
def __init__(self, tree):
579
BzrError.__init__(self, "The working tree for %s has changed since"
580
" last commit, but weave merge requires that it be"
581
" unchanged." % tree.basedir)
584
class CantReprocessAndShowBase(BzrNewError):
585
"""Can't reprocess and show base.
586
Reprocessing obscures relationship of conflicting lines to base."""
589
class GraphCycleError(BzrNewError):
590
"""Cycle in graph %(graph)r"""
591
def __init__(self, graph):
592
BzrNewError.__init__(self)
596
class NotConflicted(BzrNewError):
597
"""File %(filename)s is not conflicted."""
599
def __init__(self, filename):
600
BzrNewError.__init__(self)
601
self.filename = filename
604
class MustUseDecorated(Exception):
605
"""A decorating function has requested its original command be used.
607
This should never escape bzr, so does not need to be printable.
611
class MissingText(BzrNewError):
612
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
614
def __init__(self, branch, text_revision, file_id):
615
BzrNewError.__init__(self)
617
self.base = branch.base
618
self.text_revision = text_revision
619
self.file_id = file_id
621
class DuplicateKey(BzrNewError):
622
"""Key %(key)s is already present in map"""
624
class MalformedTransform(BzrNewError):
625
"""Tree transform is malformed %(conflicts)r"""
628
class BzrBadParameter(BzrNewError):
629
"""A bad parameter : %(param)s is not usable.
631
This exception should never be thrown, but it is a base class for all
632
parameter-to-function errors.
634
def __init__(self, param):
635
BzrNewError.__init__(self)
639
class BzrBadParameterNotUnicode(BzrBadParameter):
640
"""Parameter %(param)s is neither unicode nor utf8."""
643
class ReusingTransform(BzrNewError):
644
"""Attempt to reuse a transform that has already been applied."""
647
class CantMoveRoot(BzrNewError):
648
"""Moving the root directory is not supported at this time"""
651
class BzrBadParameterNotString(BzrBadParameter):
652
"""Parameter %(param)s is not a string or unicode string."""
655
class BzrBadParameterMissing(BzrBadParameter):
656
"""Parameter $(param)s is required but not present."""
659
class DependencyNotPresent(BzrNewError):
660
"""Unable to import library: %(library)s, %(error)s"""
662
def __init__(self, library, error):
663
BzrNewError.__init__(self, library=library, error=error)
666
class ParamikoNotPresent(DependencyNotPresent):
667
"""Unable to import paramiko (required for sftp support): %(error)s"""
669
def __init__(self, error):
670
DependencyNotPresent.__init__(self, 'paramiko', error)
673
class UninitializableFormat(BzrNewError):
674
"""Format %(format)s cannot be initialised by this version of bzr."""
676
def __init__(self, format):
677
BzrNewError.__init__(self)
681
class NoDiff3(BzrNewError):
682
"""Diff3 is not installed on this machine."""
685
class ExistingLimbo(BzrNewError):
686
"""This tree contains left-over files from a failed operation.
687
Please examine %(limbo_dir)s to see if it contains any files you wish to
688
keep, and delete it when you are done.
690
def __init__(self, limbo_dir):
691
BzrNewError.__init__(self)
692
self.limbo_dir = limbo_dir
695
class ImmortalLimbo(BzrNewError):
696
"""Unable to delete transform temporary directory $(limbo_dir)s.
697
Please examine %(limbo_dir)s to see if it contains any files you wish to
698
keep, and delete it when you are done.
700
def __init__(self, limbo_dir):
701
BzrNewError.__init__(self)
702
self.limbo_dir = limbo_dir
705
class OutOfDateTree(BzrNewError):
706
"""Working tree is out of date, please run 'bzr update'."""
708
def __init__(self, tree):
709
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
