/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-01 09:02:18 UTC
  • mto: (5064.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5065.
  • Revision ID: v.ladeuil+lp@free.fr-20100301090218-pq3ib5y07dx3wbp6
Delete spurious spaces.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 sys.exc_type
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
from bzrlib import (
 
21
    osutils,
 
22
    symbol_versioning,
 
23
    )
 
24
from bzrlib.patches import (
 
25
    MalformedHunkHeader,
 
26
    MalformedLine,
 
27
    MalformedPatchHeader,
 
28
    PatchConflict,
 
29
    PatchSyntax,
 
30
    )
 
31
 
79
32
 
80
33
# TODO: is there any value in providing the .args field used by standard
81
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
82
35
# to me.
83
36
 
84
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
85
38
# constructed to make sure it will succeed.  But that says nothing about
86
39
# exceptions that are never raised.
87
40
 
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.
 
41
# TODO: selftest assertRaises should probably also check that every error
 
42
# raised can be formatted as a string successfully, and without giving
 
43
# 'unprintable'.
 
44
 
 
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
94
50
 
95
51
 
96
52
class BzrError(StandardError):
97
 
    
98
 
    is_user_error = True
99
 
    
 
53
    """
 
54
    Base class for errors raised by bzrlib.
 
55
 
 
56
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
57
    should be displayed with a traceback; if False (or absent) this was
 
58
    probably a user or environment error and they don't need the gory details.
 
59
    (That can be overridden by -Derror on the command line.)
 
60
 
 
61
    :cvar _fmt: Format string to display the error; this is expanded
 
62
    by the instance's dict.
 
63
    """
 
64
 
 
65
    internal_error = False
 
66
 
 
67
    def __init__(self, msg=None, **kwds):
 
68
        """Construct a new BzrError.
 
69
 
 
70
        There are two alternative forms for constructing these objects.
 
71
        Either a preformatted string may be passed, or a set of named
 
72
        arguments can be given.  The first is for generic "user" errors which
 
73
        are not intended to be caught and so do not need a specific subclass.
 
74
        The second case is for use with subclasses that provide a _fmt format
 
75
        string to print the arguments.
 
76
 
 
77
        Keyword arguments are taken as parameters to the error, which can
 
78
        be inserted into the format string template.  It's recommended
 
79
        that subclasses override the __init__ method to require specific
 
80
        parameters.
 
81
 
 
82
        :param msg: If given, this is the literal complete text for the error,
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
 
85
        """
 
86
        StandardError.__init__(self)
 
87
        if msg is not None:
 
88
            # I was going to deprecate this, but it actually turns out to be
 
89
            # quite handy - mbp 20061103.
 
90
            self._preformatted_string = msg
 
91
        else:
 
92
            self._preformatted_string = None
 
93
            for key, value in kwds.items():
 
94
                setattr(self, key, value)
 
95
 
 
96
    def _format(self):
 
97
        s = getattr(self, '_preformatted_string', None)
 
98
        if s is not None:
 
99
            # contains a preformatted message
 
100
            return s
 
101
        try:
 
102
            fmt = self._get_format_string()
 
103
            if fmt:
 
104
                d = dict(self.__dict__)
 
105
                s = fmt % d
 
106
                # __str__() should always return a 'str' object
 
107
                # never a 'unicode' object.
 
108
                return s
 
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
111
                % (self.__class__.__name__,
 
112
                   self.__dict__,
 
113
                   getattr(self, '_fmt', None),
 
114
                   e)
 
115
 
 
116
    def __unicode__(self):
 
117
        u = self._format()
 
118
        if isinstance(u, str):
 
119
            # Try decoding the str using the default encoding.
 
120
            u = unicode(u)
 
121
        elif not isinstance(u, unicode):
 
122
            # Try to make a unicode object from it, because __unicode__ must
 
123
            # return a unicode object.
 
124
            u = unicode(u)
 
125
        return u
 
126
 
100
127
    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
 
128
        s = self._format()
 
129
        if isinstance(s, unicode):
 
130
            s = s.encode('utf8')
114
131
        else:
115
 
            return n + `self.args`
 
132
            # __str__ must return a str.
 
133
            s = str(s)
 
134
        return s
 
135
 
 
136
    def __repr__(self):
 
137
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
138
 
 
139
    def _get_format_string(self):
 
140
        """Return format string for this exception or None"""
 
141
        fmt = getattr(self, '_fmt', None)
 
142
        if fmt is not None:
 
143
            return fmt
 
144
        fmt = getattr(self, '__doc__', None)
 
145
        if fmt is not None:
 
146
            symbol_versioning.warn("%s uses its docstring as a format, "
 
147
                    "it should use _fmt instead" % self.__class__.__name__,
 
148
                    DeprecationWarning)
 
149
            return fmt
 
150
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
151
            % (self.__class__.__name__,
 
152
               self.__dict__,
 
153
               getattr(self, '_fmt', None),
 
154
               )
 
155
 
 
156
    def __eq__(self, other):
 
157
        if self.__class__ is not other.__class__:
 
158
            return NotImplemented
 
159
        return self.__dict__ == other.__dict__
 
160
 
 
161
 
 
162
class InternalBzrError(BzrError):
 
163
    """Base class for errors that are internal in nature.
 
164
 
 
165
    This is a convenience class for errors that are internal. The
 
166
    internal_error attribute can still be altered in subclasses, if needed.
 
167
    Using this class is simply an easy way to get internal errors.
 
168
    """
 
169
 
 
170
    internal_error = True
116
171
 
117
172
 
118
173
class BzrNewError(BzrError):
119
 
    """bzr error"""
 
174
    """Deprecated error base class."""
120
175
    # base classes should override the docstring with their human-
121
176
    # readable explanation
122
177
 
123
 
    def __init__(self, **kwds):
 
178
    def __init__(self, *args, **kwds):
 
179
        # XXX: Use the underlying BzrError to always generate the args
 
180
        # attribute if it doesn't exist.  We can't use super here, because
 
181
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
182
        # --bmc, 20060426
 
183
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
184
             'please convert %s to use BzrError instead'
 
185
             % self.__class__.__name__,
 
186
             DeprecationWarning,
 
187
             stacklevel=2)
 
188
        BzrError.__init__(self, *args)
124
189
        for key, value in kwds.items():
125
190
            setattr(self, key, value)
126
191
 
132
197
            if isinstance(s, unicode):
133
198
                return s.encode('utf8')
134
199
            return s
135
 
        except (NameError, ValueError, KeyError), e:
136
 
            return 'Unprintable exception %s: %s' \
137
 
                % (self.__class__.__name__, str(e))
138
 
 
139
 
 
140
 
class BzrCheckError(BzrNewError):
141
 
    """Internal check failed: %(message)s"""
142
 
 
143
 
    is_user_error = False
144
 
 
145
 
    def __init__(self, message):
146
 
        BzrNewError.__init__(self)
147
 
        self.message = message
148
 
 
149
 
 
150
 
class InvalidEntryName(BzrNewError):
151
 
    """Invalid entry name: %(name)s"""
152
 
 
153
 
    is_user_error = False
 
200
        except (TypeError, NameError, ValueError, KeyError), e:
 
201
            return 'Unprintable exception %s(%r): %r' \
 
202
                % (self.__class__.__name__,
 
203
                   self.__dict__, e)
 
204
 
 
205
 
 
206
class AlreadyBuilding(BzrError):
 
207
 
 
208
    _fmt = "The tree builder is already building a tree."
 
209
 
 
210
 
 
211
class BranchError(BzrError):
 
212
    """Base class for concrete 'errors about a branch'."""
 
213
 
 
214
    def __init__(self, branch):
 
215
        BzrError.__init__(self, branch=branch)
 
216
 
 
217
 
 
218
class BzrCheckError(InternalBzrError):
 
219
 
 
220
    _fmt = "Internal check failed: %(msg)s"
 
221
 
 
222
    def __init__(self, msg):
 
223
        BzrError.__init__(self)
 
224
        self.msg = msg
 
225
 
 
226
 
 
227
class DirstateCorrupt(BzrError):
 
228
 
 
229
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
230
 
 
231
    def __init__(self, state, msg):
 
232
        BzrError.__init__(self)
 
233
        self.state = state
 
234
        self.msg = msg
 
235
 
 
236
 
 
237
class DisabledMethod(InternalBzrError):
 
238
 
 
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
240
 
 
241
    def __init__(self, class_name):
 
242
        BzrError.__init__(self)
 
243
        self.class_name = class_name
 
244
 
 
245
 
 
246
class IncompatibleAPI(BzrError):
 
247
 
 
248
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
249
        'It supports versions "%(minimum)s" to "%(current)s".'
 
250
 
 
251
    def __init__(self, api, wanted, minimum, current):
 
252
        self.api = api
 
253
        self.wanted = wanted
 
254
        self.minimum = minimum
 
255
        self.current = current
 
256
 
 
257
 
 
258
class InProcessTransport(BzrError):
 
259
 
 
260
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
261
        "process."
 
262
 
 
263
    def __init__(self, transport):
 
264
        self.transport = transport
 
265
 
 
266
 
 
267
class InvalidEntryName(InternalBzrError):
 
268
 
 
269
    _fmt = "Invalid entry name: %(name)s"
154
270
 
155
271
    def __init__(self, name):
156
 
        BzrNewError.__init__(self)
 
272
        BzrError.__init__(self)
157
273
        self.name = name
158
274
 
159
275
 
160
 
class InvalidRevisionNumber(BzrNewError):
161
 
    """Invalid revision number %(revno)d"""
 
276
class InvalidRevisionNumber(BzrError):
 
277
 
 
278
    _fmt = "Invalid revision number %(revno)s"
 
279
 
162
280
    def __init__(self, revno):
163
 
        BzrNewError.__init__(self)
 
281
        BzrError.__init__(self)
164
282
        self.revno = revno
165
283
 
166
284
 
167
 
class InvalidRevisionId(BzrNewError):
168
 
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
285
class InvalidRevisionId(BzrError):
 
286
 
 
287
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
169
288
 
170
289
    def __init__(self, revision_id, branch):
171
290
        # branch can be any string or object with __str__ defined
172
 
        BzrNewError.__init__(self)
 
291
        BzrError.__init__(self)
173
292
        self.revision_id = revision_id
174
293
        self.branch = branch
175
294
 
176
295
 
177
 
class NoSuchId(BzrNewError):
178
 
    """The file id %(file_id)s is not present in the tree %(tree)s."""
179
 
    
 
296
class ReservedId(BzrError):
 
297
 
 
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
299
 
 
300
    def __init__(self, revision_id):
 
301
        self.revision_id = revision_id
 
302
 
 
303
 
 
304
class RootMissing(InternalBzrError):
 
305
 
 
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
307
        "record_entry_contents.")
 
308
 
 
309
 
 
310
class NoPublicBranch(BzrError):
 
311
 
 
312
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
313
 
 
314
    def __init__(self, branch):
 
315
        import bzrlib.urlutils as urlutils
 
316
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
317
        BzrError.__init__(self, branch_url=public_location)
 
318
 
 
319
 
 
320
class NoHelpTopic(BzrError):
 
321
 
 
322
    _fmt = ("No help could be found for '%(topic)s'. "
 
323
        "Please use 'bzr help topics' to obtain a list of topics.")
 
324
 
 
325
    def __init__(self, topic):
 
326
        self.topic = topic
 
327
 
 
328
 
 
329
class NoSuchId(BzrError):
 
330
 
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
180
333
    def __init__(self, tree, file_id):
181
 
        BzrNewError.__init__(self)
 
334
        BzrError.__init__(self)
182
335
        self.file_id = file_id
183
336
        self.tree = tree
184
337
 
185
338
 
186
 
class NoWorkingTree(BzrNewError):
187
 
    """No WorkingTree exists for %(base)s."""
188
 
    
 
339
class NoSuchIdInRepository(NoSuchId):
 
340
 
 
341
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
342
            ' %(repository)r')
 
343
 
 
344
    def __init__(self, repository, file_id):
 
345
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
346
 
 
347
 
 
348
class NotStacked(BranchError):
 
349
 
 
350
    _fmt = "The branch '%(branch)s' is not stacked."
 
351
 
 
352
 
 
353
class InventoryModified(InternalBzrError):
 
354
 
 
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
356
            " so a clean inventory cannot be read without data loss.")
 
357
 
 
358
    def __init__(self, tree):
 
359
        self.tree = tree
 
360
 
 
361
 
 
362
class NoWorkingTree(BzrError):
 
363
 
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
189
366
    def __init__(self, base):
190
 
        BzrNewError.__init__(self)
 
367
        BzrError.__init__(self)
191
368
        self.base = base
192
369
 
193
370
 
194
 
class NotLocalUrl(BzrNewError):
195
 
    """%(url)s is not a local path."""
196
 
    
 
371
class NotBuilding(BzrError):
 
372
 
 
373
    _fmt = "Not currently building a tree."
 
374
 
 
375
 
 
376
class NotLocalUrl(BzrError):
 
377
 
 
378
    _fmt = "%(url)s is not a local path."
 
379
 
197
380
    def __init__(self, url):
198
 
        BzrNewError.__init__(self)
199
381
        self.url = url
200
382
 
201
383
 
202
 
class BzrCommandError(BzrNewError):
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
 
387
 
 
388
    def __init__(self, base):
 
389
        self.base = base
 
390
 
 
391
 
 
392
class BzrCommandError(BzrError):
203
393
    """Error from user command"""
204
394
 
205
 
    is_user_error = True
206
 
 
207
395
    # Error from malformed user command; please avoid raising this as a
208
396
    # generic exception not caused by user input.
209
397
    #
211
399
    # are not intended to be caught anyway.  UI code need not subclass
212
400
    # BzrCommandError, and non-UI code should not throw a subclass of
213
401
    # BzrCommandError.  ADHB 20051211
214
 
    def __init__(self, msg):
215
 
        # Object.__str__() must return a real string
216
 
        # returning a Unicode string is a python error.
217
 
        if isinstance(msg, unicode):
218
 
            self.msg = msg.encode('utf8')
219
 
        else:
220
 
            self.msg = msg
221
 
 
222
 
    def __str__(self):
223
 
        return self.msg
 
402
 
 
403
 
 
404
class NotWriteLocked(BzrError):
 
405
 
 
406
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
407
 
 
408
    def __init__(self, not_locked):
 
409
        self.not_locked = not_locked
224
410
 
225
411
 
226
412
class BzrOptionError(BzrCommandError):
227
 
    """Error in command line options"""
228
 
 
229
 
    
230
 
class StrictCommitFailed(BzrNewError):
231
 
    """Commit refused because there are unknown files in the tree"""
 
413
 
 
414
    _fmt = "Error in command line options"
 
415
 
 
416
 
 
417
class BadIndexFormatSignature(BzrError):
 
418
 
 
419
    _fmt = "%(value)s is not an index of type %(_type)s."
 
