← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-07-15 15:40:37 UTC
  • mto: (2592.3.33 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070715154037-3ar8g89decddc9su
Make GraphIndex accept nodes as key, value, references, so that the method
signature is closer to what a simple key->value index delivers. Also
change the behaviour when the reference list count is zero to accept
key, value as nodes, and emit key, value to make it identical in that case
to a simple key->value index. This may not be a good idea, but for now it
seems ok.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
255
198
        self.current = current
256
199
 
257
200
 
258
 
class InProcessTransport(BzrError):
259
 
 
260
 
    _fmt = "The transport '%(transport)s' is only accessible within this " \
261
 
        "process."
262
 
 
263
 
    def __init__(self, transport):
264
 
        self.transport = transport
265
 
 
266
 
 
267
 
class InvalidEntryName(InternalBzrError):
268
 
 
 
201
class InvalidEntryName(BzrError):
 
202
    
269
203
    _fmt = "Invalid entry name: %(name)s"
270
204
 
 
205
    internal_error = True
 
206
 
271
207
    def __init__(self, name):
272
208
        BzrError.__init__(self)
273
209
        self.name = name
274
210
 
275
211
 
276
212
class InvalidRevisionNumber(BzrError):
277
 
 
 
213
    
278
214
    _fmt = "Invalid revision number %(revno)s"
279
215
 
280
216
    def __init__(self, revno):
292
228
        self.revision_id = revision_id
293
229
        self.branch = branch
294
230
 
295
 
 
296
231
class ReservedId(BzrError):
297
232
 
298
233
    _fmt = "Reserved revision-id {%(revision_id)s}"
301
236
        self.revision_id = revision_id
302
237
 
303
238
 
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
239
class NoHelpTopic(BzrError):
321
240
 
322
241
    _fmt = ("No help could be found for '%(topic)s'. "
328
247
 
329
248
class NoSuchId(BzrError):
330
249
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
250
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
251
    
333
252
    def __init__(self, tree, file_id):
334
253
        BzrError.__init__(self)
335
254
        self.file_id = file_id
336
255
        self.tree = tree
337
256
 
338
257
 
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):
 
258
class InventoryModified(BzrError):
354
259
 
355
260
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
261
            " so a clean inventory cannot be read without data loss.")
357
262
 
 
263
    internal_error = True
 
264
 
358
265
    def __init__(self, tree):
359
266
        self.tree = tree
360
267
 
361
268
 
362
269
class NoWorkingTree(BzrError):
363
270
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
271
    _fmt = "No WorkingTree exists for %(base)s."
 
272
    
366
273
    def __init__(self, base):
367
274
        BzrError.__init__(self)
368
275
        self.base = base
381
288
        self.url = url
382
289
 
383
290
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
291
class WorkingTreeAlreadyPopulated(BzrError):
 
292
 
 
293
    _fmt = """Working tree already populated in %(base)s"""
 
294
 
 
295
    internal_error = True
387
296
 
388
297
    def __init__(self, base):
389
298
        self.base = base
390
299
 
391
 
 
392
300
class BzrCommandError(BzrError):
393
301
    """Error from user command"""
394
302
 
 
303
    internal_error = False
 
304
 
395
305
    # Error from malformed user command; please avoid raising this as a
396
306
    # generic exception not caused by user input.
397
307
    #
399
309
    # are not intended to be caught anyway.  UI code need not subclass
400
310
    # BzrCommandError, and non-UI code should not throw a subclass of
401
311
    # BzrCommandError.  ADHB 20051211
 
312
    def __init__(self, msg):
 
313
        # Object.__str__() must return a real string
 
314
        # returning a Unicode string is a python error.
 
315
        if isinstance(msg, unicode):
 
316
            self.msg = msg.encode('utf8')
 
317
        else:
 
318
            self.msg = msg
 
319
 
 
320
    def __str__(self):
 
321
        return self.msg
402
322
 
403
323
 
404
324
class NotWriteLocked(BzrError):
477
397
    def __init__(self, name, value):
478
398
        BzrError.__init__(self, name=name, value=value)
479
399
 
480
 
 
 
400
    
481
401
class StrictCommitFailed(BzrError):
482
402
 
483
403
    _fmt = "Commit refused because there are unknown files in the tree"
486
406
# XXX: Should be unified with TransportError; they seem to represent the
487
407
# same thing
488
408
# 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
 
409
# - this is finer than a TransportError - and more useful as such. It 
490
410
# differentiates between 'transport has failed' and 'operation on a transport
491
411
# has failed.'
492
412
class PathError(BzrError):
493
 
 
 
413
    
494
414
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
415
 
496
416
    def __init__(self, path, extra=None):
516
436
    """Used when renaming and both source and dest exist."""
517
437
 
518
438
    _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")
 
439
            "%(extra)s")
521
440
 
522
441
    def __init__(self, source, dest, extra=None):
523
442
        BzrError.__init__(self)
531
450
 
532
451
class NotADirectory(PathError):
533
452
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
453
    _fmt = "%(path)r is not a directory %(extra)s"
535
454
 
536
455
 
537
456
class NotInWorkingDirectory(PathError):
538
457
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
458
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
459
 
541
460
 
542
461
class DirectoryNotEmpty(PathError):
543
462
 
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
 
 
 
463
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
464
 
 
465
 
 
466
class ReadingCompleted(BzrError):
 
467
    
554
468
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
469
            "called upon it - the request has been completed and no more "
556
470
            "data may be read.")
557
471
 
 
472
    internal_error = True
 
473
 
558
474
    def __init__(self, request):
559
475
        self.request = request
560
476
 
561
477
 
562
478
class ResourceBusy(PathError):
563
479
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
480
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
481
 
566
482
 
567
483
class PermissionDenied(PathError):
568
484
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
485
    _fmt = "Permission denied: %(path)r%(extra)s"
570
486
 
571
487
 
572
488
class InvalidURL(PathError):
573
489
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
490
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
491
 
576
492
 
577
493
class InvalidURLJoin(PathError):
578
494
 
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
 
495
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
496
 
 
497
    def __init__(self, msg, base, args):
 
498
        PathError.__init__(self, base, msg)
 
499
        self.args = [base] + list(args)
608
500
 
609
501
 
610
502
class UnknownHook(BzrError):
625
517
        PathError.__init__(self, url, extra=extra)
626
518
 
627
519
 
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
520
class ReadError(PathError):
661
 
 
 
521
    
662
522
    _fmt = """Error reading from %(path)r."""
663
523
 
664
524
 
665
525
class ShortReadvError(PathError):
666
526
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
527
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
528
            " at %(offset)s for %(path)s%(extra)s")
669
529
 
670
530
    internal_error = True
671
531
 
676
536
        self.actual = actual
677
537
 
678
538
 
679
 
class PathNotChild(PathError):
 
539
class PathNotChild(BzrError):
680
540
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
541
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
682
542
 
683
543
    internal_error = True
684
544
 
694
554
 
695
555
class InvalidNormalization(PathError):
696
556
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
557
    _fmt = "Path %(path)r is not unicode normalized"
698
558
 
699
559
 
700
560
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
561
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
562
# TODO: Probably this behavior of should be a common superclass 
703
563
class NotBranchError(PathError):
704
564
 
705
 
    _fmt = 'Not a branch: "%(path)s".'
 
565
    _fmt = "Not a branch: %(path)s"
706
566
 
707
567
    def __init__(self, path):
708
568
       import bzrlib.urlutils as urlutils
720
580
 
721
581
class AlreadyBranchError(PathError):
722
582
 
723
 
    _fmt = 'Already a branch: "%(path)s".'
 
583
    _fmt = "Already a branch: %(path)s."
724
584
 
725
585
 
726
586
class BranchExistsWithoutWorkingTree(PathError):
727
587
 
728
 
    _fmt = 'Directory contains a branch, but no working tree \
729
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
588
    _fmt = "Directory contains a branch, but no working tree \
 
589
(use bzr checkout if you wish to build a working tree): %(path)s"
730
590
 
731
591
 
732
592
class AtomicFileAlreadyClosed(PathError):
733
593
 
734
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
735
 
            ' "%(path)s"')
 
594
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
595
            " %(path)s")
736
596
 
737
597
    def __init__(self, path, function):
738
598
        PathError.__init__(self, path=path, extra=None)
741
601
 
742
602
class InaccessibleParent(PathError):
743
603
 
744
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
745
 
            ' relative path "%(path)s"')
 
