/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
 
62
61
    :cvar _fmt: Format string to display the error; this is expanded
63
62
    by the instance's dict.
64
63
    """
65
 
    
 
64
 
66
65
    internal_error = False
67
66
 
68
67
    def __init__(self, msg=None, **kwds):
73
72
        arguments can be given.  The first is for generic "user" errors which
74
73
        are not intended to be caught and so do not need a specific subclass.
75
74
        The second case is for use with subclasses that provide a _fmt format
76
 
        string to print the arguments.  
 
75
        string to print the arguments.
77
76
 
78
 
        Keyword arguments are taken as parameters to the error, which can 
79
 
        be inserted into the format string template.  It's recommended 
80
 
        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
81
80
        parameters.
82
81
 
83
82
        :param msg: If given, this is the literal complete text for the error,
84
 
        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'.
85
85
        """
86
86
        StandardError.__init__(self)
87
87
        if msg is not None:
93
93
            for key, value in kwds.items():
94
94
                setattr(self, key, value)
95
95
 
96
 
    def __str__(self):
 
96
    def _format(self):
97
97
        s = getattr(self, '_preformatted_string', None)
98
98
        if s is not None:
99
 
            # contains a preformatted message; must be cast to plain str
100
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
101
101
        try:
102
102
            fmt = self._get_format_string()
103
103
            if fmt:
104
104
                d = dict(self.__dict__)
105
 
                # special case: python2.5 puts the 'message' attribute in a
106
 
                # slot, so it isn't seen in __dict__
107
 
                d['message'] = getattr(self, 'message', 'no message')
108
105
                s = fmt % d
109
106
                # __str__() should always return a 'str' object
110
107
                # never a 'unicode' object.
111
 
                if isinstance(s, unicode):
112
 
                    return s.encode('utf8')
113
108
                return s
114
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
115
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
118
113
                   getattr(self, '_fmt', None),
119
114
                   e)
120
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
 
121
139
    def _get_format_string(self):
122
140
        """Return format string for this exception or None"""
123
141
        fmt = getattr(self, '_fmt', None)
135
153
               getattr(self, '_fmt', None),
136
154
               )
137
155
 
 
156
    def __eq__(self, other):
 
157
        if self.__class__ is not other.__class__:
 
158
            return NotImplemented
 
159
        return self.__dict__ == other.__dict__
 
160
 
138
161
 
