← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
 
20
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
31
32
 
32
33
 
33
34
# TODO: is there any value in providing the .args field used by standard
34
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
35
36
# to me.
36
37
 
37
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
38
39
# constructed to make sure it will succeed.  But that says nothing about
39
40
# exceptions that are never raised.
40
41
 
43
44
# 'unprintable'.
44
45
 
45
46
 
46
 
# return codes from the bzr program
47
 
EXIT_OK = 0
48
 
EXIT_ERROR = 3
49
 
EXIT_INTERNAL_ERROR = 4
50
 
 
51
 
 
52
47
class BzrError(StandardError):
53
48
    """
54
49
    Base class for errors raised by bzrlib.
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):
238
 
 
239
 
    _fmt = "The smart server method '%(class_name)s' is disabled."
240
 
 
241
 
    def __init__(self, class_name):
242
 
        BzrError.__init__(self)
243
 
        self.class_name = class_name
244
 
 
245
 
 
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
 
 
 
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 InvalidEntryName(BzrError):
 
179
    
269
180
    _fmt = "Invalid entry name: %(name)s"
270
181
 
 
182
    internal_error = True
 
183
 
271
184
    def __init__(self, name):
272
185
        BzrError.__init__(self)
273
186
        self.name = name
274
187
 
275
188
 
276
189
class InvalidRevisionNumber(BzrError):
277
 
 
 
190
    
278
191
    _fmt = "Invalid revision number %(revno)s"
279
192
 
280
193
    def __init__(self, revno):
292
205
        self.revision_id = revision_id
293
206
        self.branch = branch
294
207
 
295
 
 
296
208
class ReservedId(BzrError):
297
209
 
298
210
    _fmt = "Reserved revision-id {%(revision_id)s}"
300
212
    def __init__(self, revision_id):
301
213
        self.revision_id = revision_id
302
214
 
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
215
class NoSuchId(BzrError):
330
216
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
217
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
218
    
333
219
    def __init__(self, tree, file_id):
334
220
        BzrError.__init__(self)
335
221
        self.file_id = file_id
336
222
        self.tree = tree
337
223
 
338
224
 
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):
 
225
class InventoryModified(BzrError):
354
226
 
355
227
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
228
            " so a clean inventory cannot be read without data loss.")
357
229
 
 
230
    internal_error = True
 
231
 
358
232
    def __init__(self, tree):
359
233
        self.tree = tree
360
234
 
361
235
 
362
236
class NoWorkingTree(BzrError):
363
237
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
238
    _fmt = "No WorkingTree exists for %(base)s."
 
239
    
366
240
    def __init__(self, base):
367
241
        BzrError.__init__(self)
368
242
        self.base = base
381
255
        self.url = url
382
256
 
383
257
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
258
class WorkingTreeAlreadyPopulated(BzrError):
 
259
 
 
260
    _fmt = """Working tree already populated in %(base)s"""
 
261
 
 
262
    internal_error = True
387
263
 
388
264
    def __init__(self, base):
389
265
        self.base = base
390
266
 
391
 
 
392
267
class BzrCommandError(BzrError):
393
268
    """Error from user command"""
394
269
 
 
270
    internal_error = False
 
271
 
395
272
    # Error from malformed user command; please avoid raising this as a
396
273
    # generic exception not caused by user input.
397
274
    #
399
276
    # are not intended to be caught anyway.  UI code need not subclass
400
277
    # BzrCommandError, and non-UI code should not throw a subclass of
401
278
    # BzrCommandError.  ADHB 20051211
 
279
    def __init__(self, msg):
 
280
        # Object.__str__() must return a real string
 
281
        # returning a Unicode string is a python error.
 
282
        if isinstance(msg, unicode):
 
283
            self.msg = msg.encode('utf8')
 
284
        else:
 
285
            self.msg = msg
 
286
 
 
287
    def __str__(self):
 
288
        return self.msg
402
289
 
403
290
 
404
291
class NotWriteLocked(BzrError):
414
301
    _fmt = "Error in command line options"
415
302
 
416
303
 
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
304
class BadOptionValue(BzrError):
474
305
 
475
306
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
477
308
    def __init__(self, name, value):
478
309
        BzrError.__init__(self, name=name, value=value)
479
310
 
480
 
 
 
311
    
481
312
class StrictCommitFailed(BzrError):
482
313
 
483
314
    _fmt = "Commit refused because there are unknown files in the tree"
485
316
 
486
317
# XXX: Should be unified with TransportError; they seem to represent the
487
318
# 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
319
class PathError(BzrError):
493
 
 
 
320
    
494
321
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
322
 
496
323
    def __init__(self, path, extra=None):
516
343
    """Used when renaming and both source and dest exist."""
517
344
 
518
345
    _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")
 
346
            "%(extra)s")
521
347
 
522
348
    def __init__(self, source, dest, extra=None):
523
349
        BzrError.__init__(self)
531
357
 
532
358
class NotADirectory(PathError):
533
359
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
360
    _fmt = "%(path)r is not a directory %(extra)s"
535
361
 
536
362
 
537
363
class NotInWorkingDirectory(PathError):
538
364
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
365
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
366
 
541
367
 
542
368
class DirectoryNotEmpty(PathError):
543
369
 
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
 
 
 
370
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
371
 
 
372
 
 
373
class ReadingCompleted(BzrError):
 
374
    
554
375
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
376
            "called upon it - the request has been completed and no more "
556
377
            "data may be read.")
557
378
 
 
379
    internal_error = True
 
380
 
558
381
    def __init__(self, request):
559
382
        self.request = request
560
383
 
561
384
 
562
385
class ResourceBusy(PathError):
563
386
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
387
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
388
 
566
389
 
567
390
class PermissionDenied(PathError):
568
391
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
392
    _fmt = "Permission denied: %(path)r%(extra)s"
570
393
 
571
394
 
572
395
class InvalidURL(PathError):
573
396
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
397
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
398
 
576
399
 
577
400
class InvalidURLJoin(PathError):
578
401
 
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
 
402
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
403
 
 
404
    def __init__(self, msg, base, args):
 
405
        PathError.__init__(self, base, msg)
 
406
        self.args = [base] + list(args)
608
407
 
609
408
 
610
409
class UnknownHook(BzrError):
625
424
        PathError.__init__(self, url, extra=extra)
626
425
 
627
426
 
628
 
class UnstackableBranchFormat(BzrError):
629
 
 
630
 
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
631
 
        "You will need to upgrade the branch to permit branch stacking.")
632
 
 
633
 
    def __init__(self, format, url):
634
 
        BzrError.__init__(self)
635
 
        self.format = format
636
 
        self.url = url
637
 
 
638
 
 
639
 
class UnstackableRepositoryFormat(BzrError):
640
 
 
641
 
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
642
 
        "You will need to upgrade the repository to permit branch stacking.")
643
 
 
644
 
    def __init__(self, format, url):
645
 
        BzrError.__init__(self)
646
 
        self.format = format
647
 
        self.url = url
648
 
 
649
 
 
650
 
class ReadError(PathError):
651
 
 
652
 
    _fmt = """Error reading from %(path)r."""
653
 
 
654
 
 
655
427
class ShortReadvError(PathError):
656
428
 
657
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
658
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
429
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
430
            " at %(offset)s for %(path)s%(extra)s")
659
431
 
660
432
    internal_error = True
661
433
 
666
438
        self.actual = actual
667
439
 
668
440
 
669
 
class PathNotChild(PathError):
 
441
class PathNotChild(BzrError):
670
442
 
671
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
443
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
672
444
 
673
445
    internal_error = True
674
446
 
684
456
 
685
457
class InvalidNormalization(PathError):
686
458
 
687
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
459
    _fmt = "Path %(path)r is not unicode normalized"
688
460
 
689
461
 
690
462
# TODO: This is given a URL; we try to unescape it but doing that from inside
691
463
# the exception object is a bit undesirable.
692
 
# TODO: Probably this behavior of should be a common superclass
 
464
# TODO: Probably this behavior of should be a common superclass 
693
465
class NotBranchError(PathError):
694
466
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
467
    _fmt = "Not a branch: %(path)s"
696
468
 
697
469
    def __init__(self, path):
698
470
       import bzrlib.urlutils as urlutils
710
482
 
711
483
class AlreadyBranchError(PathError):
712
484
 
713
 
    _fmt = 'Already a branch: "%(path)s".'
 
485
    _fmt = "Already a branch: %(path)s."
714
486
 
715
487
 
716
488
class BranchExistsWithoutWorkingTree(PathError):
717
489
 
718
 
    _fmt = 'Directory contains a branch, but no working tree \
719
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
490
    _fmt = "Directory contains a branch, but no working tree \
 
491
(use bzr checkout if you wish to build a working tree): %(path)s"
720
492
 
721
493
 
722
494
class AtomicFileAlreadyClosed(PathError):
723
495
 
724
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
725
 
            ' "%(path)s"')
 
496
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
497
            " %(path)s")
726
498
 
727
499
    def __init__(self, path, function):
728
500
        PathError.__init__(self, path=path, extra=None)
731
503
 
732
504
class InaccessibleParent(PathError):
733
505
 
734
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
735
 
            ' relative path "%(path)s"')
 
506
    _fmt = ("Parent not accessible given base %(base)s and"
 
507
            " relative path %(path)s")
736
508
 
737
509
    def __init__(self, path, base):
738
510
        PathError.__init__(self, path)
741
513
 
742
514
class NoRepositoryPresent(BzrError):
743
515
 
744
 
    _fmt = 'No repository present: "%(path)s"'
 
516
    _fmt = "No repository present: %(path)r"
745
517
    def __init__(self, bzrdir):
746
518
        BzrError.__init__(self)
747
519
        self.path = bzrdir.transport.clone('..').base
749
521
 
750
522
class FileInWrongBranch(BzrError):
751
523
 
752
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
524
    _fmt = "File %(path)s in not in branch %(branch_base)s."
753
525
 
754
526
    def __init__(self, branch, path):
755
527
        BzrError.__init__(self)
764
536
 
765
537
 
766
538
class UnknownFormatError(BzrError):
767
 
 
768
 
    _fmt = "Unknown %(kind)s format: %(format)r"
769
 
 
770
 
    def __init__(self, format, kind='branch'):
771
 
        self.kind = kind
772
 
        self.format = format
 
539
    
 
540
    _fmt = "Unknown branch format: %(format)r"
773
541
 
774
542
 
775
543
class IncompatibleFormat(BzrError):
776
 
 
 
544
    
777
545
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
778
546
 
779
547
    def __init__(self, format, bzrdir_format):
784
552
 
785
553
class IncompatibleRepositories(BzrError):
786
554
 
787
 
    _fmt = "%(target)s\n" \
788
 
            "is not compatible with\n" \
789
 
            "%(source)s\n" \
790
 
            "%(details)s"
 
555
    _fmt = "Repository %(target)s is not compatible with repository"\
 
556
        " %(source)s"
791
557
 
792
 
    def __init__(self, source, target, details=None):
793
 
        if details is None:
794
 
            details = "(no details)"
795
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
558
    def __init__(self, source, target):
 
559
        BzrError.__init__(self, target=target, source=source)
796
560
 
797
561
 
798
562
class IncompatibleRevision(BzrError):
799
 
 
 
563
    
800
564
    _fmt = "Revision is not compatible with %(repo_format)s"
801
565
 
802
566
    def __init__(self, repo_format):
807
571
class AlreadyVersionedError(BzrError):
808
572
    """Used when a path is expected not to be versioned, but it is."""
809
573
 
810
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
574
    _fmt = "%(context_info)s%(path)s is already versioned"
811
575
 
812
576
    def __init__(self, path, context_info=None):
813
577
        """Construct a new AlreadyVersionedError.
