← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

merge append-revision fix

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.
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
264
207
        self.transport = transport
265
208
 
266
209
 
267
 
class InvalidEntryName(InternalBzrError):
268
 
 
 
210
class InvalidEntryName(BzrError):
 
211
    
269
212
    _fmt = "Invalid entry name: %(name)s"
270
213
 
 
214
    internal_error = True
 
215
 
271
216
    def __init__(self, name):
272
217
        BzrError.__init__(self)
273
218
        self.name = name
274
219
 
275
220
 
276
221
class InvalidRevisionNumber(BzrError):
277
 
 
 
222
    
278
223
    _fmt = "Invalid revision number %(revno)s"
279
224
 
280
225
    def __init__(self, revno):
292
237
        self.revision_id = revision_id
293
238
        self.branch = branch
294
239
 
295
 
 
296
240
class ReservedId(BzrError):
297
241
 
298
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
301
245
        self.revision_id = revision_id
302
246
 
303
247
 
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
248
class NoHelpTopic(BzrError):
321
249
 
322
250
    _fmt = ("No help could be found for '%(topic)s'. "
328
256
 
329
257
class NoSuchId(BzrError):
330
258
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
259
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
260
    
333
261
    def __init__(self, tree, file_id):
334
262
        BzrError.__init__(self)
335
263
        self.file_id = file_id
336
264
        self.tree = tree
337
265
 
338
266
 
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):
 
267
class InventoryModified(BzrError):
354
268
 
355
269
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
270
            " so a clean inventory cannot be read without data loss.")
357
271
 
 
272
    internal_error = True
 
273
 
358
274
    def __init__(self, tree):
359
275
        self.tree = tree
360
276
 
361
277
 
362
278
class NoWorkingTree(BzrError):
363
279
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
280
    _fmt = "No WorkingTree exists for %(base)s."
 
281
    
366
282
    def __init__(self, base):
367
283
        BzrError.__init__(self)
368
284
        self.base = base
381
297
        self.url = url
382
298
 
383
299
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
300
class WorkingTreeAlreadyPopulated(BzrError):
 
301
 
 
302
    _fmt = """Working tree already populated in %(base)s"""
 
303
 
 
304
    internal_error = True
387
305
 
388
306
    def __init__(self, base):
389
307
        self.base = base
390
308
 
391
 
 
392
309
class BzrCommandError(BzrError):
393
310
    """Error from user command"""
394
311
 
 
312
    internal_error = False
 
313
 
395
314
    # Error from malformed user command; please avoid raising this as a
396
315
    # generic exception not caused by user input.
397
316
    #
399
318
    # are not intended to be caught anyway.  UI code need not subclass
400
319
    # BzrCommandError, and non-UI code should not throw a subclass of
401
320
    # 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
402
331
 
403
332
 
404
333
class NotWriteLocked(BzrError):
477
406
    def __init__(self, name, value):
478
407
        BzrError.__init__(self, name=name, value=value)
479
408
 
480
 
 
 
409
    
481
410
class StrictCommitFailed(BzrError):
482
411
 
483
412
    _fmt = "Commit refused because there are unknown files in the tree"
486
415
# XXX: Should be unified with TransportError; they seem to represent the
487
416
# same thing
488
417
# 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
 
418
# - this is finer than a TransportError - and more useful as such. It 
490
419
# differentiates between 'transport has failed' and 'operation on a transport
491
420
# has failed.'
492
421
class PathError(BzrError):
493
 
 
 
422
    
494
423
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
424
 
496
425
    def __init__(self, path, extra=None):
516
445
    """Used when renaming and both source and dest exist."""
517
446
 
518
447
    _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")
 
448
            "%(extra)s")
521
449
 
522
450
    def __init__(self, source, dest, extra=None):
523
451
        BzrError.__init__(self)
531
459
 
532
460
class NotADirectory(PathError):
533
461
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
462
    _fmt = "%(path)r is not a directory %(extra)s"
535
463
 
536
464
 
537
465
class NotInWorkingDirectory(PathError):
538
466
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
467
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
468
 
541
469
 
542
470
class DirectoryNotEmpty(PathError):
543
471
 
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
 
 
 
472
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
473
 
 
474
 
 
475
class ReadingCompleted(BzrError):
 
476
    
554
477
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
478
            "called upon it - the request has been completed and no more "
556
479
            "data may be read.")
557
480
 
 
481
    internal_error = True
 
482
 
558
483
    def __init__(self, request):
559
484
        self.request = request
560
485
 
561
486
 
562
487
class ResourceBusy(PathError):
563
488
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
489
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
490
 
566
491
 
567
492
class PermissionDenied(PathError):
568
493
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
494
    _fmt = "Permission denied: %(path)r%(extra)s"
570
495
 
571
496
 
572
497
class InvalidURL(PathError):
573
498
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
499
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
500
 
576
501
 
577
502
class InvalidURLJoin(PathError):
578
503
 
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
 
504
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
505
 
 
506
    def __init__(self, msg, base, args):
 
507
        PathError.__init__(self, base, msg)
 
508
        self.args = [base] + list(args)
608
509
 
609
510
 
610
511
class UnknownHook(BzrError):
625
526
        PathError.__init__(self, url, extra=extra)
626
527
 
627
528
 
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
529
class ReadError(PathError):
661
 
 
 
530
    
662
531
    _fmt = """Error reading from %(path)r."""
663
532
 
664
533
 
665
534
class ShortReadvError(PathError):
666
535
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
536
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
537
            " at %(offset)s for %(path)s%(extra)s")
669
538
 
670
539
    internal_error = True
671
540
 
678
547
 
679
548
class PathNotChild(PathError):
680
549
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
550
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
682
551
 
683
552
    internal_error = True
