/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 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-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2010 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.
61
56
    :cvar _fmt: Format string to display the error; this is expanded
62
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
 
        "record_entry_contents.")
308
 
 
309
 
 
310
 
class NoPublicBranch(BzrError):
311
 
 
312
 
    _fmt = 'There is no public branch set for "%(branch_url)s".'
313
 
 
314
 
    def __init__(self, branch):
315
 
        import bzrlib.urlutils as urlutils
316
 
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
317
 
        BzrError.__init__(self, branch_url=public_location)
318
 
 
319
 
 
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
552
    internal_error = True
684
553
 
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 _format(self):
717
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
 
        # Python 2.4 have to be old-style classes so properties don't work.
719
 
        # Instead we override _format.
720
 
        if self.detail is None:
721
 
            if self.bzrdir is not None:
722
 
                try:
723
 
                    self.bzrdir.open_repository()
724
 
                except NoRepositoryPresent:
725
 
                    self.detail = ''
726
 
                else:
727
 
                    self.detail = ': location is a repository'
728
 
            else:
729
 
                self.detail = ''
730
 
        return PathError._format(self)
 
578
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
579
 
732
580
 
733
581
class NoSubmitBranch(PathError):
741
589
 
742
590
class AlreadyBranchError(PathError):
743
591
 
744
 
    _fmt = 'Already a branch: "%(path)s".'
 
592
    _fmt = "Already a branch: %(path)s."
745
593
 
746
594
 
747
595
class BranchExistsWithoutWorkingTree(PathError):
748
596
 
749
 
    _fmt = 'Directory contains a branch, but no working tree \
750
 
(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"
751
599
 
752
600
 
753
601
class AtomicFileAlreadyClosed(PathError):
754
602
 
755
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
756
 
            ' "%(path)s"')
 
603
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
604
            " %(path)s")
757
605
 
758
606
    def __init__(self, path, function):
759
607
        PathError.__init__(self, path=path, extra=None)
762
610
 
763
611
class InaccessibleParent(PathError):
764
612
 
765
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
766
 
            ' relative path "%(path)s"')
 
613
    _fmt = ("Parent not accessible given base %(base)s and"
 
614
            " relative path %(path)s")
767
615
 
768
616
    def __init__(self, path, base):
769
617
        PathError.__init__(self, path)
772
620
 
773
621
class NoRepositoryPresent(BzrError):
774
622
 
775
 
    _fmt = 'No repository present: "%(path)s"'
 
623
    _fmt = "No repository present: %(path)r"
776
624
    def __init__(self, bzrdir):
777
625
        BzrError.__init__(self)
778
626
        self.path = bzrdir.transport.clone('..').base
780
628
 
781
629
class FileInWrongBranch(BzrError):
782
630
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
631
    _fmt = "File %(path)s in not in branch %(branch_base)s."
784
632
 
785
633
    def __init__(self, branch, path):
786
634
        BzrError.__init__(self)
795
643
 
796
644
 
797
645
class UnknownFormatError(BzrError):
798
 
 
799
 
    _fmt = "Unknown %(kind)s format: %(format)r"
800
 
 
801
 
    def __init__(self, format, kind='branch'):
802
 
        self.kind = kind
803
 
        self.format = format
 
646
    
 
647
    _fmt = "Unknown branch format: %(format)r"
804
648
 
805
649
 
806
650
class IncompatibleFormat(BzrError):
807
 
 
 
651
    
808
652
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
653
 
810
654
    def __init__(self, format, bzrdir_format):
814
658
 
815
659
 
816
660
class IncompatibleRepositories(BzrError):
817
 
    """Report an error that two repositories are not compatible.
818
 
 
819
 
    Note that the source and target repositories are permitted to be strings:
820
 
    this exception is thrown from the smart server and may refer to a
821
 
    repository the client hasn't opened.
822
 
    """
823
 
 
824
 
    _fmt = "%(target)s\n" \
825
 
            "is not compatible with\n" \
826
 
            "%(source)s\n" \
827
 
            "%(details)s"
828
 
 
829
 
    def __init__(self, source, target, details=None):
830
 
        if details is None:
831
 
            details = "(no details)"
832
 
        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)
833
667
 
834
668
 
835
669
class IncompatibleRevision(BzrError):
836
 
 
 
670
    
837
671
    _fmt = "Revision is not compatible with %(repo_format)s"
838
672
 
839
673
    def __init__(self, repo_format):
844
678
class AlreadyVersionedError(BzrError):
845
679
    """Used when a path is expected not to be versioned, but it is."""
846
680
 
847
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
681
    _fmt = "%(context_info)s%(path)s is already versioned"
848
682
 
849
683
    def __init__(self, path, context_info=None):
850
684
        """Construct a new AlreadyVersionedError.
865
699
class NotVersionedError(BzrError):
866
700
    """Used when a path is expected to be versioned, but it is not."""
867
701
 
868
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
702
    _fmt = "%(context_info)s%(path)s is not versioned"
869
703
 
870
704
    def __init__(self, path, context_info=None):
871
705
        """Construct a new NotVersionedError.
922
756
        BzrError.__init__(self, filename=filename, kind=kind)
923
757
 
924
758
 
925
 
class BadFilenameEncoding(BzrError):
926
 
 
927
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
928
 
            ' encoding %(fs_encoding)s')
929
 
 
930
 
    def __init__(self, filename, fs_encoding):
931
 
        BzrError.__init__(self)
932
 
        self.filename = filename
933
 
        self.fs_encoding = fs_encoding
934
 
 
935
 
 
936
759
class ForbiddenControlFileError(BzrError):
937
760
 
938
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
939
 
 
940
 
 
941
 
class LockError(InternalBzrError):
 
761
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
762
 
 
763
 
 
764
class LockError(BzrError):
942
765
 
943
766
    _fmt = "Lock error: %(msg)s"
944
767
 
 
768
    internal_error = True
 
769
 
945
770
    # All exceptions from the lock/unlock functions should be from
946
771
    # this exception class.  They will be translated as necessary. The
947
772
    # original exception is available as e.original_error
948
773
    #
949
774
    # New code should prefer to raise specific subclasses
950
 
    def __init__(self, msg):
951
 
        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
952
780
 
953
781
 
954
782
class LockActive(LockError):
988
816
        self.obj = obj
989
817
 
990
818
 
991
 
class LockFailed(LockError):
992
 
 
993
 
    internal_error = False
994
 
 
995
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
996
 
 
997
 
    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):
998
824
        LockError.__init__(self, '')
999
 
        self.lock = lock
1000
 
        self.why = why
 
825
        self.fname = fname
 
826
        self.msg = msg
1001
827
 
1002
828
 
1003
829
class OutSideTransaction(BzrError):
1027
853
 
1028
854
class UnlockableTransport(LockError):
1029
855
 
1030
 
    internal_error = False
1031
 
 
1032
856
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1033
857
 
1034
858
    def __init__(self, transport):
1037
861
 
1038
862
class LockContention(LockError):
1039
863
 
1040
 
    _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?
1041
867
 
1042
868
    internal_error = False
1043
869
 
1044
 
    def __init__(self, lock, msg=''):
 
870
    def __init__(self, lock):
1045
871
        self.lock = lock
1046
 
        self.msg = msg
1047
872
 
1048
873
 
1049
874
class LockBroken(LockError):
1084
909
 
1085
910
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1086
911
 
 
912
    internal_error = True
 
913
 
1087
914
    def __init__(self, obj):
1088
915
        self.obj = obj
1089
916
 
1114
941
        BzrError.__init__(self, files=files, files_str=files_str)
