~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Kent Gibson
  • Date: 2006-12-08 12:59:11 UTC
  • mto: (2178.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2179.
  • Revision ID: warthog618@gmail.com-20061208125911-wsnbxy7aydzjb47s
Implement JAM's review suggestions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
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
 
 
20
 
 
21
from bzrlib import symbol_versioning
 
22
from bzrlib.patches import (PatchSyntax, 
 
23
                            PatchConflict, 
 
24
                            MalformedPatchHeader,
 
25
                            MalformedHunkHeader,
 
26
                            MalformedLine,)
 
27
 
 
28
 
 
29
# TODO: is there any value in providing the .args field used by standard
 
30
# python exceptions?   A list of values with no names seems less useful 
 
31
# to me.
 
32
 
 
33
# TODO: Perhaps convert the exception to a string at the moment it's 
 
34
# constructed to make sure it will succeed.  But that says nothing about
 
35
# exceptions that are never raised.
 
36
 
 
37
# TODO: selftest assertRaises should probably also check that every error
 
38
# raised can be formatted as a string successfully, and without giving
 
39
# 'unprintable'.
 
40
 
 
41
 
25
42
class BzrError(StandardError):
26
 
    pass
 
43
    """
 
44
    Base class for errors raised by bzrlib.
 
45
 
 
46
    :cvar internal_error: if true (or absent) this was probably caused by a
 
47
    bzr bug and should be displayed with a traceback; if False this was
 
48
    probably a user or environment error and they don't need the gory details.
 
49
    (That can be overridden by -Derror on the command line.)
 
50
 
 
51
    :cvar _fmt: Format string to display the error; this is expanded
 
52
    by the instance's dict.
 
53
    """
 
54
    
 
55
    internal_error = False
 
56
 
 
57
    def __init__(self, msg=None, **kwds):
 
58
        """Construct a new BzrError.
 
59
 
 
60
        There are two alternative forms for constructing these objects.
 
61
        Either a preformatted string may be passed, or a set of named
 
62
        arguments can be given.  The first is for generic "user" errors which
 
63
        are not intended to be caught and so do not need a specific subclass.
 
64
        The second case is for use with subclasses that provide a _fmt format
 
65
        string to print the arguments.  
 
66
 
 
67
        Keyword arguments are taken as parameters to the error, which can 
 
68
        be inserted into the format string template.  It's recommended 
 
69
        that subclasses override the __init__ method to require specific 
 
70
        parameters.
 
71
 
 
72
        :param msg: If given, this is the literal complete text for the error,
 
73
        not subject to expansion.
 
74
        """
 
75
        StandardError.__init__(self)
 
76
        if msg is not None:
 
77
            # I was going to deprecate this, but it actually turns out to be
 
78
            # quite handy - mbp 20061103.
 
79
            self._preformatted_string = msg
 
80
        else:
 
81
            self._preformatted_string = None
 
82
            for key, value in kwds.items():
 
83
                setattr(self, key, value)
 
84
 
 
85
    def __str__(self):
 
86
        s = getattr(self, '_preformatted_string', None)
 
87
        if s is not None:
 
88
            # contains a preformatted message; must be cast to plain str
 
89
            return str(s)
 
90
        try:
 
91
            fmt = self._get_format_string()
 
92
            if fmt:
 
93
                s = fmt % self.__dict__
 
94
                # __str__() should always return a 'str' object
 
95
                # never a 'unicode' object.
 
96
                if isinstance(s, unicode):
 
97
                    return s.encode('utf8')
 
98
                return s
 
99
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
100
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
 
101
                % (self.__class__.__name__,
 
102
                   self.__dict__,
 
103
                   getattr(self, '_fmt', None),
 
104
                   str(e))
 
105
 
 
106
    def _get_format_string(self):
 
107
        """Return format string for this exception or None"""
 
108
        fmt = getattr(self, '_fmt', None)
 
109
        if fmt is not None:
 
110
            return fmt
 
111
        fmt = getattr(self, '__doc__', None)
 
112
        if fmt is not None:
 
113
            symbol_versioning.warn("%s uses its docstring as a format, "
 
114
                    "it should use _fmt instead" % self.__class__.__name__,
 
115
                    DeprecationWarning)
 
116
            return fmt
 
117
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
118
            % (self.__class__.__name__,
 
119
               self.__dict__,
 
120
               getattr(self, '_fmt', None),
 
121
               )
 
122
 
 
123
 
 
124
class BzrNewError(BzrError):
 
125
    """Deprecated error base class."""
 
126
    # base classes should override the docstring with their human-
 
127
    # readable explanation
 
128
 
 
129
    def __init__(self, *args, **kwds):
 
130
        # XXX: Use the underlying BzrError to always generate the args attribute
 
131
        # if it doesn't exist.  We can't use super here, because exceptions are
 
132
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
133
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
134
             'please convert %s to use BzrError instead' 
 
135
             % self.__class__.__name__,
 
136
             DeprecationWarning,
 
137
             stacklevel=2)
 
138
        BzrError.__init__(self, *args)
 
139
        for key, value in kwds.items():
 
140
            setattr(self, key, value)
 
141
 
 
142
    def __str__(self):
 
143
        try:
 
144
            # __str__() should always return a 'str' object
 
145
            # never a 'unicode' object.
 
146
            s = self.__doc__ % self.__dict__
 
147
            if isinstance(s, unicode):
 
148
                return s.encode('utf8')
 
149
            return s
 
150
        except (TypeError, NameError, ValueError, KeyError), e:
 
151
            return 'Unprintable exception %s(%r): %s' \
 
152
                % (self.__class__.__name__,
 
153
                   self.__dict__, str(e))
 
154
 
 
155
 
 
156
class AlreadyBuilding(BzrError):
 
157
    
 
158
    _fmt = "The tree builder is already building a tree."
 
159
 
27
160
 
28
161
class BzrCheckError(BzrError):
29
 
    pass
30
 
 
 
162
    
 
163
    _fmt = "Internal check failed: %(message)s"
 
164
 
 
165
    internal_error = True
 
166
 
 
167
    def __init__(self, message):
 
