/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: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
61
62
    :cvar _fmt: Format string to display the error; this is expanded
62
63
    by the instance's dict.
63
64
    """
64
 
 
 
65
    
65
66
    internal_error = False
66
67
 
67
68
    def __init__(self, msg=None, **kwds):
72
73
        arguments can be given.  The first is for generic "user" errors which
73
74
        are not intended to be caught and so do not need a specific subclass.
74
75
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
76
        string to print the arguments.  
76
77
 
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
 
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 
80
81
        parameters.
81
82
 
82
83
        :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'.
 
84
        not subject to expansion.
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 _format(self):
 
96
    def __str__(self):
97
97
        s = getattr(self, '_preformatted_string', None)
98
98
        if s is not None:
99
 
            # contains a preformatted message
100
 
            return s
 
99
            # contains a preformatted message; must be cast to plain str
 
100
            return str(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')
105
108
                s = fmt % d
106
109
                # __str__() should always return a 'str' object
107
110
                # never a 'unicode' object.
 
111
                if isinstance(s, unicode):
 
112
                    return s.encode('utf8')
108
113
                return s
109
114
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
115
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
113
118
                   getattr(self, '_fmt', None),
114
119
                   e)
115
120
 
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
121
    def _get_format_string(self):
140
122
        """Return format string for this exception or None"""
141
123
        fmt = getattr(self, '_fmt', None)
153
135
               getattr(self, '_fmt', None),
154
136
               )
155
137
 
156
 
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
158
 
            return NotImplemented
159
 
        return self.__dict__ == other.__dict__
160
 
 
161
138
 
162
139
class InternalBzrError(BzrError):
163
140
    """Base class for errors that are internal in nature.
204
181
 
205
182
 
206
183
class AlreadyBuilding(BzrError):
207
 
 
 
184
    
208
185
    _fmt = "The tree builder is already building a tree."
209
186
 
210
187
 
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
188
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
 
189
    
 
190
    _fmt = "Internal check failed: %(message)s"
 
191
 
 
192
    def __init__(self, message):
 
193
        BzrError.__init__(self)
 
194
        self.message = message
235
195
 
236
196
 
237
197
class DisabledMethod(InternalBzrError):
265
225
 
266
226
 
267
227
class InvalidEntryName(InternalBzrError):
268
 
 
 
228
    
269
229
    _fmt = "Invalid entry name: %(name)s"
270
230
 
271
231
    def __init__(self, name):
274
234
 
275
235
 
276
236
class InvalidRevisionNumber(BzrError):
277
 
 
 
237
    
278
238
    _fmt = "Invalid revision number %(revno)s"
279
239
 
280
240
    def __init__(self, revno):
292
252
        self.revision_id = revision_id
293
253
        self.branch = branch
294
254
 
295
 
 
296
255
class ReservedId(BzrError):
297
256
 
298
257
    _fmt = "Reserved revision-id {%(revision_id)s}"
307
266
        "record_entry_contents.")
308
267
 
309
268
 
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
269
class NoHelpTopic(BzrError):
321
270
 
322
271
    _fmt = ("No help could be found for '%(topic)s'. "
329
278
class NoSuchId(BzrError):
330
279
 
331
280
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
281
    
333
282
    def __init__(self, tree, file_id):
334
283
        BzrError.__init__(self)
335
284
        self.file_id = file_id
345
294
        BzrError.__init__(self, repository=repository, file_id=file_id)
346
295
 
347
296
 
348
 
class NotStacked(BranchError):
349
 
 
350
 
    _fmt = "The branch '%(branch)s' is not stacked."
351
 
 
352
 
 
353
297
class InventoryModified(InternalBzrError):
354
298
 
355
299
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
362
306
class NoWorkingTree(BzrError):
363
307
 
364
308
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
309
    
366
310
    def __init__(self, base):
367
311
        BzrError.__init__(self)
368
312
        self.base = base
399
343
    # are not intended to be caught anyway.  UI code need not subclass
400
344
    # BzrCommandError, and non-UI code should not throw a subclass of
401
345
    # BzrCommandError.  ADHB 20051211
 
346
    def __init__(self, msg):
 
347
        # Object.__str__() must return a real string
 
348
        # returning a Unicode string is a python error.
 
349
        if isinstance(msg, unicode):
 
350
            self.msg = msg.encode('utf8')
 
351
        else:
 
352
            self.msg = msg
 
353
 
 
354
    def __str__(self):
 
355
        return self.msg
402
356
 
403
357
 
404
358
class NotWriteLocked(BzrError):
477
431
    def __init__(self, name, value):
478
432
        BzrError.__init__(self, name=name, value=value)
479
433
 
480
 
 
 
434
    
481
435
class StrictCommitFailed(BzrError):
482
436
 
483
437
    _fmt = "Commit refused because there are unknown files in the tree"
486
440
# XXX: Should be unified with TransportError; they seem to represent the
487
441
# same thing
488
442
# 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
 
443
# - this is finer than a TransportError - and more useful as such. It 
490
444
# differentiates between 'transport has failed' and 'operation on a transport
491
445
# has failed.'
492
446
class PathError(BzrError):
493
 
 
 
447
    
494
448
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
449
 
496
450
    def __init__(self, path, extra=None):
516
470
    """Used when renaming and both source and dest exist."""
517
471
 
518
472
    _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")
 
473
            "%(extra)s")
521
474
 
522
475
    def __init__(self, source, dest, extra=None):
523
476
        BzrError.__init__(self)
544
497
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
545
498
 
546
499
 
547
 
class HardLinkNotSupported(PathError):
548
 
 
549
 
    _fmt = 'Hard-linking "%(path)s" is not supported'
550
 
 
551
 
 
552
500
class ReadingCompleted(InternalBzrError):
553
 
 
 
501
    
554
502
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
503
            "called upon it - the request has been completed and no more "
556
504
            "data may be read.")
576
524
 
