/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-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
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# 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
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
44
43
# 'unprintable'.
45
44
 
46
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
 
50
 
 
51
 
47
52
class BzrError(StandardError):
48
53
    """
49
54
    Base class for errors raised by bzrlib.
56
61
    :cvar _fmt: Format string to display the error; this is expanded
57
62
    by the instance's dict.
58
63
    """
59
 
    
 
64
 
60
65
    internal_error = False
61
66
 
62
67
    def __init__(self, msg=None, **kwds):
67
72
        arguments can be given.  The first is for generic "user" errors which
68
73
        are not intended to be caught and so do not need a specific subclass.
69
74
        The second case is for use with subclasses that provide a _fmt format
70
 
        string to print the arguments.  
 
75
        string to print the arguments.
71
76
 
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 
 
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
75
80
        parameters.
76
81
 
77
82
        :param msg: If given, this is the literal complete text for the error,
78
 
        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'.
79
85
        """
80
86
        StandardError.__init__(self)
81
87
        if msg is not None:
87
93
            for key, value in kwds.items():
88
94
                setattr(self, key, value)
89
95
 
90
 
    def __str__(self):
 
96
    def _format(self):
91
97
        s = getattr(self, '_preformatted_string', None)
92
98
        if s is not None:
93
 
            # contains a preformatted message; must be cast to plain str
94
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
95
101
        try:
96
102
            fmt = self._get_format_string()
97
103
            if fmt:
98
 
                s = fmt % self.__dict__
 
104
                d = dict(self.__dict__)
 
105
                s = fmt % d
99
106
                # __str__() should always return a 'str' object
100
107
                # never a 'unicode' object.
101
 
                if isinstance(s, unicode):
102
 
                    return s.encode('utf8')
103
108
                return s
104
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
105
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
108
113
                   getattr(self, '_fmt', None),
109
114
                   e)
110
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))
 
138
 
111
139
    def _get_format_string(self):
112
140
        """Return format string for this exception or None"""
113
141
        fmt = getattr(self, '_fmt', None)
125
153
               getattr(self, '_fmt', None),
126
154
               )
127
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
 
128
172
 
129
173
class BzrNewError(BzrError):
130
174
    """Deprecated error base class."""
160
204
 
161
205
 
162
206
class AlreadyBuilding(BzrError):
163
 
    
 
207
 
164
208
    _fmt = "The tree builder is already building a tree."
165
209
 
166
210
 
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):
 
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):
179
238
 
180
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
181
240
 
182
 
    internal_error = True
183
 
 
184
241
    def __init__(self, class_name):
185
242
        BzrError.__init__(self)
186
243
        self.class_name = class_name
207
264
        self.transport = transport
208
265
 
209
266
 
210
 
class InvalidEntryName(BzrError):
211
 
    
 
267
class InvalidEntryName(InternalBzrError):
 
268
 
212
269
    _fmt = "Invalid entry name: %(name)s"
213
270
 
214
 
    internal_error = True
215
 
 
216
271
    def __init__(self, name):
217
272
        BzrError.__init__(self)
218
273
        self.name = name
219
274
 
220
275
 
221
276
class InvalidRevisionNumber(BzrError):
222
 
    
 
277
 
223
278
    _fmt = "Invalid revision number %(revno)s"
224
279
 
225
280
    def __init__(self, revno):
237
292
        self.revision_id = revision_id
238
293
        self.branch = branch
239
294
 
 
295
 
240
296
class ReservedId(BzrError):
241
297
 
242
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
245
301
        self.revision_id = revision_id
246
302
 
247
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
 
248
320
class NoHelpTopic(BzrError):
249
321
 
250
322
    _fmt = ("No help could be found for '%(topic)s'. "
256
328
 
257
329
class NoSuchId(BzrError):
258
330
 
259
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
260
 
    
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
261
333
    def __init__(self, tree, file_id):
262
334
        BzrError.__init__(self)
263
335
        self.file_id = file_id
264
336
        self.tree = tree
265
337
 
266
338
 
267
 
class InventoryModified(BzrError):
 
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):
268
354
 
269
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
270
356
            " so a clean inventory cannot be read without data loss.")
271
357
 
272
 
    internal_error = True
273
 
 
274
358
    def __init__(self, tree):
275
359
        self.tree = tree
276
360
 
277
361
 
278
362
class NoWorkingTree(BzrError):
279
363
 
280
 
    _fmt = "No WorkingTree exists for %(base)s."
281
 
    
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
282
366
    def __init__(self, base):
283
367
        BzrError.__init__(self)
284
368
        self.base = base
297
381
        self.url = url
298
382
 
299
383
 
300
 
class WorkingTreeAlreadyPopulated(BzrError):
301
 
 
302
 
    _fmt = """Working tree already populated in %(base)s"""
303
 
 
304
 
    internal_error = True
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
305
387
 
306
388
    def __init__(self, base):
307
389
        self.base = base
308
390
 
 
391
 
309
392
class BzrCommandError(BzrError):
310
393
    """Error from user command"""
311
394
 
312
 
    internal_error = False
313
 
 
314
395
    # Error from malformed user command; please avoid raising this as a
315
396
    # generic exception not caused by user input.
316
397
    #
318
399
    # are not intended to be caught anyway.  UI code need not subclass
319
400
    # BzrCommandError, and non-UI code should not throw a subclass of
320
401
    # BzrCommandError.  ADHB 20051211
321
 
    def __init__(self, msg):
322
 
        # Object.__str__() must return a real string
323
 
        # returning a Unicode string is a python error.
324
 
        if isinstance(msg, unicode):
325
 
            self.msg = msg.encode('utf8')
326
 
        else:
327
 
            self.msg = msg
328
 
 
329
 
    def __str__(self):
330
 
        return self.msg
331
402
 
332
403
 
333
404
class NotWriteLocked(BzrError):
343
414
    _fmt = "Error in command line options"
344
415
 
345
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
 
346
473
class BadOptionValue(BzrError):
347
474
 
348
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
350
477
    def __init__(self, name, value):
351
478
        BzrError.__init__(self, name=name, value=value)
352
479
 
353
 
    
 
480
 
354
481
class StrictCommitFailed(BzrError):
355
482
 
356
483
    _fmt = "Commit refused because there are unknown files in the tree"
359
486
# XXX: Should be unified with TransportError; they seem to represent the
360
487
# same thing
361
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
362
 
# - this is finer than a TransportError - and more useful as such. It 
 
489
# - this is finer than a TransportError - and more useful as such. It
363
490
# differentiates between 'transport has failed' and 'operation on a transport
364
491
# has failed.'
365
492
class PathError(BzrError):
366
 
    
 
493
 
367
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
368
495
 
369
496
    def __init__(self, path, extra=None):
389
516
    """Used when renaming and both source and dest exist."""
390
517
 
391
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
392
 
            "%(extra)s")
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
393
521
 
394
522
    def __init__(self, source, dest, extra=None):
395
523
        BzrError.__init__(self)
403
531
 
404
532
class NotADirectory(PathError):
405
533
 
406
 
    _fmt = "%(path)r is not a directory %(extra)s"
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
407
535
 
408
536
 
409
537
class NotInWorkingDirectory(PathError):
410
538
 
411
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
412
540
 
413
541
 
414
542
class DirectoryNotEmpty(PathError):
415
543
 
416
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
417
 
 
418
 
 
419
 
class ReadingCompleted(BzrError):
420
 
    
 
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
 
421
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
422
555
            "called upon it - the request has been completed and no more "
423
556
            "data may be read.")
424
557
 
425
 
    internal_error = True
426
 
 
427
558
    def __init__(self, request):
428
559
        self.request = request
429
560
 
430
561
 
431
562
class ResourceBusy(PathError):
432
563
 
433
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
434
565
 
435
566
 
436
567
class PermissionDenied(PathError):
437
568
 
438
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
439
570
 
440
571
 
441
572
class InvalidURL(PathError):
442
573
 
443
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
444
575
 
445
576
 
446
577
class InvalidURLJoin(PathError):
447
578
 
448
 
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
449
 
 
450
 
    def __init__(self, msg, base, args):
451
 
        PathError.__init__(self, base, msg)
452
 
        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
453
608
 
454
609
 
455
610
class UnknownHook(BzrError):
470
625
        PathError.__init__(self, url, extra=extra)
471
626
 
472
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
 
473
660
class ReadError(PathError):
474
 
    
 
661
 
475
662
    _fmt = """Error reading from %(path)r."""
476
663
 
477
664
 
478
665
class ShortReadvError(PathError):
479
666
 
480
 
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
481
 
            " 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')
482
669
 
483
670
    internal_error = True
484
671
 
489
676
        self.actual = actual
490
677
 
491
678
 
492
 
class PathNotChild(BzrError):
 
679
class PathNotChild(PathError):
493
680
 
494
 
    _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'
495
682
 
496
683
    internal_error = True
497
684
 
507
694
 
508
695
class InvalidNormalization(PathError):
509
696
 
510
 
    _fmt = "Path %(path)r is not unicode normalized"
 
697
    _fmt = 'Path "%(path)s" is not unicode normalized'
511
698
 
512
699
 
513
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
514
701
# the exception object is a bit undesirable.
515
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
516
703
class NotBranchError(PathError):
517
704
 
518
 
    _fmt = "Not a branch: %(path)s"
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
519
706
 
520
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
521
708
       import bzrlib.urlutils as urlutils
522
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
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)
523
731
 
524
732
 
525
733
class NoSubmitBranch(PathError):
533
741
 
534
742
class AlreadyBranchError(PathError):
535
743
 
536
 
    _fmt = "Already a branch: %(path)s."
 
744
    _fmt = 'Already a branch: "%(path)s".'
537
745
 
538
746
 
539
747
class BranchExistsWithoutWorkingTree(PathError):
540
748
 
541
 
    _fmt = "Directory contains a branch, but no working tree \
542
 
(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"'
543
751
 
544
752
 
545
753
class AtomicFileAlreadyClosed(PathError):
546
754
 
547
 
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
548
 
            " %(path)s")
 
755
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
756
            ' "%(path)s"')
549
757
 
550
758
    def __init__(self, path, function):
551
759
        PathError.__init__(self, path=path, extra=None)
554
762
 
555
763
class InaccessibleParent(PathError):
556
764
 
557
 
    _fmt = ("Parent not accessible given base %(base)s and"
558
 
            " relative path %(path)s")
 
765
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
766
            ' relative path "%(path)s"')
559
767
 
560
768
    def __init__(self, path, base):
561
769
        PathError.__init__(self, path)
564
772
 
565
773
class NoRepositoryPresent(BzrError):
566
774
 
567
 
    _fmt = "No repository present: %(path)r"
 
775
    _fmt = 'No repository present: "%(path)s"'
568
776
    def __init__(self, bzrdir):
569
777
        BzrError.__init__(self)
570
778
        self.path = bzrdir.transport.clone('..').base
572
780
 
573
781
class FileInWrongBranch(BzrError):
574
782
 
575
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
576
784
 
577
785
    def __init__(self, branch, path):
578
786
        BzrError.__init__(self)
587
795
 
588
796
 
589
797
class UnknownFormatError(BzrError):
590
 
    
591
 
    _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
592
804
 
593
805
 
594
806
class IncompatibleFormat(BzrError):
595
 
    
 
807
 
596
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
597
809
 
598
810
    def __init__(self, format, bzrdir_format):
602
814
 
603
815
 
604
816
class IncompatibleRepositories(BzrError):
605
 
 
606
 
    _fmt = "Repository %(target)s is not compatible with repository"\
607
 
        " %(source)s"
608
 
 
609
 
    def __init__(self, source, target):
610
 
        BzrError.__init__(self, target=target, source=source)
 
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)
611
833
 
612
834
 
613
835
class IncompatibleRevision(BzrError):
614
 
    
 
836
 
615
837
    _fmt = "Revision is not compatible with %(repo_format)s"
616
838
 
617
839
    def __init__(self, repo_format):
622
844
class AlreadyVersionedError(BzrError):
623
845
    """Used when a path is expected not to be versioned, but it is."""
624
846
 
625
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
847
    _fmt = "%(context_info)s%(path)s is already versioned."
626
848
 
627
849
    def __init__(self, path, context_info=None):
628
850
        """Construct a new AlreadyVersionedError.
