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"""
108
def __init__(self, message):
109
BzrNewError.__init__(self)
110
self.message = message
113
class InvalidEntryName(BzrNewError):
114
"""Invalid entry name: %(name)s"""
115
def __init__(self, name):
116
BzrNewError.__init__(self)
120
class InvalidRevisionNumber(BzrNewError):
121
"""Invalid revision number %(revno)d"""
122
def __init__(self, revno):
123
BzrNewError.__init__(self)
127
class InvalidRevisionId(BzrNewError):
128
"""Invalid revision-id {%(revision_id)s} in %(branch)s"""
129
def __init__(self, revision_id, branch):
130
BzrNewError.__init__(self)
131
self.revision_id = revision_id
135
class NoWorkingTree(BzrNewError):
136
"""No WorkingTree exists for %s(base)."""
138
def __init__(self, base):
139
BzrNewError.__init__(self)
143
class NotLocalUrl(BzrNewError):
144
"""%s(url) is not a local path."""
146
def __init__(self, url):
147
BzrNewError.__init__(self)
151
class BzrCommandError(BzrError):
152
# Error from malformed user command
153
# This is being misused as a generic exception
154
# pleae subclass. RBC 20051030
156
# I think it's a waste of effort to differentiate between errors that
157
# are not intended to be caught anyway. UI code need not subclass
158
# BzrCommandError, and non-UI code should not throw a subclass of
159
# BzrCommandError. ADHB 20051211
164
class BzrOptionError(BzrCommandError):
165
"""Some missing or otherwise incorrect option was supplied."""
168
class StrictCommitFailed(Exception):
169
"""Commit refused because there are unknowns in the tree."""
172
class PathError(BzrNewError):
173
"""Generic path error: %(path)r%(extra)s)"""
174
def __init__(self, path, extra=None):
175
BzrNewError.__init__(self)
178
self.extra = ': ' + str(extra)
183
class NoSuchFile(PathError):
184
"""No such file: %(path)r%(extra)s"""
187
class FileExists(PathError):
188
"""File exists: %(path)r%(extra)s"""
191
class PermissionDenied(PathError):
192
"""Permission denied: %(path)r%(extra)s"""
195
class PathNotChild(BzrNewError):
196
"""Path %(path)r is not a child of path %(base)r%(extra)s"""
197
def __init__(self, path, base, extra=None):
198
BzrNewError.__init__(self)
202
self.extra = ': ' + str(extra)
207
class NotBranchError(BzrNewError):
208
"""Not a branch: %(path)s"""
209
def __init__(self, path):
210
BzrNewError.__init__(self)
214
class NoRepositoryPresent(BzrNewError):
215
"""Not repository present: %(path)r"""
216
def __init__(self, bzrdir):
217
BzrNewError.__init__(self)
218
self.path = bzrdir.transport.clone('..').base
221
class FileInWrongBranch(BzrNewError):
222
"""File %(path)s in not in branch %(branch_base)s."""
224
def __init__(self, branch, path):
225
BzrNewError.__init__(self)
227
self.branch_base = branch.base
231
class UnsupportedFormatError(BzrError):
232
"""Specified path is a bzr branch that we recognize but cannot read."""
234
return 'unsupported branch format: %s' % self.args[0]
237
class UnknownFormatError(BzrError):
238
"""Specified path is a bzr branch whose format we do not recognize."""
240
return 'unknown branch format: %s' % self.args[0]
243
class IncompatibleFormat(BzrNewError):
244
"""Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
246
def __init__(self, format, bzrdir_format):
247
BzrNewError.__init__(self)
249
self.bzrdir = bzrdir_format
252
class NotVersionedError(BzrNewError):
253
"""%(path)s is not versioned"""
254
def __init__(self, path):
255
BzrNewError.__init__(self)
259
class BadFileKindError(BzrError):
260
"""Specified file is of a kind that cannot be added.
262
(For example a symlink or device file.)"""
265
class ForbiddenFileError(BzrError):
266
"""Cannot operate on a file because it is a control file."""
269
class LockError(Exception):
271
# All exceptions from the lock/unlock functions should be from
272
# this exception class. They will be translated as necessary. The
273
# original exception is available as e.original_error
276
class CommitNotPossible(LockError):
277
"""A commit was attempted but we do not have a write lock open."""
280
class AlreadyCommitted(LockError):
281
"""A rollback was requested, but is not able to be accomplished."""
284
class ReadOnlyError(LockError):
285
"""A write attempt was made in a read only transaction."""
288
class PointlessCommit(BzrNewError):
289
"""No changes to commit"""
292
class UpgradeReadonly(BzrNewError):
293
"""Upgrade URL cannot work with readonly URL's."""
296
class StrictCommitFailed(Exception):
297
"""Commit refused because there are unknowns in the tree."""
300
class NoSuchRevision(BzrError):
301
def __init__(self, branch, revision):
303
self.revision = revision
304
msg = "Branch %s has no revision %s" % (branch, revision)
305
BzrError.__init__(self, msg)
308
class HistoryMissing(BzrError):
309
def __init__(self, branch, object_type, object_id):
311
BzrError.__init__(self,
312
'%s is missing %s {%s}'
313
% (branch, object_type, object_id))
316
class DivergedBranches(BzrError):
317
def __init__(self, branch1, branch2):
318
BzrError.__init__(self, "These branches have diverged. Try merge.")
319
self.branch1 = branch1
320
self.branch2 = branch2
323
class UnrelatedBranches(BzrCommandError):
325
msg = "Branches have no common ancestor, and no base revision"\
327
BzrCommandError.__init__(self, msg)
330
class NoCommonAncestor(BzrError):
331
def __init__(self, revision_a, revision_b):
332
msg = "Revisions have no common ancestor: %s %s." \
333
% (revision_a, revision_b)
334
BzrError.__init__(self, msg)
337
class NoCommonRoot(BzrError):
338
def __init__(self, revision_a, revision_b):
339
msg = "Revisions are not derived from the same root: %s %s." \
340
% (revision_a, revision_b)
341
BzrError.__init__(self, msg)
344
class NotAncestor(BzrError):
345
def __init__(self, rev_id, not_ancestor_id):
346
msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id,
348
BzrError.__init__(self, msg)
350
self.not_ancestor_id = not_ancestor_id
353
class InstallFailed(BzrError):
354
def __init__(self, revisions):
355
msg = "Could not install revisions:\n%s" % " ,".join(revisions)
356
BzrError.__init__(self, msg)
357
self.revisions = revisions
360
class AmbiguousBase(BzrError):
361
def __init__(self, bases):
362
msg = "The correct base is unclear, becase %s are all equally close" %\
364
BzrError.__init__(self, msg)
368
class NoCommits(BzrError):
369
def __init__(self, branch):
370
msg = "Branch %s has no commits." % branch
371
BzrError.__init__(self, msg)
374
class UnlistableStore(BzrError):
375
def __init__(self, store):
376
BzrError.__init__(self, "Store %s is not listable" % store)
379
class UnlistableBranch(BzrError):
380
def __init__(self, br):
381
BzrError.__init__(self, "Stores for branch %s are not listable" % br)
384
class WeaveError(BzrNewError):
385
"""Error in processing weave: %(message)s"""
386
def __init__(self, message=None):
387
BzrNewError.__init__(self)
388
self.message = message
391
class WeaveRevisionAlreadyPresent(WeaveError):
392
"""Revision {%(revision_id)s} already present in %(weave)s"""
393
def __init__(self, revision_id, weave):
394
WeaveError.__init__(self)
395
self.revision_id = revision_id
399
class WeaveRevisionNotPresent(WeaveError):
400
"""Revision {%(revision_id)s} not present in %(weave)s"""
401
def __init__(self, revision_id, weave):
402
WeaveError.__init__(self)
403
self.revision_id = revision_id
407
class WeaveFormatError(WeaveError):
408
"""Weave invariant violated: %(what)s"""
409
def __init__(self, what):
410
WeaveError.__init__(self)
414
class WeaveParentMismatch(WeaveError):
415
"""Parents are mismatched between two revisions."""
418
class WeaveInvalidChecksum(WeaveError):
419
"""Text did not match it's checksum: %(message)s"""
422
class WeaveTextDiffers(WeaveError):
423
"""Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
425
def __init__(self, revision_id, weave_a, weave_b):
426
WeaveError.__init__(self)
427
self.revision_id = revision_id
428
self.weave_a = weave_a
429
self.weave_b = weave_b
432
class NoSuchExportFormat(BzrNewError):
433
"""Export format %(format)r not supported"""
434
def __init__(self, format):
435
BzrNewError.__init__(self)
439
class TransportError(BzrError):
440
"""All errors thrown by Transport implementations should derive
443
def __init__(self, msg=None, orig_error=None):
444
if msg is None and orig_error is not None:
445
msg = str(orig_error)
446
BzrError.__init__(self, msg)
448
self.orig_error = orig_error
451
# A set of semi-meaningful errors which can be thrown
452
class TransportNotPossible(TransportError):
453
"""This is for transports where a specific function is explicitly not
454
possible. Such as pushing files to an HTTP server.
459
class ConnectionError(TransportError):
460
"""A connection problem prevents file retrieval.
461
This does not indicate whether the file exists or not; it indicates that a
462
precondition for requesting the file was not met.
464
def __init__(self, msg=None, orig_error=None):
465
TransportError.__init__(self, msg=msg, orig_error=orig_error)
468
class ConnectionReset(TransportError):
469
"""The connection has been closed."""
473
class ConflictsInTree(BzrError):
475
BzrError.__init__(self, "Working tree has conflicts.")
478
class ParseConfigError(BzrError):
479
def __init__(self, errors, filename):
482
message = "Error(s) parsing config file %s:\n%s" % \
483
(filename, ('\n'.join(e.message for e in errors)))
484
BzrError.__init__(self, message)
487
class SigningFailed(BzrError):
488
def __init__(self, command_line):
489
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
493
class WorkingTreeNotRevision(BzrError):
494
def __init__(self, tree):
495
BzrError.__init__(self, "The working tree for %s has changed since"
496
" last commit, but weave merge requires that it be"
497
" unchanged." % tree.basedir)
500
class CantReprocessAndShowBase(BzrNewError):
501
"""Can't reprocess and show base.
502
Reprocessing obscures relationship of conflicting lines to base."""
505
class GraphCycleError(BzrNewError):
506
"""Cycle in graph %(graph)r"""
507
def __init__(self, graph):
508
BzrNewError.__init__(self)
512
class NotConflicted(BzrNewError):
513
"""File %(filename)s is not conflicted."""
515
def __init__(self, filename):
516
BzrNewError.__init__(self)
517
self.filename = filename
520
class MustUseDecorated(Exception):
521
"""A decorating function has requested its original command be used.
523
This should never escape bzr, so does not need to be printable.
527
class MissingText(BzrNewError):
528
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
530
def __init__(self, branch, text_revision, file_id):
531
BzrNewError.__init__(self)
533
self.base = branch.base
534
self.text_revision = text_revision
535
self.file_id = file_id
538
class BzrBadParameter(BzrNewError):
539
"""A bad parameter : %(param)s is not usable.
541
This exception should never be thrown, but it is a base class for all
542
parameter-to-function errors.
544
def __init__(self, param):
545
BzrNewError.__init__(self)
549
class BzrBadParameterNotUnicode(BzrBadParameter):
550
"""Parameter %(param)s is neither unicode nor utf8."""
553
class BzrBadParameterNotString(BzrBadParameter):
554
"""Parameter %(param)s is not a string or unicode string."""
557
class BzrBadParameterMissing(BzrBadParameter):
558
"""Parameter $(param)s is required but not present."""
561
class DependencyNotPresent(BzrNewError):
562
"""Unable to import library: %(library)s, %(error)s"""
564
def __init__(self, library, error):
565
BzrNewError.__init__(self, library=library, error=error)
568
class ParamikoNotPresent(DependencyNotPresent):
569
"""Unable to import paramiko (required for sftp support): %(error)s"""
571
def __init__(self, error):
572
DependencyNotPresent.__init__(self, 'paramiko', error)
575
class UninitializableFormat(BzrNewError):
576
"""Format %(format)s cannot be initialised by this version of bzr."""
578
def __init__(self, format):
579
BzrNewError.__init__(self)
added
removed
bzrlib/errors.py
