/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-11-21 00:32:54 UTC
  • mfrom: (6280.1.2 892622-feature-api)
  • Revision ID: pqm@pqm.ubuntu.com-20111121003254-321qb4a08o2a3cji
(mbp) restore old api name bzrlib.tests.Features to unbreak some plugins
 (Martin Pool)

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.context = context
 
1583
        self.reload_occurred = reload_occurred
 
1584
        self.exc_info = exc_info
 
1585
        self.orig_error = exc_info[1]
 
1586
        # TODO: The global error handler should probably treat this by
 
1587
        #       raising/printing the original exception with a bit about
 
1588
        #       RetryWithNewPacks also not being caught
 
1589
 
 
1590
 
 
1591
class RetryAutopack(RetryWithNewPacks):
 
1592
    """Raised when we are autopacking and we find a missing file.
 
1593
 
 
1594
    Meant as a signaling exception, to tell the autopack code it should try
 
1595
    again.
 
1596
    """
 
1597
 
 
1598
    internal_error = True
 
1599
 
 
1600
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1601
            " context: %(context)s %(orig_error)s")
 
1602
 
 
1603
 
 
1604
class NoSuchExportFormat(BzrError):
 
1605
 
 
1606
    _fmt = "Export format %(format)r not supported"
 
1607
 
624
1608
    def __init__(self, format):
625
 
        BzrNewError.__init__(self)
 
1609
        BzrError.__init__(self)
626
1610
        self.format = format
627
1611
 
628
1612
 
629
1613
class TransportError(BzrError):
630
 
    """All errors thrown by Transport implementations should derive
631
 
    from this class.
632
 
    """
 
1614
 
 
1615
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1616
 
633
1617
    def __init__(self, msg=None, orig_error=None):
634
1618
        if msg is None and orig_error is not None:
635
1619
            msg = str(orig_error)
636
 
        BzrError.__init__(self, msg)
 
1620
        if orig_error is None:
 
1621
            orig_error = ''
 
1622
        if msg is None:
 
1623
            msg =  ''
637
1624
        self.msg = msg
638
1625
        self.orig_error = orig_error
 
1626
        BzrError.__init__(self)
 
1627
 
 
1628
 
 
1629
class TooManyConcurrentRequests(InternalBzrError):
 
1630
 
 
1631
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1632
            " Be sure to finish_writing and finish_reading on the"
 
1633
            " currently open request.")
 
1634
 
 
1635
    def __init__(self, medium):
 
1636
        self.medium = medium
 
1637
 
 
1638
 
 
1639
class SmartProtocolError(TransportError):
 
1640
 
 
1641
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1642
 
 
1643
    def __init__(self, details):
 
1644
        self.details = details
 
1645
 
 
1646
 
 
1647
class UnexpectedProtocolVersionMarker(TransportError):
 
1648
 
 
1649
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1650
 
 
1651
    def __init__(self, marker):
 
1652
        self.marker = marker
 
1653
 
 
1654
 
 
1655
class UnknownSmartMethod(InternalBzrError):
 
1656
 
 
1657
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1658
 
 
1659
    def __init__(self, verb):
 
1660
        self.verb = verb
 
1661
 
 
1662
 
 
1663
class SmartMessageHandlerError(InternalBzrError):
 
1664
 
 
1665
    _fmt = ("The message handler raised an exception:\n"
 
1666
            "%(traceback_text)s")
 
1667
 
 
1668
    def __init__(self, exc_info):
 
1669
        import traceback
 
1670
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1671
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1672
        self.exc_info = exc_info
 
1673
        traceback_strings = traceback.format_exception(
 
1674
                self.exc_type, self.exc_value, self.exc_tb)
 
1675
        self.traceback_text = ''.join(traceback_strings)
639
1676
 
640
1677
 
641
1678
# A set of semi-meaningful errors which can be thrown
642
1679
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
 
1680
 
 
1681
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
647
1682
 
648
1683
 
649
1684
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
 
 
 
1685
 
 
1686
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1687
 
 
1688
 
 
1689
class SocketConnectionError(ConnectionError):
 
1690
 
 
1691
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1692
 
 
1693
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1694
        if msg is None:
 
1695
            msg = 'Failed to connect to'
 
1696
        if orig_error is None:
 
1697
            orig_error = ''
 
1698
        else:
 
1699
            orig_error = '; ' + str(orig_error)
 
1700
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1701
        self.host = host
 
1702
        if port is None:
 
1703
            self.port = ''
 
1704
        else:
 
1705
            self.port = ':%s' % port
 
1706
 
 
1707
 
 
1708
# XXX: This is also used for unexpected end of file, which is different at the
 
1709
# TCP level from "connection reset".
658
1710
class ConnectionReset(TransportError):
659
 
    """The connection has been closed."""
660
 
    pass
 
1711
 
 
1712
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1713
 
 
1714
 
 
1715
class ConnectionTimeout(ConnectionError):
 
1716
 
 
1717
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1718
 
 
1719
 
 
1720
class InvalidRange(TransportError):
 
1721
 
 
1722
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1723
 
 
1724
    def __init__(self, path, offset, msg=None):
 
1725
        TransportError.__init__(self, msg)
 
1726
        self.path = path
 
1727
        self.offset = offset
 
1728
 
 
1729
 
 
1730
class InvalidHttpResponse(TransportError):
 
1731
 
 
1732
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1733
 
 
1734
    def __init__(self, path, msg, orig_error=None):
 
1735
        self.path = path
 
1736
        if orig_error is None:
 
1737
            orig_error = ''
 
1738
        else:
 
1739
            # This is reached for obscure and unusual errors so we want to
 
1740
            # preserve as much info as possible to ease debug.
 
1741
            orig_error = ': %r' % (orig_error,)
 
1742
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1743
 
 
1744
 
 
1745
class InvalidHttpRange(InvalidHttpResponse):
 
1746
 
 
1747
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1748
 
 
1749
    def __init__(self, path, range, msg):
 
1750
        self.range = range
 
1751
        InvalidHttpResponse.__init__(self, path, msg)
 
1752
 
 
1753
 
 
1754
class HttpBoundaryMissing(InvalidHttpResponse):
 
1755
    """A multipart response ends with no boundary marker.
 
1756
 
 
1757
    This is a special case caused by buggy proxies, described in
 
1758
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1759
    """
 
1760
 
 
1761
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1762
 
 
1763
    def __init__(self, path, msg):
 
1764
        InvalidHttpResponse.__init__(self, path, msg)
 
1765
 
 
1766
 
 
1767
class InvalidHttpContentType(InvalidHttpResponse):
 
1768
 
 
1769
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1770
 
 
1771
    def __init__(self, path, ctype, msg):
 
1772
        self.ctype = ctype
 
1773
        InvalidHttpResponse.__init__(self, path, msg)
 
1774
 
 
1775
 
 
1776
class RedirectRequested(TransportError):
 
1777
 
 
1778
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1779
 
 
1780
    def __init__(self, source, target, is_permanent=False):
 
1781
        self.source = source
 
1782
        self.target = target
 
1783
        if is_permanent:
 
1784
            self.permanently = ' permanently'
 
1785
        else:
 
1786
            self.permanently = ''
 
1787
        TransportError.__init__(self)
 
1788
 
 
1789
 
 
1790
class TooManyRedirections(TransportError):
 
1791
 
 
1792
    _fmt = "Too many redirections"
661
1793
 
662
1794
 
