~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2009-03-24 15:47:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4241.
  • Revision ID: aaron@aaronbentley.com-20090324154732-bwkvi4dx3o90a7dq
Add output, emit minimal inventory delta.

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