← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-02 17:16:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5369.
  • Revision ID: john@arbash-meinel.com-20100802171612-rdh5ods70w2bl3j7
We also have to re-implement it for _simple_set_pyx.pyx

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
 
21
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
44
43
# 'unprintable'.
45
44
 
46
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
 
50
 
 
51
 
47
52
class BzrError(StandardError):
48
53
    """
49
54
    Base class for errors raised by bzrlib.
56
61
    :cvar _fmt: Format string to display the error; this is expanded
57
62
    by the instance's dict.
58
63
    """
59
 
    
 
64
 
60
65
    internal_error = False
61
66
 
62
67
    def __init__(self, msg=None, **kwds):
67
72
        arguments can be given.  The first is for generic "user" errors which
68
73
        are not intended to be caught and so do not need a specific subclass.
69
74
        The second case is for use with subclasses that provide a _fmt format
70
 
        string to print the arguments.  
 
75
        string to print the arguments.
71
76
 
72
 
        Keyword arguments are taken as parameters to the error, which can 
73
 
        be inserted into the format string template.  It's recommended 
74
 
        that subclasses override the __init__ method to require specific 
 
77
        Keyword arguments are taken as parameters to the error, which can
 
78
        be inserted into the format string template.  It's recommended
 
79
        that subclasses override the __init__ method to require specific
75
80
        parameters.
76
81
 
77
82
        :param msg: If given, this is the literal complete text for the error,
78
 
        not subject to expansion.
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
79
85
        """
80
86
        StandardError.__init__(self)
81
87
        if msg is not None:
87
93
            for key, value in kwds.items():
88
94
                setattr(self, key, value)
89
95
 
90
 
    def __str__(self):
 
96
    def _format(self):
91
97
        s = getattr(self, '_preformatted_string', None)
92
98
        if s is not None:
93
 
            # contains a preformatted message; must be cast to plain str
94
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
95
101
        try:
96
102
            fmt = self._get_format_string()
97
103
            if fmt:
98
 
                s = fmt % self.__dict__
 
104
                d = dict(self.__dict__)
 
105
                s = fmt % d
99
106
                # __str__() should always return a 'str' object
100
107
                # never a 'unicode' object.
101
 
                if isinstance(s, unicode):
102
 
                    return s.encode('utf8')
103
108
                return s
104
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
105
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
108
113
                   getattr(self, '_fmt', None),
109
114
                   e)
110
115
 
 
116
    def __unicode__(self):
 
117
        u = self._format()
 
118
        if isinstance(u, str):
 
119
            # Try decoding the str using the default encoding.
 
120
            u = unicode(u)
 
121
        elif not isinstance(u, unicode):
 
122
            # Try to make a unicode object from it, because __unicode__ must
 
123
            # return a unicode object.
 
124
            u = unicode(u)
 
125
        return u
 
126
 
 
127
    def __str__(self):
 
128
        s = self._format()
 
129
        if isinstance(s, unicode):
 
130
            s = s.encode('utf8')
 
131
        else:
 
132
            # __str__ must return a str.
 
133
            s = str(s)
 
134
        return s
 
135
 
 
136
    def __repr__(self):
 
137
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
138
 
111
139
    def _get_format_string(self):
112
140
        """Return format string for this exception or None"""
113
141
        fmt = getattr(self, '_fmt', None)
125
153
               getattr(self, '_fmt', None),
126
154
               )
127
155
 
 
156
    def __eq__(self, other):
 
157
        if self.__class__ is not other.__class__:
 
158
            return NotImplemented
 
159
        return self.__dict__ == other.__dict__
 
160
 
 
161
 
 
162
class InternalBzrError(BzrError):
 
163
    """Base class for errors that are internal in nature.
 
164
 
 
165
    This is a convenience class for errors that are internal. The
 
166
    internal_error attribute can still be altered in subclasses, if needed.
 
167
    Using this class is simply an easy way to get internal errors.
 
168
    """
 
169
 
 
170
    internal_error = True
 
171
 
128
172
 
129
173
class BzrNewError(BzrError):
130
174
    """Deprecated error base class."""
160
204
 
161
205
 
162
206
class AlreadyBuilding(BzrError):
163
 
    
 
207
 
164
208
    _fmt = "The tree builder is already building a tree."
165
209
 
166
210
 
167
 
class BzrCheckError(BzrError):
168
 
    
169
 
    _fmt = "Internal check failed: %(message)s"
170
 
 
171
 
    internal_error = True
172
 
 
173
 
    def __init__(self, message):
174
 
        BzrError.__init__(self)
175
 
        self.message = message
176
 
 
177
 
 
178
 
class DisabledMethod(BzrError):
 
211
class BranchError(BzrError):
 
212
    """Base class for concrete 'errors about a branch'."""
 
213
 
 
214
    def __init__(self, branch):
 
215
        BzrError.__init__(self, branch=branch)
 
216
 
 
217
 
 
218
class BzrCheckError(InternalBzrError):
 
219
 
 
220
    _fmt = "Internal check failed: %(msg)s"
 
221
 
 
222
    def __init__(self, msg):
 
223
        BzrError.__init__(self)
 
224
        self.msg = msg
 
225
 
 
226
 
 
227
class DirstateCorrupt(BzrError):
 
228
 
 
229
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
230
 
 
231
    def __init__(self, state, msg):
 
232
        BzrError.__init__(self)
 
233
        self.state = state
 
234
        self.msg = msg
 
235
 
 
236
 
 
237
class DisabledMethod(InternalBzrError):
179
238
 
180
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
181
240
 
182
 
    internal_error = True
183
 
 
184
241
    def __init__(self, class_name):
185
242
        BzrError.__init__(self)
186
243
        self.class_name = class_name
207
264
        self.transport = transport
208
265
 
209
266
 
210
 
class InvalidEntryName(BzrError):
211
 
    
 
267
class InvalidEntryName(InternalBzrError):
 
268
 
212
269
    _fmt = "Invalid entry name: %(name)s"
213
270
 
214
 
    internal_error = True
215
 
 
216
271
    def __init__(self, name):
217
272
        BzrError.__init__(self)
218
273
        self.name = name
219
274
 
220
275
 
221
276
class InvalidRevisionNumber(BzrError):
222
 
    
 
277
 
223
278
    _fmt = "Invalid revision number %(revno)s"
224
279
 
225
280
    def __init__(self, revno):
237
292
        self.revision_id = revision_id
238
293
        self.branch = branch
239
294
 
 
295
 
240
296
class ReservedId(BzrError):
241
297
 
242
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
245
301
        self.revision_id = revision_id
246
302
 
247
303
 
 
304
class RootMissing(InternalBzrError):
 
305
 
 
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
307
        "record_entry_contents.")
 
308
 
 
309
 
 
310
class NoPublicBranch(BzrError):
 
311
 
 
312
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
313
 
 
314
    def __init__(self, branch):
 
315
        import bzrlib.urlutils as urlutils
 
316
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
317
        BzrError.__init__(self, branch_url=public_location)
 
318
 
 
319
 
248
320
class NoHelpTopic(BzrError):
249
321
 
250
322
    _fmt = ("No help could be found for '%(topic)s'. "
257
329
class NoSuchId(BzrError):
258
330
 
259
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
260
 
    
 
332
 
261
333
    def __init__(self, tree, file_id):
262
334
        BzrError.__init__(self)
263
335
        self.file_id = file_id
273
345
        BzrError.__init__(self, repository=repository, file_id=file_id)
274
346
 
275
347
 
276
 
class InventoryModified(BzrError):
 
348
class NotStacked(BranchError):
 
349
 
 
350
    _fmt = "The branch '%(branch)s' is not stacked."
 
351
 
 
352
 
 
353
class InventoryModified(InternalBzrError):
277
354
 
278
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
279
356
            " so a clean inventory cannot be read without data loss.")
280
357
 
281
 
    internal_error = True
282
 
 
283
358
    def __init__(self, tree):
284
359
        self.tree = tree
285
360
 
287
362
class NoWorkingTree(BzrError):
288
363
 
289
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
290
 
    
 
365
 
291
366
    def __init__(self, base):
292
367
        BzrError.__init__(self)
293
368
        self.base = base
306
381
        self.url = url
307
382
 
308
383
 
309
 
class WorkingTreeAlreadyPopulated(BzrError):
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
310
385
 
311
386
    _fmt = 'Working tree already populated in "%(base)s"'
312
387
 
313
 
    internal_error = True
314
 
 
315
388
    def __init__(self, base):
316
389
        self.base = base
317
390
 
 
391
 
318
392
class BzrCommandError(BzrError):
319
393
    """Error from user command"""
320
394
 
321
 
    internal_error = False
322
 
 
323
395
    # Error from malformed user command; please avoid raising this as a
324
396
    # generic exception not caused by user input.
325
397
    #
327
399
    # are not intended to be caught anyway.  UI code need not subclass
328
400
    # BzrCommandError, and non-UI code should not throw a subclass of
329
401
    # BzrCommandError.  ADHB 20051211
330
 
    def __init__(self, msg):
331
 
        # Object.__str__() must return a real string
332
 
        # returning a Unicode string is a python error.
333
 
        if isinstance(msg, unicode):
334
 
            self.msg = msg.encode('utf8')
335
 
        else:
336
 
            self.msg = msg
337
 
 
338
 
    def __str__(self):
339
 
        return self.msg
340
402
 
341
403
 
342
404
class NotWriteLocked(BzrError):
415
477
    def __init__(self, name, value):
416
478
        BzrError.__init__(self, name=name, value=value)
417
479
 
418
 
    
 
480
 
419
481
class StrictCommitFailed(BzrError):
420
482
 
421
483
    _fmt = "Commit refused because there are unknown files in the tree"
424
486
# XXX: Should be unified with TransportError; they seem to represent the
425
487
# same thing
426
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
427
 
# - 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
428
490
# differentiates between 'transport has failed' and 'operation on a transport
429
491
# has failed.'
430
492
class PathError(BzrError):
431
 
    
 
493
 
432
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
433
495
 
434
496
    def __init__(self, path, extra=None):
454
516
    """Used when renaming and both source and dest exist."""
455
517
 
456
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
457
 
            "%(extra)s")
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
458
521
 
459
522
    def __init__(self, source, dest, extra=None):
460
523
        BzrError.__init__(self)
481
544
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
482
545
 
483
546
 
484
 
class ReadingCompleted(BzrError):
485
 
    
 
547
class HardLinkNotSupported(PathError):
 
548
 
 
549
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
550
 
 
551
 
 
552
class ReadingCompleted(InternalBzrError):
 
553
 
486
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
487
555
            "called upon it - the request has been completed and no more "
488
556
            "data may be read.")
489
557
 
490
 
    internal_error = True
491
 
 
492
558
    def __init__(self, request):
493
559
        self.request = request
494
560
 
510
576
 
511
577
class InvalidURLJoin(PathError):
512
578
 
513
 
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
514
 
 
515
 
    def __init__(self, msg, base, args):
516
 
        PathError.__init__(self, base, msg)
517
 
        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
518
608
 
519
609
 
520
610
class UnknownHook(BzrError):
535
625
        PathError.__init__(self, url, extra=extra)
536
626
 
537
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
 
538
660
class ReadError(PathError):
539
 
    
 
661
 
540
662
    _fmt = """Error reading from %(path)r."""
541
663
 
542
664
 
558
680
 
559
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
560
682
 
561
 
    internal_error = True
 
683
    internal_error = False
562
684
 
563
685
    def __init__(self, path, base, extra=None):
564
686
        BzrError.__init__(self)
577
699
 
578
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
579
701
# the exception object is a bit undesirable.
580
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
581
703
class NotBranchError(PathError):
582
704
 
583
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
584
706
 
585
 
    def __init__(self, path):
 
707
    def __init__(self, path, detail=None, bzrdir=None):
586
708
       import bzrlib.urlutils as urlutils
587
 
       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)
588
731
 
589
732
 
590
733
class NoSubmitBranch(PathError):
637
780
 
638
781
class FileInWrongBranch(BzrError):
639
782
 
640
 
    _fmt = 'File "%(path)s" in not in branch %(branch_base)s.'
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
641
784
 
 
785
    # use PathNotChild instead
 
786
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
642
787
    def __init__(self, branch, path):
643
788
        BzrError.__init__(self)
644
789
        self.branch = branch
652
797
 
653
798
 
654
799
class UnknownFormatError(BzrError):
655
 
    
656
 
    _fmt = "Unknown branch format: %(format)r"
 
800
 
 
801
    _fmt = "Unknown %(kind)s format: %(format)r"
 
802
 
 
803
    def __init__(self, format, kind='branch'):
 
804
        self.kind = kind
 
805
        self.format = format
657
806
 
658
807
 
659
808
class IncompatibleFormat(BzrError):
660
 
    
 
809
 
661
810
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
662
811
 
663
812
    def __init__(self, format, bzrdir_format):
667
816
 
668
817
 
669
818
class IncompatibleRepositories(BzrError):
670
 
 
671
 
    _fmt = "Repository %(target)s is not compatible with repository"\
672
 
        " %(source)s"
673
 
 
674
 
    def __init__(self, source, target):
675
 
        BzrError.__init__(self, target=target, source=source)
 
819
    """Report an error that two repositories are not compatible.
 
