← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007 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
136
 
        # attribute if it doesn't exist.  We can't use super here, because
137
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
138
 
        # --bmc, 20060426
139
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
140
 
             'please convert %s to use BzrError instead'
141
 
             % self.__class__.__name__,
142
 
             DeprecationWarning,
143
 
             stacklevel=2)
144
 
        BzrError.__init__(self, *args)
145
 
        for key, value in kwds.items():
146
 
            setattr(self, key, value)
147
 
 
148
 
    def __str__(self):
149
 
        try:
150
 
            # __str__() should always return a 'str' object
151
 
            # never a 'unicode' object.
152
 
            s = self.__doc__ % self.__dict__
153
 
            if isinstance(s, unicode):
154
 
                return s.encode('utf8')
155
 
            return s
156
 
        except (TypeError, NameError, ValueError, KeyError), e:
157
 
            return 'Unprintable exception %s(%r): %s' \
158
 
                % (self.__class__.__name__,
159
 
                   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
160
153
 
161
154
 
162
155
class AlreadyBuilding(BzrError):
163
 
    
 
156
 
164
157
    _fmt = "The tree builder is already building a tree."
165
158
 
166
159
 
167
 
class BzrCheckError(BzrError):
168
 
    
169
 
    _fmt = "Internal check failed: %(message)s"
170
 
 
171
 
    internal_error = True
172
 
 
173
 
    def __init__(self, message):
174
 
        BzrError.__init__(self)
175
 
        self.message = message
176
 
 
177
 
 
178
 
class DisabledMethod(BzrError):
 
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):
179
187
 
180
188
    _fmt = "The smart server method '%(class_name)s' is disabled."
181
189
 
182
 
    internal_error = True
183
 
 
184
190
    def __init__(self, class_name):
185
191
        BzrError.__init__(self)
186
192
        self.class_name = class_name
187
193
 
188
194
 
189
 
class InvalidEntryName(BzrError):
190
 
    
 
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
 
191
218
    _fmt = "Invalid entry name: %(name)s"
192
219
 
193
 
    internal_error = True
194
 
 
195
220
    def __init__(self, name):
196
221
        BzrError.__init__(self)
197
222
        self.name = name
198
223
 
199
224
 
200
225
class InvalidRevisionNumber(BzrError):
201
 
    
 
226
 
202
227
    _fmt = "Invalid revision number %(revno)s"
203
228
 
204
229
    def __init__(self, revno):
216
241
        self.revision_id = revision_id
217
242
        self.branch = branch
218
243
 
 
244
 
219
245
class ReservedId(BzrError):
220
246
 
221
247
    _fmt = "Reserved revision-id {%(revision_id)s}"
223
249
    def __init__(self, revision_id):
224
250
        self.revision_id = revision_id
225
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
 
226
278
class NoSuchId(BzrError):
227
279
 
228
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
229
 
    
 
280
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
281
 
230
282
    def __init__(self, tree, file_id):
231
283
        BzrError.__init__(self)
232
284
        self.file_id = file_id
233
285
        self.tree = tree
234
286
 
235
287
 
236
 
class InventoryModified(BzrError):
 
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):
237
303
 
238
304
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
239
305
            " so a clean inventory cannot be read without data loss.")
240
306
 
241
 
    internal_error = True
242
 
 
243
307
    def __init__(self, tree):
244
308
        self.tree = tree
245
309
 
246
310
 
247
311
class NoWorkingTree(BzrError):
248
312
 
249
 
    _fmt = "No WorkingTree exists for %(base)s."
250
 
    
 
313
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
314
 
251
315
    def __init__(self, base):
252
316
        BzrError.__init__(self)
253
317
        self.base = base
266
330
        self.url = url
267
331
 
268
332
 
269
 
class WorkingTreeAlreadyPopulated(BzrError):
270
 
 
271
 
    _fmt = """Working tree already populated in %(base)s"""
272
 
 
273
 
    internal_error = True
 
333
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
334
 
 
335
    _fmt = 'Working tree already populated in "%(base)s"'
274
336
 
275
337
    def __init__(self, base):
276
338
        self.base = base
277
339
 
 
340
 
278
341
class BzrCommandError(BzrError):
279
342
    """Error from user command"""
280
343
 
281
 
    internal_error = False
282
 
 
283
344
    # Error from malformed user command; please avoid raising this as a
284
345
    # generic exception not caused by user input.
285
346
    #
287
348
    # are not intended to be caught anyway.  UI code need not subclass
288
349
    # BzrCommandError, and non-UI code should not throw a subclass of
289
350
    # BzrCommandError.  ADHB 20051211
290
 
    def __init__(self, msg):
291
 
        # Object.__str__() must return a real string
292
 
        # returning a Unicode string is a python error.
293
 
        if isinstance(msg, unicode):
294
 
            self.msg = msg.encode('utf8')
295
 
        else:
296
 
            self.msg = msg
297
 
 
298
 
    def __str__(self):
299
 
        return self.msg
300
351
 
301
352
 
302
353
class NotWriteLocked(BzrError):
312
363
    _fmt = "Error in command line options"
313
364
 
314
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
 
315
422
class BadOptionValue(BzrError):
316
423
 
317
424
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
319
426
    def __init__(self, name, value):
320
427
        BzrError.__init__(self, name=name, value=value)
321
428
 
322
 
    
 
429
 
323
430
class StrictCommitFailed(BzrError):
324
431
 
325
432
    _fmt = "Commit refused because there are unknown files in the tree"
327
434
 
328
435
# XXX: Should be unified with TransportError; they seem to represent the
329
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.'
330
441
class PathError(BzrError):
331
 
    
 
442
 
332
443
    _fmt = "Generic path error: %(path)r%(extra)s)"