577
525
class InvalidURLJoin(PathError):
578
526
 
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
 
527
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
528
 
 
529
    def __init__(self, msg, base, args):
 
530
        PathError.__init__(self, base, msg)
 
531
        self.args = [base] + list(args)
608
532
 
609
533
 
610
534
class UnknownHook(BzrError):
625
549
        PathError.__init__(self, url, extra=extra)
626
550
 
627
551
 
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
552
class ReadError(PathError):
661
 
 
 
553
    
662
554
    _fmt = """Error reading from %(path)r."""
663
555
 
664
556
 
699
591
 
700
592
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
593
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
594
# TODO: Probably this behavior of should be a common superclass 
703
595
class NotBranchError(PathError):
704
596
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
597
    _fmt = 'Not a branch: "%(path)s".'
706
598
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
599
    def __init__(self, path):
708
600
       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)
 
601
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
602
 
732
603
 
733
604
class NoSubmitBranch(PathError):
780
651
 
781
652
class FileInWrongBranch(BzrError):
782
653
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
654
    _fmt = 'File "%(path)s" in not in branch %(branch_base)s.'
784
655
 
785
656
    def __init__(self, branch, path):
786
657
        BzrError.__init__(self)
795
666
 
796
667
 
797
668
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
 
669
    
 
670
    _fmt = "Unknown branch format: %(format)r"
804
671
 
805
672
 
806
673
class IncompatibleFormat(BzrError):
807
 
 
 
674
    
808
675
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
676
 
810
677
    def __init__(self, format, bzrdir_format):
814
681
 
815
682
 
816
683
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)
 
684
 
 
685
    _fmt = "Repository %(target)s is not compatible with repository"\
 
686
        " %(source)s"
 
687
 
 
688
    def __init__(self, source, target):
 
689
        BzrError.__init__(self, target=target, source=source)
833
690
 
834
691
 
835
692
class IncompatibleRevision(BzrError):
836
 
 
 
693
    
837
694
    _fmt = "Revision is not compatible with %(repo_format)s"
838
695
 
839
696
    def __init__(self, repo_format):
922
779
        BzrError.__init__(self, filename=filename, kind=kind)
923
780
 
924
781
 
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
782
class ForbiddenControlFileError(BzrError):
937
783
 
938
784
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
991
837
        self.obj = obj
992
838
 
993
839
 
 
840
class ReadOnlyLockError(LockError):
 
841
 
 
842
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
843
 
 
844
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
845
    def __init__(self, fname, msg):
 
846
        LockError.__init__(self, '')
 
847
        self.fname = fname
 
848
        self.msg = msg
 
849
 
 
850
 
994
851
class LockFailed(LockError):
995
852
 
996
853
    internal_error = False
1040
897
 
1041
898
class LockContention(LockError):
1042
899
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
900
    _fmt = 'Could not acquire lock "%(lock)s"'
1044
901
    # TODO: show full url for lock, combining the transport and relative
1045
902
    # bits?
1046
903
 
1047
904
    internal_error = False
1048
905
 
1049
 
    def __init__(self, lock, msg=''):
 
906
    def __init__(self, lock):
1050
907
        self.lock = lock
1051
 
        self.msg = msg
1052
908
 
1053
909
 
1054
910
class LockBroken(LockError):
1153
1009
        BzrError.__init__(self, branch=branch, revision=revision)
1154
1010
 
1155
1011
 
 
1012
# zero_ninetyone: this exception is no longer raised and should be removed
 
1013
class NotLeftParentDescendant(InternalBzrError):
 
1014
 
 
1015
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
1016
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
1017
 
 
1018
    def __init__(self, branch, old_revision, new_revision):
 
1019
        BzrError.__init__(self, branch_location=branch.base,
 
1020
                          old_revision=old_revision,
 
1021
                          new_revision=new_revision)
 
1022
 
 
1023
 
1156
1024
class RangeInChangeOption(BzrError):
1157
1025
 
1158
1026
    _fmt = "Option --change does not accept revision ranges"
1168
1036
 
1169
1037
class NoSuchRevisionInTree(NoSuchRevision):
1170
1038
    """When using Tree.revision_tree, and the revision is not accessible."""
1171
 
 
 
1039
    
1172
1040
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1173
1041
 
1174
1042
    def __init__(self, tree, revision_id):
1179
1047
 
1180
1048
class InvalidRevisionSpec(BzrError):
1181
1049
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1050
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1051
            " %(branch)s%(extra)s")
1184
1052
 
1185
1053
    def __init__(self, spec, branch, extra=None):
1210
1078
class DivergedBranches(BzrError):
1211
1079
 
1212
1080
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1081
            " Use the merge command to reconcile them.")
1215
1082
 
1216
1083
    def __init__(self, branch1, branch2):
1217
1084
        self.branch1 = branch1
1232
1099
            " no merge base revision was specified.")
1233
1100
 
1234
1101
 
1235
 
class CannotReverseCherrypick(BzrError):
1236
 
 
1237
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1238
 
            ' or diff3.')
1239
 
 
1240
 
 
1241
1102
class NoCommonAncestor(BzrError):
1242
 
 
 
1103
    
1243
1104
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1105
 
1245
1106
    def __init__(self, revision_a, revision_b):
1265
1126
            not_ancestor_id=not_ancestor_id)
1266
1127
 
1267
1128
 
 
1129
class InstallFailed(BzrError):
 
1130
 
 
1131
    def __init__(self, revisions):
 
1132
        revision_str = ", ".join(str(r) for r in revisions)
 
1133
        msg = "Could not install revisions:\n%s" % revision_str
 
1134
        BzrError.__init__(self, msg)
 
1135
        self.revisions = revisions
 
1136
 
 
1137
 
1268
1138
class AmbiguousBase(BzrError):
1269
1139
 
1270
1140
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1141
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1142
                DeprecationWarning)
1273
1143
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1144
                % ", ".join(bases))
1275
1145
        BzrError.__init__(self, msg)