168
        BzrError.__init__(self)
 
169
        self.message = message
 
170
 
 
171
 
 
172
class InvalidEntryName(BzrError):
 
173
    
 
174
    _fmt = "Invalid entry name: %(name)s"
 
175
 
 
176
    internal_error = True
 
177
 
 
178
    def __init__(self, name):
 
179
        BzrError.__init__(self)
 
180
        self.name = name
 
181
 
 
182
 
 
183
class InvalidRevisionNumber(BzrError):
 
184
    
 
185
    _fmt = "Invalid revision number %(revno)s"
 
186
 
 
187
    def __init__(self, revno):
 
188
        BzrError.__init__(self)
 
189
        self.revno = revno
 
190
 
 
191
 
 
192
class InvalidRevisionId(BzrError):
 
193
 
 
194
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
195
 
 
196
    def __init__(self, revision_id, branch):
 
197
        # branch can be any string or object with __str__ defined
 
198
        BzrError.__init__(self)
 
199
        self.revision_id = revision_id
 
200
        self.branch = branch
 
201
 
 
202
 
 
203
class NoSuchId(BzrError):
 
204
 
 
205
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
206
    
 
207
    def __init__(self, tree, file_id):
 
208
        BzrError.__init__(self)
 
209
        self.file_id = file_id
 
210
        self.tree = tree
 
211
 
 
212
 
 
213
class InventoryModified(BzrError):
 
214
 
 
215
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
 
216
            "so a clean inventory cannot be read without data loss.")
 
217
 
 
218
    internal_error = True
 
219
 
 
220
    def __init__(self, tree):
 
221
        self.tree = tree
 
222
 
 
223
 
 
224
class NoWorkingTree(BzrError):
 
225
 
 
226
    _fmt = "No WorkingTree exists for %(base)s."
 
227
    
 
228
    def __init__(self, base):
 
229
        BzrError.__init__(self)
 
230
        self.base = base
 
231
 
 
232
 
 
233
class NotBuilding(BzrError):
 
234
 
 
235
    _fmt = "Not currently building a tree."
 
236
 
 
237
 
 
238
class NotLocalUrl(BzrError):
 
239
 
 
240
    _fmt = "%(url)s is not a local path."
 
241
 
 
242
    def __init__(self, url):
 
243
        self.url = url
 
244
 
 
245
 
 
246
class WorkingTreeAlreadyPopulated(BzrError):
 
247
 
 
248
    _fmt = """Working tree already populated in %(base)s"""
 
249
 
 
250
    internal_error = True
 
251
 
 
252
    def __init__(self, base):
 
253
        self.base = base
31
254
 
32
255
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
 
 
 
256
    """Error from user command"""
 
257
 
 
258
    internal_error = False
 
259
 
 
260
    # Error from malformed user command; please avoid raising this as a
 
261
    # generic exception not caused by user input.
 
262
    #
 
263
    # I think it's a waste of effort to differentiate between errors that
 
264
    # are not intended to be caught anyway.  UI code need not subclass
 
265
    # BzrCommandError, and non-UI code should not throw a subclass of
 
266
    # BzrCommandError.  ADHB 20051211
 
267
    def __init__(self, msg):
 
268
        # Object.__str__() must return a real string
 
269
        # returning a Unicode string is a python error.
 
270
        if isinstance(msg, unicode):
 
271
            self.msg = msg.encode('utf8')
 
272
        else:
 
273
            self.msg = msg
 
274
 
 
275
    def __str__(self):
 
276
        return self.msg
 
277
 
 
278
 
 
279
class NotWriteLocked(BzrError):
 
280
 
 
281
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
282
 
 
283
    def __init__(self, not_locked):
 
284
        self.not_locked = not_locked
 
285
 
 
286
 
 
287
class BzrOptionError(BzrCommandError):
 
288
 
 
289
    _fmt = "Error in command line options"
 
290
 
 
291
    
 
292
class StrictCommitFailed(BzrError):
 
293
 
 
294
    _fmt = "Commit refused because there are unknown files in the tree"
 
295
 
 
296
 
 
297
# XXX: Should be unified with TransportError; they seem to represent the
 
298
# same thing
 
299
class PathError(BzrError):
 
300
    
 
301
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
302
 
 
303
    def __init__(self, path, extra=None):
 
304
        BzrError.__init__(self)
 
305
        self.path = path
 
306
        if extra:
 
307
            self.extra = ': ' + str(extra)
 
308
        else:
 
309
            self.extra = ''
 
310
 
 
311
 
 
312
class NoSuchFile(PathError):
 
313
 
 
314
    _fmt = "No such file: %(path)r%(extra)s"
 
315
 
 
316
 
 
317
class FileExists(PathError):
 
318
 
 
319
    _fmt = "File exists: %(path)r%(extra)s"
 
320
 
 
321
 
 
322
class DirectoryNotEmpty(PathError):
 
323
 
 
324
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
325
 
 
326
 
 
327
class ReadingCompleted(BzrError):
 
328
    
 
329
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
330
            "called upon it - the request has been completed and no more "
 
331
            "data may be read.")
 
332
 
 
333
    internal_error = True
 
334
 
 
335
    def __init__(self, request):
 
336
        self.request = request
 
337
 
 
338
 
 
339
class ResourceBusy(PathError):
 
340
 
 
341
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
342
 
 
343
 
 
344
class PermissionDenied(PathError):
 
345
 
 
346
    _fmt = "Permission denied: %(path)r%(extra)s"
 
347
 
 
348
 
 
349
class InvalidURL(PathError):
 
350
 
 
351
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
352
 
 
353
 
 
354
class InvalidURLJoin(PathError):
 
355
 
 
356
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
357
 
 
358
    def __init__(self, msg, base, args):
 
359
        PathError.__init__(self, base, msg)
 
360
        self.args = [base] + list(args)
 
361
 
 
362
 
 
363
class UnsupportedProtocol(PathError):
 
364
 
 
365
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
366
 
 
367
    def __init__(self, url, extra):
 
368
        PathError.__init__(self, url, extra=extra)
 
