← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Reagan Sanders
  • Date: 2013-08-11 20:22:29 UTC
  • mto: This revision was merged to the branch mainline in revision 6594.
  • Revision ID: vexofp@gmail.com-20130811202229-fn9zpjewqypdz5hr
Reverted the UTF change to the SIGNATURE_KEY_MISSING case, as the values here will always be a key ID, and that will never be non-ASCII.

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-2011 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
 
from bzrlib import (
22
 
    osutils,
23
 
    symbol_versioning,
24
 
    )
25
 
from bzrlib.patches import (
26
 
    MalformedHunkHeader,
27
 
    MalformedLine,
28
 
    MalformedPatchHeader,
29
 
    PatchConflict,
30
 
    PatchSyntax,
31
 
    )
32
 
 
 
20
from __future__ import absolute_import
33
21
 
34
22
# 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 
 
23
# python exceptions?   A list of values with no names seems less useful
36
24
# to me.
37
25
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
26
# TODO: Perhaps convert the exception to a string at the moment it's
39
27
# constructed to make sure it will succeed.  But that says nothing about
40
28
# exceptions that are never raised.
41
29
 
55
43
    Base class for errors raised by bzrlib.
56
44
 
57
45
    :cvar internal_error: if True this was probably caused by a bzr bug and
58
 
    should be displayed with a traceback; if False (or absent) this was
59
 
    probably a user or environment error and they don't need the gory details.
60
 
    (That can be overridden by -Derror on the command line.)
 
46
        should be displayed with a traceback; if False (or absent) this was
 
47
        probably a user or environment error and they don't need the gory
 
48
        details.  (That can be overridden by -Derror on the command line.)
61
49
 
62
50
    :cvar _fmt: Format string to display the error; this is expanded
63
 
    by the instance's dict.
 
51
        by the instance's dict.
64
52
    """
65
 
    
 
53
 
66
54
    internal_error = False
67
55
 
68
56
    def __init__(self, msg=None, **kwds):
73
61
        arguments can be given.  The first is for generic "user" errors which
74
62
        are not intended to be caught and so do not need a specific subclass.
75
63
        The second case is for use with subclasses that provide a _fmt format
76
 
        string to print the arguments.  
 
64
        string to print the arguments.
77
65
 
78
 
        Keyword arguments are taken as parameters to the error, which can 
79
 
        be inserted into the format string template.  It's recommended 
80
 
        that subclasses override the __init__ method to require specific 
 
66
        Keyword arguments are taken as parameters to the error, which can
 
67
        be inserted into the format string template.  It's recommended
 
68
        that subclasses override the __init__ method to require specific
81
69
        parameters.
82
70
 
83
71
        :param msg: If given, this is the literal complete text for the error,
84
 
        not subject to expansion.
 
72
           not subject to expansion. 'msg' is used instead of 'message' because
 
73
           python evolved and, in 2.6, forbids the use of 'message'.
85
74
        """
86
75
        StandardError.__init__(self)
87
76
        if msg is not None:
93
82
            for key, value in kwds.items():
94
83
                setattr(self, key, value)
95
84
 
96
 
    def __str__(self):
 
85
    def _format(self):
97
86
        s = getattr(self, '_preformatted_string', None)
98
87
        if s is not None:
99
 
            # contains a preformatted message; must be cast to plain str
100
 
            return str(s)
 
88
            # contains a preformatted message
 
89
            return s
101
90
        try:
102
91
            fmt = self._get_format_string()
103
92
            if fmt:
104
93
                d = dict(self.__dict__)
105
 
                # special case: python2.5 puts the 'message' attribute in a
106
 
                # slot, so it isn't seen in __dict__
107
 
                d['message'] = getattr(self, 'message', 'no message')
108
94
                s = fmt % d
109
95
                # __str__() should always return a 'str' object
110
96
                # never a 'unicode' object.
111
 
                if isinstance(s, unicode):
112
 
                    return s.encode('utf8')
113
97
                return s
114
 
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
115
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
116
 
                % (self.__class__.__name__,
117
 
                   self.__dict__,
118
 
                   getattr(self, '_fmt', None),
119
 
                   e)
 
98
        except Exception, e:
 
99
            pass # just bind to 'e' for formatting below
 
100
        else:
 
101
            e = None
 
102
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
103
            % (self.__class__.__name__,
 
104
               self.__dict__,
 
105
               getattr(self, '_fmt', None),
 
106
               e)
 
107
 
 
108
    def __unicode__(self):
 
109
        u = self._format()
 
110
        if isinstance(u, str):
 
111
            # Try decoding the str using the default encoding.
 
112
            u = unicode(u)
 
113
        elif not isinstance(u, unicode):
 
114
            # Try to make a unicode object from it, because __unicode__ must
 
115
            # return a unicode object.
 
116
            u = unicode(u)
 
117
        return u
 
118
 
 
119
    def __str__(self):
 
120
        s = self._format()
 
121
        if isinstance(s, unicode):
 
122
            s = s.encode('utf8')
 
123
        else:
 
124
            # __str__ must return a str.
 
125
            s = str(s)
 
126
        return s
 
127
 
 
128
    def __repr__(self):
 
129
        return '%s(%s)' % (self.__class__.__name__, str(self))
120
130
 
121
131
    def _get_format_string(self):
122
132
        """Return format string for this exception or None"""
123
133
        fmt = getattr(self, '_fmt', None)
124
134
        if fmt is not None:
125
 
            return fmt
126
 
        fmt = getattr(self, '__doc__', None)
127
 
        if fmt is not None:
128
 
            symbol_versioning.warn("%s uses its docstring as a format, "
129
 
                    "it should use _fmt instead" % self.__class__.__name__,
130
 
                    DeprecationWarning)
131
 
            return fmt
132
 
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
133
 
            % (self.__class__.__name__,
134
 
               self.__dict__,
135
 
               getattr(self, '_fmt', None),
136
 
               )
 
135
            from bzrlib.i18n import gettext
 
136
            return gettext(unicode(fmt)) # _fmt strings should be ascii
 
137
 
 
138
    def __eq__(self, other):
 
139
        if self.__class__ is not other.__class__:
 
140
            return NotImplemented
 
141
        return self.__dict__ == other.__dict__
137
142
 
138
143
 
139
144
class InternalBzrError(BzrError):
147
152
    internal_error = True
148
153
 
149
154
 
150
 
class BzrNewError(BzrError):
151
 
    """Deprecated error base class."""
152
 
    # base classes should override the docstring with their human-
153
 
    # readable explanation
154
 
 
155
 
    def __init__(self, *args, **kwds):
156
 
        # XXX: Use the underlying BzrError to always generate the args
157
 
        # attribute if it doesn't exist.  We can't use super here, because
158
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
159
 
        # --bmc, 20060426
160
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
161
 
             'please convert %s to use BzrError instead'
162
 
             % self.__class__.__name__,
163
 
             DeprecationWarning,
164
 
             stacklevel=2)
165
 
        BzrError.__init__(self, *args)
166
 
        for key, value in kwds.items():
167
 
            setattr(self, key, value)
168
 
 
169
 
    def __str__(self):
170
 
        try:
171
 
            # __str__() should always return a 'str' object
172
 
            # never a 'unicode' object.
173
 
            s = self.__doc__ % self.__dict__
174
 
            if isinstance(s, unicode):
175
 
                return s.encode('utf8')
176
 
            return s
177
 
        except (TypeError, NameError, ValueError, KeyError), e:
178
 
            return 'Unprintable exception %s(%r): %r' \
179
 
                % (self.__class__.__name__,
180
 
                   self.__dict__, e)
181
 
 
182
 
 
183
155
class AlreadyBuilding(BzrError):
184
 
    
 
156
 
185
157
    _fmt = "The tree builder is already building a tree."
186
158
 
187
159
 
 
160
class BranchError(BzrError):
 
161
    """Base class for concrete 'errors about a branch'."""
 
162
 
 
163
    def __init__(self, branch):
 
164
        BzrError.__init__(self, branch=branch)
 
165
 
 
166
 
188
167
class BzrCheckError(InternalBzrError):
189
 
    
190
 
    _fmt = "Internal check failed: %(message)s"
191
 
 
192
 
    def __init__(self, message):
193
 
        BzrError.__init__(self)
194
 
        self.message = message
 
168
 
 
169
    _fmt = "Internal check failed: %(msg)s"
 
170
 
 
171
    def __init__(self, msg):
 
172
        BzrError.__init__(self)
 
173
        self.msg = msg
 
174
 
 
175
 
 
176
class DirstateCorrupt(BzrError):
 
177
 
 
178
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
179
 
 
180
    def __init__(self, state, msg):
 
181
        BzrError.__init__(self)
 
182
        self.state = state
 
183
        self.msg = msg
195
184
 
196
185
 
197
186
class DisabledMethod(InternalBzrError):
225
214
 
226
215
 
227
216
class InvalidEntryName(InternalBzrError):
228
 
    
 
217
 
229
218
    _fmt = "Invalid entry name: %(name)s"
230
219
 
231
220
    def __init__(self, name):
234
223
 
235
224
 
236
225
class InvalidRevisionNumber(BzrError):
237
 
    
 
226
 
238
227
    _fmt = "Invalid revision number %(revno)s"
239
228
 
240
229
    def __init__(self, revno):
264
253
class RootMissing(InternalBzrError):
265
254
 
266
255
    _fmt = ("The root entry of a tree must be the first entry supplied to "
267
 
        "record_entry_contents.")
 
256
        "the commit builder.")
 
257
 
 
258
 
 
259
class NoPublicBranch(BzrError):
 
260
 
 
261
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
262
 
 
263
    def __init__(self, branch):
 
264
        import bzrlib.urlutils as urlutils
 
265
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
266
        BzrError.__init__(self, branch_url=public_location)