828
592
class NotVersionedError(BzrError):
829
593
    """Used when a path is expected to be versioned, but it is not."""
830
594
 
831
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
595
    _fmt = "%(context_info)s%(path)s is not versioned"
832
596
 
833
597
    def __init__(self, path, context_info=None):
834
598
        """Construct a new NotVersionedError.
885
649
        BzrError.__init__(self, filename=filename, kind=kind)
886
650
 
887
651
 
888
 
class BadFilenameEncoding(BzrError):
889
 
 
890
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
891
 
            ' encoding %(fs_encoding)s')
892
 
 
893
 
    def __init__(self, filename, fs_encoding):
894
 
        BzrError.__init__(self)
895
 
        self.filename = filename
896
 
        self.fs_encoding = fs_encoding
897
 
 
898
 
 
899
652
class ForbiddenControlFileError(BzrError):
900
653
 
901
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
902
 
 
903
 
 
904
 
class LockError(InternalBzrError):
 
654
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
655
 
 
656
 
 
657
class LockError(BzrError):
905
658
 
906
659
    _fmt = "Lock error: %(msg)s"
907
660
 
 
661
    internal_error = True
 
662
 
908
663
    # All exceptions from the lock/unlock functions should be from
909
664
    # this exception class.  They will be translated as necessary. The
910
665
    # original exception is available as e.original_error
912
667
    # New code should prefer to raise specific subclasses
913
668
    def __init__(self, message):
914
669
        # Python 2.5 uses a slot for StandardError.message,
915
 
        # so use a different variable name.  We now work around this in
916
 
        # BzrError.__str__, but this member name is kept for compatability.
 
670
        # so use a different variable name
 
671
        # so it is exposed in self.__dict__
917
672
        self.msg = message
918
673
 
919
674
 
954
709
        self.obj = obj
955
710
 
956
711
 
957
 
class LockFailed(LockError):
958
 
 
959
 
    internal_error = False
960
 
 
961
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
962
 
 
963
 
    def __init__(self, lock, why):
 
712
class ReadOnlyLockError(LockError):
 
713
 
 
714
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
715
 
 
716
    def __init__(self, fname, msg):
964
717
        LockError.__init__(self, '')
965
 
        self.lock = lock
966
 
        self.why = why
 
718
        self.fname = fname
 
719
        self.msg = msg
967
720
 
968
721
 
969
722
class OutSideTransaction(BzrError):
993
746
 
994
747
class UnlockableTransport(LockError):
995
748
 
996
 
    internal_error = False
997
 
 
998
749
    _fmt = "Cannot lock: transport is read only: %(transport)s"
999
750
 
1000
751
    def __init__(self, transport):
1003
754
 
1004
755
class LockContention(LockError):
1005
756
 
1006
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
757
    _fmt = "Could not acquire lock %(lock)s"
1007
758
    # TODO: show full url for lock, combining the transport and relative
1008
759
    # bits?
1009
760
 
1010
761
    internal_error = False
1011
762
 
1012
 
    def __init__(self, lock, msg=''):
 
763
    def __init__(self, lock):
1013
764
        self.lock = lock
1014
 
        self.msg = msg
1015
765
 
1016
766
 
1017
767
class LockBroken(LockError):
1048
798
        self.lock = lock
1049
799
 
1050
800
 
1051
 
class TokenLockingNotSupported(LockError):
1052
 
 
1053
 
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1054
 
 
1055
 
    def __init__(self, obj):
1056
 
        self.obj = obj
1057
 
 
1058
 
 
1059
 
class TokenMismatch(LockBroken):
1060
 
 
1061
 
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
1062
 
 
1063
 
    internal_error = True
1064
 
 
1065
 
    def __init__(self, given_token, lock_token):
1066
 
        self.given_token = given_token
1067
 
        self.lock_token = lock_token
1068
 
 
1069
 
 
1070
801
class PointlessCommit(BzrError):
1071
802
 
1072
803
    _fmt = "No changes to commit"
1073
804
 
1074
805
 
1075
 
class CannotCommitSelectedFileMerge(BzrError):
1076
 
 
1077
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
1078
 
        ' files %(files_str)s'
1079
 
 
1080
 
    def __init__(self, files):
1081
 
        files_str = ', '.join(files)
1082
 
        BzrError.__init__(self, files=files, files_str=files_str)
1083
 
 
1084
 
 
1085
 
class BadCommitMessageEncoding(BzrError):
1086
 
 
1087
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1088
 
        'the current encoding.'
1089
 
 
1090
 
 
1091
806
class UpgradeReadonly(BzrError):
1092
807
 
1093
808
    _fmt = "Upgrade URL cannot work with readonly URLs."
1107
822
    _fmt = "Commit refused because there are unknowns in the tree."
1108
823
 
1109
824
 
1110
 
class NoSuchRevision(InternalBzrError):
1111
 
 
1112
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
825
class NoSuchRevision(BzrError):
 
826
 
 
827
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
828
 
 
829
    internal_error = True
1113
830
 
1114
831
    def __init__(self, branch, revision):
1115
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1116
832
        BzrError.__init__(self, branch=branch, revision=revision)
1117
833
 
1118
834
 
1119
 
class RangeInChangeOption(BzrError):
1120
 
 
1121
 
    _fmt = "Option --change does not accept revision ranges"
 
835
class NotLeftParentDescendant(BzrError):
 
836
 
 
837
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
838
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
839
 
 
840
    internal_error = True
 
841
 
 
842
    def __init__(self, branch, old_revision, new_revision):
 
843
        BzrError.__init__(self, branch_location=branch.base,
 
844
                          old_revision=old_revision,
 
845
                          new_revision=new_revision)
1122
846
 
1123
847
 
1124
848
class NoSuchRevisionSpec(BzrError):
1131
855
 
1132
856
class NoSuchRevisionInTree(NoSuchRevision):
1133
857
    """When using Tree.revision_tree, and the revision is not accessible."""
1134
 
 
1135
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
858
    
 
859
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1136
860
 
1137
861
    def __init__(self, tree, revision_id):
1138
862
        BzrError.__init__(self)
1173
897
class DivergedBranches(BzrError):
1174
898
 
1175
899
    _fmt = ("These branches have diverged."
1176
 
            " Use the missing command to see how.\n"
1177
 
            "Use the merge command to reconcile them.")
 
900
            " Use the merge command to reconcile them.")
 
901
 
 
902
    internal_error = False
1178
903
 
1179
904
    def __init__(self, branch1, branch2):
1180
905
        self.branch1 = branch1
1181
906
        self.branch2 = branch2
1182
907
 
1183
908
 
1184
 
class NotLefthandHistory(InternalBzrError):
 
909
class NotLefthandHistory(BzrError):
1185
910
 
1186
911
    _fmt = "Supplied history does not follow left-hand parents"
1187
912
 
 
913
    internal_error = True
 
914
 
1188
915
    def __init__(self, history):
1189
916
        BzrError.__init__(self, history=history)
1190
917
 
1194
921
    _fmt = ("Branches have no common ancestor, and"
1195
922
            " no merge base revision was specified.")
1196
923
 
1197
 
 
1198
 
class CannotReverseCherrypick(BzrError):
1199
 
 
1200
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1201
 
            ' or diff3.')
 
924
    internal_error = False
1202
925
 
1203
926
 
1204
927
class NoCommonAncestor(BzrError):
1205
 
 
 
928
    
1206
929
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1207
930
 
1208
931
    def __init__(self, revision_a, revision_b):
1228
951
            not_ancestor_id=not_ancestor_id)
1229
952
 
1230
953
 
 
954
class InstallFailed(BzrError):
 
955
 
 
956
    def __init__(self, revisions):
 
957
        revision_str = ", ".join(str(r) for r in revisions)
 
958
        msg = "Could not install revisions:\n%s" % revision_str
 
959
        BzrError.__init__(self, msg)
 
960
        self.revisions = revisions
 
961
 
 
962
 
1231
963
class AmbiguousBase(BzrError):
1232
964
 
1233
965
    def __init__(self, bases):
1239
971
        self.bases = bases
1240
972
 
1241
973
 
1242
 
class NoCommits(BranchError):
 
974
class NoCommits(BzrError):
1243
975
 
1244
976
    _fmt = "Branch %(branch)s has no commits."
1245
977
 
 
978
    def __init__(self, branch):
 
979
        BzrError.__init__(self, branch=branch)
 
980
 
1246
981
 
1247
982
class UnlistableStore(BzrError):
1248
983
 
1259
994
 
1260
995
class BoundBranchOutOfDate(BzrError):
1261
996
 
1262
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1263
 
            " %(master)s.")
 
997
    _fmt = ("Bound branch %(branch)s is out of date"
 
998
            " with master branch %(master)s.")
1264
999
 
1265
1000
    def __init__(self, branch, master):
1266
1001
        BzrError.__init__(self)
1267
1002
        self.branch = branch
1268
1003
        self.master = master
1269
1004
 
1270
 
 
 
1005
        
1271
1006
class CommitToDoubleBoundBranch(BzrError):
1272
1007
 
1273
1008
    _fmt = ("Cannot commit to branch %(branch)s."
1303
1038
 
1304
1039
class WeaveError(BzrError):
1305
1040
 
1306
 
    _fmt = "Error in processing weave: %(msg)s"
 
1041
    _fmt = "Error in processing weave: %(message)s"
1307
1042
 
1308
 
    def __init__(self, msg=None):
 
1043
    def __init__(self, message=None):
1309
1044
        BzrError.__init__(self)
1310
 
        self.msg = msg
 
1045
        self.message = message
1311
1046
 
1312
1047
 
1313
1048
class WeaveRevisionAlreadyPresent(WeaveError):
1342
1077
 
1343
1078
class WeaveParentMismatch(WeaveError):
1344
1079
 
1345
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
1346
 
 
 
1080
    _fmt = "Parents are mismatched between two revisions."
 
1081
    
1347
1082
 
1348
1083
class WeaveInvalidChecksum(WeaveError):
1349
1084
 
1375
1110
 
1376
1111
 
1377
1112
class VersionedFileError(BzrError):
1378
 
 
 
1113
    
1379
1114
    _fmt = "Versioned file error"
1380
1115
 
1381
1116
 
1382
1117
class RevisionNotPresent(VersionedFileError):
1383
 
 
1384
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1118
    
 
1119
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1385
1120
 
1386
1121
    def __init__(self, revision_id, file_id):
1387
1122
        VersionedFileError.__init__(self)
1390
1125
 
1391
1126
 
1392
1127
class RevisionAlreadyPresent(VersionedFileError):
1393
 
 
1394
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1128
    
 
1129
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1395
1130
 
1396
1131
    def __init__(self, revision_id, file_id):
1397
1132
        VersionedFileError.__init__(self)
1399
1134
        self.file_id = file_id
1400
1135
 
1401
1136
 
1402
 
class VersionedFileInvalidChecksum(VersionedFileError):
1403
 
 
1404
 
    _fmt = "Text did not match its checksum: %(message)s"
1405
 
 
1406
 
 
1407
 
class KnitError(InternalBzrError):
1408
 
 
 
1137
class KnitError(BzrError):
 
1138
    
1409
1139
    _fmt = "Knit error"
1410
1140
 
 
1141
    internal_error = True
 
1142
 
 
1143
 
 
1144
class KnitHeaderError(KnitError):
 
1145
 
 
1146
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1147
 
 
1148
    def __init__(self, badline, filename):
 
1149
        KnitError.__init__(self)
 
1150
        self.badline = badline
 
1151
        self.filename = filename
 
1152
 
1411
1153
 
1412
1154
class KnitCorrupt(KnitError):
1413
1155
 
1419
1161
        self.how = how
1420
1162
 
1421
1163
 
1422
 
class SHA1KnitCorrupt(KnitCorrupt):
1423
 
 
1424
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1425
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1426
 
        "sha %(actual)s")
1427
 
 
1428
 
    def __init__(self, filename, actual, expected, key, content):
1429
 
        KnitError.__init__(self)
1430
 
        self.filename = filename
1431
 
        self.actual = actual
1432
 
        self.expected = expected
1433
 
        self.key = key
1434
 
        self.content = content
1435
 
 
1436
 
 
1437
 
class KnitDataStreamIncompatible(KnitError):
1438
 
    # Not raised anymore, as we can convert data streams.  In future we may
1439
 
    # need it again for more exotic cases, so we're keeping it around for now.
1440
 
 
1441
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1442
 
 
1443
 
    def __init__(self, stream_format, target_format):
1444
 
        self.stream_format = stream_format
1445
 
        self.target_format = target_format
1446
 
 
1447
 
 
1448
 
class KnitDataStreamUnknown(KnitError):
1449
 
    # Indicates a data stream we don't know how to handle.
1450
 
 
1451
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1452
 
 
1453
 
    def __init__(self, stream_format):
1454
 
        self.stream_format = stream_format
1455
 
 
1456
 
 
1457
 
class KnitHeaderError(KnitError):
1458
 
 
1459
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1460
 
 
1461
 
    def __init__(self, badline, filename):
1462
 
        KnitError.__init__(self)
1463
 
        self.badline = badline
1464
 
        self.filename = filename
1465
 
 
1466
1164
class KnitIndexUnknownMethod(KnitError):
1467
1165
    """Raised when we don't understand the storage method.