333
444
 
334
445
    def __init__(self, path, extra=None):
354
465
    """Used when renaming and both source and dest exist."""
355
466
 
356
467
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
357
 
            "%(extra)s")
 
468
            " (Use --after to tell bzr about a rename that has already"
 
469
            " happened)%(extra)s")
358
470
 
359
471
    def __init__(self, source, dest, extra=None):
360
472
        BzrError.__init__(self)
368
480
 
369
481
class NotADirectory(PathError):
370
482
 
371
 
    _fmt = "%(path)r is not a directory %(extra)s"
 
483
    _fmt = '"%(path)s" is not a directory %(extra)s'
372
484
 
373
485
 
374
486
class NotInWorkingDirectory(PathError):
375
487
 
376
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
488
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
377
489
 
378
490
 
379
491
class DirectoryNotEmpty(PathError):
380
492
 
381
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
382
 
 
383
 
 
384
 
class ReadingCompleted(BzrError):
385
 
    
 
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
 
386
503
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
387
504
            "called upon it - the request has been completed and no more "
388
505
            "data may be read.")
389
506
 
390
 
    internal_error = True
391
 
 
392
507
    def __init__(self, request):
393
508
        self.request = request
394
509
 
395
510
 
396
511
class ResourceBusy(PathError):
397
512
 
398
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
513
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
399
514
 
400
515
 
401
516
class PermissionDenied(PathError):
402
517
 
403
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
518
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
404
519
 
405
520
 
406
521
class InvalidURL(PathError):
407
522
 
408
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
523
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
409
524
 
410
525
 
411
526
class InvalidURLJoin(PathError):
412
527
 
413
 
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
414
 
 
415
 
    def __init__(self, msg, base, args):
416
 
        PathError.__init__(self, base, msg)
417
 
        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
418
557
 
419
558
 
420
559
class UnknownHook(BzrError):
431
570
 
432
571
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
433
572
 
434
 
    def __init__(self, url, extra):
 
573
    def __init__(self, url, extra=""):
435
574
        PathError.__init__(self, url, extra=extra)
436
575
 
437
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
 
438
614
class ShortReadvError(PathError):
439
615
 
440
 
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
441
 
            " 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')
442
618
 
443
619
    internal_error = True
444
620
 
449
625
        self.actual = actual
450
626
 
451
627
 
452
 
class PathNotChild(BzrError):
453
 
 
454
 
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
455
 
 
456
 
    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
457
633
 
458
634
    def __init__(self, path, base, extra=None):
459
635
        BzrError.__init__(self)
467
643
 
468
644
class InvalidNormalization(PathError):
469
645
 
470
 
    _fmt = "Path %(path)r is not unicode normalized"
 
646
    _fmt = 'Path "%(path)s" is not unicode normalized'
471
647
 
472
648
 
473
649
# TODO: This is given a URL; we try to unescape it but doing that from inside
474
650
# the exception object is a bit undesirable.
475
 
# TODO: Probably this behavior of should be a common superclass 
 
651
# TODO: Probably this behavior of should be a common superclass
476
652
class NotBranchError(PathError):
477
653
 
478
 
    _fmt = "Not a branch: %(path)s"
 
654
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
479
655
 
480
 
    def __init__(self, path):
 
656
    def __init__(self, path, detail=None, bzrdir=None):
481
657
       import bzrlib.urlutils as urlutils
482
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
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)
483
692
 
484
693
 
485
694
class NoSubmitBranch(PathError):
491
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
492
701
 
493
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
494
708
class AlreadyBranchError(PathError):
495
709
 
496
 
    _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".'
497
725
 
498
726
 
499
727
class BranchExistsWithoutWorkingTree(PathError):
500
728
 
501
 
    _fmt = "Directory contains a branch, but no working tree \
502
 
(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"'
503
731
 
504
732
 
505
733
class AtomicFileAlreadyClosed(PathError):
506
734
 
507
 
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
508
 
            " %(path)s")
 
735
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
736
            ' "%(path)s"')
509
737
 
510
738
    def __init__(self, path, function):
511
739
        PathError.__init__(self, path=path, extra=None)
514
742
 
515
743
class InaccessibleParent(PathError):
516
744
 
517
 
    _fmt = ("Parent not accessible given base %(base)s and"
518
 
            " relative path %(path)s")
 
745
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
746
            ' relative path "%(path)s"')
519
747
 
520
748
    def __init__(self, path, base):
521
749
        PathError.__init__(self, path)
524
752
 
525
753
class NoRepositoryPresent(BzrError):
526
754
 
527
 
    _fmt = "No repository present: %(path)r"
 
755
    _fmt = 'No repository present: "%(path)s"'
528
756
    def __init__(self, bzrdir):
529
757
        BzrError.__init__(self)
530
758
        self.path = bzrdir.transport.clone('..').base
531
759
 
532
760
 
533
 
class FileInWrongBranch(BzrError):
534
 
 
535
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
536
 
 
537
 
    def __init__(self, branch, path):
538
 
        BzrError.__init__(self)
539
 
        self.branch = branch
540
 
        self.branch_base = branch.base
541
 
        self.path = path
542
 
 
543
 
 
544
761
class UnsupportedFormatError(BzrError):
545
762
 
546
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
547
764
 
548
765
 
549
766
class UnknownFormatError(BzrError):
550
 
    
551
 
    _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
552
773
 
553
774
 
554
775
class IncompatibleFormat(BzrError):
555
 
    
 
776
 
556
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
557
778
 
558
779
    def __init__(self, format, bzrdir_format):
561
782
        self.bzrdir = bzrdir_format
562
783
 
563
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
 
564
797
class IncompatibleRepositories(BzrError):
565
 
 
566
 
    _fmt = "Repository %(target)s is not compatible with repository"\