1115
942
 
1116
943
 
1117
 
class BadCommitMessageEncoding(BzrError):
1118
 
 
1119
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1120
 
        'the current encoding.'
1121
 
 
1122
 
 
1123
944
class UpgradeReadonly(BzrError):
1124
945
 
1125
946
    _fmt = "Upgrade URL cannot work with readonly URLs."
1139
960
    _fmt = "Commit refused because there are unknowns in the tree."
1140
961
 
1141
962
 
1142
 
class NoSuchRevision(InternalBzrError):
1143
 
 
1144
 
    _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
1145
968
 
1146
969
    def __init__(self, branch, revision):
1147
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1148
970
        BzrError.__init__(self, branch=branch, revision=revision)
1149
971
 
1150
972
 
1151
 
class RangeInChangeOption(BzrError):
1152
 
 
1153
 
    _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)
1154
984
 
1155
985
 
1156
986
class NoSuchRevisionSpec(BzrError):
1163
993
 
1164
994
class NoSuchRevisionInTree(NoSuchRevision):
1165
995
    """When using Tree.revision_tree, and the revision is not accessible."""
1166
 
 
1167
 
    _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."
1168
998
 
1169
999
    def __init__(self, tree, revision_id):
1170
1000
        BzrError.__init__(self)
1174
1004
 
1175
1005
class InvalidRevisionSpec(BzrError):
1176
1006
 
1177
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1007
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1178
1008
            " %(branch)s%(extra)s")
1179
1009
 
1180
1010
    def __init__(self, spec, branch, extra=None):
1205
1035
class DivergedBranches(BzrError):
1206
1036
 
1207
1037
    _fmt = ("These branches have diverged."
1208
 
            " Use the missing command to see how.\n"
1209
 
            "Use the merge command to reconcile them.")
 
1038
            " Use the merge command to reconcile them.")
 
1039
 
 
1040
    internal_error = False
1210
1041
 
1211
1042
    def __init__(self, branch1, branch2):
1212
1043
        self.branch1 = branch1
1213
1044
        self.branch2 = branch2
1214
1045
 
1215
1046
 
1216
 
class NotLefthandHistory(InternalBzrError):
 
1047
class NotLefthandHistory(BzrError):
1217
1048
 
1218
1049
    _fmt = "Supplied history does not follow left-hand parents"
1219
1050
 
 
1051
    internal_error = True
 
1052
 
1220
1053
    def __init__(self, history):
1221
1054
        BzrError.__init__(self, history=history)
1222
1055
 
1226
1059
    _fmt = ("Branches have no common ancestor, and"
1227
1060
            " no merge base revision was specified.")
1228
1061
 
1229
 
 
1230
 
class CannotReverseCherrypick(BzrError):
1231
 
 
1232
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1233
 
            ' or diff3.')
 
1062
    internal_error = False
1234
1063
 
1235
1064
 
1236
1065
class NoCommonAncestor(BzrError):
1237
 
 
 
1066
    
1238
1067
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1239
1068
 
1240
1069
    def __init__(self, revision_a, revision_b):
1260
1089
            not_ancestor_id=not_ancestor_id)
1261
1090
 
1262
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
 
1263
1101
class AmbiguousBase(BzrError):
1264
1102
 
1265
1103
    def __init__(self, bases):
1266
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1267
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1104
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1105
                DeprecationWarning)
1268
1106
        msg = ("The correct base is unclear, because %s are all equally close"
1269
1107
                % ", ".join(bases))
1270
1108
        BzrError.__init__(self, msg)
1271
1109
        self.bases = bases
1272
1110
 
1273
1111
 
1274
 
class NoCommits(BranchError):
 
1112
class NoCommits(BzrError):
1275
1113
 
1276
1114
    _fmt = "Branch %(branch)s has no commits."
1277
1115
 
 
1116
    def __init__(self, branch):
 
1117
        BzrError.__init__(self, branch=branch)
 
1118
 
1278
1119
 
1279
1120
class UnlistableStore(BzrError):
1280
1121
 
1291
1132
 
1292
1133
class BoundBranchOutOfDate(BzrError):
1293
1134
 
1294
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1295
 
            " %(master)s.%(extra_help)s")
 
1135
    _fmt = ("Bound branch %(branch)s is out of date"
 
1136
            " with master branch %(master)s.")
1296
1137
 
1297
1138
    def __init__(self, branch, master):
1298
1139
        BzrError.__init__(self)
1299
1140
        self.branch = branch
1300
1141
        self.master = master
1301
 
        self.extra_help = ''
1302
 
 
1303
 
 
 
1142
 
 
1143
        
1304
1144
class CommitToDoubleBoundBranch(BzrError):
1305
1145
 
1306
1146
    _fmt = ("Cannot commit to branch %(branch)s."
1336
1176
 
1337
1177
class WeaveError(BzrError):
1338
1178
 
1339
 
    _fmt = "Error in processing weave: %(msg)s"
 
1179
    _fmt = "Error in processing weave: %(message)s"
1340
1180
 
1341
 
    def __init__(self, msg=None):
 
1181
    def __init__(self, message=None):
1342
1182
        BzrError.__init__(self)
1343
 
        self.msg = msg
 
1183
        self.message = message
1344
1184
 
1345
1185
 
1346
1186
class WeaveRevisionAlreadyPresent(WeaveError):
1375
1215
 
1376
1216
class WeaveParentMismatch(WeaveError):
1377
1217
 
1378
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1379
 
 
 
1218
    _fmt = "Parents are mismatched between two revisions."
 
1219
    
1380
1220
 
1381
1221
class WeaveInvalidChecksum(WeaveError):
1382
1222
 
1383
 
    _fmt = "Text did not match it's checksum: %(msg)s"
 
1223
    _fmt = "Text did not match it's checksum: %(message)s"
1384
1224
 
1385
1225
 
1386
1226
class WeaveTextDiffers(WeaveError):
1408
1248
 
1409
1249
 
1410
1250
class VersionedFileError(BzrError):
1411
 
 
 
1251
    
1412
1252
    _fmt = "Versioned file error"
1413
1253
 
1414
1254
 
1415
1255
class RevisionNotPresent(VersionedFileError):
1416
 
 
1417
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1256
    
 
1257
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1418
1258
 
1419
1259
    def __init__(self, revision_id, file_id):
1420
1260
        VersionedFileError.__init__(self)
1423
1263
 
1424
1264
 
1425
1265
class RevisionAlreadyPresent(VersionedFileError):
1426
 
 
1427
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1266
    
 
1267
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1428
1268
 
1429
1269
    def __init__(self, revision_id, file_id):
1430
1270
        VersionedFileError.__init__(self)
1434
1274
 
1435
1275
class VersionedFileInvalidChecksum(VersionedFileError):
1436
1276
 
1437
 
    _fmt = "Text did not match its checksum: %(msg)s"
1438
 
 
1439
 
 
1440
 
class KnitError(InternalBzrError):
1441
 
 
 
1277
    _fmt = "Text did not match its checksum: %(message)s"
 
1278
 
 
1279
 
 
1280
class KnitError(BzrError):
 
1281
    
1442
1282
    _fmt = "Knit error"
1443
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
 
1444
1296
 
1445
1297
class KnitCorrupt(KnitError):
1446
1298
 
1452
1304
        self.how = how
1453
1305
 
1454
1306
 
1455
 
class SHA1KnitCorrupt(KnitCorrupt):
1456
 
 
1457
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1458
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1459
 
        "sha %(actual)s")
