/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2007-01-09 15:19:18 UTC
  • mto: This revision was merged to the branch mainline in revision 2240.
  • Revision ID: abentley@panoramicfeedback.com-20070109151918-cs36mdp2wrjnn3ax
Add suggestion to HACKING

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
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
 
 
42
class BzrError(StandardError):
 
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
 
 
160
 
 
161
class BzrCheckError(BzrError):
 
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
 
254
 
 
255
class BzrCommandError(BzrError):
 
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 BadOptionValue(BzrError):
 
293
 
 
294
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
295
 
 
296
    def __init__(self, name, value):
 
297
        BzrError.__init__(self, name=name, value=value)
 
298
 
 
299
    
 
300
class StrictCommitFailed(BzrError):
 
301
 
 
302
    _fmt = "Commit refused because there are unknown files in the tree"
 
303
 
 
304
 
 
305
# XXX: Should be unified with TransportError; they seem to represent the
 
306
# same thing
 
307
class PathError(BzrError):
 
308
    
 
309
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
310
 
 
311
    def __init__(self, path, extra=None):
 
312
        BzrError.__init__(self)
 
313
        self.path = path
 
314
        if extra:
 
315
            self.extra = ': ' + str(extra)
 
316
        else:
 
317
            self.extra = ''
 
318
 
 
319
 
 
320
class NoSuchFile(PathError):
 
321
 
 
322
    _fmt = "No such file: %(path)r%(extra)s"
 
323
 
 
324
 
 
325
class FileExists(PathError):
 
326
 
 
327
    _fmt = "File exists: %(path)r%(extra)s"
 
328
 
 
329
 
 
330
class DirectoryNotEmpty(PathError):
 
331
 
 
332
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
333
 
 
334
 
 
335
class ReadingCompleted(BzrError):
 
336
    
 
337
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
338
            "called upon it - the request has been completed and no more "
 
339
            "data may be read.")
 
340
 
 
341
    internal_error = True
 
342
 
 
343
    def __init__(self, request):
 
344
        self.request = request
 
345
 
 
346
 
 
347
class ResourceBusy(PathError):
 
348
 
 
349
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
350
 
 
351
 
 
352
class PermissionDenied(PathError):
 
353
 
 
354
    _fmt = "Permission denied: %(path)r%(extra)s"
 
355
 
 
356
 
 
357
class InvalidURL(PathError):
 
358
 
 
359
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
360
 
 
361
 
 
362
class InvalidURLJoin(PathError):
 
363
 
 
364
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
365
 
 
366
    def __init__(self, msg, base, args):
 
367
        PathError.__init__(self, base, msg)
 
368
        self.args = [base] + list(args)
 
369
 
 
370
 
 
371
class UnsupportedProtocol(PathError):
 
372
 
 
373
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
374
 
 
375
    def __init__(self, url, extra):
 
376
        PathError.__init__(self, url, extra=extra)
 
377
 
 
378
 
 
379
class ShortReadvError(PathError):
 
380
 
 
381
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
382
 
 
383
    internal_error = True
 
384
 
 
385
    def __init__(self, path, offset, length, actual, extra=None):
 
386
        PathError.__init__(self, path, extra=extra)
 
387
        self.offset = offset
 
388
        self.length = length
 
389
        self.actual = actual
 
390
 
 
391
 
 
392
class PathNotChild(BzrError):
 
393
 
 
394
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
395
 
 
396
    internal_error = True
 
397
 
 
398
    def __init__(self, path, base, extra=None):
 
399
        BzrError.__init__(self)
 
400
        self.path = path
 
401
        self.base = base
 
402
        if extra:
 
403
            self.extra = ': ' + str(extra)
 
404
        else:
 
405
            self.extra = ''
 
406
 
 
407
 
 
408
class InvalidNormalization(PathError):
 
409
 
 
410
    _fmt = "Path %(path)r is not unicode normalized"
 
411
 
 
412
 
 
413
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
414
# the exception object is a bit undesirable.
 
415
# TODO: Probably this behavior of should be a common superclass 
 
416
class NotBranchError(PathError):
 
417
 
 
418
    _fmt = "Not a branch: %(path)s"
 
419
 
 
420
    def __init__(self, path):
 
421
       import bzrlib.urlutils as urlutils
 
422
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
423
 
 
424
 
 
425
class AlreadyBranchError(PathError):
 
426
 
 
427
    _fmt = "Already a branch: %(path)s."
 
428
 
 
429
 
 
430
class BranchExistsWithoutWorkingTree(PathError):
 
431
 
 
432
    _fmt = "Directory contains a branch, but no working tree \
 
433
(use bzr checkout if you wish to build a working tree): %(path)s"
 
434
 
 
435
 
 
436
class AtomicFileAlreadyClosed(PathError):
 
437
 
 
438
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
439
 
 
440
    def __init__(self, path, function):
 
441
        PathError.__init__(self, path=path, extra=None)
 
442
        self.function = function
 
443
 
 
444
 
 
445
class InaccessibleParent(PathError):
 
446
 
 
447
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
448
 
 
449
    def __init__(self, path, base):
 