684
553
 
694
563
 
695
564
class InvalidNormalization(PathError):
696
565
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
566
    _fmt = "Path %(path)r is not unicode normalized"
698
567
 
699
568
 
700
569
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
570
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
571
# TODO: Probably this behavior of should be a common superclass 
703
572
class NotBranchError(PathError):
704
573
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
574
    _fmt = "Not a branch: %(path)s"
706
575
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
576
    def __init__(self, path):
708
577
       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)
 
578
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
579
 
732
580
 
733
581
class NoSubmitBranch(PathError):
741
589
 
742
590
class AlreadyBranchError(PathError):
743
591
 
744
 
    _fmt = 'Already a branch: "%(path)s".'
 
592
    _fmt = "Already a branch: %(path)s."
745
593
 
746
594
 
747
595
class BranchExistsWithoutWorkingTree(PathError):
748
596
 
749
 
    _fmt = 'Directory contains a branch, but no working tree \
750
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
597
    _fmt = "Directory contains a branch, but no working tree \
 
598
(use bzr checkout if you wish to build a working tree): %(path)s"
751
599
 
752
600
 
753
601
class AtomicFileAlreadyClosed(PathError):
754
602
 
755
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
756
 
            ' "%(path)s"')
 
603
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
604
            " %(path)s")
757
605
 
758
606
    def __init__(self, path, function):
759
607
        PathError.__init__(self, path=path, extra=None)
762
610
 
763
611
class InaccessibleParent(PathError):
764
612
 
765
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
766
 
            ' relative path "%(path)s"')
 
613
    _fmt = ("Parent not accessible given base %(base)s and"
 
614
            " relative path %(path)s")
767
615
 
768
616
    def __init__(self, path, base):
769
617
        PathError.__init__(self, path)
772
620
 
773
621
class NoRepositoryPresent(BzrError):
774
622
 
775
 
    _fmt = 'No repository present: "%(path)s"'
 
623
    _fmt = "No repository present: %(path)r"
776
624
    def __init__(self, bzrdir):
777
625
        BzrError.__init__(self)
778
626
        self.path = bzrdir.transport.clone('..').base
780
628
 
781
629
class FileInWrongBranch(BzrError):
782
630
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
631
    _fmt = "File %(path)s in not in branch %(branch_base)s."
784
632
 
785
633
    def __init__(self, branch, path):
786
634
        BzrError.__init__(self)
795
643
 
796
644
 
797
645
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
 
646
    
 
647
    _fmt = "Unknown branch format: %(format)r"
804
648
 
805
649
 
806
650
class IncompatibleFormat(BzrError):
807
 
 
 
651
    
808
652
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
653
 
810
654
    def __init__(self, format, bzrdir_format):
814
658
 
815
659
 
816
660
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)
 
661
 
 
662
    _fmt = "Repository %(target)s is not compatible with repository"\
 
663
        " %(source)s"
 
664
 
 
665
    def __init__(self, source, target):
 
666
        BzrError.__init__(self, target=target, source=source)
833
667
 
834
668
 
835
669
class IncompatibleRevision(BzrError):
836
 
 
 
670
    
837
671
    _fmt = "Revision is not compatible with %(repo_format)s"
838
672
 
839
673
    def __init__(self, repo_format):
844
678
class AlreadyVersionedError(BzrError):
845
679
    """Used when a path is expected not to be versioned, but it is."""
846
680
 
847
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
681
    _fmt = "%(context_info)s%(path)s is already versioned"
848
682
 
849
683
    def __init__(self, path, context_info=None):
850
684
        """Construct a new AlreadyVersionedError.
865
699
class NotVersionedError(BzrError):
866
700
    """Used when a path is expected to be versioned, but it is not."""
867
701
 
868
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
702
    _fmt = "%(context_info)s%(path)s is not versioned"
869
703
 
870
704
    def __init__(self, path, context_info=None):
871
705
        """Construct a new NotVersionedError.
922
756
        BzrError.__init__(self, filename=filename, kind=kind)
923
757
 
924
758
 
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
759
class ForbiddenControlFileError(BzrError):
937
760
 
938
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
939
 
 
940
 
 
941
 
class LockError(InternalBzrError):
 
761
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
762
 
 
763
 
 
764
class LockError(BzrError):
942
765
 
943
766
    _fmt = "Lock error: %(msg)s"
944
767
 
 
768
    internal_error = True
 
769
 
945
770
    # All exceptions from the lock/unlock functions should be from
946
771
    # this exception class.  They will be translated as necessary. The
947
772
    # original exception is available as e.original_error
949
774
    # New code should prefer to raise specific subclasses
950
775
    def __init__(self, message):
951
776
        # 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.
 
777
        # so use a different variable name
 
778
        # so it is exposed in self.__dict__
954
779
        self.msg = message
955
780
 
956
781
 
991
816
        self.obj = obj
992
817
 
993
818
 
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):
 
819
class ReadOnlyLockError(LockError):
 
820
 
 
821
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
822
 
 
823
    def __init__(self, fname, msg):
1001
824
        LockError.__init__(self, '')
1002
 
        self.lock = lock
1003
 
        self.why = why
 
825
        self.fname = fname
 
826
        self.msg = msg
1004
827
 
1005
828
 
1006
829
class OutSideTransaction(BzrError):
1030
853
 
1031
854
class UnlockableTransport(LockError):
1032
855
 
1033
 
    internal_error = False
1034
 
 
1035
856
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1036
857
 
1037
858
    def __init__(self, transport):
1040
861
 
1041
862
class LockContention(LockError):
1042
863
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
864
    _fmt = "Could not acquire lock %(lock)s"
1044
865
    # TODO: show full url for lock, combining the transport and relative
