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 PermissionDenied(PathError):
193
"""Permission denied: %(path)r%(extra)s"""
196
class PathNotChild(BzrNewError):
197
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
198
def __init__(self, path, base, extra=None):
199
BzrNewError.__init__(self)
203
self.extra = ': ' + str(extra)
208
class NotBranchError(BzrNewError):
209
"""Not a branch: %(path)s"""
210
def __init__(self, path):
211
BzrNewError.__init__(self)
215
class NoRepositoryPresent(BzrNewError):
216
"""Not repository present: %(path)r"""
217
def __init__(self, bzrdir):
218
BzrNewError.__init__(self)
219
self.path = bzrdir.transport.clone('..').base
222
class FileInWrongBranch(BzrNewError):
223
"""File %(path)s in not in branch %(branch_base)s."""
225
def __init__(self, branch, path):
226
BzrNewError.__init__(self)
228
self.branch_base = branch.base
232
class UnsupportedFormatError(BzrError):
233
"""Specified path is a bzr branch that we recognize but cannot read."""
235
return 'unsupported branch format: %s' % self.args[0]
238
class UnknownFormatError(BzrError):
239
"""Specified path is a bzr branch whose format we do not recognize."""
241
return 'unknown branch format: %s' % self.args[0]
244
class IncompatibleFormat(BzrNewError):
245
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
247
def __init__(self, format, bzrdir_format):
248
BzrNewError.__init__(self)
250
self.bzrdir = bzrdir_format
253
class NotVersionedError(BzrNewError):
254
"""%(path)s is not versioned"""
255
def __init__(self, path):
256
BzrNewError.__init__(self)
260
class BadFileKindError(BzrError):
261
"""Specified file is of a kind that cannot be added.
263
(For example a symlink or device file.)"""
266
class ForbiddenFileError(BzrError):
267
"""Cannot operate on a file because it is a control file."""
270
class LockError(Exception):
272
# All exceptions from the lock/unlock functions should be from
273
# this exception class. They will be translated as necessary. The
274
# original exception is available as e.original_error
277
class CommitNotPossible(LockError):
278
"""A commit was attempted but we do not have a write lock open."""
281
class AlreadyCommitted(LockError):
282
"""A rollback was requested, but is not able to be accomplished."""
285
class ReadOnlyError(LockError):
286
"""A write attempt was made in a read only transaction."""
289
class PointlessCommit(BzrNewError):
290
"""No changes to commit"""
293
class UpgradeReadonly(BzrNewError):
294
"""Upgrade URL cannot work with readonly URL's."""
297
class UpToDateFormat(BzrNewError):
298
"""The branch format %(format)s is already at the most recent format."""
300
def __init__(self, format):
301
BzrNewError.__init__(self)
305
class StrictCommitFailed(Exception):
306
"""Commit refused because there are unknowns in the tree."""
308
class NoSuchRevision(BzrError):
309
def __init__(self, branch, revision):
311
self.revision = revision
312
msg = "Branch %s has no revision %s" % (branch, revision)
313
BzrError.__init__(self, msg)
316
class HistoryMissing(BzrError):
317
def __init__(self, branch, object_type, object_id):
319
BzrError.__init__(self,
320
'%s is missing %s {%s}'
321
% (branch, object_type, object_id))
324
class DivergedBranches(BzrError):
325
def __init__(self, branch1, branch2):
326
BzrError.__init__(self, "These branches have diverged. Try merge.")
327
self.branch1 = branch1
328
self.branch2 = branch2
331
class UnrelatedBranches(BzrCommandError):
333
msg = "Branches have no common ancestor, and no base revision"\
335
BzrCommandError.__init__(self, msg)
338
class NoCommonAncestor(BzrError):
339
def __init__(self, revision_a, revision_b):
340
msg = "Revisions have no common ancestor: %s %s." \
341
% (revision_a, revision_b)
342
BzrError.__init__(self, msg)
345
class NoCommonRoot(BzrError):
346
def __init__(self, revision_a, revision_b):
347
msg = "Revisions are not derived from the same root: %s %s." \
348
% (revision_a, revision_b)
349
BzrError.__init__(self, msg)
352
class NotAncestor(BzrError):
353
def __init__(self, rev_id, not_ancestor_id):
354
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
356
BzrError.__init__(self, msg)
358
self.not_ancestor_id = not_ancestor_id
361
class InstallFailed(BzrError):
362
def __init__(self, revisions):
363
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
364
BzrError.__init__(self, msg)
365
self.revisions = revisions
368
class AmbiguousBase(BzrError):
369
def __init__(self, bases):
370
msg = "The correct base is unclear, becase %s are all equally close" %\
372
BzrError.__init__(self, msg)
376
class NoCommits(BzrError):
377
def __init__(self, branch):
378
msg = "Branch %s has no commits." % branch
379
BzrError.__init__(self, msg)
382
class UnlistableStore(BzrError):
383
def __init__(self, store):
384
BzrError.__init__(self, "Store %s is not listable" % store)
387
class UnlistableBranch(BzrError):
388
def __init__(self, br):
389
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
392
class WeaveError(BzrNewError):
393
"""Error in processing weave: %(message)s"""
394
def __init__(self, message=None):
395
BzrNewError.__init__(self)
396
self.message = message
399
class WeaveRevisionAlreadyPresent(WeaveError):
400
"""Revision {%(revision_id)s} already present in %(weave)s"""
401
def __init__(self, revision_id, weave):
402
WeaveError.__init__(self)
403
self.revision_id = revision_id
407
class WeaveRevisionNotPresent(WeaveError):
408
"""Revision {%(revision_id)s} not present in %(weave)s"""
409
def __init__(self, revision_id, weave):
410
WeaveError.__init__(self)
411
self.revision_id = revision_id
415
class WeaveFormatError(WeaveError):
416
"""Weave invariant violated: %(what)s"""
417
def __init__(self, what):
418
WeaveError.__init__(self)
422
class WeaveParentMismatch(WeaveError):
423
"""Parents are mismatched between two revisions."""
426
class WeaveInvalidChecksum(WeaveError):
427
"""Text did not match it's checksum: %(message)s"""
430
class WeaveTextDiffers(WeaveError):
431
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
433
def __init__(self, revision_id, weave_a, weave_b):
434
WeaveError.__init__(self)
435
self.revision_id = revision_id
436
self.weave_a = weave_a
437
self.weave_b = weave_b
440
class WeaveTextDiffers(WeaveError):
441
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
443
def __init__(self, revision_id, weave_a, weave_b):
444
WeaveError.__init__(self)
445
self.revision_id = revision_id
446
self.weave_a = weave_a
447
self.weave_b = weave_b
450
class NoSuchExportFormat(BzrNewError):
451
"""Export format %(format)r not supported"""
452
def __init__(self, format):
453
BzrNewError.__init__(self)
457
class TransportError(BzrError):
458
"""All errors thrown by Transport implementations should derive
461
def __init__(self, msg=None, orig_error=None):
462
if msg is None and orig_error is not None:
463
msg = str(orig_error)
464
BzrError.__init__(self, msg)
466
self.orig_error = orig_error
469
# A set of semi-meaningful errors which can be thrown
470
class TransportNotPossible(TransportError):
471
"""This is for transports where a specific function is explicitly not
472
possible. Such as pushing files to an HTTP server.
477
class ConnectionError(TransportError):
478
"""A connection problem prevents file retrieval.
479
This does not indicate whether the file exists or not; it indicates that a
480
precondition for requesting the file was not met.
482
def __init__(self, msg=None, orig_error=None):
483
TransportError.__init__(self, msg=msg, orig_error=orig_error)
486
class ConnectionReset(TransportError):
487
"""The connection has been closed."""
491
class ConflictsInTree(BzrError):
493
BzrError.__init__(self, "Working tree has conflicts.")
496
class ParseConfigError(BzrError):
497
def __init__(self, errors, filename):
500
message = "Error(s) parsing config file %s:\n%s" % \
501
(filename, ('\n'.join(e.message for e in errors)))
502
BzrError.__init__(self, message)
505
class SigningFailed(BzrError):
506
def __init__(self, command_line):
507
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
511
class WorkingTreeNotRevision(BzrError):
512
def __init__(self, tree):
513
BzrError.__init__(self, "The working tree for %s has changed since"
514
" last commit, but weave merge requires that it be"
515
" unchanged." % tree.basedir)
518
class CantReprocessAndShowBase(BzrNewError):
519
"""Can't reprocess and show base.
520
Reprocessing obscures relationship of conflicting lines to base."""
523
class GraphCycleError(BzrNewError):
524
"""Cycle in graph %(graph)r"""
525
def __init__(self, graph):
526
BzrNewError.__init__(self)
530
class NotConflicted(BzrNewError):
531
"""File %(filename)s is not conflicted."""
533
def __init__(self, filename):
534
BzrNewError.__init__(self)
535
self.filename = filename
538
class MustUseDecorated(Exception):
539
"""A decorating function has requested its original command be used.
541
This should never escape bzr, so does not need to be printable.
545
class MissingText(BzrNewError):
546
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
548
def __init__(self, branch, text_revision, file_id):
549
BzrNewError.__init__(self)
551
self.base = branch.base
552
self.text_revision = text_revision
553
self.file_id = file_id
555
class DuplicateKey(BzrNewError):
556
"""Key %(key)s is already present in map"""
558
class MalformedTransform(BzrNewError):
559
"""Tree transform is malformed %(conflicts)r"""
562
class BzrBadParameter(BzrNewError):
563
"""A bad parameter : %(param)s is not usable.
565
This exception should never be thrown, but it is a base class for all
566
parameter-to-function errors.
568
def __init__(self, param):
569
BzrNewError.__init__(self)
573
class BzrBadParameterNotUnicode(BzrBadParameter):
574
"""Parameter %(param)s is neither unicode nor utf8."""
577
class ReusingTransform(BzrNewError):
578
"""Attempt to reuse a transform that has already been applied."""
581
class CantMoveRoot(BzrNewError):
582
"""Moving the root directory is not supported at this time"""
585
class BzrBadParameterNotString(BzrBadParameter):
586
"""Parameter %(param)s is not a string or unicode string."""
589
class BzrBadParameterMissing(BzrBadParameter):
590
"""Parameter $(param)s is required but not present."""
593
class DependencyNotPresent(BzrNewError):
594
"""Unable to import library: %(library)s, %(error)s"""
596
def __init__(self, library, error):
597
BzrNewError.__init__(self, library=library, error=error)
600
class ParamikoNotPresent(DependencyNotPresent):
601
"""Unable to import paramiko (required for sftp support): %(error)s"""
603
def __init__(self, error):
604
DependencyNotPresent.__init__(self, 'paramiko', error)
607
class UninitializableFormat(BzrNewError):
608
"""Format %(format)s cannot be initialised by this version of bzr."""
610
def __init__(self, format):
611
BzrNewError.__init__(self)
615
class NoDiff3(BzrNewError):
616
"""Diff3 is not installed on this machine."""
619
class ExistingLimbo(BzrNewError):
620
"""This tree contains left-over files from a failed operation.
621
Please examine %(limbo_dir)s to see if it contains any files you wish to
622
keep, and delete it when you are done.
624
def __init__(self, limbo_dir):
625
BzrNewError.__init__(self)
626
self.limbo_dir = limbo_dir
629
class ImmortalLimbo(BzrNewError):
630
"""Unable to delete transform temporary directory $(limbo_dir)s.
631
Please examine %(limbo_dir)s to see if it contains any files you wish to
632
keep, and delete it when you are done.
634
def __init__(self, limbo_dir):
635
BzrNewError.__init__(self)
636
self.limbo_dir = limbo_dir
639
class OutOfDateTree(BzrNewError):
640
"""Working tree is out of date, please run 'bzr update'."""
642
def __init__(self, tree):
643
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