450
        PathError.__init__(self, path)
 
451
        self.base = base
 
452
 
 
453
 
 
454
class NoRepositoryPresent(BzrError):
 
455
 
 
456
    _fmt = "No repository present: %(path)r"
 
457
    def __init__(self, bzrdir):
 
458
        BzrError.__init__(self)
 
459
        self.path = bzrdir.transport.clone('..').base
 
460
 
 
461
 
 
462
class FileInWrongBranch(BzrError):
 
463
 
 
464
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
465
 
 
466
    def __init__(self, branch, path):
 
467
        BzrError.__init__(self)
 
468
        self.branch = branch
 
469
        self.branch_base = branch.base
 
470
        self.path = path
 
471
 
 
472
 
 
473
class UnsupportedFormatError(BzrError):
 
474
    
 
475
    _fmt = "Unsupported branch format: %(format)s"
 
476
 
 
477
 
 
478
class UnknownFormatError(BzrError):
 
479
    
 
480
    _fmt = "Unknown branch format: %(format)r"
 
481
 
 
482
 
 
483
class IncompatibleFormat(BzrError):
 
484
    
 
485
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
486
 
 
487
    def __init__(self, format, bzrdir_format):
 
488
        BzrError.__init__(self)
 
489
        self.format = format
 
490
        self.bzrdir = bzrdir_format
 
491
 
 
492
 
 
493
class IncompatibleRevision(BzrError):
 
494
    
 
495
    _fmt = "Revision is not compatible with %(repo_format)s"
 
496
 
 
497
    def __init__(self, repo_format):
 
498
        BzrError.__init__(self)
 
499
        self.repo_format = repo_format
 
500
 
 
501
 
 
502
class NotVersionedError(BzrError):
 
503
 
 
504
    _fmt = "%(path)s is not versioned"
 
505
 
 
506
    def __init__(self, path):
 
507
        BzrError.__init__(self)
 
508
        self.path = path
 
509
 
 
510
 
 
511
class PathsNotVersionedError(BzrError):
 
512
    # used when reporting several paths are not versioned
 
513
 
 
514
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
515
 
 
516
    def __init__(self, paths):
 
517
        from bzrlib.osutils import quotefn
 
518
        BzrError.__init__(self)
 
519
        self.paths = paths
 
520
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
521
 
 
522
 
 
523
class PathsDoNotExist(BzrError):
 
524
 
 
525
    _fmt = "Path(s) do not exist: %(paths_as_string)s"
 
526
 
 
527
    # used when reporting that paths are neither versioned nor in the working
 
528
    # tree
 
529
 
 
530
    def __init__(self, paths):
 
531
        # circular import
 
532
        from bzrlib.osutils import quotefn
 
533
        BzrError.__init__(self)
 
534
        self.paths = paths
 
535
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
536
 
 
537
 
 
538
class BadFileKindError(BzrError):
 
539
 
 
540
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
541
 
 
542
 
 
543
class ForbiddenControlFileError(BzrError):
 
544
 
 
545
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
546
 
 
547
 
 
548
class LockError(BzrError):
 
549
 
 
550
    _fmt = "Lock error: %(message)s"
 
551
 
 
552
    # All exceptions from the lock/unlock functions should be from
 
553
    # this exception class.  They will be translated as necessary. The
 
554
    # original exception is available as e.original_error
 
555
    #
 
556
    # New code should prefer to raise specific subclasses
 
557
    def __init__(self, message):
 
558
        self.message = message
 
559
 
 
560
 
 
561
class CommitNotPossible(LockError):
 
562
 
 
563
    _fmt = "A commit was attempted but we do not have a write lock open."
 
564
 
 
565
    def __init__(self):
 
566
        pass
 
567
 
 
568
 
 
569
class AlreadyCommitted(LockError):
 
570
 
 
571
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
572
 
 
573
    def __init__(self):
 
574
        pass
 
575
 
 
576
 
 
577
class ReadOnlyError(LockError):
 
578
 
 
579
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
580
 
 
581
    def __init__(self, obj):
 
582
        self.obj = obj
 
583
 
 
584
 
 
585
class OutSideTransaction(BzrError):
 
586
 
 
587
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
588
 
 
589
 
 
590
class ObjectNotLocked(LockError):
 
591
 
 
592
    _fmt = "%(obj)r is not locked"
 
593
 
 
594
    internal_error = True
 
595
 
 
596
    # this can indicate that any particular object is not locked; see also
 
597
    # LockNotHeld which means that a particular *lock* object is not held by
 
598
    # the caller -- perhaps they should be unified.
 
599
    def __init__(self, obj):
 
600
        self.obj = obj
 
601
 
 
602
 
 
603
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
604
 
 
605
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
606
 
 
607
    def __init__(self, obj):
 
608
        self.obj = obj
 
609
 
 
610
 
 
611
class UnlockableTransport(LockError):
 
612
 
 
613
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
614
 
 
615
    def __init__(self, transport):
 
616
        self.transport = transport
 
617
 
 
618
 
 
619
class LockContention(LockError):
 