1460
 
 
1461
 
    def __init__(self, filename, actual, expected, key, content):
1462
 
        KnitError.__init__(self)
1463
 
        self.filename = filename
1464
 
        self.actual = actual
1465
 
        self.expected = expected
1466
 
        self.key = key
1467
 
        self.content = content
1468
 
 
1469
 
 
1470
 
class KnitDataStreamIncompatible(KnitError):
1471
 
    # Not raised anymore, as we can convert data streams.  In future we may
1472
 
    # need it again for more exotic cases, so we're keeping it around for now.
1473
 
 
1474
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1475
 
 
1476
 
    def __init__(self, stream_format, target_format):
1477
 
        self.stream_format = stream_format
1478
 
        self.target_format = target_format
1479
 
 
1480
 
 
1481
 
class KnitDataStreamUnknown(KnitError):
1482
 
    # Indicates a data stream we don't know how to handle.
1483
 
 
1484
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1485
 
 
1486
 
    def __init__(self, stream_format):
1487
 
        self.stream_format = stream_format
1488
 
 
1489
 
 
1490
 
class KnitHeaderError(KnitError):
1491
 
 
1492
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1493
 
 
1494
 
    def __init__(self, badline, filename):
1495
 
        KnitError.__init__(self)
1496
 
        self.badline = badline
1497
 
        self.filename = filename
1498
 
 
1499
1307
class KnitIndexUnknownMethod(KnitError):
1500
1308
    """Raised when we don't understand the storage method.
1501
1309
 
1502
1310
    Currently only 'fulltext' and 'line-delta' are supported.
1503
1311
    """
1504
 
 
 
1312
    
1505
1313
    _fmt = ("Knit index %(filename)s does not have a known method"
1506
1314
            " in options: %(options)r")
1507
1315
 
1511
1319
        self.options = options
1512
1320
 
1513
1321
 
1514
 
class RetryWithNewPacks(BzrError):
1515
 
    """Raised when we realize that the packs on disk have changed.
1516
 
 
1517
 
    This is meant as more of a signaling exception, to trap between where a
1518
 
    local error occurred and the code that can actually handle the error and
1519
 
    code that can retry appropriately.
1520
 
    """
1521
 
 
1522
 
    internal_error = True
1523
 
 
1524
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1525
 
            " %(orig_error)s")
1526
 
 
1527
 
    def __init__(self, context, reload_occurred, exc_info):
1528
 
        """create a new RetryWithNewPacks error.
1529
 
 
1530
 
        :param reload_occurred: Set to True if we know that the packs have
1531
 
            already been reloaded, and we are failing because of an in-memory
1532
 
            cache miss. If set to True then we will ignore if a reload says
1533
 
            nothing has changed, because we assume it has already reloaded. If
1534
 
            False, then a reload with nothing changed will force an error.
1535
 
        :param exc_info: The original exception traceback, so if there is a
1536
 
            problem we can raise the original error (value from sys.exc_info())
1537
 
        """
1538
 
        BzrError.__init__(self)
1539
 
        self.reload_occurred = reload_occurred
1540
 
        self.exc_info = exc_info
1541
 
        self.orig_error = exc_info[1]
1542
 
        # TODO: The global error handler should probably treat this by
1543
 
        #       raising/printing the original exception with a bit about
1544
 
        #       RetryWithNewPacks also not being caught
1545
 
 
1546
 
 
1547
 
class RetryAutopack(RetryWithNewPacks):
1548
 
    """Raised when we are autopacking and we find a missing file.
1549
 
 
1550
 
    Meant as a signaling exception, to tell the autopack code it should try
1551
 
    again.
1552
 
    """
1553
 
 
1554
 
    internal_error = True
1555
 
 
1556
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1557
 
            " context: %(context)s %(orig_error)s")
1558
 
 
1559
 
 
1560
1322
class NoSuchExportFormat(BzrError):
1561
 
 
 
1323
    
1562
1324
    _fmt = "Export format %(format)r not supported"
1563
1325
 
1564
1326
    def __init__(self, format):
1567
1329
 
1568
1330
 
1569
1331
class TransportError(BzrError):
1570
 
 
 
1332
    
1571
1333
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1572
1334
 
1573
1335
    def __init__(self, msg=None, orig_error=None):
1582
1344
        BzrError.__init__(self)
1583
1345
 
1584
1346
 
1585
 
class TooManyConcurrentRequests(InternalBzrError):
 
1347
class TooManyConcurrentRequests(BzrError):
1586
1348
 
1587
1349
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1588
1350
            " Be sure to finish_writing and finish_reading on the"
1589
1351
            " currently open request.")
1590
1352
 
 
1353
    internal_error = True
 
1354
 
1591
1355
    def __init__(self, medium):
1592
1356
        self.medium = medium
1593
1357
 
1600
1364
        self.details = details
1601
1365
 
1602
1366
 
1603
 
class UnexpectedProtocolVersionMarker(TransportError):
1604
 
 
1605
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1606
 
 
1607
 
    def __init__(self, marker):
1608
 
        self.marker = marker
1609
 
 
1610
 
 
1611
 
class UnknownSmartMethod(InternalBzrError):
1612
 
 
1613
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1614
 
 
1615
 
    def __init__(self, verb):
1616
 
        self.verb = verb
1617
 
 
1618
 
 
1619
 
class SmartMessageHandlerError(InternalBzrError):
1620
 
 
1621
 
    _fmt = ("The message handler raised an exception:\n"
1622
 
            "%(traceback_text)s")
1623
 
 
1624
 
    def __init__(self, exc_info):
1625
 
        import traceback
1626
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1627
 
        self.exc_info = exc_info
1628
 
        traceback_strings = traceback.format_exception(
1629
 
                self.exc_type, self.exc_value, self.exc_tb)
1630
 
        self.traceback_text = ''.join(traceback_strings)
1631
 
 
1632
 
 
1633
1367
# A set of semi-meaningful errors which can be thrown
1634
1368
class TransportNotPossible(TransportError):
1635
1369
 
1660
1394
            self.port = ':%s' % port
1661
1395
 
1662
1396
 
1663
 
# XXX: This is also used for unexpected end of file, which is different at the
1664
 
# TCP level from "connection reset".
1665
1397
class ConnectionReset(TransportError):
1666
1398
 
1667
1399
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1669
1401
 
1670
1402
class InvalidRange(TransportError):
1671
1403
 
1672
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1673
 
 
1674
 
    def __init__(self, path, offset, msg=None):
1675
 
        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)))
1676
1409
        self.path = path
1677
1410
        self.offset = offset
1678
1411
 
1689
1422
class InvalidHttpRange(InvalidHttpResponse):
1690
1423
 
1691
1424
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1692
 
 
 
1425
    
1693
1426
    def __init__(self, path, range, msg):
1694
1427
        self.range = range
1695
1428
        InvalidHttpResponse.__init__(self, path, msg)
1698
1431
class InvalidHttpContentType(InvalidHttpResponse):
1699
1432
 
1700
1433
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1701
 
 
 
1434
    
1702
1435
    def __init__(self, path, ctype, msg):
1703
1436
        self.ctype = ctype
1704
1437
        InvalidHttpResponse.__init__(self, path, msg)
1708
1441
 
1709
1442
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1710
1443
 
1711
 
    def __init__(self, source, target, is_permanent=False):
 
1444
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1712
1445
        self.source = source
1713
1446
        self.target = target
1714
 
        if is_permanent:
 
1447
        if is_permament:
1715
1448
            self.permanently = ' permanently'
1716
1449
        else:
1717
1450
            self.permanently = ''
 