663
1795
class ConflictsInTree(BzrError):
664
 
    def __init__(self):
665
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1796
 
 
1797
    _fmt = "Working tree has conflicts."
 
1798
 
 
1799
 
 
1800
class ConfigContentError(BzrError):
 
1801
 
 
1802
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1803
 
 
1804
    def __init__(self, filename):
 
1805
        BzrError.__init__(self)
 
1806
        self.filename = filename
666
1807
 
667
1808
 
668
1809
class ParseConfigError(BzrError):
 
1810
 
 
1811
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1812
 
669
1813
    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)
 
1814
        BzrError.__init__(self)
 
1815
        self.filename = filename
 
1816
        self.errors = '\n'.join(e.msg for e in errors)
 
1817
 
 
1818
 
 
1819
class ConfigOptionValueError(BzrError):
 
1820
 
 
1821
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
1822
 
 
1823
    def __init__(self, name, value):
 
1824
        BzrError.__init__(self, name=name, value=value)
 
1825
 
 
1826
 
 
1827
class NoEmailInUsername(BzrError):
 
1828
 
 
1829
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1830
 
 
1831
    def __init__(self, username):
 
1832
        BzrError.__init__(self)
 
1833
        self.username = username
675
1834
 
676
1835
 
677
1836
class SigningFailed(BzrError):
 
1837
 
 
1838
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1839
 
678
1840
    def __init__(self, command_line):
679
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
680
 
                               % command_line)
 
1841
        BzrError.__init__(self, command_line=command_line)
 
1842
 
 
1843
 
 
1844
class SignatureVerificationFailed(BzrError):
 
1845
 
 
1846
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1847
 
 
1848
    def __init__(self, error):
 
1849
        BzrError.__init__(self, error=error)
 
1850
 
 
1851
 
 
1852
class DependencyNotPresent(BzrError):
 
1853
 
 
1854
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1855
 
 
1856
    def __init__(self, library, error):
 
1857
        BzrError.__init__(self, library=library, error=error)
 
1858
 
 
1859
 
 
1860
class GpgmeNotInstalled(DependencyNotPresent):
 
1861
 
 
1862
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1863
 
 
1864
    def __init__(self, error):
 
1865
        DependencyNotPresent.__init__(self, 'gpgme', error)
681
1866
 
682
1867
 
683
1868
class WorkingTreeNotRevision(BzrError):
 
1869
 
 
1870
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1871
            " the last commit, but weave merge requires that it be"
 
1872
            " unchanged")
 
1873
 
684
1874
    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"""
 
1875
        BzrError.__init__(self, basedir=tree.basedir)
 
1876
 
 
1877
 
 
1878
class CantReprocessAndShowBase(BzrError):
 
1879
 
 
1880
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1881
           "the relationship of conflicting lines to the base")
 
1882
 
 
1883
 
 
1884
class GraphCycleError(BzrError):
 
1885
 
 
1886
    _fmt = "Cycle in graph %(graph)r"
 
1887
 
697
1888
    def __init__(self, graph):
698
 
        BzrNewError.__init__(self)
 
1889
        BzrError.__init__(self)
699
1890
        self.graph = graph
700
1891
 
701
1892
 
702
 
class NotConflicted(BzrNewError):
703
 
    """File %(filename)s is not conflicted."""
 
1893
class WritingCompleted(InternalBzrError):
 
1894
 
 
1895
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1896
            "called upon it - accept bytes may not be called anymore.")
 
1897
 
 
1898
    def __init__(self, request):
 
1899
        self.request = request
 
1900
 
 
1901
 
 
1902
class WritingNotComplete(InternalBzrError):
 
1903
 
 
1904
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1905
            "called upon it - until the write phase is complete no "
 
1906
            "data may be read.")
 
1907
 
 
1908
    def __init__(self, request):
 
1909
        self.request = request
 
1910
 
 
1911
 
 
1912
class NotConflicted(BzrError):
 
1913
 
 
1914
    _fmt = "File %(filename)s is not conflicted."
704
1915
 
705
1916
    def __init__(self, filename):
706
 
        BzrNewError.__init__(self)
 
1917
        BzrError.__init__(self)
707
1918
        self.filename = filename
708
1919
 
709
1920
 
 
1921
class MediumNotConnected(InternalBzrError):
 
1922
 
 
1923
    _fmt = """The medium '%(medium)s' is not connected."""
 
1924
 
 
1925
    def __init__(self, medium):
 
1926
        self.medium = medium
 
1927
 
 
1928
 
710
1929
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"""
 
1930
 
 
1931
    _fmt = "A decorating function has requested its original command be used."
 
1932
 
 
1933
 
 
1934
class NoBundleFound(BzrError):
 
1935
 
 
1936
    _fmt = 'No bundle was found in "%(filename)s".'
 
1937
 
 
1938
    def __init__(self, filename):
 
1939
        BzrError.__init__(self)
 
1940
        self.filename = filename
 
1941
 
 
1942
 
 
1943
class BundleNotSupported(BzrError):
 
1944
 
 
1945
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1946
 
 
1947
    def __init__(self, version, msg):
 
1948
        BzrError.__init__(self)
 
1949
        self.version = version
 
1950
        self.msg = msg
 
1951
 
 
1952
 
 
1953
class MissingText(BzrError):
 
1954
 
 
1955
    _fmt = ("Branch %(base)s is missing revision"
 
1956
            " %(text_revision)s of %(file_id)s")
719
1957
 
720
1958
    def __init__(self, branch, text_revision, file_id):
721
 
        BzrNewError.__init__(self)
 
1959
        BzrError.__init__(self)
722
1960
        self.branch = branch
723
1961
        self.base = branch.base
724
1962
        self.text_revision = text_revision
725
1963
        self.file_id = file_id
726
1964
 
727
1965
 
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
 
    """
 
1966
class DuplicateFileId(BzrError):
 
1967
 
 
1968
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1969
 
 
1970
    def __init__(self, file_id, entry):
 
1971
        BzrError.__init__(self)
 
1972
        self.file_id = file_id
 
1973
        self.entry = entry
 
1974
 
 
1975
 
 
1976
class DuplicateKey(BzrError):
 
1977
 
 
1978
    _fmt = "Key %(key)s is already present in map"
 
1979
 
 
1980
 
 
1981
class DuplicateHelpPrefix(BzrError):
 
1982
 
 
1983
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1984
 
 
1985
    def __init__(self, prefix):
 
1986
        self.prefix = prefix
 
1987
 
 
1988
 
 
1989
class MalformedTransform(InternalBzrError):
 
1990
 
 
1991
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1992
 
 
1993
 
 
1994
class NoFinalPath(BzrError):
 
1995
 
 
1996
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1997
            "file-id: %(file_id)r\n"
 
1998
            "root trans-id: %(root_trans_id)r\n")
 
1999
 
 
2000
    def __init__(self, trans_id, transform):
 
2001
        self.trans_id = trans_id
 
2002
        self.file_id = transform.final_file_id(trans_id)
 
2003
        self.root_trans_id = transform.root
 
2004
 
 
2005
 
 
2006
class BzrBadParameter(InternalBzrError):
 
2007
 
 
2008
    _fmt = "Bad parameter: %(param)r"
 
2009
 
 
2010
    # This exception should never be thrown, but it is a base class for all
 
2011
    # parameter-to-function errors.
 
2012
 
742
2013
    def __init__(self, param):
743
 
        BzrNewError.__init__(self)
 
2014
        BzrError.__init__(self)
744
2015
        self.param = param
745
2016
 
746
2017
 
747
2018
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"""
 
