~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2013-10-04 09:56:23 UTC
  • mto: (6588.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6589.
  • Revision ID: v.ladeuil+lp@free.fr-20131004095623-xlan34vg0y51gdb5
Stricter checks on configuration option names

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 InvalidBranchName(PathError):
 
714
 
 
715
    _fmt = "Invalid branch name: %(name)s"
 
716
 
 
717
    def __init__(self, name):
 
718
        BzrError.__init__(self)
 
719
        self.name = name
 
720
 
 
721
 
 
722
class ParentBranchExists(AlreadyBranchError):
 
723
 
 
724
    _fmt = 'Parent branch already exists: "%(path)s".'
475
725
 
476
726
 
477
727
class BranchExistsWithoutWorkingTree(PathError):
478
728
 
479
 
    _fmt = "Directory contains a branch, but no working tree \
480
 
(use bzr checkout if you wish to build a working tree): %(path)s"
 
729
    _fmt = 'Directory contains a branch, but no working tree \
 
730
(use bzr checkout if you wish to build a working tree): "%(path)s"'
481
731
 
482
732
 
483
733
class AtomicFileAlreadyClosed(PathError):
484
734
 
485
 
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
735
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
736
            ' "%(path)s"')
486
737
 
487
738
    def __init__(self, path, function):
488
739
        PathError.__init__(self, path=path, extra=None)
491
742
 
492
743
class InaccessibleParent(PathError):
493
744
 
494
 
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
745
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
746
            ' relative path "%(path)s"')
495
747
 
496
748
    def __init__(self, path, base):
497
749
        PathError.__init__(self, path)
500
752
 
501
753
class NoRepositoryPresent(BzrError):
502
754
 
503
 
    _fmt = "No repository present: %(path)r"
 
755
    _fmt = 'No repository present: "%(path)s"'
504
756
    def __init__(self, bzrdir):
505
757
        BzrError.__init__(self)
506
758
        self.path = bzrdir.transport.clone('..').base
507
759
 
508
760
 
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
761
class UnsupportedFormatError(BzrError):
521
 
    
522
 
    _fmt = "Unsupported branch format: %(format)s"
 
762
 
 
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
523
764
 
524
765
 
525
766
class UnknownFormatError(BzrError):
526
 
    
527
 
    _fmt = "Unknown branch format: %(format)r"
 
767
 
 
768
    _fmt = "Unknown %(kind)s format: %(format)r"
 
769
 
 
770
    def __init__(self, format, kind='branch'):
 
771
        self.kind = kind
 
772
        self.format = format
528
773
 
529
774
 
530
775
class IncompatibleFormat(BzrError):
531
 
    
 
776
 
532
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
533
778
 
534
779
    def __init__(self, format, bzrdir_format):
537
782
        self.bzrdir = bzrdir_format
538
783
 
539
784
 
 
785
class ParseFormatError(BzrError):
 
786
 
 
787
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
788
 
 
789
    def __init__(self, format, lineno, line, text):
 
790
        BzrError.__init__(self)
 
791
        self.format = format
 
792
        self.lineno = lineno
 
793
        self.line = line
 
794
        self.text = text
 
795
 
 
796
 
 
797
class IncompatibleRepositories(BzrError):
 
798
    """Report an error that two repositories are not compatible.
 
799
 
 
800
    Note that the source and target repositories are permitted to be strings:
 
801
    this exception is thrown from the smart server and may refer to a
 
802
    repository the client hasn't opened.
 
803
    """
 
804
 
 
805
    _fmt = "%(target)s\n" \
 
806
            "is not compatible with\n" \
 
807
            "%(source)s\n" \
 
808
            "%(details)s"
 
809
 
 
810
    def __init__(self, source, target, details=None):
 
811
        if details is None:
 
812
            details = "(no details)"
 
813
        BzrError.__init__(self, target=target, source=source, details=details)
 
814
 
 
815
 
540
816
class IncompatibleRevision(BzrError):
541
 
    
 
817
 
542
818
    _fmt = "Revision is not compatible with %(repo_format)s"
543
819
 
544
820
    def __init__(self, repo_format):
549
825
class AlreadyVersionedError(BzrError):
550
826
    """Used when a path is expected not to be versioned, but it is."""
551
827
 
552
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
828
    _fmt = "%(context_info)s%(path)s is already versioned."
553
829
 
554
830
    def __init__(self, path, context_info=None):
555
831
        """Construct a new AlreadyVersionedError.
556
832
 
557
833
        :param path: This is the path which is versioned,
558
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
559
835
        :param context_info: If given, this is information about the context,
560
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
561
837
        """
562
838
        BzrError.__init__(self)
563
839
        self.path = path
570
846
class NotVersionedError(BzrError):
571
847
    """Used when a path is expected to be versioned, but it is not."""
572
848
 
573
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
849
    _fmt = "%(context_info)s%(path)s is not versioned."
574
850
 
575
851
    def __init__(self, path, context_info=None):
576
852
        """Construct a new NotVersionedError.
577
853
 
578
854
        :param path: This is the path which is not versioned,
579
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
580
856
        :param context_info: If given, this is information about the context,
581
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
582
858
        """
583
859
        BzrError.__init__(self)
584
860
        self.path = path
621
897
 
622
898
class BadFileKindError(BzrError):
623
899
 
624
 
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
900
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
901
 
 
902
    def __init__(self, filename, kind):
 
903
        BzrError.__init__(self, filename=filename, kind=kind)
 
904
 
 
905
 
 
906
class BadFilenameEncoding(BzrError):
 
907
 
 
908
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
909
            ' encoding %(fs_encoding)s')
 
910
 
 
911
    def __init__(self, filename, fs_encoding):
 
912
        BzrError.__init__(self)
 
913
        self.filename = filename
 
914
        self.fs_encoding = fs_encoding
625
915
 
626
916
 
627
917
class ForbiddenControlFileError(BzrError):
628
918
 
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
 
919
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
920
 
 
921
 
 
922
class LockError(InternalBzrError):
 
923
 
 
924
    _fmt = "Lock error: %(msg)s"
637
925
 
638
926
    # All exceptions from the lock/unlock functions should be from
639
927
    # this exception class.  They will be translated as necessary. The
640
928
    # original exception is available as e.original_error
641
929
    #
642
930
    # New code should prefer to raise specific subclasses
643
 
    def __init__(self, message):
644
 
        self.message = message
 
931
    def __init__(self, msg):
 
932
        self.msg = msg
 
933
 
 
934
 
 
935
class LockActive(LockError):
 
936
 
 
937
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
938
 
 
939
    internal_error = False
 
940
 
 
941
    def __init__(self, lock_description):
 
942
        self.lock_description = lock_description
645
943
 
646
944
 
647
945
class CommitNotPossible(LockError):
664
962
 
665
963
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
666
964
 
 
965
    # TODO: There should also be an error indicating that you need a write
 
966
    # lock and don't have any lock at all... mbp 20070226
 
967
 
667
968
    def __init__(self, obj):
668
969
        self.obj = obj
669
970
 
670
971
 
 
972
class LockFailed(LockError):
 
973
 
 
974
    internal_error = False
 
975
 
 
976
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
977
 
 
978
    def __init__(self, lock, why):
 
979
        LockError.__init__(self, '')
 
980
        self.lock = lock
 
981
        self.why = why
 
982
 
 
983
 
671
984
class OutSideTransaction(BzrError):
672
985
 
673
 
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
986
    _fmt = ("A transaction related operation was attempted after"
 
987
            " the transaction finished.")
674
988
 
675
989
 
676
990
class ObjectNotLocked(LockError):
694
1008
 
695
1009
class UnlockableTransport(LockError):
696
1010
 
 
1011
    internal_error = False
 
1012
 
697
1013
    _fmt = "Cannot lock: transport is read only: %(transport)s"
698
1014
 
699
1015
    def __init__(self, transport):
702
1018
 
703
1019
class LockContention(LockError):
704
1020
 
705
 
    _fmt = "Could not acquire lock %(lock)s"
706
 
    # TODO: show full url for lock, combining the transport and relative
707
 
    # bits?
 
1021
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
708
1022
 
709
1023
    internal_error = False
710
 
    
711
 
    def __init__(self, lock):
 
1024
 
 
1025
    def __init__(self, lock, msg=''):
712
1026
        self.lock = lock
 
1027
        self.msg = msg
713
1028
 
714
1029
 
715
1030
class LockBroken(LockError):
716
1031
 
717
 
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
1032
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1033
            " - check storage consistency!")
718
1034
 
719
1035
    internal_error = False
720
1036
 
724
1040
 
725
1041
class LockBreakMismatch(LockError):
726
1042
 
727
 
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
1043
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1044
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
728
1045
 
729
1046
    internal_error = False
730
1047
 
734
1051
        self.target = target
735
1052
 
736
1053
 
 
1054
class LockCorrupt(LockError):
 
1055
 
 
1056
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1057
            "Use 'bzr break-lock' to clear it")
 
1058
 
 
1059
    internal_error = False
 
1060
 
 
1061
    def __init__(self, corruption_info, file_data=None):
 
1062
        self.corruption_info = corruption_info
 
1063
        self.file_data = file_data
 
1064
 
 
1065
 
737
1066
class LockNotHeld(LockError):
738
1067
 
739
1068
    _fmt = "Lock not held: %(lock)s"
744
1073
        self.lock = lock
745
1074
 
746
1075
 
 
1076
class TokenLockingNotSupported(LockError):
 
1077
 
 
1078
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1079
 
 
1080
    def __init__(self, obj):
 
1081
        self.obj = obj
 
1082
 
 
1083
 
 
1084
class TokenMismatch(LockBroken):
 
1085
 
 
1086
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1087
 
 
1088
    internal_error = True
 
1089
 
 
1090
    def __init__(self, given_token, lock_token):
 
1091
        self.given_token = given_token
 
