~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2006-06-20 07:55:43 UTC
  • mfrom: (1798 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1799.
  • Revision ID: mbp@sourcefrog.net-20060620075543-b10f6575d4a4fa32
[merge] bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005, 2006 Canonical
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
21
 
 
22
 
 
23
 
######################################################################
24
 
# exceptions 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
 
 
19
There are 3 different classes of error:
 
20
 
 
21
 * KeyboardInterrupt, and OSError with EPIPE - the program terminates 
 
22
   with an appropriate short message
 
23
 
 
24
 * User errors, indicating a problem caused by the user such as a bad URL.
 
25
   These are printed in a short form.
 
26
 
 
27
 * Internal unexpected errors, including most Python builtin errors
 
28
   and some raised from inside bzr.  These are printed with a full 
 
29
   traceback and an invitation to report the bug.
 
30
 
 
31
Exceptions are caught at a high level to report errors to the user, and
 
32
might also be caught inside the program.  Therefore it needs to be
 
33
possible to convert them to a meaningful string, and also for them to be
 
34
interrogated by the program.
 
35
 
 
36
Exceptions are defined such that the arguments given to the constructor
 
37
are stored in the object as properties of the same name.  When the
 
38
object is printed as a string, the doc string of the class is used as
 
39
a format string with the property dictionary available to it.
 
40
 
 
41
This means that exceptions can used like this:
 
42
 
 
43
>>> import sys
 
44
>>> try:
 
45
...   raise NotBranchError(path='/foo/bar')
 
46
... except:
 
47
...   print sys.exc_type
 
48
...   print sys.exc_value
 
49
...   path = getattr(sys.exc_value, 'path', None)
 
50
...   if path is not None:
 
51
...     print path
 
52
bzrlib.errors.NotBranchError
 
53
Not a branch: /foo/bar
 
54
/foo/bar
 
55
 
 
56
Therefore:
 
57
 
 
58
 * create a new exception class for any class of error that can be
 
59
   usefully distinguished.  If no callers are likely to want to catch
 
60
   one but not another, don't worry about them.
 
61
 
 
62
 * the __str__ method should generate something useful; BzrError provides
 
63
   a good default implementation
 
64
 
 
65
Exception strings should start with a capital letter and should not have a
 
66
final fullstop.
 
67
"""
 
68
 
 
69
from warnings import warn
 
70
 
 
71
from bzrlib.patches import (PatchSyntax, 
 
72
                            PatchConflict, 
 
73
                            MalformedPatchHeader,
 
74
                            MalformedHunkHeader,
 
75
                            MalformedLine,)
 
76
 
 
77
 
 
78
# based on Scott James Remnant's hct error classes
 
79
 
 
80
# TODO: is there any value in providing the .args field used by standard
 
81
# python exceptions?   A list of values with no names seems less useful 
 
82
# to me.
 
83
 
 
84
# TODO: Perhaps convert the exception to a string at the moment it's 
 
85
# constructed to make sure it will succeed.  But that says nothing about
 
86
# exceptions that are never raised.
 
87
 
 
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
89
# the old one.
 
90
 
 
91
# TODO: The pattern (from hct) of using classes docstrings as message
 
92
# templates is cute but maybe not such a great idea - perhaps should have a
 
93
# separate static message_template.
 
94
 
 
95
 
25
96
class BzrError(StandardError):
26
 
    pass
27
 
 
28
 
class BzrCheckError(BzrError):
29
 
    pass
30
 
 
31
 
 
32
 
class BzrCommandError(BzrError):
33
 
    # Error from malformed user command
34
 
    pass
35
 
 
36
 
 
37
 
def bailout(msg, explanation=[]):
38
 
    ex = BzrError(msg, explanation)
39
 
    import trace
40
 
    trace._tracefile.write('* raising %s\n' % ex)
41
 
    raise ex
42
 
 
 
97
    
 
98
    is_user_error = True
 
99
    
 
100
    def __str__(self):
 
101
        # XXX: Should we show the exception class in 
 
102
        # exceptions that don't provide their own message?  
 
103
        # maybe it should be done at a higher level
 
104
        ## n = self.__class__.__name__ + ': '
 
105
        n = ''
 
106
        if len(self.args) == 1:
 
107
            return str(self.args[0])
 
108
        elif len(self.args) == 2:
 
109
            # further explanation or suggestions
 
110
            try:
 
111
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
112
            except TypeError:
 
113
                return n + "%r" % self
 
114
        else:
 
115
            return n + `self.args`
 
116
 
 
117
 
 
118
class BzrNewError(BzrError):
 
119
    """bzr error"""
 
120
    # base classes should override the docstring with their human-
 
121
    # readable explanation
 
122
 
 
123
    def __init__(self, **kwds):
 
124
        for key, value in kwds.items():
 
125
            setattr(self, key, value)
 
126
 
 
127
    def __str__(self):
 
128
        try:
 
129
            return self.__doc__ % self.__dict__
 
130
        except (NameError, ValueError, KeyError), e:
 
131
            return 'Unprintable exception %s: %s' \
 
132
                % (self.__class__.__name__, str(e))
 
133
 
 
134
 
 
135
class BzrCheckError(BzrNewError):
 
136
    """Internal check failed: %(message)s"""
 
137
 
 
138
    is_user_error = False
 
139
 
 
140
    def __init__(self, message):
 
141
        BzrNewError.__init__(self)
 
142
        self.message = message
 
143
 
 
144
 
 
145
class InvalidEntryName(BzrNewError):
 
146
    """Invalid entry name: %(name)s"""
 
147
 
 
148
    is_user_error = False
 
149
 
 
150
    def __init__(self, name):
 
151
        BzrNewError.__init__(self)
 
152
        self.name = name
 
153
 
 
154
 
 
155
class InvalidRevisionNumber(BzrNewError):
 
156
    """Invalid revision number %(revno)d"""
 
157
    def __init__(self, revno):
 
158
        BzrNewError.__init__(self)
 
159
        self.revno = revno
 
160
 
 
161
 
 
162
class InvalidRevisionId(BzrNewError):
 
163
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
164
    def __init__(self, revision_id, branch):
 
165
        # branch can be any string or object with __str__ defined
 
166
        BzrNewError.__init__(self)
 
167
        self.revision_id = revision_id
 
168
        self.branch = branch
 
169
 
 
170
 
 
171
class NoWorkingTree(BzrNewError):
 
172
    """No WorkingTree exists for %(base)s."""
 
173
    
 
174
    def __init__(self, base):
 
175
        BzrNewError.__init__(self)
 
176
        self.base = base
 
177
 
 
178
 
 
179
class NotLocalUrl(BzrNewError):
 
180
    """%(url)s is not a local path."""
 
181
    
 
182
    def __init__(self, url):
 
183
        BzrNewError.__init__(self)
 
184
        self.url = url
 
185
 
 
186
 
 
187
class BzrCommandError(BzrNewError):
 
188
    """Error from user command"""
 
189
 
 
190
    is_user_error = True
 
191
 
 
192
    # Error from malformed user command; please avoid raising this as a
 
193
    # generic exception not caused by user input.
 
194
    #
 
195
    # I think it's a waste of effort to differentiate between errors that
 
196
    # are not intended to be caught anyway.  UI code need not subclass
 
197
    # BzrCommandError, and non-UI code should not throw a subclass of
 
198
    # BzrCommandError.  ADHB 20051211
 
199
    def __init__(self, msg):
 
200
        self.msg = msg
 
201
 
 
202
    def __str__(self):
 
203
        return self.msg
 
204
 
 
205
 
 
206
class BzrOptionError(BzrCommandError):
 
207
    """Error in command line options"""
 
208
 
 
209
    
 
210
class StrictCommitFailed(BzrNewError):
 
211
    """Commit refused because there are unknown files in the tree"""
 
212
 
 
213
 
 
214
# XXX: Should be unified with TransportError; they seem to represent the
 
215
# same thing
 
216
class PathError(BzrNewError):
 
217
    """Generic path error: %(path)r%(extra)s)"""
 
218
 
 
219
    def __init__(self, path, extra=None):
 
220
        BzrNewError.__init__(self)
 
221
        self.path = path
 
222
        if extra:
 
223
            self.extra = ': ' + str(extra)
 
224
        else:
 
225
            self.extra = ''
 
226
 
 
227
 
 
228
class NoSuchFile(PathError):
 
229
    """No such file: %(path)r%(extra)s"""
 
230
 
 
231
 
 
232
class FileExists(PathError):
 
233
    """File exists: %(path)r%(extra)s"""
 
234
 
 
235
 
 
236
class DirectoryNotEmpty(PathError):
 
237
    """Directory not empty: %(path)r%(extra)s"""
 
238
 
 
239
 
 
240
class ResourceBusy(PathError):
 
241
    """Device or resource busy: %(path)r%(extra)s"""
 
242
 
 
243
 
 
244
class PermissionDenied(PathError):
 
245
    """Permission denied: %(path)r%(extra)s"""
 
246
 
 
247
 
 
248
class InvalidURL(PathError):
 
249
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
250
 
 
251
 
 
252
class InvalidURLJoin(PathError):
 
253
    """Invalid URL join request: %(args)s%(extra)s"""
 
254
 
 
255
    def __init__(self, msg, base, args):
 
256
        PathError.__init__(self, base, msg)
 
257
        self.args = [base]
 
258
        self.args.extend(args)
 
259
 
 
260
 
 
261
class PathNotChild(BzrNewError):
 
262
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
263
 
 
264
    is_user_error = False
 
265
 
 
266
    def __init__(self, path, base, extra=None):
 
267
        BzrNewError.__init__(self)
 
268
        self.path = path
 
269
        self.base = base
 
270
        if extra:
 
271
            self.extra = ': ' + str(extra)
 
272
        else:
 
273
            self.extra = ''
 
274
 
 
275
 
 
276
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
277
# the exception object is a bit undesirable.
 
278
# TODO: Probably this behavior of should be a common superclass 
 
279
class NotBranchError(PathError):
 
280
    """Not a branch: %(path)s"""
 
281
 
 
282
    def __init__(self, path):
 
283
       import bzrlib.urlutils as urlutils
 
284
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
285
 
 
286
 
 
287
class AlreadyBranchError(PathError):
 
288
    """Already a branch: %(path)s."""
 
289
 
 
290
 
 
291
class BranchExistsWithoutWorkingTree(PathError):
 
292
    """Directory contains a branch, but no working tree \
 
