← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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
782
950
    #
783
951
    # New code should prefer to raise specific subclasses
784
 
    def __init__(self, message):
785
 
        # Python 2.5 uses a slot for StandardError.message,
786
 
        # so use a different variable name
787
 
        # so it is exposed in self.__dict__
788
 
        self.msg = message
 
952
    def __init__(self, msg):
 
953
        self.msg = msg
789
954
 
790
955
 
791
956
class LockActive(LockError):
825
990
        self.obj = obj
826
991
 
827
992
 
828
 
class ReadOnlyLockError(LockError):
829
 
 
830
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
831
 
 
832
 
    def __init__(self, fname, msg):
 
993
class LockFailed(LockError):
 
994
 
 
995
    internal_error = False
 
996
 
 
997
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
998
 
 
999
    def __init__(self, lock, why):
833
1000
        LockError.__init__(self, '')
834
 
        self.fname = fname
835
 
        self.msg = msg
 
1001
        self.lock = lock
 
1002
        self.why = why
836
1003
 
837
1004
 
838
1005
class OutSideTransaction(BzrError):
862
1029
 
863
1030
class UnlockableTransport(LockError):
864
1031
 
 
1032
    internal_error = False
 
1033
 
865
1034
    _fmt = "Cannot lock: transport is read only: %(transport)s"
866
1035
 
867
1036
    def __init__(self, transport):
870
1039
 
871
1040
class LockContention(LockError):
872
1041
 
873
 
    _fmt = 'Could not acquire lock "%(lock)s"'
874
 
    # TODO: show full url for lock, combining the transport and relative
875
 
    # bits?
 
1042
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
876
1043
 
877
1044
    internal_error = False
878
1045
 
879
 
    def __init__(self, lock):
 
1046
    def __init__(self, lock, msg=''):
880
1047
        self.lock = lock
 
1048
        self.msg = msg
881
1049
 
882
1050
 
883
1051
class LockBroken(LockError):
904
1072
        self.target = target
905
1073
 
906
1074
 
 
1075
class LockCorrupt(LockError):
 
1076
 
 
1077
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1078
            "Use 'bzr break-lock' to clear it")
 
1079
 
 
1080
    internal_error = False
 
1081
 
 
1082
    def __init__(self, corruption_info, file_data=None):
 
1083
        self.corruption_info = corruption_info
 
1084
        self.file_data = file_data
 
1085
 
 
1086
 
907
1087
class LockNotHeld(LockError):
908
1088
 
909
1089
    _fmt = "Lock not held: %(lock)s"
918
1098
 
919
1099
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
920
1100
 
921
 
    internal_error = True
922
 
 
923
1101
    def __init__(self, obj):
924
1102
        self.obj = obj
925
1103
 
975
1153
    _fmt = "Commit refused because there are unknowns in the tree."
976
1154
 
977
1155
 
978
 
class NoSuchRevision(BzrError):
 
1156
class NoSuchRevision(InternalBzrError):
979
1157
 
980
1158
    _fmt = "%(branch)s has no revision %(revision)s"
981
1159
 
982
 
    internal_error = True
983
 
 
984
1160
    def __init__(self, branch, revision):
985
1161
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
986
1162
        BzrError.__init__(self, branch=branch, revision=revision)
987
1163
 
988
1164
 
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
1165
class RangeInChangeOption(BzrError):
1004
1166
 
1005
1167
    _fmt = "Option --change does not accept revision ranges"
1015
1177
 
1016
1178
class NoSuchRevisionInTree(NoSuchRevision):
1017
1179
    """When using Tree.revision_tree, and the revision is not accessible."""
1018
 
    
 
1180
 
1019
1181
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1020
1182
 
1021
1183
    def __init__(self, tree, revision_id):
1026
1188
 
1027
1189
class InvalidRevisionSpec(BzrError):
1028
1190
 
1029
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1030
 
            " %(branch)s%(extra)s")
 
1191
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1192
            " %(branch_url)s%(extra)s")
1031
1193
 
1032
1194
    def __init__(self, spec, branch, extra=None):
1033
1195
        BzrError.__init__(self, branch=branch, spec=spec)
 
1196
        self.branch_url = getattr(branch, 'user_url', str(branch))
1034
1197
        if extra:
1035
1198
            self.extra = '\n' + str(extra)
1036
1199
        else:
1057
1220
class DivergedBranches(BzrError):
1058
1221
 
1059
1222
    _fmt = ("These branches have diverged."
1060
 
            " Use the merge command to reconcile them.")
1061
 
 
1062
 
    internal_error = False
 
1223
            " Use the missing command to see how.\n"
 
1224
            "Use the merge command to reconcile them.")
1063
1225
 
1064
1226
    def __init__(self, branch1, branch2):
1065
1227
        self.branch1 = branch1
1066
1228
        self.branch2 = branch2
1067
1229
 
1068
1230
 
1069
 
class NotLefthandHistory(BzrError):
 
1231
class NotLefthandHistory(InternalBzrError):
1070
1232
 
1071
1233
    _fmt = "Supplied history does not follow left-hand parents"
1072
1234
 
1073
 
    internal_error = True
1074
 
 
1075
1235
    def __init__(self, history):
1076
1236
        BzrError.__init__(self, history=history)
1077
1237
 
1081
1241
    _fmt = ("Branches have no common ancestor, and"
1082
1242
            " no merge base revision was specified.")
1083
1243
 
1084
 
    internal_error = False
 
1244
 
 
1245
class CannotReverseCherrypick(BzrError):
 
1246
 
 
1247
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1248
            ' or diff3.')
1085
1249
 
1086
1250
 
1087
1251
class NoCommonAncestor(BzrError):
1088
 
    
 
1252
 
1089
1253
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1090
1254
 
1091
1255
    def __init__(self, revision_a, revision_b):
1111
1275
            not_ancestor_id=not_ancestor_id)
1112
1276
 
1113
1277
 
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
1278
class AmbiguousBase(BzrError):
1124
1279
 
1125
1280
    def __init__(self, bases):
1126
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1127
 
                DeprecationWarning)
 
1281
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1282
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1128
1283
        msg = ("The correct base is unclear, because %s are all equally close"
1129
1284
                % ", ".join(bases))
1130
1285
        BzrError.__init__(self, msg)
1131
1286
        self.bases = bases
1132
1287
 
1133
1288
 
1134
 
class NoCommits(BzrError):
 
1289
class NoCommits(BranchError):
1135
1290
 
1136
1291
    _fmt = "Branch %(branch)s has no commits."
1137
1292
 
1138
 
    def __init__(self, branch):
1139
 
        BzrError.__init__(self, branch=branch)