604
    _fmt = ("Parent not accessible given base %(base)s and"
 
605
            " relative path %(path)s")
746
606
 
747
607
    def __init__(self, path, base):
748
608
        PathError.__init__(self, path)
751
611
 
752
612
class NoRepositoryPresent(BzrError):
753
613
 
754
 
    _fmt = 'No repository present: "%(path)s"'
 
614
    _fmt = "No repository present: %(path)r"
755
615
    def __init__(self, bzrdir):
756
616
        BzrError.__init__(self)
757
617
        self.path = bzrdir.transport.clone('..').base
759
619
 
760
620
class FileInWrongBranch(BzrError):
761
621
 
762
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
622
    _fmt = "File %(path)s in not in branch %(branch_base)s."
763
623
 
764
624
    def __init__(self, branch, path):
765
625
        BzrError.__init__(self)
774
634
 
775
635
 
776
636
class UnknownFormatError(BzrError):
777
 
 
778
 
    _fmt = "Unknown %(kind)s format: %(format)r"
779
 
 
780
 
    def __init__(self, format, kind='branch'):
781
 
        self.kind = kind
782
 
        self.format = format
 
637
    
 
638
    _fmt = "Unknown branch format: %(format)r"
783
639
 
784
640
 
785
641
class IncompatibleFormat(BzrError):
786
 
 
 
642
    
787
643
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
788
644
 
789
645
    def __init__(self, format, bzrdir_format):
794
650
 
795
651
class IncompatibleRepositories(BzrError):
796
652
 
797
 
    _fmt = "%(target)s\n" \
798
 
            "is not compatible with\n" \
799
 
            "%(source)s\n" \
800
 
            "%(details)s"
 
653
    _fmt = "Repository %(target)s is not compatible with repository"\
 
654
        " %(source)s"
801
655
 
802
 
    def __init__(self, source, target, details=None):
803
 
        if details is None:
804
 
            details = "(no details)"
805
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
656
    def __init__(self, source, target):
 
657
        BzrError.__init__(self, target=target, source=source)
806
658
 
807
659
 
808
660
class IncompatibleRevision(BzrError):
809
 
 
 
661
    
810
662
    _fmt = "Revision is not compatible with %(repo_format)s"
811
663
 
812
664
    def __init__(self, repo_format):
817
669
class AlreadyVersionedError(BzrError):
818
670
    """Used when a path is expected not to be versioned, but it is."""
819
671
 
820
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
672
    _fmt = "%(context_info)s%(path)s is already versioned"
821
673
 
822
674
    def __init__(self, path, context_info=None):
823
675
        """Construct a new AlreadyVersionedError.
838
690
class NotVersionedError(BzrError):
839
691
    """Used when a path is expected to be versioned, but it is not."""
840
692
 
841
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
693
    _fmt = "%(context_info)s%(path)s is not versioned"
842
694
 
843
695
    def __init__(self, path, context_info=None):
844
696
        """Construct a new NotVersionedError.
895
747
        BzrError.__init__(self, filename=filename, kind=kind)
896
748
 
897
749
 
898
 
class BadFilenameEncoding(BzrError):
899
 
 
900
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
901
 
            ' encoding %(fs_encoding)s')
902
 
 
903
 
    def __init__(self, filename, fs_encoding):
904
 
        BzrError.__init__(self)
905
 
        self.filename = filename
906
 
        self.fs_encoding = fs_encoding
907
 
 
908
 
 
909
750
class ForbiddenControlFileError(BzrError):
910
751
 
911
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
912
 
 
913
 
 
914
 
class LockError(InternalBzrError):
 
752
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
753
 
 
754
 
 
755
class LockError(BzrError):
915
756
 
916
757
    _fmt = "Lock error: %(msg)s"
917
758
 
 
759
    internal_error = True
 
760
 
918
761
    # All exceptions from the lock/unlock functions should be from
919
762
    # this exception class.  They will be translated as necessary. The
920
763
    # original exception is available as e.original_error
922
765
    # New code should prefer to raise specific subclasses
923
766
    def __init__(self, message):
924
767
        # Python 2.5 uses a slot for StandardError.message,
925
 
        # so use a different variable name.  We now work around this in
926
 
        # BzrError.__str__, but this member name is kept for compatability.
 
768
        # so use a different variable name
 
769
        # so it is exposed in self.__dict__
927
770
        self.msg = message
928
771
 
929
772
 
964
807
        self.obj = obj
965
808
 
966
809
 
967
 
class LockFailed(LockError):
968
 
 
969
 
    internal_error = False
970
 
 
971
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
972
 
 
973
 
    def __init__(self, lock, why):
 
810
class ReadOnlyLockError(LockError):
 
811
 
 
812
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
813
 
 
814
    def __init__(self, fname, msg):
974
815
        LockError.__init__(self, '')
975
 
        self.lock = lock
976
 
        self.why = why
 
816
        self.fname = fname
 
817
        self.msg = msg
977
818
 
978
819
 
979
820
class OutSideTransaction(BzrError):
1003
844
 
1004
845
class UnlockableTransport(LockError):
1005
846
 
1006
 
    internal_error = False
1007
 
 
1008
847
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1009
848
 
1010
849
    def __init__(self, transport):
1013
852
 
1014
853
class LockContention(LockError):
1015
854
 
1016
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
855
    _fmt = "Could not acquire lock %(lock)s"
1017
856
    # TODO: show full url for lock, combining the transport and relative
1018
857
    # bits?
1019
858
 
1020
859
    internal_error = False
1021
860
 
1022
 
    def __init__(self, lock, msg=''):
 
861
    def __init__(self, lock):
1023
862
        self.lock = lock
1024
 
        self.msg = msg
1025
863
 
1026
864
 
1027
865
class LockBroken(LockError):
1062
900
 
1063
901
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1064
902
 
 
903
    internal_error = True
 
904
 
1065
905
    def __init__(self, obj):
1066
906
        self.obj = obj
1067
907
 
1092
932
        BzrError.__init__(self, files=files, files_str=files_str)
1093
933
 
1094
934
 
1095
 
class BadCommitMessageEncoding(BzrError):
1096
 
 
1097
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1098
 
        'the current encoding.'
1099
 
 
1100
 
 
1101
935
class UpgradeReadonly(BzrError):
1102
936
 
1103
937
    _fmt = "Upgrade URL cannot work with readonly URLs."
1117
951
    _fmt = "Commit refused because there are unknowns in the tree."
1118
952
 
1119
953
 
1120
 
class NoSuchRevision(InternalBzrError):
1121
 
 
1122
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
954
class NoSuchRevision(BzrError):
 
955
 
 
956
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
957
 
 
958
    internal_error = True
1123
959
 
1124
960
    def __init__(self, branch, revision):
1125
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1126
961
        BzrError.__init__(self, branch=branch, revision=revision)
1127
962
 
1128
963
 
1129
 
class RangeInChangeOption(BzrError):
1130
 
 
1131
 
    _fmt = "Option --change does not accept revision ranges"
 
964
class NotLeftParentDescendant(BzrError):
 
965
 
 
966
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
967
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
968
 
 
969
    internal_error = True
 
970
 
 
971
    def __init__(self, branch, old_revision, new_revision):
 
972
        BzrError.__init__(self, branch_location=branch.base,
 
973
                          old_revision=old_revision,
 
974
                          new_revision=new_revision)
1132
975
 
1133
976
 
1134
977
class NoSuchRevisionSpec(BzrError):
1141
984
 
1142
985
class NoSuchRevisionInTree(NoSuchRevision):
1143
986
    """When using Tree.revision_tree, and the revision is not accessible."""
1144
 
 
1145
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
987
    
 
988
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1146
989
 
1147
990
    def __init__(self, tree, revision_id):
1148
991
        BzrError.__init__(self)
1183
1026
class DivergedBranches(BzrError):
1184
1027
 
1185
1028
    _fmt = ("These branches have diverged."
1186
 
            " Use the missing command to see how.\n"
1187
 
            "Use the merge command to reconcile them.")
 
1029
            " Use the merge command to reconcile them.")
 
1030
 
 
1031
    internal_error = False
1188
1032
 
1189
1033
    def __init__(self, branch1, branch2):
1190
1034
        self.branch1 = branch1
1191
1035
        self.branch2 = branch2
1192
1036
 
1193
1037
 
1194
 
class NotLefthandHistory(InternalBzrError):
 
1038
class NotLefthandHistory(BzrError):
1195
1039
 
