~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-07-04 08:08:13 UTC
  • mfrom: (2572 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2587.
  • Revision ID: robertc@robertcollins.net-20070704080813-wzebx0r88fvwj5rq
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
 
1
# Copyright (C) 2005, 2006, 2007 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 this was probably caused by a bzr bug and
 
52
    should be displayed with a traceback; if False (or absent) 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=%r' \
 
106
                % (self.__class__.__name__,
 
107
                   self.__dict__,
 
108
                   getattr(self, '_fmt', None),
 
109
                   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
 
123
134
    def __init__(self, *args, **kwds):
124
 
        # XXX: Use the underlying BzrError to always generate the args attribute
125
 
        # if it doesn't exist.  We can't use super here, because exceptions are
126
 
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
135
        # XXX: Use the underlying BzrError to always generate the args
 
136
        # attribute if it doesn't exist.  We can't use super here, because
 
137
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
138
        # --bmc, 20060426
 
139
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
140
             'please convert %s to use BzrError instead'
 
141
             % self.__class__.__name__,
 
142
             DeprecationWarning,
 
143
             stacklevel=2)
127
144
        BzrError.__init__(self, *args)
128
145
        for key, value in kwds.items():
129
146
            setattr(self, key, value)
137
154
                return s.encode('utf8')
138
155
            return s
139
156
        except (TypeError, NameError, ValueError, KeyError), e:
140
 
            return 'Unprintable exception %s(%r): %s' \
 
157
            return 'Unprintable exception %s(%r): %r' \
141
158
                % (self.__class__.__name__,
142
 
                   self.__dict__, str(e))
143
 
 
144
 
 
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
 
159
                   self.__dict__, e)
 
160
 
 
161
 
 
162
class AlreadyBuilding(BzrError):
 
163
    
 
164
    _fmt = "The tree builder is already building a tree."
 
165
 
 
166
 
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
153
172
 
154
173
    def __init__(self, message):
155
 
        BzrNewError.__init__(self)
 
174
        BzrError.__init__(self)
156
175
        self.message = message
157
176
 
158
177
 
159
 
class InvalidEntryName(BzrNewError):
160
 
    """Invalid entry name: %(name)s"""
161
 
 
162
 
    is_user_error = False
 
178
class DisabledMethod(BzrError):
 
179
 
 
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
181
 
 
182
    internal_error = True
 
183
 
 
184
    def __init__(self, class_name):
 
185
        BzrError.__init__(self)
 
186
        self.class_name = class_name
 
187
 
 
188
 
 
189
class IncompatibleAPI(BzrError):
 
190
 
 
191
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
192
        'It supports versions "%(minimum)s" to "%(current)s".'
 
193
 
 
194
    def __init__(self, api, wanted, minimum, current):
 
195
        self.api = api
 
196
        self.wanted = wanted
 
197
        self.minimum = minimum
 
198
        self.current = current
 
199
 
 
200
 
 
201
class InvalidEntryName(BzrError):
 
202
    
 
203
    _fmt = "Invalid entry name: %(name)s"
 
204
 
 
205
    internal_error = True
163
206
 
164
207
    def __init__(self, name):
165
 
        BzrNewError.__init__(self)
 
208
        BzrError.__init__(self)
166
209
        self.name = name
167
210
 
168
211
 
169
 
class InvalidRevisionNumber(BzrNewError):
170
 
    """Invalid revision number %(revno)d"""
 
212
class InvalidRevisionNumber(BzrError):
 
213
    
 
214
    _fmt = "Invalid revision number %(revno)s"
 
215
 
171
216
    def __init__(self, revno):
172
 
        BzrNewError.__init__(self)
 
217
        BzrError.__init__(self)
173
218
        self.revno = revno
174
219
 
175
220
 
176
 
class InvalidRevisionId(BzrNewError):
177
 
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
221
class InvalidRevisionId(BzrError):
 
222
 
 
223
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
178
224
 
179
225
    def __init__(self, revision_id, branch):
180
226
        # branch can be any string or object with __str__ defined
181
 
        BzrNewError.__init__(self)
 
227
        BzrError.__init__(self)
182
228
        self.revision_id = revision_id
183
229
        self.branch = branch
184
230
 
185
 
 
186
 
class NoSuchId(BzrNewError):
187
 
    """The file id %(file_id)s is not present in the tree %(tree)s."""
 
231
class ReservedId(BzrError):
 
232
 
 
233
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
234
 
 
235
    def __init__(self, revision_id):
 
236
        self.revision_id = revision_id
 
237
 
 
238
 
 
239
class NoHelpTopic(BzrError):
 
240
 
 
241
    _fmt = ("No help could be found for '%(topic)s'. "
 
242
        "Please use 'bzr help topics' to obtain a list of topics.")
 
243
 
 
244
    def __init__(self, topic):
 
245
        self.topic = topic
 
246
 
 
247
 
 
248
class NoSuchId(BzrError):
 
249
 
 
250
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
188
251
    
189
252
    def __init__(self, tree, file_id):
190
 
        BzrNewError.__init__(self)
 
253
        BzrError.__init__(self)
191
254
        self.file_id = file_id
192
255
        self.tree = tree
193
256
 
194
257
 
195
 
class NoWorkingTree(BzrNewError):
196
 
    """No WorkingTree exists for %(base)s."""
 
258
class InventoryModified(BzrError):
 
259
 
 
260
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
261
            " so a clean inventory cannot be read without data loss.")
 
262
 
 
263
    internal_error = True
 
264
 
 
265
    def __init__(self, tree):
 
266
        self.tree = tree
 
267
 
 
268
 
 
269
class NoWorkingTree(BzrError):
 
270
 
 
271
    _fmt = "No WorkingTree exists for %(base)s."
197
272
    
198
273
    def __init__(self, base):
199
 
        BzrNewError.__init__(self)
 
274
        BzrError.__init__(self)
200
275
        self.base = base
201
276
 
202
277
 
203
 
class NotBuilding(BzrNewError):
204
 
    """Not currently building a tree."""
205
 
 
206
 
 
207
 
class NotLocalUrl(BzrNewError):
208
 
    """%(url)s is not a local path."""
209
 
    
 
278
class NotBuilding(BzrError):
 
279
 
 
280
    _fmt = "Not currently building a tree."
 
281
 
 
282
 
 
283
class NotLocalUrl(BzrError):
 
284
 
 
285
    _fmt = "%(url)s is not a local path."
 
286
 
210
287
    def __init__(self, url):
211
 
        BzrNewError.__init__(self)
212
288
        self.url = url
213
289
 
214
290
 
215
 
class BzrCommandError(BzrNewError):
 
291
class WorkingTreeAlreadyPopulated(BzrError):
 
292
 
 
293
    _fmt = """Working tree already populated in %(base)s"""
 
294
 
 
295
    internal_error = True
 
296
 
 
297
    def __init__(self, base):
 
298
        self.base = base
 
299
 
 
300
class BzrCommandError(BzrError):
216
301
    """Error from user command"""
217
302
 
218
 
    is_user_error = True
 
303
    internal_error = False
219
304
 
220
305
    # Error from malformed user command; please avoid raising this as a
221
306
    # generic exception not caused by user input.
236
321
        return self.msg
237
322
 
238
323
 
 
324
class NotWriteLocked(BzrError):
 
325
 
 
326
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
327
 
 
328
    def __init__(self, not_locked):
 
329
        self.not_locked = not_locked
 
330
 
 
331
 
239
332
class BzrOptionError(BzrCommandError):
240
 
    """Error in command line options"""
 
333
 
 
334
    _fmt = "Error in command line options"
 
335
 
 
336
 
 
337
class BadOptionValue(BzrError):
 
338
 
 
339
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
340
 
 
341
    def __init__(self, name, value):
 
342
        BzrError.__init__(self, name=name, value=value)
241
343
 
242
344
    
243
 
class StrictCommitFailed(BzrNewError):
244
 
    """Commit refused because there are unknown files in the tree"""
 
345
class StrictCommitFailed(BzrError):
 
346
 
 
347
    _fmt = "Commit refused because there are unknown files in the tree"
245
348
 
246
349
 
247
350
# XXX: Should be unified with TransportError; they seem to represent the
250
353
# - this is finer than a TransportError - and more useful as such. It 
251
354
# differentiates between 'transport has failed' and 'operation on a transport
252
355
# has failed.'
253
 
class PathError(BzrNewError):
254
 
    """Generic path error: %(path)r%(extra)s)"""
 
356
class PathError(BzrError):
 
357
    
 
358
    _fmt = "Generic path error: %(path)r%(extra)s)"
255
359
 
256
360
    def __init__(self, path, extra=None):
257
 
        BzrNewError.__init__(self)
 
361
        BzrError.__init__(self)
258
362
        self.path = path
259
363
        if extra:
260
364
            self.extra = ': ' + str(extra)
263
367
 
264
368
 
265
369
class NoSuchFile(PathError):
266
 
    """No such file: %(path)r%(extra)s"""
 
370
 
 
371
    _fmt = "No such file: %(path)r%(extra)s"
267
372
 
268
373
 
269
374
class FileExists(PathError):
270
 
    """File exists: %(path)r%(extra)s"""
 
375
 
 
376
    _fmt = "File exists: %(path)r%(extra)s"
 
377
 
 
378
 
 
379
class RenameFailedFilesExist(BzrError):
 
380
    """Used when renaming and both source and dest exist."""
 
381
 
 
382
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
383
            "%(extra)s")
 
384
 
 
385
    def __init__(self, source, dest, extra=None):
 
386
        BzrError.__init__(self)
 
387
        self.source = str(source)
 
388
        self.dest = str(dest)
 
389
        if extra:
 
390
            self.extra = ' ' + str(extra)
 
391
        else:
 
392
            self.extra = ''
 
393
 
 
394
 
 
395
class NotADirectory(PathError):
 
396
 
 
397
    _fmt = "%(path)r is not a directory %(extra)s"
 
398
 
 
399
 
 
400
class NotInWorkingDirectory(PathError):
 
401
 
 
402
    _fmt = "%(path)r is not in the working directory %(extra)s"
271
403
 
272
404
 
273
405
class DirectoryNotEmpty(PathError):
274
 
    """Directory not empty: %(path)r%(extra)s"""
 
406
 
 
407
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
408
 
 
409
 
 
410
class ReadingCompleted(BzrError):
 
411
    
 
412
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
413
            "called upon it - the request has been completed and no more "
 
414
            "data may be read.")
 
415
 
 
416
    internal_error = True
 
417
 
 
418
    def __init__(self, request):
 
419
        self.request = request
275
420
 
276
421
 
277
422
class ResourceBusy(PathError):
278
 
    """Device or resource busy: %(path)r%(extra)s"""
 