1140
 
 
1141
1293
 
1142
1294
class UnlistableStore(BzrError):
1143
1295
 
1155
1307
class BoundBranchOutOfDate(BzrError):
1156
1308
 
1157
1309
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1158
 
            " %(master)s.")
 
1310
            " %(master)s.%(extra_help)s")
1159
1311
 
1160
1312
    def __init__(self, branch, master):
1161
1313
        BzrError.__init__(self)
1162
1314
        self.branch = branch
1163
1315
        self.master = master
1164
 
 
1165
 
        
 
1316
        self.extra_help = ''
 
1317
 
 
1318
 
1166
1319
class CommitToDoubleBoundBranch(BzrError):
1167
1320
 
1168
1321
    _fmt = ("Cannot commit to branch %(branch)s."
1198
1351
 
1199
1352
class WeaveError(BzrError):
1200
1353
 
1201
 
    _fmt = "Error in processing weave: %(message)s"
 
1354
    _fmt = "Error in processing weave: %(msg)s"
1202
1355
 
1203
 
    def __init__(self, message=None):
 
1356
    def __init__(self, msg=None):
1204
1357
        BzrError.__init__(self)
1205
 
        self.message = message
 
1358
        self.msg = msg
1206
1359
 
1207
1360
 
1208
1361
class WeaveRevisionAlreadyPresent(WeaveError):
1237
1390
 
1238
1391
class WeaveParentMismatch(WeaveError):
1239
1392
 
1240
 
    _fmt = "Parents are mismatched between two revisions."
1241
 
    
 
1393
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1394
 
1242
1395
 
1243
1396
class WeaveInvalidChecksum(WeaveError):
1244
1397
 
1245
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1398
    _fmt = "Text did not match its checksum: %(msg)s"
1246
1399
 
1247
1400
 
1248
1401
class WeaveTextDiffers(WeaveError):
1270
1423
 
1271
1424
 
1272
1425
class VersionedFileError(BzrError):
1273
 
    
 
1426
 
1274
1427
    _fmt = "Versioned file error"
1275
1428
 
1276
1429
 
1277
1430
class RevisionNotPresent(VersionedFileError):
1278
 
    
 
1431
 
1279
1432
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1280
1433
 
1281
1434
    def __init__(self, revision_id, file_id):
1285
1438
 
1286
1439
 
1287
1440
class RevisionAlreadyPresent(VersionedFileError):
1288
 
    
 
1441
 
1289
1442
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1290
1443
 
1291
1444
    def __init__(self, revision_id, file_id):
1296
1449
 
1297
1450
class VersionedFileInvalidChecksum(VersionedFileError):
1298
1451
 
1299
 
    _fmt = "Text did not match its checksum: %(message)s"
1300
 
 
1301
 
 
1302
 
class KnitError(BzrError):
1303
 
    
 
1452
    _fmt = "Text did not match its checksum: %(msg)s"
 
1453
 
 
1454
 
 
1455
class KnitError(InternalBzrError):
 
1456
 
1304
1457
    _fmt = "Knit error"
1305
1458
 
1306
 
    internal_error = True
1307
 
 
1308
1459
 
1309
1460
class KnitCorrupt(KnitError):
1310
1461
 
1316
1467
        self.how = how
1317
1468
 
1318
1469
 
 
1470
class SHA1KnitCorrupt(KnitCorrupt):
 
1471
 
 
1472
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1473
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1474
        "sha %(actual)s")
 
1475
 
 
1476
    def __init__(self, filename, actual, expected, key, content):
 
1477
        KnitError.__init__(self)
 
1478
        self.filename = filename
 
1479
        self.actual = actual
 
1480
        self.expected = expected
 
1481
        self.key = key
 
1482
        self.content = content
 
1483
 
 
1484
 
1319
1485
class KnitDataStreamIncompatible(KnitError):
 
1486
    # Not raised anymore, as we can convert data streams.  In future we may
 
1487
    # need it again for more exotic cases, so we're keeping it around for now.
1320
1488
 
1321
1489
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1322
1490
 
1323
1491
    def __init__(self, stream_format, target_format):
1324
1492
        self.stream_format = stream_format
1325
1493
        self.target_format = target_format
1326
 
        
 
1494
 
 
1495
 
 
1496
class KnitDataStreamUnknown(KnitError):
 
1497
    # Indicates a data stream we don't know how to handle.
 
1498
 
 
1499
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1500
 
 
1501
    def __init__(self, stream_format):
 
1502
        self.stream_format = stream_format
 
1503
 
1327
1504
 
1328
1505
class KnitHeaderError(KnitError):
1329
1506
 
1334
1511
        self.badline = badline
1335
1512
        self.filename = filename
1336
1513
 
1337
 
 
1338
1514
class KnitIndexUnknownMethod(KnitError):
1339
1515
    """Raised when we don't understand the storage method.
1340
1516
 
1341
1517
    Currently only 'fulltext' and 'line-delta' are supported.
1342
1518
    """
1343
 
    
 
1519
 
1344
1520
    _fmt = ("Knit index %(filename)s does not have a known method"
1345
1521
            " in options: %(options)r")
1346
1522
 
1350
1526
        self.options = options
1351
1527
 
1352
1528
 
 
1529
class RetryWithNewPacks(BzrError):
 
1530
    """Raised when we realize that the packs on disk have changed.
 
1531
 
 
1532
    This is meant as more of a signaling exception, to trap between where a
 
1533
    local error occurred and the code that can actually handle the error and
 
1534
    code that can retry appropriately.
 
1535
    """
 
1536
 
 
1537
    internal_error = True
 
1538
 
 
1539
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1540
            " %(orig_error)s")
 
1541
 
 
1542
    def __init__(self, context, reload_occurred, exc_info):
 
1543
        """create a new RetryWithNewPacks error.
 
1544
 
 
1545
        :param reload_occurred: Set to True if we know that the packs have
 
1546
            already been reloaded, and we are failing because of an in-memory
 
1547
            cache miss. If set to True then we will ignore if a reload says
 
1548
            nothing has changed, because we assume it has already reloaded. If
 
1549
            False, then a reload with nothing changed will force an error.
 
1550
        :param exc_info: The original exception traceback, so if there is a
 
1551
            problem we can raise the original error (value from sys.exc_info())
 
1552
        """
 
1553
        BzrError.__init__(self)
 
1554
        self.reload_occurred = reload_occurred
 
1555
        self.exc_info = exc_info
 
1556
        self.orig_error = exc_info[1]
 
1557
        # TODO: The global error handler should probably treat this by
 
1558
        #       raising/printing the original exception with a bit about
 
1559
        #       RetryWithNewPacks also not being caught
 
