← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
 
20
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
43
44
# 'unprintable'.
44
45
 
45
46
 
46
 
# return codes from the bzr program
47
 
EXIT_OK = 0
48
 
EXIT_ERROR = 3
49
 
EXIT_INTERNAL_ERROR = 4
50
 
 
51
 
 
52
47
class BzrError(StandardError):
53
48
    """
54
49
    Base class for errors raised by bzrlib.
55
50
 
56
51
    :cvar internal_error: if True this was probably caused by a bzr bug and
57
 
        should be displayed with a traceback; if False (or absent) this was
58
 
        probably a user or environment error and they don't need the gory
59
 
        details.  (That can be overridden by -Derror on the command line.)
 
52
    should be displayed with a traceback; if False (or absent) this was
 
53
    probably a user or environment error and they don't need the gory details.
 
54
    (That can be overridden by -Derror on the command line.)
60
55
 
61
56
    :cvar _fmt: Format string to display the error; this is expanded
62
 
        by the instance's dict.
 
57
    by the instance's dict.
63
58
    """
64
 
 
 
59
    
65
60
    internal_error = False
66
61
 
67
62
    def __init__(self, msg=None, **kwds):
72
67
        arguments can be given.  The first is for generic "user" errors which
73
68
        are not intended to be caught and so do not need a specific subclass.
74
69
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
70
        string to print the arguments.  
76
71
 
77
 
        Keyword arguments are taken as parameters to the error, which can
78
 
        be inserted into the format string template.  It's recommended
79
 
        that subclasses override the __init__ method to require specific
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
73
        be inserted into the format string template.  It's recommended 
 
74
        that subclasses override the __init__ method to require specific 
80
75
        parameters.
81
76
 
82
77
        :param msg: If given, this is the literal complete text for the error,
83
 
           not subject to expansion. 'msg' is used instead of 'message' because
84
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        not subject to expansion.
85
79
        """
86
80
        StandardError.__init__(self)
87
81
        if msg is not None:
93
87
            for key, value in kwds.items():
94
88
                setattr(self, key, value)
95
89
 
96
 
    def _format(self):
 
90
    def __str__(self):
97
91
        s = getattr(self, '_preformatted_string', None)
98
92
        if s is not None:
99
 
            # contains a preformatted message
100
 
            return s
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
101
95
        try:
102
96
            fmt = self._get_format_string()
103
97
            if fmt:
104
 
                d = dict(self.__dict__)
105
 
                s = fmt % d
 
98
                s = fmt % self.__dict__
106
99
                # __str__() should always return a 'str' object
107
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
108
103
                return s
109
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
113
108
                   getattr(self, '_fmt', None),
114
109
                   e)
115
110
 
116
 
    def __unicode__(self):
117
 
        u = self._format()
118
 
        if isinstance(u, str):
119
 
            # Try decoding the str using the default encoding.
120
 
            u = unicode(u)
121
 
        elif not isinstance(u, unicode):
122
 
            # Try to make a unicode object from it, because __unicode__ must
123
 
            # return a unicode object.
124
 
            u = unicode(u)
125
 
        return u
126
 
 
127
 
    def __str__(self):
128
 
        s = self._format()
129
 
        if isinstance(s, unicode):
130
 
            s = s.encode('utf8')
131
 
        else:
132
 
            # __str__ must return a str.
133
 
            s = str(s)
134
 
        return s
135
 
 
136
 
    def __repr__(self):
137
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
138
 
 
139
111
    def _get_format_string(self):
140
112
        """Return format string for this exception or None"""
141
113
        fmt = getattr(self, '_fmt', None)
153
125
               getattr(self, '_fmt', None),
154
126
               )
155
127
 
156
 
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
158
 
            return NotImplemented
159
 
        return self.__dict__ == other.__dict__
160
 
 
161
 
 
162
 
class InternalBzrError(BzrError):
163
 
    """Base class for errors that are internal in nature.
164
 
 
165
 
    This is a convenience class for errors that are internal. The
166
 
    internal_error attribute can still be altered in subclasses, if needed.
167
 
    Using this class is simply an easy way to get internal errors.