1468
1166
 
1469
1167
    Currently only 'fulltext' and 'line-delta' are supported.
1470
1168
    """
1471
 
 
 
1169
    
1472
1170
    _fmt = ("Knit index %(filename)s does not have a known method"
1473
1171
            " in options: %(options)r")
1474
1172
 
1478
1176
        self.options = options
1479
1177
 
1480
1178
 
1481
 
class RetryWithNewPacks(BzrError):
1482
 
    """Raised when we realize that the packs on disk have changed.
1483
 
 
1484
 
    This is meant as more of a signaling exception, to trap between where a
1485
 
    local error occurred and the code that can actually handle the error and
1486
 
    code that can retry appropriately.
1487
 
    """
1488
 
 
1489
 
    internal_error = True
1490
 
 
1491
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1492
 
            " %(orig_error)s")
1493
 
 
1494
 
    def __init__(self, context, reload_occurred, exc_info):
1495
 
        """create a new RetryWithNewPacks error.
1496
 
 
1497
 
        :param reload_occurred: Set to True if we know that the packs have
1498
 
            already been reloaded, and we are failing because of an in-memory
1499
 
            cache miss. If set to True then we will ignore if a reload says
1500
 
            nothing has changed, because we assume it has already reloaded. If
1501
 
            False, then a reload with nothing changed will force an error.