1560
 
 
1561
 
 
1562
class RetryAutopack(RetryWithNewPacks):
 
1563
    """Raised when we are autopacking and we find a missing file.
 
1564
 
 
1565
    Meant as a signaling exception, to tell the autopack code it should try
 
1566
    again.
 
1567
    """
 
1568
 
 
1569
    internal_error = True
 
1570
 
 
1571
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1572
            " context: %(context)s %(orig_error)s")
 
1573
 
 
1574
 
1353
1575
class NoSuchExportFormat(BzrError):
1354
 
    
 
1576
 
1355
1577
    _fmt = "Export format %(format)r not supported"
1356
1578
 
1357
1579
    def __init__(self, format):
1360
1582
 
1361
1583
 
1362
1584
class TransportError(BzrError):
1363
 
    
 
1585
 
1364
1586
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1365
1587
 
1366
1588
    def __init__(self, msg=None, orig_error=None):
1375
1597
        BzrError.__init__(self)
1376
1598
 
1377
1599
 
1378
 
class TooManyConcurrentRequests(BzrError):
 
1600
class TooManyConcurrentRequests(InternalBzrError):
1379
1601
 
1380
1602
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1381
1603
            " Be sure to finish_writing and finish_reading on the"
1382
1604
            " currently open request.")
1383
1605
 
1384
 
    internal_error = True
1385
 
 
1386
1606
    def __init__(self, medium):
1387
1607
        self.medium = medium
1388
1608
 
1395
1615
        self.details = details
1396
1616
 
1397
1617
 
 
1618
class UnexpectedProtocolVersionMarker(TransportError):
 
1619
 
 
1620
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1621
 
 
1622
    def __init__(self, marker):
 
1623
        self.marker = marker
 
1624
 
 
1625
 
 
1626
class UnknownSmartMethod(InternalBzrError):
 
1627
 
 
1628
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1629
 
 
1630
    def __init__(self, verb):
 
1631
        self.verb = verb
 
1632
 
 
1633
 
 
1634
class SmartMessageHandlerError(InternalBzrError):
 
1635
 
 
1636
    _fmt = ("The message handler raised an exception:\n"
 
1637
            "%(traceback_text)s")
 
1638
 
 
1639
    def __init__(self, exc_info):
 
1640
        import traceback
 
1641
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1642
        self.exc_info = exc_info
 
1643
        traceback_strings = traceback.format_exception(
 
1644
                self.exc_type, self.exc_value, self.exc_tb)
 
1645
        self.traceback_text = ''.join(traceback_strings)
 
1646
 
 
1647
 
1398
1648
# A set of semi-meaningful errors which can be thrown
1399
1649
class TransportNotPossible(TransportError):
1400
1650
 
1425
1675
            self.port = ':%s' % port
1426
1676
 
1427
1677
 
 
1678
# XXX: This is also used for unexpected end of file, which is different at the
 
1679
# TCP level from "connection reset".
1428
1680
class ConnectionReset(TransportError):
1429
1681
 
1430
1682
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1432
1684
 
1433
1685
class InvalidRange(TransportError):
1434
1686
 
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)))
 
1687
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1688
 
 
1689
    def __init__(self, path, offset, msg=None):
 
1690
        TransportError.__init__(self, msg)
1440
1691
        self.path = path
1441
1692
        self.offset = offset
1442
1693
 
1453
1704
class InvalidHttpRange(InvalidHttpResponse):
1454
1705
 
1455
1706
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1456
 
    
 
1707
 
1457
1708
    def __init__(self, path, range, msg):
1458
1709
        self.range = range
1459
1710
        InvalidHttpResponse.__init__(self, path, msg)
1462
1713
class InvalidHttpContentType(InvalidHttpResponse):
1463
1714
 
1464
1715
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1465
 
    
 
1716
 
1466
1717
    def __init__(self, path, ctype, msg):
1467
1718
        self.ctype = ctype
1468
1719
        InvalidHttpResponse.__init__(self, path, msg)
1472
1723
 
1473
1724
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1474
1725
 
1475
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1726
    def __init__(self, source, target, is_permanent=False):
1476
1727
        self.source = source
1477
1728
        self.target = target
1478
 
        if is_permament:
 
1729
        if is_permanent:
1479
1730
            self.permanently = ' permanently'
1480
1731
        else:
1481
1732
            self.permanently = ''
1482
 
        self.is_permament = is_permament
1483
 
        self._qualified_proto = qual_proto
1484
1733
        TransportError.__init__(self)
1485
1734
 
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
1735
 
1520
1736
class TooManyRedirections(TransportError):
1521
1737
 
1522
1738
    _fmt = "Too many redirections"
1523
1739
 
 
1740
 
1524
1741
class ConflictsInTree(BzrError):
1525
1742
 
1526
1743
    _fmt = "Working tree has conflicts."
1532
1749
        if filename is None:
1533
1750
            filename = ""
1534
1751
        message = "Error(s) parsing config file %s:\n%s" % \
1535
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1752
            (filename, ('\n'.join(e.msg for e in errors)))
1536
1753
        BzrError.__init__(self, message)
1537
1754
 
1538
1755
 
1555
1772
 
1556
1773
class WorkingTreeNotRevision(BzrError):
1557
1774
 
1558
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1775
    _fmt = ("The working tree for %(basedir)s has changed since"
1559
1776
            " the last commit, but weave merge requires that it be"
1560
1777
            " unchanged")
1561
1778
 
1578
1795
        self.graph = graph
1579
1796
 
1580
1797
 
1581
 
class WritingCompleted(BzrError):
 
1798
class WritingCompleted(InternalBzrError):
1582
1799
 
1583
1800
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1584
1801
            "called upon it - accept bytes may not be called anymore.")
1585
1802
 
1586
 
    internal_error = True
1587
 
 
1588
1803
    def __init__(self, request):
1589
1804
        self.request = request
1590
1805
 
1591
1806
 
1592
 
class WritingNotComplete(BzrError):
 
1807
class WritingNotComplete(InternalBzrError):
1593
1808
 
1594
1809
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1595
1810
            "called upon it - until the write phase is complete no "
1596
1811
            "data may be read.")
1597
1812
 
1598
 
    internal_error = True
1599
 
 
1600
1813
    def __init__(self, request):
1601
1814
        self.request = request
1602
1815
 
1610
1823
        self.filename = filename
1611
1824
 
1612
1825
 
1613
 
class MediumNotConnected(BzrError):
 
1826
class MediumNotConnected(InternalBzrError):
1614
1827
 
1615
1828
    _fmt = """The medium '%(medium)s' is not connected."""
1616
1829
 