369
 
 
370
 
 
371
class ShortReadvError(PathError):
 
372
 
 
373
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
374
 
 
375
    internal_error = True
 
376
 
 
377
    def __init__(self, path, offset, length, actual, extra=None):
 
378
        PathError.__init__(self, path, extra=extra)
 
379
        self.offset = offset
 
380
        self.length = length
 
381
        self.actual = actual
 
382
 
 
383
 
 
384
class PathNotChild(BzrError):
 
385
 
 
386
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
387
 
 
388
    internal_error = True
 
389
 
 
390
    def __init__(self, path, base, extra=None):
 
391
        BzrError.__init__(self)
 
392
        self.path = path
 
393
        self.base = base
 
394
        if extra:
 
395
            self.extra = ': ' + str(extra)
 
396
        else:
 
397
            self.extra = ''
 
398
 
 
399
 
 
400
class InvalidNormalization(PathError):
 
401
 
 
402
    _fmt = "Path %(path)r is not unicode normalized"
 
403
 
 
404
 
 
405
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
406
# the exception object is a bit undesirable.
 
407
# TODO: Probably this behavior of should be a common superclass 
 
408
class NotBranchError(PathError):
 
409
 
 
410
    _fmt = "Not a branch: %(path)s"
 
411
 
 
412
    def __init__(self, path):
 
413
       import bzrlib.urlutils as urlutils
 
414
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
415
 
 
416
 
 
417
class AlreadyBranchError(PathError):
 
418
 
 
419
    _fmt = "Already a branch: %(path)s."
 
420
 
 
421
 
 
422
class BranchExistsWithoutWorkingTree(PathError):
 
423
 
 
424
    _fmt = "Directory contains a branch, but no working tree \
 
425
(use bzr checkout if you wish to build a working tree): %(path)s"
 
426
 
 
427
 
 
428
class AtomicFileAlreadyClosed(PathError):
 
429
 
 
430
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
431
 
 
432
    def __init__(self, path, function):
 
433
        PathError.__init__(self, path=path, extra=None)
 
434
        self.function = function
 
435
 
 
436
 
 
437
class InaccessibleParent(PathError):
 
438
 
 
439
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
440
 
 
441
    def __init__(self, path, base):
 
442
        PathError.__init__(self, path)
 
443
        self.base = base
 
444
 
 
445
 
 
446
class NoRepositoryPresent(BzrError):
 
447
 
 
448
    _fmt = "No repository present: %(path)r"
 
449
    def __init__(self, bzrdir):
 
450
        BzrError.__init__(self)
 
451
        self.path = bzrdir.transport.clone('..').base
 
452
 
 
453
 
 
454
class FileInWrongBranch(BzrError):
 
455
 
 
456
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
457
 
 
458
    def __init__(self, branch, path):
 
459
        BzrError.__init__(self)
 
460
        self.branch = branch
 
461
        self.branch_base = branch.base
 
462
        self.path = path
 
463
 
 
464
 
 
465
class UnsupportedFormatError(BzrError):
 
466
    
 
467
    _fmt = "Unsupported branch format: %(format)s"
 
468
 
 
469
 
 
470
class UnknownFormatError(BzrError):
 
471
    
 
472
    _fmt = "Unknown branch format: %(format)r"
 
473
 
 
474
 
 
475
class IncompatibleFormat(BzrError):
 
476
    
 
477
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
478
 
 
479
    def __init__(self, format, bzrdir_format):
 
480
        BzrError.__init__(self)
 
481
        self.format = format
 
482
        self.bzrdir = bzrdir_format
 
483
 
 
484
 
 
485
class IncompatibleRevision(BzrError):
 
486
    
 
487
    _fmt = "Revision is not compatible with %(repo_format)s"
 
488
 
 
489
    def __init__(self, repo_format):
 
490
        BzrError.__init__(self)
 
491
        self.repo_format = repo_format
 
492
 
 
493
 
 
494
class NotVersionedError(BzrError):
 
495
 
 
496
    _fmt = "%(path)s is not versioned"
 
497
 
 
498
    def __init__(self, path):
 
499
        BzrError.__init__(self)
 
500
        self.path = path
 
501
 
 
502
 
 
503
class PathsNotVersionedError(BzrError):
 
504
    # used when reporting several paths are not versioned
 
505
 
 
506
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
507
 
 
508
    def __init__(self, paths):
 
509
        from bzrlib.osutils import quotefn
 
510
        BzrError.__init__(self)
 
511
        self.paths = paths
 
512
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
513
 
 
514
 
 
515
class PathsDoNotExist(BzrError):
 
516
 
 
517
    _fmt = "Path(s) do not exist: %(paths_as_string)s"
 
518
 
 
519
    # used when reporting that paths are neither versioned nor in the working
 
520
    # tree
 
521
 
 
522
    def __init__(self, paths):
 
523
        # circular import
 
524
        from bzrlib.osutils import quotefn
 
525
        BzrError.__init__(self)
 
526
        self.paths = paths
 
527
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
528
 
 
529
 
 
530
class BadFileKindError(BzrError):
 
531
 
 
532
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
533
 
 
534
 
 
535
class ForbiddenControlFileError(BzrError):
 
536
 
 
537
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
538
 
 
539
 
 
540
class LockError(BzrError):
 
541
 
 
542
    _fmt = "Lock error: %(message)s"
 
543
 
 
544
    # All exceptions from the lock/unlock functions should be from
 
545
    # this exception class.  They will be translated as necessary. The
 
546
    # original exception is available as e.original_error
 
547
    #
 
548
    # New code should prefer to raise specific subclasses
 
549
    def __init__(self, message):
 
550
        self.message = message
 
551
 
 
552
 
 
553
class CommitNotPossible(LockError):
 
554
 
 
555
    _fmt = "A commit was attempted but we do not have a write lock open."
 
556
 
 
557
    def __init__(self):
 
558
        pass
 
559
 
 
560
 
 
561
class AlreadyCommitted(LockError):
 
562
 
 
563
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
564
 
 
565
    def __init__(self):
 
566
        pass
 
567
 
 
568
 
 
569
class ReadOnlyError(LockError):
 
