← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-06-18 03:33:56 UTC
  • mfrom: (2527.1.1 breakin)
  • Revision ID: pqm@pqm.ubuntu.com-20070618033356-q24jtmuwbf03ojvd
Fix race in test_breakin_harder that can cause test suite hang.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
 
20
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
43
44
# 'unprintable'.
44
45
 
45
46
 
46
 
# return codes from the bzr program
47
 
EXIT_OK = 0
48
 
EXIT_ERROR = 3
49
 
EXIT_INTERNAL_ERROR = 4
50
 
 
51
 
 
52
47
class BzrError(StandardError):
53
48
    """
54
49
    Base class for errors raised by bzrlib.
55
50
 
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
 
51
    :cvar internal_error: if true (or absent) this was probably caused by a
 
52
    bzr bug and should be displayed with a traceback; if False this was
58
53
    probably a user or environment error and they don't need the gory details.
59
54
    (That can be overridden by -Derror on the command line.)
60
55
 
61
56
    :cvar _fmt: Format string to display the error; this is expanded
62
57
    by the instance's dict.
63
58
    """
64
 
 
 
59
    
65
60
    internal_error = False
66
61
 
67
62
    def __init__(self, msg=None, **kwds):
72
67
        arguments can be given.  The first is for generic "user" errors which
73
68
        are not intended to be caught and so do not need a specific subclass.
74
69
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
70
        string to print the arguments.  
76
71
 
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
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
73
        be inserted into the format string template.  It's recommended 
 
74
        that subclasses override the __init__ method to require specific 
80
75
        parameters.
81
76
 
82
77
        :param msg: If given, this is the literal complete text for the error,
83
 
           not subject to expansion. 'msg' is used instead of 'message' because
84
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        not subject to expansion.
85
79
        """
86
80
        StandardError.__init__(self)
87
81
        if msg is not None:
93
87
            for key, value in kwds.items():
94
88
                setattr(self, key, value)
95
89
 
96
 
    def _format(self):
 
90
    def __str__(self):
97
91
        s = getattr(self, '_preformatted_string', None)
98
92
        if s is not None:
99
 
            # contains a preformatted message
100
 
            return s
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
101
95
        try:
102
96
            fmt = self._get_format_string()
103
97
            if fmt:
104
 
                d = dict(self.__dict__)
105
 
                s = fmt % d
 
98
                s = fmt % self.__dict__
106
99
                # __str__() should always return a 'str' object
107
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
108
103
                return s
109
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
113
108
                   getattr(self, '_fmt', None),
114
109
                   e)
115
110
 
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))
138
 
 
139
111
    def _get_format_string(self):
140
112
        """Return format string for this exception or None"""
141
113
        fmt = getattr(self, '_fmt', None)
153
125
               getattr(self, '_fmt', None),
154
126
               )
155
127
 
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
 
 
172
128
 
173
129
class BzrNewError(BzrError):
174
130
    """Deprecated error base class."""
204
160
 
205
161
 
206
162
class AlreadyBuilding(BzrError):
207
 
 
 
163
    
208
164
    _fmt = "The tree builder is already building a tree."
209
165
 
210
166
 
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):
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class DisabledMethod(BzrError):
238
179
 
239
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
240
181
 
 
182
    internal_error = True
 
183
 
241
184
    def __init__(self, class_name):
242
185
        BzrError.__init__(self)
243
186
        self.class_name = class_name
244
187
 
245
188
 
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
 
 
 
189
class InvalidEntryName(BzrError):
 
190
    
269
191
    _fmt = "Invalid entry name: %(name)s"
270
192
 
 
193
    internal_error = True
 
194
 
271
195
    def __init__(self, name):
272
196
        BzrError.__init__(self)
273
197
        self.name = name
274
198
 
275
199
 
276
200
class InvalidRevisionNumber(BzrError):
277
 
 
 
201
    
278
202
    _fmt = "Invalid revision number %(revno)s"
279
203
 
280
204
    def __init__(self, revno):
292
216
        self.revision_id = revision_id
293
217
        self.branch = branch
294
218
 
295
 
 
296
219
class ReservedId(BzrError):
297
220
 
298
221
    _fmt = "Reserved revision-id {%(revision_id)s}"
301
224
        self.revision_id = revision_id
302
225
 
303
226
 
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
227
class NoHelpTopic(BzrError):
321
228
 
322
229
    _fmt = ("No help could be found for '%(topic)s'. "
328
235
 
329
236
class NoSuchId(BzrError):
330
237
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
238
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
239
    
333
240
    def __init__(self, tree, file_id):
334
241
        BzrError.__init__(self)
335
242
        self.file_id = file_id
336
243
        self.tree = tree
337
244
 
338
245
 
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):
 
246
class InventoryModified(BzrError):
354
247
 
355
248
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
249
            " so a clean inventory cannot be read without data loss.")
357
250
 
 
251
    internal_error = True
 
252
 
358
253
    def __init__(self, tree):
359
254
        self.tree = tree
360
255
 
361
256
 
362
257
class NoWorkingTree(BzrError):
363
258
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
259
    _fmt = "No WorkingTree exists for %(base)s."
 
260
    
366
261
    def __init__(self, base):
367
262
        BzrError.__init__(self)
368
263
        self.base = base
381
276
        self.url = url
382
277
 
383
278
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
279
class WorkingTreeAlreadyPopulated(BzrError):
 
280
 
 
281
    _fmt = """Working tree already populated in %(base)s"""
 
282
 
 
283
    internal_error = True
387
284
 
388
285
    def __init__(self, base):
389
286
        self.base = base
390
287
 
391
 
 
392
288
class BzrCommandError(BzrError):
393
289
    """Error from user command"""
394
290
 
 
291
    internal_error = False
 
292
 
395
293
    # Error from malformed user command; please avoid raising this as a
396
294
    # generic exception not caused by user input.
397
295
    #
399
297
    # are not intended to be caught anyway.  UI code need not subclass
400
298
    # BzrCommandError, and non-UI code should not throw a subclass of
401
299
    # BzrCommandError.  ADHB 20051211
 
300
    def __init__(self, msg):
 
301
        # Object.__str__() must return a real string
 
302
        # returning a Unicode string is a python error.
 
303
        if isinstance(msg, unicode):
 
304
            self.msg = msg.encode('utf8')
 
305
        else:
 
306
            self.msg = msg
 
307
 
 
308
    def __str__(self):
 
309
        return self.msg
402
310
 
403
311
 
404
312
class NotWriteLocked(BzrError):
414
322
    _fmt = "Error in command line options"
415
323
 
416
324
 
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
325
class BadOptionValue(BzrError):
474
326
 
475
327
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
477
329
    def __init__(self, name, value):
478
330
        BzrError.__init__(self, name=name, value=value)
479
331
 
480
 
 
 
332
    
481
333
class StrictCommitFailed(BzrError):
482
334
 
483
335
    _fmt = "Commit refused because there are unknown files in the tree"
485
337
 
486
338
# XXX: Should be unified with TransportError; they seem to represent the
487
339
# 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.'
492
340
class PathError(BzrError):
493
 
 
 
341
    
494
342
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
343
 
496
344
    def __init__(self, path, extra=None):
516
364
    """Used when renaming and both source and dest exist."""
517
365
 
518
366
    _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")
 
367
            "%(extra)s")
521
368
 
522
369
    def __init__(self, source, dest, extra=None):
523
370
        BzrError.__init__(self)
531
378
 
532
379
class NotADirectory(PathError):
533
380
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
381
    _fmt = "%(path)r is not a directory %(extra)s"
535
382
 
536
383
 
537
384
class NotInWorkingDirectory(PathError):
538
385
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
386
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
387
 
541
388
 
542
389
class DirectoryNotEmpty(PathError):
543
390
 
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
 
 
 
391
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
392
 
 
393
 
 
394
class ReadingCompleted(BzrError):
 
395
    
554
396
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
397
            "called upon it - the request has been completed and no more "
556
398
            "data may be read.")
557
399
 
 
400
    internal_error = True
 
401
 
558
402
    def __init__(self, request):
559
403
        self.request = request
560
404
 
561
405
 
562
406
class ResourceBusy(PathError):
563
407
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
408
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
409
 
566
410
 
567
411
class PermissionDenied(PathError):
568
412
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
413
    _fmt = "Permission denied: %(path)r%(extra)s"
570
414
 
571
415
 
572
416
class InvalidURL(PathError):
573
417
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
418
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
419
 
576
420
 
577
421
class InvalidURLJoin(PathError):
578
422
 
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
 
423
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
424
 
 
425
    def __init__(self, msg, base, args):
 
426
        PathError.__init__(self, base, msg)
 
427
        self.args = [base] + list(args)
608
428
 
609
429
 
610
430
class UnknownHook(BzrError):
625
445
        PathError.__init__(self, url, extra=extra)
626
446
 
627
447
 
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
 
 
665
448
class ShortReadvError(PathError):
666
449
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
450
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
451
            " at %(offset)s for %(path)s%(extra)s")
669
452
 
670
453
    internal_error = True
671
454
 
676
459
        self.actual = actual
677
460
 
678
461
 
679
 
class PathNotChild(PathError):
 
462
class PathNotChild(BzrError):
680
463
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
464
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
682
465
 
683
466
    internal_error = True
684
467
 
694
477
 
695
478
class InvalidNormalization(PathError):
696
479
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
480
    _fmt = "Path %(path)r is not unicode normalized"
698
481
 
699
482
 
700
483
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
484
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
485
# TODO: Probably this behavior of should be a common superclass 
703
486
class NotBranchError(PathError):
704
487
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
488
    _fmt = "Not a branch: %(path)s"
706
489
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
490
    def __init__(self, path):
708
491
       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)
 
492
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
493
 
732
494
 
733
495
class NoSubmitBranch(PathError):
741
503
 
742
504
class AlreadyBranchError(PathError):
743
505
 
744
 
    _fmt = 'Already a branch: "%(path)s".'
 
506
    _fmt = "Already a branch: %(path)s."
745
507
 
746
508
 
747
509
class BranchExistsWithoutWorkingTree(PathError):
748
510
 
749
 
    _fmt = 'Directory contains a branch, but no working tree \
750
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
511
    _fmt = "Directory contains a branch, but no working tree \
 
512
(use bzr checkout if you wish to build a working tree): %(path)s"
751
513
 
752
514
 
753
515
class AtomicFileAlreadyClosed(PathError):
754
516
 
755
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
756
 
            ' "%(path)s"')
 
517
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
518
            " %(path)s")
757
519
 
758
520
    def __init__(self, path, function):
759
521
        PathError.__init__(self, path=path, extra=None)
762
524
 
763
525
class InaccessibleParent(PathError):
764
526
 
765
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
766
 
            ' relative path "%(path)s"')
 
527
    _fmt = ("Parent not accessible given base %(base)s and"
 
528
            " relative path %(path)s")
767
529
 
768
530
    def __init__(self, path, base):
769
531
        PathError.__init__(self, path)
772
534
 
773
535
class NoRepositoryPresent(BzrError):
774
536
 
775
 
    _fmt = 'No repository present: "%(path)s"'
 
537
    _fmt = "No repository present: %(path)r"
776
538
    def __init__(self, bzrdir):
777
539
        BzrError.__init__(self)
778
540
        self.path = bzrdir.transport.clone('..').base
780
542
 
781
543
class FileInWrongBranch(BzrError):
782
544
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
545
    _fmt = "File %(path)s in not in branch %(branch_base)s."
784
546
 
785
547
    def __init__(self, branch, path):
786
548
        BzrError.__init__(self)
795
557
 
796
558
 
797
559
class UnknownFormatError(BzrError):
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
 
560
    
 
561
    _fmt = "Unknown branch format: %(format)r"
804
562
 
805
563
 
806
564
class IncompatibleFormat(BzrError):
807
 
 
 
565
    
808
566
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
567
 
810
568
    def __init__(self, format, bzrdir_format):
814
572
 
815
573
 
816
574
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)
 
575
 
 
576
    _fmt = "Repository %(target)s is not compatible with repository"\
 
577
        " %(source)s"
 
578
 
 
579
    def __init__(self, source, target):
 
580
        BzrError.__init__(self, target=target, source=source)
833
581
 
834
582
 
835
583
class IncompatibleRevision(BzrError):
836
 
 
 
584
    
837
585
    _fmt = "Revision is not compatible with %(repo_format)s"
838
586
 
839
587
    def __init__(self, repo_format):
844
592
class AlreadyVersionedError(BzrError):
845
593
    """Used when a path is expected not to be versioned, but it is."""
846
594
 
847
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
595
    _fmt = "%(context_info)s%(path)s is already versioned"
848
596
 
849
597
    def __init__(self, path, context_info=None):
850
598
        """Construct a new AlreadyVersionedError.