1502
 
        :param exc_info: The original exception traceback, so if there is a
1503
 
            problem we can raise the original error (value from sys.exc_info())
1504
 
        """
1505
 
        BzrError.__init__(self)
1506
 
        self.reload_occurred = reload_occurred
1507
 
        self.exc_info = exc_info
1508
 
        self.orig_error = exc_info[1]
1509
 
        # TODO: The global error handler should probably treat this by
1510
 
        #       raising/printing the original exception with a bit about
1511
 
        #       RetryWithNewPacks also not being caught
1512
 
 
1513
 
 
1514
 
class RetryAutopack(RetryWithNewPacks):
1515
 
    """Raised when we are autopacking and we find a missing file.
1516
 
 
1517
 
    Meant as a signaling exception, to tell the autopack code it should try
1518
 
    again.
1519
 
    """
1520
 
 
1521
 
    internal_error = True
1522
 
 
1523
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1524
 
            " context: %(context)s %(orig_error)s")
1525
 
 
1526
 
 
1527
1179
class NoSuchExportFormat(BzrError):
1528
 
 
 
1180
    
1529
1181
    _fmt = "Export format %(format)r not supported"
1530
1182
 
1531
1183
    def __init__(self, format):
1534
1186
 
1535
1187
 
1536
1188
class TransportError(BzrError):
1537
 
 
 
1189
    
1538
1190
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1539
1191
 
1540
1192
    def __init__(self, msg=None, orig_error=None):
1549
1201
        BzrError.__init__(self)
1550
1202
 
1551
1203
 
1552
 
class TooManyConcurrentRequests(InternalBzrError):
 
1204
class TooManyConcurrentRequests(BzrError):
1553
1205
 
1554
1206
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1555
1207
            " Be sure to finish_writing and finish_reading on the"
1556
 
            " currently open request.")
 
1208
            " current request that is open.")
 
1209
 
 
1210
    internal_error = True
1557
1211
 
1558
1212
    def __init__(self, medium):
1559
1213
        self.medium = medium
1567
1221
        self.details = details
1568
1222
 
1569
1223
 
1570
 
class UnexpectedProtocolVersionMarker(TransportError):
1571
 
 
1572
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1573
 
 
1574
 
    def __init__(self, marker):
1575
 
        self.marker = marker
1576
 
 
1577
 
 
1578
 
class UnknownSmartMethod(InternalBzrError):
1579
 
 
1580
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1581
 
 
1582
 
    def __init__(self, verb):
1583
 
        self.verb = verb
1584
 
 
1585
 
 
1586
 
class SmartMessageHandlerError(InternalBzrError):
1587
 
 
1588
 
    _fmt = ("The message handler raised an exception:\n"
1589
 
            "%(traceback_text)s")
1590
 
 
1591
 
    def __init__(self, exc_info):
1592
 
        import traceback
1593
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1594
 
        self.exc_info = exc_info
1595
 
        traceback_strings = traceback.format_exception(
1596
 
                self.exc_type, self.exc_value, self.exc_tb)
1597
 
        self.traceback_text = ''.join(traceback_strings)
1598
 
 
1599
 
 
1600
1224
# A set of semi-meaningful errors which can be thrown
1601
1225
class TransportNotPossible(TransportError):
1602
1226
 
1627
1251
            self.port = ':%s' % port
1628
1252
 
1629
1253
 
1630
 
# XXX: This is also used for unexpected end of file, which is different at the
1631
 
# TCP level from "connection reset".
1632
1254
class ConnectionReset(TransportError):
1633
1255
 
1634
1256
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1636
1258
 
1637
1259
class InvalidRange(TransportError):
1638
1260
 
1639
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1640
 
 
1641
 
    def __init__(self, path, offset, msg=None):
1642
 
        TransportError.__init__(self, msg)
 
1261
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1262
    
 
1263
    def __init__(self, path, offset):
 
1264
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1265
                                       % (path, offset)))
1643
1266
        self.path = path
1644
1267
        self.offset = offset
1645
1268
 
1656
1279
class InvalidHttpRange(InvalidHttpResponse):
1657
1280
 
1658
1281
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1659
 
 
 
1282
    
1660
1283
    def __init__(self, path, range, msg):
1661
1284
        self.range = range
1662
1285
        InvalidHttpResponse.__init__(self, path, msg)
1665
1288
class InvalidHttpContentType(InvalidHttpResponse):
1666
1289
 
1667
1290
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1668
 
 
 
1291
    
1669
1292
    def __init__(self, path, ctype, msg):
1670
1293
        self.ctype = ctype
1671
1294
        InvalidHttpResponse.__init__(self, path, msg)
1675
1298
 
1676
1299
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1677
1300
 
1678
 
    def __init__(self, source, target, is_permanent=False):
 
1301
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1679
1302
        self.source = source
1680
1303
        self.target = target
1681
 
        if is_permanent:
 
1304
        if is_permament:
1682
1305
            self.permanently = ' permanently'
1683
1306
        else:
1684
1307
            self.permanently = ''
 
1308
        self.is_permament = is_permament
 
1309
        self._qualified_proto = qual_proto
1685
1310
        TransportError.__init__(self)
1686
1311
 
 
1312
    def _requalify_url(self, url):
 
1313
        """Restore the qualified proto in front of the url"""
 
1314
        # When this exception is raised, source and target are in
 
1315
        # user readable format. But some transports may use a
 
1316
        # different proto (http+urllib:// will present http:// to
 
1317
        # the user. If a qualified proto is specified, the code
 
1318
        # trapping the exception can get the qualified urls to
 
1319
        # properly handle the redirection themself (creating a
 
1320
        # new transport object from the target url for example).
 
1321
        # But checking that the scheme of the original and
 
1322
        # redirected urls are the same can be tricky. (see the
 
1323
        # FIXME in BzrDir.open_from_transport for the unique use
 
1324
        # case so far).
 
1325
        if self._qualified_proto is None:
 
1326
            return url
 
1327
 
 
1328
        # The TODO related to NotBranchError mention that doing
 
1329
        # that kind of manipulation on the urls may not be the
 
1330
        # exception object job. On the other hand, this object is
 
1331
        # the interface between the code and the user so
 
1332
        # presenting the urls in different ways is indeed its
 
1333
        # job...
 
1334
        import urlparse
 
1335
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1336
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1337
                                   query, fragment))
 
1338
 
 
1339
    def get_source_url(self):
 
1340
        return self._requalify_url(self.source)
 
1341
 
 
1342
    def get_target_url(self):
 
1343
        return self._requalify_url(self.target)
 
1344
 
1687
1345
 
1688
1346
class TooManyRedirections(TransportError):
1689
1347
 
1690
1348
    _fmt = "Too many redirections"
1691
1349
 
1692
 
 
1693
1350
class ConflictsInTree(BzrError):
1694
1351
 
1695
1352
    _fmt = "Working tree has conflicts."
1701
1358
        if filename is None:
1702
1359
            filename = ""
1703
1360
        message = "Error(s) parsing config file %s:\n%s" % \
1704
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1361
            (filename, ('\n'.join(e.message for e in errors)))
1705
1362
        BzrError.__init__(self, message)
1706
1363
 
1707
1364
 
1716
1373
 
1717
1374
class SigningFailed(BzrError):
1718
1375
 
1719
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1376
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1720
1377
 
1721
1378
    def __init__(self, command_line):
1722
1379
        BzrError.__init__(self, command_line=command_line)
1724
1381
 
1725
1382
class WorkingTreeNotRevision(BzrError):
1726
1383
 
1727
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1384
    _fmt = ("The working tree for %(basedir)s has changed since" 
1728
1385
            " the last commit, but weave merge requires that it be"
1729
1386
            " unchanged")
1730
1387
 
1747
1404
        self.graph = graph
1748
1405
 
1749
1406
 
1750
 
class WritingCompleted(InternalBzrError):
 
1407
class WritingCompleted(BzrError):
1751
1408
 
1752
1409
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1753
1410
            "called upon it - accept bytes may not be called anymore.")
1754
1411
 
 
1412
    internal_error = True
 
1413
 
1755
1414
    def __init__(self, request):
1756
1415
        self.request = request
1757
1416
 
1758
1417
 
1759
 
class WritingNotComplete(InternalBzrError):
 
1418
class WritingNotComplete(BzrError):
1760
1419
 
1761
1420
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1762
1421
            "called upon it - until the write phase is complete no "
1763
1422
            "data may be read.")
1764
1423
 
 
1424
    internal_error = True
 
1425
 
1765
1426
    def __init__(self, request):
1766
1427
        self.request = request
1767
1428
 
1775
1436
        self.filename = filename
1776
1437
 
1777
1438
 
1778
 
class MediumNotConnected(InternalBzrError):
 
1439
class MediumNotConnected(BzrError):
1779
1440
 
1780
1441
    _fmt = """The medium '%(medium)s' is not connected."""
1781
1442
 
 
1443
    internal_error = True
 
1444
 
1782
1445
    def __init__(self, medium):
1783
1446
        self.medium = medium
1784
1447
 
1790
1453
 
1791
1454
class NoBundleFound(BzrError):
1792
1455
 
1793
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1456
    _fmt = "No bundle was found in %(filename)s"
1794
1457
 
1795
1458
    def __init__(self, filename):
1796
1459
        BzrError.__init__(self)
1835
1498
    _fmt = "Key %(key)s is already present in map"
1836
1499
 
1837
1500
 
1838
 
class DuplicateHelpPrefix(BzrError):
1839
 
 
1840
 
    _fmt = "The prefix %(prefix)s is in the help search path twice."
1841
 
 
1842
 
    def __init__(self, prefix):
1843
 
        self.prefix = prefix
1844
 
 
1845
 
 
1846
1501
class MalformedTransform(BzrError):
1847
1502
 
1848
1503
    _fmt = "Tree transform is malformed %(conflicts)r"
1860
1515
        self.root_trans_id = transform.root
1861
1516
 
1862
1517
 
1863
 
class BzrBadParameter(InternalBzrError):
 
1518
class BzrBadParameter(BzrError):
1864
1519
 
1865
1520
    _fmt = "Bad parameter: %(param)r"
1866
1521
 
1892
1547
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1893
1548
 
1894
1549
    def __init__(self, from_path='', to_path='', extra=None):
1895
 
        from bzrlib.osutils import splitpath
1896
1550
        BzrError.__init__(self)
1897
1551
        if extra:
1898
1552
            self.extra = ': ' + str(extra)
1902
1556
        has_from = len(from_path) > 0
1903
1557
        has_to = len(to_path) > 0
1904
1558
        if has_from:
1905
 
            self.from_path = splitpath(from_path)[-1]
 
1559
            self.from_path = osutils.splitpath(from_path)[-1]
1906
1560
        else:
1907
1561
            self.from_path = ''
1908
1562
 
1909
1563
        if has_to:
1910
 
            self.to_path = splitpath(to_path)[-1]
 
1564
            self.to_path = osutils.splitpath(to_path)[-1]
1911
1565
        else:
1912
1566
            self.to_path = ''
1913
1567
 
1929
1583
    def __init__(self, from_path, to_path, extra=None):
1930
1584
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1931
1585
 
1932
 
class BzrRemoveChangedFilesError(BzrError):
1933
 
    """Used when user is trying to remove changed files."""
1934
 
 
1935
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
1936
 
        "%(changes_as_text)s"
1937
 
        "Use --keep to not delete them, or --force to delete them regardless.")
1938
 
 
1939
 
    def __init__(self, tree_delta):
1940
 
        BzrError.__init__(self)
1941
 
        self.changes_as_text = tree_delta.get_changes_as_text()
1942
 
        #self.paths_as_string = '\n'.join(changed_files)
1943
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
1944
 
 
1945
1586
 
1946
1587
class BzrBadParameterNotString(BzrBadParameter):
1947
1588
 
2004
1645
        self.format = format
2005
1646
 
2006
1647
 
2007
 
class NoDiffFound(BzrError):
2008
 
 
2009
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2010
 
 
2011
 
    def __init__(self, path):
2012
 
        BzrError.__init__(self, path)
2013
 
 
2014
 
 
2015
 
class ExecutableMissing(BzrError):
2016
 
 
2017
 
    _fmt = "%(exe_name)s could not be found on this machine"
2018
 
 
2019
 
    def __init__(self, exe_name):
2020
 
        BzrError.__init__(self, exe_name=exe_name)
2021
 
 
2022
 
 
2023
1648
class NoDiff(BzrError):
2024
1649
 
2025
1650
    _fmt = "Diff is not installed on this machine: %(msg)s"
2033
1658
    _fmt = "Diff3 is not installed on this machine."
2034
1659
 
2035
1660
 
2036
 
class ExistingContent(BzrError):
2037
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2038
 
 
2039
 
    _fmt = "The content being inserted is already present."
2040
 
 
2041
 
 
2042
1661
class ExistingLimbo(BzrError):
2043
1662
 
2044
1663
    _fmt = """This tree contains left-over files from a failed operation.