168
 
    """
169
 
 
170
 
    internal_error = True
171
 
 
172
128
 
173
129
class BzrNewError(BzrError):
174
130
    """Deprecated error base class."""
204
160
 
205
161
 
206
162
class AlreadyBuilding(BzrError):
207
 
 
 
163
    
208
164
    _fmt = "The tree builder is already building a tree."
209
165
 
210
166
 
211
 
class BranchError(BzrError):
212
 
    """Base class for concrete 'errors about a branch'."""
213
 
 
214
 
    def __init__(self, branch):
215
 
        BzrError.__init__(self, branch=branch)
216
 
 
217
 
 
218
 
class BzrCheckError(InternalBzrError):
219
 
 
220
 
    _fmt = "Internal check failed: %(msg)s"
221
 
 
222
 
    def __init__(self, msg):
223
 
        BzrError.__init__(self)
224
 
        self.msg = msg
225
 
 
226
 
 
227
 
class DirstateCorrupt(BzrError):
228
 
 
229
 
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
230
 
 
231
 
    def __init__(self, state, msg):
232
 
        BzrError.__init__(self)
233
 
        self.state = state
234
 
        self.msg = msg
235
 
 
236
 
 
237
 
class DisabledMethod(InternalBzrError):
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class DisabledMethod(BzrError):
238
179
 
239
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
240
181
 
 
182
    internal_error = True
 
183
 
241
184
    def __init__(self, class_name):
242
185
        BzrError.__init__(self)
243
186
        self.class_name = class_name
264
207
        self.transport = transport
265
208
 
266
209
 
267
 
class InvalidEntryName(InternalBzrError):
268
 
 
 
210
class InvalidEntryName(BzrError):
 
211
    
269
212
    _fmt = "Invalid entry name: %(name)s"
270
213
 
 
214
    internal_error = True
 
215
 
271
216
    def __init__(self, name):
272
217
        BzrError.__init__(self)
273
218
        self.name = name
274
219
 
275
220
 
276
221
class InvalidRevisionNumber(BzrError):
277
 
 
 
222
    
278
223
    _fmt = "Invalid revision number %(revno)s"
279
224
 
280
225
    def __init__(self, revno):
292
237
        self.revision_id = revision_id
293
238
        self.branch = branch
294
239
 
295
 
 
296
240
class ReservedId(BzrError):
297
241
 
298
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
301
245
        self.revision_id = revision_id
302
246
 
303
247
 
304
 
class RootMissing(InternalBzrError):
305
 
 
306
 
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "the commit builder.")
308
 
 
309
 
 
310
 
class NoPublicBranch(BzrError):
311
 
 
312
 
    _fmt = 'There is no public branch set for "%(branch_url)s".'
313
 
 
314
 
    def __init__(self, branch):
315
 
        import bzrlib.urlutils as urlutils
316
 
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
317
 
        BzrError.__init__(self, branch_url=public_location)
318
 
 
319
 
 
320
248
class NoHelpTopic(BzrError):
321
249
 
322
250
    _fmt = ("No help could be found for '%(topic)s'. "
328
256
 
329
257
class NoSuchId(BzrError):
330
258
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
259
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
260
    
333
261
    def __init__(self, tree, file_id):
334
262
        BzrError.__init__(self)
335
263
        self.file_id = file_id
336
264
        self.tree = tree
337
265
 
338
266
 
339
 
class NoSuchIdInRepository(NoSuchId):
340
 
 
341
 
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
342
 
            ' %(repository)r')
343
 
 
344
 
    def __init__(self, repository, file_id):
345
 
        BzrError.__init__(self, repository=repository, file_id=file_id)
346
 
 
347
 
 
348
 
class NotStacked(BranchError):
349
 
 
350
 
    _fmt = "The branch '%(branch)s' is not stacked."
351
 
 
352
 
 
353
 
class InventoryModified(InternalBzrError):
 
267
class InventoryModified(BzrError):
354
268
 
355
269
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
270
            " so a clean inventory cannot be read without data loss.")
357
271
 
 
272
    internal_error = True
 
273
 
358
274
    def __init__(self, tree):
359
275
        self.tree = tree
360
276
 
361
277
 
362
278
class NoWorkingTree(BzrError):
363
279
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
280
    _fmt = "No WorkingTree exists for %(base)s."
 
281
    
366
282
    def __init__(self, base):
367
283
        BzrError.__init__(self)
368
284
        self.base = base
381
297
        self.url = url
382
298
 
383
299
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
300
class WorkingTreeAlreadyPopulated(BzrError):
 
301
 
 
302
    _fmt = """Working tree already populated in %(base)s"""
 
303
 
 
304
    internal_error = True
387
305
 
388
306
    def __init__(self, base):
389
307
        self.base = base
390
308
 
391
 
 
392
309
class BzrCommandError(BzrError):
393
310
    """Error from user command"""
394
311
 
 
312
    internal_error = False
 
313
 
395
314
    # Error from malformed user command; please avoid raising this as a
396
315
    # generic exception not caused by user input.
397
316
    #
399
318
    # are not intended to be caught anyway.  UI code need not subclass
400
319
    # BzrCommandError, and non-UI code should not throw a subclass of
401
320
    # BzrCommandError.  ADHB 20051211
 
321
    def __init__(self, msg):
 
322
        # Object.__str__() must return a real string
 
323
        # returning a Unicode string is a python error.
 
324
        if isinstance(msg, unicode):
 
325
            self.msg = msg.encode('utf8')
 
326
        else:
 
327
            self.msg = msg
 
328
 
 
329
    def __str__(self):
 
330
        return self.msg
402
331
 
403
332
 
404
333
class NotWriteLocked(BzrError):
477
406
    def __init__(self, name, value):
478
407
        BzrError.__init__(self, name=name, value=value)
479
408
 
480
 
 
 
409
    
481
410
class StrictCommitFailed(BzrError):
482
411
 
483
412
    _fmt = "Commit refused because there are unknown files in the tree"
486
415
# XXX: Should be unified with TransportError; they seem to represent the
487
416
# same thing
488
417
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
 
# - this is finer than a TransportError - and more useful as such. It
 
418
# - this is finer than a TransportError - and more useful as such. It 
490
419
# differentiates between 'transport has failed' and 'operation on a transport
491
420
# has failed.'
492
421
class PathError(BzrError):
493
 
 
 
422
    
494
423
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
424
 
496
425
    def __init__(self, path, extra=None):
516
445
    """Used when renaming and both source and dest exist."""
517
446
 
518
447
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
519
 
            " (Use --after to tell bzr about a rename that has already"
520
 
            " happened)%(extra)s")
 
448
            "%(extra)s")
521
449
 
522
450
    def __init__(self, source, dest, extra=None):
523
451
        BzrError.__init__(self)
531
459
 
532
460
class NotADirectory(PathError):
533
461
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
462
    _fmt = "%(path)r is not a directory %(extra)s"
535
463
 
536
464
 
537
465
class NotInWorkingDirectory(PathError):
538
466
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
467
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
468
 
541
469
 
542
470
class DirectoryNotEmpty(PathError):
543
471
 
544
 
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
545
 
 
546
 
 
547
 
class HardLinkNotSupported(PathError):
548
 
 
549
 
    _fmt = 'Hard-linking "%(path)s" is not supported'
550
 
 
551
 
 
552
 
class ReadingCompleted(InternalBzrError):
553
 
 
 
472
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
473
 
 
474
 
 
475
class ReadingCompleted(BzrError):
 
476
    
554
477
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
478
            "called upon it - the request has been completed and no more "
556
479
            "data may be read.")
557
480
 
 
481
    internal_error = True
 
482
 
558
483
    def __init__(self, request):
559
484
        self.request = request
560
485
 
561
486
 
562
487
class ResourceBusy(PathError):
563
488
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
489
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
490
 
566
491
 
567
492
class PermissionDenied(PathError):
568
493
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
494
    _fmt = "Permission denied: %(path)r%(extra)s"
570
495
 
571
496
 
572
497
class InvalidURL(PathError):
573
498
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
499
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
500
 
576
501
 
577
502
class InvalidURLJoin(PathError):
578
503
 
579
 
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
580
 
 
581
 
    def __init__(self, reason, base, join_args):
582
 
        self.reason = reason
583
 
        self.base = base
584
 
        self.join_args = join_args
585
 
        PathError.__init__(self, base, reason)
586
 
 
587
 
 
588
 
class InvalidRebaseURLs(PathError):
589
 
 
590
 
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
591
 
 
592
 
    def __init__(self, from_, to):
593
 
        self.from_ = from_
594
 
        self.to = to
595
 
        PathError.__init__(self, from_, 'URLs differ by more than path.')
596
 
 
597
 
 
598
 
class UnavailableRepresentation(InternalBzrError):
599
 
 
600
 
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
601
 
        "is encoded as '%(native)s'.")
602
 
 
603
 
    def __init__(self, key, wanted, native):
604
 
        InternalBzrError.__init__(self)
605
 
        self.wanted = wanted
606
 
        self.native = native
607
 
        self.key = key
 
504
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
505
 
 
506
    def __init__(self, msg, base, args):
 
507
        PathError.__init__(self, base, msg)
 
508
        self.args = [base] + list(args)
608
509
 
609
510
 
610
511
class UnknownHook(BzrError):
625
526
        PathError.__init__(self, url, extra=extra)
626
527
 
627
528
 
628
 
class UnstackableBranchFormat(BzrError):
629
 
 
630
 
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
631
 
        "You will need to upgrade the branch to permit branch stacking.")
632
 
 
633
 
    def __init__(self, format, url):
634
 
        BzrError.__init__(self)
635
 
        self.format = format
636
 
        self.url = url
637
 
 
638
 
 
639
 
class UnstackableLocationError(BzrError):
640
 
 
641
 
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
642
 
 
643
 
    def __init__(self, branch_url, target_url):
644
 
        BzrError.__init__(self)
645
 
        self.branch_url = branch_url
646
 
        self.target_url = target_url
647
 
 
648
 
 
649
 
class UnstackableRepositoryFormat(BzrError):
650
 
 
651
 
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
652
 
        "You will need to upgrade the repository to permit branch stacking.")
653
 
 
654
 
    def __init__(self, format, url):
655
 
        BzrError.__init__(self)
656
 
        self.format = format
657
 
        self.url = url
658
 
 
659
 
 
660
529
class ReadError(PathError):
661
 
 
 
530
    
662
531
    _fmt = """Error reading from %(path)r."""
663
532
 
664
533
 
665
534
class ShortReadvError(PathError):
666
535
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
536
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
537
            " at %(offset)s for %(path)s%(extra)s")
669
538
 
670
539
    internal_error = True
671
540
 
678
547
 
679
548
class PathNotChild(PathError):
680
549
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
550
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
682
551
 
683
 
    internal_error = False
 
552
    internal_error = True
684
553
 
685
554
    def __init__(self, path, base, extra=None):
686
555
        BzrError.__init__(self)
694
563
 
695
564
class InvalidNormalization(PathError):
696
565
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
566
    _fmt = "Path %(path)r is not unicode normalized"
698
567
 
699
568
 
700
569
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
570
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
571
# TODO: Probably this behavior of should be a common superclass 
703
572
class NotBranchError(PathError):
704
573
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
574
    _fmt = "Not a branch: %(path)s"
706
575
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
576
    def __init__(self, path):
708
577
       import bzrlib.urlutils as urlutils
709
 
       path = urlutils.unescape_for_display(path, 'ascii')
710
 
       if detail is not None:
711
 
           detail = ': ' + detail
712
 
       self.detail = detail
713
 
       self.bzrdir = bzrdir
714
 
       PathError.__init__(self, path=path)
715
 
 
716
 
    def __repr__(self):
717
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
718
 
 
719
 
    def _format(self):
720
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
721
 
        # Python 2.4 have to be old-style classes so properties don't work.
722
 
        # Instead we override _format.
723
 
        if self.detail is None:
724
 
            if self.bzrdir is not None:
725
 
                try:
726
 
                    self.bzrdir.open_repository()
727
 
                except NoRepositoryPresent:
728
 
                    self.detail = ''
729
 
                except Exception:
730
 
                    # Just ignore unexpected errors.  Raising arbitrary errors
731
 
                    # during str(err) can provoke strange bugs.  Concretely
732
 
                    # Launchpad's codehosting managed to raise NotBranchError
733
 
                    # here, and then get stuck in an infinite loop/recursion
734
 
                    # trying to str() that error.  All this error really cares
735
 
                    # about that there's no working repository there, and if
736
 
                    # open_repository() fails, there probably isn't.
737
 
                    self.detail = ''
738
 
                else:
739
 
                    self.detail = ': location is a repository'
740
 
            else:
741
 
                self.detail = ''
742
 
        return PathError._format(self)
 
578
       self.path = urlutils.unescape_for_display(path, 'ascii')
743
579
 
744
580
 
745
581
class NoSubmitBranch(PathError):
753
589
 
754
590
class AlreadyBranchError(PathError):
755
591
 
756
 
    _fmt = 'Already a branch: "%(path)s".'
 
592
    _fmt = "Already a branch: %(path)s."
757
593
 
758
594
 
759
595
class BranchExistsWithoutWorkingTree(PathError):
760
596
 
761
 
    _fmt = 'Directory contains a branch, but no working tree \
762
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
597
    _fmt = "Directory contains a branch, but no working tree \
 
598
(use bzr checkout if you wish to build a working tree): %(path)s"
763
599
 
764
600
 
765
601
class AtomicFileAlreadyClosed(PathError):
766
602
 
767
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
768
 
            ' "%(path)s"')
 
603
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
604
            " %(path)s")
769
605
 
770
606
    def __init__(self, path, function):
771
607
        PathError.__init__(self, path=path, extra=None)
774
610
 
775
611
class InaccessibleParent(PathError):
776
612
 
777
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
778
 
            ' relative path "%(path)s"')
 
613
    _fmt = ("Parent not accessible given base %(base)s and"
 
614
            " relative path %(path)s")
779
615
 
780
616
    def __init__(self, path, base):
781
617
        PathError.__init__(self, path)
784
620
 
785
621
class NoRepositoryPresent(BzrError):
786
622
 
787
 
    _fmt = 'No repository present: "%(path)s"'
 
623
    _fmt = "No repository present: %(path)r"
788
624
    def __init__(self, bzrdir):
789
625
        BzrError.__init__(self)
790
626
        self.path = bzrdir.transport.clone('..').base
792
628
 
793
629
class FileInWrongBranch(BzrError):
794
630
 
795
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
631
    _fmt = "File %(path)s in not in branch %(branch_base)s."
796
632
 
797
 
    # use PathNotChild instead
798
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
633
    def __init__(self, branch, path):
800
634
        BzrError.__init__(self)
801
635
        self.branch = branch
809
643
 
810
644
 
811
645
class UnknownFormatError(BzrError):
812
 
 
813
 
    _fmt = "Unknown %(kind)s format: %(format)r"
814
 
 
815
 
    def __init__(self, format, kind='branch'):
816
 
        self.kind = kind
817
 
        self.format = format
 
646
    
 
647
    _fmt = "Unknown branch format: %(format)r"
818
648
 
819
649
 
820
650
class IncompatibleFormat(BzrError):
821
 
 
 
651
    
822
652
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
823
653
 
824
654
    def __init__(self, format, bzrdir_format):
828
658
 
829
659
 
830
660
class IncompatibleRepositories(BzrError):
831
 
    """Report an error that two repositories are not compatible.
832
 
 
833
 
    Note that the source and target repositories are permitted to be strings:
834
 
    this exception is thrown from the smart server and may refer to a
835
 
    repository the client hasn't opened.
836
 
    """
837
 
 
838
 
    _fmt = "%(target)s\n" \
839
 
            "is not compatible with\n" \
840
 
            "%(source)s\n" \
841
 
            "%(details)s"
842
 
 
843
 
    def __init__(self, source, target, details=None):
844
 
        if details is None:
845
 
            details = "(no details)"
846
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
661
 
 
662
    _fmt = "Repository %(target)s is not compatible with repository"\
 
663
        " %(source)s"
 
664
 
 
665
    def __init__(self, source, target):
 
666
        BzrError.__init__(self, target=target, source=source)
847
667
 
848
668
 
849
669
class IncompatibleRevision(BzrError):
850
 
 
 
670
    
851
671
    _fmt = "Revision is not compatible with %(repo_format)s"
852
672
 
853
673
    def __init__(self, repo_format):
858
678
class AlreadyVersionedError(BzrError):
859
679
    """Used when a path is expected not to be versioned, but it is."""
860
680
 
861
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
681
    _fmt = "%(context_info)s%(path)s is already versioned"
862
682
 
863
683
    def __init__(self, path, context_info=None):
864
684
        """Construct a new AlreadyVersionedError.
865
685
 
866
686
        :param path: This is the path which is versioned,
867
 
            which should be in a user friendly form.
 
687
        which should be in a user friendly form.
868
688
        :param context_info: If given, this is information about the context,
869
 
            which could explain why this is expected to not be versioned.
 
689
        which could explain why this is expected to not be versioned.
870
690
        """
871
691
        BzrError.__init__(self)
872
692
        self.path = path
879
699
class NotVersionedError(BzrError):
880
700
    """Used when a path is expected to be versioned, but it is not."""
881
701
 
882
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
702
    _fmt = "%(context_info)s%(path)s is not versioned"
883
703
 
884
704
    def __init__(self, path, context_info=None):
885
705
        """Construct a new NotVersionedError.
886
706
 
887
707
        :param path: This is the path which is not versioned,
888
 
            which should be in a user friendly form.
 
708
        which should be in a user friendly form.
889
709
        :param context_info: If given, this is information about the context,
890
 
            which could explain why this is expected to be versioned.
 
710
        which could explain why this is expected to be versioned.