865
613
class NotVersionedError(BzrError):
866
614
    """Used when a path is expected to be versioned, but it is not."""
867
615
 
868
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
616
    _fmt = "%(context_info)s%(path)s is not versioned"
869
617
 
870
618
    def __init__(self, path, context_info=None):
871
619
        """Construct a new NotVersionedError.
922
670
        BzrError.__init__(self, filename=filename, kind=kind)
923
671
 
924
672
 
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
934
 
 
935
 
 
936
673
class ForbiddenControlFileError(BzrError):
937
674
 
938
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
939
 
 
940
 
 
941
 
class LockError(InternalBzrError):
 
675
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
676
 
 
677
 
 
678
class LockError(BzrError):
942
679
 
943
680
    _fmt = "Lock error: %(msg)s"
944
681
 
 
682
    internal_error = True
 
683
 
945
684
    # All exceptions from the lock/unlock functions should be from
946
685
    # this exception class.  They will be translated as necessary. The
947
686
    # original exception is available as e.original_error
949
688
    # New code should prefer to raise specific subclasses
950
689
    def __init__(self, message):
951
690
        # 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.
 
691
        # so use a different variable name
 
692
        # so it is exposed in self.__dict__
954
693
        self.msg = message
955
694
 
956
695
 
991
730
        self.obj = obj
992
731
 
993
732
 
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):
 
733
class ReadOnlyLockError(LockError):
 
734
 
 
735
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
736
 
 
737
    def __init__(self, fname, msg):
1001
738
        LockError.__init__(self, '')
1002
 
        self.lock = lock
1003
 
        self.why = why
 
739
        self.fname = fname
 
740
        self.msg = msg
1004
741
 
1005
742
 
1006
743
class OutSideTransaction(BzrError):
1030
767
 
1031
768
class UnlockableTransport(LockError):
1032
769
 
1033
 
    internal_error = False
1034
 
 
1035
770
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1036
771
 
1037
772
    def __init__(self, transport):
1040
775
 
1041
776
class LockContention(LockError):
1042
777
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
778
    _fmt = "Could not acquire lock %(lock)s"
1044
779
    # TODO: show full url for lock, combining the transport and relative
1045
780
    # bits?
1046
781
 
1047
782
    internal_error = False
1048
783
 
1049
 
    def __init__(self, lock, msg=''):
 
784
    def __init__(self, lock):
1050
785
        self.lock = lock
1051
 
        self.msg = msg
1052
786
 
1053
787
 
1054
788
class LockBroken(LockError):
1089
823
 
1090
824
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1091
825
 
 
826
    internal_error = True
 
827
 
1092
828
    def __init__(self, obj):
1093
829
        self.obj = obj
1094
830
 
1119
855
        BzrError.__init__(self, files=files, files_str=files_str)
1120
856
 
1121
857
 
1122
 
class BadCommitMessageEncoding(BzrError):
1123
 
 
1124
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1125
 
        'the current encoding.'
1126
 
 
1127
 
 
1128
858
class UpgradeReadonly(BzrError):
1129
859
 
1130
860
    _fmt = "Upgrade URL cannot work with readonly URLs."
1144
874
    _fmt = "Commit refused because there are unknowns in the tree."
1145
875
 
1146
876
 
1147
 
class NoSuchRevision(InternalBzrError):
1148
 
 
1149
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
877
class NoSuchRevision(BzrError):
 
878
 
 
879
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
880
 
 
881
    internal_error = True
1150
882
 
1151
883
    def __init__(self, branch, revision):
1152
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1153
884
        BzrError.__init__(self, branch=branch, revision=revision)
1154
885
 
1155
886
 
1156
 
class RangeInChangeOption(BzrError):
1157
 
 
1158
 
    _fmt = "Option --change does not accept revision ranges"
 
887
class NotLeftParentDescendant(BzrError):
 
888
 
 
889
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
890
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
891
 
 
892
    internal_error = True
 
893
 
 
894
    def __init__(self, branch, old_revision, new_revision):
 
895
        BzrError.__init__(self, branch_location=branch.base,
 
896
                          old_revision=old_revision,
 
897
                          new_revision=new_revision)
1159
898
 
1160
899
 
1161
900
class NoSuchRevisionSpec(BzrError):
1168
907
 
1169
908
class NoSuchRevisionInTree(NoSuchRevision):
1170
909
    """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."
 
910
    
 
911
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1173
912
 
1174
913
    def __init__(self, tree, revision_id):
1175
914
        BzrError.__init__(self)
1210
949
class DivergedBranches(BzrError):
1211
950
 
1212
951
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
952
            " Use the merge command to reconcile them.")
 
953
 
 
954
    internal_error = False
1215
955
 