1092
        self.lock_token = lock_token
 
1093
 
 
1094
 
747
1095
class PointlessCommit(BzrError):
748
1096
 
749
1097
    _fmt = "No changes to commit"
750
1098
 
751
1099
 
 
1100
class CannotCommitSelectedFileMerge(BzrError):
 
1101
 
 
1102
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1103
        ' files %(files_str)s'
 
1104
 
 
1105
    def __init__(self, files):
 
1106
        files_str = ', '.join(files)
 
1107
        BzrError.__init__(self, files=files, files_str=files_str)
 
1108
 
 
1109
 
 
1110
class ExcludesUnsupported(BzrError):
 
1111
 
 
1112
    _fmt = ('Excluding paths during commit is not supported by '
 
1113
            'repository at %(repository)r.')
 
1114
 
 
1115
    def __init__(self, repository):
 
1116
        BzrError.__init__(self, repository=repository)
 
1117
 
 
1118
 
 
1119
class BadCommitMessageEncoding(BzrError):
 
1120
 
 
1121
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1122
        'the current encoding.'
 
1123
 
 
1124
 
752
1125
class UpgradeReadonly(BzrError):
753
1126
 
754
1127
    _fmt = "Upgrade URL cannot work with readonly URLs."
768
1141
    _fmt = "Commit refused because there are unknowns in the tree."
769
1142
 
770
1143
 
771
 
class NoSuchRevision(BzrError):
772
 
 
773
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
774
 
 
775
 
    internal_error = True
 
1144
class NoSuchRevision(InternalBzrError):
 
1145
 
 
1146
    _fmt = "%(branch)s has no revision %(revision)s"
776
1147
 
777
1148
    def __init__(self, branch, revision):
 
1149
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
778
1150
        BzrError.__init__(self, branch=branch, revision=revision)
779
1151
 
780
1152
 
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)
 
1153
class RangeInChangeOption(BzrError):
 
1154
 
 
1155
    _fmt = "Option --change does not accept revision ranges"
792
1156
 
793
1157
 
794
1158
class NoSuchRevisionSpec(BzrError):
801
1165
 
802
1166
class NoSuchRevisionInTree(NoSuchRevision):
803
1167
    """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."
 
1168
 
 
1169
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
806
1170
 
807
1171
    def __init__(self, tree, revision_id):
808
1172
        BzrError.__init__(self)
812
1176
 
813
1177
class InvalidRevisionSpec(BzrError):
814
1178
 
815
 
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
1179
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1180
            " %(branch_url)s%(extra)s")
816
1181
 
817
1182
    def __init__(self, spec, branch, extra=None):
818
1183
        BzrError.__init__(self, branch=branch, spec=spec)
 
1184
        self.branch_url = getattr(branch, 'user_url', str(branch))
819
1185
        if extra:
820
1186
            self.extra = '\n' + str(extra)
821
1187
        else:
822
1188
            self.extra = ''
823
1189
 
824
1190
 
825
 
class HistoryMissing(BzrError):
826
 
 
827
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
828
 
 
829
 
 
830
1191
class AppendRevisionsOnlyViolation(BzrError):
831
1192
 
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".'
 
1193
    _fmt = ('Operation denied because it would change the main history,'
 
1194
           ' which is not permitted by the append_revisions_only setting on'
 
1195
           ' branch "%(location)s".')
835
1196
 
836
1197
    def __init__(self, location):
837
1198
       import bzrlib.urlutils as urlutils
840
1201
 
841
1202
 
842
1203
class DivergedBranches(BzrError):
843
 
    
844
 
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
845
1204
 
846
 
    internal_error = False
 
1205
    _fmt = ("These branches have diverged."
 
1206
            " Use the missing command to see how.\n"
 
1207
            "Use the merge command to reconcile them.")
847
1208
 
848
1209
    def __init__(self, branch1, branch2):
849
1210
        self.branch1 = branch1
850
1211
        self.branch2 = branch2
851
1212
 
852
1213
 
853
 
class NotLefthandHistory(BzrError):
 
1214
class NotLefthandHistory(InternalBzrError):
854
1215
 
855
1216
    _fmt = "Supplied history does not follow left-hand parents"
856
1217
 
857
 
    internal_error = True
858
 
 
859
1218
    def __init__(self, history):
860
1219
        BzrError.__init__(self, history=history)
861
1220
 
862
1221
 
863
1222
class UnrelatedBranches(BzrError):
864
1223
 
865
 
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
866
 
 
867
 
    internal_error = False
 
1224
    _fmt = ("Branches have no common ancestor, and"
 
1225
            " no merge base revision was specified.")
 
1226
 
 
1227
 
 
1228
class CannotReverseCherrypick(BzrError):
 
1229
 
 
1230
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1231
            ' or diff3.')
868
1232
 
869
1233
 
870
1234
class NoCommonAncestor(BzrError):
871
 
    
 
1235
 
872
1236
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
873
1237
 
874
1238
    def __init__(self, revision_a, revision_b):
878
1242
 
879
1243
class NoCommonRoot(BzrError):
880
1244
 
881
 
    _fmt = "Revisions are not derived from the same root: " \
882
 
           "%(revision_a)s %(revision_b)s."
 
1245
    _fmt = ("Revisions are not derived from the same root: "
 
1246
           "%(revision_a)s %(revision_b)s.")
883
1247
 
884
1248
    def __init__(self, revision_a, revision_b):
885
1249
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
894
1258
            not_ancestor_id=not_ancestor_id)
895
1259
 
896
1260
 
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):
 
1261
class NoCommits(BranchError):
918
1262
 
919
1263
    _fmt = "Branch %(branch)s has no commits."
920
1264
 
921
 
    def __init__(self, branch):
922
 
        BzrError.__init__(self, branch=branch)
923
 
 
924
1265
 
925
1266
class UnlistableStore(BzrError):
926
1267
 
937
1278
 
938
1279
class BoundBranchOutOfDate(BzrError):
939
1280
 
940
 
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1282
            " %(master)s.%(extra_help)s")
941
1283
 
942
1284
    def __init__(self, branch, master):
943
1285
        BzrError.__init__(self)
944
1286
        self.branch = branch
945
1287
        self.master = master
946
 
 
947
 
        
 
1288
        self.extra_help = ''
 
1289
 
 
1290
 
948
1291
class CommitToDoubleBoundBranch(BzrError):
949
1292
 
950
 
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
1293
    _fmt = ("Cannot commit to branch %(branch)s."
 
1294
            " It is bound to %(master)s, which is bound to %(remote)s.")
951
1295
 
952
1296
    def __init__(self, branch, master, remote):
953
1297
        BzrError.__init__(self)
967
1311
 
968
1312
class BoundBranchConnectionFailure(BzrError):
969
1313
 
970
 
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
1314
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1315
            " => %(target)s: %(error)s")
971
1316
 
972
1317
    def __init__(self, branch, target, error):
973
1318
        BzrError.__init__(self)
978
1323
 
979
1324
class WeaveError(BzrError):
980
1325
 
981
 
    _fmt = "Error in processing weave: %(message)s"
 
1326
    _fmt = "Error in processing weave: %(msg)s"
982
1327
 
983
 
    def __init__(self, message=None):
 
1328
    def __init__(self, msg=None):
984
1329
        BzrError.__init__(self)
985
 
        self.message = message
 
1330
        self.msg = msg
986
1331
 
987
1332
 
988
1333
class WeaveRevisionAlreadyPresent(WeaveError):
1017
1362
 
1018
1363
class WeaveParentMismatch(WeaveError):
1019
1364
 
1020
 
    _fmt = "Parents are mismatched between two revisions."
1021
 
    
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1366
 
1022
1367
 
1023
1368
class WeaveInvalidChecksum(WeaveError):
1024
1369
 
1025
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1026
1371
 
1027
1372
 
1028
1373
class WeaveTextDiffers(WeaveError):
1029
1374
 
1030
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1375
    _fmt = ("Weaves differ on text content. Revision:"
 
1376
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1031
1377
 
1032
1378
    def __init__(self, revision_id, weave_a, weave_b):
1033
1379
        WeaveError.__init__(self)
1038
1384
 
1039
1385
class WeaveTextDiffers(WeaveError):
1040
1386
 
1041
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1387
    _fmt = ("Weaves differ on text content. Revision:"
 
1388
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1042
1389
 
1043
1390
    def __init__(self, revision_id, weave_a, weave_b):
1044
1391
        WeaveError.__init__(self)
1048
1395
 
1049
1396
 
1050
1397
class VersionedFileError(BzrError):
1051
 
    
 
1398
 
1052
1399
    _fmt = "Versioned file error"
1053
1400
 
1054
1401
 
1055
1402
class RevisionNotPresent(VersionedFileError):
1056
 
    
1057
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1403
 
 
1404
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1058
1405
 
1059
1406
    def __init__(self, revision_id, file_id):
1060
1407
        VersionedFileError.__init__(self)
1063
1410
 
1064
1411
 
1065
1412
class RevisionAlreadyPresent(VersionedFileError):
1066
 
    
1067
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1413
 
 
1414
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1068
1415
 
1069
1416
    def __init__(self, revision_id, file_id):
1070
1417
        VersionedFileError.__init__(self)
1072
1419
        self.file_id = file_id
1073
1420
 
1074
1421
 
1075
 
class KnitError(BzrError):
1076
 
    
 
1422
class VersionedFileInvalidChecksum(VersionedFileError):
 
1423
 
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
 
1425
 
 
1426
 
 
1427
class KnitError(InternalBzrError):
 
1428
 
1077
1429
    _fmt = "Knit error"
1078
1430
 
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
1431
 
1092
1432
class KnitCorrupt(KnitError):
1093
1433
 
1099
1439
        self.how = how
1100
1440
 
1101
1441
 
 
1442
class SHA1KnitCorrupt(KnitCorrupt):
 
1443
 
 
1444
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1445
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1446
        "sha %(actual)s")
 
1447
 
 
1448
    def __init__(self, filename, actual, expected, key, content):
 
1449
        KnitError.__init__(self)
 
1450
        self.filename = filename
 
1451
        self.actual = actual
 
1452
        self.expected = expected
 
1453
        self.key = key
 
1454
        self.content = content
 
1455
 
 
1456
 
 
1457
class KnitDataStreamIncompatible(KnitError):
 
1458
    # Not raised anymore, as we can convert data streams.  In future we may
 
1459
    # need it again for more exotic cases, so we're keeping it around for now.
 
1460
 
 
1461
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1462
 
 
1463
    def __init__(self, stream_format, target_format):
 
1464
        self.stream_format = stream_format
 
1465
        self.target_format = target_format
 
1466
 
 
1467
 
 
1468
class KnitDataStreamUnknown(KnitError):
 
1469
    # Indicates a data stream we don't know how to handle.
 
1470
 
 
1471
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1472
 
 
1473
    def __init__(self, stream_format):
 
1474
        self.stream_format = stream_format
 
1475
 
 
1476
 
 
1477
class KnitHeaderError(KnitError):
 
1478
 
 
1479
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1480
 
 
1481
    def __init__(self, badline, filename):
 
1482
        KnitError.__init__(self)
 
1483
        self.badline = badline
 
1484
        self.filename = filename
 
1485
 
1102
1486
class KnitIndexUnknownMethod(KnitError):
1103
1487
    """Raised when we don't understand the storage method.