420
 
 
421
    def __init__(self, value, _type):
 
422
        BzrError.__init__(self)
 
423
        self.value = value
 
424
        self._type = _type
 
425
 
 
426
 
 
427
class BadIndexData(BzrError):
 
428
 
 
429
    _fmt = "Error in data for index %(value)s."
 
430
 
 
431
    def __init__(self, value):
 
432
        BzrError.__init__(self)
 
433
        self.value = value
 
434
 
 
435
 
 
436
class BadIndexDuplicateKey(BzrError):
 
437
 
 
438
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
439
 
 
440
    def __init__(self, key, index):
 
441
        BzrError.__init__(self)
 
442
        self.key = key
 
443
        self.index = index
 
444
 
 
445
 
 
446
class BadIndexKey(BzrError):
 
447
 
 
448
    _fmt = "The key '%(key)s' is not a valid key."
 
449
 
 
450
    def __init__(self, key):
 
451
        BzrError.__init__(self)
 
452
        self.key = key
 
453
 
 
454
 
 
455
class BadIndexOptions(BzrError):
 
456
 
 
457
    _fmt = "Could not parse options for index %(value)s."
 
458
 
 
459
    def __init__(self, value):
 
460
        BzrError.__init__(self)
 
461
        self.value = value
 
462
 
 
463
 
 
464
class BadIndexValue(BzrError):
 
465
 
 
466
    _fmt = "The value '%(value)s' is not a valid value."
 
467
 
 
468
    def __init__(self, value):
 
469
        BzrError.__init__(self)
 
470
        self.value = value
 
471
 
 
472
 
 
473
class BadOptionValue(BzrError):
 
474
 
 
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
476
 
 
477
    def __init__(self, name, value):
 
478
        BzrError.__init__(self, name=name, value=value)
 
479
 
 
480
 
 
481
class StrictCommitFailed(BzrError):
 
482
 
 
483
    _fmt = "Commit refused because there are unknown files in the tree"
232
484
 
233
485
 
234
486
# XXX: Should be unified with TransportError; they seem to represent the
235
487
# same thing
236
 
class PathError(BzrNewError):
237
 
    """Generic path error: %(path)r%(extra)s)"""
 
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
489
# - this is finer than a TransportError - and more useful as such. It
 
490
# differentiates between 'transport has failed' and 'operation on a transport
 
491
# has failed.'
 
492
class PathError(BzrError):
 
493
 
 
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
238
495
 
239
496
    def __init__(self, path, extra=None):
240
 
        BzrNewError.__init__(self)
 
497
        BzrError.__init__(self)
241
498
        self.path = path
242
499
        if extra:
243
500
            self.extra = ': ' + str(extra)
246
503
 
247
504
 
248
505
class NoSuchFile(PathError):
249
 
    """No such file: %(path)r%(extra)s"""
 
506
 
 
507
    _fmt = "No such file: %(path)r%(extra)s"
250
508
 
251
509
 
252
510
class FileExists(PathError):
253
 
    """File exists: %(path)r%(extra)s"""
 
511
 
 
512
    _fmt = "File exists: %(path)r%(extra)s"
 
513
 
 
514
 
 
515
class RenameFailedFilesExist(BzrError):
 
516
    """Used when renaming and both source and dest exist."""
 
517
 
 
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
 
521
 
 
522
    def __init__(self, source, dest, extra=None):
 
523
        BzrError.__init__(self)
 
524
        self.source = str(source)
 
525
        self.dest = str(dest)
 
526
        if extra:
 
527
            self.extra = ' ' + str(extra)
 
528
        else:
 
529
            self.extra = ''
 
530
 
 
531
 
 
532
class NotADirectory(PathError):
 
533
 
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
535
 
 
536
 
 
537
class NotInWorkingDirectory(PathError):
 
538
 
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
254
540
 
255
541
 
256
542
class DirectoryNotEmpty(PathError):
257
 
    """Directory not empty: %(path)r%(extra)s"""
 
543
 
 
544
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
545
 
 
546
 
 
547
class HardLinkNotSupported(PathError):
 
548
 
 
549
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
550
 
 
551
 
 
552
class ReadingCompleted(InternalBzrError):
 
553
 
 
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
555
            "called upon it - the request has been completed and no more "
 
556
            "data may be read.")
 
557
 
 
558
    def __init__(self, request):
 
559
        self.request = request
258
560
 
259
561
 
260
562
class ResourceBusy(PathError):
261
 
    """Device or resource busy: %(path)r%(extra)s"""
 
563
 
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
262
565
 
263
566
 
264
567
class PermissionDenied(PathError):
265
 
    """Permission denied: %(path)r%(extra)s"""
 
568
 
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
266
570
 
267
571
 
268
572
class InvalidURL(PathError):
269
 
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
573
 
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
270
575
 
271
576
 
272
577
class InvalidURLJoin(PathError):
273
 
    """Invalid URL join request: %(args)s%(extra)s"""
274
 
 
275
 
    def __init__(self, msg, base, args):
276
 
        PathError.__init__(self, base, msg)
277
 
        self.args = [base]
278
 
        self.args.extend(args)
 
578
 
 
579
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
580
 
 
581
    def __init__(self, reason, base, join_args):
 
582
        self.reason = reason
 
583
        self.base = base
 
584
        self.join_args = join_args
 
585
        PathError.__init__(self, base, reason)
 
586
 
 
587
 
 
588
class InvalidRebaseURLs(PathError):
 
589
 
 
590
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
591
 
 
592
    def __init__(self, from_, to):
 
593
        self.from_ = from_
 
594
        self.to = to
 
595
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
596
 
 
597
 
 
598
class UnavailableRepresentation(InternalBzrError):
 
599
 
 
600
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
601
        "is encoded as '%(native)s'.")
 
602
 
 
603
    def __init__(self, key, wanted, native):
 
604
        InternalBzrError.__init__(self)
 
605
        self.wanted = wanted
 
606
        self.native = native
 
607
        self.key = key
 
608
 
 
609
 
 
610
class UnknownHook(BzrError):
 
611
 
 
612
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
613
 
 
614
    def __init__(self, hook_type, hook_name):
 
615
        BzrError.__init__(self)
 
616
        self.type = hook_type
 
617
        self.hook = hook_name
279
618
 
280
619
 
281
620
class UnsupportedProtocol(PathError):
282
 
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
621
 
 
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
283
623
 
284
624
    def __init__(self, url, extra):
285
625
        PathError.__init__(self, url, extra=extra)
286
626
 
287
627
 
288
 
class PathNotChild(BzrNewError):
289
 
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
290
 
 
291
 
    is_user_error = False
 
628
class UnstackableBranchFormat(BzrError):
 
629
 
 
630
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
631
        "You will need to upgrade the branch to permit branch stacking.")
 
632
 
 
633
    def __init__(self, format, url):
 
634
        BzrError.__init__(self)
 
635
        self.format = format
 
636
        self.url = url
 
637
 
 
638
 
 
639
class UnstackableLocationError(BzrError):
 
640
 
 
641
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
642
 
 
643
    def __init__(self, branch_url, target_url):
 
644
        BzrError.__init__(self)
 
645
        self.branch_url = branch_url
 
646
        self.target_url = target_url
 
647
 
 
648
 
 
649
class UnstackableRepositoryFormat(BzrError):
 
650
 
 
651
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
652
        "You will need to upgrade the repository to permit branch stacking.")
 
653
 
 
654
    def __init__(self, format, url):
 
655
        BzrError.__init__(self)
 
656
        self.format = format
 
657
        self.url = url
 
658
 
 
659
 
 
660
class ReadError(PathError):
 
661
 
 
662
    _fmt = """Error reading from %(path)r."""
 
663
 
 
664
 
 
665
class ShortReadvError(PathError):
 
666
 
 
667
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
668
            ' at %(offset)s for "%(path)s"%(extra)s')
 
669
 
 
670
    internal_error = True
 
671
 
 
672
    def __init__(self, path, offset, length, actual, extra=None):
 
673
        PathError.__init__(self, path, extra=extra)
 
674
        self.offset = offset
 
675
        self.length = length
 
676
        self.actual = actual
 
677
 
 
678
 
 
679
class PathNotChild(PathError):
 
680
 
 
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
682
 
 
683
    internal_error = True
292
684
 
293
685
    def __init__(self, path, base, extra=None):
294
 
        BzrNewError.__init__(self)
 
686
        BzrError.__init__(self)
295
687
        self.path = path
296
688
        self.base = base
297
689
        if extra:
301
693
 
302
694
 
303
695
class InvalidNormalization(PathError):
304
 
    """Path %(path)r is not unicode normalized"""
 
696
 
 
697
    _fmt = 'Path "%(path)s" is not unicode normalized'
305
698
 
306
699
 
307
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
308
701
# the exception object is a bit undesirable.
309
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
310
703
class NotBranchError(PathError):
311
 
    """Not a branch: %(path)s"""
312
 
 
313
 
    def __init__(self, path):
314
 
       import bzrlib.urlutils as urlutils
315
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
704
 
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
706
 
 
707
    def __init__(self, path, detail=None, bzrdir=None):
 
708
       import bzrlib.urlutils as urlutils
 
709
       path = urlutils.unescape_for_display(path, 'ascii')
 
710
       if detail is not None:
 
711
           detail = ': ' + detail
 
712
       self.detail = detail
 
713
       self.bzrdir = bzrdir
 
714
       PathError.__init__(self, path=path)
 
715
 
 
716
    def _format(self):
 
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
718
        # Python 2.4 have to be old-style classes so properties don't work.
 
719
        # Instead we override _format.
 
720
        if self.detail is None:
 
721
            if self.bzrdir is not None:
 
722
                try:
 
723
                    self.bzrdir.open_repository()
 
724
                except NoRepositoryPresent:
 
725
                    self.detail = ''
 
726
                else:
 
727
                    self.detail = ': location is a repository'
 
728
            else:
 
729
                self.detail = ''
 
730
        return PathError._format(self)
 
731
 
 
732
 
 
733
class NoSubmitBranch(PathError):
 
734
 
 
735
    _fmt = 'No submit branch available for branch "%(path)s"'
 
736
 
 
737
    def __init__(self, branch):
 
738
       import bzrlib.urlutils as urlutils
 
739
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
316
740
 
317
741
 
318
742
class AlreadyBranchError(PathError):
319
 
    """Already a branch: %(path)s."""
 
743
 
 
744
    _fmt = 'Already a branch: "%(path)s".'
320
745
 
321
746
 
322
747
class BranchExistsWithoutWorkingTree(PathError):
323
 
    """Directory contains a branch, but no working tree \
324
 
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
748
 
 
749
    _fmt = 'Directory contains a branch, but no working tree \
 
750
(use bzr checkout if you wish to build a working tree): "%(path)s"'
325
751
 
326
752
 
327
753
class AtomicFileAlreadyClosed(PathError):
328
 
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
754
 
 
755
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
756
            ' "%(path)s"')
329
757
 
330
758
    def __init__(self, path, function):
331
759
        PathError.__init__(self, path=path, extra=None)
333
761
 
334
762
 
335
763
class InaccessibleParent(PathError):
336
 
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
764
 
 
765
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
766
            ' relative path "%(path)s"')
337
767
 
338
768
    def __init__(self, path, base):
339
769
        PathError.__init__(self, path)
340
770
        self.base = base
341
771
 
342
772
 
343
 
class NoRepositoryPresent(BzrNewError):
344
 
    """No repository present: %(path)r"""
 
773
class NoRepositoryPresent(BzrError):
 
774
 
 
775
    _fmt = 'No repository present: "%(path)s"'
345
776
    def __init__(self, bzrdir):
346
 
        BzrNewError.__init__(self)
 
777
        BzrError.__init__(self)
347
778
        self.path = bzrdir.transport.clone('..').base
348
779
 
349
780
 
350
 
class FileInWrongBranch(BzrNewError):
351
 
    """File %(path)s in not in branch %(branch_base)s."""
 
781
class FileInWrongBranch(BzrError):
 
782
 
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
352
784
 
353
785
    def __init__(self, branch, path):
354
 
        BzrNewError.__init__(self)
 
786
        BzrError.__init__(self)
355
787
        self.branch = branch
356
788
        self.branch_base = branch.base
357
789
        self.path = path
358
790
 
359
791
 
360
 
class UnsupportedFormatError(BzrNewError):
361
 
    """Unsupported branch format: %(format)s"""
362
 
 
363
 
 
364
 
class UnknownFormatError(BzrNewError):
365
 
    """Unknown branch format: %(format)r"""
366
 
 
367
 
 
368
 
class IncompatibleFormat(BzrNewError):
369
 
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
792
class UnsupportedFormatError(BzrError):
 
793
 
 
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
795
 
 
796
 
 
797
class UnknownFormatError(BzrError):
 
798
 
 
799
    _fmt = "Unknown %(kind)s format: %(format)r"
 
800
 
 
801
    def __init__(self, format, kind='branch'):
 
802
        self.kind = kind
 
803
        self.format = format
 
804
 
 
805
 
 
806
class IncompatibleFormat(BzrError):
 
807
 
 
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
370
809
 
371
810
    def __init__(self, format, bzrdir_format):
372
 
        BzrNewError.__init__(self)
 
811
        BzrError.__init__(self)
373
812
        self.format = format
374
813
        self.bzrdir = bzrdir_format
375
814
 
376
815
 
377
 
class NotVersionedError(BzrNewError):
378
 
    """%(path)s is not versioned"""
379
 
    def __init__(self, path):
380
 
        BzrNewError.__init__(self)
381
 
        self.path = path
382
 
 
383
 
 
384
 
class PathsNotVersionedError(BzrNewError):
385
 
    # used when reporting several paths are not versioned
386
 
    """Path(s) are not versioned: %(paths_as_string)s"""
 
816
class IncompatibleRepositories(BzrError):
 
817
    """Report an error that two repositories are not compatible.
 
818
 
 
819
    Note that the source and target repositories are permitted to be strings:
 
820
    this exception is thrown from the smart server and may refer to a
 
821
    repository the client hasn't opened.
 
822
    """
 
823
 
 
824
    _fmt = "%(target)s\n" \
 
825
            "is not compatible with\n" \
 
826
            "%(source)s\n" \
 
827
            "%(details)s"
 
828
 
 
829
    def __init__(self, source, target, details=None):
 
830
        if details is None:
 
831
            details = "(no details)"
 
832
        BzrError.__init__(self, target=target, source=source, details=details)
 
833
 
 
834
 
 
835
class IncompatibleRevision(BzrError):
 
836
 
 
837
    _fmt = "Revision is not compatible with %(repo_format)s"
 
838
 
 
839
    def __init__(self, repo_format):
 
840
        BzrError.__init__(self)
 
841
        self.repo_format = repo_format
 
842
 
 
843
 
 
844
class AlreadyVersionedError(BzrError):
 
845
    """Used when a path is expected not to be versioned, but it is."""
 
846
 
 
847
    _fmt = "%(context_info)s%(path)s is already versioned."
 
848
 
 
849
    def __init__(self, path, context_info=None):
 
850
        """Construct a new AlreadyVersionedError.
 