567
 
        " %(source)s"
568
 
 
569
 
    def __init__(self, source, target):
570
 
        BzrError.__init__(self, target=target, source=source)
 
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)
571
814
 
572
815
 
573
816
class IncompatibleRevision(BzrError):
574
 
    
 
817
 
575
818
    _fmt = "Revision is not compatible with %(repo_format)s"
576
819
 
577
820
    def __init__(self, repo_format):
582
825
class AlreadyVersionedError(BzrError):
583
826
    """Used when a path is expected not to be versioned, but it is."""
584
827
 
585
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
828
    _fmt = "%(context_info)s%(path)s is already versioned."
586
829
 
587
830
    def __init__(self, path, context_info=None):
588
831
        """Construct a new AlreadyVersionedError.
589
832
 
590
833
        :param path: This is the path which is versioned,
591
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
592
835
        :param context_info: If given, this is information about the context,
593
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
594
837
        """
595
838
        BzrError.__init__(self)
596
839
        self.path = path
603
846
class NotVersionedError(BzrError):
604
847
    """Used when a path is expected to be versioned, but it is not."""
605
848
 
606
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
849
    _fmt = "%(context_info)s%(path)s is not versioned."
607
850
 
608
851
    def __init__(self, path, context_info=None):
609
852
        """Construct a new NotVersionedError.
610
853
 
611
854
        :param path: This is the path which is not versioned,
612
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
613
856
        :param context_info: If given, this is information about the context,
614
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
615
858
        """
616
859
        BzrError.__init__(self)
617
860
        self.path = path
660
903
        BzrError.__init__(self, filename=filename, kind=kind)
661
904
 
662
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
 
915
 
 
916
 
663
917
class ForbiddenControlFileError(BzrError):
664
918
 
665
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
666
 
 
667
 
 
668
 
class LockError(BzrError):
 
919
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
920
 
 
921
 
 
922
class LockError(InternalBzrError):
669
923
 
670
924
    _fmt = "Lock error: %(msg)s"
671
925
 
672
 
    internal_error = True
673
 
 
674
926
    # All exceptions from the lock/unlock functions should be from
675
927
    # this exception class.  They will be translated as necessary. The
676
928
    # original exception is available as e.original_error
677
929
    #
678
930
    # New code should prefer to raise specific subclasses
679
 
    def __init__(self, message):
680
 
        # Python 2.5 uses a slot for StandardError.message,
681
 
        # so use a different variable name
682
 
        # so it is exposed in self.__dict__
683
 
        self.msg = message
 
931
    def __init__(self, msg):
 
932
        self.msg = msg
684
933
 
685
934
 
686
935
class LockActive(LockError):
720
969
        self.obj = obj
721
970
 
722
971
 
723
 
class ReadOnlyLockError(LockError):
724
 
 
725
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
726
 
 
727
 
    def __init__(self, fname, msg):
 
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):
728
979
        LockError.__init__(self, '')
729
 
        self.fname = fname
730
 
        self.msg = msg
 
980
        self.lock = lock
 
981
        self.why = why
731
982
 
732
983
 
733
984
class OutSideTransaction(BzrError):
757
1008
 
758
1009
class UnlockableTransport(LockError):
759
1010
 
 
1011
    internal_error = False
 
1012
 
760
1013
    _fmt = "Cannot lock: transport is read only: %(transport)s"
761
1014
 
762
1015
    def __init__(self, transport):
765
1018
 
766
1019
class LockContention(LockError):
767
1020
 
768
 
    _fmt = "Could not acquire lock %(lock)s"
769
 
    # TODO: show full url for lock, combining the transport and relative
770
 
    # bits?
 
1021
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
771
1022
 
772
1023
    internal_error = False
773
1024
 
774
 
    def __init__(self, lock):
 
1025
    def __init__(self, lock, msg=''):
775
1026
        self.lock = lock
 
1027
        self.msg = msg
776
1028
 
777
1029
 
778
1030
class LockBroken(LockError):
799
1051
        self.target = target
800
1052
 
801
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
 
802
1066
class LockNotHeld(LockError):
803
1067
 
804
1068
    _fmt = "Lock not held: %(lock)s"
809
1073
        self.lock = lock
810
1074
 
811
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
 
812
1095
class PointlessCommit(BzrError):
813
1096
 
814
1097
    _fmt = "No changes to commit"
815
1098
 
816
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
 
817
1125
class UpgradeReadonly(BzrError):
818
1126
 
819
1127
    _fmt = "Upgrade URL cannot work with readonly URLs."
833
1141
    _fmt = "Commit refused because there are unknowns in the tree."
834
1142
 
835
1143
 
836
 
class NoSuchRevision(BzrError):
837
 
 
838
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
839
 
 
840
 
    internal_error = True
 
1144
class NoSuchRevision(InternalBzrError):
 
1145
 
 
1146
    _fmt = "%(branch)s has no revision %(revision)s"
841
1147
 
842
1148
    def __init__(self, branch, revision):
 
1149
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
843
1150
        BzrError.__init__(self, branch=branch, revision=revision)
844
1151
 
845
1152
 
846
 
class NotLeftParentDescendant(BzrError):
847
 
 
848
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
849
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
850
 
 
851
 
    internal_error = True
852
 
 
853
 
    def __init__(self, branch, old_revision, new_revision):
854
 
        BzrError.__init__(self, branch_location=branch.base,
855
 
                          old_revision=old_revision,
856
 
                          new_revision=new_revision)
 
1153
class RangeInChangeOption(BzrError):
 
1154
 
 
1155
    _fmt = "Option --change does not accept revision ranges"
857
1156
 
858
1157
 
859
1158
class NoSuchRevisionSpec(BzrError):
866
1165
 