293
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
294
 
 
295
 
 
296
class NoRepositoryPresent(BzrNewError):
 
297
    """No repository present: %(path)r"""
 
298
    def __init__(self, bzrdir):
 
299
        BzrNewError.__init__(self)
 
300
        self.path = bzrdir.transport.clone('..').base
 
301
 
 
302
 
 
303
class FileInWrongBranch(BzrNewError):
 
304
    """File %(path)s in not in branch %(branch_base)s."""
 
305
 
 
306
    def __init__(self, branch, path):
 
307
        BzrNewError.__init__(self)
 
308
        self.branch = branch
 
309
        self.branch_base = branch.base
 
310
        self.path = path
 
311
 
 
312
 
 
313
class UnsupportedFormatError(BzrNewError):
 
314
    """Unsupported branch format: %(format)s"""
 
315
 
 
316
 
 
317
class UnknownFormatError(BzrNewError):
 
318
    """Unknown branch format: %(format)r"""
 
319
 
 
320
 
 
321
class IncompatibleFormat(BzrNewError):
 
322
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
323
 
 
324
    def __init__(self, format, bzrdir_format):
 
325
        BzrNewError.__init__(self)
 
326
        self.format = format
 
327
        self.bzrdir = bzrdir_format
 
328
 
 
329
 
 
330
class NotVersionedError(BzrNewError):
 
