~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-11-09 18:19:47 UTC
  • mfrom: (5524.2.1 noshfolder)
  • Revision ID: pqm@pqm.ubuntu.com-20101109181947-h26505clmkdhh2uz
(GaryvdM) Exclude SHFOLDER.dll from py2exe builds,
        as it breaks subvertpy.

Show diffs side-by-side

added added

removed removed

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