~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Merge bzr.dev (via NO_SMART_VFS branch).

Show diffs side-by-side

added added

removed removed

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