2019
 
 
2020
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
2021
 
 
2022
 
 
2023
class ReusingTransform(BzrError):
 
2024
 
 
2025
    _fmt = "Attempt to reuse a transform that has already been applied."
 
2026
 
 
2027
 
 
2028
class CantMoveRoot(BzrError):
 
2029
 
 
2030
    _fmt = "Moving the root directory is not supported at this time"
 
2031
 
 
2032
 
 
2033
class TransformRenameFailed(BzrError):
 
2034
 
 
2035
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
2036
 
 
2037
    def __init__(self, from_path, to_path, why, errno):
 
2038
        self.from_path = from_path
 
2039
        self.to_path = to_path
 
2040
        self.why = why
 
2041
        self.errno = errno
 
2042
 
 
2043
 
 
2044
class BzrMoveFailedError(BzrError):
 
2045
 
 
2046
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2047
        "%(_has_extra)s%(extra)s")
 
2048
 
 
2049
    def __init__(self, from_path='', to_path='', extra=None):
 
2050
        from bzrlib.osutils import splitpath
 
2051
        BzrError.__init__(self)
 
2052
        if extra:
 
2053
            self.extra, self._has_extra = extra, ': '
 
2054
        else:
 
2055
            self.extra = self._has_extra = ''
 
2056
 
 
2057
        has_from = len(from_path) > 0
 
2058
        has_to = len(to_path) > 0
 
2059
        if has_from:
 
2060
            self.from_path = splitpath(from_path)[-1]
 
2061
        else:
 
2062
            self.from_path = ''
 
2063
 
 
2064
        if has_to:
 
2065
            self.to_path = splitpath(to_path)[-1]
 
2066
        else:
 
2067
            self.to_path = ''
 
2068
 
 
2069
        self.operator = ""
 
2070
        if has_from and has_to:
 
2071
            self.operator = " =>"
 
2072
        elif has_from:
 
2073
            self.from_path = "from " + from_path
 
2074
        elif has_to:
 
2075
            self.operator = "to"
 
2076
        else:
 
2077
            self.operator = "file"
 
2078
 
 
2079
 
 
2080
class BzrRenameFailedError(BzrMoveFailedError):
 
2081
 
 
2082
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2083
        "%(_has_extra)s%(extra)s")
 
2084
 
 
2085
    def __init__(self, from_path, to_path, extra=None):
 
2086
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
2087
 
 
2088
 
 
2089
class BzrRemoveChangedFilesError(BzrError):
 
2090
    """Used when user is trying to remove changed files."""
 
2091
 
 
2092
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
2093
        "%(changes_as_text)s"
 
2094
        "Use --keep to not delete them, or --force to delete them regardless.")
 
2095
 
 
2096
    def __init__(self, tree_delta):
 
2097
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
 
2098
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
 
2099
        BzrError.__init__(self)
 
2100
        self.changes_as_text = tree_delta.get_changes_as_text()
 
2101
        #self.paths_as_string = '\n'.join(changed_files)
 
2102
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
757
2103
 
758
2104
 
759
2105
class BzrBadParameterNotString(BzrBadParameter):
760
 
    """Parameter %(param)s is not a string or unicode string."""
 
2106
 
 
2107
    _fmt = "Parameter %(param)s is not a string or unicode string."
761
2108
 
762
2109
 
763
2110
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)
 
2111
 
 
2112
    _fmt = "Parameter %(param)s is required but not present."
 
2113
 
 
2114
 
 
2115
class BzrBadParameterUnicode(BzrBadParameter):
 
2116
 
 
2117
    _fmt = ("Parameter %(param)s is unicode but"
 
2118
            " only byte-strings are permitted.")
 
2119
 
 
2120
 
 
2121
class BzrBadParameterContainsNewline(BzrBadParameter):
 
2122
 
 
2123
    _fmt = "Parameter %(param)s contains a newline."
772
2124
 
773
2125
 
774
2126
class ParamikoNotPresent(DependencyNotPresent):
775
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
2127
 
 
2128
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
776
2129
 
777
2130
    def __init__(self, error):
778
2131
        DependencyNotPresent.__init__(self, 'paramiko', error)
779
2132
 
780
2133
 
781
 
class UninitializableFormat(BzrNewError):
782
 
    """Format %(format)s cannot be initialised by this version of bzr."""
 
2134
class PointlessMerge(BzrError):
 
2135
 
 
2136
    _fmt = "Nothing to merge."
 
2137
 
 
2138
 
 
2139
class UninitializableFormat(BzrError):
 
2140
 
 
2141
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
783
2142
 
784
2143
    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)
 
2144
        BzrError.__init__(self)
 
2145
        self.format = format
 
2146
 
 
2147
 
 
2148
class BadConversionTarget(BzrError):
 
2149
 
 
2150
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2151
            "    %(problem)s"
 
2152
 
 
2153
    def __init__(self, problem, format, from_format=None):
 
2154
        BzrError.__init__(self)
 
2155
        self.problem = problem
 
2156
        self.format = format
 
2157
        self.from_format = from_format or '(unspecified)'
 
2158
 
 
2159
 
 
2160
class NoDiffFound(BzrError):
 
2161
 
 
2162
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2163
 
 
2164
    def __init__(self, path):
 
2165
        BzrError.__init__(self, path)
 
2166
 
 
2167
 
 
2168
class ExecutableMissing(BzrError):
 
2169
 
 
2170
    _fmt = "%(exe_name)s could not be found on this machine"
 
2171
 
 
2172
    def __init__(self, exe_name):
 
2173
        BzrError.__init__(self, exe_name=exe_name)
 
2174
 
 
2175
 
 
2176
class NoDiff(BzrError):
 
2177
 
 
2178
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
2179
 
 
2180
    def __init__(self, msg):
 
2181
        BzrError.__init__(self, msg=msg)
 
2182
 
 
2183
 
 
2184
class NoDiff3(BzrError):
 
2185
 
 
2186
    _fmt = "Diff3 is not installed on this machine."
 
2187
 
 
2188
 
 
2189
class ExistingContent(BzrError):
 
2190
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2191
 
 
2192
    _fmt = "The content being inserted is already present."
 
2193
 
 
2194
 
 
2195
class ExistingLimbo(BzrError):
 
2196
 
 
2197
    _fmt = """This tree contains left-over files from a failed operation.
 
2198
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2199
    keep, and delete it when you are done."""
 
2200
 
 
2201
    def __init__(self, limbo_dir):
 
2202
       BzrError.__init__(self)
 
2203
       self.limbo_dir = limbo_dir
 
2204
 
 
2205
 
 
2206
class ExistingPendingDeletion(BzrError):
 
2207
 
 
2208
    _fmt = """This tree contains left-over files from a failed operation.
 
2209
    Please examine %(pending_deletion)s to see if it contains any files you
 
2210
    wish to keep, and delete it when you are done."""
 
2211
 
 
2212
    def __init__(self, pending_deletion):
 
2213
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2214
 
 
2215
 
 
2216
class ImmortalLimbo(BzrError):
 