570
 
 
571
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
572
 
 
573
    def __init__(self, obj):
 
574
        self.obj = obj
 
575
 
 
576
 
 
577
class OutSideTransaction(BzrError):
 
578
 
 
579
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
580
 
 
581
 
 
582
class ObjectNotLocked(LockError):
 
583
 
 
584
    _fmt = "%(obj)r is not locked"
 
585
 
 
586
    internal_error = True
 
587
 
 
588
    # this can indicate that any particular object is not locked; see also
 
589
    # LockNotHeld which means that a particular *lock* object is not held by
 
590
    # the caller -- perhaps they should be unified.
 
591
    def __init__(self, obj):
 
592
        self.obj = obj
 
593
 
 
594
 
 
595
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
596
 
 
597
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
598
 
 
599
    def __init__(self, obj):
 
600
        self.obj = obj
 
601
 
 
602
 
 
603
class UnlockableTransport(LockError):
 
604
 
 
605
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
606
 
 
607
    def __init__(self, transport):
 
608
        self.transport = transport
 
609
 
 
610
 
 
611
class LockContention(LockError):
 
612
 
 
613
    _fmt = "Could not acquire lock %(lock)s"
 
614
    # TODO: show full url for lock, combining the transport and relative bits?
 
615
    
 
616
    def __init__(self, lock):
 
617
        self.lock = lock
 
618
 
 
619
 
 
620
class LockBroken(LockError):
 
621
 
 
622
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
623
 
 
624
    def __init__(self, lock):
 
625
        self.lock = lock
 
626
 
 
627
 
 
628
class LockBreakMismatch(LockError):
 
629
 
 
630
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
631
 
 
632
    def __init__(self, lock, holder, target):
 
633
        self.lock = lock
 
634
        self.holder = holder
 
635
        self.target = target
 
636
 
 
637
 
 
638
class LockNotHeld(LockError):
 
639
 
 
640
    _fmt = "Lock not held: %(lock)s"
 
641
 
 
642
    def __init__(self, lock):
 
643
        self.lock = lock
 
644
 
 
645
 
 
646
class PointlessCommit(BzrError):
 
647
 
 
648
    _fmt = "No changes to commit"
 
649
 
 
650
 
 
651
class UpgradeReadonly(BzrError):
 
652
 
 
653
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
654
 
 
655
 
 
656
class UpToDateFormat(BzrError):
 
657
 
 
658
    _fmt = "The branch format %(format)s is already at the most recent format."
 
659
 
 
660
    def __init__(self, format):
 
661
        BzrError.__init__(self)
 
662
        self.format = format
 
663
 
 
664
 
 
665
class StrictCommitFailed(Exception):
 
666
 
 
667
    _fmt = "Commit refused because there are unknowns in the tree."
 
668
 
 
669
 
 
670
class NoSuchRevision(BzrError):
 
671
 
 
672
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
673
 
 
674
    internal_error = True
 
675
 
 
676
    def __init__(self, branch, revision):
 
677
        BzrError.__init__(self, branch=branch, revision=revision)
 
678
 
 
679
 
 
680
class NoSuchRevisionSpec(BzrError):
 
681
 
 
682
    _fmt = "No namespace registered for string: %(spec)r"
 
683
 
 
684
    def __init__(self, spec):
 
685
        BzrError.__init__(self, spec=spec)
 
686
 
 
687
 
 
688
class InvalidRevisionSpec(BzrError):
 
689
 
 
690
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
691
 
 
692
    def __init__(self, spec, branch, extra=None):
 
693
        BzrError.__init__(self, branch=branch, spec=spec)
 
694
        if extra:
 
695
            self.extra = '\n' + str(extra)
 
696
        else:
 
697
            self.extra = ''
 
698
 
 
699
 
 
700
class HistoryMissing(BzrError):
 
701
 
 
702
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
703
 
 
704
 
 
705
class DivergedBranches(BzrError):
 
706
    
 
707
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
708
 
 
709
    internal_error = False
 
710
 
 
711
    def __init__(self, branch1, branch2):
 
712
        self.branch1 = branch1
 
713
        self.branch2 = branch2
 
714
 
 
715
 
 
716
class UnrelatedBranches(BzrError):
 
717
 
 
718
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
719
 
 
720
    internal_error = False
 
721
 
 
722
 
 
723
class NoCommonAncestor(BzrError):
 
724
    
 
725
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
726
 
 
727
    def __init__(self, revision_a, revision_b):
 
728
        self.revision_a = revision_a
 
729
        self.revision_b = revision_b
 
730
 
 
731
 
 
732
class NoCommonRoot(BzrError):
 
733
 
 
734
    _fmt = "Revisions are not derived from the same root: " \
 
735
           "%(revision_a)s %(revision_b)s."
 
736
 
 
737
    def __init__(self, revision_a, revision_b):
 
738
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
739
 
 
740
 
 
741
class NotAncestor(BzrError):
 
742
 
 
743
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
744
 
 
745
    def __init__(self, rev_id, not_ancestor_id):
 
746
        BzrError.__init__(self, rev_id=rev_id,
 
747
            not_ancestor_id=not_ancestor_id)
 
748
 
 
749
 
 
750
class InstallFailed(BzrError):
 
751
 
 
752
    def __init__(self, revisions):
 
753
        revision_str = ", ".join(str(r) for r in revisions)
 
754
        msg = "Could not install revisions:\n%s" % revision_str
 
755
        BzrError.__init__(self, msg)
 
756
        self.revisions = revisions
 
757
 
 
758
 
 
759
class AmbiguousBase(BzrError):
 
760
 
 
761
    def __init__(self, bases):
 
762
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
763
                DeprecationWarning)
 
764
        msg = "The correct base is unclear, because %s are all equally close" %\
 
765
            ", ".join(bases)
 
766
        BzrError.__init__(self, msg)
 
767
        self.bases = bases
 
768
 
 
769
 
 
770
class NoCommits(BzrError):
 
771
 
 
772
    _fmt = "Branch %(branch)s has no commits."
 
773
 
 
774
    def __init__(self, branch):
 
