/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

merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
 
21
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
44
43
# 'unprintable'.
45
44
 
46
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
 
50
 
 
51
 
47
52
class BzrError(StandardError):
48
53
    """
49
54
    Base class for errors raised by bzrlib.
56
61
    :cvar _fmt: Format string to display the error; this is expanded
57
62
    by the instance's dict.
58
63
    """
59
 
    
 
64
 
60
65
    internal_error = False
61
66
 
62
67
    def __init__(self, msg=None, **kwds):
67
72
        arguments can be given.  The first is for generic "user" errors which
68
73
        are not intended to be caught and so do not need a specific subclass.
69
74
        The second case is for use with subclasses that provide a _fmt format
70
 
        string to print the arguments.  
 
75
        string to print the arguments.
71
76
 
72
 
        Keyword arguments are taken as parameters to the error, which can 
73
 
        be inserted into the format string template.  It's recommended 
74
 
        that subclasses override the __init__ method to require specific 
 
77
        Keyword arguments are taken as parameters to the error, which can
 
78
        be inserted into the format string template.  It's recommended
 
79
        that subclasses override the __init__ method to require specific
75
80
        parameters.
76
81
 
77
82
        :param msg: If given, this is the literal complete text for the error,
78
 
        not subject to expansion.
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
79
85
        """
80
86
        StandardError.__init__(self)
81
87
        if msg is not None:
87
93
            for key, value in kwds.items():
88
94
                setattr(self, key, value)
89
95
 
90
 
    def __str__(self):
 
96
    def _format(self):
91
97
        s = getattr(self, '_preformatted_string', None)
92
98
        if s is not None:
93
 
            # contains a preformatted message; must be cast to plain str
94
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
95
101
        try:
96
102
            fmt = self._get_format_string()
97
103
            if fmt:
98
 
                s = fmt % self.__dict__
 
104
                d = dict(self.__dict__)
 
105
                s = fmt % d
99
106
                # __str__() should always return a 'str' object
100
107
                # never a 'unicode' object.
101
 
                if isinstance(s, unicode):
102
 
                    return s.encode('utf8')
103
108
                return s
104
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
105
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
108
113
                   getattr(self, '_fmt', None),
109
114
                   e)
110
115
 
 
116
    def __unicode__(self):
 
117
        u = self._format()
 
118
        if isinstance(u, str):
 
119
            # Try decoding the str using the default encoding.
 
120
            u = unicode(u)
 
121
        elif not isinstance(u, unicode):
 
122
            # Try to make a unicode object from it, because __unicode__ must
 
123
            # return a unicode object.
 
124
            u = unicode(u)
 
125
        return u
 
126
 
 
127
    def __str__(self):
 
128
        s = self._format()
 
129
        if isinstance(s, unicode):
 
130
            s = s.encode('utf8')
 
131
        else:
 
132
            # __str__ must return a str.
 
133
            s = str(s)
 
134
        return s
 
135
 
 
136
    def __repr__(self):
 
137
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
138
 
111
139
    def _get_format_string(self):
112
140
        """Return format string for this exception or None"""
113
141
        fmt = getattr(self, '_fmt', None)
125
153
               getattr(self, '_fmt', None),
126
154
               )
127
155
 
 
156
    def __eq__(self, other):
 
157
        if self.__class__ is not other.__class__:
 
158
            return NotImplemented
 
159
        return self.__dict__ == other.__dict__
 
160
 
 
161
 
 
162
class InternalBzrError(BzrError):
 
163
    """Base class for errors that are internal in nature.
 
164
 
 
165
    This is a convenience class for errors that are internal. The
 
166
    internal_error attribute can still be altered in subclasses, if needed.
 
167
    Using this class is simply an easy way to get internal errors.
 