423
 
 
424
    _fmt = "Device or resource busy: %(path)r%(extra)s"
279
425
 
280
426
 
281
427
class PermissionDenied(PathError):
282
 
    """Permission denied: %(path)r%(extra)s"""
 
428
 
 
429
    _fmt = "Permission denied: %(path)r%(extra)s"
283
430
 
284
431
 
285
432
class InvalidURL(PathError):
286
 
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
433
 
 
434
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
287
435
 
288
436
 
289
437
class InvalidURLJoin(PathError):
290
 
    """Invalid URL join request: %(args)s%(extra)s"""
 
438
 
 
439
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
291
440
 
292
441
    def __init__(self, msg, base, args):
293
442
        PathError.__init__(self, base, msg)
294
443
        self.args = [base] + list(args)
295
444
 
296
445
 
 
446
class UnknownHook(BzrError):
 
447
 
 
448
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
449
 
 
450
    def __init__(self, hook_type, hook_name):
 
451
        BzrError.__init__(self)
 
452
        self.type = hook_type
 
453
        self.hook = hook_name
 
454
 
 
455
 
297
456
class UnsupportedProtocol(PathError):
298
 
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
457
 
 
458
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
299
459
 
300
460
    def __init__(self, url, extra):
301
461
        PathError.__init__(self, url, extra=extra)
302
462
 
303
463
 
304
464
class ReadError(PathError):
305
 
    """Error reading from %(path)r."""
 
465
    
 
466
    _fmt = """Error reading from %(path)r."""
306
467
 
307
468
 
308
469
class ShortReadvError(PathError):
309
 
    """readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"""
310
 
 
311
 
    is_user_error = False
 
470
 
 
471
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
472
            " at %(offset)s for %(path)s%(extra)s")
 
473
 
 
474
    internal_error = True
312
475
 
313
476
    def __init__(self, path, offset, length, actual, extra=None):
314
477
        PathError.__init__(self, path, extra=extra)
317
480
        self.actual = actual
318
481
 
319
482
 
320
 
class PathNotChild(BzrNewError):
321
 
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
322
 
 
323
 
    is_user_error = False
 
483
class PathNotChild(BzrError):
 
484
 
 
485
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
486
 
 
487
    internal_error = True
324
488
 
325
489
    def __init__(self, path, base, extra=None):
326
 
        BzrNewError.__init__(self)
 
490
        BzrError.__init__(self)
327
491
        self.path = path
328
492
        self.base = base
329
493
        if extra:
333
497
 
334
498
 
335
499
class InvalidNormalization(PathError):
336
 
    """Path %(path)r is not unicode normalized"""
 
500
 
 
501
    _fmt = "Path %(path)r is not unicode normalized"
337
502
 
338
503
 
339
504
# TODO: This is given a URL; we try to unescape it but doing that from inside
340
505
# the exception object is a bit undesirable.
341
506
# TODO: Probably this behavior of should be a common superclass 
342
507
class NotBranchError(PathError):
343
 
    """Not a branch: %(path)s"""
 
508
 
 
509
    _fmt = "Not a branch: %(path)s"
344
510
 
345
511
    def __init__(self, path):
346
512
       import bzrlib.urlutils as urlutils
347
513
       self.path = urlutils.unescape_for_display(path, 'ascii')
348
514
 
349
515
 
 
516
class NoSubmitBranch(PathError):
 
517
 
 
518
    _fmt = 'No submit branch available for branch "%(path)s"'
 
519
 
 
520
    def __init__(self, branch):
 
521
       import bzrlib.urlutils as urlutils
 
522
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
523
 
 
524
 
350
525
class AlreadyBranchError(PathError):
351
 
    """Already a branch: %(path)s."""
 
526
 
 
527
    _fmt = "Already a branch: %(path)s."
352
528
 
353
529
 
354
530
class BranchExistsWithoutWorkingTree(PathError):
355
 
    """Directory contains a branch, but no working tree \
356
 
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
531
 
 
532
    _fmt = "Directory contains a branch, but no working tree \
 
533
(use bzr checkout if you wish to build a working tree): %(path)s"
357
534
 
358
535
 
359
536
class AtomicFileAlreadyClosed(PathError):
360
 
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
537
 
 
538
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
539
            " %(path)s")
361
540
 
362
541
    def __init__(self, path, function):
363
542
        PathError.__init__(self, path=path, extra=None)
365
544
 
366
545
 
367
546
class InaccessibleParent(PathError):
368
 
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
547
 
 
548
    _fmt = ("Parent not accessible given base %(base)s and"
 
549
            " relative path %(path)s")
369
550
 
370
551
    def __init__(self, path, base):
371
552
        PathError.__init__(self, path)
372
553
        self.base = base
373
554
 
374
555
 
375
 
class NoRepositoryPresent(BzrNewError):
376
 
    """No repository present: %(path)r"""
 
556
class NoRepositoryPresent(BzrError):
 
557
 
 
558
    _fmt = "No repository present: %(path)r"
377
559
    def __init__(self, bzrdir):
378
 
        BzrNewError.__init__(self)
 
560
        BzrError.__init__(self)
379
561
        self.path = bzrdir.transport.clone('..').base
380
562
 
381
563
 
382
 
class FileInWrongBranch(BzrNewError):
383
 
    """File %(path)s in not in branch %(branch_base)s."""
 
564
class FileInWrongBranch(BzrError):
 
565
 
 
566
    _fmt = "File %(path)s in not in branch %(branch_base)s."
384
567
 
385
568
    def __init__(self, branch, path):
386
 
        BzrNewError.__init__(self)
 
569
        BzrError.__init__(self)
387
570
        self.branch = branch
388
571
        self.branch_base = branch.base
389
572
        self.path = path
390
573
 
391
574
 
392
 
class UnsupportedFormatError(BzrNewError):
393
 
    """Unsupported branch format: %(format)s"""
394
 
 
395
 
 
396
 
class UnknownFormatError(BzrNewError):
397
 
    """Unknown branch format: %(format)r"""
398
 
 
399
 
 
400
 
class IncompatibleFormat(BzrNewError):
401
 
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
575
class UnsupportedFormatError(BzrError):
 
576
 
 
577
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
578
 
 
579
 
 
580
class UnknownFormatError(BzrError):
 
581
    
 
582
    _fmt = "Unknown branch format: %(format)r"
 
583
 
 
584
 
 
585
class IncompatibleFormat(BzrError):
 
586
    
 
587
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
402
588
 
403
589
    def __init__(self, format, bzrdir_format):
404
 
        BzrNewError.__init__(self)
 
590
        BzrError.__init__(self)
405
591
        self.format = format
406
592
        self.bzrdir = bzrdir_format
407
593
 
408
594
 
409
 
class IncompatibleRevision(BzrNewError):
410
 
    """Revision is not compatible with %(repo_format)s"""
 
595
class IncompatibleRepositories(BzrError):
 
596
 
 
597
    _fmt = "Repository %(target)s is not compatible with repository"\
 
598
        " %(source)s"
 
599
 
 
600
    def __init__(self, source, target):
 
601
        BzrError.__init__(self, target=target, source=source)
 
602
 
 
603
 
 
604
class IncompatibleRevision(BzrError):
 
605
    
 
606
    _fmt = "Revision is not compatible with %(repo_format)s"
411
607
 
412
608
    def __init__(self, repo_format):
413
 
        BzrNewError.__init__(self)
 
609
        BzrError.__init__(self)
414
610
        self.repo_format = repo_format
415
611
 
416
612
 
417
 
class NotVersionedError(BzrNewError):
418
 
    """%(path)s is not versioned"""
419
 
    def __init__(self, path):
420
 
        BzrNewError.__init__(self)
421
 
        self.path = path
422
 
 
423
 
 
424
 
class PathsNotVersionedError(BzrNewError):
425
 
    # used when reporting several paths are not versioned
426
 
    """Path(s) are not versioned: %(paths_as_string)s"""
 
613
class AlreadyVersionedError(BzrError):
 
614
    """Used when a path is expected not to be versioned, but it is."""
 
615
 
 
616
    _fmt = "%(context_info)s%(path)s is already versioned"
 
617
 
 
618
    def __init__(self, path, context_info=None):
 
619
        """Construct a new AlreadyVersionedError.
 
620
 
 
621
        :param path: This is the path which is versioned,
 
622
        which should be in a user friendly form.
 
623
        :param context_info: If given, this is information about the context,
 
624
        which could explain why this is expected to not be versioned.
 
625
        """
 
626
        BzrError.__init__(self)
 
627
        self.path = path
 
628
        if context_info is None:
 
629
            self.context_info = ''
 
630
        else:
 
631
            self.context_info = context_info + ". "
 
632
 
 
633
 
 
634
class NotVersionedError(BzrError):
 
635
    """Used when a path is expected to be versioned, but it is not."""
 
636
 
 
637
    _fmt = "%(context_info)s%(path)s is not versioned"
 
638
 
 
639
    def __init__(self, path, context_info=None):
 
640
        """Construct a new NotVersionedError.
 
641
 
 
642
        :param path: This is the path which is not versioned,
 
643
        which should be in a user friendly form.
 
644
        :param context_info: If given, this is information about the context,
 
645
        which could explain why this is expected to be versioned.
 