2045
1664
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2046
1665
    keep, and delete it when you are done."""
2047
 
 
 
1666
    
2048
1667
    def __init__(self, limbo_dir):
2049
1668
       BzrError.__init__(self)
2050
1669
       self.limbo_dir = limbo_dir
2051
1670
 
2052
1671
 
2053
 
class ExistingPendingDeletion(BzrError):
2054
 
 
2055
 
    _fmt = """This tree contains left-over files from a failed operation.
2056
 
    Please examine %(pending_deletion)s to see if it contains any files you
2057
 
    wish to keep, and delete it when you are done."""
2058
 
 
2059
 
    def __init__(self, pending_deletion):
2060
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2061
 
 
2062
 
 
2063
1672
class ImmortalLimbo(BzrError):
2064
1673
 
2065
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1674
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2066
1675
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2067
1676
    keep, and delete it when you are done."""
2068
1677
 
2071
1680
       self.limbo_dir = limbo_dir
2072
1681
 
2073
1682
 
2074
 
class ImmortalPendingDeletion(BzrError):
2075
 
 
2076
 
    _fmt = ("Unable to delete transform temporary directory "
2077
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2078
 
    "contains any files you wish to keep, and delete it when you are done.")
2079
 
 
2080
 
    def __init__(self, pending_deletion):
2081
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2082
 
 
2083
 
 
2084
1683
class OutOfDateTree(BzrError):
2085
1684
 
2086
1685
    _fmt = "Working tree is out of date, please run 'bzr update'."
2113
1712
    _fmt = "Format error in conflict listings"
2114
1713
 
2115
1714
 
2116
 
class CorruptDirstate(BzrError):
2117
 
 
2118
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2119
 
            "Error: %(description)s")
2120
 
 
2121
 
    def __init__(self, dirstate_path, description):
2122
 
        BzrError.__init__(self)
2123
 
        self.dirstate_path = dirstate_path
2124
 
        self.description = description
2125
 
 
2126
 
 
2127
1715
class CorruptRepository(BzrError):
2128
1716
 
2129
1717
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2134
1722
        self.repo_path = repo.bzrdir.root_transport.base
2135
1723
 
2136
1724
 
2137
 
class InconsistentDelta(BzrError):
2138
 
    """Used when we get a delta that is not valid."""
2139
 
 
2140
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2141
 
            " %(file_id)r\nreason: %(reason)s")
2142
 
 
2143
 
    def __init__(self, path, file_id, reason):
2144
 
        BzrError.__init__(self)
2145
 
        self.path = path
2146
 
        self.file_id = file_id
2147
 
        self.reason = reason
2148
 
 
2149
 
 
2150
1725
class UpgradeRequired(BzrError):
2151
1726
 
2152
1727
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2156
1731
        self.path = path
2157
1732
 
2158
1733
 
2159
 
class RepositoryUpgradeRequired(UpgradeRequired):
2160
 
 
2161
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2162
 
 
2163
 
 
2164
1734
class LocalRequiresBoundBranch(BzrError):
2165
1735
 
2166
1736
    _fmt = "Cannot perform local-only commits on unbound branches."
2167
1737
 
2168
1738
 
 
1739
class MissingProgressBarFinish(BzrError):
 
1740
 
 
1741
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1742
 
 
1743
 