331
    """%(path)s is not versioned"""
 
332
    def __init__(self, path):
 
333
        BzrNewError.__init__(self)
 
334
        self.path = path
 
335
 
 
336
 
 
337
class PathsNotVersionedError(BzrNewError):
 
338
    # used when reporting several paths are not versioned
 
339
    """Path(s) are not versioned: %(paths_as_string)s"""
 
340
 
 
341
    def __init__(self, paths):
 
342
        from bzrlib.osutils import quotefn
 
343
        BzrNewError.__init__(self)
 
344
        self.paths = paths
 
345
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
346
 
 
347
 
 
348
class PathsDoNotExist(BzrNewError):
 
349
    """Path(s) do not exist: %(paths_as_string)s"""
 
350
 
 
351
    # used when reporting that paths are neither versioned nor in the working
 
352
    # tree
 
353
 
 
354
    def __init__(self, paths):
 
355
        # circular import
 
356
        from bzrlib.osutils import quotefn
 
357
        BzrNewError.__init__(self)
 
358
        self.paths = paths
 
359
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
360
 
 
361
 
 
362
class BadFileKindError(BzrNewError):
 
363
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
364
 
 
365
 
 
366
class ForbiddenControlFileError(BzrNewError):
 
367
    """Cannot operate on %(filename)s because it is a control file"""
 
368
 
 
369
 
 
370
class LockError(BzrNewError):
 
371
    """Lock error: %(message)s"""
 
372
    # All exceptions from the lock/unlock functions should be from
 