620
 
 
621
    _fmt = "Could not acquire lock %(lock)s"
 
622
    # TODO: show full url for lock, combining the transport and relative bits?
 
623
    
 
624
    def __init__(self, lock):
 
625
        self.lock = lock
 
626
 
 
627
 
 
628
class LockBroken(LockError):
 
629
 
 
630
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
631
 
 
632
    def __init__(self, lock):
 
633
        self.lock = lock
 
634
 
 
635
 
 
636
class LockBreakMismatch(LockError):
 
637
 
 
638
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
639
 
 
640
    def __init__(self, lock, holder, target):
 
641
        self.lock = lock
 
642
        self.holder = holder
 
643
        self.target = target
 
644
 
 
645
 
 
646
class LockNotHeld(LockError):
 
647
 
 
648
    _fmt = "Lock not held: %(lock)s"
 
649
 
 
650
    def __init__(self, lock):
 
651
        self.lock = lock
 
652
 
 
653
 
 
654
class PointlessCommit(BzrError):
 
655
 
 
656
    _fmt = "No changes to commit"
 
657
 
 
658
 
 
659
class UpgradeReadonly(BzrError):
 
660
 
 
661
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
662
 
 
663
 
 
664
class UpToDateFormat(BzrError):
 
665
 
 
666
    _fmt = "The branch format %(format)s is already at the most recent format."
 
667
 
 
668
    def __init__(self, format):
 
669
        BzrError.__init__(self)
 
670
        self.format = format
 
671
 
 
672
 
 
673
class StrictCommitFailed(Exception):
 
674
 
 
675
    _fmt = "Commit refused because there are unknowns in the tree."
 
676
 
 
677
 
 
678
class NoSuchRevision(BzrError):
 
679
 
 
680
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
681
 
 
682
    internal_error = True
 
683
 
 
684
    def __init__(self, branch, revision):
 
685
        BzrError.__init__(self, branch=branch, revision=revision)
 
686
 
 
687
 
 
688
class NoSuchRevisionSpec(BzrError):
 
689
 
 
690
    _fmt = "No namespace registered for string: %(spec)r"
 
691
 
 
692
    def __init__(self, spec):
 
693
        BzrError.__init__(self, spec=spec)
 
694
 
 
695
 
 
696
class InvalidRevisionSpec(BzrError):
 
697
 
 
698
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
699
 
 
700
    def __init__(self, spec, branch, extra=None):
 
701
        BzrError.__init__(self, branch=branch, spec=spec)
 
702
        if extra:
 
703
            self.extra = '\n' + str(extra)
 
704
        else:
 
705
            self.extra = ''
 
706
 
 
707
 
 
708
class HistoryMissing(BzrError):
 
709
 
 
710
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
711
 
 
712
 
 
713
class DivergedBranches(BzrError):
 
714
    
 
715
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
716
 
 
717
    internal_error = False
 
718
 
 
719
    def __init__(self, branch1, branch2):
 
720
        self.branch1 = branch1
 
721
        self.branch2 = branch2
 
722
 
 
723
 
 
724
class UnrelatedBranches(BzrError):
 
725
 
 
726
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
727
 
 
728
    internal_error = False
 
729
 
 
730
 
 
731
class NoCommonAncestor(BzrError):
 
732
    
 
733
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
734
 
 
735
    def __init__(self, revision_a, revision_b):
 
736
        self.revision_a = revision_a
 
737
        self.revision_b = revision_b
 
738
 
 
739
 
 
740
class NoCommonRoot(BzrError):
 
741
 
 
742
    _fmt = "Revisions are not derived from the same root: " \
 
743
           "%(revision_a)s %(revision_b)s."
 
744
 
 
745
    def __init__(self, revision_a, revision_b):
 
746
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
747
 
 
748
 
 
749
class NotAncestor(BzrError):
 
750
 
 
751
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
752
 
 
753
    def __init__(self, rev_id, not_ancestor_id):
 
754
        BzrError.__init__(self, rev_id=rev_id,
 
755
            not_ancestor_id=not_ancestor_id)
 
756
 
 
757
 
 
758
class InstallFailed(BzrError):
 
759
 
 
760
    def __init__(self, revisions):
 
761
        revision_str = ", ".join(str(r) for r in revisions)
 
762
        msg = "Could not install revisions:\n%s" % revision_str
 
763
        BzrError.__init__(self, msg)
 
764
        self.revisions = revisions
 
765
 
 
766
 
 
767
class AmbiguousBase(BzrError):
 
768
 
 
769
    def __init__(self, bases):
 
770
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
771
                DeprecationWarning)
 
772
        msg = "The correct base is unclear, because %s are all equally close" %\
 
773
            ", ".join(bases)
 
774
        BzrError.__init__(self, msg)
 
775
        self.bases = bases
 
776
 
 
777
 
 
778
class NoCommits(BzrError):
 
779
 
 
780
    _fmt = "Branch %(branch)s has no commits."
 
781
 
 
782
    def __init__(self, branch):
 
783
        BzrError.__init__(self, branch=branch)
 