268
267
 
269
268
 
270
269
class NoHelpTopic(BzrError):
279
278
class NoSuchId(BzrError):
280
279
 
281
280
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
282
 
    
 
281
 
283
282
    def __init__(self, tree, file_id):
284
283
        BzrError.__init__(self)
285
284
        self.file_id = file_id
295
294
        BzrError.__init__(self, repository=repository, file_id=file_id)
296
295
 
297
296
 
 
297
class NotStacked(BranchError):
 
298
 
 
299
    _fmt = "The branch '%(branch)s' is not stacked."
 
300
 
 
301
 
298
302
class InventoryModified(InternalBzrError):
299
303
 
300
304
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
307
311
class NoWorkingTree(BzrError):
308
312
 
309
313
    _fmt = 'No WorkingTree exists for "%(base)s".'
310
 
    
 
314
 
311
315
    def __init__(self, base):
312
316
        BzrError.__init__(self)
313
317
        self.base = base
344
348
    # are not intended to be caught anyway.  UI code need not subclass
345
349
    # BzrCommandError, and non-UI code should not throw a subclass of
346
350
    # BzrCommandError.  ADHB 20051211
347
 
    def __init__(self, msg):
348
 
        # Object.__str__() must return a real string
349
 
        # returning a Unicode string is a python error.
350
 
        if isinstance(msg, unicode):
351
 
            self.msg = msg.encode('utf8')
352
 
        else:
353
 
            self.msg = msg
354
 
 
355
 
    def __str__(self):
356
 
        return self.msg
357
351
 
358
352
 
359
353
class NotWriteLocked(BzrError):
432
426
    def __init__(self, name, value):
433
427
        BzrError.__init__(self, name=name, value=value)
434
428
 
435
 
    
 
429
 
436
430
class StrictCommitFailed(BzrError):
437
431
 
438
432
    _fmt = "Commit refused because there are unknown files in the tree"
441
435
# XXX: Should be unified with TransportError; they seem to represent the
442
436
# same thing
443
437
# RBC 20060929: I think that unifiying with TransportError would be a mistake
444
 
# - this is finer than a TransportError - and more useful as such. It 
 
438
# - this is finer than a TransportError - and more useful as such. It
445
439
# differentiates between 'transport has failed' and 'operation on a transport
446
440
# has failed.'
447
441
class PathError(BzrError):
448
 
    
 
442
 
449
443
    _fmt = "Generic path error: %(path)r%(extra)s)"
450
444
 
451
445
    def __init__(self, path, extra=None):
499
493
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
500
494
 
501
495
 
 
496
class HardLinkNotSupported(PathError):
 
497
 
 
498
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
499
 
 
500
 
502
501
class ReadingCompleted(InternalBzrError):
503
 
    
 
502
 
504
503
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
505
504
            "called upon it - the request has been completed and no more "
506
505
            "data may be read.")
526
525
 
527
526
class InvalidURLJoin(PathError):
528
527
 
529
 
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
530
 
 
531
 
    def __init__(self, msg, base, args):
532
 
        PathError.__init__(self, base, msg)
533
 
        self.args = [base] + list(args)
 
528
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
529
 
 
530
    def __init__(self, reason, base, join_args):
 
531
        self.reason = reason
 
532
        self.base = base
 
533
        self.join_args = join_args
 
534
        PathError.__init__(self, base, reason)
 
535
 
 
536
 
 
537
class InvalidRebaseURLs(PathError):
 
538
 
 
539
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
540
 
 
541
    def __init__(self, from_, to):
 
542
        self.from_ = from_
 
543
        self.to = to
 
544
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
545
 
 
546
 
 
547
class UnavailableRepresentation(InternalBzrError):
 
548
 
 
549
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
550
        "is encoded as '%(native)s'.")
 
551
 
 
552
    def __init__(self, key, wanted, native):
 
553
        InternalBzrError.__init__(self)
 
554
        self.wanted = wanted
 
555
        self.native = native
 
556
        self.key = key
534
557
 
535
558
 
536
559
class UnknownHook(BzrError):
547
570
 
548
571
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
549
572
 
550
 
    def __init__(self, url, extra):
 
573
    def __init__(self, url, extra=""):
551
574
        PathError.__init__(self, url, extra=extra)
552
575
 
553
576
 
 
577
class UnstackableBranchFormat(BzrError):
 
578
 
 
579
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
580
        "You will need to upgrade the branch to permit branch stacking.")
 
581
 
 
582
    def __init__(self, format, url):
 
583
        BzrError.__init__(self)
 
584
        self.format = format
 
585
        self.url = url
 
586
 
 
587
 
 
588
class UnstackableLocationError(BzrError):
 
589
 
 
590
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
591
 
 
592
    def __init__(self, branch_url, target_url):
 
593
        BzrError.__init__(self)
 
594
        self.branch_url = branch_url
 
595
        self.target_url = target_url
 
596
 
 
597
 
 
598
class UnstackableRepositoryFormat(BzrError):
 
599
 
 
600
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
601
        "You will need to upgrade the repository to permit branch stacking.")
 
602
 
 
603
    def __init__(self, format, url):
 
604
        BzrError.__init__(self)
 
605
        self.format = format
 
606
        self.url = url
 
607
 
 
608
 
554
609
class ReadError(PathError):
555
 
    
 
610
 
556
611
    _fmt = """Error reading from %(path)r."""
557
612
 
558
613
 
574
629
 
575
630
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
576
631
 
577
 
    internal_error = True
 
632
    internal_error = False
578
633
 
579
634
    def __init__(self, path, base, extra=None):
580
635
        BzrError.__init__(self)
593
648
 
594
649
# TODO: This is given a URL; we try to unescape it but doing that from inside
595
650
# the exception object is a bit undesirable.
596
 
# TODO: Probably this behavior of should be a common superclass 
 
651
# TODO: Probably this behavior of should be a common superclass
597
652
class NotBranchError(PathError):
598
653
 
599
 
    _fmt = 'Not a branch: "%(path)s".'
 
654
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
600
655
 
601
 
    def __init__(self, path):
 
656
    def __init__(self, path, detail=None, bzrdir=None):
602
657
       import bzrlib.urlutils as urlutils
603
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
658
       path = urlutils.unescape_for_display(path, 'ascii')
 
659
       if detail is not None:
 
660
           detail = ': ' + detail
 
661
       self.detail = detail
 
662
       self.bzrdir = bzrdir
 
663
       PathError.__init__(self, path=path)
 
664
 
 
665
    def __repr__(self):
 
666
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
667
 
 
668
    def _format(self):
 
669
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
670
        # Python 2.4 have to be old-style classes so properties don't work.
 
671
        # Instead we override _format.
 
672
        if self.detail is None:
 
673
            if self.bzrdir is not None:
 
674
                try:
 
675
                    self.bzrdir.open_repository()
 
676
                except NoRepositoryPresent:
 
677
                    self.detail = ''
 
678
                except Exception:
 
679
                    # Just ignore unexpected errors.  Raising arbitrary errors
 
680
                    # during str(err) can provoke strange bugs.  Concretely
 
681
                    # Launchpad's codehosting managed to raise NotBranchError
 
682
                    # here, and then get stuck in an infinite loop/recursion
 
683
                    # trying to str() that error.  All this error really cares
 
684
                    # about that there's no working repository there, and if
 
685
                    # open_repository() fails, there probably isn't.
 
686
                    self.detail = ''
 
687
                else:
 
688
                    self.detail = ': location is a repository'
 
689
            else:
 
690
                self.detail = ''
 
691
        return PathError._format(self)
604
692
 
605
693
 
606
694
class NoSubmitBranch(PathError):
612
700
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
613
701
 
614
702
 
 
703
class AlreadyControlDirError(PathError):
 
704
 
 
705
    _fmt = 'A control directory already exists: "%(path)s".'
 
706
 
 
707
 
615
708
class AlreadyBranchError(PathError):
616
709
 
617
710
    _fmt = 'Already a branch: "%(path)s".'
618
711
 
619
712
 
 
713
class InvalidBranchName(PathError):
 
714
 
 
715
    _fmt = "Invalid branch name: %(name)s"
 
716
 
 
717
    def __init__(self, name):
 
718
        BzrError.__init__(self)
 
719
        self.name = name
 
720
 
 
721
 
 
722
class ParentBranchExists(AlreadyBranchError):
 
723
 
 
724
    _fmt = 'Parent branch already exists: "%(path)s".'
 
725
 
 
726
 
620
727
class BranchExistsWithoutWorkingTree(PathError):
621
728
 
622
729
    _fmt = 'Directory contains a branch, but no working tree \
651
758
        self.path = bzrdir.transport.clone('..').base
652
759
 
653
760
 
654
 
class FileInWrongBranch(BzrError):
655
 
 
656
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
657
 
 
658
 
    def __init__(self, branch, path):
659
 
        BzrError.__init__(self)
660
 
        self.branch = branch
661
 
        self.branch_base = branch.base
662
 
        self.path = path
663
 
 
664
 
 
665
761
class UnsupportedFormatError(BzrError):
666
762
 
667
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
668
764
 
669
765
 
670
766
class UnknownFormatError(BzrError):
671
 
    
672
 
    _fmt = "Unknown branch format: %(format)r"
 
767
 
 
768
    _fmt = "Unknown %(kind)s format: %(format)r"
 
769
 
 
770
    def __init__(self, format, kind='branch'):
 
771
        self.kind = kind
 
772
        self.format = format
673
773
 
674
774
 
675
775
class IncompatibleFormat(BzrError):
676
 
    
 
776
 
677
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
678
778
 
679
779
    def __init__(self, format, bzrdir_format):
682
782
        self.bzrdir = bzrdir_format
683
783
 
684
784
 
 
785
class ParseFormatError(BzrError):
 