820
 
 
821
    Note that the source and target repositories are permitted to be strings:
 
822
    this exception is thrown from the smart server and may refer to a
 
823
    repository the client hasn't opened.
 
824
    """
 
825
 
 
826
    _fmt = "%(target)s\n" \
 
827
            "is not compatible with\n" \
 
828
            "%(source)s\n" \
 
829
            "%(details)s"
 
830
 
 
831
    def __init__(self, source, target, details=None):
 
832
        if details is None:
 
833
            details = "(no details)"
 
834
        BzrError.__init__(self, target=target, source=source, details=details)
676
835
 
677
836
 
678
837
class IncompatibleRevision(BzrError):
679
 
    
 
838
 
680
839
    _fmt = "Revision is not compatible with %(repo_format)s"
681
840
 
682
841
    def __init__(self, repo_format):
765
924
        BzrError.__init__(self, filename=filename, kind=kind)
766
925
 
767
926
 
 
927
class BadFilenameEncoding(BzrError):
 
928
 
 
929
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
930
            ' encoding %(fs_encoding)s')
 
931
 
 
932
    def __init__(self, filename, fs_encoding):
 
933
        BzrError.__init__(self)
 
934
        self.filename = filename
 
935
        self.fs_encoding = fs_encoding
 
936
 
 
937
 
768
938
class ForbiddenControlFileError(BzrError):
769
939
 
770
940
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
771
941
 
772
942
 
773
 
class LockError(BzrError):
 
943
class LockError(InternalBzrError):
774
944
 
775
945
    _fmt = "Lock error: %(msg)s"
776
946
 
777
 
    internal_error = True
778
 
 
779
947
    # All exceptions from the lock/unlock functions should be from
780
948
    # this exception class.  They will be translated as necessary. The
781
949
    # original exception is available as e.original_error
783
951
    # New code should prefer to raise specific subclasses
784
952
    def __init__(self, message):
785
953
        # Python 2.5 uses a slot for StandardError.message,
786
 
        # so use a different variable name
787
 
        # so it is exposed in self.__dict__
 
954
        # so use a different variable name.  We now work around this in
 
955
        # BzrError.__str__, but this member name is kept for compatability.
788
956
        self.msg = message
789
957
 
790
958
 
825
993
        self.obj = obj
826
994
 
827
995
 
828
 
class ReadOnlyLockError(LockError):
829
 
 
830
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
831
 
 
832
 
    def __init__(self, fname, msg):
 
996
class LockFailed(LockError):
 
997
 
 
998
    internal_error = False
 
999
 
 
1000
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
1001
 
 
1002
    def __init__(self, lock, why):
833
1003
        LockError.__init__(self, '')
834
 
        self.fname = fname
835
 
        self.msg = msg
 
1004
        self.lock = lock
 
1005
        self.why = why
836
1006
 
837
1007
 
838
1008
class OutSideTransaction(BzrError):
862
1032
 
863
1033
class UnlockableTransport(LockError):
864
1034
 
 
1035
    internal_error = False
 
1036
 
865
1037
    _fmt = "Cannot lock: transport is read only: %(transport)s"
866
1038
 
867
1039
    def __init__(self, transport):
870
1042
 
871
1043
class LockContention(LockError):
872
1044
 
873
 
    _fmt = 'Could not acquire lock "%(lock)s"'
874
 
    # TODO: show full url for lock, combining the transport and relative
875
 
    # bits?
 
1045
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
876
1046
 
877
1047
    internal_error = False
878
1048
 
879
 
    def __init__(self, lock):
 
1049
    def __init__(self, lock, msg=''):
880
1050
        self.lock = lock
 
1051
        self.msg = msg
881
1052
 
882
1053
 
883
1054
class LockBroken(LockError):
918
1089
 
919
1090
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
920
1091
 
921
 
    internal_error = True
922
 
 
923
1092
    def __init__(self, obj):
924
1093
        self.obj = obj
925
1094
 
975
1144
    _fmt = "Commit refused because there are unknowns in the tree."
976
1145
 
977
1146
 
978
 
class NoSuchRevision(BzrError):
 
1147
class NoSuchRevision(InternalBzrError):
979
1148
 
980
1149
    _fmt = "%(branch)s has no revision %(revision)s"
981
1150
 
982
 
    internal_error = True
983
 
 
984
1151
    def __init__(self, branch, revision):
985
1152
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
986
1153
        BzrError.__init__(self, branch=branch, revision=revision)
987
1154
 
988
1155
 
989
 
# zero_ninetyone: this exception is no longer raised and should be removed
990
 
class NotLeftParentDescendant(BzrError):
991
 
 
992
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
993
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
994
 
 
995
 
    internal_error = True
996
 
 
997
 
    def __init__(self, branch, old_revision, new_revision):
998
 
        BzrError.__init__(self, branch_location=branch.base,
999
 
                          old_revision=old_revision,
1000
 
                          new_revision=new_revision)
1001
 
 
1002
 
 
1003
1156
class RangeInChangeOption(BzrError):
1004
1157
 
1005
1158
    _fmt = "Option --change does not accept revision ranges"
1015
1168
 
1016
1169
class NoSuchRevisionInTree(NoSuchRevision):
1017
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
1018
 
    
 
1171
 
1019
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1020
1173
 
1021
1174
    def __init__(self, tree, revision_id):
1026
1179
 
1027
1180
class InvalidRevisionSpec(BzrError):
1028
1181
 
1029
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1030
 
            " %(branch)s%(extra)s")
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1183
            " %(branch_url)s%(extra)s")
1031
1184
 
1032
1185
    def __init__(self, spec, branch, extra=None):
1033
1186
        BzrError.__init__(self, branch=branch, spec=spec)
 
1187
        self.branch_url = getattr(branch, 'user_url', str(branch))
1034
1188
        if extra:
1035
1189
            self.extra = '\n' + str(extra)
1036
1190
        else:
1057
1211
class DivergedBranches(BzrError):
1058
1212
 
1059
1213
    _fmt = ("These branches have diverged."
1060
 
            " Use the merge command to reconcile them.")
1061
 
 
1062
 
    internal_error = False
 
1214
            " Use the missing command to see how.\n"
 
1215
            "Use the merge command to reconcile them.")
1063
1216
 
1064
1217
    def __init__(self, branch1, branch2):
1065
1218
        self.branch1 = branch1
1066
1219
        self.branch2 = branch2
1067
1220
 
1068
1221
 
1069
 
class NotLefthandHistory(BzrError):
 
1222
class NotLefthandHistory(InternalBzrError):
1070
1223
 
1071
1224
    _fmt = "Supplied history does not follow left-hand parents"
1072
1225
 
1073
 
    internal_error = True
1074
 
 
1075
1226
    def __init__(self, history):
1076
1227
        BzrError.__init__(self, history=history)
1077
1228
 
1081
1232
    _fmt = ("Branches have no common ancestor, and"
1082
1233
            " no merge base revision was specified.")
1083
1234
 
1084
 
    internal_error = False
 
1235
 
 
1236
class CannotReverseCherrypick(BzrError):
 
1237
 
 
1238
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1239
            ' or diff3.')
1085
1240
 
1086
1241
 
1087
1242
class NoCommonAncestor(BzrError):
1088
 
    
 
1243
 
1089
1244
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1090
1245
 
1091
1246
    def __init__(self, revision_a, revision_b):
1111
1266
            not_ancestor_id=not_ancestor_id)
1112
1267
 
1113
1268
 
1114
 
class InstallFailed(BzrError):
1115
 
 
1116
 
    def __init__(self, revisions):
1117
 
        revision_str = ", ".join(str(r) for r in revisions)
1118
 
        msg = "Could not install revisions:\n%s" % revision_str
1119
 
        BzrError.__init__(self, msg)
1120
 
        self.revisions = revisions
1121
 
 
1122
 
 
1123
1269
class AmbiguousBase(BzrError):
1124
1270
 
1125
1271
    def __init__(self, bases):
1126
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1127
 
                DeprecationWarning)
 
1272
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1273
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1128
1274
        msg = ("The correct base is unclear, because %s are all equally close"
1129
1275
                % ", ".join(bases))
1130
1276
        BzrError.__init__(self, msg)
1131
1277
        self.bases = bases
1132
1278
 
1133
1279
 
1134
 
class NoCommits(BzrError):
 
1280
class NoCommits(BranchError):
1135
1281
 
1136
1282
    _fmt = "Branch %(branch)s has no commits."
1137
1283
 
1138
 
    def __init__(self, branch):
1139
 
        BzrError.__init__(self, branch=branch)
1140
 
 
1141
1284
 
1142
1285
class UnlistableStore(BzrError):
1143
1286
 
1155
1298
class BoundBranchOutOfDate(BzrError):
1156
1299
 
1157
1300
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1158
 
            " %(master)s.")
 
1301
            " %(master)s.%(extra_help)s")
1159
1302
 
1160
1303
    def __init__(self, branch, master):
1161
1304
        BzrError.__init__(self)
1162
1305
        self.branch = branch
1163
1306
        self.master = master
1164
 
 
1165
 
        
 
1307
        self.extra_help = ''
 
1308
 
 
1309
 
1166
1310
class CommitToDoubleBoundBranch(BzrError):
1167
1311
 
1168
1312
    _fmt = ("Cannot commit to branch %(branch)s."
1198
1342
 
1199
1343
class WeaveError(BzrError):
1200
1344
 
1201
 
    _fmt = "Error in processing weave: %(message)s"
 
1345
    _fmt = "Error in processing weave: %(msg)s"
1202
1346
 
1203
 
    def __init__(self, message=None):
 
1347
    def __init__(self, msg=None):
1204
1348
        BzrError.__init__(self)
1205
 
        self.message = message
 
1349
        self.msg = msg
1206
1350
 
1207
1351
 
1208
1352
class WeaveRevisionAlreadyPresent(WeaveError):
1237
1381
 
1238
1382
class WeaveParentMismatch(WeaveError):
1239
1383
 
1240
 
    _fmt = "Parents are mismatched between two revisions."
1241
 
    
 
1384
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1385
 
1242
1386
 
1243
1387
class WeaveInvalidChecksum(WeaveError):
1244
1388
 
1270
1414
 
1271
1415
 
1272
1416
class VersionedFileError(BzrError):
1273
 
    
 
1417
 
1274
1418
    _fmt = "Versioned file error"
1275
1419
 
1276
1420
 
1277
1421
class RevisionNotPresent(VersionedFileError):
1278
 
    
 
1422
 
1279
1423
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1280
1424
 
1281
1425
    def __init__(self, revision_id, file_id):
1285
1429
 
1286
1430
 
1287
1431
class RevisionAlreadyPresent(VersionedFileError):
1288
 
    
 
1432
 
1289
1433
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1290
1434
 
1291
1435
    def __init__(self, revision_id, file_id):
1299
1443
    _fmt = "Text did not match its checksum: %(message)s"
1300
1444
 
1301
1445
 
1302
 
class KnitError(BzrError):
1303
 
    
 
1446
class KnitError(InternalBzrError):
 
1447
 
1304
1448
    _fmt = "Knit error"
1305
1449
 
1306
 
    internal_error = True
1307
 
 
1308
1450
 
1309
1451
class KnitCorrupt(KnitError):
1310
1452
 
1316
1458
        self.how = how
1317
1459
 
1318
1460
 
 
1461
class SHA1KnitCorrupt(KnitCorrupt):
 
1462
 
 
1463
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1464
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1465
        "sha %(actual)s")
 
1466
 
 
1467
    def __init__(self, filename, actual, expected, key, content):
 
1468
        KnitError.__init__(self)
 
1469
        self.filename = filename
 
1470
        self.actual = actual
 
1471
        self.expected = expected
 
1472
        self.key = key
 
1473
        self.content = content
 
1474
 
 
1475
 
1319
1476
class KnitDataStreamIncompatible(KnitError):
 
1477
    # Not raised anymore, as we can convert data streams.  In future we may
 
1478
    # need it again for more exotic cases, so we're keeping it around for now.
1320
1479
 
1321
1480
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1322
1481
 
1323
1482
    def __init__(self, stream_format, target_format):
1324
1483
        self.stream_format = stream_format
1325
1484
        self.target_format = target_format
1326
 
        
 
1485
 
 
1486
 
 
1487
class KnitDataStreamUnknown(KnitError):
 
1488
    # Indicates a data stream we don't know how to handle.
 
1489
 
 
1490
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1491
 
 
1492
    def __init__(self, stream_format):
 
1493
        self.stream_format = stream_format
 
1494
 
1327
1495
 
1328
1496
class KnitHeaderError(KnitError):
1329
1497
 
1334
1502
        self.badline = badline
1335
1503
        self.filename = filename
1336
1504
 
1337
 
 
1338
1505
class KnitIndexUnknownMethod(KnitError):
1339
1506
    """Raised when we don't understand the storage method.