891
711
        """
892
712
        BzrError.__init__(self)
893
713
        self.path = path
936
756
        BzrError.__init__(self, filename=filename, kind=kind)
937
757
 
938
758
 
939
 
class BadFilenameEncoding(BzrError):
940
 
 
941
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
942
 
            ' encoding %(fs_encoding)s')
943
 
 
944
 
    def __init__(self, filename, fs_encoding):
945
 
        BzrError.__init__(self)
946
 
        self.filename = filename
947
 
        self.fs_encoding = fs_encoding
948
 
 
949
 
 
950
759
class ForbiddenControlFileError(BzrError):
951
760
 
952
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
953
 
 
954
 
 
955
 
class LockError(InternalBzrError):
 
761
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
762
 
 
763
 
 
764
class LockError(BzrError):
956
765
 
957
766
    _fmt = "Lock error: %(msg)s"
958
767
 
 
768
    internal_error = True
 
769
 
959
770
    # All exceptions from the lock/unlock functions should be from
960
771
    # this exception class.  They will be translated as necessary. The
961
772
    # original exception is available as e.original_error
962
773
    #
963
774
    # New code should prefer to raise specific subclasses
964
 
    def __init__(self, msg):
965
 
        self.msg = msg
 
775
    def __init__(self, message):
 
776
        # Python 2.5 uses a slot for StandardError.message,
 
777
        # so use a different variable name
 
778
        # so it is exposed in self.__dict__
 
779
        self.msg = message
966
780
 
967
781
 
968
782
class LockActive(LockError):
1002
816
        self.obj = obj
1003
817
 
1004
818
 
1005
 
class LockFailed(LockError):
1006
 
 
1007
 
    internal_error = False
1008
 
 
1009
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
1010
 
 
1011
 
    def __init__(self, lock, why):
 
819
class ReadOnlyLockError(LockError):
 
820
 
 
821
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
822
 
 
823
    def __init__(self, fname, msg):
1012
824
        LockError.__init__(self, '')
1013
 
        self.lock = lock
1014
 
        self.why = why
 
825
        self.fname = fname
 
826
        self.msg = msg
1015
827
 
1016
828
 
1017
829
class OutSideTransaction(BzrError):
1041
853
 
1042
854
class UnlockableTransport(LockError):
1043
855
 
1044
 
    internal_error = False
1045
 
 
1046
856
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1047
857
 
1048
858
    def __init__(self, transport):
1051
861
 
1052
862
class LockContention(LockError):
1053
863
 
1054
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
864
    _fmt = "Could not acquire lock %(lock)s"
 
865
    # TODO: show full url for lock, combining the transport and relative
 
866
    # bits?
1055
867
 
1056
868
    internal_error = False
1057
869
 
1058
 
    def __init__(self, lock, msg=''):
 
870
    def __init__(self, lock):
1059
871
        self.lock = lock
1060
 
        self.msg = msg
1061
872
 
1062
873
 
1063
874
class LockBroken(LockError):
1084
895
        self.target = target
1085
896
 
1086
897
 
1087
 
class LockCorrupt(LockError):
1088
 
 
1089
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1090
 
            "Use 'bzr break-lock' to clear it")
1091
 
 
1092
 
    internal_error = False
1093
 
 
1094
 
    def __init__(self, corruption_info, file_data=None):
1095
 
        self.corruption_info = corruption_info
1096
 
        self.file_data = file_data
1097
 
 
1098
 
 
1099
898
class LockNotHeld(LockError):
1100
899
 
1101
900
    _fmt = "Lock not held: %(lock)s"
1110
909
 
1111
910
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1112
911
 
 
912
    internal_error = True
 
913
 
1113
914
    def __init__(self, obj):
1114
915
        self.obj = obj
1115
916
 
1140
941
        BzrError.__init__(self, files=files, files_str=files_str)
1141
942
 
1142
943
 
1143
 
class ExcludesUnsupported(BzrError):
1144
 
 
1145
 
    _fmt = ('Excluding paths during commit is not supported by '
1146
 
            'repository at %(repository)r.')
1147
 
 
1148
 
    def __init__(self, repository):
1149
 
        BzrError.__init__(self, repository=repository)
1150
 
 
1151
 
 
1152
 
class BadCommitMessageEncoding(BzrError):
1153
 
 
1154
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1155
 
        'the current encoding.'
1156
 
 
1157
 
 
1158
944
class UpgradeReadonly(BzrError):
1159
945
 
1160
946
    _fmt = "Upgrade URL cannot work with readonly URLs."
1174
960
    _fmt = "Commit refused because there are unknowns in the tree."
1175
961
 
1176
962
 
1177
 
class NoSuchRevision(InternalBzrError):
1178
 
 
1179
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
963
class NoSuchRevision(BzrError):
 
964
 
 
965
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
966
 
 
967
    internal_error = True
1180
968
 
1181
969
    def __init__(self, branch, revision):
1182
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1183
970
        BzrError.__init__(self, branch=branch, revision=revision)
1184
971
 
1185
972
 
1186
 
class RangeInChangeOption(BzrError):
1187
 
 
1188
 
    _fmt = "Option --change does not accept revision ranges"
 
973
class NotLeftParentDescendant(BzrError):
 
974
 
 
975
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
976
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
977
 
 
978
    internal_error = True
 
979
 
 
980
    def __init__(self, branch, old_revision, new_revision):
 
981
        BzrError.__init__(self, branch_location=branch.base,
 
982
                          old_revision=old_revision,
 
983
                          new_revision=new_revision)
1189
984
 
1190
985
 
1191
986
class NoSuchRevisionSpec(BzrError):
1198
993
 
1199
994
class NoSuchRevisionInTree(NoSuchRevision):
1200
995
    """When using Tree.revision_tree, and the revision is not accessible."""
1201
 
 
1202
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
996
    
 
997
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1203
998
 
1204
999
    def __init__(self, tree, revision_id):
1205
1000
        BzrError.__init__(self)
1209
1004
 
1210
1005
class InvalidRevisionSpec(BzrError):
1211
1006
 
1212
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
 
            " %(branch_url)s%(extra)s")
 
1007
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1008
            " %(branch)s%(extra)s")
1214
1009
 
1215
1010
    def __init__(self, spec, branch, extra=None):
1216
1011
        BzrError.__init__(self, branch=branch, spec=spec)
1217
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1218
1012
        if extra:
1219
1013
            self.extra = '\n' + str(extra)
1220
1014
        else:
1241
1035
class DivergedBranches(BzrError):
1242
1036
 
1243
1037
    _fmt = ("These branches have diverged."
1244
 
            " Use the missing command to see how.\n"
1245
 
            "Use the merge command to reconcile them.")
 
1038
            " Use the merge command to reconcile them.")
 
1039
 
 
1040
    internal_error = False
1246
1041
 
1247
1042
    def __init__(self, branch1, branch2):
1248
1043
        self.branch1 = branch1
1249
1044
        self.branch2 = branch2
1250
1045
 
1251
1046
 
1252
 
class NotLefthandHistory(InternalBzrError):
 
1047
class NotLefthandHistory(BzrError):
1253
1048
 
1254
1049
    _fmt = "Supplied history does not follow left-hand parents"
1255
1050
 
 
1051
    internal_error = True
 
1052
 
1256
1053
    def __init__(self, history):
1257
1054
        BzrError.__init__(self, history=history)
1258
1055
 
1262
1059
    _fmt = ("Branches have no common ancestor, and"
1263
1060
            " no merge base revision was specified.")
1264
1061
 
1265
 
 
1266
 
class CannotReverseCherrypick(BzrError):
1267
 
 
1268
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1269
 
            ' or diff3.')
 
1062
    internal_error = False
1270
1063
 
1271
1064
 
1272
1065
class NoCommonAncestor(BzrError):
1273
 
 
 
1066
    
1274
1067
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1275
1068
 
1276
1069
    def __init__(self, revision_a, revision_b):
1296
1089
            not_ancestor_id=not_ancestor_id)
1297
1090
 
1298
1091
 
 
1092
class InstallFailed(BzrError):
 
1093
 
 
1094
    def __init__(self, revisions):
 
1095
        revision_str = ", ".join(str(r) for r in revisions)
 
1096
        msg = "Could not install revisions:\n%s" % revision_str
 
1097
        BzrError.__init__(self, msg)
 
1098
        self.revisions = revisions
 
1099
 
 
1100
 
1299
1101
class AmbiguousBase(BzrError):
1300
1102
 
1301
1103
    def __init__(self, bases):
1302
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1104
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1105
                DeprecationWarning)
1304
1106
        msg = ("The correct base is unclear, because %s are all equally close"
1305
1107
                % ", ".join(bases))
1306
1108
        BzrError.__init__(self, msg)
1307
1109
        self.bases = bases
1308
1110
 
1309
1111
 
1310
 
class NoCommits(BranchError):
 
1112
class NoCommits(BzrError):
1311
1113
 
1312
1114
    _fmt = "Branch %(branch)s has no commits."
1313
1115
 
 
1116
    def __init__(self, branch):
 
1117
        BzrError.__init__(self, branch=branch)
 
1118
 
1314
1119
 
1315
1120
class UnlistableStore(BzrError):
1316
1121
 
1327
1132
 
1328
1133
class BoundBranchOutOfDate(BzrError):
1329
1134
 
1330
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1331
 
            " %(master)s.%(extra_help)s")
 
1135
    _fmt = ("Bound branch %(branch)s is out of date"
 
1136
            " with master branch %(master)s.")
1332
1137
 
1333
1138
    def __init__(self, branch, master):
1334
1139
        BzrError.__init__(self)
1335
1140
        self.branch = branch
1336
1141
        self.master = master
1337
 
        self.extra_help = ''
1338
 
 
1339
 
 
 
1142
 
 
1143
        
1340
1144
class CommitToDoubleBoundBranch(BzrError):
1341
1145
 
1342
1146
    _fmt = ("Cannot commit to branch %(branch)s."
1372
1176
 
1373
1177
class WeaveError(BzrError):
1374
1178
 
1375
 
    _fmt = "Error in processing weave: %(msg)s"
 
1179
    _fmt = "Error in processing weave: %(message)s"
1376
1180
 
1377
 
    def __init__(self, msg=None):
 
1181
    def __init__(self, message=None):
1378
1182
        BzrError.__init__(self)
1379
 
        self.msg = msg
 
1183
        self.message = message
1380
1184
 
1381
1185
 
1382
1186
class WeaveRevisionAlreadyPresent(WeaveError):
1411
1215
 
1412
1216
class WeaveParentMismatch(WeaveError):
1413
1217
 
1414
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1415
 
 
 
1218
    _fmt = "Parents are mismatched between two revisions."
 
1219
    
1416
1220
 
1417
1221
class WeaveInvalidChecksum(WeaveError):
1418
1222
 
1419
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1223
    _fmt = "Text did not match it's checksum: %(message)s"
1420
1224
 
1421
1225
 
1422
1226
class WeaveTextDiffers(WeaveError):
1444
1248
 
1445
1249
 
1446
1250
class VersionedFileError(BzrError):
1447
 
 
 
1251
    
1448
1252
    _fmt = "Versioned file error"
1449
1253
 
1450
1254
 
1451
1255
class RevisionNotPresent(VersionedFileError):
1452
 
 
1453
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1256
    
 
1257
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1454
1258
 
1455
1259
    def __init__(self, revision_id, file_id):
1456
1260
        VersionedFileError.__init__(self)
1459
1263
 
1460
1264
 
1461
1265
class RevisionAlreadyPresent(VersionedFileError):
1462
 
 
1463
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1266
    
 
1267
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1464
1268
 
1465
1269
    def __init__(self, revision_id, file_id):
1466
1270
        VersionedFileError.__init__(self)
1470
1274
 
1471
1275
class VersionedFileInvalidChecksum(VersionedFileError):
1472
1276
 
1473
 
    _fmt = "Text did not match its checksum: %(msg)s"
1474
 
 
1475
 
 
1476
 
class KnitError(InternalBzrError):
1477
 
 
 
1277
    _fmt = "Text did not match its checksum: %(message)s"
 
1278
 
 
1279
 
 
1280
class KnitError(BzrError):
 
1281
    
1478
1282
    _fmt = "Knit error"
1479
1283
 
 
1284
    internal_error = True
 
1285
 
 
1286
 
 
1287
class KnitHeaderError(KnitError):
 
1288
 
 
1289
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1290
 
 
1291
    def __init__(self, badline, filename):
 
1292
        KnitError.__init__(self)
 
1293
        self.badline = badline
 
1294
        self.filename = filename
 
1295
 
1480
1296
 
1481
1297
class KnitCorrupt(KnitError):
1482
1298
 
1488
1304
        self.how = how
1489
1305
 
1490
1306
 
1491
 
class SHA1KnitCorrupt(KnitCorrupt):
1492
 
 
1493
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1494
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1495
 
        "sha %(actual)s")
1496
 
 
1497
 
    def __init__(self, filename, actual, expected, key, content):
1498
 
        KnitError.__init__(self)
1499
 
        self.filename = filename
1500
 
        self.actual = actual
1501
 
        self.expected = expected
1502
 
        self.key = key
1503
 
        self.content = content
1504
 
 
1505
 
 
1506
 
class KnitDataStreamIncompatible(KnitError):
1507
 
    # Not raised anymore, as we can convert data streams.  In future we may
1508
 
    # need it again for more exotic cases, so we're keeping it around for now.
1509
 
 
1510
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1511
 
 
1512
 
    def __init__(self, stream_format, target_format):
1513
 
        self.stream_format = stream_format
1514
 
        self.target_format = target_format
1515
 
 
1516
 
 
1517
 
class KnitDataStreamUnknown(KnitError):
1518
 
    # Indicates a data stream we don't know how to handle.
1519
 
 
1520
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1521
 
 
1522
 
    def __init__(self, stream_format):
1523
 
        self.stream_format = stream_format
1524
 
 
1525
 
 
1526
 
class KnitHeaderError(KnitError):
1527
 
 
1528
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1529
 
 
1530
 
    def __init__(self, badline, filename):
1531
 
        KnitError.__init__(self)
1532
 
        self.badline = badline
1533
 
        self.filename = filename
1534
 
 
1535
1307
class KnitIndexUnknownMethod(KnitError):
1536
1308
    """Raised when we don't understand the storage method.
