← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-23 00:12:35 UTC
  • mto: (2772.2.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2774.
  • Revision ID: ian.clatworthy@internode.on.net-20070823001235-bjza31s3c5ffdxlj
Skip path lookup for tree.get_file() when we already know the path

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
 
20
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
43
44
# 'unprintable'.
44
45
 
45
46
 
46
 
# return codes from the bzr program
47
 
EXIT_OK = 0
48
 
EXIT_ERROR = 3
49
 
EXIT_INTERNAL_ERROR = 4
50
 
 
51
 
 
52
47
class BzrError(StandardError):
53
48
    """
54
49
    Base class for errors raised by bzrlib.
61
56
    :cvar _fmt: Format string to display the error; this is expanded
62
57
    by the instance's dict.
63
58
    """
64
 
 
 
59
    
65
60
    internal_error = False
66
61
 
67
62
    def __init__(self, msg=None, **kwds):
72
67
        arguments can be given.  The first is for generic "user" errors which
73
68
        are not intended to be caught and so do not need a specific subclass.
74
69
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
70
        string to print the arguments.  
76
71
 
77
 
        Keyword arguments are taken as parameters to the error, which can
78
 
        be inserted into the format string template.  It's recommended
79
 
        that subclasses override the __init__ method to require specific
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
73
        be inserted into the format string template.  It's recommended 
 
74
        that subclasses override the __init__ method to require specific 
80
75
        parameters.
81
76
 
82
77
        :param msg: If given, this is the literal complete text for the error,
83
 
           not subject to expansion. 'msg' is used instead of 'message' because
84
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        not subject to expansion.
85
79
        """
86
80
        StandardError.__init__(self)
87
81
        if msg is not None:
93
87
            for key, value in kwds.items():
94
88
                setattr(self, key, value)
95
89
 
96
 
    def _format(self):
 
90
    def __str__(self):
97
91
        s = getattr(self, '_preformatted_string', None)
98
92
        if s is not None:
99
 
            # contains a preformatted message
100
 
            return s
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
101
95
        try:
102
96
            fmt = self._get_format_string()
103
97
            if fmt:
104
 
                d = dict(self.__dict__)
105
 
                s = fmt % d
 
98
                s = fmt % self.__dict__
106
99
                # __str__() should always return a 'str' object
107
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
108
103
                return s
109
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
113
108
                   getattr(self, '_fmt', None),
114
109
                   e)
115
110
 
116
 
    def __unicode__(self):
117
 
        u = self._format()
118
 
        if isinstance(u, str):
119
 
            # Try decoding the str using the default encoding.
120
 
            u = unicode(u)
121
 
        elif not isinstance(u, unicode):
122
 
            # Try to make a unicode object from it, because __unicode__ must
123
 
            # return a unicode object.
124
 
            u = unicode(u)
125
 
        return u
126
 
 
127
 
    def __str__(self):
128
 
        s = self._format()
129
 
        if isinstance(s, unicode):
130
 
            s = s.encode('utf8')
131
 
        else:
132
 
            # __str__ must return a str.
133
 
            s = str(s)
134
 
        return s
135
 
 
136
 
    def __repr__(self):
137
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
138
 
 
139
111
    def _get_format_string(self):
140
112
        """Return format string for this exception or None"""
141
113
        fmt = getattr(self, '_fmt', None)
153
125
               getattr(self, '_fmt', None),
154
126
               )
155
127
 
156
 
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
158
 
            return NotImplemented
159
 
        return self.__dict__ == other.__dict__
160
 
 
161
 
 
162
 
class InternalBzrError(BzrError):
163
 
    """Base class for errors that are internal in nature.
164
 
 
165
 
    This is a convenience class for errors that are internal. The
166
 
    internal_error attribute can still be altered in subclasses, if needed.
167
 
    Using this class is simply an easy way to get internal errors.
168
 
    """
169
 
 
170
 
    internal_error = True
171
 
 
172
128
 
173
129
class BzrNewError(BzrError):
174
130
    """Deprecated error base class."""
204
160
 
205
161
 
206
162
class AlreadyBuilding(BzrError):
207
 
 
 
163
    
208
164
    _fmt = "The tree builder is already building a tree."
209
165
 
210
166
 
211
 
class BranchError(BzrError):
212
 
    """Base class for concrete 'errors about a branch'."""
213
 
 
214
 
    def __init__(self, branch):
215
 
        BzrError.__init__(self, branch=branch)
216
 
 
217
 
 
218
 
class BzrCheckError(InternalBzrError):
219
 
 
220
 
    _fmt = "Internal check failed: %(msg)s"
221
 
 
222
 
    def __init__(self, msg):
223
 
        BzrError.__init__(self)
224
 
        self.msg = msg
225
 
 
226
 
 
227
 
class DirstateCorrupt(BzrError):
228
 
 
229
 
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
230
 
 
231
 
    def __init__(self, state, msg):
232
 
        BzrError.__init__(self)
233
 
        self.state = state
234
 
        self.msg = msg
235
 
 
236
 
 
237
 
class DisabledMethod(InternalBzrError):
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class DisabledMethod(BzrError):
238
179
 
239
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
240
181
 
 
182
    internal_error = True
 
183
 
241
184
    def __init__(self, class_name):
242
185
        BzrError.__init__(self)
243
186
        self.class_name = class_name
264
207
        self.transport = transport
265
208
 
266
209
 
267
 
class InvalidEntryName(InternalBzrError):
268
 
 
 
210
class InvalidEntryName(BzrError):
 
211
    
269
212
    _fmt = "Invalid entry name: %(name)s"
270
213
 
 
214
    internal_error = True
 
215
 
271
216
    def __init__(self, name):
272
217
        BzrError.__init__(self)
273
218
        self.name = name
274
219
 
275
220
 
276
221
class InvalidRevisionNumber(BzrError):
277
 
 
 
222
    
278
223
    _fmt = "Invalid revision number %(revno)s"
279
224
 
280
225
    def __init__(self, revno):
292
237
        self.revision_id = revision_id
293
238
        self.branch = branch
294
239
 
295
 
 
296
240
class ReservedId(BzrError):
297
241
 
298
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
301
245
        self.revision_id = revision_id
302
246
 
303
247
 
304
 
class RootMissing(InternalBzrError):
305
 
 
306
 
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "record_entry_contents.")
308
 
 
309
 
 
310
 
class NoPublicBranch(BzrError):
311
 
 
312
 
    _fmt = 'There is no public branch set for "%(branch_url)s".'
313
 
 
314
 
    def __init__(self, branch):
315
 
        import bzrlib.urlutils as urlutils
316
 
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
317
 
        BzrError.__init__(self, branch_url=public_location)
318
 
 
319
 
 
320
248
class NoHelpTopic(BzrError):
321
249
 
322
250
    _fmt = ("No help could be found for '%(topic)s'. "
328
256
 
329
257
class NoSuchId(BzrError):
330
258
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
259
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
260
    
333
261
    def __init__(self, tree, file_id):
334
262
        BzrError.__init__(self)
335
263
        self.file_id = file_id
338
266
 
339
267
class NoSuchIdInRepository(NoSuchId):
340
268
 
341
 
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
342
 
            ' %(repository)r')
 
269
    _fmt = ("The file id %(file_id)r is not present in the repository"
 
270
            " %(repository)r")
343
271
 
344
272
    def __init__(self, repository, file_id):
345
273
        BzrError.__init__(self, repository=repository, file_id=file_id)
346
274
 
347
275
 
348
 
class NotStacked(BranchError):
349
 
 
350
 
    _fmt = "The branch '%(branch)s' is not stacked."
351
 
 
352
 
 
353
 
class InventoryModified(InternalBzrError):
 
276
class InventoryModified(BzrError):
354
277
 
355
278
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
279
            " so a clean inventory cannot be read without data loss.")
357
280
 
 
281
    internal_error = True
 
282
 
358
283
    def __init__(self, tree):
359
284
        self.tree = tree
360
285
 
361
286
 
362
287
class NoWorkingTree(BzrError):
363
288
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
289
    _fmt = "No WorkingTree exists for %(base)s."
 
290
    
366
291
    def __init__(self, base):
367
292
        BzrError.__init__(self)
368
293
        self.base = base
381
306
        self.url = url
382
307
 
383
308
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
309
class WorkingTreeAlreadyPopulated(BzrError):
 
310
 
 
311
    _fmt = """Working tree already populated in %(base)s"""
 
312
 
 
313
    internal_error = True
387
314
 
388
315
    def __init__(self, base):
389
316
        self.base = base
390
317
 
391
 
 
392
318
class BzrCommandError(BzrError):
393
319
    """Error from user command"""
394
320
 
 
321
    internal_error = False
 
322
 
395
323
    # Error from malformed user command; please avoid raising this as a
396
324
    # generic exception not caused by user input.
397
325
    #
399
327
    # are not intended to be caught anyway.  UI code need not subclass
400
328
    # BzrCommandError, and non-UI code should not throw a subclass of
401
329
    # BzrCommandError.  ADHB 20051211
 
330
    def __init__(self, msg):
 
331
        # Object.__str__() must return a real string
 
332
        # returning a Unicode string is a python error.
 
333
        if isinstance(msg, unicode):
 
334
            self.msg = msg.encode('utf8')
 
335
        else:
 
336
            self.msg = msg
 
337
 
 
338
    def __str__(self):
 
339
        return self.msg
402
340
 
403
341
 
404
342
class NotWriteLocked(BzrError):
477
415
    def __init__(self, name, value):
478
416
        BzrError.__init__(self, name=name, value=value)
479
417
 
480
 
 
 
418
    
481
419
class StrictCommitFailed(BzrError):
482
420
 
483
421
    _fmt = "Commit refused because there are unknown files in the tree"
486
424
# XXX: Should be unified with TransportError; they seem to represent the
487
425
# same thing
488
426
# 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
 
427
# - this is finer than a TransportError - and more useful as such. It 
490
428
# differentiates between 'transport has failed' and 'operation on a transport
491
429
# has failed.'
492
430
class PathError(BzrError):
493
 
 
 
431
    
494
432
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
433
 
496
434
    def __init__(self, path, extra=None):
516
454
    """Used when renaming and both source and dest exist."""
517
455
 
518
456
    _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")
 
457
            "%(extra)s")
521
458
 
522
459
    def __init__(self, source, dest, extra=None):
523
460
        BzrError.__init__(self)
531
468
 
532
469
class NotADirectory(PathError):
533
470
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
471
    _fmt = "%(path)r is not a directory %(extra)s"
535
472
 
536
473
 
537
474
class NotInWorkingDirectory(PathError):
538
475
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
476
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
477
 
541
478
 
542
479
class DirectoryNotEmpty(PathError):
543
480
 
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
 
 
 
481
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
482
 
 
483
 
 
484
class ReadingCompleted(BzrError):
 
485
    
554
486
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
487
            "called upon it - the request has been completed and no more "
556
488
            "data may be read.")
557
489
 
 
490
    internal_error = True
 
491
 
558
492
    def __init__(self, request):
559
493
        self.request = request
560
494
 
561
495
 
562
496
class ResourceBusy(PathError):
563
497
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
498
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
499
 
566
500
 
567
501
class PermissionDenied(PathError):
568
502
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
503
    _fmt = "Permission denied: %(path)r%(extra)s"
570
504
 
571
505
 
572
506
class InvalidURL(PathError):
573
507
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
508
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
509
 
576
510
 
577
511
class InvalidURLJoin(PathError):
578
512
 
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
 
513
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
514
 
 
515
    def __init__(self, msg, base, args):
 
516
        PathError.__init__(self, base, msg)
 
517
        self.args = [base] + list(args)
608
518
 
609
519
 
610
520
class UnknownHook(BzrError):
625
535
        PathError.__init__(self, url, extra=extra)
626
536
 
627
537
 
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
538
class ReadError(PathError):
661
 
 
 
539
    
662
540
    _fmt = """Error reading from %(path)r."""
663
541
 
664
542
 
665
543
class ShortReadvError(PathError):
666
544
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
545
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
546
            " at %(offset)s for %(path)s%(extra)s")
669
547
 
670
548
    internal_error = True
671
549
 
678
556
 
679
557
class PathNotChild(PathError):
680
558
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
559
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
682
560
 
683
561
    internal_error = True
684
562
 
694
572
 
695
573
class InvalidNormalization(PathError):
696
574
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
575
    _fmt = "Path %(path)r is not unicode normalized"
698
576
 
699
577
 
700
578
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
579
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
580
# TODO: Probably this behavior of should be a common superclass 
703
581
class NotBranchError(PathError):
704
582
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
583
    _fmt = "Not a branch: %(path)s"
706
584
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
585
    def __init__(self, path):
708
586
       import bzrlib.urlutils as urlutils
709
 
       path = urlutils.unescape_for_display(path, 'ascii')
710
 
       if detail is not None:
711
 
           detail = ': ' + detail
712
 
       self.detail = detail
713
 
       self.bzrdir = bzrdir
714
 
       PathError.__init__(self, path=path)
715
 
 
716
 
    def _format(self):
717
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
718
 
        # Python 2.4 have to be old-style classes so properties don't work.
719
 
        # Instead we override _format.
720
 
        if self.detail is None:
721
 
            if self.bzrdir is not None:
722
 
                try:
723
 
                    self.bzrdir.open_repository()
724
 
                except NoRepositoryPresent:
725
 
                    self.detail = ''
726
 
                else:
727
 
                    self.detail = ': location is a repository'
728
 
            else:
729
 
                self.detail = ''
730
 
        return PathError._format(self)
 
587
       self.path = urlutils.unescape_for_display(path, 'ascii')
731
588
 
732
589
 
733
590
class NoSubmitBranch(PathError):
741
598
 
742
599
class AlreadyBranchError(PathError):
743
600
 
744
 
    _fmt = 'Already a branch: "%(path)s".'
 
601
    _fmt = "Already a branch: %(path)s."
745
602
 
746
603
 
747
604
class BranchExistsWithoutWorkingTree(PathError):
748
605
 
749
 
    _fmt = 'Directory contains a branch, but no working tree \
750
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
606
    _fmt = "Directory contains a branch, but no working tree \
 
607
(use bzr checkout if you wish to build a working tree): %(path)s"
751
608
 
752
609
 
753
610
class AtomicFileAlreadyClosed(PathError):
754
611
 
755
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
756
 
            ' "%(path)s"')
 
612
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
613
            " %(path)s")
757
614
 
758
615
    def __init__(self, path, function):
759
616
        PathError.__init__(self, path=path, extra=None)
762
619
 
763
620
class InaccessibleParent(PathError):
764
621
 
765
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
766
 
            ' relative path "%(path)s"')
 
622
    _fmt = ("Parent not accessible given base %(base)s and"
 
623
            " relative path %(path)s")
767
624
 
768
625
    def __init__(self, path, base):
769
626
        PathError.__init__(self, path)
772
629
 
773
630
class NoRepositoryPresent(BzrError):
774
631
 
775
 
    _fmt = 'No repository present: "%(path)s"'
 
632
    _fmt = "No repository present: %(path)r"
776
633
    def __init__(self, bzrdir):
777
634
        BzrError.__init__(self)
778
635
        self.path = bzrdir.transport.clone('..').base
780
637
 
781
638
class FileInWrongBranch(BzrError):
782
639
 
783
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
640
    _fmt = "File %(path)s in not in branch %(branch_base)s."
784
641
 
785
642
    def __init__(self, branch, path):
786
643
        BzrError.__init__(self)
795
652
 
796
653
 
797
654
class UnknownFormatError(BzrError):
798
 
 
799
 
    _fmt = "Unknown %(kind)s format: %(format)r"
800
 
 
801
 
    def __init__(self, format, kind='branch'):
802
 
        self.kind = kind
803
 
        self.format = format
 
655
    
 
656
    _fmt = "Unknown branch format: %(format)r"
804
657
 
805
658
 
806
659
class IncompatibleFormat(BzrError):
807
 
 
 
660
    
808
661
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
809
662
 
810
663
    def __init__(self, format, bzrdir_format):
814
667
 
815
668
 
816
669
class IncompatibleRepositories(BzrError):
817
 
    """Report an error that two repositories are not compatible.
818
 
 
819
 
    Note that the source and target repositories are permitted to be strings:
820
 
    this exception is thrown from the smart server and may refer to a
821
 
    repository the client hasn't opened.
822
 
    """
823
 
 
824
 
    _fmt = "%(target)s\n" \
825
 
            "is not compatible with\n" \
826
 
            "%(source)s\n" \
827
 
            "%(details)s"
828
 
 
829
 
    def __init__(self, source, target, details=None):
830
 
        if details is None:
831
 
            details = "(no details)"
832
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
670
 
 
671
    _fmt = "Repository %(target)s is not compatible with repository"\
 
672
        " %(source)s"
 
673
 
 
674
    def __init__(self, source, target):
 
675
        BzrError.__init__(self, target=target, source=source)
833
676
 
834
677
 
835
678
class IncompatibleRevision(BzrError):
836
 
 
 
679
    
837
680
    _fmt = "Revision is not compatible with %(repo_format)s"
838
681
 
839
682
    def __init__(self, repo_format):
844
687
class AlreadyVersionedError(BzrError):
845
688
    """Used when a path is expected not to be versioned, but it is."""
846
689
 
847
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
690
    _fmt = "%(context_info)s%(path)s is already versioned"
848
691
 
849
692
    def __init__(self, path, context_info=None):
850
693
        """Construct a new AlreadyVersionedError.
865
708
class NotVersionedError(BzrError):
866
709
    """Used when a path is expected to be versioned, but it is not."""
867
710
 
868
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
711
    _fmt = "%(context_info)s%(path)s is not versioned"
869
712
 
870
713
    def __init__(self, path, context_info=None):
871
714
        """Construct a new NotVersionedError.
922
765
        BzrError.__init__(self, filename=filename, kind=kind)
923
766
 
924
767
 
925
 
class BadFilenameEncoding(BzrError):
926
 
 
927
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
928
 
            ' encoding %(fs_encoding)s')
929
 
 
930
 
    def __init__(self, filename, fs_encoding):
931
 
        BzrError.__init__(self)
932
 
        self.filename = filename
933
 
        self.fs_encoding = fs_encoding
934
 
 
935
 
 
936
768
class ForbiddenControlFileError(BzrError):
937
769
 
938
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
939
 
 
940
 
 
941
 
class LockError(InternalBzrError):
 
770
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
771
 
 
772
 
 
773
class LockError(BzrError):
942
774
 
943
775
    _fmt = "Lock error: %(msg)s"
944
776
 
 
777
    internal_error = True
 
778
 
945
779
    # All exceptions from the lock/unlock functions should be from
946
780
    # this exception class.  They will be translated as necessary. The
947
781
    # original exception is available as e.original_error
949
783
    # New code should prefer to raise specific subclasses
950
784
    def __init__(self, message):
951
785
        # Python 2.5 uses a slot for StandardError.message,
952
 
        # so use a different variable name.  We now work around this in
953
 
        # BzrError.__str__, but this member name is kept for compatability.
 
786
        # so use a different variable name
 
787
        # so it is exposed in self.__dict__
954
788
        self.msg = message
955
789
 
956
790
 
991
825
        self.obj = obj
992
826
 
993
827
 
994
 
class LockFailed(LockError):
995
 
 
996
 
    internal_error = False
997
 
 
998
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
999
 
 
1000
 
    def __init__(self, lock, why):
 
828
class ReadOnlyLockError(LockError):
 
829
 
 
830
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
831
 
 
832
    def __init__(self, fname, msg):
1001
833
        LockError.__init__(self, '')
1002
 
        self.lock = lock
1003
 
        self.why = why
 
834
        self.fname = fname
 
835
        self.msg = msg
1004
836
 
1005
837
 
1006
838
class OutSideTransaction(BzrError):
1030
862
 
1031
863
class UnlockableTransport(LockError):
1032
864
 
1033
 
    internal_error = False
1034
 
 
1035
865
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1036
866
 
1037
867
    def __init__(self, transport):
1040
870
 
1041
871
class LockContention(LockError):
1042
872
 
1043
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
873
    _fmt = "Could not acquire lock %(lock)s"
1044
874
    # TODO: show full url for lock, combining the transport and relative
1045
875
    # bits?
1046
876
 
1047
877
    internal_error = False
1048
878
 
1049
 
    def __init__(self, lock, msg=''):
 
879
    def __init__(self, lock):
1050
880
        self.lock = lock
1051
 
        self.msg = msg
1052
881
 
1053
882
 
1054
883
class LockBroken(LockError):
1089
918
 
1090
919
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1091
920
 
 
921
    internal_error = True
 
922
 
1092
923
    def __init__(self, obj):
1093
924
        self.obj = obj
1094
925
 
1119
950
        BzrError.__init__(self, files=files, files_str=files_str)
1120
951
 
1121
952
 
1122
 
class BadCommitMessageEncoding(BzrError):
1123
 
 
1124
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1125
 
        'the current encoding.'
1126
 
 
1127
 
 
1128
953
class UpgradeReadonly(BzrError):
1129
954
 
1130
955
    _fmt = "Upgrade URL cannot work with readonly URLs."
1144
969
    _fmt = "Commit refused because there are unknowns in the tree."
1145
970
 
1146
971
 
1147
 
class NoSuchRevision(InternalBzrError):
 
972
class NoSuchRevision(BzrError):
1148
973
 
1149
974
    _fmt = "%(branch)s has no revision %(revision)s"
1150
975
 
 
976
    internal_error = True
 
977
 
1151
978
    def __init__(self, branch, revision):
1152
979
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1153
980
        BzrError.__init__(self, branch=branch, revision=revision)
1154
981
 
1155
982
 
1156
 
class RangeInChangeOption(BzrError):
1157
 
 
1158
 
    _fmt = "Option --change does not accept revision ranges"
 
983
# zero_ninetyone: this exception is no longer raised and should be removed
 
984
class NotLeftParentDescendant(BzrError):
 
985
 
 
986
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
987
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
988
 
 
989
    internal_error = True
 
990
 
 
991
    def __init__(self, branch, old_revision, new_revision):
 
992
        BzrError.__init__(self, branch_location=branch.base,
 
993
                          old_revision=old_revision,
 
994
                          new_revision=new_revision)
1159
995
 
1160
996
 
1161
997
class NoSuchRevisionSpec(BzrError):
1168
1004
 
1169
1005
class NoSuchRevisionInTree(NoSuchRevision):
1170
1006
    """When using Tree.revision_tree, and the revision is not accessible."""
1171
 
 
1172
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1007
    
 
1008
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1173
1009
 
1174
1010
    def __init__(self, tree, revision_id):
1175
1011
        BzrError.__init__(self)
1179
1015
 
1180
1016
class InvalidRevisionSpec(BzrError):
1181
1017
 
1182
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1018
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1019
            " %(branch)s%(extra)s")
1184
1020
 
1185
1021
    def __init__(self, spec, branch, extra=None):
1210
1046
class DivergedBranches(BzrError):
1211
1047
 
1212
1048
    _fmt = ("These branches have diverged."
1213
 
            " Use the missing command to see how.\n"
1214
 
            "Use the merge command to reconcile them.")
 
1049
            " Use the merge command to reconcile them.")
 
1050
 
 
1051
    internal_error = False
1215
1052
 
1216
1053
    def __init__(self, branch1, branch2):
1217
1054
        self.branch1 = branch1
1218
1055
        self.branch2 = branch2
1219
1056
 
1220
1057
 
1221
 
class NotLefthandHistory(InternalBzrError):
 
1058
class NotLefthandHistory(BzrError):
1222
1059
 
1223
1060
    _fmt = "Supplied history does not follow left-hand parents"
1224
1061
 
 
1062
    internal_error = True
 
1063
 
1225
1064
    def __init__(self, history):
1226
1065
        BzrError.__init__(self, history=history)
1227
1066
 
1231
1070
    _fmt = ("Branches have no common ancestor, and"
1232
1071
            " no merge base revision was specified.")
1233
1072
 
1234
 
 
1235
 
class CannotReverseCherrypick(BzrError):
1236
 
 
1237
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1238
 
            ' or diff3.')
 
1073
    internal_error = False
1239
1074
 
1240
1075
 
1241
1076
class NoCommonAncestor(BzrError):
1242
 
 
 
1077
    
1243
1078
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1244
1079
 
1245
1080
    def __init__(self, revision_a, revision_b):
1265
1100
            not_ancestor_id=not_ancestor_id)
1266
1101
 
1267
1102
 
 
1103
class InstallFailed(BzrError):
 
1104
 
 
1105
    def __init__(self, revisions):
 
1106
        revision_str = ", ".join(str(r) for r in revisions)
 
1107
        msg = "Could not install revisions:\n%s" % revision_str
 
1108
        BzrError.__init__(self, msg)
 
1109
        self.revisions = revisions
 
1110
 
 
1111
 
1268
1112
class AmbiguousBase(BzrError):
1269
1113
 
1270
1114
    def __init__(self, bases):
1271
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1115
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1116
                DeprecationWarning)
1273
1117
        msg = ("The correct base is unclear, because %s are all equally close"
1274
1118
                % ", ".join(bases))
1275
1119
        BzrError.__init__(self, msg)
1276
1120
        self.bases = bases
1277
1121
 
1278
1122
 
1279
 
class NoCommits(BranchError):
 
1123
class NoCommits(BzrError):
1280
1124
 
1281
1125
    _fmt = "Branch %(branch)s has no commits."
1282
1126
 
 
1127
    def __init__(self, branch):
 
1128
        BzrError.__init__(self, branch=branch)
 
1129
 
1283
1130
 
1284
1131
class UnlistableStore(BzrError):
1285
1132
 
1296
1143
 
1297
1144
class BoundBranchOutOfDate(BzrError):
1298
1145
 
1299
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
 
            " %(master)s.%(extra_help)s")
 
1146
    _fmt = ("Bound branch %(branch)s is out of date"
 
1147
            " with master branch %(master)s.")
1301
1148
 
1302
1149
    def __init__(self, branch, master):
1303
1150
        BzrError.__init__(self)
1304
1151
        self.branch = branch
1305
1152
        self.master = master
1306
 
        self.extra_help = ''
1307
 
 
1308
 
 
 
1153
 
 
1154
        
1309
1155
class CommitToDoubleBoundBranch(BzrError):
1310
1156
 
1311
1157
    _fmt = ("Cannot commit to branch %(branch)s."
1341
1187
 
1342
1188
class WeaveError(BzrError):
1343
1189
 
1344
 
    _fmt = "Error in processing weave: %(msg)s"
 
1190
    _fmt = "Error in processing weave: %(message)s"
1345
1191
 
1346
 
    def __init__(self, msg=None):
 
1192
    def __init__(self, message=None):
1347
1193
        BzrError.__init__(self)
1348
 
        self.msg = msg
 
1194
        self.message = message
1349
1195
 
1350
1196
 
1351
1197
class WeaveRevisionAlreadyPresent(WeaveError):
1380
1226
 
1381
1227
class WeaveParentMismatch(WeaveError):
1382
1228
 
1383
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1384
 
 
 
1229
    _fmt = "Parents are mismatched between two revisions."
 
1230
    
1385
1231
 
1386
1232
class WeaveInvalidChecksum(WeaveError):
1387
1233
 
1413
1259
 
1414
1260
 
1415
1261
class VersionedFileError(BzrError):
1416
 
 
 
1262
    
1417
1263
    _fmt = "Versioned file error"
1418
1264
 
1419
1265
 
1420
1266
class RevisionNotPresent(VersionedFileError):
1421
 
 
1422
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1267
    
 
1268
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1423
1269
 
1424
1270
    def __init__(self, revision_id, file_id):
1425
1271
        VersionedFileError.__init__(self)
1428
1274
 
1429
1275
 
1430
1276
class RevisionAlreadyPresent(VersionedFileError):
1431
 
 
1432
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1277
    
 
1278
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1433
1279
 
1434
1280
    def __init__(self, revision_id, file_id):
1435
1281
        VersionedFileError.__init__(self)
1442
1288
    _fmt = "Text did not match its checksum: %(message)s"
1443
1289
 
1444
1290
 
1445
 
class KnitError(InternalBzrError):
1446
 
 
 
1291
class KnitError(BzrError):
 
1292
    
1447
1293
    _fmt = "Knit error"
1448
1294
 
 
1295
    internal_error = True
 
1296
 
 
1297
 
 
1298
class KnitHeaderError(KnitError):
 
1299
 
 
1300
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1301
 
 
1302
    def __init__(self, badline, filename):
 
1303
        KnitError.__init__(self)
 
1304
        self.badline = badline
 
1305
        self.filename = filename
 
1306
 
1449
1307
 
1450
1308
class KnitCorrupt(KnitError):
1451
1309
 
1457
1315
        self.how = how
1458
1316
 
1459
1317
 
1460
 
class SHA1KnitCorrupt(KnitCorrupt):
1461
 
 
1462
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1463
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1464
 
        "sha %(actual)s")
1465
 
 
1466
 
    def __init__(self, filename, actual, expected, key, content):
1467
 
        KnitError.__init__(self)
1468
 
        self.filename = filename
1469
 
        self.actual = actual
1470
 
        self.expected = expected
1471
 
        self.key = key
1472
 
        self.content = content
1473
 
 
1474
 
 
1475
 
class KnitDataStreamIncompatible(KnitError):
1476
 
    # Not raised anymore, as we can convert data streams.  In future we may
1477
 
    # need it again for more exotic cases, so we're keeping it around for now.
1478
 
 
1479
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1480
 
 
1481
 
    def __init__(self, stream_format, target_format):
1482
 
        self.stream_format = stream_format
1483
 
        self.target_format = target_format
1484
 
 
1485
 
 
1486
 
class KnitDataStreamUnknown(KnitError):
1487
 
    # Indicates a data stream we don't know how to handle.
1488
 
 
1489
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1490
 
 
1491
 
    def __init__(self, stream_format):
1492
 
        self.stream_format = stream_format
1493
 
 
1494
 
 
1495
 
class KnitHeaderError(KnitError):
1496
 
 
1497
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1498
 
 
1499
 
    def __init__(self, badline, filename):
1500
 
        KnitError.__init__(self)
1501
 
        self.badline = badline
1502
 
        self.filename = filename
1503
 
 
1504
1318
class KnitIndexUnknownMethod(KnitError):
1505
1319
    """Raised when we don't understand the storage method.
1506
1320
 
1507
1321
    Currently only 'fulltext' and 'line-delta' are supported.
1508
1322
    """
1509
 
 
 
1323
    
1510
1324
    _fmt = ("Knit index %(filename)s does not have a known method"
1511
1325
            " in options: %(options)r")
1512
1326
 
1516
1330
        self.options = options
1517
1331
 
1518
1332
 
1519
 
class RetryWithNewPacks(BzrError):
1520
 
    """Raised when we realize that the packs on disk have changed.
1521
 
 
1522
 
    This is meant as more of a signaling exception, to trap between where a
1523
 
    local error occurred and the code that can actually handle the error and
1524
 
    code that can retry appropriately.
1525
 
    """
1526
 
 
1527
 
    internal_error = True
1528
 
 
1529
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1530
 
            " %(orig_error)s")
1531
 
 
1532
 
    def __init__(self, context, reload_occurred, exc_info):
1533
 
        """create a new RetryWithNewPacks error.
1534
 
 
1535
 
        :param reload_occurred: Set to True if we know that the packs have
1536
 
            already been reloaded, and we are failing because of an in-memory
1537
 
            cache miss. If set to True then we will ignore if a reload says
1538
 
            nothing has changed, because we assume it has already reloaded. If
1539
 
            False, then a reload with nothing changed will force an error.
1540
 
        :param exc_info: The original exception traceback, so if there is a
1541
 
            problem we can raise the original error (value from sys.exc_info())
1542
 
        """
1543
 
        BzrError.__init__(self)
1544
 
        self.reload_occurred = reload_occurred
1545
 
        self.exc_info = exc_info
1546
 
        self.orig_error = exc_info[1]
1547
 
        # TODO: The global error handler should probably treat this by
1548
 
        #       raising/printing the original exception with a bit about
1549
 
        #       RetryWithNewPacks also not being caught
1550
 
 
1551
 
 
1552
 
class RetryAutopack(RetryWithNewPacks):
1553
 
    """Raised when we are autopacking and we find a missing file.
1554
 
 
1555
 
    Meant as a signaling exception, to tell the autopack code it should try
1556
 
    again.
1557
 
    """
1558
 
 
1559
 
    internal_error = True
1560
 
 
1561
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1562
 
            " context: %(context)s %(orig_error)s")
1563
 
 
1564
 
 
1565
1333
class NoSuchExportFormat(BzrError):
1566
 
 
 
1334
    
1567
1335
    _fmt = "Export format %(format)r not supported"
1568
1336
 
1569
1337
    def __init__(self, format):
1572
1340
 
1573
1341
 
1574
1342
class TransportError(BzrError):
1575
 
 
 
1343
    
1576
1344
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1577
1345
 
1578
1346
    def __init__(self, msg=None, orig_error=None):
1587
1355
        BzrError.__init__(self)
1588
1356
 
1589
1357
 
1590
 
class TooManyConcurrentRequests(InternalBzrError):
 
1358
class TooManyConcurrentRequests(BzrError):
1591
1359
 
1592
1360
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1593
1361
            " Be sure to finish_writing and finish_reading on the"
1594
1362
            " currently open request.")
1595
1363
 
 
1364
    internal_error = True
 
1365
 
1596
1366
    def __init__(self, medium):
1597
1367
        self.medium = medium
1598
1368
 
1605
1375
        self.details = details
1606
1376
 
1607
1377
 
1608
 
class UnexpectedProtocolVersionMarker(TransportError):
1609
 
 
1610
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1611
 
 
1612
 
    def __init__(self, marker):
1613
 
        self.marker = marker
1614
 
 
1615
 
 
1616
 
class UnknownSmartMethod(InternalBzrError):
1617
 
 
1618
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1619
 
 
1620
 
    def __init__(self, verb):
1621
 
        self.verb = verb
1622
 
 
1623
 
 
1624
 
class SmartMessageHandlerError(InternalBzrError):
1625
 
 
1626
 
    _fmt = ("The message handler raised an exception:\n"
1627
 
            "%(traceback_text)s")
1628
 
 
1629
 
    def __init__(self, exc_info):
1630
 
        import traceback
1631
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1632
 
        self.exc_info = exc_info
1633
 
        traceback_strings = traceback.format_exception(
1634
 
                self.exc_type, self.exc_value, self.exc_tb)
1635
 
        self.traceback_text = ''.join(traceback_strings)
1636
 
 
1637
 
 
1638
1378
# A set of semi-meaningful errors which can be thrown
1639
1379
class TransportNotPossible(TransportError):
1640
1380
 
1665
1405
            self.port = ':%s' % port
1666
1406
 
1667
1407
 
1668
 
# XXX: This is also used for unexpected end of file, which is different at the
1669
 
# TCP level from "connection reset".
1670
1408
class ConnectionReset(TransportError):
1671
1409
 
1672
1410
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1674
1412
 
1675
1413
class InvalidRange(TransportError):
1676
1414
 
1677
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1678
 
 
1679
 
    def __init__(self, path, offset, msg=None):
1680
 
        TransportError.__init__(self, msg)
 
1415
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1416
    
 
1417
    def __init__(self, path, offset):
 
1418
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1419
                                       % (path, offset)))
1681
1420
        self.path = path
1682
1421
        self.offset = offset
1683
1422
 
1694
1433
class InvalidHttpRange(InvalidHttpResponse):
1695
1434
 
1696
1435
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1697
 
 
 
1436
    
1698
1437
    def __init__(self, path, range, msg):
1699
1438
        self.range = range
1700
1439
        InvalidHttpResponse.__init__(self, path, msg)
1703
1442
class InvalidHttpContentType(InvalidHttpResponse):
1704
1443
 
1705
1444
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1706
 
 
 
1445
    
1707
1446
    def __init__(self, path, ctype, msg):
1708
1447
        self.ctype = ctype
1709
1448
        InvalidHttpResponse.__init__(self, path, msg)
1713
1452
 
1714
1453
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1715
1454
 
1716
 
    def __init__(self, source, target, is_permanent=False):
 
1455
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1717
1456
        self.source = source
1718
1457
        self.target = target
1719
 
        if is_permanent:
 
1458
        if is_permament:
1720
1459
            self.permanently = ' permanently'
1721
1460
        else:
1722
1461
            self.permanently = ''
 
1462
        self.is_permament = is_permament
 
1463
        self._qualified_proto = qual_proto
1723
1464
        TransportError.__init__(self)
1724
1465
 
 
1466
    def _requalify_url(self, url):
 
1467
        """Restore the qualified proto in front of the url"""
 
1468
        # When this exception is raised, source and target are in
 
1469
        # user readable format. But some transports may use a
 
1470
        # different proto (http+urllib:// will present http:// to
 
1471
        # the user. If a qualified proto is specified, the code
 
1472
        # trapping the exception can get the qualified urls to
 
1473
        # properly handle the redirection themself (creating a
 
1474
        # new transport object from the target url for example).
 
1475
        # But checking that the scheme of the original and
 
1476
        # redirected urls are the same can be tricky. (see the
 
1477
        # FIXME in BzrDir.open_from_transport for the unique use
 
1478
        # case so far).
 
1479
        if self._qualified_proto is None:
 
1480
            return url
 
1481
 
 
1482
        # The TODO related to NotBranchError mention that doing
 
1483
        # that kind of manipulation on the urls may not be the
 
1484
        # exception object job. On the other hand, this object is
 
1485
        # the interface between the code and the user so
 
1486
        # presenting the urls in different ways is indeed its
 
1487
        # job...
 
1488
        import urlparse
 
1489
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1490
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1491
                                   query, fragment))
 
1492
 
 
1493
    def get_source_url(self):
 
1494
        return self._requalify_url(self.source)
 
1495
 
 
1496
    def get_target_url(self):
 
1497
        return self._requalify_url(self.target)
 
1498
 
1725
1499
 
1726
1500
class TooManyRedirections(TransportError):
1727
1501
 
1728
1502
    _fmt = "Too many redirections"
1729
1503
 
1730
 
 
1731
1504
class ConflictsInTree(BzrError):
1732
1505
 
1733
1506
    _fmt = "Working tree has conflicts."
1739
1512
        if filename is None:
1740
1513
            filename = ""
1741
1514
        message = "Error(s) parsing config file %s:\n%s" % \
1742
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1515
            (filename, ('\n'.join(e.message for e in errors)))
1743
1516
        BzrError.__init__(self, message)
1744
1517
 
1745
1518
 
1754
1527
 
1755
1528
class SigningFailed(BzrError):
1756
1529
 
1757
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1530
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1758
1531
 
1759
1532
    def __init__(self, command_line):
1760
1533
        BzrError.__init__(self, command_line=command_line)
1762
1535
 
1763
1536
class WorkingTreeNotRevision(BzrError):
1764
1537
 
1765
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1538
    _fmt = ("The working tree for %(basedir)s has changed since" 
1766
1539
            " the last commit, but weave merge requires that it be"
1767
1540
            " unchanged")
1768
1541
 
1785
1558
        self.graph = graph
1786
1559
 
1787
1560
 
1788
 
class WritingCompleted(InternalBzrError):
 
1561
class WritingCompleted(BzrError):
1789
1562
 
1790
1563
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1791
1564
            "called upon it - accept bytes may not be called anymore.")
1792
1565
 
 
1566
    internal_error = True
 
1567
 
1793
1568
    def __init__(self, request):
1794
1569
        self.request = request
1795
1570
 
1796
1571
 
1797
 
class WritingNotComplete(InternalBzrError):
 
1572
class WritingNotComplete(BzrError):
1798
1573
 
1799
1574
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1800
1575
            "called upon it - until the write phase is complete no "
1801
1576
            "data may be read.")
1802
1577
 
 
1578
    internal_error = True
 
1579
 
1803
1580
    def __init__(self, request):
1804
1581
        self.request = request
1805
1582
 
1813
1590
        self.filename = filename
1814
1591
 
1815
1592
 
1816
 
class MediumNotConnected(InternalBzrError):
 
1593
class MediumNotConnected(BzrError):
1817
1594
 
1818
1595
    _fmt = """The medium '%(medium)s' is not connected."""
1819
1596
 
 
1597
    internal_error = True
 
1598
 
1820
1599
    def __init__(self, medium):
1821
1600
        self.medium = medium
1822
1601
 
1828
1607
 
1829
1608
class NoBundleFound(BzrError):
1830
1609
 
1831
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1610
    _fmt = "No bundle was found in %(filename)s"
1832
1611
 
1833
1612
    def __init__(self, filename):
1834
1613
        BzrError.__init__(self)
1857
1636
        self.text_revision = text_revision
1858
1637
        self.file_id = file_id
1859
1638
 
1860
 
 
1861
1639
class DuplicateFileId(BzrError):
1862
1640
 
1863
1641
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1898
1676
        self.root_trans_id = transform.root
1899
1677
 
1900
1678
 
1901
 
class BzrBadParameter(InternalBzrError):
 
1679
class BzrBadParameter(BzrError):
1902
1680
 
1903
1681
    _fmt = "Bad parameter: %(param)r"
1904
1682
 
 
1683
    internal_error = True
 
1684
 
1905
1685
    # This exception should never be thrown, but it is a base class for all
1906
1686
    # parameter-to-function errors.
1907
1687
 
1930
1710
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1931
1711
 
1932
1712
    def __init__(self, from_path='', to_path='', extra=None):
1933
 
        from bzrlib.osutils import splitpath
1934
1713
        BzrError.__init__(self)
1935
1714
        if extra:
1936
1715
            self.extra = ': ' + str(extra)
1940
1719
        has_from = len(from_path) > 0
1941
1720
        has_to = len(to_path) > 0
1942
1721
        if has_from:
1943
 
            self.from_path = splitpath(from_path)[-1]
 
1722
            self.from_path = osutils.splitpath(from_path)[-1]
1944
1723
        else:
1945
1724
            self.from_path = ''
1946
1725
 
1947
1726
        if has_to:
1948
 
            self.to_path = splitpath(to_path)[-1]
 
1727
            self.to_path = osutils.splitpath(to_path)[-1]
1949
1728
        else:
1950
1729
            self.to_path = ''
1951
1730
 
1970
1749
class BzrRemoveChangedFilesError(BzrError):
1971
1750
    """Used when user is trying to remove changed files."""
1972
1751
 
1973
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1974
 
        "%(changes_as_text)s"
 
1752
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
1975
1753
        "Use --keep to not delete them, or --force to delete them regardless.")
1976
1754
 
1977
1755
    def __init__(self, tree_delta):
2034
1812
 
2035
1813
class BadConversionTarget(BzrError):
2036
1814
 
2037
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2038
 
            "    %(problem)s"
 
1815
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2039
1816
 
2040
 
    def __init__(self, problem, format, from_format=None):
 
1817
    def __init__(self, problem, format):
2041
1818
        BzrError.__init__(self)
2042
1819
        self.problem = problem
2043
1820
        self.format = format
2044
 
        self.from_format = from_format or '(unspecified)'
2045
 
 
2046
 
 
2047
 
class NoDiffFound(BzrError):
2048
 
 
2049
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2050
 
 
2051
 
    def __init__(self, path):
2052
 
        BzrError.__init__(self, path)
2053
 
 
2054
 
 
2055
 
class ExecutableMissing(BzrError):
2056
 
 
2057
 
    _fmt = "%(exe_name)s could not be found on this machine"
2058
 
 
2059
 
    def __init__(self, exe_name):
2060
 
        BzrError.__init__(self, exe_name=exe_name)
2061
1821
 
2062
1822
 
2063
1823
class NoDiff(BzrError):
2073
1833
    _fmt = "Diff3 is not installed on this machine."
2074
1834
 
2075
1835
 
2076
 
class ExistingContent(BzrError):
2077
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2078
 
 
2079
 
    _fmt = "The content being inserted is already present."
2080
 
 
2081
 
 
2082
1836
class ExistingLimbo(BzrError):
2083
1837
 
2084
1838
    _fmt = """This tree contains left-over files from a failed operation.
2085
1839
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2086
1840
    keep, and delete it when you are done."""
2087
 
 
 
1841
    
2088
1842
    def __init__(self, limbo_dir):
2089
1843
       BzrError.__init__(self)
2090
1844
       self.limbo_dir = limbo_dir
2091
1845
 
2092
1846
 
2093
 
class ExistingPendingDeletion(BzrError):
2094
 
 
2095
 
    _fmt = """This tree contains left-over files from a failed operation.
2096
 
    Please examine %(pending_deletion)s to see if it contains any files you
2097
 
    wish to keep, and delete it when you are done."""
2098
 
 
2099
 
    def __init__(self, pending_deletion):
2100
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2101
 
 
2102
 
 
2103
1847
class ImmortalLimbo(BzrError):
2104
1848
 
2105
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1849
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2106
1850
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2107
1851
    keep, and delete it when you are done."""
2108
1852
 
2111
1855
       self.limbo_dir = limbo_dir
2112
1856
 
2113
1857
 
2114
 
class ImmortalPendingDeletion(BzrError):
2115
 
 
2116
 
    _fmt = ("Unable to delete transform temporary directory "
2117
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2118
 
    "contains any files you wish to keep, and delete it when you are done.")
2119
 
 
2120
 
    def __init__(self, pending_deletion):
2121
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2122
 
 
2123
 
 
2124
1858
class OutOfDateTree(BzrError):
2125
1859
 
2126
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1860
    _fmt = "Working tree is out of date, please run 'bzr update'."
2127
1861
 
2128
 
    def __init__(self, tree, more=None):
2129
 
        if more is None:
2130
 
            more = ''
2131
 
        else:
2132
 
            more = ' ' + more
 
1862
    def __init__(self, tree):
2133
1863
        BzrError.__init__(self)
2134
1864
        self.tree = tree
2135
 
        self.more = more
2136
1865
 
2137
1866
 
2138
1867
class PublicBranchOutOfDate(BzrError):
2158
1887
    _fmt = "Format error in conflict listings"
2159
1888
 
2160
1889
 
2161
 
class CorruptDirstate(BzrError):
2162
 
 
2163
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2164
 
            "Error: %(description)s")