1340
1507
 
1341
1508
    Currently only 'fulltext' and 'line-delta' are supported.
1342
1509
    """
1343
 
    
 
1510
 
1344
1511
    _fmt = ("Knit index %(filename)s does not have a known method"
1345
1512
            " in options: %(options)r")
1346
1513
 
1350
1517
        self.options = options
1351
1518
 
1352
1519
 
 
1520
class RetryWithNewPacks(BzrError):
 
1521
    """Raised when we realize that the packs on disk have changed.
 
1522
 
 
1523
    This is meant as more of a signaling exception, to trap between where a
 
1524
    local error occurred and the code that can actually handle the error and
 
1525
    code that can retry appropriately.
 
1526
    """
 
1527
 
 
1528
    internal_error = True
 
1529
 
 
1530
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1531
            " %(orig_error)s")
 
1532
 
 
1533
    def __init__(self, context, reload_occurred, exc_info):
 
1534
        """create a new RetryWithNewPacks error.
 
1535
 
 
1536
        :param reload_occurred: Set to True if we know that the packs have
 
1537
            already been reloaded, and we are failing because of an in-memory
 
1538
            cache miss. If set to True then we will ignore if a reload says
 
1539
            nothing has changed, because we assume it has already reloaded. If
 
1540
            False, then a reload with nothing changed will force an error.
 