373
    # this exception class.  They will be translated as necessary. The
 
374
    # original exception is available as e.original_error
 
375
    #
 
376
    # New code should prefer to raise specific subclasses
 
377
    def __init__(self, message):
 
378
        self.message = message
 
379
 
 
380
 
 
381
class CommitNotPossible(LockError):
 
382
    """A commit was attempted but we do not have a write lock open."""
 
383
    def __init__(self):
 
384
        pass
 
385
 
 
386
 
 
387
class AlreadyCommitted(LockError):
 
388
    """A rollback was requested, but is not able to be accomplished."""
 
389
    def __init__(self):
 
390
        pass
 
391
 
 
392
 
 
393
class ReadOnlyError(LockError):
 
394
    """A write attempt was made in a read only transaction on %(obj)s"""
 
395
    def __init__(self, obj):
 
396
        self.obj = obj
 
397
 
 
398
 
 
399
class OutSideTransaction(BzrNewError):
 
400
    """A transaction related operation was attempted after the transaction finished."""
 
401
 
 
402
 
 
403
class ObjectNotLocked(LockError):
 
404
    """%(obj)r is not locked"""
 
405
 
 
406
    is_user_error = False
 
407
 
 
408
    # this can indicate that any particular object is not locked; see also
 
409
    # LockNotHeld which means that a particular *lock* object is not held by
 
410
    # the caller -- perhaps they should be unified.
 
411
    def __init__(self, obj):
 
412
        self.obj = obj
 
413
 
 
414
 
 
415
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
416
    """Cannot change object %(obj)r in read only transaction"""
 
417
    def __init__(self, obj):
 
418
        self.obj = obj
 
419
 
 
420
 
 
421
class UnlockableTransport(LockError):
 
422
    """Cannot lock: transport is read only: %(transport)s"""
 
423
    def __init__(self, transport):
 
424
        self.transport = transport
 
425
 
 
426
 
 
427
class LockContention(LockError):
 
428
    """Could not acquire lock %(lock)s"""
 
429
    # TODO: show full url for lock, combining the transport and relative bits?
 
430
    def __init__(self, lock):
 
431
        self.lock = lock
 
432
 
 
433
 
 
434
class LockBroken(LockError):
 
435
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
436
    def __init__(self, lock):
 
437
        self.lock = lock
 
438
 
 
439
 
 
440
class LockBreakMismatch(LockError):
 
441
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
442
    def __init__(self, lock, holder, target):
 
443
        self.lock = lock
 
444
        self.holder = holder
 
445
        self.target = target
 
446
 
 
447
 
 
448
class LockNotHeld(LockError):
 
449
    """Lock not held: %(lock)s"""
 
450
    def __init__(self, lock):
 
451
        self.lock = lock
 
452
 
 
453
 
 
454
class PointlessCommit(BzrNewError):
 
455
    """No changes to commit"""
 
456
 
 
457
 
 
458
class UpgradeReadonly(BzrNewError):
 
459
    """Upgrade URL cannot work with readonly URL's."""
 
460
 
 
461
 
 
462
class UpToDateFormat(BzrNewError):
 
463
    """The branch format %(format)s is already at the most recent format."""
 
464
 
 
465
    def __init__(self, format):
 
466
        BzrNewError.__init__(self)
 
467
        self.format = format
 
468
 
 
469
 
 
470
 
 
471
class StrictCommitFailed(Exception):
 
472
    """Commit refused because there are unknowns in the tree."""
 
473
 
 
474
 
 
475
class NoSuchRevision(BzrNewError):
 
476
    """Branch %(branch)s has no revision %(revision)s"""
 
477
 
 
478
    is_user_error = False
 
479
 
 
480
    def __init__(self, branch, revision):
 
481
        self.branch = branch
 
482
        self.revision = revision
 
483
 
 
484
 
 
485
class HistoryMissing(BzrError):
 
486
    def __init__(self, branch, object_type, object_id):
 
487
        self.branch = branch
 
488
        BzrError.__init__(self,
 
489
                          '%s is missing %s {%s}'
 
490
                          % (branch, object_type, object_id))
 
491
 
 
492
 
 
493
class DivergedBranches(BzrNewError):
 
494
    "These branches have diverged.  Use the merge command to reconcile them."""
 
495
 
 
496
    is_user_error = True
 
497
 
 
498
    def __init__(self, branch1, branch2):
 
499
        self.branch1 = branch1
 
500
        self.branch2 = branch2
 