775
        BzrError.__init__(self, branch=branch)
 
776
 
 
777
 
 
778
class UnlistableStore(BzrError):
 
779
 
 
780
    def __init__(self, store):
 
781
        BzrError.__init__(self, "Store %s is not listable" % store)
 
782
 
 
783
 
 
784
 
 
785
class UnlistableBranch(BzrError):
 
786
 
 
787
    def __init__(self, br):
 
788
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
789
 
 
790
 
 
791
class BoundBranchOutOfDate(BzrError):
 
792
 
 
793
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
794
 
 
795
    def __init__(self, branch, master):
 
796
        BzrError.__init__(self)
 
797
        self.branch = branch
 
798
        self.master = master
 
799
 
 
800
        
 
801
class CommitToDoubleBoundBranch(BzrError):
 
802
 
 
803
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
804
 
 
805
    def __init__(self, branch, master, remote):
 
806
        BzrError.__init__(self)
 
807
        self.branch = branch
 
808
        self.master = master
 
809
        self.remote = remote
 
810
 
 
811
 
 
812
class OverwriteBoundBranch(BzrError):
 
813
 
 
814
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
815
 
 
816
    def __init__(self, branch):
 
817
        BzrError.__init__(self)
 
818
        self.branch = branch
 
819
 
 
820
 
 
821
class BoundBranchConnectionFailure(BzrError):
 
822
 
 
823
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
824
 
 
825
    def __init__(self, branch, target, error):
 
826
        BzrError.__init__(self)
 
827
        self.branch = branch
 
828
        self.target = target
 
829
        self.error = error
 
830
 
 
831
 
 
832
class WeaveError(BzrError):
 
833
 
 
834
    _fmt = "Error in processing weave: %(message)s"
 
835
 
 
836
    def __init__(self, message=None):
 
837
        BzrError.__init__(self)
 
838
        self.message = message
 
839
 
 
840
 
 
841
class WeaveRevisionAlreadyPresent(WeaveError):
 
842
 
 
843
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
844
 
 
845
    def __init__(self, revision_id, weave):
 
846
 
 
847
        WeaveError.__init__(self)
 
848
        self.revision_id = revision_id
 
849
        self.weave = weave
 
850
 
 
851
 
 
852
class WeaveRevisionNotPresent(WeaveError):
 
853
 
 
854
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
855
 
 
856
    def __init__(self, revision_id, weave):
 
857
        WeaveError.__init__(self)
 
858
        self.revision_id = revision_id
 
859
        self.weave = weave
 
860
 
 
861
 
 
862
class WeaveFormatError(WeaveError):
 
863
 
 
864
    _fmt = "Weave invariant violated: %(what)s"
 
865
 
 
866
    def __init__(self, what):
 
867
        WeaveError.__init__(self)
 
868
        self.what = what
 
869
 
 
870
 
 
871
class WeaveParentMismatch(WeaveError):
 
872
 
 
873
    _fmt = "Parents are mismatched between two revisions."
 
874
    
 
875
 
 
876
class WeaveInvalidChecksum(WeaveError):
 
877
 
 
878
    _fmt = "Text did not match it's checksum: %(message)s"
 
879
 
 
880
 
 
881
class WeaveTextDiffers(WeaveError):
 
882
 
 
883
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
884
 
 
885
    def __init__(self, revision_id, weave_a, weave_b):
 
886
        WeaveError.__init__(self)
 
887
        self.revision_id = revision_id
 
888
        self.weave_a = weave_a
 
889
        self.weave_b = weave_b
 
890
 
 
891
 
 
892
class WeaveTextDiffers(WeaveError):
 
893
 
 
894
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
895
 
 
896
    def __init__(self, revision_id, weave_a, weave_b):
 
897
        WeaveError.__init__(self)
 
898
        self.revision_id = revision_id
 
899
        self.weave_a = weave_a
 
900
        self.weave_b = weave_b
 
901
 
 
902
 
 
903
class VersionedFileError(BzrError):
 
904
    
 
905
    _fmt = "Versioned file error"
 
906
 
 
907
 
 
908
class RevisionNotPresent(VersionedFileError):
 
909
    
 
910
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
911
 
 
912
    def __init__(self, revision_id, file_id):
 
913
        VersionedFileError.__init__(self)
 
914
        self.revision_id = revision_id
 
915
        self.file_id = file_id
 
916
 
 
917
 
 
918
class RevisionAlreadyPresent(VersionedFileError):
 
919
    
 
920
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
921
 
 
922
    def __init__(self, revision_id, file_id):
 
923
        VersionedFileError.__init__(self)
 
924
        self.revision_id = revision_id
 
925
        self.file_id = file_id
 
926
 
 
927
 
 
928
class KnitError(BzrError):
 
929
    
 
930
    _fmt = "Knit error"
 
931
 
 
932
 
 
933
class KnitHeaderError(KnitError):
 
934
 
 
935
    _fmt = "Knit header error: %(badline)r unexpected"
 
936
 
 
937
    def __init__(self, badline):
 
938
        KnitError.__init__(self)
 
939
        self.badline = badline
 
940
 
 
941
 
 
942
class KnitCorrupt(KnitError):
 
943
 
 
944
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
945
 
 
946
    def __init__(self, filename, how):
 
947
        KnitError.__init__(self)
 
948
        self.filename = filename
 
949
        self.how = how
 
950
 
 
951
 
 
952
class NoSuchExportFormat(BzrError):
 
953
    
 
954
    _fmt = "Export format %(format)r not supported"
 
955
 
 
956
    def __init__(self, format):
 
957
        BzrError.__init__(self)
 
958
        self.format = format
 
959
 
 
960
 
 
961
class TransportError(BzrError):
 
962
    
 
963
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
964
 
 
965
    def __init__(self, msg=None, orig_error=None):
 
966
        if msg is None and orig_error is not None:
 
967
            msg = str(orig_error)
 
968
        if orig_error is None:
 
969
            orig_error = ''
 
970
        if msg is None:
 
971
            msg =  ''
 
972
        self.msg = msg
 
973
        self.orig_error = orig_error
 