139
162
class InternalBzrError(BzrError):
140
163
    """Base class for errors that are internal in nature.
181
204
 
182
205
 
183
206
class AlreadyBuilding(BzrError):
184
 
    
 
207
 
185
208
    _fmt = "The tree builder is already building a tree."
186
209
 
187
210
 
 
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
 
188
218
class BzrCheckError(InternalBzrError):
189
 
    
190
 
    _fmt = "Internal check failed: %(message)s"
191
 
 
192
 
    def __init__(self, message):
193
 
        BzrError.__init__(self)
194
 
        self.message = message
 
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
195
235
 
196
236
 
197
237
class DisabledMethod(InternalBzrError):
225
265
 
226
266
 
227
267
class InvalidEntryName(InternalBzrError):
228
 
    
 
268
 
229
269
    _fmt = "Invalid entry name: %(name)s"
230
270
 
231
271
    def __init__(self, name):
234
274
 
235
275
 
236
276
class InvalidRevisionNumber(BzrError):
237
 
    
 
277
 
238
278
    _fmt = "Invalid revision number %(revno)s"
239
279
 
240
280
    def __init__(self, revno):
267
307
        "record_entry_contents.")
268
308
 
269
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
 
270
320
class NoHelpTopic(BzrError):
271
321
 
272
322
    _fmt = ("No help could be found for '%(topic)s'. "
279
329
class NoSuchId(BzrError):
280
330
 
281
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
282
 
    
 
332
 
283
333
    def __init__(self, tree, file_id):
284
334
        BzrError.__init__(self)
285
335
        self.file_id = file_id
295
345
        BzrError.__init__(self, repository=repository, file_id=file_id)
296
346
 
297
347
 
 
348
class NotStacked(BranchError):
 
349
 
 
350
    _fmt = "The branch '%(branch)s' is not stacked."
 
351
 
 
352
 
298
353
class InventoryModified(InternalBzrError):
299
354
 
300
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
307
362
class NoWorkingTree(BzrError):
308
363
 
309
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
310
 
    
 
365
 
311
366
    def __init__(self, base):
312
367
        BzrError.__init__(self)
313
368
        self.base = base
344
399
    # are not intended to be caught anyway.  UI code need not subclass
345
400
    # BzrCommandError, and non-UI code should not throw a subclass of
346
401
    # BzrCommandError.  ADHB 20051211
347
 
    def __init__(self, msg):
348
 
        # Object.__str__() must return a real string
349
 
        # returning a Unicode string is a python error.
350
 
        if isinstance(msg, unicode):
351
 
            self.msg = msg.encode('utf8')
352
 
        else:
353
 
            self.msg = msg
354
 
 
355
 
    def __str__(self):
356
 
        return self.msg
357
402
 
358
403
 
359
404
class NotWriteLocked(BzrError):
432
477
    def __init__(self, name, value):
433
478
        BzrError.__init__(self, name=name, value=value)
434
479
 
435
 
    
 
480
 
436
481
class StrictCommitFailed(BzrError):
437
482
 
438
483
    _fmt = "Commit refused because there are unknown files in the tree"
441
486
# XXX: Should be unified with TransportError; they seem to represent the
442
487
# same thing
443
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
444
 
# - 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
445
490
# differentiates between 'transport has failed' and 'operation on a transport
446
491
# has failed.'
447
492
class PathError(BzrError):
448
 
    
 
493
 
449
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
450
495
 
451
496
    def __init__(self, path, extra=None):
499
544
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
500
545
 
501
546
 
 
547
class HardLinkNotSupported(PathError):
 
548
 
 
549
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
550
 
 
551
 
502
552
class ReadingCompleted(InternalBzrError):
503
 
    
 
553
 
504
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
505
555
            "called upon it - the request has been completed and no more "
506
556
            "data may be read.")
526
576
 
527
577
class InvalidURLJoin(PathError):
528
578
 
529
 
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
530
 
 
531
 
    def __init__(self, msg, base, args):
532
 
        PathError.__init__(self, base, msg)
533
 
        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
534
608
 
535
609
 
536
610
class UnknownHook(BzrError):
551
625
        PathError.__init__(self, url, extra=extra)
552
626
 
553
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
 
554
660
class ReadError(PathError):
555
 
    
 
661
 
556
662
    _fmt = """Error reading from %(path)r."""
557
663
 
558
664
 
593
699
 
594
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
595
701
# the exception object is a bit undesirable.
596
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
597
703
class NotBranchError(PathError):
598
704
 
599
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
600
706
 
601
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
602
708
       import bzrlib.urlutils as urlutils
603
 
       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)
604
731
 
605
732
 
606
733
class NoSubmitBranch(PathError):
653
780
 
654
781
class FileInWrongBranch(BzrError):
655
782
 
656
 
    _fmt = 'File "%(path)s" in not in branch %(branch_base)s.'
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
657
784
 
658
785
    def __init__(self, branch, path):
659
786
        BzrError.__init__(self)
668
795
 
669
796
 
670
797
class UnknownFormatError(BzrError):
671
 
    
672
 
    _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
673
804
 
674
805
 
675
806
class IncompatibleFormat(BzrError):
676
 
    
 
807
 
677
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
678
809
 
679
810
    def __init__(self, format, bzrdir_format):
683
814
 
684
815
 
685
816
class IncompatibleRepositories(BzrError):
686
 
 
687
 
    _fmt = "Repository %(target)s is not compatible with repository"\
688
 
        " %(source)s"
689
 
 
690
 
    def __init__(self, source, target):
691
 
        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)
692
833
 
693
834
 
694
835
class IncompatibleRevision(BzrError):
695
 
    
 
836
 
696
837
    _fmt = "Revision is not compatible with %(repo_format)s"
697
838
 
698
839
    def __init__(self, repo_format):
781
922
        BzrError.__init__(self, filename=filename, kind=kind)
782
923
 
783
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
 
784
936
class ForbiddenControlFileError(BzrError):
785
937
 
786
938
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
839
991
        self.obj = obj
840
992
 
841
993
 
842
 
class ReadOnlyLockError(LockError):
843
 
 
844
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
845
 
 
846
 
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
847
 
    def __init__(self, fname, msg):
848
 
        LockError.__init__(self, '')
849
 
        self.fname = fname
850
 
        self.msg = msg
851
 
 
852
 
 
853
994
class LockFailed(LockError):
854
995
 
855
996
    internal_error = False
899
1040
 
900
1041
class LockContention(LockError):
901
1042
 
902
 
    _fmt = 'Could not acquire lock "%(lock)s"'
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
903
1044
    # TODO: show full url for lock, combining the transport and relative
904
1045
    # bits?
905
1046
 
906
1047
    internal_error = False
907
1048
 
908
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
909
1050
        self.lock = lock
 
1051
        self.msg = msg
910
1052
 
911
1053
 
912
1054
class LockBroken(LockError):
1011
1153
        BzrError.__init__(self, branch=branch, revision=revision)
1012
1154
 
1013
1155
 
1014
 
# zero_ninetyone: this exception is no longer raised and should be removed
1015
 
class NotLeftParentDescendant(InternalBzrError):
1016
 
 
1017
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
1018
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
1019
 
 
1020
 
    def __init__(self, branch, old_revision, new_revision):
1021
 
        BzrError.__init__(self, branch_location=branch.base,
1022
 
                          old_revision=old_revision,
1023
 
                          new_revision=new_revision)
1024
 
 
1025
 
 
1026
1156
class RangeInChangeOption(BzrError):
1027
1157
 
1028
1158
    _fmt = "Option --change does not accept revision ranges"
1038
1168
 
1039
1169
class NoSuchRevisionInTree(NoSuchRevision):
1040
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
1041
 
    
 
1171
 
1042
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1043
1173
 
1044
1174
    def __init__(self, tree, revision_id):
1049
1179
 
1050
1180
class InvalidRevisionSpec(BzrError):
1051
1181
 
1052
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1053
1183
            " %(branch)s%(extra)s")
1054
1184
 
1055
1185
    def __init__(self, spec, branch, extra=None):
1080
1210
class DivergedBranches(BzrError):
1081
1211
 
1082
1212
    _fmt = ("These branches have diverged."
1083
 
            " Use the merge command to reconcile them.")
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
1084
1215
 
1085
1216
    def __init__(self, branch1, branch2):
1086
1217
        self.branch1 = branch1
1101
1232
            " no merge base revision was specified.")
1102
1233
 
1103
1234
 
 
1235
class CannotReverseCherrypick(BzrError):
 
1236
 
 
1237
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1238
            ' or diff3.')
 
1239
 
 
1240
 
1104
1241
class NoCommonAncestor(BzrError):
1105
 
    
 
1242
 
1106
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1107
1244
 
1108
1245
    def __init__(self, revision_a, revision_b):
1128
1265
            not_ancestor_id=not_ancestor_id)
1129
1266
 
1130
1267
 
1131
 
class InstallFailed(BzrError):
1132
 
 
1133
 
    def __init__(self, revisions):
1134
 
        revision_str = ", ".join(str(r) for r in revisions)
1135
 
        msg = "Could not install revisions:\n%s" % revision_str
1136
 
        BzrError.__init__(self, msg)
1137
 
        self.revisions = revisions
1138
 
 
1139
 
 
1140
1268
class AmbiguousBase(BzrError):
1141
1269
 
1142
1270
    def __init__(self, bases):
1143
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1144
 
                DeprecationWarning)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1145
1273
        msg = ("The correct base is unclear, because %s are all equally close"
1146
1274
                % ", ".join(bases))
1147
1275
        BzrError.__init__(self, msg)
1148
1276
        self.bases = bases
1149
1277
 
1150
1278
 
1151
 
class NoCommits(BzrError):
 
1279
class NoCommits(BranchError):
1152
1280
 
1153
1281
    _fmt = "Branch %(branch)s has no commits."
1154
1282
 
1155
 
    def __init__(self, branch):
1156
 
        BzrError.__init__(self, branch=branch)
1157
 
 
1158
1283
 
1159
1284
class UnlistableStore(BzrError):
1160
1285
 
1172
1297
class BoundBranchOutOfDate(BzrError):
1173
1298
 
1174
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1175
 
            " %(master)s.")
 
1300
            " %(master)s.%(extra_help)s")
1176
1301
 
1177
1302
    def __init__(self, branch, master):
1178
1303
        BzrError.__init__(self)
1179
1304
        self.branch = branch
1180
1305
        self.master = master
1181
 
 
1182
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
1183
1309
class CommitToDoubleBoundBranch(BzrError):
1184
1310
 
1185
1311
    _fmt = ("Cannot commit to branch %(branch)s."
1215
1341
 
1216
1342
class WeaveError(BzrError):
1217
1343
 
1218
 
    _fmt = "Error in processing weave: %(message)s"
 
1344
    _fmt = "Error in processing weave: %(msg)s"
1219
1345
 
1220
 
    def __init__(self, message=None):
 
1346
    def __init__(self, msg=None):
1221
1347
        BzrError.__init__(self)
1222
 
        self.message = message
 
1348
        self.msg = msg
1223
1349
 
1224
1350
 
1225
1351
class WeaveRevisionAlreadyPresent(WeaveError):
1255
1381
class WeaveParentMismatch(WeaveError):
1256
1382
 
1257
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1258
 
    
 
1384
 
1259
1385
 
1260
1386
class WeaveInvalidChecksum(WeaveError):
1261
1387
 
1287
1413
 
1288
1414
 
1289
1415
class VersionedFileError(BzrError):
1290
 
    
 
1416
 
1291
1417
    _fmt = "Versioned file error"
1292
1418
 
1293
1419
 
1294
1420
class RevisionNotPresent(VersionedFileError):
1295
 
    
 
1421
 
1296
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1297
1423
 
1298
1424
    def __init__(self, revision_id, file_id):
1302
1428
 
1303
1429
 
1304
1430
class RevisionAlreadyPresent(VersionedFileError):
1305
 
    
 
1431
 
1306
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1307
1433
 
1308
1434
    def __init__(self, revision_id, file_id):
1317
1443
 
1318
1444
 
1319
1445
class KnitError(InternalBzrError):
1320
 
    
 
1446
 
1321
1447
    _fmt = "Knit error"
1322
1448
 
1323
1449
 
1331
1457
        self.how = how
1332
1458
 
1333
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
 
1334
1475
class KnitDataStreamIncompatible(KnitError):
1335
1476
    # Not raised anymore, as we can convert data streams.  In future we may
1336
1477
    # need it again for more exotic cases, so we're keeping it around for now.
1340
1481
    def __init__(self, stream_format, target_format):
1341
1482
        self.stream_format = stream_format
1342
1483
        self.target_format = target_format
1343
 
        
 
1484
 
1344
1485
 
1345
1486
class KnitDataStreamUnknown(KnitError):
1346
1487
    # Indicates a data stream we don't know how to handle.
1349
1490
 
1350
1491
    def __init__(self, stream_format):
1351
1492
        self.stream_format = stream_format
1352
 
        
 
1493
 
1353
1494
 
1354
1495
class KnitHeaderError(KnitError):
1355
1496
 
1365
1506
 
1366
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1367
1508
    """
