~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-10-13 07:04:50 UTC
  • mfrom: (5447.2.2 work)
  • Revision ID: pqm@pqm.ubuntu.com-20101013070450-xmn9cpnli5qnmrt8
(vila) Tweak the release process based on ML discussion (Vincent Ladeuil)

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