867
1166
class NoSuchRevisionInTree(NoSuchRevision):
868
1167
    """When using Tree.revision_tree, and the revision is not accessible."""
869
 
    
870
 
    _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."
871
1170
 
872
1171
    def __init__(self, tree, revision_id):
873
1172
        BzrError.__init__(self)
877
1176
 
878
1177
class InvalidRevisionSpec(BzrError):
879
1178
 
880
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
881
 
            " %(branch)s%(extra)s")
 
1179
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1180
            " %(branch_url)s%(extra)s")
882
1181
 
883
1182
    def __init__(self, spec, branch, extra=None):
884
1183
        BzrError.__init__(self, branch=branch, spec=spec)
 
1184
        self.branch_url = getattr(branch, 'user_url', str(branch))
885
1185
        if extra:
886
1186
            self.extra = '\n' + str(extra)
887
1187
        else:
888
1188
            self.extra = ''
889
1189
 
890
1190
 
891
 
class HistoryMissing(BzrError):
892
 
 
893
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
894
 
 
895
 
 
896
1191
class AppendRevisionsOnlyViolation(BzrError):
897
1192
 
898
1193
    _fmt = ('Operation denied because it would change the main history,'
908
1203
class DivergedBranches(BzrError):
909
1204
 
910
1205
    _fmt = ("These branches have diverged."
911
 
            " Use the merge command to reconcile them.")
912
 
 
913
 
    internal_error = False
 
1206
            " Use the missing command to see how.\n"
 
1207
            "Use the merge command to reconcile them.")
914
1208
 
915
1209
    def __init__(self, branch1, branch2):
916
1210
        self.branch1 = branch1
917
1211
        self.branch2 = branch2
918
1212
 
919
1213
 
920
 
class NotLefthandHistory(BzrError):
 
1214
class NotLefthandHistory(InternalBzrError):
921
1215
 
922
1216
    _fmt = "Supplied history does not follow left-hand parents"
923
1217
 
924
 
    internal_error = True
925
 
 
926
1218
    def __init__(self, history):
927
1219
        BzrError.__init__(self, history=history)
928
1220
 
932
1224
    _fmt = ("Branches have no common ancestor, and"
933
1225
            " no merge base revision was specified.")
934
1226
 
935
 
    internal_error = False
 
1227
 
 
1228
class CannotReverseCherrypick(BzrError):
 
1229
 
 
1230
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1231
            ' or diff3.')
936
1232
 
937
1233
 
938
1234
class NoCommonAncestor(BzrError):
939
 
    
 
1235
 
940
1236
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
941
1237
 
942
1238
    def __init__(self, revision_a, revision_b):
962
1258
            not_ancestor_id=not_ancestor_id)
963
1259
 
964
1260
 
965
 
class InstallFailed(BzrError):
966
 
 
967
 
    def __init__(self, revisions):
968
 
        revision_str = ", ".join(str(r) for r in revisions)
969
 
        msg = "Could not install revisions:\n%s" % revision_str
970
 
        BzrError.__init__(self, msg)
971
 
        self.revisions = revisions
972
 
 
973
 
 
974
 
class AmbiguousBase(BzrError):
975
 
 
976
 
    def __init__(self, bases):
977
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
978
 
                DeprecationWarning)
979
 
        msg = ("The correct base is unclear, because %s are all equally close"
980
 
                % ", ".join(bases))
981
 
        BzrError.__init__(self, msg)
982
 
        self.bases = bases
983
 
 
984
 
 
985
 
class NoCommits(BzrError):
 
1261
class NoCommits(BranchError):
986
1262
 
987
1263
    _fmt = "Branch %(branch)s has no commits."
988
1264
 
989
 
    def __init__(self, branch):
990
 
        BzrError.__init__(self, branch=branch)
991
 
 
992
1265
 
993
1266
class UnlistableStore(BzrError):
994
1267
 
1005
1278
 
1006
1279
class BoundBranchOutOfDate(BzrError):
1007
1280
 
1008
 
    _fmt = ("Bound branch %(branch)s is out of date"
1009
 
            " with master branch %(master)s.")
 
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1282
            " %(master)s.%(extra_help)s")
1010
1283
 
1011
1284
    def __init__(self, branch, master):
1012
1285
        BzrError.__init__(self)
1013
1286
        self.branch = branch
1014
1287
        self.master = master
1015
 
 
1016
 
        
 
1288
        self.extra_help = ''
 
1289
 
 
1290
 
1017
1291
class CommitToDoubleBoundBranch(BzrError):
1018
1292
 
