~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Latest bzr.dev

Show diffs side-by-side

added added

removed removed

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