1276
1146
        self.bases = bases
1277
1147
 
1278
1148
 
1279
 
class NoCommits(BranchError):
 
1149
class NoCommits(BzrError):
1280
1150
 
1281
1151
    _fmt = "Branch %(branch)s has no commits."
1282
1152
 
 
1153
    def __init__(self, branch):
 
1154
        BzrError.__init__(self, branch=branch)
 
1155
 
1283
1156
 
1284
1157
class UnlistableStore(BzrError):
1285
1158
 
1297
1170
class BoundBranchOutOfDate(BzrError):
1298
1171
 
1299
1172
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1173
            " %(master)s.")
1301
1174
 
1302
1175
    def __init__(self, branch, master):
1303
1176
        BzrError.__init__(self)
1304
1177
        self.branch = branch
1305
1178
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1179
 
 
1180
        
1309
1181
class CommitToDoubleBoundBranch(BzrError):
1310
1182
 
1311
1183
    _fmt = ("Cannot commit to branch %(branch)s."
1341
1213
 
1342
1214
class WeaveError(BzrError):
1343
1215
 
1344
 
    _fmt = "Error in processing weave: %(msg)s"
 
1216
    _fmt = "Error in processing weave: %(message)s"
1345
1217
 
1346
 
    def __init__(self, msg=None):
 
1218
    def __init__(self, message=None):
1347
1219
        BzrError.__init__(self)
1348
 
        self.msg = msg
 
1220
        self.message = message
1349
1221
 
1350
1222
 
1351
1223
class WeaveRevisionAlreadyPresent(WeaveError):
1381
1253
class WeaveParentMismatch(WeaveError):
1382
1254
 
1383
1255
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1256
    
1385
1257
 
1386
1258
class WeaveInvalidChecksum(WeaveError):
1387
1259
 
1413
1285
 
1414
1286
 
1415
1287
class VersionedFileError(BzrError):
1416
 
 
 
1288
    
1417
1289
    _fmt = "Versioned file error"
1418
1290
 
1419
1291
 
1420
1292
class RevisionNotPresent(VersionedFileError):
1421
 
 
 
1293
    
1422
1294
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1423
1295
 
1424
1296
    def __init__(self, revision_id, file_id):
1428
1300
 
1429
1301
 
1430
1302
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
 
1303
    
1432
1304
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1433
1305
 
1434
1306
    def __init__(self, revision_id, file_id):
1443
1315
 
1444
1316
 
1445
1317
class KnitError(InternalBzrError):
1446
 
 
 
1318
    
1447
1319
    _fmt = "Knit error"
1448
1320
 
1449
1321
 
1457
1329
        self.how = how
1458
1330
 
1459
1331
 
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
1332
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
1333
 
1479
1334
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1480
1335
 
1481
1336
    def __init__(self, stream_format, target_format):
1482
1337
        self.stream_format = stream_format
1483
1338
        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
 
 
 
1339
        
1494
1340
 
1495
1341
class KnitHeaderError(KnitError):
1496
1342
 
1506
1352
 
1507
1353
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1354
    """
1509
 
 
 
1355
    
1510
1356
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1357
            " in options: %(options)r")
1512
1358
 
1516
1362
        self.options = options
1517
1363
 
1518
1364
 
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
1365
class NoSuchExportFormat(BzrError):
1566
 
 
 
1366
    
1567
1367
    _fmt = "Export format %(format)r not supported"
1568
1368
 
1569
1369
    def __init__(self, format):
1572
1372
 
1573
1373
 
1574
1374
class TransportError(BzrError):
1575
 
 
 
1375
    
1576
1376
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1377
 
1578
1378
    def __init__(self, msg=None, orig_error=None):
1605
1405
        self.details = details
1606
1406
 
1607
1407
 
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
1408
# A set of semi-meaningful errors which can be thrown
1639
1409
class TransportNotPossible(TransportError):
1640
1410
 
1665
1435
            self.port = ':%s' % port
1666
1436
 
1667
1437
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1438
class ConnectionReset(TransportError):
1671
1439
 
1672
1440
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1674
1442
 
1675
1443
class InvalidRange(TransportError):
1676
1444
 
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)
 
1445
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1446
    
 
1447
    def __init__(self, path, offset):
 
1448
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1449
                                       % (path, offset)))
1681
1450
        self.path = path
1682
1451
        self.offset = offset
1683
1452
 
1694
1463
class InvalidHttpRange(InvalidHttpResponse):
1695
1464
 
1696
1465
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1697
 
 
 
1466
    
1698
1467
    def __init__(self, path, range, msg):
1699
1468
        self.range = range
1700
1469
        InvalidHttpResponse.__init__(self, path, msg)
1703
1472
class InvalidHttpContentType(InvalidHttpResponse):
1704
1473
 
1705
1474
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1706
 
 
 
1475
    
1707
1476
    def __init__(self, path, ctype, msg):
1708
1477
        self.ctype = ctype
1709
1478
        InvalidHttpResponse.__init__(self, path, msg)
1713
1482
 
1714
1483
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1484
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1485
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1486
        self.source = source
1718
1487
        self.target = target
1719
1488
        if is_permanent:
1720
1489
            self.permanently = ' permanently'
1721
1490
        else:
1722
1491
            self.permanently = ''
 
1492
        self._qualified_proto = qual_proto
1723
1493
        TransportError.__init__(self)
1724
1494
 
 
1495
    def _requalify_url(self, url):
 
1496
        """Restore the qualified proto in front of the url"""
 
1497
        # When this exception is raised, source and target are in
 
1498
        # user readable format. But some transports may use a
 
1499
        # different proto (http+urllib:// will present http:// to
 
1500
        # the user. If a qualified proto is specified, the code
 
1501
        # trapping the exception can get the qualified urls to
 
1502
        # properly handle the redirection themself (creating a
 
1503
        # new transport object from the target url for example).
 
1504
        # But checking that the scheme of the original and
 
1505
        # redirected urls are the same can be tricky. (see the
 
1506
        # FIXME in BzrDir.open_from_transport for the unique use
 
1507
        # case so far).
 
1508
        if self._qualified_proto is None:
 
1509
            return url
 
1510
 
 
1511
        # The TODO related to NotBranchError mention that doing
 
1512
        # that kind of manipulation on the urls may not be the
 
1513
        # exception object job. On the other hand, this object is
 
1514
        # the interface between the code and the user so
 
1515
        # presenting the urls in different ways is indeed its
 
1516
        # job...
 
1517
        import urlparse
 
1518
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1519
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1520
                                   query, fragment))
 
1521
 
 
1522
    def get_source_url(self):
 
1523
        return self._requalify_url(self.source)
 
1524
 
 
1525
    def get_target_url(self):
 
1526
        return self._requalify_url(self.target)
 
1527
 
1725
1528
 
1726
1529
class TooManyRedirections(TransportError):
1727
1530
 
1739
1542
        if filename is None:
1740
1543
            filename = ""
1741
1544
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1545
            (filename, ('\n'.join(e.message for e in errors)))
1743
1546
        BzrError.__init__(self, message)
1744
1547
 
1745
1548
 
1762
1565
 
1763
1566
class WorkingTreeNotRevision(BzrError):
1764
1567
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1568
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1569
            " the last commit, but weave merge requires that it be"
1767
1570
            " unchanged")
1768
1571
 
1923
1726
class CantMoveRoot(BzrError):
1924
1727
 
1925
1728
    _fmt = "Moving the root directory is not supported at this time"
1926
 
    
1927
 
    
1928
 
class TransformRenameFailed(BzrError):
1929
 
 
1930
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1931
 
    
1932
 
    def __init__(self, from_path, to_path, why, errno):
1933
 
        self.from_path = from_path
1934
 
        self.to_path = to_path
1935
 
        self.why = why
1936
 
        self.errno = errno
1937
1729
 
1938
1730
 
1939
1731
class BzrMoveFailedError(BzrError):
1941
1733
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1942
1734
 
1943
1735
    def __init__(self, from_path='', to_path='', extra=None):
1944
 
        from bzrlib.osutils import splitpath
1945
1736
        BzrError.__init__(self)
1946
1737
        if extra:
1947
1738
            self.extra = ': ' + str(extra)
1951
1742
        has_from = len(from_path) > 0
1952
1743
        has_to = len(to_path) > 0
1953
1744
        if has_from:
1954
 
            self.from_path = splitpath(from_path)[-1]
 
1745
            self.from_path = osutils.splitpath(from_path)[-1]
1955
1746
        else:
1956
1747
            self.from_path = ''
1957
1748
 
1958
1749
        if has_to:
1959
 
            self.to_path = splitpath(to_path)[-1]
 
1750
            self.to_path = osutils.splitpath(to_path)[-1]
1960
1751
        else:
1961
1752
            self.to_path = ''
1962
1753
 
2045
1836
 
2046
1837
class BadConversionTarget(BzrError):
2047
1838
 
2048
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2049
 
            "    %(problem)s"
 
1839
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2050
1840
 
2051
 
    def __init__(self, problem, format, from_format=None):
 
1841
    def __init__(self, problem, format):
2052
1842
        BzrError.__init__(self)
2053
1843
        self.problem = problem
2054
1844
        self.format = format
2055
 
        self.from_format = from_format or '(unspecified)'
2056
 
 
2057
 
 
2058
 
class NoDiffFound(BzrError):
2059
 
 
2060
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2061
 
 
2062
 
    def __init__(self, path):
2063
 
        BzrError.__init__(self, path)
2064
 
 
2065
 
 
2066
 
class ExecutableMissing(BzrError):
2067
 
 
2068
 
    _fmt = "%(exe_name)s could not be found on this machine"
2069
 
 
2070
 
    def __init__(self, exe_name):
2071
 
        BzrError.__init__(self, exe_name=exe_name)
2072
1845
 
2073
1846
 
2074
1847
class NoDiff(BzrError):
2095
1868
    _fmt = """This tree contains left-over files from a failed operation.
2096
1869
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2097
1870
    keep, and delete it when you are done."""
2098
 
 
 
1871
    
2099
1872
    def __init__(self, limbo_dir):
2100
1873
       BzrError.__init__(self)
2101
1874
       self.limbo_dir = limbo_dir
2124
1897
 
2125
1898
class ImmortalPendingDeletion(BzrError):
2126
1899
 
2127
 
    _fmt = ("Unable to delete transform temporary directory "
2128
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2129
 
    "contains any files you wish to keep, and delete it when you are done.")
 
1900
    _fmt = """Unable to delete transform temporary directory
 
1901
    %(pending_deletion)s.  Please examine %(pending_deletions)s to see if it
 
1902
    contains any files you wish to keep, and delete it when you are done."""
2130
1903
 
2131
1904
    def __init__(self, pending_deletion):
2132
1905
       BzrError.__init__(self, pending_deletion=pending_deletion)
2134
1907
 
2135
1908
class OutOfDateTree(BzrError):
2136
1909
 
2137
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1910
    _fmt = "Working tree is out of date, please run 'bzr update'."
2138
1911
 
2139
 
    def __init__(self, tree, more=None):
2140
 
        if more is None:
2141
 
            more = ''
2142
 
        else:
2143
 
            more = ' ' + more
 
1912
    def __init__(self, tree):
2144
1913
        BzrError.__init__(self)
2145
1914
        self.tree = tree
2146
 
        self.more = more
2147
1915
 
2148
1916
 
2149
1917
class PublicBranchOutOfDate(BzrError):
2169
1937
    _fmt = "Format error in conflict listings"
2170
1938
 
2171
1939
 
2172
 
class CorruptDirstate(BzrError):
2173
 
 
2174
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2175
 
            "Error: %(description)s")
2176
 
 
2177
 
    def __init__(self, dirstate_path, description):
2178
 
        BzrError.__init__(self)
2179
 
        self.dirstate_path = dirstate_path
2180
 
        self.description = description
2181
 
 
2182
 
 
2183
1940
class CorruptRepository(BzrError):
2184
1941
 
2185
1942
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2187
1944
 
2188
1945
    def __init__(self, repo):
2189
1946
        BzrError.__init__(self)
2190
 
        self.repo_path = repo.user_url
2191
 
 
2192
 
 
2193
 
class InconsistentDelta(BzrError):
2194
 
    """Used when we get a delta that is not valid."""
2195
 
 
2196
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2197
 
            " %(file_id)r\nreason: %(reason)s")
2198
 
 
2199
 
    def __init__(self, path, file_id, reason):
2200
 
        BzrError.__init__(self)
2201
 
        self.path = path
2202
 
        self.file_id = file_id
2203
 
        self.reason = reason
2204
 
 
2205
 
 
2206
 
class InconsistentDeltaDelta(InconsistentDelta):
2207
 
    """Used when we get a delta that is not valid."""
2208
 
 
2209
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2210
 
            "\nreason: %(reason)s")
2211
 
 
2212
 
    def __init__(self, delta, reason):
2213
 
        BzrError.__init__(self)
2214
 
        self.delta = delta
2215
 
        self.reason = reason
 
1947
        self.repo_path = repo.bzrdir.root_transport.base
2216
1948
 
2217
1949
 
2218
1950
class UpgradeRequired(BzrError):
2224
1956
        self.path = path
2225
1957
 
2226
1958
 
2227
 
class RepositoryUpgradeRequired(UpgradeRequired):
2228
 
 
2229
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2230
 
 
2231
 
 
2232
 
class RichRootUpgradeRequired(UpgradeRequired):
2233
 
 
2234
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2235
 
           " a format which supports rich roots.")
2236
 
 
2237
 
 
2238
1959
class LocalRequiresBoundBranch(BzrError):
2239
1960
 
2240
1961
    _fmt = "Cannot perform local-only commits on unbound branches."
2241
1962
 
2242
1963
 
 
1964
class MissingProgressBarFinish(BzrError):
 
1965
 
 
1966
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1967
 
 
1968
 
 
1969
class InvalidProgressBarType(BzrError):
 
1970
 
 
1971
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1972
            " is not a supported type Select one of: %(valid_types)s")
 
1973
 
 
1974
    def __init__(self, bar_type, valid_types):
 
1975
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1976
 
 
1977
 
2243
1978
class UnsupportedOperation(BzrError):
2244
1979
 
2245
1980
    _fmt = ("The method %(mname)s is not supported on"
2262
1997
 
2263
1998
 
2264
1999
class BinaryFile(BzrError):
2265
 
 
 
2000
    
2266
2001
    _fmt = "File is binary but should be text."
2267
2002
 
2268
2003
 
2288
2023
 
2289
2024
 
2290
2025
class NotABundle(BzrError):
2291
 
 
 
2026
    
2292
2027
    _fmt = "Not a bzr revision-bundle: %(text)r"
2293
2028
 
2294
2029
    def __init__(self, text):
2296
2031
        self.text = text
2297
2032
 
2298
2033
 
2299
 
class BadBundle(BzrError):
2300
 
 
 
2034
class BadBundle(BzrError): 
 
2035
    
2301
2036
    _fmt = "Bad bzr revision-bundle: %(text)r"
2302
2037
 
2303
2038
    def __init__(self, text):
2305
2040
        self.text = text
2306
2041
 
2307
2042
 
2308
 
class MalformedHeader(BadBundle):
2309
 
 
 
2043
class MalformedHeader(BadBundle): 
 
2044
    
2310
2045
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2311
2046
 
2312
2047
 
2313
 
class MalformedPatches(BadBundle):
2314
 
 
 
2048
class MalformedPatches(BadBundle): 
 
2049
    
2315
2050
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2316
2051
 
2317
2052
 
2318
 
class MalformedFooter(BadBundle):
2319
 
 
 
2053
class MalformedFooter(BadBundle): 
 
2054
    
2320
2055
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2321
2056
 
2322
2057
 
2323
2058
class UnsupportedEOLMarker(BadBundle):
2324
 
 
2325
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2059
    
 
2060
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2326
2061
 
2327
2062
    def __init__(self):
2328
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2063
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2329
2064
        # but for this there is not
2330
2065
        BzrError.__init__(self)
2331
2066
 
2332
2067
 
2333
2068
class IncompatibleBundleFormat(BzrError):
2334
 
 
 
2069
    
2335
2070
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2336
2071
 
2337
2072
    def __init__(self, bundle_format, other):
2341
2076
 
2342
2077
 
2343
2078
class BadInventoryFormat(BzrError):
2344
 
 
 
2079
    
2345
2080
    _fmt = "Root class for inventory serialization errors"
2346
2081
 
2347
2082
 
2366
2101
        self.transport = transport
2367
2102
 
2368
2103
 
 
2104
class NoSmartServer(NotBranchError):
 
2105
 
 
2106
    _fmt = "No smart server available at %(url)s"
 
2107
 
 
2108
    def __init__(self, url):
 
2109
        self.url = url
 
2110
 
 
2111
 
2369
2112
class UnknownSSH(BzrError):
2370
2113
 
2371
2114
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2381
2124
            " Please set BZR_SSH environment variable.")
2382
2125
 
2383
2126
 
2384
 
class GhostRevisionsHaveNoRevno(BzrError):
2385
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2386
 
 
2387
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2388
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2389
 
 
2390
 
    def __init__(self, revision_id, ghost_revision_id):
2391
 
        self.revision_id = revision_id
2392
 
        self.ghost_revision_id = ghost_revision_id
2393
 
 
2394
 
 
2395
2127
class GhostRevisionUnusableHere(BzrError):
2396
2128
 
2397
2129
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2475
2207
        self.patch_type = patch_type
2476
2208
 
2477
2209
 
2478
 
class TargetNotBranch(BzrError):
2479
 
    """A merge directive's target branch is required, but isn't a branch"""
2480
 
 
2481
 
    _fmt = ("Your branch does not have all of the revisions required in "
2482
 
            "order to merge this merge directive and the target "
2483
 
            "location specified in the merge directive is not a branch: "
2484
 
            "%(location)s.")
2485
 
 
2486
 
    def __init__(self, location):
2487
 
        BzrError.__init__(self)
2488
 
        self.location = location
2489
 
 
2490
 
 
2491
2210
class UnsupportedInventoryKind(BzrError):
2492
 
 
 
2211
    
2493
2212
    _fmt = """Unsupported entry kind %(kind)s"""
2494
2213
 
2495
2214
    def __init__(self, kind):
2507
2226
 
2508
2227
 
2509
2228
class SubsumeTargetNeedsUpgrade(BzrError):
2510
 
 
 
2229
    
2511
2230
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2512
2231
 
2513
2232
    def __init__(self, other_tree):
2536
2255
class TagsNotSupported(BzrError):
2537
2256
 
2538
2257
    _fmt = ("Tags not supported by %(branch)s;"
2539
 
            " you may be able to use bzr upgrade.")
 
2258
            " you may be able to use bzr upgrade --dirstate-tags.")
2540
2259
 
2541
2260
    def __init__(self, branch):
2542
2261
        self.branch = branch
2543
2262
 
2544
 
 
 
2263
        
2545
2264
class TagAlreadyExists(BzrError):
2546
2265
 
2547
2266
    _fmt = "Tag %(tag_name)s already exists."
2552
2271
 
2553
2272
class MalformedBugIdentifier(BzrError):
2554
2273
 
2555
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2556
 
            'See "bzr help bugs" for more information on this feature.')
 
2274
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2557
2275
 
2558
2276
    def __init__(self, bug_id, reason):
2559
2277
        self.bug_id = bug_id
2560
2278
        self.reason = reason
2561
2279
 
2562
2280
 
2563
 
class InvalidBugTrackerURL(BzrError):
2564
 
 
2565
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2566
 
            "contain {id}: %(url)s")
2567
 
 
2568
 
    def __init__(self, abbreviation, url):
2569
 
        self.abbreviation = abbreviation
2570
 
        self.url = url
2571
 
 
2572
 
 
2573
2281
class UnknownBugTrackerAbbreviation(BzrError):
2574
2282
 
2575
2283
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2580
2288
        self.branch = branch
2581
2289
 
2582
2290
 
2583
 
class InvalidLineInBugsProperty(BzrError):
2584
 
 
2585
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2586
 
 
2587
 
    def __init__(self, line):
2588
 
        self.line = line
2589
 
 
2590
 
 
2591
 
class InvalidBugStatus(BzrError):
2592
 
 
2593
 
    _fmt = ("Invalid bug status: '%(status)s'")
2594
 
 
2595
 
    def __init__(self, status):
2596
 
        self.status = status
2597
 
 
2598
 
 
2599
2291
class UnexpectedSmartServerResponse(BzrError):
2600
2292
 
2601
2293
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2604
2296
        self.response_tuple = response_tuple
2605
2297
 
2606
2298
 
2607
 
class ErrorFromSmartServer(BzrError):
2608
 
    """An error was received from a smart server.
2609
 
 
2610
 
    :seealso: UnknownErrorFromSmartServer
2611
 
    """
2612
 
 
2613
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2614
 
 
2615
 
    internal_error = True
2616
 
 
2617
 
    def __init__(self, error_tuple):
2618
 
        self.error_tuple = error_tuple
2619
 
        try:
2620
 
            self.error_verb = error_tuple[0]
2621
 
        except IndexError:
2622
 
            self.error_verb = None
2623
 
        self.error_args = error_tuple[1:]
2624
 
 
2625
 
 
2626
 
class UnknownErrorFromSmartServer(BzrError):
2627
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2628
 
    error.
2629
 
 
2630
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2631
 
    distinguish between the following two cases:
2632
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2633
 
        and so should provoke a traceback to the user.
2634
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2635
 
        translated.  This is probably because the server sent us garbage, and
2636
 
        should not provoke a traceback.
2637
 
    """
2638
 
 
2639
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2640
 
 
2641
 
    internal_error = False
2642
 
 
2643
 
    def __init__(self, error_from_smart_server):
2644
 
        """Constructor.
2645
 
 
2646
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2647
 
        """
2648
 
        self.error_from_smart_server = error_from_smart_server
2649
 
        self.error_tuple = error_from_smart_server.error_tuple
2650
 
 
2651
 
 
2652
2299
class ContainerError(BzrError):
2653
2300
    """Base class of container errors."""
2654
2301
 
2656
2303
class UnknownContainerFormatError(ContainerError):
2657
2304
 
2658
2305
    _fmt = "Unrecognised container format: %(container_format)r"
2659
 
 
 
2306
    
2660
2307
    def __init__(self, container_format):
2661
2308
        self.container_format = container_format
2662
2309
 
2724
2371
    _fmt = "No message supplied."
2725
2372
 
2726
2373
 
2727
 
class NoMailAddressSpecified(BzrError):
2728
 
 
2729
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2730
 
 
2731
 
 
2732
2374
class UnknownMailClient(BzrError):
2733
2375
 
2734
2376
    _fmt = "Unknown mail client: %(mail_client)s"
2765
2407
 
2766
2408
    def __init__(self, bzrdir):
2767
2409
        import bzrlib.urlutils as urlutils
2768
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2410
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2769
2411
                                                    'ascii')