2217
 
 
2218
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2219
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2220
    keep, and delete it when you are done."""
 
2221
 
 
2222
    def __init__(self, limbo_dir):
 
2223
       BzrError.__init__(self)
 
2224
       self.limbo_dir = limbo_dir
 
2225
 
 
2226
 
 
2227
class ImmortalPendingDeletion(BzrError):
 
2228
 
 
2229
    _fmt = ("Unable to delete transform temporary directory "
 
2230
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2231
    "contains any files you wish to keep, and delete it when you are done.")
 
2232
 
 
2233
    def __init__(self, pending_deletion):
 
2234
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2235
 
 
2236
 
 
2237
class OutOfDateTree(BzrError):
 
2238
 
 
2239
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2240
 
 
2241
    def __init__(self, tree, more=None):
 
2242
        if more is None:
 
2243
            more = ''
 
2244
        else:
 
2245
            more = ' ' + more
 
2246
        BzrError.__init__(self)
818
2247
        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."""
 
2248
        self.more = more
 
2249
 
 
2250
 
 
2251
class PublicBranchOutOfDate(BzrError):
 
2252
 
 
2253
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2254
        '"%(revstring)s".'
 
2255
 
 
2256
    def __init__(self, public_location, revstring):
 
2257
        import bzrlib.urlutils as urlutils
 
2258
        public_location = urlutils.unescape_for_display(public_location,
 
2259
                                                        'ascii')
 
2260
        BzrError.__init__(self, public_location=public_location,
 
2261
                          revstring=revstring)
 
2262
 
 
2263
 
 
2264
class MergeModifiedFormatError(BzrError):
 
2265
 
 
2266
    _fmt = "Error in merge modified format"
 
2267
 
 
2268
 
 
2269
class ConflictFormatError(BzrError):
 
2270
 
 
2271
    _fmt = "Format error in conflict listings"
 
2272
 
 
2273
 
 
2274
class CorruptDirstate(BzrError):
 
2275
 
 
2276
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2277
            "Error: %(description)s")
 
2278
 
 
2279
    def __init__(self, dirstate_path, description):
 
2280
        BzrError.__init__(self)
 
2281
        self.dirstate_path = dirstate_path
 
2282
        self.description = description
 
2283
 
 
2284
 
 
2285
class CorruptRepository(BzrError):
 
2286
 
 
2287
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2288
            "Please run bzr reconcile on this repository.")
832
2289
 
833
2290
    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."""
 
2291
        BzrError.__init__(self)
 
2292
        self.repo_path = repo.user_url
 
2293
 
 
2294
 
 
2295
class InconsistentDelta(BzrError):
 
2296
    """Used when we get a delta that is not valid."""
 
2297
 
 
2298
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2299
            " %(file_id)r\nreason: %(reason)s")
 
2300
 
 
2301
    def __init__(self, path, file_id, reason):
 
2302
        BzrError.__init__(self)
 
2303
        self.path = path
 
2304
        self.file_id = file_id
 
2305
        self.reason = reason
 
2306
 
 
2307
 
 
2308
class InconsistentDeltaDelta(InconsistentDelta):
 
2309
    """Used when we get a delta that is not valid."""
 
2310
 
 
2311
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2312
            "\nreason: %(reason)s")
 
2313
 
 
2314
    def __init__(self, delta, reason):
 
2315
        BzrError.__init__(self)
 
2316
        self.delta = delta
 
2317
        self.reason = reason
 
2318
 
 
2319
 
 
2320
class UpgradeRequired(BzrError):
 
2321
 
 
2322
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
840
2323
 
841
2324
    def __init__(self, path):
842
 
        BzrNewError.__init__(self)
 
2325
        BzrError.__init__(self)
843
2326
        self.path = path
844
2327
 
845
2328
 
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."""
 
2329
class RepositoryUpgradeRequired(UpgradeRequired):
 
2330
 
 
2331
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2332
 
 
2333
 
 
2334
class RichRootUpgradeRequired(UpgradeRequired):
 
2335
 
 
2336
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2337
           " a format which supports rich roots.")
 
2338
 
 
2339
 
 
2340
class LocalRequiresBoundBranch(BzrError):
 
2341
 
 
2342
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2343
 
 
2344
 
 
2345
class UnsupportedOperation(BzrError):
 
2346
 
 
2347
    _fmt = ("The method %(mname)s is not supported on"
 
2348
            " objects of type %(tname)s.")
 
2349
 
856
2350
    def __init__(self, method, method_self):
857
2351
        self.method = method
858
2352
        self.mname = method.__name__
859
2353
        self.tname = type(method_self).__name__
 
2354
 
 
2355
 
 
2356
class CannotSetRevisionId(UnsupportedOperation):
 
2357
    """Raised when a commit is attempting to set a revision id but cant."""
 
2358
 
 
2359
 
 
2360
class NonAsciiRevisionId(UnsupportedOperation):
 
2361
    """Raised when a commit is attempting to set a non-ascii revision id
 
2362
       but cant.
 
2363
    """
 
2364
 
 
2365
 
 
2366
class GhostTagsNotSupported(BzrError):
 
2367
 
 
2368
    _fmt = "Ghost tags not supported by format %(format)r."
 
2369
 
 
2370
    def __init__(self, format):
 
2371
        self.format = format
 
2372
 
 
2373
 
 
2374
class BinaryFile(BzrError):
 
2375
 
 
2376
    _fmt = "File is binary but should be text."
 
2377
 
 
2378
 
 
2379
class IllegalPath(BzrError):
 
2380
 
 
2381
    _fmt = "The path %(path)s is not permitted on this platform"
 
2382
 
 
2383
    def __init__(self, path):
 
2384
        BzrError.__init__(self)
 
2385
        self.path = path
 
2386
 
 
2387
 
 
2388
class TestamentMismatch(BzrError):
 
2389
 
 
2390
    _fmt = """Testament did not match expected value.
 
2391
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2392
       {%(measured)s}"""
 
2393
 
 
2394
    def __init__(self, revision_id, expected, measured):
 
2395
        self.revision_id = revision_id
 
2396
        self.expected = expected
 
2397
        self.measured = measured
 
2398
 
 
2399
 
 
2400
class NotABundle(BzrError):
 
2401
 
 
2402
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2403
 
 
2404
    def __init__(self, text):
 
2405
        BzrError.__init__(self)
 
2406
        self.text = text
 
2407
 
 
2408
 
 
2409
class BadBundle(BzrError):
 
2410
 
 
2411
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2412
 
 
2413
    def __init__(self, text):
 
2414
        BzrError.__init__(self)
 
2415
        self.text = text
 
2416
 
 
2417
 
 
2418
class MalformedHeader(BadBundle):
 
2419
 
 
2420
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2421
 
 
2422
 
 
2423
class MalformedPatches(BadBundle):
 
2424
 
 
2425
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2426
 
 
2427
 
 
2428
class MalformedFooter(BadBundle):
 
2429
 
 
2430
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2431
 
 
2432
 
 
2433
class UnsupportedEOLMarker(BadBundle):
 
2434
 
 
2435
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2436
 
 
2437
    def __init__(self):
 
2438
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2439
        # but for this there is not
 
2440
        BzrError.__init__(self)
 
2441
 
 
2442
 
 
2443
class IncompatibleBundleFormat(BzrError):
 
2444
 
 
2445
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2446
 
 
2447
    def __init__(self, bundle_format, other):
 
2448
        BzrError.__init__(self)
 
2449
        self.bundle_format = bundle_format
 
2450
        self.other = other
 
2451
 
 
2452
 
 
2453
class BadInventoryFormat(BzrError):
 
2454
 
 
2455
    _fmt = "Root class for inventory serialization errors"
 