2169
1744
class InvalidProgressBarType(BzrError):
2170
1745
 
2171
1746
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2197
1772
 
2198
1773
 
2199
1774
class BinaryFile(BzrError):
2200
 
 
 
1775
    
2201
1776
    _fmt = "File is binary but should be text."
2202
1777
 
2203
1778
 
2223
1798
 
2224
1799
 
2225
1800
class NotABundle(BzrError):
2226
 
 
 
1801
    
2227
1802
    _fmt = "Not a bzr revision-bundle: %(text)r"
2228
1803
 
2229
1804
    def __init__(self, text):
2231
1806
        self.text = text
2232
1807
 
2233
1808
 
2234
 
class BadBundle(BzrError):
2235
 
 
 
1809
class BadBundle(BzrError): 
 
1810
    
2236
1811
    _fmt = "Bad bzr revision-bundle: %(text)r"
2237
1812
 
2238
1813
    def __init__(self, text):
2240
1815
        self.text = text
2241
1816
 
2242
1817
 
2243
 
class MalformedHeader(BadBundle):
2244
 
 
 
1818
class MalformedHeader(BadBundle): 
 
1819
    
2245
1820
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2246
1821
 
2247
1822
 
2248
 
class MalformedPatches(BadBundle):
2249
 
 
 
1823
class MalformedPatches(BadBundle): 
 
1824
    
2250
1825
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2251
1826
 
2252
1827
 
2253
 
class MalformedFooter(BadBundle):
2254
 
 
 
1828
class MalformedFooter(BadBundle): 
 
1829
    
2255
1830
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2256
1831
 
2257
1832
 
2258
1833
class UnsupportedEOLMarker(BadBundle):
2259
 
 
2260
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1834
    
 
1835
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2261
1836
 
2262
1837
    def __init__(self):
2263
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1838
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2264
1839
        # but for this there is not
2265
1840
        BzrError.__init__(self)
2266
1841
 
2267
1842
 
2268
1843
class IncompatibleBundleFormat(BzrError):
2269
 
 
 
1844
    
2270
1845
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2271
1846
 
2272
1847
    def __init__(self, bundle_format, other):
2276
1851
 
2277
1852
 
2278
1853
class BadInventoryFormat(BzrError):
2279
 
 
 
1854
    
2280
1855
    _fmt = "Root class for inventory serialization errors"
2281
1856
 
2282
1857
 
2293
1868
    _fmt = """This operation requires rich root data storage"""
2294
1869
 
2295
1870
 
2296
 
class NoSmartMedium(InternalBzrError):
 
1871
class NoSmartMedium(BzrError):
2297
1872
 
2298
1873
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2299
1874
 
 
1875
    internal_error = True
 
1876
 
2300
1877
    def __init__(self, transport):
2301
1878
        self.transport = transport
2302
1879
 
2303
1880
 
 
1881
class NoSmartServer(NotBranchError):
 
1882
 
 
1883
    _fmt = "No smart server available at %(url)s"
 
1884
 
 
1885
    def __init__(self, url):
 
1886
        self.url = url
 
1887
 
 
1888
 
2304
1889
class UnknownSSH(BzrError):
2305
1890
 
2306
1891
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2316
1901
            " Please set BZR_SSH environment variable.")
2317
1902
 
2318
1903
 
2319
 
class GhostRevisionsHaveNoRevno(BzrError):
2320
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2321
 
 
2322
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2323
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2324
 
 
2325
 
    def __init__(self, revision_id, ghost_revision_id):
2326
 
        self.revision_id = revision_id
2327
 
        self.ghost_revision_id = ghost_revision_id
2328
 
 
2329
 
 
2330
1904
class GhostRevisionUnusableHere(BzrError):
2331
1905
 
2332
1906
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2336
1910
        self.revision_id = revision_id
2337
1911
 
2338
1912
 
2339
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
1913
class IllegalUseOfScopeReplacer(BzrError):
2340
1914
 
2341
1915
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2342
1916
            " %(msg)s%(extra)s")
2343
1917
 
 
1918
    internal_error = True
 
1919
 
2344
1920
    def __init__(self, name, msg, extra=None):
2345
1921
        BzrError.__init__(self)
2346
1922
        self.name = name
2351
1927
            self.extra = ''
2352
1928
 
2353
1929
 
2354
 
class InvalidImportLine(InternalBzrError):
 
1930
class InvalidImportLine(BzrError):
2355
1931
 
2356
1932
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2357
1933
 
 
1934
    internal_error = True
 
1935
 
2358
1936
    def __init__(self, text, msg):
2359
1937
        BzrError.__init__(self)
2360
1938
        self.text = text
2361
1939
        self.msg = msg
2362
1940
 
2363
1941
 
2364
 
class ImportNameCollision(InternalBzrError):
 
1942
class ImportNameCollision(BzrError):
2365
1943
 
2366
1944
    _fmt = ("Tried to import an object to the same name as"
2367
1945
            " an existing object. %(name)s")
2368
1946
 
 
1947
    internal_error = True
 
1948
 
2369
1949
    def __init__(self, name):
2370
1950
        BzrError.__init__(self)
2371
1951
        self.name = name
2384
1964
        " branch location."
2385
1965
 
2386
1966
 
2387
 
class IllegalMergeDirectivePayload(BzrError):
2388
 
    """A merge directive contained something other than a patch or bundle"""
2389
 
 
2390
 
    _fmt = "Bad merge directive payload %(start)r"
2391
 
 
2392
 
    def __init__(self, start):
2393
 
        BzrError(self)
2394
 
        self.start = start
2395
 
 
2396
 
 
2397
 
class PatchVerificationFailed(BzrError):
2398
 
    """A patch from a merge directive could not be verified"""
2399
 
 
2400
 
    _fmt = "Preview patch does not match requested changes."
2401
 
 
2402
 
 
2403
1967
class PatchMissing(BzrError):
2404
1968
    """Raise a patch type was specified but no patch supplied"""
2405
1969
 
2406
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
1970
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2407
1971
 
2408
1972
    def __init__(self, patch_type):
2409
1973
        BzrError.__init__(self)
2410
1974
        self.patch_type = patch_type
2411
1975
 
2412
1976
 
2413
 
class TargetNotBranch(BzrError):
2414
 
    """A merge directive's target branch is required, but isn't a branch"""
2415
 
 
2416
 
    _fmt = ("Your branch does not have all of the revisions required in "
2417
 
            "order to merge this merge directive and the target "
2418
 
            "location specified in the merge directive is not a branch: "
2419
 
            "%(location)s.")
2420
 
 
2421
 
    def __init__(self, location):
2422
 
        BzrError.__init__(self)
2423
 
        self.location = location
2424
 
 
2425
 
 
2426
1977
class UnsupportedInventoryKind(BzrError):
2427
 
 
 
1978
    
2428
1979
    _fmt = """Unsupported entry kind %(kind)s"""
2429
1980
 
2430
1981
    def __init__(self, kind):
2433
1984
 
2434
1985
class BadSubsumeSource(BzrError):
2435
1986
 
2436
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
1987
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2437
1988
 
2438
1989
    def __init__(self, tree, other_tree, reason):
2439
1990
        self.tree = tree
2442
1993
 
2443
1994
 
2444
1995
class SubsumeTargetNeedsUpgrade(BzrError):
2445
 
 
 
1996
    
2446
1997
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2447
1998
 
2448
1999
    def __init__(self, other_tree):
2449
2000
        self.other_tree = other_tree
2450
2001
 
2451
2002
 
2452
 
class BadReferenceTarget(InternalBzrError):
2453
 
 
2454
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2455
 
           "%(reason)s"
 
2003
class BadReferenceTarget(BzrError):
 
2004
 
 
2005
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2006
 
 
2007
    internal_error = True
2456
2008
 
2457
2009
    def __init__(self, tree, other_tree, reason):
2458
2010
        self.tree = tree
2476
2028
    def __init__(self, branch):
2477
2029
        self.branch = branch
2478
2030
 
2479
 
 
 
2031
        
2480
2032
class TagAlreadyExists(BzrError):
2481
2033
 
2482
2034
    _fmt = "Tag %(tag_name)s already exists."
2483
2035
 
2484
2036
    def __init__(self, tag_name):
2485
2037
        self.tag_name = tag_name
2486
 
 
2487
 
 
2488
 
class MalformedBugIdentifier(BzrError):
2489
 
 
2490
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2491
 
            'See "bzr help bugs" for more information on this feature.')
2492
 
 
2493
 
    def __init__(self, bug_id, reason):
2494
 
        self.bug_id = bug_id