1045
866
    # bits?
1046
867
 
1047
868
    internal_error = False
1048
869
 
1049
 
    def __init__(self, lock, msg=''):
 
870
    def __init__(self, lock):
1050
871
        self.lock = lock
1051
 
        self.msg = msg
1052
872
 
1053
873
 
1054
874
class LockBroken(LockError):
1089
909
 
1090
910
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1091
911
 
 
912
    internal_error = True
 
913
 
1092
914
    def __init__(self, obj):
1093
915
        self.obj = obj
1094
916
 
1119
941
        BzrError.__init__(self, files=files, files_str=files_str)
1120
942
 
1121
943
 
1122
 
class BadCommitMessageEncoding(BzrError):
1123
 
 
1124
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1125
 
        'the current encoding.'
1126
 
 
1127
 
 
1128
944
class UpgradeReadonly(BzrError):
1129
945
 
1130
946
    _fmt = "Upgrade URL cannot work with readonly URLs."
1144
960
    _fmt = "Commit refused because there are unknowns in the tree."
1145
961
 
1146
962
 
1147
 
class NoSuchRevision(InternalBzrError):
 
963
class NoSuchRevision(BzrError):
1148
964
 
1149
965
    _fmt = "%(branch)s has no revision %(revision)s"
1150
966
 
 
967
    internal_error = True
 
968
 
1151
969
    def __init__(self, branch, revision):
1152
970
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1153
971
        BzrError.__init__(self, branch=branch, revision=revision)
1154
972
 
1155
973
 
1156
 
class RangeInChangeOption(BzrError):
1157
 
 
1158
 
    _fmt = "Option --change does not accept revision ranges"
 
974
# zero_ninetyone: this exception is no longer raised and should be removed
 
975
class NotLeftParentDescendant(BzrError):
 
976
 
 
977
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
978
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
979
 
 
980
    internal_error = True
 
981
 
 
982
    def __init__(self, branch, old_revision, new_revision):
 
983
        BzrError.__init__(self, branch_location=branch.base,
 
984
                          old_revision=old_revision,
 
985
                          new_revision=new_revision)
1159
986
 
1160
987
 
1161
988
class NoSuchRevisionSpec(BzrError):
1168
995
 