1216
956
    def __init__(self, branch1, branch2):
1217
957
        self.branch1 = branch1
1218
958
        self.branch2 = branch2
1219
959
 
1220
960
 
1221
 
class NotLefthandHistory(InternalBzrError):
 
961
class NotLefthandHistory(BzrError):
1222
962
 
1223
963
    _fmt = "Supplied history does not follow left-hand parents"
1224
964
 
 
965
    internal_error = True
 
966
 
1225
967
    def __init__(self, history):
1226
968
        BzrError.__init__(self, history=history)
1227
969
 
1231
973
    _fmt = ("Branches have no common ancestor, and"
1232
974
            " no merge base revision was specified.")
1233
975
 
1234
 
 
1235
 
class CannotReverseCherrypick(BzrError):
1236
 
 
1237
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1238
 
            ' or diff3.')
 
976
    internal_error = False
1239
977
 
1240
978
 
1241
979
class NoCommonAncestor(BzrError):
1242
 
 
 
980
    
1243
981
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
982
 
1245
983
    def __init__(self, revision_a, revision_b):
1265
1003
            not_ancestor_id=not_ancestor_id)
1266
1004
 
1267
1005
 
 
1006
class InstallFailed(BzrError):
 
1007
 
 
1008
    def __init__(self, revisions):
 
1009
        revision_str = ", ".join(str(r) for r in revisions)
 
1010
        msg = "Could not install revisions:\n%s" % revision_str
 
1011
        BzrError.__init__(self, msg)
 
1012
        self.revisions = revisions
 
1013
 
 
1014
 
1268
1015
class AmbiguousBase(BzrError):
1269
1016
 
1270
1017
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1018
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1019
                DeprecationWarning)
1273
1020
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1021
                % ", ".join(bases))
1275
1022
        BzrError.__init__(self, msg)
1276
1023
        self.bases = bases
1277
1024
 
1278
1025
 
1279
 
class NoCommits(BranchError):
 
1026
class NoCommits(BzrError):
1280
1027
 
1281
1028
    _fmt = "Branch %(branch)s has no commits."
1282
1029
 
 
1030
    def __init__(self, branch):
 
1031
        BzrError.__init__(self, branch=branch)
 
1032
 
1283
1033
 
1284
1034
class UnlistableStore(BzrError):
1285
1035
 
1296
1046
 
1297
1047
class BoundBranchOutOfDate(BzrError):
1298
1048
 
1299
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.")
 
1049
    _fmt = ("Bound branch %(branch)s is out of date"
 
1050
            " with master branch %(master)s.")
1301
1051
 
1302
1052
    def __init__(self, branch, master):
1303
1053
        BzrError.__init__(self)
1304
1054
        self.branch = branch
1305
1055
        self.master = master
1306
1056
 
1307
 
 
 
1057
        
1308
1058
class CommitToDoubleBoundBranch(BzrError):
1309
1059
 
1310
1060
    _fmt = ("Cannot commit to branch %(branch)s."
1340
1090
 
1341
1091
class WeaveError(BzrError):
1342
1092
 
1343
 
    _fmt = "Error in processing weave: %(msg)s"
 
1093
    _fmt = "Error in processing weave: %(message)s"
1344
1094
 
1345
 
    def __init__(self, msg=None):
 
1095
    def __init__(self, message=None):
1346
1096
        BzrError.__init__(self)
1347
 
        self.msg = msg
 
1097
        self.message = message
1348
1098
 
1349
1099
 
1350
1100
class WeaveRevisionAlreadyPresent(WeaveError):
1379
1129
 
1380
1130
class WeaveParentMismatch(WeaveError):
1381
1131
 
1382
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1383
 
 
 
1132
    _fmt = "Parents are mismatched between two revisions."
 
1133
    
1384
1134
 
1385
1135
class WeaveInvalidChecksum(WeaveError):
1386
1136
 
1412
1162
 
1413
1163
 
1414
1164
class VersionedFileError(BzrError):
1415
 
 
 
1165
    
1416
1166
    _fmt = "Versioned file error"
1417
1167
 
1418
1168
 
1419
1169
class RevisionNotPresent(VersionedFileError):
1420
 
 
1421
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1170
    
 
1171
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1422
1172
 
1423
1173
    def __init__(self, revision_id, file_id):
1424
1174
        VersionedFileError.__init__(self)
1427
1177
 
1428
1178
 
1429
1179
class RevisionAlreadyPresent(VersionedFileError):
1430
 
 
1431
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1180
    
 
1181
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1432
1182
 
1433
1183
    def __init__(self, revision_id, file_id):
1434
1184
        VersionedFileError.__init__(self)
1436
1186
        self.file_id = file_id
1437
1187
 
1438
1188
 
1439
 
class VersionedFileInvalidChecksum(VersionedFileError):
1440
 
 
1441
 
    _fmt = "Text did not match its checksum: %(message)s"
1442
 
 
1443
 
 
1444
 
class KnitError(InternalBzrError):
1445
 
 
 
1189
class KnitError(BzrError):
 
1190
    
1446
1191
    _fmt = "Knit error"
1447
1192
 
 
1193
    internal_error = True
 
1194
 
 
1195
 
 
1196
class KnitHeaderError(KnitError):
 
1197
 
 
1198
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1199
 
 
1200
    def __init__(self, badline, filename):
 
1201
        KnitError.__init__(self)
 
1202
        self.badline = badline
 
1203
        self.filename = filename
 
1204
 
1448
1205
 
1449
1206
class KnitCorrupt(KnitError):
1450
1207
 
1456
1213
        self.how = how
1457
1214
 
1458
1215
 
1459
 
class SHA1KnitCorrupt(KnitCorrupt):
1460
 
 
1461
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1462
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1463
 
        "sha %(actual)s")
1464
 
 
1465
 
    def __init__(self, filename, actual, expected, key, content):
1466
 
        KnitError.__init__(self)
1467
 
        self.filename = filename
1468
 
        self.actual = actual
1469
 
        self.expected = expected
1470
 
        self.key = key
1471
 
        self.content = content
1472
 
 
1473
 
 
1474
 
class KnitDataStreamIncompatible(KnitError):
1475
 
    # Not raised anymore, as we can convert data streams.  In future we may
1476
 
    # need it again for more exotic cases, so we're keeping it around for now.
1477
 
 
1478
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1479
 
 
1480
 
    def __init__(self, stream_format, target_format):
1481
 
        self.stream_format = stream_format
1482
 
        self.target_format = target_format
1483
 
 
1484
 
 
1485
 
class KnitDataStreamUnknown(KnitError):
1486
 
    # Indicates a data stream we don't know how to handle.
1487
 
 
1488
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1489
 
 
1490
 
    def __init__(self, stream_format):
1491
 
        self.stream_format = stream_format
1492
 
 
1493
 
 
1494
 
class KnitHeaderError(KnitError):
1495
 
 
1496
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1497
 
 
1498
 
    def __init__(self, badline, filename):
1499
 
        KnitError.__init__(self)
1500
 
        self.badline = badline
1501
 
        self.filename = filename
1502
 
 
1503
1216
class KnitIndexUnknownMethod(KnitError):
1504
1217
    """Raised when we don't understand the storage method.
1505
1218
 
1506
1219
    Currently only 'fulltext' and 'line-delta' are supported.
1507
1220
    """
1508
 
 
 
1221
    
1509
1222
    _fmt = ("Knit index %(filename)s does not have a known method"
1510
1223
            " in options: %(options)r")
1511
1224
 
1515
1228
        self.options = options
1516
1229
 
1517
1230
 
1518
 
class RetryWithNewPacks(BzrError):
1519
 
    """Raised when we realize that the packs on disk have changed.
1520
 
 
1521
 
    This is meant as more of a signaling exception, to trap between where a
1522
 
    local error occurred and the code that can actually handle the error and
1523
 
    code that can retry appropriately.
1524
 
    """
1525
 
 
1526
 
    internal_error = True
1527
 
 
1528
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1529
 
            " %(orig_error)s")
1530
 
 
1531
 
    def __init__(self, context, reload_occurred, exc_info):
1532
 
        """create a new RetryWithNewPacks error.
1533
 
 
1534
 
        :param reload_occurred: Set to True if we know that the packs have
1535
 
            already been reloaded, and we are failing because of an in-memory
1536
 
            cache miss. If set to True then we will ignore if a reload says
1537
 
            nothing has changed, because we assume it has already reloaded. If
1538
 
            False, then a reload with nothing changed will force an error.
1539
 
        :param exc_info: The original exception traceback, so if there is a
1540
 
            problem we can raise the original error (value from sys.exc_info())
1541
 
        """
1542
 
        BzrError.__init__(self)
1543
 
        self.reload_occurred = reload_occurred
1544
 
        self.exc_info = exc_info
