← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
43
44
# 'unprintable'.
44
45
 
45
46
 
46
 
# return codes from the bzr program
47
 
EXIT_OK = 0
48
 
EXIT_ERROR = 3
49
 
EXIT_INTERNAL_ERROR = 4
50
 
 
51
 
 
52
47
class BzrError(StandardError):
53
48
    """
54
49
    Base class for errors raised by bzrlib.
55
50
 
56
 
    :cvar internal_error: if True this was probably caused by a bzr bug and
57
 
    should be displayed with a traceback; if False (or absent) this was
 
51
    :cvar internal_error: if true (or absent) this was probably caused by a
 
52
    bzr bug and should be displayed with a traceback; if False this was
58
53
    probably a user or environment error and they don't need the gory details.
59
54
    (That can be overridden by -Derror on the command line.)
60
55
 
61
56
    :cvar _fmt: Format string to display the error; this is expanded
62
57
    by the instance's dict.
63
58
    """
64
 
 
 
59
    
65
60
    internal_error = False
66
61
 
67
62
    def __init__(self, msg=None, **kwds):
72
67
        arguments can be given.  The first is for generic "user" errors which
73
68
        are not intended to be caught and so do not need a specific subclass.
74
69
        The second case is for use with subclasses that provide a _fmt format
75
 
        string to print the arguments.
 
70
        string to print the arguments.  
76
71
 
77
 
        Keyword arguments are taken as parameters to the error, which can
78
 
        be inserted into the format string template.  It's recommended
79
 
        that subclasses override the __init__ method to require specific
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
73
        be inserted into the format string template.  It's recommended 
 
74
        that subclasses override the __init__ method to require specific 
80
75
        parameters.
81
76
 
82
77
        :param msg: If given, this is the literal complete text for the error,
83
 
           not subject to expansion. 'msg' is used instead of 'message' because
84
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        not subject to expansion.
85
79
        """
86
80
        StandardError.__init__(self)
87
81
        if msg is not None:
93
87
            for key, value in kwds.items():
94
88
                setattr(self, key, value)
95
89
 
96
 
    def _format(self):
 
90
    def __str__(self):
97
91
        s = getattr(self, '_preformatted_string', None)
98
92
        if s is not None:
99
 
            # contains a preformatted message
100
 
            return s
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
101
95
        try:
102
96
            fmt = self._get_format_string()
103
97
            if fmt:
104
 
                d = dict(self.__dict__)
105
 
                s = fmt % d
 
98
                s = fmt % self.__dict__
106
99
                # __str__() should always return a 'str' object
107
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
108
103
                return s
109
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
111
106
                % (self.__class__.__name__,
112
107
                   self.__dict__,
113
108
                   getattr(self, '_fmt', None),
114
 
                   e)
115
 
 
116
 
    def __unicode__(self):
117
 
        u = self._format()
118
 
        if isinstance(u, str):
119
 
            # Try decoding the str using the default encoding.
120
 
            u = unicode(u)
121
 
        elif not isinstance(u, unicode):
122
 
            # Try to make a unicode object from it, because __unicode__ must
123
 
            # return a unicode object.
124
 
            u = unicode(u)
125
 
        return u
126
 
 
127
 
    def __str__(self):
128
 
        s = self._format()
129
 
        if isinstance(s, unicode):
130
 
            s = s.encode('utf8')
131
 
        else:
132
 
            # __str__ must return a str.
133
 
            s = str(s)
134
 
        return s
135
 
 
136
 
    def __repr__(self):
137
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
109
                   str(e))
138
110
 
139
111
    def _get_format_string(self):
140
112
        """Return format string for this exception or None"""
153
125
               getattr(self, '_fmt', None),
154
126
               )
155
127
 
156
 
    def __eq__(self, other):
157
 
        if self.__class__ is not other.__class__:
158
 
            return NotImplemented
159
 
        return self.__dict__ == other.__dict__
160
 
 
161
 
 
162
 
class InternalBzrError(BzrError):
163
 
    """Base class for errors that are internal in nature.
164
 
 
165
 
    This is a convenience class for errors that are internal. The
166
 
    internal_error attribute can still be altered in subclasses, if needed.
167
 
    Using this class is simply an easy way to get internal errors.