501
 
 
502
 
 
503
class UnrelatedBranches(BzrNewError):
 
504
    "Branches have no common ancestor, and no merge base revision was specified."
 
505
 
 
506
    is_user_error = True
 
507
 
 
508
 
 
509
class NoCommonAncestor(BzrNewError):
 
510
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
511
 
 
512
    def __init__(self, revision_a, revision_b):
 
513
        self.revision_a = revision_a
 
514
        self.revision_b = revision_b
 
515
 
 
516
 
 
517
class NoCommonRoot(BzrError):
 
518
    def __init__(self, revision_a, revision_b):
 
519
        msg = "Revisions are not derived from the same root: %s %s." \
 
520
            % (revision_a, revision_b) 
 
521
        BzrError.__init__(self, msg)
 
522
 
 
523
 
 
524
 
 
525
class NotAncestor(BzrError):
 
526
    def __init__(self, rev_id, not_ancestor_id):
 
527
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
528
                                                        rev_id)
 
529
        BzrError.__init__(self, msg)
 
530
        self.rev_id = rev_id
 
531
        self.not_ancestor_id = not_ancestor_id
 
532
 
 
533
 
 
534
class InstallFailed(BzrError):
 
535
    def __init__(self, revisions):
 
536
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
537
        BzrError.__init__(self, msg)
 
538
        self.revisions = revisions
 
539
 
 
540
 
 
541
class AmbiguousBase(BzrError):
 
542
    def __init__(self, bases):
 
543
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
544
                DeprecationWarning)
 
545
        msg = "The correct base is unclear, because %s are all equally close" %\
 
546
            ", ".join(bases)
 
547
        BzrError.__init__(self, msg)
 
548
        self.bases = bases
 
549
 
 
550
 
 
551
class NoCommits(BzrError):
 
552
    def __init__(self, branch):
 
553
        msg = "Branch %s has no commits." % branch
 
554
        BzrError.__init__(self, msg)
 
555
 
 
556
 
 
557
class UnlistableStore(BzrError):
 
558
    def __init__(self, store):
 
559
        BzrError.__init__(self, "Store %s is not listable" % store)
 
560
 
 
561
 
 
562
 
 
563
class UnlistableBranch(BzrError):
 
564
    def __init__(self, br):
 
565
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
566
 
 
567
 
 
568
class BoundBranchOutOfDate(BzrNewError):
 
569
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
570
    def __init__(self, branch, master):
 
571
        BzrNewError.__init__(self)
 
572
        self.branch = branch
 
573
        self.master = master
 
574
 
 
575
        
 
576
class CommitToDoubleBoundBranch(BzrNewError):
 
577
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
578
    def __init__(self, branch, master, remote):
 
579
        BzrNewError.__init__(self)
 
580
        self.branch = branch
 
581
        self.master = master
 
582
        self.remote = remote
 
583
 
 
584
 
 
585
class OverwriteBoundBranch(BzrNewError):
 
586
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
587
    def __init__(self, branch):
 
588
        BzrNewError.__init__(self)
 
589
        self.branch = branch
 
590
 
 
591
 
 
592
class BoundBranchConnectionFailure(BzrNewError):
 
593
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
594
    def __init__(self, branch, target, error):
 
595
        BzrNewError.__init__(self)
 
596
        self.branch = branch
 
597
        self.target = target
 
598
        self.error = error
 
599
 
 
600
 
 
601
class WeaveError(BzrNewError):
 
602
    """Error in processing weave: %(message)s"""
 
603
 
 
604
    def __init__(self, message=None):
 
605
        BzrNewError.__init__(self)
 
606
        self.message = message
 
607
 
 
608
 
 
609
class WeaveRevisionAlreadyPresent(WeaveError):
 
610
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
611
    def __init__(self, revision_id, weave):
 
612
 
 
613
        WeaveError.__init__(self)
 
614
        self.revision_id = revision_id
 
615
        self.weave = weave
 
616
 
 
617
 
 
618
class WeaveRevisionNotPresent(WeaveError):
 
619
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
620
 
 
621
    def __init__(self, revision_id, weave):
 
622
        WeaveError.__init__(self)
 
623
        self.revision_id = revision_id
 
624
        self.weave = weave
 
625
 
 
626
 
 
627
class WeaveFormatError(WeaveError):
 
628
    """Weave invariant violated: %(what)s"""
 
629
 
 
630
    def __init__(self, what):
 
631
        WeaveError.__init__(self)
 
632
        self.what = what
 
633
 
 
634
 
 
635
class WeaveParentMismatch(WeaveError):
 