784
 
 
785
 
 
786
class UnlistableStore(BzrError):
 
787
 
 
788
    def __init__(self, store):
 
789
        BzrError.__init__(self, "Store %s is not listable" % store)
 
790
 
 
791
 
 
792
 
 
793
class UnlistableBranch(BzrError):
 
794
 
 
795
    def __init__(self, br):
 
796
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
797
 
 
798
 
 
799
class BoundBranchOutOfDate(BzrError):
 
800
 
 
801
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
802
 
 
803
    def __init__(self, branch, master):
 
804
        BzrError.__init__(self)
 
805
        self.branch = branch
 
806
        self.master = master
 
807
 
 
808
        
 
809
class CommitToDoubleBoundBranch(BzrError):
 
810
 
 
811
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
812
 
 
813
    def __init__(self, branch, master, remote):
 
814
        BzrError.__init__(self)
 
815
        self.branch = branch
 
816
        self.master = master
 
817
        self.remote = remote
 
818
 
 
819
 
 
820
class OverwriteBoundBranch(BzrError):
 
821
 
 
822
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
823
 
 
824
    def __init__(self, branch):
 
825
        BzrError.__init__(self)
 
826
        self.branch = branch
 
827
 
 
828
 
 
829
class BoundBranchConnectionFailure(BzrError):
 
830
 
 
831
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
832
 
 
833
    def __init__(self, branch, target, error):
 
834
        BzrError.__init__(self)
 
835
        self.branch = branch
 
836
        self.target = target
 
837
        self.error = error
 
838
 
 
839
 
 
840
class WeaveError(BzrError):
 
841
 
 
842
    _fmt = "Error in processing weave: %(message)s"
 
843
 
 
844
    def __init__(self, message=None):
 
845
        BzrError.__init__(self)
 
846
        self.message = message
 
847
 
 
848
 
 
849
class WeaveRevisionAlreadyPresent(WeaveError):
 
850
 
 
851
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
852
 
 
853
    def __init__(self, revision_id, weave):
 
854
 
 
855
        WeaveError.__init__(self)
 
856
        self.revision_id = revision_id
 
857
        self.weave = weave
 
858
 
 
859
 
 
860
class WeaveRevisionNotPresent(WeaveError):
 
861
 
 
862
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
863
 
 
864
    def __init__(self, revision_id, weave):
 
865
        WeaveError.__init__(self)
 
866
        self.revision_id = revision_id
 
867
        self.weave = weave
 
868
 
 
869
 
 
870
class WeaveFormatError(WeaveError):
 
871
 
 
872
    _fmt = "Weave invariant violated: %(what)s"
 
873
 
 
874
    def __init__(self, what):
 
875
        WeaveError.__init__(self)
 
876
        self.what = what
 
877
 
 
878
 
 
879
class WeaveParentMismatch(WeaveError):
 
880
 
 
881
    _fmt = "Parents are mismatched between two revisions."
 
882
    
 
883
 
 
884
class WeaveInvalidChecksum(WeaveError):
 
885
 
 
886
    _fmt = "Text did not match it's checksum: %(message)s"
 
887
 
 
888
 
 
889
class WeaveTextDiffers(WeaveError):
 
890
 
 
891
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
892
 
 
893
    def __init__(self, revision_id, weave_a, weave_b):
 
894
        WeaveError.__init__(self)
 
895
        self.revision_id = revision_id
 
896
        self.weave_a = weave_a
 
897
        self.weave_b = weave_b
 
898
 
 
899
 
 
900
class WeaveTextDiffers(WeaveError):
 
901
 
 
902
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
903
 
 
904
    def __init__(self, revision_id, weave_a, weave_b):
 
905
        WeaveError.__init__(self)
 
906
        self.revision_id = revision_id
 
907
        self.weave_a = weave_a
 
908
        self.weave_b = weave_b
 
909
 
 
910
 
 
911
class VersionedFileError(BzrError):
 
912
    
 
913
    _fmt = "Versioned file error"
 
914
 
 
915
 
 
916
class RevisionNotPresent(VersionedFileError):
 
917
    
 
918
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
919
 
 
920
    def __init__(self, revision_id, file_id):
 
921
        VersionedFileError.__init__(self)
 
922
        self.revision_id = revision_id
 
923
        self.file_id = file_id
 
924
 
 
925
 
 
926
class RevisionAlreadyPresent(VersionedFileError):
 
927
    
 
928
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
929
 
 
930
    def __init__(self, revision_id, file_id):
 
931
        VersionedFileError.__init__(self)
 
932
        self.revision_id = revision_id
 
933
        self.file_id = file_id
 
934
 
 
935
 
 
936
class KnitError(BzrError):
 
937
    
 
938
    _fmt = "Knit error"
 
939
 
 
940
    internal_error = True
 
941
 
 
942
 
 
943
class KnitHeaderError(KnitError):
 
944
 
 
945
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
946
 
 
947
    def __init__(self, badline, filename):
 
948
        KnitError.__init__(self)
 
949
        self.badline = badline
 
950
        self.filename = filename
 