168
 
    """
169
 
 
170
 
    internal_error = True
171
 
 
172
128
 
173
129
class BzrNewError(BzrError):
174
130
    """Deprecated error base class."""
198
154
                return s.encode('utf8')
199
155
            return s
200
156
        except (TypeError, NameError, ValueError, KeyError), e:
201
 
            return 'Unprintable exception %s(%r): %r' \
 
157
            return 'Unprintable exception %s(%r): %s' \
202
158
                % (self.__class__.__name__,
203
 
                   self.__dict__, e)
 
159
                   self.__dict__, str(e))
204
160
 
205
161
 
206
162
class AlreadyBuilding(BzrError):
207
 
 
 
163
    
208
164
    _fmt = "The tree builder is already building a tree."
209
165
 
210
166
 
211
 
class BranchError(BzrError):
212
 
    """Base class for concrete 'errors about a branch'."""
213
 
 
214
 
    def __init__(self, branch):
215
 
        BzrError.__init__(self, branch=branch)
216
 
 
217
 
 
218
 
class BzrCheckError(InternalBzrError):
219
 
 
220
 
    _fmt = "Internal check failed: %(msg)s"
221
 
 
222
 
    def __init__(self, msg):
223
 
        BzrError.__init__(self)
224
 
        self.msg = msg
225
 
 
226
 
 
227
 
class DirstateCorrupt(BzrError):
228
 
 
229
 
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
230
 
 
231
 
    def __init__(self, state, msg):
232
 
        BzrError.__init__(self)
233
 
        self.state = state
234
 
        self.msg = msg
235
 
 
236
 
 
237
 
class DisabledMethod(InternalBzrError):
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class DisabledMethod(BzrError):
238
179
 
239
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
240
181
 
 
182
    internal_error = True
 
183
 
241
184
    def __init__(self, class_name):
242
185
        BzrError.__init__(self)
243
186
        self.class_name = class_name
244
187
 
245
188
 
246
 
class IncompatibleAPI(BzrError):
247
 
 
248
 
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
249
 
        'It supports versions "%(minimum)s" to "%(current)s".'
250
 
 
251
 
    def __init__(self, api, wanted, minimum, current):
252
 
        self.api = api
253
 
        self.wanted = wanted
254
 
        self.minimum = minimum
255
 
        self.current = current
256
 
 
257
 
 
258
 
class InProcessTransport(BzrError):
259
 
 
260
 
    _fmt = "The transport '%(transport)s' is only accessible within this " \
261
 
        "process."
262
 
 
263
 
    def __init__(self, transport):
264
 
        self.transport = transport
265
 
 
266
 
 
267
 
class InvalidEntryName(InternalBzrError):
268
 
 
 
189
class InvalidEntryName(BzrError):
 
190
    
269
191
    _fmt = "Invalid entry name: %(name)s"
270
192
 
 
193
    internal_error = True
 
194
 
271
195
    def __init__(self, name):
272
196
        BzrError.__init__(self)
273
197
        self.name = name
274
198
 
275
199
 
276
200
class InvalidRevisionNumber(BzrError):
277
 
 
 
201
    
278
202
    _fmt = "Invalid revision number %(revno)s"
279
203
 
280
204
    def __init__(self, revno):
292
216
        self.revision_id = revision_id
293
217
        self.branch = branch
294
218
 
295
 
 
296
219
class ReservedId(BzrError):
297
220
 
298
221
    _fmt = "Reserved revision-id {%(revision_id)s}"
300
223
    def __init__(self, revision_id):
301
224
        self.revision_id = revision_id
302
225
 
303
 
 
304
 
class RootMissing(InternalBzrError):
305
 
 
306
 
    _fmt = ("The root entry of a tree must be the first entry supplied to "
307
 
        "record_entry_contents.")
308
 
 
309
 
 
310
 
class NoPublicBranch(BzrError):
311
 
 
312
 
    _fmt = 'There is no public branch set for "%(branch_url)s".'
313
 
 
314
 
    def __init__(self, branch):
315
 
        import bzrlib.urlutils as urlutils
316
 
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
317
 
        BzrError.__init__(self, branch_url=public_location)
318
 
 
319
 
 
320
 
class NoHelpTopic(BzrError):
321
 
 
322
 
    _fmt = ("No help could be found for '%(topic)s'. "
323
 
        "Please use 'bzr help topics' to obtain a list of topics.")
324
 
 
325
 
    def __init__(self, topic):
326
 
        self.topic = topic
327
 
 
328
 
 
329
226
class NoSuchId(BzrError):
330
227
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
228
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
229
    
333
230
    def __init__(self, tree, file_id):
334
231
        BzrError.__init__(self)
335
232
        self.file_id = file_id
336
233
        self.tree = tree
337
234
 
338
235
 
339
 
class NoSuchIdInRepository(NoSuchId):
340
 
 
341
 
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
342
 
            ' %(repository)r')
343
 
 
344
 
    def __init__(self, repository, file_id):
345
 
        BzrError.__init__(self, repository=repository, file_id=file_id)
346
 
 
347
 
 
348
 
class NotStacked(BranchError):
349
 
 
350
 
    _fmt = "The branch '%(branch)s' is not stacked."
351
 
 
352
 
 
353
 
class InventoryModified(InternalBzrError):
 
236
class InventoryModified(BzrError):
354
237
 
355
238
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
239
            " so a clean inventory cannot be read without data loss.")
357
240
 
 
241
    internal_error = True
 
242
 
358
243
    def __init__(self, tree):
359
244
        self.tree = tree
360
245
 
361
246
 
362
247
class NoWorkingTree(BzrError):
363
248
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
249
    _fmt = "No WorkingTree exists for %(base)s."
 
250
    
366
251
    def __init__(self, base):
367
252
        BzrError.__init__(self)
368
253
        self.base = base
381
266
        self.url = url
382
267
 
383
268
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
269
class WorkingTreeAlreadyPopulated(BzrError):
 
270
 
 
271
    _fmt = """Working tree already populated in %(base)s"""
 
272
 
 
273
    internal_error = True
387
274
 
388
275
    def __init__(self, base):
389
276
        self.base = base
390
277
 
391
 
 
392
278
class BzrCommandError(BzrError):
393
279
    """Error from user command"""
394
280
 
 
281
    internal_error = False
 
282
 
395
283
    # Error from malformed user command; please avoid raising this as a
396
284
    # generic exception not caused by user input.
397
285
    #
399
287
    # are not intended to be caught anyway.  UI code need not subclass
400
288
    # BzrCommandError, and non-UI code should not throw a subclass of
401
289
    # BzrCommandError.  ADHB 20051211
 
290
    def __init__(self, msg):
 
291
        # Object.__str__() must return a real string
 
292
        # returning a Unicode string is a python error.
 
293
        if isinstance(msg, unicode):
 
294
            self.msg = msg.encode('utf8')
 
295
        else:
 
296
            self.msg = msg
 
297
 
 
298
    def __str__(self):
 
299
        return self.msg
402
300
 
403
301
 
404
302
class NotWriteLocked(BzrError):
414
312
    _fmt = "Error in command line options"
415
313
 
416
314
 
417
 
class BadIndexFormatSignature(BzrError):
418
 
 
419
 
    _fmt = "%(value)s is not an index of type %(_type)s."
420
 
 
421
 
    def __init__(self, value, _type):
422
 
        BzrError.__init__(self)
423
 
        self.value = value
424
 
        self._type = _type
425
 
 
426
 
 
427
 
class BadIndexData(BzrError):
428
 
 
429
 
    _fmt = "Error in data for index %(value)s."
430
 
 
431
 
    def __init__(self, value):
432
 
        BzrError.__init__(self)
433
 
        self.value = value
434
 
 
435
 
 
436
 
class BadIndexDuplicateKey(BzrError):
437
 
 
438
 
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
439
 
 
440
 
    def __init__(self, key, index):
441
 
        BzrError.__init__(self)
442
 
        self.key = key
443
 
        self.index = index
444
 
 
445
 
 
446
 
class BadIndexKey(BzrError):
447
 
 
448
 
    _fmt = "The key '%(key)s' is not a valid key."
449
 
 
450
 
    def __init__(self, key):
451
 
        BzrError.__init__(self)
452
 
        self.key = key
453
 
 
454
 
 
455
 
class BadIndexOptions(BzrError):
456
 
 
457
 
    _fmt = "Could not parse options for index %(value)s."
458
 
 
459
 
    def __init__(self, value):
460
 
        BzrError.__init__(self)
461
 
        self.value = value
462
 
 
463
 
 
464
 
class BadIndexValue(BzrError):
465
 
 
466
 
    _fmt = "The value '%(value)s' is not a valid value."
467
 
 
468
 
    def __init__(self, value):
469
 
        BzrError.__init__(self)
470
 
        self.value = value
471
 
 
472
 
 
473
315
class BadOptionValue(BzrError):
474
316
 
475
317
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
477
319
    def __init__(self, name, value):
478
320
        BzrError.__init__(self, name=name, value=value)
479
321
 
480
 
 
 
322
    
481
323
class StrictCommitFailed(BzrError):
482
324
 
483
325
    _fmt = "Commit refused because there are unknown files in the tree"
485
327
 
486
328
# XXX: Should be unified with TransportError; they seem to represent the
487
329
# same thing
488
 
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
 
# - this is finer than a TransportError - and more useful as such. It
490
 
# differentiates between 'transport has failed' and 'operation on a transport
491
 
# has failed.'
492
330
class PathError(BzrError):
493
 
 
 
331
    
494
332
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
333
 
496
334
    def __init__(self, path, extra=None):
516
354
    """Used when renaming and both source and dest exist."""
517
355
 
518
356
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
519
 
            " (Use --after to tell bzr about a rename that has already"
520
 
            " happened)%(extra)s")
 
357
            "%(extra)s")
521
358
 
522
359
    def __init__(self, source, dest, extra=None):
523
360
        BzrError.__init__(self)
531
368
 
532
369
class NotADirectory(PathError):
533
370
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
371
    _fmt = "%(path)r is not a directory %(extra)s"
535
372
 
536
373
 
537
374
class NotInWorkingDirectory(PathError):
538
375
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
376
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
377
 
541
378
 
542
379
class DirectoryNotEmpty(PathError):
543
380
 
544
 
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
545
 
 
546
 
 
547
 
class HardLinkNotSupported(PathError):
548
 
 
549
 
    _fmt = 'Hard-linking "%(path)s" is not supported'
550
 
 
551
 
 
552
 
class ReadingCompleted(InternalBzrError):
553
 
 
 
381
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
382
 
 
383
 
 
384
class ReadingCompleted(BzrError):
 
385
    
554
386
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
387
            "called upon it - the request has been completed and no more "
556
388
            "data may be read.")
557
389
 
 
390
    internal_error = True
 
391
 
558
392
    def __init__(self, request):
559
393
        self.request = request
560
394
 
561
395
 
562
396
class ResourceBusy(PathError):
563
397
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
398
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
399
 
566
400
 
567
401
class PermissionDenied(PathError):
568
402
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
403
    _fmt = "Permission denied: %(path)r%(extra)s"
570
404
 
571
405
 
572
406
class InvalidURL(PathError):
573
407
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
408
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
409
 
576
410
 
577
411
class InvalidURLJoin(PathError):
578
412
 
579
 
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
580
 
 
581
 
    def __init__(self, reason, base, join_args):
582
 
        self.reason = reason
583
 
        self.base = base
584
 
        self.join_args = join_args
585
 
        PathError.__init__(self, base, reason)
586
 
 
587
 
 
588
 
class InvalidRebaseURLs(PathError):
589
 
 
590
 
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
591
 
 
592
 
    def __init__(self, from_, to):
593
 
        self.from_ = from_
594
 
        self.to = to
595
 
        PathError.__init__(self, from_, 'URLs differ by more than path.')
596
 
 
597
 
 
598
 
class UnavailableRepresentation(InternalBzrError):
599
 
 
600
 
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
601
 
        "is encoded as '%(native)s'.")
602
 
 
603
 
    def __init__(self, key, wanted, native):
604
 
        InternalBzrError.__init__(self)
605
 
        self.wanted = wanted
606
 
        self.native = native
607
 
        self.key = key
 
413
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
414
 
 
415
    def __init__(self, msg, base, args):
 
416
        PathError.__init__(self, base, msg)
 
417
        self.args = [base] + list(args)
608
418
 
609
419
 
610
420
class UnknownHook(BzrError):
625
435
        PathError.__init__(self, url, extra=extra)
626
436
 
627
437
 
628
 
class UnstackableBranchFormat(BzrError):
629
 
 
630
 
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
631
 
        "You will need to upgrade the branch to permit branch stacking.")
632
 
 
633
 
    def __init__(self, format, url):
634
 
        BzrError.__init__(self)
635
 
        self.format = format
636
 
        self.url = url
637
 
 
638
 
 
639
 
class UnstackableLocationError(BzrError):
640
 
 
641
 
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
642
 
 
643
 
    def __init__(self, branch_url, target_url):
644
 
        BzrError.__init__(self)
645
 
        self.branch_url = branch_url
646
 
        self.target_url = target_url
647
 
 
648
 
 
649
 
class UnstackableRepositoryFormat(BzrError):
650
 
 
651
 
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
652
 
        "You will need to upgrade the repository to permit branch stacking.")
653
 
 
654
 
    def __init__(self, format, url):
655
 
        BzrError.__init__(self)
656
 
        self.format = format
657
 
        self.url = url
658
 
 
659
 
 
660
 
class ReadError(PathError):
661
 
 
662
 
    _fmt = """Error reading from %(path)r."""
663
 
 
664
 
 
665
438
class ShortReadvError(PathError):
666
439
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
440
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
441
            " at %(offset)s for %(path)s%(extra)s")
669
442
 
670
443
    internal_error = True
671
444
 
676
449
        self.actual = actual
677
450
 
678
451
 
679
 
class PathNotChild(PathError):
680
 
 
681
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
682
 
 
683
 
    internal_error = False
 
452
class PathNotChild(BzrError):
 
453
 
 
454
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
455
 
 
456
    internal_error = True
684
457
 
685
458
    def __init__(self, path, base, extra=None):
686
459
        BzrError.__init__(self)
694
467
 
695
468
class InvalidNormalization(PathError):
696
469
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
470
    _fmt = "Path %(path)r is not unicode normalized"
698
471
 
699
472
 
700
473
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
474
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
475
# TODO: Probably this behavior of should be a common superclass 
703
476
class NotBranchError(PathError):
704
477
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
478
    _fmt = "Not a branch: %(path)s"
706
479
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
 
480
    def __init__(self, path):
708
481
       import bzrlib.urlutils as urlutils
709
 
       path = urlutils.unescape_for_display(path, 'ascii')
710
 
       if detail is not None:
711
 
           detail = ': ' + detail
712
 
       self.detail = detail
713
 
       self.bzrdir = bzrdir
714
 
       PathError.__init__(self, path=path)
715
 
 
716
 
    def __repr__(self):
717
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
718
 
 
719
 
    def _format(self):
720
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
721
 
        # Python 2.4 have to be old-style classes so properties don't work.
722
 
        # Instead we override _format.
723
 
        if self.detail is None:
724
 
            if self.bzrdir is not None:
725
 
                try:
726
 
                    self.bzrdir.open_repository()
727
 
                except NoRepositoryPresent:
728
 
                    self.detail = ''
729
 
                except Exception:
730
 
                    # Just ignore unexpected errors.  Raising arbitrary errors
731
 
                    # during str(err) can provoke strange bugs.  Concretely
732
 
                    # Launchpad's codehosting managed to raise NotBranchError
733
 
                    # here, and then get stuck in an infinite loop/recursion
734
 
                    # trying to str() that error.  All this error really cares
735
 
                    # about that there's no working repository there, and if
736
 
                    # open_repository() fails, there probably isn't.
737
 
                    self.detail = ''
738
 
                else:
739
 
                    self.detail = ': location is a repository'
740
 
            else:
741
 
                self.detail = ''
742
 
        return PathError._format(self)
 
482
       self.path = urlutils.unescape_for_display(path, 'ascii')
743
483
 
744
484
 
745
485
class NoSubmitBranch(PathError):
753
493
 
754
494
class AlreadyBranchError(PathError):
755
495
 
756
 
    _fmt = 'Already a branch: "%(path)s".'
 
496
    _fmt = "Already a branch: %(path)s."
757
497
 
758
498
 
759
499
class BranchExistsWithoutWorkingTree(PathError):
760
500
 
761
 
    _fmt = 'Directory contains a branch, but no working tree \
762
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
501
    _fmt = "Directory contains a branch, but no working tree \
 
502
(use bzr checkout if you wish to build a working tree): %(path)s"
763
503
 
764
504
 
765
505
class AtomicFileAlreadyClosed(PathError):
766
506
 
767
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
768
 
            ' "%(path)s"')
 
507
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
508
            " %(path)s")
769
509
 
770
510
    def __init__(self, path, function):
771
511
        PathError.__init__(self, path=path, extra=None)
774
514
 
775
515
class InaccessibleParent(PathError):
776
516
 
777
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
778
 
            ' relative path "%(path)s"')
 
517
    _fmt = ("Parent not accessible given base %(base)s and"
 
518
            " relative path %(path)s")
779
519
 
780
520
    def __init__(self, path, base):
781
521
        PathError.__init__(self, path)
784
524
 
785
525
class NoRepositoryPresent(BzrError):
786
526
 
787
 
    _fmt = 'No repository present: "%(path)s"'
 
527
    _fmt = "No repository present: %(path)r"
788
528
    def __init__(self, bzrdir):
789
529
        BzrError.__init__(self)
790
530
        self.path = bzrdir.transport.clone('..').base
792
532
 
793
533
class FileInWrongBranch(BzrError):
794
534
 
795
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
535
    _fmt = "File %(path)s in not in branch %(branch_base)s."
796
536
 
797
 
    # use PathNotChild instead
798
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
537
    def __init__(self, branch, path):
800
538
        BzrError.__init__(self)
801
539
        self.branch = branch
809
547
 
810
548
 
811
549
class UnknownFormatError(BzrError):
812
 
 
813
 
    _fmt = "Unknown %(kind)s format: %(format)r"
814
 
 
815
 
    def __init__(self, format, kind='branch'):
816
 
        self.kind = kind
817
 
        self.format = format
 
550
    
 
551
    _fmt = "Unknown branch format: %(format)r"
818
552
 
819
553
 
820
554
class IncompatibleFormat(BzrError):
821
 
 
 
555
    
822
556
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
823
557
 
824
558
    def __init__(self, format, bzrdir_format):
828
562
 
829
563
 
830
564
class IncompatibleRepositories(BzrError):
831
 
    """Report an error that two repositories are not compatible.
