← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

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