168
    """
 
169
 
 
170
    internal_error = True
 
171
 
128
172
 
129
173
class BzrNewError(BzrError):
130
174
    """Deprecated error base class."""
160
204
 
161
205
 
162
206
class AlreadyBuilding(BzrError):
163
 
    
 
207
 
164
208
    _fmt = "The tree builder is already building a tree."
165
209
 
166
210
 
167
 
class BzrCheckError(BzrError):
168
 
    
169
 
    _fmt = "Internal check failed: %(message)s"
170
 
 
171
 
    internal_error = True
172
 
 
173
 
    def __init__(self, message):
174
 
        BzrError.__init__(self)
175
 
        self.message = message
176
 
 
177
 
 
178
 
class DisabledMethod(BzrError):
 
211
class BranchError(BzrError):
 
212
    """Base class for concrete 'errors about a branch'."""
 
213
 
 
214
    def __init__(self, branch):
 
215
        BzrError.__init__(self, branch=branch)
 
216
 
 
217
 
 
218
class BzrCheckError(InternalBzrError):
 
219
 
 
220
    _fmt = "Internal check failed: %(msg)s"
 
221
 
 
222
    def __init__(self, msg):
 
223
        BzrError.__init__(self)
 
224
        self.msg = msg
 
225
 
 
226
 
 
227
class DirstateCorrupt(BzrError):
 
228
 
 
229
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
230
 
 
231
    def __init__(self, state, msg):
 
232
        BzrError.__init__(self)
 
233
        self.state = state
 
234
        self.msg = msg
 
235
 
 
236
 
 
237
class DisabledMethod(InternalBzrError):
179
238
 
180
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
181
240
 
182
 
    internal_error = True
183
 
 
184
241
    def __init__(self, class_name):
185
242
        BzrError.__init__(self)
186
243
        self.class_name = class_name
207
264
        self.transport = transport
208
265
 
209
266
 
210
 
class InvalidEntryName(BzrError):
211
 
    
 
267
class InvalidEntryName(InternalBzrError):
 
268
 
212
269
    _fmt = "Invalid entry name: %(name)s"
213
270
 
214
 
    internal_error = True
215
 
 
216
271
    def __init__(self, name):
217
272
        BzrError.__init__(self)
218
273
        self.name = name
219
274
 
220
275
 
221
276
class InvalidRevisionNumber(BzrError):
222
 
    
 
277
 
223
278
    _fmt = "Invalid revision number %(revno)s"
224
279
 
225
280
    def __init__(self, revno):
237
292
        self.revision_id = revision_id
238
293
        self.branch = branch
239
294
 
 
295
 
240
296
class ReservedId(BzrError):
241
297
 
242
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
245
301
        self.revision_id = revision_id
246
302
 
247
303
 
 
304
class RootMissing(InternalBzrError):
 
305
 
 
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
307
        "record_entry_contents.")
 
308
 
 
309
 
 
310
class NoPublicBranch(BzrError):
 
311
 
 
312
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
313
 
 
314
    def __init__(self, branch):
 
315
        import bzrlib.urlutils as urlutils
 
316
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
317
        BzrError.__init__(self, branch_url=public_location)
 
318
 
 
319
 
248
320
class NoHelpTopic(BzrError):
249
321
 
250
322
    _fmt = ("No help could be found for '%(topic)s'. "
256
328
 
257
329
class NoSuchId(BzrError):
258
330
 
259
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
260
 
    
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
261
333
    def __init__(self, tree, file_id):
262
334
        BzrError.__init__(self)
263
335
        self.file_id = file_id
264
336
        self.tree = tree
265
337
 
266
338
 
267
 
class InventoryModified(BzrError):
 
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):
268
354
 
269
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
270
356
            " so a clean inventory cannot be read without data loss.")
271
357
 
272
 
    internal_error = True
273
 
 
274
358
    def __init__(self, tree):
275
359
        self.tree = tree
276
360
 
277
361
 
278
362
class NoWorkingTree(BzrError):
279
363
 
280
 
    _fmt = "No WorkingTree exists for %(base)s."
281
 
    
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
282
366
    def __init__(self, base):
283
367
        BzrError.__init__(self)
284
368
        self.base = base
297
381
        self.url = url
298
382
 
299
383
 
300
 
class WorkingTreeAlreadyPopulated(BzrError):
301
 
 
302
 
    _fmt = """Working tree already populated in %(base)s"""
303
 
 
304
 
    internal_error = True
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
305
387
 
306
388
    def __init__(self, base):
307
389
        self.base = base
308
390
 
 
391
 
309
392
class BzrCommandError(BzrError):
310
393
    """Error from user command"""
311
394
 
312
 
    internal_error = False
313
 
 
314
395
    # Error from malformed user command; please avoid raising this as a
315
396
    # generic exception not caused by user input.
316
397
    #
318
399
    # are not intended to be caught anyway.  UI code need not subclass
319
400
    # BzrCommandError, and non-UI code should not throw a subclass of
320
401
    # 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
331
402
 
332
403
 
333
404
class NotWriteLocked(BzrError):
406
477
    def __init__(self, name, value):
407
478
        BzrError.__init__(self, name=name, value=value)
408
479
 
409
 
    
 
480
 
410
481
class StrictCommitFailed(BzrError):
411
482
 
412
483
    _fmt = "Commit refused because there are unknown files in the tree"
415
486
# XXX: Should be unified with TransportError; they seem to represent the
416
487
# same thing
417
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
418
 
# - this is finer than a TransportError - and more useful as such. It 
 
489
# - this is finer than a TransportError - and more useful as such. It
419
490
# differentiates between 'transport has failed' and 'operation on a transport
420
491
# has failed.'
421
492
class PathError(BzrError):
422
 
    
 
493
 
423
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
424
495
 
425
496
    def __init__(self, path, extra=None):
445
516
    """Used when renaming and both source and dest exist."""
446
517
 
447
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
448
 
            "%(extra)s")
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
449
521
 
450
522
    def __init__(self, source, dest, extra=None):
451
523
        BzrError.__init__(self)
459
531
 
460
532
class NotADirectory(PathError):
461
533
 
462
 
    _fmt = "%(path)r is not a directory %(extra)s"
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
463
535
 
464
536
 
465
537
class NotInWorkingDirectory(PathError):
466
538
 
467
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
468
540
 
469
541
 
470
542
class DirectoryNotEmpty(PathError):
471
543
 
472
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
473
 
 
474
 
 
475
 
class ReadingCompleted(BzrError):
476
 
    
 
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
 
477
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
478
555
            "called upon it - the request has been completed and no more "
479
556
            "data may be read.")
480
557
 
481
 
    internal_error = True
482
 
 
483
558
    def __init__(self, request):
484
559
        self.request = request
485
560
 
486
561
 
487
562
class ResourceBusy(PathError):
488
563
 
489
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
490
565
 
491
566
 
492
567
class PermissionDenied(PathError):
493
568
 
494
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
495
570
 
496
571
 
497
572
class InvalidURL(PathError):
498
573
 
499
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
500
575
 
501
576
 
502
577
class InvalidURLJoin(PathError):
503
578
 
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)
 
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
509
608
 
510
609
 
511
610
class UnknownHook(BzrError):
526
625
        PathError.__init__(self, url, extra=extra)
527
626
 
528
627
 
 
628
class UnstackableBranchFormat(BzrError):
 
629
 
 
630
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
631
        "You will need to upgrade the branch to permit branch stacking.")
 
632
 
 
633
    def __init__(self, format, url):
 
634
        BzrError.__init__(self)
 
635
        self.format = format
 
636
        self.url = url
 
637
 
 
638
 
 
639
class UnstackableRepositoryFormat(BzrError):
 
640
 
 
641
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
642
        "You will need to upgrade the repository to permit branch stacking.")
 
643
 
 
644
    def __init__(self, format, url):
 
645
        BzrError.__init__(self)
 
646
        self.format = format
 
647
        self.url = url
 
648
 
 
649
 
529
650
class ReadError(PathError):
530
 
    
 
651
 
531
652
    _fmt = """Error reading from %(path)r."""
532
653
 
533
654
 
534
655
class ShortReadvError(PathError):
535
656
 
536
 
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
537
 
            " at %(offset)s for %(path)s%(extra)s")
 
657
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
658
            ' at %(offset)s for "%(path)s"%(extra)s')
538
659
 
539
660
    internal_error = True
540
661
 
547
668
 
548
669
class PathNotChild(PathError):
549
670
 
550
 
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
671
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
551
672
 
552
673
    internal_error = True
553
674
 
563
684
 
564
685
class InvalidNormalization(PathError):
565
686
 
566
 
    _fmt = "Path %(path)r is not unicode normalized"
 
687
    _fmt = 'Path "%(path)s" is not unicode normalized'
567
688
 
568
689
 
569
690
# TODO: This is given a URL; we try to unescape it but doing that from inside
570
691
# the exception object is a bit undesirable.
571
 
# TODO: Probably this behavior of should be a common superclass 
 
692
# TODO: Probably this behavior of should be a common superclass
572
693
class NotBranchError(PathError):
573
694
 
574
 
    _fmt = "Not a branch: %(path)s"
 
695
    _fmt = 'Not a branch: "%(path)s".'
575
696
 
576
697
    def __init__(self, path):
577
698
       import bzrlib.urlutils as urlutils
589
710
 
590
711
class AlreadyBranchError(PathError):
591
712
 
592
 
    _fmt = "Already a branch: %(path)s."
 
713
    _fmt = 'Already a branch: "%(path)s".'
593
714
 
594
715
 
595
716
class BranchExistsWithoutWorkingTree(PathError):
596
717
 
597
 
    _fmt = "Directory contains a branch, but no working tree \
598
 
(use bzr checkout if you wish to build a working tree): %(path)s"
 
718
    _fmt = 'Directory contains a branch, but no working tree \
 
719
(use bzr checkout if you wish to build a working tree): "%(path)s"'
599
720
 
600
721
 
601
722
class AtomicFileAlreadyClosed(PathError):
602
723
 
603
 
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
604
 
            " %(path)s")
 
724
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
725
            ' "%(path)s"')
605
726
 
606
727
    def __init__(self, path, function):
607
728
        PathError.__init__(self, path=path, extra=None)
610
731
 
611
732
class InaccessibleParent(PathError):
612
733
 
613
 
    _fmt = ("Parent not accessible given base %(base)s and"
614
 
            " relative path %(path)s")
 
734
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
735
            ' relative path "%(path)s"')
615
736
 
616
737
    def __init__(self, path, base):
617
738
        PathError.__init__(self, path)
620
741
 
621
742
class NoRepositoryPresent(BzrError):
622
743
 
623
 
    _fmt = "No repository present: %(path)r"
 
744
    _fmt = 'No repository present: "%(path)s"'
624
745
    def __init__(self, bzrdir):
625
746
        BzrError.__init__(self)
626
747
        self.path = bzrdir.transport.clone('..').base
628
749
 
629
750
class FileInWrongBranch(BzrError):
630
751
 
631
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
752
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
632
753
 
633
754
    def __init__(self, branch, path):
634
755
        BzrError.__init__(self)
643
764
 
644
765
 
645
766
class UnknownFormatError(BzrError):
646
 
    
647
 
    _fmt = "Unknown branch format: %(format)r"
 
767
 
 
768
    _fmt = "Unknown %(kind)s format: %(format)r"
 
769
 
 
770
    def __init__(self, format, kind='branch'):
 
771
        self.kind = kind
 
772
        self.format = format
648
773
 
649
774
 
650
775
class IncompatibleFormat(BzrError):
651
 
    
 
776
 
652
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
653
778
 
654
779
    def __init__(self, format, bzrdir_format):
659
784
 
660
785
class IncompatibleRepositories(BzrError):
661
786
 
662
 
    _fmt = "Repository %(target)s is not compatible with repository"\
663
 
        " %(source)s"
 
787
    _fmt = "%(target)s\n" \
 
788
            "is not compatible with\n" \
 
789
            "%(source)s\n" \
 
790
            "%(details)s"
664
791
 
665
 
    def __init__(self, source, target):
666
 
        BzrError.__init__(self, target=target, source=source)
 
792
    def __init__(self, source, target, details=None):
 
793
        if details is None:
 
794
            details = "(no details)"
 
795
        BzrError.__init__(self, target=target, source=source, details=details)
667
796
 
668
797
 
669
798
class IncompatibleRevision(BzrError):
670
 
    
 
799
 
671
800
    _fmt = "Revision is not compatible with %(repo_format)s"
672
801
 
673
802
    def __init__(self, repo_format):
678
807
class AlreadyVersionedError(BzrError):
679
808
    """Used when a path is expected not to be versioned, but it is."""
680
809
 
681
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
810
    _fmt = "%(context_info)s%(path)s is already versioned."
682
811
 
683
812
    def __init__(self, path, context_info=None):
684
813
        """Construct a new AlreadyVersionedError.
699
828
class NotVersionedError(BzrError):
700
829
    """Used when a path is expected to be versioned, but it is not."""
701
830
 
702
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
831
    _fmt = "%(context_info)s%(path)s is not versioned."
703
832
 
704
833
    def __init__(self, path, context_info=None):