1196
1040
    _fmt = "Supplied history does not follow left-hand parents"
1197
1041
 
 
1042
    internal_error = True
 
1043
 
1198
1044
    def __init__(self, history):
1199
1045
        BzrError.__init__(self, history=history)
1200
1046
 
1204
1050
    _fmt = ("Branches have no common ancestor, and"
1205
1051
            " no merge base revision was specified.")
1206
1052
 
1207
 
 
1208
 
class CannotReverseCherrypick(BzrError):
1209
 
 
1210
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1211
 
            ' or diff3.')
 
1053
    internal_error = False
1212
1054
 
1213
1055
 
1214
1056
class NoCommonAncestor(BzrError):
1215
 
 
 
1057
    
1216
1058
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1217
1059
 
1218
1060
    def __init__(self, revision_a, revision_b):
1238
1080
            not_ancestor_id=not_ancestor_id)
1239
1081
 
1240
1082
 
 
1083
class InstallFailed(BzrError):
 
1084
 
 
1085
    def __init__(self, revisions):
 
1086
        revision_str = ", ".join(str(r) for r in revisions)
 
1087
        msg = "Could not install revisions:\n%s" % revision_str
 
1088
        BzrError.__init__(self, msg)
 
1089
        self.revisions = revisions
 
1090
 
 
1091
 
1241
1092
class AmbiguousBase(BzrError):
1242
1093
 
1243
1094
    def __init__(self, bases):
1249
1100
        self.bases = bases
1250
1101
 
1251
1102
 
1252
 
class NoCommits(BranchError):
 
1103
class NoCommits(BzrError):
1253
1104
 
1254
1105
    _fmt = "Branch %(branch)s has no commits."
1255
1106
 
 
1107
    def __init__(self, branch):
 
1108
        BzrError.__init__(self, branch=branch)
 
1109
 
1256
1110
 
1257
1111
class UnlistableStore(BzrError):
1258
1112
 
1269
1123
 
1270
1124
class BoundBranchOutOfDate(BzrError):
1271
1125
 
1272
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1273
 
            " %(master)s.")
 
1126
    _fmt = ("Bound branch %(branch)s is out of date"
 
1127
            " with master branch %(master)s.")
1274
1128
 
1275
1129
    def __init__(self, branch, master):
1276
1130
        BzrError.__init__(self)
1277
1131
        self.branch = branch
1278
1132
        self.master = master
1279
1133
 
1280
 
 
 
1134
        
1281
1135
class CommitToDoubleBoundBranch(BzrError):
1282
1136
 
1283
1137
    _fmt = ("Cannot commit to branch %(branch)s."
1313
1167
 
1314
1168
class WeaveError(BzrError):
1315
1169
 
1316
 
    _fmt = "Error in processing weave: %(msg)s"
 
1170
    _fmt = "Error in processing weave: %(message)s"
1317
1171
 
1318
 
    def __init__(self, msg=None):
 
1172
    def __init__(self, message=None):
1319
1173
        BzrError.__init__(self)
1320
 
        self.msg = msg
 
1174
        self.message = message
1321
1175
 
1322
1176
 
1323
1177
class WeaveRevisionAlreadyPresent(WeaveError):
1352
1206
 
1353
1207
class WeaveParentMismatch(WeaveError):
1354
1208
 
1355
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1356
 
 
 
1209
    _fmt = "Parents are mismatched between two revisions."
 
1210
    
1357
1211
 
1358
1212
class WeaveInvalidChecksum(WeaveError):
1359
1213
 
1385
1239
 
1386
1240
 
1387
1241
class VersionedFileError(BzrError):
1388
 
 
 
1242
    
1389
1243
    _fmt = "Versioned file error"
1390
1244
 
1391
1245
 
1392
1246
class RevisionNotPresent(VersionedFileError):
1393
 
 
1394
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1247
    
 
1248
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1395
1249
 
1396
1250
    def __init__(self, revision_id, file_id):
1397
1251
        VersionedFileError.__init__(self)
1400
1254
 
1401
1255
 
1402
1256
class RevisionAlreadyPresent(VersionedFileError):
1403
 
 
1404
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1257
    
 
1258
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1405
1259
 
1406
1260
    def __init__(self, revision_id, file_id):
1407
1261
        VersionedFileError.__init__(self)
1409
1263
        self.file_id = file_id
1410
1264
 
1411
1265
 
1412
 
class VersionedFileInvalidChecksum(VersionedFileError):
1413
 
 
1414
 
    _fmt = "Text did not match its checksum: %(message)s"
1415
 
 
1416
 
 
1417
 
class KnitError(InternalBzrError):
1418
 
 
 
1266
class KnitError(BzrError):
 
1267
    
1419
1268
    _fmt = "Knit error"
1420
1269
 
 
1270
    internal_error = True
 
1271
 
 
1272
 
 
1273
class KnitHeaderError(KnitError):
 
1274
 
 
1275
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1276
 
 
1277
    def __init__(self, badline, filename):
 
1278
        KnitError.__init__(self)
 
1279
        self.badline = badline
 
1280
        self.filename = filename
 
1281
 
1421
1282
 
1422
1283
class KnitCorrupt(KnitError):
1423
1284
 
1429
1290
        self.how = how
1430
1291
 
1431
1292
 
1432
 
class SHA1KnitCorrupt(KnitCorrupt):
1433
 
 
1434
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1435
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1436
 
        "sha %(actual)s")
1437
 
 
1438
 
    def __init__(self, filename, actual, expected, key, content):
1439
 
        KnitError.__init__(self)
1440
 
        self.filename = filename
1441
 
        self.actual = actual
1442
 
        self.expected = expected
1443
 
        self.key = key
1444
 
        self.content = content
1445
 
 
1446
 
 
1447
 
class KnitDataStreamIncompatible(KnitError):
1448
 
    # Not raised anymore, as we can convert data streams.  In future we may
1449
 
    # need it again for more exotic cases, so we're keeping it around for now.
1450
 
 
1451
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1452
 
 
1453
 
    def __init__(self, stream_format, target_format):
1454
 
        self.stream_format = stream_format
1455
 
        self.target_format = target_format
1456
 
 
1457
 
 
1458
 
class KnitDataStreamUnknown(KnitError):
1459
 
    # Indicates a data stream we don't know how to handle.
1460
 
 
1461
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1462
 
 
1463
 
    def __init__(self, stream_format):
1464
 
        self.stream_format = stream_format
1465
 
 
1466
 
 
1467
 
class KnitHeaderError(KnitError):
1468
 
 
1469
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1470
 
 
1471
 
    def __init__(self, badline, filename):
1472
 
        KnitError.__init__(self)
1473
 
        self.badline = badline
1474
 
        self.filename = filename
1475
 
 
1476
1293
class KnitIndexUnknownMethod(KnitError):
1477
1294
    """Raised when we don't understand the storage method.
1478
1295
 
1479
1296
    Currently only 'fulltext' and 'line-delta' are supported.
1480
1297
    """
1481
 
 
 
1298
    
1482
1299
    _fmt = ("Knit index %(filename)s does not have a known method"
1483
1300
            " in options: %(options)r")
1484
1301
 
1488
1305
        self.options = options
1489
1306
 
1490
1307
 
1491
 
class RetryWithNewPacks(BzrError):
1492
 
    """Raised when we realize that the packs on disk have changed.
1493
 
 
1494
 
    This is meant as more of a signaling exception, to trap between where a
1495
 
    local error occurred and the code that can actually handle the error and
1496
 
    code that can retry appropriately.
1497
 
    """
1498
 
 
1499
 
    internal_error = True
1500
 
 
1501
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1502
 
            " %(orig_error)s")
1503
 
 
1504
 
    def __init__(self, context, reload_occurred, exc_info):
1505
 
        """create a new RetryWithNewPacks error.
1506
 
 
1507
 
        :param reload_occurred: Set to True if we know that the packs have
1508
 
            already been reloaded, and we are failing because of an in-memory
1509
 
            cache miss. If set to True then we will ignore if a reload says
1510
 
            nothing has changed, because we assume it has already reloaded. If
1511
 
            False, then a reload with nothing changed will force an error.
1512
 
        :param exc_info: The original exception traceback, so if there is a
1513
 
            problem we can raise the original error (value from sys.exc_info())
1514
 
        """
1515
 
        BzrError.__init__(self)
1516
 
        self.reload_occurred = reload_occurred
1517
 
        self.exc_info = exc_info
1518
 
        self.orig_error = exc_info[1]