2770
2412
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2771
2413
 
2772
2414
 
2773
 
class UnsyncedBranches(BzrDirError):
2774
 
 
2775
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2776
 
            " bzr help sync-for-reconfigure.")
2777
 
 
2778
 
    def __init__(self, bzrdir, target_branch):
2779
 
        BzrDirError.__init__(self, bzrdir)
2780
 
        import bzrlib.urlutils as urlutils
2781
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2782
 
                                                        'ascii')
2783
 
 
2784
 
 
2785
2415
class AlreadyBranch(BzrDirError):
2786
2416
 
2787
2417
    _fmt = "'%(display_url)s' is already a branch."
2797
2427
    _fmt = "'%(display_url)s' is already a checkout."
2798
2428
 
2799
2429
 
2800
 
class AlreadyLightweightCheckout(BzrDirError):
2801
 
 
2802
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2803
 
 
2804
 
 
2805
 
class AlreadyUsingShared(BzrDirError):
2806
 
 
2807
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2808
 
 
2809
 
 
2810
 
class AlreadyStandalone(BzrDirError):
2811
 
 
2812
 
    _fmt = "'%(display_url)s' is already standalone."
2813
 
 
2814
 
 
2815
 
class AlreadyWithTrees(BzrDirError):
2816
 
 
2817
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2818
 
            "working trees.")