951
 
 
952
 
 
953
class KnitCorrupt(KnitError):
 
954
 
 
955
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
956
 
 
957
    def __init__(self, filename, how):
 
958
        KnitError.__init__(self)
 
959
        self.filename = filename
 
960
        self.how = how
 
961
 
 
962
 
 
963
class KnitIndexUnknownMethod(KnitError):
 
964
    """Raised when we don't understand the storage method.
 
965
 
 
966
    Currently only 'fulltext' and 'line-delta' are supported.
 
967
    """
 
968
    
 
969
    _fmt = ("Knit index %(filename)s does not have a known method"
 
970
            " in options: %(options)r")
 
971
 
 
972
    def __init__(self, filename, options):
 
973
        KnitError.__init__(self)
 
974
        self.filename = filename
 
975
        self.options = options
 
976
 
 
977
 
 
978
class NoSuchExportFormat(BzrError):
 
979
    
 
980
    _fmt = "Export format %(format)r not supported"
 
981
 
 
982
    def __init__(self, format):
 
983
        BzrError.__init__(self)
 
984
        self.format = format
 
985
 
 
986
 
 
987
class TransportError(BzrError):
 
988
    
 
989
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
990
 
 
991
    def __init__(self, msg=None, orig_error=None):
 
992
        if msg is None and orig_error is not None:
 
993
            msg = str(orig_error)
 
994
        if orig_error is None:
 
995
            orig_error = ''
 
996
        if msg is None:
 
997
            msg =  ''
 
998
        self.msg = msg
 
999
        self.orig_error = orig_error
 
1000
        BzrError.__init__(self)
 
1001
 
 
1002
 
 
1003
class TooManyConcurrentRequests(BzrError):
 
1004
 
 
1005
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
1006
            "Be sure to finish_writing and finish_reading on the "
 
1007
            "current request that is open.")
 
1008
 
 
1009
    internal_error = True
 
1010
 
 
1011
    def __init__(self, medium):
 
1012
        self.medium = medium
 
1013
 
 
1014
 
 
1015
class SmartProtocolError(TransportError):
 
1016
 
 
1017
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1018
 
 
1019
    def __init__(self, details):
 
1020
        self.details = details
 
1021
 
 
1022
 
 
1023
# A set of semi-meaningful errors which can be thrown
 
1024
class TransportNotPossible(TransportError):
 
1025
 
 
1026
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1027
 
 
1028
 
 
1029
class ConnectionError(TransportError):
 
1030
 
 
1031
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1032
 
 
1033
 
 
1034
class SocketConnectionError(ConnectionError):
 
1035
 
 
1036
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1037
 
 
1038
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1039
        if msg is None:
 
1040
            msg = 'Failed to connect to'
 
1041
        if orig_error is None:
 
1042
            orig_error = ''
 
1043
        else:
 
1044
            orig_error = '; ' + str(orig_error)
 
1045
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1046
        self.host = host
 
1047
        if port is None:
 
1048
            self.port = ''
 
1049
        else:
 
1050
            self.port = ':%s' % port
 
1051
 
 
1052
 
 
1053
class ConnectionReset(TransportError):
 
1054
 
 
1055
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1056
 
 
1057
 
 
1058
class InvalidRange(TransportError):
 
1059
 
 
1060
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1061
    
 
1062
    def __init__(self, path, offset):
 
1063
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1064
                                       % (path, offset)))
 
1065
        self.path = path
 
1066
        self.offset = offset
 
1067
 
 
1068
 
 
1069
class InvalidHttpResponse(TransportError):
 
1070
 
 
1071
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1072
 
 
1073
    def __init__(self, path, msg, orig_error=None):
 
1074
        self.path = path
 
1075
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1076
 
 
1077
 
 
1078
class InvalidHttpRange(InvalidHttpResponse):
 
1079
 
 
1080
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1081
    
 
1082
    def __init__(self, path, range, msg):
 
1083
        self.range = range
 
1084
        InvalidHttpResponse.__init__(self, path, msg)
 
1085
 
 
1086
 
 
1087
class InvalidHttpContentType(InvalidHttpResponse):
 
1088
 
 
1089
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1090
    
 
1091
    def __init__(self, path, ctype, msg):
 
1092
        self.ctype = ctype
 
1093
        InvalidHttpResponse.__init__(self, path, msg)
 
1094
 
 
1095
 
 
1096
class ConflictsInTree(BzrError):
 
1097
 
 
1098
    _fmt = "Working tree has conflicts."
 
1099
 
 
1100
 
 
1101
class ParseConfigError(BzrError):
 
1102
 
 
1103
    def __init__(self, errors, filename):
 
1104
        if filename is None:
 
1105
            filename = ""
 
1106
        message = "Error(s) parsing config file %s:\n%s" % \
 
1107
            (filename, ('\n'.join(e.message for e in errors)))
 
1108
        BzrError.__init__(self, message)
 
1109
 
 
1110
 
 
1111
class NoEmailInUsername(BzrError):
 
1112
 
 
1113
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1114
 
 
1115
    def __init__(self, username):
 
1116
        BzrError.__init__(self)
 