1104
1488
 
1105
1489
    Currently only 'fulltext' and 'line-delta' are supported.
1106
1490
    """
1107
 
    
 
1491
 
1108
1492
    _fmt = ("Knit index %(filename)s does not have a known method"
1109
1493
            " in options: %(options)r")
1110
1494
 
1114
1498
        self.options = options
1115
1499
 
1116
1500
 
 
1501
class RetryWithNewPacks(BzrError):
 
1502
    """Raised when we realize that the packs on disk have changed.
 
1503
 
 
1504
    This is meant as more of a signaling exception, to trap between where a
 
1505
    local error occurred and the code that can actually handle the error and
 
1506
    code that can retry appropriately.
 
1507
    """
 
1508
 
 
1509
    internal_error = True
 
1510
 
 
1511
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1512
            " %(orig_error)s")
 
1513
 
 
1514
    def __init__(self, context, reload_occurred, exc_info):
 
1515
        """create a new RetryWithNewPacks error.
 
1516
 
 
1517
        :param reload_occurred: Set to True if we know that the packs have
 
1518
            already been reloaded, and we are failing because of an in-memory
 
1519
            cache miss. If set to True then we will ignore if a reload says
 
1520
            nothing has changed, because we assume it has already reloaded. If
 
1521
            False, then a reload with nothing changed will force an error.
 
1522
        :param exc_info: The original exception traceback, so if there is a
 
1523
            problem we can raise the original error (value from sys.exc_info())
 
1524
        """
 
1525
        BzrError.__init__(self)
 
1526
        self.context = context
 
1527
        self.reload_occurred = reload_occurred
 
1528
        self.exc_info = exc_info
 
1529
        self.orig_error = exc_info[1]
 
1530
        # TODO: The global error handler should probably treat this by
 
1531
        #       raising/printing the original exception with a bit about
 
1532
        #       RetryWithNewPacks also not being caught
 
1533
 
 
1534
 
 
1535
class RetryAutopack(RetryWithNewPacks):
 
1536
    """Raised when we are autopacking and we find a missing file.
 
1537
 
 
1538
    Meant as a signaling exception, to tell the autopack code it should try
 
1539
    again.
 
1540
    """
 
1541
 
 
1542
    internal_error = True
 
1543
 
 
1544
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1545
            " context: %(context)s %(orig_error)s")
 
1546
 
 
1547
 
1117
1548
class NoSuchExportFormat(BzrError):
1118
 
    
 
1549
 
1119
1550
    _fmt = "Export format %(format)r not supported"
1120
1551
 
1121
1552
    def __init__(self, format):
1124
1555
 
1125
1556
 
1126
1557
class TransportError(BzrError):
1127
 
    
 
1558
 
1128
1559
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1129
1560
 
1130
1561
    def __init__(self, msg=None, orig_error=None):
1139
1570
        BzrError.__init__(self)
1140
1571
 
1141
1572
 
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
 
1573
class TooManyConcurrentRequests(InternalBzrError):
 
1574
 
 
1575
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1576
            " Be sure to finish_writing and finish_reading on the"
 
1577
            " currently open request.")
1149
1578
 
1150
1579
    def __init__(self, medium):
1151
1580
        self.medium = medium
1159
1588
        self.details = details
1160
1589
 
1161
1590
 
 
1591
class UnexpectedProtocolVersionMarker(TransportError):
 
1592
 
 
1593
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1594
 
 
1595
    def __init__(self, marker):
 
1596
        self.marker = marker
 
1597
 
 
1598
 
 
1599
class UnknownSmartMethod(InternalBzrError):
 
1600
 
 
1601
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1602
 
 
1603
    def __init__(self, verb):
 
1604
        self.verb = verb
 
1605
 
 
1606
 
 
1607
class SmartMessageHandlerError(InternalBzrError):
 
1608
 
 
1609
    _fmt = ("The message handler raised an exception:\n"
 
1610
            "%(traceback_text)s")
 
1611
 
 
1612
    def __init__(self, exc_info):
 
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1616
        self.exc_info = exc_info
 
1617
        traceback_strings = traceback.format_exception(
 
1618
                self.exc_type, self.exc_value, self.exc_tb)
 
1619
        self.traceback_text = ''.join(traceback_strings)
 
1620
 
 
1621
 
1162
1622
# A set of semi-meaningful errors which can be thrown
1163
1623
class TransportNotPossible(TransportError):
1164
1624
 
1189
1649
            self.port = ':%s' % port
1190
1650
 
1191
1651
 
 
1652
# XXX: This is also used for unexpected end of file, which is different at the
 
1653
# TCP level from "connection reset".
1192
1654
class ConnectionReset(TransportError):
1193
1655
 
1194
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1195
1657
 
1196
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1197
1664
class InvalidRange(TransportError):
1198
1665
 
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)))
 
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1667
 
 
1668
    def __init__(self, path, offset, msg=None):
 
1669
        TransportError.__init__(self, msg)
1204
1670
        self.path = path
1205
1671
        self.offset = offset
1206
1672
 
1207
1673
 
1208
1674
class InvalidHttpResponse(TransportError):
1209
1675
 
1210
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1211
1677
 
1212
1678
    def __init__(self, path, msg, orig_error=None):
1213
1679
        self.path = path
 
1680
        if orig_error is None:
 
1681
            orig_error = ''
 
1682
        else:
 
1683
            # This is reached for obscure and unusual errors so we want to
 
1684
            # preserve as much info as possible to ease debug.
 
1685
            orig_error = ': %r' % (orig_error,)
1214
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1215
1687
 
1216
1688
 
 
1689
class CertificateError(TransportError):
 
1690
 
 
1691
    _fmt = "Certificate error: %(error)s"
 
1692
 
 
1693
    def __init__(self, error):
 
1694
        self.error = error
 
1695
 
 
1696
 
1217
1697
class InvalidHttpRange(InvalidHttpResponse):
1218
1698
 
1219
1699
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1220
 
    
 
1700
 
1221
1701
    def __init__(self, path, range, msg):
1222
1702
        self.range = range
1223
1703
        InvalidHttpResponse.__init__(self, path, msg)
1224
1704
 
1225
1705
 
 
1706
class HttpBoundaryMissing(InvalidHttpResponse):
 
1707
    """A multipart response ends with no boundary marker.
 
1708
 
 
1709
    This is a special case caused by buggy proxies, described in
 