1617
 
    internal_error = True
1618
 
 
1619
1830
    def __init__(self, medium):
1620
1831
        self.medium = medium
1621
1832
 
1697
1908
        self.root_trans_id = transform.root
1698
1909
 
1699
1910
 
1700
 
class BzrBadParameter(BzrError):
 
1911
class BzrBadParameter(InternalBzrError):
1701
1912
 
1702
1913
    _fmt = "Bad parameter: %(param)r"
1703
1914
 
1704
 
    internal_error = True
1705
 
 
1706
1915
    # This exception should never be thrown, but it is a base class for all
1707
1916
    # parameter-to-function errors.
1708
1917
 
1726
1935
    _fmt = "Moving the root directory is not supported at this time"
1727
1936
 
1728
1937
 
 
1938
class TransformRenameFailed(BzrError):
 
1939
 
 
1940
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1941
 
 
1942
    def __init__(self, from_path, to_path, why, errno):
 
1943
        self.from_path = from_path
 
1944
        self.to_path = to_path
 
1945
        self.why = why
 
1946
        self.errno = errno
 
1947
 
 
1948
 
1729
1949
class BzrMoveFailedError(BzrError):
1730
1950
 
1731
1951
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1732
1952
 
1733
1953
    def __init__(self, from_path='', to_path='', extra=None):
 
1954
        from bzrlib.osutils import splitpath
1734
1955
        BzrError.__init__(self)
1735
1956
        if extra:
1736
1957
            self.extra = ': ' + str(extra)
1740
1961
        has_from = len(from_path) > 0
1741
1962
        has_to = len(to_path) > 0
1742
1963
        if has_from:
1743
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1964
            self.from_path = splitpath(from_path)[-1]
1744
1965
        else:
1745
1966
            self.from_path = ''
1746
1967
 
1747
1968
        if has_to:
1748
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1969
            self.to_path = splitpath(to_path)[-1]
1749
1970
        else:
1750
1971
            self.to_path = ''
1751
1972
 
1770
1991
class BzrRemoveChangedFilesError(BzrError):
1771
1992
    """Used when user is trying to remove changed files."""
1772
1993
 
1773
 
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1994
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1995
        "%(changes_as_text)s"
1774
1996
        "Use --keep to not delete them, or --force to delete them regardless.")
1775
1997
 
1776
1998
    def __init__(self, tree_delta):
 
1999
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
 
2000
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
1777
2001
        BzrError.__init__(self)
1778
2002
        self.changes_as_text = tree_delta.get_changes_as_text()
1779
2003
        #self.paths_as_string = '\n'.join(changed_files)
1833
2057
 
1834
2058
class BadConversionTarget(BzrError):
1835
2059
 
1836
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2060
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2061
            "    %(problem)s"
1837
2062
 
1838
 
    def __init__(self, problem, format):
 
2063
    def __init__(self, problem, format, from_format=None):
1839
2064
        BzrError.__init__(self)
1840
2065
        self.problem = problem
1841
2066
        self.format = format
 
2067
        self.from_format = from_format or '(unspecified)'
 
2068
 
 
2069
 
 
2070
class NoDiffFound(BzrError):
 
2071
 
 
2072
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2073
 
 
2074
    def __init__(self, path):
 
2075
        BzrError.__init__(self, path)
 
2076
 
 
2077
 
 
2078
class ExecutableMissing(BzrError):
 
2079
 
 
2080
    _fmt = "%(exe_name)s could not be found on this machine"
 
2081
 
 
2082
    def __init__(self, exe_name):
 
2083
        BzrError.__init__(self, exe_name=exe_name)
1842
2084
 
1843
2085
 
1844
2086
class NoDiff(BzrError):
1854
2096
    _fmt = "Diff3 is not installed on this machine."
1855
2097
 
1856
2098
 
 
2099
class ExistingContent(BzrError):
 
2100
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2101
 
 
2102
    _fmt = "The content being inserted is already present."
 
2103
 
 
2104
 
1857
2105
class ExistingLimbo(BzrError):
1858
2106
 
1859
2107
    _fmt = """This tree contains left-over files from a failed operation.
1860
2108
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1861
2109
    keep, and delete it when you are done."""
1862
 
    
 
2110
 
1863
2111
    def __init__(self, limbo_dir):
1864
2112
       BzrError.__init__(self)
1865
2113
       self.limbo_dir = limbo_dir
1877
2125
 
1878
2126
class ImmortalLimbo(BzrError):
1879
2127
 
1880
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2128
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1881
2129
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1882
2130
    keep, and delete it when you are done."""
1883
2131
 
1888
2136
 
1889
2137
class ImmortalPendingDeletion(BzrError):
1890
2138
 
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."""
 
2139
    _fmt = ("Unable to delete transform temporary directory "
 
2140
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2141
    "contains any files you wish to keep, and delete it when you are done.")
1894
2142
 
1895
2143
    def __init__(self, pending_deletion):
1896
2144
       BzrError.__init__(self, pending_deletion=pending_deletion)
1898
2146
 
1899
2147
class OutOfDateTree(BzrError):
1900
2148
 
1901
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2149
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1902
2150
 
1903
 
    def __init__(self, tree):
 
2151
    def __init__(self, tree, more=None):
 
2152
        if more is None:
 
2153
            more = ''
 
2154
        else:
 
2155
            more = ' ' + more
1904
2156
        BzrError.__init__(self)
1905
2157
        self.tree = tree
 
2158
        self.more = more
1906
2159
 
1907
2160
 
1908
2161
class PublicBranchOutOfDate(BzrError):
1928
2181
    _fmt = "Format error in conflict listings"
1929
2182
 
1930
2183
 
 
2184
class CorruptDirstate(BzrError):
 
2185
 
 
2186
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2187
            "Error: %(description)s")
 
2188
 
 
2189
    def __init__(self, dirstate_path, description):
 
2190
        BzrError.__init__(self)
 
2191
        self.dirstate_path = dirstate_path
 
2192
        self.description = description
 
2193
 
 
2194
 
1931
2195
class CorruptRepository(BzrError):
1932
2196
 
1933
2197
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1935
2199
 
1936
2200
    def __init__(self, repo):
1937
2201
        BzrError.__init__(self)
1938
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2202
        self.repo_path = repo.user_url
 
2203
 
 
2204
 
 
2205
class InconsistentDelta(BzrError):
 
2206
    """Used when we get a delta that is not valid."""
 
2207
 
 
2208
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2209
            " %(file_id)r\nreason: %(reason)s")
 
2210
 
 
2211
    def __init__(self, path, file_id, reason):
 
2212
        BzrError.__init__(self)
 
2213
        self.path = path
 