646
        """
 
647
        BzrError.__init__(self)
 
648
        self.path = path
 
649
        if context_info is None:
 
650
            self.context_info = ''
 
651
        else:
 
652
            self.context_info = context_info + ". "
 
653
 
 
654
 
 
655
class PathsNotVersionedError(BzrError):
 
656
    """Used when reporting several paths which are not versioned"""
 
657
 
 
658
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
427
659
 
428
660
    def __init__(self, paths):
429
661
        from bzrlib.osutils import quotefn
430
 
        BzrNewError.__init__(self)
 
662
        BzrError.__init__(self)
431
663
        self.paths = paths
432
664
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
433
665
 
434
666
 
435
 
class PathsDoNotExist(BzrNewError):
436
 
    """Path(s) do not exist: %(paths_as_string)s"""
 
667
class PathsDoNotExist(BzrError):
 
668
 
 
669
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
437
670
 
438
671
    # used when reporting that paths are neither versioned nor in the working
439
672
    # tree
440
673
 
441
 
    def __init__(self, paths):
 
674
    def __init__(self, paths, extra=None):
442
675
        # circular import
443
676
        from bzrlib.osutils import quotefn
444
 
        BzrNewError.__init__(self)
 
677
        BzrError.__init__(self)
445
678
        self.paths = paths
446
679
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
447
 
 
448
 
 
449
 
class BadFileKindError(BzrNewError):
450
 
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
451
 
 
452
 
 
453
 
class ForbiddenControlFileError(BzrNewError):
454
 
    """Cannot operate on %(filename)s because it is a control file"""
455
 
 
456
 
 
457
 
class LockError(BzrNewError):
458
 
    """Lock error: %(message)s"""
 
680
        if extra:
 
681
            self.extra = ': ' + str(extra)
 
682
        else:
 
683
            self.extra = ''
 
684
 
 
685
 
 
686
class BadFileKindError(BzrError):
 
687
 
 
688
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
689
 
 
690
    def __init__(self, filename, kind):
 
691
        BzrError.__init__(self, filename=filename, kind=kind)
 
692
 
 
693
 
 
694
class ForbiddenControlFileError(BzrError):
 
695
 
 
696
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
697
 
 
698
 
 
699
class LockError(BzrError):
 
700
 
 
701
    _fmt = "Lock error: %(msg)s"
 
702
 
 
703
    internal_error = True
 
704
 
459
705
    # All exceptions from the lock/unlock functions should be from
460
706
    # this exception class.  They will be translated as necessary. The
461
707
    # original exception is available as e.original_error
462
708
    #
463
709
    # New code should prefer to raise specific subclasses
464
710
    def __init__(self, message):
465
 
        self.message = message
 
711
        # Python 2.5 uses a slot for StandardError.message,
 
712
        # so use a different variable name
 
713
        # so it is exposed in self.__dict__
 
714
        self.msg = message
 
715
 
 
716
 
 
717
class LockActive(LockError):
 
718
 
 
719
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
720
 
 
721
    internal_error = False
 
722
 
 
723
    def __init__(self, lock_description):
 
724
        self.lock_description = lock_description
466
725
 
467
726
 
468
727
class CommitNotPossible(LockError):
469
 
    """A commit was attempted but we do not have a write lock open."""
 
728
 
 
729
    _fmt = "A commit was attempted but we do not have a write lock open."
 
730
 
470
731
    def __init__(self):
471
732
        pass
472
733
 
473
734
 
474
735
class AlreadyCommitted(LockError):
475
 
    """A rollback was requested, but is not able to be accomplished."""
 
736
 
 
737
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
738
 
476
739
    def __init__(self):
477
740
        pass
478
741
 
479
742
 
480
743
class ReadOnlyError(LockError):
481
 
    """A write attempt was made in a read only transaction on %(obj)s"""
 
744
 
 
745
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
746
 
 
747
    # TODO: There should also be an error indicating that you need a write
 
748
    # lock and don't have any lock at all... mbp 20070226
 
749
 
482
750
    def __init__(self, obj):
483
751
        self.obj = obj
484
752
 
485
753
 
486
 
class OutSideTransaction(BzrNewError):
487
 
    """A transaction related operation was attempted after the transaction finished."""
 
754
class ReadOnlyLockError(LockError):
 
755
 
 
756
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
757
 
 
758
    def __init__(self, fname, msg):
 
759
        LockError.__init__(self, '')
 
760
        self.fname = fname
 
761
        self.msg = msg
 
762
 
 
763
 
 
764
class OutSideTransaction(BzrError):
 
765
 
 
766
    _fmt = ("A transaction related operation was attempted after"
 
767
            " the transaction finished.")
488
768
 
489
769
 
490
770
class ObjectNotLocked(LockError):
491
 
    """%(obj)r is not locked"""
492
771
 
493
 
    is_user_error = False
 
772
    _fmt = "%(obj)r is not locked"
494
773
 
495
774
    # this can indicate that any particular object is not locked; see also
496
775
    # LockNotHeld which means that a particular *lock* object is not held by
500
779
 
501
780
 
502
781
class ReadOnlyObjectDirtiedError(ReadOnlyError):
503
 
    """Cannot change object %(obj)r in read only transaction"""
 
782
 
 
783
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
784
 
504
785
    def __init__(self, obj):
505
786
        self.obj = obj
506
787
 
507
788
 
508
789
class UnlockableTransport(LockError):
509
 
    """Cannot lock: transport is read only: %(transport)s"""
 
790
 
 
791
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
792
 
510
793
    def __init__(self, transport):
511
794
        self.transport = transport
512
795
 
513
796
 
514
797
class LockContention(LockError):
515
 
    """Could not acquire lock %(lock)s"""
516
 
    # TODO: show full url for lock, combining the transport and relative bits?
 
798
 
 
799
    _fmt = "Could not acquire lock %(lock)s"
 
800
    # TODO: show full url for lock, combining the transport and relative
 
801
    # bits?
 
802
 
 
803
    internal_error = False
 
804
 
517
805
    def __init__(self, lock):
518
806
        self.lock = lock
519
807
 
520
808
 
521
809
class LockBroken(LockError):
522
 
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
810
 
 
811
    _fmt = ("Lock was broken while still open: %(lock)s"
 
812
            " - check storage consistency!")
 
813
 
 
814
    internal_error = False
 
815
 
523
816
    def __init__(self, lock):
524
817
        self.lock = lock
525
818
 
526
819
 
527
820
class LockBreakMismatch(LockError):
528
 
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
821
 
 
822
    _fmt = ("Lock was released and re-acquired before being broken:"
 
823
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
824
 
 
825
    internal_error = False
 
826
 
529
827
    def __init__(self, lock, holder, target):
530
828
        self.lock = lock
531
829
        self.holder = holder
533
831
 
534
832
 
535
833
class LockNotHeld(LockError):
536
 
    """Lock not held: %(lock)s"""
 
834
 
 
835
    _fmt = "Lock not held: %(lock)s"
 
836
 
 
837
    internal_error = False
 
838
 
537
839
    def __init__(self, lock):
538
840
        self.lock = lock
539
841
 
540
842
 
541
 
class PointlessCommit(BzrNewError):
542
 
    """No changes to commit"""
543
 
 
544
 
 
545
 
class UpgradeReadonly(BzrNewError):
546
 
    """Upgrade URL cannot work with readonly URL's."""
547
 
 
548
 
 
549
 
class UpToDateFormat(BzrNewError):
550
 
    """The branch format %(format)s is already at the most recent format."""
 
843
class TokenLockingNotSupported(LockError):
 
844
 
 
845
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
846
 
 
847
    internal_error = True
 
848
 
 
849
    def __init__(self, obj):
 
850
        self.obj = obj
 
851
 
 
852
 
 
853
class TokenMismatch(LockBroken):
 
854
 
 
855
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
856
 
 
857
    internal_error = True
 
858
 
 
859
    def __init__(self, given_token, lock_token):
 
860
        self.given_token = given_token
 
861
        self.lock_token = lock_token
 
862
 
 
863
 
 
864
class PointlessCommit(BzrError):
 
865
 
 
866
    _fmt = "No changes to commit"
 
867
 
 
868
 
 
869
class CannotCommitSelectedFileMerge(BzrError):
 
870
 
 
871
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
872
        ' files %(files_str)s'
 
873
 
 
874
    def __init__(self, files):
 
875
        files_str = ', '.join(files)
 
876
        BzrError.__init__(self, files=files, files_str=files_str)
 
877
 
 
878
 
 
879
class UpgradeReadonly(BzrError):
 
880
 
 
881
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
882
 
 
883
 
 
884
class UpToDateFormat(BzrError):
 
885
 
 
886
    _fmt = "The branch format %(format)s is already at the most recent format."
551
887
 
552
888
    def __init__(self, format):
553
 
        BzrNewError.__init__(self)
 
889
        BzrError.__init__(self)
554
890
        self.format = format
555
891
 
556
892
 
557
893
class StrictCommitFailed(Exception):
558
 
    """Commit refused because there are unknowns in the tree."""
559
 
 
560
 
 
561
 
class NoSuchRevision(BzrNewError):
562
 
    """Branch %(branch)s has no revision %(revision)s"""
563
 
 
564
 
    is_user_error = False
 
894
 
 
895
    _fmt = "Commit refused because there are unknowns in the tree."
 
896
 
 
897
 
 
898
class NoSuchRevision(BzrError):
 
899
 
 
900
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
901
 
 
902
    internal_error = True
565
903
 
566
904
    def __init__(self, branch, revision):
567
 
        BzrNewError.__init__(self, branch=branch, revision=revision)
568
 
 
569
 
 
570
 
class NoSuchRevisionSpec(BzrNewError):
571
 
    """No namespace registered for string: %(spec)r"""
 
905
        BzrError.__init__(self, branch=branch, revision=revision)
 
906
 
 
907
 
 
908
class NotLeftParentDescendant(BzrError):
 
909
 
 
910
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
911
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
912
 
 
913
    internal_error = True
 
914
 
 
915
    def __init__(self, branch, old_revision, new_revision):
 
916
        BzrError.__init__(self, branch_location=branch.base,
 
917
                          old_revision=old_revision,
 
918
                          new_revision=new_revision)
 
919
 
 
920
 
 
921
class NoSuchRevisionSpec(BzrError):
 
922
 
 
923
    _fmt = "No namespace registered for string: %(spec)r"
572
924
 
573
925
    def __init__(self, spec):
574
 
        BzrNewError.__init__(self, spec=spec)
575
 
 
576
 
 
577
 
class InvalidRevisionSpec(BzrNewError):
578
 
    """Requested revision: '%(spec)s' does not exist in branch:
579
 
%(branch)s%(extra)s"""
 
926
        BzrError.__init__(self, spec=spec)
 
927
 
 
928
 
 
929
class NoSuchRevisionInTree(NoSuchRevision):
 
930
    """When using Tree.revision_tree, and the revision is not accessible."""
 
931
    
 
932
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
933
 
 
934
    def __init__(self, tree, revision_id):
 
935
        BzrError.__init__(self)
 
936
        self.tree = tree
 
937
        self.revision_id = revision_id
 
938
 
 
939
 
 
940
class InvalidRevisionSpec(BzrError):
 
941
 
 
942
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
943
            " %(branch)s%(extra)s")
580
944
 
581
945
    def __init__(self, spec, branch, extra=None):
582
 
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
946
        BzrError.__init__(self, branch=branch, spec=spec)
583
947
        if extra:
584
948
            self.extra = '\n' + str(extra)
585
949
        else:
587
951
 
588
952
 
589
953
class HistoryMissing(BzrError):
590
 
    def __init__(self, branch, object_type, object_id):
591
 
        self.branch = branch
592
 
        BzrError.__init__(self,
593
 
                          '%s is missing %s {%s}'
594
 
                          % (branch, object_type, object_id))
595
 
 
596
 
 
597
 
class DivergedBranches(BzrNewError):
598
 
    "These branches have diverged.  Use the merge command to reconcile them."""
599
 
 
600
 
    is_user_error = True
 
954
 
 
955
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
956
 
 
957
 
 
958
class AppendRevisionsOnlyViolation(BzrError):
 
959
 
 
960
    _fmt = ('Operation denied because it would change the main history,'
 
961
           ' which is not permitted by the append_revisions_only setting on'
 
962
           ' branch "%(location)s".')
 