1451
        self.is_permament = is_permament
 
1452
        self._qualified_proto = qual_proto
1718
1453
        TransportError.__init__(self)
1719
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
 
1720
1488
 
1721
1489
class TooManyRedirections(TransportError):
1722
1490
 
1723
1491
    _fmt = "Too many redirections"
1724
1492
 
1725
 
 
1726
1493
class ConflictsInTree(BzrError):
1727
1494
 
1728
1495
    _fmt = "Working tree has conflicts."
1734
1501
        if filename is None:
1735
1502
            filename = ""
1736
1503
        message = "Error(s) parsing config file %s:\n%s" % \
1737
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1504
            (filename, ('\n'.join(e.message for e in errors)))
1738
1505
        BzrError.__init__(self, message)
1739
1506
 
1740
1507
 
1749
1516
 
1750
1517
class SigningFailed(BzrError):
1751
1518
 
1752
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1519
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1753
1520
 
1754
1521
    def __init__(self, command_line):
1755
1522
        BzrError.__init__(self, command_line=command_line)
1757
1524
 
1758
1525
class WorkingTreeNotRevision(BzrError):
1759
1526
 
1760
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1527
    _fmt = ("The working tree for %(basedir)s has changed since" 
1761
1528
            " the last commit, but weave merge requires that it be"
1762
1529
            " unchanged")
1763
1530
 
1780
1547
        self.graph = graph
1781
1548
 
1782
1549
 
1783
 
class WritingCompleted(InternalBzrError):
 
1550
class WritingCompleted(BzrError):
1784
1551
 
1785
1552
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1786
1553
            "called upon it - accept bytes may not be called anymore.")
1787
1554
 
 
1555
    internal_error = True
 
1556
 
1788
1557
    def __init__(self, request):
1789
1558
        self.request = request
1790
1559
 
1791
1560
 
1792
 
class WritingNotComplete(InternalBzrError):
 
1561
class WritingNotComplete(BzrError):
1793
1562
 
1794
1563
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1795
1564
            "called upon it - until the write phase is complete no "
1796
1565
            "data may be read.")
1797
1566
 
 
1567
    internal_error = True
 
1568
 
1798
1569
    def __init__(self, request):
1799
1570
        self.request = request
1800
1571
 
1808
1579
        self.filename = filename
1809
1580
 
1810
1581
 
1811
 
class MediumNotConnected(InternalBzrError):
 
1582
class MediumNotConnected(BzrError):
1812
1583
 
1813
1584
    _fmt = """The medium '%(medium)s' is not connected."""
1814
1585
 
 
1586
    internal_error = True
 
1587
 
1815
1588
    def __init__(self, medium):
1816
1589
        self.medium = medium
1817
1590
 
1823
1596
 
1824
1597
class NoBundleFound(BzrError):
1825
1598
 
1826
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1599
    _fmt = "No bundle was found in %(filename)s"
1827
1600
 
1828
1601
    def __init__(self, filename):
1829
1602
        BzrError.__init__(self)
1852
1625
        self.text_revision = text_revision
1853
1626
        self.file_id = file_id
1854
1627
 
1855
 
 
1856
1628
class DuplicateFileId(BzrError):
1857
1629
 
1858
1630
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1893
1665
        self.root_trans_id = transform.root
1894
1666
 
1895
1667
 
1896
 
class BzrBadParameter(InternalBzrError):
 
1668
class BzrBadParameter(BzrError):
1897
1669
 
1898
1670
    _fmt = "Bad parameter: %(param)r"
1899
1671
 
 
1672
    internal_error = True
 
1673
 
1900
1674
    # This exception should never be thrown, but it is a base class for all
1901
1675
    # parameter-to-function errors.
1902
1676
 
1920
1694
    _fmt = "Moving the root directory is not supported at this time"
1921
1695
 
1922
1696
 
1923
 
class TransformRenameFailed(BzrError):
1924
 
 
1925
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1926
 
 
1927
 
    def __init__(self, from_path, to_path, why, errno):
1928
 
        self.from_path = from_path
1929
 
        self.to_path = to_path
1930
 
        self.why = why
1931
 
        self.errno = errno
1932
 
 
1933
 
 
1934
1697
class BzrMoveFailedError(BzrError):
1935
1698
 
1936
1699
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1937
1700
 
1938
1701
    def __init__(self, from_path='', to_path='', extra=None):
1939
 
        from bzrlib.osutils import splitpath
1940
1702
        BzrError.__init__(self)
1941
1703
        if extra:
1942
1704
            self.extra = ': ' + str(extra)
1946
1708
        has_from = len(from_path) > 0
1947
1709
        has_to = len(to_path) > 0
1948
1710
        if has_from:
1949
 
            self.from_path = splitpath(from_path)[-1]
 
1711
            self.from_path = osutils.splitpath(from_path)[-1]
1950
1712
        else:
1951
1713
            self.from_path = ''
1952
1714
 
1953
1715
        if has_to:
1954
 
            self.to_path = splitpath(to_path)[-1]
 
1716
            self.to_path = osutils.splitpath(to_path)[-1]
1955
1717
        else:
1956
1718
            self.to_path = ''
1957
1719
 
1976
1738
class BzrRemoveChangedFilesError(BzrError):
1977
1739
    """Used when user is trying to remove changed files."""
1978
1740
 
1979
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1980
 
        "%(changes_as_text)s"
 
1741
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
1981
1742
        "Use --keep to not delete them, or --force to delete them regardless.")
1982
1743
 
1983
1744
    def __init__(self, tree_delta):
2040
1801
 
2041
1802
class BadConversionTarget(BzrError):
2042
1803
 
2043
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2044
 
            "    %(problem)s"
 
1804
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2045
1805
 
2046
 
    def __init__(self, problem, format, from_format=None):
 
1806
    def __init__(self, problem, format):
2047
1807
        BzrError.__init__(self)
2048
1808
        self.problem = problem
2049
1809
        self.format = format
2050
 
        self.from_format = from_format or '(unspecified)'
2051
 
 
2052
 
 
2053
 
class NoDiffFound(BzrError):
2054
 
 
2055
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2056
 
 
2057
 
    def __init__(self, path):
2058
 
        BzrError.__init__(self, path)
2059
 
 
2060
 
 
2061
 
class ExecutableMissing(BzrError):
2062
 
 
2063
 
    _fmt = "%(exe_name)s could not be found on this machine"
2064
 
 
2065
 
    def __init__(self, exe_name):
2066
 
        BzrError.__init__(self, exe_name=exe_name)
2067
1810
 
2068
1811
 
2069
1812
class NoDiff(BzrError):
2079
1822
    _fmt = "Diff3 is not installed on this machine."
2080
1823
 
2081
1824
 
2082
 
class ExistingContent(BzrError):
2083
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2084
 
 
2085
 
    _fmt = "The content being inserted is already present."
2086
 
 
2087
 
 
2088
1825
class ExistingLimbo(BzrError):
2089
1826
 
2090
1827
    _fmt = """This tree contains left-over files from a failed operation.
2091
1828
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2092
1829
    keep, and delete it when you are done."""
2093
 
 
 
1830
    
2094
1831
    def __init__(self, limbo_dir):
2095
1832
       BzrError.__init__(self)
2096
1833
       self.limbo_dir = limbo_dir
2097
1834
 
2098
1835
 
2099
 
class ExistingPendingDeletion(BzrError):
2100
 
 
2101
 
    _fmt = """This tree contains left-over files from a failed operation.
2102
 
    Please examine %(pending_deletion)s to see if it contains any files you
2103
 
    wish to keep, and delete it when you are done."""