1019
1293
    _fmt = ("Cannot commit to branch %(branch)s."
1049
1323
 
1050
1324
class WeaveError(BzrError):
1051
1325
 
1052
 
    _fmt = "Error in processing weave: %(message)s"
 
1326
    _fmt = "Error in processing weave: %(msg)s"
1053
1327
 
1054
 
    def __init__(self, message=None):
 
1328
    def __init__(self, msg=None):
1055
1329
        BzrError.__init__(self)
1056
 
        self.message = message
 
1330
        self.msg = msg
1057
1331
 
1058
1332
 
1059
1333
class WeaveRevisionAlreadyPresent(WeaveError):
1088
1362
 
1089
1363
class WeaveParentMismatch(WeaveError):
1090
1364
 
1091
 
    _fmt = "Parents are mismatched between two revisions."
1092
 
    
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1366
 
1093
1367
 
1094
1368
class WeaveInvalidChecksum(WeaveError):
1095
1369
 
1096
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1097
1371
 
1098
1372
 
1099
1373
class WeaveTextDiffers(WeaveError):
1121
1395
 
1122
1396
 
1123
1397
class VersionedFileError(BzrError):
1124
 
    
 
1398
 
1125
1399
    _fmt = "Versioned file error"
1126
1400
 
1127
1401
 
1128
1402
class RevisionNotPresent(VersionedFileError):
1129
 
    
1130
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1403
 
 
1404
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1131
1405
 
1132
1406
    def __init__(self, revision_id, file_id):
1133
1407
        VersionedFileError.__init__(self)
1136
1410
 
1137
1411
 
1138
1412
class RevisionAlreadyPresent(VersionedFileError):
1139
 
    
1140
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1413
 
 
1414
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1141
1415
 
1142
1416
    def __init__(self, revision_id, file_id):
1143
1417
        VersionedFileError.__init__(self)
1145
1419
        self.file_id = file_id
1146
1420
 
1147
1421
 
1148
 
class KnitError(BzrError):
1149
 
    
 
1422
class VersionedFileInvalidChecksum(VersionedFileError):
 
1423
 
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
 
1425
 
 
1426
 
 
1427
class KnitError(InternalBzrError):
 
1428
 
1150
1429
    _fmt = "Knit error"
1151
1430
 
1152
 
    internal_error = True
1153
 
 
1154
 
 
1155
 
class KnitHeaderError(KnitError):
1156
 
 
1157
 
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
1158
 
 
1159
 
    def __init__(self, badline, filename):
1160
 
        KnitError.__init__(self)
1161
 
        self.badline = badline
1162
 
        self.filename = filename
1163
 
 
1164
1431
 
1165
1432
class KnitCorrupt(KnitError):
1166
1433
 
1172
1439
        self.how = how
1173
1440
 
1174
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
 
1175
1486
class KnitIndexUnknownMethod(KnitError):
1176
1487
    """Raised when we don't understand the storage method.
1177
1488
 
1178
1489
    Currently only 'fulltext' and 'line-delta' are supported.
1179
1490
    """
1180
 
    
 
1491
 
1181
1492
    _fmt = ("Knit index %(filename)s does not have a known method"
1182
1493
            " in options: %(options)r")
1183
1494
 
1187
1498
        self.options = options
1188
1499
 
1189
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
 
1190
1548
class NoSuchExportFormat(BzrError):
1191
 
    
 
1549
 
1192
1550
    _fmt = "Export format %(format)r not supported"
1193
1551
 
1194
1552
    def __init__(self, format):
1197
1555
 
1198
1556
 
1199
1557
class TransportError(BzrError):
1200
 
    
 
1558
 
1201
1559
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1202
1560
 
1203
1561
    def __init__(self, msg=None, orig_error=None):
1212
1570
        BzrError.__init__(self)
1213
1571
 
1214
1572
 
1215
 
class TooManyConcurrentRequests(BzrError):
 
1573
class TooManyConcurrentRequests(InternalBzrError):
1216
1574
 
1217
1575
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1218
1576
            " Be sure to finish_writing and finish_reading on the"
1219
 
            " current request that is open.")
1220
 
 
1221
 
    internal_error = True
 
1577
            " currently open request.")
1222
1578
 
1223
1579
    def __init__(self, medium):
1224
1580
        self.medium = medium
1232
1588
        self.details = details
1233
1589
 
1234
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
 
1235
1622
# A set of semi-meaningful errors which can be thrown
1236
1623
class TransportNotPossible(TransportError):
1237
1624
 
1262
1649
            self.port = ':%s' % port
1263
1650
 
1264
1651
 
 
1652
# XXX: This is also used for unexpected end of file, which is different at the
 
1653
# TCP level from "connection reset".
1265
1654
class ConnectionReset(TransportError):
1266
1655
 
1267
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1268
1657
 
1269
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1270
1664
class InvalidRange(TransportError):
1271
1665
 
1272
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1273
 
    
1274
 
    def __init__(self, path, offset):
1275
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1276
 
                                       % (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)
1277
1670
        self.path = path
1278
1671
        self.offset = offset
1279
1672
 
1280
1673
 
1281
1674
class InvalidHttpResponse(TransportError):
1282
1675
 
1283
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1284
1677
 
1285
1678
    def __init__(self, path, msg, orig_error=None):
1286
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,)
1287
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1288
1687
 
1289
1688
 
 
1689
class CertificateError(TransportError):
 
1690
 
 
1691
    _fmt = "Certificate error: %(error)s"
 
1692
 
 
1693
    def __init__(self, error):
 
1694
        self.error = error
 
1695
 
 
1696
 
1290
1697
class InvalidHttpRange(InvalidHttpResponse):
1291
1698
 
1292
1699
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1293
 
    
 
1700
 
1294
1701
    def __init__(self, path, range, msg):
1295
1702
        self.range = range
1296
1703
        InvalidHttpResponse.__init__(self, path, msg)
1297
1704
 
1298
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
 
1299
1719
class InvalidHttpContentType(InvalidHttpResponse):
1300
1720
 
1301
1721
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1302
 
    
 
1722
 
1303
1723
    def __init__(self, path, ctype, msg):
1304
1724
        self.ctype = ctype
1305
1725
        InvalidHttpResponse.__init__(self, path, msg)
1309
1729
 
1310
1730
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1311
1731
 
1312
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1732
    def __init__(self, source, target, is_permanent=False):
1313
1733
        self.source = source
1314
1734
        self.target = target
1315
 
        if is_permament:
 
1735
        if is_permanent:
1316
1736
            self.permanently = ' permanently'
1317
1737
        else:
1318
1738
            self.permanently = ''
1319
 
        self.is_permament = is_permament
1320
 
        self._qualified_proto = qual_proto
1321
1739
        TransportError.__init__(self)
1322
1740
 
1323
 
    def _requalify_url(self, url):
1324
 
        """Restore the qualified proto in front of the url"""