1117
        self.username = username
 
1118
 
 
1119
 
 
1120
class SigningFailed(BzrError):
 
1121
 
 
1122
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1123
 
 
1124
    def __init__(self, command_line):
 
1125
        BzrError.__init__(self, command_line=command_line)
 
1126
 
 
1127
 
 
1128
class WorkingTreeNotRevision(BzrError):
 
1129
 
 
1130
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1131
            " the last commit, but weave merge requires that it be"
 
1132
            " unchanged")
 
1133
 
 
1134
    def __init__(self, tree):
 
1135
        BzrError.__init__(self, basedir=tree.basedir)
 
1136
 
 
1137
 
 
1138
class CantReprocessAndShowBase(BzrError):
 
1139
 
 
1140
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
1141
           "the relationship of conflicting lines to the base"
 
1142
 
 
1143
 
 
1144
class GraphCycleError(BzrError):
 
1145
 
 
1146
    _fmt = "Cycle in graph %(graph)r"
 
1147
 
 
1148
    def __init__(self, graph):
 
1149
        BzrError.__init__(self)
 
1150
        self.graph = graph
 
1151
 
 
1152
 
 
1153
class WritingCompleted(BzrError):
 
1154
 
 
1155
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1156
            "called upon it - accept bytes may not be called anymore.")
 
1157
 
 
1158
    internal_error = True
 
1159
 
 
1160
    def __init__(self, request):
 
1161
        self.request = request
 
1162
 
 
1163
 
 
1164
class WritingNotComplete(BzrError):
 
1165
 
 
1166
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1167
            "called upon it - until the write phase is complete no "
 
1168
            "data may be read.")
 
1169
 
 
1170
    internal_error = True
 
1171
 
 
1172
    def __init__(self, request):
 
1173
        self.request = request
 
1174
 
 
1175
 
 
1176
class NotConflicted(BzrError):
 
1177
 
 
1178
    _fmt = "File %(filename)s is not conflicted."
 
1179
 
 
1180
    def __init__(self, filename):
 
1181
        BzrError.__init__(self)
 
1182
        self.filename = filename
 
1183
 
 
1184
 
 
1185
class MediumNotConnected(BzrError):
 
1186
 
 
1187
    _fmt = """The medium '%(medium)s' is not connected."""
 
1188
 
 
1189
    internal_error = True
 
1190
 
 
1191
    def __init__(self, medium):
 
1192
        self.medium = medium
 
1193
 
 
1194
 
 
1195
class MustUseDecorated(Exception):
 
1196
    
 
1197
    _fmt = """A decorating function has requested its original command be used."""
 
1198
    
 
1199
 
 
1200
class NoBundleFound(BzrError):
 
1201
 
 
1202
    _fmt = "No bundle was found in %(filename)s"
 
1203
 
 
1204
    def __init__(self, filename):
 
1205
        BzrError.__init__(self)
 
1206
        self.filename = filename
 
1207
 
 
1208
 
 
1209
class BundleNotSupported(BzrError):
 
1210
 
 
1211
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1212
 
 
1213
    def __init__(self, version, msg):
 
1214
        BzrError.__init__(self)
 
1215
        self.version = version
 
1216
        self.msg = msg
 
1217
 
 
1218
 
 
1219
class MissingText(BzrError):
 
1220
 
 
1221
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1222
 
 
1223
    def __init__(self, branch, text_revision, file_id):
 
1224
        BzrError.__init__(self)
 
1225
        self.branch = branch
 
1226
        self.base = branch.base
 
1227
        self.text_revision = text_revision
 
1228
        self.file_id = file_id
 
1229
 
 
1230
 
 
1231
class DuplicateKey(BzrError):
 
1232
 
 
1233
    _fmt = "Key %(key)s is already present in map"
 
1234
 
 
1235
 
 
1236
class MalformedTransform(BzrError):
 
1237
 
 
1238
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1239
 
 
1240
 
 
1241
class NoFinalPath(BzrError):
 
1242
 
 
1243
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1244
            "file-id: %(file_id)r\n"
 
1245
            "root trans-id: %(root_trans_id)r\n")
 
1246
 
 
1247
    def __init__(self, trans_id, transform):
 
1248
        self.trans_id = trans_id
 
1249
        self.file_id = transform.final_file_id(trans_id)
 
1250
        self.root_trans_id = transform.root
 
1251
 
 
1252
 
 
1253
class BzrBadParameter(BzrError):
 
1254
 
 
1255
    _fmt = "Bad parameter: %(param)r"
 
1256
 
 
1257
    # This exception should never be thrown, but it is a base class for all
 
1258
    # parameter-to-function errors.
 
1259
 
 
1260
    def __init__(self, param):
 
1261
        BzrError.__init__(self)
 
1262
        self.param = param
 
1263
 
 
1264
 
 
1265
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1266
 
 
1267
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1268
 
 
1269
 
 
1270
class ReusingTransform(BzrError):
 
1271
 
 
1272
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1273
 
 
1274
 
 
1275
class CantMoveRoot(BzrError):
 