2165
 
 
2166
 
    def __init__(self, dirstate_path, description):
2167
 
        BzrError.__init__(self)
2168
 
        self.dirstate_path = dirstate_path
2169
 
        self.description = description
2170
 
 
2171
 
 
2172
1890
class CorruptRepository(BzrError):
2173
1891
 
2174
1892
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2176
1894
 
2177
1895
    def __init__(self, repo):
2178
1896
        BzrError.__init__(self)
2179
 
        self.repo_path = repo.user_url
2180
 
 
2181
 
 
2182
 
class InconsistentDelta(BzrError):
2183
 
    """Used when we get a delta that is not valid."""
2184
 
 
2185
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2186
 
            " %(file_id)r\nreason: %(reason)s")
2187
 
 
2188
 
    def __init__(self, path, file_id, reason):
2189
 
        BzrError.__init__(self)
2190
 
        self.path = path
2191
 
        self.file_id = file_id
2192
 
        self.reason = reason
2193
 
 
2194
 
 
2195
 
class InconsistentDeltaDelta(InconsistentDelta):
2196
 
    """Used when we get a delta that is not valid."""
2197
 
 
2198
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2199
 
            "\nreason: %(reason)s")
2200
 
 
2201
 
    def __init__(self, delta, reason):
2202
 
        BzrError.__init__(self)