705
834
        """Construct a new NotVersionedError.
756
885
        BzrError.__init__(self, filename=filename, kind=kind)
757
886
 
758
887
 
 
888
class BadFilenameEncoding(BzrError):
 
889
 
 
890
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
891
            ' encoding %(fs_encoding)s')
 
892
 
 
893
    def __init__(self, filename, fs_encoding):
 
894
        BzrError.__init__(self)
 
895
        self.filename = filename
 
896
        self.fs_encoding = fs_encoding
 
897
 
 
898
 
759
899
class ForbiddenControlFileError(BzrError):
760
900
 
761
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
762
 
 
763
 
 
764
 
class LockError(BzrError):
 
901
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
902
 
 
903
 
 
904
class LockError(InternalBzrError):
765
905
 
766
906
    _fmt = "Lock error: %(msg)s"
767
907
 
768
 
    internal_error = True
769
 
 
770
908
    # All exceptions from the lock/unlock functions should be from
771
909
    # this exception class.  They will be translated as necessary. The
772
910
    # original exception is available as e.original_error
774
912
    # New code should prefer to raise specific subclasses
775
913
    def __init__(self, message):
776
914
        # Python 2.5 uses a slot for StandardError.message,
777
 
        # so use a different variable name
778
 
        # so it is exposed in self.__dict__
 
915
        # so use a different variable name.  We now work around this in
 
916
        # BzrError.__str__, but this member name is kept for compatability.
779
917
        self.msg = message
780
918
 
781
919
 
816
954
        self.obj = obj
817
955
 
818
956
 
819
 
class ReadOnlyLockError(LockError):
820
 
 
821
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
822
 
 
823
 
    def __init__(self, fname, msg):
 
957
class LockFailed(LockError):
 
958
 
 
959
    internal_error = False
 
960
 
 
961
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
962
 
 
963
    def __init__(self, lock, why):
824
964
        LockError.__init__(self, '')
825
 
        self.fname = fname
826
 
        self.msg = msg
 
965
        self.lock = lock
 
966
        self.why = why
827
967
 
828
968
 
829
969
class OutSideTransaction(BzrError):
853
993
 
854
994
class UnlockableTransport(LockError):
855
995
 
 
996
    internal_error = False
 
997
 
856
998
    _fmt = "Cannot lock: transport is read only: %(transport)s"
857
999
 
858
1000
    def __init__(self, transport):
861
1003
 
862
1004
class LockContention(LockError):
863
1005
 
864
 
    _fmt = "Could not acquire lock %(lock)s"
 
1006
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
865
1007
    # TODO: show full url for lock, combining the transport and relative
866
1008
    # bits?
867
1009
 
868
1010
    internal_error = False
869
1011
 
870
 
    def __init__(self, lock):
 
1012
    def __init__(self, lock, msg=''):
871
1013
        self.lock = lock
 
1014
        self.msg = msg
872
1015
 
873
1016
 
874
1017
class LockBroken(LockError):
909
1052
 
910
1053
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
911
1054
 
912
 
    internal_error = True
913
 
 
914
1055
    def __init__(self, obj):
915
1056
        self.obj = obj
916
1057
 
941
1082
        BzrError.__init__(self, files=files, files_str=files_str)
942
1083
 
943
1084
 
 
1085
class BadCommitMessageEncoding(BzrError):
 
1086
 
 
1087
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1088
        'the current encoding.'
 
1089
 
 
1090
 
944
1091
class UpgradeReadonly(BzrError):
945
1092
 
946
1093
    _fmt = "Upgrade URL cannot work with readonly URLs."
960
1107
    _fmt = "Commit refused because there are unknowns in the tree."
961
1108
 
962
1109
 
963
 
class NoSuchRevision(BzrError):
964
 
 
965
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
966
 
 
967
 
    internal_error = True
 
1110
class NoSuchRevision(InternalBzrError):
 
1111
 
 
1112
    _fmt = "%(branch)s has no revision %(revision)s"
968
1113
 
969
1114
    def __init__(self, branch, revision):
 
1115
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
970
1116
        BzrError.__init__(self, branch=branch, revision=revision)
971
1117
 
972
1118
 
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)
 
1119
class RangeInChangeOption(BzrError):
 
1120
 
 
1121
    _fmt = "Option --change does not accept revision ranges"
984
1122
 
985
1123
 
986
1124
class NoSuchRevisionSpec(BzrError):
993
1131
 
994
1132
class NoSuchRevisionInTree(NoSuchRevision):
995
1133
    """When using Tree.revision_tree, and the revision is not accessible."""
996
 
    
997
 
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
1134
 
 
1135
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
998
1136
 
999
1137
    def __init__(self, tree, revision_id):
1000
1138
        BzrError.__init__(self)
1035
1173
class DivergedBranches(BzrError):
1036
1174
 
1037
1175
    _fmt = ("These branches have diverged."
1038
 
            " Use the merge command to reconcile them.")
1039
 
 
1040
 
    internal_error = False
 
1176
            " Use the missing command to see how.\n"
 
1177
            "Use the merge command to reconcile them.")
1041
1178
 
1042
1179
    def __init__(self, branch1, branch2):
1043
1180
        self.branch1 = branch1
1044
1181
        self.branch2 = branch2
1045
1182
 
1046
1183
 
1047
 
class NotLefthandHistory(BzrError):
 
1184
class NotLefthandHistory(InternalBzrError):
1048
1185
 
1049
1186
    _fmt = "Supplied history does not follow left-hand parents"
1050
1187
 
1051
 
    internal_error = True
1052
 
 
1053
1188
    def __init__(self, history):
1054
1189
        BzrError.__init__(self, history=history)
1055
1190
 
1059
1194
    _fmt = ("Branches have no common ancestor, and"
1060
1195
            " no merge base revision was specified.")
1061
1196
 
1062
 
    internal_error = False
 
1197
 
 
1198
class CannotReverseCherrypick(BzrError):
 
1199
 
 
1200
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1201
            ' or diff3.')
1063
1202
 
1064
1203
 
1065
1204
class NoCommonAncestor(BzrError):
1066
 
    
 
1205
 
1067
1206
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1068
1207
 
1069
1208
    def __init__(self, revision_a, revision_b):
1089
1228
            not_ancestor_id=not_ancestor_id)
1090
1229
 
1091
1230
 
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
 
 
1101
1231
class AmbiguousBase(BzrError):
1102
1232
 
1103
1233
    def __init__(self, bases):
1109
1239
        self.bases = bases
1110
1240
 
1111
1241
 
1112
 
class NoCommits(BzrError):
 
1242
class NoCommits(BranchError):
1113
1243
 
1114
1244
    _fmt = "Branch %(branch)s has no commits."
1115
1245
 
1116
 
    def __init__(self, branch):
1117
 
        BzrError.__init__(self, branch=branch)
1118
 
 
1119
1246
 
1120
1247
class UnlistableStore(BzrError):
1121
1248
 
1132
1259
 
1133
1260
class BoundBranchOutOfDate(BzrError):
1134
1261
 
1135
 
    _fmt = ("Bound branch %(branch)s is out of date"
1136
 
            " with master branch %(master)s.")
 
1262
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1263
            " %(master)s.")
1137
1264
 
1138
1265
    def __init__(self, branch, master):
1139
1266
        BzrError.__init__(self)
1140
1267
        self.branch = branch
1141
1268
        self.master = master
1142
1269
 
1143
 
        
 
1270
 
1144
1271
class CommitToDoubleBoundBranch(BzrError):
1145
1272
 
1146
1273
    _fmt = ("Cannot commit to branch %(branch)s."
1176
1303
 
1177
1304
class WeaveError(BzrError):
1178
1305
 
1179
 
    _fmt = "Error in processing weave: %(message)s"
 
1306
    _fmt = "Error in processing weave: %(msg)s"
1180
1307
 
1181
 
    def __init__(self, message=None):
 
1308
    def __init__(self, msg=None):
1182
1309
        BzrError.__init__(self)
1183
 
        self.message = message
 
1310
        self.msg = msg
1184
1311
 
1185
1312
 
1186
1313
class WeaveRevisionAlreadyPresent(WeaveError):
1215
1342
 
1216
1343
class WeaveParentMismatch(WeaveError):
1217
1344
 
1218
 
    _fmt = "Parents are mismatched between two revisions."
1219
 
    
 
1345
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1346
 
1220
1347
 
1221
1348
class WeaveInvalidChecksum(WeaveError):
1222
1349
 
1248
1375
 
1249
1376
 
1250
1377
class VersionedFileError(BzrError):
1251
 
    
 
1378
 
1252
1379
    _fmt = "Versioned file error"
1253
1380
 
1254
1381
 
1255
1382
class RevisionNotPresent(VersionedFileError):
1256
 
    
1257
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1383
 
 
1384
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1258
1385
 
1259
1386
    def __init__(self, revision_id, file_id):
1260
1387
        VersionedFileError.__init__(self)
1263
1390
 
1264
1391
 
1265
1392
class RevisionAlreadyPresent(VersionedFileError):
1266
 
    
1267
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1393
 
 
1394
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1268
1395
 
1269
1396
    def __init__(self, revision_id, file_id):
1270
1397
        VersionedFileError.__init__(self)
1277
1404
    _fmt = "Text did not match its checksum: %(message)s"
1278
1405
 
1279
1406
 
1280
 
class KnitError(BzrError):
1281
 
    
 
1407
class KnitError(InternalBzrError):
 
1408
 
1282
1409
    _fmt = "Knit error"
1283
1410
 
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
 
 
1296
1411
 
1297
1412
class KnitCorrupt(KnitError):
1298
1413
 
1304
1419
        self.how = how
1305
1420
 
1306
1421
 
 
1422
class SHA1KnitCorrupt(KnitCorrupt):
 
1423
 
 
1424
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1425
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1426
        "sha %(actual)s")
 
1427
 
 
1428
    def __init__(self, filename, actual, expected, key, content):
 
1429
        KnitError.__init__(self)
 
1430
        self.filename = filename
 
1431
        self.actual = actual
 
1432
        self.expected = expected
 
1433
        self.key = key
 
1434
        self.content = content
 
1435
 
 
1436
 
 
1437
class KnitDataStreamIncompatible(KnitError):
 
1438
    # Not raised anymore, as we can convert data streams.  In future we may
 
1439
    # need it again for more exotic cases, so we're keeping it around for now.
 
1440
 
 
1441
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1442
 
 
1443
    def __init__(self, stream_format, target_format):
 
1444
        self.stream_format = stream_format
 
1445
        self.target_format = target_format
 
1446
 
 
1447
 
 
1448
class KnitDataStreamUnknown(KnitError):
 
1449
    # Indicates a data stream we don't know how to handle.
 
1450
 
 
1451
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1452
 
 
1453
    def __init__(self, stream_format):
 
1454
        self.stream_format = stream_format
 
1455
 
 
1456
 
 
1457
class KnitHeaderError(KnitError):
 
1458
 
 
1459
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1460
 
 
1461
    def __init__(self, badline, filename):
 
1462
        KnitError.__init__(self)
 
1463
        self.badline = badline
 
1464
        self.filename = filename
 
1465
 
1307
1466
class KnitIndexUnknownMethod(KnitError):
1308
1467
    """Raised when we don't understand the storage method.