974
        BzrError.__init__(self)
 
975
 
 
976
 
 
977
class TooManyConcurrentRequests(BzrError):
 
978
 
 
979
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
980
            "Be sure to finish_writing and finish_reading on the "
 
981
            "current request that is open.")
 
982
 
 
983
    internal_error = True
 
984
 
 
985
    def __init__(self, medium):
 
986
        self.medium = medium
 
987
 
 
988
 
 
989
class SmartProtocolError(TransportError):
 
990
 
 
991
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
992
 
 
993
    def __init__(self, details):
 
994
        self.details = details
 
995
 
 
996
 
 
997
# A set of semi-meaningful errors which can be thrown
 
998
class TransportNotPossible(TransportError):
 
999
 
 
1000
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1001
 
 
1002
 
 
1003
class ConnectionError(TransportError):
 
1004
 
 
1005
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1006
 
 
1007
 
 
1008
class SocketConnectionError(ConnectionError):
 
1009
 
 
1010
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1011
 
 
1012
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1013
        if msg is None:
 
1014
            msg = 'Failed to connect to'
 
1015
        if orig_error is None:
 
1016
            orig_error = ''
 
1017
        else:
 
1018
            orig_error = '; ' + str(orig_error)
 
1019
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1020
        self.host = host
 
1021
        if port is None:
 
1022
            self.port = ''
 
1023
        else:
 
1024
            self.port = ':%s' % port
 
1025
 
 
1026
 
 
1027
class ConnectionReset(TransportError):
 
1028
 
 
1029
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1030
 
 
1031
 
 
1032
class InvalidRange(TransportError):
 
1033
 
 
1034
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1035
    
 
1036
    def __init__(self, path, offset):
 
1037
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1038
                                       % (path, offset)))
 
1039
        self.path = path
 
1040
        self.offset = offset
 
1041
 
 
1042
 
 
1043
class InvalidHttpResponse(TransportError):
 
1044
 
 
1045
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1046
 
 
1047
    def __init__(self, path, msg, orig_error=None):
 
1048
        self.path = path
 
1049
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1050
 
 
1051
 
 
1052
class InvalidHttpRange(InvalidHttpResponse):
 
1053
 
 
1054
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1055
    
 
1056
    def __init__(self, path, range, msg):
 
1057
        self.range = range
 
1058
        InvalidHttpResponse.__init__(self, path, msg)
 
1059
 
 
1060
 
 
1061
class InvalidHttpContentType(InvalidHttpResponse):
 
1062
 
 
1063
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1064
    
 
1065
    def __init__(self, path, ctype, msg):
 
1066
        self.ctype = ctype
 
1067
        InvalidHttpResponse.__init__(self, path, msg)
 
1068
 
 
1069
 
 
1070
class ConflictsInTree(BzrError):
 
1071
 
 
1072
    _fmt = "Working tree has conflicts."
 
1073
 
 
1074
 
 
1075
class ParseConfigError(BzrError):
 
1076
 
 
1077
    def __init__(self, errors, filename):
 
1078
        if filename is None:
 
1079
            filename = ""
 
1080
        message = "Error(s) parsing config file %s:\n%s" % \
 
1081
            (filename, ('\n'.join(e.message for e in errors)))
 
1082
        BzrError.__init__(self, message)
 
1083
 
 
1084
 
 
1085
class NoEmailInUsername(BzrError):
 
1086
 
 
1087
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1088
 
 
1089
    def __init__(self, username):
 
1090
        BzrError.__init__(self)
 
1091
        self.username = username
 
1092
 
 
1093
 
 
1094
class SigningFailed(BzrError):
 
1095
 
 
1096
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1097
 
 
1098
    def __init__(self, command_line):
 
1099
        BzrError.__init__(self, command_line=command_line)
 
1100
 
 
1101
 
 
1102
class WorkingTreeNotRevision(BzrError):
 
1103
 
 
1104
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1105
            " the last commit, but weave merge requires that it be"
 
1106
            " unchanged")
 
1107
 
 
1108
    def __init__(self, tree):
 
1109
        BzrError.__init__(self, basedir=tree.basedir)
 
1110
 
 
1111
 
 
1112
class CantReprocessAndShowBase(BzrError):
 
1113
 
 
1114
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
1115
           "the relationship of conflicting lines to the base"
 
1116
 
 
1117
 
 
1118
class GraphCycleError(BzrError):
 
1119
 
 
1120
    _fmt = "Cycle in graph %(graph)r"
 
1121
 
 
1122
    def __init__(self, graph):
 
1123
        BzrError.__init__(self)
 
1124
        self.graph = graph
 
1125
 
 
1126
 
 
1127
class WritingCompleted(BzrError):
 
1128
 
 
1129
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1130
            "called upon it - accept bytes may not be called anymore.")
 
1131
 
 
1132
    internal_error = True
 
1133
 
 
1134
    def __init__(self, request):
 
1135
        self.request = request
 
1136
 
 
1137
 
 
1138
class WritingNotComplete(BzrError):
 
1139
 
 
1140
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1141
            "called upon it - until the write phase is complete no "
 
1142
            "data may be read.")
 
1143
 
 
1144
    internal_error = True
 
1145
 
 
1146
    def __init__(self, request):
 
1147
        self.request = request
 
1148
 
 
1149
 
 
1150
class NotConflicted(BzrError):
 
1151
 
 
1152
    _fmt = "File %(filename)s is not conflicted."
 
1153
 
 
1154
    def __init__(self, filename):
 
1155
        BzrError.__init__(self)
 
1156
        self.filename = filename
 
1157
 
 
1158
 
 
1159
class MediumNotConnected(BzrError):
 
1160
 
 
1161
    _fmt = """The medium '%(medium)s' is not connected."""
 
1162
 
 
1163
    internal_error = True
 
1164
 
 
1165
    def __init__(self, medium):
 
1166
        self.medium = medium
 
1167
 
 
1168
 
 
1169
class MustUseDecorated(Exception):
 
1170
    
 
1171
    _fmt = """A decorating function has requested its original command be used."""
 
1172
    
 
1173
 
 
1174
class NoBundleFound(BzrError):
 
