~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-28 02:10:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6450.
  • Revision ID: jelmer@samba.org-20120128021019-047mhvjsr9t72xfi
Fix reading weave files.

Show diffs side-by-side

added added

removed removed

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