786
 
 
787
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
788
 
 
789
    def __init__(self, format, lineno, line, text):
 
790
        BzrError.__init__(self)
 
791
        self.format = format
 
792
        self.lineno = lineno
 
793
        self.line = line
 
794
        self.text = text
 
795
 
 
796
 
685
797
class IncompatibleRepositories(BzrError):
686
 
 
687
 
    _fmt = "Repository %(target)s is not compatible with repository"\
688
 
        " %(source)s"
689
 
 
690
 
    def __init__(self, source, target):
691
 
        BzrError.__init__(self, target=target, source=source)
 
798
    """Report an error that two repositories are not compatible.
 
799
 
 
800
    Note that the source and target repositories are permitted to be strings:
 
801
    this exception is thrown from the smart server and may refer to a
 
802
    repository the client hasn't opened.
 
803
    """
 
804
 
 
805
    _fmt = "%(target)s\n" \
 
806
            "is not compatible with\n" \
 
807
            "%(source)s\n" \
 
808
            "%(details)s"
 
809
 
 
810
    def __init__(self, source, target, details=None):
 
811
        if details is None:
 
812
            details = "(no details)"
 
813
        BzrError.__init__(self, target=target, source=source, details=details)
692
814
 
693
815
 
694
816
class IncompatibleRevision(BzrError):
695
 
    
 
817
 
696
818
    _fmt = "Revision is not compatible with %(repo_format)s"
697
819
 
698
820
    def __init__(self, repo_format):
709
831
        """Construct a new AlreadyVersionedError.
710
832
 
711
833
        :param path: This is the path which is versioned,
712
 
        which should be in a user friendly form.
 
834
            which should be in a user friendly form.
713
835
        :param context_info: If given, this is information about the context,
714
 
        which could explain why this is expected to not be versioned.
 
836
            which could explain why this is expected to not be versioned.
715
837
        """
716
838
        BzrError.__init__(self)
717
839
        self.path = path
730
852
        """Construct a new NotVersionedError.
731
853
 
732
854
        :param path: This is the path which is not versioned,
733
 
        which should be in a user friendly form.
 
855
            which should be in a user friendly form.
734
856
        :param context_info: If given, this is information about the context,
735
 
        which could explain why this is expected to be versioned.
 
857
            which could explain why this is expected to be versioned.
736
858
        """
737
859
        BzrError.__init__(self)
738
860
        self.path = path
781
903
        BzrError.__init__(self, filename=filename, kind=kind)
782
904
 
783
905
 
 
906
class BadFilenameEncoding(BzrError):
 
907
 
 
908
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
909
            ' encoding %(fs_encoding)s')
 
910
 
 
911
    def __init__(self, filename, fs_encoding):
 
912
        BzrError.__init__(self)
 
913
        self.filename = filename
 
914
        self.fs_encoding = fs_encoding
 
915
 
 
916
 
784
917
class ForbiddenControlFileError(BzrError):
785
918
 
786
919
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
795
928
    # original exception is available as e.original_error
796
929
    #
797
930
    # New code should prefer to raise specific subclasses
798
 
    def __init__(self, message):
799
 
        # Python 2.5 uses a slot for StandardError.message,
800
 
        # so use a different variable name.  We now work around this in
801
 
        # BzrError.__str__, but this member name is kept for compatability.
802
 
        self.msg = message
 
931
    def __init__(self, msg):
 
932
        self.msg = msg
803
933
 
804
934
 
805
935
class LockActive(LockError):
839
969
        self.obj = obj
840
970
 
841
971
 
842
 
class ReadOnlyLockError(LockError):
843
 
 
844
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
845
 
 
846
 
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
847
 
    def __init__(self, fname, msg):
848
 
        LockError.__init__(self, '')
849
 
        self.fname = fname
850
 
        self.msg = msg
851
 
 
852
 
 
853
972
class LockFailed(LockError):
854
973
 
855
974
    internal_error = False
899
1018
 
900
1019
class LockContention(LockError):
901
1020
 
902
 
    _fmt = 'Could not acquire lock "%(lock)s"'
903
 
    # TODO: show full url for lock, combining the transport and relative
904
 
    # bits?
 
1021
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
905
1022
 
906
1023
    internal_error = False
907
1024
 
908
 
    def __init__(self, lock):
 
1025
    def __init__(self, lock, msg=''):
909
1026
        self.lock = lock
 
1027
        self.msg = msg
910
1028
 
911
1029
 
912
1030
class LockBroken(LockError):
933
1051
        self.target = target
934
1052
 
935
1053
 
 
1054
class LockCorrupt(LockError):
 
1055
 
 
1056
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1057
            "Use 'bzr break-lock' to clear it")
 
1058
 
 
1059
    internal_error = False
 
1060
 
 
1061
    def __init__(self, corruption_info, file_data=None):
 
1062
        self.corruption_info = corruption_info
 
1063
        self.file_data = file_data
 
1064
 
 
1065
 
936
1066
class LockNotHeld(LockError):
937
1067
 
938
1068
    _fmt = "Lock not held: %(lock)s"
977
1107
        BzrError.__init__(self, files=files, files_str=files_str)
978
1108
 
979
1109
 
 
1110
class ExcludesUnsupported(BzrError):
 
1111
 
 
1112
    _fmt = ('Excluding paths during commit is not supported by '
 
1113
            'repository at %(repository)r.')
 
1114
 
 
1115
    def __init__(self, repository):
 
1116
        BzrError.__init__(self, repository=repository)
 
1117
 
 
1118
 
980
1119
class BadCommitMessageEncoding(BzrError):
981
1120
 
982
1121
    _fmt = 'The specified commit message contains characters unsupported by '\
1011
1150
        BzrError.__init__(self, branch=branch, revision=revision)
1012
1151
 
1013
1152
 
1014
 
# zero_ninetyone: this exception is no longer raised and should be removed
1015
 
class NotLeftParentDescendant(InternalBzrError):
1016
 
 
1017
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
1018
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
1019
 
 
1020
 
    def __init__(self, branch, old_revision, new_revision):
1021
 
        BzrError.__init__(self, branch_location=branch.base,
1022
 
                          old_revision=old_revision,
1023
 
                          new_revision=new_revision)
1024
 
 
1025
 
 
1026
1153
class RangeInChangeOption(BzrError):
1027
1154
 
1028
1155
    _fmt = "Option --change does not accept revision ranges"
1038
1165
 
1039
1166
class NoSuchRevisionInTree(NoSuchRevision):
1040
1167
    """When using Tree.revision_tree, and the revision is not accessible."""
1041
 
    
 
1168
 
1042
1169
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1043
1170
 
1044
1171
    def __init__(self, tree, revision_id):
1049
1176
 
1050
1177
class InvalidRevisionSpec(BzrError):
1051
1178
 
1052
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1053
 
            " %(branch)s%(extra)s")
 
1179
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1180
            " %(branch_url)s%(extra)s")
1054
1181
 
1055
1182
    def __init__(self, spec, branch, extra=None):
1056
1183
        BzrError.__init__(self, branch=branch, spec=spec)
 
1184
        self.branch_url = getattr(branch, 'user_url', str(branch))
1057
1185
        if extra:
1058
1186
            self.extra = '\n' + str(extra)
1059
1187
        else:
1060
1188
            self.extra = ''
1061
1189
 
1062
1190
 
1063
 
class HistoryMissing(BzrError):
1064
 
 
1065
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
1066
 
 
1067
 
 
1068
1191
class AppendRevisionsOnlyViolation(BzrError):
1069
1192
 
1070
1193
    _fmt = ('Operation denied because it would change the main history,'
1080
1203
class DivergedBranches(BzrError):
1081
1204
 
1082
1205
    _fmt = ("These branches have diverged."
1083
 
            " Use the merge command to reconcile them.")
 
1206
            " Use the missing command to see how.\n"
 
1207
            "Use the merge command to reconcile them.")
1084
1208
 
1085
1209
    def __init__(self, branch1, branch2):
1086
1210
        self.branch1 = branch1
1108
1232
 
1109
1233
 
1110
1234
class NoCommonAncestor(BzrError):
1111
 
    
 
1235
 
1112
1236
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1113
1237
 
1114
1238
    def __init__(self, revision_a, revision_b):
1134
1258
            not_ancestor_id=not_ancestor_id)
1135
1259
 
1136
1260
 
1137
 
class InstallFailed(BzrError):
1138
 
 
1139
 
    def __init__(self, revisions):
1140
 
        revision_str = ", ".join(str(r) for r in revisions)
1141
 
        msg = "Could not install revisions:\n%s" % revision_str
1142
 
        BzrError.__init__(self, msg)
1143
 
        self.revisions = revisions
1144
 
 
1145
 
 
1146
 
class AmbiguousBase(BzrError):
1147
 
 
1148
 
    def __init__(self, bases):
1149
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1150
 
                DeprecationWarning)
1151
 
        msg = ("The correct base is unclear, because %s are all equally close"
1152
 
                % ", ".join(bases))
1153
 
        BzrError.__init__(self, msg)
1154
 
        self.bases = bases
1155
 
 
1156
 
 
1157
 
class NoCommits(BzrError):
 
1261
class NoCommits(BranchError):
1158
1262
 
1159
1263
    _fmt = "Branch %(branch)s has no commits."
1160
1264
 
1161
 
    def __init__(self, branch):
1162
 
        BzrError.__init__(self, branch=branch)
1163
 
 
1164
1265
 
1165
1266
class UnlistableStore(BzrError):
1166
1267
 
1178
1279
class BoundBranchOutOfDate(BzrError):
1179
1280
 
1180
1281
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1181
 
            " %(master)s.")
 
1282
            " %(master)s.%(extra_help)s")
1182
1283
 
1183
1284
    def __init__(self, branch, master):