2203
 
        self.delta = delta
2204
 
        self.reason = reason
 
1897
        self.repo_path = repo.bzrdir.root_transport.base
2205
1898
 
2206
1899
 
2207
1900
class UpgradeRequired(BzrError):
2213
1906
        self.path = path
2214
1907
 
2215
1908
 
2216
 
class RepositoryUpgradeRequired(UpgradeRequired):
2217
 
 
2218
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2219
 
 
2220
 
 
2221
 
class RichRootUpgradeRequired(UpgradeRequired):
2222
 
 
2223
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2224
 
           " a format which supports rich roots.")
2225
 
 
2226
 
 
2227
1909
class LocalRequiresBoundBranch(BzrError):
2228
1910
 
2229
1911
    _fmt = "Cannot perform local-only commits on unbound branches."
2230
1912
 
2231
1913
 
 
1914
class MissingProgressBarFinish(BzrError):
 
1915
 
 
1916
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1917
 
 
1918
 
 
1919
class InvalidProgressBarType(BzrError):
 
1920
 
 
1921
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1922
            " is not a supported type Select one of: %(valid_types)s")
 
1923
 
 
1924
    def __init__(self, bar_type, valid_types):
 
1925
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1926
 
 
1927
 
2232
1928
class UnsupportedOperation(BzrError):
2233
1929
 