963
 
 
964
    def __init__(self, location):
 
965
       import bzrlib.urlutils as urlutils
 
966
       location = urlutils.unescape_for_display(location, 'ascii')
 
967
       BzrError.__init__(self, location=location)
 
968
 
 
969
 
 
970
class DivergedBranches(BzrError):
 
971
 
 
972
    _fmt = ("These branches have diverged."
 
973
            " Use the merge command to reconcile them.")
 
974
 
 
975
    internal_error = False
601
976
 
602
977
    def __init__(self, branch1, branch2):
603
978
        self.branch1 = branch1
604
979
        self.branch2 = branch2
605
980
 
606
981
 
607
 
class UnrelatedBranches(BzrNewError):
608
 
    "Branches have no common ancestor, and no merge base revision was specified."
609
 
 
610
 
    is_user_error = True
611
 
 
612
 
 
613
 
class NoCommonAncestor(BzrNewError):
614
 
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
982
class NotLefthandHistory(BzrError):
 
983
 
 
984
    _fmt = "Supplied history does not follow left-hand parents"
 
985
 
 
986
    internal_error = True
 
987
 
 
988
    def __init__(self, history):
 
989
        BzrError.__init__(self, history=history)
 
990
 
 
991
 
 
992
class UnrelatedBranches(BzrError):
 
993
 
 
994
    _fmt = ("Branches have no common ancestor, and"
 
995
            " no merge base revision was specified.")
 
996
 
 
997
    internal_error = False
 
998
 
 
999
 
 
1000
class NoCommonAncestor(BzrError):
 
1001
    
 
1002
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
615
1003
 
616
1004
    def __init__(self, revision_a, revision_b):
617
1005
        self.revision_a = revision_a
619
1007
 
620
1008
 
621
1009
class NoCommonRoot(BzrError):
 
1010
 
 
1011
    _fmt = ("Revisions are not derived from the same root: "
 
1012
           "%(revision_a)s %(revision_b)s.")
 
1013
 
622
1014
    def __init__(self, revision_a, revision_b):
623
 
        msg = "Revisions are not derived from the same root: %s %s." \
624
 
            % (revision_a, revision_b) 
625
 
        BzrError.__init__(self, msg)
626
 
 
 
1015
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
627
1016
 
628
1017
 
629
1018
class NotAncestor(BzrError):
 
1019
 
 
1020
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1021
 
630
1022
    def __init__(self, rev_id, not_ancestor_id):
631
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
632
 
                                                        rev_id)
633
 
        BzrError.__init__(self, msg)
634
 
        self.rev_id = rev_id
635
 
        self.not_ancestor_id = not_ancestor_id
 
1023
        BzrError.__init__(self, rev_id=rev_id,
 
1024
            not_ancestor_id=not_ancestor_id)
636
1025
 
637
1026
 
638
1027
class InstallFailed(BzrError):
 
1028
 
639
1029
    def __init__(self, revisions):
640
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
1030
        revision_str = ", ".join(str(r) for r in revisions)
 
1031
        msg = "Could not install revisions:\n%s" % revision_str
641
1032
        BzrError.__init__(self, msg)
642
1033
        self.revisions = revisions
643
1034
 
644
1035
 
645
1036
class AmbiguousBase(BzrError):
 
1037
 
646
1038
    def __init__(self, bases):
647
1039
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
648
1040
                DeprecationWarning)
649
 
        msg = "The correct base is unclear, because %s are all equally close" %\
650
 
            ", ".join(bases)
 
1041
        msg = ("The correct base is unclear, because %s are all equally close"
 
1042
                % ", ".join(bases))
651
1043
        BzrError.__init__(self, msg)
652
1044
        self.bases = bases
653
1045
 
654
1046
 
655
 
class NoCommits(BzrNewError):
656
 
    """Branch %(branch)s has no commits."""
 
1047
class NoCommits(BzrError):
 
1048
 
 
1049
    _fmt = "Branch %(branch)s has no commits."
657
1050
 
658
1051
    def __init__(self, branch):
659
 
        BzrNewError.__init__(self, branch=branch)
 
1052
        BzrError.__init__(self, branch=branch)
660
1053
 
661
1054
 
662
1055
class UnlistableStore(BzrError):
 
1056
 
663
1057
    def __init__(self, store):
664
1058
        BzrError.__init__(self, "Store %s is not listable" % store)
665
1059
 
666
1060
 
667
1061
 
668
1062
class UnlistableBranch(BzrError):
 
1063
 
669
1064
    def __init__(self, br):
670
1065
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
671
1066
 
672
1067
 
673
 
class BoundBranchOutOfDate(BzrNewError):
674
 
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
1068
class BoundBranchOutOfDate(BzrError):
 
1069
 
 
1070
    _fmt = ("Bound branch %(branch)s is out of date"
 
1071
            " with master branch %(master)s.")
 
1072
 
675
1073
    def __init__(self, branch, master):
676
 
        BzrNewError.__init__(self)
 
1074
        BzrError.__init__(self)
677
1075
        self.branch = branch
678
1076
        self.master = master
679
1077
 
680
1078
        
681
 
class CommitToDoubleBoundBranch(BzrNewError):
682
 
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
1079
class CommitToDoubleBoundBranch(BzrError):
 
1080
 
 
1081
    _fmt = ("Cannot commit to branch %(branch)s."
 
1082
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1083
 
683
1084
    def __init__(self, branch, master, remote):
684
 
        BzrNewError.__init__(self)
 
1085
        BzrError.__init__(self)
685
1086
        self.branch = branch
686
1087
        self.master = master
687
1088
        self.remote = remote
688
1089
 
689
1090
 
690
 
class OverwriteBoundBranch(BzrNewError):
691
 
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
1091
class OverwriteBoundBranch(BzrError):
 
1092
 
 
1093
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1094
 
692
1095
    def __init__(self, branch):
693
 
        BzrNewError.__init__(self)
 
1096
        BzrError.__init__(self)
694
1097
        self.branch = branch
695
1098
 
696
1099
 
697
 
class BoundBranchConnectionFailure(BzrNewError):
698
 
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
1100
class BoundBranchConnectionFailure(BzrError):
 
1101
 
 
1102
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1103
            " => %(target)s: %(error)s")
 
1104
 
699
1105
    def __init__(self, branch, target, error):
700
 
        BzrNewError.__init__(self)
 
1106
        BzrError.__init__(self)
701
1107
        self.branch = branch
702
1108
        self.target = target
703
1109
        self.error = error
704
1110
 
705
1111
 
706
 
class WeaveError(BzrNewError):
707
 
    """Error in processing weave: %(message)s"""
 
1112
class WeaveError(BzrError):
 
1113
 
 
1114
    _fmt = "Error in processing weave: %(message)s"
708
1115
 
709
1116
    def __init__(self, message=None):
710
 
        BzrNewError.__init__(self)
 
1117
        BzrError.__init__(self)
711
1118
        self.message = message
712
1119
 
713
1120
 
714
1121
class WeaveRevisionAlreadyPresent(WeaveError):
715
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
1122
 
 
1123
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1124
 
716
1125
    def __init__(self, revision_id, weave):
717
1126
 
718
1127
        WeaveError.__init__(self)
721
1130
 
722
1131
 
723
1132
class WeaveRevisionNotPresent(WeaveError):
724
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
1133
 
 
1134
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
725
1135
 
726
1136
    def __init__(self, revision_id, weave):
727
1137
        WeaveError.__init__(self)
730
1140
 
731
1141
 
732
1142
class WeaveFormatError(WeaveError):
733
 
    """Weave invariant violated: %(what)s"""
 
1143
 
 
1144
    _fmt = "Weave invariant violated: %(what)s"
734
1145
 
735
1146
    def __init__(self, what):
736
1147
        WeaveError.__init__(self)
738
1149
 
739
1150
 
740
1151
class WeaveParentMismatch(WeaveError):
741
 
    """Parents are mismatched between two revisions."""
 
1152
 
 
1153
    _fmt = "Parents are mismatched between two revisions."
742
1154
    
743
1155
 
744
1156
class WeaveInvalidChecksum(WeaveError):
745
 
    """Text did not match it's checksum: %(message)s"""
746
 
 
747
 
 
748
 
class WeaveTextDiffers(WeaveError):
749
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
750
 
 
751
 
    def __init__(self, revision_id, weave_a, weave_b):
752
 
        WeaveError.__init__(self)
753
 
        self.revision_id = revision_id
754
 
        self.weave_a = weave_a
755
 
        self.weave_b = weave_b
756
 
 
757
 
 
758
 
class WeaveTextDiffers(WeaveError):
759
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
760
 
 
761
 
    def __init__(self, revision_id, weave_a, weave_b):
762
 
        WeaveError.__init__(self)
763
 
        self.revision_id = revision_id
764
 
        self.weave_a = weave_a
765
 
        self.weave_b = weave_b
766
 
 
767
 
 
768
 
class VersionedFileError(BzrNewError):
769
 
    """Versioned file error."""
 
1157
 
 
1158
    _fmt = "Text did not match it's checksum: %(message)s"
 
1159
 
 
1160
 
 
1161
class WeaveTextDiffers(WeaveError):
 