1184
1285
        BzrError.__init__(self)
1185
1286
        self.branch = branch
1186
1287
        self.master = master
1187
 
 
1188
 
        
 
1288
        self.extra_help = ''
 
1289
 
 
1290
 
1189
1291
class CommitToDoubleBoundBranch(BzrError):
1190
1292
 
1191
1293
    _fmt = ("Cannot commit to branch %(branch)s."
1221
1323
 
1222
1324
class WeaveError(BzrError):
1223
1325
 
1224
 
    _fmt = "Error in processing weave: %(message)s"
 
1326
    _fmt = "Error in processing weave: %(msg)s"
1225
1327
 
1226
 
    def __init__(self, message=None):
 
1328
    def __init__(self, msg=None):
1227
1329
        BzrError.__init__(self)
1228
 
        self.message = message
 
1330
        self.msg = msg
1229
1331
 
1230
1332
 
1231
1333
class WeaveRevisionAlreadyPresent(WeaveError):
1260
1362
 
1261
1363
class WeaveParentMismatch(WeaveError):
1262
1364
 
1263
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1264
 
    
 
1365
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1366
 
1265
1367
 
1266
1368
class WeaveInvalidChecksum(WeaveError):
1267
1369
 
1268
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1370
    _fmt = "Text did not match its checksum: %(msg)s"
1269
1371
 
1270
1372
 
1271
1373
class WeaveTextDiffers(WeaveError):
1293
1395
 
1294
1396
 
1295
1397
class VersionedFileError(BzrError):
1296
 
    
 
1398
 
1297
1399
    _fmt = "Versioned file error"
1298
1400
 
1299
1401
 
1300
1402
class RevisionNotPresent(VersionedFileError):
1301
 
    
 
1403
 
1302
1404
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1303
1405
 
1304
1406
    def __init__(self, revision_id, file_id):
1308
1410
 
1309
1411
 
1310
1412
class RevisionAlreadyPresent(VersionedFileError):
1311
 
    
 
1413
 
1312
1414
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1313
1415
 
1314
1416
    def __init__(self, revision_id, file_id):
1319
1421
 
1320
1422
class VersionedFileInvalidChecksum(VersionedFileError):
1321
1423
 
1322
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1424
    _fmt = "Text did not match its checksum: %(msg)s"
1323
1425
 
1324
1426
 
1325
1427
class KnitError(InternalBzrError):
1326
 
    
 
1428
 
1327
1429
    _fmt = "Knit error"
1328
1430
 
1329
1431
 
1337
1439
        self.how = how
1338
1440
 
1339
1441
 
 
1442
class SHA1KnitCorrupt(KnitCorrupt):
 
1443
 
 
1444
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1445
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1446
        "sha %(actual)s")
 
1447
 
 
1448
    def __init__(self, filename, actual, expected, key, content):
 
1449
        KnitError.__init__(self)
 
1450
        self.filename = filename
 
1451
        self.actual = actual
 
1452
        self.expected = expected
 
1453
        self.key = key
 
1454
        self.content = content
 
1455
 
 
1456
 
1340
1457
class KnitDataStreamIncompatible(KnitError):
1341
1458
    # Not raised anymore, as we can convert data streams.  In future we may
1342
1459
    # need it again for more exotic cases, so we're keeping it around for now.
1346
1463
    def __init__(self, stream_format, target_format):
1347
1464
        self.stream_format = stream_format
1348
1465
        self.target_format = target_format
1349
 
        
 
1466
 
1350
1467
 
1351
1468
class KnitDataStreamUnknown(KnitError):
1352
1469
    # Indicates a data stream we don't know how to handle.
1355
1472
 
1356
1473
    def __init__(self, stream_format):
1357
1474
        self.stream_format = stream_format
1358
 
        
 
1475
 
1359
1476
 
1360
1477
class KnitHeaderError(KnitError):
1361
1478
 
1371
1488
 
1372
1489
    Currently only 'fulltext' and 'line-delta' are supported.
1373
1490
    """
1374
 
    
 
1491
 
1375
1492
    _fmt = ("Knit index %(filename)s does not have a known method"
1376
1493
            " in options: %(options)r")
1377
1494
 
1381
1498
        self.options = options
1382
1499
 
1383
1500
 
 
1501
class RetryWithNewPacks(BzrError):
 
1502
    """Raised when we realize that the packs on disk have changed.
 
1503
 
 
1504
    This is meant as more of a signaling exception, to trap between where a
 
1505
    local error occurred and the code that can actually handle the error and
 
1506
    code that can retry appropriately.
 
1507
    """
 
1508
 
 
1509
    internal_error = True
 
1510
 
 
1511
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1512
            " %(orig_error)s")
 
1513
 
 
1514
    def __init__(self, context, reload_occurred, exc_info):
 
1515
        """create a new RetryWithNewPacks error.
 
1516
 
 
1517
        :param reload_occurred: Set to True if we know that the packs have
 
1518
            already been reloaded, and we are failing because of an in-memory
 
1519
            cache miss. If set to True then we will ignore if a reload says
 
1520
            nothing has changed, because we assume it has already reloaded. If
 
1521
            False, then a reload with nothing changed will force an error.
 
1522
        :param exc_info: The original exception traceback, so if there is a
 
1523
            problem we can raise the original error (value from sys.exc_info())
 
1524
        """
 
1525
        BzrError.__init__(self)
 
1526
        self.context = context
 
1527
        self.reload_occurred = reload_occurred
 
1528
        self.exc_info = exc_info
 
1529
        self.orig_error = exc_info[1]
 
1530
        # TODO: The global error handler should probably treat this by
 
1531
        #       raising/printing the original exception with a bit about
 
1532
        #       RetryWithNewPacks also not being caught
 
1533
 
 
1534
 
 
1535
class RetryAutopack(RetryWithNewPacks):
 
1536
    """Raised when we are autopacking and we find a missing file.
 
1537
 
 
1538
    Meant as a signaling exception, to tell the autopack code it should try
 
1539
    again.
 
1540
    """
 
1541
 
 
1542
    internal_error = True
 
1543
 
 
1544
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1545
            " context: %(context)s %(orig_error)s")
 
1546
 
 
1547
 
1384
1548
class NoSuchExportFormat(BzrError):
1385
 
    
 
1549
 
1386
1550
    _fmt = "Export format %(format)r not supported"
1387
1551
 
1388
1552
    def __init__(self, format):
1391
1555
 
1392
1556
 
1393
1557
class TransportError(BzrError):
1394
 
    
 
1558
 
1395
1559
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1396
1560
 
1397
1561
    def __init__(self, msg=None, orig_error=None):
1424
1588
        self.details = details
1425
1589
 
1426
1590
 
 
1591
class UnexpectedProtocolVersionMarker(TransportError):
 
1592
 
 
1593
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1594
 
 
1595
    def __init__(self, marker):
 
1596
        self.marker = marker
 
1597
 
 
1598
 
 
1599
class UnknownSmartMethod(InternalBzrError):
 
1600
 
 
1601
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1602
 
 
1603
    def __init__(self, verb):
 
1604
        self.verb = verb
 
1605
 
 
1606
 
 
1607
class SmartMessageHandlerError(InternalBzrError):
 
1608
 
 
1609
    _fmt = ("The message handler raised an exception:\n"
 
1610
            "%(traceback_text)s")
 
1611
 
 
1612
    def __init__(self, exc_info):
 
1613
        import traceback
 
1614
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1615
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1616
        self.exc_info = exc_info
 
1617
        traceback_strings = traceback.format_exception(
 
1618
                self.exc_type, self.exc_value, self.exc_tb)
 
1619
        self.traceback_text = ''.join(traceback_strings)
 
1620
 
 
1621
 
1427
1622
# A set of semi-meaningful errors which can be thrown
1428
1623
class TransportNotPossible(TransportError):
1429
1624
 
1454
1649
            self.port = ':%s' % port
1455
1650
 
1456
1651
 
 
1652
# XXX: This is also used for unexpected end of file, which is different at the
 
1653
# TCP level from "connection reset".
1457
1654
class ConnectionReset(TransportError):
1458
1655
 
1459
1656
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1460
1657
 
1461
1658
 
 
1659
class ConnectionTimeout(ConnectionError):
 
1660
 
 
1661
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1662
 
 
1663
 
1462
1664
class InvalidRange(TransportError):
1463
1665
 
1464
1666
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1471
1673
 
1472
1674
class InvalidHttpResponse(TransportError):
1473
1675
 
1474
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1676
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1475
1677
 
1476
1678
    def __init__(self, path, msg, orig_error=None):
1477
1679
        self.path = path
 
1680
        if orig_error is None:
 
1681
            orig_error = ''
 
1682
        else:
 
1683
            # This is reached for obscure and unusual errors so we want to
 
1684
            # preserve as much info as possible to ease debug.
 
1685
            orig_error = ': %r' % (orig_error,)
1478
1686
        TransportError.__init__(self, msg, orig_error=orig_error)
1479
1687
 
1480
1688
 
 
1689
class CertificateError(TransportError):
 
1690
 
 
1691
    _fmt = "Certificate error: %(error)s"
 
1692
 
 
1693
    def __init__(self, error):
 
1694
        self.error = error
 
1695
 
 
1696
 
1481
1697
class InvalidHttpRange(InvalidHttpResponse):
1482
1698
 
1483
1699
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1487
1703
        InvalidHttpResponse.__init__(self, path, msg)
1488
1704
 
1489
1705
 
 
1706
class HttpBoundaryMissing(InvalidHttpResponse):
 
1707
    """A multipart response ends with no boundary marker.
 
1708
 
 
1709
    This is a special case caused by buggy proxies, described in
 