2495
 
        self.reason = reason
2496
 
 
2497
 
 
2498
 
class InvalidBugTrackerURL(BzrError):
2499
 
 
2500
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2501
 
            "contain {id}: %(url)s")
2502
 
 
2503
 
    def __init__(self, abbreviation, url):
2504
 
        self.abbreviation = abbreviation
2505
 
        self.url = url
2506
 
 
2507
 
 
2508
 
class UnknownBugTrackerAbbreviation(BzrError):
2509
 
 
2510
 
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2511
 
            "on %(branch)s")
2512
 
 
2513
 
    def __init__(self, abbreviation, branch):
2514
 
        self.abbreviation = abbreviation
2515
 
        self.branch = branch
2516
 
 
2517
 
 
2518
 
class InvalidLineInBugsProperty(BzrError):
2519
 
 
2520
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2521
 
 
2522
 
    def __init__(self, line):
2523
 
        self.line = line
2524
 
 
2525
 
 
2526
 
class InvalidBugStatus(BzrError):
2527
 
 
2528
 
    _fmt = ("Invalid bug status: '%(status)s'")
2529
 
 
2530
 
    def __init__(self, status):
2531
 
        self.status = status
2532
 
 
2533
 
 
2534
 
class UnexpectedSmartServerResponse(BzrError):
2535
 
 
2536
 
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2537
 
 
2538
 
    def __init__(self, response_tuple):
2539
 
        self.response_tuple = response_tuple
2540
 
 
2541
 
 
2542
 
class ErrorFromSmartServer(BzrError):
2543
 
    """An error was received from a smart server.
2544
 
 
2545
 
    :seealso: UnknownErrorFromSmartServer
2546
 
    """
2547
 
 
2548
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2549
 
 
2550
 
    internal_error = True
2551
 
 
2552
 
    def __init__(self, error_tuple):
2553
 
        self.error_tuple = error_tuple
2554
 
        try:
2555
 
            self.error_verb = error_tuple[0]
2556
 
        except IndexError:
2557
 
            self.error_verb = None
2558
 
        self.error_args = error_tuple[1:]
2559
 
 
2560
 
 
2561
 
class UnknownErrorFromSmartServer(BzrError):
2562
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2563
 
    error.
2564
 
 
2565
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2566
 
    distinguish between the following two cases:
2567
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2568
 
        and so should provoke a traceback to the user.
2569
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2570
 
        translated.  This is probably because the server sent us garbage, and
2571
 
        should not provoke a traceback.
2572
 
    """
2573
 
 
2574
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2575
 
 
2576
 
    internal_error = False
2577
 
 
2578
 
    def __init__(self, error_from_smart_server):
2579
 
        """Constructor.
2580
 
 
2581
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2582
 
        """
2583
 
        self.error_from_smart_server = error_from_smart_server
2584
 
        self.error_tuple = error_from_smart_server.error_tuple
2585
 
 
2586
 
 
2587
 
class ContainerError(BzrError):
2588
 
    """Base class of container errors."""
2589
 
 
2590
 
 
2591
 
class UnknownContainerFormatError(ContainerError):
2592
 
 
2593
 
    _fmt = "Unrecognised container format: %(container_format)r"
2594
 
 
2595
 
    def __init__(self, container_format):
2596
 
        self.container_format = container_format
2597
 
 
2598
 
 
2599
 
class UnexpectedEndOfContainerError(ContainerError):
2600
 
 
2601
 
    _fmt = "Unexpected end of container stream"
2602
 
 
2603
 
 
2604
 
class UnknownRecordTypeError(ContainerError):
2605
 
 
2606
 
    _fmt = "Unknown record type: %(record_type)r"
2607
 
 
2608
 
    def __init__(self, record_type):
2609
 
        self.record_type = record_type
2610
 
 
2611
 
 
2612
 
class InvalidRecordError(ContainerError):
2613
 
 
2614
 
    _fmt = "Invalid record: %(reason)s"
2615
 
 
2616
 
    def __init__(self, reason):
2617
 
        self.reason = reason
2618
 
 
2619
 
 
2620
 
class ContainerHasExcessDataError(ContainerError):
2621
 
 
2622
 
    _fmt = "Container has data after end marker: %(excess)r"
2623
 
 
2624
 
    def __init__(self, excess):
2625
 
        self.excess = excess
2626
 
 
2627
 
 
2628
 
class DuplicateRecordNameError(ContainerError):
2629
 
 
2630
 
    _fmt = "Container has multiple records with the same name: %(name)s"
2631
 
 
2632
 
    def __init__(self, name):
2633
 
        self.name = name
2634
 
 
2635
 
 
2636
 
class NoDestinationAddress(InternalBzrError):
2637
 
 
2638
 
    _fmt = "Message does not have a destination address."
2639
 
 
2640
 
 
2641
 
class RepositoryDataStreamError(BzrError):
2642
 
 
2643
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2644
 
 
2645
 
    def __init__(self, reason):
2646
 
        self.reason = reason
2647
 
 
2648
 
 
2649
 
class SMTPError(BzrError):
2650
 
 
2651
 
    _fmt = "SMTP error: %(error)s"
2652
 
 
2653
 
    def __init__(self, error):
2654
 
        self.error = error
2655
 
 
2656
 
 
2657
 
class NoMessageSupplied(BzrError):
2658
 
 
2659
 
    _fmt = "No message supplied."
2660
 
 
2661
 
 
2662
 
class NoMailAddressSpecified(BzrError):
2663
 
 
2664
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2665
 
 
2666
 
 
2667
 
class UnknownMailClient(BzrError):
2668
 
 
2669
 
    _fmt = "Unknown mail client: %(mail_client)s"
2670
 
 
2671
 
    def __init__(self, mail_client):
2672
 
        BzrError.__init__(self, mail_client=mail_client)
2673
 
 
2674
 
 
2675
 
class MailClientNotFound(BzrError):
2676
 
 
2677
 
    _fmt = "Unable to find mail client with the following names:"\
2678
 
        " %(mail_command_list_string)s"
2679
 
 
2680
 
    def __init__(self, mail_command_list):
2681
 
        mail_command_list_string = ', '.join(mail_command_list)
2682
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2683
 
                          mail_command_list_string=mail_command_list_string)
2684
 
 
2685
 
class SMTPConnectionRefused(SMTPError):
2686
 
 
2687
 
    _fmt = "SMTP connection to %(host)s refused"
2688
 
 
2689
 
    def __init__(self, error, host):
2690
 
        self.error = error
2691
 
        self.host = host
2692
 
 
2693
 
 
2694
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2695
 
 
2696
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2697
 
 
2698
 
 
2699
 
class BzrDirError(BzrError):
2700
 
 
2701
 
    def __init__(self, bzrdir):
2702
 
        import bzrlib.urlutils as urlutils
2703
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2704
 
                                                    'ascii')
2705
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2706
 
 
2707
 
 
2708
 
class UnsyncedBranches(BzrDirError):
2709
 
 
2710
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2711
 
            " bzr help sync-for-reconfigure.")
2712
 
 
2713
 
    def __init__(self, bzrdir, target_branch):
2714
 
        BzrDirError.__init__(self, bzrdir)
2715
 
        import bzrlib.urlutils as urlutils
2716
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2717
 
                                                        'ascii')
2718
 
 
2719
 
 
2720
 
class AlreadyBranch(BzrDirError):
2721
 
 
2722
 
    _fmt = "'%(display_url)s' is already a branch."
2723
 
 
2724
 
 
2725
 
class AlreadyTree(BzrDirError):
2726
 
 
2727
 
    _fmt = "'%(display_url)s' is already a tree."
2728
 
 
2729
 
 
2730
 
class AlreadyCheckout(BzrDirError):
2731
 
 
2732
 
    _fmt = "'%(display_url)s' is already a checkout."
2733
 
 
2734
 
 
2735
 
class AlreadyLightweightCheckout(BzrDirError):
2736
 
 
2737
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2738
 
 
2739
 
 
2740
 
class AlreadyUsingShared(BzrDirError):
2741
 
 
2742
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2743
 
 
2744
 
 
2745
 
class AlreadyStandalone(BzrDirError):
2746
 
 
2747
 
    _fmt = "'%(display_url)s' is already standalone."
2748
 
 
2749
 
 
2750
 
class AlreadyWithTrees(BzrDirError):
2751
 
 
2752
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2753
 
            "working trees.")
2754
 
 
2755
 
 
2756
 
class AlreadyWithNoTrees(BzrDirError):
2757
 
 
2758
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2759
 
            "working trees.")
2760
 
 
2761
 
 
2762
 
class ReconfigurationNotSupported(BzrDirError):
2763
 
 
2764
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2765
 
 
2766
 
 
2767
 
class NoBindLocation(BzrDirError):
2768
 
 
2769
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2770
 
 
2771
 
 
2772
 
class UncommittedChanges(BzrError):
2773
 
 
2774
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2775
 
 
2776
 
    def __init__(self, tree):
2777
 
        import bzrlib.urlutils as urlutils
2778
 
        display_url = urlutils.unescape_for_display(
2779
 
            tree.bzrdir.root_transport.base, 'ascii')
2780
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
2781
 
 
2782
 
 
2783
 
class MissingTemplateVariable(BzrError):
2784
 
 
2785
 
    _fmt = 'Variable {%(name)s} is not available.'
2786
 
 
2787
 
    def __init__(self, name):
2788
 
        self.name = name
2789
 
 
2790
 
 
2791
 
class NoTemplate(BzrError):
2792
 
 
2793
 
    _fmt = 'No template specified.'
2794
 
 
2795
 
 
2796
 
class UnableCreateSymlink(BzrError):
2797
 
 
2798
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2799
 
 
2800
 
    def __init__(self, path=None):
2801
 
        path_str = ''
2802
 
        if path:
2803
 
            try:
2804
 
                path_str = repr(str(path))
2805
 
            except UnicodeEncodeError:
2806
 
                path_str = repr(path)
2807
 
            path_str += ' '
2808
 
        self.path_str = path_str
2809
 
 
2810
 
 
2811
 
class UnsupportedTimezoneFormat(BzrError):
2812
 
 
2813
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2814
 
            'options are "utc", "original", "local".')
2815
 
 
2816
 
    def __init__(self, timezone):
2817
 
        self.timezone = timezone
2818
 
 
2819
 
 
2820
 
class CommandAvailableInPlugin(StandardError):
2821
 
 
2822
 
    internal_error = False
2823
 
 
2824
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2825
 
 
2826
 
        self.plugin_metadata = plugin_metadata
2827
 
        self.cmd_name = cmd_name
2828
 
        self.provider = provider
2829
 
 
2830
 
    def __str__(self):
2831
 
 
2832
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2833
 
                'However, the following official plugin provides this command: %s\n'
2834
 
                'You can install it by going to: %s'
2835
 
                % (self.cmd_name, self.plugin_metadata['name'],
2836
 
                    self.plugin_metadata['url']))
2837
 
 
2838
 
        return _fmt
2839
 
 
2840
 
 
2841
 
class NoPluginAvailable(BzrError):
2842
 
    pass
2843
 
 
2844
 
 
2845
 
class UnableEncodePath(BzrError):
2846
 
 
2847
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2848
 
            'user encoding %(user_encoding)s')
2849
 
 
2850
 
    def __init__(self, path, kind):
2851
 
        from bzrlib.osutils import get_user_encoding
2852
 
        self.path = path
2853
 
        self.kind = kind
2854
 
        self.user_encoding = osutils.get_user_encoding()
2855
 
 
2856
 
 
2857
 
class NoSuchAlias(BzrError):
2858
 
 
2859
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2860
 
 
2861
 
    def __init__(self, alias_name):
2862
 
        BzrError.__init__(self, alias_name=alias_name)
2863
 
 
2864
 
 
2865
 
class DirectoryLookupFailure(BzrError):
2866
 
    """Base type for lookup errors."""
2867
 
 
2868
 
    pass
2869
 
 
2870
 
 
2871
 
class InvalidLocationAlias(DirectoryLookupFailure):
2872
 
 
2873
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
2874
 
 
2875
 
    def __init__(self, alias_name):
2876
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
2877
 
 
2878
 
 
2879
 
class UnsetLocationAlias(DirectoryLookupFailure):
2880
 
 
2881
 
    _fmt = 'No %(alias_name)s location assigned.'
2882
 
 
2883
 
    def __init__(self, alias_name):
2884
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
2885
 
 
2886
 
 
2887
 
class CannotBindAddress(BzrError):
2888
 
 
2889
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2890
 
 
2891
 
    def __init__(self, host, port, orig_error):
2892
 
        BzrError.__init__(self, host=host, port=port,
2893
 
            orig_error=orig_error[1])
2894
 
 
2895
 
 
2896
 
class UnknownRules(BzrError):
2897
 
 
2898
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
2899
 
 
2900
 
    def __init__(self, unknowns):
2901
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2902
 
 
2903
 
 
2904
 
class HookFailed(BzrError):
2905
 
    """Raised when a pre_change_branch_tip hook function fails anything other