2214
        self.file_id = file_id
 
2215
        self.reason = reason
 
2216
 
 
2217
 
 
2218
class InconsistentDeltaDelta(InconsistentDelta):
 
2219
    """Used when we get a delta that is not valid."""
 
2220
 
 
2221
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2222
            "\nreason: %(reason)s")
 
2223
 
 
2224
    def __init__(self, delta, reason):
 
2225
        BzrError.__init__(self)
 
2226
        self.delta = delta
 
2227
        self.reason = reason
1939
2228
 
1940
2229
 
1941
2230
class UpgradeRequired(BzrError):
1947
2236
        self.path = path
1948
2237
 
1949
2238
 
 
2239
class RepositoryUpgradeRequired(UpgradeRequired):
 
2240
 
 
2241
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2242
 
 
2243
 
 
2244
class RichRootUpgradeRequired(UpgradeRequired):
 
2245
 
 
2246
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2247
           " a format which supports rich roots.")
 
2248
 
 
2249
 
1950
2250
class LocalRequiresBoundBranch(BzrError):
1951
2251
 
1952
2252
    _fmt = "Cannot perform local-only commits on unbound branches."
1953
2253
 
1954
2254
 
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
2255
class UnsupportedOperation(BzrError):
1970
2256
 
1971
2257
    _fmt = ("The method %(mname)s is not supported on"
1988
2274
 
1989
2275
 
1990
2276
class BinaryFile(BzrError):
1991
 
    
 
2277
 
1992
2278
    _fmt = "File is binary but should be text."
1993
2279
 
1994
2280
 
2014
2300
 
2015
2301
 
2016
2302
class NotABundle(BzrError):
2017
 
    
 
2303
 
2018
2304
    _fmt = "Not a bzr revision-bundle: %(text)r"
2019
2305
 
2020
2306
    def __init__(self, text):
2022
2308
        self.text = text
2023
2309
 
2024
2310
 
2025
 
class BadBundle(BzrError): 
2026
 
    
 
2311
class BadBundle(BzrError):
 
2312
 
2027
2313
    _fmt = "Bad bzr revision-bundle: %(text)r"
2028
2314
 
2029
2315
    def __init__(self, text):
2031
2317
        self.text = text
2032
2318
 
2033
2319
 
2034
 
class MalformedHeader(BadBundle): 
2035
 
    
 
2320
class MalformedHeader(BadBundle):
 
2321
 
2036
2322
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2037
2323
 
2038
2324
 
2039
 
class MalformedPatches(BadBundle): 
2040
 
    
 
2325
class MalformedPatches(BadBundle):
 
2326
 
2041
2327
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2042
2328
 
2043
2329
 
2044
 
class MalformedFooter(BadBundle): 
2045
 
    
 
2330
class MalformedFooter(BadBundle):
 
2331
 
2046
2332
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2047
2333
 
2048
2334
 
2049
2335
class UnsupportedEOLMarker(BadBundle):
2050
 
    
2051
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2336
 
 
2337
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
2052
2338
 
2053
2339
    def __init__(self):
2054
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2340
        # XXX: BadBundle's constructor assumes there's explanatory text,
2055
2341
        # but for this there is not
2056
2342
        BzrError.__init__(self)
2057
2343
 
2058
2344
 
2059
2345
class IncompatibleBundleFormat(BzrError):
2060
 
    
 
2346
 
2061
2347
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2062
2348
 
2063
2349
    def __init__(self, bundle_format, other):
2067
2353
 
2068
2354
 
2069
2355
class BadInventoryFormat(BzrError):
2070
 
    
 
2356
 
2071
2357
    _fmt = "Root class for inventory serialization errors"
2072
2358
 
2073
2359
 
2084
2370
    _fmt = """This operation requires rich root data storage"""
2085
2371
 
2086
2372
 
2087
 
class NoSmartMedium(BzrError):
 
2373
class NoSmartMedium(InternalBzrError):
2088
2374
 
2089
2375
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2090
2376
 
2091
 
    internal_error = True
2092
 
 
2093
2377
    def __init__(self, transport):
2094
2378
        self.transport = transport
2095
2379
 
2096
2380
 
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
2381
class UnknownSSH(BzrError):
2106
2382
 
2107
2383
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2117
2393
            " Please set BZR_SSH environment variable.")
2118
2394
 
2119
2395
 
 
2396
class GhostRevisionsHaveNoRevno(BzrError):
 
2397
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2398
 
 
2399
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2400
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2401
 
 
2402
    def __init__(self, revision_id, ghost_revision_id):
 
2403
        self.revision_id = revision_id
 
2404
        self.ghost_revision_id = ghost_revision_id
 
2405
 
 
2406
 
2120
2407
class GhostRevisionUnusableHere(BzrError):
2121
2408
 
2122
2409
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2126
2413
        self.revision_id = revision_id
2127
2414
 
2128
2415
 
2129
 
class IllegalUseOfScopeReplacer(BzrError):
 
2416
class IllegalUseOfScopeReplacer(InternalBzrError):
2130
2417
 
2131
2418
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2132
2419
            " %(msg)s%(extra)s")
2133
2420
 
2134
 
    internal_error = True
2135
 
 
2136
2421
    def __init__(self, name, msg, extra=None):
2137
2422
        BzrError.__init__(self)
2138
2423
        self.name = name
2143
2428
            self.extra = ''
2144
2429
 
2145
2430
 
2146
 
class InvalidImportLine(BzrError):
 
2431
class InvalidImportLine(InternalBzrError):
2147
2432
 
2148
2433
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2149
2434
 
2150
 
    internal_error = True
2151
 
 
2152
2435
    def __init__(self, text, msg):
2153
2436
        BzrError.__init__(self)
2154
2437
        self.text = text
2155
2438
        self.msg = msg
2156
2439
 
2157
2440
 
2158
 
class ImportNameCollision(BzrError):
 
2441
class ImportNameCollision(InternalBzrError):
2159
2442
 
2160
2443
    _fmt = ("Tried to import an object to the same name as"
2161
2444
            " an existing object. %(name)s")
2162
2445
 
2163
 
    internal_error = True
2164
 
 
2165
2446
    def __init__(self, name):
2166
2447
        BzrError.__init__(self)
2167
2448
        self.name = name
2199
2480
class PatchMissing(BzrError):
2200
2481
    """Raise a patch type was specified but no patch supplied"""
2201
2482
 
2202
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2483
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
2203
2484
 
2204
2485
    def __init__(self, patch_type):
2205
2486
        BzrError.__init__(self)
2206
2487
        self.patch_type = patch_type
2207
2488
 