1519
 
        # TODO: The global error handler should probably treat this by
1520
 
        #       raising/printing the original exception with a bit about
1521
 
        #       RetryWithNewPacks also not being caught
1522
 
 
1523
 
 
1524
 
class RetryAutopack(RetryWithNewPacks):
1525
 
    """Raised when we are autopacking and we find a missing file.
1526
 
 
1527
 
    Meant as a signaling exception, to tell the autopack code it should try
1528
 
    again.
1529
 
    """
1530
 
 
1531
 
    internal_error = True
1532
 
 
1533
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1534
 
            " context: %(context)s %(orig_error)s")
1535
 
 
1536
 
 
1537
1308
class NoSuchExportFormat(BzrError):
1538
 
 
 
1309
    
1539
1310
    _fmt = "Export format %(format)r not supported"
1540
1311
 
1541
1312
    def __init__(self, format):
1544
1315
 
1545
1316
 
1546
1317
class TransportError(BzrError):
1547
 
 
 
1318
    
1548
1319
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1549
1320
 
1550
1321
    def __init__(self, msg=None, orig_error=None):
1559
1330
        BzrError.__init__(self)
1560
1331
 
1561
1332
 
1562
 
class TooManyConcurrentRequests(InternalBzrError):
 
1333
class TooManyConcurrentRequests(BzrError):
1563
1334
 
1564
1335
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1565
1336
            " Be sure to finish_writing and finish_reading on the"
1566
1337
            " currently open request.")
1567
1338
 
 
1339
    internal_error = True
 
1340
 
1568
1341
    def __init__(self, medium):
1569
1342
        self.medium = medium
1570
1343
 
1577
1350
        self.details = details
1578
1351
 
1579
1352
 
1580
 
class UnexpectedProtocolVersionMarker(TransportError):
1581
 
 
1582
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1583
 
 
1584
 
    def __init__(self, marker):
1585
 
        self.marker = marker
1586
 
 
1587
 
 
1588
 
class UnknownSmartMethod(InternalBzrError):
1589
 
 
1590
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1591
 
 
1592
 
    def __init__(self, verb):
1593
 
        self.verb = verb
1594
 
 
1595
 
 
1596
 
class SmartMessageHandlerError(InternalBzrError):
1597
 
 
1598
 
    _fmt = ("The message handler raised an exception:\n"
1599
 
            "%(traceback_text)s")
1600
 
 
1601
 
    def __init__(self, exc_info):
1602
 
        import traceback
1603
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1604
 
        self.exc_info = exc_info
1605
 
        traceback_strings = traceback.format_exception(
1606
 
                self.exc_type, self.exc_value, self.exc_tb)
1607
 
        self.traceback_text = ''.join(traceback_strings)
1608
 
 
1609
 
 
1610
1353
# A set of semi-meaningful errors which can be thrown
1611
1354
class TransportNotPossible(TransportError):
1612
1355
 
1637
1380
            self.port = ':%s' % port
1638
1381
 
1639
1382
 
1640
 
# XXX: This is also used for unexpected end of file, which is different at the
1641
 
# TCP level from "connection reset".
1642
1383
class ConnectionReset(TransportError):
1643
1384
 
1644
1385
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1646
1387
 
1647
1388
class InvalidRange(TransportError):
1648
1389
 
1649
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1650
 
 
1651
 
    def __init__(self, path, offset, msg=None):
1652
 
        TransportError.__init__(self, msg)
 
1390
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1391
    
 
1392
    def __init__(self, path, offset):
 
1393
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1394
                                       % (path, offset)))
1653
1395
        self.path = path
1654
1396
        self.offset = offset
1655
1397
 
1666
1408
class InvalidHttpRange(InvalidHttpResponse):
1667
1409
 
1668
1410
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1669
 
 
 
1411
    
1670
1412
    def __init__(self, path, range, msg):
1671
1413
        self.range = range
1672
1414
        InvalidHttpResponse.__init__(self, path, msg)
1675
1417
class InvalidHttpContentType(InvalidHttpResponse):
1676
1418
 
1677
1419
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1678
 
 
 
1420
    
1679
1421
    def __init__(self, path, ctype, msg):
1680
1422
        self.ctype = ctype
1681
1423
        InvalidHttpResponse.__init__(self, path, msg)
1685
1427
 
1686
1428
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1687
1429
 
1688
 
    def __init__(self, source, target, is_permanent=False):
 
1430
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1689
1431
        self.source = source
1690
1432
        self.target = target
1691
 
        if is_permanent:
 
1433
        if is_permament:
1692
1434
            self.permanently = ' permanently'
1693
1435
        else:
1694
1436
            self.permanently = ''
 
1437
        self.is_permament = is_permament
 
1438
        self._qualified_proto = qual_proto
1695
1439
        TransportError.__init__(self)
1696
1440
 
 
1441
    def _requalify_url(self, url):
 
1442
        """Restore the qualified proto in front of the url"""
 
1443
        # When this exception is raised, source and target are in
 
1444
        # user readable format. But some transports may use a
 
1445
        # different proto (http+urllib:// will present http:// to
 
1446
        # the user. If a qualified proto is specified, the code
 
1447
        # trapping the exception can get the qualified urls to
 
1448
        # properly handle the redirection themself (creating a
 
1449
        # new transport object from the target url for example).
 
1450
        # But checking that the scheme of the original and
 
1451
        # redirected urls are the same can be tricky. (see the
 
1452
        # FIXME in BzrDir.open_from_transport for the unique use
 
1453
        # case so far).
 
1454
        if self._qualified_proto is None:
 
1455
            return url
 
1456
 
 
1457
        # The TODO related to NotBranchError mention that doing
 
1458
        # that kind of manipulation on the urls may not be the
 
1459
        # exception object job. On the other hand, this object is
 
1460
        # the interface between the code and the user so
 
1461
        # presenting the urls in different ways is indeed its
 
1462
        # job...
 
1463
        import urlparse
 
1464
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1465
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1466
                                   query, fragment))
 
1467
 
 
1468
    def get_source_url(self):
 
1469
        return self._requalify_url(self.source)
 
1470
 
 
1471
    def get_target_url(self):
 
1472
        return self._requalify_url(self.target)
 
1473
 
1697
1474
 
1698
1475
class TooManyRedirections(TransportError):
1699
1476
 
1700
1477
    _fmt = "Too many redirections"
1701
1478
 
1702
 
 
1703
1479
class ConflictsInTree(BzrError):
1704
1480
 
1705
1481
    _fmt = "Working tree has conflicts."
1711
1487
        if filename is None:
1712
1488
            filename = ""
1713
1489
        message = "Error(s) parsing config file %s:\n%s" % \
1714
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1490
            (filename, ('\n'.join(e.message for e in errors)))
1715
1491
        BzrError.__init__(self, message)
1716
1492
 
1717
1493
 
1726
1502
 
1727
1503
class SigningFailed(BzrError):
1728
1504
 
1729
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1505
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1730
1506
 
1731
1507
    def __init__(self, command_line):
1732
1508
        BzrError.__init__(self, command_line=command_line)
1734
1510
 
1735
1511
class WorkingTreeNotRevision(BzrError):
1736
1512
 
1737
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1513
    _fmt = ("The working tree for %(basedir)s has changed since" 
1738
1514
            " the last commit, but weave merge requires that it be"
1739
1515
            " unchanged")
1740
1516
 
1757
1533
        self.graph = graph
1758
1534
 
1759
1535
 
1760
 
class WritingCompleted(InternalBzrError):
 
1536
class WritingCompleted(BzrError):
1761
1537
 
1762
1538
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1763
1539
            "called upon it - accept bytes may not be called anymore.")
1764
1540
 
 
1541
    internal_error = True
 
1542
 
1765
1543
    def __init__(self, request):
1766
1544
        self.request = request
1767
1545
 
1768
1546
 
1769
 
class WritingNotComplete(InternalBzrError):
 
1547
class WritingNotComplete(BzrError):
1770
1548
 
1771
1549
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1772
1550
            "called upon it - until the write phase is complete no "
1773
1551
            "data may be read.")
1774
1552
 
 
1553
    internal_error = True
 
1554
 
1775
1555
    def __init__(self, request):
1776
1556
        self.request = request
1777
1557
 
1785
1565
        self.filename = filename
1786
1566
 
1787
1567
 
1788
 
class MediumNotConnected(InternalBzrError):
 
1568
class MediumNotConnected(BzrError):
1789
1569
 