1309
1468
 
1310
1469
    Currently only 'fulltext' and 'line-delta' are supported.
1311
1470
    """
1312
 
    
 
1471
 
1313
1472
    _fmt = ("Knit index %(filename)s does not have a known method"
1314
1473
            " in options: %(options)r")
1315
1474
 
1319
1478
        self.options = options
1320
1479
 
1321
1480
 
 
1481
class RetryWithNewPacks(BzrError):
 
1482
    """Raised when we realize that the packs on disk have changed.
 
1483
 
 
1484
    This is meant as more of a signaling exception, to trap between where a
 
1485
    local error occurred and the code that can actually handle the error and
 
1486
    code that can retry appropriately.
 
1487
    """
 
1488
 
 
1489
    internal_error = True
 
1490
 
 
1491
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1492
            " %(orig_error)s")
 
1493
 
 
1494
    def __init__(self, context, reload_occurred, exc_info):
 
1495
        """create a new RetryWithNewPacks error.
 
1496
 
 
1497
        :param reload_occurred: Set to True if we know that the packs have
 
1498
            already been reloaded, and we are failing because of an in-memory
 
1499
            cache miss. If set to True then we will ignore if a reload says
 
1500
            nothing has changed, because we assume it has already reloaded. If
 
1501
            False, then a reload with nothing changed will force an error.
 
1502
        :param exc_info: The original exception traceback, so if there is a
 
1503
            problem we can raise the original error (value from sys.exc_info())
 
1504
        """
 
1505
        BzrError.__init__(self)
 
1506
        self.reload_occurred = reload_occurred
 
1507
        self.exc_info = exc_info
 
1508
        self.orig_error = exc_info[1]
 
1509
        # TODO: The global error handler should probably treat this by
 
1510
        #       raising/printing the original exception with a bit about
 
1511
        #       RetryWithNewPacks also not being caught
 
1512
 
 
1513
 
 
1514
class RetryAutopack(RetryWithNewPacks):
 
1515
    """Raised when we are autopacking and we find a missing file.
 
1516
 
 
1517
    Meant as a signaling exception, to tell the autopack code it should try
 
1518
    again.
 