2208
2489
 
 
2490
class TargetNotBranch(BzrError):
 
2491
    """A merge directive's target branch is required, but isn't a branch"""
 
2492
 
 
2493
    _fmt = ("Your branch does not have all of the revisions required in "
 
2494
            "order to merge this merge directive and the target "
 
2495
            "location specified in the merge directive is not a branch: "
 
2496
            "%(location)s.")
 
2497
 
 
2498
    def __init__(self, location):
 
2499
        BzrError.__init__(self)
 
2500
        self.location = location
 
2501
 
 
2502
 
2209
2503
class UnsupportedInventoryKind(BzrError):
2210
 
    
 
2504
 
2211
2505
    _fmt = """Unsupported entry kind %(kind)s"""
2212
2506
 
2213
2507
    def __init__(self, kind):
2225
2519
 
2226
2520
 
2227
2521
class SubsumeTargetNeedsUpgrade(BzrError):
2228
 
    
 
2522
 
2229
2523
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2230
2524
 
2231
2525
    def __init__(self, other_tree):
2232
2526
        self.other_tree = other_tree
2233
2527
 
2234
2528
 
2235
 
class BadReferenceTarget(BzrError):
 
2529
class BadReferenceTarget(InternalBzrError):
2236
2530
 
2237
2531
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2238
2532
           "%(reason)s"
2239
2533
 
2240
 
    internal_error = True
2241
 
 
2242
2534
    def __init__(self, tree, other_tree, reason):
2243
2535
        self.tree = tree
2244
2536
        self.other_tree = other_tree
2256
2548
class TagsNotSupported(BzrError):
2257
2549
 
2258
2550
    _fmt = ("Tags not supported by %(branch)s;"
2259
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2551
            " you may be able to use bzr upgrade.")
2260
2552
 
2261
2553
    def __init__(self, branch):
2262
2554
        self.branch = branch
2263
2555
 
2264
 
        
 
2556
 
2265
2557
class TagAlreadyExists(BzrError):
2266
2558
 
2267
2559
    _fmt = "Tag %(tag_name)s already exists."
2272
2564
 
2273
2565
class MalformedBugIdentifier(BzrError):
2274
2566
 
2275
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2567
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2568
            'See "bzr help bugs" for more information on this feature.')
2276
2569
 
2277
2570
    def __init__(self, bug_id, reason):
2278
2571
        self.bug_id = bug_id
2279
2572
        self.reason = reason
2280
2573
 
2281
2574
 
 
2575
class InvalidBugTrackerURL(BzrError):
 
2576
 
 
2577
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2578
            "contain {id}: %(url)s")
 
2579
 
 
2580
    def __init__(self, abbreviation, url):
 
2581
        self.abbreviation = abbreviation
 
2582
        self.url = url
 
2583
 
 
2584
 
2282
2585
class UnknownBugTrackerAbbreviation(BzrError):
2283
2586
 
2284
2587
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2289
2592
        self.branch = branch
2290
2593
 
2291
2594
 
 
2595
class InvalidLineInBugsProperty(BzrError):
 
2596
 
 
2597
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2598
 
 
2599
    def __init__(self, line):
 
2600
        self.line = line
 
2601
 
 
2602
 
 
2603
class InvalidBugStatus(BzrError):
 
2604
 
 
2605
    _fmt = ("Invalid bug status: '%(status)s'")
 
2606
 
 
2607
    def __init__(self, status):
 
2608
        self.status = status
 
2609
 
 
2610
 
2292
2611
class UnexpectedSmartServerResponse(BzrError):
2293
2612
 
2294
2613
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2297
2616
        self.response_tuple = response_tuple
2298
2617
 
2299
2618
 
 
2619
class ErrorFromSmartServer(BzrError):
 
2620
    """An error was received from a smart server.
 
2621
 
 
2622
    :seealso: UnknownErrorFromSmartServer
 
2623
    """
 
2624
 
 
2625
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2626
 
 
2627
    internal_error = True
 
2628
 
 
2629
    def __init__(self, error_tuple):
 
2630
        self.error_tuple = error_tuple
 
2631
        try:
 
2632
            self.error_verb = error_tuple[0]
 
2633
        except IndexError:
 
2634
            self.error_verb = None
 
2635
        self.error_args = error_tuple[1:]
 
2636
 
 
2637
 
 
2638
class UnknownErrorFromSmartServer(BzrError):
 
2639
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2640
    error.
 
2641
 
 
2642
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2643
    distinguish between the following two cases:
 
2644
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2645
        and so should provoke a traceback to the user.
 
2646
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2647
        translated.  This is probably because the server sent us garbage, and
 
2648
        should not provoke a traceback.
 
2649
    """
 
2650
 
 
2651
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2652
 
 
2653
    internal_error = False
 
2654
 
 
2655
    def __init__(self, error_from_smart_server):
 
2656
        """Constructor.
 