1710
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1711
    """
 
1712
 
 
1713
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1714
 
 
1715
    def __init__(self, path, msg):
 
1716
        InvalidHttpResponse.__init__(self, path, msg)
 
1717
 
 
1718
 
1226
1719
class InvalidHttpContentType(InvalidHttpResponse):
1227
1720
 
1228
1721
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1229
 
    
 
1722
 
1230
1723
    def __init__(self, path, ctype, msg):
1231
1724
        self.ctype = ctype
1232
1725
        InvalidHttpResponse.__init__(self, path, msg)
1233
1726
 
1234
1727
 
 
1728
class RedirectRequested(TransportError):
 
1729
 
 
1730
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1731
 
 
1732
    def __init__(self, source, target, is_permanent=False):
 
1733
        self.source = source
 
1734
        self.target = target
 
1735
        if is_permanent:
 
1736
            self.permanently = ' permanently'
 
1737
        else:
 
1738
            self.permanently = ''
 
1739
        TransportError.__init__(self)
 
1740
 
 
1741
 
 
1742
class TooManyRedirections(TransportError):
 
1743
 
 
1744
    _fmt = "Too many redirections"
 
1745
 
 
1746
 
1235
1747
class ConflictsInTree(BzrError):
1236
1748
 
1237
1749
    _fmt = "Working tree has conflicts."
1238
1750
 
1239
1751
 
 
1752
class ConfigContentError(BzrError):
 
1753
 
 
1754
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1755
 
 
1756
    def __init__(self, filename):
 
1757
        BzrError.__init__(self)
 
1758
        self.filename = filename
 
1759
 
 
1760
 
1240
1761
class ParseConfigError(BzrError):
1241
1762
 
 
1763
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1764
 
1242
1765
    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)
 
1766
        BzrError.__init__(self)
 
1767
        self.filename = filename
 
1768
        self.errors = '\n'.join(e.msg for e in errors)
 
1769
 
 
1770
 
 
1771
class ConfigOptionValueError(BzrError):
 
1772
 
 
1773
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1774
            'See ``bzr help %(name)s``')
 
1775
 
 
1776
    def __init__(self, name, value):
 
1777
        BzrError.__init__(self, name=name, value=value)
1248
1778
 
1249
1779
 
1250
1780
class NoEmailInUsername(BzrError):
1258
1788
 
1259
1789
class SigningFailed(BzrError):
1260
1790
 
1261
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1791
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1262
1792
 
1263
1793
    def __init__(self, command_line):
1264
1794
        BzrError.__init__(self, command_line=command_line)
1265
1795
 
1266
1796
 
 
1797
class SignatureVerificationFailed(BzrError):
 
1798
 
 
1799
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1800
 
 
1801
    def __init__(self, error):
 
1802
        BzrError.__init__(self, error=error)
 
1803
 
 
1804
 
 
1805
class DependencyNotPresent(BzrError):
 
1806
 
 
1807
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1808
 
 
1809
    def __init__(self, library, error):
 
1810
        BzrError.__init__(self, library=library, error=error)
 
1811
 
 
1812
 
 
1813
class GpgmeNotInstalled(DependencyNotPresent):
 
1814
 
 
1815
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1816
 
 
1817
    def __init__(self, error):
 
1818
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1819
 
 
1820
 
1267
1821
class WorkingTreeNotRevision(BzrError):
1268
1822
 
1269
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1823
    _fmt = ("The working tree for %(basedir)s has changed since"
1270
1824
            " the last commit, but weave merge requires that it be"
1271
1825
            " unchanged")
1272
1826
 
1276
1830
 
1277
1831
class CantReprocessAndShowBase(BzrError):
1278
1832
 
1279
 
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
1280
 
           "the relationship of conflicting lines to the base"
 
1833
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1834
           "the relationship of conflicting lines to the base")
1281
1835
 
1282
1836
 
1283
1837
class GraphCycleError(BzrError):
1289
1843
        self.graph = graph
1290
1844
 
1291
1845
 
1292
 
class WritingCompleted(BzrError):
 
1846
class WritingCompleted(InternalBzrError):
1293
1847
 
1294
1848
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1295
1849
            "called upon it - accept bytes may not be called anymore.")
1296
1850
 
1297
 
    internal_error = True
1298
 
 
1299
1851
    def __init__(self, request):
1300
1852
        self.request = request
1301
1853
 
1302
1854
 
1303
 
class WritingNotComplete(BzrError):
 
1855
class WritingNotComplete(InternalBzrError):
1304
1856
 
1305
1857
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1306
1858
            "called upon it - until the write phase is complete no "
1307
1859
            "data may be read.")
1308
1860
 
1309
 
    internal_error = True
1310
 
 
1311
1861
    def __init__(self, request):
1312
1862
        self.request = request
1313
1863
 
1321
1871
        self.filename = filename
1322
1872
 
1323
1873
 
1324
 
class MediumNotConnected(BzrError):
 
1874
class MediumNotConnected(InternalBzrError):
1325
1875
 
1326
1876
    _fmt = """The medium '%(medium)s' is not connected."""
1327
1877
 
1328
 
    internal_error = True
1329
 
 
1330
1878
    def __init__(self, medium):
1331
1879
        self.medium = medium
1332
1880
 
1333
1881
 
1334
1882
class MustUseDecorated(Exception):
1335
 
    
1336
 
    _fmt = """A decorating function has requested its original command be used."""
1337
 
    
 
1883
 
 
1884
    _fmt = "A decorating function has requested its original command be used."
 
1885
 
1338
1886
 
1339
1887
class NoBundleFound(BzrError):
1340
1888
 
1341
 
    _fmt = "No bundle was found in %(filename)s"
 
1889
    _fmt = 'No bundle was found in "%(filename)s".'
1342
1890
 
1343
1891
    def __init__(self, filename):
1344
1892
        BzrError.__init__(self)
1357
1905
 
1358
1906
class MissingText(BzrError):
1359
1907
 
1360
 
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1908
    _fmt = ("Branch %(base)s is missing revision"
 
1909
            " %(text_revision)s of %(file_id)s")
1361
1910
 
1362
1911
    def __init__(self, branch, text_revision, file_id):
1363
1912
        BzrError.__init__(self)
1367
1916
        self.file_id = file_id
1368
1917
 
1369
1918
 
 
1919
class DuplicateFileId(BzrError):
 
1920
 
 
1921
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1922
 
 
1923
    def __init__(self, file_id, entry):
 
1924
        BzrError.__init__(self)
 
1925
        self.file_id = file_id
 
1926
        self.entry = entry
 
1927
 
 
1928
 
1370
1929
class DuplicateKey(BzrError):
1371
1930
 
1372
1931
    _fmt = "Key %(key)s is already present in map"
1373
1932
 
1374
1933
 
1375
 
class MalformedTransform(BzrError):
 
1934
class DuplicateHelpPrefix(BzrError):
 
1935
 
 
1936
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1937
 
 
1938
    def __init__(self, prefix):
 
1939
        self.prefix = prefix
 
1940
 
 
1941
 
 
1942
class MalformedTransform(InternalBzrError):
1376
1943
 
1377
1944
    _fmt = "Tree transform is malformed %(conflicts)r"
1378
1945
 
1389
1956
        self.root_trans_id = transform.root
1390
1957
 
1391
1958
 
1392
 
class BzrBadParameter(BzrError):
 
1959
class BzrBadParameter(InternalBzrError):
1393
1960
 
1394
1961
    _fmt = "Bad parameter: %(param)r"
1395
1962
 
1416
1983
    _fmt = "Moving the root directory is not supported at this time"
1417
1984
 
1418
1985
 
 
1986
class TransformRenameFailed(BzrError):
 
1987
 
 
1988
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1989
 
 
1990
    def __init__(self, from_path, to_path, why, errno):
 
1991
        self.from_path = from_path
 
1992
        self.to_path = to_path
 
1993
        self.why = why
 
1994
        self.errno = errno
 
1995
 
 
1996
 
1419
1997
class BzrMoveFailedError(BzrError):
1420
1998
 
1421
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1999
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2000
        "%(_has_extra)s%(extra)s")
1422
2001
 
1423
2002
    def __init__(self, from_path='', to_path='', extra=None):
 
2003
        from bzrlib.osutils import splitpath
1424
2004
        BzrError.__init__(self)
1425
2005
        if extra:
1426
 
            self.extra = ': ' + str(extra)
 
2006
            self.extra, self._has_extra = extra, ': '
1427
2007
        else:
1428
 
            self.extra = ''
 
2008
            self.extra = self._has_extra = ''
1429
2009
 
1430
2010
        has_from = len(from_path) > 0
1431
2011
        has_to = len(to_path) > 0
1432
2012
        if has_from:
1433
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
2013
            self.from_path = splitpath(from_path)[-1]
1434
2014
        else:
1435
2015
            self.from_path = ''
1436
2016
 
1437
2017
        if has_to:
1438
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
2018
            self.to_path = splitpath(to_path)[-1]
1439
2019
        else:
1440
2020
            self.to_path = ''
1441
2021
 
1452
2032
 
1453
2033
class BzrRenameFailedError(BzrMoveFailedError):
1454
2034
 
1455
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2035
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2036
        "%(_has_extra)s%(extra)s")
1456
2037
 
1457
2038
    def __init__(self, from_path, to_path, extra=None):
1458
2039
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1465
2046
 
1466
2047
class BzrBadParameterMissing(BzrBadParameter):
1467
2048
 
1468
 
    _fmt = "Parameter $(param)s is required but not present."
 
2049
    _fmt = "Parameter %(param)s is required but not present."
1469
2050
 
1470
2051
 
1471
2052
class BzrBadParameterUnicode(BzrBadParameter):
1472
2053
 
1473
 
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
2054
    _fmt = ("Parameter %(param)s is unicode but"
 
2055
            " only byte-strings are permitted.")
1474
2056
 
1475
2057
 
1476
2058
class BzrBadParameterContainsNewline(BzrBadParameter):
1478
2060
    _fmt = "Parameter %(param)s contains a newline."
1479
2061
 
1480
2062
 
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
2063
class ParamikoNotPresent(DependencyNotPresent):
1490
2064
 
1491
2065
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1510
2084
 
1511
2085
class BadConversionTarget(BzrError):
1512
2086
 
1513
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2087
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2088
            "    %(problem)s"
1514
2089
 
1515
 
    def __init__(self, problem, format):
 
2090
    def __init__(self, problem, format, from_format=None):
1516
2091
        BzrError.__init__(self)
1517
2092
        self.problem = problem
1518
2093
        self.format = format
 
2094
        self.from_format = from_format or '(unspecified)'
 
2095
 
 
2096
 
 
2097
class NoDiffFound(BzrError):
 
2098
 
 
2099
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2100
 
 
2101
    def __init__(self, path):
 
2102
        BzrError.__init__(self, path)
 
2103
 
 
2104
 
 
2105
class ExecutableMissing(BzrError):
 
2106
 
 
2107
    _fmt = "%(exe_name)s could not be found on this machine"
 
2108
 
 
2109
    def __init__(self, exe_name):
 
2110
        BzrError.__init__(self, exe_name=exe_name)
1519
2111
 
1520
2112
 
1521
2113
class NoDiff(BzrError):
1531
2123
    _fmt = "Diff3 is not installed on this machine."
1532
2124
 
1533
2125
 
 
2126
class ExistingContent(BzrError):
 
2127
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2128
 
 
2129
    _fmt = "The content being inserted is already present."
 
2130
 
 
2131
 
1534
2132
class ExistingLimbo(BzrError):
1535
2133
 
1536
2134
    _fmt = """This tree contains left-over files from a failed operation.