1519
    """
 
1520
 
 
1521
    internal_error = True
 
1522
 
 
1523
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1524
            " context: %(context)s %(orig_error)s")
 
1525
 
 
1526
 
1322
1527
class NoSuchExportFormat(BzrError):
1323
 
    
 
1528
 
1324
1529
    _fmt = "Export format %(format)r not supported"
1325
1530
 
1326
1531
    def __init__(self, format):
1329
1534
 
1330
1535
 
1331
1536
class TransportError(BzrError):
1332
 
    
 
1537
 
1333
1538
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1334
1539
 
1335
1540
    def __init__(self, msg=None, orig_error=None):
1344
1549
        BzrError.__init__(self)
1345
1550
 
1346
1551
 
1347
 
class TooManyConcurrentRequests(BzrError):
 
1552
class TooManyConcurrentRequests(InternalBzrError):
1348
1553
 
1349
1554
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1350
1555
            " Be sure to finish_writing and finish_reading on the"
1351
1556
            " currently open request.")
1352
1557
 
1353
 
    internal_error = True
1354
 
 
1355
1558
    def __init__(self, medium):
1356
1559
        self.medium = medium
1357
1560
 
1364
1567
        self.details = details
1365
1568
 
1366
1569
 
 
1570
class UnexpectedProtocolVersionMarker(TransportError):
 
1571
 
 
1572
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1573
 
 
1574
    def __init__(self, marker):
 
1575
        self.marker = marker
 
1576
 
 
1577
 
 
1578
class UnknownSmartMethod(InternalBzrError):
 
1579
 
 
1580
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1581
 
 
1582
    def __init__(self, verb):
 
1583
        self.verb = verb
 
1584
 
 
1585
 
 
1586
class SmartMessageHandlerError(InternalBzrError):
 
1587
 
 
1588
    _fmt = ("The message handler raised an exception:\n"
 
1589
            "%(traceback_text)s")
 
1590
 
 
1591
    def __init__(self, exc_info):
 
1592
        import traceback
 
1593
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1594
        self.exc_info = exc_info
 
1595
        traceback_strings = traceback.format_exception(
 
1596
                self.exc_type, self.exc_value, self.exc_tb)
 
1597
        self.traceback_text = ''.join(traceback_strings)
 
1598
 
 
1599
 
1367
1600
# A set of semi-meaningful errors which can be thrown
1368
1601
class TransportNotPossible(TransportError):
1369
1602
 
1394
1627
            self.port = ':%s' % port
1395
1628
 
1396
1629
 
 
1630
# XXX: This is also used for unexpected end of file, which is different at the
 
1631
# TCP level from "connection reset".
1397
1632
class ConnectionReset(TransportError):
1398
1633
 
1399
1634
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1401
1636
 
1402
1637
class InvalidRange(TransportError):
1403
1638
 
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)))
 
1639
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1640
 
 
1641
    def __init__(self, path, offset, msg=None):
 
1642
        TransportError.__init__(self, msg)
1409
1643
        self.path = path
1410
1644
        self.offset = offset
1411
1645
 
1422
1656
class InvalidHttpRange(InvalidHttpResponse):
1423
1657
 
1424
1658
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1425
 
    
 
1659
 
1426
1660
    def __init__(self, path, range, msg):
1427
1661
        self.range = range
1428
1662
        InvalidHttpResponse.__init__(self, path, msg)
1431
1665
class InvalidHttpContentType(InvalidHttpResponse):
1432
1666
 
1433
1667
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1434
 
    
 
1668
 
1435
1669
    def __init__(self, path, ctype, msg):
1436
1670
        self.ctype = ctype
1437
1671
        InvalidHttpResponse.__init__(self, path, msg)
1441
1675
 
1442
1676
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1443
1677
 
1444
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1678
    def __init__(self, source, target, is_permanent=False):
1445
1679
        self.source = source
1446
1680
        self.target = target
1447
 
        if is_permament:
 
1681
        if is_permanent:
1448
1682
            self.permanently = ' permanently'
1449
1683
        else:
1450
1684
            self.permanently = ''
1451
 
        self.is_permament = is_permament
1452
 
        self._qualified_proto = qual_proto
1453
1685
        TransportError.__init__(self)
1454
1686
 
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
 
 
1488
1687
 
1489
1688
class TooManyRedirections(TransportError):
1490
1689
 
1491
1690
    _fmt = "Too many redirections"
1492
1691
 
 
1692
 
1493
1693
class ConflictsInTree(BzrError):
1494
1694
 
1495
1695
    _fmt = "Working tree has conflicts."
1501
1701
        if filename is None:
1502
1702
            filename = ""
1503
1703
        message = "Error(s) parsing config file %s:\n%s" % \
1504
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1704
            (filename, ('\n'.join(e.msg for e in errors)))
1505
1705
        BzrError.__init__(self, message)
1506
1706
 
1507
1707
 
1516
1716
 
1517
1717
class SigningFailed(BzrError):
1518
1718
 
1519
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1719
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1520
1720
 
1521
1721
    def __init__(self, command_line):
1522
1722
        BzrError.__init__(self, command_line=command_line)
1524
1724
 
1525
1725
class WorkingTreeNotRevision(BzrError):
1526
1726
 
1527
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1727
    _fmt = ("The working tree for %(basedir)s has changed since"
1528
1728
            " the last commit, but weave merge requires that it be"
1529
1729
            " unchanged")
1530
1730
 
1547
1747
        self.graph = graph
1548
1748
 
1549
1749
 
1550
 
class WritingCompleted(BzrError):
 
1750
class WritingCompleted(InternalBzrError):
1551
1751
 
1552
1752
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1553
1753
            "called upon it - accept bytes may not be called anymore.")
1554
1754
 
1555
 
    internal_error = True
1556
 
 
1557
1755
    def __init__(self, request):
1558
1756
        self.request = request
1559
1757
 
1560
1758
 
1561
 
class WritingNotComplete(BzrError):
 
1759
class WritingNotComplete(InternalBzrError):
1562
1760
 
1563
1761
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1564
1762
            "called upon it - until the write phase is complete no "
1565
1763
            "data may be read.")
1566
1764
 
1567
 
    internal_error = True
1568
 
 
1569
1765
    def __init__(self, request):
1570
1766
        self.request = request
1571
1767
 
1579
1775
        self.filename = filename
1580
1776
 
1581
1777
 
1582
 
class MediumNotConnected(BzrError):
 
1778
class MediumNotConnected(InternalBzrError):
1583
1779
 
1584
1780
    _fmt = """The medium '%(medium)s' is not connected."""
1585
1781
 
1586
 
    internal_error = True
1587
 
 
1588
1782
    def __init__(self, medium):
1589
1783
        self.medium = medium
1590
1784
 
1596
1790
 
1597
1791
class NoBundleFound(BzrError):
1598
1792
 
1599
 
    _fmt = "No bundle was found in %(filename)s"
 
1793
    _fmt = 'No bundle was found in "%(filename)s".'
1600
1794
 
1601
1795
    def __init__(self, filename):
1602
1796
        BzrError.__init__(self)
1625
1819
        self.text_revision = text_revision
1626
1820
        self.file_id = file_id
1627
1821
 
 
1822
 
1628
1823
class DuplicateFileId(BzrError):
1629
1824
 
1630
1825
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1665
1860
        self.root_trans_id = transform.root
1666
1861
 
1667
1862
 
1668
 
class BzrBadParameter(BzrError):
 
1863
class BzrBadParameter(InternalBzrError):
1669
1864
 
1670
1865
    _fmt = "Bad parameter: %(param)r"
1671
1866
 
1672
 
    internal_error = True
1673
 
 
1674
1867
    # This exception should never be thrown, but it is a base class for all
1675
1868
    # parameter-to-function errors.
1676
1869
 
1699
1892
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1700
1893
 
1701
1894
    def __init__(self, from_path='', to_path='', extra=None):
 
1895
        from bzrlib.osutils import splitpath
1702
1896
        BzrError.__init__(self)
1703
1897
        if extra:
1704
1898
            self.extra = ': ' + str(extra)
1708
1902
        has_from = len(from_path) > 0
1709
1903
        has_to = len(to_path) > 0
1710
1904
        if has_from:
1711
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1905
            self.from_path = splitpath(from_path)[-1]
1712
1906
        else:
1713
1907
            self.from_path = ''
1714
1908
 
1715
1909
        if has_to:
1716
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1910
            self.to_path = splitpath(to_path)[-1]
1717
1911
        else:
1718
1912
            self.to_path = ''
1719
1913
 
1738
1932
class BzrRemoveChangedFilesError(BzrError):
1739
1933
    """Used when user is trying to remove changed files."""
1740
1934
 
1741
 
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1935
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1936
        "%(changes_as_text)s"
1742
1937
        "Use --keep to not delete them, or --force to delete them regardless.")
1743
1938
 
1744
1939
    def __init__(self, tree_delta):
1809
2004
        self.format = format
1810
2005
 
1811
2006
 
 
2007
class NoDiffFound(BzrError):
 
2008
 
 
2009
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2010
 
 
2011
    def __init__(self, path):
 
2012
        BzrError.__init__(self, path)
 
2013
 
 
2014
 
 
2015
class ExecutableMissing(BzrError):
 
2016
 
 
2017
    _fmt = "%(exe_name)s could not be found on this machine"
 
2018
 
 
2019
    def __init__(self, exe_name):
 
2020
        BzrError.__init__(self, exe_name=exe_name)
 
2021
 
 
2022
 
1812
2023
class NoDiff(BzrError):
1813
2024
 
1814
2025
    _fmt = "Diff is not installed on this machine: %(msg)s"
1822
2033
    _fmt = "Diff3 is not installed on this machine."
1823
2034
 
1824
2035
 
 
2036
class ExistingContent(BzrError):
 
2037
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2038
 
 
2039
    _fmt = "The content being inserted is already present."
 
2040
 
 
2041
 
1825
2042
class ExistingLimbo(BzrError):
1826
2043
 
1827
2044
    _fmt = """This tree contains left-over files from a failed operation.
1828
2045
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1829
2046
    keep, and delete it when you are done."""
1830
 
    
 
2047
 
1831
2048
    def __init__(self, limbo_dir):
1832
2049
       BzrError.__init__(self)
1833
2050
       self.limbo_dir = limbo_dir
1834
2051
 
1835
2052
 
 
2053
class ExistingPendingDeletion(BzrError):
 
2054
 
 
2055
    _fmt = """This tree contains left-over files from a failed operation.
 
2056
    Please examine %(pending_deletion)s to see if it contains any files you
 
2057
    wish to keep, and delete it when you are done."""
 
2058
 
 
2059
    def __init__(self, pending_deletion):
 
2060
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2061
 
 
2062
 
1836
2063
class ImmortalLimbo(BzrError):
1837
2064
 
1838
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2065
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1839
2066
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1840
2067
    keep, and delete it when you are done."""
1841
2068
 
1844
2071
       self.limbo_dir = limbo_dir
1845
2072
 
1846
2073
 
 
2074
class ImmortalPendingDeletion(BzrError):
 
2075
 
 
2076
    _fmt = ("Unable to delete transform temporary directory "
 
2077
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2078
    "contains any files you wish to keep, and delete it when you are done.")
 
2079
 
 
2080
    def __init__(self, pending_deletion):
 
2081
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2082
 
 
2083
 
1847
2084
class OutOfDateTree(BzrError):
1848
2085
 
1849
2086
    _fmt = "Working tree is out of date, please run 'bzr update'."
1876
2113
    _fmt = "Format error in conflict listings"
1877
2114
 
1878
2115
 
 
2116
class CorruptDirstate(BzrError):
 
2117
 
 
2118
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2119
            "Error: %(description)s")
 
2120
 
 
2121
    def __init__(self, dirstate_path, description):
 
2122
        BzrError.__init__(self)
 
2123
        self.dirstate_path = dirstate_path
 
2124
        self.description = description
 
2125
 
 
2126
 
1879
2127
class CorruptRepository(BzrError):
1880
2128
 
1881
2129
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1886
2134
        self.repo_path = repo.bzrdir.root_transport.base