832
 
 
833
 
    Note that the source and target repositories are permitted to be strings:
834
 
    this exception is thrown from the smart server and may refer to a
835
 
    repository the client hasn't opened.
836
 
    """
837
 
 
838
 
    _fmt = "%(target)s\n" \
839
 
            "is not compatible with\n" \
840
 
            "%(source)s\n" \
841
 
            "%(details)s"
842
 
 
843
 
    def __init__(self, source, target, details=None):
844
 
        if details is None:
845
 
            details = "(no details)"
846
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
565
 
 
566
    _fmt = "Repository %(target)s is not compatible with repository"\
 
567
        " %(source)s"
 
568
 
 
569
    def __init__(self, source, target):
 
570
        BzrError.__init__(self, target=target, source=source)
847
571
 
848
572
 
849
573
class IncompatibleRevision(BzrError):
850
 
 
 
574
    
851
575
    _fmt = "Revision is not compatible with %(repo_format)s"
852
576
 
853
577
    def __init__(self, repo_format):
858
582
class AlreadyVersionedError(BzrError):
859
583
    """Used when a path is expected not to be versioned, but it is."""
860
584
 
861
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
585
    _fmt = "%(context_info)s%(path)s is already versioned"
862
586
 
863
587
    def __init__(self, path, context_info=None):
864
588
        """Construct a new AlreadyVersionedError.
879
603
class NotVersionedError(BzrError):
880
604
    """Used when a path is expected to be versioned, but it is not."""
881
605
 
882
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
606
    _fmt = "%(context_info)s%(path)s is not versioned"
883
607
 
884
608
    def __init__(self, path, context_info=None):
885
609
        """Construct a new NotVersionedError.
936
660
        BzrError.__init__(self, filename=filename, kind=kind)
937
661
 
938
662
 
939
 
class BadFilenameEncoding(BzrError):
940
 
 
941
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
942
 
            ' encoding %(fs_encoding)s')
943
 
 
944
 
    def __init__(self, filename, fs_encoding):
945
 
        BzrError.__init__(self)
946
 
        self.filename = filename
947
 
        self.fs_encoding = fs_encoding
948
 
 
949
 
 
950
663
class ForbiddenControlFileError(BzrError):
951
664
 
952
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
953
 
 
954
 
 
955
 
class LockError(InternalBzrError):
 
665
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
666
 
 
667
 
 
668
class LockError(BzrError):
956
669
 
957
670
    _fmt = "Lock error: %(msg)s"
958
671
 
 
672
    internal_error = True
 
673
 
959
674
    # All exceptions from the lock/unlock functions should be from
960
675
    # this exception class.  They will be translated as necessary. The
961
676
    # original exception is available as e.original_error
962
677
    #
963
678
    # New code should prefer to raise specific subclasses
964
 
    def __init__(self, msg):
965
 
        self.msg = msg
 
679
    def __init__(self, message):
 
680
        # Python 2.5 uses a slot for StandardError.message,
 
681
        # so use a different variable name
 
682
        # so it is exposed in self.__dict__
 
683
        self.msg = message
966
684
 
967
685
 
968
686
class LockActive(LockError):
1002
720
        self.obj = obj
1003
721
 
1004
722
 
1005
 
class LockFailed(LockError):
1006
 
 
1007
 
    internal_error = False
1008
 
 
1009
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
1010
 
 
1011
 
    def __init__(self, lock, why):
 
723
class ReadOnlyLockError(LockError):
 
724
 
 
725
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
726
 
 
727
    def __init__(self, fname, msg):
1012
728
        LockError.__init__(self, '')
1013
 
        self.lock = lock
1014
 
        self.why = why
 
729
        self.fname = fname
 
730
        self.msg = msg
1015
731
 
1016
732
 
1017
733
class OutSideTransaction(BzrError):
1041
757
 
1042
758
class UnlockableTransport(LockError):
1043
759
 
1044
 
    internal_error = False
1045
 
 
1046
760
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1047
761
 
1048
762
    def __init__(self, transport):
1051
765
 
1052
766
class LockContention(LockError):
1053
767
 
1054
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
768
    _fmt = "Could not acquire lock %(lock)s"
 
769
    # TODO: show full url for lock, combining the transport and relative
 
770
    # bits?
1055
771
 
1056
772
    internal_error = False
1057
773
 
1058
 
    def __init__(self, lock, msg=''):
 
774
    def __init__(self, lock):
1059
775
        self.lock = lock
1060
 
        self.msg = msg
1061
776
 
1062
777
 
1063
778
class LockBroken(LockError):
1084
799
        self.target = target
1085
800
 
1086
801
 
1087
 
class LockCorrupt(LockError):
1088
 
 
1089
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1090
 
            "Use 'bzr break-lock' to clear it")
1091
 
 
1092
 
    internal_error = False
1093
 
 
1094
 
    def __init__(self, corruption_info, file_data=None):
1095
 
        self.corruption_info = corruption_info
1096
 
        self.file_data = file_data
1097
 
 
1098
 
 
1099
802
class LockNotHeld(LockError):
1100
803
 
1101
804
    _fmt = "Lock not held: %(lock)s"
1110
813
 
1111
814
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1112
815
 
 
816
    internal_error = True
 
817
 
1113
818
    def __init__(self, obj):
1114
819
        self.obj = obj
1115
820
 
1130
835
    _fmt = "No changes to commit"
1131
836
 
1132
837
 
1133
 
class CannotCommitSelectedFileMerge(BzrError):
1134
 
 
1135
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
1136
 
        ' files %(files_str)s'
1137
 
 
1138
 
    def __init__(self, files):
1139
 
        files_str = ', '.join(files)
1140
 
        BzrError.__init__(self, files=files, files_str=files_str)
1141
 
 
1142
 
 
1143
 
class BadCommitMessageEncoding(BzrError):
1144
 
 
1145
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1146
 
        'the current encoding.'
1147
 
 
1148
 
 
1149
838
class UpgradeReadonly(BzrError):
1150
839
 
1151
840
    _fmt = "Upgrade URL cannot work with readonly URLs."
1165
854
    _fmt = "Commit refused because there are unknowns in the tree."
1166
855
 
1167
856
 
1168
 
class NoSuchRevision(InternalBzrError):
1169
 
 
1170
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
857
class NoSuchRevision(BzrError):
 
858
 
 
859
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
860
 
 
861
    internal_error = True
1171
862
 
1172
863
    def __init__(self, branch, revision):
1173
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1174
864
        BzrError.__init__(self, branch=branch, revision=revision)
1175
865
 
1176
866
 
1177
 
class RangeInChangeOption(BzrError):
1178
 
 
1179
 
    _fmt = "Option --change does not accept revision ranges"
 
867
class NotLeftParentDescendant(BzrError):
 
868
 
 
869
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
870
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
871
 
 
872
    internal_error = True
 
873
 
 
874
    def __init__(self, branch, old_revision, new_revision):
 
875
        BzrError.__init__(self, branch_location=branch.base,
 
876
                          old_revision=old_revision,
 
877
                          new_revision=new_revision)
1180
878
 
1181
879
 
1182
880
class NoSuchRevisionSpec(BzrError):
1189
887
 
1190
888
class NoSuchRevisionInTree(NoSuchRevision):
1191
889
    """When using Tree.revision_tree, and the revision is not accessible."""
1192
 
 
1193
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
890
    
 
891
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1194
892
 
1195
893
    def __init__(self, tree, revision_id):
1196
894
        BzrError.__init__(self)
1200
898
 
1201
899
class InvalidRevisionSpec(BzrError):
1202
900
 
1203
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1204
 
            " %(branch_url)s%(extra)s")
 
901
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
902
            " %(branch)s%(extra)s")
1205
903
 
1206
904
    def __init__(self, spec, branch, extra=None):
1207
905
        BzrError.__init__(self, branch=branch, spec=spec)
1208
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1209
906
        if extra:
1210
907
            self.extra = '\n' + str(extra)
1211
908
        else:
1232
929
class DivergedBranches(BzrError):
1233
930
 
1234
931
    _fmt = ("These branches have diverged."
1235
 
            " Use the missing command to see how.\n"
1236
 
            "Use the merge command to reconcile them.")
 
932
            " Use the merge command to reconcile them.")
 
933
 
 
934
    internal_error = False
1237
935
 
1238
936
    def __init__(self, branch1, branch2):
1239
937
        self.branch1 = branch1
1240
938
        self.branch2 = branch2
1241
939
 
1242
940
 
1243
 
class NotLefthandHistory(InternalBzrError):
 
941
class NotLefthandHistory(BzrError):
1244
942
 
1245
943
    _fmt = "Supplied history does not follow left-hand parents"
1246
944
 
 
945
    internal_error = True
 
946
 
1247
947
    def __init__(self, history):
1248
948
        BzrError.__init__(self, history=history)
1249
949
 
1253
953
    _fmt = ("Branches have no common ancestor, and"
1254
954
            " no merge base revision was specified.")
1255
955
 
1256
 
 
1257
 
class CannotReverseCherrypick(BzrError):
1258
 
 
1259
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1260
 
            ' or diff3.')
 
956
    internal_error = False
1261
957
 
1262
958
 
1263
959
class NoCommonAncestor(BzrError):
1264
 
 
 
960
    
1265
961
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1266
962
 
1267
963
    def __init__(self, revision_a, revision_b):
1287
983
            not_ancestor_id=not_ancestor_id)
1288
984
 
1289
985
 
 
986
class InstallFailed(BzrError):
 
987
 
 
988
    def __init__(self, revisions):
 
989
        revision_str = ", ".join(str(r) for r in revisions)
 
990
        msg = "Could not install revisions:\n%s" % revision_str
 
991
        BzrError.__init__(self, msg)
 
992
        self.revisions = revisions
 
993
 
 
994
 
1290
995
class AmbiguousBase(BzrError):
1291
996
 
1292
997
    def __init__(self, bases):
1293
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1294
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
998
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
999
                DeprecationWarning)
1295
1000
        msg = ("The correct base is unclear, because %s are all equally close"
1296
1001
                % ", ".join(bases))
1297
1002
        BzrError.__init__(self, msg)
1298
1003
        self.bases = bases
1299
1004
 
1300
1005
 
1301
 
class NoCommits(BranchError):
 
1006
class NoCommits(BzrError):
1302
1007
 
1303
1008
    _fmt = "Branch %(branch)s has no commits."
1304
1009
 
 
1010
    def __init__(self, branch):
 
1011
        BzrError.__init__(self, branch=branch)
 
1012
 
1305
1013
 
1306
1014
class UnlistableStore(BzrError):
1307
1015
 
1318
1026
 
1319
1027
class BoundBranchOutOfDate(BzrError):
1320
1028
 
1321
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1322
 
            " %(master)s.%(extra_help)s")
 
1029
    _fmt = ("Bound branch %(branch)s is out of date"
 
1030
            " with master branch %(master)s.")
1323
1031
 
1324
1032
    def __init__(self, branch, master):
1325
1033
        BzrError.__init__(self)
1326
1034
        self.branch = branch
1327
1035
        self.master = master
1328
 
        self.extra_help = ''
1329
 
 
1330
 
 
 
1036
 
 
1037
        
1331
1038
class CommitToDoubleBoundBranch(BzrError):
1332
1039
 
1333
1040
    _fmt = ("Cannot commit to branch %(branch)s."
1363
1070
 
1364
1071
class WeaveError(BzrError):
1365
1072
 
1366
 
    _fmt = "Error in processing weave: %(msg)s"
 
1073
    _fmt = "Error in processing weave: %(message)s"
1367
1074
 
1368
 
    def __init__(self, msg=None):
 
1075
    def __init__(self, message=None):
1369
1076
        BzrError.__init__(self)
1370
 
        self.msg = msg
 
1077
        self.message = message
1371
1078
 
1372
1079
 
1373
1080
class WeaveRevisionAlreadyPresent(WeaveError):
1402
1109
 
1403
1110
class WeaveParentMismatch(WeaveError):
1404
1111
 
1405
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1406
 
 
 
1112
    _fmt = "Parents are mismatched between two revisions."
 
1113
    
1407
1114
 
1408
1115
class WeaveInvalidChecksum(WeaveError):
1409
1116
 
1410
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1117
    _fmt = "Text did not match it's checksum: %(message)s"
1411
1118
 
1412
1119
 
1413
1120
class WeaveTextDiffers(WeaveError):
1435
1142
 
1436
1143
 
1437
1144
class VersionedFileError(BzrError):
1438
 
 
 
1145
    
1439
1146
    _fmt = "Versioned file error"
1440
1147
 
1441
1148
 
1442
1149
class RevisionNotPresent(VersionedFileError):
1443
 
 
1444
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1150
    
 
1151
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1445
1152
 
1446
1153
    def __init__(self, revision_id, file_id):
1447
1154
        VersionedFileError.__init__(self)
1450
1157
 
1451
1158
 
1452
1159
class RevisionAlreadyPresent(VersionedFileError):
1453
 
 
1454
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1160
    
 
1161
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1455
1162
 
1456
1163
    def __init__(self, revision_id, file_id):
1457
1164
        VersionedFileError.__init__(self)
1459
1166
        self.file_id = file_id
1460
1167
 
1461
1168
 
1462
 
class VersionedFileInvalidChecksum(VersionedFileError):
1463
 
 
1464
 
    _fmt = "Text did not match its checksum: %(msg)s"
1465
 
 
1466
 
 
1467
 
class KnitError(InternalBzrError):
1468
 
 
 
1169
class KnitError(BzrError):
 
1170
    
1469
1171
    _fmt = "Knit error"
1470
1172
 
 
1173
    internal_error = True
 
1174
 
 
1175
 
 
1176
class KnitHeaderError(KnitError):
 
1177
 
 
1178
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1179
 
 
1180
    def __init__(self, badline, filename):
 
1181
        KnitError.__init__(self)
 
1182
        self.badline = badline
 
1183
        self.filename = filename
 
1184
 
1471
1185
 
1472
1186
class KnitCorrupt(KnitError):
1473
1187
 
1479
1193
        self.how = how
1480
1194
 
1481
1195
 
1482
 
class SHA1KnitCorrupt(KnitCorrupt):
1483
 
 
1484
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1485
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1486
 
        "sha %(actual)s")
1487
 
 
1488
 
    def __init__(self, filename, actual, expected, key, content):
1489
 
        KnitError.__init__(self)
1490
 
        self.filename = filename
1491
 
        self.actual = actual
1492
 
        self.expected = expected
1493
 
        self.key = key
1494
 
        self.content = content
1495
 
 
1496
 
 
1497
 
class KnitDataStreamIncompatible(KnitError):
1498
 
    # Not raised anymore, as we can convert data streams.  In future we may
1499
 
    # need it again for more exotic cases, so we're keeping it around for now.
1500
 
 
1501
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1502
 
 
1503
 
    def __init__(self, stream_format, target_format):
1504
 
        self.stream_format = stream_format
1505
 
        self.target_format = target_format
1506
 
 
1507
 
 
1508
 
class KnitDataStreamUnknown(KnitError):
1509
 
    # Indicates a data stream we don't know how to handle.
1510
 
 
1511
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1512
 
 
1513
 
    def __init__(self, stream_format):
1514
 
        self.stream_format = stream_format
1515
 
 
1516
 
 
1517
 
class KnitHeaderError(KnitError):
1518
 
 
1519
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1520
 
 
1521
 
    def __init__(self, badline, filename):
1522
 
        KnitError.__init__(self)
1523
 
        self.badline = badline
1524
 
        self.filename = filename
1525
 
 
1526
1196
class KnitIndexUnknownMethod(KnitError):
1527
1197
    """Raised when we don't understand the storage method.
