/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robey Pointer
  • Date: 2006-09-08 18:46:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908184629-e3fc4c61ca21508c
pychecker is on crack; go back to using 'is None'.

Show diffs side-by-side

added added

removed removed

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