851
 
 
852
        :param path: This is the path which is versioned,
 
853
        which should be in a user friendly form.
 
854
        :param context_info: If given, this is information about the context,
 
855
        which could explain why this is expected to not be versioned.
 
856
        """
 
857
        BzrError.__init__(self)
 
858
        self.path = path
 
859
        if context_info is None:
 
860
            self.context_info = ''
 
861
        else:
 
862
            self.context_info = context_info + ". "
 
863
 
 
864
 
 
865
class NotVersionedError(BzrError):
 
866
    """Used when a path is expected to be versioned, but it is not."""
 
867
 
 
868
    _fmt = "%(context_info)s%(path)s is not versioned."
 
869
 
 
870
    def __init__(self, path, context_info=None):
 
871
        """Construct a new NotVersionedError.
 
872
 
 
873
        :param path: This is the path which is not versioned,
 
874
        which should be in a user friendly form.
 
875
        :param context_info: If given, this is information about the context,
 
876
        which could explain why this is expected to be versioned.
 
877
        """
 
878
        BzrError.__init__(self)
 
879
        self.path = path
 
880
        if context_info is None:
 
881
            self.context_info = ''
 
882
        else:
 
883
            self.context_info = context_info + ". "
 
884
 
 
885
 
 
886
class PathsNotVersionedError(BzrError):
 
887
    """Used when reporting several paths which are not versioned"""
 
888
 
 
889
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
387
890
 
388
891
    def __init__(self, paths):
389
892
        from bzrlib.osutils import quotefn
390
 
        BzrNewError.__init__(self)
 
893
        BzrError.__init__(self)
391
894
        self.paths = paths
392
895
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
393
896
 
394
897
 
395
 
class PathsDoNotExist(BzrNewError):
396
 
    """Path(s) do not exist: %(paths_as_string)s"""
 
898
class PathsDoNotExist(BzrError):
 
899
 
 
900
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
397
901
 
398
902
    # used when reporting that paths are neither versioned nor in the working
399
903
    # tree
400
904
 
401
 
    def __init__(self, paths):
 
905
    def __init__(self, paths, extra=None):
402
906
        # circular import
403
907
        from bzrlib.osutils import quotefn
404
 
        BzrNewError.__init__(self)
 
908
        BzrError.__init__(self)
405
909
        self.paths = paths
406
910
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
407
 
 
408
 
 
409
 
class BadFileKindError(BzrNewError):
410
 
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
411
 
 
412
 
 
413
 
class ForbiddenControlFileError(BzrNewError):
414
 
    """Cannot operate on %(filename)s because it is a control file"""
415
 
 
416
 
 
417
 
class LockError(BzrNewError):
418
 
    """Lock error: %(message)s"""
 
911
        if extra:
 
912
            self.extra = ': ' + str(extra)
 
913
        else:
 
914
            self.extra = ''
 
915
 
 
916
 
 
917
class BadFileKindError(BzrError):
 
918
 
 
919
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
920
 
 
921
    def __init__(self, filename, kind):
 
922
        BzrError.__init__(self, filename=filename, kind=kind)
 
923
 
 
924
 
 
925
class BadFilenameEncoding(BzrError):
 
926
 
 
927
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
928
            ' encoding %(fs_encoding)s')
 
929
 
 
930
    def __init__(self, filename, fs_encoding):
 
931
        BzrError.__init__(self)
 
932
        self.filename = filename
 
933
        self.fs_encoding = fs_encoding
 
934
 
 
935
 
 
936
class ForbiddenControlFileError(BzrError):
 
937
 
 
938
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
939
 
 
940
 
 
941
class LockError(InternalBzrError):
 
942
 
 
943
    _fmt = "Lock error: %(msg)s"
 
944
 
419
945
    # All exceptions from the lock/unlock functions should be from
420
946
    # this exception class.  They will be translated as necessary. The
421
947
    # original exception is available as e.original_error
422
948
    #
423
949
    # New code should prefer to raise specific subclasses
424
950
    def __init__(self, message):
425
 
        self.message = message
 
951
        # Python 2.5 uses a slot for StandardError.message,
 
952
        # so use a different variable name.  We now work around this in
 
953
        # BzrError.__str__, but this member name is kept for compatability.
 
954
        self.msg = message
 
955
 
 
956
 
 
957
class LockActive(LockError):
 
958
 
 
959
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
960
 
 
961
    internal_error = False
 
962
 
 
963
    def __init__(self, lock_description):
 
964
        self.lock_description = lock_description
426
965
 
427
966
 
428
967
class CommitNotPossible(LockError):
429
 
    """A commit was attempted but we do not have a write lock open."""
 
968
 
 
969
    _fmt = "A commit was attempted but we do not have a write lock open."
 
970
 
430
971
    def __init__(self):
431
972
        pass
432
973
 
433
974
 
434
975
class AlreadyCommitted(LockError):
435
 
    """A rollback was requested, but is not able to be accomplished."""
 
976
 
 
977
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
978
 
436
979
    def __init__(self):
437
980
        pass
438
981
 
439
982
 
440
983
class ReadOnlyError(LockError):
441
 
    """A write attempt was made in a read only transaction on %(obj)s"""
 
984
 
 
985
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
986
 
 
987
    # TODO: There should also be an error indicating that you need a write
 
988
    # lock and don't have any lock at all... mbp 20070226
 
989
 
442
990
    def __init__(self, obj):
443
991
        self.obj = obj
444
992
 
445
993
 
446
 
class OutSideTransaction(BzrNewError):
447
 
    """A transaction related operation was attempted after the transaction finished."""
 
994
class LockFailed(LockError):
 
995
 
 
996
    internal_error = False
 
997
 
 
998
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
999
 
 
1000
    def __init__(self, lock, why):
 
1001
        LockError.__init__(self, '')
 
1002
        self.lock = lock
 
1003
        self.why = why
 
1004
 
 
1005
 
 
1006
class OutSideTransaction(BzrError):
 
1007
 
 
1008
    _fmt = ("A transaction related operation was attempted after"
 
1009
            " the transaction finished.")
448
1010
 
449
1011
 
450
1012
class ObjectNotLocked(LockError):
451
 
    """%(obj)r is not locked"""
452
1013
 
453
 
    is_user_error = False
 
1014
    _fmt = "%(obj)r is not locked"
454
1015
 
455
1016
    # this can indicate that any particular object is not locked; see also
456
1017
    # LockNotHeld which means that a particular *lock* object is not held by
460
1021
 
461
1022
 
462
1023
class ReadOnlyObjectDirtiedError(ReadOnlyError):
463
 
    """Cannot change object %(obj)r in read only transaction"""
 
1024
 
 
1025
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
1026
 
464
1027
    def __init__(self, obj):
465
1028
        self.obj = obj
466
1029
 
467
1030
 
468
1031
class UnlockableTransport(LockError):
469
 
    """Cannot lock: transport is read only: %(transport)s"""
 
1032
 
 
1033
    internal_error = False
 
1034
 
 
1035
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
1036
 
470
1037
    def __init__(self, transport):
471
1038
        self.transport = transport
472
1039
 
473
1040
 
474
1041
class LockContention(LockError):
475
 
    """Could not acquire lock %(lock)s"""
476
 
    # TODO: show full url for lock, combining the transport and relative bits?
477
 
    def __init__(self, lock):
 
1042
 
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
 
1046
 
 
1047
    internal_error = False
 
1048
 
 
1049
    def __init__(self, lock, msg=''):
478
1050
        self.lock = lock
 
1051
        self.msg = msg
479
1052
 
480
1053
 
481
1054
class LockBroken(LockError):
482
 
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
1055
 
 
1056
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1057
            " - check storage consistency!")
 
1058
 
 
1059
    internal_error = False
 
1060
 
483
1061
    def __init__(self, lock):
484
1062
        self.lock = lock
485
1063
 
486
1064
 
487
1065
class LockBreakMismatch(LockError):
488
 
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
1066
 
 
1067
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1068
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
1069
 
 
1070
    internal_error = False
 
1071
 
489
1072
    def __init__(self, lock, holder, target):
490
1073
        self.lock = lock
491
1074
        self.holder = holder
493
1076
 
494
1077
 
495
1078
class LockNotHeld(LockError):
496
 
    """Lock not held: %(lock)s"""
 
1079
 
 
1080
    _fmt = "Lock not held: %(lock)s"
 
1081
 
 
1082
    internal_error = False
 
1083
 
497
1084
    def __init__(self, lock):
498
1085
        self.lock = lock
499
1086
 
500
1087
 
501
 
class PointlessCommit(BzrNewError):
502
 
    """No changes to commit"""
503
 
 
504
 
 
505
 
class UpgradeReadonly(BzrNewError):
506
 
    """Upgrade URL cannot work with readonly URL's."""
507
 
 
508
 
 
509
 
class UpToDateFormat(BzrNewError):
510
 
    """The branch format %(format)s is already at the most recent format."""
 
1088
class TokenLockingNotSupported(LockError):
 
1089
 
 
1090
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1091
 
 
1092
    def __init__(self, obj):
 
1093
        self.obj = obj
 
1094
 
 
1095
 
 
1096
class TokenMismatch(LockBroken):
 
1097
 
 
1098
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1099
 
 
1100
    internal_error = True
 
1101
 
 
1102
    def __init__(self, given_token, lock_token):
 
1103
        self.given_token = given_token
 
1104
        self.lock_token = lock_token
 
1105
 
 
1106
 
 
1107
class PointlessCommit(BzrError):
 
1108
 
 
1109
    _fmt = "No changes to commit"
 
1110
 
 
1111
 
 
1112
class CannotCommitSelectedFileMerge(BzrError):
 
1113
 
 
1114
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1115
        ' files %(files_str)s'
 
1116
 
 
1117
    def __init__(self, files):
 
1118
        files_str = ', '.join(files)
 
1119
        BzrError.__init__(self, files=files, files_str=files_str)
 
1120
 
 
1121
 
 
1122
class BadCommitMessageEncoding(BzrError):
 
1123
 
 
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1125
        'the current encoding.'
 
1126
 
 
1127
 
 
1128
class UpgradeReadonly(BzrError):
 
1129
 
 
1130
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
1131
 
 
1132
 
 
1133
class UpToDateFormat(BzrError):
 
1134
 
 
1135
    _fmt = "The branch format %(format)s is already at the most recent format."
511
1136
 
512
1137
    def __init__(self, format):
513
 
        BzrNewError.__init__(self)
 
1138
        BzrError.__init__(self)
514
1139
        self.format = format
515
1140
 
516
1141
 
517
1142
class StrictCommitFailed(Exception):
518
 
    """Commit refused because there are unknowns in the tree."""
519
 
 
520
 
 
521
 
class NoSuchRevision(BzrNewError):
522
 
    """Branch %(branch)s has no revision %(revision)s"""
523
 
 
524
 
    is_user_error = False
 
1143
 
 
1144
    _fmt = "Commit refused because there are unknowns in the tree."
 
1145
 
 
1146
 
 
1147
class NoSuchRevision(InternalBzrError):
 
1148
 
 
1149
    _fmt = "%(branch)s has no revision %(revision)s"
525
1150
 
526
1151
    def __init__(self, branch, revision):
527
 
        BzrNewError.__init__(self, branch=branch, revision=revision)
528
 
 
529
 
 
530
 
class NoSuchRevisionSpec(BzrNewError):
531
 
    """No namespace registered for string: %(spec)r"""
 
1152
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1153
        BzrError.__init__(self, branch=branch, revision=revision)
 
1154
 
 
1155
 
 
1156
class RangeInChangeOption(BzrError):
 
1157
 
 
1158
    _fmt = "Option --change does not accept revision ranges"
 
1159
 
 
1160
 
 
1161
class NoSuchRevisionSpec(BzrError):
 
1162
 
 
1163
    _fmt = "No namespace registered for string: %(spec)r"
532
1164
 
533
1165
    def __init__(self, spec):
534
 
        BzrNewError.__init__(self, spec=spec)
535
 
 
536
 
 
537
 
class InvalidRevisionSpec(BzrNewError):
538
 
    """Requested revision: '%(spec)s' does not exist in branch:
539
 
%(branch)s%(extra)s"""
 
1166
        BzrError.__init__(self, spec=spec)
 
1167
 
 
1168
 
 
1169
class NoSuchRevisionInTree(NoSuchRevision):
 
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1171
 
 
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1173
 
 
1174
    def __init__(self, tree, revision_id):
 
1175
        BzrError.__init__(self)
 
1176
        self.tree = tree
 
1177
        self.revision_id = revision_id
 
1178
 
 
1179
 
 
1180
class InvalidRevisionSpec(BzrError):
 
1181
 
 
1182
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1183
            " %(branch)s%(extra)s")
540
1184
 
541
1185
    def __init__(self, spec, branch, extra=None):
542
 
        BzrNewError.__init__(self, branch=branch, spec=spec)
 
1186
        BzrError.__init__(self, branch=branch, spec=spec)
543
1187
        if extra:
544
1188
            self.extra = '\n' + str(extra)
545
1189
        else:
547
1191
 
548
1192
 
549
1193
class HistoryMissing(BzrError):
550
 
    def __init__(self, branch, object_type, object_id):
551
 
        self.branch = branch
552
 
        BzrError.__init__(self,
553
 
                          '%s is missing %s {%s}'
554
 
                          % (branch, object_type, object_id))
555
 
 
556
 
 
557
 
class DivergedBranches(BzrNewError):
558
 
    "These branches have diverged.  Use the merge command to reconcile them."""
559
 
 
560
 
    is_user_error = True
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
 
1198
class AppendRevisionsOnlyViolation(BzrError):
 
1199
 
 
1200
    _fmt = ('Operation denied because it would change the main history,'
 
1201
           ' which is not permitted by the append_revisions_only setting on'
 
1202
           ' branch "%(location)s".')
 
1203
 
 
1204
    def __init__(self, location):
 
1205
       import bzrlib.urlutils as urlutils
 
1206
       location = urlutils.unescape_for_display(location, 'ascii')
 
1207
       BzrError.__init__(self, location=location)
 
1208
 
 
1209
 
 
1210
class DivergedBranches(BzrError):
 