636
    """Parents are mismatched between two revisions."""
 
637
    
 
638
 
 
639
class WeaveInvalidChecksum(WeaveError):
 
640
    """Text did not match it's checksum: %(message)s"""
 
641
 
 
642
 
 
643
class WeaveTextDiffers(WeaveError):
 
644
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
645
 
 
646
    def __init__(self, revision_id, weave_a, weave_b):
 
647
        WeaveError.__init__(self)
 
648
        self.revision_id = revision_id
 
649
        self.weave_a = weave_a
 
650
        self.weave_b = weave_b
 
651
 
 
652
 
 
653
class WeaveTextDiffers(WeaveError):
 
654
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
655
 
 
656
    def __init__(self, revision_id, weave_a, weave_b):
 
657
        WeaveError.__init__(self)
 
658
        self.revision_id = revision_id
 
659
        self.weave_a = weave_a
 
660
        self.weave_b = weave_b
 
661
 
 
662
 
 
663
class VersionedFileError(BzrNewError):
 
664
    """Versioned file error."""
 
665
 
 
666
 
 
667
class RevisionNotPresent(VersionedFileError):
 
668
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
669
 
 
670
    def __init__(self, revision_id, file_id):
 
671
        VersionedFileError.__init__(self)
 
672
        self.revision_id = revision_id
 
673
        self.file_id = file_id
 
674
 
 
675
 
 
676
class RevisionAlreadyPresent(VersionedFileError):
 
677
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
678
 
 
679
    def __init__(self, revision_id, file_id):
 
680
        VersionedFileError.__init__(self)
 
681
        self.revision_id = revision_id
 
682
        self.file_id = file_id
 
683
 
 
684
 
 
685
class KnitError(BzrNewError):
 
686
    """Knit error"""
 
687
 
 
688
 
 
689
class KnitHeaderError(KnitError):
 
690
    """Knit header error: %(badline)r unexpected"""
 
691
 
 
692
    def __init__(self, badline):
 
693
        KnitError.__init__(self)
 
694
        self.badline = badline
 
695
 
 
696
 
 
697
class KnitCorrupt(KnitError):
 
698
    """Knit %(filename)s corrupt: %(how)s"""
 
699
 
 
700
    def __init__(self, filename, how):
 
701
        KnitError.__init__(self)
 
702
        self.filename = filename
 
703
        self.how = how
 
704
 
 
705
 
 
706
class NoSuchExportFormat(BzrNewError):
 
707
    """Export format %(format)r not supported"""
 
708
    def __init__(self, format):
 
709
        BzrNewError.__init__(self)
 
710
        self.format = format
 
711
 
 
712
 
 
713
class TransportError(BzrError):
 
714
    """All errors thrown by Transport implementations should derive
 
715
    from this class.
 
716
    """
 
717
    def __init__(self, msg=None, orig_error=None):
 
718
        if msg is None and orig_error is not None:
 
719
            msg = str(orig_error)
 
720
        BzrError.__init__(self, msg)
 
721
        self.msg = msg
 
722
        self.orig_error = orig_error
 
723
 
 
724
 
 
725
# A set of semi-meaningful errors which can be thrown
 
726
class TransportNotPossible(TransportError):
 
727
    """This is for transports where a specific function is explicitly not
 
728
    possible. Such as pushing files to an HTTP server.
 
729
    """
 
730
    pass
 
731
 
 
732
 
 
733
class ConnectionError(TransportError):
 
734
    """A connection problem prevents file retrieval.
 
735
    This does not indicate whether the file exists or not; it indicates that a
 
736
    precondition for requesting the file was not met.
 
737
    """
 
738
    def __init__(self, msg=None, orig_error=None):
 
739
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
740
 
 
741
 
 
742
class ConnectionReset(TransportError):
 
743
    """The connection has been closed."""
 
744
    pass
 
745
 
 
746
 
 
747
class ConflictsInTree(BzrError):
 
748
    def __init__(self):
 
749
        BzrError.__init__(self, "Working tree has conflicts.")
 
750
 
 
751
 
 
752
class ParseConfigError(BzrError):
 
753
    def __init__(self, errors, filename):
 
754
        if filename is None:
 
755
            filename = ""
 
756
        message = "Error(s) parsing config file %s:\n%s" % \
 
757
            (filename, ('\n'.join(e.message for e in errors)))
 
758
        BzrError.__init__(self, message)
 
759
 
 
760
 
 
761
class SigningFailed(BzrError):
 