1790
1570
    _fmt = """The medium '%(medium)s' is not connected."""
1791
1571
 
 
1572
    internal_error = True
 
1573
 
1792
1574
    def __init__(self, medium):
1793
1575
        self.medium = medium
1794
1576
 
1800
1582
 
1801
1583
class NoBundleFound(BzrError):
1802
1584
 
1803
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1585
    _fmt = "No bundle was found in %(filename)s"
1804
1586
 
1805
1587
    def __init__(self, filename):
1806
1588
        BzrError.__init__(self)
1829
1611
        self.text_revision = text_revision
1830
1612
        self.file_id = file_id
1831
1613
 
1832
 
 
1833
1614
class DuplicateFileId(BzrError):
1834
1615
 
1835
1616
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1870
1651
        self.root_trans_id = transform.root
1871
1652
 
1872
1653
 
1873
 
class BzrBadParameter(InternalBzrError):
 
1654
class BzrBadParameter(BzrError):
1874
1655
 
1875
1656
    _fmt = "Bad parameter: %(param)r"
1876
1657
 
 
1658
    internal_error = True
 
1659
 
1877
1660
    # This exception should never be thrown, but it is a base class for all
1878
1661
    # parameter-to-function errors.
1879
1662
 
1902
1685
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1903
1686
 
1904
1687
    def __init__(self, from_path='', to_path='', extra=None):
1905
 
        from bzrlib.osutils import splitpath
1906
1688
        BzrError.__init__(self)
1907
1689
        if extra:
1908
1690
            self.extra = ': ' + str(extra)
1912
1694
        has_from = len(from_path) > 0
1913
1695
        has_to = len(to_path) > 0
1914
1696
        if has_from:
1915
 
            self.from_path = splitpath(from_path)[-1]
 
1697
            self.from_path = osutils.splitpath(from_path)[-1]
1916
1698
        else:
1917
1699
            self.from_path = ''
1918
1700
 
1919
1701
        if has_to:
1920
 
            self.to_path = splitpath(to_path)[-1]
 
1702
            self.to_path = osutils.splitpath(to_path)[-1]
1921
1703
        else:
1922
1704
            self.to_path = ''
1923
1705
 
1942
1724
class BzrRemoveChangedFilesError(BzrError):
1943
1725
    """Used when user is trying to remove changed files."""
1944
1726
 
1945
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1946
 
        "%(changes_as_text)s"
 
1727
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
1947
1728
        "Use --keep to not delete them, or --force to delete them regardless.")
1948
1729
 
1949
1730
    def __init__(self, tree_delta):
2014
1795
        self.format = format
2015
1796
 
2016
1797
 
2017
 
class NoDiffFound(BzrError):
2018
 
 
2019
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2020
 
 
2021
 
    def __init__(self, path):
2022
 
        BzrError.__init__(self, path)
2023
 
 
2024
 
 
2025
 
class ExecutableMissing(BzrError):
2026
 
 
2027
 
    _fmt = "%(exe_name)s could not be found on this machine"
2028
 
 
2029
 
    def __init__(self, exe_name):
2030
 
        BzrError.__init__(self, exe_name=exe_name)
2031
 
 
2032
 
 
2033
1798
class NoDiff(BzrError):
2034
1799
 
2035
1800
    _fmt = "Diff is not installed on this machine: %(msg)s"
2043
1808
    _fmt = "Diff3 is not installed on this machine."
2044
1809
 
2045
1810
 
2046
 
class ExistingContent(BzrError):
2047
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2048
 
 
2049
 
    _fmt = "The content being inserted is already present."
2050
 
 
2051
 
 
2052
1811
class ExistingLimbo(BzrError):
2053
1812
 
2054
1813
    _fmt = """This tree contains left-over files from a failed operation.
2055
1814
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2056
1815
    keep, and delete it when you are done."""
2057
 
 
 
1816
    
2058
1817
    def __init__(self, limbo_dir):
2059
1818
       BzrError.__init__(self)
2060
1819
       self.limbo_dir = limbo_dir
2061
1820
 
2062
1821
 
2063
 
class ExistingPendingDeletion(BzrError):
2064
 
 
2065
 
    _fmt = """This tree contains left-over files from a failed operation.
2066
 
    Please examine %(pending_deletion)s to see if it contains any files you
2067
 
    wish to keep, and delete it when you are done."""
2068
 
 
2069
 
    def __init__(self, pending_deletion):
2070
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2071
 
 
2072
 
 
2073
1822
class ImmortalLimbo(BzrError):
2074
1823
 
