~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 19:26:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619192632-1a4ntoq61fkhlp2x
Make a note of the 'worst case' for heads.

Show diffs side-by-side

added added

removed removed

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