2234
1930
    _fmt = ("The method %(mname)s is not supported on"
2251
1947
 
2252
1948
 
2253
1949
class BinaryFile(BzrError):
2254
 
 
 
1950
    
2255
1951
    _fmt = "File is binary but should be text."
2256
1952
 
2257
1953
 
2277
1973
 
2278
1974
 
2279
1975
class NotABundle(BzrError):
2280
 
 
 
1976
    
2281
1977
    _fmt = "Not a bzr revision-bundle: %(text)r"
2282
1978
 
2283
1979
    def __init__(self, text):
2285
1981
        self.text = text
2286
1982
 
2287
1983
 
2288
 
class BadBundle(BzrError):
2289
 
 
 
1984
class BadBundle(BzrError): 
 
1985
    
2290
1986
    _fmt = "Bad bzr revision-bundle: %(text)r"
2291
1987
 
2292
1988
    def __init__(self, text):
2294
1990
        self.text = text
2295
1991
 
2296
1992
 
2297
 
class MalformedHeader(BadBundle):
2298
 
 
 
1993
class MalformedHeader(BadBundle): 
 
1994
    
2299
1995
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2300
1996
 
2301
1997
 
2302
 
class MalformedPatches(BadBundle):
2303
 
 
 
1998
class MalformedPatches(BadBundle): 
 
1999
    
2304
2000
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2305
2001
 
2306
2002
 
2307
 
class MalformedFooter(BadBundle):
2308
 
 
 
2003
class MalformedFooter(BadBundle): 
 
2004
    
2309
2005
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2310
2006
 
2311
2007
 
2312
2008
class UnsupportedEOLMarker(BadBundle):
2313
 
 
2314
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2009
    
 
2010
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2315
2011
 
2316
2012
    def __init__(self):
2317
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2013
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2318
2014
        # but for this there is not
2319
2015
        BzrError.__init__(self)
2320
2016
 
2321
2017
 
2322
2018
class IncompatibleBundleFormat(BzrError):
2323
 
 
 
2019
    
2324
2020
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2325
2021
 
2326
2022
    def __init__(self, bundle_format, other):
2330
2026
 
2331
2027
 
2332
2028
class BadInventoryFormat(BzrError):
2333
 
 
 
2029
    
2334
2030
    _fmt = "Root class for inventory serialization errors"
2335
2031
 
2336
2032
 
2347
2043
    _fmt = """This operation requires rich root data storage"""
2348
2044
 
2349
2045
 
2350
 
class NoSmartMedium(InternalBzrError):
 
2046
class NoSmartMedium(BzrError):
2351
2047
 
2352
2048
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2353
2049
 
 
2050
    internal_error = True
 
2051
 
2354
2052
    def __init__(self, transport):
2355
2053
        self.transport = transport
2356
2054
 
2357
2055
 
 
2056
class NoSmartServer(NotBranchError):
 
2057
 
 
2058
    _fmt = "No smart server available at %(url)s"
 
2059
 
 
2060
    def __init__(self, url):
 
2061
        self.url = url
 
2062
 
 
2063
 
2358
2064
class UnknownSSH(BzrError):
2359
2065
 
2360
2066
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2370
2076
            " Please set BZR_SSH environment variable.")
