← 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: 2007-10-29 08:34:38 UTC
  • mto: (2535.4.22 streaming-smart-fetch)
  • mto: This revision was merged to the branch mainline in revision 2981.
  • Revision ID: andrew.bennetts@canonical.com-20071029083438-ke1vsv97dvgrvup5
Improve some docstrings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2013, 2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
 
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
 
21
33
 
22
34
# TODO: is there any value in providing the .args field used by standard
23
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
24
36
# to me.
25
37
 
26
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
27
39
# constructed to make sure it will succeed.  But that says nothing about
28
40
# exceptions that are never raised.
29
41
 
43
55
    Base class for errors raised by bzrlib.
44
56
 
45
57
    :cvar internal_error: if True this was probably caused by a bzr bug and
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.)
 
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.)
49
61
 
50
62
    :cvar _fmt: Format string to display the error; this is expanded
51
 
        by the instance's dict.
 
63
    by the instance's dict.
52
64
    """
53
 
 
 
65
    
54
66
    internal_error = False
55
67
 
56
68
    def __init__(self, msg=None, **kwds):
61
73
        arguments can be given.  The first is for generic "user" errors which
62
74
        are not intended to be caught and so do not need a specific subclass.
63
75
        The second case is for use with subclasses that provide a _fmt format
64
 
        string to print the arguments.
 
76
        string to print the arguments.  
65
77
 
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
 
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 
69
81
        parameters.
70
82
 
71
83
        :param msg: If given, this is the literal complete text for the error,
72
 
           not subject to expansion. 'msg' is used instead of 'message' because
73
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
84
        not subject to expansion.
74
85
        """
75
86
        StandardError.__init__(self)
76
87
        if msg is not None:
82
93
            for key, value in kwds.items():
83
94
                setattr(self, key, value)
84
95
 
85
 
    def _format(self):
 
96
    def __str__(self):
86
97
        s = getattr(self, '_preformatted_string', None)
87
98
        if s is not None:
88
 
            # contains a preformatted message
89
 
            return s
 
99
            # contains a preformatted message; must be cast to plain str
 
100
            return str(s)
90
101
        try:
91
102
            fmt = self._get_format_string()
92
103
            if fmt:
93
104
                d = dict(self.__dict__)
 
105
                # special case: python2.5 puts the 'message' attribute in a
 
106
                # slot, so it isn't seen in __dict__
 
107
                d['message'] = getattr(self, 'message', 'no message')
94
108
                s = fmt % d
95
109
                # __str__() should always return a 'str' object
96
110
                # never a 'unicode' object.
 
111
                if isinstance(s, unicode):
 
112
                    return s.encode('utf8')
97
113
                return s
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' \
 
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)
 
120
 
 
121
    def _get_format_string(self):
 
122
        """Return format string for this exception or None"""
 
123
        fmt = getattr(self, '_fmt', None)
 
124
        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' \
103
133
            % (self.__class__.__name__,
104
134
               self.__dict__,
105
135
               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))
130
 
 
131
 
    def _get_format_string(self):
132
 
        """Return format string for this exception or None"""
133
 
        fmt = getattr(self, '_fmt', None)
134
 
        if fmt is not None:
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__
 
136
               )
142
137
 
143
138
 
144
139
class InternalBzrError(BzrError):
152
147
    internal_error = True
153
148
 
154
149
 
 
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
 
155
183
class AlreadyBuilding(BzrError):
156
 
 
 
184
    
157
185
    _fmt = "The tree builder is already building a tree."
158
186
 
159
187
 
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
 
 
167
188
class BzrCheckError(InternalBzrError):
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
 
189
    
 
190
    _fmt = "Internal check failed: %(message)s"
 
191
 
 
192
    def __init__(self, message):
 
193
        BzrError.__init__(self)
 
194
        self.message = message
184
195
 
185
196
 
186
197
class DisabledMethod(InternalBzrError):
214
225
 
215
226
 
216
227
class InvalidEntryName(InternalBzrError):
217
 
 
 
228
    
218
229
    _fmt = "Invalid entry name: %(name)s"
219
230
 
220
231
    def __init__(self, name):
223
234
 
224
235
 
225
236
class InvalidRevisionNumber(BzrError):
226
 
 
 
237
    
227
238
    _fmt = "Invalid revision number %(revno)s"
228
239
 
229
240
    def __init__(self, revno):
241
252
        self.revision_id = revision_id
242
253
        self.branch = branch
243
254
 
244
 
 
245
255
class ReservedId(BzrError):
246
256
 
247
257
    _fmt = "Reserved revision-id {%(revision_id)s}"
253
263
class RootMissing(InternalBzrError):
254
264
 
255
265
    _fmt = ("The root entry of a tree must be the first entry supplied to "
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)
 
266
        "record_entry_contents.")
267
267
 
268
268
 
269
269
class NoHelpTopic(BzrError):
278
278
class NoSuchId(BzrError):
279
279
 
280
280
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
281
 
 
 
281
    
282
282
    def __init__(self, tree, file_id):
283
283
        BzrError.__init__(self)
284
284
        self.file_id = file_id
294
294
        BzrError.__init__(self, repository=repository, file_id=file_id)
295
295
 
296
296
 
297
 
class NotStacked(BranchError):
298
 
 
299
 
    _fmt = "The branch '%(branch)s' is not stacked."
300
 
 
301
 
 
302
297
class InventoryModified(InternalBzrError):
303
298
 
304
299
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
311
306
class NoWorkingTree(BzrError):
312
307
 
313
308
    _fmt = 'No WorkingTree exists for "%(base)s".'
314
 
 
 
309
    
315
310
    def __init__(self, base):
316
311
        BzrError.__init__(self)
317
312
        self.base = base
348
343
    # are not intended to be caught anyway.  UI code need not subclass
349
344
    # BzrCommandError, and non-UI code should not throw a subclass of
350
345
    # BzrCommandError.  ADHB 20051211
 
346
    def __init__(self, msg):
 
347
        # Object.__str__() must return a real string
 
348
        # returning a Unicode string is a python error.
 
349
        if isinstance(msg, unicode):
 
350
            self.msg = msg.encode('utf8')
 
351
        else:
 
352
            self.msg = msg
 
353
 
 
354
    def __str__(self):
 
355
        return self.msg
351
356
 
352
357
 
353
358
class NotWriteLocked(BzrError):
426
431
    def __init__(self, name, value):
427
432
        BzrError.__init__(self, name=name, value=value)
428
433
 
429
 
 
 
434
    
430
435
class StrictCommitFailed(BzrError):
431
436
 
432
437
    _fmt = "Commit refused because there are unknown files in the tree"
435
440
# XXX: Should be unified with TransportError; they seem to represent the
436
441
# same thing
437
442
# RBC 20060929: I think that unifiying with TransportError would be a mistake
438
 
# - this is finer than a TransportError - and more useful as such. It
 
443
# - this is finer than a TransportError - and more useful as such. It 
439
444
# differentiates between 'transport has failed' and 'operation on a transport
440
445
# has failed.'
441
446
class PathError(BzrError):
442
 
 
 
447
    
443
448
    _fmt = "Generic path error: %(path)r%(extra)s)"
444
449
 
445
450
    def __init__(self, path, extra=None):
465
470
    """Used when renaming and both source and dest exist."""
466
471
 
467
472
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
468
 
            " (Use --after to tell bzr about a rename that has already"
469
 
            " happened)%(extra)s")
 
473
            "%(extra)s")
470
474
 
471
475
    def __init__(self, source, dest, extra=None):
472
476
        BzrError.__init__(self)
493
497
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
494
498
 
495
499
 
496
 
class HardLinkNotSupported(PathError):
497
 
 
498
 
    _fmt = 'Hard-linking "%(path)s" is not supported'
499
 
 
500
 
 
501
500
class ReadingCompleted(InternalBzrError):
502
 
 
 
501
    
503
502
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
504
503
            "called upon it - the request has been completed and no more "
505
504
            "data may be read.")
525
524
 
526
525
class InvalidURLJoin(PathError):
527
526
 
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
 