1175
 
 
1176
    _fmt = "No bundle was found in %(filename)s"
 
1177
 
 
1178
    def __init__(self, filename):
 
1179
        BzrError.__init__(self)
 
1180
        self.filename = filename
 
1181
 
 
1182
 
 
1183
class BundleNotSupported(BzrError):
 
1184
 
 
1185
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1186
 
 
1187
    def __init__(self, version, msg):
 
1188
        BzrError.__init__(self)
 
1189
        self.version = version
 
1190
        self.msg = msg
 
1191
 
 
1192
 
 
1193
class MissingText(BzrError):
 
1194
 
 
1195
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1196
 
 
1197
    def __init__(self, branch, text_revision, file_id):
 
1198
        BzrError.__init__(self)
 
1199
        self.branch = branch
 
1200
        self.base = branch.base
 
1201
        self.text_revision = text_revision
 
1202
        self.file_id = file_id
 
1203
 
 
1204
 
 
1205
class DuplicateKey(BzrError):
 
1206
 
 
1207
    _fmt = "Key %(key)s is already present in map"
 
1208
 
 
1209
 
 
1210
class MalformedTransform(BzrError):
 
1211
 
 
1212
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1213
 
 
1214
 
 
1215
class NoFinalPath(BzrError):
 
1216
 
 
1217
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1218
            "file-id: %(file_id)r\n"
 
1219
            "root trans-id: %(root_trans_id)r\n")
 
1220
 
 
1221
    def __init__(self, trans_id, transform):
 
1222
        self.trans_id = trans_id
 
1223
        self.file_id = transform.final_file_id(trans_id)
 
1224
        self.root_trans_id = transform.root
 
1225
 
 
1226
 
 
1227
class BzrBadParameter(BzrError):
 
1228
 
 
1229
    _fmt = "Bad parameter: %(param)r"
 
1230
 
 
1231
    # This exception should never be thrown, but it is a base class for all
 
1232
    # parameter-to-function errors.
 
1233
 
 
1234
    def __init__(self, param):
 
1235
        BzrError.__init__(self)
 
1236
        self.param = param
 
1237
 
 
1238
 
 
1239
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1240
 
 
1241
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1242
 
 
1243
 
 
1244
class ReusingTransform(BzrError):
 
1245
 
 
1246
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1247
 
 
1248
 
 
1249
class CantMoveRoot(BzrError):
 
1250
 
 
1251
    _fmt = "Moving the root directory is not supported at this time"
 
1252
 
 
1253
 
 
1254
class BzrBadParameterNotString(BzrBadParameter):
 
1255
 
 
1256
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1257
 
 
1258
 
 
1259
class BzrBadParameterMissing(BzrBadParameter):
 
1260
 
 
1261
    _fmt = "Parameter $(param)s is required but not present."
 
1262
 
 
1263
 
 
1264
class BzrBadParameterUnicode(BzrBadParameter):
 
1265
 
 
1266
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
1267
 
 
1268
 
 
1269
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1270
 
 
1271
    _fmt = "Parameter %(param)s contains a newline."
 
1272
 
 
1273
 
 
1274
class DependencyNotPresent(BzrError):
 
1275
 
 
1276
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1277
 
 
1278
    def __init__(self, library, error):
 
1279
        BzrError.__init__(self, library=library, error=error)
 
1280
 
 
1281
 
 
1282
class ParamikoNotPresent(DependencyNotPresent):
 
1283
 
 
1284
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1285
 
 
1286
    def __init__(self, error):
 
1287
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1288
 
 
1289
 
 
1290
class PointlessMerge(BzrError):
 
1291
 
 
1292
    _fmt = "Nothing to merge."
 
1293
 
 
1294
 
 
1295
class UninitializableFormat(BzrError):
 
1296
 
 
1297
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1298
 
 
1299
    def __init__(self, format):
 
1300
        BzrError.__init__(self)
 
1301
        self.format = format
 
1302
 
 
1303
 
 
1304
class BadConversionTarget(BzrError):
 
1305
 
 
1306
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1307
 
 
1308
    def __init__(self, problem, format):
 
1309
        BzrError.__init__(self)
 
1310
        self.problem = problem
 
1311
        self.format = format
 
1312
 
 
1313
 
 
1314
class NoDiff(BzrError):
 
1315
 
 
1316
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1317
 
 
1318
    def __init__(self, msg):
 
1319
        BzrError.__init__(self, msg=msg)
 
1320
 
 
1321
 
 
1322
class NoDiff3(BzrError):
 
1323
 
 
1324
    _fmt = "Diff3 is not installed on this machine."
 
1325
 
 
1326
 
 
1327
class ExistingLimbo(BzrError):
 
1328
 
 
1329
    _fmt = """This tree contains left-over files from a failed operation.
 
1330
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1331
    keep, and delete it when you are done."""
 
1332
    
 
1333
    def __init__(self, limbo_dir):
 
1334
       BzrError.__init__(self)
 
1335
       self.limbo_dir = limbo_dir
 
1336
 
 
1337
 
 
1338
class ImmortalLimbo(BzrError):
 
1339
 
 
1340
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1341
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1342
    keep, and delete it when you are done."""
 
1343
 
 
1344
    def __init__(self, limbo_dir):
 
1345
       BzrError.__init__(self)
 
1346
       self.limbo_dir = limbo_dir
 
1347
 
 
1348
 
 
1349
class OutOfDateTree(BzrError):
 
1350
 
 
1351
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1352
 
 
1353
    def __init__(self, tree):
 
1354
        BzrError.__init__(self)
 
1355
        self.tree = tree
 
1356
 
 
1357
 
 
1358
class MergeModifiedFormatError(BzrError):
 
1359
 
 
1360
    _fmt = "Error in merge modified format"
 
1361
 
 
1362
 
 
1363
class ConflictFormatError(BzrError):
 
1364
 
 
1365
    _fmt = "Format error in conflict listings"
 
1366
 
 
1367
 
 
1368
class CorruptRepository(BzrError):
 
1369
 
 
1370
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
1371
Please run bzr reconcile on this repository."""
 