2371
2077
 
2372
2078
 
2373
 
class GhostRevisionsHaveNoRevno(BzrError):
2374
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2375
 
 
2376
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2377
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2378
 
 
2379
 
    def __init__(self, revision_id, ghost_revision_id):
2380
 
        self.revision_id = revision_id
2381
 
        self.ghost_revision_id = ghost_revision_id
2382
 
 
2383
 
 
2384
2079
class GhostRevisionUnusableHere(BzrError):
2385
2080
 
2386
2081
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2390
2085
        self.revision_id = revision_id
2391
2086
 
2392
2087
 
2393
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2088
class IllegalUseOfScopeReplacer(BzrError):
2394
2089
 
2395
2090
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2396
2091
            " %(msg)s%(extra)s")
2397
2092
 
 
2093
    internal_error = True
 
2094
 
2398
2095
    def __init__(self, name, msg, extra=None):
2399
2096
        BzrError.__init__(self)
2400
2097
        self.name = name
2405
2102
            self.extra = ''
2406
2103
 
2407
2104
 
2408
 
class InvalidImportLine(InternalBzrError):
 
2105
class InvalidImportLine(BzrError):
2409
2106
 
2410
2107
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2411
2108
 
 
2109
    internal_error = True
 
2110
 
2412
2111
    def __init__(self, text, msg):
