/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

[merge] bzr.dev 2255, resolve conflicts, update copyrights

Show diffs side-by-side

added added

removed removed

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