1325
 
        # When this exception is raised, source and target are in
1326
 
        # user readable format. But some transports may use a
1327
 
        # different proto (http+urllib:// will present http:// to
1328
 
        # the user. If a qualified proto is specified, the code
1329
 
        # trapping the exception can get the qualified urls to
1330
 
        # properly handle the redirection themself (creating a
1331
 
        # new transport object from the target url for example).
1332
 
        # But checking that the scheme of the original and
1333
 
        # redirected urls are the same can be tricky. (see the
1334
 
        # FIXME in BzrDir.open_from_transport for the unique use
1335
 
        # case so far).
1336
 
        if self._qualified_proto is None:
1337
 
            return url
1338
 
 
1339
 
        # The TODO related to NotBranchError mention that doing
1340
 
        # that kind of manipulation on the urls may not be the
1341
 
        # exception object job. On the other hand, this object is
1342
 
        # the interface between the code and the user so
1343
 
        # presenting the urls in different ways is indeed its
1344
 
        # job...
1345
 
        import urlparse
1346
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1347
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1348
 
                                   query, fragment))
1349
 
 
1350
 
    def get_source_url(self):
1351
 
        return self._requalify_url(self.source)
1352
 
 
1353
 
    def get_target_url(self):
1354
 
        return self._requalify_url(self.target)
1355
 
 
1356
1741
 
1357
1742
class TooManyRedirections(TransportError):
1358
1743
 
1359
1744
    _fmt = "Too many redirections"
1360
1745
 
 
1746
 
1361
1747
class ConflictsInTree(BzrError):
1362
1748
 
1363
1749
    _fmt = "Working tree has conflicts."
1364
1750
 
1365
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
 
1366
1761
class ParseConfigError(BzrError):
1367
1762
 
 
1763
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1764
 
1368
1765
    def __init__(self, errors, filename):
1369
 
        if filename is None:
1370
 
            filename = ""
1371
 
        message = "Error(s) parsing config file %s:\n%s" % \
1372
 
            (filename, ('\n'.join(e.message for e in errors)))
1373
 
        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)
1374
1778
 
1375
1779
 
1376
1780
class NoEmailInUsername(BzrError):
1384
1788
 
1385
1789
class SigningFailed(BzrError):
1386
1790
 
1387
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1791
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1388
1792
 
1389
1793
    def __init__(self, command_line):
1390
1794
        BzrError.__init__(self, command_line=command_line)
1391
1795
 
1392
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
 
1393
1821
class WorkingTreeNotRevision(BzrError):
1394
1822
 
1395
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1823
    _fmt = ("The working tree for %(basedir)s has changed since"
1396
1824
            " the last commit, but weave merge requires that it be"
1397
1825
            " unchanged")
1398
1826
 
1415
1843
        self.graph = graph
1416
1844
 
1417
1845
 
1418
 
class WritingCompleted(BzrError):
 
1846
class WritingCompleted(InternalBzrError):
1419
1847
 
1420
1848
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1421
1849
            "called upon it - accept bytes may not be called anymore.")
1422
1850
 
1423
 
    internal_error = True
1424
 
 
1425
1851
    def __init__(self, request):
1426
1852
        self.request = request
1427
1853
 
1428
1854
 
1429
 
class WritingNotComplete(BzrError):
 
1855
class WritingNotComplete(InternalBzrError):
1430
1856
 
1431
1857
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1432
1858
            "called upon it - until the write phase is complete no "
1433
1859
            "data may be read.")
1434
1860
 
1435
 
    internal_error = True
1436
 
 
1437
1861
    def __init__(self, request):
1438
1862
        self.request = request
1439
1863
 
1447
1871
        self.filename = filename
1448
1872
 
1449
1873
 
1450
 
class MediumNotConnected(BzrError):
 
1874
class MediumNotConnected(InternalBzrError):
1451
1875
 
1452
1876
    _fmt = """The medium '%(medium)s' is not connected."""
1453
1877
 
1454
 
    internal_error = True
1455
 
 
1456
1878
    def __init__(self, medium):
1457
1879
        self.medium = medium
1458
1880
 
1464
1886
 
1465
1887
class NoBundleFound(BzrError):
1466
1888
 
1467
 
    _fmt = "No bundle was found in %(filename)s"
 
1889
    _fmt = 'No bundle was found in "%(filename)s".'
1468
1890
 
1469
1891
    def __init__(self, filename):
1470
1892
        BzrError.__init__(self)
1509
1931
    _fmt = "Key %(key)s is already present in map"
1510
1932
 
1511
1933
 
1512
 
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):
1513
1943
 
1514
1944
    _fmt = "Tree transform is malformed %(conflicts)r"
1515
1945
 
1526
1956
        self.root_trans_id = transform.root
1527
1957
 
1528
1958
 
1529
 
class BzrBadParameter(BzrError):
 
1959
class BzrBadParameter(InternalBzrError):
1530
1960
 
1531
1961
    _fmt = "Bad parameter: %(param)r"
1532
1962
 
1553
1983
    _fmt = "Moving the root directory is not supported at this time"
1554
1984
 
1555
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
 
1556
1997
class BzrMoveFailedError(BzrError):
1557
1998
 
1558
 
    _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")
1559
2001
 
1560
2002
    def __init__(self, from_path='', to_path='', extra=None):
 
2003
        from bzrlib.osutils import splitpath
1561
2004
        BzrError.__init__(self)
1562
2005
        if extra:
1563
 
            self.extra = ': ' + str(extra)
 
2006
            self.extra, self._has_extra = extra, ': '
1564
2007
        else:
1565
 
            self.extra = ''
 
2008
            self.extra = self._has_extra = ''
1566
2009
 
1567
2010
        has_from = len(from_path) > 0