1528
1198
 
1529
1199
    Currently only 'fulltext' and 'line-delta' are supported.
1530
1200
    """
1531
 
 
 
1201
    
1532
1202
    _fmt = ("Knit index %(filename)s does not have a known method"
1533
1203
            " in options: %(options)r")
1534
1204
 
1538
1208
        self.options = options
1539
1209
 
1540
1210
 
1541
 
class RetryWithNewPacks(BzrError):
1542
 
    """Raised when we realize that the packs on disk have changed.
1543
 
 
1544
 
    This is meant as more of a signaling exception, to trap between where a
1545
 
    local error occurred and the code that can actually handle the error and
1546
 
    code that can retry appropriately.
1547
 
    """
1548
 
 
1549
 
    internal_error = True
1550
 
 
1551
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1552
 
            " %(orig_error)s")
1553
 
 
1554
 
    def __init__(self, context, reload_occurred, exc_info):
1555
 
        """create a new RetryWithNewPacks error.
1556
 
 
1557
 
        :param reload_occurred: Set to True if we know that the packs have
1558
 
            already been reloaded, and we are failing because of an in-memory
1559
 
            cache miss. If set to True then we will ignore if a reload says
1560
 
            nothing has changed, because we assume it has already reloaded. If
1561
 
            False, then a reload with nothing changed will force an error.
1562
 
        :param exc_info: The original exception traceback, so if there is a
1563
 
            problem we can raise the original error (value from sys.exc_info())
1564
 
        """
1565
 
        BzrError.__init__(self)
1566
 
        self.reload_occurred = reload_occurred
1567
 
        self.exc_info = exc_info
1568
 
        self.orig_error = exc_info[1]
1569
 
        # TODO: The global error handler should probably treat this by
1570
 
        #       raising/printing the original exception with a bit about
1571
 
        #       RetryWithNewPacks also not being caught
1572
 
 
1573
 
 
1574
 
class RetryAutopack(RetryWithNewPacks):
1575
 
    """Raised when we are autopacking and we find a missing file.
1576
 
 
1577
 
    Meant as a signaling exception, to tell the autopack code it should try
1578
 
    again.