1211
 
 
1212
    _fmt = ("These branches have diverged."
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
561
1215
 
562
1216
    def __init__(self, branch1, branch2):
563
1217
        self.branch1 = branch1
564
1218
        self.branch2 = branch2
565
1219
 
566
1220
 
567
 
class UnrelatedBranches(BzrNewError):
568
 
    "Branches have no common ancestor, and no merge base revision was specified."
569
 
 
570
 
    is_user_error = True
571
 
 
572
 
 
573
 
class NoCommonAncestor(BzrNewError):
574
 
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1221
class NotLefthandHistory(InternalBzrError):
 
1222
 
 
1223
    _fmt = "Supplied history does not follow left-hand parents"
 
1224
 
 
1225
    def __init__(self, history):
 
1226
        BzrError.__init__(self, history=history)
 
1227
 
 
1228
 
 
1229
class UnrelatedBranches(BzrError):
 
1230
 
 
1231
    _fmt = ("Branches have no common ancestor, and"
 
1232
            " no merge base revision was specified.")
 
1233
 
 
1234
 
 
1235
class CannotReverseCherrypick(BzrError):
 
1236
 
 
1237
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1238
            ' or diff3.')
 
1239
 
 
1240
 
 
1241
class NoCommonAncestor(BzrError):
 
1242
 
 
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
575
1244
 
576
1245
    def __init__(self, revision_a, revision_b):
577
1246
        self.revision_a = revision_a
579
1248
 
580
1249
 
581
1250
class NoCommonRoot(BzrError):
 
1251
 
 
1252
    _fmt = ("Revisions are not derived from the same root: "
 
1253
           "%(revision_a)s %(revision_b)s.")
 
1254
 
582
1255
    def __init__(self, revision_a, revision_b):
583
 
        msg = "Revisions are not derived from the same root: %s %s." \
584
 
            % (revision_a, revision_b) 
585
 
        BzrError.__init__(self, msg)
586
 
 
 
1256
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
587
1257
 
588
1258
 
589
1259
class NotAncestor(BzrError):
 
1260
 
 
1261
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1262
 
590
1263
    def __init__(self, rev_id, not_ancestor_id):
591
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
592
 
                                                        rev_id)
593
 
        BzrError.__init__(self, msg)
594
 
        self.rev_id = rev_id
595
 
        self.not_ancestor_id = not_ancestor_id
596
 
 
597
 
 
598
 
class InstallFailed(BzrError):
599
 
    def __init__(self, revisions):
600
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
601
 
        BzrError.__init__(self, msg)
602
 
        self.revisions = revisions
 
1264
        BzrError.__init__(self, rev_id=rev_id,
 
1265
            not_ancestor_id=not_ancestor_id)
603
1266
 
604
1267
 
605
1268
class AmbiguousBase(BzrError):
 
1269
 
606
1270
    def __init__(self, bases):
607
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
608
 
                DeprecationWarning)
609
 
        msg = "The correct base is unclear, because %s are all equally close" %\
610
 
            ", ".join(bases)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1273
        msg = ("The correct base is unclear, because %s are all equally close"
 
1274
                % ", ".join(bases))
611
1275
        BzrError.__init__(self, msg)
612
1276
        self.bases = bases
613
1277
 
614
1278
 
615
 
class NoCommits(BzrNewError):
616
 
    """Branch %(branch)s has no commits."""
 
1279
class NoCommits(BranchError):
617
1280
 
618
 
    def __init__(self, branch):
619
 
        BzrNewError.__init__(self, branch=branch)
 
1281
    _fmt = "Branch %(branch)s has no commits."
620
1282
 
621
1283
 
622
1284
class UnlistableStore(BzrError):
 
1285
 
623
1286
    def __init__(self, store):
624
1287
        BzrError.__init__(self, "Store %s is not listable" % store)
625
1288
 
626
1289
 
627
1290
 
628
1291
class UnlistableBranch(BzrError):
 
1292
 
629
1293
    def __init__(self, br):
630
1294
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
631
1295
 
632
1296
 
633
 
class BoundBranchOutOfDate(BzrNewError):
634
 
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
1297
class BoundBranchOutOfDate(BzrError):
 
1298
 
 
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1300
            " %(master)s.")
 
1301
 
635
1302
    def __init__(self, branch, master):
636
 
        BzrNewError.__init__(self)
 
1303
        BzrError.__init__(self)
637
1304
        self.branch = branch
638
1305
        self.master = master
639
1306
 
640
 
        
641
 
class CommitToDoubleBoundBranch(BzrNewError):
642
 
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
1307
 
 
1308
class CommitToDoubleBoundBranch(BzrError):
 
1309
 
 
1310
    _fmt = ("Cannot commit to branch %(branch)s."
 
1311
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1312
 
643
1313
    def __init__(self, branch, master, remote):
644
 
        BzrNewError.__init__(self)
 
1314
        BzrError.__init__(self)
645
1315
        self.branch = branch
646
1316
        self.master = master
647
1317
        self.remote = remote
648
1318
 
649
1319
 
650
 
class OverwriteBoundBranch(BzrNewError):
651
 
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
1320
class OverwriteBoundBranch(BzrError):
 
1321
 
 
1322
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1323
 
652
1324
    def __init__(self, branch):
653
 
        BzrNewError.__init__(self)
 
1325
        BzrError.__init__(self)
654
1326
        self.branch = branch
655
1327
 
656
1328
 
657
 
class BoundBranchConnectionFailure(BzrNewError):
658
 
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
1329
class BoundBranchConnectionFailure(BzrError):
 
1330
 
 
1331
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1332
            " => %(target)s: %(error)s")
 
1333
 
659
1334
    def __init__(self, branch, target, error):
660
 
        BzrNewError.__init__(self)
 
1335
        BzrError.__init__(self)
661
1336
        self.branch = branch
662
1337
        self.target = target
663
1338
        self.error = error
664
1339
 
665
1340
 
666
 
class WeaveError(BzrNewError):
667
 
    """Error in processing weave: %(message)s"""
668
 
 
669
 
    def __init__(self, message=None):
670
 
        BzrNewError.__init__(self)
671
 
        self.message = message
 
1341
class WeaveError(BzrError):
 
1342
 
 
1343
    _fmt = "Error in processing weave: %(msg)s"
 
1344
 
 
1345
    def __init__(self, msg=None):
 
1346
        BzrError.__init__(self)
 
1347
        self.msg = msg
672
1348
 
673
1349
 
674
1350
class WeaveRevisionAlreadyPresent(WeaveError):
675
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
1351
 
 
1352
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1353
 
676
1354
    def __init__(self, revision_id, weave):
677
1355
 
678
1356
        WeaveError.__init__(self)
681
1359
 
682
1360
 
683
1361
class WeaveRevisionNotPresent(WeaveError):
684
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
1362
 
 
1363
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
685
1364
 
686
1365
    def __init__(self, revision_id, weave):
687
1366
        WeaveError.__init__(self)
690
1369
 
691
1370
 
692
1371
class WeaveFormatError(WeaveError):
693
 
    """Weave invariant violated: %(what)s"""
 
1372
 
 
1373
    _fmt = "Weave invariant violated: %(what)s"
694
1374
 
695
1375
    def __init__(self, what):
696
1376
        WeaveError.__init__(self)
698
1378
 
699
1379
 
700
1380
class WeaveParentMismatch(WeaveError):
701
 
    """Parents are mismatched between two revisions."""
702
 
    
 
1381
 
 
1382
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1383
 
703
1384
 
704
1385
class WeaveInvalidChecksum(WeaveError):
705
 
    """Text did not match it's checksum: %(message)s"""
706
 
 
707
 
 
708
 
class WeaveTextDiffers(WeaveError):
709
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
710
 
 
711
 
    def __init__(self, revision_id, weave_a, weave_b):
712
 
        WeaveError.__init__(self)
713
 
        self.revision_id = revision_id
714
 
        self.weave_a = weave_a
715
 
        self.weave_b = weave_b
716
 
 
717
 
 
718
 
class WeaveTextDiffers(WeaveError):
719
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
720
 
 
721
 
    def __init__(self, revision_id, weave_a, weave_b):
722
 
        WeaveError.__init__(self)
723
 
        self.revision_id = revision_id
724
 
        self.weave_a = weave_a
725
 
        self.weave_b = weave_b
726
 
 
727
 
 
728
 
class VersionedFileError(BzrNewError):
729
 
    """Versioned file error."""
 
1386
 
 
1387
    _fmt = "Text did not match it's checksum: %(message)s"
 
1388
 
 
1389
 
 
1390
class WeaveTextDiffers(WeaveError):
 
1391
 
 
1392
    _fmt = ("Weaves differ on text content. Revision:"
 
1393
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1394
 
 
1395
    def __init__(self, revision_id, weave_a, weave_b):
 
1396
        WeaveError.__init__(self)
 
1397
        self.revision_id = revision_id
 
1398
        self.weave_a = weave_a
 
1399
        self.weave_b = weave_b
 
1400
 
 
1401
 
 
1402
class WeaveTextDiffers(WeaveError):
 
1403
 
 
1404
    _fmt = ("Weaves differ on text content. Revision:"
 
1405
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1406
 
 
1407
    def __init__(self, revision_id, weave_a, weave_b):
 
1408
        WeaveError.__init__(self)
 
1409
        self.revision_id = revision_id
 
1410
        self.weave_a = weave_a
 
1411
        self.weave_b = weave_b
 
1412
 
 
1413
 
 
1414
class VersionedFileError(BzrError):
 
1415
 
 
1416
    _fmt = "Versioned file error"
730
1417
 
731
1418
 
732
1419
class RevisionNotPresent(VersionedFileError):
733
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
1420
 
 
1421
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
734
1422
 
735
1423
    def __init__(self, revision_id, file_id):
736
1424
        VersionedFileError.__init__(self)
739
1427
 
740
1428
 
741
1429
class RevisionAlreadyPresent(VersionedFileError):
742
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
1430
 
 
1431
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
743
1432
 
744
1433
    def __init__(self, revision_id, file_id):
745
1434
        VersionedFileError.__init__(self)
747
1436
        self.file_id = file_id
748
1437
 
749
1438
 
750
 
class KnitError(BzrNewError):
751
 
    """Knit error"""
752
 
 
753
 
 
754
 
class KnitHeaderError(KnitError):
755
 
    """Knit header error: %(badline)r unexpected"""
756
 
 
757
 
    def __init__(self, badline):
758
 
        KnitError.__init__(self)
759
 
        self.badline = badline
 
1439
class VersionedFileInvalidChecksum(VersionedFileError):
 
1440
 
 
1441
    _fmt = "Text did not match its checksum: %(message)s"
 
1442
 
 
1443
 
 
1444
class KnitError(InternalBzrError):
 
1445
 
 
1446
    _fmt = "Knit error"
760
1447
 
761
1448
 
762
1449
class KnitCorrupt(KnitError):
763
 
    """Knit %(filename)s corrupt: %(how)s"""
 
1450
 
 
1451
    _fmt = "Knit %(filename)s corrupt: %(how)s"
764
1452
 
765
1453
    def __init__(self, filename, how):
766
1454
        KnitError.__init__(self)
768
1456
        self.how = how
769
1457
 
770
1458
 
771
 
class NoSuchExportFormat(BzrNewError):
772
 
    """Export format %(format)r not supported"""
 
1459
class SHA1KnitCorrupt(KnitCorrupt):
 
1460
 
 
1461
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1462
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1463
        "sha %(actual)s")
 
1464
 
 
1465
    def __init__(self, filename, actual, expected, key, content):
 
1466
        KnitError.__init__(self)
 
1467
        self.filename = filename
 
1468
        self.actual = actual
 
1469
        self.expected = expected
 
1470
        self.key = key
 
1471
        self.content = content
 
1472
 
 
1473
 
 
1474
class KnitDataStreamIncompatible(KnitError):
 
1475
    # Not raised anymore, as we can convert data streams.  In future we may
 
1476
    # need it again for more exotic cases, so we're keeping it around for now.
 
1477
 
 
1478
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1479
 
 
1480
    def __init__(self, stream_format, target_format):
 
1481
        self.stream_format = stream_format
 
1482
        self.target_format = target_format
 
1483
 
 
1484
 
 
1485
class KnitDataStreamUnknown(KnitError):
 
1486
    # Indicates a data stream we don't know how to handle.
 
1487
 
 
1488
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1489
 
 
1490
    def __init__(self, stream_format):
 
1491
        self.stream_format = stream_format
 
1492
 
 
1493
 
 
1494
class KnitHeaderError(KnitError):
 
1495
 
 
1496
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1497
 
 
1498
    def __init__(self, badline, filename):
 
1499
        KnitError.__init__(self)
 
1500
        self.badline = badline
 
1501
        self.filename = filename
 
1502
 
 
1503
class KnitIndexUnknownMethod(KnitError):
 
1504
    """Raised when we don't understand the storage method.
 
1505
 
 
1506
    Currently only 'fulltext' and 'line-delta' are supported.
 
1507
    """
 
1508
 
 
1509
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1510
            " in options: %(options)r")
 
1511
 
 
1512
    def __init__(self, filename, options):
 
1513
        KnitError.__init__(self)
 
1514
        self.filename = filename
 
1515
        self.options = options
 
1516
 
 
1517
 
 
1518
class RetryWithNewPacks(BzrError):
 
1519
    """Raised when we realize that the packs on disk have changed.
 
1520
 
 
1521
    This is meant as more of a signaling exception, to trap between where a
 
1522
    local error occurred and the code that can actually handle the error and
 
1523
    code that can retry appropriately.
 
1524
    """
 
1525
 
 
1526
    internal_error = True
 
1527
 
 
1528
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1529
            " %(orig_error)s")
 
1530
 
 
1531
    def __init__(self, context, reload_occurred, exc_info):
 
1532
        """create a new RetryWithNewPacks error.
 
1533
 
 
1534
        :param reload_occurred: Set to True if we know that the packs have
 
1535
            already been reloaded, and we are failing because of an in-memory
 
1536
            cache miss. If set to True then we will ignore if a reload says
 
1537
            nothing has changed, because we assume it has already reloaded. If
 
1538
            False, then a reload with nothing changed will force an error.
 
1539
        :param exc_info: The original exception traceback, so if there is a
 
1540
            problem we can raise the original error (value from sys.exc_info())
 
1541
        """
 
1542
        BzrError.__init__(self)
 
1543
        self.reload_occurred = reload_occurred
 
1544
        self.exc_info = exc_info
 
1545
        self.orig_error = exc_info[1]
 
1546
        # TODO: The global error handler should probably treat this by
 
1547
        #       raising/printing the original exception with a bit about
 
1548
        #       RetryWithNewPacks also not being caught
 
1549
 
 
1550
 
 
1551
class RetryAutopack(RetryWithNewPacks):
 
1552
    """Raised when we are autopacking and we find a missing file.
 
1553
 
 
1554
    Meant as a signaling exception, to tell the autopack code it should try
 
1555
    again.
 
1556
    """
 
1557
 
 
1558
    internal_error = True
 
1559
 
 
1560
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1561
            " context: %(context)s %(orig_error)s")
 
1562
 
 
1563
 
 
1564
class NoSuchExportFormat(BzrError):
 
1565
 
 
1566
    _fmt = "Export format %(format)r not supported"
 
1567
 