643
865
class NotVersionedError(BzrError):
644
866
    """Used when a path is expected to be versioned, but it is not."""
645
867
 
646
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
868
    _fmt = "%(context_info)s%(path)s is not versioned."
647
869
 
648
870
    def __init__(self, path, context_info=None):
649
871
        """Construct a new NotVersionedError.
700
922
        BzrError.__init__(self, filename=filename, kind=kind)
701
923
 
702
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
 
934
 
 
935
 
703
936
class ForbiddenControlFileError(BzrError):
704
937
 
705
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
706
 
 
707
 
 
708
 
class LockError(BzrError):
 
938
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
939
 
 
940
 
 
941
class LockError(InternalBzrError):
709
942
 
710
943
    _fmt = "Lock error: %(msg)s"
711
944
 
712
 
    internal_error = True
713
 
 
714
945
    # All exceptions from the lock/unlock functions should be from
715
946
    # this exception class.  They will be translated as necessary. The
716
947
    # original exception is available as e.original_error
718
949
    # New code should prefer to raise specific subclasses
719
950
    def __init__(self, message):
720
951
        # Python 2.5 uses a slot for StandardError.message,
721
 
        # so use a different variable name
722
 
        # so it is exposed in self.__dict__
 
952
        # so use a different variable name.  We now work around this in
 
953
        # BzrError.__str__, but this member name is kept for compatability.
723
954
        self.msg = message
724
955
 
725
956
 
760
991
        self.obj = obj
761
992
 
762
993
 
763
 
class ReadOnlyLockError(LockError):
764
 
 
765
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
766
 
 
767
 
    def __init__(self, fname, msg):
 
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):
768
1001
        LockError.__init__(self, '')
769
 
        self.fname = fname
770
 
        self.msg = msg
 
1002
        self.lock = lock
 
1003
        self.why = why
771
1004
 
772
1005
 
773
1006
class OutSideTransaction(BzrError):
797
1030
 
798
1031
class UnlockableTransport(LockError):
799
1032
 
 
1033
    internal_error = False
 
1034
 
800
1035
    _fmt = "Cannot lock: transport is read only: %(transport)s"
801
1036
 
802
1037
    def __init__(self, transport):
805
1040
 
806
1041
class LockContention(LockError):
807
1042
 
808
 
    _fmt = "Could not acquire lock %(lock)s"
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
809
1044
    # TODO: show full url for lock, combining the transport and relative
810
1045
    # bits?
811
1046
 
812
1047
    internal_error = False
813
1048
 
814
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
815
1050
        self.lock = lock
 
1051
        self.msg = msg
816
1052
 
817
1053
 
818
1054
class LockBroken(LockError):
853
1089
 
854
1090
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
855
1091
 
856
 
    internal_error = True
857
 
 
858
1092
    def __init__(self, obj):
859
1093
        self.obj = obj
860
1094
 
885
1119
        BzrError.__init__(self, files=files, files_str=files_str)
886
1120
 
887
1121
 
 
1122
class BadCommitMessageEncoding(BzrError):
 
1123
 
 
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1125
        'the current encoding.'
 
1126
 
 
1127
 
888
1128
class UpgradeReadonly(BzrError):
889
1129
 
890
1130
    _fmt = "Upgrade URL cannot work with readonly URLs."
904
1144
    _fmt = "Commit refused because there are unknowns in the tree."
905
1145
 
906
1146
 
907
 
class NoSuchRevision(BzrError):
908
 
 
909
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
910
 
 
911
 
    internal_error = True
 
1147
class NoSuchRevision(InternalBzrError):
 
1148
 
 
1149
    _fmt = "%(branch)s has no revision %(revision)s"
912
1150
 
913
1151
    def __init__(self, branch, revision):
 
1152
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
914
1153
        BzrError.__init__(self, branch=branch, revision=revision)
915
1154
 
916
1155
 
917
 
class NotLeftParentDescendant(BzrError):
918
 
 
919
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
920
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
921
 
 
922
 
    internal_error = True
923
 
 
924
 
    def __init__(self, branch, old_revision, new_revision):
925
 
        BzrError.__init__(self, branch_location=branch.base,
926
 
                          old_revision=old_revision,
927
 
                          new_revision=new_revision)
 
1156
class RangeInChangeOption(BzrError):
 
1157
 
 
1158
    _fmt = "Option --change does not accept revision ranges"
928
1159
 
929
1160
 
930
1161
class NoSuchRevisionSpec(BzrError):
937
1168
 
938
1169
class NoSuchRevisionInTree(NoSuchRevision):
939
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
940
 
    
941
 
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
1171
 
 
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
942
1173
 
943
1174
    def __init__(self, tree, revision_id):
944
1175
        BzrError.__init__(self)
948
1179
 
949
1180
class InvalidRevisionSpec(BzrError):
950
1181
 
951
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
952
1183
            " %(branch)s%(extra)s")
953
1184
 
954
1185
    def __init__(self, spec, branch, extra=None):
979
1210
class DivergedBranches(BzrError):
980
1211
 
981
1212
    _fmt = ("These branches have diverged."
982
 
            " Use the merge command to reconcile them.")
983
 
 
984
 
    internal_error = False
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
985
1215
 
986
1216
    def __init__(self, branch1, branch2):
987
1217
        self.branch1 = branch1
988
1218
        self.branch2 = branch2
989
1219
 
990
1220
 
991
 
class NotLefthandHistory(BzrError):
 
1221
class NotLefthandHistory(InternalBzrError):
992
1222
 
993
1223
    _fmt = "Supplied history does not follow left-hand parents"
994
1224
 
995
 
    internal_error = True
996
 
 
997
1225
    def __init__(self, history):
998
1226
        BzrError.__init__(self, history=history)
999
1227
 
1003
1231
    _fmt = ("Branches have no common ancestor, and"
1004
1232
            " no merge base revision was specified.")
1005
1233
 
1006
 
    internal_error = False
 
1234
 
 
1235
class CannotReverseCherrypick(BzrError):
 
1236
 
 
1237
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1238
            ' or diff3.')
1007
1239
 
1008
1240
 
1009
1241
class NoCommonAncestor(BzrError):
1010
 
    
 
1242
 
1011
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1012
1244
 
1013
1245
    def __init__(self, revision_a, revision_b):
1033
1265
            not_ancestor_id=not_ancestor_id)
1034
1266
 
1035
1267
 
1036
 
class InstallFailed(BzrError):
1037
 
 
1038
 
    def __init__(self, revisions):
1039
 
        revision_str = ", ".join(str(r) for r in revisions)
1040
 
        msg = "Could not install revisions:\n%s" % revision_str
1041
 
        BzrError.__init__(self, msg)
1042
 
        self.revisions = revisions
1043
 
 
1044
 
 
1045
1268
class AmbiguousBase(BzrError):
1046
1269
 
1047
1270
    def __init__(self, bases):
1048
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1049
 
                DeprecationWarning)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1050
1273
        msg = ("The correct base is unclear, because %s are all equally close"
1051
1274
                % ", ".join(bases))
1052
1275
        BzrError.__init__(self, msg)
1053
1276
        self.bases = bases
1054
1277
 
1055
1278
 
1056
 
class NoCommits(BzrError):
 
1279
class NoCommits(BranchError):
1057
1280
 
1058
1281
    _fmt = "Branch %(branch)s has no commits."
1059
1282
 
1060
 
    def __init__(self, branch):
1061
 
        BzrError.__init__(self, branch=branch)
1062
 
 
1063
1283
 
1064
1284
class UnlistableStore(BzrError):
1065
1285
 
1076
1296
 
1077
1297
class BoundBranchOutOfDate(BzrError):
1078
1298
 
1079
 
    _fmt = ("Bound branch %(branch)s is out of date"
1080
 
            " with master branch %(master)s.")
 
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1300
            " %(master)s.%(extra_help)s")
1081
1301
 
1082
1302
    def __init__(self, branch, master):
1083
1303
        BzrError.__init__(self)
1084
1304
        self.branch = branch
1085
1305
        self.master = master
1086
 
 
1087
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
1088
1309
class CommitToDoubleBoundBranch(BzrError):
1089
1310
 
1090
1311
    _fmt = ("Cannot commit to branch %(branch)s."
1120
1341
 
1121
1342
class WeaveError(BzrError):
1122
1343
 
1123
 
    _fmt = "Error in processing weave: %(message)s"
 
1344
    _fmt = "Error in processing weave: %(msg)s"
1124
1345
 
1125
 
    def __init__(self, message=None):
 
1346
    def __init__(self, msg=None):
1126
1347
        BzrError.__init__(self)
1127
 
        self.message = message
 
1348
        self.msg = msg
1128
1349
 
1129
1350
 
1130
1351
class WeaveRevisionAlreadyPresent(WeaveError):
1159
1380
 
1160
1381
class WeaveParentMismatch(WeaveError):
1161
1382
 
1162
 
    _fmt = "Parents are mismatched between two revisions."
1163
 
    
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1384
 
1164
1385
 
1165
1386
class WeaveInvalidChecksum(WeaveError):
1166
1387
 
1192
1413
 
1193
1414
 
1194
1415
class VersionedFileError(BzrError):
1195
 
    
 
1416
 
1196
1417
    _fmt = "Versioned file error"
1197
1418
 
1198
1419
 
1199
1420
class RevisionNotPresent(VersionedFileError):
1200
 
    
1201
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1421
 
 
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1202
1423
 
1203
1424
    def __init__(self, revision_id, file_id):
1204
1425
        VersionedFileError.__init__(self)
1207
1428
 
1208
1429
 
1209
1430
class RevisionAlreadyPresent(VersionedFileError):
1210
 
    
1211
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1431
 
 
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1212
1433
 
1213
1434
    def __init__(self, revision_id, file_id):
1214
1435
        VersionedFileError.__init__(self)
1216
1437
        self.file_id = file_id
1217
1438
 
1218
1439
 
1219
 
class KnitError(BzrError):
1220
 
    
 
1440
class VersionedFileInvalidChecksum(VersionedFileError):
 
1441
 
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
 
1443
 
 
1444
 
 
1445
class KnitError(InternalBzrError):
 
1446
 
1221
1447
    _fmt = "Knit error"
1222
1448
 
1223
 
    internal_error = True
1224
 
 
1225
 
 
1226
 
class KnitHeaderError(KnitError):
1227
 
 
1228
 
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
1229
 
 
1230
 
    def __init__(self, badline, filename):
1231
 
        KnitError.__init__(self)
1232
 
        self.badline = badline
1233
 
        self.filename = filename
1234
 
 
1235
1449
 
1236
1450
class KnitCorrupt(KnitError):
1237
1451
 
1243
1457
        self.how = how
1244
1458
 
1245
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
 
1246
1504
class KnitIndexUnknownMethod(KnitError):
1247
1505
    """Raised when we don't understand the storage method.