1537
2135
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1538
2136
    keep, and delete it when you are done."""
1539
 
    
 
2137
 
1540
2138
    def __init__(self, limbo_dir):
1541
2139
       BzrError.__init__(self)
1542
2140
       self.limbo_dir = limbo_dir
1543
2141
 
1544
2142
 
 
2143
class ExistingPendingDeletion(BzrError):
 
2144
 
 
2145
    _fmt = """This tree contains left-over files from a failed operation.
 
2146
    Please examine %(pending_deletion)s to see if it contains any files you
 
2147
    wish to keep, and delete it when you are done."""
 
2148
 
 
2149
    def __init__(self, pending_deletion):
 
2150
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2151
 
 
2152
 
1545
2153
class ImmortalLimbo(BzrError):
1546
2154
 
1547
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2155
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1548
2156
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1549
2157
    keep, and delete it when you are done."""
1550
2158
 
1553
2161
       self.limbo_dir = limbo_dir
1554
2162
 
1555
2163
 
 
2164
class ImmortalPendingDeletion(BzrError):
 
2165
 
 
2166
    _fmt = ("Unable to delete transform temporary directory "
 
2167
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2168
    "contains any files you wish to keep, and delete it when you are done.")
 
2169
 
 
2170
    def __init__(self, pending_deletion):
 
2171
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2172
 
 
2173
 
1556
2174
class OutOfDateTree(BzrError):
1557
2175
 
1558
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2176
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1559
2177
 
1560
 
    def __init__(self, tree):
 
2178
    def __init__(self, tree, more=None):
 
2179
        if more is None:
 
2180
            more = ''
 
2181
        else:
 
2182
            more = ' ' + more
1561
2183
        BzrError.__init__(self)
1562
2184
        self.tree = tree
 
2185
        self.more = more
 
2186
 
 
2187
 
 
2188
class PublicBranchOutOfDate(BzrError):
 
2189
 
 
2190
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2191
        '"%(revstring)s".'
 
2192
 
 
2193
    def __init__(self, public_location, revstring):
 
2194
        import bzrlib.urlutils as urlutils
 
2195
        public_location = urlutils.unescape_for_display(public_location,
 
2196
                                                        'ascii')
 
2197
        BzrError.__init__(self, public_location=public_location,
 
2198
                          revstring=revstring)
1563
2199
 
1564
2200
 
1565
2201
class MergeModifiedFormatError(BzrError):
1572
2208
    _fmt = "Format error in conflict listings"
1573
2209
 
1574
2210
 
 
2211
class CorruptDirstate(BzrError):
 
2212
 
 
2213
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2214
            "Error: %(description)s")
 
2215
 
 
2216
    def __init__(self, dirstate_path, description):
 
2217
        BzrError.__init__(self)
 
2218
        self.dirstate_path = dirstate_path
 
2219
        self.description = description
 
2220
 
 
2221
 
1575
2222
class CorruptRepository(BzrError):
1576
2223
 
1577
 
    _fmt = """An error has been detected in the repository %(repo_path)s.
1578
 
Please run bzr reconcile on this repository."""
 
2224
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2225
            "Please run bzr reconcile on this repository.")
1579
2226
 
1580
2227
    def __init__(self, repo):
1581
2228
        BzrError.__init__(self)
1582
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2229
        self.repo_path = repo.user_url
 
2230
 
 
2231
 
 
2232
class InconsistentDelta(BzrError):
 
2233
    """Used when we get a delta that is not valid."""
 
2234
 
 
2235
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2236
            " %(file_id)r\nreason: %(reason)s")
 
2237
 
 
2238
    def __init__(self, path, file_id, reason):
 
2239
        BzrError.__init__(self)
 
2240
        self.path = path
 
2241
        self.file_id = file_id
 
2242
        self.reason = reason
 
2243
 
 
2244
 
 
2245
class InconsistentDeltaDelta(InconsistentDelta):
 
2246
    """Used when we get a delta that is not valid."""
 
2247
 
 
2248
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2249
            "\nreason: %(reason)s")
 
2250
 
 
2251
    def __init__(self, delta, reason):
 
2252
        BzrError.__init__(self)
 
2253
        self.delta = delta
 
2254
        self.reason = reason
1583
2255
 
1584
2256
 
1585
2257
class UpgradeRequired(BzrError):
1591
2263
        self.path = path
1592
2264
 
1593
2265
 
 
2266
class RepositoryUpgradeRequired(UpgradeRequired):
 
2267
 
 
2268
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2269
 
 
2270
 
 
2271
class RichRootUpgradeRequired(UpgradeRequired):
 
2272
 
 
2273
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2274
           " a format which supports rich roots.")
 
2275
 
 
2276
 
1594
2277
class LocalRequiresBoundBranch(BzrError):
1595
2278
 
1596
2279
    _fmt = "Cannot perform local-only commits on unbound branches."
1597
2280
 
1598
2281
 
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
2282
class UnsupportedOperation(BzrError):
1614
2283
 
1615
 
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
2284
    _fmt = ("The method %(mname)s is not supported on"
 
2285
            " objects of type %(tname)s.")
1616
2286
 
1617
2287
    def __init__(self, method, method_self):
1618
2288
        self.method = method
1625
2295
 
1626
2296
 
1627
2297
class NonAsciiRevisionId(UnsupportedOperation):
1628
 
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
2298
    """Raised when a commit is attempting to set a non-ascii revision id
 
2299
       but cant.
 
2300
    """
 
2301
 
 
2302
 
 
2303
class GhostTagsNotSupported(BzrError):
 
2304
 
 
2305
    _fmt = "Ghost tags not supported by format %(format)r."
 
2306
 
 
2307
    def __init__(self, format):
 
2308
        self.format = format
1629
2309
 
1630
2310
 
1631
2311
class BinaryFile(BzrError):
1632
 
    
 
2312
 
1633
2313
    _fmt = "File is binary but should be text."
1634
2314
 
1635
2315
 
1644
2324
 
1645
2325
class TestamentMismatch(BzrError):
1646
2326
 
1647
 
    _fmt = """Testament did not match expected value.  
1648
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
2327
    _fmt = """Testament did not match expected value.
 