1368
 
    
 
1509
 
1369
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1370
1511
            " in options: %(options)r")
1371
1512
 
1375
1516
        self.options = options
1376
1517
 
1377
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
 
1378
1565
class NoSuchExportFormat(BzrError):
1379
 
    
 
1566
 
1380
1567
    _fmt = "Export format %(format)r not supported"
1381
1568
 
1382
1569
    def __init__(self, format):
1385
1572
 
1386
1573
 
1387
1574
class TransportError(BzrError):
1388
 
    
 
1575
 
1389
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1390
1577
 
1391
1578
    def __init__(self, msg=None, orig_error=None):
1418
1605
        self.details = details
1419
1606
 
1420
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
 
1421
1638
# A set of semi-meaningful errors which can be thrown
1422
1639
class TransportNotPossible(TransportError):
1423
1640
 
1448
1665
            self.port = ':%s' % port
1449
1666
 
1450
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1451
1670
class ConnectionReset(TransportError):
1452
1671
 
1453
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1455
1674
 
1456
1675
class InvalidRange(TransportError):
1457
1676
 
1458
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1459
 
    
1460
 
    def __init__(self, path, offset):
1461
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1462
 
                                       % (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)
1463
1681
        self.path = path
1464
1682
        self.offset = offset
1465
1683
 