1248
1506
 
1249
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1250
1508
    """
1251
 
    
 
1509
 
1252
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1253
1511
            " in options: %(options)r")
1254
1512
 
1258
1516
        self.options = options
1259
1517
 
1260
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
 
1261
1565
class NoSuchExportFormat(BzrError):
1262
 
    
 
1566
 
1263
1567
    _fmt = "Export format %(format)r not supported"
1264
1568
 
1265
1569
    def __init__(self, format):
1268
1572
 
1269
1573
 
1270
1574
class TransportError(BzrError):
1271
 
    
 
1575
 
1272
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1273
1577
 
1274
1578
    def __init__(self, msg=None, orig_error=None):
1283
1587
        BzrError.__init__(self)
1284
1588
 
1285
1589
 
1286
 
class TooManyConcurrentRequests(BzrError):
 
1590
class TooManyConcurrentRequests(InternalBzrError):
1287
1591
 
1288
1592
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1289
1593
            " Be sure to finish_writing and finish_reading on the"
1290
1594
            " currently open request.")
1291
1595
 
1292
 
    internal_error = True
1293
 
 
1294
1596
    def __init__(self, medium):
1295
1597
        self.medium = medium
1296
1598
 
1303
1605
        self.details = details
1304
1606
 
1305
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
 
1306
1638
# A set of semi-meaningful errors which can be thrown
1307
1639
class TransportNotPossible(TransportError):
1308
1640
 
1333
1665
            self.port = ':%s' % port
1334
1666
 
1335
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1336
1670
class ConnectionReset(TransportError):
1337
1671
 
1338
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1340
1674
 
1341
1675
class InvalidRange(TransportError):
1342
1676
 
1343
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1344
 
    
1345
 
    def __init__(self, path, offset):
1346
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1347
 
                                       % (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)
1348
1681
        self.path = path
1349
1682
        self.offset = offset
1350
1683
 
1361
1694
class InvalidHttpRange(InvalidHttpResponse):
1362
1695
 
1363
1696
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1364
 
    
 
1697
 
1365
1698
    def __init__(self, path, range, msg):
1366
1699
        self.range = range
1367
1700
        InvalidHttpResponse.__init__(self, path, msg)
1370
1703
class InvalidHttpContentType(InvalidHttpResponse):
1371
1704
 
1372
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1373
 
    
 
1706
 
1374
1707
    def __init__(self, path, ctype, msg):
1375
1708
        self.ctype = ctype
1376
1709
        InvalidHttpResponse.__init__(self, path, msg)
1380
1713
 
1381
1714
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1382
1715
 
1383
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1716
    def __init__(self, source, target, is_permanent=False):
1384
1717
        self.source = source
1385
1718
        self.target = target
1386
 
        if is_permament:
 
1719
        if is_permanent:
1387
1720
            self.permanently = ' permanently'
1388
1721
        else:
1389
1722
            self.permanently = ''
1390
 
        self.is_permament = is_permament
1391
 
        self._qualified_proto = qual_proto
1392
1723
        TransportError.__init__(self)
1393
1724
 
1394
 
    def _requalify_url(self, url):
1395
 
        """Restore the qualified proto in front of the url"""
1396
 
        # When this exception is raised, source and target are in
1397
 
        # user readable format. But some transports may use a
1398
 
        # different proto (http+urllib:// will present http:// to
1399
 
        # the user. If a qualified proto is specified, the code
1400
 
        # trapping the exception can get the qualified urls to
1401
 
        # properly handle the redirection themself (creating a
1402
 
        # new transport object from the target url for example).
1403
 
        # But checking that the scheme of the original and
1404
 
        # redirected urls are the same can be tricky. (see the
1405
 
        # FIXME in BzrDir.open_from_transport for the unique use
1406
 
        # case so far).
1407
 
        if self._qualified_proto is None:
1408
 
            return url
1409
 
 
1410
 
        # The TODO related to NotBranchError mention that doing
1411
 
        # that kind of manipulation on the urls may not be the
1412
 
        # exception object job. On the other hand, this object is
1413
 
        # the interface between the code and the user so
1414
 
        # presenting the urls in different ways is indeed its
1415
 
        # job...
1416
 
        import urlparse
1417
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1418
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1419
 
                                   query, fragment))
1420
 
 
1421
 
    def get_source_url(self):
1422
 
        return self._requalify_url(self.source)
1423
 
 
1424
 
    def get_target_url(self):
1425
 
        return self._requalify_url(self.target)
1426
 
 
1427
1725
 
1428
1726
class TooManyRedirections(TransportError):
1429
1727
 
1430
1728
    _fmt = "Too many redirections"
1431
1729
 
 
1730
 
1432
1731
class ConflictsInTree(BzrError):
1433
1732
 
1434
1733
    _fmt = "Working tree has conflicts."
1440
1739
        if filename is None:
1441
1740
            filename = ""
1442
1741
        message = "Error(s) parsing config file %s:\n%s" % \
1443
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1742
            (filename, ('\n'.join(e.msg for e in errors)))
1444
1743
        BzrError.__init__(self, message)
1445
1744
 
1446
1745
 
1455
1754
 
1456
1755
class SigningFailed(BzrError):
1457
1756
 
1458
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1459
1758
 
1460
1759
    def __init__(self, command_line):
1461
1760
        BzrError.__init__(self, command_line=command_line)
1463
1762
 
1464
1763
class WorkingTreeNotRevision(BzrError):
1465
1764
 
1466
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1467
1766
            " the last commit, but weave merge requires that it be"
1468
1767
            " unchanged")
1469
1768
 
1486
1785
        self.graph = graph
1487
1786
 
1488
1787
 
1489
 
class WritingCompleted(BzrError):
 
1788
class WritingCompleted(InternalBzrError):
1490
1789
 
1491
1790
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1492
1791
            "called upon it - accept bytes may not be called anymore.")
1493
1792
 
1494
 
    internal_error = True
1495
 
 
1496
1793
    def __init__(self, request):
1497
1794
        self.request = request
1498
1795
 
1499
1796
 
1500
 
class WritingNotComplete(BzrError):
 
1797
class WritingNotComplete(InternalBzrError):
1501
1798
 
1502
1799
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1503
1800
            "called upon it - until the write phase is complete no "
1504
1801
            "data may be read.")
1505
1802
 
1506
 
    internal_error = True
1507
 
 
1508
1803
    def __init__(self, request):
1509
1804
        self.request = request
1510
1805
 
1518
1813
        self.filename = filename
1519
1814
 
1520
1815
 
1521
 
class MediumNotConnected(BzrError):
 
1816
class MediumNotConnected(InternalBzrError):
1522
1817
 
1523
1818
    _fmt = """The medium '%(medium)s' is not connected."""
1524
1819
 
1525
 
    internal_error = True
1526
 
 
1527
1820
    def __init__(self, medium):
1528
1821
        self.medium = medium
1529
1822
 
1535
1828
 
1536
1829
class NoBundleFound(BzrError):
1537
1830
 
1538
 
    _fmt = "No bundle was found in %(filename)s"
 
1831
    _fmt = 'No bundle was found in "%(filename)s".'
1539
1832
 
1540
1833
    def __init__(self, filename):
1541
1834
        BzrError.__init__(self)
1605
1898
        self.root_trans_id = transform.root
1606
1899
 
1607
1900
 
1608
 
class BzrBadParameter(BzrError):
 
1901
class BzrBadParameter(InternalBzrError):
1609
1902
 
1610
1903
    _fmt = "Bad parameter: %(param)r"
1611
1904
 
1612
 
    internal_error = True
1613
 
 
1614
1905
    # This exception should never be thrown, but it is a base class for all
1615
1906
    # parameter-to-function errors.
1616
1907
 
1639
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1640
1931
 
1641
1932
    def __init__(self, from_path='', to_path='', extra=None):
 
1933
        from bzrlib.osutils import splitpath
1642
1934
        BzrError.__init__(self)
1643
1935
        if extra:
1644
1936
            self.extra = ': ' + str(extra)
1648
1940
        has_from = len(from_path) > 0
1649
1941
        has_to = len(to_path) > 0
1650
1942
        if has_from:
1651
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1943
            self.from_path = splitpath(from_path)[-1]
1652
1944
        else:
1653
1945
            self.from_path = ''
1654
1946
 
1655
1947
        if has_to:
1656
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1948
            self.to_path = splitpath(to_path)[-1]
1657
1949
        else:
1658
1950
            self.to_path = ''
1659
1951
 
1678
1970
class BzrRemoveChangedFilesError(BzrError):
1679
1971
    """Used when user is trying to remove changed files."""
1680
1972
 
1681
 
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1973
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1974
        "%(changes_as_text)s"
1682
1975
        "Use --keep to not delete them, or --force to delete them regardless.")
1683
1976
 
1684
1977
    def __init__(self, tree_delta):
1741
2034
 
1742
2035
class BadConversionTarget(BzrError):
1743
2036
 
1744
 
    _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"
1745
2039
 
1746
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
1747
2041
        BzrError.__init__(self)
1748
2042
        self.problem = problem
1749
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)
1750
2061
 
1751
2062
 
1752
2063
class NoDiff(BzrError):
1762
2073
    _fmt = "Diff3 is not installed on this machine."
1763
2074
 
1764
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
 
1765
2082
class ExistingLimbo(BzrError):
1766
2083
 
1767
2084
    _fmt = """This tree contains left-over files from a failed operation.
