← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

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