2819
 
 
2820
 
 
2821
 
class AlreadyWithNoTrees(BzrDirError):
2822
 
 
2823
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2824
 
            "working trees.")
2825
 
 
2826
 
 
2827
2430
class ReconfigurationNotSupported(BzrDirError):
2828
2431
 
2829
2432
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2836
2439
 
2837
2440
class UncommittedChanges(BzrError):
2838
2441
 
2839
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2840
 
            ' (See bzr status).%(more)s')
 
2442
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2841
2443
 
2842
 
    def __init__(self, tree, more=None):
2843
 
        if more is None:
2844
 
            more = ''
2845
 
        else:
2846
 
            more = ' ' + more
 
2444
    def __init__(self, tree):
2847
2445
        import bzrlib.urlutils as urlutils
2848
2446
        display_url = urlutils.unescape_for_display(
2849
 
            tree.user_url, 'ascii')
2850
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2851
 
 
2852
 
 
2853
 
class MissingTemplateVariable(BzrError):
2854
 
 
2855
 
    _fmt = 'Variable {%(name)s} is not available.'
2856
 
 
2857
 
    def __init__(self, name):
2858
 
        self.name = name
2859
 
 
2860
 
 
2861
 
class NoTemplate(BzrError):
2862
 
 
2863
 
    _fmt = 'No template specified.'