1541
        :param exc_info: The original exception traceback, so if there is a
 
1542
            problem we can raise the original error (value from sys.exc_info())
 
1543
        """
 
1544
        BzrError.__init__(self)
 
1545
        self.reload_occurred = reload_occurred
 
1546
        self.exc_info = exc_info
 
1547
        self.orig_error = exc_info[1]
 
1548
        # TODO: The global error handler should probably treat this by
 
1549
        #       raising/printing the original exception with a bit about
 
1550
        #       RetryWithNewPacks also not being caught
 
1551
 
 
1552
 
 
1553
class RetryAutopack(RetryWithNewPacks):
 
1554
    """Raised when we are autopacking and we find a missing file.
 
1555
 
 
1556
    Meant as a signaling exception, to tell the autopack code it should try
 
1557
    again.
 
1558
    """
 
1559
 
 
1560
    internal_error = True
 
1561
 
 
1562
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1563
            " context: %(context)s %(orig_error)s")
 
1564
 
 
1565
 
1353
1566
class NoSuchExportFormat(BzrError):
1354
 
    
 
1567
 
1355
1568
    _fmt = "Export format %(format)r not supported"
1356
1569
 
1357
1570
    def __init__(self, format):
1360
1573
 
1361
1574
 
1362
1575
class TransportError(BzrError):
1363
 
    
 
1576
 
1364
1577
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1365
1578
 
1366
1579
    def __init__(self, msg=None, orig_error=None):
1375
1588
        BzrError.__init__(self)
1376
1589
 
1377
1590
 
1378
 
class TooManyConcurrentRequests(BzrError):
 
1591
class TooManyConcurrentRequests(InternalBzrError):
1379
1592
 
1380
1593
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1381
1594
            " Be sure to finish_writing and finish_reading on the"
1382
1595
            " currently open request.")
1383
1596
 
1384
 
    internal_error = True
1385
 
 
1386
1597
    def __init__(self, medium):
1387
1598
        self.medium = medium
1388
1599
 
1395
1606
        self.details = details
1396
1607
 
1397
1608
 
 
1609
class UnexpectedProtocolVersionMarker(TransportError):
 
1610
 
 
1611
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1612
 
 
1613
    def __init__(self, marker):
 
1614
        self.marker = marker
 
1615
 
 
1616
 
 
1617
class UnknownSmartMethod(InternalBzrError):
 
1618
 
 
1619
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1620
 
 
1621
    def __init__(self, verb):
 
1622
        self.verb = verb
 
1623
 
 
1624
 
 
1625
class SmartMessageHandlerError(InternalBzrError):
 
1626
 
 
1627
    _fmt = ("The message handler raised an exception:\n"
 
1628
            "%(traceback_text)s")
 
1629
 
 
1630
    def __init__(self, exc_info):
 
1631
        import traceback
 
1632
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1633
        self.exc_info = exc_info
 
1634
        traceback_strings = traceback.format_exception(
 
1635
                self.exc_type, self.exc_value, self.exc_tb)
 
1636
        self.traceback_text = ''.join(traceback_strings)
 
1637
 
 
1638
 
1398
1639
# A set of semi-meaningful errors which can be thrown
1399
1640
class TransportNotPossible(TransportError):
1400
1641
 
1425
1666
            self.port = ':%s' % port
1426
1667
 
1427
1668
 
 
1669
# XXX: This is also used for unexpected end of file, which is different at the
 
1670
# TCP level from "connection reset".
1428
1671
class ConnectionReset(TransportError):
1429
1672
 
1430
1673
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1432
1675
 
1433
1676
class InvalidRange(TransportError):
1434
1677
 
1435
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1436
 
    
1437
 
    def __init__(self, path, offset):
1438
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1439
 
                                       % (path, offset)))
 
1678
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1679
 
 
1680
    def __init__(self, path, offset, msg=None):
 
1681
        TransportError.__init__(self, msg)
1440
1682
        self.path = path
1441
1683
        self.offset = offset
1442
1684
 
1453
1695
class InvalidHttpRange(InvalidHttpResponse):
1454
1696
 
1455
1697
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1456
 
    
 
1698
 
1457
1699
    def __init__(self, path, range, msg):
1458
1700
        self.range = range
1459
1701
        InvalidHttpResponse.__init__(self, path, msg)
1462
1704
class InvalidHttpContentType(InvalidHttpResponse):
1463
1705
 
1464
1706
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1465
 
    
 
1707
 
1466
1708
    def __init__(self, path, ctype, msg):
1467
1709
        self.ctype = ctype
1468
1710
        InvalidHttpResponse.__init__(self, path, msg)
1472
1714
 
1473
1715
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1474
1716
 
1475
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1717
    def __init__(self, source, target, is_permanent=False):
1476
1718
        self.source = source
1477
1719
        self.target = target
1478
 
        if is_permament:
 
1720
        if is_permanent:
1479
1721
            self.permanently = ' permanently'
1480
1722
        else:
1481
1723
            self.permanently = ''
1482
 
        self.is_permament = is_permament
1483
 
        self._qualified_proto = qual_proto
1484
1724
        TransportError.__init__(self)
1485
1725
 
1486
 
    def _requalify_url(self, url):
1487
 
        """Restore the qualified proto in front of the url"""
1488
 
        # When this exception is raised, source and target are in
1489
 
        # user readable format. But some transports may use a
1490
 
        # different proto (http+urllib:// will present http:// to
1491
 
        # the user. If a qualified proto is specified, the code
1492
 
        # trapping the exception can get the qualified urls to
1493
 
        # properly handle the redirection themself (creating a
1494
 
        # new transport object from the target url for example).
1495
 
        # But checking that the scheme of the original and
1496
 
        # redirected urls are the same can be tricky. (see the
1497
 
        # FIXME in BzrDir.open_from_transport for the unique use
1498
 
        # case so far).
1499
 
        if self._qualified_proto is None:
1500
 
            return url
1501
 
 
1502
 
        # The TODO related to NotBranchError mention that doing
1503
 
        # that kind of manipulation on the urls may not be the
1504
 
        # exception object job. On the other hand, this object is
1505
 
        # the interface between the code and the user so
1506
 
        # presenting the urls in different ways is indeed its
1507
 
        # job...
1508
 
        import urlparse
1509
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1510
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1511
 
                                   query, fragment))
1512
 
 
1513
 
    def get_source_url(self):
1514
 
        return self._requalify_url(self.source)
1515
 
 
1516
 
    def get_target_url(self):
1517
 
        return self._requalify_url(self.target)
1518
 
 
1519
1726
 
1520
1727
class TooManyRedirections(TransportError):
1521
1728
 
1522
1729
    _fmt = "Too many redirections"
1523
1730
 
 
1731
 
1524
1732
class ConflictsInTree(BzrError):
1525
1733
 
1526
1734
    _fmt = "Working tree has conflicts."
1532
1740
        if filename is None:
1533
1741
            filename = ""
1534
1742
        message = "Error(s) parsing config file %s:\n%s" % \
1535
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1743
            (filename, ('\n'.join(e.msg for e in errors)))
1536
1744
        BzrError.__init__(self, message)
1537
1745
 
1538
1746
 
1555
1763
 
1556
1764
class WorkingTreeNotRevision(BzrError):
1557
1765
 
1558
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1766
    _fmt = ("The working tree for %(basedir)s has changed since"
1559
1767
            " the last commit, but weave merge requires that it be"
1560
1768
            " unchanged")
1561
1769
 
1578
1786
        self.graph = graph
1579
1787
 
1580
1788
 
1581
 
class WritingCompleted(BzrError):
 
1789
class WritingCompleted(InternalBzrError):
1582
1790
 
1583
1791
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1584
1792
            "called upon it - accept bytes may not be called anymore.")
1585
1793
 
1586
 
    internal_error = True
1587
 
 
1588
1794
    def __init__(self, request):
1589
1795
        self.request = request
1590
1796
 
1591
1797
 
1592
 
class WritingNotComplete(BzrError):
 
1798
class WritingNotComplete(InternalBzrError):
1593
1799
 
1594
1800
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1595
1801
            "called upon it - until the write phase is complete no "
1596
1802
            "data may be read.")
1597
1803
 
1598
 
    internal_error = True
1599
 
 
1600
1804
    def __init__(self, request):
1601
1805
        self.request = request
1602
1806
 
1610
1814
        self.filename = filename
1611
1815
 
1612
1816
 
1613
 
class MediumNotConnected(BzrError):
 
1817
class MediumNotConnected(InternalBzrError):
1614
1818
 
1615
1819
    _fmt = """The medium '%(medium)s' is not connected."""
1616
1820
 
1617
 
    internal_error = True
1618
 
 
1619
1821
    def __init__(self, medium):
1620
1822
        self.medium = medium
1621
1823
 
1697
1899
        self.root_trans_id = transform.root
1698
1900
 
1699
1901
 
1700
 
class BzrBadParameter(BzrError):
 
1902
class BzrBadParameter(InternalBzrError):
1701
1903
 
1702
1904
    _fmt = "Bad parameter: %(param)r"
1703
1905
 
1704
 
    internal_error = True
1705
 
 
1706
1906
    # This exception should never be thrown, but it is a base class for all
1707
1907
    # parameter-to-function errors.
1708
1908
 
1726
1926
    _fmt = "Moving the root directory is not supported at this time"
1727
1927
 
1728
1928
 
 
1929
class TransformRenameFailed(BzrError):
 
1930
 
 
1931
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1932
 
 
1933
    def __init__(self, from_path, to_path, why, errno):
 
1934
        self.from_path = from_path
 
1935
        self.to_path = to_path
 
1936
        self.why = why
 
1937
        self.errno = errno
 
1938
 
 
1939
 
1729
1940
class BzrMoveFailedError(BzrError):
1730
1941
 
1731
1942
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1732
1943
 
1733
1944
    def __init__(self, from_path='', to_path='', extra=None):
 
1945
        from bzrlib.osutils import splitpath
1734
1946
        BzrError.__init__(self)
1735
1947
        if extra:
1736
1948
            self.extra = ': ' + str(extra)
1740
1952
        has_from = len(from_path) > 0
1741
1953
        has_to = len(to_path) > 0
1742
1954
        if has_from:
1743
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1955
            self.from_path = splitpath(from_path)[-1]
1744
1956
        else:
1745
1957
            self.from_path = ''
1746
1958
 
1747
1959
        if has_to:
1748
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1960
            self.to_path = splitpath(to_path)[-1]
1749
1961
        else:
1750
1962
            self.to_path = ''
1751
1963
 
1770
1982
class BzrRemoveChangedFilesError(BzrError):
1771
1983
    """Used when user is trying to remove changed files."""
1772
1984
 
1773
 
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1985
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1986
        "%(changes_as_text)s"
1774
1987
        "Use --keep to not delete them, or --force to delete them regardless.")
1775
1988
 
1776
1989
    def __init__(self, tree_delta):
1833
2046
 
1834
2047
class BadConversionTarget(BzrError):
1835
2048
 
1836
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2049
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2050
            "    %(problem)s"
1837
2051
 
1838
 
    def __init__(self, problem, format):
 
2052
    def __init__(self, problem, format, from_format=None):
1839
2053
        BzrError.__init__(self)
1840
2054
        self.problem = problem
1841
2055
        self.format = format
 
2056
        self.from_format = from_format or '(unspecified)'
 
2057
 
 
2058
 
 
2059
class NoDiffFound(BzrError):
 
2060
 
 
2061
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2062
 
 
2063
    def __init__(self, path):
 
2064
        BzrError.__init__(self, path)
 
2065
 
 
2066
 
 
2067
class ExecutableMissing(BzrError):
 
2068
 
 
2069
    _fmt = "%(exe_name)s could not be found on this machine"
 
2070
 
 
2071
    def __init__(self, exe_name):
 
2072
        BzrError.__init__(self, exe_name=exe_name)
1842
2073
 
1843
2074
 
1844
2075
class NoDiff(BzrError):
1854
2085
    _fmt = "Diff3 is not installed on this machine."
1855
2086
 
1856
2087
 
 
2088
class ExistingContent(BzrError):
 
2089
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2090
 
 
2091
    _fmt = "The content being inserted is already present."
 
2092
 
 
2093
 
1857
2094
class ExistingLimbo(BzrError):
1858
2095
 
1859
2096
    _fmt = """This tree contains left-over files from a failed operation.