1768
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1769
2086
    keep, and delete it when you are done."""
1770
 
    
 
2087
 
1771
2088
    def __init__(self, limbo_dir):
1772
2089
       BzrError.__init__(self)
1773
2090
       self.limbo_dir = limbo_dir
1774
2091
 
1775
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
 
1776
2103
class ImmortalLimbo(BzrError):
1777
2104
 
1778
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2105
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1779
2106
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1780
2107
    keep, and delete it when you are done."""
1781
2108
 
1784
2111
       self.limbo_dir = limbo_dir
1785
2112
 
1786
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
 
1787
2124
class OutOfDateTree(BzrError):
1788
2125
 
1789
 
    _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"
1790
2127
 
1791
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
1792
2133
        BzrError.__init__(self)
1793
2134
        self.tree = tree
 
2135
        self.more = more
1794
2136
 
1795
2137
 
1796
2138
class PublicBranchOutOfDate(BzrError):
1816
2158
    _fmt = "Format error in conflict listings"
1817
2159
 
1818
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
 
1819
2172
class CorruptRepository(BzrError):
1820
2173
 
1821
2174
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1823
2176
 
1824
2177
    def __init__(self, repo):
1825
2178
        BzrError.__init__(self)
1826
 
        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
1827
2205
 
1828
2206
 