2864
 
 
2865
 
 
2866
 
class UnableCreateSymlink(BzrError):
2867
 
 
2868
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2869
 
 
2870
 
    def __init__(self, path=None):
2871
 
        path_str = ''
2872
 
        if path:
2873
 
            try:
2874
 
                path_str = repr(str(path))
2875
 
            except UnicodeEncodeError:
2876
 
                path_str = repr(path)
2877
 
            path_str += ' '
2878
 
        self.path_str = path_str
2879
 
 
2880
 
 
2881
 
class UnsupportedTimezoneFormat(BzrError):
2882
 
 
2883
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2884
 
            'options are "utc", "original", "local".')
2885
 
 
2886
 
    def __init__(self, timezone):
2887
 
        self.timezone = timezone
2888
 
 
2889
 
 
2890
 
class CommandAvailableInPlugin(StandardError):
2891
 
 
2892
 
    internal_error = False
2893
 
 
2894
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2895
 
 
2896
 
        self.plugin_metadata = plugin_metadata
2897
 
        self.cmd_name = cmd_name
2898
 
        self.provider = provider
2899
 
 
2900
 
    def __str__(self):
2901
 
 
2902
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2903
 
                'However, the following official plugin provides this command: %s\n'
2904
 
                'You can install it by going to: %s'