2413
2112
        BzrError.__init__(self)
2414
2113
        self.text = text
2415
2114
        self.msg = msg
2416
2115
 
2417
2116
 
2418
 
class ImportNameCollision(InternalBzrError):
 
2117
class ImportNameCollision(BzrError):
2419
2118
 
2420
2119
    _fmt = ("Tried to import an object to the same name as"
2421
2120
            " an existing object. %(name)s")
2422
2121
 
 
2122
    internal_error = True
 
2123
 
2423
2124
    def __init__(self, name):
2424
2125
        BzrError.__init__(self)
2425
2126
        self.name = name
2457
2158
class PatchMissing(BzrError):
2458
2159
    """Raise a patch type was specified but no patch supplied"""
2459
2160
 
2460
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2161
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2461
2162
 
2462
2163
    def __init__(self, patch_type):
2463
2164
        BzrError.__init__(self)
2464
2165
        self.patch_type = patch_type
2465
2166
 
2466
2167
 
2467
 
class TargetNotBranch(BzrError):
2468
 
    """A merge directive's target branch is required, but isn't a branch"""
2469
 
 
2470
 
    _fmt = ("Your branch does not have all of the revisions required in "
2471
 
            "order to merge this merge directive and the target "
2472
 
            "location specified in the merge directive is not a branch: "
2473
 
            "%(location)s.")
2474
 
 
2475
 
    def __init__(self, location):
2476
 
        BzrError.__init__(self)
2477
 
        self.location = location
2478
 
 
2479
 
 
2480
2168
class UnsupportedInventoryKind(BzrError):
2481
 
 
 
2169
    
2482
2170
    _fmt = """Unsupported entry kind %(kind)s"""
2483
2171
 
2484
2172
    def __init__(self, kind):