527
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
528
 
 
529
    def __init__(self, msg, base, args):
 
530
        PathError.__init__(self, base, msg)
 
531
        self.args = [base] + list(args)
557
532
 
558
533
 
559
534
class UnknownHook(BzrError):
570
545
 
571
546
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
572
547
 
573
 
    def __init__(self, url, extra=""):
 
548
    def __init__(self, url, extra):
574
549
        PathError.__init__(self, url, extra=extra)
575
550
 
576
551
 
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
 
 
609
552
class ReadError(PathError):
610
 
 
 
553
    
611
554
    _fmt = """Error reading from %(path)r."""
612
555
 
613
556
 
629
572
 
630
573
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
631
574
 
632
 
    internal_error = False
 
575
    internal_error = True
633
576
 
634
577
    def __init__(self, path, base, extra=None):
635
578
        BzrError.__init__(self)
648
591
 
649
592
# TODO: This is given a URL; we try to unescape it but doing that from inside
650
593
# the exception object is a bit undesirable.
651
 
# TODO: Probably this behavior of should be a common superclass
 
594
# TODO: Probably this behavior of should be a common superclass 
652
595
class NotBranchError(PathError):
653
596
 
654
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
597
    _fmt = 'Not a branch: "%(path)s".'
655
598
 
656
 
    def __init__(self, path, detail=None, bzrdir=None):
 
599
    def __init__(self, path):
657
600
       import bzrlib.urlutils as urlutils
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)
 
601
       self.path = urlutils.unescape_for_display(path, 'ascii')
692
602
 
693
603
 
694
604
class NoSubmitBranch(PathError):
700
610
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
701
611
 
702
612
 
703
 
class AlreadyControlDirError(PathError):
704
 
 
705
 
    _fmt = 'A control directory already exists: "%(path)s".'
706
 
 
707
 
 
708
613
class AlreadyBranchError(PathError):
709
614
 
710
615
    _fmt = 'Already a branch: "%(path)s".'
711
616
 
712
617
 
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
 
 
727
618
class BranchExistsWithoutWorkingTree(PathError):
728
619
 
729
620
    _fmt = 'Directory contains a branch, but no working tree \
758
649
        self.path = bzrdir.transport.clone('..').base
759
650
 
760
651
 
 
652
class FileInWrongBranch(BzrError):
 
653
 
 
654
    _fmt = 'File "%(path)s" in not in branch %(branch_base)s.'
 
655
 
 
656
    def __init__(self, branch, path):
 
657
        BzrError.__init__(self)
 
658
        self.branch = branch
 
659
        self.branch_base = branch.base
 
660
        self.path = path
 
661
 
 
662
 
761
663
class UnsupportedFormatError(BzrError):
762
664
 
763
665
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
764
666
 
765
667
 
766
668
class UnknownFormatError(BzrError):
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
 
669
    
 
670
    _fmt = "Unknown branch format: %(format)r"
773
671
 
774
672
 
775
673
class IncompatibleFormat(BzrError):
776
 
 
 
674
    
777
675
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
778
676
 
779
677
    def __init__(self, format, bzrdir_format):
782
680
        self.bzrdir = bzrdir_format
783
681
 
784
682
 
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
 
 
797
683
class IncompatibleRepositories(BzrError):
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)
 
684
 
 
685
    _fmt = "Repository %(target)s is not compatible with repository"\
 
686
        " %(source)s"
 
687
 
 
688
    def __init__(self, source, target):
 
689
        BzrError.__init__(self, target=target, source=source)
814
690
 
815
691
 
816
692
class IncompatibleRevision(BzrError):
817
 
 
 
693
    
818
694
    _fmt = "Revision is not compatible with %(repo_format)s"
819
695
 
820
696
    def __init__(self, repo_format):
831
707
        """Construct a new AlreadyVersionedError.
832
708
 
833
709
        :param path: This is the path which is versioned,
834
 
            which should be in a user friendly form.
 
710
        which should be in a user friendly form.
835
711
        :param context_info: If given, this is information about the context,
836
 
            which could explain why this is expected to not be versioned.
 
712
        which could explain why this is expected to not be versioned.
837
713
        """
838
714
        BzrError.__init__(self)
839
715
        self.path = path
852
728
        """Construct a new NotVersionedError.
853
729
 
854
730
        :param path: This is the path which is not versioned,
855
 
            which should be in a user friendly form.
 
731
        which should be in a user friendly form.
856
732
        :param context_info: If given, this is information about the context,
857
 
            which could explain why this is expected to be versioned.
 
733
        which could explain why this is expected to be versioned.
858
734
        """
859
735
        BzrError.__init__(self)
860
736
        self.path = path
903
779
        BzrError.__init__(self, filename=filename, kind=kind)
904
780
 
905
781
 
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
 
 
917
782
class ForbiddenControlFileError(BzrError):
918
783
 
919
784
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
928
793
    # original exception is available as e.original_error
929
794
    #
930
795
    # New code should prefer to raise specific subclasses
931
 
    def __init__(self, msg):
932
 
        self.msg = msg
 
796
    def __init__(self, message):
 
797
        # Python 2.5 uses a slot for StandardError.message,
 
798
        # so use a different variable name.  We now work around this in
 
799
        # BzrError.__str__, but this member name is kept for compatability.
 
800
        self.msg = message
933
801
 
934
802
 
935
803
class LockActive(LockError):
969
837
        self.obj = obj
970
838
 
971
839
 
 
840
class ReadOnlyLockError(LockError):
 
841
 
 
842
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
843
 
 
844
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
845
    def __init__(self, fname, msg):
 
846
        LockError.__init__(self, '')
 
847
        self.fname = fname
 
848
        self.msg = msg
 
849
 
 
850
 
972
851
class LockFailed(LockError):
973
852
 
974
853
    internal_error = False
1018
897
 
1019
898
class LockContention(LockError):
1020
899
 
1021
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
900
    _fmt = 'Could not acquire lock "%(lock)s"'
 
901
    # TODO: show full url for lock, combining the transport and relative
 
902
    # bits?
1022
903
 
1023
904
    internal_error = False
1024
905
 
1025
 
    def __init__(self, lock, msg=''):
 
906
    def __init__(self, lock):
1026
907
        self.lock = lock
1027
 
        self.msg = msg
1028
908
 
1029
909
 
1030
910
class LockBroken(LockError):
1051
931
        self.target = target
1052
932
 
1053
933
 
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
 
 
1066
934
class LockNotHeld(LockError):
1067
935
 
1068
936
    _fmt = "Lock not held: %(lock)s"
1107
975
        BzrError.__init__(self, files=files, files_str=files_str)
1108
976
 
1109
977
 
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
 
 
1119
978
class BadCommitMessageEncoding(BzrError):
1120
979
 
1121
980
    _fmt = 'The specified commit message contains characters unsupported by '\
1150
1009
        BzrError.__init__(self, branch=branch, revision=revision)
1151
1010
 
1152
1011
 
 
1012
# zero_ninetyone: this exception is no longer raised and should be removed
 
1013
class NotLeftParentDescendant(InternalBzrError):
 
1014
 
 
1015
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
1016
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
1017
 
 
1018
    def __init__(self, branch, old_revision, new_revision):
 
1019
        BzrError.__init__(self, branch_location=branch.base,
 
1020
                          old_revision=old_revision,
 
1021
                          new_revision=new_revision)
 
1022
 
 
1023
 
1153
1024
class RangeInChangeOption(BzrError):
1154
1025
 
1155
1026
    _fmt = "Option --change does not accept revision ranges"
1165
1036
 
1166
1037
class NoSuchRevisionInTree(NoSuchRevision):
1167
1038
    """When using Tree.revision_tree, and the revision is not accessible."""
1168
 
 
 
1039
    
1169
1040
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1170
1041
 
1171
1042
    def __init__(self, tree, revision_id):
1176
1047
 
1177
1048
class InvalidRevisionSpec(BzrError):
1178
1049
 
1179
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1180
 
            " %(branch_url)s%(extra)s")
 