1476
1694
class InvalidHttpRange(InvalidHttpResponse):
1477
1695
 
1478
1696
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1479
 
    
 
1697
 
1480
1698
    def __init__(self, path, range, msg):
1481
1699
        self.range = range
1482
1700
        InvalidHttpResponse.__init__(self, path, msg)
1485
1703
class InvalidHttpContentType(InvalidHttpResponse):
1486
1704
 
1487
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1488
 
    
 
1706
 
1489
1707
    def __init__(self, path, ctype, msg):
1490
1708
        self.ctype = ctype
1491
1709
        InvalidHttpResponse.__init__(self, path, msg)
1495
1713
 
1496
1714
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1497
1715
 
1498
 
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1716
    def __init__(self, source, target, is_permanent=False):
1499
1717
        self.source = source
1500
1718
        self.target = target
1501
1719
        if is_permanent:
1502
1720
            self.permanently = ' permanently'
1503
1721
        else:
1504
1722
            self.permanently = ''
1505
 
        self._qualified_proto = qual_proto
1506
1723
        TransportError.__init__(self)
1507
1724
 
1508
 
    def _requalify_url(self, url):
1509
 
        """Restore the qualified proto in front of the url"""
1510
 
        # When this exception is raised, source and target are in
1511
 
        # user readable format. But some transports may use a