773
1568
    def __init__(self, format):
774
 
        BzrNewError.__init__(self)
 
1569
        BzrError.__init__(self)
775
1570
        self.format = format
776
1571
 
777
1572
 
778
 
class TransportError(BzrNewError):
779
 
    """Transport error: %(msg)s %(orig_error)s"""
 
1573
class TransportError(BzrError):
 
1574
 
 
1575
    _fmt = "Transport error: %(msg)s %(orig_error)s"
780
1576
 
781
1577
    def __init__(self, msg=None, orig_error=None):
782
1578
        if msg is None and orig_error is not None:
787
1583
            msg =  ''
788
1584
        self.msg = msg
789
1585
        self.orig_error = orig_error
790
 
        BzrNewError.__init__(self)
 
1586
        BzrError.__init__(self)
 
1587
 
 
1588
 
 
1589
class TooManyConcurrentRequests(InternalBzrError):
 
1590
 
 
1591
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1592
            " Be sure to finish_writing and finish_reading on the"
 
1593
            " currently open request.")
 
1594
 
 
1595
    def __init__(self, medium):
 
1596
        self.medium = medium
 
1597
 
 
1598
 
 
1599
class SmartProtocolError(TransportError):
 
1600
 
 
1601
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1602
 
 
1603
    def __init__(self, details):
 
1604
        self.details = details
 
1605
 
 
1606
 
 
1607
class UnexpectedProtocolVersionMarker(TransportError):
 
1608
 
 
1609
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1610
 
 
1611
    def __init__(self, marker):
 
1612
        self.marker = marker
 
1613
 
 
1614
 
 
1615
class UnknownSmartMethod(InternalBzrError):
 
1616
 
 
1617
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1618
 
 
1619
    def __init__(self, verb):
 
1620
        self.verb = verb
 
1621
 
 
1622
 
 
1623
class SmartMessageHandlerError(InternalBzrError):
 
1624
 
 
1625
    _fmt = ("The message handler raised an exception:\n"
 
1626
            "%(traceback_text)s")
 
1627
 
 
1628
    def __init__(self, exc_info):
 
1629
        import traceback
 
1630
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1631
        self.exc_info = exc_info
 
1632
        traceback_strings = traceback.format_exception(
 
1633
                self.exc_type, self.exc_value, self.exc_tb)
 
1634
        self.traceback_text = ''.join(traceback_strings)
791
1635
 
792
1636
 
793
1637
# A set of semi-meaningful errors which can be thrown
794
1638
class TransportNotPossible(TransportError):
795
 
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
1639
 
 
1640
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
796
1641
 
797
1642
 
798
1643
class ConnectionError(TransportError):
799
 
    """Connection error: %(msg)s %(orig_error)s"""
800
 
 
801
 
 
 
1644
 
 
1645
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1646
 
 
1647
 
 
1648
class SocketConnectionError(ConnectionError):
 
1649
 
 
1650
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1651
 
 
1652
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1653
        if msg is None:
 
1654
            msg = 'Failed to connect to'
 
1655
        if orig_error is None:
 
1656
            orig_error = ''
 
1657
        else:
 
1658
            orig_error = '; ' + str(orig_error)
 
1659
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1660
        self.host = host
 
1661
        if port is None:
 
1662
            self.port = ''
 
1663
        else:
 
1664
            self.port = ':%s' % port
 
1665
 
 
1666
 
 
1667
# XXX: This is also used for unexpected end of file, which is different at the
 
1668
# TCP level from "connection reset".
802
1669
class ConnectionReset(TransportError):
803
 
    """Connection closed: %(msg)s %(orig_error)s"""
 
1670
 
 
1671
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
804
1672
 
805
1673
 
806
1674
class InvalidRange(TransportError):
807
 
    """Invalid range access in %(path)s at %(offset)s."""
808
 
    
809
 
    def __init__(self, path, offset):
810
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
811
 
                                       % (path, offset)))
 
1675
 
 
1676
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1677
 
 
1678
    def __init__(self, path, offset, msg=None):
 
1679
        TransportError.__init__(self, msg)
812
1680
        self.path = path
813
1681
        self.offset = offset
814
1682
 
815
1683
 
816
1684
class InvalidHttpResponse(TransportError):
817
 
    """Invalid http response for %(path)s: %(msg)s"""
 
1685
 
 
1686
    _fmt = "Invalid http response for %(path)s: %(msg)s"
818
1687
 
819
1688
    def __init__(self, path, msg, orig_error=None):
820
1689
        self.path = path
822
1691
 
823
1692
 
824
1693
class InvalidHttpRange(InvalidHttpResponse):
825
 
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
826
 
    
 
1694
 
 
1695
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1696
 
827
1697
    def __init__(self, path, range, msg):
828
1698
        self.range = range
829
1699
        InvalidHttpResponse.__init__(self, path, msg)
830
1700
 
831
1701
 
832
1702
class InvalidHttpContentType(InvalidHttpResponse):
833
 
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
834
 
    
 
1703
 
 
1704
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1705
 
835
1706
    def __init__(self, path, ctype, msg):
836
1707
        self.ctype = ctype
837
1708
        InvalidHttpResponse.__init__(self, path, msg)
838
1709
 
839
1710
 
 
1711
class RedirectRequested(TransportError):
 
1712
 
 
1713
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1714
 
 
1715
    def __init__(self, source, target, is_permanent=False):
 
1716
        self.source = source
 
1717
        self.target = target
 
1718
        if is_permanent:
 
1719
            self.permanently = ' permanently'
 
1720
        else:
 
1721
            self.permanently = ''
 
1722
        TransportError.__init__(self)
 
1723
 
 
1724
 
 
1725
class TooManyRedirections(TransportError):
 
1726
 
 
1727
    _fmt = "Too many redirections"
 
1728
 
 
1729
 
840
1730
class ConflictsInTree(BzrError):
841
 
    def __init__(self):
842
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1731
 
 
1732
    _fmt = "Working tree has conflicts."
843
1733
 
844
1734
 
845
1735
class ParseConfigError(BzrError):
 
1736
 
846
1737
    def __init__(self, errors, filename):
847
1738
        if filename is None:
848
1739
            filename = ""
849
1740
        message = "Error(s) parsing config file %s:\n%s" % \
850
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1741
            (filename, ('\n'.join(e.msg for e in errors)))
851
1742
        BzrError.__init__(self, message)
852
1743
 
853
1744
 
 
1745
class NoEmailInUsername(BzrError):
 
1746
 
 
1747
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1748
 
 
1749
    def __init__(self, username):
 
1750
        BzrError.__init__(self)
 
1751
        self.username = username
 
1752
 
 
1753
 
854
1754
class SigningFailed(BzrError):
 
1755
 
 
1756
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1757
 
855
1758
    def __init__(self, command_line):
856
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
857
 
                               % command_line)
 
1759
        BzrError.__init__(self, command_line=command_line)
858
1760
 
859
1761
 
860
1762
class WorkingTreeNotRevision(BzrError):
 
1763
 
 
1764
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1765
            " the last commit, but weave merge requires that it be"
 
1766
            " unchanged")
 
1767
 
861
1768
    def __init__(self, tree):
862
 
        BzrError.__init__(self, "The working tree for %s has changed since"
863
 
                          " last commit, but weave merge requires that it be"
864
 
                          " unchanged." % tree.basedir)
865
 
 
866
 
 
867
 
class CantReprocessAndShowBase(BzrNewError):
868
 
    """Can't reprocess and show base.
869
 
Reprocessing obscures relationship of conflicting lines to base."""
870
 
 
871
 
 
872
 
class GraphCycleError(BzrNewError):
873
 
    """Cycle in graph %(graph)r"""
 
1769
        BzrError.__init__(self, basedir=tree.basedir)
 
1770
 
 
1771
 
 
1772
class CantReprocessAndShowBase(BzrError):
 
1773
 
 
1774
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1775
           "the relationship of conflicting lines to the base")
 
1776
 
 
1777
 
 
1778
class GraphCycleError(BzrError):
 
1779
 
 
1780
    _fmt = "Cycle in graph %(graph)r"
 
1781
 
874
1782
    def __init__(self, graph):
875
 
        BzrNewError.__init__(self)
 
1783
        BzrError.__init__(self)
876
1784
        self.graph = graph
877
1785
 
878
1786
 
879
 
class NotConflicted(BzrNewError):
880
 
    """File %(filename)s is not conflicted."""
 
1787
class WritingCompleted(InternalBzrError):
 
1788
 
 
1789
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1790
            "called upon it - accept bytes may not be called anymore.")
 
1791
 
 
1792
    def __init__(self, request):
 
1793
        self.request = request
 
1794
 
 
1795
 
 
1796
class WritingNotComplete(InternalBzrError):
 
1797
 
 
1798
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1799
            "called upon it - until the write phase is complete no "
 
1800
            "data may be read.")
 
1801
 
 
1802
    def __init__(self, request):
 
1803
        self.request = request
 
1804
 
 
1805
 
 
1806
class NotConflicted(BzrError):
 
1807
 
 
1808
    _fmt = "File %(filename)s is not conflicted."
881
1809
 
882
1810
    def __init__(self, filename):
883
 
        BzrNewError.__init__(self)
 
1811
        BzrError.__init__(self)
884
1812
        self.filename = filename
885
1813
 
886
1814
 
 
1815
class MediumNotConnected(InternalBzrError):
 
1816
 
 
1817
    _fmt = """The medium '%(medium)s' is not connected."""
 
1818
 
 
1819
    def __init__(self, medium):
 
1820
        self.medium = medium
 
1821
 
 
1822
 
887
1823
class MustUseDecorated(Exception):
888
 
    """A decorating function has requested its original command be used.
889
 
    
890
 
    This should never escape bzr, so does not need to be printable.
891
 
    """
892
 
 
893
 
 
894
 
class NoBundleFound(BzrNewError):
895
 
    """No bundle was found in %(filename)s"""
 
1824
 
 
1825
    _fmt = "A decorating function has requested its original command be used."
 
1826
 
 
1827
 
 
1828
class NoBundleFound(BzrError):
 
1829
 
 
1830
    _fmt = 'No bundle was found in "%(filename)s".'
 
1831
 
896
1832
    def __init__(self, filename):
897
 
        BzrNewError.__init__(self)
 
1833
        BzrError.__init__(self)
898
1834
        self.filename = filename
899
1835
 
900
1836
 
901
 
class BundleNotSupported(BzrNewError):
902
 
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
1837
class BundleNotSupported(BzrError):
 
1838
 
 
1839
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1840
 
903
1841
    def __init__(self, version, msg):
904
 
        BzrNewError.__init__(self)
 
1842
        BzrError.__init__(self)
905
1843
        self.version = version
906
1844
        self.msg = msg
907
1845
 
908
1846
 
909
 
class MissingText(BzrNewError):
910
 
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
1847
class MissingText(BzrError):
 
1848
 
 
1849
    _fmt = ("Branch %(base)s is missing revision"
 
1850
            " %(text_revision)s of %(file_id)s")
911
1851
 
912
1852
    def __init__(self, branch, text_revision, file_id):
913
 
        BzrNewError.__init__(self)
 
1853
        BzrError.__init__(self)
914
1854
        self.branch = branch
915
1855
        self.base = branch.base
916
1856
        self.text_revision = text_revision
917
1857
        self.file_id = file_id
918
1858
 
919
1859
 
920
 
class DuplicateKey(BzrNewError):
921
 
    """Key %(key)s is already present in map"""
922
 
 
923
 
 
924
 
class MalformedTransform(BzrNewError):
925
 
    """Tree transform is malformed %(conflicts)r"""
926
 
 
927
 
 
928
 
class BzrBadParameter(BzrNewError):
929
 
    """A bad parameter : %(param)s is not usable.
930
 
    
931
 
    This exception should never be thrown, but it is a base class for all
932
 
    parameter-to-function errors.
933
 
    """
 
1860
class DuplicateFileId(BzrError):
 
1861
 
 
1862
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1863
 
 
1864
    def __init__(self, file_id, entry):
 
1865
        BzrError.__init__(self)
 
1866
        self.file_id = file_id
 
1867
        self.entry = entry
 
1868
 
 
1869
 
 
1870
class DuplicateKey(BzrError):
 
1871
 
 
1872
    _fmt = "Key %(key)s is already present in map"
 
1873
 
 
1874
 
 
1875
class DuplicateHelpPrefix(BzrError):
 
1876
 
 
1877
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1878
 
 
1879
    def __init__(self, prefix):
 
1880
        self.prefix = prefix
 
1881
 
 
1882
 
 
1883
class MalformedTransform(BzrError):
 
1884
 
 
1885
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1886
 
 
1887
 
 
1888
class NoFinalPath(BzrError):
 
1889
 
 
1890
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1891
            "file-id: %(file_id)r\n"
 
1892
            "root trans-id: %(root_trans_id)r\n")
 
1893
 
 
1894
    def __init__(self, trans_id, transform):
 
1895
        self.trans_id = trans_id
 
1896
        self.file_id = transform.final_file_id(trans_id)
 
1897
        self.root_trans_id = transform.root
 
1898
 
 
1899
 
 
1900
class BzrBadParameter(InternalBzrError):
 
1901
 
 
1902
    _fmt = "Bad parameter: %(param)r"
 
1903
 
 
1904
    # This exception should never be thrown, but it is a base class for all
 
1905
    # parameter-to-function errors.
 
1906
 
934
1907
    def __init__(self, param):
935
 
        BzrNewError.__init__(self)
 
1908
        BzrError.__init__(self)
936
1909
        self.param = param
937
1910
 
938
1911
 
939
1912
class BzrBadParameterNotUnicode(BzrBadParameter):
940
 
    """Parameter %(param)s is neither unicode nor utf8."""
941
 
 
942
 
 
943
 
class ReusingTransform(BzrNewError):
944
 
    """Attempt to reuse a transform that has already been applied."""
945
 
 
946
 
 
947
 
class CantMoveRoot(BzrNewError):
948
 
    """Moving the root directory is not supported at this time"""
 
1913
 
 
1914
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1915
 
 
1916
 
 
1917
class ReusingTransform(BzrError):
 
1918
 
 
1919
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1920
 
 
1921
 
 
1922
class CantMoveRoot(BzrError):
 
1923
 
 
1924
    _fmt = "Moving the root directory is not supported at this time"
 
1925
 
 
1926
 
 
1927
class BzrMoveFailedError(BzrError):
 
1928
 
 
1929
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1930
 
 
1931
    def __init__(self, from_path='', to_path='', extra=None):
 
1932
        from bzrlib.osutils import splitpath
 
1933
        BzrError.__init__(self)
 
1934
        if extra:
 
1935
            self.extra = ': ' + str(extra)
 
1936
        else:
 
1937
            self.extra = ''
 
1938
 
 
1939
        has_from = len(from_path) > 0
 
1940
        has_to = len(to_path) > 0
 