2657
 
 
2658
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2659
        """
 
2660
        self.error_from_smart_server = error_from_smart_server
 
2661
        self.error_tuple = error_from_smart_server.error_tuple
 
2662
 
 
2663
 
2300
2664
class ContainerError(BzrError):
2301
2665
    """Base class of container errors."""
2302
2666
 
2304
2668
class UnknownContainerFormatError(ContainerError):
2305
2669
 
2306
2670
    _fmt = "Unrecognised container format: %(container_format)r"
2307
 
    
 
2671
 
2308
2672
    def __init__(self, container_format):
2309
2673
        self.container_format = container_format
2310
2674
 
2313
2677
 
2314
2678
    _fmt = "Unexpected end of container stream"
2315
2679
 
2316
 
    internal_error = False
2317
 
 
2318
2680
 
2319
2681
class UnknownRecordTypeError(ContainerError):
2320
2682
 
2348
2710
        self.name = name
2349
2711
 
2350
2712
 
2351
 
class NoDestinationAddress(BzrError):
 
2713
class NoDestinationAddress(InternalBzrError):
2352
2714
 
2353
2715
    _fmt = "Message does not have a destination address."
2354
2716
 
2355
 
    internal_error = True
 
2717
 
 
2718
class RepositoryDataStreamError(BzrError):
 
2719
 
 
2720
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2721
 
 
2722
    def __init__(self, reason):
 
2723
        self.reason = reason
2356
2724
 
2357
2725
 
2358
2726
class SMTPError(BzrError):
2368
2736
    _fmt = "No message supplied."
2369
2737
 
2370
2738
 
 
2739
class NoMailAddressSpecified(BzrError):
 
2740
 
 
2741
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2742
 
 
2743
 
2371
2744
class UnknownMailClient(BzrError):
2372
2745
 
2373
2746
    _fmt = "Unknown mail client: %(mail_client)s"
2398
2771
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2399
2772
 
2400
2773
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2774
 
 
2775
 
 
2776
class BzrDirError(BzrError):
 
2777
 
 
2778
    def __init__(self, bzrdir):
 
2779
        import bzrlib.urlutils as urlutils
 
2780
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2781
                                                    'ascii')
 
2782
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2783
 
 
2784
 
 
2785
class UnsyncedBranches(BzrDirError):
 
2786
 
 
2787
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2788
            " bzr help sync-for-reconfigure.")
 
2789
 
 
2790
    def __init__(self, bzrdir, target_branch):
 
2791
        BzrDirError.__init__(self, bzrdir)
 
2792
        import bzrlib.urlutils as urlutils
 
2793
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2794
                                                        'ascii')
 
2795
 
 
2796
 
 
2797
class AlreadyBranch(BzrDirError):
 
2798
 
 
2799
    _fmt = "'%(display_url)s' is already a branch."
 
2800
 
 
2801
 
 
2802
class AlreadyTree(BzrDirError):
 
2803
 
 
2804
    _fmt = "'%(display_url)s' is already a tree."
 
2805
 
 
2806
 
 
2807
class AlreadyCheckout(BzrDirError):
 
2808
 
 
2809
    _fmt = "'%(display_url)s' is already a checkout."
 
2810
 
 
2811
 
 
2812
class AlreadyLightweightCheckout(BzrDirError):
 
2813
 
 
2814
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2815
 
 
2816
 
 
2817
class AlreadyUsingShared(BzrDirError):
 
2818
 
 
2819
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2820
 
 
2821
 
 
2822
class AlreadyStandalone(BzrDirError):
 
2823
 
 
2824
    _fmt = "'%(display_url)s' is already standalone."
 
2825
 
 
2826
 
 
2827
class AlreadyWithTrees(BzrDirError):
 
2828
 
 
2829
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2830
            "working trees.")
 
2831
 
 
2832
 
 
2833
class AlreadyWithNoTrees(BzrDirError):
 
2834
 
 
2835
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2836
            "working trees.")
 
2837
 
 
2838
 
 
2839
class ReconfigurationNotSupported(BzrDirError):
 
2840
 
 
2841
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2842
 
 
2843
 
 
2844
class NoBindLocation(BzrDirError):
 
2845
 
 
2846
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2847
 
 
2848
 
 
2849
class UncommittedChanges(BzrError):
 
2850
 
 
2851
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2852
            ' (See bzr status).%(more)s')
 
2853
 
 
2854
    def __init__(self, tree, more=None):
 
2855
        if more is None:
 
2856
            more = ''
 
2857
        else:
 
2858
            more = ' ' + more
 
2859
        import bzrlib.urlutils as urlutils
 
2860
        user_url = getattr(tree, "user_url", None)
 
2861
        if user_url is None:
 
2862
            display_url = str(tree)
 
2863
        else:
 
2864
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2865
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2866
 
 
2867
 
 
2868
class ShelvedChanges(UncommittedChanges):
 
2869
 
 
2870
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2871
            ' (See bzr shelve --list).%(more)s')
 
2872
 
 
2873
 
 
2874
class MissingTemplateVariable(BzrError):
 
2875
 
 
2876
    _fmt = 'Variable {%(name)s} is not available.'
 
2877
 
 
2878
    def __init__(self, name):
 
2879
        self.name = name
 
2880
 
 
2881
 
 
2882
class NoTemplate(BzrError):
 
2883
 
 
2884
    _fmt = 'No template specified.'
 
2885
 
 
2886
 
 
2887
class UnableCreateSymlink(BzrError):
 
2888
 
 
2889
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2890
 
 
2891
    def __init__(self, path=None):
 
2892
        path_str = ''
 
2893
        if path:
 
2894
            try:
 
2895
                path_str = repr(str(path))
 
2896
            except UnicodeEncodeError:
 
2897
                path_str = repr(path)
 
2898
            path_str += ' '
 
2899
        self.path_str = path_str
 
2900
 
 
2901
 
 
2902
class UnsupportedTimezoneFormat(BzrError):
 
2903
 
 
2904
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2905
            'options are "utc", "original", "local".')
 
2906
 
 
2907
    def __init__(self, timezone):
 
2908
        self.timezone = timezone
 
2909
 
 
2910
 
 
2911
class CommandAvailableInPlugin(StandardError):
 
2912
 
 
2913
    internal_error = False
 
2914
 
 
2915
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2916
 
 
2917
        self.plugin_metadata = plugin_metadata
 
2918
        self.cmd_name = cmd_name
 
2919
        self.provider = provider
 
2920
 
 
2921
    def __str__(self):
 
2922
 
 
2923
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2924
                'However, the following official plugin provides this command: %s\n'
 
2925
                'You can install it by going to: %s'
 
2926
                % (self.cmd_name, self.plugin_metadata['name'],
 
2927
                    self.plugin_metadata['url']))
 
2928
 
 
2929
        return _fmt
 
2930
 
 
2931
 
 
2932
class NoPluginAvailable(BzrError):
 
2933
    pass
 
2934
 
 
2935
 
 
2936
class UnableEncodePath(BzrError):
 
2937
 
 
2938
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2939
            'user encoding %(user_encoding)s')
 
2940
 
 
2941
    def __init__(self, path, kind):
 
2942
        from bzrlib.osutils import get_user_encoding
 
2943
        self.path = path
 
2944
        self.kind = kind
 
2945
        self.user_encoding = osutils.get_user_encoding()
 
2946
 
 
2947
 
 
2948
class NoSuchAlias(BzrError):
 
2949
 
 
2950
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2951
 
 
2952
    def __init__(self, alias_name):
 
2953
        BzrError.__init__(self, alias_name=alias_name)
 
2954
 
 
2955
 
 
2956
class DirectoryLookupFailure(BzrError):
 
2957
    """Base type for lookup errors."""
 
2958
 
 
2959
    pass
 
2960
 
 
2961
 
 
2962
class InvalidLocationAlias(DirectoryLookupFailure):
 
2963
 
 
2964
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2965
 
 
2966
    def __init__(self, alias_name):
 
2967
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2968
 
 
2969
 
 
2970
class UnsetLocationAlias(DirectoryLookupFailure):
 
2971
 
 
2972
    _fmt = 'No %(alias_name)s location assigned.'
 
2973
 
 
2974
    def __init__(self, alias_name):
 
2975
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2976
 
 
2977
 
 
2978
class CannotBindAddress(BzrError):
 
2979
 
 
2980
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2981
 
 
2982
    def __init__(self, host, port, orig_error):
 
2983
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2984
        BzrError.__init__(self, host=host, port=port,
 
2985
            orig_error=repr(orig_error.args))
 
2986
 
 
2987
 
 
2988
class UnknownRules(BzrError):
 
2989
 
 
2990
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2991
 
 
2992
    def __init__(self, unknowns):
 
2993
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2994
 
 
2995
 
 
2996
class HookFailed(BzrError):
 
2997
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2998
    than TipChangeRejected.
 
2999
 
 
3000
    Note that this exception is no longer raised, and the import is only left
 
3001
    to be nice to code which might catch it in a plugin.
 
3002
    """
 