1537
1309
 
1538
1310
    Currently only 'fulltext' and 'line-delta' are supported.
1539
1311
    """
1540
 
 
 
1312
    
1541
1313
    _fmt = ("Knit index %(filename)s does not have a known method"
1542
1314
            " in options: %(options)r")
1543
1315
 
1547
1319
        self.options = options
1548
1320
 
1549
1321
 
1550
 
class RetryWithNewPacks(BzrError):
1551
 
    """Raised when we realize that the packs on disk have changed.
1552
 
 
1553
 
    This is meant as more of a signaling exception, to trap between where a
1554
 
    local error occurred and the code that can actually handle the error and
1555
 
    code that can retry appropriately.
1556
 
    """
1557
 
 
1558
 
    internal_error = True
1559
 
 
1560
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1561
 
            " %(orig_error)s")
1562
 
 
1563
 
    def __init__(self, context, reload_occurred, exc_info):
1564
 
        """create a new RetryWithNewPacks error.
1565
 
 
1566
 
        :param reload_occurred: Set to True if we know that the packs have
1567
 
            already been reloaded, and we are failing because of an in-memory
1568
 
            cache miss. If set to True then we will ignore if a reload says
1569
 
            nothing has changed, because we assume it has already reloaded. If
1570
 
            False, then a reload with nothing changed will force an error.
1571
 
        :param exc_info: The original exception traceback, so if there is a
1572
 
            problem we can raise the original error (value from sys.exc_info())
1573
 
        """
1574
 
        BzrError.__init__(self)
1575
 
        self.reload_occurred = reload_occurred
1576
 
        self.exc_info = exc_info
1577
 
        self.orig_error = exc_info[1]
1578
 
        # TODO: The global error handler should probably treat this by
1579
 
        #       raising/printing the original exception with a bit about
1580
 
        #       RetryWithNewPacks also not being caught
1581
 
 
1582
 
 
1583
 
class RetryAutopack(RetryWithNewPacks):
1584
 
    """Raised when we are autopacking and we find a missing file.
1585
 
 
1586
 
    Meant as a signaling exception, to tell the autopack code it should try
1587
 
    again.