1568
2011
        has_to = len(to_path) > 0
1569
2012
        if has_from:
1570
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
2013
            self.from_path = splitpath(from_path)[-1]
1571
2014
        else:
1572
2015
            self.from_path = ''
1573
2016
 
1574
2017
        if has_to:
1575
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
2018
            self.to_path = splitpath(to_path)[-1]
1576
2019
        else:
1577
2020
            self.to_path = ''
1578
2021
 
1589
2032
 
1590
2033
class BzrRenameFailedError(BzrMoveFailedError):
1591
2034
 
1592
 
    _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")
1593
2037
 
1594
2038
    def __init__(self, from_path, to_path, extra=None):
1595
2039
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1602
2046
 
1603
2047
class BzrBadParameterMissing(BzrBadParameter):
1604
2048
 
1605
 
    _fmt = "Parameter $(param)s is required but not present."
 
2049
    _fmt = "Parameter %(param)s is required but not present."
1606
2050
 
1607
2051
 
1608
2052
class BzrBadParameterUnicode(BzrBadParameter):
1616
2060
    _fmt = "Parameter %(param)s contains a newline."
1617
2061
 
1618
2062
 
1619
 
class DependencyNotPresent(BzrError):
1620
 
 
1621
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1622
 
 
1623
 
    def __init__(self, library, error):
1624
 
        BzrError.__init__(self, library=library, error=error)
1625
 
 
1626
 
 
1627
2063
class ParamikoNotPresent(DependencyNotPresent):
1628
2064
 
1629
2065
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1648
2084
 
1649
2085
class BadConversionTarget(BzrError):
1650
2086
 
1651
 
    _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"
1652
2089
 
1653
 
    def __init__(self, problem, format):
 
2090
    def __init__(self, problem, format, from_format=None):
1654
2091
        BzrError.__init__(self)
1655
2092
        self.problem = problem
1656
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)
1657
2111
 
1658
2112
 
1659
2113
class NoDiff(BzrError):
1669
2123
    _fmt = "Diff3 is not installed on this machine."
1670
2124
 
1671
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
 
1672
2132
class ExistingLimbo(BzrError):
1673
2133
 
1674
2134
    _fmt = """This tree contains left-over files from a failed operation.
1675
2135
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1676
2136
    keep, and delete it when you are done."""
1677
 
    
 
2137
 
1678
2138
    def __init__(self, limbo_dir):
1679
2139
       BzrError.__init__(self)
1680
2140
       self.limbo_dir = limbo_dir
1681
2141
 
1682
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
 
1683
2153
class ImmortalLimbo(BzrError):
1684
2154
 
1685
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2155
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1686
2156
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1687
2157
    keep, and delete it when you are done."""
1688
2158
 
1691
2161
       self.limbo_dir = limbo_dir
1692
2162
 
1693
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
 
1694
2174
class OutOfDateTree(BzrError):
1695
2175
 
1696
 
    _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"
1697
2177
 
1698
 
    def __init__(self, tree):
 
2178
    def __init__(self, tree, more=None):
 
2179
        if more is None:
 
2180
            more = ''
 
2181
        else:
 
2182
            more = ' ' + more
1699
2183
        BzrError.__init__(self)
1700
2184
        self.tree = tree
 
2185
        self.more = more
1701
2186
 
1702
2187
 
1703
2188
class PublicBranchOutOfDate(BzrError):
1723
2208
    _fmt = "Format error in conflict listings"
1724
2209
 
1725
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
 
1726
2222
class CorruptRepository(BzrError):
1727
2223
 
1728
2224
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1730
2226
 
1731
2227
    def __init__(self, repo):
1732
2228
        BzrError.__init__(self)
1733
 
        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
1734
2255
 
1735
2256
 
1736
2257
class UpgradeRequired(BzrError):
1742
2263
        self.path = path
1743
2264
 
1744
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
 
1745
2277
class LocalRequiresBoundBranch(BzrError):
1746
2278
 
1747
2279
    _fmt = "Cannot perform local-only commits on unbound branches."
1748
2280
 
1749
2281
 
1750
 
class MissingProgressBarFinish(BzrError):
1751
 
 
1752
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1753
 
 
1754
 
 
1755
 
class InvalidProgressBarType(BzrError):
1756
 
 
1757
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1758
 
            " is not a supported type Select one of: %(valid_types)s")
1759
 
 
1760
 
    def __init__(self, bar_type, valid_types):
1761
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1762
 
 
1763
 
 
1764
2282
class UnsupportedOperation(BzrError):
1765
2283
 
1766
2284
    _fmt = ("The method %(mname)s is not supported on"
1782
2300
    """
1783
2301
 
1784
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
 
2309
 
 
2310
 
1785
2311
class BinaryFile(BzrError):
1786
 
    
 
2312
 
1787
2313
    _fmt = "File is binary but should be text."
1788
2314
 
1789
2315
 
1809
2335
 
1810
2336
 
1811
2337
class NotABundle(BzrError):
1812
 
    
 
2338
 
1813
2339
    _fmt = "Not a bzr revision-bundle: %(text)r"
1814
2340
 
1815
2341
    def __init__(self, text):
1817
2343
        self.text = text
1818
2344
 
1819
2345
 
1820
 
class BadBundle(BzrError): 
1821
 
    
 
2346
class BadBundle(BzrError):
 
2347
 
1822
2348
    _fmt = "Bad bzr revision-bundle: %(text)r"
1823
2349
 
1824
2350
    def __init__(self, text):
1826
2352
        self.text = text
1827
2353
 
1828
2354
 
1829
 
class MalformedHeader(BadBundle): 
1830
 
    
 
2355
class MalformedHeader(BadBundle):
 
2356
 
1831
2357
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1832
2358
 
1833
2359
 