3003
 
 
3004
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
3005
            "%(traceback_text)s%(exc_value)s")
 
3006
 
 
3007
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
3008
        if warn:
 
3009
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
3010
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
3011
        import traceback
 
3012
        self.hook_stage = hook_stage
 
3013
        self.hook_name = hook_name
 
3014
        self.exc_info = exc_info
 
3015
        self.exc_type = exc_info[0]
 
3016
        self.exc_value = exc_info[1]
 
3017
        self.exc_tb = exc_info[2]
 
3018
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
3019
 
 
3020
 
 
3021
class TipChangeRejected(BzrError):
 
3022
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3023
    explicitly abort a change to a branch tip.
 
3024
    """
 
3025
 
 
3026
    _fmt = u"Tip change rejected: %(msg)s"
 
3027
 
 
3028
    def __init__(self, msg):
 
3029
        self.msg = msg
 
3030
 
 
3031
 
 
3032
class ShelfCorrupt(BzrError):
 
3033
 
 
3034
    _fmt = "Shelf corrupt."
 
3035
 
 
3036
 
 
3037
class NoSuchShelfId(BzrError):
 
3038
 
 
3039
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3040
 
 
3041
    def __init__(self, shelf_id):
 
3042
        BzrError.__init__(self, shelf_id=shelf_id)
 
3043
 
 
3044
 
 
3045
class InvalidShelfId(BzrError):
 
3046
 
 
3047
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3048
 
 
3049
    def __init__(self, invalid_id):
 
3050
        BzrError.__init__(self, invalid_id=invalid_id)
 
3051
 
 
3052
 
 
3053
class JailBreak(BzrError):
 
3054
 
 
3055
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3056
 
 
3057
    def __init__(self, url):
 
3058
        BzrError.__init__(self, url=url)
 
3059
 
 
3060
 
 
3061
class UserAbort(BzrError):
 
3062
 
 
3063
    _fmt = 'The user aborted the operation.'
 
3064
 
 
3065
 
 
3066
class MustHaveWorkingTree(BzrError):
 
3067
 
 
3068
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3069
 
 
3070
    def __init__(self, format, url):
 
3071
        BzrError.__init__(self, format=format, url=url)
 
3072
 
 
3073
 
 
3074
class NoSuchView(BzrError):
 
3075
    """A view does not exist.
 
3076
    """
 
3077
 
 
3078
    _fmt = u"No such view: %(view_name)s."
 
3079
 
 
3080
    def __init__(self, view_name):
 
3081
        self.view_name = view_name
 
3082
 
 
3083
 
 
3084
class ViewsNotSupported(BzrError):
 
3085
    """Views are not supported by a tree format.
 
3086
    """
 
3087
 
 
3088
    _fmt = ("Views are not supported by %(tree)s;"
 
3089
            " use 'bzr upgrade' to change your tree to a later format.")
 
3090
 
 
3091
    def __init__(self, tree):
 
3092
        self.tree = tree
 
3093
 
 
3094
 
 
3095
class FileOutsideView(BzrError):
 
3096
 
 
3097
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3098
            '%(view_str)s')
 
3099
 
 
3100
    def __init__(self, file_name, view_files):
 
3101
        self.file_name = file_name
 
3102
        self.view_str = ", ".join(view_files)
 
3103
 
 
3104
 
 
3105
class UnresumableWriteGroup(BzrError):
 
3106
 
 
3107
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3108
            "%(write_groups)r: %(reason)s")
 
3109
 
 
3110
    internal_error = True
 
3111
 
 
3112
    def __init__(self, repository, write_groups, reason):
 
3113
        self.repository = repository
 
3114
        self.write_groups = write_groups
 
3115
        self.reason = reason
 
3116
 
 
3117
 
 
3118
class UnsuspendableWriteGroup(BzrError):
 
3119
 
 
3120
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3121
 
 
3122
    internal_error = True
 
3123
 
 
3124
    def __init__(self, repository):
 
3125
        self.repository = repository
 
3126
 
 
3127
 
 
3128
class LossyPushToSameVCS(BzrError):
 
3129
 
 
3130
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3131
            "%(target_branch)r that are in the same VCS.")
 
3132
 
 
3133
    internal_error = True
 
3134
 
 
3135
    def __init__(self, source_branch, target_branch):
 
3136
        self.source_branch = source_branch
 
3137
        self.target_branch = target_branch
 
3138
 
 
3139
 
 
3140
class NoRoundtrippingSupport(BzrError):
 
3141
 
 
3142
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3143
            "%(target_branch)r.")
 
3144
 
 
3145
    internal_error = True
 
3146
 
 
3147
    def __init__(self, source_branch, target_branch):
 
3148
        self.source_branch = source_branch
 
3149
        self.target_branch = target_branch
 
3150
 
 
3151
 
 
3152
class FileTimestampUnavailable(BzrError):
 
3153
 
 
3154
    _fmt = "The filestamp for %(path)s is not available."
 
3155
 
 
3156
    internal_error = True
 
3157
 
 
3158
    def __init__(self, path):
 
3159
        self.path = path
 
3160
 
 
3161
 
 
3162
class NoColocatedBranchSupport(BzrError):
 
3163
 
 
3164
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3165
 
 
3166
    def __init__(self, bzrdir):
 
3167
        self.bzrdir = bzrdir
 
3168
 
 
3169
 
 
3170
class NoWhoami(BzrError):
 
3171
 
 
3172
    _fmt = ('Unable to determine your name.\n'
 
3173
        "Please, set your name with the 'whoami' command.\n"
 
3174
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3175
 
 
3176
 
 
3177
class InvalidPattern(BzrError):
 
3178
 
 
3179
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3180
 
 
3181
    def __init__(self, msg):
 
3182
        self.msg = msg
 
3183
 
 
3184
 
 
3185
class RecursiveBind(BzrError):
 
3186
 
 
3187
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3188
        'Please use `bzr unbind` to fix.')
 
3189
 
 
3190
    def __init__(self, branch_url):
 
3191
        self.branch_url = branch_url
 
3192