2104
 
 
2105
 
    def __init__(self, pending_deletion):
2106
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2107
 
 
2108
 
 
2109
1836
class ImmortalLimbo(BzrError):
2110
1837
 
2111
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1838
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2112
1839
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2113
1840
    keep, and delete it when you are done."""
2114
1841
 
2117
1844
       self.limbo_dir = limbo_dir
2118
1845
 
2119
1846
 
2120
 
class ImmortalPendingDeletion(BzrError):
2121
 
 
2122
 
    _fmt = ("Unable to delete transform temporary directory "
2123
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2124
 
    "contains any files you wish to keep, and delete it when you are done.")
2125
 
 
2126
 
    def __init__(self, pending_deletion):
2127
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2128
 
 
2129
 
 
2130
1847
class OutOfDateTree(BzrError):
2131
1848
 
2132
 
    _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'."
2133
1850
 
2134
 
    def __init__(self, tree, more=None):
2135
 
        if more is None:
2136
 
            more = ''
2137
 
        else:
2138
 
            more = ' ' + more
 
1851
    def __init__(self, tree):
2139
1852
        BzrError.__init__(self)
2140
1853
        self.tree = tree
2141
 
        self.more = more
2142
1854
 
2143
1855
 
2144
1856
class PublicBranchOutOfDate(BzrError):
2164
1876
    _fmt = "Format error in conflict listings"
2165
1877
 
2166
1878
 
2167
 
class CorruptDirstate(BzrError):
2168
 
 
2169
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2170
 
            "Error: %(description)s")
2171
 
 
2172
 
    def __init__(self, dirstate_path, description):
2173
 
        BzrError.__init__(self)
2174
 
        self.dirstate_path = dirstate_path
2175
 
        self.description = description
2176
 
 
2177
 
 
2178
1879
class CorruptRepository(BzrError):
2179
1880
 
2180
1881
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2182
1883
 
2183
1884
    def __init__(self, repo):
2184
1885
        BzrError.__init__(self)
2185
 
        self.repo_path = repo.user_url
2186
 
 
2187
 
 
2188
 
class InconsistentDelta(BzrError):
2189
 
    """Used when we get a delta that is not valid."""
2190
 
 
2191
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2192
 
            " %(file_id)r\nreason: %(reason)s")
2193
 
 
2194
 
    def __init__(self, path, file_id, reason):
2195
 
        BzrError.__init__(self)
2196
 
        self.path = path
2197
 
        self.file_id = file_id
2198
 
        self.reason = reason
2199
 
 
2200
 
 
2201
 
class InconsistentDeltaDelta(InconsistentDelta):
2202
 
    """Used when we get a delta that is not valid."""
2203
 
 
2204
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2205
 
            "\nreason: %(reason)s")
2206
 
 
2207
 
    def __init__(self, delta, reason):
2208
 
        BzrError.__init__(self)
2209
 
        self.delta = delta
2210
 
        self.reason = reason
 
1886
        self.repo_path = repo.bzrdir.root_transport.base
2211
1887
 
2212
1888
 
2213
1889
class UpgradeRequired(BzrError):
2219
1895
        self.path = path
2220
1896
 
2221
1897
 
2222
 
class RepositoryUpgradeRequired(UpgradeRequired):
2223
 
 
2224
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2225
 
 
2226
 
 
2227
 
class RichRootUpgradeRequired(UpgradeRequired):
2228
 
 
2229
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2230
 
           " a format which supports rich roots.")
2231
 
 
2232
 
 
2233
1898
class LocalRequiresBoundBranch(BzrError):
2234
1899
 
2235
1900
    _fmt = "Cannot perform local-only commits on unbound branches."
2236
1901
 
2237
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
 
2238
1917
class UnsupportedOperation(BzrError):
2239
1918
 
2240
1919
    _fmt = ("The method %(mname)s is not supported on"
2257
1936
 
2258
1937
 
2259
1938
class BinaryFile(BzrError):
2260
 
 
 
1939
    
2261
1940
    _fmt = "File is binary but should be text."
2262
1941
 
2263
1942
 
2283
1962
 
2284
1963
 
2285
1964
class NotABundle(BzrError):
2286
 
 
 
1965
    
2287
1966
    _fmt = "Not a bzr revision-bundle: %(text)r"
2288
1967
 
2289
1968
    def __init__(self, text):
2291
1970
        self.text = text
2292
1971
 
2293
1972
 
2294
 
class BadBundle(BzrError):
2295
 
 
 
1973
class BadBundle(BzrError): 
 
1974
    
2296
1975
    _fmt = "Bad bzr revision-bundle: %(text)r"
2297
1976
 
2298
1977
    def __init__(self, text):
2300
1979
        self.text = text
2301
1980
 
2302
1981
 
2303
 
class MalformedHeader(BadBundle):
2304
 
 
 
1982
class MalformedHeader(BadBundle): 
 
1983
    
2305
1984
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2306
1985
 
2307
1986
 
2308
 
class MalformedPatches(BadBundle):
2309
 
 
 
1987
class MalformedPatches(BadBundle): 
 
1988
    
2310
1989
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2311
1990
 
2312
1991
 
2313
 
class MalformedFooter(BadBundle):
2314
 
 
 
1992
class MalformedFooter(BadBundle): 
 
1993
    
2315
1994
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2316
1995
 
2317
1996
 
2318
1997
class UnsupportedEOLMarker(BadBundle):
2319
 
 
2320
 
    _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"    
2321
2000
 
2322
2001
    def __init__(self):
2323
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2002
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2324
2003
        # but for this there is not
2325
2004
        BzrError.__init__(self)
2326
2005
 
2327
2006
 
2328
2007
class IncompatibleBundleFormat(BzrError):
2329
 
 
 
2008
    
2330
2009
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2331
2010
 
2332
2011
    def __init__(self, bundle_format, other):
2336
2015
 
2337
2016
 
2338
2017
class BadInventoryFormat(BzrError):
2339
 
 
 
2018
    
2340
2019
    _fmt = "Root class for inventory serialization errors"
2341
2020
 
2342
2021
 
2353
2032
    _fmt = """This operation requires rich root data storage"""
2354
2033
 
2355
2034
 
2356
 
class NoSmartMedium(InternalBzrError):
 
2035
class NoSmartMedium(BzrError):
2357
2036
 
2358
2037
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2359
2038
 
 
2039
    internal_error = True
 
2040
 
2360
2041
    def __init__(self, transport):
2361
2042
        self.transport = transport
2362
2043
 
2363
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
 
2364
2053
class UnknownSSH(BzrError):
2365
2054
 
2366
2055
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2376
2065
            " Please set BZR_SSH environment variable.")
2377
2066
 
2378
2067
 
2379
 
class GhostRevisionsHaveNoRevno(BzrError):
2380
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2381
 
 
2382
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2383
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2384
 
 
2385
 
    def __init__(self, revision_id, ghost_revision_id):
2386
 
        self.revision_id = revision_id
2387
 
        self.ghost_revision_id = ghost_revision_id
2388
 
 
2389
 
 
2390
2068
class GhostRevisionUnusableHere(BzrError):
2391
2069
 
2392
2070
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2396
2074
        self.revision_id = revision_id
2397
2075
 
2398
2076
 
2399
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2077
class IllegalUseOfScopeReplacer(BzrError):
2400
2078
 
2401
2079
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2402
2080
            " %(msg)s%(extra)s")
2403
2081
 
 
2082
    internal_error = True
 
2083
 
2404
2084
    def __init__(self, name, msg, extra=None):
2405
2085
        BzrError.__init__(self)
2406
2086
        self.name = name
2411
2091
            self.extra = ''
2412
2092
 
2413
2093
 
2414
 
class InvalidImportLine(InternalBzrError):
 
2094
class InvalidImportLine(BzrError):
2415
2095
 
2416
2096
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2417
2097
 
 
2098
    internal_error = True
 
2099
 
2418
2100
    def __init__(self, text, msg):
2419
2101
        BzrError.__init__(self)
2420
2102
        self.text = text
2421
2103
        self.msg = msg
2422
2104
 
2423
2105
 
2424
 
class ImportNameCollision(InternalBzrError):
 
2106
class ImportNameCollision(BzrError):
2425
2107
 
2426
2108
    _fmt = ("Tried to import an object to the same name as"
2427
2109
            " an existing object. %(name)s")
2428
2110
 
 
2111
    internal_error = True
 
2112
 
2429
2113
    def __init__(self, name):
2430
2114
        BzrError.__init__(self)
2431
2115
        self.name = name
2463
2147
class PatchMissing(BzrError):
2464
2148
    """Raise a patch type was specified but no patch supplied"""
2465
2149
 
2466
 
    _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."
2467
2151
 
2468
2152
    def __init__(self, patch_type):
2469
2153
        BzrError.__init__(self)
2470
2154
        self.patch_type = patch_type
2471
2155
 
2472
2156
 
2473
 
class TargetNotBranch(BzrError):
2474
 
    """A merge directive's target branch is required, but isn't a branch"""
2475
 
 
2476
 
    _fmt = ("Your branch does not have all of the revisions required in "
2477
 
            "order to merge this merge directive and the target "
2478
 
            "location specified in the merge directive is not a branch: "
2479
 
            "%(location)s.")
2480
 
 
2481
 
    def __init__(self, location):
2482
 
        BzrError.__init__(self)
2483
 
        self.location = location
2484
 
 
2485
 
 
2486
2157
class UnsupportedInventoryKind(BzrError):
2487
 
 
 
2158
    
2488
2159
    _fmt = """Unsupported entry kind %(kind)s"""
2489
2160
 
2490
2161
    def __init__(self, kind):
2493
2164
 
2494
2165
class BadSubsumeSource(BzrError):
2495
2166
 
2496
 
    _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"""