1545
 
        self.orig_error = exc_info[1]
1546
 
        # TODO: The global error handler should probably treat this by
1547
 
        #       raising/printing the original exception with a bit about
1548
 
        #       RetryWithNewPacks also not being caught
1549
 
 
1550
 
 
1551
 
class RetryAutopack(RetryWithNewPacks):
1552
 
    """Raised when we are autopacking and we find a missing file.
1553
 
 
1554
 
    Meant as a signaling exception, to tell the autopack code it should try
1555
 
    again.
1556
 
    """
1557
 
 
1558
 
    internal_error = True
1559
 
 
1560
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1561
 
            " context: %(context)s %(orig_error)s")
1562
 
 
1563
 
 
1564
1231
class NoSuchExportFormat(BzrError):
1565
 
 
 
1232
    
1566
1233
    _fmt = "Export format %(format)r not supported"
1567
1234
 
1568
1235
    def __init__(self, format):
1571
1238
 
1572
1239
 
1573
1240
class TransportError(BzrError):
1574
 
 
 
1241
    
1575
1242
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1576
1243
 
1577
1244
    def __init__(self, msg=None, orig_error=None):
1586
1253
        BzrError.__init__(self)
1587
1254
 
1588
1255
 
1589
 
class TooManyConcurrentRequests(InternalBzrError):
 
1256
class TooManyConcurrentRequests(BzrError):
1590
1257
 
1591
1258
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1592
1259
            " Be sure to finish_writing and finish_reading on the"
1593
1260
            " currently open request.")
1594
1261
 
 
1262
    internal_error = True
 
1263
 
1595
1264
    def __init__(self, medium):
1596
1265
        self.medium = medium
1597
1266
 
1604
1273
        self.details = details
1605
1274
 
1606
1275
 
1607
 
class UnexpectedProtocolVersionMarker(TransportError):
1608
 
 
1609
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1610
 
 
1611
 
    def __init__(self, marker):
1612
 
        self.marker = marker
1613
 
 
1614
 
 
1615
 
class UnknownSmartMethod(InternalBzrError):
1616
 
 
1617
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1618
 
 
1619
 
    def __init__(self, verb):
1620
 
        self.verb = verb
1621
 
 
1622
 
 
1623
 
class SmartMessageHandlerError(InternalBzrError):
1624
 
 
1625
 
    _fmt = ("The message handler raised an exception:\n"
1626
 
            "%(traceback_text)s")
1627
 
 
1628
 
    def __init__(self, exc_info):
1629
 
        import traceback
1630
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1631
 
        self.exc_info = exc_info
1632
 
        traceback_strings = traceback.format_exception(
1633
 
                self.exc_type, self.exc_value, self.exc_tb)
1634
 
        self.traceback_text = ''.join(traceback_strings)
1635
 
 
1636
 
 
1637
1276
# A set of semi-meaningful errors which can be thrown
1638
1277
class TransportNotPossible(TransportError):
1639
1278
 
1664
1303
            self.port = ':%s' % port
1665
1304
 
1666
1305
 
1667
 
# XXX: This is also used for unexpected end of file, which is different at the
1668
 
# TCP level from "connection reset".
1669
1306
class ConnectionReset(TransportError):
1670
1307
 
1671
1308
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1673
1310
 
1674
1311
class InvalidRange(TransportError):
1675
1312
 
1676
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1677
 
 
1678
 
    def __init__(self, path, offset, msg=None):
1679
 
        TransportError.__init__(self, msg)
 
1313
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1314
    
 
1315
    def __init__(self, path, offset):
 
1316
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1317
                                       % (path, offset)))
1680
1318
        self.path = path
1681
1319
        self.offset = offset
1682
1320
 
1693
1331
class InvalidHttpRange(InvalidHttpResponse):
1694
1332
 
1695
1333
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1696
 
 
 
1334
    
1697
1335
    def __init__(self, path, range, msg):
1698
1336
        self.range = range
1699
1337
        InvalidHttpResponse.__init__(self, path, msg)
1702
1340
class InvalidHttpContentType(InvalidHttpResponse):
1703
1341
 
1704
1342
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1705
 
 
 
1343
    
1706
1344
    def __init__(self, path, ctype, msg):
1707
1345
        self.ctype = ctype
1708
1346
        InvalidHttpResponse.__init__(self, path, msg)
1712
1350
 
1713
1351
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1714
1352
 
1715
 
    def __init__(self, source, target, is_permanent=False):
 
1353
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1716
1354
        self.source = source
1717
1355
        self.target = target
1718
 
        if is_permanent:
 
1356
        if is_permament:
1719
1357
            self.permanently = ' permanently'
1720
1358
        else:
1721
1359
            self.permanently = ''
 
1360
        self.is_permament = is_permament
 
1361
        self._qualified_proto = qual_proto
1722
1362
        TransportError.__init__(self)
1723
1363
 
 
1364
    def _requalify_url(self, url):
 
1365
        """Restore the qualified proto in front of the url"""
 
1366
        # When this exception is raised, source and target are in
 
1367
        # user readable format. But some transports may use a
 
1368
        # different proto (http+urllib:// will present http:// to
 
1369
        # the user. If a qualified proto is specified, the code
 
1370
        # trapping the exception can get the qualified urls to
 
1371
        # properly handle the redirection themself (creating a
 
1372
        # new transport object from the target url for example).
 
1373
        # But checking that the scheme of the original and
 
1374
        # redirected urls are the same can be tricky. (see the
 
1375
        # FIXME in BzrDir.open_from_transport for the unique use
 
1376
        # case so far).
 
1377
        if self._qualified_proto is None:
 
1378
            return url
 
1379
 
 
1380
        # The TODO related to NotBranchError mention that doing
 
1381
        # that kind of manipulation on the urls may not be the
 
1382
        # exception object job. On the other hand, this object is
 
1383
        # the interface between the code and the user so
 
1384
        # presenting the urls in different ways is indeed its
 
1385
        # job...
 
1386
        import urlparse
 
1387
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1388
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1389
                                   query, fragment))
 
1390
 
 
1391
    def get_source_url(self):
 
1392
        return self._requalify_url(self.source)
 
1393
 
 
1394
    def get_target_url(self):
 
1395
        return self._requalify_url(self.target)
 
1396
 
1724
1397
 
1725
1398
class TooManyRedirections(TransportError):
1726
1399
 
1727
1400
    _fmt = "Too many redirections"
1728
1401
 
1729
 
 
1730
1402
class ConflictsInTree(BzrError):
1731
1403
 
1732
1404
    _fmt = "Working tree has conflicts."
1738
1410
        if filename is None:
1739
1411
            filename = ""
1740
1412
        message = "Error(s) parsing config file %s:\n%s" % \
1741
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1413
            (filename, ('\n'.join(e.message for e in errors)))
1742
1414
        BzrError.__init__(self, message)
1743
1415
 
1744
1416
 
1753
1425
 
1754
1426
class SigningFailed(BzrError):
1755
1427
 
1756
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1428
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1757
1429
 
1758
1430
    def __init__(self, command_line):
1759
1431
        BzrError.__init__(self, command_line=command_line)
1761
1433
 
1762
1434
class WorkingTreeNotRevision(BzrError):
1763
1435
 
1764
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1436
    _fmt = ("The working tree for %(basedir)s has changed since" 
1765
1437
            " the last commit, but weave merge requires that it be"
1766
1438
            " unchanged")
1767
1439
 
1784
1456
        self.graph = graph
1785
1457
 
1786
1458
 
1787
 
class WritingCompleted(InternalBzrError):
 
1459
class WritingCompleted(BzrError):
1788
1460
 
1789
1461
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1790
1462
            "called upon it - accept bytes may not be called anymore.")
1791
1463
 
 
1464
    internal_error = True
 
1465
 
1792
1466
    def __init__(self, request):
1793
1467
        self.request = request
1794
1468
 
1795
1469
 
1796
 
class WritingNotComplete(InternalBzrError):
 
1470
class WritingNotComplete(BzrError):
1797
1471
 
1798
1472
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1799
1473
            "called upon it - until the write phase is complete no "
1800
1474
            "data may be read.")
1801
1475
 
 
1476
    internal_error = True
 
1477
 
1802
1478
    def __init__(self, request):
1803
1479
        self.request = request
1804
1480
 
1812
1488
        self.filename = filename
1813
1489
 
1814
1490
 
1815
 
class MediumNotConnected(InternalBzrError):
 
1491
class MediumNotConnected(BzrError):
1816
1492
 
1817
1493
    _fmt = """The medium '%(medium)s' is not connected."""
1818
1494
 
 
1495
    internal_error = True
 
1496
 
1819
1497
    def __init__(self, medium):
1820
1498
        self.medium = medium
1821
1499
 
1827
1505
 