1276
 
 
1277
    _fmt = "Moving the root directory is not supported at this time"
 
1278
 
 
1279
 
 
1280
class BzrBadParameterNotString(BzrBadParameter):
 
1281
 
 
1282
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1283
 
 
1284
 
 
1285
class BzrBadParameterMissing(BzrBadParameter):
 
1286
 
 
1287
    _fmt = "Parameter $(param)s is required but not present."
 
1288
 
 
1289
 
 
1290
class BzrBadParameterUnicode(BzrBadParameter):
 
1291
 
 
1292
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
1293
 
 
1294
 
 
1295
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1296
 
 
1297
    _fmt = "Parameter %(param)s contains a newline."
 
1298
 
 
1299
 
 
1300
class DependencyNotPresent(BzrError):
 
1301
 
 
1302
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1303
 
 
1304
    def __init__(self, library, error):
 
1305
        BzrError.__init__(self, library=library, error=error)
 
1306
 
 
1307
 
 
1308
class ParamikoNotPresent(DependencyNotPresent):
 
1309
 
 
1310
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1311
 
 
1312
    def __init__(self, error):
 
1313
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1314
 
 
1315
 
 
1316
class PointlessMerge(BzrError):
 
1317
 
 
1318
    _fmt = "Nothing to merge."
 
1319
 
 
1320
 
 
1321
class UninitializableFormat(BzrError):
 
1322
 
 
1323
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1324
 
 
1325
    def __init__(self, format):
 
1326
        BzrError.__init__(self)
 
1327
        self.format = format
 
1328
 
 
1329
 
 
1330
class BadConversionTarget(BzrError):
 
1331
 
 
1332
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1333
 
 
1334
    def __init__(self, problem, format):
 
1335
        BzrError.__init__(self)
 
1336
        self.problem = problem
 
1337
        self.format = format
 
1338
 
 
1339
 
 
1340
class NoDiff(BzrError):
 
1341
 
 
1342
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1343
 
 
1344
    def __init__(self, msg):
 
1345
        BzrError.__init__(self, msg=msg)
 
1346
 
 
1347
 
 
1348
class NoDiff3(BzrError):
 
1349
 
 
1350
    _fmt = "Diff3 is not installed on this machine."
 
1351
 
 
1352
 
 
1353
class ExistingLimbo(BzrError):
 
1354
 
 
1355
    _fmt = """This tree contains left-over files from a failed operation.
 
1356
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1357
    keep, and delete it when you are done."""
 
1358
    
 
1359
    def __init__(self, limbo_dir):
 
1360
       BzrError.__init__(self)
 
1361
       self.limbo_dir = limbo_dir
 
1362
 
 
1363
 
 
1364
class ImmortalLimbo(BzrError):
 
1365
 
 
1366
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1367
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1368
    keep, and delete it when you are done."""
 
1369
 
 
1370
    def __init__(self, limbo_dir):
 
1371
       BzrError.__init__(self)
 
1372
       self.limbo_dir = limbo_dir
 
1373
 
 
1374
 
 
1375
class OutOfDateTree(BzrError):
 
1376
 
 
1377
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1378
 
 
1379
    def __init__(self, tree):
 
1380
        BzrError.__init__(self)
 
1381
        self.tree = tree
 
1382
 
 
1383
 
 
1384
class MergeModifiedFormatError(BzrError):
 
1385
 
 
1386
    _fmt = "Error in merge modified format"
 
1387
 
 
1388
 
 
1389
class ConflictFormatError(BzrError):
 
1390
 
 
1391
    _fmt = "Format error in conflict listings"
 
1392
 
 
1393
 
 
1394
class CorruptRepository(BzrError):
 
1395
 
 
1396
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
1397
Please run bzr reconcile on this repository."""
 
1398
 
 
1399
    def __init__(self, repo):
 
1400
        BzrError.__init__(self)
 
1401
        self.repo_path = repo.bzrdir.root_transport.base
 
1402
 
 
1403
 
 
1404
class UpgradeRequired(BzrError):
 
1405
 
 
1406
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1407
 
 
1408
    def __init__(self, path):
 
1409
        BzrError.__init__(self)
 
1410
        self.path = path
 
1411
 
 
1412
 
 
1413
class LocalRequiresBoundBranch(BzrError):
 
1414
 
 
1415
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1416
 
 
1417
 
 
1418
class MissingProgressBarFinish(BzrError):
 
1419
 
 
1420
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1421
 
 
1422
 
 
1423
class InvalidProgressBarType(BzrError):
 