1169
996
class NoSuchRevisionInTree(NoSuchRevision):
1170
997
    """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."
 
998
    
 
999
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1173
1000
 
1174
1001
    def __init__(self, tree, revision_id):
1175
1002
        BzrError.__init__(self)
1179
1006
 
1180
1007
class InvalidRevisionSpec(BzrError):
1181
1008
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1009
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1010
            " %(branch)s%(extra)s")
1184
1011
 
1185
1012
    def __init__(self, spec, branch, extra=None):
1210
1037
class DivergedBranches(BzrError):
1211
1038
 
1212
1039
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1040
            " Use the merge command to reconcile them.")
 
1041
 
 
1042
    internal_error = False
1215
1043
 
1216
1044
    def __init__(self, branch1, branch2):
1217
1045
        self.branch1 = branch1
1218
1046
        self.branch2 = branch2
1219
1047
 
1220
1048
 
1221
 
class NotLefthandHistory(InternalBzrError):
 
1049
class NotLefthandHistory(BzrError):
1222
1050
 
1223
1051
    _fmt = "Supplied history does not follow left-hand parents"
1224
1052
 
 
1053
    internal_error = True
 
1054
 
1225
1055
    def __init__(self, history):
1226
1056
        BzrError.__init__(self, history=history)
1227
1057
 
1231
1061
    _fmt = ("Branches have no common ancestor, and"
1232
1062
            " no merge base revision was specified.")
1233
1063
 
1234
 
 
1235
 
class CannotReverseCherrypick(BzrError):
1236
 
 
1237
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1238
 
            ' or diff3.')
 
1064
    internal_error = False
1239
1065
 
1240
1066
 
1241
1067
class NoCommonAncestor(BzrError):
1242
 
 
 
1068
    
1243
1069
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1070
 
1245
1071
    def __init__(self, revision_a, revision_b):
1265
1091
            not_ancestor_id=not_ancestor_id)
1266
1092
 
1267
1093
 
 
1094
class InstallFailed(BzrError):
 
1095
 
 
1096
    def __init__(self, revisions):
 
1097
        revision_str = ", ".join(str(r) for r in revisions)
 
1098
        msg = "Could not install revisions:\n%s" % revision_str
 
1099
        BzrError.__init__(self, msg)
 
1100
        self.revisions = revisions
 
1101
 
 
1102
 
1268
1103
class AmbiguousBase(BzrError):
1269
1104
 
1270
1105
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1106
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1107
                DeprecationWarning)
1273
1108
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1109
                % ", ".join(bases))
1275
1110
        BzrError.__init__(self, msg)
1276
1111
        self.bases = bases
1277
1112
 
1278
1113
 
1279
 
class NoCommits(BranchError):
 
1114
class NoCommits(BzrError):
1280
1115
 
1281
1116
    _fmt = "Branch %(branch)s has no commits."
1282
1117
 
 
1118
    def __init__(self, branch):
 
1119
        BzrError.__init__(self, branch=branch)
 
1120
 
1283
1121
 
1284
1122
class UnlistableStore(BzrError):
1285
1123
 
1296
1134
 
1297
1135
class BoundBranchOutOfDate(BzrError):
1298
1136
 
1299
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1137
    _fmt = ("Bound branch %(branch)s is out of date"
 
1138
            " with master branch %(master)s.")
1301
1139
 
1302
1140
    def __init__(self, branch, master):
1303
1141
        BzrError.__init__(self)
1304
1142
        self.branch = branch
1305
1143
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1144
 
 
1145
        
1309
1146
class CommitToDoubleBoundBranch(BzrError):
1310
1147
 
1311
1148
    _fmt = ("Cannot commit to branch %(branch)s."
1341
1178
 
1342
1179
class WeaveError(BzrError):
1343
1180
 
1344
 
    _fmt = "Error in processing weave: %(msg)s"
 
1181
    _fmt = "Error in processing weave: %(message)s"
1345
1182
 
1346
 
    def __init__(self, msg=None):
 
1183
    def __init__(self, message=None):
1347
1184
        BzrError.__init__(self)
1348
 
        self.msg = msg
 
1185
        self.message = message
1349
1186
 
1350
1187
 
1351
1188
class WeaveRevisionAlreadyPresent(WeaveError):
1380
1217
 
1381
1218
class WeaveParentMismatch(WeaveError):
1382
1219
 
1383
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1220
    _fmt = "Parents are mismatched between two revisions."
 
1221
    
1385
1222
 
1386
1223
class WeaveInvalidChecksum(WeaveError):
1387
1224
 
1413
1250
 
1414
1251
 
1415
1252
class VersionedFileError(BzrError):
1416
 
 
 
1253
    
1417
1254
    _fmt = "Versioned file error"
1418
1255
 
1419
1256
 
1420
1257
class RevisionNotPresent(VersionedFileError):
1421
 
 
1422
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1258
    
 
1259
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1423
1260
 
1424
1261
    def __init__(self, revision_id, file_id):
1425
1262
        VersionedFileError.__init__(self)
1428
1265
 
1429
1266
 
1430
1267
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
1432
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1268
    
 
1269
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1433
1270
 
1434
1271
    def __init__(self, revision_id, file_id):
1435
1272
        VersionedFileError.__init__(self)
1442
1279
    _fmt = "Text did not match its checksum: %(message)s"
1443
1280
 
1444
1281
 
1445
 
class KnitError(InternalBzrError):
1446
 
 
 
1282
class KnitError(BzrError):
 
1283
    
1447
1284
    _fmt = "Knit error"
1448
1285
 
 
1286
    internal_error = True
 
1287
 
 
1288
 
 
1289
class KnitHeaderError(KnitError):
 
1290
 
 
1291
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1292
 
 
1293
    def __init__(self, badline, filename):
 
1294
        KnitError.__init__(self)
 
1295
        self.badline = badline
 
1296
        self.filename = filename
 
1297
 
1449
1298
 
1450
1299
class KnitCorrupt(KnitError):
1451
1300
 
1457
1306
        self.how = how
1458
1307
 
1459
1308
 
1460
 
class SHA1KnitCorrupt(KnitCorrupt):
1461
 
 
1462
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1463
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1464
 
        "sha %(actual)s")
1465
 
 
1466
 
    def __init__(self, filename, actual, expected, key, content):
1467
 
        KnitError.__init__(self)
1468
 
        self.filename = filename
1469
 
        self.actual = actual
1470
 
        self.expected = expected
1471
 
        self.key = key
1472
 
        self.content = content
1473
 
 
1474
 
 
1475
 
class KnitDataStreamIncompatible(KnitError):
1476
 
    # Not raised anymore, as we can convert data streams.  In future we may
1477
 
    # need it again for more exotic cases, so we're keeping it around for now.
1478
 
 
1479
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1480
 
 
1481
 
    def __init__(self, stream_format, target_format):
1482
 
        self.stream_format = stream_format
1483
 
        self.target_format = target_format
1484
 
 
1485
 
 
1486
 
class KnitDataStreamUnknown(KnitError):
1487
 
    # Indicates a data stream we don't know how to handle.
1488
 
 
1489
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1490
 
 
1491
 
    def __init__(self, stream_format):
1492
 
        self.stream_format = stream_format
1493
 
 
1494
 
 
1495
 
class KnitHeaderError(KnitError):
1496
 
 
1497
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1498
 
 
1499
 
    def __init__(self, badline, filename):
1500
 
        KnitError.__init__(self)
1501
 
        self.badline = badline
1502
 
        self.filename = filename
1503
 
 
1504
1309
class KnitIndexUnknownMethod(KnitError):
1505
1310
    """Raised when we don't understand the storage method.
1506
1311
 