762
    def __init__(self, command_line):
 
763
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
764
                               % command_line)
 
765
 
 
766
 
 
767
class WorkingTreeNotRevision(BzrError):
 
768
    def __init__(self, tree):
 
769
        BzrError.__init__(self, "The working tree for %s has changed since"
 
770
                          " last commit, but weave merge requires that it be"
 
771
                          " unchanged." % tree.basedir)
 
772
 
 
773
 
 
774
class CantReprocessAndShowBase(BzrNewError):
 
775
    """Can't reprocess and show base.
 
776
Reprocessing obscures relationship of conflicting lines to base."""
 
777
 
 
778
 
 
779
class GraphCycleError(BzrNewError):
 
780
    """Cycle in graph %(graph)r"""
 
781
    def __init__(self, graph):
 
782
        BzrNewError.__init__(self)
 
783
        self.graph = graph
 
784
 
 
785
 
 
786
class NotConflicted(BzrNewError):
 
787
    """File %(filename)s is not conflicted."""
 
788
 
 
789
    def __init__(self, filename):
 
790
        BzrNewError.__init__(self)
 
791
        self.filename = filename
 
792
 
 
793
 
 
794
class MustUseDecorated(Exception):
 
795
    """A decorating function has requested its original command be used.
 
796
    
 
797
    This should never escape bzr, so does not need to be printable.
 
798
    """
 
799
 
 
800
 
 
801
class NoBundleFound(BzrNewError):
 
802
    """No bundle was found in %(filename)s"""
 
803
    def __init__(self, filename):
 
804
        BzrNewError.__init__(self)
 
805
        self.filename = filename
 
806
 
 
807
 
 
808
class BundleNotSupported(BzrNewError):
 
809
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
810
    def __init__(self, version, msg):
 
811
        BzrNewError.__init__(self)
 
812
        self.version = version
 
813
        self.msg = msg
 
814
 
 
815
 
 
816
class MissingText(BzrNewError):
 
817
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
818
 
 
819
    def __init__(self, branch, text_revision, file_id):
 
820
        BzrNewError.__init__(self)
 
821
        self.branch = branch
 
822
        self.base = branch.base
 
823
        self.text_revision = text_revision
 
824
        self.file_id = file_id
 
825
 
 
826
 
 
827
class DuplicateKey(BzrNewError):
 
828
    """Key %(key)s is already present in map"""
 
829
 
 
830
 
 
831
class MalformedTransform(BzrNewError):
 
832
    """Tree transform is malformed %(conflicts)r"""
 
833
 
 
834
 
 
835
class BzrBadParameter(BzrNewError):
 
836
    """A bad parameter : %(param)s is not usable.
 
837
    
 
838
    This exception should never be thrown, but it is a base class for all
 
839
    parameter-to-function errors.
 
840
    """
 
841
    def __init__(self, param):
 
842
        BzrNewError.__init__(self)
 
843
        self.param = param
 
844
 
 
845
 
 
846
class BzrBadParameterNotUnicode(BzrBadParameter):
 
847
    """Parameter %(param)s is neither unicode nor utf8."""
 
848
 
 
849
 
 
850
class ReusingTransform(BzrNewError):
 
851
    """Attempt to reuse a transform that has already been applied."""
 
852
 
 
853
 
 
854
class CantMoveRoot(BzrNewError):
 
855
    """Moving the root directory is not supported at this time"""
 
856
 
 
857
 
 
858
class BzrBadParameterNotString(BzrBadParameter):
 
859
    """Parameter %(param)s is not a string or unicode string."""
 
860
 
 
861
 
 
862
class BzrBadParameterMissing(BzrBadParameter):
 
863
    """Parameter $(param)s is required but not present."""
 
864
 
 
865
 
 
866
class BzrBadParameterUnicode(BzrBadParameter):
 
867
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
868
 
 
869
 
 
870
class BzrBadParameterContainsNewline(BzrBadParameter):
 
871
    """Parameter %(param)s contains a newline."""
 
872
 
 
873
 
 
874
class DependencyNotPresent(BzrNewError):
 
875
    """Unable to import library "%(library)s": %(error)s"""
 
876
 
 
877
    def __init__(self, library, error):
 
878
        BzrNewError.__init__(self, library=library, error=error)
 
879
 
 
880
 
 
881
class ParamikoNotPresent(DependencyNotPresent):
 
882
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
883
 
 
884
    def __init__(self, error):
 
885
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
886
 
 
887
 
 
888
class UninitializableFormat(BzrNewError):
 