2906
 
    than TipChangeRejected.
2907
 
    """
2908
 
 
2909
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2910
 
            "%(traceback_text)s%(exc_value)s")
2911
 
 
2912
 
    def __init__(self, hook_stage, hook_name, exc_info):
2913
 
        import traceback
2914
 
        self.hook_stage = hook_stage
2915
 
        self.hook_name = hook_name
2916
 
        self.exc_info = exc_info
2917
 
        self.exc_type = exc_info[0]
2918
 
        self.exc_value = exc_info[1]
2919
 
        self.exc_tb = exc_info[2]
2920
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2921
 
 
2922
 
 
2923
 
class TipChangeRejected(BzrError):
2924
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
2925
 
    explicitly abort a change to a branch tip.
2926
 
    """
2927
 
 
2928
 
    _fmt = u"Tip change rejected: %(msg)s"
2929
 
 
2930
 
    def __init__(self, msg):
2931
 
        self.msg = msg
2932
 
 
2933
 
 
2934
 
class ShelfCorrupt(BzrError):
2935
 
 
2936
 
    _fmt = "Shelf corrupt."
2937
 
 
2938
 
 
2939
 
class NoSuchShelfId(BzrError):
2940
 
 
2941
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
2942
 
 
2943
 
    def __init__(self, shelf_id):
2944
 
        BzrError.__init__(self, shelf_id=shelf_id)
2945
 
 
2946
 
 
2947
 
class InvalidShelfId(BzrError):
2948
 
 
2949
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
2950
 
 
2951
 
    def __init__(self, invalid_id):
2952
 
        BzrError.__init__(self, invalid_id=invalid_id)
2953
 
 
2954
 
 
2955
 
class JailBreak(BzrError):
2956
 
 
2957
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
2958
 
 
2959
 
    def __init__(self, url):
2960
 
        BzrError.__init__(self, url=url)
2961
 
 
2962
 
 
2963
 
class UserAbort(BzrError):
2964
 
 
2965
 
    _fmt = 'The user aborted the operation.'
2966
 
 
2967
 
 
2968
 
class MustHaveWorkingTree(BzrError):
2969
 
 
2970
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
2971
 
 
2972
 
    def __init__(self, format, url):
2973
 
        BzrError.__init__(self, format=format, url=url)
2974
 
 
2975
 
 
2976
 
class NoSuchView(BzrError):
2977
 
    """A view does not exist.
2978
 
    """
2979
 
 
2980
 
    _fmt = u"No such view: %(view_name)s."
2981
 
 
2982
 
    def __init__(self, view_name):
2983
 
        self.view_name = view_name
2984
 
 
2985
 
 
2986
 
class ViewsNotSupported(BzrError):
2987
 
    """Views are not supported by a tree format.
2988
 
    """
2989
 
 
2990
 
    _fmt = ("Views are not supported by %(tree)s;"
2991
 
            " use 'bzr upgrade' to change your tree to a later format.")
2992
 
 
2993
 
    def __init__(self, tree):
2994
 
        self.tree = tree
2995
 
 
2996
 
 
2997
 
class FileOutsideView(BzrError):
2998
 
 
2999
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3000
 
            '%(view_str)s')
3001
 
 
3002
 
    def __init__(self, file_name, view_files):
3003
 
        self.file_name = file_name
3004
 
        self.view_str = ", ".join(view_files)
3005
 
 
3006
 
 
3007
 
class UnresumableWriteGroup(BzrError):
3008
 
 
3009
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3010
 
            "%(write_groups)r: %(reason)s")
3011
 
 
3012
 
    internal_error = True
3013
 
 
3014
 
    def __init__(self, repository, write_groups, reason):
3015
 
        self.repository = repository
3016
 
        self.write_groups = write_groups
3017
 
        self.reason = reason
3018
 
 
3019
 
 
3020
 
class UnsuspendableWriteGroup(BzrError):
3021
 
 
3022
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3023
 
 
3024
 
    internal_error = True
3025
 
 
3026
 
    def __init__(self, repository):
3027
 
        self.repository = repository