1512
 
        # different proto (http+urllib:// will present http:// to
1513
 
        # the user. If a qualified proto is specified, the code
1514
 
        # trapping the exception can get the qualified urls to
1515
 
        # properly handle the redirection themself (creating a
1516
 
        # new transport object from the target url for example).
1517
 
        # But checking that the scheme of the original and
1518
 
        # redirected urls are the same can be tricky. (see the
1519
 
        # FIXME in BzrDir.open_from_transport for the unique use
1520
 
        # case so far).
1521
 
        if self._qualified_proto is None:
1522
 
            return url
1523
 
 
1524
 
        # The TODO related to NotBranchError mention that doing
1525
 
        # that kind of manipulation on the urls may not be the
1526
 
        # exception object job. On the other hand, this object is
1527
 
        # the interface between the code and the user so
1528
 
        # presenting the urls in different ways is indeed its
1529
 
        # job...
1530
 
        import urlparse
1531
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1532
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1533
 
                                   query, fragment))
1534
 
 
1535
 
    def get_source_url(self):
1536
 
        return self._requalify_url(self.source)
1537
 
 
1538
 
    def get_target_url(self):
1539
 
        return self._requalify_url(self.target)
1540
 
 
1541
1725
 
1542
1726
class TooManyRedirections(TransportError):
1543
1727
 
1555
1739
        if filename is None:
1556
1740
            filename = ""
1557
1741
        message = "Error(s) parsing config file %s:\n%s" % \
1558
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1742
            (filename, ('\n'.join(e.msg for e in errors)))
1559
1743
        BzrError.__init__(self, message)
1560
1744
 
1561
1745
 
1578
1762
 
1579
1763
class WorkingTreeNotRevision(BzrError):
1580
1764
 
1581
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1582
1766
            " the last commit, but weave merge requires that it be"
1583
1767
            " unchanged")
1584
1768
 
1746
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1747
1931
 
1748
1932
    def __init__(self, from_path='', to_path='', extra=None):
 
1933
        from bzrlib.osutils import splitpath
1749
1934
        BzrError.__init__(self)
1750
1935
        if extra:
1751
1936
            self.extra = ': ' + str(extra)
1755
1940
        has_from = len(from_path) > 0
1756
1941
        has_to = len(to_path) > 0
1757
1942
        if has_from:
1758
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1943
            self.from_path = splitpath(from_path)[-1]
1759
1944
        else:
1760
1945
            self.from_path = ''
1761
1946
 
1762
1947
        if has_to:
1763
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1948
            self.to_path = splitpath(to_path)[-1]
1764
1949
        else:
1765
1950
            self.to_path = ''
1766
1951
 
1849
2034
 
1850
2035
class BadConversionTarget(BzrError):
1851
2036
 
1852
 
    _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"
1853
2039
 
1854
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
1855
2041
        BzrError.__init__(self)
1856
2042
        self.problem = problem
1857
2043
        self.format = format
 