1424
 
 
1425
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1426
Select one of: %(valid_types)s"""
 
1427
 
 
1428
    def __init__(self, bar_type, valid_types):
 
1429
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1430
 
 
1431
 
 
1432
class UnsupportedOperation(BzrError):
 
1433
 
 
1434
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
1435
 
 
1436
    def __init__(self, method, method_self):
 
1437
        self.method = method
 
1438
        self.mname = method.__name__
 
1439
        self.tname = type(method_self).__name__
 
1440
 
 
1441
 
 
1442
class CannotSetRevisionId(UnsupportedOperation):
 
1443
    """Raised when a commit is attempting to set a revision id but cant."""
 
1444
 
 
1445
 
 
1446
class NonAsciiRevisionId(UnsupportedOperation):
 
1447
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
1448
 
 
1449
 
 
1450
class BinaryFile(BzrError):
 
1451
    
 
1452
    _fmt = "File is binary but should be text."
 
1453
 
 
1454
 
 
1455
class IllegalPath(BzrError):
 
1456
 
 
1457
    _fmt = "The path %(path)s is not permitted on this platform"
 
1458
 
 
1459
    def __init__(self, path):
 
1460
        BzrError.__init__(self)
 
1461
        self.path = path
 
1462
 
 
1463
 
 
1464
class TestamentMismatch(BzrError):
 
1465
 
 
1466
    _fmt = """Testament did not match expected value.  
 
1467
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1468
       {%(measured)s}"""
 
1469
 
 
1470
    def __init__(self, revision_id, expected, measured):
 
1471
        self.revision_id = revision_id
 
1472
        self.expected = expected
 
1473
        self.measured = measured
 
1474
 
 
1475
 
 
1476
class NotABundle(BzrError):
 
1477
    
 
1478
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1479
 
 
1480
    def __init__(self, text):
 
1481
        BzrError.__init__(self)
 
1482
        self.text = text
 
1483
 
 
1484
 
 
1485
class BadBundle(BzrError): 
 
1486
    
 
1487
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1488
 
 
1489
    def __init__(self, text):
 
1490
        BzrError.__init__(self)
 
1491
        self.text = text
 
1492
 
 
1493
 
 
1494
class MalformedHeader(BadBundle): 
 
1495
    
 
1496
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1497
 
 
1498
 
 
1499
class MalformedPatches(BadBundle): 
 
1500
    
 
1501
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1502
 
 
1503
 
 
1504
class MalformedFooter(BadBundle): 
 
1505
    
 
1506
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1507
 
 
1508
 
 
1509
class UnsupportedEOLMarker(BadBundle):
 
1510
    
 
1511
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1512
 
 
1513
    def __init__(self):
 
1514
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1515
        # but for this there is not
 
1516
        BzrError.__init__(self)
 
1517
 
 
1518
 
 
1519
class IncompatibleBundleFormat(BzrError):
 
1520
    
 
1521
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1522
 
 
1523
    def __init__(self, bundle_format, other):
 
1524
        BzrError.__init__(self)
 
1525
        self.bundle_format = bundle_format
 
1526
        self.other = other
 
1527
 
 
1528
 
 
1529
class BadInventoryFormat(BzrError):
 
1530
    
 
1531
    _fmt = "Root class for inventory serialization errors"
 
1532
 
 
1533
 
 
1534
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1535
 
 
1536
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1537
 
 
1538
    def __init__(self, msg):
 
1539
        BadInventoryFormat.__init__(self, msg=msg)
 
1540
 
 
1541
 
 
1542
class NoSmartMedium(BzrError):
 
1543
 
 
1544
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1545
 
 
1546
    def __init__(self, transport):
 
1547
        self.transport = transport
 
1548
 
 
1549
 
 
1550
class NoSmartServer(NotBranchError):
 
1551
 
 
1552
    _fmt = "No smart server available at %(url)s"
 
1553
 
 
1554
    def __init__(self, url):
 
1555
        self.url = url
 
1556
 
 
1557
 
 
1558
class UnknownSSH(BzrError):
 
1559
 
 
1560
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1561
 
 
1562
    def __init__(self, vendor):
 
1563
        BzrError.__init__(self)
 
1564
        self.vendor = vendor
 
1565
 
 
1566
 
 
1567
class GhostRevisionUnusableHere(BzrError):
 
1568
 
 
1569
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1570
 
 
1571
    def __init__(self, revision_id):
 
1572
        BzrError.__init__(self)
 
1573
        self.revision_id = revision_id
 
1574
 
 
1575
 
 
1576
class IllegalUseOfScopeReplacer(BzrError):
 
1577
 
 
1578
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
1579
 
 
1580
    internal_error = True
 
1581
 
 
1582
    def __init__(self, name, msg, extra=None):
 
1583
        BzrError.__init__(self)
 
1584
        self.name = name
 
1585
        self.msg = msg
 
1586
        if extra:
 
1587
            self.extra = ': ' + str(extra)
 
1588
        else:
 
1589
            self.extra = ''
 
1590
 
 
1591
 
 
1592
class InvalidImportLine(BzrError):
 
1593
 
 
1594
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1595
 
 
1596
    internal_error = True
 
1597
 
 
1598
    def __init__(self, text, msg):
 
1599
        BzrError.__init__(self)
 
1600
        self.text = text
 
1601
        self.msg = msg
 
1602
 
 
1603
 
 
1604
class ImportNameCollision(BzrError):
 
1605
 
 
1606
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
1607
 
 
1608
    internal_error = True
 
1609
 
 
1610
    def __init__(self, name):
 
1611
        BzrError.__init__(self)
 
1612
        self.name = name