~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

Show diffs side-by-side

added added

removed removed

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