1887
2135
 
1888
2136
 
 
2137
class InconsistentDelta(BzrError):
 
2138
    """Used when we get a delta that is not valid."""
 
2139
 
 
2140
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2141
            " %(file_id)r\nreason: %(reason)s")
 
2142
 
 
2143
    def __init__(self, path, file_id, reason):
 
2144
        BzrError.__init__(self)
 
2145
        self.path = path
 
2146
        self.file_id = file_id
 
2147
        self.reason = reason
 
2148
 
 
2149
 
1889
2150
class UpgradeRequired(BzrError):
1890
2151
 
1891
2152
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
1895
2156
        self.path = path
1896
2157
 
1897
2158
 
 
2159
class RepositoryUpgradeRequired(UpgradeRequired):
 
2160
 
 
2161
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2162
 
 
2163
 
1898
2164
class LocalRequiresBoundBranch(BzrError):
1899
2165
 
1900
2166
    _fmt = "Cannot perform local-only commits on unbound branches."
1901
2167
 
1902
2168
 
1903
 
class MissingProgressBarFinish(BzrError):
1904
 
 
1905
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1906
 
 
1907
 
 
1908
2169
class InvalidProgressBarType(BzrError):
1909
2170
 
1910
2171
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1936
2197
 
1937
2198
 
1938
2199
class BinaryFile(BzrError):
1939
 
    
 
2200
 
1940
2201
    _fmt = "File is binary but should be text."
1941
2202
 
1942
2203
 
1962
2223
 
1963
2224
 
1964
2225
class NotABundle(BzrError):
1965
 
    
 
2226
 
1966
2227
    _fmt = "Not a bzr revision-bundle: %(text)r"
1967
2228
 
1968
2229
    def __init__(self, text):
1970
2231
        self.text = text
1971
2232
 
1972
2233
 
1973
 
class BadBundle(BzrError): 
1974
 
    
 
2234
class BadBundle(BzrError):
 
2235
 
1975
2236
    _fmt = "Bad bzr revision-bundle: %(text)r"
1976
2237
 
1977
2238
    def __init__(self, text):
1979
2240
        self.text = text
1980
2241
 
1981
2242
 
1982
 
class MalformedHeader(BadBundle): 
1983
 
    
 
2243
class MalformedHeader(BadBundle):
 
2244
 
1984
2245
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1985
2246
 
1986
2247
 
1987
 
class MalformedPatches(BadBundle): 
1988
 
    
 
2248
class MalformedPatches(BadBundle):
 
2249
 
1989
2250
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1990
2251
 
1991
2252
 
1992
 
class MalformedFooter(BadBundle): 
1993
 
    
 
2253
class MalformedFooter(BadBundle):
 
2254
 
1994
2255
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1995
2256
 
1996
2257
 
1997
2258
class UnsupportedEOLMarker(BadBundle):
1998
 
    
1999
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2259
 
 
2260
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
2000
2261
 
2001
2262
    def __init__(self):
2002
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2263
        # XXX: BadBundle's constructor assumes there's explanatory text,
2003
2264
        # but for this there is not
2004
2265
        BzrError.__init__(self)
2005
2266
 
2006
2267
 
2007
2268
class IncompatibleBundleFormat(BzrError):
2008
 
    
 
2269
 
2009
2270
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2010
2271
 
2011
2272
    def __init__(self, bundle_format, other):
2015
2276
 
2016
2277
 
2017
2278
class BadInventoryFormat(BzrError):
2018
 
    
 
2279
 
2019
2280
    _fmt = "Root class for inventory serialization errors"
2020
2281
 
2021
2282
 
2032
2293
    _fmt = """This operation requires rich root data storage"""
2033
2294
 
2034
2295
 
2035
 
class NoSmartMedium(BzrError):
 
2296
class NoSmartMedium(InternalBzrError):
2036
2297
 
2037
2298
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2038
2299
 
2039
 
    internal_error = True
2040
 
 
2041
2300
    def __init__(self, transport):
2042
2301
        self.transport = transport
2043
2302
 
2044
2303
 
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
 
 
2053
2304
class UnknownSSH(BzrError):
2054
2305
 
2055
2306
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2065
2316
            " Please set BZR_SSH environment variable.")
2066
2317
 
2067
2318
 
 
2319
class GhostRevisionsHaveNoRevno(BzrError):
 
2320
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2321
 
 
2322
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2323
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2324
 
 
2325
    def __init__(self, revision_id, ghost_revision_id):
 
2326
        self.revision_id = revision_id
 
2327
        self.ghost_revision_id = ghost_revision_id
 
2328
 
 
2329
 
2068
2330
class GhostRevisionUnusableHere(BzrError):
2069
2331
 
2070
2332
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2074
2336
        self.revision_id = revision_id
2075
2337
 
2076
2338
 
2077
 
class IllegalUseOfScopeReplacer(BzrError):
 
2339
class IllegalUseOfScopeReplacer(InternalBzrError):
2078
2340
 
2079
2341
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2080
2342
            " %(msg)s%(extra)s")
2081
2343
 
2082
 
    internal_error = True
2083
 
 
2084
2344
    def __init__(self, name, msg, extra=None):
2085
2345
        BzrError.__init__(self)
2086
2346
        self.name = name
2091
2351
            self.extra = ''
2092
2352
 
2093
2353
 
2094
 
class InvalidImportLine(BzrError):
 
2354
class InvalidImportLine(InternalBzrError):
2095
2355
 
2096
2356
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2097
2357
 
2098
 
    internal_error = True
2099
 
 
2100
2358
    def __init__(self, text, msg):
2101
2359
        BzrError.__init__(self)
2102
2360
        self.text = text
2103
2361
        self.msg = msg
2104
2362
 
2105
2363
 
2106
 
class ImportNameCollision(BzrError):
 
2364
class ImportNameCollision(InternalBzrError):
2107
2365
 
2108
2366
    _fmt = ("Tried to import an object to the same name as"
2109
2367
            " an existing object. %(name)s")
2110
2368
 
2111
 
    internal_error = True
2112
 
 
2113
2369
    def __init__(self, name):
2114
2370
        BzrError.__init__(self)
2115
2371
        self.name = name
2147
2403
class PatchMissing(BzrError):
2148
2404
    """Raise a patch type was specified but no patch supplied"""
2149
2405
 
2150
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2406
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
2151
2407
 
2152
2408
    def __init__(self, patch_type):
2153
2409
        BzrError.__init__(self)
2154
2410
        self.patch_type = patch_type
2155
2411
 
2156
2412
 
 
2413
class TargetNotBranch(BzrError):
 
2414
    """A merge directive's target branch is required, but isn't a branch"""
 
2415
 
 
2416
    _fmt = ("Your branch does not have all of the revisions required in "
 
2417
            "order to merge this merge directive and the target "
 
2418
            "location specified in the merge directive is not a branch: "
 
2419
            "%(location)s.")
 
2420
 
 
2421
    def __init__(self, location):
 
2422
        BzrError.__init__(self)
 
2423
        self.location = location
 
2424
 
 
2425
 
2157
2426
class UnsupportedInventoryKind(BzrError):
2158
 
    
 
2427
 
2159
2428
    _fmt = """Unsupported entry kind %(kind)s"""
2160
2429
 
2161
2430
    def __init__(self, kind):
2164
2433
 
2165
2434
class BadSubsumeSource(BzrError):
2166
2435
 
2167
 
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
2436
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
2168
2437
 
2169
2438
    def __init__(self, tree, other_tree, reason):
2170
2439
        self.tree = tree
2173
2442
 
2174
2443
 
2175
2444
class SubsumeTargetNeedsUpgrade(BzrError):
2176
 
    
 
2445
 
2177
2446
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2178
2447
 
2179
2448
    def __init__(self, other_tree):
2180
2449
        self.other_tree = other_tree
2181
2450
 
2182
2451
 
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
 
2452
class BadReferenceTarget(InternalBzrError):
 
2453
 
 
2454
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2455
           "%(reason)s"
2188
2456
 
2189
2457
    def __init__(self, tree, other_tree, reason):
2190
2458
        self.tree = tree
2203
2471
class TagsNotSupported(BzrError):
2204
2472
 
2205
2473
    _fmt = ("Tags not supported by %(branch)s;"
2206
 
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2474
            " you may be able to use bzr upgrade.")
2207
2475
 
2208
2476
    def __init__(self, branch):
2209
2477
        self.branch = branch
2210
2478
 
2211
 
        
 
2479
 