1162
 
 
1163
    _fmt = ("Weaves differ on text content. Revision:"
 
1164
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1165
 
 
1166
    def __init__(self, revision_id, weave_a, weave_b):
 
1167
        WeaveError.__init__(self)
 
1168
        self.revision_id = revision_id
 
1169
        self.weave_a = weave_a
 
1170
        self.weave_b = weave_b
 
1171
 
 
1172
 
 
1173
class WeaveTextDiffers(WeaveError):
 
1174
 
 
1175
    _fmt = ("Weaves differ on text content. Revision:"
 
1176
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1177
 
 
1178
    def __init__(self, revision_id, weave_a, weave_b):
 
1179
        WeaveError.__init__(self)
 
1180
        self.revision_id = revision_id
 
1181
        self.weave_a = weave_a
 
1182
        self.weave_b = weave_b
 
1183
 
 
1184
 
 
1185
class VersionedFileError(BzrError):
 
1186
    
 
1187
    _fmt = "Versioned file error"
770
1188
 
771
1189
 
772
1190
class RevisionNotPresent(VersionedFileError):
773
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
1191
    
 
1192
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
774
1193
 
775
1194
    def __init__(self, revision_id, file_id):
776
1195
        VersionedFileError.__init__(self)
779
1198
 
780
1199
 
781
1200
class RevisionAlreadyPresent(VersionedFileError):
782
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
1201
    
 
1202
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
783
1203
 
784
1204
    def __init__(self, revision_id, file_id):
785
1205
        VersionedFileError.__init__(self)
787
1207
        self.file_id = file_id
788
1208
 
789
1209
 
790
 
class KnitError(BzrNewError):
791
 
    """Knit error"""
 
1210
class KnitError(BzrError):
 
1211
    
 
1212
    _fmt = "Knit error"
 
1213
 
 
1214
    internal_error = True
792
1215
 
793
1216
 
794
1217
class KnitHeaderError(KnitError):
795
 
    """Knit header error: %(badline)r unexpected"""
796
 
 
797
 
    def __init__(self, badline):
 
1218
 
 
1219
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1220
 
 
1221
    def __init__(self, badline, filename):
798
1222
        KnitError.__init__(self)
799
1223
        self.badline = badline
 
1224
        self.filename = filename
800
1225
 
801
1226
 
802
1227
class KnitCorrupt(KnitError):
803
 
    """Knit %(filename)s corrupt: %(how)s"""
 
1228
 
 
1229
    _fmt = "Knit %(filename)s corrupt: %(how)s"
804
1230
 
805
1231
    def __init__(self, filename, how):
806
1232
        KnitError.__init__(self)
808
1234
        self.how = how
809
1235
 
810
1236
 
811
 
class NoSuchExportFormat(BzrNewError):
812
 
    """Export format %(format)r not supported"""
 
1237
class KnitIndexUnknownMethod(KnitError):
 
1238
    """Raised when we don't understand the storage method.
 
1239
 
 
1240
    Currently only 'fulltext' and 'line-delta' are supported.
 
1241
    """
 
1242
    
 
1243
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1244
            " in options: %(options)r")
 
1245
 
 
1246
    def __init__(self, filename, options):
 
1247
        KnitError.__init__(self)
 
1248
        self.filename = filename
 
1249
        self.options = options
 
1250
 
 
1251
 
 
1252
class NoSuchExportFormat(BzrError):
 
1253
    
 
1254
    _fmt = "Export format %(format)r not supported"
 
1255
 
813
1256
    def __init__(self, format):
814
 
        BzrNewError.__init__(self)
 
1257
        BzrError.__init__(self)
815
1258
        self.format = format
816
1259
 
817
1260
 
818
 
class TransportError(BzrNewError):
819
 
    """Transport error: %(msg)s %(orig_error)s"""
 
1261
class TransportError(BzrError):
 
1262
    
 
1263
    _fmt = "Transport error: %(msg)s %(orig_error)s"
820
1264
 
821
1265
    def __init__(self, msg=None, orig_error=None):
822
1266
        if msg is None and orig_error is not None:
827
1271
            msg =  ''
828
1272
        self.msg = msg
829
1273
        self.orig_error = orig_error
830
 
        BzrNewError.__init__(self)
 
1274
        BzrError.__init__(self)
 
1275
 
 
1276
 
 
1277
class TooManyConcurrentRequests(BzrError):
 
1278
 
 
1279
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1280
            " Be sure to finish_writing and finish_reading on the"
 
1281
            " currently open request.")
 
1282
 
 
1283
    internal_error = True
 
1284
 
 
1285
    def __init__(self, medium):
 
1286
        self.medium = medium
831
1287
 
832
1288
 
833
1289
class SmartProtocolError(TransportError):
834
 
    """Generic bzr smart protocol error: %(details)s"""
 
1290
 
 
1291
    _fmt = "Generic bzr smart protocol error: %(details)s"
835
1292
 
836
1293
    def __init__(self, details):
837
1294
        self.details = details
839
1296
 
840
1297
# A set of semi-meaningful errors which can be thrown
841
1298
class TransportNotPossible(TransportError):
842
 
    """Transport operation not possible: %(msg)s %(orig_error)s"""
 
1299
 
 
1300
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
843
1301
 
844
1302
 
845
1303
class ConnectionError(TransportError):
846
 
    """Connection error: %(msg)s %(orig_error)s"""
 
1304
 
 
1305
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1306
 
 
1307
 
 
1308
class SocketConnectionError(ConnectionError):
 
1309
 
 
1310
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1311
 
 
1312
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1313
        if msg is None:
 
1314
            msg = 'Failed to connect to'
 
1315
        if orig_error is None:
 
1316
            orig_error = ''
 
1317
        else:
 
1318
            orig_error = '; ' + str(orig_error)
 
1319
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1320
        self.host = host
 
1321
        if port is None:
 
1322
            self.port = ''
 
1323
        else:
 
1324
            self.port = ':%s' % port
847
1325
 
848
1326
 
849
1327
class ConnectionReset(TransportError):
850
 
    """Connection closed: %(msg)s %(orig_error)s"""
 
1328
 
 
1329
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
851
1330
 
852
1331
 
853
1332
class InvalidRange(TransportError):
854
 
    """Invalid range access in %(path)s at %(offset)s."""
 
1333
 
 
1334
    _fmt = "Invalid range access in %(path)s at %(offset)s."
855
1335
    
856
1336
    def __init__(self, path, offset):
857
1337
        TransportError.__init__(self, ("Invalid range access in %s at %d"
861
1341
 
862
1342
 
863
1343
class InvalidHttpResponse(TransportError):
864
 
    """Invalid http response for %(path)s: %(msg)s"""
 
1344
 
 
1345
    _fmt = "Invalid http response for %(path)s: %(msg)s"
865
1346
 
866
1347
    def __init__(self, path, msg, orig_error=None):
867
1348
        self.path = path
869
1350
 
870
1351
 
871
1352
class InvalidHttpRange(InvalidHttpResponse):
872
 
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
1353
 
 
1354
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
873
1355
    
874
1356
    def __init__(self, path, range, msg):
875
1357
        self.range = range
877
1359
 
878
1360
 
879
1361
class InvalidHttpContentType(InvalidHttpResponse):
880
 
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
1362
 
 
1363
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
881
1364
    
882
1365
    def __init__(self, path, ctype, msg):
883
1366
        self.ctype = ctype
884
1367
        InvalidHttpResponse.__init__(self, path, msg)
885
1368
 
886
1369
 
 
1370
class RedirectRequested(TransportError):
 
1371
 
 
1372
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1373
 
 
1374
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1375
        self.source = source
 
1376
        self.target = target
 
1377
        if is_permament:
 
1378
            self.permanently = ' permanently'
 
1379
        else:
 
1380
            self.permanently = ''
 
1381
        self.is_permament = is_permament
 
1382
        self._qualified_proto = qual_proto
 
1383
        TransportError.__init__(self)
 
1384
 
 
1385
    def _requalify_url(self, url):
 
1386
        """Restore the qualified proto in front of the url"""
 
1387
        # When this exception is raised, source and target are in
 
1388
        # user readable format. But some transports may use a
 
1389
        # different proto (http+urllib:// will present http:// to
 
1390
        # the user. If a qualified proto is specified, the code
 
1391
        # trapping the exception can get the qualified urls to
 
1392
        # properly handle the redirection themself (creating a
 
1393
        # new transport object from the target url for example).
 
1394
        # But checking that the scheme of the original and
 
1395
        # redirected urls are the same can be tricky. (see the
 
1396
        # FIXME in BzrDir.open_from_transport for the unique use
 
1397
        # case so far).
 
1398
        if self._qualified_proto is None:
 
1399
            return url
 
1400
 
 
1401
        # The TODO related to NotBranchError mention that doing
 
1402
        # that kind of manipulation on the urls may not be the
 
1403
        # exception object job. On the other hand, this object is
 
1404
        # the interface between the code and the user so
 
1405
        # presenting the urls in different ways is indeed its
 
1406
        # job...
 
1407
        import urlparse
 
1408
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1409
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1410
                                   query, fragment))
 
1411
 
 
1412
    def get_source_url(self):
 
1413
        return self._requalify_url(self.source)
 
1414
 
 
1415
    def get_target_url(self):
 
1416
        return self._requalify_url(self.target)
 
1417
 
 
1418
 
 
1419
class TooManyRedirections(TransportError):
 
1420
 
 
1421
    _fmt = "Too many redirections"
 
1422
 
887
1423
class ConflictsInTree(BzrError):
888
 
    def __init__(self):
889
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1424
 
 
1425
    _fmt = "Working tree has conflicts."
890
1426
 
891
1427
 
892
1428
class ParseConfigError(BzrError):
 
1429
 
893
1430
    def __init__(self, errors, filename):
894
1431
        if filename is None:
895
1432
            filename = ""
898
1435
        BzrError.__init__(self, message)
899
1436
 
900
1437
 
 
1438
class NoEmailInUsername(BzrError):
 
1439
 
 
1440
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1441
 
 
1442
    def __init__(self, username):
 
1443
        BzrError.__init__(self)
 
1444
        self.username = username
 
1445
 
 
1446
 
901
1447
class SigningFailed(BzrError):
 
1448
 
 
1449
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1450
 
902
1451
    def __init__(self, command_line):
903
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
904
 
                               % command_line)
 
1452
        BzrError.__init__(self, command_line=command_line)
905
1453
 
906
1454
 
907
1455
class WorkingTreeNotRevision(BzrError):
 
1456
 
 
1457
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1458
            " the last commit, but weave merge requires that it be"
 
1459
            " unchanged")
 
1460
 
908
1461
    def __init__(self, tree):
909
 
        BzrError.__init__(self, "The working tree for %s has changed since"
910
 
                          " last commit, but weave merge requires that it be"
911
 
                          " unchanged." % tree.basedir)
912
 
 
913
 
 
914
 
class CantReprocessAndShowBase(BzrNewError):
915
 
    """Can't reprocess and show base.
916
 
Reprocessing obscures relationship of conflicting lines to base."""
917
 
 
918
 
 
919
 
class GraphCycleError(BzrNewError):
920
 
    """Cycle in graph %(graph)r"""
 
1462
        BzrError.__init__(self, basedir=tree.basedir)
 
1463
 
 
1464
 
 
1465
class CantReprocessAndShowBase(BzrError):
 
1466
 
 
1467
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1468
           "the relationship of conflicting lines to the base")
 
1469
 
 
1470
 
 
1471
class GraphCycleError(BzrError):
 
1472
 
 
1473
    _fmt = "Cycle in graph %(graph)r"
 
1474
 
921
1475
    def __init__(self, graph):
922
 
        BzrNewError.__init__(self)
 
1476
        BzrError.__init__(self)
923
1477
        self.graph = graph
924
1478
 
925
1479
 
926
 
class NotConflicted(BzrNewError):
927
 
    """File %(filename)s is not conflicted."""
 
1480
class WritingCompleted(BzrError):
 
1481
 
 
1482
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1483
            "called upon it - accept bytes may not be called anymore.")
 
1484
 
 
1485
    internal_error = True
 
1486
 
 
1487
    def __init__(self, request):
 
1488
        self.request = request
 
1489
 
 
1490
 
 
1491
class WritingNotComplete(BzrError):
 