1588
 
    """
1589
 
 
1590
 
    internal_error = True
1591
 
 
1592
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1593
 
            " context: %(context)s %(orig_error)s")
1594
 
 
1595
 
 
1596
1322
class NoSuchExportFormat(BzrError):
1597
 
 
 
1323
    
1598
1324
    _fmt = "Export format %(format)r not supported"
1599
1325
 
1600
1326
    def __init__(self, format):
1603
1329
 
1604
1330
 
1605
1331
class TransportError(BzrError):
1606
 
 
 
1332
    
1607
1333
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1608
1334
 
1609
1335
    def __init__(self, msg=None, orig_error=None):
1618
1344
        BzrError.__init__(self)
1619
1345
 
1620
1346
 
1621
 
class TooManyConcurrentRequests(InternalBzrError):
 
1347
class TooManyConcurrentRequests(BzrError):
1622
1348
 
1623
1349
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1624
1350
            " Be sure to finish_writing and finish_reading on the"
1625
1351
            " currently open request.")
1626
1352
 
 
1353
    internal_error = True
 
1354
 
1627
1355
    def __init__(self, medium):
1628
1356
        self.medium = medium
1629
1357
 
1636
1364
        self.details = details
1637
1365
 
1638
1366
 
1639
 
class UnexpectedProtocolVersionMarker(TransportError):
1640
 
 
1641
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1642
 
 
1643
 
    def __init__(self, marker):
1644
 
        self.marker = marker
1645
 
 
1646
 
 
1647
 
class UnknownSmartMethod(InternalBzrError):
1648
 
 
1649
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1650
 
 
1651
 
    def __init__(self, verb):
1652
 
        self.verb = verb
1653
 
 
1654
 
 
1655
 
class SmartMessageHandlerError(InternalBzrError):
1656
 
 
1657
 
    _fmt = ("The message handler raised an exception:\n"
1658
 
            "%(traceback_text)s")
1659
 
 
1660
 
    def __init__(self, exc_info):
1661
 
        import traceback
1662
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1663
 
        self.exc_info = exc_info
1664
 
        traceback_strings = traceback.format_exception(
1665
 
                self.exc_type, self.exc_value, self.exc_tb)
1666
 
        self.traceback_text = ''.join(traceback_strings)
1667
 
 
1668
 
 
1669
1367
# A set of semi-meaningful errors which can be thrown
1670
1368
class TransportNotPossible(TransportError):
1671
1369
 
1696
1394
            self.port = ':%s' % port
1697
1395
 
1698
1396
 
1699
 
# XXX: This is also used for unexpected end of file, which is different at the
1700
 
# TCP level from "connection reset".
1701
1397
class ConnectionReset(TransportError):
1702
1398
 
1703
1399
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1705
1401
 
1706
1402
class InvalidRange(TransportError):
1707
1403
 
1708
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1709
 
 
1710
 
    def __init__(self, path, offset, msg=None):
1711
 
        TransportError.__init__(self, msg)
 
1404
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1405
    
 
1406
    def __init__(self, path, offset):
 
1407
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1408
                                       % (path, offset)))
1712
1409
        self.path = path
1713
1410
        self.offset = offset
1714
1411
 
1715
1412
 
1716
1413
class InvalidHttpResponse(TransportError):
1717
1414
 
1718
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1415
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1719
1416
 
1720
1417
    def __init__(self, path, msg, orig_error=None):
1721
1418
        self.path = path
1722
 
        if orig_error is None:
1723
 
            orig_error = ''
1724
 
        else:
1725
 
            # This is reached for obscure and unusual errors so we want to
1726
 
            # preserve as much info as possible to ease debug.
1727
 
            orig_error = ': %r' % (orig_error,)
1728
1419
        TransportError.__init__(self, msg, orig_error=orig_error)
1729
1420
 
1730
1421
 
1731
1422
class InvalidHttpRange(InvalidHttpResponse):
1732
1423
 
1733
1424
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1734
 
 
 
1425
    
1735
1426
    def __init__(self, path, range, msg):
1736
1427
        self.range = range
1737
1428
        InvalidHttpResponse.__init__(self, path, msg)
1740
1431
class InvalidHttpContentType(InvalidHttpResponse):
1741
1432
 
1742
1433
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1743
 
 
 
1434
    
1744
1435
    def __init__(self, path, ctype, msg):
1745
1436
        self.ctype = ctype
1746
1437
        InvalidHttpResponse.__init__(self, path, msg)
1750
1441
 
1751
1442
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1752
1443
 
1753
 
    def __init__(self, source, target, is_permanent=False):
 
1444
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1754
1445
        self.source = source
1755
1446
        self.target = target
1756
 
        if is_permanent:
 
1447
        if is_permament:
1757
1448
            self.permanently = ' permanently'
1758
1449
        else:
1759
1450
            self.permanently = ''
 
1451
        self.is_permament = is_permament
 
1452
        self._qualified_proto = qual_proto
1760
1453
        TransportError.__init__(self)
1761
1454
 
 
1455
    def _requalify_url(self, url):
 
1456
        """Restore the qualified proto in front of the url"""
 
1457
        # When this exception is raised, source and target are in
 
1458
        # user readable format. But some transports may use a
 
1459
        # different proto (http+urllib:// will present http:// to
 
1460
        # the user. If a qualified proto is specified, the code
 
1461
        # trapping the exception can get the qualified urls to
 
1462
        # properly handle the redirection themself (creating a
 
1463
        # new transport object from the target url for example).
 
1464
        # But checking that the scheme of the original and
 
1465
        # redirected urls are the same can be tricky. (see the
 
1466
        # FIXME in BzrDir.open_from_transport for the unique use
 
1467
        # case so far).
 
1468
        if self._qualified_proto is None:
 
1469
            return url
 
1470
 
 
1471
        # The TODO related to NotBranchError mention that doing
 
1472
        # that kind of manipulation on the urls may not be the
 
1473
        # exception object job. On the other hand, this object is
 
1474
        # the interface between the code and the user so
 
1475
        # presenting the urls in different ways is indeed its
 
1476
        # job...
 
1477
        import urlparse
 
1478
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1479
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1480
                                   query, fragment))
 
1481
 
 
1482
    def get_source_url(self):
 
1483
        return self._requalify_url(self.source)
 
1484
 
 
1485
    def get_target_url(self):
 
1486
        return self._requalify_url(self.target)
 
1487
 
1762
1488
 
1763
1489
class TooManyRedirections(TransportError):
1764
1490
 
1765
1491
    _fmt = "Too many redirections"
1766
1492
 
1767
 
 
1768
1493
class ConflictsInTree(BzrError):
1769
1494
 
1770
1495
    _fmt = "Working tree has conflicts."
1771
1496
 
1772
1497
 
1773
 
class ConfigContentError(BzrError):
1774
 
 
1775
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1776
 
 
1777
 
    def __init__(self, filename):
1778
 
        BzrError.__init__(self)
1779
 
        self.filename = filename
1780
 
 
1781
 
 
1782
1498
class ParseConfigError(BzrError):
1783
1499
 
1784
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1785
 
 
1786
1500
    def __init__(self, errors, filename):
1787
 
        BzrError.__init__(self)
1788
 
        self.filename = filename
1789
 
        self.errors = '\n'.join(e.msg for e in errors)
 
1501
        if filename is None:
 
1502
            filename = ""
 
1503
        message = "Error(s) parsing config file %s:\n%s" % \
 
1504
            (filename, ('\n'.join(e.message for e in errors)))
 
1505
        BzrError.__init__(self, message)
1790
1506
 
1791
1507
 
1792
1508
class NoEmailInUsername(BzrError):
1800
1516
 
1801
1517
class SigningFailed(BzrError):
1802
1518
 
1803
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1519
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1804
1520
 
1805
1521
    def __init__(self, command_line):
1806
1522
        BzrError.__init__(self, command_line=command_line)
1807
1523
 
1808
1524
 
1809
 
class SignatureVerificationFailed(BzrError):
1810
 
 
1811
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1812
 
 
1813
 
    def __init__(self, error):
1814
 
        BzrError.__init__(self, error=error)
1815
 
 
1816
 
 
1817
 
class DependencyNotPresent(BzrError):
1818
 
 
1819
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1820
 
 
1821
 
    def __init__(self, library, error):
1822
 
        BzrError.__init__(self, library=library, error=error)
1823
 
 
1824
 
 
1825
 
class GpgmeNotInstalled(DependencyNotPresent):
1826
 
 
1827
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1828
 
 
1829
 
    def __init__(self, error):
1830
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1831
 
 
1832
 
 
1833
1525
class WorkingTreeNotRevision(BzrError):
1834
1526
 
1835
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1527
    _fmt = ("The working tree for %(basedir)s has changed since" 
1836
1528
            " the last commit, but weave merge requires that it be"
1837
1529
            " unchanged")
1838
1530
 
1855
1547
        self.graph = graph
1856
1548
 
1857
1549
 
1858
 
class WritingCompleted(InternalBzrError):
 
1550
class WritingCompleted(BzrError):
1859
1551
 
1860
1552
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1861
1553
            "called upon it - accept bytes may not be called anymore.")
1862
1554
 
 
1555
    internal_error = True
 
1556
 
1863
1557
    def __init__(self, request):
1864
1558
        self.request = request
1865
1559
 
1866
1560
 
1867
 
class WritingNotComplete(InternalBzrError):
 
1561
class WritingNotComplete(BzrError):
1868
1562
 
1869
1563
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1870
1564
            "called upon it - until the write phase is complete no "
1871
1565
            "data may be read.")
1872
1566
 
 
1567
    internal_error = True
 
1568
 
1873
1569
    def __init__(self, request):
1874
1570
        self.request = request
1875
1571
 
1883
1579
        self.filename = filename
1884
1580
 
1885
1581
 
1886
 
class MediumNotConnected(InternalBzrError):
 
1582
class MediumNotConnected(BzrError):
1887
1583
 
1888
1584
    _fmt = """The medium '%(medium)s' is not connected."""
1889
1585
 
 
1586
    internal_error = True
 
1587
 
1890
1588
    def __init__(self, medium):
1891
1589
        self.medium = medium
1892
1590
 
1898
1596
 
1899
1597
class NoBundleFound(BzrError):
1900
1598
 
1901
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1599
    _fmt = "No bundle was found in %(filename)s"
1902
1600
 
1903
1601
    def __init__(self, filename):
1904
1602
        BzrError.__init__(self)
1927
1625
        self.text_revision = text_revision
1928
1626
        self.file_id = file_id
1929
1627
 
1930
 
 
1931
1628
class DuplicateFileId(BzrError):
1932
1629
 
1933
1630
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1968
1665
        self.root_trans_id = transform.root
1969
1666
 
1970
1667
 
1971
 
class BzrBadParameter(InternalBzrError):
 
1668
class BzrBadParameter(BzrError):
1972
1669
 
1973
1670
    _fmt = "Bad parameter: %(param)r"
1974
1671
 
 
1672
    internal_error = True
 
1673
 
1975
1674
    # This exception should never be thrown, but it is a base class for all
1976
1675
    # parameter-to-function errors.
1977
1676
 
1995
1694
    _fmt = "Moving the root directory is not supported at this time"
1996
1695
 
1997
1696
 
1998
 
class TransformRenameFailed(BzrError):
1999
 
 
2000
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2001
 
 
2002
 
    def __init__(self, from_path, to_path, why, errno):
2003
 
        self.from_path = from_path
2004
 
        self.to_path = to_path
2005
 
        self.why = why
2006
 
        self.errno = errno
2007
 
 
2008
 
 
2009
1697
class BzrMoveFailedError(BzrError):
2010
1698
 
2011
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2012
 
        "%(_has_extra)s%(extra)s")
 
1699
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2013
1700
 
2014
1701
    def __init__(self, from_path='', to_path='', extra=None):
2015
 
        from bzrlib.osutils import splitpath
2016
1702
        BzrError.__init__(self)
2017
1703
        if extra:
2018
 
            self.extra, self._has_extra = extra, ': '
 
1704
            self.extra = ': ' + str(extra)
2019
1705
        else:
2020
 
            self.extra = self._has_extra = ''
 
1706
            self.extra = ''
2021
1707
 
2022
1708
        has_from = len(from_path) > 0
2023
1709
        has_to = len(to_path) > 0
2024
1710
        if has_from:
2025
 
            self.from_path = splitpath(from_path)[-1]
 
1711
            self.from_path = osutils.splitpath(from_path)[-1]
2026
1712
        else:
2027
1713
            self.from_path = ''
2028
1714
 
2029
1715
        if has_to:
2030
 
            self.to_path = splitpath(to_path)[-1]
 
1716
            self.to_path = osutils.splitpath(to_path)[-1]
2031
1717
        else:
2032
1718
            self.to_path = ''
2033
1719
 
2044
1730
 
2045
1731
class BzrRenameFailedError(BzrMoveFailedError):
2046
1732
 
2047
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2048
 
        "%(_has_extra)s%(extra)s")
 
1733
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2049
1734
 
2050
1735
    def __init__(self, from_path, to_path, extra=None):
2051
1736
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2052
1737
 
2053
 
 
2054
1738
class BzrRemoveChangedFilesError(BzrError):
2055
1739
    """Used when user is trying to remove changed files."""
2056
1740
 
2057
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2058
 
        "%(changes_as_text)s"
 
1741
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
2059
1742
        "Use --keep to not delete them, or --force to delete them regardless.")
2060
1743
 
2061
1744
    def __init__(self, tree_delta):
2062
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2063
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2064
1745
        BzrError.__init__(self)
2065
1746
        self.changes_as_text = tree_delta.get_changes_as_text()
2066
1747
        #self.paths_as_string = '\n'.join(changed_files)
2074
1755
 
2075
1756
class BzrBadParameterMissing(BzrBadParameter):
2076
1757
 
2077
 
    _fmt = "Parameter %(param)s is required but not present."
 
1758
    _fmt = "Parameter $(param)s is required but not present."
2078
1759
 
2079
1760
 
2080
1761
class BzrBadParameterUnicode(BzrBadParameter):
2088
1769
    _fmt = "Parameter %(param)s contains a newline."
2089
1770
 
2090
1771
 
 
1772
class DependencyNotPresent(BzrError):
 
1773
 
 
1774
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1775
 
 
1776
    def __init__(self, library, error):
 
1777
        BzrError.__init__(self, library=library, error=error)
 
1778
 
 
1779
 
2091
1780
class ParamikoNotPresent(DependencyNotPresent):
2092
1781
 
2093
1782
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2112
1801
 
2113
1802
class BadConversionTarget(BzrError):
2114
1803
 
2115
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2116
 
            "    %(problem)s"
 
1804
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2117
1805
 
2118
 
    def __init__(self, problem, format, from_format=None):
 
1806
    def __init__(self, problem, format):
2119
1807
        BzrError.__init__(self)
2120
1808
        self.problem = problem
2121
1809
        self.format = format
2122
 
        self.from_format = from_format or '(unspecified)'
2123
 
 
2124
 
 
2125
 
class NoDiffFound(BzrError):
2126
 
 
2127
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2128
 
 
2129
 
    def __init__(self, path):
2130
 
        BzrError.__init__(self, path)
2131
 
 
2132
 
 
2133
 
class ExecutableMissing(BzrError):
2134
 
 
2135
 
    _fmt = "%(exe_name)s could not be found on this machine"
2136
 
 
2137
 
    def __init__(self, exe_name):
2138
 
        BzrError.__init__(self, exe_name=exe_name)
2139
1810
 
2140
1811
 
2141
1812
class NoDiff(BzrError):
2151
1822
    _fmt = "Diff3 is not installed on this machine."
2152
1823
 
2153
1824
 
2154
 
class ExistingContent(BzrError):
2155
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2156
 
 
2157
 
    _fmt = "The content being inserted is already present."
2158
 
 
2159
 
 
2160
1825
class ExistingLimbo(BzrError):
2161
1826
 
2162
1827
    _fmt = """This tree contains left-over files from a failed operation.
2163
1828
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2164
1829
    keep, and delete it when you are done."""
2165
 
 
 
1830
    
2166
1831
    def __init__(self, limbo_dir):
2167
1832
       BzrError.__init__(self)
2168
1833
       self.limbo_dir = limbo_dir
2169
1834
 
2170
1835
 
2171
 
class ExistingPendingDeletion(BzrError):
2172
 
 
2173
 
    _fmt = """This tree contains left-over files from a failed operation.