1860
2097
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1861
2098
    keep, and delete it when you are done."""
1862
 
    
 
2099
 
1863
2100
    def __init__(self, limbo_dir):
1864
2101
       BzrError.__init__(self)
1865
2102
       self.limbo_dir = limbo_dir
1877
2114
 
1878
2115
class ImmortalLimbo(BzrError):
1879
2116
 
1880
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2117
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1881
2118
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1882
2119
    keep, and delete it when you are done."""
1883
2120
 
1888
2125
 
1889
2126
class ImmortalPendingDeletion(BzrError):
1890
2127
 
1891
 
    _fmt = """Unable to delete transform temporary directory
1892
 
    %(pending_deletion)s.  Please examine %(pending_deletions)s to see if it
1893
 
    contains any files you wish to keep, and delete it when you are done."""
 
2128
    _fmt = ("Unable to delete transform temporary directory "
 
2129
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2130
    "contains any files you wish to keep, and delete it when you are done.")
1894
2131
 
1895
2132
    def __init__(self, pending_deletion):
1896
2133
       BzrError.__init__(self, pending_deletion=pending_deletion)
1898
2135
 
1899
2136
class OutOfDateTree(BzrError):
1900
2137
 
1901
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2138
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1902
2139
 
1903
 
    def __init__(self, tree):
 
2140
    def __init__(self, tree, more=None):
 
2141
        if more is None:
 
2142
            more = ''
 
2143
        else:
 
2144
            more = ' ' + more
1904
2145
        BzrError.__init__(self)
1905
2146
        self.tree = tree
 
2147
        self.more = more
1906
2148
 
1907
2149
 
1908
2150
class PublicBranchOutOfDate(BzrError):
1928
2170
    _fmt = "Format error in conflict listings"
1929
2171
 
1930
2172
 
 
2173
class CorruptDirstate(BzrError):
 
2174
 
 
2175
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2176
            "Error: %(description)s")
 
2177
 
 
2178
    def __init__(self, dirstate_path, description):
 
2179
        BzrError.__init__(self)
 
2180
        self.dirstate_path = dirstate_path
 
2181
        self.description = description
 
2182
 
 
2183
 
1931
2184
class CorruptRepository(BzrError):
1932
2185
 
1933
2186
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1935
2188
 
1936
2189
    def __init__(self, repo):
1937
2190
        BzrError.__init__(self)
1938
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2191
        self.repo_path = repo.user_url
 
2192
 
 
2193
 
 
2194
class InconsistentDelta(BzrError):
 
2195
    """Used when we get a delta that is not valid."""
 
2196
 
 
2197
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2198
            " %(file_id)r\nreason: %(reason)s")
 
2199
 
 
2200
    def __init__(self, path, file_id, reason):
 
2201
        BzrError.__init__(self)
 
2202
        self.path = path
 
2203
        self.file_id = file_id
 
2204
        self.reason = reason
 
2205
 
 
2206
 
 
2207
class InconsistentDeltaDelta(InconsistentDelta):
 
2208
    """Used when we get a delta that is not valid."""
 
2209
 
 
2210
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2211
            "\nreason: %(reason)s")
 
2212
 
 
2213
    def __init__(self, delta, reason):
 
2214
        BzrError.__init__(self)
 
2215
        self.delta = delta
 
2216
        self.reason = reason
1939
2217
 
1940
2218
 
1941
2219
class UpgradeRequired(BzrError):
1947
2225
        self.path = path