2456
 
 
2457
 
 
2458
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2459
 
 
2460
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2461
 
 
2462
    def __init__(self, msg):
 
2463
        BadInventoryFormat.__init__(self, msg=msg)
 
2464
 
 
2465
 
 
2466
class RootNotRich(BzrError):
 
2467
 
 
2468
    _fmt = """This operation requires rich root data storage"""
 
2469
 
 
2470
 
 
2471
class NoSmartMedium(InternalBzrError):
 
2472
 
 
2473
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2474
 
 
2475
    def __init__(self, transport):
 
2476
        self.transport = transport
 
2477
 
 
2478
 
 
2479
class UnknownSSH(BzrError):
 
2480
 
 
2481
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2482
 
 
2483
    def __init__(self, vendor):
 
2484
        BzrError.__init__(self)
 
2485
        self.vendor = vendor
 
2486
 
 
2487
 
 
2488
class SSHVendorNotFound(BzrError):
 
2489
 
 
2490
    _fmt = ("Don't know how to handle SSH connections."
 
2491
            " Please set BZR_SSH environment variable.")
 
2492
 
 
2493
 
 
2494
class GhostRevisionsHaveNoRevno(BzrError):
 
2495
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2496
 
 
2497
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2498
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2499
 
 
2500
    def __init__(self, revision_id, ghost_revision_id):
 
2501
        self.revision_id = revision_id
 
2502
        self.ghost_revision_id = ghost_revision_id
 
2503
 
 
2504
 
 
2505
class GhostRevisionUnusableHere(BzrError):
 
2506
 
 
2507
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2508
 
 
2509
    def __init__(self, revision_id):
 
2510
        BzrError.__init__(self)
 
2511
        self.revision_id = revision_id
 
2512
 
 
2513
 
 
2514
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2515
 
 
2516
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2517
            " %(msg)s%(extra)s")
 
2518
 
 
2519
    def __init__(self, name, msg, extra=None):
 
2520
        BzrError.__init__(self)
 
2521
        self.name = name
 
2522
        self.msg = msg
 
2523
        if extra:
 
2524
            self.extra = ': ' + str(extra)
 
2525
        else:
 
2526
            self.extra = ''
 
2527
 
 
2528
 
 
2529
class InvalidImportLine(InternalBzrError):
 
2530
 
 
2531
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2532
 
 
2533
    def __init__(self, text, msg):
 
2534
        BzrError.__init__(self)
 
2535
        self.text = text
 
2536
        self.msg = msg
 
2537
 
 
2538
 
 
2539
class ImportNameCollision(InternalBzrError):
 
2540
 
 
2541
    _fmt = ("Tried to import an object to the same name as"
 
2542
            " an existing object. %(name)s")
 
2543
 
 
2544
    def __init__(self, name):
 
2545
        BzrError.__init__(self)
 
2546
        self.name = name
 
2547
 
 
2548
 
 
2549
class NotAMergeDirective(BzrError):
 
2550
    """File starting with %(firstline)r is not a merge directive"""
 
2551
    def __init__(self, firstline):
 
2552
        BzrError.__init__(self, firstline=firstline)
 
2553
 
 
2554
 
 
2555
class NoMergeSource(BzrError):
 
2556
    """Raise if no merge source was specified for a merge directive"""
 
2557
 
 
2558
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2559
        " branch location."
 
2560
 
 
2561
 
 
2562
class IllegalMergeDirectivePayload(BzrError):
 
2563
    """A merge directive contained something other than a patch or bundle"""
 
2564
 
 
2565
    _fmt = "Bad merge directive payload %(start)r"
 
2566
 
 
2567
    def __init__(self, start):
 
2568
        BzrError(self)
 
2569
        self.start = start
 
2570
 
 
2571
 
 
2572
class PatchVerificationFailed(BzrError):
 
2573
    """A patch from a merge directive could not be verified"""
 
2574
 
 
2575
    _fmt = "Preview patch does not match requested changes."
 
2576
 
 
2577
 
 
2578
class PatchMissing(BzrError):
 
2579
    """Raise a patch type was specified but no patch supplied"""
 
2580
 
 
2581
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2582
 
 
2583
    def __init__(self, patch_type):
 
2584
        BzrError.__init__(self)
 
2585
        self.patch_type = patch_type
 
2586
 
 
2587
 
 
2588
class TargetNotBranch(BzrError):
 
2589
    """A merge directive's target branch is required, but isn't a branch"""
 
2590
 
 
2591
    _fmt = ("Your branch does not have all of the revisions required in "
 
2592
            "order to merge this merge directive and the target "
 
2593
            "location specified in the merge directive is not a branch: "
 
2594
            "%(location)s.")
 
2595
 
 
2596
    def __init__(self, location):
 
2597
        BzrError.__init__(self)
 
2598
        self.location = location
 
2599
 
 
2600
 
 
2601
class UnsupportedInventoryKind(BzrError):
 
2602
 
 
2603
    _fmt = """Unsupported entry kind %(kind)s"""
 
2604
 
 
2605
    def __init__(self, kind):
 
2606
        self.kind = kind
 
2607
 
 
2608
 
 
2609
class BadSubsumeSource(BzrError):
 
2610
 
 
2611
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2612
 
 
2613
    def __init__(self, tree, other_tree, reason):
 
2614
        self.tree = tree
 
2615
        self.other_tree = other_tree
 
2616
        self.reason = reason
 
2617
 
 
2618
 
 
2619
class SubsumeTargetNeedsUpgrade(BzrError):
 
2620
 
 
2621
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2622
 
 
2623
    def __init__(self, other_tree):
 
2624
        self.other_tree = other_tree
 
2625
 
 
2626
 
 
2627
class BadReferenceTarget(InternalBzrError):
 
2628
 
 
2629
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2630
           "%(reason)s"
 
2631
 
 
2632
    def __init__(self, tree, other_tree, reason):
 
2633
        self.tree = tree
 
2634
        self.other_tree = other_tree
 
2635
        self.reason = reason
 
2636
 
 
2637
 
 
2638
class NoSuchTag(BzrError):
 
2639
 
 
2640
    _fmt = "No such tag: %(tag_name)s"
 
2641
 
 
2642
    def __init__(self, tag_name):
 
2643
        self.tag_name = tag_name
 
2644
 
 
2645
 
 
2646
class TagsNotSupported(BzrError):
 
2647
 
 
2648
    _fmt = ("Tags not supported by %(branch)s;"
 
2649
            " you may be able to use bzr upgrade.")
 
2650
 
 
2651
    def __init__(self, branch):
 
2652
        self.branch = branch
 
2653
 
 
2654
 
 
2655
class TagAlreadyExists(BzrError):
 
2656
 
 
2657
    _fmt = "Tag %(tag_name)s already exists."
 
2658
 
 
2659
    def __init__(self, tag_name):
 
2660
        self.tag_name = tag_name
 
2661
 
 
2662
 
 
2663
class MalformedBugIdentifier(BzrError):
 
2664
 
 
2665
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2666
            'See "bzr help bugs" for more information on this feature.')
 
2667
 
 
2668
    def __init__(self, bug_id, reason):
 
2669
        self.bug_id = bug_id
 
2670
        self.reason = reason
 
2671
 
 
2672
 
 
2673
class InvalidBugTrackerURL(BzrError):
 
2674
 
 
2675
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2676
            "contain {id}: %(url)s")
 
2677
 
 
2678
    def __init__(self, abbreviation, url):
 