1492
 
 
1493
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1494
            "called upon it - until the write phase is complete no "
 
1495
            "data may be read.")
 
1496
 
 
1497
    internal_error = True
 
1498
 
 
1499
    def __init__(self, request):
 
1500
        self.request = request
 
1501
 
 
1502
 
 
1503
class NotConflicted(BzrError):
 
1504
 
 
1505
    _fmt = "File %(filename)s is not conflicted."
928
1506
 
929
1507
    def __init__(self, filename):
930
 
        BzrNewError.__init__(self)
 
1508
        BzrError.__init__(self)
931
1509
        self.filename = filename
932
1510
 
933
1511
 
 
1512
class MediumNotConnected(BzrError):
 
1513
 
 
1514
    _fmt = """The medium '%(medium)s' is not connected."""
 
1515
 
 
1516
    internal_error = True
 
1517
 
 
1518
    def __init__(self, medium):
 
1519
        self.medium = medium
 
1520
 
 
1521
 
934
1522
class MustUseDecorated(Exception):
935
 
    """A decorating function has requested its original command be used.
936
 
    
937
 
    This should never escape bzr, so does not need to be printable.
938
 
    """
939
 
 
940
 
 
941
 
class NoBundleFound(BzrNewError):
942
 
    """No bundle was found in %(filename)s"""
 
1523
 
 
1524
    _fmt = "A decorating function has requested its original command be used."
 
1525
 
 
1526
 
 
1527
class NoBundleFound(BzrError):
 
1528
 
 
1529
    _fmt = "No bundle was found in %(filename)s"
 
1530
 
943
1531
    def __init__(self, filename):
944
 
        BzrNewError.__init__(self)
 
1532
        BzrError.__init__(self)
945
1533
        self.filename = filename
946
1534
 
947
1535
 
948
 
class BundleNotSupported(BzrNewError):
949
 
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
1536
class BundleNotSupported(BzrError):
 
1537
 
 
1538
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1539
 
950
1540
    def __init__(self, version, msg):
951
 
        BzrNewError.__init__(self)
 
1541
        BzrError.__init__(self)
952
1542
        self.version = version
953
1543
        self.msg = msg
954
1544
 
955
1545
 
956
 
class MissingText(BzrNewError):
957
 
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
1546
class MissingText(BzrError):
 
1547
 
 
1548
    _fmt = ("Branch %(base)s is missing revision"
 
1549
            " %(text_revision)s of %(file_id)s")
958
1550
 
959
1551
    def __init__(self, branch, text_revision, file_id):
960
 
        BzrNewError.__init__(self)
 
1552
        BzrError.__init__(self)
961
1553
        self.branch = branch
962
1554
        self.base = branch.base
963
1555
        self.text_revision = text_revision
964
1556
        self.file_id = file_id
965
1557
 
966
1558
 
967
 
class DuplicateKey(BzrNewError):
968
 
    """Key %(key)s is already present in map"""
969
 
 
970
 
 
971
 
class MalformedTransform(BzrNewError):
972
 
    """Tree transform is malformed %(conflicts)r"""
973
 
 
974
 
 
975
 
class BzrBadParameter(BzrNewError):
976
 
    """A bad parameter : %(param)s is not usable.
977
 
    
978
 
    This exception should never be thrown, but it is a base class for all
979
 
    parameter-to-function errors.
980
 
    """
 
1559
class DuplicateFileId(BzrError):
 
1560
 
 
1561
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1562
 
 
1563
    def __init__(self, file_id, entry):
 
1564
        BzrError.__init__(self)
 
1565
        self.file_id = file_id
 
1566
        self.entry = entry
 
1567
 
 
1568
 
 
1569
class DuplicateKey(BzrError):
 
1570
 
 
1571
    _fmt = "Key %(key)s is already present in map"
 
1572
 
 
1573
 
 
1574
class DuplicateHelpPrefix(BzrError):
 
1575
 
 
1576
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1577
 
 
1578
    def __init__(self, prefix):
 
1579
        self.prefix = prefix
 
1580
 
 
1581
 
 
1582
class MalformedTransform(BzrError):
 
1583
 
 
1584
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1585
 
 
1586
 
 
1587
class NoFinalPath(BzrError):
 
1588
 
 
1589
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1590
            "file-id: %(file_id)r\n"
 
1591
            "root trans-id: %(root_trans_id)r\n")
 
1592
 
 
1593
    def __init__(self, trans_id, transform):
 
1594
        self.trans_id = trans_id
 
1595
        self.file_id = transform.final_file_id(trans_id)
 
1596
        self.root_trans_id = transform.root
 
1597
 
 
1598
 
 
1599
class BzrBadParameter(BzrError):
 
1600
 
 
1601
    _fmt = "Bad parameter: %(param)r"
 
1602
 
 
1603
    internal_error = True
 
1604
 
 
1605
    # This exception should never be thrown, but it is a base class for all
 
1606
    # parameter-to-function errors.
 
1607
 
981
1608
    def __init__(self, param):
982
 
        BzrNewError.__init__(self)
 
1609
        BzrError.__init__(self)
983
1610
        self.param = param
984
1611
 
985
1612
 
986
1613
class BzrBadParameterNotUnicode(BzrBadParameter):
987
 
    """Parameter %(param)s is neither unicode nor utf8."""
988
 
 
989
 
 
990
 
class ReusingTransform(BzrNewError):
991
 
    """Attempt to reuse a transform that has already been applied."""
992
 
 
993
 
 
994
 
class CantMoveRoot(BzrNewError):
995
 
    """Moving the root directory is not supported at this time"""
 
1614
 
 
1615
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1616
 
 
1617
 
 
1618
class ReusingTransform(BzrError):
 
1619
 
 
1620
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1621
 
 
1622
 
 
1623
class CantMoveRoot(BzrError):
 
1624
 
 
1625
    _fmt = "Moving the root directory is not supported at this time"
 
1626
 
 
1627
 
 
1628
class BzrMoveFailedError(BzrError):
 
1629
 
 
1630
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1631
 
 
1632
    def __init__(self, from_path='', to_path='', extra=None):
 
1633
        BzrError.__init__(self)
 
1634
        if extra:
 
1635
            self.extra = ': ' + str(extra)
 
1636
        else:
 
1637
            self.extra = ''
 
1638
 
 
1639
        has_from = len(from_path) > 0
 
1640
        has_to = len(to_path) > 0
 
1641
        if has_from:
 
1642
            self.from_path = osutils.splitpath(from_path)[-1]
 
1643
        else:
 
1644
            self.from_path = ''
 
1645
 
 
1646
        if has_to:
 
1647
            self.to_path = osutils.splitpath(to_path)[-1]
 
1648
        else:
 
1649
            self.to_path = ''
 
1650
 
 
1651
        self.operator = ""
 
1652
        if has_from and has_to:
 
1653
            self.operator = " =>"
 
1654
        elif has_from:
 
1655
            self.from_path = "from " + from_path
 
1656
        elif has_to:
 
1657
            self.operator = "to"
 
1658
        else:
 
1659
            self.operator = "file"
 
1660
 
 
1661
 
 
1662
class BzrRenameFailedError(BzrMoveFailedError):
 
1663
 
 
1664
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1665
 
 
1666
    def __init__(self, from_path, to_path, extra=None):
 
1667
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1668
 
 
1669
class BzrRemoveChangedFilesError(BzrError):
 
1670
    """Used when user is trying to remove changed files."""
 
1671
 
 
1672
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1673
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1674
 
 
1675
    def __init__(self, tree_delta):
 
1676
        BzrError.__init__(self)
 
1677
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1678
        #self.paths_as_string = '\n'.join(changed_files)
 
1679
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
996
1680
 
997
1681
 
998
1682
class BzrBadParameterNotString(BzrBadParameter):
999
 
    """Parameter %(param)s is not a string or unicode string."""
 
1683
 
 
1684
    _fmt = "Parameter %(param)s is not a string or unicode string."
1000
1685
 
1001
1686
 
1002
1687
class BzrBadParameterMissing(BzrBadParameter):
1003
 
    """Parameter $(param)s is required but not present."""
 
1688
 
 
1689
    _fmt = "Parameter $(param)s is required but not present."
1004
1690
 
1005
1691
 
1006
1692
class BzrBadParameterUnicode(BzrBadParameter):
1007
 
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
1693
 
 
1694
    _fmt = ("Parameter %(param)s is unicode but"
 
1695
            " only byte-strings are permitted.")
1008
1696
 
1009
1697
 
1010
1698
class BzrBadParameterContainsNewline(BzrBadParameter):
1011
 
    """Parameter %(param)s contains a newline."""
1012
 
 
1013
 
 
1014
 
class DependencyNotPresent(BzrNewError):
1015
 
    """Unable to import library "%(library)s": %(error)s"""
 
1699
 
 
1700
    _fmt = "Parameter %(param)s contains a newline."
 
1701
 
 
1702
 
 
1703
class DependencyNotPresent(BzrError):
 
1704
 
 
1705
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1016
1706
 
1017
1707
    def __init__(self, library, error):
1018
 
        BzrNewError.__init__(self, library=library, error=error)
 
1708
        BzrError.__init__(self, library=library, error=error)
1019
1709
 
1020
1710
 
1021
1711
class ParamikoNotPresent(DependencyNotPresent):
1022
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
1712
 
 
1713
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1023
1714
 
1024
1715
    def __init__(self, error):
1025
1716
        DependencyNotPresent.__init__(self, 'paramiko', error)
1026
1717
 
1027
1718
 
1028
 
class PointlessMerge(BzrNewError):
1029
 
    """Nothing to merge."""
1030
 
 
1031
 
 
1032
 
class UninitializableFormat(BzrNewError):
1033
 
    """Format %(format)s cannot be initialised by this version of bzr."""
 
1719
class PointlessMerge(BzrError):
 
1720
 
 
1721
    _fmt = "Nothing to merge."
 
1722
 
 
1723
 
 
1724
class UninitializableFormat(BzrError):
 
1725
 
 
1726
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
1034
1727
 
1035
1728
    def __init__(self, format):
1036
 
        BzrNewError.__init__(self)
 
1729
        BzrError.__init__(self)
1037
1730
        self.format = format
1038
1731
 
1039
1732
 
1040
 
class BadConversionTarget(BzrNewError):
1041
 
    """Cannot convert to format %(format)s.  %(problem)s"""
 
1733
class BadConversionTarget(BzrError):
 
1734
 
 
1735
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
1042
1736
 
1043
1737
    def __init__(self, problem, format):
1044
 
        BzrNewError.__init__(self)
 
1738
        BzrError.__init__(self)
1045
1739
        self.problem = problem
1046
1740
        self.format = format
1047
1741
 
1048
1742
 
1049
 