2328
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1649
2329
       {%(measured)s}"""
1650
2330
 
1651
2331
    def __init__(self, revision_id, expected, measured):
1655
2335
 
1656
2336
 
1657
2337
class NotABundle(BzrError):
1658
 
    
 
2338
 
1659
2339
    _fmt = "Not a bzr revision-bundle: %(text)r"
1660
2340
 
1661
2341
    def __init__(self, text):
1663
2343
        self.text = text
1664
2344
 
1665
2345
 
1666
 
class BadBundle(BzrError): 
1667
 
    
 
2346
class BadBundle(BzrError):
 
2347
 
1668
2348
    _fmt = "Bad bzr revision-bundle: %(text)r"
1669
2349
 
1670
2350
    def __init__(self, text):
1672
2352
        self.text = text
1673
2353
 
1674
2354
 
1675
 
class MalformedHeader(BadBundle): 
1676
 
    
 
2355
class MalformedHeader(BadBundle):
 
2356
 
1677
2357
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1678
2358
 
1679
2359
 
1680
 
class MalformedPatches(BadBundle): 
1681
 
    
 
2360
class MalformedPatches(BadBundle):
 
2361
 
1682
2362
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1683
2363
 
1684
2364
 
1685
 
class MalformedFooter(BadBundle): 
1686
 
    
 
2365
class MalformedFooter(BadBundle):
 
2366
 
1687
2367
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1688
2368
 
1689
2369
 
1690
2370
class UnsupportedEOLMarker(BadBundle):
1691
 
    
1692
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2371
 
 
2372
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
1693
2373
 
1694
2374
    def __init__(self):
1695
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2375
        # XXX: BadBundle's constructor assumes there's explanatory text,
1696
2376
        # but for this there is not
1697
2377
        BzrError.__init__(self)
1698
2378
 
1699
2379
 
1700
2380
class IncompatibleBundleFormat(BzrError):
1701
 
    
 
2381
 
1702
2382
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1703
2383
 
1704
2384
    def __init__(self, bundle_format, other):
1708
2388
 
1709
2389
 
1710
2390
class BadInventoryFormat(BzrError):
1711
 
    
 
2391
 
1712
2392
    _fmt = "Root class for inventory serialization errors"
1713
2393
 
1714
2394
 
1720
2400
        BadInventoryFormat.__init__(self, msg=msg)
1721
2401
 
1722
2402
 
1723
 
class NoSmartMedium(BzrError):
 
2403
class RootNotRich(BzrError):
 
2404
 
 
2405
    _fmt = """This operation requires rich root data storage"""
 
2406
 
 
2407
 
 
2408
class NoSmartMedium(InternalBzrError):
1724
2409
 
1725
2410
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1726
 
    internal_error = True
1727
2411
 
1728
2412
    def __init__(self, transport):
1729
2413
        self.transport = transport
1730
2414
 
1731
2415
 
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
2416
class UnknownSSH(BzrError):
1741
2417
 
1742
2418
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1746
2422
        self.vendor = vendor
1747
2423
 
1748
2424
 
 
2425
class SSHVendorNotFound(BzrError):
 
2426
 
 
2427
    _fmt = ("Don't know how to handle SSH connections."
 
2428
            " Please set BZR_SSH environment variable.")
 
2429
 
 
2430
 
 
2431
class GhostRevisionsHaveNoRevno(BzrError):
 
2432
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2433
 
 
2434
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2435
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2436
 
 
2437
    def __init__(self, revision_id, ghost_revision_id):
 
2438
        self.revision_id = revision_id
 
2439
        self.ghost_revision_id = ghost_revision_id
 
2440
 
 
2441
 
1749
2442
class GhostRevisionUnusableHere(BzrError):
1750
2443
 
1751
2444
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1755
2448
        self.revision_id = revision_id
1756
2449
 
1757
2450
 
1758
 
class IllegalUseOfScopeReplacer(BzrError):
1759
 
 
1760
 
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
1761
 
 
1762
 
    internal_error = True
 
2451
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2452
 
 
2453
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2454
            " %(msg)s%(extra)s")
1763
2455
 
1764
2456
    def __init__(self, name, msg, extra=None):
1765
2457
        BzrError.__init__(self)
1771
2463
            self.extra = ''
1772
2464
 
1773
2465
 
1774
 
class InvalidImportLine(BzrError):
 
2466
class InvalidImportLine(InternalBzrError):
1775
2467
 
1776
2468
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1777
2469
 
1778
 
    internal_error = True
1779
 
 
1780
2470
    def __init__(self, text, msg):
1781
2471
        BzrError.__init__(self)
1782
2472
        self.text = text
1783
2473
        self.msg = msg
1784
2474
 
1785
2475
 
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
 
2476
class ImportNameCollision(InternalBzrError):
 
2477
 
 
2478
    _fmt = ("Tried to import an object to the same name as"
 
2479
            " an existing object. %(name)s")
 
2480
 
 
2481
    def __init__(self, name):
 
2482
        BzrError.__init__(self)
 
2483
        self.name = name
 
2484
 
 
2485
 
 
2486
class NotAMergeDirective(BzrError):
 
2487
    """File starting with %(firstline)r is not a merge directive"""
 
2488
    def __init__(self, firstline):
 
2489
        BzrError.__init__(self, firstline=firstline)
 
2490
 
 
2491
 
 
2492
class NoMergeSource(BzrError):
 
2493
    """Raise if no merge source was specified for a merge directive"""
 
2494
 
 
2495
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2496
        " branch location."
 
2497
 
 
2498
 
 
2499
class IllegalMergeDirectivePayload(BzrError):
 
2500
    """A merge directive contained something other than a patch or bundle"""
 
2501
 
 
2502
    _fmt = "Bad merge directive payload %(start)r"
 
2503
 
 
2504
    def __init__(self, start):
 
2505
        BzrError(self)
 
2506
        self.start = start
 
2507
 
 
2508
 
 
2509
class PatchVerificationFailed(BzrError):
 
2510
    """A patch from a merge directive could not be verified"""
 
2511
 
 
2512
    _fmt = "Preview patch does not match requested changes."
 
2513
 
 
2514
 
 
2515
class PatchMissing(BzrError):
 
2516
    """Raise a patch type was specified but no patch supplied"""
 
2517
 
 
2518
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2519
 
 
2520
    def __init__(self, patch_type):
 
2521
        BzrError.__init__(self)
 
2522
        self.patch_type = patch_type
 
2523
 
 
2524
 
 
2525
class TargetNotBranch(BzrError):
 
2526
    """A merge directive's target branch is required, but isn't a branch"""
 
2527
 
 
2528
    _fmt = ("Your branch does not have all of the revisions required in "
 
2529
            "order to merge this merge directive and the target "
 
2530
            "location specified in the merge directive is not a branch: "
 
2531
            "%(location)s.")
 
2532
 
 
2533
    def __init__(self, location):
 
2534
        BzrError.__init__(self)
 
2535
        self.location = location
 
2536
 
 
2537
 
 
2538
class UnsupportedInventoryKind(BzrError):
 
2539
 
 
2540
    _fmt = """Unsupported entry kind %(kind)s"""
 
2541
 
 
2542
    def __init__(self, kind):
 
2543
        self.kind = kind
 
2544
 
 
2545
 
 
2546
class BadSubsumeSource(BzrError):
 
2547
 
 
2548
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2549
 
 
2550
    def __init__(self, tree, other_tree, reason):
 
2551
        self.tree = tree
 
2552
        self.other_tree = other_tree
 
2553
        self.reason = reason
 
2554
 
 
2555
 
 
2556
class SubsumeTargetNeedsUpgrade(BzrError):
 
2557
 
 
2558
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2559
 
 
2560
    def __init__(self, other_tree):
 
2561
        self.other_tree = other_tree
 
2562
 
 
2563
 
 
2564
class BadReferenceTarget(InternalBzrError):
 
2565
 
 
2566
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2567
           "%(reason)s"
 
2568
 
 
2569
    def __init__(self, tree, other_tree, reason):
 
2570
        self.tree = tree
 
2571
        self.other_tree = other_tree
 
2572
        self.reason = reason
 
2573
 
 
2574
 
 
2575
class NoSuchTag(BzrError):
 
2576
 
 
2577
    _fmt = "No such tag: %(tag_name)s"
 
2578
 
 
2579
    def __init__(self, tag_name):
 
2580
        self.tag_name = tag_name
 
2581
 
 
2582
 
 
2583
class TagsNotSupported(BzrError):
 
2584
 
 
2585
    _fmt = ("Tags not supported by %(branch)s;"
 
2586
            " you may be able to use bzr upgrade.")
 
2587
 
 
2588
    def __init__(self, branch):
 
2589
        self.branch = branch
 
2590
 
 
2591
 
 
2592
class TagAlreadyExists(BzrError):
 
2593
 
 
2594
    _fmt = "Tag %(tag_name)s already exists."
 
2595
 
 
2596
    def __init__(self, tag_name):
 
2597
        self.tag_name = tag_name
 
2598
 
 
2599
 
 
2600
class MalformedBugIdentifier(BzrError):
 
2601
 
 
2602
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2603
            'See "bzr help bugs" for more information on this feature.')
 
2604
 
 
2605
    def __init__(self, bug_id, reason):
 
2606
        self.bug_id = bug_id
 
2607
        self.reason = reason
 
2608
 
 
2609
 
 
2610
class InvalidBugTrackerURL(BzrError):
 
2611
 
 
2612
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2613
            "contain {id}: %(url)s")
 
2614
 
 
2615
    def __init__(self, abbreviation, url):
 
2616
        self.abbreviation = abbreviation
 
2617
        self.url = url
 
2618
 
 
2619
 
 
2620
class UnknownBugTrackerAbbreviation(BzrError):
 
2621
 
 
2622
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2623
            "on %(branch)s")
 
2624
 
 
2625
    def __init__(self, abbreviation, branch):
 
2626
        self.abbreviation = abbreviation
 
2627
        self.branch = branch
 
2628
 
 
2629
 
 
2630
class InvalidLineInBugsProperty(BzrError):
 
2631
 
 
2632
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2633
 
 
2634
    def __init__(self, line):
 
2635
        self.line = line
 
2636
 
 
2637
 
 
2638
class InvalidBugStatus(BzrError):
 
2639
 
 
2640
    _fmt = ("Invalid bug status: '%(status)s'")
 
2641
 
 
2642
    def __init__(self, status):
 
2643
        self.status = status
 
2644
 
 
2645
 
 
2646
class UnexpectedSmartServerResponse(BzrError):
 
2647
 
 
2648
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2649
 
 
2650
    def __init__(self, response_tuple):
 
2651
        self.response_tuple = response_tuple
 
2652
 
 
2653
 
 
2654
class ErrorFromSmartServer(BzrError):
 
2655
    """An error was received from a smart server.
 
2656
 
 
2657
    :seealso: UnknownErrorFromSmartServer
 
2658
    """
 
2659
 
 
2660
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2661
 
 
2662
    internal_error = True
 
2663
 
 
2664
    def __init__(self, error_tuple):
 
2665
        self.error_tuple = error_tuple
 
2666
        try:
 
2667
            self.error_verb = error_tuple[0]
 
2668
        except IndexError:
 
2669
            self.error_verb = None
 
2670
        self.error_args = error_tuple[1:]
 
2671
 
 
2672
 
 
2673
class UnknownErrorFromSmartServer(BzrError):
 
2674
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2675
    error.
 
2676
 
 
2677
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2678
    distinguish between the following two cases:
 
2679
 
 
2680
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2681
      and so should provoke a traceback to the user.
 
2682
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2683
      translated.  This is probably because the server sent us garbage, and
 
2684
      should not provoke a traceback.
 
2685
    """
 
2686
 
 
2687
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2688
 
 
2689
    internal_error = False
 
2690
 
 
2691
    def __init__(self, error_from_smart_server):
 
2692
        """Constructor.
 
2693
 
 
2694
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2695
        """
 
2696
        self.error_from_smart_server = error_from_smart_server
 
2697
        self.error_tuple = error_from_smart_server.error_tuple
 
2698
 
 
2699
 
 
2700
class ContainerError(BzrError):
 
2701
    """Base class of container errors."""
 
2702
 
 
2703
 
 
2704
class UnknownContainerFormatError(ContainerError):
 
2705
 
 
2706
    _fmt = "Unrecognised container format: %(container_format)r"
 
2707
 
 
2708
    def __init__(self, container_format):
 
2709
        self.container_format = container_format
 
2710
 
 
2711
 
 
2712
class UnexpectedEndOfContainerError(ContainerError):
 
2713
 
 
2714
    _fmt = "Unexpected end of container stream"
 
2715
 
 
2716
 
 
2717
class UnknownRecordTypeError(ContainerError):
 
2718
 
 
2719
    _fmt = "Unknown record type: %(record_type)r"
 
2720
 
 
2721
    def __init__(self, record_type):
 
2722
        self.record_type = record_type
 
2723
 
 
2724
 
 
2725
class InvalidRecordError(ContainerError):
 
2726
 
 
2727
    _fmt = "Invalid record: %(reason)s"
 
2728
 
 
2729
    def __init__(self, reason):
 
2730
        self.reason = reason
 
2731
 
 
2732
 
 
2733
class ContainerHasExcessDataError(ContainerError):
 
2734
 
 
2735
    _fmt = "Container has data after end marker: %(excess)r"
 
2736
 
 
2737
    def __init__(self, excess):
 
2738
        self.excess = excess
 
2739
 
 
2740
 
 
2741
class DuplicateRecordNameError(ContainerError):
 
2742
 
 
2743
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2744
 
 
2745
    def __init__(self, name):
 