1050
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1051
            " %(branch)s%(extra)s")
1181
1052
 
1182
1053
    def __init__(self, spec, branch, extra=None):
1183
1054
        BzrError.__init__(self, branch=branch, spec=spec)
1184
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1185
1055
        if extra:
1186
1056
            self.extra = '\n' + str(extra)
1187
1057
        else:
1188
1058
            self.extra = ''
1189
1059
 
1190
1060
 
 
1061
class HistoryMissing(BzrError):
 
1062
 
 
1063
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1064
 
 
1065
 
1191
1066
class AppendRevisionsOnlyViolation(BzrError):
1192
1067
 
1193
1068
    _fmt = ('Operation denied because it would change the main history,'
1203
1078
class DivergedBranches(BzrError):
1204
1079
 
1205
1080
    _fmt = ("These branches have diverged."
1206
 
            " Use the missing command to see how.\n"
1207
 
            "Use the merge command to reconcile them.")
 
1081
            " Use the merge command to reconcile them.")
1208
1082
 
1209
1083
    def __init__(self, branch1, branch2):
1210
1084
        self.branch1 = branch1
1225
1099
            " no merge base revision was specified.")
1226
1100
 
1227
1101
 
1228
 
class CannotReverseCherrypick(BzrError):
1229
 
 
1230
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1231
 
            ' or diff3.')
1232
 
 
1233
 
 
1234
1102
class NoCommonAncestor(BzrError):
1235
 
 
 
1103
    
1236
1104
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1237
1105
 
1238
1106
    def __init__(self, revision_a, revision_b):
1258
1126
            not_ancestor_id=not_ancestor_id)
1259
1127
 
1260
1128
 
1261
 
class NoCommits(BranchError):
 
1129
class InstallFailed(BzrError):
 
1130
 
 
1131
    def __init__(self, revisions):
 
1132
        revision_str = ", ".join(str(r) for r in revisions)
 
1133
        msg = "Could not install revisions:\n%s" % revision_str
 
1134
        BzrError.__init__(self, msg)
 
1135
        self.revisions = revisions
 
1136
 
 
1137
 
 
1138
class AmbiguousBase(BzrError):
 
1139
 
 
1140
    def __init__(self, bases):
 
1141
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1142
                DeprecationWarning)
 
1143
        msg = ("The correct base is unclear, because %s are all equally close"
 
1144
                % ", ".join(bases))
 
1145
        BzrError.__init__(self, msg)
 
1146
        self.bases = bases
 
1147
 
 
1148
 
 
1149
class NoCommits(BzrError):
1262
1150
 
1263
1151
    _fmt = "Branch %(branch)s has no commits."
1264
1152
 
 
1153
    def __init__(self, branch):
 
1154
        BzrError.__init__(self, branch=branch)
 
1155
 
1265
1156
 
1266
1157
class UnlistableStore(BzrError):
1267
1158
 
1279
1170
class BoundBranchOutOfDate(BzrError):
1280
1171
 
1281
1172
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1282
 
            " %(master)s.%(extra_help)s")
 
1173
            " %(master)s.")
1283
1174
 
1284
1175
    def __init__(self, branch, master):
1285
1176
        BzrError.__init__(self)
1286
1177
        self.branch = branch
1287
1178
        self.master = master
1288
 
        self.extra_help = ''
1289
 
 
1290
 
 
 
1179
 
 
1180
        
1291
1181
class CommitToDoubleBoundBranch(BzrError):
1292
1182
 