1579
 
    """
1580
 
 
1581
 
    internal_error = True
1582
 
 
1583
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1584
 
            " context: %(context)s %(orig_error)s")
1585
 
 
1586
 
 
1587
1211
class NoSuchExportFormat(BzrError):
1588
 
 
 
1212
    
1589
1213
    _fmt = "Export format %(format)r not supported"
1590
1214
 
1591
1215
    def __init__(self, format):
1594
1218
 
1595
1219
 
1596
1220
class TransportError(BzrError):
1597
 
 
 
1221
    
1598
1222
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1599
1223
 
1600
1224
    def __init__(self, msg=None, orig_error=None):
1609
1233
        BzrError.__init__(self)
1610
1234
 
1611
1235
 
1612
 
class TooManyConcurrentRequests(InternalBzrError):
 
1236
class TooManyConcurrentRequests(BzrError):
1613
1237
 
1614
1238
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1615
1239
            " Be sure to finish_writing and finish_reading on the"
1616
 
            " currently open request.")
 
1240
            " current request that is open.")
 
1241
 
 
1242
    internal_error = True
1617
1243
 
1618
1244
    def __init__(self, medium):
1619
1245
        self.medium = medium
1627
1253
        self.details = details
1628
1254
 
1629
1255
 
1630
 
class UnexpectedProtocolVersionMarker(TransportError):
1631
 
 
1632
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1633
 
 
1634
 
    def __init__(self, marker):
1635
 
        self.marker = marker
1636
 
 
1637
 
 
1638
 
class UnknownSmartMethod(InternalBzrError):
1639
 
 
1640
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1641
 
 
1642
 
    def __init__(self, verb):
1643
 
        self.verb = verb
1644
 
 
1645
 
 
1646
 
class SmartMessageHandlerError(InternalBzrError):
1647
 
 
1648
 
    _fmt = ("The message handler raised an exception:\n"
1649
 
            "%(traceback_text)s")
1650
 
 
1651
 
    def __init__(self, exc_info):
1652
 
        import traceback
1653
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1654
 
        self.exc_info = exc_info
1655
 
        traceback_strings = traceback.format_exception(
1656
 
                self.exc_type, self.exc_value, self.exc_tb)
1657
 
        self.traceback_text = ''.join(traceback_strings)
1658
 
 
1659
 
 
1660
1256
# A set of semi-meaningful errors which can be thrown
1661
1257
class TransportNotPossible(TransportError):
1662
1258
 
1687
1283
            self.port = ':%s' % port
1688
1284
 
1689
1285
 
1690
 
# XXX: This is also used for unexpected end of file, which is different at the
1691
 
# TCP level from "connection reset".
1692
1286
class ConnectionReset(TransportError):
1693
1287
 
1694
1288
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1696
1290
 
1697
1291
class InvalidRange(TransportError):
1698
1292
 
1699
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1700
 
 
1701
 
    def __init__(self, path, offset, msg=None):
1702
 
        TransportError.__init__(self, msg)
 
1293
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1294
    
 
1295
    def __init__(self, path, offset):
 
1296
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1297
                                       % (path, offset)))
1703
1298
        self.path = path
1704
1299
        self.offset = offset
1705
1300
 
1716
1311
class InvalidHttpRange(InvalidHttpResponse):
1717
1312
 
1718
1313
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1719
 
 
 
1314
    
1720
1315
    def __init__(self, path, range, msg):
1721
1316
        self.range = range
1722
1317
        InvalidHttpResponse.__init__(self, path, msg)
1725
1320
class InvalidHttpContentType(InvalidHttpResponse):
1726
1321
 
1727
1322
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1728
 
 
 
1323
    
1729
1324
    def __init__(self, path, ctype, msg):
1730
1325
        self.ctype = ctype
1731
1326
        InvalidHttpResponse.__init__(self, path, msg)
1735
1330
 
1736
1331
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1737
1332
 
1738
 
    def __init__(self, source, target, is_permanent=False):
 
1333
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1739
1334
        self.source = source
1740
1335
        self.target = target
1741
 
        if is_permanent:
 
1336
        if is_permament:
1742
1337
            self.permanently = ' permanently'
1743
1338
        else:
1744
1339
            self.permanently = ''
 
1340
        self.is_permament = is_permament
 
1341
        self._qualified_proto = qual_proto
1745
1342
        TransportError.__init__(self)
1746
1343
 
 
1344
    def _requalify_url(self, url):
 
1345
        """Restore the qualified proto in front of the url"""
 
1346
        # When this exception is raised, source and target are in
 
1347
        # user readable format. But some transports may use a
 
1348
        # different proto (http+urllib:// will present http:// to
 
1349
        # the user. If a qualified proto is specified, the code
 
1350
        # trapping the exception can get the qualified urls to
 
1351
        # properly handle the redirection themself (creating a
 
1352
        # new transport object from the target url for example).
 
1353
        # But checking that the scheme of the original and
 
1354
        # redirected urls are the same can be tricky. (see the
 
1355
        # FIXME in BzrDir.open_from_transport for the unique use
 
1356
        # case so far).
 
1357
        if self._qualified_proto is None:
 
1358
            return url
 
1359
 
 
1360
        # The TODO related to NotBranchError mention that doing
 
1361
        # that kind of manipulation on the urls may not be the
 
1362
        # exception object job. On the other hand, this object is
 
1363
        # the interface between the code and the user so
 
1364
        # presenting the urls in different ways is indeed its
 
1365
        # job...
 
1366
        import urlparse
 
1367
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1368
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1369
                                   query, fragment))
 
1370
 
 
1371
    def get_source_url(self):
 
1372
        return self._requalify_url(self.source)
 
1373
 
 
1374
    def get_target_url(self):
 
1375
        return self._requalify_url(self.target)
 
1376
 
1747
1377
 
1748
1378
class TooManyRedirections(TransportError):
1749
1379
 
1750
1380
    _fmt = "Too many redirections"
1751
1381
 
1752
 
 
1753
1382
class ConflictsInTree(BzrError):
1754
1383
 
1755
1384
    _fmt = "Working tree has conflicts."
1761
1390
        if filename is None:
1762
1391
            filename = ""
1763
1392
        message = "Error(s) parsing config file %s:\n%s" % \
1764
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1393
            (filename, ('\n'.join(e.message for e in errors)))
1765
1394
        BzrError.__init__(self, message)
1766
1395
 
1767
1396
 
1776
1405
 
1777
1406
class SigningFailed(BzrError):
1778
1407
 
1779
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1408
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1780
1409
 
1781
1410
    def __init__(self, command_line):
1782
1411
        BzrError.__init__(self, command_line=command_line)
1784
1413
 
1785
1414
class WorkingTreeNotRevision(BzrError):
1786
1415
 
1787
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1416
    _fmt = ("The working tree for %(basedir)s has changed since" 
1788
1417
            " the last commit, but weave merge requires that it be"
1789
1418
            " unchanged")
1790
1419
 
1807
1436
        self.graph = graph
1808
1437
 
1809
1438
 
1810
 
class WritingCompleted(InternalBzrError):
 
1439
class WritingCompleted(BzrError):
1811
1440
 
1812
1441
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1813
1442
            "called upon it - accept bytes may not be called anymore.")
1814
1443
 
 
1444
    internal_error = True
 
1445
 
1815
1446
    def __init__(self, request):
1816
1447
        self.request = request
1817
1448
 
1818
1449
 
1819
 
class WritingNotComplete(InternalBzrError):
 
1450
class WritingNotComplete(BzrError):
1820
1451
 
1821
1452
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1822
1453
            "called upon it - until the write phase is complete no "
1823
1454
            "data may be read.")
1824
1455
 
 
1456
    internal_error = True
 
1457
 
1825
1458
    def __init__(self, request):
1826
1459
        self.request = request
1827
1460
 
1835
1468
        self.filename = filename
1836
1469
 
1837
1470
 
1838
 
class MediumNotConnected(InternalBzrError):
 
1471
class MediumNotConnected(BzrError):
1839
1472
 
1840
1473
    _fmt = """The medium '%(medium)s' is not connected."""
1841
1474
 
 
1475
    internal_error = True
 
1476
 
1842
1477
    def __init__(self, medium):
1843
1478
        self.medium = medium
1844
1479
 
1850
1485
 
1851
1486
class NoBundleFound(BzrError):
1852
1487
 
1853
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1488
    _fmt = "No bundle was found in %(filename)s"
1854
1489
 
1855
1490
    def __init__(self, filename):
1856
1491
        BzrError.__init__(self)
1895
1530
    _fmt = "Key %(key)s is already present in map"
1896
1531
 
1897
1532
 
1898
 
class DuplicateHelpPrefix(BzrError):
1899
 
 
1900
 
    _fmt = "The prefix %(prefix)s is in the help search path twice."
1901
 
 
1902
 
    def __init__(self, prefix):
1903
 
        self.prefix = prefix
1904
 
 
1905
 
 
1906
1533
class MalformedTransform(BzrError):
1907
1534
 
1908
1535
    _fmt = "Tree transform is malformed %(conflicts)r"
1920
1547
        self.root_trans_id = transform.root
1921
1548
 
1922
1549
 
1923
 
class BzrBadParameter(InternalBzrError):
 
1550
class BzrBadParameter(BzrError):
1924
1551
 
1925
1552
    _fmt = "Bad parameter: %(param)r"
1926
1553
 
1947
1574
    _fmt = "Moving the root directory is not supported at this time"
1948
1575
 
1949
1576
 
1950
 
class TransformRenameFailed(BzrError):
1951
 
 
1952
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1953
 
 
1954
 
    def __init__(self, from_path, to_path, why, errno):
1955
 
        self.from_path = from_path
1956
 
        self.to_path = to_path
1957
 
        self.why = why
1958
 
        self.errno = errno
1959
 
 
1960
 
 
1961
1577
class BzrMoveFailedError(BzrError):
1962
1578
 
1963
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1964
 
        "%(_has_extra)s%(extra)s")
 
1579
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1965
1580
 
1966
1581
    def __init__(self, from_path='', to_path='', extra=None):
1967
 
        from bzrlib.osutils import splitpath
1968
1582
        BzrError.__init__(self)
1969
1583
        if extra:
1970
 
            self.extra, self._has_extra = extra, ': '
 
1584
            self.extra = ': ' + str(extra)
1971
1585
        else:
1972
 
            self.extra = self._has_extra = ''
 
1586
            self.extra = ''
1973
1587
 
1974
1588
        has_from = len(from_path) > 0
1975
1589
        has_to = len(to_path) > 0
1976
1590
        if has_from:
1977
 
            self.from_path = splitpath(from_path)[-1]
 
1591
            self.from_path = osutils.splitpath(from_path)[-1]
1978
1592
        else:
1979
1593
            self.from_path = ''
1980
1594
 
1981
1595
        if has_to:
1982
 
            self.to_path = splitpath(to_path)[-1]
 
1596
            self.to_path = osutils.splitpath(to_path)[-1]
1983
1597
        else:
1984
1598
            self.to_path = ''
1985
1599
 
1996
1610
 
1997
1611
class BzrRenameFailedError(BzrMoveFailedError):
1998
1612
 
1999
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2000
 
        "%(_has_extra)s%(extra)s")
 
1613
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2001
1614
 
2002
1615
    def __init__(self, from_path, to_path, extra=None):
2003
1616
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2004
1617
 
2005
1618
 
2006
 
class BzrRemoveChangedFilesError(BzrError):
2007
 
    """Used when user is trying to remove changed files."""
2008
 
 
2009
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2010
 
        "%(changes_as_text)s"
2011
 
        "Use --keep to not delete them, or --force to delete them regardless.")
2012
 
 
2013
 
    def __init__(self, tree_delta):
2014
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2015
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2016
 
        BzrError.__init__(self)
2017
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2018
 
        #self.paths_as_string = '\n'.join(changed_files)
2019
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2020
 
 
2021
 
 
2022
1619
class BzrBadParameterNotString(BzrBadParameter):
2023
1620
 
2024
1621
    _fmt = "Parameter %(param)s is not a string or unicode string."
2026
1623
 
2027
1624
class BzrBadParameterMissing(BzrBadParameter):
2028
1625
 
2029
 
    _fmt = "Parameter %(param)s is required but not present."
 
1626
    _fmt = "Parameter $(param)s is required but not present."
2030
1627
 
2031
1628
 
2032
1629
class BzrBadParameterUnicode(BzrBadParameter):
2072
1669
 
2073
1670
class BadConversionTarget(BzrError):
2074
1671
 
2075
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2076
 
            "    %(problem)s"
 
1672
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2077
1673
 
2078
 
    def __init__(self, problem, format, from_format=None):
 
1674
    def __init__(self, problem, format):
2079
1675
        BzrError.__init__(self)
2080
1676
        self.problem = problem
2081
1677
        self.format = format
2082
 
        self.from_format = from_format or '(unspecified)'
2083
 
 
2084
 
 
2085
 
class NoDiffFound(BzrError):
2086
 
 
2087
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2088
 
 
2089
 
    def __init__(self, path):
2090
 
        BzrError.__init__(self, path)
2091
 
 
2092
 
 
2093
 
class ExecutableMissing(BzrError):
2094
 
 
2095
 
    _fmt = "%(exe_name)s could not be found on this machine"
2096
 
 
2097
 
    def __init__(self, exe_name):
2098
 
        BzrError.__init__(self, exe_name=exe_name)
2099
1678
 
2100
1679
 
2101
1680
class NoDiff(BzrError):
2111
1690
    _fmt = "Diff3 is not installed on this machine."
2112
1691
 
2113
1692
 
2114
 
class ExistingContent(BzrError):
2115
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2116
 
 
2117
 
    _fmt = "The content being inserted is already present."
2118
 
 
2119
 
 
2120
1693
class ExistingLimbo(BzrError):
2121
1694
 
2122
1695
    _fmt = """This tree contains left-over files from a failed operation.
2123
1696
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2124
1697
    keep, and delete it when you are done."""
2125
 
 
 
1698
    
2126
1699
    def __init__(self, limbo_dir):
2127
1700
       BzrError.__init__(self)
2128
1701
       self.limbo_dir = limbo_dir
2129
1702
 
2130
1703
 
2131
 
class ExistingPendingDeletion(BzrError):
2132
 
 
2133
 
    _fmt = """This tree contains left-over files from a failed operation.
2134
 
    Please examine %(pending_deletion)s to see if it contains any files you
2135
 
    wish to keep, and delete it when you are done."""
2136
 
 
2137
 
    def __init__(self, pending_deletion):
2138
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2139
 
 
2140
 
 
2141
1704
class ImmortalLimbo(BzrError):
2142
1705
 
2143
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1706
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2144
1707
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2145
1708
    keep, and delete it when you are done."""
2146
1709
 
2149
1712
       self.limbo_dir = limbo_dir
