/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-20 22:42:34 UTC
  • mfrom: (6083.1.2 more-get-transport-from)
  • Revision ID: pqm@pqm.ubuntu.com-20110820224234-l0c0cmesdnfp2srq
(jelmer) Use get_transport_from_path and get_transport_from_url in more
 places. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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