1293
1183
    _fmt = ("Cannot commit to branch %(branch)s."
1323
1213
 
1324
1214
class WeaveError(BzrError):
1325
1215
 
1326
 
    _fmt = "Error in processing weave: %(msg)s"
 
1216
    _fmt = "Error in processing weave: %(message)s"
1327
1217
 
1328
 
    def __init__(self, msg=None):
 
1218
    def __init__(self, message=None):
1329
1219
        BzrError.__init__(self)
1330
 
        self.msg = msg
 
1220
        self.message = message
1331
1221
 
1332
1222
 
1333
1223
class WeaveRevisionAlreadyPresent(WeaveError):
1362
1252
 
1363
1253
class WeaveParentMismatch(WeaveError):
1364
1254
 
1365
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1366
 
 
 
1255
    _fmt = "Parents are mismatched between two revisions."
 
1256
    
1367
1257
 
1368
1258
class WeaveInvalidChecksum(WeaveError):
1369
1259
 
1370
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1260
    _fmt = "Text did not match it's checksum: %(message)s"
1371
1261
 
1372
1262
 
1373
1263
class WeaveTextDiffers(WeaveError):
1395
1285
 
1396
1286
 
1397
1287
class VersionedFileError(BzrError):
1398
 
 
 
1288
    
1399
1289
    _fmt = "Versioned file error"
1400
1290
 
1401
1291
 
1402
1292
class RevisionNotPresent(VersionedFileError):
1403
 
 
 
1293
    
1404
1294
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1405
1295
 
1406
1296
    def __init__(self, revision_id, file_id):
1410
1300
 
1411
1301
 
1412
1302
class RevisionAlreadyPresent(VersionedFileError):
1413
 
 
 
1303
    
1414
1304
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1415
1305
 
1416
1306
    def __init__(self, revision_id, file_id):
1421
1311
 
1422
1312
class VersionedFileInvalidChecksum(VersionedFileError):
1423
1313
 
1424
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1314
    _fmt = "Text did not match its checksum: %(message)s"
1425
1315
 
1426
1316
 
1427
1317
class KnitError(InternalBzrError):
1428
 
 
 
1318
    
1429
1319
    _fmt = "Knit error"
1430
1320
 
1431
1321
 
1439
1329
        self.how = how
1440
1330
 
1441
1331
 
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
 
 
1457
1332
class KnitDataStreamIncompatible(KnitError):
1458
 
    # Not raised anymore, as we can convert data streams.  In future we may
1459
 
    # need it again for more exotic cases, so we're keeping it around for now.
1460
1333
 
1461
1334
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1462
1335
 
1463
1336
    def __init__(self, stream_format, target_format):
1464
1337
        self.stream_format = stream_format
1465
1338
        self.target_format = target_format
1466
 
 
1467
 
 
1468
 
class KnitDataStreamUnknown(KnitError):
1469
 
    # Indicates a data stream we don't know how to handle.
1470
 
 
1471
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1472
 
 
1473
 
    def __init__(self, stream_format):
1474
 
        self.stream_format = stream_format
1475
 
 
 
1339
        
1476
1340
 
1477
1341
class KnitHeaderError(KnitError):
1478
1342
 
1488
1352
 
1489
1353
    Currently only 'fulltext' and 'line-delta' are supported.
1490
1354
    """
1491
 
 
 
1355
    
1492
1356
    _fmt = ("Knit index %(filename)s does not have a known method"
1493
1357
            " in options: %(options)r")
1494
1358
 
1498
1362
        self.options = options
1499
1363
 
1500
1364
 
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
 
 
1548
1365
class NoSuchExportFormat(BzrError):
1549
 
 
 
1366
    
1550
1367
    _fmt = "Export format %(format)r not supported"
1551
1368
 
1552
1369
    def __init__(self, format):
1555
1372
 
1556
1373
 
1557
1374
class TransportError(BzrError):
1558
 
 
 
1375
    
1559
1376
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1560
1377
 
1561
1378
    def __init__(self, msg=None, orig_error=None):
1588
1405
        self.details = details
1589
1406
 
1590
1407
 
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
 
 
1622
1408
# A set of semi-meaningful errors which can be thrown
1623
1409
class TransportNotPossible(TransportError):
1624
1410
 
1649
1435
            self.port = ':%s' % port
1650
1436
 
1651
1437
 
1652
 
# XXX: This is also used for unexpected end of file, which is different at the
1653
 
# TCP level from "connection reset".
1654
1438
class ConnectionReset(TransportError):
1655
1439
 
1656
1440
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1657
1441
 
1658
1442
 
1659
 
class ConnectionTimeout(ConnectionError):
1660
 
 
1661
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1662
 
 
1663
 
 
1664
1443
class InvalidRange(TransportError):
1665
1444
 
1666
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1667
 
 
1668
 
    def __init__(self, path, offset, msg=None):
1669
 
        TransportError.__init__(self, msg)
 
1445
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1446
    
 
1447
    def __init__(self, path, offset):
 
1448
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1449
                                       % (path, offset)))
1670
1450
        self.path = path
1671
1451
        self.offset = offset
1672
1452
 
1673
1453
 
1674
1454
class InvalidHttpResponse(TransportError):
1675
1455
 
1676
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1456
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1677
1457
 
1678
1458
    def __init__(self, path, msg, orig_error=None):
1679
1459
        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,)
1686
1460
        TransportError.__init__(self, msg, orig_error=orig_error)
1687
1461
 
1688
1462
 
1689
1463
class InvalidHttpRange(InvalidHttpResponse):
1690
1464
 
1691
1465
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1692
 
 
 
1466
    
1693
1467
    def __init__(self, path, range, msg):
1694
1468
        self.range = range
1695
1469
        InvalidHttpResponse.__init__(self, path, msg)
1696
1470
 
1697
1471
 
1698
 
class HttpBoundaryMissing(InvalidHttpResponse):
1699
 
    """A multipart response ends with no boundary marker.
1700
 
 
1701
 
    This is a special case caused by buggy proxies, described in
1702
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1703
 
    """
1704
 
 
1705
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1706
 
 
1707
 
    def __init__(self, path, msg):
1708
 
        InvalidHttpResponse.__init__(self, path, msg)
1709
 
 
1710
 
 
1711
1472
class InvalidHttpContentType(InvalidHttpResponse):
1712
1473
 
1713
1474
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1714
 
 
 
1475
    
1715
1476
    def __init__(self, path, ctype, msg):
1716
1477
        self.ctype = ctype
1717
1478
        InvalidHttpResponse.__init__(self, path, msg)
1721
1482
 
1722
1483
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1723
1484
 
1724
 
    def __init__(self, source, target, is_permanent=False):
 
1485
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1725
1486
        self.source = source
1726
1487
        self.target = target
1727
 
        if is_permanent:
 
1488
        if is_permament:
1728
1489
            self.permanently = ' permanently'
1729
1490
        else:
1730
1491
            self.permanently = ''
 
1492
        self.is_permament = is_permament
 
1493
        self._qualified_proto = qual_proto
1731
1494
        TransportError.__init__(self)
1732
1495
 
 
1496
    def _requalify_url(self, url):
 
1497
        """Restore the qualified proto in front of the url"""
 
1498
        # When this exception is raised, source and target are in
 
1499
        # user readable format. But some transports may use a
 
1500
        # different proto (http+urllib:// will present http:// to
 
1501
        # the user. If a qualified proto is specified, the code
 
1502
        # trapping the exception can get the qualified urls to
 
1503
        # properly handle the redirection themself (creating a
 
1504
        # new transport object from the target url for example).
 
1505
        # But checking that the scheme of the original and
 
1506
        # redirected urls are the same can be tricky. (see the
 
1507
        # FIXME in BzrDir.open_from_transport for the unique use
 
1508
        # case so far).
 
1509
        if self._qualified_proto is None:
 
1510
            return url
 
1511
 
 
1512
        # The TODO related to NotBranchError mention that doing
 
1513
        # that kind of manipulation on the urls may not be the
 
1514
        # exception object job. On the other hand, this object is
 
1515
        # the interface between the code and the user so
 
1516
        # presenting the urls in different ways is indeed its
 
1517
        # job...
 
1518
        import urlparse
 
1519
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1520
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1521
                                   query, fragment))
 
1522
 
 
1523
    def get_source_url(self):
 
1524
        return self._requalify_url(self.source)
 
1525
 
 
1526
    def get_target_url(self):
 
1527
        return self._requalify_url(self.target)
 
1528
 
1733
1529
 
1734
1530
class TooManyRedirections(TransportError):
1735
1531
 
1736
1532
    _fmt = "Too many redirections"
1737
1533
 
1738
 
 
1739
1534
class ConflictsInTree(BzrError):
1740
1535
 
1741
1536
    _fmt = "Working tree has conflicts."
1742
1537
 
1743
1538
 
1744
 
class ConfigContentError(BzrError):
1745
 
 
1746
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1747
 
 
1748
 
    def __init__(self, filename):
1749
 
        BzrError.__init__(self)
1750
 
        self.filename = filename
1751
 
 
1752
 
 
1753
1539
class ParseConfigError(BzrError):
1754
1540
 
1755
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1756
 
 
1757
1541
    def __init__(self, errors, filename):
1758
 
        BzrError.__init__(self)
1759
 
        self.filename = filename
1760
 
        self.errors = '\n'.join(e.msg for e in errors)
1761
 
 
1762
 
 
1763
 
class ConfigOptionValueError(BzrError):
1764
 
 
1765
 
    _fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
1766
 
            'See ``bzr help %(name)s``')
1767
 
 
1768
 
    def __init__(self, name, value):
1769
 
        BzrError.__init__(self, name=name, value=value)
 
1542
        if filename is None:
 
1543
            filename = ""
 
1544
        message = "Error(s) parsing config file %s:\n%s" % \
 
1545
            (filename, ('\n'.join(e.message for e in errors)))
 
1546
        BzrError.__init__(self, message)
1770
1547
 
1771
1548
 
1772
1549
class NoEmailInUsername(BzrError):
1780
1557
 
1781
1558
class SigningFailed(BzrError):
1782
1559
 
1783
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1560
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1784
1561
 
1785
1562
    def __init__(self, command_line):
1786
1563
        BzrError.__init__(self, command_line=command_line)
1787
1564
 
1788
1565
 
1789
 
class SignatureVerificationFailed(BzrError):
1790
 
 
1791
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1792
 
 
1793
 
    def __init__(self, error):
1794
 
        BzrError.__init__(self, error=error)
1795
 
 
1796
 
 
1797
 
class DependencyNotPresent(BzrError):
1798
 
 
1799
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1800
 
 
1801
 
    def __init__(self, library, error):
1802
 
        BzrError.__init__(self, library=library, error=error)
1803
 
 
1804
 
 
1805
 
class GpgmeNotInstalled(DependencyNotPresent):
1806
 
 
1807
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1808
 
 
1809
 
    def __init__(self, error):
1810
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1811
 
 
1812
 
 
1813
1566
class WorkingTreeNotRevision(BzrError):
1814
1567
 
1815
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1568
    _fmt = ("The working tree for %(basedir)s has changed since" 
1816
1569
            " the last commit, but weave merge requires that it be"
1817
1570
            " unchanged")
1818
1571
 
1931
1684
        self.prefix = prefix
1932
1685
 
1933
1686
 
1934
 
class MalformedTransform(InternalBzrError):
 
1687
class MalformedTransform(BzrError):
1935
1688
 
1936
1689
    _fmt = "Tree transform is malformed %(conflicts)r"
1937
1690
 
1975
1728
    _fmt = "Moving the root directory is not supported at this time"
1976
1729
 
1977
1730
 
1978
 
class TransformRenameFailed(BzrError):
1979
 
 
1980
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1981
 
 
1982
 
    def __init__(self, from_path, to_path, why, errno):
1983
 
        self.from_path = from_path
1984
 
        self.to_path = to_path
1985
 
        self.why = why
1986
 
        self.errno = errno
1987
 
 
1988
 
 
1989
1731
class BzrMoveFailedError(BzrError):
1990
1732
 
1991
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1992
 
        "%(_has_extra)s%(extra)s")
 
1733
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1993
1734
 
1994
1735
    def __init__(self, from_path='', to_path='', extra=None):
1995
 
        from bzrlib.osutils import splitpath
1996
1736
        BzrError.__init__(self)
1997
1737
        if extra:
1998
 
            self.extra, self._has_extra = extra, ': '
 
1738
            self.extra = ': ' + str(extra)
1999
1739
        else:
2000
 
            self.extra = self._has_extra = ''
 
1740
            self.extra = ''
2001
1741
 
2002
1742
        has_from = len(from_path) > 0
2003
1743
        has_to = len(to_path) > 0
2004
1744
        if has_from:
2005
 
            self.from_path = splitpath(from_path)[-1]
 
1745
            self.from_path = osutils.splitpath(from_path)[-1]
2006
1746
        else:
2007
1747
            self.from_path = ''
2008
1748
 
2009
1749
        if has_to:
2010
 
            self.to_path = splitpath(to_path)[-1]
 
1750
            self.to_path = osutils.splitpath(to_path)[-1]
2011
1751
        else:
2012
1752
            self.to_path = ''
2013
1753
 
2024
1764
 
2025
1765
class BzrRenameFailedError(BzrMoveFailedError):
2026
1766
 
2027
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2028
 
        "%(_has_extra)s%(extra)s")
 
1767
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2029
1768
 
2030
1769
    def __init__(self, from_path, to_path, extra=None):
2031
1770
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2032
1771
 
 
1772
class BzrRemoveChangedFilesError(BzrError):
 
1773
    """Used when user is trying to remove changed files."""
 
1774
 
 
1775
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1776
        "%(changes_as_text)s"
 
1777
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1778
 
 
1779
    def __init__(self, tree_delta):
 
1780
        BzrError.__init__(self)
 
1781
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1782
        #self.paths_as_string = '\n'.join(changed_files)
 
1783
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1784
 
2033
1785
 
2034
1786
class BzrBadParameterNotString(BzrBadParameter):
2035
1787
 
2038
1790
 
2039
1791
class BzrBadParameterMissing(BzrBadParameter):
2040
1792
 
2041
 
    _fmt = "Parameter %(param)s is required but not present."
 
1793
    _fmt = "Parameter $(param)s is required but not present."
2042
1794
 
2043
1795
 
2044
1796
class BzrBadParameterUnicode(BzrBadParameter):
2052
1804
    _fmt = "Parameter %(param)s contains a newline."
2053
1805
 
2054
1806
 
 
1807
class DependencyNotPresent(BzrError):
 
1808
 
 
1809
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1810
 
 
1811
    def __init__(self, library, error):
 
1812
        BzrError.__init__(self, library=library, error=error)
 
1813
 
 
1814
 
2055
1815
class ParamikoNotPresent(DependencyNotPresent):
2056
1816
 
2057
1817
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2076
1836
 
2077
1837
class BadConversionTarget(BzrError):
2078
1838
 
2079
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2080
 
            "    %(problem)s"
 
1839
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2081
1840
 
2082
 
    def __init__(self, problem, format, from_format=None):
 
1841
    def __init__(self, problem, format):
2083
1842
        BzrError.__init__(self)
2084
1843
        self.problem = problem
2085
1844
        self.format = format
2086
 
        self.from_format = from_format or '(unspecified)'
2087
 
 
2088
 
 
2089
 
class NoDiffFound(BzrError):
2090
 
 
2091
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2092
 
 
2093
 
    def __init__(self, path):
2094
 
        BzrError.__init__(self, path)
2095
 
 
2096
 
 
2097
 
class ExecutableMissing(BzrError):
2098
 
 
2099
 
    _fmt = "%(exe_name)s could not be found on this machine"
2100
 
 
2101
 
    def __init__(self, exe_name):
2102
 
        BzrError.__init__(self, exe_name=exe_name)
2103
1845
 
2104
1846
 
2105
1847
class NoDiff(BzrError):
2126
1868
    _fmt = """This tree contains left-over files from a failed operation.
2127
1869
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2128
1870
    keep, and delete it when you are done."""
2129
 
 
 
1871
    
2130
1872
    def __init__(self, limbo_dir):
2131
1873
       BzrError.__init__(self)
2132
1874
       self.limbo_dir = limbo_dir
2155
1897
 
2156
1898
class ImmortalPendingDeletion(BzrError):
2157
1899
 
2158
 
    _fmt = ("Unable to delete transform temporary directory "
2159
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2160
 
    "contains any files you wish to keep, and delete it when you are done.")
 
1900
    _fmt = """Unable to delete transform temporary directory
 
1901
    %(pending_deletion)s.  Please examine %(pending_deletions)s to see if it
 
1902
    contains any files you wish to keep, and delete it when you are done."""
2161
1903
 
2162
1904
    def __init__(self, pending_deletion):
2163
1905
       BzrError.__init__(self, pending_deletion=pending_deletion)
2165
1907
 
2166
1908
class OutOfDateTree(BzrError):
2167
1909
 
2168
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1910
    _fmt = "Working tree is out of date, please run 'bzr update'."
2169
1911
 
2170
 
    def __init__(self, tree, more=None):
2171
 
        if more is None:
2172
 
            more = ''
2173
 
        else:
2174
 
            more = ' ' + more
 
1912
    def __init__(self, tree):
2175
1913
        BzrError.__init__(self)
2176
1914
        self.tree = tree
2177
 
        self.more = more
2178
1915
 
2179
1916
 
2180
1917
class PublicBranchOutOfDate(BzrError):
2200
1937
    _fmt = "Format error in conflict listings"
2201
1938
 
2202
1939
 
2203
 
class CorruptDirstate(BzrError):
2204
 
 
2205
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2206
 
            "Error: %(description)s")
2207
 
 
2208
 
    def __init__(self, dirstate_path, description):
2209
 
        BzrError.__init__(self)
2210
 
        self.dirstate_path = dirstate_path
2211
 
        self.description = description
2212
 
 
2213
 
 
2214
1940
class CorruptRepository(BzrError):
2215
1941
 
2216
1942
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2218
1944
 
2219
1945
    def __init__(self, repo):
2220
1946
        BzrError.__init__(self)
2221
 
        self.repo_path = repo.user_url
2222
 
 
2223
 
 
2224
 
class InconsistentDelta(BzrError):
2225
 
    """Used when we get a delta that is not valid."""
2226
 
 
2227
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2228
 
            " %(file_id)r\nreason: %(reason)s")
2229
 
 
2230
 
    def __init__(self, path, file_id, reason):
2231
 
        BzrError.__init__(self)
2232
 
        self.path = path
2233
 
        self.file_id = file_id
2234
 
        self.reason = reason
2235
 
 
2236
 
 
2237
 
class InconsistentDeltaDelta(InconsistentDelta):
2238
 
    """Used when we get a delta that is not valid."""
2239
 
 
2240
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2241
 
            "\nreason: %(reason)s")
2242
 
 
2243
 
    def __init__(self, delta, reason):
2244
 
        BzrError.__init__(self)
2245
 
        self.delta = delta
2246
 
        self.reason = reason
 
1947
        self.repo_path = repo.bzrdir.root_transport.base
2247
1948
 
2248
1949
 
2249
1950
class UpgradeRequired(BzrError):
2255
1956
        self.path = path
2256
1957
 
2257
1958
 
2258
 
class RepositoryUpgradeRequired(UpgradeRequired):
2259
 
 
2260
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2261
 
 
2262
 
 
2263
 
class RichRootUpgradeRequired(UpgradeRequired):
2264
 
 
2265
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2266
 
           " a format which supports rich roots.")
2267
 
 
2268
 
 
2269
1959
class LocalRequiresBoundBranch(BzrError):
2270
1960
 
2271
1961
    _fmt = "Cannot perform local-only commits on unbound branches."
2272
1962
 
2273
1963
 
 
1964
class MissingProgressBarFinish(BzrError):
 
1965
 
 
1966
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1967
 
 
1968
 
 
1969
class InvalidProgressBarType(BzrError):
 
1970
 
 
1971
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1972
            " is not a supported type Select one of: %(valid_types)s")
 
1973
 
 
1974
    def __init__(self, bar_type, valid_types):
 
1975
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1976
 
 
1977
 
2274
1978
class UnsupportedOperation(BzrError):
2275
1979
 
2276
1980
    _fmt = ("The method %(mname)s is not supported on"
2292
1996
    """
2293
1997
 
2294
1998
 
2295
 
class GhostTagsNotSupported(BzrError):
2296
 
 
2297
 
    _fmt = "Ghost tags not supported by format %(format)r."
2298
 
 
2299
 
    def __init__(self, format):
2300
 
        self.format = format
2301
 
 
2302
 
 
2303
1999
class BinaryFile(BzrError):
2304
 
 
 
2000
    
2305
2001
    _fmt = "File is binary but should be text."
2306
2002
 
2307
2003
 
2327
2023
 
2328
2024
 
2329
2025
class NotABundle(BzrError):
2330
 
 
 
2026
    
2331
2027
    _fmt = "Not a bzr revision-bundle: %(text)r"
2332
2028
 
2333
2029
    def __init__(self, text):
2335
2031
        self.text = text
2336
2032
 
2337
2033
 
2338
 
class BadBundle(BzrError):
2339
 
 
 
2034
class BadBundle(BzrError): 
 
2035
    
2340
2036
    _fmt = "Bad bzr revision-bundle: %(text)r"
2341
2037
 
2342
2038
    def __init__(self, text):
2344
2040
        self.text = text
2345
2041
 
2346
2042
 
2347
 
class MalformedHeader(BadBundle):
2348
 
 
 
2043
class MalformedHeader(BadBundle): 
 
2044
    
2349
2045
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2350
2046
 
2351
2047
 
2352
 
class MalformedPatches(BadBundle):
2353
 
 
 
2048
class MalformedPatches(BadBundle): 
 
2049
    
2354
2050
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2355
2051
 
2356
2052
 
2357
 
class MalformedFooter(BadBundle):
2358
 
 
 
2053
class MalformedFooter(BadBundle): 
 
2054
    
2359
2055
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2360
2056
 
2361
2057
 
2362
2058
class UnsupportedEOLMarker(BadBundle):
2363
 
 
2364
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2059
    
 
2060
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2365
2061
 
2366
2062
    def __init__(self):
2367
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2063
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2368
2064
        # but for this there is not
2369
2065
        BzrError.__init__(self)
2370
2066
 
2371
2067
 
2372
2068
class IncompatibleBundleFormat(BzrError):
2373
 
 
 
2069
    
2374
2070
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2375
2071
 
2376
2072
    def __init__(self, bundle_format, other):
2380
2076
 
2381
2077
 
2382
2078
class BadInventoryFormat(BzrError):
2383
 
 
 
2079
    
2384
2080
    _fmt = "Root class for inventory serialization errors"
2385
2081
 
2386
2082
 
2405
2101
        self.transport = transport
2406
2102
 
2407
2103
 
 
2104
class NoSmartServer(NotBranchError):
 
2105
 
 
2106
    _fmt = "No smart server available at %(url)s"
 
2107
 
 
2108
    def __init__(self, url):
 
2109
        self.url = url
 
2110
 
 
2111
 
2408
2112
class UnknownSSH(BzrError):
2409
2113
 
2410
2114
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2420
2124
            " Please set BZR_SSH environment variable.")