2905
 
                % (self.cmd_name, self.plugin_metadata['name'],
2906
 
                    self.plugin_metadata['url']))
2907
 
 
2908
 
        return _fmt
2909
 
 
2910
 
 
2911
 
class NoPluginAvailable(BzrError):
2912
 
    pass
2913
 
 
2914
 
 
2915
 
class UnableEncodePath(BzrError):
2916
 
 
2917
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2918
 
            'user encoding %(user_encoding)s')
2919
 
 
2920
 
    def __init__(self, path, kind):
2921
 
        from bzrlib.osutils import get_user_encoding
2922
 
        self.path = path
2923
 
        self.kind = kind
2924
 
        self.user_encoding = osutils.get_user_encoding()
2925
 
 
2926
 
 
2927
 
class NoSuchAlias(BzrError):
2928
 
 
2929
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2930
 
 
2931
 
    def __init__(self, alias_name):
2932
 
        BzrError.__init__(self, alias_name=alias_name)
2933
 
 
2934
 
 
2935
 
class DirectoryLookupFailure(BzrError):
2936
 
    """Base type for lookup errors."""
2937
 
 
2938
 
    pass
2939
 
 
2940
 
 
2941
 
class InvalidLocationAlias(DirectoryLookupFailure):
2942
 
 
2943
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2944
 
 
2945
 
    def __init__(self, alias_name):
2946
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2947
 
 
2948
 
 
2949
 
class UnsetLocationAlias(DirectoryLookupFailure):
2950
 
 
2951
 
    _fmt = 'No %(alias_name)s location assigned.'
2952
 
 
2953
 
    def __init__(self, alias_name):
2954
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2955
 
 
2956
 
 
2957
 
class CannotBindAddress(BzrError):
2958
 
 
2959
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2960
 
 
2961
 
    def __init__(self, host, port, orig_error):
2962
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2963
 
        BzrError.__init__(self, host=host, port=port,
2964
 
            orig_error=repr(orig_error.args))
2965
 
 
2966
 
 
2967
 
class UnknownRules(BzrError):
2968
 
 
2969
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2970
 
 
2971
 
    def __init__(self, unknowns):
2972
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2973
 
 
2974
 
 
2975
 