1828
1506
class NoBundleFound(BzrError):
1829
1507
 
1830
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1508
    _fmt = "No bundle was found in %(filename)s"
1831
1509
 
1832
1510
    def __init__(self, filename):
1833
1511
        BzrError.__init__(self)
1897
1575
        self.root_trans_id = transform.root
1898
1576
 
1899
1577
 
1900
 
class BzrBadParameter(InternalBzrError):
 
1578
class BzrBadParameter(BzrError):
1901
1579
 
1902
1580
    _fmt = "Bad parameter: %(param)r"
1903
1581
 
1929
1607
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1930
1608
 
1931
1609
    def __init__(self, from_path='', to_path='', extra=None):
1932
 
        from bzrlib.osutils import splitpath
1933
1610
        BzrError.__init__(self)
1934
1611
        if extra:
1935
1612
            self.extra = ': ' + str(extra)
1939
1616
        has_from = len(from_path) > 0
1940
1617
        has_to = len(to_path) > 0
1941
1618
        if has_from:
1942
 
            self.from_path = splitpath(from_path)[-1]
 
1619
            self.from_path = osutils.splitpath(from_path)[-1]
1943
1620
        else:
1944
1621
            self.from_path = ''
1945
1622
 
1946
1623
        if has_to:
1947
 
            self.to_path = splitpath(to_path)[-1]
 
1624
            self.to_path = osutils.splitpath(to_path)[-1]
1948
1625
        else:
1949
1626
            self.to_path = ''
1950
1627
 
1969
1646
class BzrRemoveChangedFilesError(BzrError):
1970
1647
    """Used when user is trying to remove changed files."""
1971
1648
 
1972
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1973
 
        "%(changes_as_text)s"
 
1649
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
1974
1650
        "Use --keep to not delete them, or --force to delete them regardless.")
1975
1651
 
1976
1652
    def __init__(self, tree_delta):
2033
1709
 
2034
1710
class BadConversionTarget(BzrError):
2035
1711
 
2036
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2037
 
            "    %(problem)s"
 
1712
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2038
1713
 
2039
 
    def __init__(self, problem, format, from_format=None):
 
1714
    def __init__(self, problem, format):
2040
1715
        BzrError.__init__(self)
2041
1716
        self.problem = problem
2042
1717
        self.format = format
2043
 
        self.from_format = from_format or '(unspecified)'
2044
 
 
2045
 
 
2046
 
class NoDiffFound(BzrError):
2047
 
 
2048
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2049
 
 
2050
 
    def __init__(self, path):
2051
 
        BzrError.__init__(self, path)
2052
 
 
2053
 
 
2054
 
class ExecutableMissing(BzrError):
2055
 
 
2056
 
    _fmt = "%(exe_name)s could not be found on this machine"
2057
 
 
2058
 
    def __init__(self, exe_name):
2059
 
        BzrError.__init__(self, exe_name=exe_name)
2060
1718
 
2061
1719
 
2062
1720
class NoDiff(BzrError):
2072
1730
    _fmt = "Diff3 is not installed on this machine."
2073
1731
 
2074
1732
 
2075
 
class ExistingContent(BzrError):
2076
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2077
 
 
2078
 
    _fmt = "The content being inserted is already present."
2079
 
 
2080
 
 
2081
1733
class ExistingLimbo(BzrError):
2082
1734
 
2083
1735
    _fmt = """This tree contains left-over files from a failed operation.
2084
1736
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2085
1737
    keep, and delete it when you are done."""
2086
 
 
 
1738
    
2087
1739
    def __init__(self, limbo_dir):
2088
1740
       BzrError.__init__(self)
2089
1741
       self.limbo_dir = limbo_dir
2090
1742
 
2091
1743
 
2092
 
class ExistingPendingDeletion(BzrError):
2093
 
 
2094
 
    _fmt = """This tree contains left-over files from a failed operation.
2095
 
    Please examine %(pending_deletion)s to see if it contains any files you
2096
 
    wish to keep, and delete it when you are done."""
2097
 
 
2098
 
    def __init__(self, pending_deletion):
2099
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2100
 
 
2101
 
 
2102
1744
class ImmortalLimbo(BzrError):
2103
1745
 