2421
2125
 
2422
2126
 
2423
 
class GhostRevisionsHaveNoRevno(BzrError):
2424
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2425
 
 
2426
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2427
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2428
 
 
2429
 
    def __init__(self, revision_id, ghost_revision_id):
2430
 
        self.revision_id = revision_id
2431
 
        self.ghost_revision_id = ghost_revision_id
2432
 
 
2433
 
 
2434
2127
class GhostRevisionUnusableHere(BzrError):
2435
2128
 
2436
2129
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2514
2207
        self.patch_type = patch_type
2515
2208
 
2516
2209
 
2517
 
class TargetNotBranch(BzrError):
2518
 
    """A merge directive's target branch is required, but isn't a branch"""
2519
 
 
2520
 
    _fmt = ("Your branch does not have all of the revisions required in "
2521
 
            "order to merge this merge directive and the target "
2522
 
            "location specified in the merge directive is not a branch: "
2523
 
            "%(location)s.")
2524
 
 
2525
 
    def __init__(self, location):
2526
 
        BzrError.__init__(self)
2527
 
        self.location = location
2528
 
 
2529
 
 
2530
2210
class UnsupportedInventoryKind(BzrError):
2531
 
 
 
2211
    
2532
2212
    _fmt = """Unsupported entry kind %(kind)s"""