2679
        self.abbreviation = abbreviation
 
2680
        self.url = url
 
2681
 
 
2682
 
 
2683
class UnknownBugTrackerAbbreviation(BzrError):
 
2684
 
 
2685
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2686
            "on %(branch)s")
 
2687
 
 
2688
    def __init__(self, abbreviation, branch):
 
2689
        self.abbreviation = abbreviation
 
2690
        self.branch = branch
 
2691
 
 
2692
 
 
2693
class InvalidLineInBugsProperty(BzrError):
 
2694
 
 
2695
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2696
 
 
2697
    def __init__(self, line):
 
2698
        self.line = line
 
2699
 
 
2700
 
 
2701
class InvalidBugStatus(BzrError):
 
2702
 
 
2703
    _fmt = ("Invalid bug status: '%(status)s'")
 
2704
 
 
2705
    def __init__(self, status):
 
2706
        self.status = status
 
2707
 
 
2708
 
 
2709
class UnexpectedSmartServerResponse(BzrError):
 
2710
 
 
2711
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2712
 
 
2713
    def __init__(self, response_tuple):
 
2714
        self.response_tuple = response_tuple
 
2715
 
 
2716
 
 
2717
class ErrorFromSmartServer(BzrError):
 
2718
    """An error was received from a smart server.
 
2719
 
 
2720
    :seealso: UnknownErrorFromSmartServer
 
2721
    """
 
2722
 
 
2723
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2724
 
 
2725
    internal_error = True
 
2726
 
 
2727
    def __init__(self, error_tuple):
 
2728
        self.error_tuple = error_tuple
 
2729
        try:
 
2730
            self.error_verb = error_tuple[0]
 
2731
        except IndexError:
 
2732
            self.error_verb = None
 
2733
        self.error_args = error_tuple[1:]
 
2734
 
 
2735
 
 
2736
class UnknownErrorFromSmartServer(BzrError):
 
2737
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2738
    error.
 
2739
 
 
2740
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2741
    distinguish between the following two cases:
 
2742
 
 
2743
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2744
      and so should provoke a traceback to the user.
 
2745
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2746
      translated.  This is probably because the server sent us garbage, and
 
2747
      should not provoke a traceback.
 
2748
    """
 
2749
 
 
2750
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2751
 
 
2752
    internal_error = False
 
2753
 
 
2754
    def __init__(self, error_from_smart_server):
 
2755
        """Constructor.
 