1941
        if has_from:
 
1942
            self.from_path = splitpath(from_path)[-1]
 
1943
        else:
 
1944
            self.from_path = ''
 
1945
 
 
1946
        if has_to:
 
1947
            self.to_path = splitpath(to_path)[-1]
 
1948
        else:
 
1949
            self.to_path = ''
 
1950
 
 
1951
        self.operator = ""
 
1952
        if has_from and has_to:
 
1953
            self.operator = " =>"
 
1954
        elif has_from:
 
1955
            self.from_path = "from " + from_path
 
1956
        elif has_to:
 
1957
            self.operator = "to"
 
1958
        else:
 
1959
            self.operator = "file"
 
1960
 
 
1961
 
 
1962
class BzrRenameFailedError(BzrMoveFailedError):
 
1963
 
 
1964
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1965
 
 
1966
    def __init__(self, from_path, to_path, extra=None):
 
1967
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1968
 
 
1969
class BzrRemoveChangedFilesError(BzrError):
 
1970
    """Used when user is trying to remove changed files."""
 
1971
 
 
1972
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1973
        "%(changes_as_text)s"
 
1974
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1975
 
 
1976
    def __init__(self, tree_delta):
 
1977
        BzrError.__init__(self)
 
1978
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1979
        #self.paths_as_string = '\n'.join(changed_files)
 
1980
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
949
1981
 
950
1982
 
951
1983
class BzrBadParameterNotString(BzrBadParameter):
952
 
    """Parameter %(param)s is not a string or unicode string."""
 
1984
 
 
1985
    _fmt = "Parameter %(param)s is not a string or unicode string."
953
1986
 
954
1987
 
955
1988
class BzrBadParameterMissing(BzrBadParameter):
956
 
    """Parameter $(param)s is required but not present."""
 
1989
 
 
1990
    _fmt = "Parameter $(param)s is required but not present."
957
1991
 
958
1992
 
959
1993
class BzrBadParameterUnicode(BzrBadParameter):
960
 
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
1994
 
 
1995
    _fmt = ("Parameter %(param)s is unicode but"
 
1996
            " only byte-strings are permitted.")
961
1997
 
962
1998
 
963
1999
class BzrBadParameterContainsNewline(BzrBadParameter):
964
 
    """Parameter %(param)s contains a newline."""
965
 
 
966
 
 
967
 
class DependencyNotPresent(BzrNewError):
968
 
    """Unable to import library "%(library)s": %(error)s"""
 
2000
 
 
2001
    _fmt = "Parameter %(param)s contains a newline."
 
2002
 
 
2003
 
 
2004
class DependencyNotPresent(BzrError):
 
2005
 
 
2006
    _fmt = 'Unable to import library "%(library)s": %(error)s'
969
2007
 
970
2008
    def __init__(self, library, error):
971
 
        BzrNewError.__init__(self, library=library, error=error)
 
2009
        BzrError.__init__(self, library=library, error=error)
972
2010
 
973
2011
 
974
2012
class ParamikoNotPresent(DependencyNotPresent):
975
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
2013
 
 
2014
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
976
2015
 
977
2016
    def __init__(self, error):
978
2017
        DependencyNotPresent.__init__(self, 'paramiko', error)
979
2018
 
980
2019
 
981
 
class PointlessMerge(BzrNewError):
982
 
    """Nothing to merge."""
983
 
 
984
 
 
985
 
class UninitializableFormat(BzrNewError):
986
 
    """Format %(format)s cannot be initialised by this version of bzr."""
 
2020
class PointlessMerge(BzrError):
 
2021
 
 
2022
    _fmt = "Nothing to merge."
 
2023
 
 
2024
 
 
2025
class UninitializableFormat(BzrError):
 
2026
 
 
2027
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
987
2028
 
988
2029
    def __init__(self, format):
989
 
        BzrNewError.__init__(self)
 
2030
        BzrError.__init__(self)
990
2031
        self.format = format
991
2032
 
992
2033
 
993
 
class BadConversionTarget(BzrNewError):
994
 
    """Cannot convert to format %(format)s.  %(problem)s"""
995
 
 
996
 
    def __init__(self, problem, format):
997
 
        BzrNewError.__init__(self)
 
2034
class BadConversionTarget(BzrError):
 
2035
 
 
2036
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2037
            "    %(problem)s"
 
2038
 
 
2039
    def __init__(self, problem, format, from_format=None):
 
2040
        BzrError.__init__(self)
998
2041
        self.problem = problem
999
2042
        self.format = format
1000
 
 
1001
 
 
1002
 
class NoDiff(BzrNewError):
1003
 
    """Diff is not installed on this machine: %(msg)s"""
 
2043
        self.from_format = from_format or '(unspecified)'
 
2044
 
 
2045
 
 
2046
class NoDiffFound(BzrError):
 
2047
 
 
2048
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2049
 
 
2050
    def __init__(self, path):
 
2051
        BzrError.__init__(self, path)
 
2052
 
 
2053
 
 
2054
class ExecutableMissing(BzrError):
 
2055
 
 
2056
    _fmt = "%(exe_name)s could not be found on this machine"
 
2057
 
 
2058
    def __init__(self, exe_name):
 
2059
        BzrError.__init__(self, exe_name=exe_name)
 
2060
 
 
2061
 
 
2062
class NoDiff(BzrError):
 
2063
 
 
2064
    _fmt = "Diff is not installed on this machine: %(msg)s"
1004
2065
 
1005
2066
    def __init__(self, msg):
1006
 
        BzrNewError.__init__(self, msg=msg)
1007
 
 
1008
 
 
1009
 
class NoDiff3(BzrNewError):
1010
 
    """Diff3 is not installed on this machine."""
1011
 
 
1012
 
 
1013
 
class ExistingLimbo(BzrNewError):
1014
 
    """This tree contains left-over files from a failed operation.
1015
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1016
 
    keep, and delete it when you are done.
1017
 
    """
1018
 
    def __init__(self, limbo_dir):
1019
 
       BzrNewError.__init__(self)
1020
 
       self.limbo_dir = limbo_dir
1021
 
 
1022
 
 
1023
 
class ImmortalLimbo(BzrNewError):
1024
 
    """Unable to delete transform temporary directory $(limbo_dir)s.
1025
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1026
 
    keep, and delete it when you are done.
1027
 
    """
1028
 
    def __init__(self, limbo_dir):
1029
 
       BzrNewError.__init__(self)
1030
 
       self.limbo_dir = limbo_dir
1031
 
 
1032
 
 
1033
 
class OutOfDateTree(BzrNewError):
1034
 
    """Working tree is out of date, please run 'bzr update'."""
1035
 
 
1036
 
    def __init__(self, tree):
1037
 
        BzrNewError.__init__(self)
 
2067
        BzrError.__init__(self, msg=msg)
 
2068
 
 
2069
 
 
2070
class NoDiff3(BzrError):
 
2071
 
 
2072
    _fmt = "Diff3 is not installed on this machine."
 
2073
 
 
2074
 
 
2075
class ExistingContent(BzrError):
 
2076
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2077
 
 
2078
    _fmt = "The content being inserted is already present."
 
2079
 
 
2080
 
 
2081
class ExistingLimbo(BzrError):
 
2082
 
 
2083
    _fmt = """This tree contains left-over files from a failed operation.
 
2084
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2085
    keep, and delete it when you are done."""
 
2086
 
 
2087
    def __init__(self, limbo_dir):
 
2088
       BzrError.__init__(self)
 
2089
       self.limbo_dir = limbo_dir
 
2090
 
 
2091
 
 
2092
class ExistingPendingDeletion(BzrError):
 
2093
 
 
2094
    _fmt = """This tree contains left-over files from a failed operation.
 
2095
    Please examine %(pending_deletion)s to see if it contains any files you
 
2096
    wish to keep, and delete it when you are done."""
 
2097
 
 
2098
    def __init__(self, pending_deletion):
 
2099
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2100
 
 
2101
 
 
2102
class ImmortalLimbo(BzrError):
 
2103
 
 
2104
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2105
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2106
    keep, and delete it when you are done."""
 
2107
 
 
2108
    def __init__(self, limbo_dir):
 
2109
       BzrError.__init__(self)
 
2110
       self.limbo_dir = limbo_dir
 
2111
 
 
2112
 
 
2113
class ImmortalPendingDeletion(BzrError):
 
2114
 
 
2115
    _fmt = ("Unable to delete transform temporary directory "
 
2116
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2117
    "contains any files you wish to keep, and delete it when you are done.")
 
2118
 
 
2119
    def __init__(self, pending_deletion):
 
2120
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2121
 
 
2122
 
 
2123
class OutOfDateTree(BzrError):
 
2124
 
 
2125
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2126
 
 
2127
    def __init__(self, tree, more=None):
 
2128
        if more is None:
 
2129
            more = ''
 
2130
        else:
 
2131
            more = ' ' + more
 
2132
        BzrError.__init__(self)
1038
2133
        self.tree = tree
1039
 
 
1040
 
 
1041
 
class MergeModifiedFormatError(BzrNewError):
1042
 
    """Error in merge modified format"""
1043
 
 
1044
 
 
1045
 
class ConflictFormatError(BzrNewError):
1046
 
    """Format error in conflict listings"""
1047
 
 
1048
 
 
1049
 
class CorruptRepository(BzrNewError):
1050
 
    """An error has been detected in the repository %(repo_path)s.
1051
 
Please run bzr reconcile on this repository."""
 
2134
        self.more = more
 
2135
 
 
2136
 
 
2137
class PublicBranchOutOfDate(BzrError):
 
2138
 
 
2139
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2140
        '"%(revstring)s".'
 
2141
 
 
2142
    def __init__(self, public_location, revstring):
 
2143
        import bzrlib.urlutils as urlutils
 
2144
        public_location = urlutils.unescape_for_display(public_location,
 
2145
                                                        'ascii')
 
2146
        BzrError.__init__(self, public_location=public_location,
 
2147
                          revstring=revstring)
 
2148
 
 
2149
 
 
2150
class MergeModifiedFormatError(BzrError):
 
2151
 
 
2152
    _fmt = "Error in merge modified format"
 
2153
 
 
2154
 
 
2155
class ConflictFormatError(BzrError):
 
2156
 
 
2157
    _fmt = "Format error in conflict listings"
 
2158
 
 
2159
 
 
2160
class CorruptDirstate(BzrError):
 
2161
 
 
2162
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2163
            "Error: %(description)s")
 
2164
 
 
2165
    def __init__(self, dirstate_path, description):
 
2166
        BzrError.__init__(self)
 
2167
        self.dirstate_path = dirstate_path
 
2168
        self.description = description
 
2169
 
 
2170
 
 
2171
class CorruptRepository(BzrError):
 
2172
 
 
2173
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2174
            "Please run bzr reconcile on this repository.")
1052
2175
 
1053
2176
    def __init__(self, repo):
1054
 
        BzrNewError.__init__(self)
 
2177
        BzrError.__init__(self)
1055
2178
        self.repo_path = repo.bzrdir.root_transport.base
1056
2179
 
1057
2180
 
1058
 
class UpgradeRequired(BzrNewError):
1059
 
    """To use this feature you must upgrade your branch at %(path)s."""
 
2181
class InconsistentDelta(BzrError):
 
2182
    """Used when we get a delta that is not valid."""
 
2183
 
 
2184
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2185
            " %(file_id)r\nreason: %(reason)s")
 
2186
 
 
2187
    def __init__(self, path, file_id, reason):
 
2188
        BzrError.__init__(self)
 
2189
        self.path = path
 
2190
        self.file_id = file_id
 
2191
        self.reason = reason
 
2192
 
 
2193
 
 
2194
class InconsistentDeltaDelta(InconsistentDelta):
 
2195
    """Used when we get a delta that is not valid."""
 
2196
 
 
2197
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2198
            "\nreason: %(reason)s")
 
2199
 
 
2200
    def __init__(self, delta, reason):
 
2201
        BzrError.__init__(self)
 
2202
        self.delta = delta
 
2203
        self.reason = reason
 
2204
 
 
2205
 
 
2206
class UpgradeRequired(BzrError):
 
2207
 
 
2208
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
1060
2209
 
1061
2210
    def __init__(self, path):
1062
 
        BzrNewError.__init__(self)
 
2211
        BzrError.__init__(self)
1063
2212
        self.path = path
1064
2213
 
1065
2214
 
1066
 
class LocalRequiresBoundBranch(BzrNewError):
1067
 
    """Cannot perform local-only commits on unbound branches."""
1068
 
 
1069
 
 
1070
 
class MissingProgressBarFinish(BzrNewError):
1071
 
    """A nested progress bar was not 'finished' correctly."""
1072
 
 
1073
 
 
1074
 
class InvalidProgressBarType(BzrNewError):
1075
 
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1076
 
Select one of: %(valid_types)s"""
1077
 
 
1078
 
    def __init__(self, bar_type, valid_types):
1079
 
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1080
 
 
1081
 
 
1082
 
class UnsupportedOperation(BzrNewError):
1083
 
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
2215
class RepositoryUpgradeRequired(UpgradeRequired):
 
2216
 
 
2217
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2218
 
 
2219
 
 
2220
class RichRootUpgradeRequired(UpgradeRequired):
 
2221
 
 
2222
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2223
           " a format which supports rich roots.")
 
2224
 
 
2225
 
 
2226
class LocalRequiresBoundBranch(BzrError):
 
2227
 
 
2228
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2229
 
 
2230
 
 
2231
class UnsupportedOperation(BzrError):
 
2232
 
 
2233
    _fmt = ("The method %(mname)s is not supported on"
 
2234
            " objects of type %(tname)s.")
 
2235
 
1084
2236
    def __init__(self, method, method_self):
1085
2237
        self.method = method
1086
2238
        self.mname = method.__name__
1087
2239
        self.tname = type(method_self).__name__
1088
2240
 
1089
2241
 
1090
 
class BinaryFile(BzrNewError):
1091
 
    """File is binary but should be text."""
1092
 
 
1093
 
 
1094
 
class IllegalPath(BzrNewError):
1095
 
    """The path %(path)s is not permitted on this platform"""
 
2242
class CannotSetRevisionId(UnsupportedOperation):
 
2243
    """Raised when a commit is attempting to set a revision id but cant."""
 
2244
 
 
2245
 
 
2246
class NonAsciiRevisionId(UnsupportedOperation):
 
2247
    """Raised when a commit is attempting to set a non-ascii revision id
 
2248
       but cant.
 
2249
    """
 
2250
 
 
2251
 
 
2252
class BinaryFile(BzrError):
 
2253
 
 
2254
    _fmt = "File is binary but should be text."
 
2255
 
 
2256
 
 
2257
class IllegalPath(BzrError):
 
2258
 
 
2259
    _fmt = "The path %(path)s is not permitted on this platform"
1096
2260
 
1097
2261
    def __init__(self, path):
