~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-06-12 02:17:42 UTC
  • mfrom: (2521.1.1 56322)
  • Revision ID: pqm@pqm.ubuntu.com-20070612021742-uetsy3g747iq3xkk
mergeĀ initĀ --create-prefix

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