1829
2207
class UpgradeRequired(BzrError):
1835
2213
        self.path = path
1836
2214
 
1837
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
 
1838
2227
class LocalRequiresBoundBranch(BzrError):
1839
2228
 
1840
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
1841
2230
 
1842
2231
 
1843
 
class MissingProgressBarFinish(BzrError):
1844
 
 
1845
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1846
 
 
1847
 
 
1848
 
class InvalidProgressBarType(BzrError):
1849
 
 
1850
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1851
 
            " is not a supported type Select one of: %(valid_types)s")
1852
 
 
1853
 
    def __init__(self, bar_type, valid_types):
1854
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1855
 
 
1856
 
 
1857
2232
class UnsupportedOperation(BzrError):
1858
2233
 
1859
2234
    _fmt = ("The method %(mname)s is not supported on"
1876
2251
 
1877
2252
 
1878
2253
class BinaryFile(BzrError):
1879
 
    
 
2254
 
1880
2255
    _fmt = "File is binary but should be text."
1881
2256
 
1882
2257
 
1902
2277
 
1903
2278
 
1904
2279
class NotABundle(BzrError):
1905
 
    
 
2280
 
1906
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
1907
2282
 
1908
2283
    def __init__(self, text):
1910
2285
        self.text = text
1911
2286
 
1912
2287
 
1913
 
class BadBundle(BzrError): 
1914
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
1915
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
1916
2291
 
1917
2292
    def __init__(self, text):
1919
2294
        self.text = text
1920
2295
 
1921
2296
 
1922
 
class MalformedHeader(BadBundle): 
1923
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
1924
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1925
2300
 
1926
2301
 
1927
 
class MalformedPatches(BadBundle): 
1928
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
1929
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1930
2305
 
1931
2306
 
1932
 
class MalformedFooter(BadBundle): 
1933
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
1934
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1935
2310
 
1936
2311
 
1937
2312
class UnsupportedEOLMarker(BadBundle):
1938
 
    
1939
 
    _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"
1940
2315
 
1941
2316
    def __init__(self):
1942
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
1943
2318
        # but for this there is not
1944
2319
        BzrError.__init__(self)
1945
2320
 
1946
2321
 
1947
2322
class IncompatibleBundleFormat(BzrError):
1948
 
    
 
2323
 
1949
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1950
2325
 
1951
2326
    def __init__(self, bundle_format, other):
1955
2330
 
1956
2331
 
1957
2332
class BadInventoryFormat(BzrError):
1958
 
    
 
2333
 
1959
2334
    _fmt = "Root class for inventory serialization errors"
1960
2335
 
1961
2336
 
1972
2347
    _fmt = """This operation requires rich root data storage"""
1973
2348
 
1974
2349
 
1975
 
class NoSmartMedium(BzrError):
 
2350
class NoSmartMedium(InternalBzrError):
1976
2351
 
1977
2352
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1978
2353
 
1979
 
    internal_error = True
1980
 
 
1981
2354
    def __init__(self, transport):
1982
2355
        self.transport = transport
1983
2356
 
1984
2357
 
1985
 
class NoSmartServer(NotBranchError):
1986
 
 
1987
 
    _fmt = "No smart server available at %(url)s"
1988
 
 
1989
 
    def __init__(self, url):
1990
 
        self.url = url
1991
 
 
1992
 
 
1993
2358
class UnknownSSH(BzrError):
1994
2359
 
1995
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2005
2370
            " Please set BZR_SSH environment variable.")