2104
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1746
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2105
1747
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2106
1748
    keep, and delete it when you are done."""
2107
1749
 
2110
1752
       self.limbo_dir = limbo_dir
2111
1753
 
2112
1754
 
2113
 
class ImmortalPendingDeletion(BzrError):
2114
 
 
2115
 
    _fmt = ("Unable to delete transform temporary directory "
2116
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2117
 
    "contains any files you wish to keep, and delete it when you are done.")
2118
 
 
2119
 
    def __init__(self, pending_deletion):
2120
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2121
 
 
2122
 
 
2123
1755
class OutOfDateTree(BzrError):
2124
1756
 
2125
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1757
    _fmt = "Working tree is out of date, please run 'bzr update'."
2126
1758
 
2127
 
    def __init__(self, tree, more=None):
2128
 
        if more is None:
2129
 
            more = ''
2130
 
        else:
2131
 
            more = ' ' + more
 
1759
    def __init__(self, tree):
2132
1760
        BzrError.__init__(self)
2133
1761
        self.tree = tree
2134
 
        self.more = more
2135
1762
 
2136
1763
 
2137
1764
class PublicBranchOutOfDate(BzrError):
2157
1784
    _fmt = "Format error in conflict listings"
2158
1785
 
2159
1786
 
2160
 
class CorruptDirstate(BzrError):
2161
 
 
2162
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2163
 
            "Error: %(description)s")
2164
 
 
2165
 
    def __init__(self, dirstate_path, description):
2166
 
        BzrError.__init__(self)
2167
 
        self.dirstate_path = dirstate_path
2168
 
        self.description = description
2169
 
 
2170
 
 
2171
1787
class CorruptRepository(BzrError):
2172
1788
 
2173
1789
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2178
1794
        self.repo_path = repo.bzrdir.root_transport.base
2179
1795
 
2180
1796
 
2181
 
class InconsistentDelta(BzrError):
2182
 
    """Used when we get a delta that is not valid."""
2183
 
 
2184
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2185
 
            " %(file_id)r\nreason: %(reason)s")
2186
 
 
2187
 
    def __init__(self, path, file_id, reason):
2188
 
        BzrError.__init__(self)
2189
 
        self.path = path
2190
 
        self.file_id = file_id
2191
 
        self.reason = reason
2192
 
 
2193
 
 
2194
 
class InconsistentDeltaDelta(InconsistentDelta):
2195
 
    """Used when we get a delta that is not valid."""
2196
 
 
2197
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2198
 
            "\nreason: %(reason)s")
2199
 
 
2200
 
    def __init__(self, delta, reason):
2201
 
        BzrError.__init__(self)
2202
 
        self.delta = delta
2203
 
        self.reason = reason
2204
 
 
2205
 
 
2206
1797
class UpgradeRequired(BzrError):
2207
1798
 
2208
1799
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2212
1803
        self.path = path
2213
1804
 
2214
1805
 
2215
 
class RepositoryUpgradeRequired(UpgradeRequired):
2216
 
 
2217
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2218
 
 
2219
 
 
2220
 
class RichRootUpgradeRequired(UpgradeRequired):
2221
 
 
2222
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2223
 
           " a format which supports rich roots.")
2224
 
 
2225
 
 
2226
1806
class LocalRequiresBoundBranch(BzrError):
2227
1807
 
2228
1808
    _fmt = "Cannot perform local-only commits on unbound branches."
2229
1809
 
2230
1810
 
 
1811
class MissingProgressBarFinish(BzrError):
 
1812
 
 
1813
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1814
 
 
1815
 
 
1816
class InvalidProgressBarType(BzrError):
 
1817
 
 
1818
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1819
            " is not a supported type Select one of: %(valid_types)s")
 
1820
 
 
1821
    def __init__(self, bar_type, valid_types):
 
1822
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1823
 
 
1824
 
2231
1825
class UnsupportedOperation(BzrError):
2232
1826
 
2233
1827
    _fmt = ("The method %(mname)s is not supported on"
2250
1844
 
2251
1845
 
2252
1846
class BinaryFile(BzrError):
2253
 
 
 
1847
    
2254
1848
    _fmt = "File is binary but should be text."
2255
1849
 
2256
1850
 
2276
1870
 
2277
1871
 
2278
1872
class NotABundle(BzrError):
2279
 
 
 
1873
    
2280
1874
    _fmt = "Not a bzr revision-bundle: %(text)r"
2281
1875
 
2282
1876
    def __init__(self, text):
2284
1878
        self.text = text
2285
1879
 
2286
1880
 
2287
 
class BadBundle(BzrError):
2288
 
 
 
1881
class BadBundle(BzrError): 
 
1882
    
2289
1883
    _fmt = "Bad bzr revision-bundle: %(text)r"
2290
1884
 
2291
1885
    def __init__(self, text):
2293
1887
        self.text = text
2294
1888
 
2295
1889
 
2296
 
class MalformedHeader(BadBundle):
2297
 
 
 
1890
class MalformedHeader(BadBundle): 
 
1891
    
2298
1892
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2299
1893
 
2300
1894
 
2301
 
class MalformedPatches(BadBundle):
2302
 
 
 
1895
class MalformedPatches(BadBundle): 
 
1896
    
2303
1897
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2304
1898
 
2305
1899
 
2306
 
class MalformedFooter(BadBundle):
2307
 
 
 
1900
class MalformedFooter(BadBundle): 
 
1901
    
2308
1902
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2309
1903
 
2310
1904
 
2311
1905
class UnsupportedEOLMarker(BadBundle):
2312
 
 
2313
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1906
    
 
1907
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2314
1908
 
2315
1909
    def __init__(self):
2316
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1910
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2317
1911
        # but for this there is not
2318
1912
        BzrError.__init__(self)
2319
1913
 
2320
1914
 
2321
1915
class IncompatibleBundleFormat(BzrError):
2322
 
 
 
1916
    
2323
1917
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2324
1918
 
2325
1919
    def __init__(self, bundle_format, other):
2329
1923
 
2330
1924
 
2331
1925
class BadInventoryFormat(BzrError):
2332
 
 
 
1926
    
2333
1927
    _fmt = "Root class for inventory serialization errors"
2334
1928
 
2335
1929
 
2346
1940
    _fmt = """This operation requires rich root data storage"""
2347
1941
 
2348
1942
 
2349
 
class NoSmartMedium(InternalBzrError):
 
1943
class NoSmartMedium(BzrError):
2350
1944
 
2351
1945
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2352
1946
 
 
1947
    internal_error = True
 
1948
 
2353
1949
    def __init__(self, transport):
2354
1950
        self.transport = transport
2355
1951
 
2356
1952
 
 
1953
class NoSmartServer(NotBranchError):
 
1954
 
 
1955
    _fmt = "No smart server available at %(url)s"
 
1956
 
 
1957
    def __init__(self, url):
 
1958
        self.url = url
 
1959
 
 
1960
 
2357
1961
class UnknownSSH(BzrError):
2358
1962
 
2359
1963
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2369
1973
            " Please set BZR_SSH environment variable.")
2370
1974
 
2371
1975
 
2372
 
class GhostRevisionsHaveNoRevno(BzrError):
2373
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2374
 
 
2375
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2376
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2377
 
 
2378
 
    def __init__(self, revision_id, ghost_revision_id):
2379
 
        self.revision_id = revision_id
2380
 
        self.ghost_revision_id = ghost_revision_id
2381
 
 
2382
 
 
2383
1976
class GhostRevisionUnusableHere(BzrError):
2384
1977
 
2385
1978
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2389
1982
        self.revision_id = revision_id
2390
1983
 
2391
1984
 
2392
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
1985
class IllegalUseOfScopeReplacer(BzrError):
2393
1986
 
2394
1987
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2395
1988
            " %(msg)s%(extra)s")
2396
1989
 
 
1990
    internal_error = True
 
1991
 
2397
1992
    def __init__(self, name, msg, extra=None):
2398
1993
        BzrError.__init__(self)
2399
1994
        self.name = name
2404
1999
            self.extra = ''
2405
2000
 
2406
2001
 
2407
 
class InvalidImportLine(InternalBzrError):
 
2002
class InvalidImportLine(BzrError):
2408
2003
 
2409
2004
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2410
2005
 
 
2006
    internal_error = True
 
2007
 
2411
2008
    def __init__(self, text, msg):
2412
2009
        BzrError.__init__(self)
2413
2010
        self.text = text
2414
2011
        self.msg = msg
2415
2012
 
2416
2013
 
2417
 
class ImportNameCollision(InternalBzrError):
 
2014
class ImportNameCollision(BzrError):
2418
2015
 
2419
2016
    _fmt = ("Tried to import an object to the same name as"
2420
2017
            " an existing object. %(name)s")
2421
2018
 
 
2019
    internal_error = True
 
2020
 
2422
2021
    def __init__(self, name):
2423
2022
        BzrError.__init__(self)
2424
2023
        self.name = name
2437
2036
        " branch location."
2438
2037
 
2439
2038
 
2440
 
class IllegalMergeDirectivePayload(BzrError):
2441
 
    """A merge directive contained something other than a patch or bundle"""
2442
 
 
2443
 
    _fmt = "Bad merge directive payload %(start)r"
2444
 
 
2445
 
    def __init__(self, start):
2446
 
        BzrError(self)
2447
 
        self.start = start
2448
 
 
2449
 
 
2450
 
class PatchVerificationFailed(BzrError):
2451
 
    """A patch from a merge directive could not be verified"""
2452
 
 
2453
 
    _fmt = "Preview patch does not match requested changes."
2454
 
 
2455
 
 
2456
2039
class PatchMissing(BzrError):
2457
2040
    """Raise a patch type was specified but no patch supplied"""
2458
2041
 
2459
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2042
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2460
2043
 
2461
2044
    def __init__(self, patch_type):
2462
2045
        BzrError.__init__(self)
2463
2046
        self.patch_type = patch_type
2464
2047
 
2465
2048
 
2466
 
class TargetNotBranch(BzrError):
2467
 
    """A merge directive's target branch is required, but isn't a branch"""
2468
 
 
2469
 
    _fmt = ("Your branch does not have all of the revisions required in "
2470
 
            "order to merge this merge directive and the target "
2471
 
            "location specified in the merge directive is not a branch: "
2472
 
            "%(location)s.")
2473
 
 
2474
 
    def __init__(self, location):
2475
 
        BzrError.__init__(self)
2476
 
        self.location = location
2477
 
 
2478
 
 
2479
2049
class UnsupportedInventoryKind(BzrError):
2480
 
 
 
2050
    
2481
2051
    _fmt = """Unsupported entry kind %(kind)s"""
2482
2052
 
2483
2053
    def __init__(self, kind):
2486
2056
 
2487
2057
class BadSubsumeSource(BzrError):
2488
2058
 
2489
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2059
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2490
2060
 
2491
2061
    def __init__(self, tree, other_tree, reason):
2492
2062
        self.tree = tree
2495
2065
 
2496
2066
 
2497
2067
class SubsumeTargetNeedsUpgrade(BzrError):
2498
 
 
 
2068
    
2499
2069
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2500
2070
 
2501
2071
    def __init__(self, other_tree):
2502
2072
        self.other_tree = other_tree
2503
2073
 
2504
2074
 
2505
 
class BadReferenceTarget(InternalBzrError):
2506
 
 
2507
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2508
 
           "%(reason)s"
 
2075
class BadReferenceTarget(BzrError):
 
2076
 
 
2077
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2078
 
 
2079
    internal_error = True
2509
2080
 
2510
2081
    def __init__(self, tree, other_tree, reason):
2511
2082
        self.tree = tree
2524
2095
class TagsNotSupported(BzrError):
2525
2096
 
2526
2097
    _fmt = ("Tags not supported by %(branch)s;"
2527
 
            " you may be able to use bzr upgrade.")
 
2098
            " you may be able to use bzr upgrade --dirstate-tags.")
2528
2099
 
2529
2100
    def __init__(self, branch):
2530
2101
        self.branch = branch
2531
2102
 
2532
 
 
 
2103
        
2533
2104
class TagAlreadyExists(BzrError):
2534
2105
 
2535
2106
    _fmt = "Tag %(tag_name)s already exists."
2540
2111
 
2541
2112
class MalformedBugIdentifier(BzrError):
2542
2113
 
2543
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2544
 
            'See "bzr help bugs" for more information on this feature.')
 
2114
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2545
2115
 
2546
2116
    def __init__(self, bug_id, reason):
2547
2117
        self.bug_id = bug_id
2548
2118
        self.reason = reason
2549
2119
 
2550
2120
 
2551
 
class InvalidBugTrackerURL(BzrError):
2552
 
 
2553
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2554
 
            "contain {id}: %(url)s")
2555
 
 
2556
 
    def __init__(self, abbreviation, url):
2557
 
        self.abbreviation = abbreviation
2558
 
        self.url = url
2559
 
 
2560
 
 
2561
2121
class UnknownBugTrackerAbbreviation(BzrError):
2562
2122
 
2563
2123
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2568
2128
        self.branch = branch
2569
2129
 
2570
2130
 
2571
 
class InvalidLineInBugsProperty(BzrError):
2572
 
 
2573
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2574
 
 
2575
 
    def __init__(self, line):
2576
 
        self.line = line
2577
 
 
2578
 
 
2579
 
class InvalidBugStatus(BzrError):
2580
 
 
2581
 
    _fmt = ("Invalid bug status: '%(status)s'")
2582
 
 
2583
 
    def __init__(self, status):
2584
 
        self.status = status
2585
 
 
2586
 
 
2587
2131
class UnexpectedSmartServerResponse(BzrError):
2588
2132
 
2589
2133
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2590
2134
 
2591
2135
    def __init__(self, response_tuple):
2592
2136
        self.response_tuple = response_tuple
2593
 
 
2594
 
 
2595
 
class ErrorFromSmartServer(BzrError):
2596
 
    """An error was received from a smart server.