2150
1713
 
2151
1714
 
2152
 
class ImmortalPendingDeletion(BzrError):
2153
 
 
2154
 
    _fmt = ("Unable to delete transform temporary directory "
2155
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2156
 
    "contains any files you wish to keep, and delete it when you are done.")
2157
 
 
2158
 
    def __init__(self, pending_deletion):
2159
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2160
 
 
2161
 
 
2162
1715
class OutOfDateTree(BzrError):
2163
1716
 
2164
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1717
    _fmt = "Working tree is out of date, please run 'bzr update'."
2165
1718
 
2166
 
    def __init__(self, tree, more=None):
2167
 
        if more is None:
2168
 
            more = ''
2169
 
        else:
2170
 
            more = ' ' + more
 
1719
    def __init__(self, tree):
2171
1720
        BzrError.__init__(self)
2172
1721
        self.tree = tree
2173
 
        self.more = more
2174
1722
 
2175
1723
 
2176
1724
class PublicBranchOutOfDate(BzrError):
2196
1744
    _fmt = "Format error in conflict listings"
2197
1745
 
2198
1746
 
2199
 
class CorruptDirstate(BzrError):
2200
 
 
2201
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2202
 
            "Error: %(description)s")
2203
 
 
2204
 
    def __init__(self, dirstate_path, description):
2205
 
        BzrError.__init__(self)
2206
 
        self.dirstate_path = dirstate_path
2207
 
        self.description = description
2208
 
 
2209
 
 
2210
1747
class CorruptRepository(BzrError):
2211
1748
 
2212
1749
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2214
1751
 
2215
1752
    def __init__(self, repo):
2216
1753
        BzrError.__init__(self)
2217
 
        self.repo_path = repo.user_url
2218
 
 
2219
 
 
2220
 
class InconsistentDelta(BzrError):
2221
 
    """Used when we get a delta that is not valid."""
2222
 
 
2223
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2224
 
            " %(file_id)r\nreason: %(reason)s")
2225
 
 
2226
 
    def __init__(self, path, file_id, reason):
2227
 
        BzrError.__init__(self)
2228
 
        self.path = path
2229
 
        self.file_id = file_id
2230
 
        self.reason = reason
2231
 
 
2232
 
 
2233
 
class InconsistentDeltaDelta(InconsistentDelta):
2234
 
    """Used when we get a delta that is not valid."""
2235
 
 
2236
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2237
 
            "\nreason: %(reason)s")
2238
 
 
2239
 
    def __init__(self, delta, reason):
2240
 
        BzrError.__init__(self)
2241
 
        self.delta = delta
2242
 
        self.reason = reason
 
1754
        self.repo_path = repo.bzrdir.root_transport.base
2243
1755
 
2244
1756
 
2245
1757
class UpgradeRequired(BzrError):
2251
1763
        self.path = path
2252
1764
 
2253
1765
 
2254
 
class RepositoryUpgradeRequired(UpgradeRequired):
2255
 
 
2256
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2257
 
 
2258
 
 
2259
 
class RichRootUpgradeRequired(UpgradeRequired):
2260
 
 
2261
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2262
 
           " a format which supports rich roots.")
2263
 
 
2264
 
 
2265
1766
class LocalRequiresBoundBranch(BzrError):
2266
1767
 
2267
1768
    _fmt = "Cannot perform local-only commits on unbound branches."
2268
1769
 
2269
1770
 
 
1771
class MissingProgressBarFinish(BzrError):
 
1772
 
 
1773
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1774
 
 
1775
 
 
1776
class InvalidProgressBarType(BzrError):
 
1777
 
 
1778
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1779
            " is not a supported type Select one of: %(valid_types)s")
 
1780
 
 
1781
    def __init__(self, bar_type, valid_types):
 
1782
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1783
 
 
1784
 
2270
1785
class UnsupportedOperation(BzrError):
2271
1786
 
2272
1787
    _fmt = ("The method %(mname)s is not supported on"
2289
1804
 
2290
1805
 
2291
1806
class BinaryFile(BzrError):
2292
 
 
 
1807
    
2293
1808
    _fmt = "File is binary but should be text."
2294
1809
 
2295
1810
 
2315
1830
 
2316
1831
 
2317
1832
class NotABundle(BzrError):
2318
 
 
 
1833
    
2319
1834
    _fmt = "Not a bzr revision-bundle: %(text)r"
2320
1835
 
2321
1836
    def __init__(self, text):
2323
1838
        self.text = text
2324
1839
 
2325
1840
 
2326
 
class BadBundle(BzrError):
2327
 
 
 
1841
class BadBundle(BzrError): 
 
1842
    
2328
1843
    _fmt = "Bad bzr revision-bundle: %(text)r"
2329
1844
 
2330
1845
    def __init__(self, text):
2332
1847
        self.text = text
2333
1848
 
2334
1849
 
2335
 
class MalformedHeader(BadBundle):
2336
 
 
 
1850
class MalformedHeader(BadBundle): 
 
1851
    
2337
1852
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2338
1853
 
2339
1854
 
2340
 
class MalformedPatches(BadBundle):
2341
 
 
 
1855
class MalformedPatches(BadBundle): 
 
1856
    
2342
1857
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2343
1858
 
2344
1859
 
2345
 
class MalformedFooter(BadBundle):
2346
 
 
 
1860
class MalformedFooter(BadBundle): 
 
1861
    
2347
1862
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2348
1863
 
2349
1864
 
2350
1865
class UnsupportedEOLMarker(BadBundle):
2351
 
 
2352
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1866
    
 
1867
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2353
1868
 
2354
1869
    def __init__(self):
2355
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1870
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2356
1871
        # but for this there is not
2357
1872
        BzrError.__init__(self)
2358
1873
 
2359
1874
 
2360
1875
class IncompatibleBundleFormat(BzrError):
2361
 
 
 
1876
    
2362
1877
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2363
1878
 
2364
1879
    def __init__(self, bundle_format, other):
2368
1883
 
2369
1884
 
2370
1885
class BadInventoryFormat(BzrError):
2371
 
 
 
1886
    
2372
1887
    _fmt = "Root class for inventory serialization errors"
2373
1888
 
2374
1889
 
2385
1900
    _fmt = """This operation requires rich root data storage"""
2386
1901
 
2387
1902
 
2388
 
class NoSmartMedium(InternalBzrError):
 
1903
class NoSmartMedium(BzrError):
2389
1904
 
2390
1905
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2391
1906
 
 
1907
    internal_error = True
 
1908
 
2392
1909
    def __init__(self, transport):
2393
1910
        self.transport = transport
2394
1911
 
2395
1912
 
 
1913
class NoSmartServer(NotBranchError):
 
1914
 
 
1915
    _fmt = "No smart server available at %(url)s"
 
1916
 
 
1917
    def __init__(self, url):
 
1918
        self.url = url
 
1919
 
 
1920
 
2396
1921
class UnknownSSH(BzrError):
2397
1922
 
2398
1923
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2408
1933
            " Please set BZR_SSH environment variable.")
2409
1934
 
2410
1935
 
2411
 
class GhostRevisionsHaveNoRevno(BzrError):
2412
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2413
 
 
2414
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2415
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2416
 
 
2417
 
    def __init__(self, revision_id, ghost_revision_id):
2418
 
        self.revision_id = revision_id
2419
 
        self.ghost_revision_id = ghost_revision_id
2420
 
 
2421
 
 
2422
1936
class GhostRevisionUnusableHere(BzrError):
2423
1937
 
2424
1938
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2428
1942
        self.revision_id = revision_id
2429
1943
 
2430
1944
 
2431
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
1945
class IllegalUseOfScopeReplacer(BzrError):
2432
1946
 
2433
1947
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2434
1948
            " %(msg)s%(extra)s")
2435
1949
 
 
1950
    internal_error = True
 
1951
 
2436
1952
    def __init__(self, name, msg, extra=None):
2437
1953
        BzrError.__init__(self)
2438
1954
        self.name = name
2443
1959
            self.extra = ''
2444
1960
 
2445
1961
 
2446
 
class InvalidImportLine(InternalBzrError):
 
1962
class InvalidImportLine(BzrError):
2447
1963
 
2448
1964
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2449
1965
 
 
1966
    internal_error = True
 
1967
 
2450
1968
    def __init__(self, text, msg):
2451
1969
        BzrError.__init__(self)
2452
1970
        self.text = text
2453
1971
        self.msg = msg
2454
1972
 
2455
1973
 
2456
 
class ImportNameCollision(InternalBzrError):
 
1974
class ImportNameCollision(BzrError):
2457
1975
 
2458
1976
    _fmt = ("Tried to import an object to the same name as"
2459
1977
            " an existing object. %(name)s")
2460
1978
 
 
1979
    internal_error = True
 
1980
 
2461
1981
    def __init__(self, name):
2462
1982
        BzrError.__init__(self)
2463
1983
        self.name = name
2476
1996
        " branch location."
2477
1997
 
2478
1998
 
2479
 
class IllegalMergeDirectivePayload(BzrError):
2480
 
    """A merge directive contained something other than a patch or bundle"""
2481
 
 
2482
 
    _fmt = "Bad merge directive payload %(start)r"
2483
 
 
2484
 
    def __init__(self, start):
2485
 
        BzrError(self)
2486
 
        self.start = start
2487
 
 
2488
 
 
2489
 
class PatchVerificationFailed(BzrError):
2490
 
    """A patch from a merge directive could not be verified"""
2491
 
 
2492
 
    _fmt = "Preview patch does not match requested changes."
2493
 
 
2494
 
 
2495
1999
class PatchMissing(BzrError):
2496
2000
    """Raise a patch type was specified but no patch supplied"""
2497
2001
 
2498
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2002
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2499
2003
 
2500
2004
    def __init__(self, patch_type):
2501
2005
        BzrError.__init__(self)
2502
2006
        self.patch_type = patch_type
2503
2007
 
2504
2008
 
2505
 
class TargetNotBranch(BzrError):
2506
 
    """A merge directive's target branch is required, but isn't a branch"""
2507
 
 
2508
 
    _fmt = ("Your branch does not have all of the revisions required in "
2509
 
            "order to merge this merge directive and the target "
2510
 
            "location specified in the merge directive is not a branch: "
2511
 
            "%(location)s.")
2512
 
 
2513
 
    def __init__(self, location):
2514
 
        BzrError.__init__(self)
2515
 
        self.location = location
2516
 
 
2517
 
 
2518
2009
class UnsupportedInventoryKind(BzrError):
2519
 
 
 
2010
    
2520
2011
    _fmt = """Unsupported entry kind %(kind)s"""
2521
2012
 
2522
2013
    def __init__(self, kind):
2525
2016
 
2526
2017
class BadSubsumeSource(BzrError):
2527
2018
 
2528
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2019
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2529
2020
 
2530
2021
    def __init__(self, tree, other_tree, reason):
2531
2022
        self.tree = tree
2534
2025
 
2535
2026
 
2536
2027
class SubsumeTargetNeedsUpgrade(BzrError):
2537
 
 
 
2028
    
2538
2029
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2539
2030
 
2540
2031
    def __init__(self, other_tree):
