~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

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