1834
 
class MalformedPatches(BadBundle): 
1835
 
    
 
2360
class MalformedPatches(BadBundle):
 
2361
 
1836
2362
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1837
2363
 
1838
2364
 
1839
 
class MalformedFooter(BadBundle): 
1840
 
    
 
2365
class MalformedFooter(BadBundle):
 
2366
 
1841
2367
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1842
2368
 
1843
2369
 
1844
2370
class UnsupportedEOLMarker(BadBundle):
1845
 
    
1846
 
    _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"
1847
2373
 
1848
2374
    def __init__(self):
1849
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2375
        # XXX: BadBundle's constructor assumes there's explanatory text,
1850
2376
        # but for this there is not
1851
2377
        BzrError.__init__(self)
1852
2378
 
1853
2379
 
1854
2380
class IncompatibleBundleFormat(BzrError):
1855
 
    
 
2381
 
1856
2382
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1857
2383
 
1858
2384
    def __init__(self, bundle_format, other):
1862
2388
 
1863
2389
 
1864
2390
class BadInventoryFormat(BzrError):
1865
 
    
 
2391
 
1866
2392
    _fmt = "Root class for inventory serialization errors"
1867
2393
 
1868
2394
 
1879
2405
    _fmt = """This operation requires rich root data storage"""
1880
2406
 
1881
2407
 
1882
 
class NoSmartMedium(BzrError):
 
2408
class NoSmartMedium(InternalBzrError):
1883
2409
 
1884
2410
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1885
2411
 
1886
 
    internal_error = True
1887
 
 
1888
2412
    def __init__(self, transport):
1889
2413
        self.transport = transport
1890
2414
 
1891
2415
 
1892
 
class NoSmartServer(NotBranchError):
1893
 
 
1894
 
    _fmt = "No smart server available at %(url)s"
1895
 
 
1896
 
    def __init__(self, url):
1897
 
        self.url = url
1898
 
 
1899
 
 
1900
2416
class UnknownSSH(BzrError):
1901
2417
 
1902
2418
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1912
2428
            " Please set BZR_SSH environment variable.")
1913
2429
 
1914
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
 
1915
2442
class GhostRevisionUnusableHere(BzrError):
1916
2443
 
1917
2444
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1921
2448
        self.revision_id = revision_id
1922
2449
 
1923
2450
 
1924
 
class IllegalUseOfScopeReplacer(BzrError):
 
2451
class IllegalUseOfScopeReplacer(InternalBzrError):
1925
2452
 
1926
2453
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
1927
2454
            " %(msg)s%(extra)s")
1928
2455
 
1929
 
    internal_error = True
1930
 
 
1931
2456
    def __init__(self, name, msg, extra=None):
1932
2457
        BzrError.__init__(self)
1933
2458
        self.name = name
1938
2463
            self.extra = ''
1939
2464
 
1940
2465
 
1941
 
class InvalidImportLine(BzrError):
 
2466
class InvalidImportLine(InternalBzrError):
1942
2467
 
1943
2468
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1944
2469
 
1945
 
    internal_error = True
1946
 
 
1947
2470
    def __init__(self, text, msg):
1948
2471
        BzrError.__init__(self)
1949
2472
        self.text = text
1950
2473
        self.msg = msg
1951
2474
 
1952
2475
 
1953
 
class ImportNameCollision(BzrError):
 
2476
class ImportNameCollision(InternalBzrError):
1954
2477
 
1955
2478
    _fmt = ("Tried to import an object to the same name as"
1956
2479
            " an existing object. %(name)s")
1957
2480
 
1958
 
    internal_error = True
1959
 
 
1960
2481
    def __init__(self, name):
1961
2482
        BzrError.__init__(self)
1962
2483
        self.name = name
1975
2496
        " branch location."
1976
2497
 
1977
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
 
1978
2515
class PatchMissing(BzrError):
1979
2516
    """Raise a patch type was specified but no patch supplied"""
1980
2517
 
1981
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2518
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
1982
2519
 
1983
2520
    def __init__(self, patch_type):
1984
2521
        BzrError.__init__(self)
1985
2522
        self.patch_type = patch_type
1986
2523
 
1987
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
 
1988
2538
class UnsupportedInventoryKind(BzrError):
1989
 
    
 
2539
 
1990
2540
    _fmt = """Unsupported entry kind %(kind)s"""
1991
2541
 
1992
2542
    def __init__(self, kind):
1995
2545
 
1996
2546
class BadSubsumeSource(BzrError):
1997
2547
 
1998
 
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
2548
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
1999
2549
 
2000
2550
    def __init__(self, tree, other_tree, reason):
2001
2551
        self.tree = tree
2004
2554
 
2005
2555
 
2006
2556
class SubsumeTargetNeedsUpgrade(BzrError):
2007
 
    
 
2557
 
2008
2558
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2009
2559
 
2010
2560
    def __init__(self, other_tree):
2011
2561
        self.other_tree = other_tree
2012
2562
 
2013
2563
 
2014
 
class BadReferenceTarget(BzrError):
2015
 
 
2016
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
2017
 
 
2018
 
    internal_error = True
 
2564
class BadReferenceTarget(InternalBzrError):
 
2565
 
 
2566
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2567
           "%(reason)s"
2019
2568
 
2020
2569
    def __init__(self, tree, other_tree, reason):
2021
2570
        self.tree = tree
2039
2588
    def __init__(self, branch):
2040
2589
        self.branch = branch
2041
2590
 
2042
 
        
 
2591
 
2043
2592
class TagAlreadyExists(BzrError):
2044
2593
 
2045
2594
    _fmt = "Tag %(tag_name)s already exists."
2046
2595
 
2047
2596
    def __init__(self, tag_name):
2048
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.')