1948
2226
 
1949
2227
 
 
2228
class RepositoryUpgradeRequired(UpgradeRequired):
 
2229
 
 
2230
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2231
 
 
2232
 
 
2233
class RichRootUpgradeRequired(UpgradeRequired):
 
2234
 
 
2235
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2236
           " a format which supports rich roots.")
 
2237
 
 
2238
 
1950
2239
class LocalRequiresBoundBranch(BzrError):
1951
2240
 
1952
2241
    _fmt = "Cannot perform local-only commits on unbound branches."
1953
2242
 
1954
2243
 
1955
 
class MissingProgressBarFinish(BzrError):
1956
 
 
1957
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1958
 
 
1959
 
 
1960
 
class InvalidProgressBarType(BzrError):
1961
 
 
1962
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1963
 
            " is not a supported type Select one of: %(valid_types)s")
1964
 
 
1965
 
    def __init__(self, bar_type, valid_types):
1966
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1967
 
 
1968
 
 
1969
2244
class UnsupportedOperation(BzrError):
1970
2245
 
1971
2246
    _fmt = ("The method %(mname)s is not supported on"
1988
2263
 
1989
2264
 
1990
2265
class BinaryFile(BzrError):
1991
 
    
 
2266
 
1992
2267
    _fmt = "File is binary but should be text."
1993
2268
 
1994
2269
 
2014
2289
 
2015
2290
 
2016
2291
class NotABundle(BzrError):
2017
 
    
 
2292
 
2018
2293
    _fmt = "Not a bzr revision-bundle: %(text)r"
2019
2294
 
2020
2295
    def __init__(self, text):
2022
2297
        self.text = text
2023
2298
 
2024
2299
 
2025
 
class BadBundle(BzrError): 
2026
 
    
 
2300
class BadBundle(BzrError):
 
2301
 
2027
2302
    _fmt = "Bad bzr revision-bundle: %(text)r"
2028
2303
 
2029
2304
    def __init__(self, text):
2031
2306
        self.text = text
2032
2307
 
2033
2308
 
2034
 
class MalformedHeader(BadBundle): 
2035
 
    
 
2309
class MalformedHeader(BadBundle):
 
2310
 
2036
2311
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2037
2312
 
2038
2313
 
2039
 
class MalformedPatches(BadBundle): 
2040
 
    
 
2314
class MalformedPatches(BadBundle):
 
2315
 
2041
2316
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2042
2317
 
2043
2318
 
2044
 
class MalformedFooter(BadBundle): 
2045
 
    
 
2319
class MalformedFooter(BadBundle):
 
2320
 
2046
2321
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2047
2322
 
2048
2323
 
2049
2324
class UnsupportedEOLMarker(BadBundle):
2050
 
    
2051
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2325
 
 
2326
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
2052
2327
 
2053
2328
    def __init__(self):
2054
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2329
        # XXX: BadBundle's constructor assumes there's explanatory text,
2055
2330
        # but for this there is not
2056
2331
        BzrError.__init__(self)
2057
2332
 
2058
2333
 
2059
2334
class IncompatibleBundleFormat(BzrError):
2060
 
    
 
2335
 
2061
2336
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2062
2337
 
2063
2338
    def __init__(self, bundle_format, other):
2067
2342
 
2068
2343
 
2069
2344
class BadInventoryFormat(BzrError):
2070
 
    
 
2345
 
2071
2346
    _fmt = "Root class for inventory serialization errors"
2072
2347
 
2073
2348
 
2084
2359
    _fmt = """This operation requires rich root data storage"""
2085
2360
 
2086
2361
 
2087
 
class NoSmartMedium(BzrError):
 
2362
class NoSmartMedium(InternalBzrError):
2088
2363
 
2089
2364
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2090
2365
 
2091
 
    internal_error = True
2092
 
 
2093
2366
    def __init__(self, transport):
2094
2367
        self.transport = transport
2095
2368
 
2096
2369
 
2097
 
class NoSmartServer(NotBranchError):
2098
 
 
2099
 
    _fmt = "No smart server available at %(url)s"
2100
 
 
2101
 
    def __init__(self, url):
2102
 
        self.url = url
2103
 
 
2104
 
 
2105
2370
class UnknownSSH(BzrError):
2106
2371
 
2107
2372
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2117
2382
            " Please set BZR_SSH environment variable.")
2118
2383
 
2119
2384
 
 
2385
class GhostRevisionsHaveNoRevno(BzrError):
 
2386
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2387
 
 
2388
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2389
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2390
 
 
2391
    def __init__(self, revision_id, ghost_revision_id):
 
2392
        self.revision_id = revision_id
 
2393
        self.ghost_revision_id = ghost_revision_id
 
2394
 
 
2395
 
2120
2396
class GhostRevisionUnusableHere(BzrError):
2121
2397
 
2122
2398
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2126
2402
        self.revision_id = revision_id
2127
2403
 
2128
2404
 
2129
 
class IllegalUseOfScopeReplacer(BzrError):
 
2405
class IllegalUseOfScopeReplacer(InternalBzrError):
2130
2406
 
2131
2407
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2132
2408
            " %(msg)s%(extra)s")
2133
2409
 
2134
 
    internal_error = True
2135
 
 
2136
2410
    def __init__(self, name, msg, extra=None):
2137
2411
        BzrError.__init__(self)
2138
2412
        self.name = name
2143
2417
            self.extra = ''
2144
2418
 
2145
2419
 
2146
 
class InvalidImportLine(BzrError):
 
2420
class InvalidImportLine(InternalBzrError):
2147
2421
 
2148
2422
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2149
2423
 
2150
 
    internal_error = True
2151
 
 
2152
2424
    def __init__(self, text, msg):
2153
2425
        BzrError.__init__(self)
2154
2426
        self.text = text
2155
2427
        self.msg = msg
2156
2428
 
2157
2429
 
2158
 
class ImportNameCollision(BzrError):
 
2430
class ImportNameCollision(InternalBzrError):
2159
2431
 
2160
2432
    _fmt = ("Tried to import an object to the same name as"
2161
2433
            " an existing object. %(name)s")
2162
2434
 
2163
 
    internal_error = True
2164
 
 
2165
2435
    def __init__(self, name):
2166
2436
        BzrError.__init__(self)
2167
2437
        self.name = name
2199
2469
class PatchMissing(BzrError):
2200
2470
    """Raise a patch type was specified but no patch supplied"""
2201
2471
 
2202
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2472
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
2203
2473
 
2204
2474
    def __init__(self, patch_type):
2205
2475
        BzrError.__init__(self)
2206
2476
        self.patch_type = patch_type
2207
2477
 
2208
2478
 
 
2479
class TargetNotBranch(BzrError):
 
2480
    """A merge directive's target branch is required, but isn't a branch"""
 
2481
 
 
2482
    _fmt = ("Your branch does not have all of the revisions required in "
 
2483
            "order to merge this merge directive and the target "
 
2484
            "location specified in the merge directive is not a branch: "
 
2485
            "%(location)s.")
 
2486
 
 
2487
    def __init__(self, location):
 
2488
        BzrError.__init__(self)
 
2489
        self.location = location
 
2490
 
 
2491
 
2209
2492
class UnsupportedInventoryKind(BzrError):
2210
 
    
 
2493
 
2211
2494
    _fmt = """Unsupported entry kind %(kind)s"""
2212
2495
 
2213
2496
    def __init__(self, kind):
2225
2508
 
2226
2509
 
2227
2510
class SubsumeTargetNeedsUpgrade(BzrError):
2228
 
    
 
2511
 
2229
2512
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2230
2513
 
2231
2514
    def __init__(self, other_tree):
2232
2515
        self.other_tree = other_tree
2233
2516
 
2234
2517
 
2235
 
class BadReferenceTarget(BzrError):
 
2518
class BadReferenceTarget(InternalBzrError):
2236
2519
 
2237
2520
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2238
2521
           "%(reason)s"
2239
2522
 
2240
 
    internal_error = True
2241
 
 
2242
2523
    def __init__(self, tree, other_tree, reason):
2243
2524
        self.tree = tree
2244
2525
        self.other_tree = other_tree
2256
2537
class TagsNotSupported(BzrError):
2257
2538
 
2258
2539
    _fmt = ("Tags not supported by %(branch)s;"
2259
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2540
            " you may be able to use bzr upgrade.")
2260
2541
 
2261
2542
    def __init__(self, branch):
2262
2543
        self.branch = branch
2263
2544
 
2264
 
        
 
2545
 
2265
2546
class TagAlreadyExists(BzrError):
2266
2547
 
2267
2548
    _fmt = "Tag %(tag_name)s already exists."
2272
2553
 