2597
 
 
2598
 
    :seealso: UnknownErrorFromSmartServer
2599
 
    """
2600
 
 
2601
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2602
 
 
2603
 
    internal_error = True
2604
 
 
2605
 
    def __init__(self, error_tuple):
2606
 
        self.error_tuple = error_tuple
2607
 
        try:
2608
 
            self.error_verb = error_tuple[0]
2609
 
        except IndexError:
2610
 
            self.error_verb = None
2611
 
        self.error_args = error_tuple[1:]
2612
 
 
2613
 
 
2614
 
class UnknownErrorFromSmartServer(BzrError):
2615
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2616
 
    error.
2617
 
 
2618
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2619
 
    distinguish between the following two cases:
2620
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2621
 
        and so should provoke a traceback to the user.
2622
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2623
 
        translated.  This is probably because the server sent us garbage, and
2624
 
        should not provoke a traceback.
2625
 
    """
2626
 
 
2627
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2628
 
 
2629
 
    internal_error = False
2630
 
 
2631
 
    def __init__(self, error_from_smart_server):
2632
 
        """Constructor.
2633
 
 
2634
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2635
 
        """
2636
 
        self.error_from_smart_server = error_from_smart_server
2637
 
        self.error_tuple = error_from_smart_server.error_tuple
2638
 
 
2639
 
 
2640
 
class ContainerError(BzrError):
2641
 
    """Base class of container errors."""
2642
 
 
2643
 
 
2644
 
class UnknownContainerFormatError(ContainerError):
2645
 
 
2646
 
    _fmt = "Unrecognised container format: %(container_format)r"
2647
 
 
2648
 
    def __init__(self, container_format):
2649
 
        self.container_format = container_format
2650
 
 
2651
 
 
2652
 
class UnexpectedEndOfContainerError(ContainerError):
2653
 
 
2654
 
    _fmt = "Unexpected end of container stream"
2655
 
 
2656
 
 
2657
 
class UnknownRecordTypeError(ContainerError):
2658
 
 
2659
 
    _fmt = "Unknown record type: %(record_type)r"
2660
 
 
2661
 
    def __init__(self, record_type):
2662
 
        self.record_type = record_type
2663
 
 
2664
 
 
2665
 
class InvalidRecordError(ContainerError):
2666
 
 
2667
 
    _fmt = "Invalid record: %(reason)s"
2668
 
 
2669
 
    def __init__(self, reason):
2670
 
        self.reason = reason
2671
 
 
2672
 
 
2673
 
class ContainerHasExcessDataError(ContainerError):
2674
 
 
2675
 
    _fmt = "Container has data after end marker: %(excess)r"
2676
 
 
2677
 
    def __init__(self, excess):
2678
 
        self.excess = excess
2679
 
 
2680
 
 
2681
 
class DuplicateRecordNameError(ContainerError):
2682
 
 
2683
 
    _fmt = "Container has multiple records with the same name: %(name)s"
2684
 
 
2685
 
    def __init__(self, name):
2686
 
        self.name = name
2687
 
 
2688
 
 
2689
 
class NoDestinationAddress(InternalBzrError):
2690
 
 
2691
 
    _fmt = "Message does not have a destination address."
2692
 
 
2693
 
 
2694
 
class RepositoryDataStreamError(BzrError):
2695
 
 
2696
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2697
 
 
2698
 
    def __init__(self, reason):
2699
 
        self.reason = reason
2700
 
 
2701
 
 
2702
 
class SMTPError(BzrError):
2703
 
 
2704
 
    _fmt = "SMTP error: %(error)s"
2705
 
 
2706
 
    def __init__(self, error):
2707
 
        self.error = error
2708
 
 
2709
 
 
2710
 
class NoMessageSupplied(BzrError):
2711
 
 
2712
 
    _fmt = "No message supplied."
2713
 
 
2714
 
 
2715
 
class NoMailAddressSpecified(BzrError):
2716
 
 
2717
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2718
 
 
2719
 
 
2720
 
class UnknownMailClient(BzrError):
2721
 
 
2722
 
    _fmt = "Unknown mail client: %(mail_client)s"
2723
 
 
2724
 
    def __init__(self, mail_client):
2725
 
        BzrError.__init__(self, mail_client=mail_client)
2726
 
 
2727
 
 
2728
 
class MailClientNotFound(BzrError):
2729
 
 
2730
 
    _fmt = "Unable to find mail client with the following names:"\
2731
 
        " %(mail_command_list_string)s"
2732
 
 
2733
 
    def __init__(self, mail_command_list):
2734
 
        mail_command_list_string = ', '.join(mail_command_list)
2735
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2736
 
                          mail_command_list_string=mail_command_list_string)
2737
 
 
2738
 
class SMTPConnectionRefused(SMTPError):
2739
 
 
2740
 
    _fmt = "SMTP connection to %(host)s refused"
2741
 
 
2742
 
    def __init__(self, error, host):
2743
 
        self.error = error
2744
 
        self.host = host
2745
 
 
2746
 
 
2747
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2748
 
 
2749
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2750
 
 
2751
 
 
2752
 
class BzrDirError(BzrError):
2753
 
 
2754
 
    def __init__(self, bzrdir):
2755
 
        import bzrlib.urlutils as urlutils
2756
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2757
 
                                                    'ascii')
2758
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2759
 
 
2760
 
 
2761
 
class UnsyncedBranches(BzrDirError):
2762
 
 
2763
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2764
 
            " bzr help sync-for-reconfigure.")
2765
 
 
2766
 
    def __init__(self, bzrdir, target_branch):
2767
 
        BzrDirError.__init__(self, bzrdir)
2768
 
        import bzrlib.urlutils as urlutils
2769
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2770
 
                                                        'ascii')
2771
 
 
2772
 
 
2773
 
class AlreadyBranch(BzrDirError):
2774
 
 
2775
 
    _fmt = "'%(display_url)s' is already a branch."
2776
 
 
2777
 
 
2778
 
class AlreadyTree(BzrDirError):
2779
 
 
2780
 
    _fmt = "'%(display_url)s' is already a tree."
2781
 
 
2782
 
 
2783
 
class AlreadyCheckout(BzrDirError):
2784
 
 
2785
 
    _fmt = "'%(display_url)s' is already a checkout."
2786
 
 
2787
 
 
2788
 
class AlreadyLightweightCheckout(BzrDirError):
2789
 
 
2790
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2791
 
 
2792
 
 
2793
 
class AlreadyUsingShared(BzrDirError):
2794
 
 
2795
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2796
 
 
2797
 
 
2798
 
class AlreadyStandalone(BzrDirError):
2799
 
 
2800
 
    _fmt = "'%(display_url)s' is already standalone."
2801
 
 
2802
 
 
2803
 
class AlreadyWithTrees(BzrDirError):
2804
 
 
2805
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2806
 
            "working trees.")
2807
 
 
2808
 
 
2809
 
class AlreadyWithNoTrees(BzrDirError):
2810
 
 
2811
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2812
 
            "working trees.")
2813
 
 
2814
 
 
2815
 
class ReconfigurationNotSupported(BzrDirError):
2816
 
 
2817
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2818
 
 
2819
 
 
2820
 
class NoBindLocation(BzrDirError):
2821
 
 
2822
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2823
 
 
2824
 
 
2825
 
class UncommittedChanges(BzrError):
2826
 
 
2827
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2828
 
            ' (See bzr status).%(more)s')
2829
 
 
2830
 
    def __init__(self, tree, more=None):
2831
 
        if more is None:
2832
 
            more = ''
2833
 
        else:
2834
 
            more = ' ' + more
2835
 
        import bzrlib.urlutils as urlutils
2836
 
        display_url = urlutils.unescape_for_display(
2837
 
            tree.bzrdir.root_transport.base, 'ascii')
2838
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2839
 
 
2840
 
 
2841
 
class MissingTemplateVariable(BzrError):
2842
 
 
2843
 
    _fmt = 'Variable {%(name)s} is not available.'
2844
 
 
2845
 
    def __init__(self, name):
2846
 
        self.name = name
2847
 
 
2848
 
 
2849
 