889
    """Format %(format)s cannot be initialised by this version of bzr."""
 
890
 
 
891
    def __init__(self, format):
 
892
        BzrNewError.__init__(self)
 
893
        self.format = format
 
894
 
 
895
 
 
896
class NoDiff(BzrNewError):
 
897
    """Diff is not installed on this machine: %(msg)s"""
 
898
 
 
899
    def __init__(self, msg):
 
900
        super(NoDiff, self).__init__(msg=msg)
 
901
 
 
902
 
 
903
class NoDiff3(BzrNewError):
 
904
    """Diff3 is not installed on this machine."""
 
905
 
 
906
 
 
907
class ExistingLimbo(BzrNewError):
 
908
    """This tree contains left-over files from a failed operation.
 
909
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
910
    keep, and delete it when you are done.
 
911
    """
 
912
    def __init__(self, limbo_dir):
 
913
       BzrNewError.__init__(self)
 
914
       self.limbo_dir = limbo_dir
 
915
 
 
916
 
 
917
class ImmortalLimbo(BzrNewError):
 
918
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
919
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
920
    keep, and delete it when you are done.
 
921
    """
 
922
    def __init__(self, limbo_dir):
 
923
       BzrNewError.__init__(self)
 
924
       self.limbo_dir = limbo_dir
 
925
 
 
926
 
 
927
class OutOfDateTree(BzrNewError):
 
928
    """Working tree is out of date, please run 'bzr update'."""
 
929
 
 
930
    def __init__(self, tree):
 
931
        BzrNewError.__init__(self)
 
932
        self.tree = tree
 
933
 
 
934
 
 
935
class MergeModifiedFormatError(BzrNewError):
 
936
    """Error in merge modified format"""
 
937
 
 
938
 
 
939
class ConflictFormatError(BzrNewError):
 
940
    """Format error in conflict listings"""
 
941
 
 
942
 
 
943
class CorruptRepository(BzrNewError):
 
944
    """An error has been detected in the repository %(repo_path)s.
 
945
Please run bzr reconcile on this repository."""
 
946
 
 
947
    def __init__(self, repo):
 
948
        BzrNewError.__init__(self)
 
949
        self.repo_path = repo.bzrdir.root_transport.base
 
950
 
 
951
 
 
952
class UpgradeRequired(BzrNewError):
 
953
    """To use this feature you must upgrade your branch at %(path)s."""
 
954
 
 
955
    def __init__(self, path):
 
956
        BzrNewError.__init__(self)
 
957
        self.path = path
 
958
 
 
959
 
 
960
class LocalRequiresBoundBranch(BzrNewError):
 
961
    """Cannot perform local-only commits on unbound branches."""
 
962
 
 
963
 
 
964
class MissingProgressBarFinish(BzrNewError):
 
965
    """A nested progress bar was not 'finished' correctly."""
 
966
 
 
967
 
 
968
class UnsupportedOperation(BzrNewError):
 
969
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
970
    def __init__(self, method, method_self):
 
971
        self.method = method
 
972
        self.mname = method.__name__
 
973
        self.tname = type(method_self).__name__
 
974
 
 
975
 
 
976
class BinaryFile(BzrNewError):
 
977
    """File is binary but should be text."""
 
978
 
 
979
 
 
980
class IllegalPath(BzrNewError):
 
981
    """The path %(path)s is not permitted on this platform"""
 
982
 
 
983
    def __init__(self, path):
 
984
        BzrNewError.__init__(self)
 
985
        self.path = path
 
986
 
 
987
 
 
988
class TestamentMismatch(BzrNewError):
 
989
    """Testament did not match expected value.  
 
990
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
991
       {%(measured)s}
 
992
    """
 
993
    def __init__(self, revision_id, expected, measured):
 
994
        self.revision_id = revision_id
 
995
        self.expected = expected
 
996
        self.measured = measured
 
997
 
 
998
 
 
999
class NotABundle(BzrNewError):
 
1000
    """Not a bzr revision-bundle: %(text)r"""
 
1001
 
 
1002
    def __init__(self, text):
 
1003
        self.text = text
 
1004
 
 
1005
 
 
1006
class BadBundle(Exception): pass
 
1007
 
 
1008
 
 
1009
class MalformedHeader(BadBundle): pass
 
1010
 
 
1011
 
 
1012
class MalformedPatches(BadBundle): pass
 
1013
 
 
1014
 
 
1015
class MalformedFooter(BadBundle): pass