2075
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1824
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2076
1825
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2077
1826
    keep, and delete it when you are done."""
2078
1827
 
2081
1830
       self.limbo_dir = limbo_dir
2082
1831
 
2083
1832
 
2084
 
class ImmortalPendingDeletion(BzrError):
2085
 
 
2086
 
    _fmt = ("Unable to delete transform temporary directory "
2087
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2088
 
    "contains any files you wish to keep, and delete it when you are done.")
2089
 
 
2090
 
    def __init__(self, pending_deletion):
2091
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2092
 
 
2093
 
 
2094
1833
class OutOfDateTree(BzrError):
2095
1834
 
2096
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1835
    _fmt = "Working tree is out of date, please run 'bzr update'."
2097
1836
 
2098
 
    def __init__(self, tree, more=None):
2099
 
        if more is None:
2100
 
            more = ''
2101
 
        else:
2102
 
            more = ' ' + more
 
1837
    def __init__(self, tree):
2103
1838
        BzrError.__init__(self)
2104
1839
        self.tree = tree
2105
 
        self.more = more
2106
1840
 
2107
1841
 
2108
1842
class PublicBranchOutOfDate(BzrError):
2128
1862
    _fmt = "Format error in conflict listings"
2129
1863
 
2130
1864
 
2131
 
class CorruptDirstate(BzrError):
2132
 
 
2133
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2134
 
            "Error: %(description)s")
2135
 
 
2136
 
    def __init__(self, dirstate_path, description):
2137
 
        BzrError.__init__(self)
2138
 
        self.dirstate_path = dirstate_path
2139
 
        self.description = description
2140
 
 
2141
 
 
2142
1865
class CorruptRepository(BzrError):
2143
1866
 
2144
1867
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2149
1872
        self.repo_path = repo.bzrdir.root_transport.base
2150
1873
 
2151
1874
 
2152
 
class InconsistentDelta(BzrError):
2153
 
    """Used when we get a delta that is not valid."""
2154
 
 
2155
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2156
 
            " %(file_id)r\nreason: %(reason)s")
2157
 
 
2158
 
    def __init__(self, path, file_id, reason):
2159
 
        BzrError.__init__(self)
2160
 
        self.path = path
2161
 
        self.file_id = file_id
2162
 
        self.reason = reason
2163
 
 
2164
 
 
2165
 
class InconsistentDeltaDelta(InconsistentDelta):
2166
 
    """Used when we get a delta that is not valid."""
2167
 
 
2168
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2169
 
            "\nreason: %(reason)s")
2170
 
 
2171
 
    def __init__(self, delta, reason):
2172
 
        BzrError.__init__(self)
2173
 
        self.delta = delta
2174
 
        self.reason = reason
2175
 
 
2176
 
 
2177
1875
class UpgradeRequired(BzrError):
2178
1876
 
2179
1877
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2183
1881
        self.path = path
2184
1882
 
2185
1883
 
2186
 
class RepositoryUpgradeRequired(UpgradeRequired):
2187
 
 
2188
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2189
 
 
2190
 
 
2191
 
class RichRootUpgradeRequired(UpgradeRequired):
2192
 
 
2193
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2194
 
           " a format which supports rich roots.")
2195
 
 
2196
 
 
2197
1884
class LocalRequiresBoundBranch(BzrError):
2198
1885
 
2199
1886
    _fmt = "Cannot perform local-only commits on unbound branches."
2200
1887
 
2201
1888
 
 
1889
class MissingProgressBarFinish(BzrError):
 
1890
 
 
1891
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1892
 
 
1893
 
 
1894
class InvalidProgressBarType(BzrError):
 
1895
 
 
1896
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1897
            " is not a supported type Select one of: %(valid_types)s")
 
1898
 
 
1899
    def __init__(self, bar_type, valid_types):
 
1900
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1901
 
 
1902
 
2202
1903
class UnsupportedOperation(BzrError):
2203
1904
 
2204
1905
    _fmt = ("The method %(mname)s is not supported on"
2221
1922
 
2222
1923
 
2223
1924
class BinaryFile(BzrError):
2224
 
 
 
1925
    
2225
1926
    _fmt = "File is binary but should be text."
2226
1927
 
2227
1928
 
2247
1948
 
2248
1949
 
2249
1950
class NotABundle(BzrError):
2250
 
 
 
1951
    
2251
1952
    _fmt = "Not a bzr revision-bundle: %(text)r"
2252
1953
 
2253
1954
    def __init__(self, text):
2255
1956
        self.text = text
2256
1957
 
2257
1958
 
2258
 
class BadBundle(BzrError):
2259
 
 
 
1959
class BadBundle(BzrError): 
 
1960
    
2260
1961
    _fmt = "Bad bzr revision-bundle: %(text)r"
2261
1962
 
2262
1963
    def __init__(self, text):
2264
1965
        self.text = text
2265
1966
 
2266
1967
 
2267
 
class MalformedHeader(BadBundle):
2268
 
 
 
1968
class MalformedHeader(BadBundle): 
 
1969
    
2269
1970
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2270
1971
 
2271
1972
 
2272
 
class MalformedPatches(BadBundle):
2273
 
 
 
1973
class MalformedPatches(BadBundle): 
 
1974
    
2274
1975
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2275
1976
 
2276
1977
 
2277
 
class MalformedFooter(BadBundle):
2278
 
 
 
1978
class MalformedFooter(BadBundle): 
 
1979
    
2279
1980
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2280
1981
 
2281
1982
 
2282
1983
class UnsupportedEOLMarker(BadBundle):
2283
 
 
2284
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1984
    
 
1985
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2285
1986
 
2286
1987
    def __init__(self):
2287
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1988
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2288
1989
        # but for this there is not
2289
1990
        BzrError.__init__(self)
2290
1991
 
2291
1992
 
2292
1993
class IncompatibleBundleFormat(BzrError):
2293
 
 
 
1994
    
2294
1995
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2295
1996
 
2296
1997
    def __init__(self, bundle_format, other):
2300
2001
 
2301
2002
 
2302
2003
class BadInventoryFormat(BzrError):
2303
 
 
 
2004
    
2304
2005
    _fmt = "Root class for inventory serialization errors"
2305
2006
 
2306
2007
 
2317
2018
    _fmt = """This operation requires rich root data storage"""
2318
2019
 
2319
2020
 
2320
 
class NoSmartMedium(InternalBzrError):
 
2021
class NoSmartMedium(BzrError):
2321
2022
 
2322
2023
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2323
2024
 
 
2025
    internal_error = True
 
2026
 
2324
2027
    def __init__(self, transport):
2325
2028
        self.transport = transport
2326
2029
 
2327
2030
 
 
2031
class NoSmartServer(NotBranchError):
 
2032
 
 
2033
    _fmt = "No smart server available at %(url)s"
 
2034
 
 
2035
    def __init__(self, url):
 
2036
        self.url = url
 
2037
 
 
2038
 
2328
2039
class UnknownSSH(BzrError):
2329
2040
 
2330
2041
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2340
2051
            " Please set BZR_SSH environment variable.")
2341
2052
 
2342
2053
 
2343
 
class GhostRevisionsHaveNoRevno(BzrError):
2344
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2345
 
 
2346
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2347
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2348
 
 
2349
 
    def __init__(self, revision_id, ghost_revision_id):
2350
 
        self.revision_id = revision_id
2351
 
        self.ghost_revision_id = ghost_revision_id
2352
 
 
2353
 
 
2354
2054
class GhostRevisionUnusableHere(BzrError):
2355
2055
 
2356
2056
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2360
2060
        self.revision_id = revision_id
2361
2061
 
2362
2062
 
2363
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2063
class IllegalUseOfScopeReplacer(BzrError):
2364
2064
 
2365
2065
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2366
2066
            " %(msg)s%(extra)s")
2367
2067
 
 
2068
    internal_error = True
 
2069
 
2368
2070
    def __init__(self, name, msg, extra=None):
2369
2071
        BzrError.__init__(self)
2370
2072
        self.name = name
2375
2077
            self.extra = ''
2376
2078
 
2377
2079
 
2378
 
class InvalidImportLine(InternalBzrError):
 
2080
class InvalidImportLine(BzrError):
2379
2081
 
2380
2082
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2381
2083
 
 
2084
    internal_error = True
 
2085
 
2382
2086
    def __init__(self, text, msg):
2383
2087
        BzrError.__init__(self)
2384
2088
        self.text = text
2385
2089
        self.msg = msg
2386
2090
 
2387
2091
 
2388
 
class ImportNameCollision(InternalBzrError):
 
2092
class ImportNameCollision(BzrError):
2389
2093
 
2390
2094
    _fmt = ("Tried to import an object to the same name as"
2391
2095
            " an existing object. %(name)s")
2392
2096
 
 
2097
    internal_error = True
 
2098
 
2393
2099
    def __init__(self, name):
2394
2100
        BzrError.__init__(self)
2395
2101
        self.name = name
2408
2114
        " branch location."
2409
2115
 
2410
2116
 
2411
 
class IllegalMergeDirectivePayload(BzrError):
2412
 
    """A merge directive contained something other than a patch or bundle"""
2413
 
 
2414
 
    _fmt = "Bad merge directive payload %(start)r"
2415
 
 
2416
 
    def __init__(self, start):
2417
 
        BzrError(self)
2418
 
        self.start = start
2419
 
 
2420
 
 
2421
 
class PatchVerificationFailed(BzrError):
2422
 
    """A patch from a merge directive could not be verified"""
2423
 
 
2424
 
    _fmt = "Preview patch does not match requested changes."
2425
 
 
2426
 
 
2427
2117
class PatchMissing(BzrError):
2428
2118
    """Raise a patch type was specified but no patch supplied"""
2429
2119
 
2430
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2120
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2431
2121
 
2432
2122
    def __init__(self, patch_type):
2433
2123
        BzrError.__init__(self)
2434
2124
        self.patch_type = patch_type
2435
2125
 
2436
2126
 
2437
 
class TargetNotBranch(BzrError):
2438
 
    """A merge directive's target branch is required, but isn't a branch"""
2439
 
 
2440
 
    _fmt = ("Your branch does not have all of the revisions required in "
2441
 
            "order to merge this merge directive and the target "
2442
 
            "location specified in the merge directive is not a branch: "
2443
 
            "%(location)s.")
2444
 
 
2445
 
    def __init__(self, location):
2446
 
        BzrError.__init__(self)
2447
 
        self.location = location
2448
 
 
2449
 
 
2450
2127
class UnsupportedInventoryKind(BzrError):
2451
 
 
 
2128
    
2452
2129
    _fmt = """Unsupported entry kind %(kind)s"""
2453
2130
 
2454
2131
    def __init__(self, kind):
2457
2134
 
2458
2135
class BadSubsumeSource(BzrError):
2459
2136
 
2460
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2137
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2461
2138
 
2462
2139
    def __init__(self, tree, other_tree, reason):
2463
2140
        self.tree = tree
2466
2143
 
2467
2144
 
2468
2145
class SubsumeTargetNeedsUpgrade(BzrError):
2469
 
 
 
2146
    
2470
2147
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2471
2148
 
2472
2149
    def __init__(self, other_tree):
2473
2150
        self.other_tree = other_tree
2474
2151
 
2475
2152
 
2476
 
class BadReferenceTarget(InternalBzrError):
2477
 
 
2478
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2479
 
           "%(reason)s"
 
2153
class BadReferenceTarget(BzrError):
 
2154
 
 
2155
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2156
 
 
2157
    internal_error = True
2480
2158
 
2481
2159
    def __init__(self, tree, other_tree, reason):
2482
2160
        self.tree = tree
2495
2173
class TagsNotSupported(BzrError):
2496
2174
 
2497
2175
    _fmt = ("Tags not supported by %(branch)s;"
2498
 
            " you may be able to use bzr upgrade.")
 
2176
            " you may be able to use bzr upgrade --dirstate-tags.")
2499
2177
 
2500
2178
    def __init__(self, branch):
2501
2179
        self.branch = branch
2502
2180
 
2503
 
 
 
2181
        
2504
2182
class TagAlreadyExists(BzrError):
2505
2183
 
2506
2184
    _fmt = "Tag %(tag_name)s already exists."
2511
2189
 
2512
2190
class MalformedBugIdentifier(BzrError):
2513
2191
 
2514
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2515
 
            'See "bzr help bugs" for more information on this feature.')
 
2192
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2516
2193
 
2517
2194
    def __init__(self, bug_id, reason):
2518
2195
        self.bug_id = bug_id
2519
2196
        self.reason = reason
2520
2197
 
2521
2198
 
2522
 
class InvalidBugTrackerURL(BzrError):
2523
 
 
2524
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2525
 
            "contain {id}: %(url)s")
2526
 
 
2527
 
    def __init__(self, abbreviation, url):
2528
 
        self.abbreviation = abbreviation
2529
 
        self.url = url
2530
 
 
2531
 
 
2532
2199
class UnknownBugTrackerAbbreviation(BzrError):
2533
2200
 
2534
2201
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2539
2206
        self.branch = branch
2540
2207
 
2541
2208
 
2542
 
class InvalidLineInBugsProperty(BzrError):
2543
 
 
2544
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2545
 
 
2546
 
    def __init__(self, line):
2547
 
        self.line = line
2548
 
 
2549
 
 
2550
 
class InvalidBugStatus(BzrError):
2551
 
 
2552
 
    _fmt = ("Invalid bug status: '%(status)s'")
2553
 
 
2554
 
    def __init__(self, status):
2555
 
        self.status = status
2556
 
 
2557
 
 
2558
2209
class UnexpectedSmartServerResponse(BzrError):
2559
2210
 
2560
2211
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2563
2214
        self.response_tuple = response_tuple
2564
2215
 
2565
2216
 
2566
 
class ErrorFromSmartServer(BzrError):
2567
 
    """An error was received from a smart server.
