/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2009-09-11 06:36:50 UTC
  • mto: This revision was merged to the branch mainline in revision 4688.
  • Revision ID: mbp@sourcefrog.net-20090911063650-yvb522sbe6k0i62r
Only mutter extension load errors when they occur, and record for later

Show diffs side-by-side

added added

removed removed

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