2044
        self.from_format = from_format or '(unspecified)'
1858
2045
 
1859
2046
 
1860
2047
class NoDiffFound(BzrError):
1865
2052
        BzrError.__init__(self, path)
1866
2053
 
1867
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
 
 
2062
 
1868
2063
class NoDiff(BzrError):
1869
2064
 
1870
2065
    _fmt = "Diff is not installed on this machine: %(msg)s"
1889
2084
    _fmt = """This tree contains left-over files from a failed operation.
1890
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1891
2086
    keep, and delete it when you are done."""
1892
 
    
 
2087
 
1893
2088
    def __init__(self, limbo_dir):
1894
2089
       BzrError.__init__(self)
1895
2090
       self.limbo_dir = limbo_dir
1928
2123
 
1929
2124
class OutOfDateTree(BzrError):
1930
2125
 
1931
 
    _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"
1932
2127
 
1933
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
1934
2133
        BzrError.__init__(self)
1935
2134
        self.tree = tree
 
2135
        self.more = more
1936
2136
 
1937
2137
 
1938
2138
class PublicBranchOutOfDate(BzrError):
1958
2158
    _fmt = "Format error in conflict listings"
1959
2159
 
1960
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
 
1961
2172
class CorruptRepository(BzrError):
1962
2173
 
1963
2174
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1965
2176
 
1966
2177
    def __init__(self, repo):
1967
2178
        BzrError.__init__(self)
1968
 
        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
1969
2205
 
1970
2206
 
1971
2207
class UpgradeRequired(BzrError):
1977
2213
        self.path = path
1978
2214
 
1979
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
 
1980
2227
class LocalRequiresBoundBranch(BzrError):
1981
2228
 
1982
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
1983
2230
 
1984
2231
 
1985
 
class MissingProgressBarFinish(BzrError):
1986
 
 
1987
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1988
 
 
1989
 
 
1990
 
class InvalidProgressBarType(BzrError):
1991
 
 
1992
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1993
 
            " is not a supported type Select one of: %(valid_types)s")
1994
 
 
1995
 
    def __init__(self, bar_type, valid_types):
1996
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1997
 
 
1998
 
 
1999
2232
class UnsupportedOperation(BzrError):
2000
2233
 
2001
2234
    _fmt = ("The method %(mname)s is not supported on"
2018
2251
 
2019
2252
 
2020
2253
class BinaryFile(BzrError):
2021
 
    
 
2254
 
2022
2255
    _fmt = "File is binary but should be text."
2023
2256
 
2024
2257
 
2044
2277
 
2045
2278
 
2046
2279
class NotABundle(BzrError):
2047
 
    
 
2280
 
2048
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
2049
2282
 
2050
2283
    def __init__(self, text):
2052
2285
        self.text = text
2053
2286
 
2054
2287
 
2055
 
class BadBundle(BzrError): 
2056
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
2057
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
2058
2291
 
2059
2292
    def __init__(self, text):
2061
2294
        self.text = text
2062
2295
 
2063
2296
 
2064
 
class MalformedHeader(BadBundle): 
2065
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
2066
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2067
2300
 
2068
2301
 
2069
 
class MalformedPatches(BadBundle): 
2070
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
2071
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2072
2305
 
2073
2306
 
2074
 
class MalformedFooter(BadBundle): 
2075
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
2076
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2077
2310
 
2078
2311
 
2079
2312
class UnsupportedEOLMarker(BadBundle):
2080
 
    
2081
 
    _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"
2082
2315
 
2083
2316
    def __init__(self):
2084
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
2085
2318
        # but for this there is not
2086
2319
        BzrError.__init__(self)
2087
2320
 
2088
2321
 
2089
2322
class IncompatibleBundleFormat(BzrError):
2090
 
    
 
2323
 
2091
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2092
2325
 
2093
2326
    def __init__(self, bundle_format, other):
2097
2330
 
2098
2331
 
2099
2332
class BadInventoryFormat(BzrError):
2100
 
    
 
2333
 
2101
2334
    _fmt = "Root class for inventory serialization errors"
2102
2335
 
2103
2336
 
2122
2355
        self.transport = transport
2123
2356
 
2124
2357
 
2125
 
class NoSmartServer(NotBranchError):
2126
 
 
2127
 
    _fmt = "No smart server available at %(url)s"
2128
 
 
2129
 
    def __init__(self, url):
2130
 
        self.url = url
2131
 
 
2132
 
 
2133
2358
class UnknownSSH(BzrError):
2134
2359
 
2135
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2145
2370
            " Please set BZR_SSH environment variable.")