2174
 
    Please examine %(pending_deletion)s to see if it contains any files you
2175
 
    wish to keep, and delete it when you are done."""
2176
 
 
2177
 
    def __init__(self, pending_deletion):
2178
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2179
 
 
2180
 
 
2181
1836
class ImmortalLimbo(BzrError):
2182
1837
 
2183
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1838
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2184
1839
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2185
1840
    keep, and delete it when you are done."""
2186
1841
 
2189
1844
       self.limbo_dir = limbo_dir
2190
1845
 
2191
1846
 
2192
 
class ImmortalPendingDeletion(BzrError):
2193
 
 
2194
 
    _fmt = ("Unable to delete transform temporary directory "
2195
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2196
 
    "contains any files you wish to keep, and delete it when you are done.")
2197
 
 
2198
 
    def __init__(self, pending_deletion):
2199
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2200
 
 
2201
 
 
2202
1847
class OutOfDateTree(BzrError):
2203
1848
 
2204
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1849
    _fmt = "Working tree is out of date, please run 'bzr update'."
2205
1850
 
2206
 
    def __init__(self, tree, more=None):
2207
 
        if more is None:
2208
 
            more = ''
2209
 
        else:
2210
 
            more = ' ' + more
 
1851
    def __init__(self, tree):
2211
1852
        BzrError.__init__(self)
2212
1853
        self.tree = tree
2213
 
        self.more = more
2214
1854
 
2215
1855
 
2216
1856
class PublicBranchOutOfDate(BzrError):
2236
1876
    _fmt = "Format error in conflict listings"
2237
1877
 
2238
1878
 
2239
 
class CorruptDirstate(BzrError):
2240
 
 
2241
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2242
 
            "Error: %(description)s")
2243
 
 
2244
 
    def __init__(self, dirstate_path, description):
2245
 
        BzrError.__init__(self)
2246
 
        self.dirstate_path = dirstate_path
2247
 
        self.description = description
2248
 
 
2249
 
 
2250
1879
class CorruptRepository(BzrError):
2251
1880
 
2252
1881
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2254
1883
 
2255
1884
    def __init__(self, repo):
2256
1885
        BzrError.__init__(self)
2257
 
        self.repo_path = repo.user_url
2258
 
 
2259
 
 
2260
 
class InconsistentDelta(BzrError):
2261
 
    """Used when we get a delta that is not valid."""
2262
 
 
2263
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2264
 
            " %(file_id)r\nreason: %(reason)s")
2265
 
 
2266
 
    def __init__(self, path, file_id, reason):
2267
 
        BzrError.__init__(self)
2268
 
        self.path = path
2269
 
        self.file_id = file_id
2270
 
        self.reason = reason
2271
 
 
2272
 
 
2273
 
class InconsistentDeltaDelta(InconsistentDelta):
2274
 
    """Used when we get a delta that is not valid."""
2275
 
 
2276
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2277
 
            "\nreason: %(reason)s")
2278
 
 
2279
 
    def __init__(self, delta, reason):
2280
 
        BzrError.__init__(self)
2281
 
        self.delta = delta
2282
 
        self.reason = reason
 
1886
        self.repo_path = repo.bzrdir.root_transport.base
2283
1887
 
2284
1888
 
2285
1889
class UpgradeRequired(BzrError):
2291
1895
        self.path = path
2292
1896
 
2293
1897
 
2294
 
class RepositoryUpgradeRequired(UpgradeRequired):
2295
 
 
2296
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2297
 
 
2298
 
 
2299
 
class RichRootUpgradeRequired(UpgradeRequired):
2300
 
 
2301
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2302
 
           " a format which supports rich roots.")
2303
 
 
2304
 
 
2305
1898
class LocalRequiresBoundBranch(BzrError):
2306
1899
 
2307
1900
    _fmt = "Cannot perform local-only commits on unbound branches."
2308
1901
 
2309
1902
 
 
1903
class MissingProgressBarFinish(BzrError):
 
1904
 
 
1905
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1906
 
 
1907
 
 
1908
class InvalidProgressBarType(BzrError):
 
1909
 
 
1910
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1911
            " is not a supported type Select one of: %(valid_types)s")
 
1912
 
 
1913
    def __init__(self, bar_type, valid_types):
 
1914
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1915
 
 
1916
 
2310
1917
class UnsupportedOperation(BzrError):
2311
1918
 
2312
1919
    _fmt = ("The method %(mname)s is not supported on"
2329
1936
 
2330
1937
 
2331
1938
class BinaryFile(BzrError):
2332
 
 
 
1939
    
2333
1940
    _fmt = "File is binary but should be text."
2334
1941
 
2335
1942
 
2355
1962
 
2356
1963
 
2357
1964
class NotABundle(BzrError):
2358
 
 
 
1965
    
2359
1966
    _fmt = "Not a bzr revision-bundle: %(text)r"
2360
1967
 
2361
1968
    def __init__(self, text):
2363
1970
        self.text = text
2364
1971
 
2365
1972
 
2366
 
class BadBundle(BzrError):
2367
 
 
 
1973
class BadBundle(BzrError): 
 
1974
    
2368
1975
    _fmt = "Bad bzr revision-bundle: %(text)r"
2369
1976
 
2370
1977
    def __init__(self, text):
2372
1979
        self.text = text
2373
1980
 
2374
1981
 
2375
 
class MalformedHeader(BadBundle):
2376
 
 
 
1982
class MalformedHeader(BadBundle): 
 
1983
    
2377
1984
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2378
1985
 
2379
1986
 
2380
 
class MalformedPatches(BadBundle):
2381
 
 
 
1987
class MalformedPatches(BadBundle): 
 
1988
    
2382
1989
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2383
1990
 
2384
1991
 
2385
 
class MalformedFooter(BadBundle):
2386
 
 
 
1992
class MalformedFooter(BadBundle): 
 
1993
    
2387
1994
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2388
1995
 
2389
1996
 
2390
1997
class UnsupportedEOLMarker(BadBundle):
2391
 
 
2392
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1998
    
 
1999
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2393
2000
 
2394
2001
    def __init__(self):
2395
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2002
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2396
2003
        # but for this there is not
2397
2004
        BzrError.__init__(self)
2398
2005
 
2399
2006
 
2400
2007
class IncompatibleBundleFormat(BzrError):
2401
 
 
 
2008
    
2402
2009
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2403
2010
 
2404
2011
    def __init__(self, bundle_format, other):
2408
2015
 
2409
2016
 
2410
2017
class BadInventoryFormat(BzrError):
2411
 
 
 
2018
    
2412
2019
    _fmt = "Root class for inventory serialization errors"
2413
2020
 
2414
2021
 
2425
2032
    _fmt = """This operation requires rich root data storage"""
2426
2033
 
2427
2034
 
2428
 
class NoSmartMedium(InternalBzrError):
 
2035
class NoSmartMedium(BzrError):
2429
2036
 
2430
2037
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2431
2038
 
 
2039
    internal_error = True
 
2040
 
2432
2041
    def __init__(self, transport):
2433
2042
        self.transport = transport
2434
2043
 
2435
2044
 
 
2045
class NoSmartServer(NotBranchError):
 
2046
 
 
2047
    _fmt = "No smart server available at %(url)s"
 
2048
 
 
2049
    def __init__(self, url):
 
2050
        self.url = url
 
2051
 
 
2052
 
2436
2053
class UnknownSSH(BzrError):
2437
2054
 
2438
2055
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2448
2065
            " Please set BZR_SSH environment variable.")
2449
2066
 
2450
2067
 
2451
 
class GhostRevisionsHaveNoRevno(BzrError):
2452
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2453
 
 
2454
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2455
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2456
 
 
2457
 
    def __init__(self, revision_id, ghost_revision_id):
2458
 
        self.revision_id = revision_id
2459
 
        self.ghost_revision_id = ghost_revision_id
2460
 
 
2461
 
 
2462
2068
class GhostRevisionUnusableHere(BzrError):
2463
2069
 
2464
2070
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2468
2074
        self.revision_id = revision_id
2469
2075
 
2470
2076
 
2471
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2077
class IllegalUseOfScopeReplacer(BzrError):
2472
2078
 
2473
2079
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2474
2080
            " %(msg)s%(extra)s")
2475
2081
 
 
2082
    internal_error = True
 
2083
 
2476
2084
    def __init__(self, name, msg, extra=None):
2477
2085
        BzrError.__init__(self)
2478
2086
        self.name = name
2483
2091
            self.extra = ''
2484
2092
 
2485
2093
 
2486
 
class InvalidImportLine(InternalBzrError):
 
2094
class InvalidImportLine(BzrError):
2487
2095
 
2488
2096
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2489
2097
 
 
2098
    internal_error = True
 
2099
 
2490
2100
    def __init__(self, text, msg):
2491
2101
        BzrError.__init__(self)
2492
2102
        self.text = text
2493
2103
        self.msg = msg
2494
2104
 
2495
2105
 
2496
 
class ImportNameCollision(InternalBzrError):
 
2106
class ImportNameCollision(BzrError):
2497
2107
 
2498
2108
    _fmt = ("Tried to import an object to the same name as"
2499
2109
            " an existing object. %(name)s")
2500
2110
 
 
2111
    internal_error = True
 
2112
 
2501
2113
    def __init__(self, name):
2502
2114
        BzrError.__init__(self)
2503
2115
        self.name = name
2535
2147
class PatchMissing(BzrError):
2536
2148
    """Raise a patch type was specified but no patch supplied"""
2537
2149
 
2538
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2150
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2539
2151
 
2540
2152
    def __init__(self, patch_type):
2541
2153
        BzrError.__init__(self)
2542
2154
        self.patch_type = patch_type
2543
2155
 
2544
2156
 
2545
 
class TargetNotBranch(BzrError):
2546
 
    """A merge directive's target branch is required, but isn't a branch"""
2547
 
 
2548
 
    _fmt = ("Your branch does not have all of the revisions required in "
2549
 
            "order to merge this merge directive and the target "
2550
 
            "location specified in the merge directive is not a branch: "
2551
 
            "%(location)s.")
2552
 
 
2553
 
    def __init__(self, location):
2554
 
        BzrError.__init__(self)
2555
 
        self.location = location
2556
 
 
2557
 
 
2558
2157
class UnsupportedInventoryKind(BzrError):
2559
 
 
 
2158
    
2560
2159
    _fmt = """Unsupported entry kind %(kind)s"""
2561
2160
 
2562
2161
    def __init__(self, kind):
2565
2164
 
2566
2165
class BadSubsumeSource(BzrError):
2567
2166
 
2568
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2167
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2569
2168
 
2570
2169
    def __init__(self, tree, other_tree, reason):
2571
2170
        self.tree = tree
2574
2173
 
2575
2174
 
2576
2175
class SubsumeTargetNeedsUpgrade(BzrError):
2577
 
 
 
2176
    
2578
2177
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2579
2178
 