2756
 
 
2757
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2758
        """
 
2759
        self.error_from_smart_server = error_from_smart_server
 
2760
        self.error_tuple = error_from_smart_server.error_tuple
 
2761
 
 
2762
 
 
2763
class ContainerError(BzrError):
 
2764
    """Base class of container errors."""
 
2765
 
 
2766
 
 
2767
class UnknownContainerFormatError(ContainerError):
 
2768
 
 
2769
    _fmt = "Unrecognised container format: %(container_format)r"
 
2770
 
 
2771
    def __init__(self, container_format):
 
2772
        self.container_format = container_format
 
2773
 
 
2774
 
 
2775
class UnexpectedEndOfContainerError(ContainerError):
 
2776
 
 
2777
    _fmt = "Unexpected end of container stream"
 
2778
 
 
2779
 
 
2780
class UnknownRecordTypeError(ContainerError):
 
2781
 
 
2782
    _fmt = "Unknown record type: %(record_type)r"
 
2783
 
 
2784
    def __init__(self, record_type):
 
2785
        self.record_type = record_type
 
2786
 
 
2787
 
 
2788
class InvalidRecordError(ContainerError):
 
2789
 
 
2790
    _fmt = "Invalid record: %(reason)s"
 
2791
 
 
2792
    def __init__(self, reason):
 
2793
        self.reason = reason
 
2794
 
 
2795
 
 
2796
class ContainerHasExcessDataError(ContainerError):
 
2797
 
 
2798
    _fmt = "Container has data after end marker: %(excess)r"
 
2799
 
 
2800
    def __init__(self, excess):
 
2801
        self.excess = excess
 
2802
 
 
2803
 
 
2804
class DuplicateRecordNameError(ContainerError):
 
2805
 
 
2806
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2807
 
 
2808
    def __init__(self, name):
 
2809
        self.name = name.decode("utf-8")
 
2810
 
 
2811
 
 
2812
class NoDestinationAddress(InternalBzrError):
 
2813
 
 
2814
    _fmt = "Message does not have a destination address."
 
2815
 
 
2816
 
 
2817
class RepositoryDataStreamError(BzrError):
 
2818
 
 
2819
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2820
 
 
2821
    def __init__(self, reason):
 
2822
        self.reason = reason
 
2823
 
 
2824
 
 
2825
class SMTPError(BzrError):
 
2826
 
 
2827
    _fmt = "SMTP error: %(error)s"
 
2828
 
 
2829
    def __init__(self, error):
 
2830
        self.error = error
 
2831
 
 
2832
 
 
2833
class NoMessageSupplied(BzrError):
 
2834
 
 
2835
    _fmt = "No message supplied."
 
2836
 
 
2837
 
 
2838
class NoMailAddressSpecified(BzrError):
 
2839
 
 
2840
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2841
 
 
2842
 
 
2843
class UnknownMailClient(BzrError):
 
2844
 
 
2845
    _fmt = "Unknown mail client: %(mail_client)s"
 
2846
 
 
2847
    def __init__(self, mail_client):
 
2848
        BzrError.__init__(self, mail_client=mail_client)
 
2849
 
 
2850
 
 
2851
class MailClientNotFound(BzrError):
 
2852
 
 
2853
    _fmt = "Unable to find mail client with the following names:"\
 
2854
        " %(mail_command_list_string)s"
 
2855
 
 
2856
    def __init__(self, mail_command_list):
 
2857
        mail_command_list_string = ', '.join(mail_command_list)
 
2858
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2859
                          mail_command_list_string=mail_command_list_string)
 
2860
 
 
2861
class SMTPConnectionRefused(SMTPError):
 
2862
 
 
2863
    _fmt = "SMTP connection to %(host)s refused"
 
2864
 
 
2865
    def __init__(self, error, host):
 
2866
        self.error = error
 
2867
        self.host = host
 
2868
 
 
2869
 
 
2870
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2871
 
 
2872
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2873
 
 
2874
 
 
2875
class BzrDirError(BzrError):
 
2876
 
 
2877
    def __init__(self, bzrdir):
 
2878
        import bzrlib.urlutils as urlutils
 
2879
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2880
                                                    'ascii')
 
2881
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2882
 
 
2883
 
 
2884
class UnsyncedBranches(BzrDirError):
 
2885
 
 
2886
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2887
            " bzr help sync-for-reconfigure.")
 
2888
 
 
2889
    def __init__(self, bzrdir, target_branch):
 
2890
        BzrDirError.__init__(self, bzrdir)
 
2891
        import bzrlib.urlutils as urlutils
 
2892
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2893
                                                        'ascii')
 
2894
 
 
2895
 
 
2896
class AlreadyBranch(BzrDirError):
 
2897
 
 
2898
    _fmt = "'%(display_url)s' is already a branch."
 
2899
 
 
2900
 
 
2901
class AlreadyTree(BzrDirError):
 
2902
 
 
2903
    _fmt = "'%(display_url)s' is already a tree."
 
2904
 
 
2905
 
 
2906
class AlreadyCheckout(BzrDirError):
 
2907
 
 
2908
    _fmt = "'%(display_url)s' is already a checkout."
 
2909
 
 
2910
 
 
2911
class AlreadyLightweightCheckout(BzrDirError):
 
2912
 
 
2913
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2914
 
 
2915
 
 
2916
class AlreadyUsingShared(BzrDirError):
 
2917
 
 
2918
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2919
 
 
2920
 
 
2921
class AlreadyStandalone(BzrDirError):
 
2922
 
 
2923
    _fmt = "'%(display_url)s' is already standalone."
 
2924
 
 
2925
 
 
2926
class AlreadyWithTrees(BzrDirError):
 
2927
 
 
2928
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2929
            "working trees.")
 
2930
 
 
2931
 
 
2932
class AlreadyWithNoTrees(BzrDirError):
 
2933
 
 
2934
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2935
            "working trees.")
 
2936
 
 
2937
 
 
2938
class ReconfigurationNotSupported(BzrDirError):
 
2939
 
 
2940
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2941
 
 
2942
 
 
2943
class NoBindLocation(BzrDirError):
 
2944
 
 
2945
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2946
 
 
2947
 
 
2948
class UncommittedChanges(BzrError):
 
2949
 
 
2950
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2951
            ' (See bzr status).%(more)s')
 
2952
 
 
2953
    def __init__(self, tree, more=None):
 
2954
        if more is None:
 
2955
            more = ''
 
2956
        else:
 
2957
            more = ' ' + more
 
2958
        import bzrlib.urlutils as urlutils
 
2959
        user_url = getattr(tree, "user_url", None)
 
2960
        if user_url is None:
 
2961
            display_url = str(tree)
 
2962
        else:
 
2963
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2964
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2965
 
 
2966
 
 
2967
class ShelvedChanges(UncommittedChanges):
 
2968
 
 
2969
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2970
            ' (See bzr shelve --list).%(more)s')
 
2971
 
 
2972
 
 
2973
class MissingTemplateVariable(BzrError):
 
2974
 
 
2975
    _fmt = 'Variable {%(name)s} is not available.'
 
2976
 
 
2977
    def __init__(self, name):
 
2978
        self.name = name
 
2979
 
 
2980
 
 
2981
class NoTemplate(BzrError):
 
2982
 
 
2983
    _fmt = 'No template specified.'
 
2984
 
 
2985
 
 
2986
class UnableCreateSymlink(BzrError):
 
2987
 
 
2988
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2989
 
 
2990
    def __init__(self, path=None):
 
2991
        path_str = ''
 
2992
        if path:
 
2993
            try:
 
2994
                path_str = repr(str(path))
 
2995
            except UnicodeEncodeError:
 
2996
                path_str = repr(path)
 
2997
            path_str += ' '
 
2998
        self.path_str = path_str
 
2999
 
 
3000
 
 
3001
class UnsupportedTimezoneFormat(BzrError):
 
3002
 
 
3003
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
3004
            'options are "utc", "original", "local".')
 
3005
 
 
3006
    def __init__(self, timezone):
 
3007
        self.timezone = timezone
 
3008
 
 
3009
 
 
3010
class CommandAvailableInPlugin(StandardError):
 
3011
 
 
3012
    internal_error = False
 
3013
 
 
3014
    def __init__(self, cmd_name, plugin_metadata, provider):
 
3015
 
 
3016
        self.plugin_metadata = plugin_metadata
 
3017
        self.cmd_name = cmd_name
 
3018
        self.provider = provider
 
3019
 
 
3020
    def __str__(self):
 
3021
 
 
3022
        _fmt = ('"%s" is not a standard bzr command. \n'
 
3023
                'However, the following official plugin provides this command: %s\n'
 
3024
                'You can install it by going to: %s'
 
3025
                % (self.cmd_name, self.plugin_metadata['name'],
 
3026
                    self.plugin_metadata['url']))
 
3027
 
 
3028
        return _fmt
 
3029
 
 
3030
 
 
3031
class NoPluginAvailable(BzrError):
 
3032
    pass
 
3033
 
 
3034
 
 
3035
class UnableEncodePath(BzrError):
 
3036
 
 
3037
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
3038
            'user encoding %(user_encoding)s')
 
3039
 
 
3040
    def __init__(self, path, kind):
 
3041
        from bzrlib.osutils import get_user_encoding
 
3042
        self.path = path
 
3043
        self.kind = kind
 
3044
        self.user_encoding = osutils.get_user_encoding()
 
3045
 
 
3046
 
 
3047
class NoSuchConfig(BzrError):
 
3048
 
 
3049
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
3050
 
 
3051
    def __init__(self, config_id):
 
3052
        BzrError.__init__(self, config_id=config_id)
 
3053
 
 
3054
 
 
3055
class NoSuchConfigOption(BzrError):
 
3056
 
 
3057
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
3058
 
 
3059
    def __init__(self, option_name):
 
3060
        BzrError.__init__(self, option_name=option_name)
 
3061
 
 
3062
 
 
3063
class NoSuchAlias(BzrError):
 
3064
 
 
3065
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
3066
 
 
3067
    def __init__(self, alias_name):
 
3068
        BzrError.__init__(self, alias_name=alias_name)
 
3069
 
 
3070
 
 
3071
class DirectoryLookupFailure(BzrError):
 
3072
    """Base type for lookup errors."""
 
3073
 
 
3074
    pass
 
3075
 
 
3076
 
 
3077
class InvalidLocationAlias(DirectoryLookupFailure):
 
3078
 
 
3079
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
3080
 
 
3081
    def __init__(self, alias_name):
 
3082
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
3083
 
 
3084
 
 
3085
class UnsetLocationAlias(DirectoryLookupFailure):
 
3086
 
 
3087
    _fmt = 'No %(alias_name)s location assigned.'
 
3088
 
 
3089
    def __init__(self, alias_name):
 
3090
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
3091
 
 
3092
 
 
3093
class CannotBindAddress(BzrError):
 
3094
 
 
3095
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
3096
 
 
3097
    def __init__(self, host, port, orig_error):
 
3098
        # nb: in python2.4 socket.error doesn't have a useful repr
 
3099
        BzrError.__init__(self, host=host, port=port,
 
3100
            orig_error=repr(orig_error.args))
 
3101
 
 
3102
 
 
3103
class UnknownRules(BzrError):
 
3104
 
 
3105
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
3106
 
 
3107
    def __init__(self, unknowns):
 
3108
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
3109
 
 
3110
 
 
3111
class HookFailed(BzrError):
 
3112
    """Raised when a pre_change_branch_tip hook function fails anything other
 
3113
    than TipChangeRejected.
 
3114
 
 
3115
    Note that this exception is no longer raised, and the import is only left
 
3116
    to be nice to code which might catch it in a plugin.
 
3117
    """
 
3118
 
 
3119
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
3120
            "%(traceback_text)s%(exc_value)s")
 
3121
 
 
3122
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
3123
        if warn:
 
3124
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
3125
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
3126
        import traceback
 
3127
        self.hook_stage = hook_stage
 
3128
        self.hook_name = hook_name
 
3129
        self.exc_info = exc_info
 
3130
        self.exc_type = exc_info[0]
 
3131
        self.exc_value = exc_info[1]
 
3132
        self.exc_tb = exc_info[2]
 
3133
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
3134
 
 
3135
 
 
3136
class TipChangeRejected(BzrError):
 
3137
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3138
    explicitly abort a change to a branch tip.
 
3139
    """
 
