/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: Patch Queue Manager
  • Date: 2011-09-26 10:55:49 UTC
  • mfrom: (6165.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20110926105549-5ywzuwhv6proidxc
(vila) Merge 2.4 into trunk (Vincent Ladeuil)

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