2006
2371
 
2007
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
 
2008
2384
class GhostRevisionUnusableHere(BzrError):
2009
2385
 
2010
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2014
2390
        self.revision_id = revision_id
2015
2391
 
2016
2392
 
2017
 
class IllegalUseOfScopeReplacer(BzrError):
 
2393
class IllegalUseOfScopeReplacer(InternalBzrError):
2018
2394
 
2019
2395
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2020
2396
            " %(msg)s%(extra)s")
2021
2397
 
2022
 
    internal_error = True
2023
 
 
2024
2398
    def __init__(self, name, msg, extra=None):
2025
2399
        BzrError.__init__(self)
2026
2400
        self.name = name
2031
2405
            self.extra = ''
2032
2406
 
2033
2407
 
2034
 
class InvalidImportLine(BzrError):
 
2408
class InvalidImportLine(InternalBzrError):
2035
2409
 
2036
2410
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2037
2411
 
2038
 
    internal_error = True
2039
 
 
2040
2412
    def __init__(self, text, msg):
2041
2413
        BzrError.__init__(self)
2042
2414
        self.text = text
2043
2415
        self.msg = msg
2044
2416
 
2045
2417
 
2046
 
class ImportNameCollision(BzrError):
 
2418
class ImportNameCollision(InternalBzrError):
2047
2419
 