2146
2371
 
2147
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
 
2148
2384
class GhostRevisionUnusableHere(BzrError):
2149
2385
 
2150
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2228
2464
        self.patch_type = patch_type
2229
2465
 
2230
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
 
2231
2480
class UnsupportedInventoryKind(BzrError):
2232
 
    
 
2481
 
2233
2482
    _fmt = """Unsupported entry kind %(kind)s"""
2234
2483
 
2235
2484
    def __init__(self, kind):
2247
2496
 
2248
2497
 
2249
2498
class SubsumeTargetNeedsUpgrade(BzrError):
2250
 
    
 
2499
 
2251
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2252
2501
 
2253
2502
    def __init__(self, other_tree):
2276
2525
class TagsNotSupported(BzrError):
2277
2526
 
2278
2527
    _fmt = ("Tags not supported by %(branch)s;"
2279
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2528
            " you may be able to use bzr upgrade.")
2280
2529
 
2281
2530
    def __init__(self, branch):
2282
2531
        self.branch = branch
2283
2532
 
2284
 
        
 
2533
 
2285
2534
class TagAlreadyExists(BzrError):
2286
2535
 
2287
2536
    _fmt = "Tag %(tag_name)s already exists."
2292
2541
 
2293
2542
class MalformedBugIdentifier(BzrError):
2294
2543
 
2295
 
    _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.')
2296
2546
 
2297
2547
    def __init__(self, bug_id, reason):
2298
2548
        self.bug_id = bug_id
2299
2549
        self.reason = reason
2300
2550
 
2301
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
 
2302
2562
class UnknownBugTrackerAbbreviation(BzrError):
2303
2563
 
2304
2564
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2309
2569
        self.branch = branch
2310
2570
 
2311
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
 
2312
2588
class UnexpectedSmartServerResponse(BzrError):
2313
2589
 
2314
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2317
2593
        self.response_tuple = response_tuple
2318
2594
 
2319
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
 
2320
2641
class ContainerError(BzrError):
2321
2642
    """Base class of container errors."""
2322
2643
 
2324
2645
class UnknownContainerFormatError(ContainerError):
2325
2646
 
2326
2647
    _fmt = "Unrecognised container format: %(container_format)r"
2327
 
    
 
2648
 
2328
2649
    def __init__(self, container_format):
2329
2650
        self.container_format = container_format
2330
2651
 
2394
2715
 
2395
2716
class NoMailAddressSpecified(BzrError):
2396
2717
 
2397
 
    _fmt = "No mail-to address specified."
 
2718
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2398
2719
 
2399
2720
 
2400
2721
class UnknownMailClient(BzrError):
2433
2754
 
2434
2755
    def __init__(self, bzrdir):
2435
2756
        import bzrlib.urlutils as urlutils
2436
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2437
2758
                                                    'ascii')
2438
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2439
2760
 
2440
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
 
2441
2774
class AlreadyBranch(BzrDirError):
2442
2775
 
2443
2776
    _fmt = "'%(display_url)s' is already a branch."
2458
2791
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2459
2792
 
2460
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
 
2461
2816
class ReconfigurationNotSupported(BzrDirError):
2462
2817
 
2463
2818
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2470
2825
 
2471
2826
class UncommittedChanges(BzrError):
2472
2827
 
2473
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2828
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2829
            ' (See bzr status).%(more)s')
2474
2830
 
2475
 
    def __init__(self, tree):
 
2831
    def __init__(self, tree, more=None):
 
2832
        if more is None:
 
2833
            more = ''
 
2834
        else:
 
2835
            more = ' ' + more
2476
2836
        import bzrlib.urlutils as urlutils
2477
2837
        display_url = urlutils.unescape_for_display(
2478
 
            tree.bzrdir.root_transport.base, 'ascii')
2479
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
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.'
2480
2853
 
2481
2854
 
2482
2855
class UnableCreateSymlink(BzrError):
2492
2865
                path_str = repr(path)
2493
2866
            path_str += ' '
2494
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