2746
        self.name = name.decode("utf-8")
 
2747
 
 
2748
 
 
2749
class NoDestinationAddress(InternalBzrError):
 
2750
 
 
2751
    _fmt = "Message does not have a destination address."
 
2752
 
 
2753
 
 
2754
class RepositoryDataStreamError(BzrError):
 
2755
 
 
2756
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2757
 
 
2758
    def __init__(self, reason):
 
2759
        self.reason = reason
 
2760
 
 
2761
 
 
2762
class SMTPError(BzrError):
 
2763
 
 
2764
    _fmt = "SMTP error: %(error)s"
 
2765
 
 
2766
    def __init__(self, error):
 
2767
        self.error = error
 
2768
 
 
2769
 
 
2770
class NoMessageSupplied(BzrError):
 
2771
 
 
2772
    _fmt = "No message supplied."
 
2773
 
 
2774
 
 
2775
class NoMailAddressSpecified(BzrError):
 
2776
 
 
2777
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2778
 
 
2779
 
 
2780
class MailClientNotFound(BzrError):
 
2781
 
 
2782
    _fmt = "Unable to find mail client with the following names:"\
 
2783
        " %(mail_command_list_string)s"
 
2784
 
 
2785
    def __init__(self, mail_command_list):
 
2786
        mail_command_list_string = ', '.join(mail_command_list)
 
2787
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2788
                          mail_command_list_string=mail_command_list_string)
 
2789
 
 
2790
class SMTPConnectionRefused(SMTPError):
 
2791
 
 
2792
    _fmt = "SMTP connection to %(host)s refused"
 
2793
 
 
2794
    def __init__(self, error, host):
 
2795
        self.error = error
 
2796
        self.host = host
 
2797
 
 
2798
 
 
2799
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2800
 
 
2801
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2802
 
 
2803
 
 
2804
class BzrDirError(BzrError):
 
2805
 
 
2806
    def __init__(self, bzrdir):
 
2807
        import bzrlib.urlutils as urlutils
 
2808
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2809
                                                    'ascii')
 
2810
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2811
 
 
2812
 
 
2813
class UnsyncedBranches(BzrDirError):
 
2814
 
 
2815
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2816
            " bzr help sync-for-reconfigure.")
 
2817
 
 
2818
    def __init__(self, bzrdir, target_branch):
 
2819
        BzrDirError.__init__(self, bzrdir)
 
2820
        import bzrlib.urlutils as urlutils
 
2821
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2822
                                                        'ascii')
 
2823
 
 
2824
 
 
2825
class AlreadyBranch(BzrDirError):
 
2826
 
 
2827
    _fmt = "'%(display_url)s' is already a branch."
 
2828
 
 
2829
 
 
2830
class AlreadyTree(BzrDirError):
 
2831
 
 
2832
    _fmt = "'%(display_url)s' is already a tree."
 
2833
 
 
2834
 
 
2835
class AlreadyCheckout(BzrDirError):
 
2836
 
 
2837
    _fmt = "'%(display_url)s' is already a checkout."
 
2838
 
 
2839
 
 
2840
class AlreadyLightweightCheckout(BzrDirError):
 
2841
 
 
2842
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2843
 
 
2844
 
 
2845
class AlreadyUsingShared(BzrDirError):
 
2846
 
 
2847
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2848
 
 
2849
 
 
2850
class AlreadyStandalone(BzrDirError):
 
2851
 
 
2852
    _fmt = "'%(display_url)s' is already standalone."
 
2853
 
 
2854
 
 
2855
class AlreadyWithTrees(BzrDirError):
 
2856
 
 
2857
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2858
            "working trees.")
 
2859
 
 
2860
 
 
2861
class AlreadyWithNoTrees(BzrDirError):
 
2862
 
 
2863
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2864
            "working trees.")
 
2865
 
 
2866
 
 
2867
class ReconfigurationNotSupported(BzrDirError):
 
2868
 
 
2869
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2870
 
 
2871
 
 
2872
class NoBindLocation(BzrDirError):
 
2873
 
 
2874
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2875
 
 
2876
 
 
2877
class UncommittedChanges(BzrError):
 
2878
 
 
2879
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2880
            ' (See bzr status).%(more)s')
 
2881
 
 
2882
    def __init__(self, tree, more=None):
 
2883
        if more is None:
 
2884
            more = ''
 
2885
        else:
 
2886
            more = ' ' + more
 
2887
        import bzrlib.urlutils as urlutils
 
2888
        user_url = getattr(tree, "user_url", None)
 
2889
        if user_url is None:
 
2890
            display_url = str(tree)
 
2891
        else:
 
2892
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2893
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2894
 
 
2895
 
 
2896
class StoringUncommittedNotSupported(BzrError):
 
2897
 
 
2898
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2899
            ' changes.')
 
2900
 
 
2901
    def __init__(self, branch):
 
2902
        import bzrlib.urlutils as urlutils
 
2903
        user_url = getattr(branch, "user_url", None)
 
2904
        if user_url is None:
 
2905
            display_url = str(branch)
 
2906
        else:
 
2907
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2908
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2909
 
 
2910
 
 
2911
class ShelvedChanges(UncommittedChanges):
 
2912
 
 
2913
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2914
            ' (See bzr shelve --list).%(more)s')
 
2915
 
 
2916
 
 
2917
class MissingTemplateVariable(BzrError):
 
2918
 
 
2919
    _fmt = 'Variable {%(name)s} is not available.'
 
2920
 
 
2921
    def __init__(self, name):
 
2922
        self.name = name
 
2923
 
 
2924
 
 
2925
class NoTemplate(BzrError):
 
2926
 
 
2927
    _fmt = 'No template specified.'
 
2928
 
 
2929
 
 
2930
class UnableCreateSymlink(BzrError):
 
2931
 
 
2932
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2933
 
 
2934
    def __init__(self, path=None):
 
2935
        path_str = ''
 
2936
        if path:
 
2937
            try:
 
2938
                path_str = repr(str(path))
 
2939
            except UnicodeEncodeError:
 
2940
                path_str = repr(path)
 
2941
            path_str += ' '
 
2942
        self.path_str = path_str
 
2943
 
 
2944
 
 
2945
class UnsupportedTimezoneFormat(BzrError):
 
2946
 
 
2947
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2948
            'options are "utc", "original", "local".')
 
2949
 
 
2950
    def __init__(self, timezone):
 
2951
        self.timezone = timezone
 
2952
 
 
2953
 
 
2954
class CommandAvailableInPlugin(StandardError):
 
2955
 
 
2956
    internal_error = False
 
2957
 
 
2958
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2959
 
 
2960
        self.plugin_metadata = plugin_metadata
 
2961
        self.cmd_name = cmd_name
 
2962
        self.provider = provider
 
2963
 
 
2964
    def __str__(self):
 
2965
 
 
2966
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2967
                'However, the following official plugin provides this command: %s\n'
 
2968
                'You can install it by going to: %s'
 
2969
                % (self.cmd_name, self.plugin_metadata['name'],
 
2970
                    self.plugin_metadata['url']))
 
2971
 
 
2972
        return _fmt
 
2973
 
 
2974
 
 
2975
class NoPluginAvailable(BzrError):
 
2976
    pass
 
2977
 
 
2978
 
 
2979
class UnableEncodePath(BzrError):
 
2980
 
 
2981
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2982
            'user encoding %(user_encoding)s')
 
2983
 
 
2984
    def __init__(self, path, kind):
 
2985
        from bzrlib.osutils import get_user_encoding
 
2986
        self.path = path
 
2987
        self.kind = kind
 
2988
        self.user_encoding = get_user_encoding()
 
2989
 
 
2990
 
 
2991
class NoSuchConfig(BzrError):
 
2992
 
 
2993
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2994
 
 
2995
    def __init__(self, config_id):
 
2996
        BzrError.__init__(self, config_id=config_id)
 
2997
 
 
2998
 
 
2999
class NoSuchConfigOption(BzrError):
 
3000
 
 
3001
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
3002
 
 
3003
    def __init__(self, option_name):
 
3004
        BzrError.__init__(self, option_name=option_name)
 
3005
 
 
3006
 
 
3007
class NoSuchAlias(BzrError):
 
3008
 
 
3009
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
3010
 
 
3011
    def __init__(self, alias_name):
 
3012
        BzrError.__init__(self, alias_name=alias_name)
 
3013
 
 
3014
 
 
3015
class DirectoryLookupFailure(BzrError):
 
3016
    """Base type for lookup errors."""
 
3017
 
 
3018
    pass
 
3019
 
 
3020
 
 
3021
class InvalidLocationAlias(DirectoryLookupFailure):
 
3022
 
 
3023
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
3024
 
 
3025
    def __init__(self, alias_name):
 
3026
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
3027
 
 
3028
 
 
3029
class UnsetLocationAlias(DirectoryLookupFailure):
 
3030
 
 
3031
    _fmt = 'No %(alias_name)s location assigned.'
 
3032
 
 
3033
    def __init__(self, alias_name):
 
3034
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
3035
 
 
3036
 
 
3037
class CannotBindAddress(BzrError):
 
3038
 
 
3039
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
3040
 
 
3041
    def __init__(self, host, port, orig_error):
 
3042
        # nb: in python2.4 socket.error doesn't have a useful repr
 
3043
        BzrError.__init__(self, host=host, port=port,
 
3044
            orig_error=repr(orig_error.args))
 
3045
 
 
3046
 
 
3047
class UnknownRules(BzrError):
 
3048
 
 
3049
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
3050
 
 
3051
    def __init__(self, unknowns):
 
3052
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
3053
 
 
3054
 
 
3055
class TipChangeRejected(BzrError):
 
3056
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3057
    explicitly abort a change to a branch tip.
 