2212
2480
class TagAlreadyExists(BzrError):
2213
2481
 
2214
2482
    _fmt = "Tag %(tag_name)s already exists."
2219
2487
 
2220
2488
class MalformedBugIdentifier(BzrError):
2221
2489
 
2222
 
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2490
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2491
            'See "bzr help bugs" for more information on this feature.')
2223
2492
 
2224
2493
    def __init__(self, bug_id, reason):
2225
2494
        self.bug_id = bug_id
2226
2495
        self.reason = reason
2227
2496
 
2228
2497
 
 
2498
class InvalidBugTrackerURL(BzrError):
 
2499
 
 
2500
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2501
            "contain {id}: %(url)s")
 
2502
 
 
2503
    def __init__(self, abbreviation, url):
 
2504
        self.abbreviation = abbreviation
 
2505
        self.url = url
 
2506
 
 
2507
 
2229
2508
class UnknownBugTrackerAbbreviation(BzrError):
2230
2509
 
2231
2510
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2236
2515
        self.branch = branch
2237
2516
 
2238
2517
 
 
2518
class InvalidLineInBugsProperty(BzrError):
 
2519
 
 
2520
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2521
 
 
2522
    def __init__(self, line):
 
2523
        self.line = line
 
2524
 
 
2525
 
 
2526
class InvalidBugStatus(BzrError):
 
2527
 
 
2528
    _fmt = ("Invalid bug status: '%(status)s'")
 
2529
 
 
2530
    def __init__(self, status):
 
2531
        self.status = status
 
2532
 
 
2533
 
2239
2534
class UnexpectedSmartServerResponse(BzrError):
2240
2535
 
2241
2536
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2244
2539
        self.response_tuple = response_tuple
2245
2540
 
2246
2541
 
 
2542
class ErrorFromSmartServer(BzrError):
 
2543
    """An error was received from a smart server.
 
2544
 
 
2545
    :seealso: UnknownErrorFromSmartServer
 
2546
    """
 
2547
 
 
2548
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2549
 
 
2550
    internal_error = True
 
2551
 
 
2552
    def __init__(self, error_tuple):
 
2553
        self.error_tuple = error_tuple
 
2554
        try:
 
2555
            self.error_verb = error_tuple[0]
 
2556
        except IndexError:
 
2557
            self.error_verb = None
 
2558
        self.error_args = error_tuple[1:]
 
2559
 
 
2560
 
 
2561
class UnknownErrorFromSmartServer(BzrError):
 
2562
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2563
    error.
 
2564
 
 
2565
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2566
    distinguish between the following two cases:
 
2567
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2568
        and so should provoke a traceback to the user.
 
2569
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2570
        translated.  This is probably because the server sent us garbage, and
 
2571
        should not provoke a traceback.
 
2572
    """
 
2573
 
 
2574
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2575
 
 
2576
    internal_error = False
 
2577
 
 
2578
    def __init__(self, error_from_smart_server):
 
2579
        """Constructor.
 
2580
 
 
2581
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2582
        """
 
2583
        self.error_from_smart_server = error_from_smart_server
 
2584
        self.error_tuple = error_from_smart_server.error_tuple
 
2585
 
 
2586
 
2247
2587
class ContainerError(BzrError):
2248
2588
    """Base class of container errors."""
2249
2589
 
2251
2591
class UnknownContainerFormatError(ContainerError):
2252
2592
 
2253
2593
    _fmt = "Unrecognised container format: %(container_format)r"
2254
 
    
 
2594
 
2255
2595
    def __init__(self, container_format):
2256
2596
        self.container_format = container_format
2257
2597
 
2260
2600
 
2261
2601
    _fmt = "Unexpected end of container stream"
2262
2602
 
2263
 
    internal_error = False
2264
 
 
2265
2603
 
2266
2604
class UnknownRecordTypeError(ContainerError):
2267
2605
 
2289
2627
 
2290
2628
class DuplicateRecordNameError(ContainerError):
2291
2629
 
2292
 
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
 
2630
    _fmt = "Container has multiple records with the same name: %(name)s"
2293
2631
 
2294
2632
    def __init__(self, name):
2295
2633
        self.name = name
2296
2634
 
2297
2635
 
2298
 
class NoDestinationAddress(BzrError):
 
2636
class NoDestinationAddress(InternalBzrError):
2299
2637
 
2300
2638
    _fmt = "Message does not have a destination address."
2301
2639
 
2302
 
    internal_error = True
 
2640
 
 
2641
class RepositoryDataStreamError(BzrError):
 
2642
 
 
2643
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2644
 
 
2645
    def __init__(self, reason):
 
2646
        self.reason = reason
2303
2647
 
2304
2648
 
2305
2649
class SMTPError(BzrError):
2308
2652
 
2309
2653
    def __init__(self, error):
2310
2654
        self.error = error
 
2655
 
 
2656
 
 
2657
class NoMessageSupplied(BzrError):
 
2658
 
 
2659
    _fmt = "No message supplied."
 
2660
 
 
2661
 
 
2662
class NoMailAddressSpecified(BzrError):
 
2663
 
 
2664
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2665
 
 
2666
 
 
2667
class UnknownMailClient(BzrError):
 
2668
 
 
2669
    _fmt = "Unknown mail client: %(mail_client)s"
 
2670
 
 
2671
    def __init__(self, mail_client):
 
2672
        BzrError.__init__(self, mail_client=mail_client)
 
2673
 
 
2674
 
 
2675
class MailClientNotFound(BzrError):
 
2676
 
 
2677
    _fmt = "Unable to find mail client with the following names:"\
 
2678
        " %(mail_command_list_string)s"
 
2679
 
 
2680
    def __init__(self, mail_command_list):
 
2681
        mail_command_list_string = ', '.join(mail_command_list)
 
2682
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2683
                          mail_command_list_string=mail_command_list_string)
 
2684
 
 
2685
class SMTPConnectionRefused(SMTPError):
 
2686
 
 
2687
    _fmt = "SMTP connection to %(host)s refused"
 
2688
 
 
2689
    def __init__(self, error, host):
 
2690
        self.error = error
 
2691
        self.host = host
 
2692
 
 
2693
 
 
2694
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2695
 
 
2696
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2697
 
 
2698
 
 
2699
class BzrDirError(BzrError):
 
2700
 
 
2701
    def __init__(self, bzrdir):
 
2702
        import bzrlib.urlutils as urlutils
 
2703
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2704
                                                    'ascii')
 
2705
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2706
 
 
2707
 
 
2708
class UnsyncedBranches(BzrDirError):
 
2709
 
 
2710
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2711
            " bzr help sync-for-reconfigure.")
 
2712
 
 
2713
    def __init__(self, bzrdir, target_branch):
 
2714
        BzrDirError.__init__(self, bzrdir)
 
2715
        import bzrlib.urlutils as urlutils
 
2716
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2717
                                                        'ascii')
 
2718
 
 
2719
 
 
2720
class AlreadyBranch(BzrDirError):
 
2721
 
 
2722
    _fmt = "'%(display_url)s' is already a branch."
 
2723
 
 
2724
 
 
2725
class AlreadyTree(BzrDirError):
 
2726
 
 
2727
    _fmt = "'%(display_url)s' is already a tree."
 
2728
 
 
2729
 
 
2730
class AlreadyCheckout(BzrDirError):
 
2731
 
 
2732
    _fmt = "'%(display_url)s' is already a checkout."
 
2733
 
 
2734
 
 
2735
class AlreadyLightweightCheckout(BzrDirError):
 
2736
 
 
2737
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2738
 
 
2739
 
 
2740
class AlreadyUsingShared(BzrDirError):
 
2741
 
 
2742
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2743
 
 
2744
 
 
2745
class AlreadyStandalone(BzrDirError):
 
2746
 
 
2747
    _fmt = "'%(display_url)s' is already standalone."
 
2748
 
 
2749
 
 
2750
class AlreadyWithTrees(BzrDirError):
 
2751
 
 
2752
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2753
            "working trees.")
 
2754
 
 
2755
 
 
2756
class AlreadyWithNoTrees(BzrDirError):
 
2757
 
 
2758
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2759
            "working trees.")
 
2760
 
 
2761
 
 
2762
class ReconfigurationNotSupported(BzrDirError):
 
2763
 
 
2764
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2765
 
 
2766
 
 
2767
class NoBindLocation(BzrDirError):
 
2768
 
 
2769
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2770
 
 
2771
 
 
2772
class UncommittedChanges(BzrError):
 
2773
 
 
2774
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2775
 
 
2776
    def __init__(self, tree):
 
2777
        import bzrlib.urlutils as urlutils
 
2778
        display_url = urlutils.unescape_for_display(
 
2779
            tree.bzrdir.root_transport.base, 'ascii')
 
2780
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2781
 
 
2782
 
 
2783
class MissingTemplateVariable(BzrError):
 
2784
 
 
2785
    _fmt = 'Variable {%(name)s} is not available.'
 
2786
 
 
2787
    def __init__(self, name):
 
2788
        self.name = name
 
2789
 
 
2790
 
 
2791
class NoTemplate(BzrError):
 
2792
 
 
2793
    _fmt = 'No template specified.'
 
2794
 
 
2795
 
 
2796
class UnableCreateSymlink(BzrError):
 
2797
 
 
2798
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2799
 
 
2800
    def __init__(self, path=None):
 
2801
        path_str = ''
 
2802
        if path:
 
2803
            try:
 
2804
                path_str = repr(str(path))
 
2805
            except UnicodeEncodeError:
 
2806
                path_str = repr(path)
 
2807
            path_str += ' '
 
2808
        self.path_str = path_str
 
2809
 
 
2810
 
 
2811
class UnsupportedTimezoneFormat(BzrError):
 
2812
 
 
2813
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2814
            'options are "utc", "original", "local".')
 
2815
 
 
2816
    def __init__(self, timezone):
 
2817
        self.timezone = timezone
 
2818
 
 
2819
 
 
2820
class CommandAvailableInPlugin(StandardError):
 
2821
 
 
2822
    internal_error = False
 
2823
 
 
2824
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2825
 
 
2826
        self.plugin_metadata = plugin_metadata
 
2827
        self.cmd_name = cmd_name
 
2828
        self.provider = provider
 
2829
 
 
2830
    def __str__(self):
 
2831
 
 
2832
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2833
                'However, the following official plugin provides this command: %s\n'
 
2834
                'You can install it by going to: %s'
 
2835
                % (self.cmd_name, self.plugin_metadata['name'],
 
2836
                    self.plugin_metadata['url']))
 
2837
 
 
2838
        return _fmt
 
2839
 
 
2840
 
 
2841
class NoPluginAvailable(BzrError):
 
2842
    pass
 
2843
 
 
2844
 
 
2845
class UnableEncodePath(BzrError):
 
2846
 
 
2847
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2848
            'user encoding %(user_encoding)s')
 
2849
 
 
2850
    def __init__(self, path, kind):
 
2851
        from bzrlib.osutils import get_user_encoding
 
2852
        self.path = path
 
2853
        self.kind = kind
 
2854
        self.user_encoding = osutils.get_user_encoding()
 
2855
 
 
2856
 
 
2857
class NoSuchAlias(BzrError):
 
2858
 
 
2859
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2860
 
 
2861
    def __init__(self, alias_name):
 
2862
        BzrError.__init__(self, alias_name=alias_name)
 
2863
 
 
2864
 
 
2865
class DirectoryLookupFailure(BzrError):
 
2866
    """Base type for lookup errors."""
 
2867
 
 
2868
    pass
 
2869
 
 
2870
 
 
2871
class InvalidLocationAlias(DirectoryLookupFailure):
 
2872
 
 
2873
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2874
 
 
2875
    def __init__(self, alias_name):
 
2876
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2877
 
 
2878
 
 
2879
class UnsetLocationAlias(DirectoryLookupFailure):
 
2880
 
 
2881
    _fmt = 'No %(alias_name)s location assigned.'
 
2882
 
 
2883
    def __init__(self, alias_name):
 
2884
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2885
 
 
2886
 
 
2887
class CannotBindAddress(BzrError):
 
2888
 
 
2889
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2890
 
 
2891
    def __init__(self, host, port, orig_error):
 
2892
        BzrError.__init__(self, host=host, port=port,
 
2893
            orig_error=orig_error[1])
 
2894
 
 
2895
 
 
2896
class UnknownRules(BzrError):
 
2897
 
 
2898
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2899
 
 
2900
    def __init__(self, unknowns):
 
2901
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2902
 
 
2903
 
 
2904
class HookFailed(BzrError):
 
2905
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2906
    than TipChangeRejected.
 
2907
    """
 