2541
2032
        self.other_tree = other_tree
2542
2033
 
2543
2034
 
2544
 
class BadReferenceTarget(InternalBzrError):
2545
 
 
2546
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2547
 
           "%(reason)s"
 
2035
class BadReferenceTarget(BzrError):
 
2036
 
 
2037
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2038
 
 
2039
    internal_error = True
2548
2040
 
2549
2041
    def __init__(self, tree, other_tree, reason):
2550
2042
        self.tree = tree
2563
2055
class TagsNotSupported(BzrError):
2564
2056
 
2565
2057
    _fmt = ("Tags not supported by %(branch)s;"
2566
 
            " you may be able to use bzr upgrade.")
 
2058
            " you may be able to use bzr upgrade --dirstate-tags.")
2567
2059
 
2568
2060
    def __init__(self, branch):
2569
2061
        self.branch = branch
2570
2062
 
2571
 
 
 
2063
        
2572
2064
class TagAlreadyExists(BzrError):
2573
2065
 
2574
2066
    _fmt = "Tag %(tag_name)s already exists."
2575
2067
 
2576
2068
    def __init__(self, tag_name):
2577
2069
        self.tag_name = tag_name
2578
 
 
2579
 
 
2580
 
class MalformedBugIdentifier(BzrError):
2581
 
 
2582
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2583
 
            'See "bzr help bugs" for more information on this feature.')
2584
 
 
2585
 
    def __init__(self, bug_id, reason):
2586
 
        self.bug_id = bug_id
2587
 
        self.reason = reason
2588
 
 
2589
 
 
2590
 
class InvalidBugTrackerURL(BzrError):
2591
 
 
2592
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2593
 
            "contain {id}: %(url)s")
2594
 
 
2595
 
    def __init__(self, abbreviation, url):
2596
 
        self.abbreviation = abbreviation
2597
 
        self.url = url
2598
 
 
2599
 
 
2600
 
class UnknownBugTrackerAbbreviation(BzrError):
2601
 
 
2602
 
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2603
 
            "on %(branch)s")
2604
 
 
2605
 
    def __init__(self, abbreviation, branch):
2606
 
        self.abbreviation = abbreviation
2607
 
        self.branch = branch
2608
 
 
2609
 
 
2610
 
class InvalidLineInBugsProperty(BzrError):
2611
 
 
2612
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2613
 
 
2614
 
    def __init__(self, line):
2615
 
        self.line = line
2616
 
 
2617
 
 
2618
 
class InvalidBugStatus(BzrError):
2619
 
 
2620
 
    _fmt = ("Invalid bug status: '%(status)s'")
2621
 
 
2622
 
    def __init__(self, status):
2623
 
        self.status = status
2624
 
 
2625
 
 
2626
 
class UnexpectedSmartServerResponse(BzrError):
2627
 
 
2628
 
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2629
 
 
2630
 
    def __init__(self, response_tuple):
2631
 
        self.response_tuple = response_tuple
2632
 
 
2633
 
 
2634
 
class ErrorFromSmartServer(BzrError):
2635
 
    """An error was received from a smart server.
2636
 
 
2637
 
    :seealso: UnknownErrorFromSmartServer
2638
 
    """
2639
 
 
2640
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2641
 
 
2642
 
    internal_error = True
2643
 
 
2644
 
    def __init__(self, error_tuple):
2645
 
        self.error_tuple = error_tuple
2646
 
        try:
2647
 
            self.error_verb = error_tuple[0]
2648
 
        except IndexError:
2649
 
            self.error_verb = None
2650
 
        self.error_args = error_tuple[1:]
2651
 
 
2652
 
 
2653
 
class UnknownErrorFromSmartServer(BzrError):
2654
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2655
 
    error.
2656
 
 
2657
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2658
 
    distinguish between the following two cases:
2659
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2660
 
        and so should provoke a traceback to the user.
2661
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2662
 
        translated.  This is probably because the server sent us garbage, and
2663
 
        should not provoke a traceback.
2664
 
    """
2665
 
 
2666
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2667
 
 
2668
 
    internal_error = False
2669
 
 
2670
 
    def __init__(self, error_from_smart_server):
2671
 
        """Constructor.
2672
 
 
2673
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2674
 
        """
2675
 
        self.error_from_smart_server = error_from_smart_server
2676
 
        self.error_tuple = error_from_smart_server.error_tuple
2677
 
 
2678
 
 
2679
 
class ContainerError(BzrError):
2680
 
    """Base class of container errors."""
2681
 
 
2682
 
 
2683
 
class UnknownContainerFormatError(ContainerError):
2684
 
 
2685
 
    _fmt = "Unrecognised container format: %(container_format)r"
2686
 
 
2687
 
    def __init__(self, container_format):
2688
 
        self.container_format = container_format
2689
 
 
2690
 
 
2691
 
class UnexpectedEndOfContainerError(ContainerError):
2692
 
 
2693
 
    _fmt = "Unexpected end of container stream"
2694
 
 
2695
 
 
2696
 
class UnknownRecordTypeError(ContainerError):
2697
 
 
2698
 
    _fmt = "Unknown record type: %(record_type)r"
2699
 
 
2700
 
    def __init__(self, record_type):
2701
 
        self.record_type = record_type
2702
 
 
2703
 
 
2704
 
class InvalidRecordError(ContainerError):
2705
 
 
2706
 
    _fmt = "Invalid record: %(reason)s"
2707
 
 
2708
 
    def __init__(self, reason):
2709
 
        self.reason = reason
2710
 
 
2711
 
 
2712
 
class ContainerHasExcessDataError(ContainerError):
2713
 
 
2714
 
    _fmt = "Container has data after end marker: %(excess)r"
2715
 
 
2716
 
    def __init__(self, excess):
2717
 
        self.excess = excess
2718
 
 
2719
 
 
2720
 
class DuplicateRecordNameError(ContainerError):
2721
 
 
2722
 
    _fmt = "Container has multiple records with the same name: %(name)s"
2723
 
 
2724
 
    def __init__(self, name):
2725
 
        self.name = name
2726
 
 
2727
 
 
2728
 
class NoDestinationAddress(InternalBzrError):
2729
 
 
2730
 
    _fmt = "Message does not have a destination address."
2731
 
 
2732
 
 
2733
 
class RepositoryDataStreamError(BzrError):
2734
 
 
2735
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2736
 
 
2737
 
    def __init__(self, reason):
2738
 
        self.reason = reason
2739
 
 
2740
 
 
2741
 
class SMTPError(BzrError):
2742
 
 
2743
 
    _fmt = "SMTP error: %(error)s"
2744
 
 
2745
 
    def __init__(self, error):
2746
 
        self.error = error
2747
 
 
2748
 
 
2749
 
class NoMessageSupplied(BzrError):
2750
 
 
2751
 
    _fmt = "No message supplied."
2752
 
 
2753
 
 
2754
 
class NoMailAddressSpecified(BzrError):
2755
 
 
2756
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2757
 
 
2758
 
 
2759
 
class UnknownMailClient(BzrError):
2760
 
 
2761
 
    _fmt = "Unknown mail client: %(mail_client)s"
2762
 
 
2763
 
    def __init__(self, mail_client):
2764
 
        BzrError.__init__(self, mail_client=mail_client)
2765
 
 
2766
 
 
2767
 
class MailClientNotFound(BzrError):
2768
 
 
2769
 
    _fmt = "Unable to find mail client with the following names:"\
2770
 
        " %(mail_command_list_string)s"
2771
 
 
2772
 
    def __init__(self, mail_command_list):
2773
 
        mail_command_list_string = ', '.join(mail_command_list)
2774
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2775
 
                          mail_command_list_string=mail_command_list_string)
2776
 
 
2777
 
class SMTPConnectionRefused(SMTPError):
2778
 
 
2779
 
    _fmt = "SMTP connection to %(host)s refused"
2780
 
 
2781
 
    def __init__(self, error, host):
2782
 
        self.error = error
2783
 
        self.host = host
2784
 
 
2785
 
 
2786
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2787
 
 
2788
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2789
 
 
2790
 
 
2791
 
class BzrDirError(BzrError):
2792
 
 
2793
 
    def __init__(self, bzrdir):
2794
 
        import bzrlib.urlutils as urlutils
2795
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2796
 
                                                    'ascii')
2797
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2798
 
 
2799
 
 
2800
 
class UnsyncedBranches(BzrDirError):
2801
 
 
2802
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2803
 
            " bzr help sync-for-reconfigure.")
2804
 
 
2805
 
    def __init__(self, bzrdir, target_branch):
2806
 
        BzrDirError.__init__(self, bzrdir)
2807
 
        import bzrlib.urlutils as urlutils
2808
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2809
 
                                                        'ascii')
2810
 
 
2811
 
 
2812
 
class AlreadyBranch(BzrDirError):
2813
 
 
2814
 
    _fmt = "'%(display_url)s' is already a branch."
2815
 
 
2816
 
 
2817
 
class AlreadyTree(BzrDirError):
2818
 
 
2819
 
    _fmt = "'%(display_url)s' is already a tree."
2820
 
 
2821
 
 
2822
 
class AlreadyCheckout(BzrDirError):
2823
 
 
2824
 
    _fmt = "'%(display_url)s' is already a checkout."
2825
 
 
2826
 
 
2827
 
class AlreadyLightweightCheckout(BzrDirError):
2828
 
 
2829
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2830
 
 
2831
 
 
2832
 
class AlreadyUsingShared(BzrDirError):
2833
 
 
2834
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2835
 
 
2836
 
 
2837
 
class AlreadyStandalone(BzrDirError):
2838
 
 
2839
 
    _fmt = "'%(display_url)s' is already standalone."
2840
 
 
2841
 
 
2842
 
class AlreadyWithTrees(BzrDirError):
2843
 
 
2844
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2845
 
            "working trees.")
2846
 
 
2847
 
 
2848
 
class AlreadyWithNoTrees(BzrDirError):
2849
 
 
2850
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2851
 
            "working trees.")
2852
 
 
2853
 
 
2854
 
class ReconfigurationNotSupported(BzrDirError):
2855
 
 
2856
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2857
 
 
2858
 
 
2859
 
class NoBindLocation(BzrDirError):
2860
 
 
2861
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2862
 
 
2863
 
 
2864
 
class UncommittedChanges(BzrError):
2865
 
 
2866
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2867
 
            ' (See bzr status).%(more)s')
2868
 
 
2869
 
    def __init__(self, tree, more=None):
2870
 
        if more is None:
2871
 
            more = ''
2872
 
        else:
2873
 
            more = ' ' + more
2874
 
        import bzrlib.urlutils as urlutils
2875
 
        user_url = getattr(tree, "user_url", None)
2876
 
        if user_url is None:
2877
 
            display_url = str(tree)
2878
 
        else:
2879
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2880
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2881
 
 
2882
 
 
2883
 
class ShelvedChanges(UncommittedChanges):
2884
 
 
2885
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2886
 
            ' (See bzr shelve --list).%(more)s')
2887
 
 
2888
 
 
2889
 
class MissingTemplateVariable(BzrError):
2890
 
 
2891
 
    _fmt = 'Variable {%(name)s} is not available.'
2892
 
 
2893
 
    def __init__(self, name):
2894
 
        self.name = name
2895
 
 
2896
 
 
2897
 
class NoTemplate(BzrError):
2898
 
 
2899
 
    _fmt = 'No template specified.'
2900
 
 
2901
 
 
2902
 
class UnableCreateSymlink(BzrError):
2903
 
 
2904
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2905
 
 
2906
 
    def __init__(self, path=None):
2907
 
        path_str = ''
2908
 
        if path:
2909
 
            try:
2910
 
                path_str = repr(str(path))
2911
 
            except UnicodeEncodeError:
2912
 
                path_str = repr(path)
2913
 
            path_str += ' '
2914
 
        self.path_str = path_str
2915
 
 
2916
 
 
2917
 
class UnsupportedTimezoneFormat(BzrError):
2918
 
 
2919
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2920
 
            'options are "utc", "original", "local".')
2921
 
 
2922
 
    def __init__(self, timezone):
2923
 
        self.timezone = timezone
2924
 
 
2925
 
 
2926
 
class CommandAvailableInPlugin(StandardError):
2927
 
 
2928
 
    internal_error = False
2929
 
 
2930
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2931
 
 
2932
 
        self.plugin_metadata = plugin_metadata
2933
 
        self.cmd_name = cmd_name
2934
 
        self.provider = provider
2935
 
 
2936
 
    def __str__(self):
2937
 
 
2938
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2939
 
                'However, the following official plugin provides this command: %s\n'
2940
 
                'You can install it by going to: %s'
2941
 
                % (self.cmd_name, self.plugin_metadata['name'],
2942
 
                    self.plugin_metadata['url']))
2943
 
 
2944
 
        return _fmt
2945
 
 
2946
 
 
2947
 
class NoPluginAvailable(BzrError):
2948
 
    pass
2949
 
 
2950
 
 
2951
 
class UnableEncodePath(BzrError):
2952
 
 
2953
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2954
 
            'user encoding %(user_encoding)s')
2955
 
 
2956
 
    def __init__(self, path, kind):
2957
 
        from bzrlib.osutils import get_user_encoding
2958
 
        self.path = path
2959
 
        self.kind = kind
2960
 
        self.user_encoding = osutils.get_user_encoding()
2961
 
 
2962
 
 
2963
 
class NoSuchConfig(BzrError):
2964
 
 
2965
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2966
 
 
2967
 
    def __init__(self, config_id):
2968
 
        BzrError.__init__(self, config_id=config_id)
2969
 
 
2970
 
 
2971
 
class NoSuchConfigOption(BzrError):
2972
 
 
2973
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2974
 
 
2975
 
    def __init__(self, option_name):
2976
 
        BzrError.__init__(self, option_name=option_name)
2977
 
 
2978
 
 
2979
 
class NoSuchAlias(BzrError):
2980
 
 
2981
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2982
 
 
2983
 
    def __init__(self, alias_name):
2984
 
        BzrError.__init__(self, alias_name=alias_name)
2985
 
 
2986
 
 
2987
 
class DirectoryLookupFailure(BzrError):
2988
 
    """Base type for lookup errors."""
2989
 
 
2990
 
    pass
2991
 
 
2992
 
 
2993
 
class InvalidLocationAlias(DirectoryLookupFailure):
2994
 
 
2995
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2996
 
 
2997
 
    def __init__(self, alias_name):
2998
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2999
 
 
3000
 
 
3001
 
class UnsetLocationAlias(DirectoryLookupFailure):
3002
 
 
3003
 
    _fmt = 'No %(alias_name)s location assigned.'
3004
 
 
3005
 
    def __init__(self, alias_name):
3006
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
3007
 
 
3008
 
 
3009
 
class CannotBindAddress(BzrError):
3010
 
 
3011
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3012
 
 
3013
 
    def __init__(self, host, port, orig_error):
3014
 
        # nb: in python2.4 socket.error doesn't have a useful repr
3015
 
        BzrError.__init__(self, host=host, port=port,
3016
 
            orig_error=repr(orig_error.args))
3017
 
 
3018
 
 
3019
 
class UnknownRules(BzrError):
3020
 
 
3021
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
3022
 
 
3023
 
    def __init__(self, unknowns):
3024
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3025
 
 
3026
 
 
3027
 
class HookFailed(BzrError):
3028
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3029
 
    than TipChangeRejected.
3030
 
 
3031
 
    Note that this exception is no longer raised, and the import is only left
3032
 
    to be nice to code which might catch it in a plugin.
3033
 
    """