class NoDiff(BzrNewError):
1050
 
    """Diff is not installed on this machine: %(msg)s"""
 
1743
class NoDiff(BzrError):
 
1744
 
 
1745
    _fmt = "Diff is not installed on this machine: %(msg)s"
1051
1746
 
1052
1747
    def __init__(self, msg):
1053
 
        BzrNewError.__init__(self, msg=msg)
1054
 
 
1055
 
 
1056
 
class NoDiff3(BzrNewError):
1057
 
    """Diff3 is not installed on this machine."""
1058
 
 
1059
 
 
1060
 
class ExistingLimbo(BzrNewError):
1061
 
    """This tree contains left-over files from a failed operation.
1062
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1063
 
    keep, and delete it when you are done.
1064
 
    """
1065
 
    def __init__(self, limbo_dir):
1066
 
       BzrNewError.__init__(self)
1067
 
       self.limbo_dir = limbo_dir
1068
 
 
1069
 
 
1070
 
class ImmortalLimbo(BzrNewError):
1071
 
    """Unable to delete transform temporary directory $(limbo_dir)s.
1072
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1073
 
    keep, and delete it when you are done.
1074
 
    """
1075
 
    def __init__(self, limbo_dir):
1076
 
       BzrNewError.__init__(self)
1077
 
       self.limbo_dir = limbo_dir
1078
 
 
1079
 
 
1080
 
class OutOfDateTree(BzrNewError):
1081
 
    """Working tree is out of date, please run 'bzr update'."""
 
1748
        BzrError.__init__(self, msg=msg)
 
1749
 
 
1750
 
 
1751
class NoDiff3(BzrError):
 
1752
 
 
1753
    _fmt = "Diff3 is not installed on this machine."
 
1754
 
 
1755
 
 
1756
class ExistingLimbo(BzrError):
 
1757
 
 
1758
    _fmt = """This tree contains left-over files from a failed operation.
 
1759
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1760
    keep, and delete it when you are done."""
 
1761
    
 
1762
    def __init__(self, limbo_dir):
 
1763
       BzrError.__init__(self)
 
1764
       self.limbo_dir = limbo_dir
 
1765
 
 
1766
 
 
1767
class ImmortalLimbo(BzrError):
 
1768
 
 
1769
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1770
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1771
    keep, and delete it when you are done."""
 
1772
 
 
1773
    def __init__(self, limbo_dir):
 
1774
       BzrError.__init__(self)
 
1775
       self.limbo_dir = limbo_dir
 
1776
 
 
1777
 
 
1778
class OutOfDateTree(BzrError):
 
1779
 
 
1780
    _fmt = "Working tree is out of date, please run 'bzr update'."
1082
1781
 
1083
1782
    def __init__(self, tree):
1084
 
        BzrNewError.__init__(self)
 
1783
        BzrError.__init__(self)
1085
1784
        self.tree = tree
1086
1785
 
1087
1786
 
1088
 
class MergeModifiedFormatError(BzrNewError):
1089
 
    """Error in merge modified format"""
1090
 
 
1091
 
 
1092
 
class ConflictFormatError(BzrNewError):
1093
 
    """Format error in conflict listings"""
1094
 
 
1095
 
 
1096
 
class CorruptRepository(BzrNewError):
1097
 
    """An error has been detected in the repository %(repo_path)s.
1098
 
Please run bzr reconcile on this repository."""
 
1787
class PublicBranchOutOfDate(BzrError):
 
1788
 
 
1789
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1790
        '"%(revstring)s".'
 
1791
 
 
1792
    def __init__(self, public_location, revstring):
 
1793
        import bzrlib.urlutils as urlutils
 
1794
        public_location = urlutils.unescape_for_display(public_location,
 
1795
                                                        'ascii')
 
1796
        BzrError.__init__(self, public_location=public_location,
 
1797
                          revstring=revstring)
 
1798
 
 
1799
 
 
1800
class MergeModifiedFormatError(BzrError):
 
1801
 
 
1802
    _fmt = "Error in merge modified format"
 
1803
 
 
1804
 
 
1805
class ConflictFormatError(BzrError):
 
1806
 
 
1807
    _fmt = "Format error in conflict listings"
 
1808
 
 
1809
 
 
1810
class CorruptRepository(BzrError):
 
1811
 
 
1812
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1813
            "Please run bzr reconcile on this repository.")
1099
1814
 
1100
1815
    def __init__(self, repo):
1101
 
        BzrNewError.__init__(self)
 
1816
        BzrError.__init__(self)
1102
1817
        self.repo_path = repo.bzrdir.root_transport.base
1103
1818
 
1104
1819
 
1105
 
class UpgradeRequired(BzrNewError):
1106
 
    """To use this feature you must upgrade your branch at %(path)s."""
 
1820
class UpgradeRequired(BzrError):
 
1821
 
 
1822
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
1107
1823
 
1108
1824
    def __init__(self, path):
1109
 
        BzrNewError.__init__(self)
 
1825
        BzrError.__init__(self)
1110
1826
        self.path = path
1111
1827
 
1112
1828
 
1113
 
class LocalRequiresBoundBranch(BzrNewError):
1114
 
    """Cannot perform local-only commits on unbound branches."""
1115
 
 
1116
 
 
1117
 
class MissingProgressBarFinish(BzrNewError):
1118
 
    """A nested progress bar was not 'finished' correctly."""
1119
 
 
1120
 
 
1121
 
class InvalidProgressBarType(BzrNewError):
1122
 
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1123
 
Select one of: %(valid_types)s"""
 
1829
class LocalRequiresBoundBranch(BzrError):
 
1830
 
 
1831
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1832
 
 
1833
 
 
1834
class MissingProgressBarFinish(BzrError):
 
1835
 
 
1836
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1837
 
 
1838
 
 
1839
class InvalidProgressBarType(BzrError):
 
1840
 
 
1841
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1842
            " is not a supported type Select one of: %(valid_types)s")
1124
1843
 
1125
1844
    def __init__(self, bar_type, valid_types):
1126
 
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1127
 
 
1128
 
 
1129
 
class UnsupportedOperation(BzrNewError):
1130
 
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
1845
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1846
 
 
1847
 
 
1848
class UnsupportedOperation(BzrError):
 
1849
 
 
1850
    _fmt = ("The method %(mname)s is not supported on"
 
1851
            " objects of type %(tname)s.")
 
1852
 
1131
1853
    def __init__(self, method, method_self):
1132
1854
        self.method = method
1133
1855
        self.mname = method.__name__
1134
1856
        self.tname = type(method_self).__name__
1135
1857
 
1136
1858
 
1137
 
class BinaryFile(BzrNewError):
1138
 
    """File is binary but should be text."""
1139
 
 
1140
 
 
1141
 
class IllegalPath(BzrNewError):
1142
 
    """The path %(path)s is not permitted on this platform"""
 
1859
class CannotSetRevisionId(UnsupportedOperation):
 
1860
    """Raised when a commit is attempting to set a revision id but cant."""
 
1861
 
 
1862
 
 
1863
class NonAsciiRevisionId(UnsupportedOperation):
 
1864
    """Raised when a commit is attempting to set a non-ascii revision id
 
1865
       but cant.
 
1866
    """
 
1867
 
 
1868
 
 
1869
class BinaryFile(BzrError):
 
1870
    
 
1871
    _fmt = "File is binary but should be text."
 
1872
 
 
1873
 
 
1874
class IllegalPath(BzrError):
 
1875
 
 
1876
    _fmt = "The path %(path)s is not permitted on this platform"
1143
1877
 
1144
1878
    def __init__(self, path):
1145
 
        BzrNewError.__init__(self)
 
1879
        BzrError.__init__(self)
1146
1880
        self.path = path
1147
1881
 
1148
1882
 
1149
 
class TestamentMismatch(BzrNewError):
1150
 
    """Testament did not match expected value.  
1151
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
1152
 
       {%(measured)s}
1153
 
    """
 
1883
class TestamentMismatch(BzrError):
 
1884
 
 
1885
    _fmt = """Testament did not match expected value.
 
1886
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1887
       {%(measured)s}"""
 
1888
 
1154
1889
    def __init__(self, revision_id, expected, measured):
1155
1890
        self.revision_id = revision_id
1156
1891
        self.expected = expected
1157
1892
        self.measured = measured
1158
1893
 
1159
1894
 
1160
 
class NotABundle(BzrNewError):
1161
 
    """Not a bzr revision-bundle: %(text)r"""
 
1895
class NotABundle(BzrError):
 
1896
    
 
1897
    _fmt = "Not a bzr revision-bundle: %(text)r"
1162
1898
 
1163
1899
    def __init__(self, text):
1164
 
        BzrNewError.__init__(self)
 
1900
        BzrError.__init__(self)
1165
1901
        self.text = text
1166
1902
 
1167
1903
 
1168
 
class BadBundle(BzrNewError): 
1169
 
    """Bad bzr revision-bundle: %(text)r"""
 
1904
class BadBundle(BzrError): 
 
1905
    
 
1906
    _fmt = "Bad bzr revision-bundle: %(text)r"
1170
1907
 
1171
1908
    def __init__(self, text):
1172
 
        BzrNewError.__init__(self)
 
1909
        BzrError.__init__(self)
1173
1910
        self.text = text
1174
1911
 
1175
1912
 
1176
1913
class MalformedHeader(BadBundle): 
1177
 
    """Malformed bzr revision-bundle header: %(text)r"""
1178
 
 
1179
 
    def __init__(self, text):
1180
 
        BzrNewError.__init__(self)
1181
 
        self.text = text
 
1914
    
 
1915
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1182
1916
 
1183
1917
 
1184
1918
class MalformedPatches(BadBundle): 
1185
 
    """Malformed patches in bzr revision-bundle: %(text)r"""
1186
 
 
1187
 
    def __init__(self, text):
1188
 
        BzrNewError.__init__(self)
1189
 
        self.text = text
 
1919
    
 
1920
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1190
1921
 
1191
1922
 
1192
1923
class MalformedFooter(BadBundle): 
1193
 
    """Malformed footer in bzr revision-bundle: %(text)r"""
1194
 
 
1195
 
    def __init__(self, text):
1196
 
        BzrNewError.__init__(self)
1197
 
        self.text = text
 
1924
    
 
1925
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1198
1926
 
1199
1927
 
1200
1928
class UnsupportedEOLMarker(BadBundle):
1201
 
    """End of line marker was not \\n in bzr revision-bundle"""    
 
1929
    
 
1930
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
1202
1931
 
1203
1932
    def __init__(self):
1204
 
        BzrNewError.__init__(self)
1205
 
 
1206
 
 
1207
 
class IncompatibleFormat(BzrNewError):
1208
 
    """Bundle format %(bundle_format)s is incompatible with %(other)s"""
 