2533
2213
 
2534
2214
    def __init__(self, kind):
2546
2226
 
2547
2227
 
2548
2228
class SubsumeTargetNeedsUpgrade(BzrError):
2549
 
 
 
2229
    
2550
2230
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2551
2231
 
2552
2232
    def __init__(self, other_tree):
2575
2255
class TagsNotSupported(BzrError):
2576
2256
 
2577
2257
    _fmt = ("Tags not supported by %(branch)s;"
2578
 
            " you may be able to use bzr upgrade.")
 
2258
            " you may be able to use bzr upgrade --dirstate-tags.")
2579
2259
 
2580
2260
    def __init__(self, branch):
2581
2261
        self.branch = branch
2582
2262
 
2583
 
 
 
2263
        
2584
2264
class TagAlreadyExists(BzrError):
2585
2265
 
2586
2266
    _fmt = "Tag %(tag_name)s already exists."
2591
2271
 
2592
2272
class MalformedBugIdentifier(BzrError):
2593
2273
 
2594
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2595
 
            'See "bzr help bugs" for more information on this feature.')
 
2274
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2596
2275
 
2597
2276
    def __init__(self, bug_id, reason):
2598
2277
        self.bug_id = bug_id
2599
2278
        self.reason = reason
2600
2279
 
2601
2280
 
2602
 
class InvalidBugTrackerURL(BzrError):
2603
 
 
2604
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2605
 
            "contain {id}: %(url)s")
2606
 
 
2607
 
    def __init__(self, abbreviation, url):
2608
 
        self.abbreviation = abbreviation
2609
 
        self.url = url
2610
 
 
2611
 
 
2612
2281
class UnknownBugTrackerAbbreviation(BzrError):
2613
2282
 
2614
2283
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2619
2288
        self.branch = branch
2620
2289
 
2621
2290
 
2622
 
class InvalidLineInBugsProperty(BzrError):
2623
 
 
2624
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2625
 
 
2626
 
    def __init__(self, line):
2627
 
        self.line = line
2628
 
 
2629
 
 
2630
 
class InvalidBugStatus(BzrError):
2631
 
 
2632
 
    _fmt = ("Invalid bug status: '%(status)s'")
2633
 
 
2634
 
    def __init__(self, status):
2635
 
        self.status = status
2636
 
 
2637
 
 
2638
2291
class UnexpectedSmartServerResponse(BzrError):
2639
2292
 
2640
2293
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2643
2296
        self.response_tuple = response_tuple
2644
2297
 
2645
2298
 
2646
 
class ErrorFromSmartServer(BzrError):
2647
 
    """An error was received from a smart server.
2648
 
 
2649
 
    :seealso: UnknownErrorFromSmartServer
2650
 
    """
2651
 
 
2652
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2653
 
 
2654
 
    internal_error = True
2655
 
 
2656
 
    def __init__(self, error_tuple):
2657
 
        self.error_tuple = error_tuple
2658
 
        try:
2659
 
            self.error_verb = error_tuple[0]
2660
 
        except IndexError:
2661
 
            self.error_verb = None
2662
 
        self.error_args = error_tuple[1:]
2663
 
 
2664
 
 
2665
 
class UnknownErrorFromSmartServer(BzrError):
2666
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2667
 
    error.
2668
 
 
2669
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2670
 
    distinguish between the following two cases:
2671
 
 
2672
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2673
 
      and so should provoke a traceback to the user.
2674
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2675
 
      translated.  This is probably because the server sent us garbage, and
2676
 
      should not provoke a traceback.
2677
 
    """
2678
 
 
2679
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2680
 
 
2681
 
    internal_error = False
2682
 
 
2683
 
    def __init__(self, error_from_smart_server):
2684
 
        """Constructor.