2568
 
 
2569
 
    :seealso: UnknownErrorFromSmartServer
2570
 
    """
2571
 
 
2572
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2573
 
 
2574
 
    internal_error = True
2575
 
 
2576
 
    def __init__(self, error_tuple):
2577
 
        self.error_tuple = error_tuple
2578
 
        try:
2579
 
            self.error_verb = error_tuple[0]
2580
 
        except IndexError:
2581
 
            self.error_verb = None
2582
 
        self.error_args = error_tuple[1:]
2583
 
 
2584
 
 
2585
 
class UnknownErrorFromSmartServer(BzrError):
2586
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2587
 
    error.
2588
 
 
2589
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2590
 
    distinguish between the following two cases:
2591
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2592
 
        and so should provoke a traceback to the user.
2593
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2594
 
        translated.  This is probably because the server sent us garbage, and
2595
 
        should not provoke a traceback.
2596
 
    """
2597
 
 
2598
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2599
 
 
2600
 
    internal_error = False
2601
 
 
2602
 
    def __init__(self, error_from_smart_server):
2603
 
        """Constructor.
2604
 
 
2605
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2606
 
        """
2607
 
        self.error_from_smart_server = error_from_smart_server
2608
 
        self.error_tuple = error_from_smart_server.error_tuple
2609
 
 
2610
 
 
2611
2217
class ContainerError(BzrError):
2612
2218
    """Base class of container errors."""
2613
2219
 
2615
2221
class UnknownContainerFormatError(ContainerError):
2616
2222
 
2617
2223
    _fmt = "Unrecognised container format: %(container_format)r"
2618
 
 
 
2224
    
2619
2225
    def __init__(self, container_format):
2620
2226
        self.container_format = container_format
2621
2227
 
2624
2230
 
2625
2231
    _fmt = "Unexpected end of container stream"
2626
2232
 
 
2233
    internal_error = False
 
2234
 
2627
2235
 
2628
2236
class UnknownRecordTypeError(ContainerError):
2629
2237
 
2651
2259
 
2652
2260
class DuplicateRecordNameError(ContainerError):
2653
2261
 
2654
 
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2262
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
2655
2263
 
2656
2264
    def __init__(self, name):
2657
2265
        self.name = name
2658
2266
 
2659
2267
 
2660
 
class NoDestinationAddress(InternalBzrError):
 
2268
class NoDestinationAddress(BzrError):
2661
2269
 
2662
2270
    _fmt = "Message does not have a destination address."
2663
2271
 
2664
 
 
2665
 
class RepositoryDataStreamError(BzrError):
2666
 
 
2667
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2668
 
 
2669
 
    def __init__(self, reason):
2670
 
        self.reason = reason
 
2272
    internal_error = True
2671
2273
 
2672
2274
 
2673
2275
class SMTPError(BzrError):
2676
2278
 
2677
2279
    def __init__(self, error):
2678
2280
        self.error = error
2679
 
 
2680
 
 
2681
 
class NoMessageSupplied(BzrError):
2682
 
 
2683
 
    _fmt = "No message supplied."
2684
 
 
2685
 
 
2686
 
class NoMailAddressSpecified(BzrError):
2687
 
 
2688
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2689
 
 
2690
 
 
2691
 
class UnknownMailClient(BzrError):
2692
 
 
2693
 
    _fmt = "Unknown mail client: %(mail_client)s"
2694
 
 
2695
 
    def __init__(self, mail_client):
2696
 
        BzrError.__init__(self, mail_client=mail_client)
2697
 
 
2698
 
 
2699
 
class MailClientNotFound(BzrError):
2700
 
 
2701
 
    _fmt = "Unable to find mail client with the following names:"\
2702
 
        " %(mail_command_list_string)s"
2703
 
 
2704
 
    def __init__(self, mail_command_list):
2705
 
        mail_command_list_string = ', '.join(mail_command_list)
2706
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2707
 
                          mail_command_list_string=mail_command_list_string)
2708
 
 
2709
 
class SMTPConnectionRefused(SMTPError):
2710
 
 
2711
 
    _fmt = "SMTP connection to %(host)s refused"
2712
 
 
2713
 
    def __init__(self, error, host):
2714
 
        self.error = error
2715
 
        self.host = host
2716
 
 
2717
 
 
2718
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2719
 
 
2720
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2721
 
 
2722
 
 
2723
 
class BzrDirError(BzrError):
2724
 
 
2725
 
    def __init__(self, bzrdir):
2726
 
        import bzrlib.urlutils as urlutils
2727
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2728
 
                                                    'ascii')
2729
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2730
 
 
2731
 
 
2732
 
class UnsyncedBranches(BzrDirError):
2733
 
 
2734
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2735
 
            " bzr help sync-for-reconfigure.")
2736
 
 
2737
 
    def __init__(self, bzrdir, target_branch):
2738
 
        BzrDirError.__init__(self, bzrdir)
2739
 
        import bzrlib.urlutils as urlutils
2740
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2741
 
                                                        'ascii')
2742
 
 
2743
 
 
2744
 
class AlreadyBranch(BzrDirError):
2745
 
 
2746
 
    _fmt = "'%(display_url)s' is already a branch."
2747
 
 
2748
 
 
2749
 
class AlreadyTree(BzrDirError):
2750
 
 
2751
 
    _fmt = "'%(display_url)s' is already a tree."
2752
 
 
2753
 
 
2754
 
class AlreadyCheckout(BzrDirError):
2755
 
 
2756
 
    _fmt = "'%(display_url)s' is already a checkout."
2757
 
 
2758
 
 
2759
 
class AlreadyLightweightCheckout(BzrDirError):
2760
 
 
2761
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2762
 
 
2763
 
 
2764
 
class AlreadyUsingShared(BzrDirError):
2765
 
 
2766
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2767
 
 
2768
 
 
2769
 
class AlreadyStandalone(BzrDirError):
2770
 
 
2771
 
    _fmt = "'%(display_url)s' is already standalone."
2772
 
 
2773
 
 
2774
 
class AlreadyWithTrees(BzrDirError):
2775
 
 
2776
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2777
 
            "working trees.")
2778
 
 
2779
 
 
2780
 
class AlreadyWithNoTrees(BzrDirError):
2781
 
 
2782
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2783
 
            "working trees.")
2784
 
 
2785
 
 
2786
 
class ReconfigurationNotSupported(BzrDirError):
2787
 
 
2788
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2789
 
 
2790
 
 
2791
 
class NoBindLocation(BzrDirError):
2792
 
 
2793
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2794
 
 
2795
 
 
2796
 
class UncommittedChanges(BzrError):
2797
 
 
2798
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2799
 
            ' (See bzr status).%(more)s')
2800
 
 
2801
 
    def __init__(self, tree, more=None):
2802
 
        if more is None:
2803
 
            more = ''
2804
 
        else:
2805
 
            more = ' ' + more
2806
 
        import bzrlib.urlutils as urlutils