2273
2554
class MalformedBugIdentifier(BzrError):
2274
2555
 
2275
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2556
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2557
            'See "bzr help bugs" for more information on this feature.')
2276
2558
 
2277
2559
    def __init__(self, bug_id, reason):
2278
2560
        self.bug_id = bug_id
2279
2561
        self.reason = reason
2280
2562
 
2281
2563
 
 
2564
class InvalidBugTrackerURL(BzrError):
 
2565
 
 
2566
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2567
            "contain {id}: %(url)s")
 
2568
 
 
2569
    def __init__(self, abbreviation, url):
 
2570
        self.abbreviation = abbreviation
 
2571
        self.url = url
 
2572
 
 
2573
 
2282
2574
class UnknownBugTrackerAbbreviation(BzrError):
2283
2575
 
2284
2576
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2289
2581
        self.branch = branch
2290
2582
 
2291
2583
 
 
2584
class InvalidLineInBugsProperty(BzrError):
 
2585
 
 
2586
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2587
 
 
2588
    def __init__(self, line):
 
2589
        self.line = line
 
2590
 
 
2591
 
 
2592
class InvalidBugStatus(BzrError):
 
2593
 
 
2594
    _fmt = ("Invalid bug status: '%(status)s'")
 
2595
 
 
2596
    def __init__(self, status):
 
2597
        self.status = status
 
2598
 
 
2599
 
2292
2600
class UnexpectedSmartServerResponse(BzrError):
2293
2601
 
2294
2602
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2297
2605
        self.response_tuple = response_tuple
2298
2606
 
2299
2607
 
 
2608
class ErrorFromSmartServer(BzrError):
 
2609
    """An error was received from a smart server.
 
2610
 
 
2611
    :seealso: UnknownErrorFromSmartServer
 
2612
    """
 
2613
 
 
2614
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2615
 
 
2616
    internal_error = True
 
2617
 
 
2618
    def __init__(self, error_tuple):
 
2619
        self.error_tuple = error_tuple
 
2620
        try:
 
2621
            self.error_verb = error_tuple[0]
 
2622
        except IndexError:
 
2623
            self.error_verb = None
 
2624
        self.error_args = error_tuple[1:]
 
2625
 
 
2626
 
 
2627
class UnknownErrorFromSmartServer(BzrError):
 
2628
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2629
    error.
 
2630
 
 
2631
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2632
    distinguish between the following two cases:
 
2633
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2634
        and so should provoke a traceback to the user.
 
2635
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2636
        translated.  This is probably because the server sent us garbage, and
 
2637
        should not provoke a traceback.
 
2638
    """
 
2639
 
 
2640
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2641
 
 
2642
    internal_error = False
 
2643
 
 
2644
    def __init__(self, error_from_smart_server):
 
2645
        """Constructor.
 
2646
 
 
2647
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2648
        """
 
2649
        self.error_from_smart_server = error_from_smart_server
 
2650
        self.error_tuple = error_from_smart_server.error_tuple
 
2651
 
 
2652
 
2300
2653
class ContainerError(BzrError):
2301
2654
    """Base class of container errors."""
2302
2655
 
2304
2657
class UnknownContainerFormatError(ContainerError):
2305
2658
 
2306
2659
    _fmt = "Unrecognised container format: %(container_format)r"
2307
 
    
 
2660
 
2308
2661
    def __init__(self, container_format):
2309
2662
        self.container_format = container_format
2310
2663
 
2313
2666
 
2314
2667
    _fmt = "Unexpected end of container stream"
2315
2668
 
2316
 
    internal_error = False
2317
 
 
2318
2669
 
2319
2670
class UnknownRecordTypeError(ContainerError):
2320
2671
 
2348
2699
        self.name = name
2349
2700
 
2350
2701
 
2351
 
class NoDestinationAddress(BzrError):
 
2702
class NoDestinationAddress(InternalBzrError):
2352
2703
 
2353
2704
    _fmt = "Message does not have a destination address."
2354
2705
 
2355
 
    internal_error = True
 
2706
 
 
2707
class RepositoryDataStreamError(BzrError):
 
2708
 
 
2709
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2710
 
 
2711
    def __init__(self, reason):
 
2712
        self.reason = reason
2356
2713
 
2357
2714
 
2358
2715
class SMTPError(BzrError):
2368
2725
    _fmt = "No message supplied."
2369
2726
 
2370
2727
 
 
2728
class NoMailAddressSpecified(BzrError):
 
2729
 
 
2730
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2731
 
 
2732
 
2371
2733
class UnknownMailClient(BzrError):
2372
2734
 
2373
2735
    _fmt = "Unknown mail client: %(mail_client)s"
2398
2760
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2399
2761
 
2400
2762
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2763
 
 
2764
 
 
2765
class BzrDirError(BzrError):
 
2766
 
 
2767
    def __init__(self, bzrdir):
 
2768
        import bzrlib.urlutils as urlutils
 
2769
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2770
                                                    'ascii')
 
2771
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2772
 
 
2773
 
 
2774
class UnsyncedBranches(BzrDirError):
 
2775
 
 
2776
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2777
            " bzr help sync-for-reconfigure.")
 
2778
 
 
2779
    def __init__(self, bzrdir, target_branch):
 
2780
        BzrDirError.__init__(self, bzrdir)
 
2781
        import bzrlib.urlutils as urlutils
 
2782
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2783
                                                        'ascii')
 
2784
 
 
2785
 
 
2786
class AlreadyBranch(BzrDirError):
 
2787
 
 
2788
    _fmt = "'%(display_url)s' is already a branch."
 
2789
 
 
2790
 
 
2791
class AlreadyTree(BzrDirError):
 
2792
 
 
2793
    _fmt = "'%(display_url)s' is already a tree."
 
2794
 
 
2795
 
 
2796
class AlreadyCheckout(BzrDirError):
 
2797
 
 
2798
    _fmt = "'%(display_url)s' is already a checkout."
 
2799
 
 
2800
 
 
2801
class AlreadyLightweightCheckout(BzrDirError):
 
2802
 
 
2803
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2804
 
 
2805
 
 
2806
class AlreadyUsingShared(BzrDirError):
 
2807
 
 
2808
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2809
 
 
2810
 
 
2811
class AlreadyStandalone(BzrDirError):
 
2812
 
 
2813
    _fmt = "'%(display_url)s' is already standalone."
 
2814
 
 
2815
 
 
2816
class AlreadyWithTrees(BzrDirError):
 
2817
 
 
2818
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2819
            "working trees.")
 
2820
 
 
2821
 
 
2822
class AlreadyWithNoTrees(BzrDirError):
 
2823
 
 
2824
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2825
            "working trees.")
 
2826
 
 
2827
 
 
2828
class ReconfigurationNotSupported(BzrDirError):
 
2829
 
 
2830
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2831
 
 
2832
 
 
2833
class NoBindLocation(BzrDirError):
 
2834
 
 
2835
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2836
 
 
2837
 
 
2838
class UncommittedChanges(BzrError):
 
2839
 
 
2840
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2841
            ' (See bzr status).%(more)s')
 
2842
 
 
2843
    def __init__(self, tree, more=None):
 
2844
        if more is None:
 
2845
            more = ''
 
2846
        else:
 
2847
            more = ' ' + more
 
2848
        import bzrlib.urlutils as urlutils
 
2849
        display_url = urlutils.unescape_for_display(
 
2850
            tree.user_url, 'ascii')
 
2851
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2852
 
 
2853
 
 
2854
class ShelvedChanges(UncommittedChanges):
 
2855
 
 
2856
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2857
            ' (See bzr shelve --list).%(more)s')
 
2858
 
 
2859
 
 
2860
class MissingTemplateVariable(BzrError):
 
2861
 
 
2862
    _fmt = 'Variable {%(name)s} is not available.'
 
2863
 
 
2864
    def __init__(self, name):
 
2865
        self.name = name
 
2866
 
 
2867
 
 
2868
class NoTemplate(BzrError):
 
2869
 
 
2870
    _fmt = 'No template specified.'
 
2871
 
 
2872
 
 
2873
class UnableCreateSymlink(BzrError):
 
2874
 
 
2875
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2876
 
 
2877
    def __init__(self, path=None):
 
2878
        path_str = ''
 
2879
        if path:
 
2880
            try:
 
2881
                path_str = repr(str(path))
 
2882
            except UnicodeEncodeError:
 
2883
                path_str = repr(path)
 
2884
            path_str += ' '
 
2885
        self.path_str = path_str
 
2886
 
 
2887
 
 
2888
class UnsupportedTimezoneFormat(BzrError):
 
2889
 
 
2890
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2891
            'options are "utc", "original", "local".')
 
2892
 
 
2893
    def __init__(self, timezone):
 
2894
        self.timezone = timezone
 
2895
 
 
2896
 
 
2897
class CommandAvailableInPlugin(StandardError):
 
2898
 
 
2899
    internal_error = False
 
2900
 
 
2901
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2902
 
 
2903
        self.plugin_metadata = plugin_metadata
 
2904
        self.cmd_name = cmd_name
 
2905
        self.provider = provider
 
2906
 
 
2907
    def __str__(self):
 
2908
 
 
2909
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2910
                'However, the following official plugin provides this command: %s\n'
 
2911
                'You can install it by going to: %s'
 
2912
                % (self.cmd_name, self.plugin_metadata['name'],
 
2913
                    self.plugin_metadata['url']))
 
2914
 
 
2915
        return _fmt
 
2916
 
 
2917
 
 
2918
class NoPluginAvailable(BzrError):
 
2919
    pass
 
2920
 
 
2921
 
 
2922
class UnableEncodePath(BzrError):
 
2923
 
 
2924
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2925
            'user encoding %(user_encoding)s')
 
2926
 
 
2927
    def __init__(self, path, kind):
 
2928
        from bzrlib.osutils import get_user_encoding
 
2929
        self.path = path
 
2930
        self.kind = kind
 
2931
        self.user_encoding = osutils.get_user_encoding()
 
2932
 
 
2933
 
 
2934
class NoSuchAlias(BzrError):
 
2935
 
 
2936
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2937
 
 
2938
    def __init__(self, alias_name):
 
2939
        BzrError.__init__(self, alias_name=alias_name)
 
2940
 
 
2941
 
 
2942
class DirectoryLookupFailure(BzrError):
 
2943
    """Base type for lookup errors."""
 
2944
 
 
2945
    pass
 
2946
 
 
2947
 
 
2948
class InvalidLocationAlias(DirectoryLookupFailure):
 
2949
 
 
2950
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2951
 
 
2952
    def __init__(self, alias_name):
 
2953
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2954
 
 
2955
 
 
2956
class UnsetLocationAlias(DirectoryLookupFailure):
 
2957
 
 
2958
    _fmt = 'No %(alias_name)s location assigned.'
 
2959
 
 
2960
    def __init__(self, alias_name):
 
2961
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2962
 
 
2963
 
 
2964
class CannotBindAddress(BzrError):
 
2965
 
 
2966
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2967
 
 
2968
    def __init__(self, host, port, orig_error):
 
2969
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2970
        BzrError.__init__(self, host=host, port=port,
 
2971
            orig_error=repr(orig_error.args))
 
2972
 
 
2973
 
 
2974
class UnknownRules(BzrError):
 
2975
 
 
2976
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2977
 
 
2978
    def __init__(self, unknowns):
 
2979
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2980
 
 
2981
 
 
2982
class HookFailed(BzrError):
 
2983
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2984
    than TipChangeRejected.
 
2985
 
 
2986
    Note that this exception is no longer raised, and the import is only left
 
2987
    to be nice to code which might catch it in a plugin.
 
2988
    """
 
