/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: Canonical.com Patch Queue Manager
  • Date: 2007-03-09 21:27:15 UTC
  • mfrom: (2328.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070309212715-07aacbc78b3e2dc0
(Dmitry Vasiliev) Improvements to osutils functions.

Show diffs side-by-side

added added

removed removed

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