1933
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1934
        # but for this there is not
 
1935
        BzrError.__init__(self)
 
1936
 
 
1937
 
 
1938
class IncompatibleBundleFormat(BzrError):
 
1939
    
 
1940
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1209
1941
 
1210
1942
    def __init__(self, bundle_format, other):
1211
 
        BzrNewError.__init__(self)
 
1943
        BzrError.__init__(self)
1212
1944
        self.bundle_format = bundle_format
1213
1945
        self.other = other
1214
1946
 
1215
1947
 
1216
 
class BadInventoryFormat(BzrNewError):
1217
 
    """Root class for inventory serialization errors"""
 
1948
class BadInventoryFormat(BzrError):
 
1949
    
 
1950
    _fmt = "Root class for inventory serialization errors"
1218
1951
 
1219
1952
 
1220
1953
class UnexpectedInventoryFormat(BadInventoryFormat):
1221
 
    """The inventory was not in the expected format:\n %(msg)s"""
 
1954
 
 
1955
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
1222
1956
 
1223
1957
    def __init__(self, msg):
1224
1958
        BadInventoryFormat.__init__(self, msg=msg)
1225
1959
 
1226
1960
 
 
1961
class RootNotRich(BzrError):
 
1962
 
 
1963
    _fmt = """This operation requires rich root data storage"""
 
1964
 
 
1965
 
 
1966
class NoSmartMedium(BzrError):
 
1967
 
 
1968
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1969
 
 
1970
    internal_error = True
 
1971
 
 
1972
    def __init__(self, transport):
 
1973
        self.transport = transport
 
1974
 
 
1975
 
1227
1976
class NoSmartServer(NotBranchError):
1228
 
    """No smart server available at %(url)s"""
 
1977
 
 
1978
    _fmt = "No smart server available at %(url)s"
1229
1979
 
1230
1980
    def __init__(self, url):
1231
1981
        self.url = url
1232
1982
 
1233
1983
 
1234
 
class UnknownSSH(BzrNewError):
1235
 
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
1984
class UnknownSSH(BzrError):
 
1985
 
 
1986
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1236
1987
 
1237
1988
    def __init__(self, vendor):
1238
 
        BzrNewError.__init__(self)
 
1989
        BzrError.__init__(self)
1239
1990
        self.vendor = vendor
1240
1991
 
1241
1992
 
1242
 
class GhostRevisionUnusableHere(BzrNewError):
1243
 
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
1993
class SSHVendorNotFound(BzrError):
 
1994
 
 
1995
    _fmt = ("Don't know how to handle SSH connections."
 
1996
            " Please set BZR_SSH environment variable.")
 
1997
 
 
1998
 
 
1999
class GhostRevisionUnusableHere(BzrError):
 
2000
 
 
2001
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1244
2002
 
1245
2003
    def __init__(self, revision_id):
1246
 
        BzrNewError.__init__(self)
 
2004
        BzrError.__init__(self)
1247
2005
        self.revision_id = revision_id
1248
2006
 
1249
2007
 
1250
 
class IllegalUseOfScopeReplacer(BzrNewError):
1251
 
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
1252
 
 
1253
 
    is_user_error = False
 
2008
class IllegalUseOfScopeReplacer(BzrError):
 
2009
 
 
2010
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2011
            " %(msg)s%(extra)s")
 
2012
 
 
2013
    internal_error = True
1254
2014
 
1255
2015
    def __init__(self, name, msg, extra=None):
1256
 
        BzrNewError.__init__(self)
 
2016
        BzrError.__init__(self)
1257
2017
        self.name = name
1258
2018
        self.msg = msg
1259
2019
        if extra:
1262
2022
            self.extra = ''
1263
2023
 
1264
2024
 
1265
 
class InvalidImportLine(BzrNewError):
1266
 
    """Not a valid import statement: %(msg)\n%(text)s"""
1267
 
 
1268
 
    is_user_error = False
 
2025
class InvalidImportLine(BzrError):
 
2026
 
 
2027
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2028
 
 
2029
    internal_error = True
1269
2030
 
1270
2031
    def __init__(self, text, msg):
1271
 
        BzrNewError.__init__(self)
 
2032
        BzrError.__init__(self)
1272
2033
        self.text = text
1273
2034
        self.msg = msg
1274
2035
 
1275
2036
 
1276
 
class ImportNameCollision(BzrNewError):
1277
 
    """Tried to import an object to the same name as an existing object. %(name)s"""
1278
 
 
1279
 
    is_user_error = False
1280
 
 
1281
 
    def __init__(self, name):
1282
 
        BzrNewError.__init__(self)
1283
 
        self.name = name
 
2037
class ImportNameCollision(BzrError):
 
2038
 
 
2039
    _fmt = ("Tried to import an object to the same name as"
 
2040
            " an existing object. %(name)s")
 
2041
 
 
2042
    internal_error = True
 
2043
 
 
2044
    def __init__(self, name):
 
2045
        BzrError.__init__(self)
 
2046
        self.name = name
 
2047
 
 
2048
 
 
2049
class NotAMergeDirective(BzrError):
 
2050
    """File starting with %(firstline)r is not a merge directive"""
 
2051
    def __init__(self, firstline):
 
2052
        BzrError.__init__(self, firstline=firstline)
 
2053
 
 
2054
 
 
2055
class NoMergeSource(BzrError):
 
2056
    """Raise if no merge source was specified for a merge directive"""
 
2057
 
 
2058
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2059
        " branch location."
 
2060
 
 
2061
 
 
2062
class PatchMissing(BzrError):
 
2063
    """Raise a patch type was specified but no patch supplied"""
 
2064
 
 
2065
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2066
 
 
2067
    def __init__(self, patch_type):
 
2068
        BzrError.__init__(self)
 
2069
        self.patch_type = patch_type
 
2070
 
 
2071
 
 
2072
class UnsupportedInventoryKind(BzrError):
 
2073
    
 
2074
    _fmt = """Unsupported entry kind %(kind)s"""
 
2075
 
 
2076
    def __init__(self, kind):
 
2077
        self.kind = kind
 
2078
 
 
2079
 
 
2080
class BadSubsumeSource(BzrError):
 
2081
 
 
2082
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
2083
 
 
2084
    def __init__(self, tree, other_tree, reason):
 
2085
        self.tree = tree
 
2086
        self.other_tree = other_tree
 
2087
        self.reason = reason
 
2088
 
 
2089
 
 
2090
class SubsumeTargetNeedsUpgrade(BzrError):
 
2091
    
 
2092
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2093
 
 
2094
    def __init__(self, other_tree):
 
2095
        self.other_tree = other_tree
 
2096
 
 
2097
 
 
2098
class BadReferenceTarget(BzrError):
 
2099
 
 
2100
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2101
 
 
2102
    internal_error = True
 
2103
 
 
2104
    def __init__(self, tree, other_tree, reason):
 
2105
        self.tree = tree
 
2106
        self.other_tree = other_tree
 
2107
        self.reason = reason
 
2108
 
 
2109
 
 
2110
class NoSuchTag(BzrError):
 
2111
 
 
2112
    _fmt = "No such tag: %(tag_name)s"
 
2113
 
 
2114
    def __init__(self, tag_name):
 
2115
        self.tag_name = tag_name
 
2116
 
 
2117
 
 
2118
class TagsNotSupported(BzrError):
 
2119
 
 
2120
    _fmt = ("Tags not supported by %(branch)s;"
 
2121
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2122
 
 
2123
    def __init__(self, branch):
 
2124
        self.branch = branch
 
2125
 
 
2126
        
 
2127
class TagAlreadyExists(BzrError):
 
2128
 
 
2129
    _fmt = "Tag %(tag_name)s already exists."
 
2130
 
 
2131
    def __init__(self, tag_name):
 
2132
        self.tag_name = tag_name
 
2133
 
 
2134
 
 
2135
class MalformedBugIdentifier(BzrError):
 
2136
 
 
2137
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2138
 
 
2139
    def __init__(self, bug_id, reason):
 
2140
        self.bug_id = bug_id
 
2141
        self.reason = reason
 
2142
 
 
2143
 
 
2144
class UnknownBugTrackerAbbreviation(BzrError):
 
2145
 
 
2146
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2147
            "on %(branch)s")
 
2148
 
 
2149
    def __init__(self, abbreviation, branch):
 
2150
        self.abbreviation = abbreviation
 
2151
        self.branch = branch
 
2152
 
 
2153
 
 
2154
class UnexpectedSmartServerResponse(BzrError):
 
2155
 
 
2156
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2157
 
 
2158
    def __init__(self, response_tuple):
 
2159
        self.response_tuple = response_tuple
 
2160
 
 
2161
 
 
2162
class ContainerError(BzrError):
 
2163
    """Base class of container errors."""
 
2164
 
 
2165
 
 
2166
class UnknownContainerFormatError(ContainerError):
 
2167
 
 
2168
    _fmt = "Unrecognised container format: %(container_format)r"
 
2169
    
 
2170
    def __init__(self, container_format):
 
2171
        self.container_format = container_format
 
2172
 
 
2173
 
 
2174
class UnexpectedEndOfContainerError(ContainerError):
 
2175
 
 
2176
    _fmt = "Unexpected end of container stream"
 
2177
 
 
2178
    internal_error = False
 
2179
 
 
2180
 
 
2181
class UnknownRecordTypeError(ContainerError):
 
2182
 
 
2183
    _fmt = "Unknown record type: %(record_type)r"
 
2184
 
 
2185
    def __init__(self, record_type):
 
2186
        self.record_type = record_type
 
2187
 
 
2188
 
 
2189
class InvalidRecordError(ContainerError):
 
2190
 
 
2191
    _fmt = "Invalid record: %(reason)s"
 
2192
 
 
2193
    def __init__(self, reason):
 
2194
        self.reason = reason
 
2195
 
 
2196
 
 
2197
class ContainerHasExcessDataError(ContainerError):
 
2198
 
 
2199
    _fmt = "Container has data after end marker: %(excess)r"
 
2200
 
 
2201
    def __init__(self, excess):
 
2202
        self.excess = excess
 
2203
 
 
2204
 
 
2205
class DuplicateRecordNameError(ContainerError):
 
2206
 
 
2207
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
2208
 
 
2209
    def __init__(self, name):
 
2210
        self.name = name
 
2211
 
 
2212
 
 
2213
class NoDestinationAddress(BzrError):
 
2214
 
 
2215
    _fmt = "Message does not have a destination address."
 
2216
 
 
2217
    internal_error = True
 
2218
 
 
2219
 
 
2220
class SMTPError(BzrError):
 
2221
 
 
2222
    _fmt = "SMTP error: %(error)s"
 
2223
 
 
2224
    def __init__(self, error):
 
2225
        self.error = error