2048
2420
    _fmt = ("Tried to import an object to the same name as"
2049
2421
            " an existing object. %(name)s")
2050
2422
 
2051
 
    internal_error = True
2052
 
 
2053
2423
    def __init__(self, name):
2054
2424
        BzrError.__init__(self)
2055
2425
        self.name = name
2068
2438
        " branch location."
2069
2439
 
2070
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
 
2071
2457
class PatchMissing(BzrError):
2072
2458
    """Raise a patch type was specified but no patch supplied"""
2073
2459
 
2074
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2460
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
2075
2461
 
2076
2462
    def __init__(self, patch_type):
2077
2463
        BzrError.__init__(self)
2078
2464
        self.patch_type = patch_type
2079
2465
 
2080
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
 
2081
2480
class UnsupportedInventoryKind(BzrError):
2082
 
    
 
2481
 
2083
2482
    _fmt = """Unsupported entry kind %(kind)s"""
2084
2483
 
2085
2484
    def __init__(self, kind):
2088
2487
 
2089
2488
class BadSubsumeSource(BzrError):
2090
2489
 
2091
 
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
2490
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
2092
2491
 
2093
2492
    def __init__(self, tree, other_tree, reason):
2094
2493
        self.tree = tree
2097
2496
 
2098
2497
 