1507
1312
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1313
    """
1509
 
 
 
1314
    
1510
1315
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1316
            " in options: %(options)r")
1512
1317
 
1516
1321
        self.options = options
1517
1322
 
1518
1323
 
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
 
 
1565
1324
class NoSuchExportFormat(BzrError):
1566
 
 
 
1325
    
1567
1326
    _fmt = "Export format %(format)r not supported"
1568
1327
 
1569
1328
    def __init__(self, format):
1572
1331
 
1573
1332
 
1574
1333
class TransportError(BzrError):
1575
 
 
 
1334
    
1576
1335
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1336
 
1578
1337
    def __init__(self, msg=None, orig_error=None):
1587
1346
        BzrError.__init__(self)
1588
1347
 
1589
1348
 
1590
 
class TooManyConcurrentRequests(InternalBzrError):
 
1349
class TooManyConcurrentRequests(BzrError):
1591
1350
 
1592
1351
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1593
1352
            " Be sure to finish_writing and finish_reading on the"
1594
1353
            " currently open request.")
1595
1354
 
 
1355
    internal_error = True
 
1356
 
1596
1357
    def __init__(self, medium):
1597
1358
        self.medium = medium
1598
1359
 
1605
1366
        self.details = details
1606
1367
 
1607
1368
 
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
 
 
1638
1369
# A set of semi-meaningful errors which can be thrown
1639
1370
class TransportNotPossible(TransportError):
1640
1371
 
1665
1396
            self.port = ':%s' % port
1666
1397
 
1667
1398
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1399
class ConnectionReset(TransportError):
1671
1400
 
1672
1401
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1674
1403
 
1675
1404
class InvalidRange(TransportError):
1676
1405
 
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)
 
1406
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1407
    
 
1408
    def __init__(self, path, offset):
 
1409
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1410
                                       % (path, offset)))
1681
1411
        self.path = path
1682
1412
        self.offset = offset
1683
1413
 
1694
1424
class InvalidHttpRange(InvalidHttpResponse):
1695
1425
 
1696
1426
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1697
 
 
 
1427
    
1698
1428
    def __init__(self, path, range, msg):
1699
1429
        self.range = range
1700
1430
        InvalidHttpResponse.__init__(self, path, msg)
1703
1433
class InvalidHttpContentType(InvalidHttpResponse):
1704
1434
 
1705
1435
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1706
 
 
 
1436
    
1707
1437
    def __init__(self, path, ctype, msg):
1708
1438
        self.ctype = ctype
1709
1439
        InvalidHttpResponse.__init__(self, path, msg)
1713
1443
 
1714
1444
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1445
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1446
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1717
1447
        self.source = source
1718
1448
        self.target = target
1719
 
        if is_permanent:
 
1449
        if is_permament:
1720
1450
            self.permanently = ' permanently'
1721
1451
        else:
1722
1452
            self.permanently = ''
 
1453
        self.is_permament = is_permament
 
1454
        self._qualified_proto = qual_proto
1723
1455
        TransportError.__init__(self)
1724
1456
 
 
1457
    def _requalify_url(self, url):
 
1458
        """Restore the qualified proto in front of the url"""
 
1459
        # When this exception is raised, source and target are in
 
1460
        # user readable format. But some transports may use a
 
1461
        # different proto (http+urllib:// will present http:// to
 
1462
        # the user. If a qualified proto is specified, the code
 
1463
        # trapping the exception can get the qualified urls to
 
1464
        # properly handle the redirection themself (creating a
 
1465
        # new transport object from the target url for example).
 
1466
        # But checking that the scheme of the original and
 
1467
        # redirected urls are the same can be tricky. (see the
 
1468
        # FIXME in BzrDir.open_from_transport for the unique use
 
1469
        # case so far).
 
1470
        if self._qualified_proto is None:
 
1471
            return url
 
1472
 
 
1473
        # The TODO related to NotBranchError mention that doing
 
1474
        # that kind of manipulation on the urls may not be the
 
1475
        # exception object job. On the other hand, this object is
 
1476
        # the interface between the code and the user so
 
1477
        # presenting the urls in different ways is indeed its
 
1478
        # job...
 
1479
        import urlparse
 
1480
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1481
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1482
                                   query, fragment))
 
1483
 
 
1484
    def get_source_url(self):
 
1485
        return self._requalify_url(self.source)
 
1486
 
 
1487
    def get_target_url(self):
 
1488
        return self._requalify_url(self.target)
 
1489
 
1725
1490
 
1726
1491
class TooManyRedirections(TransportError):
1727
1492
 
1728
1493
    _fmt = "Too many redirections"
1729
1494
 
1730
 
 
1731
1495
class ConflictsInTree(BzrError):
1732
1496
 
1733
1497
    _fmt = "Working tree has conflicts."
1739
1503
        if filename is None:
1740
1504
            filename = ""
1741
1505
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1506
            (filename, ('\n'.join(e.message for e in errors)))
1743
1507
        BzrError.__init__(self, message)
1744
1508
 
1745
1509
 
1754
1518
 
1755
1519
class SigningFailed(BzrError):
1756
1520
 
1757
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1521
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1758
1522
 
1759
1523
    def __init__(self, command_line):
1760
1524
        BzrError.__init__(self, command_line=command_line)
1762
1526
 
1763
1527
class WorkingTreeNotRevision(BzrError):
1764
1528
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1529
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1530
            " the last commit, but weave merge requires that it be"
1767
1531
            " unchanged")
1768
1532
 
1785
1549
        self.graph = graph
1786
1550
 
1787
1551
 
1788
 
class WritingCompleted(InternalBzrError):
 
1552
class WritingCompleted(BzrError):
1789
1553
 
1790
1554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1791
1555
            "called upon it - accept bytes may not be called anymore.")
1792
1556
 
 
1557
    internal_error = True
 
1558
 
1793
1559
    def __init__(self, request):
1794
1560
        self.request = request
1795
1561
 
1796
1562
 
1797
 
class WritingNotComplete(InternalBzrError):
 
1563
class WritingNotComplete(BzrError):
1798
1564
 
1799
1565
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1800
1566
            "called upon it - until the write phase is complete no "
1801
1567
            "data may be read.")
1802
1568
 
 
1569
    internal_error = True
 
1570
 
1803
1571
    def __init__(self, request):
1804
1572
        self.request = request
1805
1573
 
1813
1581
        self.filename = filename
1814
1582
 
1815
1583
 
1816
 
class MediumNotConnected(InternalBzrError):
 
1584
class MediumNotConnected(BzrError):
1817
1585
 
1818
1586
    _fmt = """The medium '%(medium)s' is not connected."""
1819
1587
 
 
1588
    internal_error = True
 
1589
 
1820
1590
    def __init__(self, medium):
1821
1591
        self.medium = medium
1822
1592
 
1828
1598
 
1829
1599
class NoBundleFound(BzrError):
1830
1600
 
1831
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1601
    _fmt = "No bundle was found in %(filename)s"
1832
1602
 
1833
1603
    def __init__(self, filename):
1834
1604
        BzrError.__init__(self)
1857
1627
        self.text_revision = text_revision
1858
1628
        self.file_id = file_id
1859
1629
 
1860
 
 
1861
1630
class DuplicateFileId(BzrError):
1862
1631
 
1863
1632
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1898
1667
        self.root_trans_id = transform.root
1899
1668
 
1900
1669
 
1901
 
class BzrBadParameter(InternalBzrError):
 
1670
class BzrBadParameter(BzrError):
1902
1671
 
1903
1672
    _fmt = "Bad parameter: %(param)r"
1904
1673
 
 
1674
    internal_error = True
 
1675
 
1905
1676
    # This exception should never be thrown, but it is a base class for all
1906
1677
    # parameter-to-function errors.
1907
1678
 
1930
1701
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1931
1702
 
1932
1703
    def __init__(self, from_path='', to_path='', extra=None):
1933
 
        from bzrlib.osutils import splitpath
1934
1704
        BzrError.__init__(self)
1935
1705
        if extra:
1936
1706
            self.extra = ': ' + str(extra)
1940
1710
        has_from = len(from_path) > 0
1941
1711
        has_to = len(to_path) > 0
1942
1712
        if has_from:
1943
 
            self.from_path = splitpath(from_path)[-1]
 
1713
            self.from_path = osutils.splitpath(from_path)[-1]
1944
1714
        else:
1945
1715
            self.from_path = ''
1946
1716
 
1947
1717
        if has_to:
1948
 
            self.to_path = splitpath(to_path)[-1]
 
1718
            self.to_path = osutils.splitpath(to_path)[-1]
1949
1719
        else:
1950
1720
            self.to_path = ''
1951
1721
 
1970
1740
class BzrRemoveChangedFilesError(BzrError):
1971
1741
    """Used when user is trying to remove changed files."""
1972
1742
 
1973
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1974
 
        "%(changes_as_text)s"
 
1743
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
1975
1744
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
1745
 
1977
1746
    def __init__(self, tree_delta):
2034
1803
 
2035
1804
class BadConversionTarget(BzrError):
2036
1805
 
2037
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2038
 
            "    %(problem)s"
 
1806
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2039
1807
 
2040
 
    def __init__(self, problem, format, from_format=None):
 
1808
    def __init__(self, problem, format):
2041
1809
        BzrError.__init__(self)
2042
1810
        self.problem = problem
2043
1811
        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)
2061
1812
 
2062
1813
 
2063
1814
class NoDiff(BzrError):
2073
1824
    _fmt = "Diff3 is not installed on this machine."
2074
1825
 
2075
1826
 
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
 
 
2082
1827
class ExistingLimbo(BzrError):
2083
1828
 
2084
1829
    _fmt = """This tree contains left-over files from a failed operation.