3058
    """
 
3059
 
 
3060
    _fmt = u"Tip change rejected: %(msg)s"
 
3061
 
 
3062
    def __init__(self, msg):
 
3063
        self.msg = msg
 
3064
 
 
3065
 
 
3066
class ShelfCorrupt(BzrError):
 
3067
 
 
3068
    _fmt = "Shelf corrupt."
 
3069
 
 
3070
 
 
3071
class DecompressCorruption(BzrError):
 
3072
 
 
3073
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3074
 
 
3075
    def __init__(self, orig_error=None):
 
3076
        if orig_error is not None:
 
3077
            self.orig_error = ", %s" % (orig_error,)
 
3078
        else:
 
3079
            self.orig_error = ""
 
3080
        BzrError.__init__(self)
 
3081
 
 
3082
 
 
3083
class NoSuchShelfId(BzrError):
 
3084
 
 
3085
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3086
 
 
3087
    def __init__(self, shelf_id):
 
3088
        BzrError.__init__(self, shelf_id=shelf_id)
 
3089
 
 
3090
 
 
3091
class InvalidShelfId(BzrError):
 
3092
 
 
3093
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3094
 
 
3095
    def __init__(self, invalid_id):
 
3096
        BzrError.__init__(self, invalid_id=invalid_id)
 
3097
 
 
3098
 
 
3099
class JailBreak(BzrError):
 
3100
 
 
3101
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3102
 
 
3103
    def __init__(self, url):
 
3104
        BzrError.__init__(self, url=url)
 
3105
 
 
3106
 
 
3107
class UserAbort(BzrError):
 
3108
 
 
3109
    _fmt = 'The user aborted the operation.'
 
3110
 
 
3111
 
 
3112
class MustHaveWorkingTree(BzrError):
 
3113
 
 
3114
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3115
 
 
3116
    def __init__(self, format, url):
 
3117
        BzrError.__init__(self, format=format, url=url)
 
3118
 
 
3119
 
 
3120
class NoSuchView(BzrError):
 
3121
    """A view does not exist.
 
3122
    """
 
3123
 
 
3124
    _fmt = u"No such view: %(view_name)s."
 
3125
 
 
3126
    def __init__(self, view_name):
 
3127
        self.view_name = view_name
 
3128
 
 
3129
 
 
3130
class ViewsNotSupported(BzrError):
 
3131
    """Views are not supported by a tree format.
 
3132
    """
 
3133
 
 
3134
    _fmt = ("Views are not supported by %(tree)s;"
 
3135
            " use 'bzr upgrade' to change your tree to a later format.")
 
3136
 
 
3137
    def __init__(self, tree):
 
3138
        self.tree = tree
 
3139
 
 
3140
 
 
3141
class FileOutsideView(BzrError):
 
3142
 
 
3143
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3144
            '%(view_str)s')
 
3145
 
 
3146
    def __init__(self, file_name, view_files):
 
3147
        self.file_name = file_name
 
3148
        self.view_str = ", ".join(view_files)
 
3149
 
 
3150
 
 
3151
class UnresumableWriteGroup(BzrError):
 
3152
 
 
3153
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3154
            "%(write_groups)r: %(reason)s")
 
3155
 
 
3156
    internal_error = True
 
3157
 
 
3158
    def __init__(self, repository, write_groups, reason):
 
3159
        self.repository = repository
 
3160
        self.write_groups = write_groups
 
3161
        self.reason = reason
 
3162
 
 
3163
 
 
3164
class UnsuspendableWriteGroup(BzrError):
 
3165
 
 
3166
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3167
 
 
3168
    internal_error = True
 
3169
 
 
3170
    def __init__(self, repository):
 
3171
        self.repository = repository
 
3172
 
 
3173
 
 
3174
class LossyPushToSameVCS(BzrError):
 
3175
 
 
3176
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3177
            "%(target_branch)r that are in the same VCS.")
 
3178
 
 
3179
    internal_error = True
 
3180
 
 
3181
    def __init__(self, source_branch, target_branch):
 
3182
        self.source_branch = source_branch
 
3183
        self.target_branch = target_branch
 
3184
 
 
3185
 
 
3186
class NoRoundtrippingSupport(BzrError):
 
3187
 
 
3188
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3189
            "%(target_branch)r.")
 
3190
 
 
3191
    internal_error = True
 
3192
 
 
3193
    def __init__(self, source_branch, target_branch):
 
3194
        self.source_branch = source_branch
 
3195
        self.target_branch = target_branch
 
3196
 
 
3197
 
 
3198
class FileTimestampUnavailable(BzrError):
 
3199
 
 
3200
    _fmt = "The filestamp for %(path)s is not available."
 
3201
 
 
3202
    internal_error = True
 
3203
 
 
3204
    def __init__(self, path):
 
3205
        self.path = path
 
3206
 
 
3207
 
 
3208
class NoColocatedBranchSupport(BzrError):
 
3209
 
 
3210
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3211
 
 
3212
    def __init__(self, bzrdir):
 
3213
        self.bzrdir = bzrdir
 
3214
 
 
3215
 
 
3216
class NoWhoami(BzrError):
 
3217
 
 
3218
    _fmt = ('Unable to determine your name.\n'
 
3219
        "Please, set your name with the 'whoami' command.\n"
 
3220
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3221
 
 
3222
 
 
3223
class InvalidPattern(BzrError):
 
3224
 
 
3225
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3226
 
 
3227
    def __init__(self, msg):
 
3228
        self.msg = msg
 
3229
 
 
3230
 
 
3231
class RecursiveBind(BzrError):
 
3232
 
 
3233
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3234
        'Please use `bzr unbind` to fix.')
 
3235
 
 
3236
    def __init__(self, branch_url):
 
3237
        self.branch_url = branch_url
 
3238
 
 
3239
 
 
3240
# FIXME: I would prefer to define the config related exception classes in
 
3241
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3242
class OptionExpansionLoop(BzrError):
 
3243
 
 
3244
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3245
 
 
3246
    def __init__(self, string, refs):
 
3247
        self.string = string
 
3248
        self.refs = '->'.join(refs)
 
3249
 
 
3250
 
 
3251
class ExpandingUnknownOption(BzrError):
 
3252
 
 
3253
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
 
3254
 
 
3255
    def __init__(self, name, string):
 
3256
        self.name = name
 
3257
        self.string = string
 
3258
 
 
3259
 
 
3260
class IllegalOptionName(BzrError):
 
3261
 
 
3262
    _fmt = 'Option "%(name)s" is not allowed.'
 
3263
 
 
3264
    def __init__(self, name):
 
3265
        self.name = name
 
3266
 
 
3267
 
 
3268
class NoCompatibleInter(BzrError):
 
3269
 
 
3270
    _fmt = ('No compatible object available for operations from %(source)r '
 
3271
            'to %(target)r.')
 
3272
 
 
3273
    def __init__(self, source, target):
 
3274
        self.source = source
 
3275
        self.target = target
 
3276
 
 
3277
 
 
3278
class HpssVfsRequestNotAllowed(BzrError):
 
3279
 
 
3280
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3281
            "%(method)s, %(arguments)s.")
 
3282
 
 
3283
    def __init__(self, method, arguments):
 
3284
        self.method = method
 
3285
        self.arguments = arguments
 
3286
 
 
3287
 
 
3288
class UnsupportedKindChange(BzrError):
 
3289
 
 
3290
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3291
            "%(path)s not supported by format %(format)r")
 
3292
 
 
3293
    def __init__(self, path, from_kind, to_kind, format):
 
3294
        self.path = path
 
3295
        self.from_kind = from_kind
 
3296
        self.to_kind = to_kind
 
3297
        self.format = format
 
3298
 
 
3299
 
 
3300
class MissingFeature(BzrError):
 
3301
 
 
3302
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3303
            "version of Bazaar or any plugin.")
 
3304
 
 
3305
    def __init__(self, feature):
 
3306
        self.feature = feature
 
3307
 
 
3308
 
 
3309
class PatchSyntax(BzrError):
 
3310
    """Base class for patch syntax errors."""
 
3311
 
 
3312
 
 
3313
class BinaryFiles(BzrError):
 
3314
 
 
3315
    _fmt = 'Binary files section encountered.'
 
3316
 
 
3317
    def __init__(self, orig_name, mod_name):
 
3318
        self.orig_name = orig_name
 
3319
        self.mod_name = mod_name
 
3320
 
 
3321
 
 
3322
class MalformedPatchHeader(PatchSyntax):
 
3323
 
 
3324
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3325
 
 
3326
    def __init__(self, desc, line):
 
3327
        self.desc = desc
 
3328
        self.line = line
 
3329
 
 
3330
 
 
3331
class MalformedHunkHeader(PatchSyntax):
 
3332
 
 
3333
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3334
 
 
3335
    def __init__(self, desc, line):
 
3336
        self.desc = desc
 
3337
        self.line = line
 
3338
 
 
3339
 
 
3340
class MalformedLine(PatchSyntax):
 
3341
 
 
3342
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3343
 
 
3344
    def __init__(self, desc, line):
 
3345
        self.desc = desc
 
3346
        self.line = line
 
3347
 
 
3348
 
 
3349
class PatchConflict(BzrError):
 
3350
 
 
3351
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3352
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3353
 
 
3354
    def __init__(self, line_no, orig_line, patch_line):
 
3355
        self.line_no = line_no
 
3356
        self.orig_line = orig_line.rstrip('\n')
 
3357
        self.patch_line = patch_line.rstrip('\n')
 
3358
 
 
3359
 
 
3360
class FeatureAlreadyRegistered(BzrError):
 
3361
 
 
3362
    _fmt = 'The feature %(feature)s has already been registered.'
 
3363
 
 
3364
    def __init__(self, feature):
 
3365
        self.feature = feature
 
3366
 
 
3367
 
 
3368
class ChangesAlreadyStored(BzrCommandError):
 
3369
 
 
3370
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
3371
            ' stores uncommitted changes.')