~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-15 14:06:37 UTC
  • mto: This revision was merged to the branch mainline in revision 1926.
  • Revision ID: john@arbash-meinel.com-20060815140637-fa80ad04e689d5e4
Fix accidental import removal

Show diffs side-by-side

added added

removed removed

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