2807
 
        display_url = urlutils.unescape_for_display(
2808
 
            tree.bzrdir.root_transport.base, 'ascii')
2809
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2810
 
 
2811
 
 
2812
 
class MissingTemplateVariable(BzrError):
2813
 
 
2814
 
    _fmt = 'Variable {%(name)s} is not available.'
2815
 
 
2816
 
    def __init__(self, name):
2817
 
        self.name = name
2818
 
 
2819
 
 
2820
 
class NoTemplate(BzrError):
2821
 
 
2822
 
    _fmt = 'No template specified.'
2823
 
 
2824
 
 
2825
 
class UnableCreateSymlink(BzrError):
2826
 
 
2827
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2828
 
 
2829
 
    def __init__(self, path=None):
2830
 
        path_str = ''
2831
 
        if path:
2832
 
            try:
2833
 
                path_str = repr(str(path))
2834
 
            except UnicodeEncodeError:
2835
 
                path_str = repr(path)
2836
 
            path_str += ' '
2837
 
        self.path_str = path_str
2838
 
 
2839
 
 
2840
 
class UnsupportedTimezoneFormat(BzrError):
2841
 
 
2842
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2843
 
            'options are "utc", "original", "local".')
2844
 
 
2845
 
    def __init__(self, timezone):
2846
 
        self.timezone = timezone
2847
 
 
2848
 
 
2849
 
class CommandAvailableInPlugin(StandardError):
2850
 
 
2851
 
    internal_error = False
2852
 
 
2853
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2854
 
 
2855
 
        self.plugin_metadata = plugin_metadata
2856
 
        self.cmd_name = cmd_name
2857
 
        self.provider = provider
2858
 
 
2859
 
    def __str__(self):
2860
 
 
2861
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2862
 
                'However, the following official plugin provides this command: %s\n'
2863
 
                'You can install it by going to: %s'
2864
 
                % (self.cmd_name, self.plugin_metadata['name'],
2865
 
                    self.plugin_metadata['url']))
2866
 
 
2867
 
        return _fmt
2868
 
 
2869
 
 
2870
 
class NoPluginAvailable(BzrError):
2871
 
    pass
2872
 
 
2873
 
 
2874
 
class UnableEncodePath(BzrError):
2875
 
 
2876
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2877
 
            'user encoding %(user_encoding)s')
2878
 
 
2879
 
    def __init__(self, path, kind):
2880
 
        from bzrlib.osutils import get_user_encoding
2881
 
        self.path = path
2882
 
        self.kind = kind
2883
 
        self.user_encoding = osutils.get_user_encoding()
2884
 
 
2885
 
 
2886
 
class NoSuchAlias(BzrError):
2887
 
 
2888
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2889
 
 
2890
 
    def __init__(self, alias_name):
2891
 
        BzrError.__init__(self, alias_name=alias_name)
2892
 
 
2893
 
 
2894
 
class DirectoryLookupFailure(BzrError):
2895
 
    """Base type for lookup errors."""
2896
 
 
2897
 
    pass
2898
 
 
2899
 
 
2900
 
class InvalidLocationAlias(DirectoryLookupFailure):
2901
 
 
2902
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2903
 
 
2904
 
    def __init__(self, alias_name):
2905
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2906
 
 
2907
 
 
2908
 
class UnsetLocationAlias(DirectoryLookupFailure):
2909
 
 
2910
 
    _fmt = 'No %(alias_name)s location assigned.'
2911
 
 
2912
 
    def __init__(self, alias_name):
2913
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2914
 
 
2915
 
 
2916
 
class CannotBindAddress(BzrError):
2917
 
 
2918
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2919
 
 
2920
 
    def __init__(self, host, port, orig_error):
2921
 
        BzrError.__init__(self, host=host, port=port,
2922
 
            orig_error=orig_error[1])
2923
 
 
2924
 
 
2925
 
class UnknownRules(BzrError):
2926
 
 
2927
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2928
 
 
2929
 
    def __init__(self, unknowns):
2930
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2931
 
 
2932
 
 
2933
 
class HookFailed(BzrError):
2934
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2935
 
    than TipChangeRejected.
2936
 
    """
2937
 
 
2938
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2939
 
            "%(traceback_text)s%(exc_value)s")
2940
 
 
2941
 
    def __init__(self, hook_stage, hook_name, exc_info):
2942
 
        import traceback
2943
 
        self.hook_stage = hook_stage
2944
 
        self.hook_name = hook_name
2945
 
        self.exc_info = exc_info
2946
 
        self.exc_type = exc_info[0]
2947
 
        self.exc_value = exc_info[1]
2948
 
        self.exc_tb = exc_info[2]
2949
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2950
 
 
2951
 
 
2952
 
class TipChangeRejected(BzrError):
2953
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
2954
 
    explicitly abort a change to a branch tip.
2955
 
    """
2956
 
 
2957
 
    _fmt = u"Tip change rejected: %(msg)s"
2958
 
 
2959
 
    def __init__(self, msg):
2960
 
        self.msg = msg
2961
 
 
2962
 
 
2963
 
class ShelfCorrupt(BzrError):
2964
 
 
2965
 
    _fmt = "Shelf corrupt."
2966
 
 
2967
 
 
2968
 
class NoSuchShelfId(BzrError):
2969
 
 
2970
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
2971
 
 
2972
 
    def __init__(self, shelf_id):
2973
 
        BzrError.__init__(self, shelf_id=shelf_id)
2974
 
 
2975
 
 
2976
 
class InvalidShelfId(BzrError):
2977
 
 
2978
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
2979
 
 
2980
 
    def __init__(self, invalid_id):
2981
 
        BzrError.__init__(self, invalid_id=invalid_id)
2982
 
 
2983
 
 
2984
 
class JailBreak(BzrError):
2985
 
 
2986
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
2987
 
 
2988
 
    def __init__(self, url):
2989
 
        BzrError.__init__(self, url=url)
2990
 
 
2991
 
 
2992
 
class UserAbort(BzrError):
2993
 
 
2994
 
    _fmt = 'The user aborted the operation.'
2995
 
 
2996
 
 
2997
 
class MustHaveWorkingTree(BzrError):
2998
 
 
2999
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3000
 
 
3001
 
    def __init__(self, format, url):
3002
 
        BzrError.__init__(self, format=format, url=url)
3003
 
 
3004
 
 
3005
 
class NoSuchView(BzrError):
3006
 
    """A view does not exist.
3007
 
    """
3008
 
 
3009
 
    _fmt = u"No such view: %(view_name)s."
3010
 
 
3011
 
    def __init__(self, view_name):
3012
 
        self.view_name = view_name
3013
 
 
3014
 
 
3015
 
class ViewsNotSupported(BzrError):
3016
 
    """Views are not supported by a tree format.
3017
 
    """
3018
 
 
3019
 
    _fmt = ("Views are not supported by %(tree)s;"
3020
 
            " use 'bzr upgrade' to change your tree to a later format.")
3021
 
 
3022
 
    def __init__(self, tree):
3023
 
        self.tree = tree
3024
 
 
3025
 
 
3026
 
class FileOutsideView(BzrError):
3027
 
 
3028
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3029
 
            '%(view_str)s')
3030
 
 
3031
 
    def __init__(self, file_name, view_files):
3032
 
        self.file_name = file_name
3033
 
        self.view_str = ", ".join(view_files)
3034
 
 
3035
 
 
3036
 
class UnresumableWriteGroup(BzrError):
3037
 
 
3038
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3039
 
            "%(write_groups)r: %(reason)s")
3040
 
 
3041
 
    internal_error = True
3042
 
 
3043
 
    def __init__(self, repository, write_groups, reason):
3044
 
        self.repository = repository
3045
 
        self.write_groups = write_groups
3046
 
        self.reason = reason
3047
 
 
3048
 
 
3049
 
class UnsuspendableWriteGroup(BzrError):
3050
 
 
3051
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3052
 
 
3053
 
    internal_error = True
3054
 
 
3055
 
    def __init__(self, repository):
3056
 
        self.repository = repository
3057
 
 
3058
 
 
3059
 
class LossyPushToSameVCS(BzrError):
3060
 
 
3061
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3062
 
            "%(target_branch)r that are in the same VCS.")
3063
 
 
3064
 
    internal_error = True
3065
 
 
3066
 
    def __init__(self, source_branch, target_branch):
3067
 
        self.source_branch = source_branch
3068
 
        self.target_branch = target_branch