1098
 
        BzrNewError.__init__(self)
 
2262
        BzrError.__init__(self)
1099
2263
        self.path = path
1100
2264
 
1101
2265
 
1102
 
class TestamentMismatch(BzrNewError):
1103
 
    """Testament did not match expected value.  
1104
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
1105
 
       {%(measured)s}
1106
 
    """
 
2266
class TestamentMismatch(BzrError):
 
2267
 
 
2268
    _fmt = """Testament did not match expected value.
 
2269
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2270
       {%(measured)s}"""
 
2271
 
1107
2272
    def __init__(self, revision_id, expected, measured):
1108
2273
        self.revision_id = revision_id
1109
2274
        self.expected = expected
1110
2275
        self.measured = measured
1111
2276
 
1112
2277
 
1113
 
class NotABundle(BzrNewError):
1114
 
    """Not a bzr revision-bundle: %(text)r"""
1115
 
 
1116
 
    def __init__(self, text):
1117
 
        BzrNewError.__init__(self)
1118
 
        self.text = text
1119
 
 
1120
 
 
1121
 
class BadBundle(BzrNewError): 
1122
 
    """Bad bzr revision-bundle: %(text)r"""
1123
 
 
1124
 
    def __init__(self, text):
1125
 
        BzrNewError.__init__(self)
1126
 
        self.text = text
1127
 
 
1128
 
 
1129
 
class MalformedHeader(BadBundle): 
1130
 
    """Malformed bzr revision-bundle header: %(text)r"""
1131
 
 
1132
 
    def __init__(self, text):
1133
 
        BzrNewError.__init__(self)
1134
 
        self.text = text
1135
 
 
1136
 
 
1137
 
class MalformedPatches(BadBundle): 
1138
 
    """Malformed patches in bzr revision-bundle: %(text)r"""
1139
 
 
1140
 
    def __init__(self, text):
1141
 
        BzrNewError.__init__(self)
1142
 
        self.text = text
1143
 
 
1144
 
 
1145
 
class MalformedFooter(BadBundle): 
1146
 
    """Malformed footer in bzr revision-bundle: %(text)r"""
1147
 
 
1148
 
    def __init__(self, text):
1149
 
        BzrNewError.__init__(self)
1150
 
        self.text = text
 
2278
class NotABundle(BzrError):
 
2279
 
 
2280
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2281
 
 
2282
    def __init__(self, text):
 
2283
        BzrError.__init__(self)
 
2284
        self.text = text
 
2285
 
 
2286
 
 
2287
class BadBundle(BzrError):
 
2288
 
 
2289
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2290
 
 
2291
    def __init__(self, text):
 
2292
        BzrError.__init__(self)
 
2293
        self.text = text
 
2294
 
 
2295
 
 
2296
class MalformedHeader(BadBundle):
 
2297
 
 
2298
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2299
 
 
2300
 
 
2301
class MalformedPatches(BadBundle):
 
2302
 
 
2303
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2304
 
 
2305
 
 
2306
class MalformedFooter(BadBundle):
 
2307
 
 
2308
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1151
2309
 
1152
2310
 
1153
2311
class UnsupportedEOLMarker(BadBundle):
1154
 
    """End of line marker was not \\n in bzr revision-bundle"""    
 
2312
 
 
2313
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
1155
2314
 
1156
2315
    def __init__(self):
1157
 
        BzrNewError.__init__(self)
1158
 
 
1159
 
 
1160
 
class BadInventoryFormat(BzrNewError):
1161
 
    """Root class for inventory serialization errors"""
 
2316
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2317
        # but for this there is not
 
2318
        BzrError.__init__(self)
 
2319
 
 
2320
 
 
2321
class IncompatibleBundleFormat(BzrError):
 
2322
 
 
2323
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2324
 
 
2325
    def __init__(self, bundle_format, other):
 
2326
        BzrError.__init__(self)
 
2327
        self.bundle_format = bundle_format
 
2328
        self.other = other
 
2329
 
 
2330
 
 
2331
class BadInventoryFormat(BzrError):
 
2332
 
 
2333
    _fmt = "Root class for inventory serialization errors"
1162
2334
 
1163
2335
 
1164
2336
class UnexpectedInventoryFormat(BadInventoryFormat):
1165
 
    """The inventory was not in the expected format:\n %(msg)s"""
 
2337
 
 
2338
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
1166
2339
 
1167
2340
    def __init__(self, msg):
1168
2341
        BadInventoryFormat.__init__(self, msg=msg)
1169
2342
 
1170
2343
 
1171
 
class UnknownSSH(BzrNewError):
1172
 
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
 
2344
class RootNotRich(BzrError):
 
2345
 
 
2346
    _fmt = """This operation requires rich root data storage"""
 
2347
 
 
2348
 
 
2349
class NoSmartMedium(InternalBzrError):
 
2350
 
 
2351
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2352
 
 
2353
    def __init__(self, transport):
 
2354
        self.transport = transport
 
2355
 
 
2356
 
 
2357
class UnknownSSH(BzrError):
 
2358
 
 
2359
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1173
2360
 
1174
2361
    def __init__(self, vendor):
1175
 
        BzrNewError.__init__(self)
 
2362
        BzrError.__init__(self)
1176
2363
        self.vendor = vendor
1177
2364
 
1178
2365
 
1179
 
class GhostRevisionUnusableHere(BzrNewError):
1180
 
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
2366
class SSHVendorNotFound(BzrError):
 
2367
 
 
2368
    _fmt = ("Don't know how to handle SSH connections."
 
2369
            " Please set BZR_SSH environment variable.")
 
2370
 
 
2371
 
 
2372
class GhostRevisionsHaveNoRevno(BzrError):
 
2373
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2374
 
 
2375
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2376
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2377
 
 
2378
    def __init__(self, revision_id, ghost_revision_id):
 
2379
        self.revision_id = revision_id
 
2380
        self.ghost_revision_id = ghost_revision_id
 
2381
 
 
2382
 
 
2383
class GhostRevisionUnusableHere(BzrError):
 
2384
 
 
2385
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1181
2386
 
1182
2387
    def __init__(self, revision_id):
1183
 
        BzrNewError.__init__(self)
 
2388
        BzrError.__init__(self)
1184
2389
        self.revision_id = revision_id
 
2390
 
 
2391
 
 
2392
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2393
 
 
2394
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2395
            " %(msg)s%(extra)s")
 
2396
 
 
2397
    def __init__(self, name, msg, extra=None):
 
2398
        BzrError.__init__(self)
 
2399
        self.name = name
 
2400
        self.msg = msg
 
2401
        if extra:
 
2402
            self.extra = ': ' + str(extra)
 
2403
        else:
 
2404
            self.extra = ''
 
2405
 
 
2406
 
 
2407
class InvalidImportLine(InternalBzrError):
 
2408
 
 
2409
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2410
 
 
2411
    def __init__(self, text, msg):
 
2412
        BzrError.__init__(self)
 
2413
        self.text = text
 
2414
        self.msg = msg
 
2415
 
 
2416
 
 
2417
class ImportNameCollision(InternalBzrError):
 
2418
 
 
2419
    _fmt = ("Tried to import an object to the same name as"
 
2420
            " an existing object. %(name)s")
 
2421
 
 
2422
    def __init__(self, name):
 
2423
        BzrError.__init__(self)
 
2424
        self.name = name
 
2425
 
 
2426
 
 
2427
class NotAMergeDirective(BzrError):
 
2428
    """File starting with %(firstline)r is not a merge directive"""
 
2429
    def __init__(self, firstline):
 
2430
        BzrError.__init__(self, firstline=firstline)
 
2431
 
 
2432
 
 
2433
class NoMergeSource(BzrError):
 
2434
    """Raise if no merge source was specified for a merge directive"""
 
2435
 
 
2436
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2437
        " branch location."
 
2438
 
 
2439
 
 
2440
class IllegalMergeDirectivePayload(BzrError):
 
2441
    """A merge directive contained something other than a patch or bundle"""
 
2442
 
 
2443
    _fmt = "Bad merge directive payload %(start)r"
 
2444
 
 
2445
    def __init__(self, start):
 
2446
        BzrError(self)
 
2447
        self.start = start
 
2448
 
 
2449
 
 
2450
class PatchVerificationFailed(BzrError):
 
2451
    """A patch from a merge directive could not be verified"""
 
2452
 
 
2453
    _fmt = "Preview patch does not match requested changes."
 
2454
 
 
2455
 
 
2456
class PatchMissing(BzrError):
 
2457
    """Raise a patch type was specified but no patch supplied"""
 
2458
 
 
2459
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2460
 
 
2461
    def __init__(self, patch_type):
 
2462
        BzrError.__init__(self)
 
2463
        self.patch_type = patch_type
 
2464
 
 
2465
 
 
2466
class TargetNotBranch(BzrError):
 
2467
    """A merge directive's target branch is required, but isn't a branch"""
 
2468
 
 
2469
    _fmt = ("Your branch does not have all of the revisions required in "
 
2470
            "order to merge this merge directive and the target "
 
2471
            "location specified in the merge directive is not a branch: "
 
2472
            "%(location)s.")
 
2473
 
 
2474
    def __init__(self, location):
 
2475
        BzrError.__init__(self)
 
2476
        self.location = location
 
2477
 
 
2478
 
 
2479
class UnsupportedInventoryKind(BzrError):
 
2480
 
 
2481
    _fmt = """Unsupported entry kind %(kind)s"""
 
2482
 
 
2483
    def __init__(self, kind):
 
2484
        self.kind = kind
 
2485
 
 
2486
 
 
2487
class BadSubsumeSource(BzrError):
 
2488
 
 
2489
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2490
 
 
2491
    def __init__(self, tree, other_tree, reason):
 
2492
        self.tree = tree
 
2493
        self.other_tree = other_tree
 
2494
        self.reason = reason
 
2495
 
 
2496
 
 
2497
class SubsumeTargetNeedsUpgrade(BzrError):
 
2498
 
 
2499
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2500
 
 
2501
    def __init__(self, other_tree):
 
2502
        self.other_tree = other_tree
 
2503
 
 
2504
 
 
2505
class BadReferenceTarget(InternalBzrError):
 
2506
 
 
2507
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2508
           "%(reason)s"
 
2509
 
 
2510
    def __init__(self, tree, other_tree, reason):
 
2511
        self.tree = tree
 
2512
        self.other_tree = other_tree
 
2513
        self.reason = reason
 
2514
 
 
2515
 
 
2516
class NoSuchTag(BzrError):
 
2517
 
 
2518
    _fmt = "No such tag: %(tag_name)s"
 
2519
 
 
2520
    def __init__(self, tag_name):
 
2521
        self.tag_name = tag_name
 
2522
 
 
2523
 
 
2524
class TagsNotSupported(BzrError):
 
2525
 
 
2526
    _fmt = ("Tags not supported by %(branch)s;"
 
2527
            " you may be able to use bzr upgrade.")
 
2528
 
 
2529
    def __init__(self, branch):
 
2530
        self.branch = branch
 
2531
 
 
2532
 
 
2533
class TagAlreadyExists(BzrError):
 
2534
 
 
2535
    _fmt = "Tag %(tag_name)s already exists."
 
2536
 
 
2537
    def __init__(self, tag_name):
 
2538
        self.tag_name = tag_name
 
2539
 
 
2540
 
 
2541
class MalformedBugIdentifier(BzrError):
 
2542
 
 
2543
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2544
            'See "bzr help bugs" for more information on this feature.')
 
2545
 
 
2546
    def __init__(self, bug_id, reason):
 
2547
        self.bug_id = bug_id
 
2548
        self.reason = reason
 
2549
 
 
2550
 
 
2551
class InvalidBugTrackerURL(BzrError):
 
2552
 
 
2553
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2554
            "contain {id}: %(url)s")
 
2555
 
 
2556
    def __init__(self, abbreviation, url):
 
2557
        self.abbreviation = abbreviation
 
2558
        self.url = url
 
2559
 
 
2560
 
 
2561
class UnknownBugTrackerAbbreviation(BzrError):
 
2562
 
 
2563
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2564
            "on %(branch)s")
 
2565
 
 
2566
    def __init__(self, abbreviation, branch):
 
2567
        self.abbreviation = abbreviation
 
2568
        self.branch = branch
 
2569
 
 
2570
 
 
2571
class InvalidLineInBugsProperty(BzrError):
 
2572
 
 
2573
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2574
 
 
2575
    def __init__(self, line):
 
2576
        self.line = line
 
2577
 
 
2578
 
 
2579
class InvalidBugStatus(BzrError):
 
2580
 
 
2581
    _fmt = ("Invalid bug status: '%(status)s'")
 
2582
 
 
2583
    def __init__(self, status):
 
2584
        self.status = status
 
2585
 
 
2586
 
 
2587
class UnexpectedSmartServerResponse(BzrError):
 
2588
 
 
2589
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2590
 
 
2591
    def __init__(self, response_tuple):
 
2592
        self.response_tuple = response_tuple
 
2593
 
 
2594
 
 
2595
class ErrorFromSmartServer(BzrError):
 
2596
    """An error was received from a smart server.
 
2597
 
 
2598
    :seealso: UnknownErrorFromSmartServer
 
2599
    """
 
2600
 
 
2601
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2602
 
 
2603
    internal_error = True
 
2604
 
 
2605
    def __init__(self, error_tuple):
 
2606
        self.error_tuple = error_tuple
 
2607
        try:
 
2608
            self.error_verb = error_tuple[0]
 
2609
        except IndexError:
 
2610
            self.error_verb = None
 
2611
        self.error_args = error_tuple[1:]
 
2612
 
 
2613
 
 
2614
class UnknownErrorFromSmartServer(BzrError):
 
2615
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2616
    error.
 
2617
 
 
2618
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2619
    distinguish between the following two cases:
 
2620
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2621
        and so should provoke a traceback to the user.
 
2622
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2623
        translated.  This is probably because the server sent us garbage, and
 
2624
        should not provoke a traceback.
 
2625
    """
 
2626
 
 
2627
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2628
 
 
2629
    internal_error = False
 
2630
 
 
2631
    def __init__(self, error_from_smart_server):
 
2632
        """Constructor.
 