1710
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1711
    """
 
1712
 
 
1713
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1714
 
 
1715
    def __init__(self, path, msg):
 
1716
        InvalidHttpResponse.__init__(self, path, msg)
 
1717
 
 
1718
 
1490
1719
class InvalidHttpContentType(InvalidHttpResponse):
1491
1720
 
1492
1721
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1500
1729
 
1501
1730
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1502
1731
 
1503
 
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1732
    def __init__(self, source, target, is_permanent=False):
1504
1733
        self.source = source
1505
1734
        self.target = target
1506
1735
        if is_permanent:
1507
1736
            self.permanently = ' permanently'
1508
1737
        else:
1509
1738
            self.permanently = ''
1510
 
        self._qualified_proto = qual_proto
1511
1739
        TransportError.__init__(self)
1512
1740
 
1513
 
    def _requalify_url(self, url):
1514
 
        """Restore the qualified proto in front of the url"""
1515
 
        # When this exception is raised, source and target are in
1516
 
        # user readable format. But some transports may use a
1517
 
        # different proto (http+urllib:// will present http:// to
1518
 
        # the user. If a qualified proto is specified, the code
1519
 
        # trapping the exception can get the qualified urls to
1520
 
        # properly handle the redirection themself (creating a
1521
 
        # new transport object from the target url for example).
1522
 
        # But checking that the scheme of the original and
1523
 
        # redirected urls are the same can be tricky. (see the
1524
 
        # FIXME in BzrDir.open_from_transport for the unique use
1525
 
        # case so far).
1526
 
        if self._qualified_proto is None:
1527
 
            return url
1528
 
 
1529
 
        # The TODO related to NotBranchError mention that doing
1530
 
        # that kind of manipulation on the urls may not be the
1531
 
        # exception object job. On the other hand, this object is
1532
 
        # the interface between the code and the user so
1533
 
        # presenting the urls in different ways is indeed its
1534
 
        # job...
1535
 
        import urlparse
1536
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1537
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1538
 
                                   query, fragment))
1539
 
 
1540
 
    def get_source_url(self):
1541
 
        return self._requalify_url(self.source)
1542
 
 
1543
 
    def get_target_url(self):
1544
 
        return self._requalify_url(self.target)
1545
 
 
1546
1741
 
1547
1742
class TooManyRedirections(TransportError):
1548
1743
 
1554
1749
    _fmt = "Working tree has conflicts."
1555
1750
 
1556
1751
 
 
1752
class ConfigContentError(BzrError):
 
1753
 
 
1754
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1755
 
 
1756
    def __init__(self, filename):
 
1757
        BzrError.__init__(self)
 
1758
        self.filename = filename
 
1759
 
 
1760
 
1557
1761
class ParseConfigError(BzrError):
1558
1762
 
 
1763
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1764
 
1559
1765
    def __init__(self, errors, filename):
1560
 
        if filename is None:
1561
 
            filename = ""
1562
 
        message = "Error(s) parsing config file %s:\n%s" % \
1563
 
            (filename, ('\n'.join(e.message for e in errors)))
1564
 
        BzrError.__init__(self, message)
 
1766
        BzrError.__init__(self)
 
1767
        self.filename = filename
 
1768
        self.errors = '\n'.join(e.msg for e in errors)
 
1769
 
 
1770
 
 
1771
class ConfigOptionValueError(BzrError):
 
1772
 
 
1773
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
 
1774
            'See ``bzr help %(name)s``')
 
1775
 
 
1776
    def __init__(self, name, value):
 
1777
        BzrError.__init__(self, name=name, value=value)
1565
1778
 
1566
1779
 
1567
1780
class NoEmailInUsername(BzrError):
1575
1788
 
1576
1789
class SigningFailed(BzrError):
1577
1790
 
1578
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1791
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1579
1792
 
1580
1793
    def __init__(self, command_line):
1581
1794
        BzrError.__init__(self, command_line=command_line)
1582
1795
 
1583
1796
 
 
1797
class SignatureVerificationFailed(BzrError):
 
1798
 
 
1799
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1800
 
 
1801
    def __init__(self, error):
 
1802
        BzrError.__init__(self, error=error)
 
1803
 
 
1804
 
 
1805
class DependencyNotPresent(BzrError):
 
1806
 
 
1807
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1808
 
 
1809
    def __init__(self, library, error):
 
1810
        BzrError.__init__(self, library=library, error=error)
 
1811
 
 
1812
 
 
1813
class GpgmeNotInstalled(DependencyNotPresent):
 
1814
 
 
1815
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1816
 
 
1817
    def __init__(self, error):
 
1818
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1819
 
 
1820
 
1584
1821
class WorkingTreeNotRevision(BzrError):
1585
1822
 
1586
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1823
    _fmt = ("The working tree for %(basedir)s has changed since"
1587
1824
            " the last commit, but weave merge requires that it be"
1588
1825
            " unchanged")
1589
1826
 
1702
1939
        self.prefix = prefix
1703
1940
 
1704
1941
 
1705
 
class MalformedTransform(BzrError):
 
1942
class MalformedTransform(InternalBzrError):
1706
1943
 
1707
1944
    _fmt = "Tree transform is malformed %(conflicts)r"
1708
1945
 
1746
1983
    _fmt = "Moving the root directory is not supported at this time"
1747
1984
 
1748
1985
 
 
1986
class TransformRenameFailed(BzrError):
 
1987
 
 
1988
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1989
 
 
1990
    def __init__(self, from_path, to_path, why, errno):
 
1991
        self.from_path = from_path
 
1992
        self.to_path = to_path
 
1993
        self.why = why
 
1994
        self.errno = errno
 
1995
 
 
1996
 
1749
1997
class BzrMoveFailedError(BzrError):
1750
1998
 
1751
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1999
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2000
        "%(_has_extra)s%(extra)s")
1752
2001
 
1753
2002
    def __init__(self, from_path='', to_path='', extra=None):
 
2003
        from bzrlib.osutils import splitpath
1754
2004
        BzrError.__init__(self)
1755
2005
        if extra:
1756
 
            self.extra = ': ' + str(extra)
 
2006
            self.extra, self._has_extra = extra, ': '
1757
2007
        else:
1758
 
            self.extra = ''
 
2008
            self.extra = self._has_extra = ''
1759
2009
 
1760
2010
        has_from = len(from_path) > 0
1761
2011
        has_to = len(to_path) > 0
1762
2012
        if has_from:
1763
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
2013
            self.from_path = splitpath(from_path)[-1]
1764
2014
        else:
1765
2015
            self.from_path = ''
1766
2016
 
1767
2017
        if has_to:
1768
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
2018
            self.to_path = splitpath(to_path)[-1]
1769
2019
        else:
1770
2020
            self.to_path = ''
1771
2021
 
1782
2032
 
1783
2033
class BzrRenameFailedError(BzrMoveFailedError):
1784
2034
 
1785
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
2035
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2036
        "%(_has_extra)s%(extra)s")
1786
2037
 
1787
2038
    def __init__(self, from_path, to_path, extra=None):
1788
2039
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1789
2040
 
1790
 
class BzrRemoveChangedFilesError(BzrError):
1791
 
    """Used when user is trying to remove changed files."""
1792
 
 
1793
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1794
 
        "%(changes_as_text)s"
1795
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1796
 
 
1797
 
    def __init__(self, tree_delta):
1798
 
        BzrError.__init__(self)
1799
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1800
 
        #self.paths_as_string = '\n'.join(changed_files)
1801
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1802
 
 
1803
2041
 
1804
2042
class BzrBadParameterNotString(BzrBadParameter):
1805
2043
 
1808
2046
 
1809
2047
class BzrBadParameterMissing(BzrBadParameter):
1810
2048
 
1811
 
    _fmt = "Parameter $(param)s is required but not present."
 
2049
    _fmt = "Parameter %(param)s is required but not present."
1812
2050
 
1813
2051
 
1814
2052
class BzrBadParameterUnicode(BzrBadParameter):
1822
2060
    _fmt = "Parameter %(param)s contains a newline."
1823
2061
 
1824
2062
 
1825
 
class DependencyNotPresent(BzrError):
1826
 
 
1827
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1828
 
 
1829
 
    def __init__(self, library, error):
1830
 
        BzrError.__init__(self, library=library, error=error)
1831
 
 
1832
 
 
1833
2063
class ParamikoNotPresent(DependencyNotPresent):
1834
2064
 
1835
2065
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1854
2084
 
1855
2085
class BadConversionTarget(BzrError):
1856
2086
 
1857
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2087
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2088
            "    %(problem)s"
1858
2089
 
1859
 
    def __init__(self, problem, format):
 
2090
    def __init__(self, problem, format, from_format=None):
1860
2091
        BzrError.__init__(self)
1861
2092
        self.problem = problem
1862
2093
        self.format = format
 
2094
        self.from_format = from_format or '(unspecified)'
1863
2095
 
1864
2096
 
1865
2097
class NoDiffFound(BzrError):
1870
2102
        BzrError.__init__(self, path)
1871
2103
 
1872
2104
 
 
2105
class ExecutableMissing(BzrError):
 
2106
 
 
2107
    _fmt = "%(exe_name)s could not be found on this machine"
 
2108
 
 
2109
    def __init__(self, exe_name):
 
2110
        BzrError.__init__(self, exe_name=exe_name)
 
2111
 
 
2112
 
1873
2113
class NoDiff(BzrError):
1874
2114
 
1875
2115
    _fmt = "Diff is not installed on this machine: %(msg)s"
1894
2134
    _fmt = """This tree contains left-over files from a failed operation.