2085
1830
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2086
1831
    keep, and delete it when you are done."""
2087
 
 
 
1832
    
2088
1833
    def __init__(self, limbo_dir):
2089
1834
       BzrError.__init__(self)
2090
1835
       self.limbo_dir = limbo_dir
2091
1836
 
2092
1837
 
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
 
 
2103
1838
class ImmortalLimbo(BzrError):
2104
1839
 
2105
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1840
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2106
1841
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2107
1842
    keep, and delete it when you are done."""
2108
1843
 
2111
1846
       self.limbo_dir = limbo_dir
2112
1847
 
2113
1848
 
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
 
 
2124
1849
class OutOfDateTree(BzrError):
2125
1850
 
2126
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1851
    _fmt = "Working tree is out of date, please run 'bzr update'."
2127
1852
 
2128
 
    def __init__(self, tree, more=None):
2129
 
        if more is None:
2130
 
            more = ''
2131
 
        else:
2132
 
            more = ' ' + more
 
1853
    def __init__(self, tree):
2133
1854
        BzrError.__init__(self)
2134
1855
        self.tree = tree
2135
 
        self.more = more
2136
1856
 
2137
1857
 
2138
1858
class PublicBranchOutOfDate(BzrError):
2158
1878
    _fmt = "Format error in conflict listings"
2159
1879
 
2160
1880
 
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
 
 
2172
1881
class CorruptRepository(BzrError):
2173
1882
 
2174
1883
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2176
1885
 
2177
1886
    def __init__(self, repo):
2178
1887
        BzrError.__init__(self)
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
 
1888
        self.repo_path = repo.bzrdir.root_transport.base
2205
1889
 
2206
1890
 
2207
1891
class UpgradeRequired(BzrError):
2213
1897
        self.path = path
2214
1898
 
2215
1899
 
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
 
 
2227
1900
class LocalRequiresBoundBranch(BzrError):
2228
1901
 
2229
1902
    _fmt = "Cannot perform local-only commits on unbound branches."
2230
1903
 
2231
1904
 
 
1905
class MissingProgressBarFinish(BzrError):
 
1906
 
 
1907
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1908
 
 
1909
 
 
1910
class InvalidProgressBarType(BzrError):
 
1911
 
 
1912
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1913
            " is not a supported type Select one of: %(valid_types)s")
 
1914
 
 
1915
    def __init__(self, bar_type, valid_types):
 
1916
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1917
 
 
1918
 
2232
1919
class UnsupportedOperation(BzrError):
2233
1920
 