2633
 
 
2634
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2635
        """
 
2636
        self.error_from_smart_server = error_from_smart_server
 
2637
        self.error_tuple = error_from_smart_server.error_tuple
 
2638
 
 
2639
 
 
2640
class ContainerError(BzrError):
 
2641
    """Base class of container errors."""
 
2642
 
 
2643
 
 
2644
class UnknownContainerFormatError(ContainerError):
 
2645
 
 
2646
    _fmt = "Unrecognised container format: %(container_format)r"
 
2647
 
 
2648
    def __init__(self, container_format):
 
2649
        self.container_format = container_format
 
2650
 
 
2651
 
 
2652
class UnexpectedEndOfContainerError(ContainerError):
 
2653
 
 
2654
    _fmt = "Unexpected end of container stream"
 
2655
 
 
2656
 
 
2657
class UnknownRecordTypeError(ContainerError):
 
2658
 
 
2659
    _fmt = "Unknown record type: %(record_type)r"
 
2660
 
 
2661
    def __init__(self, record_type):
 
2662
        self.record_type = record_type
 
2663
 
 
2664
 
 
2665
class InvalidRecordError(ContainerError):
 
2666
 
 
2667
    _fmt = "Invalid record: %(reason)s"
 
2668
 
 
2669
    def __init__(self, reason):
 
2670
        self.reason = reason
 
2671
 
 
2672
 
 
2673
class ContainerHasExcessDataError(ContainerError):
 
2674
 
 
2675
    _fmt = "Container has data after end marker: %(excess)r"
 
2676
 
 
2677
    def __init__(self, excess):
 
2678
        self.excess = excess
 
2679
 
 
2680
 
 
2681
class DuplicateRecordNameError(ContainerError):
 
2682
 
 
2683
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2684
 
 
2685
    def __init__(self, name):
 
2686
        self.name = name
 
2687
 
 
2688
 
 
2689
class NoDestinationAddress(InternalBzrError):
 
2690
 
 
2691
    _fmt = "Message does not have a destination address."
 
2692
 
 
2693
 
 
2694
class RepositoryDataStreamError(BzrError):
 
2695
 
 
2696
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2697
 
 
2698
    def __init__(self, reason):
 
2699
        self.reason = reason
 
2700
 
 
2701
 
 
2702
class SMTPError(BzrError):
 
2703
 
 
2704
    _fmt = "SMTP error: %(error)s"
 
2705
 
 
2706
    def __init__(self, error):
 
2707
        self.error = error
 
2708
 
 
2709
 
 
2710
class NoMessageSupplied(BzrError):
 
2711
 
 
2712
    _fmt = "No message supplied."
 
2713
 
 
2714
 
 
2715
class NoMailAddressSpecified(BzrError):
 
2716
 
 
2717
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2718
 
 
2719
 
 
2720
class UnknownMailClient(BzrError):
 
2721
 
 
2722
    _fmt = "Unknown mail client: %(mail_client)s"
 
2723
 
 
2724
    def __init__(self, mail_client):
 
2725
        BzrError.__init__(self, mail_client=mail_client)
 
2726
 
 
2727
 
 
2728
class MailClientNotFound(BzrError):
 
2729
 
 
2730
    _fmt = "Unable to find mail client with the following names:"\
 
2731
        " %(mail_command_list_string)s"
 
2732
 
 
2733
    def __init__(self, mail_command_list):
 
2734
        mail_command_list_string = ', '.join(mail_command_list)
 
2735
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2736
                          mail_command_list_string=mail_command_list_string)
 
2737
 
 
2738
class SMTPConnectionRefused(SMTPError):
 
2739
 
 
2740
    _fmt = "SMTP connection to %(host)s refused"
 
2741
 
 
2742
    def __init__(self, error, host):
 
2743
        self.error = error
 
2744
        self.host = host
 
2745
 
 
2746
 
 
2747
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2748
 
 
2749
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2750
 
 
2751
 
 
2752
class BzrDirError(BzrError):
 
2753
 
 
2754
    def __init__(self, bzrdir):
 
2755
        import bzrlib.urlutils as urlutils
 
2756
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
                                                    'ascii')
 
2758
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2759
 
 
2760
 
 
2761
class UnsyncedBranches(BzrDirError):
 
2762
 
 
2763
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2764
            " bzr help sync-for-reconfigure.")
 
2765
 
 
2766
    def __init__(self, bzrdir, target_branch):
 
2767
        BzrDirError.__init__(self, bzrdir)
 
2768
        import bzrlib.urlutils as urlutils
 
2769
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2770
                                                        'ascii')
 
2771
 
 
2772
 
 
2773
class AlreadyBranch(BzrDirError):
 
2774
 
 
2775
    _fmt = "'%(display_url)s' is already a branch."
 
2776
 
 
2777
 
 
2778
class AlreadyTree(BzrDirError):
 
2779
 
 
2780
    _fmt = "'%(display_url)s' is already a tree."
 
2781
 
 
2782
 
 
2783
class AlreadyCheckout(BzrDirError):
 
2784
 
 
2785
    _fmt = "'%(display_url)s' is already a checkout."
 
2786
 
 
2787
 
 
2788
class AlreadyLightweightCheckout(BzrDirError):
 
2789
 
 
2790
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2791
 
 
2792
 
 
2793
class AlreadyUsingShared(BzrDirError):
 
2794
 
 
2795
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2796
 
 
2797
 
 
2798
class AlreadyStandalone(BzrDirError):
 
2799
 
 
2800
    _fmt = "'%(display_url)s' is already standalone."
 
2801
 
 
2802
 
 
2803
class AlreadyWithTrees(BzrDirError):
 
2804
 
 
2805
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2806
            "working trees.")
 
2807
 
 
2808
 
 
2809
class AlreadyWithNoTrees(BzrDirError):
 
2810
 
 
2811
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2812
            "working trees.")
 
2813
 
 
2814
 
 
2815
class ReconfigurationNotSupported(BzrDirError):
 
2816
 
 
2817
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2818
 
 
2819
 
 
2820
class NoBindLocation(BzrDirError):
 
2821
 
 
2822
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2823
 
 
2824
 
 
2825
class UncommittedChanges(BzrError):
 
2826
 
 
2827
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2828
            ' (See bzr status).%(more)s')
 
2829
 
 
2830
    def __init__(self, tree, more=None):
 
2831
        if more is None:
 
2832
            more = ''
 
2833
        else:
 
2834
            more = ' ' + more
 
2835
        import bzrlib.urlutils as urlutils
 
2836
        display_url = urlutils.unescape_for_display(
 
2837
            tree.bzrdir.root_transport.base, 'ascii')
 
2838
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2839
 
 
2840
 
 
2841
class MissingTemplateVariable(BzrError):
 
2842
 
 
2843
    _fmt = 'Variable {%(name)s} is not available.'
 
2844
 
 
2845
    def __init__(self, name):
 
2846
        self.name = name
 
2847
 
 
2848
 
 
2849
class NoTemplate(BzrError):
 
2850
 
 
2851
    _fmt = 'No template specified.'
 
2852
 
 
2853
 
 
2854
class UnableCreateSymlink(BzrError):
 
2855
 
 
2856
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2857
 
 
2858
    def __init__(self, path=None):
 
2859
        path_str = ''
 
2860
        if path:
 
2861
            try:
 
2862
                path_str = repr(str(path))
 
2863
            except UnicodeEncodeError:
 
2864
                path_str = repr(path)
 
2865
            path_str += ' '
 
2866
        self.path_str = path_str
 
2867
 
 
2868
 
 
2869
class UnsupportedTimezoneFormat(BzrError):
 
2870
 
 
2871
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2872
            'options are "utc", "original", "local".')
 
2873
 
 
2874
    def __init__(self, timezone):
 
2875
        self.timezone = timezone
 
2876
 
 
2877
 
 
2878
class CommandAvailableInPlugin(StandardError):
 
2879
 
 
2880
    internal_error = False
 
2881
 
 
2882
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2883
 
 
2884
        self.plugin_metadata = plugin_metadata
 
2885
        self.cmd_name = cmd_name
 
2886
        self.provider = provider
 
2887
 
 
2888
    def __str__(self):
 
2889
 
 
2890
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2891
                'However, the following official plugin provides this command: %s\n'
 
2892
                'You can install it by going to: %s'
 
2893
                % (self.cmd_name, self.plugin_metadata['name'],
 
2894
                    self.plugin_metadata['url']))
 
2895
 
 
2896
        return _fmt
 
2897
 
 
2898
 
 
2899
class NoPluginAvailable(BzrError):
 
2900
    pass
 
2901
 
 
2902
 
 
2903
class UnableEncodePath(BzrError):
 
2904
 
 
2905
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2906
            'user encoding %(user_encoding)s')
 
2907
 
 
2908
    def __init__(self, path, kind):
 
2909
        from bzrlib.osutils import get_user_encoding
 
2910
        self.path = path
 
2911
        self.kind = kind
 
2912
        self.user_encoding = osutils.get_user_encoding()
 
2913
 
 
2914
 
 
2915
class NoSuchAlias(BzrError):
 
2916
 
 
2917
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2918
 
 
2919
    def __init__(self, alias_name):
 
2920
        BzrError.__init__(self, alias_name=alias_name)
 
2921
 
 
2922
 
 
2923
class DirectoryLookupFailure(BzrError):
 
2924
    """Base type for lookup errors."""
 
2925
 
 
2926
    pass
 
2927
 
 
2928
 
 
2929
class InvalidLocationAlias(DirectoryLookupFailure):
 
2930
 
 
2931
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2932
 
 
2933
    def __init__(self, alias_name):
 
2934
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2935
 
 
2936
 
 
2937
class UnsetLocationAlias(DirectoryLookupFailure):
 
2938
 
 
2939
    _fmt = 'No %(alias_name)s location assigned.'
 
2940
 
 
2941
    def __init__(self, alias_name):
 
2942
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2943
 
 
2944
 
 
2945
class CannotBindAddress(BzrError):
 
2946
 
 
2947
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2948
 
 
2949
    def __init__(self, host, port, orig_error):
 
2950
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2951
        BzrError.__init__(self, host=host, port=port,
 
2952
            orig_error=repr(orig_error.args))
 
2953
 
 
2954
 
 
2955
class UnknownRules(BzrError):
 
2956
 
 
2957
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2958
 
 
2959
    def __init__(self, unknowns):
 
2960
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2961
 
 
2962
 
 
2963
class HookFailed(BzrError):
 
2964
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2965
    than TipChangeRejected.
 
2966
 
 
2967
    Note that this exception is no longer raised, and the import is only left
 
2968
    to be nice to code which might catch it in a plugin.
 
2969
    """
 
2970
 
 
2971
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2972
            "%(traceback_text)s%(exc_value)s")
 
2973
 
 
2974
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2975
        if warn:
 
2976
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2977
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2978
        import traceback
 
2979
        self.hook_stage = hook_stage
 
2980
        self.hook_name = hook_name
 
2981
        self.exc_info = exc_info
 
2982
        self.exc_type = exc_info[0]
 
2983
        self.exc_value = exc_info[1]
 
2984
        self.exc_tb = exc_info[2]
 
2985
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2986
 
 
2987
 
 
2988
class TipChangeRejected(BzrError):
 
2989
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2990
    explicitly abort a change to a branch tip.
 
2991
    """
 
2992
 
 
2993
    _fmt = u"Tip change rejected: %(msg)s"
 
2994
 
 
2995
    def __init__(self, msg):
 
2996
        self.msg = msg
 
2997
 
 
2998
 
 
2999
class ShelfCorrupt(BzrError):
 
3000
 
 
3001
    _fmt = "Shelf corrupt."
 
3002
 
 
3003
 
 
3004
class NoSuchShelfId(BzrError):
 
3005
 
 
3006
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3007
 
 
3008
    def __init__(self, shelf_id):
 
3009
        BzrError.__init__(self, shelf_id=shelf_id)
 
3010
 
 
3011
 
 
3012
class InvalidShelfId(BzrError):
 
3013
 
 
3014
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3015
 
 
3016
    def __init__(self, invalid_id):
 
3017
        BzrError.__init__(self, invalid_id=invalid_id)
 
3018
 
 
3019
 
 
3020
class JailBreak(BzrError):
 
3021
 
 
3022
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3023
 
 
3024
    def __init__(self, url):
 
3025
        BzrError.__init__(self, url=url)
 
3026
 
 
3027
 
 
3028
class UserAbort(BzrError):
 
3029
 
 
3030
    _fmt = 'The user aborted the operation.'
 
3031
 
 
3032
 
 
3033
class MustHaveWorkingTree(BzrError):
 
3034
 
 
3035
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3036
 
 
3037
    def __init__(self, format, url):
 
3038
        BzrError.__init__(self, format=format, url=url)
 
3039
 
 
3040
 
 
3041
class NoSuchView(BzrError):
 
3042
    """A view does not exist.
 
3043
    """
 
3044
 
 
3045
    _fmt = u"No such view: %(view_name)s."
 
3046
 
 
3047
    def __init__(self, view_name):
 
3048
        self.view_name = view_name
 
3049
 
 
3050
 
 
3051
class ViewsNotSupported(BzrError):
 
3052
    """Views are not supported by a tree format.
 
3053
    """
 
3054
 
 
3055
    _fmt = ("Views are not supported by %(tree)s;"
 
3056
            " use 'bzr upgrade' to change your tree to a later format.")
 
3057
 
 
3058
    def __init__(self, tree):
 
3059
        self.tree = tree
 
3060
 
 
3061
 
 
3062
class FileOutsideView(BzrError):
 
3063
 
 
3064
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3065
            '%(view_str)s')
 
3066
 
 
3067
    def __init__(self, file_name, view_files):
 
3068
        self.file_name = file_name
 
3069
        self.view_str = ", ".join(view_files)
 
3070
 
 
3071
 
 
3072
class UnresumableWriteGroup(BzrError):
 
3073
 
 
3074
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3075
            "%(write_groups)r: %(reason)s")
 
3076
 
 
3077
    internal_error = True
 
3078
 
 
3079
    def __init__(self, repository, write_groups, reason):
 
3080
        self.repository = repository
 
3081
        self.write_groups = write_groups
 
3082
        self.reason = reason
 
3083
 
 
3084
 
 
3085
class UnsuspendableWriteGroup(BzrError):
 
3086
 
 
3087
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3088
 
 
3089
    internal_error = True
 
3090
 
 
3091
    def __init__(self, repository):
 
3092
        self.repository = repository
 
3093
 
 
3094
 
 
3095
class LossyPushToSameVCS(BzrError):
 
3096
 
 
3097
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3098
            "%(target_branch)r that are in the same VCS.")
 
3099
 
 
3100
    internal_error = True
 
3101
 
 
3102
    def __init__(self, source_branch, target_branch):
 
3103
        self.source_branch = source_branch
 
3104
        self.target_branch = target_branch
 
3105
 
 
3106
 
 
3107
class NoRoundtrippingSupport(BzrError):
 
3108
 
 
3109
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3110
            "%(target_branch)r.")
 
3111
 
 
3112
    internal_error = True
 
3113
 
 
3114
    def __init__(self, source_branch, target_branch):
 
3115
        self.source_branch = source_branch
 
3116
        self.target_branch = target_branch
 
3117
 
 
3118
 
 
3119
class FileTimestampUnavailable(BzrError):
 
3120
 
 
3121
    _fmt = "The filestamp for %(path)s is not available."
 
3122
 
 
3123
    internal_error = True
 
3124
 
 
3125
    def __init__(self, path):
 
3126
        self.path = path