1895
2135
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1896
2136
    keep, and delete it when you are done."""
1897
 
    
 
2137
 
1898
2138
    def __init__(self, limbo_dir):
1899
2139
       BzrError.__init__(self)
1900
2140
       self.limbo_dir = limbo_dir
1933
2173
 
1934
2174
class OutOfDateTree(BzrError):
1935
2175
 
1936
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2176
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1937
2177
 
1938
 
    def __init__(self, tree):
 
2178
    def __init__(self, tree, more=None):
 
2179
        if more is None:
 
2180
            more = ''
 
2181
        else:
 
2182
            more = ' ' + more
1939
2183
        BzrError.__init__(self)
1940
2184
        self.tree = tree
 
2185
        self.more = more
1941
2186
 
1942
2187
 
1943
2188
class PublicBranchOutOfDate(BzrError):
1963
2208
    _fmt = "Format error in conflict listings"
1964
2209
 
1965
2210
 
 
2211
class CorruptDirstate(BzrError):
 
2212
 
 
2213
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2214
            "Error: %(description)s")
 
2215
 
 
2216
    def __init__(self, dirstate_path, description):
 
2217
        BzrError.__init__(self)
 
2218
        self.dirstate_path = dirstate_path
 
2219
        self.description = description
 
2220
 
 
2221
 
1966
2222
class CorruptRepository(BzrError):
1967
2223
 
1968
2224
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1970
2226
 
1971
2227
    def __init__(self, repo):
1972
2228
        BzrError.__init__(self)
1973
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2229
        self.repo_path = repo.user_url
 
2230
 
 
2231
 
 
2232
class InconsistentDelta(BzrError):
 
2233
    """Used when we get a delta that is not valid."""
 
2234
 
 
2235
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2236
            " %(file_id)r\nreason: %(reason)s")
 
2237
 
 
2238
    def __init__(self, path, file_id, reason):
 
2239
        BzrError.__init__(self)
 
2240
        self.path = path
 
2241
        self.file_id = file_id
 
2242
        self.reason = reason
 
2243
 
 
2244
 
 
2245
class InconsistentDeltaDelta(InconsistentDelta):
 
2246
    """Used when we get a delta that is not valid."""
 
2247
 
 
2248
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2249
            "\nreason: %(reason)s")
 
2250
 
 
2251
    def __init__(self, delta, reason):
 
2252
        BzrError.__init__(self)
 
2253
        self.delta = delta
 
2254
        self.reason = reason
1974
2255
 
1975
2256
 
1976
2257
class UpgradeRequired(BzrError):
1982
2263
        self.path = path
1983
2264
 
1984
2265
 
 
2266
class RepositoryUpgradeRequired(UpgradeRequired):
 
2267
 
 
2268
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2269
 
 
2270
 
 
2271
class RichRootUpgradeRequired(UpgradeRequired):
 
2272
 
 
2273
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2274
           " a format which supports rich roots.")
 
2275
 
 
2276
 
1985
2277
class LocalRequiresBoundBranch(BzrError):
1986
2278
 
1987
2279
    _fmt = "Cannot perform local-only commits on unbound branches."
1988
2280
 
1989
2281
 
1990
 
class MissingProgressBarFinish(BzrError):
1991
 
 
1992
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1993
 
 
1994
 
 
1995
 
class InvalidProgressBarType(BzrError):
1996
 
 
1997
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1998
 
            " is not a supported type Select one of: %(valid_types)s")
1999
 
 
2000
 
    def __init__(self, bar_type, valid_types):
2001
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2002
 
 
2003
 
 
2004
2282
class UnsupportedOperation(BzrError):
2005
2283
 
2006
2284
    _fmt = ("The method %(mname)s is not supported on"
2022
2300
    """
2023
2301
 
2024
2302
 
 
2303
class GhostTagsNotSupported(BzrError):
 
2304
 
 
2305
    _fmt = "Ghost tags not supported by format %(format)r."
 
2306
 
 
2307
    def __init__(self, format):
 
2308
        self.format = format
 
2309
 
 
2310
 
2025
2311
class BinaryFile(BzrError):
2026
 
    
 
2312
 
2027
2313
    _fmt = "File is binary but should be text."
2028
2314
 
2029
2315
 
2049
2335
 
2050
2336
 
2051
2337
class NotABundle(BzrError):
2052
 
    
 
2338
 
2053
2339
    _fmt = "Not a bzr revision-bundle: %(text)r"
2054
2340
 
2055
2341
    def __init__(self, text):
2057
2343
        self.text = text
2058
2344
 
2059
2345
 
2060
 
class BadBundle(BzrError): 
2061
 
    
 
2346
class BadBundle(BzrError):
 
2347
 
2062
2348
    _fmt = "Bad bzr revision-bundle: %(text)r"
2063
2349
 
2064
2350
    def __init__(self, text):
2066
2352
        self.text = text
2067
2353
 
2068
2354
 
2069
 
class MalformedHeader(BadBundle): 
2070
 
    
 
2355
class MalformedHeader(BadBundle):
 
2356
 
2071
2357
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2072
2358
 
2073
2359
 
2074
 
class MalformedPatches(BadBundle): 
2075
 
    
 
2360
class MalformedPatches(BadBundle):
 
2361
 
2076
2362
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2077
2363
 
2078
2364
 
2079
 
class MalformedFooter(BadBundle): 
2080
 
    
 
2365
class MalformedFooter(BadBundle):
 
2366
 
2081
2367
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2082
2368
 
2083
2369
 
2084
2370
class UnsupportedEOLMarker(BadBundle):
2085
 
    
2086
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2371
 
 
2372
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
2087
2373
 
2088
2374
    def __init__(self):
2089
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2375
        # XXX: BadBundle's constructor assumes there's explanatory text,
2090
2376
        # but for this there is not
2091
2377
        BzrError.__init__(self)
2092
2378
 
2093
2379
 
2094
2380
class IncompatibleBundleFormat(BzrError):
2095
 
    
 
2381
 
2096
2382
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2097
2383
 
2098
2384
    def __init__(self, bundle_format, other):
2102
2388
 
2103
2389
 
2104
2390
class BadInventoryFormat(BzrError):
2105
 
    
 
2391
 
2106
2392
    _fmt = "Root class for inventory serialization errors"
2107
2393
 
2108
2394
 
2127
2413
        self.transport = transport
2128
2414
 
2129
2415
 
2130
 
class NoSmartServer(NotBranchError):
2131
 
 
2132
 
    _fmt = "No smart server available at %(url)s"
2133
 
 
2134
 
    def __init__(self, url):
2135
 
        self.url = url
2136
 
 
2137
 
 
2138
2416
class UnknownSSH(BzrError):
2139
2417
 
2140
2418
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2150
2428
            " Please set BZR_SSH environment variable.")
2151
2429
 
2152
2430
 
 
2431
class GhostRevisionsHaveNoRevno(BzrError):
 
2432
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2433
 
 
2434
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2435
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2436
 
 
2437
    def __init__(self, revision_id, ghost_revision_id):
 
2438
        self.revision_id = revision_id
 
2439
        self.ghost_revision_id = ghost_revision_id
 
2440
 
 
2441
 
2153
2442
class GhostRevisionUnusableHere(BzrError):
2154
2443
 
2155
2444
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2233
2522
        self.patch_type = patch_type
2234
2523
 
2235
2524
 
 
2525
class TargetNotBranch(BzrError):
 
2526
    """A merge directive's target branch is required, but isn't a branch"""
 
2527
 
 
2528
    _fmt = ("Your branch does not have all of the revisions required in "
 
2529
            "order to merge this merge directive and the target "
 
2530
            "location specified in the merge directive is not a branch: "
 
2531
            "%(location)s.")
 
2532
 
 
2533
    def __init__(self, location):
 
2534
        BzrError.__init__(self)
 
2535
        self.location = location
 
2536
 
 
2537
 
2236
2538
class UnsupportedInventoryKind(BzrError):
2237
 
    
 
2539
 
2238
2540
    _fmt = """Unsupported entry kind %(kind)s"""
2239
2541
 
2240
2542
    def __init__(self, kind):
2252
2554
 
2253
2555
 
2254
2556
class SubsumeTargetNeedsUpgrade(BzrError):
2255
 
    
 
2557
 
2256
2558
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2257
2559
 
2258
2560
    def __init__(self, other_tree):
2281
2583
class TagsNotSupported(BzrError):
2282
2584
 
2283
2585
    _fmt = ("Tags not supported by %(branch)s;"
2284
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2586
            " you may be able to use bzr upgrade.")
2285
2587
 
2286
2588
    def __init__(self, branch):
2287
2589
        self.branch = branch
2288
2590
 
2289
 
        
 
2591
 
2290
2592
class TagAlreadyExists(BzrError):
2291
2593
 
2292
2594
    _fmt = "Tag %(tag_name)s already exists."
2297
2599
 
2298
2600
class MalformedBugIdentifier(BzrError):
2299
2601
 
2300
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2602
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2603
            'See "bzr help bugs" for more information on this feature.')
2301
2604
 
2302
2605
    def __init__(self, bug_id, reason):
2303
2606
        self.bug_id = bug_id
2324
2627
        self.branch = branch
2325
2628
 
2326
2629
 
 
2630
class InvalidLineInBugsProperty(BzrError):
 
2631
 
 
2632
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2633
 
 
2634
    def __init__(self, line):
 
2635
        self.line = line
 
2636
 
 
2637
 
 
2638
class InvalidBugStatus(BzrError):
 
2639
 
 
2640
    _fmt = ("Invalid bug status: '%(status)s'")
 
2641
 
 
2642
    def __init__(self, status):
 
2643
        self.status = status
 
2644
 
 
2645
 
2327
2646
class UnexpectedSmartServerResponse(BzrError):
2328
2647
 
2329
2648
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2332
2651
        self.response_tuple = response_tuple
2333
2652
 
2334
2653
 
 
2654
class ErrorFromSmartServer(BzrError):
 
2655
    """An error was received from a smart server.
 
2656
 
 
2657
    :seealso: UnknownErrorFromSmartServer
 
2658
    """
 