2908
 
 
2909
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2910
            "%(traceback_text)s%(exc_value)s")
 
2911
 
 
2912
    def __init__(self, hook_stage, hook_name, exc_info):
 
2913
        import traceback
 
2914
        self.hook_stage = hook_stage
 
2915
        self.hook_name = hook_name
 
2916
        self.exc_info = exc_info
 
2917
        self.exc_type = exc_info[0]
 
2918
        self.exc_value = exc_info[1]
 
2919
        self.exc_tb = exc_info[2]
 
2920
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2921
 
 
2922
 
 
2923
class TipChangeRejected(BzrError):
 
2924
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2925
    explicitly abort a change to a branch tip.
 
2926
    """
 
2927
 
 
2928
    _fmt = u"Tip change rejected: %(msg)s"
 
2929
 
 
2930
    def __init__(self, msg):
 
2931
        self.msg = msg
 
2932
 
 
2933
 
 
2934
class ShelfCorrupt(BzrError):
 
2935
 
 
2936
    _fmt = "Shelf corrupt."
 
2937
 
 
2938
 
 
2939
class NoSuchShelfId(BzrError):
 
2940
 
 
2941
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
2942
 
 
2943
    def __init__(self, shelf_id):
 
2944
        BzrError.__init__(self, shelf_id=shelf_id)
 
2945
 
 
2946
 
 
2947
class InvalidShelfId(BzrError):
 
2948
 
 
2949
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
2950
 
 
2951
    def __init__(self, invalid_id):
 
2952
        BzrError.__init__(self, invalid_id=invalid_id)
 
2953
 
 
2954
 
 
2955
class JailBreak(BzrError):
 
2956
 
 
2957
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2958
 
 
2959
    def __init__(self, url):
 
2960
        BzrError.__init__(self, url=url)
 
2961
 
 
2962
 
 
2963
class UserAbort(BzrError):
 
2964
 
 
2965
    _fmt = 'The user aborted the operation.'
 
2966
 
 
2967
 
 
2968
class MustHaveWorkingTree(BzrError):
 
2969
 
 
2970
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
2971
 
 
2972
    def __init__(self, format, url):
 
2973
        BzrError.__init__(self, format=format, url=url)
 
2974
 
 
2975
 
 
2976
class NoSuchView(BzrError):
 
2977
    """A view does not exist.
 
2978
    """
 
2979
 
 
2980
    _fmt = u"No such view: %(view_name)s."
 
2981
 
 
2982
    def __init__(self, view_name):
 
2983
        self.view_name = view_name
 
2984
 
 
2985
 
 
2986
class ViewsNotSupported(BzrError):
 
2987
    """Views are not supported by a tree format.
 
2988
    """
 
2989
 
 
2990
    _fmt = ("Views are not supported by %(tree)s;"
 
2991
            " use 'bzr upgrade' to change your tree to a later format.")
 
2992
 
 
2993
    def __init__(self, tree):
 
2994
        self.tree = tree
 
2995
 
 
2996
 
 
2997
class FileOutsideView(BzrError):
 
2998
 
 
2999
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3000
            '%(view_str)s')
 
3001
 
 
3002
    def __init__(self, file_name, view_files):
 
3003
        self.file_name = file_name
 
3004
        self.view_str = ", ".join(view_files)
 
3005
 
 
3006
 
 
3007
class UnresumableWriteGroup(BzrError):
 
3008
 
 
3009
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3010
            "%(write_groups)r: %(reason)s")
 
3011
 
 
3012
    internal_error = True
 
3013
 
 
3014
    def __init__(self, repository, write_groups, reason):
 
3015
        self.repository = repository
 
3016
        self.write_groups = write_groups
 
3017
        self.reason = reason
 
3018
 
 
3019
 
 
3020
class UnsuspendableWriteGroup(BzrError):
 
3021
 
 
3022
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3023
 
 
3024
    internal_error = True
 
3025
 
 
3026
    def __init__(self, repository):
 
3027
        self.repository = repository
 
3028
 
 
3029
 
 
3030
class LossyPushToSameVCS(BzrError):
 
3031
 
 
3032
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3033
            "%(target_branch)r that are in the same VCS.")
 
3034
 
 
3035
    internal_error = True
 
3036
 
 
3037
    def __init__(self, source_branch, target_branch):
 
3038
        self.source_branch = source_branch
 
3039
        self.target_branch = target_branch