2685
 
 
2686
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2687
 
        """
2688
 
        self.error_from_smart_server = error_from_smart_server
2689
 
        self.error_tuple = error_from_smart_server.error_tuple
2690
 
 
2691
 
 
2692
2299
class ContainerError(BzrError):
2693
2300
    """Base class of container errors."""
2694
2301
 
2696
2303
class UnknownContainerFormatError(ContainerError):
2697
2304
 
2698
2305
    _fmt = "Unrecognised container format: %(container_format)r"
2699
 
 
 
2306
    
2700
2307
    def __init__(self, container_format):
2701
2308
        self.container_format = container_format
2702
2309
 
2735
2342
    _fmt = "Container has multiple records with the same name: %(name)s"
2736
2343
 
2737
2344
    def __init__(self, name):
2738
 
        self.name = name.decode("utf-8")
 
2345
        self.name = name
2739
2346
 
2740
2347
 
2741
2348
class NoDestinationAddress(InternalBzrError):
2764
2371
    _fmt = "No message supplied."
2765
2372
 
2766
2373
 
2767
 
class NoMailAddressSpecified(BzrError):
2768
 
 
2769
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2374
class UnknownMailClient(BzrError):
 
2375
 
 
2376
    _fmt = "Unknown mail client: %(mail_client)s"
 
2377
 
 
2378
    def __init__(self, mail_client):
 
2379
        BzrError.__init__(self, mail_client=mail_client)
2770
2380
 
2771
2381
 
2772
2382
class MailClientNotFound(BzrError):
2797
2407
 
2798
2408
    def __init__(self, bzrdir):
2799
2409
        import bzrlib.urlutils as urlutils
2800
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2410
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2801
2411
                                                    'ascii')
2802
2412
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2803
2413
 
2804
2414
 
2805
 
class UnsyncedBranches(BzrDirError):
2806
 
 
2807
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2808
 
            " bzr help sync-for-reconfigure.")
2809
 
 
2810
 
    def __init__(self, bzrdir, target_branch):
2811
 
        BzrDirError.__init__(self, bzrdir)
2812
 
        import bzrlib.urlutils as urlutils
2813
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2814
 
                                                        'ascii')
2815
 
 
2816
 
 
2817
2415
class AlreadyBranch(BzrDirError):
2818
2416
 
2819
2417
    _fmt = "'%(display_url)s' is already a branch."
2829
2427
    _fmt = "'%(display_url)s' is already a checkout."
2830
2428
 
2831
2429
 
2832
 
class AlreadyLightweightCheckout(BzrDirError):
2833
 
 
2834
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2835
 
 
2836
 
 
2837
 
class AlreadyUsingShared(BzrDirError):
2838
 
 
2839
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2840
 
 
2841
 
 
2842
 
class AlreadyStandalone(BzrDirError):
2843
 
 
2844
 
    _fmt = "'%(display_url)s' is already standalone."
2845
 
 
2846
 
 
2847
 
class AlreadyWithTrees(BzrDirError):
2848
 
 
2849
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2850
 
            "working trees.")
2851
 
 
2852
 
 
2853
 
class AlreadyWithNoTrees(BzrDirError):
2854
 
 
2855
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2856
 
            "working trees.")
2857
 
 
2858
 
 
2859
2430
class ReconfigurationNotSupported(BzrDirError):
2860
2431
 
2861
2432
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2868
2439
 
2869
2440
class UncommittedChanges(BzrError):
2870
2441
 
2871
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2872
 
            ' (See bzr status).%(more)s')
2873
 
 
2874
 
    def __init__(self, tree, more=None):
2875
 
        if more is None:
2876
 
            more = ''
2877
 
        else:
2878
 
            more = ' ' + more
2879
 
        import bzrlib.urlutils as urlutils
2880
 
        user_url = getattr(tree, "user_url", None)
2881
 
        if user_url is None:
2882
 
            display_url = str(tree)
2883
 
        else:
2884
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2885
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2886
 
 
2887
 
 
2888
 
class StoringUncommittedNotSupported(BzrError):
2889
 
 
2890
 
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
2891
 
            ' changes.')
2892
 
 
2893
 
    def __init__(self, branch):
2894
 
        import bzrlib.urlutils as urlutils
2895
 
        user_url = getattr(branch, "user_url", None)
2896
 
        if user_url is None:
2897
 
            display_url = str(branch)
2898
 
        else:
2899
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2900
 
        BzrError.__init__(self, branch=branch, display_url=display_url)
2901
 
 
2902
 
 
2903
 
class ShelvedChanges(UncommittedChanges):
2904
 
 
2905
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2906
 
            ' (See bzr shelve --list).%(more)s')
2907
 
 
2908
 
 
2909
 
class MissingTemplateVariable(BzrError):
2910
 
 
2911
 
    _fmt = 'Variable {%(name)s} is not available.'
2912
 
 
2913
 
    def __init__(self, name):
2914
 
        self.name = name
2915
 
 
2916
 
 
2917
 
class NoTemplate(BzrError):
2918
 
 
2919
 
    _fmt = 'No template specified.'
2920
 
 
2921
 
 
2922
 
class UnableCreateSymlink(BzrError):
2923
 
 
2924
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2925
 
 
2926
 
    def __init__(self, path=None):
2927
 
        path_str = ''
2928
 
        if path:
2929
 
            try:
2930
 
                path_str = repr(str(path))
2931
 
            except UnicodeEncodeError:
2932
 
                path_str = repr(path)
2933
 
            path_str += ' '
2934
 
        self.path_str = path_str
2935
 
 
2936
 
 
2937
 
class UnsupportedTimezoneFormat(BzrError):
2938
 
 
2939
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2940
 
            'options are "utc", "original", "local".')
2941
 
 
2942
 
    def __init__(self, timezone):
2943
 
        self.timezone = timezone
2944
 
 
2945
 
 
2946
 
class CommandAvailableInPlugin(StandardError):
2947
 
 
2948
 
    internal_error = False
2949
 
 
2950
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2951
 
 
2952
 
        self.plugin_metadata = plugin_metadata
2953
 
        self.cmd_name = cmd_name
2954
 
        self.provider = provider
2955
 
 
2956
 
    def __str__(self):
2957
 
 
2958
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2959
 
                'However, the following official plugin provides this command: %s\n'
2960
 
                'You can install it by going to: %s'
2961
 
                % (self.cmd_name, self.plugin_metadata['name'],
2962
 
                    self.plugin_metadata['url']))
2963
 
 
2964
 
        return _fmt
2965
 
 
2966
 
 
2967
 
class NoPluginAvailable(BzrError):
2968
 
    pass
2969
 
 
2970
 
 
2971
 
class UnableEncodePath(BzrError):
2972
 
 
2973
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2974
 
            'user encoding %(user_encoding)s')
2975
 
 
2976
 
    def __init__(self, path, kind):
2977
 
        from bzrlib.osutils import get_user_encoding
2978
 
        self.path = path
2979
 
        self.kind = kind
2980
 
        self.user_encoding = get_user_encoding()
2981
 
 
2982
 
 
2983
 
class NoSuchConfig(BzrError):
2984
 
 
2985
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2986
 
 
2987
 
    def __init__(self, config_id):
2988
 
        BzrError.__init__(self, config_id=config_id)
2989
 
 
2990
 
 
2991
 
class NoSuchConfigOption(BzrError):
2992
 
 
2993
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2994
 
 
2995
 
    def __init__(self, option_name):
2996
 
        BzrError.__init__(self, option_name=option_name)
2997
 
 
2998
 
 
2999
 
class NoSuchAlias(BzrError):
3000
 
 
3001
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3002
 
 
3003
 
    def __init__(self, alias_name):
3004
 
        BzrError.__init__(self, alias_name=alias_name)
3005
 
 
3006
 
 
3007
 
class DirectoryLookupFailure(BzrError):
3008
 
    """Base type for lookup errors."""
3009
 
 
3010
 
    pass
3011
 
 
3012
 
 
3013
 
class InvalidLocationAlias(DirectoryLookupFailure):
3014
 
 
3015
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
3016
 
 
3017
 
    def __init__(self, alias_name):
3018
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
3019
 
 
3020
 
 
3021
 
class UnsetLocationAlias(DirectoryLookupFailure):
3022
 
 
3023
 
    _fmt = 'No %(alias_name)s location assigned.'
3024
 
 
3025
 
    def __init__(self, alias_name):
3026
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
3027
 
 
3028
 
 
3029
 
class CannotBindAddress(BzrError):
3030
 
 
3031
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3032
 
 
3033
 
    def __init__(self, host, port, orig_error):
3034
 
        # nb: in python2.4 socket.error doesn't have a useful repr
3035
 
        BzrError.__init__(self, host=host, port=port,
3036
 
            orig_error=repr(orig_error.args))
3037
 
 
3038
 
 
3039
 
class UnknownRules(BzrError):
3040
 
 
3041
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
3042
 
 
3043
 
    def __init__(self, unknowns):
3044
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3045
 
 
3046
 
 
3047
 
class TipChangeRejected(BzrError):
3048
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3049
 
    explicitly abort a change to a branch tip.
3050
 
    """