2099
2498
class SubsumeTargetNeedsUpgrade(BzrError):
2100
 
    
 
2499
 
2101
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2102
2501
 
2103
2502
    def __init__(self, other_tree):
2104
2503
        self.other_tree = other_tree
2105
2504
 
2106
2505
 
2107
 
class BadReferenceTarget(BzrError):
2108
 
 
2109
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
2110
 
 
2111
 
    internal_error = True
 
2506
class BadReferenceTarget(InternalBzrError):
 
2507
 
 
2508
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2509
           "%(reason)s"
2112
2510
 
2113
2511
    def __init__(self, tree, other_tree, reason):
2114
2512
        self.tree = tree
2127
2525
class TagsNotSupported(BzrError):
2128
2526
 
2129
2527
    _fmt = ("Tags not supported by %(branch)s;"
2130
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2528
            " you may be able to use bzr upgrade.")
2131
2529
 
2132
2530
    def __init__(self, branch):
2133
2531
        self.branch = branch
2134
2532
 
2135
 
        
 
2533
 
2136
2534
class TagAlreadyExists(BzrError):
2137
2535
 
2138
2536
    _fmt = "Tag %(tag_name)s already exists."
2143
2541
 
2144
2542
class MalformedBugIdentifier(BzrError):
2145
2543
 
2146
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2544
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2545
            'See "bzr help bugs" for more information on this feature.')
2147
2546
 
2148
2547
    def __init__(self, bug_id, reason):
2149
2548
        self.bug_id = bug_id
2150
2549
        self.reason = reason
2151
2550
 
2152
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
 
2153
2562
class UnknownBugTrackerAbbreviation(BzrError):
2154
2563
 
2155
2564
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2160
2569
        self.branch = branch
2161
2570
 
2162
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
 
2163
2588
class UnexpectedSmartServerResponse(BzrError):
2164
2589
 
2165
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2168
2593
        self.response_tuple = response_tuple
2169
2594
 
2170
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
 
2171
2641
class ContainerError(BzrError):
2172
2642
    """Base class of container errors."""
2173
2643
 
2175
2645
class UnknownContainerFormatError(ContainerError):
2176
2646
 
2177
2647
    _fmt = "Unrecognised container format: %(container_format)r"
2178
 
    
 
2648
 
2179
2649
    def __init__(self, container_format):
2180
2650
        self.container_format = container_format
2181
2651
 
2184
2654
 
2185
2655
    _fmt = "Unexpected end of container stream"
2186
2656
 
2187
 
    internal_error = False
2188
 
 
2189
2657
 
2190
2658
class UnknownRecordTypeError(ContainerError):
2191
2659
 
2213
2681
 
2214
2682
class DuplicateRecordNameError(ContainerError):
2215
2683
 
2216
 
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
2217
2685
 
2218
2686
    def __init__(self, name):
2219
2687
        self.name = name
2220
2688
 
2221
2689
 
2222
 
class NoDestinationAddress(BzrError):
 
2690
class NoDestinationAddress(InternalBzrError):
2223
2691
 
2224
2692
    _fmt = "Message does not have a destination address."
2225
2693
 
2226
 
    internal_error = True
 
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
2227
2701
 
2228
2702
 
2229
2703
class SMTPError(BzrError):
2232
2706
 
2233
2707
    def __init__(self, error):
2234
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