class HookFailed(BzrError):
2976
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2977
 
    than TipChangeRejected.
2978
 
 
2979
 
    Note that this exception is no longer raised, and the import is only left
2980
 
    to be nice to code which might catch it in a plugin.
2981
 
    """
2982
 
 
2983
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2984
 
            "%(traceback_text)s%(exc_value)s")
2985
 
 
2986
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2987
 
        if warn:
2988
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2989
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2990
 
        import traceback
2991
 
        self.hook_stage = hook_stage
2992
 
        self.hook_name = hook_name
2993
 
        self.exc_info = exc_info
2994
 
        self.exc_type = exc_info[0]
2995
 
        self.exc_value = exc_info[1]
2996
 
        self.exc_tb = exc_info[2]
2997
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2998
 
 
2999
 
 
3000
 
class TipChangeRejected(BzrError):
3001
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3002
 
    explicitly abort a change to a branch tip.
3003
 
    """
3004
 
 
3005
 
    _fmt = u"Tip change rejected: %(msg)s"
3006
 
 
3007
 
    def __init__(self, msg):
3008
 
        self.msg = msg
3009
 
 
3010
 
 
3011
 
class ShelfCorrupt(BzrError):
3012
 
 
3013
 
    _fmt = "Shelf corrupt."
3014
 
 
3015
 
 
3016
 
class NoSuchShelfId(BzrError):
3017
 
 
3018
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3019
 
 
3020
 
    def __init__(self, shelf_id):
3021
 
        BzrError.__init__(self, shelf_id=shelf_id)
3022
 
 
3023
 
 
3024
 
class InvalidShelfId(BzrError):
3025
 
 
3026
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3027
 
 
3028
 
    def __init__(self, invalid_id):
3029
 
        BzrError.__init__(self, invalid_id=invalid_id)
3030
 
 
3031
 
 
3032
 
class JailBreak(BzrError):
3033
 
 
3034
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3035
 
 
3036
 
    def __init__(self, url):
3037
 
        BzrError.__init__(self, url=url)
3038
 
 
3039
 
 
3040
 
class UserAbort(BzrError):
3041
 
 
3042
 
    _fmt = 'The user aborted the operation.'
3043
 
 
3044
 
 
3045
 
class MustHaveWorkingTree(BzrError):
3046
 
 
3047
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3048
 
 
3049
 
    def __init__(self, format, url):
3050
 
        BzrError.__init__(self, format=format, url=url)
3051
 
 
3052
 
 
3053
 
class NoSuchView(BzrError):
3054
 
    """A view does not exist.
3055
 
    """
3056
 
 
3057
 
    _fmt = u"No such view: %(view_name)s."
3058
 
 
3059
 
    def __init__(self, view_name):
3060
 
        self.view_name = view_name
3061
 
 
3062
 
 
3063
 
class ViewsNotSupported(BzrError):
3064
 
    """Views are not supported by a tree format.
3065
 
    """
3066
 
 
3067
 
    _fmt = ("Views are not supported by %(tree)s;"
3068
 
            " use 'bzr upgrade' to change your tree to a later format.")
3069
 
 
3070
 
    def __init__(self, tree):
3071
 
        self.tree = tree
3072
 
 
3073
 
 
3074
 
class FileOutsideView(BzrError):
3075
 
 
3076
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3077
 
            '%(view_str)s')
3078
 
 
3079
 
    def __init__(self, file_name, view_files):
3080
 
        self.file_name = file_name
3081
 
        self.view_str = ", ".join(view_files)
3082
 
 
3083
 
 
3084
 
class UnresumableWriteGroup(BzrError):
3085
 
 
3086
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3087
 
            "%(write_groups)r: %(reason)s")
3088
 
 
3089
 
    internal_error = True
3090
 
 
3091
 
    def __init__(self, repository, write_groups, reason):
3092
 
        self.repository = repository
3093
 
        self.write_groups = write_groups
3094
 
        self.reason = reason
3095
 
 
3096
 
 
3097
 
class UnsuspendableWriteGroup(BzrError):
3098
 
 
3099
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3100
 
 
3101
 
    internal_error = True
3102
 
 
3103
 
    def __init__(self, repository):
3104
 
        self.repository = repository
3105
 
 
3106
 
 
3107
 
class LossyPushToSameVCS(BzrError):
3108
 
 
3109
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3110
 
            "%(target_branch)r that are in the same VCS.")
3111
 
 
3112
 
    internal_error = True
3113
 
 
3114
 
    def __init__(self, source_branch, target_branch):
3115
 
        self.source_branch = source_branch
3116
 
        self.target_branch = target_branch
3117
 
 
3118
 
 
3119
 
class NoRoundtrippingSupport(BzrError):
3120
 
 
3121
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3122
 
            "%(target_branch)r.")
3123
 
 
3124
 
    internal_error = True
3125
 
 
3126
 
    def __init__(self, source_branch, target_branch):
3127
 
        self.source_branch = source_branch
3128
 
        self.target_branch = target_branch
3129
 
 
3130
 
 
3131
 
class FileTimestampUnavailable(BzrError):
3132
 
 
3133
 
    _fmt = "The filestamp for %(path)s is not available."
3134
 
 
3135
 
    internal_error = True
3136
 
 
3137
 
    def __init__(self, path):
3138
 
        self.path = path
3139
 
 
3140
 
 
3141
 
class NoColocatedBranchSupport(BzrError):
3142
 
 
3143
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3144
 
 
3145
 
    def __init__(self, bzrdir):
3146
 
        self.bzrdir = bzrdir
3147
 
 
3148
 
class NoWhoami(BzrError):
3149
 
 
3150
 
    _fmt = ('Unable to determine your name.\n'
3151
 
        "Please, set your name with the 'whoami' command.\n"
3152
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3153
 
 
3154
 
 
 
2447
            tree.bzrdir.root_transport.base, 'ascii')
 
2448
        BzrError.__init__(self, tree=tree, display_url=display_url)