2659
 
 
2660
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2661
 
 
2662
    internal_error = True
 
2663
 
 
2664
    def __init__(self, error_tuple):
 
2665
        self.error_tuple = error_tuple
 
2666
        try:
 
2667
            self.error_verb = error_tuple[0]
 
2668
        except IndexError:
 
2669
            self.error_verb = None
 
2670
        self.error_args = error_tuple[1:]
 
2671
 
 
2672
 
 
2673
class UnknownErrorFromSmartServer(BzrError):
 
2674
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2675
    error.
 
2676
 
 
2677
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2678
    distinguish between the following two cases:
 
2679
 
 
2680
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2681
      and so should provoke a traceback to the user.
 
2682
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2683
      translated.  This is probably because the server sent us garbage, and
 
2684
      should not provoke a traceback.
 
2685
    """
 
2686
 
 
2687
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2688
 
 
2689
    internal_error = False
 
2690
 
 
2691
    def __init__(self, error_from_smart_server):
 
2692
        """Constructor.
 
2693
 
 
2694
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2695
        """
 
2696
        self.error_from_smart_server = error_from_smart_server
 
2697
        self.error_tuple = error_from_smart_server.error_tuple
 
2698
 
 
2699
 
2335
2700
class ContainerError(BzrError):
2336
2701
    """Base class of container errors."""
2337
2702
 
2339
2704
class UnknownContainerFormatError(ContainerError):
2340
2705
 
2341
2706
    _fmt = "Unrecognised container format: %(container_format)r"
2342
 
    
 
2707
 
2343
2708
    def __init__(self, container_format):
2344
2709
        self.container_format = container_format
2345
2710
 
2378
2743
    _fmt = "Container has multiple records with the same name: %(name)s"
2379
2744
 
2380
2745
    def __init__(self, name):
2381
 
        self.name = name
 
2746
        self.name = name.decode("utf-8")
2382
2747
 
2383
2748
 
2384
2749
class NoDestinationAddress(InternalBzrError):
2409
2774
 
2410
2775
class NoMailAddressSpecified(BzrError):
2411
2776
 
2412
 
    _fmt = "No mail-to address specified."
2413
 
 
2414
 
 
2415
 
class UnknownMailClient(BzrError):
2416
 
 
2417
 
    _fmt = "Unknown mail client: %(mail_client)s"
2418
 
 
2419
 
    def __init__(self, mail_client):
2420
 
        BzrError.__init__(self, mail_client=mail_client)
 
2777
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2421
2778
 
2422
2779
 
2423
2780
class MailClientNotFound(BzrError):
2448
2805
 
2449
2806
    def __init__(self, bzrdir):
2450
2807
        import bzrlib.urlutils as urlutils
2451
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2808
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2452
2809
                                                    'ascii')
2453
2810
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2454
2811
 
2455
2812
 
 
2813
class UnsyncedBranches(BzrDirError):
 
2814
 
 
2815
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2816
            " bzr help sync-for-reconfigure.")
 
2817
 
 
2818
    def __init__(self, bzrdir, target_branch):
 
2819
        BzrDirError.__init__(self, bzrdir)
 
2820
        import bzrlib.urlutils as urlutils
 
2821
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2822
                                                        'ascii')
 
2823
 
 
2824
 
2456
2825
class AlreadyBranch(BzrDirError):
2457
2826
 
2458
2827
    _fmt = "'%(display_url)s' is already a branch."
2473
2842
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2474
2843
 
2475
2844
 
 
2845
class AlreadyUsingShared(BzrDirError):
 
2846
 
 
2847
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2848
 
 
2849
 
 
2850
class AlreadyStandalone(BzrDirError):
 
2851
 
 
2852
    _fmt = "'%(display_url)s' is already standalone."
 
2853
 
 
2854
 
 
2855
class AlreadyWithTrees(BzrDirError):
 
2856
 
 
2857
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2858
            "working trees.")
 
2859
 
 
2860
 
 
2861
class AlreadyWithNoTrees(BzrDirError):
 
2862
 
 
2863
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2864
            "working trees.")
 
2865
 
 
2866
 
2476
2867
class ReconfigurationNotSupported(BzrDirError):
2477
2868
 
2478
2869
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2485
2876
 
2486
2877
class UncommittedChanges(BzrError):
2487
2878
 
2488
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2489
 
 
2490
 
    def __init__(self, tree):
2491
 
        import bzrlib.urlutils as urlutils
2492
 
        display_url = urlutils.unescape_for_display(
2493
 
            tree.bzrdir.root_transport.base, 'ascii')
2494
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2879
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2880
            ' (See bzr status).%(more)s')
 
2881
 
 
2882
    def __init__(self, tree, more=None):
 
2883
        if more is None:
 
2884
            more = ''
 
2885
        else:
 
2886
            more = ' ' + more
 
2887
        import bzrlib.urlutils as urlutils
 
2888
        user_url = getattr(tree, "user_url", None)
 
2889
        if user_url is None:
 
2890
            display_url = str(tree)
 
2891
        else:
 
2892
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2893
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2894
 
 
2895
 
 
2896
class StoringUncommittedNotSupported(BzrError):
 
2897
 
 
2898
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2899
            ' changes.')
 
2900
 
 
2901
    def __init__(self, branch):
 
2902
        import bzrlib.urlutils as urlutils
 
2903
        user_url = getattr(branch, "user_url", None)
 
2904
        if user_url is None:
 
2905
            display_url = str(branch)
 
2906
        else:
 
2907
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2908
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2909
 
 
2910
 
 
2911
class ShelvedChanges(UncommittedChanges):
 
2912
 
 
2913
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2914
            ' (See bzr shelve --list).%(more)s')
2495
2915
 
2496
2916
 
2497
2917
class MissingTemplateVariable(BzrError):
2502
2922
        self.name = name
2503
2923
 
2504
2924
 
 
2925
class NoTemplate(BzrError):
 
2926
 
 
2927
    _fmt = 'No template specified.'
 
2928
 
 
2929
 
2505
2930
class UnableCreateSymlink(BzrError):
2506
2931
 
2507
2932
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2515
2940
                path_str = repr(path)
2516
2941
            path_str += ' '
2517
2942
        self.path_str = path_str
 
2943
 
 
2944
 
 
2945
class UnsupportedTimezoneFormat(BzrError):
 
2946
 
 
2947
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2948
            'options are "utc", "original", "local".')
 
2949
 
 
2950
    def __init__(self, timezone):
 
2951
        self.timezone = timezone
 
2952
 
 
2953
 
 
2954
class CommandAvailableInPlugin(StandardError):
 
2955
 
 
2956
    internal_error = False
 
2957
 
 
2958
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2959
 
 
2960
        self.plugin_metadata = plugin_metadata
 
2961
        self.cmd_name = cmd_name
 
2962
        self.provider = provider
 
2963
 
 
2964
    def __str__(self):
 
2965
 
 
2966
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2967
                'However, the following official plugin provides this command: %s\n'
 
2968
                'You can install it by going to: %s'
 
2969
                % (self.cmd_name, self.plugin_metadata['name'],
 
2970
                    self.plugin_metadata['url']))
 
2971
 
 
2972
        return _fmt
 
2973
 
 
2974
 
 
2975
class NoPluginAvailable(BzrError):
 
2976
    pass
 
2977
 
 
2978
 
 
2979
class UnableEncodePath(BzrError):
 
2980
 
 
2981
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2982
            'user encoding %(user_encoding)s')
 
2983
 
 
2984
    def __init__(self, path, kind):
 
2985
        from bzrlib.osutils import get_user_encoding
 
2986
        self.path = path
 
2987
        self.kind = kind
 
2988
        self.user_encoding = get_user_encoding()
 
2989
 
 
2990
 
 
2991
class NoSuchConfig(BzrError):
 
2992
 
 
2993
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2994
 
 
2995
    def __init__(self, config_id):
 
2996
        BzrError.__init__(self, config_id=config_id)
 
2997
 
 
2998
 
 
2999
class NoSuchConfigOption(BzrError):
 
3000
 
 
3001
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
3002
 
 
3003
    def __init__(self, option_name):
 
3004
        BzrError.__init__(self, option_name=option_name)
 
3005
 
 
3006
 
 
3007
class NoSuchAlias(BzrError):
 
3008
 
 
3009
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
3010
 
 
3011
    def __init__(self, alias_name):
 
3012
        BzrError.__init__(self, alias_name=alias_name)
 
3013
 
 
3014
 
 
3015
class DirectoryLookupFailure(BzrError):
 
3016
    """Base type for lookup errors."""
 
3017
 
 
3018
    pass
 
3019
 
 
3020
 
 
3021
class InvalidLocationAlias(DirectoryLookupFailure):
 
3022
 
 
3023
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
3024
 
 
3025
    def __init__(self, alias_name):
 
3026
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
3027
 
 
3028
 
 
3029
class UnsetLocationAlias(DirectoryLookupFailure):
 
3030
 
 
3031
    _fmt = 'No %(alias_name)s location assigned.'
 
3032
 
 
3033
    def __init__(self, alias_name):
 
3034
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
3035
 
 
3036
 
 
3037
class CannotBindAddress(BzrError):
 
3038
 
 
3039
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
3040
 
 
3041
    def __init__(self, host, port, orig_error):
 
3042
        # nb: in python2.4 socket.error doesn't have a useful repr
 
3043
        BzrError.__init__(self, host=host, port=port,
 
3044
            orig_error=repr(orig_error.args))
 
3045
 
 
3046
 
 
3047
class UnknownRules(BzrError):
 
3048
 
 
3049
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
3050
 
 
3051
    def __init__(self, unknowns):
 
3052
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
3053
 
 
3054
 
 
3055
class TipChangeRejected(BzrError):
 
3056
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3057
    explicitly abort a change to a branch tip.
 
3058
    """
 