3051
 
 
3052
 
    _fmt = u"Tip change rejected: %(msg)s"
3053
 
 
3054
 
    def __init__(self, msg):
3055
 
        self.msg = msg
3056
 
 
3057
 
 
3058
 
class ShelfCorrupt(BzrError):
3059
 
 
3060
 
    _fmt = "Shelf corrupt."
3061
 
 
3062
 
 
3063
 
class DecompressCorruption(BzrError):
3064
 
 
3065
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3066
 
 
3067
 
    def __init__(self, orig_error=None):
3068
 
        if orig_error is not None:
3069
 
            self.orig_error = ", %s" % (orig_error,)
3070
 
        else:
3071
 
            self.orig_error = ""
3072
 
        BzrError.__init__(self)
3073
 
 
3074
 
 
3075
 
class NoSuchShelfId(BzrError):
3076
 
 
3077
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3078
 
 
3079
 
    def __init__(self, shelf_id):
3080
 
        BzrError.__init__(self, shelf_id=shelf_id)
3081
 
 
3082
 
 
3083
 
class InvalidShelfId(BzrError):
3084
 
 
3085
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3086
 
 
3087
 
    def __init__(self, invalid_id):
3088
 
        BzrError.__init__(self, invalid_id=invalid_id)
3089
 
 
3090
 
 
3091
 
class JailBreak(BzrError):
3092
 
 
3093
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3094
 
 
3095
 
    def __init__(self, url):
3096
 
        BzrError.__init__(self, url=url)
3097
 
 
3098
 
 
3099
 
class UserAbort(BzrError):
3100
 
 
3101
 
    _fmt = 'The user aborted the operation.'
3102
 
 
3103
 
 
3104
 
class MustHaveWorkingTree(BzrError):
3105
 
 
3106
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3107
 
 
3108
 
    def __init__(self, format, url):
3109
 
        BzrError.__init__(self, format=format, url=url)
3110
 
 
3111
 
 
3112
 
class NoSuchView(BzrError):
3113
 
    """A view does not exist.
3114
 
    """
3115
 
 
3116
 
    _fmt = u"No such view: %(view_name)s."
3117
 
 
3118
 
    def __init__(self, view_name):
3119
 
        self.view_name = view_name
3120
 
 
3121
 
 
3122
 
class ViewsNotSupported(BzrError):
3123
 
    """Views are not supported by a tree format.
3124
 
    """
3125
 
 
3126
 
    _fmt = ("Views are not supported by %(tree)s;"
3127
 
            " use 'bzr upgrade' to change your tree to a later format.")
 
2442
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
3128
2443
 
3129
2444
    def __init__(self, tree):
3130
 
        self.tree = tree
3131
 
 
3132
 
 
3133
 
class FileOutsideView(BzrError):
3134
 
 
3135
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3136
 
            '%(view_str)s')
3137
 
 
3138
 
    def __init__(self, file_name, view_files):
3139
 
        self.file_name = file_name
3140
 
        self.view_str = ", ".join(view_files)
3141
 
 
3142
 
 
3143
 
class UnresumableWriteGroup(BzrError):
3144
 
 
3145
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3146
 
            "%(write_groups)r: %(reason)s")
3147
 
 
3148
 
    internal_error = True
3149
 
 
3150
 
    def __init__(self, repository, write_groups, reason):
3151
 
        self.repository = repository
3152
 
        self.write_groups = write_groups
3153
 
        self.reason = reason
3154
 
 
3155
 
 
3156
 
class UnsuspendableWriteGroup(BzrError):
3157
 
 
3158
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3159
 
 
3160
 
    internal_error = True
3161
 
 
3162
 
    def __init__(self, repository):
3163
 
        self.repository = repository
3164
 
 
3165
 
 
3166
 
class LossyPushToSameVCS(BzrError):
3167
 
 
3168
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3169
 
            "%(target_branch)r that are in the same VCS.")
3170
 
 
3171
 
    internal_error = True
3172
 
 
3173
 
    def __init__(self, source_branch, target_branch):
3174
 
        self.source_branch = source_branch
3175
 
        self.target_branch = target_branch
3176
 
 
3177
 
 
3178
 
class NoRoundtrippingSupport(BzrError):
3179
 
 
3180
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3181
 
            "%(target_branch)r.")
3182
 
 
3183
 
    internal_error = True
3184
 
 
3185
 
    def __init__(self, source_branch, target_branch):
3186
 
        self.source_branch = source_branch
3187
 
        self.target_branch = target_branch
3188
 
 
3189
 
 
3190
 
class FileTimestampUnavailable(BzrError):
3191
 
 
3192
 
    _fmt = "The filestamp for %(path)s is not available."
3193
 
 
3194
 
    internal_error = True
3195
 
 
3196
 
    def __init__(self, path):
3197
 
        self.path = path
3198
 
 
3199
 
 
3200
 
class NoColocatedBranchSupport(BzrError):
3201
 
 
3202
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3203
 
 
3204
 
    def __init__(self, bzrdir):
3205
 
        self.bzrdir = bzrdir
3206
 
 
3207
 
 
3208
 
class NoWhoami(BzrError):
3209
 
 
3210
 
    _fmt = ('Unable to determine your name.\n'
3211
 
        "Please, set your name with the 'whoami' command.\n"
3212
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3213
 
 
3214
 
 
3215
 
class InvalidPattern(BzrError):
3216
 
 
3217
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3218
 
 
3219
 
    def __init__(self, msg):
3220
 
        self.msg = msg
3221
 
 
3222
 
 
3223
 
class RecursiveBind(BzrError):
3224
 
 
3225
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3226
 
        'Please use `bzr unbind` to fix.')
3227
 
 
3228
 
    def __init__(self, branch_url):
3229
 
        self.branch_url = branch_url
3230
 
 
3231
 
 
3232
 
# FIXME: I would prefer to define the config related exception classes in
3233
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3234
 
class OptionExpansionLoop(BzrError):
3235
 
 
3236
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3237
 
 
3238
 
    def __init__(self, string, refs):
3239
 
        self.string = string
3240
 
        self.refs = '->'.join(refs)
3241
 
 
3242
 
 
3243
 
class ExpandingUnknownOption(BzrError):
3244
 
 
3245
 
    _fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
3246
 
 
3247
 
    def __init__(self, name, string):
3248
 
        self.name = name
3249
 
        self.string = string
3250
 
 
3251
 
 
3252
 
class IllegalOptionName(BzrError):
3253
 
 
3254
 
    _fmt = 'Option "%(name)s" is not allowed.'
3255
 
 
3256
 
    def __init__(self, name):
3257
 
        self.name = name
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.')
 
2445
        import bzrlib.urlutils as urlutils
 
2446
        display_url = urlutils.unescape_for_display(
 
2447
            tree.bzrdir.root_transport.base, 'ascii')
 
2448
        BzrError.__init__(self, tree=tree, display_url=display_url)