3140
 
 
3141
    _fmt = u"Tip change rejected: %(msg)s"
 
3142
 
 
3143
    def __init__(self, msg):
 
3144
        self.msg = msg
 
3145
 
 
3146
 
 
3147
class ShelfCorrupt(BzrError):
 
3148
 
 
3149
    _fmt = "Shelf corrupt."
 
3150
 
 
3151
 
 
3152
class DecompressCorruption(BzrError):
 
3153
 
 
3154
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3155
 
 
3156
    def __init__(self, orig_error=None):
 
3157
        if orig_error is not None:
 
3158
            self.orig_error = ", %s" % (orig_error,)
 
3159
        else:
 
3160
            self.orig_error = ""
 
3161
        BzrError.__init__(self)
 
3162
 
 
3163
 
 
3164
class NoSuchShelfId(BzrError):
 
3165
 
 
3166
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3167
 
 
3168
    def __init__(self, shelf_id):
 
3169
        BzrError.__init__(self, shelf_id=shelf_id)
 
3170
 
 
3171
 
 
3172
class InvalidShelfId(BzrError):
 
3173
 
 
3174
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3175
 
 
3176
    def __init__(self, invalid_id):
 
3177
        BzrError.__init__(self, invalid_id=invalid_id)
 
3178
 
 
3179
 
 
3180
class JailBreak(BzrError):
 
3181
 
 
3182
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3183
 
 
3184
    def __init__(self, url):
 
3185
        BzrError.__init__(self, url=url)
 
3186
 
 
3187
 
 
3188
class UserAbort(BzrError):
 
3189
 
 
3190
    _fmt = 'The user aborted the operation.'
 
3191
 
 
3192
 
 
3193
class MustHaveWorkingTree(BzrError):
 
3194
 
 
3195
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3196
 
 
3197
    def __init__(self, format, url):
 
3198
        BzrError.__init__(self, format=format, url=url)
 
3199
 
 
3200
 
 
3201
class NoSuchView(BzrError):
 
3202
    """A view does not exist.
 
3203
    """
 
3204
 
 
3205
    _fmt = u"No such view: %(view_name)s."
 
3206
 
 
3207
    def __init__(self, view_name):
 
3208
        self.view_name = view_name
 
3209
 
 
3210
 
 
3211
class ViewsNotSupported(BzrError):
 
3212
    """Views are not supported by a tree format.
 
3213
    """
 
3214
 
 
3215
    _fmt = ("Views are not supported by %(tree)s;"
 
3216
            " use 'bzr upgrade' to change your tree to a later format.")
 
3217
 
 
3218
    def __init__(self, tree):
 
3219
        self.tree = tree
 
3220
 
 
3221
 
 
3222
class FileOutsideView(BzrError):
 
3223
 
 
3224
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3225
            '%(view_str)s')
 
3226
 
 
3227
    def __init__(self, file_name, view_files):
 
3228
        self.file_name = file_name
 
3229
        self.view_str = ", ".join(view_files)
 
3230
 
 
3231
 
 
3232
class UnresumableWriteGroup(BzrError):
 
3233
 
 
3234
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3235
            "%(write_groups)r: %(reason)s")
 
3236
 
 
3237
    internal_error = True
 
3238
 
 
3239
    def __init__(self, repository, write_groups, reason):
 
3240
        self.repository = repository
 
3241
        self.write_groups = write_groups
 
3242
        self.reason = reason
 
3243
 
 
3244
 
 
3245
class UnsuspendableWriteGroup(BzrError):
 
3246
 
 
3247
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3248
 
 
3249
    internal_error = True
 
3250
 
 
3251
    def __init__(self, repository):
 
3252
        self.repository = repository
 
3253
 
 
3254
 
 
3255
class LossyPushToSameVCS(BzrError):
 
3256
 
 
3257
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3258
            "%(target_branch)r that are in the same VCS.")
 
3259
 
 
3260
    internal_error = True
 
3261
 
 
3262
    def __init__(self, source_branch, target_branch):
 
3263
        self.source_branch = source_branch
 
3264
        self.target_branch = target_branch
 
3265
 
 
3266
 
 
3267
class NoRoundtrippingSupport(BzrError):
 
3268
 
 
3269
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3270
            "%(target_branch)r.")
 
3271
 
 
3272
    internal_error = True
 
3273
 
 
3274
    def __init__(self, source_branch, target_branch):
 
3275
        self.source_branch = source_branch
 
3276
        self.target_branch = target_branch
 
3277
 
 
3278
 
 
3279
class FileTimestampUnavailable(BzrError):
 
3280
 
 
3281
    _fmt = "The filestamp for %(path)s is not available."
 
3282
 
 
3283
    internal_error = True
 
3284
 
 
3285
    def __init__(self, path):
 
3286
        self.path = path
 
3287
 
 
3288
 
 
3289
class NoColocatedBranchSupport(BzrError):
 
3290
 
 
3291
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3292
 
 
3293
    def __init__(self, bzrdir):
 
3294
        self.bzrdir = bzrdir
 
3295
 
 
3296
 
 
3297
class NoWhoami(BzrError):
 
3298
 
 
3299
    _fmt = ('Unable to determine your name.\n'
 
3300
        "Please, set your name with the 'whoami' command.\n"
 
3301
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3302
 
 
3303
 
 
3304
class InvalidPattern(BzrError):
 
3305
 
 
3306
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3307
 
 
3308
    def __init__(self, msg):
 
3309
        self.msg = msg
 
3310
 
 
3311
 
 
3312
class RecursiveBind(BzrError):
 
3313
 
 
3314
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3315
        'Please use `bzr unbind` to fix.')
 
3316
 
 
3317
    def __init__(self, branch_url):
 
3318
        self.branch_url = branch_url
 
3319
 
 
3320
 
 
3321
# FIXME: I would prefer to define the config related exception classes in
 
3322
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3323
class OptionExpansionLoop(BzrError):
 
3324
 
 
3325
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3326
 
 
3327
    def __init__(self, string, refs):
 
3328
        self.string = string
 
3329
        self.refs = '->'.join(refs)
 
3330
 
 
3331
 
 
3332
class ExpandingUnknownOption(BzrError):
 
3333
 
 
3334
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3335
 
 
3336
    def __init__(self, name, string):
 
3337
        self.name = name
 
3338
        self.string = string
 
3339
 
 
3340
 
 
3341
class NoCompatibleInter(BzrError):
 
3342
 
 
3343
    _fmt = ('No compatible object available for operations from %(source)r '
 
3344
            'to %(target)r.')
 
3345
 
 
3346
    def __init__(self, source, target):
 
3347
        self.source = source
 
3348
        self.target = target
 
3349
 
 
3350
 
 
3351
class HpssVfsRequestNotAllowed(BzrError):
 
3352
 
 
3353
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3354
            "%(method)s, %(arguments)s.")
 
3355
 
 
3356
    def __init__(self, method, arguments):
 
3357
        self.method = method
 
3358
        self.arguments = arguments
 
3359
 
 
3360
 
 
3361
class UnsupportedKindChange(BzrError):
 
3362
 
 
3363
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3364
            "%(path)s not supported by format %(format)r")
 
3365
 
 
3366
    def __init__(self, path, from_kind, to_kind, format):
 
3367
        self.path = path
 
3368
        self.from_kind = from_kind
 
3369
        self.to_kind = to_kind
 
3370
        self.format = format