class NoTemplate(BzrError):
2850
 
 
2851
 
    _fmt = 'No template specified.'
2852
 
 
2853
 
 
2854
 
class UnableCreateSymlink(BzrError):
2855
 
 
2856
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2857
 
 
2858
 
    def __init__(self, path=None):
2859
 
        path_str = ''
2860
 
        if path:
2861
 
            try:
2862
 
                path_str = repr(str(path))
2863
 
            except UnicodeEncodeError:
2864
 
                path_str = repr(path)
2865
 
            path_str += ' '
2866
 
        self.path_str = path_str
2867
 
 
2868
 
 
2869
 
class UnsupportedTimezoneFormat(BzrError):
2870
 
 
2871
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2872
 
            'options are "utc", "original", "local".')
2873
 
 
2874
 
    def __init__(self, timezone):
2875
 
        self.timezone = timezone
2876
 
 
2877
 
 
2878
 
class CommandAvailableInPlugin(StandardError):
2879
 
 
2880
 
    internal_error = False
2881
 
 
2882
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2883
 
 
2884
 
        self.plugin_metadata = plugin_metadata
2885
 
        self.cmd_name = cmd_name
2886
 
        self.provider = provider
2887
 
 
2888
 
    def __str__(self):
2889
 
 
2890
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2891
 
                'However, the following official plugin provides this command: %s\n'
2892
 
                'You can install it by going to: %s'
2893
 
                % (self.cmd_name, self.plugin_metadata['name'],
2894
 
                    self.plugin_metadata['url']))
2895
 
 
2896
 
        return _fmt
2897
 
 
2898
 
 
2899
 
class NoPluginAvailable(BzrError):
2900
 
    pass
2901
 
 
2902
 
 
2903
 
class UnableEncodePath(BzrError):
2904
 
 
2905
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2906
 
            'user encoding %(user_encoding)s')
2907
 
 
2908
 
    def __init__(self, path, kind):
2909
 
        from bzrlib.osutils import get_user_encoding
2910
 
        self.path = path
2911
 
        self.kind = kind
2912
 
        self.user_encoding = osutils.get_user_encoding()
2913
 
 
2914
 
 
2915
 
class NoSuchAlias(BzrError):
2916
 
 
2917
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2918
 
 
2919
 
    def __init__(self, alias_name):
2920
 
        BzrError.__init__(self, alias_name=alias_name)
2921
 
 
2922
 
 
2923
 
class DirectoryLookupFailure(BzrError):
2924
 
    """Base type for lookup errors."""
2925
 
 
2926
 
    pass
2927
 
 
2928
 
 
2929
 
class InvalidLocationAlias(DirectoryLookupFailure):
2930
 
 
2931
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2932
 
 
2933
 
    def __init__(self, alias_name):
2934
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2935
 
 
2936
 
 
2937
 
class UnsetLocationAlias(DirectoryLookupFailure):
2938
 
 
2939
 
    _fmt = 'No %(alias_name)s location assigned.'
2940
 
 
2941
 
    def __init__(self, alias_name):
2942
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2943
 
 
2944
 
 
2945
 
class CannotBindAddress(BzrError):
2946
 
 
2947
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2948
 
 
2949
 
    def __init__(self, host, port, orig_error):
2950
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2951
 
        BzrError.__init__(self, host=host, port=port,
2952
 
            orig_error=repr(orig_error.args))
2953
 
 
2954
 
 
2955
 
class UnknownRules(BzrError):
2956
 
 
2957
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2958
 
 
2959
 
    def __init__(self, unknowns):
2960
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2961
 
 
2962
 
 
2963
 
class HookFailed(BzrError):
2964
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2965
 
    than TipChangeRejected.
2966
 
 
2967
 
    Note that this exception is no longer raised, and the import is only left
2968
 
    to be nice to code which might catch it in a plugin.
2969
 
    """
2970
 
 
2971
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2972
 
            "%(traceback_text)s%(exc_value)s")
2973
 
 
2974
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2975
 
        if warn:
2976
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2977
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2978
 
        import traceback
2979
 
        self.hook_stage = hook_stage
2980
 
        self.hook_name = hook_name
2981
 
        self.exc_info = exc_info
2982
 
        self.exc_type = exc_info[0]
2983
 
        self.exc_value = exc_info[1]
2984
 
        self.exc_tb = exc_info[2]
2985
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2986
 
 
2987
 
 
2988
 
class TipChangeRejected(BzrError):
2989
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
2990
 
    explicitly abort a change to a branch tip.
2991
 
    """
2992
 
 
2993
 
    _fmt = u"Tip change rejected: %(msg)s"
2994
 
 
2995
 
    def __init__(self, msg):
2996
 
        self.msg = msg
2997
 
 
2998
 
 
2999
 
class ShelfCorrupt(BzrError):
3000
 
 
3001
 
    _fmt = "Shelf corrupt."
3002
 
 
3003
 
 
3004
 
class NoSuchShelfId(BzrError):
3005
 
 
3006
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3007
 
 
3008
 
    def __init__(self, shelf_id):
3009
 
        BzrError.__init__(self, shelf_id=shelf_id)
3010
 
 
3011
 
 
3012
 
class InvalidShelfId(BzrError):
3013
 
 
3014
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3015
 
 
3016
 
    def __init__(self, invalid_id):
3017
 
        BzrError.__init__(self, invalid_id=invalid_id)
3018
 
 
3019
 
 
3020
 
class JailBreak(BzrError):
3021
 
 
3022
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3023
 
 
3024
 
    def __init__(self, url):
3025
 
        BzrError.__init__(self, url=url)
3026
 
 
3027
 
 
3028
 
class UserAbort(BzrError):
3029
 
 
3030
 
    _fmt = 'The user aborted the operation.'
3031
 
 
3032
 
 
3033
 
class MustHaveWorkingTree(BzrError):
3034
 
 
3035
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3036
 
 
3037
 
    def __init__(self, format, url):
3038
 
        BzrError.__init__(self, format=format, url=url)
3039
 
 
3040
 
 
3041
 
class NoSuchView(BzrError):
3042
 
    """A view does not exist.
3043
 
    """
3044
 
 
3045
 
    _fmt = u"No such view: %(view_name)s."
3046
 
 
3047
 
    def __init__(self, view_name):
3048
 
        self.view_name = view_name
3049
 
 
3050
 
 
3051
 
class ViewsNotSupported(BzrError):
3052
 
    """Views are not supported by a tree format.
3053
 
    """
3054
 
 
3055
 
    _fmt = ("Views are not supported by %(tree)s;"
3056
 
            " use 'bzr upgrade' to change your tree to a later format.")
3057
 
 
3058
 
    def __init__(self, tree):
3059
 
        self.tree = tree
3060
 
 
3061
 
 
3062
 
class FileOutsideView(BzrError):
3063
 
 
3064
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3065
 
            '%(view_str)s')
3066
 
 
3067
 
    def __init__(self, file_name, view_files):
3068
 
        self.file_name = file_name
3069
 
        self.view_str = ", ".join(view_files)
3070
 
 
3071
 
 
3072
 
class UnresumableWriteGroup(BzrError):
3073
 
 
3074
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3075
 
            "%(write_groups)r: %(reason)s")
3076
 
 
3077
 
    internal_error = True
3078
 
 
3079
 
    def __init__(self, repository, write_groups, reason):
3080
 
        self.repository = repository
3081
 
        self.write_groups = write_groups
3082
 
        self.reason = reason
3083
 
 
3084
 
 
3085
 
class UnsuspendableWriteGroup(BzrError):
3086
 
 
3087
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3088
 
 
3089
 
    internal_error = True
3090
 
 
3091
 
    def __init__(self, repository):
3092
 
        self.repository = repository
3093
 
 
3094
 
 
3095
 
class LossyPushToSameVCS(BzrError):
3096
 
 
3097
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3098
 
            "%(target_branch)r that are in the same VCS.")
3099
 
 
3100
 
    internal_error = True
3101
 
 
3102
 
    def __init__(self, source_branch, target_branch):
3103
 
        self.source_branch = source_branch
3104
 
        self.target_branch = target_branch
3105
 
 
3106
 
 
3107
 
class NoRoundtrippingSupport(BzrError):
3108
 
 
3109
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3110
 
            "%(target_branch)r.")
3111
 
 
3112
 
    internal_error = True
3113
 
 
3114
 
    def __init__(self, source_branch, target_branch):
3115
 
        self.source_branch = source_branch
3116
 
        self.target_branch = target_branch
3117
 
 
3118
 
 
3119
 
class FileTimestampUnavailable(BzrError):
3120
 
 
3121
 
    _fmt = "The filestamp for %(path)s is not available."
3122
 
 
3123
 
    internal_error = True
3124
 
 
3125
 
    def __init__(self, path):
3126
 
        self.path = path