2497
2168
 
2498
2169
    def __init__(self, tree, other_tree, reason):
2499
2170
        self.tree = tree
2502
2173
 
2503
2174
 
2504
2175
class SubsumeTargetNeedsUpgrade(BzrError):
2505
 
 
 
2176
    
2506
2177
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2507
2178
 
2508
2179
    def __init__(self, other_tree):
2509
2180
        self.other_tree = other_tree
2510
2181
 
2511
2182
 
2512
 
class BadReferenceTarget(InternalBzrError):
2513
 
 
2514
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2515
 
           "%(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
2516
2188
 
2517
2189
    def __init__(self, tree, other_tree, reason):
2518
2190
        self.tree = tree
2531
2203
class TagsNotSupported(BzrError):
2532
2204
 
2533
2205
    _fmt = ("Tags not supported by %(branch)s;"
2534
 
            " you may be able to use bzr upgrade.")
 
2206
            " you may be able to use bzr upgrade --dirstate-tags.")
2535
2207
 
2536
2208
    def __init__(self, branch):
2537
2209
        self.branch = branch
2538
2210
 
2539
 
 
 
2211
        
2540
2212
class TagAlreadyExists(BzrError):
2541
2213
 
2542
2214
    _fmt = "Tag %(tag_name)s already exists."
2547
2219
 
2548
2220
class MalformedBugIdentifier(BzrError):
2549
2221
 
2550
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2551
 
            'See "bzr help bugs" for more information on this feature.')
 
2222
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2552
2223
 
2553
2224
    def __init__(self, bug_id, reason):
2554
2225
        self.bug_id = bug_id
2555
2226
        self.reason = reason
2556
2227
 
2557
2228
 
2558
 
class InvalidBugTrackerURL(BzrError):
2559
 
 
2560
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2561
 
            "contain {id}: %(url)s")
2562
 
 
2563
 
    def __init__(self, abbreviation, url):
2564
 
        self.abbreviation = abbreviation
2565
 
        self.url = url
2566
 
 
2567
 
 
2568
2229
class UnknownBugTrackerAbbreviation(BzrError):
2569
2230
 
2570
2231
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2575
2236
        self.branch = branch
2576
2237
 
2577
2238
 
2578
 
class InvalidLineInBugsProperty(BzrError):
2579
 
 
2580
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2581
 
 
2582
 
    def __init__(self, line):
2583
 
        self.line = line
2584
 
 
2585
 
 
2586
 
class InvalidBugStatus(BzrError):
2587
 
 
2588
 
    _fmt = ("Invalid bug status: '%(status)s'")
2589
 
 
2590
 
    def __init__(self, status):
2591
 
        self.status = status
2592
 
 
2593
 
 
2594
2239
class UnexpectedSmartServerResponse(BzrError):
2595
2240
 
2596
2241
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2599
2244
        self.response_tuple = response_tuple
2600
2245
 
2601
2246
 
2602
 
class ErrorFromSmartServer(BzrError):
2603
 
    """An error was received from a smart server.
2604
 
 
2605
 
    :seealso: UnknownErrorFromSmartServer
2606
 
    """
2607
 
 
2608
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2609
 
 
2610
 
    internal_error = True
2611
 
 
2612
 
    def __init__(self, error_tuple):
2613
 
        self.error_tuple = error_tuple
2614
 
        try:
2615
 
            self.error_verb = error_tuple[0]
2616
 
        except IndexError:
2617
 
            self.error_verb = None
2618
 
        self.error_args = error_tuple[1:]
2619
 
 
2620
 
 
2621
 
class UnknownErrorFromSmartServer(BzrError):
2622
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2623
 
    error.
2624
 
 
2625
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2626
 
    distinguish between the following two cases:
2627
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2628
 
        and so should provoke a traceback to the user.
2629
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2630
 
        translated.  This is probably because the server sent us garbage, and
2631
 
        should not provoke a traceback.
2632
 
    """
2633
 
 
2634
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2635
 
 
2636
 
    internal_error = False
2637
 
 
2638
 
    def __init__(self, error_from_smart_server):
2639
 
        """Constructor.