1372
 
 
1373
    def __init__(self, repo):
 
1374
        BzrError.__init__(self)
 
1375
        self.repo_path = repo.bzrdir.root_transport.base
 
1376
 
 
1377
 
 
1378
class UpgradeRequired(BzrError):
 
1379
 
 
1380
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1381
 
 
1382
    def __init__(self, path):
 
1383
        BzrError.__init__(self)
 
1384
        self.path = path
 
1385
 
 
1386
 
 
1387
class LocalRequiresBoundBranch(BzrError):
 
1388
 
 
1389
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1390
 
 
1391
 
 
1392
class MissingProgressBarFinish(BzrError):
 
1393
 
 
1394
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1395
 
 
1396
 
 
1397
class InvalidProgressBarType(BzrError):
 
1398
 
 
1399
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1400
Select one of: %(valid_types)s"""
 
1401
 
 
1402
    def __init__(self, bar_type, valid_types):
 
1403
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1404
 
 
1405
 
 
1406
class UnsupportedOperation(BzrError):
 
1407
 
 
1408
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
1409
 
 
1410
    def __init__(self, method, method_self):
 
1411
        self.method = method
 
1412
        self.mname = method.__name__
 
1413
        self.tname = type(method_self).__name__
 
1414
 
 
1415
 
 
1416
class BinaryFile(BzrError):
 
1417
    
 
1418
    _fmt = "File is binary but should be text."
 
1419
 
 
1420
 
 
1421
class IllegalPath(BzrError):
 
1422
 
 
1423
    _fmt = "The path %(path)s is not permitted on this platform"
 
1424
 
 
1425
    def __init__(self, path):
 
1426
        BzrError.__init__(self)
 
1427
        self.path = path
 
1428
 
 
1429
 
 
1430
class TestamentMismatch(BzrError):
 
1431
 
 
1432
    _fmt = """Testament did not match expected value.  
 
1433
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1434
       {%(measured)s}"""
 
1435
 
 
1436
    def __init__(self, revision_id, expected, measured):
 
1437
        self.revision_id = revision_id
 
1438
        self.expected = expected
 
1439
        self.measured = measured
 
1440
 
 
1441
 
 
1442
class NotABundle(BzrError):
 
1443
    
 
1444
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1445
 
 
1446
    def __init__(self, text):
 
1447
        BzrError.__init__(self)
 
1448
        self.text = text
 
1449
 
 
1450
 
 
1451
class BadBundle(BzrError): 
 
1452
    
 
1453
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1454
 
 
1455
    def __init__(self, text):
 
1456
        BzrError.__init__(self)
 
1457
        self.text = text
 
1458
 
 
1459
 
 
1460
class MalformedHeader(BadBundle): 
 
1461
    
 
1462
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1463
 
 
1464
 
 
1465
class MalformedPatches(BadBundle): 
 
1466
    
 
1467
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1468
 
 
1469
 
 
1470
class MalformedFooter(BadBundle): 
 
1471
    
 
1472
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1473
 
 
1474
 
 
1475
class UnsupportedEOLMarker(BadBundle):
 
1476
    
 
1477
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1478
 
 
1479
    def __init__(self):
 
1480
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1481
        # but for this there is not
 
1482
        BzrError.__init__(self)
 
1483
 
 
1484
 
 
1485
class IncompatibleBundleFormat(BzrError):
 
1486
    
 
1487
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1488
 
 
1489
    def __init__(self, bundle_format, other):
 
1490
        BzrError.__init__(self)
 
1491
        self.bundle_format = bundle_format
 
1492
        self.other = other
 
1493
 
 
1494
 
 
1495
class BadInventoryFormat(BzrError):
 
1496
    
 
1497
    _fmt = "Root class for inventory serialization errors"
 
1498
 
 
1499
 
 
1500
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1501
 
 
1502
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1503
 
 
1504
    def __init__(self, msg):
 
1505
        BadInventoryFormat.__init__(self, msg=msg)
 
1506
 
 
1507
 
 
1508
class NoSmartMedium(BzrError):
 
1509
 
 
1510
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1511
 
 
1512
    def __init__(self, transport):
 
1513
        self.transport = transport
 
1514
 
 
1515
 
 
1516
class NoSmartServer(NotBranchError):
 
1517
 
 
1518
    _fmt = "No smart server available at %(url)s"
 
1519
 
 
1520
    def __init__(self, url):
 
1521
        self.url = url
 
1522
 
 
1523
 
 
1524
class UnknownSSH(BzrError):
 
1525
 
 
1526
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1527
 
 
1528
    def __init__(self, vendor):
 
1529
        BzrError.__init__(self)
 
1530
        self.vendor = vendor
 
1531
 
 
1532
 
 
1533
class GhostRevisionUnusableHere(BzrError):
 
1534
 
 
1535
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1536
 
 
1537
    def __init__(self, revision_id):
 
1538
        BzrError.__init__(self)
 
1539
        self.revision_id = revision_id
 
1540
 
 
1541
 
 
1542
class IllegalUseOfScopeReplacer(BzrError):
 
1543
 
 
1544
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
1545
 
 
1546
    internal_error = True
 
1547
 
 
1548
    def __init__(self, name, msg, extra=None):
 
1549
        BzrError.__init__(self)
 
1550
        self.name = name
 
1551
        self.msg = msg
 
1552
        if extra:
 
1553
            self.extra = ': ' + str(extra)
 
1554
        else:
 
1555
            self.extra = ''
 
1556
 
 
1557
 
 
1558
class InvalidImportLine(BzrError):
 
1559
 
 
1560
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1561
 
 
1562
    internal_error = True
 
1563
 
 
1564
    def __init__(self, text, msg):
 
1565
        BzrError.__init__(self)
 
1566
        self.text = text
 
1567
        self.msg = msg
 
1568
 
 
1569
 
 
1570
class ImportNameCollision(BzrError):
 
1571
 
 
1572
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
1573
 
 
1574
    internal_error = True
 
1575
 
 
1576
    def __init__(self, name):
 
1577
        BzrError.__init__(self)
 
1578
        self.name = name