2580
2179
    def __init__(self, other_tree):
2581
2180
        self.other_tree = other_tree
2582
2181
 
2583
2182
 
2584
 
class BadReferenceTarget(InternalBzrError):
2585
 
 
2586
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2587
 
           "%(reason)s"
 
2183
class BadReferenceTarget(BzrError):
 
2184
 
 
2185
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2186
 
 
2187
    internal_error = True
2588
2188
 
2589
2189
    def __init__(self, tree, other_tree, reason):
2590
2190
        self.tree = tree
2603
2203
class TagsNotSupported(BzrError):
2604
2204
 
2605
2205
    _fmt = ("Tags not supported by %(branch)s;"
2606
 
            " you may be able to use bzr upgrade.")
 
2206
            " you may be able to use bzr upgrade --dirstate-tags.")
2607
2207
 
2608
2208
    def __init__(self, branch):
2609
2209
        self.branch = branch
2610
2210
 
2611
 
 
 
2211
        
2612
2212
class TagAlreadyExists(BzrError):
2613
2213
 
2614
2214
    _fmt = "Tag %(tag_name)s already exists."
2619
2219
 
2620
2220
class MalformedBugIdentifier(BzrError):
2621
2221
 
2622
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2623
 
            'See "bzr help bugs" for more information on this feature.')
 
2222
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2624
2223
 
2625
2224
    def __init__(self, bug_id, reason):
2626
2225
        self.bug_id = bug_id
2627
2226
        self.reason = reason
2628
2227
 
2629
2228
 
2630
 
class InvalidBugTrackerURL(BzrError):
2631
 
 
2632
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2633
 
            "contain {id}: %(url)s")
2634
 
 
2635
 
    def __init__(self, abbreviation, url):
2636
 
        self.abbreviation = abbreviation
2637
 
        self.url = url
2638
 
 
2639
 
 
2640
2229
class UnknownBugTrackerAbbreviation(BzrError):
2641
2230
 
2642
2231
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2647
2236
        self.branch = branch
2648
2237
 
2649
2238
 
2650
 
class InvalidLineInBugsProperty(BzrError):
2651
 
 
2652
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2653
 
 
2654
 
    def __init__(self, line):
2655
 
        self.line = line
2656
 
 
2657
 
 
2658
 
class InvalidBugStatus(BzrError):
2659
 
 
2660
 
    _fmt = ("Invalid bug status: '%(status)s'")
2661
 
 
2662
 
    def __init__(self, status):
2663
 
        self.status = status
2664
 
 
2665
 
 
2666
2239
class UnexpectedSmartServerResponse(BzrError):
2667
2240
 
2668
2241
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2671
2244
        self.response_tuple = response_tuple
2672
2245
 
2673
2246
 
2674
 
class ErrorFromSmartServer(BzrError):
2675
 
    """An error was received from a smart server.
2676
 
 
2677
 
    :seealso: UnknownErrorFromSmartServer
2678
 
    """
2679
 
 
2680
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2681
 
 
2682
 
    internal_error = True
2683
 
 
2684
 
    def __init__(self, error_tuple):
2685
 
        self.error_tuple = error_tuple
2686
 
        try:
2687
 
            self.error_verb = error_tuple[0]
2688
 
        except IndexError:
2689
 
            self.error_verb = None
2690
 
        self.error_args = error_tuple[1:]
2691
 
 
2692
 
 
2693
 
class UnknownErrorFromSmartServer(BzrError):
2694
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2695
 
    error.
2696
 
 
2697
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2698
 
    distinguish between the following two cases:
2699
 
 
2700
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2701
 
      and so should provoke a traceback to the user.
2702
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2703
 
      translated.  This is probably because the server sent us garbage, and
2704
 
      should not provoke a traceback.
2705
 
    """
2706
 
 
2707
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2708
 
 
2709
 
    internal_error = False
2710
 
 
2711
 
    def __init__(self, error_from_smart_server):
2712
 
        """Constructor.
2713
 
 
2714
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2715
 
        """
2716
 
        self.error_from_smart_server = error_from_smart_server
2717
 
        self.error_tuple = error_from_smart_server.error_tuple
2718
 
 
2719
 
 
2720
2247
class ContainerError(BzrError):
2721
2248
    """Base class of container errors."""
2722
2249
 
2724
2251
class UnknownContainerFormatError(ContainerError):
2725
2252
 
2726
2253
    _fmt = "Unrecognised container format: %(container_format)r"
2727
 
 
 
2254
    
2728
2255
    def __init__(self, container_format):
2729
2256
        self.container_format = container_format
2730
2257
 
2733
2260
 
2734
2261
    _fmt = "Unexpected end of container stream"
2735
2262
 
 
2263
    internal_error = False
 
2264
 
2736
2265
 
2737
2266
class UnknownRecordTypeError(ContainerError):
2738
2267
 
2760
2289
 
2761
2290
class DuplicateRecordNameError(ContainerError):
2762
2291
 
2763
 
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2292
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
2764
2293
 
2765
2294
    def __init__(self, name):
2766
2295
        self.name = name
2767
2296
 
2768
2297
 
2769
 
class NoDestinationAddress(InternalBzrError):
 
2298
class NoDestinationAddress(BzrError):
2770
2299
 
2771
2300
    _fmt = "Message does not have a destination address."
2772
2301
 
2773
 
 
2774
 
class RepositoryDataStreamError(BzrError):
2775
 
 
2776
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2777
 
 
2778
 
    def __init__(self, reason):
2779
 
        self.reason = reason
 
2302
    internal_error = True
2780
2303
 
2781
2304
 
2782
2305
class SMTPError(BzrError):
2785
2308
 
2786
2309
    def __init__(self, error):
2787
2310
        self.error = error
2788
 
 
2789
 
 
2790
 
class NoMessageSupplied(BzrError):
2791
 
 
2792
 
    _fmt = "No message supplied."
2793
 
 
2794
 
 
2795
 
class NoMailAddressSpecified(BzrError):
2796
 
 
2797
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2798
 
 
2799
 
 
2800
 
class UnknownMailClient(BzrError):
2801
 
 
2802
 
    _fmt = "Unknown mail client: %(mail_client)s"
2803
 
 
2804
 
    def __init__(self, mail_client):
2805
 
        BzrError.__init__(self, mail_client=mail_client)
2806
 
 
2807
 
 
2808
 
class MailClientNotFound(BzrError):
2809
 
 
2810
 
    _fmt = "Unable to find mail client with the following names:"\
2811
 
        " %(mail_command_list_string)s"
2812
 
 
2813
 
    def __init__(self, mail_command_list):
2814
 
        mail_command_list_string = ', '.join(mail_command_list)
2815
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2816
 
                          mail_command_list_string=mail_command_list_string)
2817
 
 
2818
 
class SMTPConnectionRefused(SMTPError):
2819
 
 
2820
 
    _fmt = "SMTP connection to %(host)s refused"
2821
 
 
2822
 
    def __init__(self, error, host):
2823
 
        self.error = error
2824
 
        self.host = host
2825
 
 
2826
 
 
2827
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2828
 
 
2829
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2830
 
 
2831
 
 
2832
 
class BzrDirError(BzrError):
2833
 
 
2834
 
    def __init__(self, bzrdir):
2835
 
        import bzrlib.urlutils as urlutils
2836
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2837
 
                                                    'ascii')
2838
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2839
 
 
2840
 
 
2841
 
class UnsyncedBranches(BzrDirError):
2842
 
 
2843
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2844
 
            " bzr help sync-for-reconfigure.")
2845
 
 
2846
 
    def __init__(self, bzrdir, target_branch):
2847
 
        BzrDirError.__init__(self, bzrdir)
2848
 
        import bzrlib.urlutils as urlutils
2849
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2850
 
                                                        'ascii')
2851
 
 
2852
 
 
2853
 
class AlreadyBranch(BzrDirError):
2854
 
 
2855
 
    _fmt = "'%(display_url)s' is already a branch."
2856
 
 
2857
 
 
2858
 
class AlreadyTree(BzrDirError):
2859
 
 
2860
 
    _fmt = "'%(display_url)s' is already a tree."
2861
 
 
2862
 
 
2863
 
class AlreadyCheckout(BzrDirError):
2864
 
 
2865
 
    _fmt = "'%(display_url)s' is already a checkout."
2866
 
 
2867
 
 
2868
 
class AlreadyLightweightCheckout(BzrDirError):
2869
 
 
2870
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2871
 
 
2872
 
 
2873
 
class AlreadyUsingShared(BzrDirError):
2874
 
 
2875
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2876
 
 
2877
 
 
2878
 
class AlreadyStandalone(BzrDirError):
2879
 
 
2880
 
    _fmt = "'%(display_url)s' is already standalone."
2881
 
 
2882
 
 
2883
 
class AlreadyWithTrees(BzrDirError):
2884
 
 
2885
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2886
 
            "working trees.")
2887
 
 
2888
 
 
2889
 
class AlreadyWithNoTrees(BzrDirError):
2890
 
 
2891
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2892
 
            "working trees.")
2893
 
 
2894
 
 
2895
 
class ReconfigurationNotSupported(BzrDirError):
2896
 
 
2897
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2898
 
 
2899
 
 
2900
 
class NoBindLocation(BzrDirError):
2901
 
 
2902
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2903
 
 
2904
 
 
2905
 
class UncommittedChanges(BzrError):
2906
 
 
2907
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2908
 
            ' (See bzr status).%(more)s')
2909
 
 
2910
 
    def __init__(self, tree, more=None):
2911
 
        if more is None:
2912
 
            more = ''
2913
 
        else:
2914
 
            more = ' ' + more
2915
 
        import bzrlib.urlutils as urlutils
2916
 
        user_url = getattr(tree, "user_url", None)
2917
 
        if user_url is None:
2918
 
            display_url = str(tree)
2919
 
        else:
2920
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2921
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2922
 
 
2923
 
 
2924
 
class ShelvedChanges(UncommittedChanges):
2925
 
 
2926
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2927
 
            ' (See bzr shelve --list).%(more)s')
2928
 
 
2929
 
 
2930
 
class MissingTemplateVariable(BzrError):
2931
 
 
2932
 
    _fmt = 'Variable {%(name)s} is not available.'
2933
 
 
2934
 
    def __init__(self, name):
2935
 
        self.name = name
2936
 
 
2937
 
 
2938
 
class NoTemplate(BzrError):
2939
 
 
2940
 
    _fmt = 'No template specified.'
2941
 
 
2942
 
 
2943
 
class UnableCreateSymlink(BzrError):
2944
 
 
2945
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2946
 
 
2947
 
    def __init__(self, path=None):
2948
 
        path_str = ''
2949
 
        if path:
2950
 
            try:
2951
 
                path_str = repr(str(path))
2952
 
            except UnicodeEncodeError:
2953
 
                path_str = repr(path)
2954
 
            path_str += ' '
2955
 
        self.path_str = path_str
2956
 
 
2957
 
 
2958
 
class UnsupportedTimezoneFormat(BzrError):
2959
 
 
2960
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2961
 
            'options are "utc", "original", "local".')
2962
 
 
2963
 
    def __init__(self, timezone):
2964
 
        self.timezone = timezone
2965
 
 
2966
 
 
2967
 
class CommandAvailableInPlugin(StandardError):
2968
 
 
2969
 
    internal_error = False
2970
 
 
2971
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2972
 
 
2973
 
        self.plugin_metadata = plugin_metadata
2974
 
        self.cmd_name = cmd_name
2975
 
        self.provider = provider
2976
 
 
2977
 
    def __str__(self):
2978
 
 
2979
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2980
 
                'However, the following official plugin provides this command: %s\n'
2981
 
                'You can install it by going to: %s'
2982
 
                % (self.cmd_name, self.plugin_metadata['name'],
2983
 
                    self.plugin_metadata['url']))
2984
 
 
2985
 
        return _fmt
2986
 
 
2987
 
 
2988
 
class NoPluginAvailable(BzrError):
2989
 
    pass
2990
 
 
2991
 
 
2992
 
class UnableEncodePath(BzrError):
2993
 
 
2994
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2995
 
            'user encoding %(user_encoding)s')
2996
 
 
2997
 
    def __init__(self, path, kind):
2998
 
        from bzrlib.osutils import get_user_encoding
2999
 
        self.path = path
3000
 
        self.kind = kind
3001
 
        self.user_encoding = osutils.get_user_encoding()
3002
 
 
3003
 
 
3004
 
class NoSuchConfig(BzrError):
3005
 
 
3006
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
3007
 
 
3008
 
    def __init__(self, config_id):
3009
 
        BzrError.__init__(self, config_id=config_id)
3010
 
 
3011
 
 
3012
 
class NoSuchConfigOption(BzrError):
3013
 
 
3014
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
3015
 
 
3016
 
    def __init__(self, option_name):
3017
 
        BzrError.__init__(self, option_name=option_name)
3018
 
 
3019
 
 
3020
 
class NoSuchAlias(BzrError):
3021
 
 
3022
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3023
 
 
3024
 
    def __init__(self, alias_name):
3025
 
        BzrError.__init__(self, alias_name=alias_name)
3026
 
 
3027
 
 
3028
 
class DirectoryLookupFailure(BzrError):
3029
 
    """Base type for lookup errors."""
3030
 
 
3031
 
    pass
3032
 
 
3033
 
 
3034
 
class InvalidLocationAlias(DirectoryLookupFailure):
3035
 
 
3036
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
3037
 
 
3038
 
    def __init__(self, alias_name):
3039
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
3040
 
 
3041
 
 
3042
 
class UnsetLocationAlias(DirectoryLookupFailure):
3043
 
 
3044
 
    _fmt = 'No %(alias_name)s location assigned.'
3045
 
 
3046
 
    def __init__(self, alias_name):
3047
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
3048
 
 
3049
 
 
3050
 
class CannotBindAddress(BzrError):
3051
 
 
3052
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3053
 
 
3054
 
    def __init__(self, host, port, orig_error):
3055
 
        # nb: in python2.4 socket.error doesn't have a useful repr
3056
 
        BzrError.__init__(self, host=host, port=port,
3057
 
            orig_error=repr(orig_error.args))
3058
 
 
3059
 
 
3060
 
class UnknownRules(BzrError):
3061
 
 
3062
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
3063
 
 
3064
 
    def __init__(self, unknowns):
3065
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3066
 
 
3067
 
 
3068
 
class HookFailed(BzrError):
3069
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3070
 
    than TipChangeRejected.
3071
 
 
3072
 
    Note that this exception is no longer raised, and the import is only left
3073
 
    to be nice to code which might catch it in a plugin.
3074
 
    """