3034
 
 
3035
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3036
 
            "%(traceback_text)s%(exc_value)s")
3037
 
 
3038
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3039
 
        if warn:
3040
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3041
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3042
 
        import traceback
3043
 
        self.hook_stage = hook_stage
3044
 
        self.hook_name = hook_name
3045
 
        self.exc_info = exc_info
3046
 
        self.exc_type = exc_info[0]
3047
 
        self.exc_value = exc_info[1]
3048
 
        self.exc_tb = exc_info[2]
3049
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3050
 
 
3051
 
 
3052
 
class TipChangeRejected(BzrError):
3053
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3054
 
    explicitly abort a change to a branch tip.
3055
 
    """
3056
 
 
3057
 
    _fmt = u"Tip change rejected: %(msg)s"
3058
 
 
3059
 
    def __init__(self, msg):
3060
 
        self.msg = msg
3061
 
 
3062
 
 
3063
 
class ShelfCorrupt(BzrError):
3064
 
 
3065
 
    _fmt = "Shelf corrupt."
3066
 
 
3067
 
 
3068
 
class NoSuchShelfId(BzrError):
3069
 
 
3070
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3071
 
 
3072
 
    def __init__(self, shelf_id):
3073
 
        BzrError.__init__(self, shelf_id=shelf_id)
3074
 
 
3075
 
 
3076
 
class InvalidShelfId(BzrError):
3077
 
 
3078
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3079
 
 
3080
 
    def __init__(self, invalid_id):
3081
 
        BzrError.__init__(self, invalid_id=invalid_id)
3082
 
 
3083
 
 
3084
 
class JailBreak(BzrError):
3085
 
 
3086
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3087
 
 
3088
 
    def __init__(self, url):
3089
 
        BzrError.__init__(self, url=url)
3090
 
 
3091
 
 
3092
 
class UserAbort(BzrError):
3093
 
 
3094
 
    _fmt = 'The user aborted the operation.'
3095
 
 
3096
 
 
3097
 
class MustHaveWorkingTree(BzrError):
3098
 
 
3099
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3100
 
 
3101
 
    def __init__(self, format, url):
3102
 
        BzrError.__init__(self, format=format, url=url)
3103
 
 
3104
 
 
3105
 
class NoSuchView(BzrError):
3106
 
    """A view does not exist.
3107
 
    """
3108
 
 
3109
 
    _fmt = u"No such view: %(view_name)s."
3110
 
 
3111
 
    def __init__(self, view_name):
3112
 
        self.view_name = view_name
3113
 
 
3114
 
 
3115
 
class ViewsNotSupported(BzrError):
3116
 
    """Views are not supported by a tree format.
3117
 
    """
3118
 
 
3119
 
    _fmt = ("Views are not supported by %(tree)s;"
3120
 
            " use 'bzr upgrade' to change your tree to a later format.")
3121
 
 
3122
 
    def __init__(self, tree):
3123
 
        self.tree = tree
3124
 
 
3125
 
 
3126
 
class FileOutsideView(BzrError):
3127
 
 
3128
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3129
 
            '%(view_str)s')
3130
 
 
3131
 
    def __init__(self, file_name, view_files):
3132
 
        self.file_name = file_name
3133
 
        self.view_str = ", ".join(view_files)
3134
 
 
3135
 
 
3136
 
class UnresumableWriteGroup(BzrError):
3137
 
 
3138
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3139
 
            "%(write_groups)r: %(reason)s")
3140
 
 
3141
 
    internal_error = True
3142
 
 
3143
 
    def __init__(self, repository, write_groups, reason):
3144
 
        self.repository = repository
3145
 
        self.write_groups = write_groups
3146
 
        self.reason = reason
3147
 
 
3148
 
 
3149
 
class UnsuspendableWriteGroup(BzrError):
3150
 
 
3151
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3152
 
 
3153
 
    internal_error = True
3154
 
 
3155
 
    def __init__(self, repository):
3156
 
        self.repository = repository
3157
 
 
3158
 
 
3159
 
class LossyPushToSameVCS(BzrError):
3160
 
 
3161
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3162
 
            "%(target_branch)r that are in the same VCS.")
3163
 
 
3164
 
    internal_error = True
3165
 
 
3166
 
    def __init__(self, source_branch, target_branch):
3167
 
        self.source_branch = source_branch
3168
 
        self.target_branch = target_branch
3169
 
 
3170
 
 
3171
 
class NoRoundtrippingSupport(BzrError):
3172
 
 
3173
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3174
 
            "%(target_branch)r.")
3175
 
 
3176
 
    internal_error = True
3177
 
 
3178
 
    def __init__(self, source_branch, target_branch):
3179
 
        self.source_branch = source_branch
3180
 
        self.target_branch = target_branch
3181
 
 
3182
 
 
3183
 
class FileTimestampUnavailable(BzrError):
3184
 
 
3185
 
    _fmt = "The filestamp for %(path)s is not available."
3186
 
 
3187
 
    internal_error = True
3188
 
 
3189
 
    def __init__(self, path):
3190
 
        self.path = path
3191
 
 
3192
 
 
3193
 
class NoColocatedBranchSupport(BzrError):
3194
 
 
3195
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3196
 
 
3197
 
    def __init__(self, bzrdir):
3198
 
        self.bzrdir = bzrdir
3199
 
 
3200
 
 
3201
 
class NoWhoami(BzrError):
3202
 
 
3203
 
    _fmt = ('Unable to determine your name.\n'
3204
 
        "Please, set your name with the 'whoami' command.\n"
3205
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3206
 
 
3207
 
 
3208
 
class InvalidPattern(BzrError):
3209
 
 
3210
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3211
 
 
3212
 
    def __init__(self, msg):
3213
 
        self.msg = msg
3214
 
 
3215
 
 
3216
 
class RecursiveBind(BzrError):
3217
 
 
3218
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3219
 
        'Please use `bzr unbind` to fix.')
3220
 
 
3221
 
    def __init__(self, branch_url):
3222
 
        self.branch_url = branch_url
3223
 
 
3224
 
 
3225
 
# FIXME: I would prefer to define the config related exception classes in
3226
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3227
 
class InterpolationLoop(BzrError):
3228
 
 
3229
 
    _fmt = 'Loop involving %(refs)r while evaluating "%(string)s".'
3230
 
 
3231
 
    def __init__(self, string, refs):
3232
 
        self.string = string
3233
 
        self.refs = '->'.join(refs)
3234
 
 
3235
 
 
3236
 
class InterpolationUnknownOption(BzrError):
3237
 
 
3238
 
    _fmt = 'Option %(name)s is not defined while interpolating "%(string)s".'
3239
 
 
3240
 
    def __init__(self, name, string):
3241
 
        self.name = name
3242
 
        self.string = string