3059
 
 
3060
    _fmt = u"Tip change rejected: %(msg)s"
 
3061
 
 
3062
    def __init__(self, msg):
 
3063
        self.msg = msg
 
3064
 
 
3065
 
 
3066
class ShelfCorrupt(BzrError):
 
3067
 
 
3068
    _fmt = "Shelf corrupt."
 
3069
 
 
3070
 
 
3071
class DecompressCorruption(BzrError):
 
3072
 
 
3073
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3074
 
 
3075
    def __init__(self, orig_error=None):
 
3076
        if orig_error is not None:
 
3077
            self.orig_error = ", %s" % (orig_error,)
 
3078
        else:
 
3079
            self.orig_error = ""
 
3080
        BzrError.__init__(self)
 
3081
 
 
3082
 
 
3083
class NoSuchShelfId(BzrError):
 
3084
 
 
3085
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3086
 
 
3087
    def __init__(self, shelf_id):
 
3088
        BzrError.__init__(self, shelf_id=shelf_id)
 
3089
 
 
3090
 
 
3091
class InvalidShelfId(BzrError):
 
3092
 
 
3093
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3094
 
 
3095
    def __init__(self, invalid_id):
 
3096
        BzrError.__init__(self, invalid_id=invalid_id)
 
3097
 
 
3098
 
 
3099
class JailBreak(BzrError):
 
3100
 
 
3101
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3102
 
 
3103
    def __init__(self, url):
 
3104
        BzrError.__init__(self, url=url)
 
3105
 
 
3106
 
 
3107
class UserAbort(BzrError):
 
3108
 
 
3109
    _fmt = 'The user aborted the operation.'
 
3110
 
 
3111
 
 
3112
class MustHaveWorkingTree(BzrError):
 
3113
 
 
3114
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3115
 
 
3116
    def __init__(self, format, url):
 
3117
        BzrError.__init__(self, format=format, url=url)
 
3118
 
 
3119
 
 
3120
class NoSuchView(BzrError):
 
3121
    """A view does not exist.
 
3122
    """
 
3123
 
 
3124
    _fmt = u"No such view: %(view_name)s."
 
3125
 
 
3126
    def __init__(self, view_name):
 
3127
        self.view_name = view_name
 
3128
 
 
3129
 
 
3130
class ViewsNotSupported(BzrError):
 
3131
    """Views are not supported by a tree format.
 
3132
    """
 
3133
 
 
3134
    _fmt = ("Views are not supported by %(tree)s;"
 
3135
            " use 'bzr upgrade' to change your tree to a later format.")
 
3136
 
 
3137
    def __init__(self, tree):
 
3138
        self.tree = tree
 
3139
 
 
3140
 
 
3141
class FileOutsideView(BzrError):
 
3142
 
 
3143
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3144
            '%(view_str)s')
 
3145
 
 
3146
    def __init__(self, file_name, view_files):
 
3147
        self.file_name = file_name
 
3148
        self.view_str = ", ".join(view_files)
 
3149
 
 
3150
 
 
3151
class UnresumableWriteGroup(BzrError):
 
3152
 
 
3153
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3154
            "%(write_groups)r: %(reason)s")
 
3155
 
 
3156
    internal_error = True
 
3157
 
 
3158
    def __init__(self, repository, write_groups, reason):
 
3159
        self.repository = repository
 
3160
        self.write_groups = write_groups
 
3161
        self.reason = reason
 
3162
 
 
3163
 
 
3164
class UnsuspendableWriteGroup(BzrError):
 
3165
 
 
3166
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3167
 
 
3168
    internal_error = True
 
3169
 
 
3170
    def __init__(self, repository):
 
3171
        self.repository = repository
 
3172
 
 
3173
 
 
3174
class LossyPushToSameVCS(BzrError):
 
3175
 
 
3176
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3177
            "%(target_branch)r that are in the same VCS.")
 
3178
 
 
3179
    internal_error = True
 
3180
 
 
3181
    def __init__(self, source_branch, target_branch):
 
3182
        self.source_branch = source_branch
 
3183
        self.target_branch = target_branch
 
3184
 
 
3185
 
 
3186
class NoRoundtrippingSupport(BzrError):
 
3187
 
 
3188
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3189
            "%(target_branch)r.")
 
3190
 
 
3191
    internal_error = True
 
3192
 
 
3193
    def __init__(self, source_branch, target_branch):
 
3194
        self.source_branch = source_branch
 
3195
        self.target_branch = target_branch
 
3196
 
 
3197
 
 
3198
class FileTimestampUnavailable(BzrError):
 
3199
 
 
3200
    _fmt = "The filestamp for %(path)s is not available."
 
3201
 
 
3202
    internal_error = True
 
3203
 
 
3204
    def __init__(self, path):
 
3205
        self.path = path
 
3206
 
 
3207
 
 
3208
class NoColocatedBranchSupport(BzrError):
 
3209
 
 
3210
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3211
 
 
3212
    def __init__(self, bzrdir):
 
3213
        self.bzrdir = bzrdir
 
3214
 
 
3215
 
 
3216
class NoWhoami(BzrError):
 
3217
 
 
3218
    _fmt = ('Unable to determine your name.\n'
 
3219
        "Please, set your name with the 'whoami' command.\n"
 
3220
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3221
 
 
3222
 
 
3223
class InvalidPattern(BzrError):
 
3224
 
 
3225
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3226
 
 
3227
    def __init__(self, msg):
 
3228
        self.msg = msg
 
3229
 
 
3230
 
 
3231
class RecursiveBind(BzrError):
 
3232
 
 
3233
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3234
        'Please use `bzr unbind` to fix.')
 
3235
 
 
3236
    def __init__(self, branch_url):
 
3237
        self.branch_url = branch_url
 
3238
 
 
3239
 
 
3240
# FIXME: I would prefer to define the config related exception classes in
 
3241
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3242
class OptionExpansionLoop(BzrError):
 
3243
 
 
3244
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3245
 
 
3246
    def __init__(self, string, refs):
 
3247
        self.string = string
 
3248
        self.refs = '->'.join(refs)
 
3249
 
 
3250
 
 
3251
class ExpandingUnknownOption(BzrError):
 
3252
 
 
3253
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3254
 
 
3255
    def __init__(self, name, string):
 
3256
        self.name = name
 
3257
        self.string = string
 
3258
 
 
3259
 
 
3260
class NoCompatibleInter(BzrError):
 
3261
 
 
3262
    _fmt = ('No compatible object available for operations from %(source)r '
 
3263
            'to %(target)r.')
 
3264
 
 
3265
    def __init__(self, source, target):
 
3266
        self.source = source
 
3267
        self.target = target
 
3268
 
 
3269
 
 
3270
class HpssVfsRequestNotAllowed(BzrError):
 
3271
 
 
3272
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3273
            "%(method)s, %(arguments)s.")
 
3274
 
 
3275
    def __init__(self, method, arguments):
 
3276
        self.method = method
 
3277
        self.arguments = arguments
 
3278
 
 
3279
 
 
3280
class UnsupportedKindChange(BzrError):
 
3281
 
 
3282
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3283
            "%(path)s not supported by format %(format)r")
 
3284
 
 
3285
    def __init__(self, path, from_kind, to_kind, format):
 
3286
        self.path = path
 
3287
        self.from_kind = from_kind
 
3288
        self.to_kind = to_kind
 
3289
        self.format = format
 
3290
 
 
3291
 
 
3292
class MissingFeature(BzrError):
 
3293
 
 
3294
    _fmt = ("Missing feature %(feature)s not provided by this "
 
3295
            "version of Bazaar or any plugin.")
 
3296
 
 
3297
    def __init__(self, feature):
 
3298
        self.feature = feature
 
3299
 
 
3300
 
 
3301
class PatchSyntax(BzrError):
 
3302
    """Base class for patch syntax errors."""
 
3303
 
 
3304
 
 
3305
class BinaryFiles(BzrError):
 
3306
 
 
3307
    _fmt = 'Binary files section encountered.'
 
3308
 
 
3309
    def __init__(self, orig_name, mod_name):
 
3310
        self.orig_name = orig_name
 
3311
        self.mod_name = mod_name
 
3312
 
 
3313
 
 
3314
class MalformedPatchHeader(PatchSyntax):
 
3315
 
 
3316
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3317
 
 
3318
    def __init__(self, desc, line):
 
3319
        self.desc = desc
 
3320
        self.line = line
 
3321
 
 
3322
 
 
3323
class MalformedHunkHeader(PatchSyntax):
 
3324
 
 
3325
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3326
 
 
3327
    def __init__(self, desc, line):
 
3328
        self.desc = desc
 
3329
        self.line = line
 
3330
 
 
3331
 
 
3332
class MalformedLine(PatchSyntax):
 
3333
 
 
3334
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3335
 
 
3336
    def __init__(self, desc, line):
 
3337
        self.desc = desc
 
3338
        self.line = line
 
3339
 
 
3340
 
 
3341
class PatchConflict(BzrError):
 
3342
 
 
3343
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3344
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3345
 
 
3346
    def __init__(self, line_no, orig_line, patch_line):
 
3347
        self.line_no = line_no
 
3348
        self.orig_line = orig_line.rstrip('\n')
 
3349
        self.patch_line = patch_line.rstrip('\n')
 
3350
 
 
3351
 
 
3352
class FeatureAlreadyRegistered(BzrError):
 
3353
 
 
3354
    _fmt = 'The feature %(feature)s has already been registered.'
 
3355
 
 
3356
    def __init__(self, feature):
 
3357
        self.feature = feature
 
3358
 
 
3359
 
 
3360
class ChangesAlreadyStored(BzrCommandError):
 
3361
 
 
3362
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
3363
            ' stores uncommitted changes.')