2989
 
 
2990
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2991
            "%(traceback_text)s%(exc_value)s")
 
2992
 
 
2993
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2994
        if warn:
 
2995
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2996
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2997
        import traceback
 
2998
        self.hook_stage = hook_stage
 
2999
        self.hook_name = hook_name
 
3000
        self.exc_info = exc_info
 
3001
        self.exc_type = exc_info[0]
 
3002
        self.exc_value = exc_info[1]
 
3003
        self.exc_tb = exc_info[2]
 
3004
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
3005
 
 
3006
 
 
3007
class TipChangeRejected(BzrError):
 
3008
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3009
    explicitly abort a change to a branch tip.
 
3010
    """
 
3011
 
 
3012
    _fmt = u"Tip change rejected: %(msg)s"
 
3013
 
 
3014
    def __init__(self, msg):
 
3015
        self.msg = msg
 
3016
 
 
3017
 
 
3018
class ShelfCorrupt(BzrError):
 
3019
 
 
3020
    _fmt = "Shelf corrupt."
 
3021
 
 
3022
 
 
3023
class NoSuchShelfId(BzrError):
 
3024
 
 
3025
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3026
 
 
3027
    def __init__(self, shelf_id):
 
3028
        BzrError.__init__(self, shelf_id=shelf_id)
 
3029
 
 
3030
 
 
3031
class InvalidShelfId(BzrError):
 
3032
 
 
3033
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3034
 
 
3035
    def __init__(self, invalid_id):
 
3036
        BzrError.__init__(self, invalid_id=invalid_id)
 
3037
 
 
3038
 
 
3039
class JailBreak(BzrError):
 
3040
 
 
3041
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3042
 
 
3043
    def __init__(self, url):
 
3044
        BzrError.__init__(self, url=url)
 
3045
 
 
3046
 
 
3047
class UserAbort(BzrError):
 
3048
 
 
3049
    _fmt = 'The user aborted the operation.'
 
3050
 
 
3051
 
 
3052
class MustHaveWorkingTree(BzrError):
 
3053
 
 
3054
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3055
 
 
3056
    def __init__(self, format, url):
 
3057
        BzrError.__init__(self, format=format, url=url)
 
3058
 
 
3059
 
 
3060
class NoSuchView(BzrError):
 
3061
    """A view does not exist.
 
3062
    """
 
3063
 
 
3064
    _fmt = u"No such view: %(view_name)s."
 
3065
 
 
3066
    def __init__(self, view_name):
 
3067
        self.view_name = view_name
 
3068
 
 
3069
 
 
3070
class ViewsNotSupported(BzrError):
 
3071
    """Views are not supported by a tree format.
 
3072
    """
 
3073
 
 
3074
    _fmt = ("Views are not supported by %(tree)s;"
 
3075
            " use 'bzr upgrade' to change your tree to a later format.")
 
3076
 
 
3077
    def __init__(self, tree):
 
3078
        self.tree = tree
 
3079
 
 
3080
 
 
3081
class FileOutsideView(BzrError):
 
3082
 
 
3083
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3084
            '%(view_str)s')
 
3085
 
 
3086
    def __init__(self, file_name, view_files):
 
3087
        self.file_name = file_name
 
3088
        self.view_str = ", ".join(view_files)
 
3089
 
 
3090
 
 
3091
class UnresumableWriteGroup(BzrError):
 
3092
 
 
3093
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3094
            "%(write_groups)r: %(reason)s")
 
3095
 
 
3096
    internal_error = True
 
3097
 
 
3098
    def __init__(self, repository, write_groups, reason):
 
3099
        self.repository = repository
 
3100
        self.write_groups = write_groups
 
3101
        self.reason = reason
 
3102
 
 
3103
 
 
3104
class UnsuspendableWriteGroup(BzrError):
 
3105
 
 
3106
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3107
 
 
3108
    internal_error = True
 
3109
 
 
3110
    def __init__(self, repository):
 
3111
        self.repository = repository
 
3112
 
 
3113
 
 
3114
class LossyPushToSameVCS(BzrError):
 
3115
 
 
3116
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3117
            "%(target_branch)r that are in the same VCS.")
 
3118
 
 
3119
    internal_error = True
 
3120
 
 
3121
    def __init__(self, source_branch, target_branch):
 
3122
        self.source_branch = source_branch
 
3123
        self.target_branch = target_branch
 
3124
 
 
3125
 
 
3126
class NoRoundtrippingSupport(BzrError):
 
3127
 
 
3128
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3129
            "%(target_branch)r.")
 
3130
 
 
3131
    internal_error = True
 
3132
 
 
3133
    def __init__(self, source_branch, target_branch):
 
3134
        self.source_branch = source_branch
 
3135
        self.target_branch = target_branch
 
3136
 
 
3137
 
 
3138
class FileTimestampUnavailable(BzrError):
 
3139
 
 
3140
    _fmt = "The filestamp for %(path)s is not available."
 
3141
 
 
3142
    internal_error = True
 
3143
 
 
3144
    def __init__(self, path):
 
3145
        self.path = path
 
3146
 
 
3147
 
 
3148
class NoColocatedBranchSupport(BzrError):
 
3149
 
 
3150
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3151
 
 
3152
    def __init__(self, bzrdir):
 
3153
        self.bzrdir = bzrdir
 
3154
 
 
3155
class NoWhoami(BzrError):
 
3156
 
 
3157
    _fmt = ('Unable to determine your name.\n'
 
3158
        "Please, set your name with the 'whoami' command.\n"
 
3159
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3160
 
 
3161
class InvalidPattern(BzrError):
 
3162
 
 
3163
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3164
 
 
3165
    def __init__(self, msg):
 
3166
        self.msg = msg
 
3167