3075
 
 
3076
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3077
 
            "%(traceback_text)s%(exc_value)s")
3078
 
 
3079
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3080
 
        if warn:
3081
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3082
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3083
 
        import traceback
3084
 
        self.hook_stage = hook_stage
3085
 
        self.hook_name = hook_name
3086
 
        self.exc_info = exc_info
3087
 
        self.exc_type = exc_info[0]
3088
 
        self.exc_value = exc_info[1]
3089
 
        self.exc_tb = exc_info[2]
3090
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3091
 
 
3092
 
 
3093
 
class TipChangeRejected(BzrError):
3094
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3095
 
    explicitly abort a change to a branch tip.
3096
 
    """
3097
 
 
3098
 
    _fmt = u"Tip change rejected: %(msg)s"
3099
 
 
3100
 
    def __init__(self, msg):
3101
 
        self.msg = msg
3102
 
 
3103
 
 
3104
 
class ShelfCorrupt(BzrError):
3105
 
 
3106
 
    _fmt = "Shelf corrupt."
3107
 
 
3108
 
 
3109
 
class DecompressCorruption(BzrError):
3110
 
 
3111
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3112
 
 
3113
 
    def __init__(self, orig_error=None):
3114
 
        if orig_error is not None:
3115
 
            self.orig_error = ", %s" % (orig_error,)
3116
 
        else:
3117
 
            self.orig_error = ""
3118
 
        BzrError.__init__(self)
3119
 
 
3120
 
 
3121
 
class NoSuchShelfId(BzrError):
3122
 
 
3123
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3124
 
 
3125
 
    def __init__(self, shelf_id):
3126
 
        BzrError.__init__(self, shelf_id=shelf_id)
3127
 
 
3128
 
 
3129
 
class InvalidShelfId(BzrError):
3130
 
 
3131
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3132
 
 
3133
 
    def __init__(self, invalid_id):
3134
 
        BzrError.__init__(self, invalid_id=invalid_id)
3135
 
 
3136
 
 
3137
 
class JailBreak(BzrError):
3138
 
 
3139
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3140
 
 
3141
 
    def __init__(self, url):
3142
 
        BzrError.__init__(self, url=url)
3143
 
 
3144
 
 
3145
 
class UserAbort(BzrError):
3146
 
 
3147
 
    _fmt = 'The user aborted the operation.'
3148
 
 
3149
 
 
3150
 
class MustHaveWorkingTree(BzrError):
3151
 
 
3152
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3153
 
 
3154
 
    def __init__(self, format, url):
3155
 
        BzrError.__init__(self, format=format, url=url)
3156
 
 
3157
 
 
3158
 
class NoSuchView(BzrError):
3159
 
    """A view does not exist.
3160
 
    """
3161
 
 
3162
 
    _fmt = u"No such view: %(view_name)s."
3163
 
 
3164
 
    def __init__(self, view_name):
3165
 
        self.view_name = view_name
3166
 
 
3167
 
 
3168
 
class ViewsNotSupported(BzrError):
3169
 
    """Views are not supported by a tree format.
3170
 
    """
3171
 
 
3172
 
    _fmt = ("Views are not supported by %(tree)s;"
3173
 
            " use 'bzr upgrade' to change your tree to a later format.")
3174
 
 
3175
 
    def __init__(self, tree):
3176
 
        self.tree = tree
3177
 
 
3178
 
 
3179
 
class FileOutsideView(BzrError):
3180
 
 
3181
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3182
 
            '%(view_str)s')
3183
 
 
3184
 
    def __init__(self, file_name, view_files):
3185
 
        self.file_name = file_name
3186
 
        self.view_str = ", ".join(view_files)
3187
 
 
3188
 
 
3189
 
class UnresumableWriteGroup(BzrError):
3190
 
 
3191
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3192
 
            "%(write_groups)r: %(reason)s")
3193
 
 
3194
 
    internal_error = True
3195
 
 
3196
 
    def __init__(self, repository, write_groups, reason):
3197
 
        self.repository = repository
3198
 
        self.write_groups = write_groups
3199
 
        self.reason = reason
3200
 
 
3201
 
 
3202
 
class UnsuspendableWriteGroup(BzrError):
3203
 
 
3204
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3205
 
 
3206
 
    internal_error = True
3207
 
 
3208
 
    def __init__(self, repository):
3209
 
        self.repository = repository
3210
 
 
3211
 
 
3212
 
class LossyPushToSameVCS(BzrError):
3213
 
 
3214
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3215
 
            "%(target_branch)r that are in the same VCS.")
3216
 
 
3217
 
    internal_error = True
3218
 
 
3219
 
    def __init__(self, source_branch, target_branch):
3220
 
        self.source_branch = source_branch
3221
 
        self.target_branch = target_branch
3222
 
 
3223
 
 
3224
 
class NoRoundtrippingSupport(BzrError):
3225
 
 
3226
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3227
 
            "%(target_branch)r.")
3228
 
 
3229
 
    internal_error = True
3230
 
 
3231
 
    def __init__(self, source_branch, target_branch):
3232
 
        self.source_branch = source_branch
3233
 
        self.target_branch = target_branch
3234
 
 
3235
 
 
3236
 
class FileTimestampUnavailable(BzrError):
3237
 
 
3238
 
    _fmt = "The filestamp for %(path)s is not available."
3239
 
 
3240
 
    internal_error = True
3241
 
 
3242
 
    def __init__(self, path):
3243
 
        self.path = path
3244
 
 
3245
 
 
3246
 
class NoColocatedBranchSupport(BzrError):
3247
 
 
3248
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3249
 
 
3250
 
    def __init__(self, bzrdir):
3251
 
        self.bzrdir = bzrdir
3252
 
 
3253
 
 
3254
 
class NoWhoami(BzrError):
3255
 
 
3256
 
    _fmt = ('Unable to determine your name.\n'
3257
 
        "Please, set your name with the 'whoami' command.\n"
3258
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3259
 
 
3260
 
 
3261
 
class InvalidPattern(BzrError):
3262
 
 
3263
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3264
 
 
3265
 
    def __init__(self, msg):
3266
 
        self.msg = msg
3267
 
 
3268
 
 
3269
 
class RecursiveBind(BzrError):
3270
 
 
3271
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3272
 
        'Please use `bzr unbind` to fix.')
3273
 
 
3274
 
    def __init__(self, branch_url):
3275
 
        self.branch_url = branch_url
3276
 
 
3277
 
 
3278
 
# FIXME: I would prefer to define the config related exception classes in
3279
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3280
 
class OptionExpansionLoop(BzrError):
3281
 
 
3282
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3283
 
 
3284
 
    def __init__(self, string, refs):
3285
 
        self.string = string
3286
 
        self.refs = '->'.join(refs)
3287
 
 
3288
 
 
3289
 
class ExpandingUnknownOption(BzrError):
3290
 
 
3291
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3292
 
 
3293
 
    def __init__(self, name, string):
3294
 
        self.name = name
3295
 
        self.string = string
3296
 
 
3297
 
 
3298
 
class NoCompatibleInter(BzrError):
3299
 
 
3300
 
    _fmt = ('No compatible object available for operations from %(source)r '
3301
 
            'to %(target)r.')
3302
 
 
3303
 
    def __init__(self, source, target):
3304
 
        self.source = source
3305
 
        self.target = target