2487
2175
 
2488
2176
class BadSubsumeSource(BzrError):
2489
2177
 
2490
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2178
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2491
2179
 
2492
2180
    def __init__(self, tree, other_tree, reason):
2493
2181
        self.tree = tree
2496
2184
 
2497
2185
 
2498
2186
class SubsumeTargetNeedsUpgrade(BzrError):
2499
 
 
 
2187
    
2500
2188
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2501
2189
 
2502
2190
    def __init__(self, other_tree):
2503
2191
        self.other_tree = other_tree
2504
2192
 
2505
2193
 
2506
 
class BadReferenceTarget(InternalBzrError):
2507
 
 
2508
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2509
 
           "%(reason)s"
 
2194
class BadReferenceTarget(BzrError):
 
2195
 
 
2196
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2197
 
 
2198
    internal_error = True
2510
2199
 
2511
2200
    def __init__(self, tree, other_tree, reason):
2512
2201
        self.tree = tree
2525
2214
class TagsNotSupported(BzrError):
2526
2215
 
2527
2216
    _fmt = ("Tags not supported by %(branch)s;"
2528
 
            " you may be able to use bzr upgrade.")
 
2217
            " you may be able to use bzr upgrade --dirstate-tags.")
2529
2218
 
2530
2219
    def __init__(self, branch):
2531
2220
        self.branch = branch
2532
2221
 
2533
 
 
 
2222
        
2534
2223
class TagAlreadyExists(BzrError):
2535
2224
 
2536
2225
    _fmt = "Tag %(tag_name)s already exists."
2541
2230
 
2542
2231
class MalformedBugIdentifier(BzrError):
2543
2232
 
2544
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2545
 
            'See "bzr help bugs" for more information on this feature.')
 
2233
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2546
2234
 
2547
2235
    def __init__(self, bug_id, reason):
2548
2236
        self.bug_id = bug_id
2549
2237
        self.reason = reason
2550
2238
 
2551
2239
 
2552
 
class InvalidBugTrackerURL(BzrError):
2553
 
 
2554
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2555
 
            "contain {id}: %(url)s")
2556
 
 
2557
 
    def __init__(self, abbreviation, url):
2558
 
        self.abbreviation = abbreviation
2559
 
        self.url = url
2560
 
 
2561
 
 
2562
2240
class UnknownBugTrackerAbbreviation(BzrError):
2563
2241
 
2564
2242
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2569
2247
        self.branch = branch
2570
2248
 
2571
2249
 
2572
 
class InvalidLineInBugsProperty(BzrError):
2573
 
 
2574
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2575
 
 
2576
 
    def __init__(self, line):
2577
 
        self.line = line
2578
 
 
2579
 
 
2580
 
class InvalidBugStatus(BzrError):
2581
 
 
2582
 
    _fmt = ("Invalid bug status: '%(status)s'")
2583
 
 
2584
 
    def __init__(self, status):
2585
 
        self.status = status
2586
 
 
2587
 
 
2588
2250
class UnexpectedSmartServerResponse(BzrError):
2589
2251
 
2590
2252
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2593
2255
        self.response_tuple = response_tuple
2594
2256
 
2595
2257
 
2596
 
class ErrorFromSmartServer(BzrError):
2597
 
    """An error was received from a smart server.
2598
 
 
2599
 
    :seealso: UnknownErrorFromSmartServer
2600
 
    """
2601
 
 
2602
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2603
 
 
2604
 
    internal_error = True
2605
 
 
2606
 
    def __init__(self, error_tuple):
2607
 
        self.error_tuple = error_tuple
2608
 
        try:
2609
 
            self.error_verb = error_tuple[0]
2610
 
        except IndexError:
2611
 
            self.error_verb = None
2612
 
        self.error_args = error_tuple[1:]
2613
 
 
2614
 
 
2615
 
class UnknownErrorFromSmartServer(BzrError):
2616
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2617
 
    error.
2618
 
 
2619
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2620
 
    distinguish between the following two cases:
2621
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2622
 
        and so should provoke a traceback to the user.
2623
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2624
 
        translated.  This is probably because the server sent us garbage, and
2625
 
        should not provoke a traceback.
2626
 
    """
2627
 
 
2628
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2629
 
 
2630
 
    internal_error = False
2631
 
 
2632
 
    def __init__(self, error_from_smart_server):
2633
 
        """Constructor.
2634
 
 
2635
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2636
 
        """
2637
 
        self.error_from_smart_server = error_from_smart_server
2638
 
        self.error_tuple = error_from_smart_server.error_tuple
2639
 
 
2640
 
 
2641
2258
class ContainerError(BzrError):
2642
2259
    """Base class of container errors."""
2643
2260
 
2645
2262
class UnknownContainerFormatError(ContainerError):
2646
2263
 
2647
2264
    _fmt = "Unrecognised container format: %(container_format)r"
2648
 
 
 
2265
    
2649
2266
    def __init__(self, container_format):
2650
2267
        self.container_format = container_format
2651
2268
 
2654
2271
 
2655
2272
    _fmt = "Unexpected end of container stream"
2656
2273
 
 
2274
    internal_error = False
 
2275
 
2657
2276
 
2658
2277
class UnknownRecordTypeError(ContainerError):
2659
2278
 
2681
2300
 
2682
2301
class DuplicateRecordNameError(ContainerError):
2683
2302
 
2684
 
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2303
    _fmt = "Container has multiple records with the same name: \"%(name)s\""
2685
2304
 
2686
2305
    def __init__(self, name):
2687
2306
        self.name = name
2688
2307
 
2689
2308
 
2690
 
class NoDestinationAddress(InternalBzrError):
 
2309
class NoDestinationAddress(BzrError):
2691
2310
 
2692
2311
    _fmt = "Message does not have a destination address."
2693
2312
 
2694
 
 
2695
 
class RepositoryDataStreamError(BzrError):
2696
 
 
2697
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2698
 
 
2699
 
    def __init__(self, reason):
2700
 
        self.reason = reason
 
2313
    internal_error = True
2701
2314
 
2702
2315
 
2703
2316
class SMTPError(BzrError):
2713
2326
    _fmt = "No message supplied."
2714
2327
 
2715
2328
 
2716
 
class NoMailAddressSpecified(BzrError):
2717
 
 
2718
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2719
 
 
2720
 
 
2721
2329
class UnknownMailClient(BzrError):
2722
2330
 
2723
2331
    _fmt = "Unknown mail client: %(mail_client)s"
2748
2356
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2749
2357
 
2750
2358
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2751
 
 
2752
 
 
2753
 
class BzrDirError(BzrError):
2754
 
 
2755
 
    def __init__(self, bzrdir):
2756
 
        import bzrlib.urlutils as urlutils
2757
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2758
 
                                                    'ascii')
2759
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2760
 
 
2761
 
 
2762
 
class UnsyncedBranches(BzrDirError):
2763
 
 
2764
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2765
 
            " bzr help sync-for-reconfigure.")
2766
 
 
2767
 
    def __init__(self, bzrdir, target_branch):
2768
 
        BzrDirError.__init__(self, bzrdir)
2769
 
        import bzrlib.urlutils as urlutils
2770
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2771
 
                                                        'ascii')
2772
 
 
2773
 
 
2774
 
class AlreadyBranch(BzrDirError):
2775
 
 
2776
 
    _fmt = "'%(display_url)s' is already a branch."
2777
 
 
2778
 
 
2779
 
class AlreadyTree(BzrDirError):
2780
 
 
2781
 
    _fmt = "'%(display_url)s' is already a tree."
2782
 
 
2783
 
 
2784
 
class AlreadyCheckout(BzrDirError):
2785
 
 
2786
 
    _fmt = "'%(display_url)s' is already a checkout."
2787
 
 
2788
 
 
2789
 
class AlreadyLightweightCheckout(BzrDirError):
2790
 
 
2791
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2792
 
 
2793
 
 
2794
 
class AlreadyUsingShared(BzrDirError):
2795
 
 
2796
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2797
 
 
2798
 
 
2799
 
class AlreadyStandalone(BzrDirError):
2800
 
 
2801
 
    _fmt = "'%(display_url)s' is already standalone."
2802
 
 
2803
 
 
2804
 
class AlreadyWithTrees(BzrDirError):
2805
 
 
2806
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2807
 
            "working trees.")
2808
 
 
2809
 
 
2810
 
class AlreadyWithNoTrees(BzrDirError):
2811
 
 
2812
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2813
 
            "working trees.")
2814
 
 
2815
 
 
2816
 
class ReconfigurationNotSupported(BzrDirError):
2817
 
 
2818
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2819
 
 
2820
 
 
2821
 
class NoBindLocation(BzrDirError):
2822
 
 
2823
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2824
 
 
2825
 
 
2826
 
class UncommittedChanges(BzrError):
2827
 
 
2828
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
 
            ' (See bzr status).%(more)s')
2830
 
 
2831
 
    def __init__(self, tree, more=None):
2832
 
        if more is None:
2833
 
            more = ''
2834
 
        else:
2835
 
            more = ' ' + more
2836
 
        import bzrlib.urlutils as urlutils
2837
 
        display_url = urlutils.unescape_for_display(
2838
 
            tree.user_url, 'ascii')
2839
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2840
 
 
2841
 
 
2842
 
class MissingTemplateVariable(BzrError):
2843
 
 
2844
 
    _fmt = 'Variable {%(name)s} is not available.'
2845
 
 
2846
 
    def __init__(self, name):
2847
 
        self.name = name
2848
 
 
2849
 
 
2850
 
class NoTemplate(BzrError):
2851
 
 
2852
 
    _fmt = 'No template specified.'
2853
 
 
2854
 
 
2855
 
class UnableCreateSymlink(BzrError):
2856
 
 
2857
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2858
 
 
2859
 
    def __init__(self, path=None):
2860
 
        path_str = ''
2861
 
        if path:
2862
 
            try:
2863
 
                path_str = repr(str(path))
2864
 
            except UnicodeEncodeError:
2865
 
                path_str = repr(path)
2866
 
            path_str += ' '
2867
 
        self.path_str = path_str
2868
 
 
2869
 
 
2870
 
class UnsupportedTimezoneFormat(BzrError):
2871
 
 
2872
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2873
 
            'options are "utc", "original", "local".')
2874
 
 
2875
 
    def __init__(self, timezone):
2876
 
        self.timezone = timezone
2877
 
 
2878
 
 
2879
 
class CommandAvailableInPlugin(StandardError):
2880
 
 
2881
 
    internal_error = False
2882
 
 
2883
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2884
 
 
2885
 
        self.plugin_metadata = plugin_metadata
2886
 
        self.cmd_name = cmd_name
2887
 
        self.provider = provider
2888
 
 
2889
 
    def __str__(self):
2890
 
 
2891
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2892
 
                'However, the following official plugin provides this command: %s\n'
2893
 
                'You can install it by going to: %s'
2894
 
                % (self.cmd_name, self.plugin_metadata['name'],
2895
 
                    self.plugin_metadata['url']))
2896
 
 
2897
 
        return _fmt
2898
 
 
2899
 
 
2900
 
class NoPluginAvailable(BzrError):
2901
 
    pass
2902
 
 
2903
 
 
2904
 
class UnableEncodePath(BzrError):
2905
 
 
2906
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2907
 
            'user encoding %(user_encoding)s')
2908
 
 
2909
 
    def __init__(self, path, kind):
2910
 
        from bzrlib.osutils import get_user_encoding
2911
 
        self.path = path
2912
 
        self.kind = kind
2913
 
        self.user_encoding = osutils.get_user_encoding()
2914
 
 
2915
 
 
2916
 
class NoSuchAlias(BzrError):
2917
 
 
2918
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2919
 
 
2920
 
    def __init__(self, alias_name):
2921
 
        BzrError.__init__(self, alias_name=alias_name)
2922
 
 
2923
 
 
2924
 
class DirectoryLookupFailure(BzrError):
2925
 
    """Base type for lookup errors."""
2926
 
 
2927
 
    pass
2928
 
 
2929
 
 
2930
 
class InvalidLocationAlias(DirectoryLookupFailure):
2931
 
 
2932
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2933
 
 
2934
 
    def __init__(self, alias_name):
2935
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2936
 
 
2937
 
 
2938
 
class UnsetLocationAlias(DirectoryLookupFailure):
2939
 
 
2940
 
    _fmt = 'No %(alias_name)s location assigned.'
2941
 
 
2942
 
    def __init__(self, alias_name):
2943
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2944
 
 
2945
 
 
2946
 
class CannotBindAddress(BzrError):
2947
 
 
2948
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2949
 
 
2950
 
    def __init__(self, host, port, orig_error):
2951
 
        # nb: in python2.4 socket.error doesn't have a useful repr
2952
 
        BzrError.__init__(self, host=host, port=port,
2953
 
            orig_error=repr(orig_error.args))
2954
 
 
2955
 
 
2956
 
class UnknownRules(BzrError):
2957
 
 
2958
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2959
 
 
2960
 
    def __init__(self, unknowns):
2961
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2962
 
 
2963
 
 
2964
 
class HookFailed(BzrError):
2965
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2966
 
    than TipChangeRejected.
2967
 
 
2968
 
    Note that this exception is no longer raised, and the import is only left
2969
 
    to be nice to code which might catch it in a plugin.
2970
 
    """