2234
1921
    _fmt = ("The method %(mname)s is not supported on"
2251
1938
 
2252
1939
 
2253
1940
class BinaryFile(BzrError):
2254
 
 
 
1941
    
2255
1942
    _fmt = "File is binary but should be text."
2256
1943
 
2257
1944
 
2277
1964
 
2278
1965
 
2279
1966
class NotABundle(BzrError):
2280
 
 
 
1967
    
2281
1968
    _fmt = "Not a bzr revision-bundle: %(text)r"
2282
1969
 
2283
1970
    def __init__(self, text):
2285
1972
        self.text = text
2286
1973
 
2287
1974
 
2288
 
class BadBundle(BzrError):
2289
 
 
 
1975
class BadBundle(BzrError): 
 
1976
    
2290
1977
    _fmt = "Bad bzr revision-bundle: %(text)r"
2291
1978
 
2292
1979
    def __init__(self, text):
2294
1981
        self.text = text
2295
1982
 
2296
1983
 
2297
 
class MalformedHeader(BadBundle):
2298
 
 
 
1984
class MalformedHeader(BadBundle): 
 
1985
    
2299
1986
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2300
1987
 
2301
1988
 
2302
 
class MalformedPatches(BadBundle):
2303
 
 
 
1989
class MalformedPatches(BadBundle): 
 
1990
    
2304
1991
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2305
1992
 
2306
1993
 
2307
 
class MalformedFooter(BadBundle):
2308
 
 
 
1994
class MalformedFooter(BadBundle): 
 
1995
    
2309
1996
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2310
1997
 
2311
1998
 
2312
1999
class UnsupportedEOLMarker(BadBundle):
2313
 
 
2314
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2000
    
 
2001
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2315
2002
 
2316
2003
    def __init__(self):
2317
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2004
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2318
2005
        # but for this there is not
2319
2006
        BzrError.__init__(self)
2320
2007
 
2321
2008
 
2322
2009
class IncompatibleBundleFormat(BzrError):
2323
 
 
 
2010
    
2324
2011
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2325
2012
 
2326
2013
    def __init__(self, bundle_format, other):
2330
2017
 
2331
2018
 
2332
2019
class BadInventoryFormat(BzrError):
2333
 
 
 
2020
    
2334
2021
    _fmt = "Root class for inventory serialization errors"
2335
2022
 
2336
2023
 
2347
2034
    _fmt = """This operation requires rich root data storage"""
2348
2035
 
2349
2036
 
2350
 
class NoSmartMedium(InternalBzrError):
 
2037
class NoSmartMedium(BzrError):
2351
2038
 
2352
2039
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2353
2040
 
 
2041
    internal_error = True
 
2042
 
2354
2043
    def __init__(self, transport):
2355
2044
        self.transport = transport
2356
2045
 
2357
2046
 
 
2047
class NoSmartServer(NotBranchError):
 
2048
 
 
2049
    _fmt = "No smart server available at %(url)s"
 
2050
 
 
2051
    def __init__(self, url):
 
2052
        self.url = url
 
2053
 
 
2054
 
2358
2055
class UnknownSSH(BzrError):
2359
2056
 
2360
2057
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2370
2067
            " Please set BZR_SSH environment variable.")
2371
2068
 
2372
2069
 
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
 
 
2384
2070
class GhostRevisionUnusableHere(BzrError):
2385
2071
 
2386
2072
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2390
2076
        self.revision_id = revision_id
2391
2077
 
2392
2078
 
2393
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2079
class IllegalUseOfScopeReplacer(BzrError):
2394
2080
 
2395
2081
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2396
2082
            " %(msg)s%(extra)s")
2397
2083
 
 
2084
    internal_error = True
 
2085
 
2398
2086
    def __init__(self, name, msg, extra=None):
2399
2087
        BzrError.__init__(self)
2400
2088
        self.name = name
2405
2093
            self.extra = ''
2406
2094
 
2407
2095
 
2408
 
class InvalidImportLine(InternalBzrError):
 
2096
class InvalidImportLine(BzrError):
2409
2097
 
2410
2098
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2411
2099
 
 
2100
    internal_error = True
 
2101
 
2412
2102
    def __init__(self, text, msg):
2413
2103
        BzrError.__init__(self)
2414
2104
        self.text = text
2415
2105
        self.msg = msg
2416
2106
 
2417
2107
 
2418
 
class ImportNameCollision(InternalBzrError):
 
2108
class ImportNameCollision(BzrError):
2419
2109
 
2420
2110
    _fmt = ("Tried to import an object to the same name as"
2421
2111
            " an existing object. %(name)s")
2422
2112
 
 
2113
    internal_error = True
 
2114
 
2423
2115
    def __init__(self, name):
2424
2116
        BzrError.__init__(self)
2425
2117
        self.name = name
2457
2149
class PatchMissing(BzrError):
2458
2150
    """Raise a patch type was specified but no patch supplied"""
2459
2151
 
2460
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2152
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2461
2153
 
2462
2154
    def __init__(self, patch_type):
2463
2155
        BzrError.__init__(self)
2464
2156
        self.patch_type = patch_type
2465
2157
 
2466
2158
 
2467
 
class TargetNotBranch(BzrError):
2468
 
    """A merge directive's target branch is required, but isn't a branch"""
2469
 
 
2470
 
    _fmt = ("Your branch does not have all of the revisions required in "
2471
 
            "order to merge this merge directive and the target "
2472
 
            "location specified in the merge directive is not a branch: "
2473
 
            "%(location)s.")
2474
 
 
2475
 
    def __init__(self, location):
2476
 
        BzrError.__init__(self)
2477
 
        self.location = location
2478
 
 
2479
 
 
2480
2159
class UnsupportedInventoryKind(BzrError):
2481
 
 
 
2160
    
2482
2161
    _fmt = """Unsupported entry kind %(kind)s"""
2483
2162
 
2484
2163
    def __init__(self, kind):
2487
2166
 
2488
2167
class BadSubsumeSource(BzrError):
2489
2168
 
2490
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2169
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2491
2170
 
2492
2171
    def __init__(self, tree, other_tree, reason):
2493
2172
        self.tree = tree
2496
2175
 
2497
2176
 
2498
2177
class SubsumeTargetNeedsUpgrade(BzrError):
2499
 
 
 
2178
    
2500
2179
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2501
2180
 