2640
 
 
2641
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2642
 
        """
2643
 
        self.error_from_smart_server = error_from_smart_server
2644
 
        self.error_tuple = error_from_smart_server.error_tuple
2645
 
 
2646
 
 
2647
2247
class ContainerError(BzrError):
2648
2248
    """Base class of container errors."""
2649
2249
 
2651
2251
class UnknownContainerFormatError(ContainerError):
2652
2252
 
2653
2253
    _fmt = "Unrecognised container format: %(container_format)r"
2654
 
 
 
2254
    
2655
2255
    def __init__(self, container_format):
2656
2256
        self.container_format = container_format
2657
2257
 
2660
2260
 
2661
2261
    _fmt = "Unexpected end of container stream"
2662
2262
 
 
2263
    internal_error = False
 
2264
 
2663
2265
 
2664
2266
class UnknownRecordTypeError(ContainerError):
2665
2267
 
2687
2289
 
2688
2290
class DuplicateRecordNameError(ContainerError):
2689
2291
 
2690
 
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2292
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
2691
2293
 
2692
2294
    def __init__(self, name):
2693
2295
        self.name = name
2694
2296
 
2695
2297
 
2696
 
class NoDestinationAddress(InternalBzrError):
 
2298
class NoDestinationAddress(BzrError):
2697
2299
 
2698
2300
    _fmt = "Message does not have a destination address."
2699
2301
 
2700
 
 
2701
 
class RepositoryDataStreamError(BzrError):
2702
 
 
2703
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2704
 
 
2705
 
    def __init__(self, reason):
2706
 
        self.reason = reason
 
2302
    internal_error = True
2707
2303
 
2708
2304
 
2709
2305
class SMTPError(BzrError):
2712
2308
 
2713
2309
    def __init__(self, error):
2714
2310
        self.error = error
2715
 
 
2716
 
 
2717
 
class NoMessageSupplied(BzrError):
2718
 
 
2719
 
    _fmt = "No message supplied."
2720
 
 
2721
 
 
2722
 
class NoMailAddressSpecified(BzrError):
2723
 
 
2724
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2725
 
 
2726
 
 
2727
 
class UnknownMailClient(BzrError):
2728
 
 
2729
 
    _fmt = "Unknown mail client: %(mail_client)s"
2730
 
 
2731
 
    def __init__(self, mail_client):
2732
 
        BzrError.__init__(self, mail_client=mail_client)
2733
 
 
2734
 
 
2735
 
class MailClientNotFound(BzrError):
2736
 
 
2737
 
    _fmt = "Unable to find mail client with the following names:"\
2738
 
        " %(mail_command_list_string)s"
2739
 
 
2740
 
    def __init__(self, mail_command_list):
2741
 
        mail_command_list_string = ', '.join(mail_command_list)
2742
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2743
 
                          mail_command_list_string=mail_command_list_string)
2744
 
 
2745
 
class SMTPConnectionRefused(SMTPError):
2746
 
 
2747
 
    _fmt = "SMTP connection to %(host)s refused"
2748
 
 
2749
 
    def __init__(self, error, host):
2750
 
        self.error = error
2751
 
        self.host = host
2752
 
 
2753
 
 
2754
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2755
 
 
2756
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2757
 
 
2758
 
 
2759
 
class BzrDirError(BzrError):
2760
 
 
2761
 
    def __init__(self, bzrdir):
2762
 
        import bzrlib.urlutils as urlutils
2763
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2764
 
                                                    'ascii')
2765
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2766
 
 
2767
 
 
2768
 
class UnsyncedBranches(BzrDirError):
2769
 
 
2770
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2771
 
            " bzr help sync-for-reconfigure.")
2772
 
 
2773
 
    def __init__(self, bzrdir, target_branch):
2774
 
        BzrDirError.__init__(self, bzrdir)
2775
 
        import bzrlib.urlutils as urlutils
2776
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2777
 
                                                        'ascii')
2778
 
 
2779
 
 
2780
 
class AlreadyBranch(BzrDirError):
2781
 
 
2782
 
    _fmt = "'%(display_url)s' is already a branch."
2783
 
 
2784
 
 
2785
 
class AlreadyTree(BzrDirError):
2786
 
 
2787
 
    _fmt = "'%(display_url)s' is already a tree."
2788
 
 
2789
 
 
2790
 
class AlreadyCheckout(BzrDirError):
2791
 
 
2792
 
    _fmt = "'%(display_url)s' is already a checkout."
2793
 
 
2794
 
 
2795
 
class AlreadyLightweightCheckout(BzrDirError):
2796
 
 
2797
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2798
 
 
2799
 
 
2800
 
class AlreadyUsingShared(BzrDirError):
2801
 
 
2802
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2803
 
 
2804
 
 
2805
 
class AlreadyStandalone(BzrDirError):
2806
 
 
2807
 
    _fmt = "'%(display_url)s' is already standalone."
2808
 
 
2809
 
 
2810
 
class AlreadyWithTrees(BzrDirError):
2811
 
 
2812
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2813
 
            "working trees.")
2814
 
 
2815
 
 
2816
 
class AlreadyWithNoTrees(BzrDirError):
2817
 
 
2818
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2819
 
            "working trees.")
2820
 
 
2821
 
 
2822
 
class ReconfigurationNotSupported(BzrDirError):
2823
 
 
2824
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2825
 
 
2826
 
 
2827
 
class NoBindLocation(BzrDirError):
2828
 
 
2829
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2830
 
 
2831
 
 
2832
 
class UncommittedChanges(BzrError):
2833
 
 
2834
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2835
 
            ' (See bzr status).%(more)s')
2836
 
 
2837
 
    def __init__(self, tree, more=None):
2838
 
        if more is None:
2839
 
            more = ''
2840
 
        else:
2841
 
            more = ' ' + more
2842
 
        import bzrlib.urlutils as urlutils
2843
 
        display_url = urlutils.unescape_for_display(
2844
 
            tree.user_url, 'ascii')
2845
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2846
 
 
2847
 
 
2848
 
class ShelvedChanges(UncommittedChanges):
2849
 
 
2850
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2851
 
            ' (See bzr shelve --list).%(more)s')
2852
 
 
2853
 
 
2854
 
class MissingTemplateVariable(BzrError):
2855
 
 
2856
 
    _fmt = 'Variable {%(name)s} is not available.'
2857
 
 
2858
 
    def __init__(self, name):
2859
 
        self.name = name
2860
 
 
2861
 
 
2862
 
class NoTemplate(BzrError):
2863
 
 
2864
 
    _fmt = 'No template specified.'
2865
 
 
2866
 
 
2867
 
class UnableCreateSymlink(BzrError):
2868
 
 
2869
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2870
 
 
2871
 
    def __init__(self, path=None):
2872
 
        path_str = ''
2873
 
        if path:
2874
 
            try:
2875
 
                path_str = repr(str(path))
2876
 
            except UnicodeEncodeError:
2877
 
                path_str = repr(path)
2878
 
            path_str += ' '
2879
 
        self.path_str = path_str
2880
 
 
2881
 
 
2882
 
class UnsupportedTimezoneFormat(BzrError):
2883
 
 
2884
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2885
 
            'options are "utc", "original", "local".')
2886
 
 
2887
 
    def __init__(self, timezone):
2888
 
        self.timezone = timezone
2889
 
 
2890
 
 
2891
 
class CommandAvailableInPlugin(StandardError):
2892
 
 
2893
 
    internal_error = False
2894
 
 
2895
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2896
 
 
2897
 
        self.plugin_metadata = plugin_metadata
2898
 
        self.cmd_name = cmd_name
2899
 
        self.provider = provider
2900
 
 
2901
 
    def __str__(self):
2902
 
 
2903
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2904
 
                'However, the following official plugin provides this command: %s\n'
2905
 
                'You can install it by going to: %s'
2906
 
                % (self.cmd_name, self.plugin_metadata['name'],
2907
 
                    self.plugin_metadata['url']))
2908
 
 
2909
 
        return _fmt
2910
 
 
2911
 
 
2912
 
class NoPluginAvailable(BzrError):
2913
 
    pass
2914
 
 
2915
 
 
2916
 
class UnableEncodePath(BzrError):
2917
 
 
2918
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2919
 
            'user encoding %(user_encoding)s')
2920
 
 
2921
 
    def __init__(self, path, kind):
2922
 
        from bzrlib.osutils import get_user_encoding
2923
 
        self.path = path
2924
 
        self.kind = kind
2925
 
        self.user_encoding = osutils.get_user_encoding()
2926
 
 
2927
 
 
2928
 
class NoSuchAlias(BzrError):
2929
 
 
2930
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2931
 
 
2932
 
    def __init__(self, alias_name):
2933
 
        BzrError.__init__(self, alias_name=alias_name)
2934
 
 
2935
 
 
2936
 
class DirectoryLookupFailure(BzrError):
2937
 
    """Base type for lookup errors."""
2938
 
 
2939
 
    pass
2940
 
 
2941
 
 
2942
 
class InvalidLocationAlias(DirectoryLookupFailure):
2943
 
 
2944
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2945
 
 
2946
 
    def __init__(self, alias_name):
2947
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2948
 
 
2949
 
 
2950
 
class UnsetLocationAlias(DirectoryLookupFailure):
2951
 
 
2952
 
    _fmt = 'No %(alias_name)s location assigned.'
2953
 
 
2954
 
    def __init__(self, alias_name):
2955
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2956
 
 
2957
 
 
2958
 
class CannotBindAddress(BzrError):
2959
 
 
2960
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2961
 
 
2962
 
    def __init__(self, host, port, orig_error):
2963
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2964
 
        BzrError.__init__(self, host=host, port=port,
2965
 
            orig_error=repr(orig_error.args))
2966
 
 
2967
 
 
2968
 
class UnknownRules(BzrError):
2969
 
 
2970
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2971
 
 
2972
 
    def __init__(self, unknowns):
2973
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2974
 
 
2975
 
 
2976
 
class HookFailed(BzrError):
2977
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2978
 
    than TipChangeRejected.
2979
 
 
2980
 
    Note that this exception is no longer raised, and the import is only left
2981
 
    to be nice to code which might catch it in a plugin.
2982
 
    """