2971
 
 
2972
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
 
            "%(traceback_text)s%(exc_value)s")
2974
 
 
2975
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2976
 
        if warn:
2977
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
2978
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2979
 
        import traceback
2980
 
        self.hook_stage = hook_stage
2981
 
        self.hook_name = hook_name
2982
 
        self.exc_info = exc_info
2983
 
        self.exc_type = exc_info[0]
2984
 
        self.exc_value = exc_info[1]
2985
 
        self.exc_tb = exc_info[2]
2986
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2987
 
 
2988
 
 
2989
 
class TipChangeRejected(BzrError):
2990
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
2991
 
    explicitly abort a change to a branch tip.
2992
 
    """
2993
 
 
2994
 
    _fmt = u"Tip change rejected: %(msg)s"
2995
 
 
2996
 
    def __init__(self, msg):
2997
 
        self.msg = msg
2998
 
 
2999
 
 
3000
 
class ShelfCorrupt(BzrError):
3001
 
 
3002
 
    _fmt = "Shelf corrupt."
3003
 
 
3004
 
 
3005
 
class NoSuchShelfId(BzrError):
3006
 
 
3007
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3008
 
 
3009
 
    def __init__(self, shelf_id):
3010
 
        BzrError.__init__(self, shelf_id=shelf_id)
3011
 
 
3012
 
 
3013
 
class InvalidShelfId(BzrError):
3014
 
 
3015
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3016
 
 
3017
 
    def __init__(self, invalid_id):
3018
 
        BzrError.__init__(self, invalid_id=invalid_id)
3019
 
 
3020
 
 
3021
 
class JailBreak(BzrError):
3022
 
 
3023
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3024
 
 
3025
 
    def __init__(self, url):
3026
 
        BzrError.__init__(self, url=url)
3027
 
 
3028
 
 
3029
 
class UserAbort(BzrError):
3030
 
 
3031
 
    _fmt = 'The user aborted the operation.'
3032
 
 
3033
 
 
3034
 
class MustHaveWorkingTree(BzrError):
3035
 
 
3036
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3037
 
 
3038
 
    def __init__(self, format, url):
3039
 
        BzrError.__init__(self, format=format, url=url)
3040
 
 
3041
 
 
3042
 
class NoSuchView(BzrError):
3043
 
    """A view does not exist.
3044
 
    """
3045
 
 
3046
 
    _fmt = u"No such view: %(view_name)s."
3047
 
 
3048
 
    def __init__(self, view_name):
3049
 
        self.view_name = view_name
3050
 
 
3051
 
 
3052
 
class ViewsNotSupported(BzrError):
3053
 
    """Views are not supported by a tree format.
3054
 
    """
3055
 
 
3056
 
    _fmt = ("Views are not supported by %(tree)s;"
3057
 
            " use 'bzr upgrade' to change your tree to a later format.")
3058
 
 
3059
 
    def __init__(self, tree):
3060
 
        self.tree = tree
3061
 
 
3062
 
 
3063
 
class FileOutsideView(BzrError):
3064
 
 
3065
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3066
 
            '%(view_str)s')
3067
 
 
3068
 
    def __init__(self, file_name, view_files):
3069
 
        self.file_name = file_name
3070
 
        self.view_str = ", ".join(view_files)
3071
 
 
3072
 
 
3073
 
class UnresumableWriteGroup(BzrError):
3074
 
 
3075
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3076
 
            "%(write_groups)r: %(reason)s")
3077
 
 
3078
 
    internal_error = True
3079
 
 
3080
 
    def __init__(self, repository, write_groups, reason):
3081
 
        self.repository = repository
3082
 
        self.write_groups = write_groups
3083
 
        self.reason = reason
3084
 
 
3085
 
 
3086
 
class UnsuspendableWriteGroup(BzrError):
3087
 
 
3088
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3089
 
 
3090
 
    internal_error = True
3091
 
 
3092
 
    def __init__(self, repository):
3093
 
        self.repository = repository
3094
 
 
3095
 
 
3096
 
class LossyPushToSameVCS(BzrError):
3097
 
 
3098
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3099
 
            "%(target_branch)r that are in the same VCS.")
3100
 
 
3101
 
    internal_error = True
3102
 
 
3103
 
    def __init__(self, source_branch, target_branch):
3104
 
        self.source_branch = source_branch
3105
 
        self.target_branch = target_branch
3106
 
 
3107
 
 
3108
 
class NoRoundtrippingSupport(BzrError):
3109
 
 
3110
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3111
 
            "%(target_branch)r.")
3112
 
 
3113
 
    internal_error = True
3114
 
 
3115
 
    def __init__(self, source_branch, target_branch):
3116
 
        self.source_branch = source_branch
3117
 
        self.target_branch = target_branch
3118
 
 
3119
 
 
3120
 
class FileTimestampUnavailable(BzrError):
3121
 
 
3122
 
    _fmt = "The filestamp for %(path)s is not available."
3123
 
 
3124
 
    internal_error = True
3125
 
 
3126
 
    def __init__(self, path):
3127
 
        self.path = path
3128
 
 
3129
 
 
3130
 
class NoColocatedBranchSupport(BzrError):
3131
 
 
3132
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3133
 
 
3134
 
    def __init__(self, bzrdir):
3135
 
        self.bzrdir = bzrdir
3136