2502
2181
    def __init__(self, other_tree):
2503
2182
        self.other_tree = other_tree
2504
2183
 
2505
2184
 
2506
 
class BadReferenceTarget(InternalBzrError):
2507
 
 
2508
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2509
 
           "%(reason)s"
 
2185
class BadReferenceTarget(BzrError):
 
2186
 
 
2187
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2188
 
 
2189
    internal_error = True
2510
2190
 
2511
2191
    def __init__(self, tree, other_tree, reason):
2512
2192
        self.tree = tree
2525
2205
class TagsNotSupported(BzrError):
2526
2206
 
2527
2207
    _fmt = ("Tags not supported by %(branch)s;"
2528
 
            " you may be able to use bzr upgrade.")
 
2208
            " you may be able to use bzr upgrade --dirstate-tags.")
2529
2209
 
2530
2210
    def __init__(self, branch):
2531
2211
        self.branch = branch
2532
2212
 
2533
 
 
 
2213
        
2534
2214
class TagAlreadyExists(BzrError):
2535
2215
 
2536
2216
    _fmt = "Tag %(tag_name)s already exists."
2541
2221
 
2542
2222
class MalformedBugIdentifier(BzrError):
2543
2223
 
2544
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2545
 
            'See "bzr help bugs" for more information on this feature.')
 
2224
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2546
2225
 
2547
2226
    def __init__(self, bug_id, reason):
2548
2227
        self.bug_id = bug_id
2549
2228
        self.reason = reason
2550
2229
 
2551
2230
 
2552
 
class InvalidBugTrackerURL(BzrError):
2553
 
 
2554
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2555
 
            "contain {id}: %(url)s")
2556
 
 
2557
 
    def __init__(self, abbreviation, url):
2558
 
        self.abbreviation = abbreviation
2559
 
        self.url = url
2560
 
 
2561
 
 
2562
2231
class UnknownBugTrackerAbbreviation(BzrError):
2563
2232
 
2564
2233
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2569
2238
        self.branch = branch
2570
2239
 
2571
2240
 
2572
 
class InvalidLineInBugsProperty(BzrError):
2573
 
 
2574
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2575
 
 
2576
 
    def __init__(self, line):
2577
 
        self.line = line
2578
 
 
2579
 
 
2580
 
class InvalidBugStatus(BzrError):
2581
 
 
2582
 
    _fmt = ("Invalid bug status: '%(status)s'")
2583
 
 
2584
 
    def __init__(self, status):
2585
 
        self.status = status
2586
 
 
2587
 
 
2588
2241
class UnexpectedSmartServerResponse(BzrError):
2589
2242
 
2590
2243
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2593
2246
        self.response_tuple = response_tuple
2594
2247
 
2595
2248
 
2596
 
class ErrorFromSmartServer(BzrError):
2597
 
    """An error was received from a smart server.
2598
 
 
2599
 
    :seealso: UnknownErrorFromSmartServer
2600
 
    """
2601
 
 
2602
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2603
 
 
2604
 
    internal_error = True
2605
 
 
2606
 
    def __init__(self, error_tuple):
2607
 
        self.error_tuple = error_tuple
2608
 
        try:
2609
 
            self.error_verb = error_tuple[0]
2610
 
        except IndexError:
2611
 
            self.error_verb = None
2612
 
        self.error_args = error_tuple[1:]
2613
 
 
2614
 
 
2615
 
class UnknownErrorFromSmartServer(BzrError):
2616
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2617
 
    error.
2618
 
 
2619
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
 
    distinguish between the following two cases:
2621
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2622
 
        and so should provoke a traceback to the user.
2623
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2624
 
        translated.  This is probably because the server sent us garbage, and
2625
 
        should not provoke a traceback.
2626
 
    """
2627
 
 
2628
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2629
 
 
2630
 
    internal_error = False
2631
 
 
2632
 
    def __init__(self, error_from_smart_server):
2633
 
        """Constructor.
2634
 
 
2635
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2636
 
        """
2637
 
        self.error_from_smart_server = error_from_smart_server
2638
 
        self.error_tuple = error_from_smart_server.error_tuple
2639
 
 
2640
 
 
2641
2249
class ContainerError(BzrError):
2642
2250
    """Base class of container errors."""
2643
2251
 
2645
2253
class UnknownContainerFormatError(ContainerError):
2646
2254
 
2647
2255
    _fmt = "Unrecognised container format: %(container_format)r"
2648
 
 
 
2256
    
2649
2257
    def __init__(self, container_format):
2650
2258
        self.container_format = container_format
2651
2259
 
2654
2262
 
2655
2263
    _fmt = "Unexpected end of container stream"
2656
2264
 
 
2265
    internal_error = False
 
2266
 
2657
2267
 
2658
2268
class UnknownRecordTypeError(ContainerError):
2659
2269
 
2681
2291
 
2682
2292
class DuplicateRecordNameError(ContainerError):
2683
2293
 
2684
 
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2294
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
2685
2295
 
2686
2296
    def __init__(self, name):
2687
2297
        self.name = name
2688
2298
 
2689
2299
 
2690
 
class NoDestinationAddress(InternalBzrError):
 
2300
class NoDestinationAddress(BzrError):
2691
2301
 
2692
2302
    _fmt = "Message does not have a destination address."
2693
2303
 
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
 
2304
    internal_error = True
2701
2305
 
2702
2306
 
2703
2307
class SMTPError(BzrError):
2708
2312
        self.error = error
2709
2313
 
2710
2314
 
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
2315
class SMTPConnectionRefused(SMTPError):
2740
2316
 
2741
2317
    _fmt = "SMTP connection to %(host)s refused"
2748
2324
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2749
2325
 
2750
2326
    _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