2983
 
 
2984
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2985
 
            "%(traceback_text)s%(exc_value)s")
2986
 
 
2987
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2988
 
        if warn:
2989
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2990
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2991
 
        import traceback
2992
 
        self.hook_stage = hook_stage
2993
 
        self.hook_name = hook_name
2994
 
        self.exc_info = exc_info
2995
 
        self.exc_type = exc_info[0]
2996
 
        self.exc_value = exc_info[1]
2997
 
        self.exc_tb = exc_info[2]
2998
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2999
 
 
3000
 
 
3001
 
class TipChangeRejected(BzrError):
3002
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3003
 
    explicitly abort a change to a branch tip.
3004
 
    """
3005
 
 
3006
 
    _fmt = u"Tip change rejected: %(msg)s"
3007
 
 
3008
 
    def __init__(self, msg):
3009
 
        self.msg = msg
3010
 
 
3011
 
 
3012
 
class ShelfCorrupt(BzrError):
3013
 
 
3014
 
    _fmt = "Shelf corrupt."
3015
 
 
3016
 
 
3017
 
class NoSuchShelfId(BzrError):
3018
 
 
3019
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3020
 
 
3021
 
    def __init__(self, shelf_id):
3022
 
        BzrError.__init__(self, shelf_id=shelf_id)
3023
 
 
3024
 
 
3025
 
class InvalidShelfId(BzrError):
3026
 
 
3027
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3028
 
 
3029
 
    def __init__(self, invalid_id):
3030
 
        BzrError.__init__(self, invalid_id=invalid_id)
3031
 
 
3032
 
 
3033
 
class JailBreak(BzrError):
3034
 
 
3035
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3036
 
 
3037
 
    def __init__(self, url):
3038
 
        BzrError.__init__(self, url=url)
3039
 
 
3040
 
 
3041
 
class UserAbort(BzrError):
3042
 
 
3043
 
    _fmt = 'The user aborted the operation.'
3044
 
 
3045
 
 
3046
 
class MustHaveWorkingTree(BzrError):
3047
 
 
3048
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3049
 
 
3050
 
    def __init__(self, format, url):
3051
 
        BzrError.__init__(self, format=format, url=url)
3052
 
 
3053
 
 
3054
 
class NoSuchView(BzrError):
3055
 
    """A view does not exist.
3056
 
    """
3057
 
 
3058
 
    _fmt = u"No such view: %(view_name)s."
3059
 
 
3060
 
    def __init__(self, view_name):
3061
 
        self.view_name = view_name
3062
 
 
3063
 
 
3064
 
class ViewsNotSupported(BzrError):
3065
 
    """Views are not supported by a tree format.
3066
 
    """
3067
 
 
3068
 
    _fmt = ("Views are not supported by %(tree)s;"
3069
 
            " use 'bzr upgrade' to change your tree to a later format.")
3070
 
 
3071
 
    def __init__(self, tree):
3072
 
        self.tree = tree
3073
 
 
3074
 
 
3075
 
class FileOutsideView(BzrError):
3076
 
 
3077
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3078
 
            '%(view_str)s')
3079
 
 
3080
 
    def __init__(self, file_name, view_files):
3081
 
        self.file_name = file_name
3082
 
        self.view_str = ", ".join(view_files)
3083
 
 
3084
 
 
3085
 
class UnresumableWriteGroup(BzrError):
3086
 
 
3087
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3088
 
            "%(write_groups)r: %(reason)s")
3089
 
 
3090
 
    internal_error = True
3091
 
 
3092
 
    def __init__(self, repository, write_groups, reason):
3093
 
        self.repository = repository
3094
 
        self.write_groups = write_groups
3095
 
        self.reason = reason
3096
 
 
3097
 
 
3098
 
class UnsuspendableWriteGroup(BzrError):
3099
 
 
3100
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3101
 
 
3102
 
    internal_error = True
3103
 
 
3104
 
    def __init__(self, repository):
3105
 
        self.repository = repository
3106
 
 
3107
 
 
3108
 
class LossyPushToSameVCS(BzrError):
3109
 
 
3110
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3111
 
            "%(target_branch)r that are in the same VCS.")
3112
 
 
3113
 
    internal_error = True
3114
 
 
3115
 
    def __init__(self, source_branch, target_branch):
3116
 
        self.source_branch = source_branch
3117
 
        self.target_branch = target_branch
3118
 
 
3119
 
 
3120
 
class NoRoundtrippingSupport(BzrError):
3121
 
 
3122
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3123
 
            "%(target_branch)r.")
3124
 
 
3125
 
    internal_error = True
3126
 
 
3127
 
    def __init__(self, source_branch, target_branch):
3128
 
        self.source_branch = source_branch
3129
 
        self.target_branch = target_branch
3130
 
 
3131
 
 
3132
 
class FileTimestampUnavailable(BzrError):
3133
 
 
3134
 
    _fmt = "The filestamp for %(path)s is not available."
3135
 
 
3136
 
    internal_error = True
3137
 
 
3138
 
    def __init__(self, path):
3139
 
        self.path = path
3140
 
 
3141
 
 
3142
 
class NoColocatedBranchSupport(BzrError):
3143
 
 
3144
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3145
 
 
3146
 
    def __init__(self, bzrdir):
3147
 
        self.bzrdir = bzrdir
3148
 
 
3149
 
 
3150
 
class NoWhoami(BzrError):
3151
 
 
3152
 
    _fmt = ('Unable to determine your name.\n'
3153
 
        "Please, set your name with the 'whoami' command.\n"
3154
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3155
 
 
3156
 
 
3157
 
class InvalidPattern(BzrError):
3158
 
 
3159
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3160
 
 
3161
 
    def __init__(self, msg):
3162
 
        self.msg = msg
3163
 
 
3164
 
 
3165
 
class RecursiveBind(BzrError):
3166
 
 
3167
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3168
 
        'Please use `bzr unbind` to fix.')
3169
 
 
3170
 
    def __init__(self, branch_url):
3171
 
        self.branch_url = branch_url
3172