/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2007-03-07 03:09:14 UTC
  • mto: (2321.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: mbp@sourcefrog.net-20070307030914-fb2gw9ae6lxcbbcd
Review cleanups: mostly updating or removing todo comments.

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."""
176
132
    # readable explanation
177
133
 
178
134
    def __init__(self, *args, **kwds):
179
 
        # XXX: Use the underlying BzrError to always generate the args
180
 
        # attribute if it doesn't exist.  We can't use super here, because
181
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
182
 
        # --bmc, 20060426
 
135
        # XXX: Use the underlying BzrError to always generate the args attribute
 
136
        # if it doesn't exist.  We can't use super here, because exceptions are
 
137
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
183
138
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
184
 
             'please convert %s to use BzrError instead'
 
139
             'please convert %s to use BzrError instead' 
185
140
             % self.__class__.__name__,
186
141
             DeprecationWarning,
187
142
             stacklevel=2)
198
153
                return s.encode('utf8')
199
154
            return s
200
155
        except (TypeError, NameError, ValueError, KeyError), e:
201
 
            return 'Unprintable exception %s(%r): %r' \
 
156
            return 'Unprintable exception %s(%r): %s' \
202
157
                % (self.__class__.__name__,
203
 
                   self.__dict__, e)
 
158
                   self.__dict__, str(e))
204
159
 
205
160
 
206
161
class AlreadyBuilding(BzrError):
207
 
 
 
162
    
208
163
    _fmt = "The tree builder is already building a tree."
209
164
 
210
165
 
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
 
 
 
166
class BzrCheckError(BzrError):
 
167
    
 
168
    _fmt = "Internal check failed: %(message)s"
 
169
 
 
170
    internal_error = True
 
171
 
 
172
    def __init__(self, message):
 
173
        BzrError.__init__(self)
 
174
        self.message = message
 
175
 
 
176
 
 
177
class InvalidEntryName(BzrError):
 
178
    
269
179
    _fmt = "Invalid entry name: %(name)s"
270
180
 
 
181
    internal_error = True
 
182
 
271
183
    def __init__(self, name):
272
184
        BzrError.__init__(self)
273
185
        self.name = name
274
186
 
275
187
 
276
188
class InvalidRevisionNumber(BzrError):
277
 
 
 
189
    
278
190
    _fmt = "Invalid revision number %(revno)s"
279
191
 
280
192
    def __init__(self, revno):
292
204
        self.revision_id = revision_id
293
205
        self.branch = branch
294
206
 
295
 
 
296
207
class ReservedId(BzrError):
297
208
 
298
209
    _fmt = "Reserved revision-id {%(revision_id)s}"
300
211
    def __init__(self, revision_id):
301
212
        self.revision_id = revision_id
302
213
 
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
214
class NoSuchId(BzrError):
330
215
 
331
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
332
 
 
 
216
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
217
    
333
218
    def __init__(self, tree, file_id):
334
219
        BzrError.__init__(self)
335
220
        self.file_id = file_id
336
221
        self.tree = tree
337
222
 
338
223
 
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):
354
 
 
355
 
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
356
 
            " so a clean inventory cannot be read without data loss.")
 
224
class InventoryModified(BzrError):
 
225
 
 
226
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
 
227
            "so a clean inventory cannot be read without data loss.")
 
228
 
 
229
    internal_error = True
357
230
 
358
231
    def __init__(self, tree):
359
232
        self.tree = tree
361
234
 
362
235
class NoWorkingTree(BzrError):
363
236
 
364
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
365
 
 
 
237
    _fmt = "No WorkingTree exists for %(base)s."
 
238
    
366
239
    def __init__(self, base):
367
240
        BzrError.__init__(self)
368
241
        self.base = base
381
254
        self.url = url
382
255
 
383
256
 
384
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
385
 
 
386
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
257
class WorkingTreeAlreadyPopulated(BzrError):
 
258
 
 
259
    _fmt = """Working tree already populated in %(base)s"""
 
260
 
 
261
    internal_error = True
387
262
 
388
263
    def __init__(self, base):
389
264
        self.base = base
390
265
 
391
 
 
392
266
class BzrCommandError(BzrError):
393
267
    """Error from user command"""
394
268
 
 
269
    internal_error = False
 
270
 
395
271
    # Error from malformed user command; please avoid raising this as a
396
272
    # generic exception not caused by user input.
397
273
    #
399
275
    # are not intended to be caught anyway.  UI code need not subclass
400
276
    # BzrCommandError, and non-UI code should not throw a subclass of
401
277
    # BzrCommandError.  ADHB 20051211
 
278
    def __init__(self, msg):
 
279
        # Object.__str__() must return a real string
 
280
        # returning a Unicode string is a python error.
 
281
        if isinstance(msg, unicode):
 
282
            self.msg = msg.encode('utf8')
 
283
        else:
 
284
            self.msg = msg
 
285
 
 
286
    def __str__(self):
 
287
        return self.msg
402
288
 
403
289
 
404
290
class NotWriteLocked(BzrError):
414
300
    _fmt = "Error in command line options"
415
301
 
416
302
 
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
303
class BadOptionValue(BzrError):
474
304
 
475
305
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
477
307
    def __init__(self, name, value):
478
308
        BzrError.__init__(self, name=name, value=value)
479
309
 
480
 
 
 
310
    
481
311
class StrictCommitFailed(BzrError):
482
312
 
483
313
    _fmt = "Commit refused because there are unknown files in the tree"
485
315
 
486
316
# XXX: Should be unified with TransportError; they seem to represent the
487
317
# 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
318
class PathError(BzrError):
493
 
 
 
319
    
494
320
    _fmt = "Generic path error: %(path)r%(extra)s)"
495
321
 
496
322
    def __init__(self, path, extra=None):
516
342
    """Used when renaming and both source and dest exist."""
517
343
 
518
344
    _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")
 
345
         "%(extra)s")
521
346
 
522
347
    def __init__(self, source, dest, extra=None):
523
348
        BzrError.__init__(self)
531
356
 
532
357
class NotADirectory(PathError):
533
358
 
534
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
359
    _fmt = "%(path)r is not a directory %(extra)s"
535
360
 
536
361
 
537
362
class NotInWorkingDirectory(PathError):
538
363
 
539
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
364
    _fmt = "%(path)r is not in the working directory %(extra)s"
540
365
 
541
366
 
542
367
class DirectoryNotEmpty(PathError):
543
368
 
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
 
 
 
369
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
370
 
 
371
 
 
372
class ReadingCompleted(BzrError):
 
373
    
554
374
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
555
375
            "called upon it - the request has been completed and no more "
556
376
            "data may be read.")
557
377
 
 
378
    internal_error = True
 
379
 
558
380
    def __init__(self, request):
559
381
        self.request = request
560
382
 
561
383
 
562
384
class ResourceBusy(PathError):
563
385
 
564
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
386
    _fmt = "Device or resource busy: %(path)r%(extra)s"
565
387
 
566
388
 
567
389
class PermissionDenied(PathError):
568
390
 
569
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
391
    _fmt = "Permission denied: %(path)r%(extra)s"
570
392
 
571
393
 
572
394
class InvalidURL(PathError):
573
395
 
574
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
396
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
575
397
 
576
398
 
577
399
class InvalidURLJoin(PathError):
578
400
 
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
 
401
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
402
 
 
403
    def __init__(self, msg, base, args):
 
404
        PathError.__init__(self, base, msg)
 
405
        self.args = [base] + list(args)
608
406
 
609
407
 
610
408
class UnknownHook(BzrError):
625
423
        PathError.__init__(self, url, extra=extra)
626
424
 
627
425
 
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
426
class ShortReadvError(PathError):
666
427
 
667
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
668
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
428
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
669
429
 
670
430
    internal_error = True
671
431
 
676
436
        self.actual = actual
677
437
 
678
438
 
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
 
439
class PathNotChild(BzrError):
 
440
 
 
441
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
442
 
 
443
    internal_error = True
684
444
 
685
445
    def __init__(self, path, base, extra=None):
686
446
        BzrError.__init__(self)
694
454
 
695
455
class InvalidNormalization(PathError):
696
456
 
697
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
457
    _fmt = "Path %(path)r is not unicode normalized"
698
458
 
699
459
 
700
460
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
461
# the exception object is a bit undesirable.
702
 
# TODO: Probably this behavior of should be a common superclass
 
462
# TODO: Probably this behavior of should be a common superclass 
703
463
class NotBranchError(PathError):
704
464
 
705
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
706
 
 
707
 
    def __init__(self, path, detail=None, bzrdir=None):
708
 
       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)
743
 
 
744
 
 
745
 
class NoSubmitBranch(PathError):
746
 
 
747
 
    _fmt = 'No submit branch available for branch "%(path)s"'
748
 
 
749
 
    def __init__(self, branch):
750
 
       import bzrlib.urlutils as urlutils
751
 
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
465
    _fmt = "Not a branch: %(path)s"
 
466
 
 
467
    def __init__(self, path):
 
468
       import bzrlib.urlutils as urlutils
 
469
       self.path = urlutils.unescape_for_display(path, 'ascii')
752
470
 
753
471
 
754
472
class AlreadyBranchError(PathError):
755
473
 
756
 
    _fmt = 'Already a branch: "%(path)s".'
 
474
    _fmt = "Already a branch: %(path)s."
757
475
 
758
476
 
759
477
class BranchExistsWithoutWorkingTree(PathError):
760
478
 
761
 
    _fmt = 'Directory contains a branch, but no working tree \
762
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
479
    _fmt = "Directory contains a branch, but no working tree \
 
480
(use bzr checkout if you wish to build a working tree): %(path)s"
763
481
 
764
482
 
765
483
class AtomicFileAlreadyClosed(PathError):
766
484
 
767
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
768
 
            ' "%(path)s"')
 
485
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
769
486
 
770
487
    def __init__(self, path, function):
771
488
        PathError.__init__(self, path=path, extra=None)
774
491
 
775
492
class InaccessibleParent(PathError):
776
493
 
777
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
778
 
            ' relative path "%(path)s"')
 
494
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
779
495
 
780
496
    def __init__(self, path, base):
781
497
        PathError.__init__(self, path)
784
500
 
785
501
class NoRepositoryPresent(BzrError):
786
502
 
787
 
    _fmt = 'No repository present: "%(path)s"'
 
503
    _fmt = "No repository present: %(path)r"
788
504
    def __init__(self, bzrdir):
789
505
        BzrError.__init__(self)
790
506
        self.path = bzrdir.transport.clone('..').base
792
508
 
793
509
class FileInWrongBranch(BzrError):
794
510
 
795
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
511
    _fmt = "File %(path)s in not in branch %(branch_base)s."
796
512
 
797
 
    # use PathNotChild instead
798
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
513
    def __init__(self, branch, path):
800
514
        BzrError.__init__(self)
801
515
        self.branch = branch
804
518
 
805
519
 
806
520
class UnsupportedFormatError(BzrError):
807
 
 
808
 
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
521
    
 
522
    _fmt = "Unsupported branch format: %(format)s"
809
523
 
810
524
 
811
525
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
 
526
    
 
527
    _fmt = "Unknown branch format: %(format)r"
818
528
 
819
529
 
820
530
class IncompatibleFormat(BzrError):
821
 
 
 
531
    
822
532
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
823
533
 
824
534
    def __init__(self, format, bzrdir_format):
827
537
        self.bzrdir = bzrdir_format
828
538
 
829
539
 
830
 
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)
847
 
 
848
 
 
849
540
class IncompatibleRevision(BzrError):
850
 
 
 
541
    
851
542
    _fmt = "Revision is not compatible with %(repo_format)s"
852
543
 
853
544
    def __init__(self, repo_format):
858
549
class AlreadyVersionedError(BzrError):
859
550
    """Used when a path is expected not to be versioned, but it is."""
860
551
 
861
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
552
    _fmt = "%(context_info)s%(path)s is already versioned"
862
553
 
863
554
    def __init__(self, path, context_info=None):
864
555
        """Construct a new AlreadyVersionedError.
879
570
class NotVersionedError(BzrError):
880
571
    """Used when a path is expected to be versioned, but it is not."""
881
572
 
882
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
573
    _fmt = "%(context_info)s%(path)s is not versioned"
883
574
 
884
575
    def __init__(self, path, context_info=None):
885
576
        """Construct a new NotVersionedError.
936
627
        BzrError.__init__(self, filename=filename, kind=kind)
937
628
 
938
629
 
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
630
class ForbiddenControlFileError(BzrError):
951
631
 
952
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
953
 
 
954
 
 
955
 
class LockError(InternalBzrError):
956
 
 
957
 
    _fmt = "Lock error: %(msg)s"
 
632
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
633
 
 
634
 
 
635
class LockError(BzrError):
 
636
 
 
637
    _fmt = "Lock error: %(message)s"
 
638
 
 
639
    internal_error = True
958
640
 
959
641
    # All exceptions from the lock/unlock functions should be from
960
642
    # this exception class.  They will be translated as necessary. The
961
643
    # original exception is available as e.original_error
962
644
    #
963
645
    # New code should prefer to raise specific subclasses
964
 
    def __init__(self, msg):
965
 
        self.msg = msg
 
646
    def __init__(self, message):
 
647
        self.message = message
966
648
 
967
649
 
968
650
class LockActive(LockError):
1002
684
        self.obj = obj
1003
685
 
1004
686
 
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):
1012
 
        LockError.__init__(self, '')
1013
 
        self.lock = lock
1014
 
        self.why = why
1015
 
 
1016
 
 
1017
687
class OutSideTransaction(BzrError):
1018
688
 
1019
 
    _fmt = ("A transaction related operation was attempted after"
1020
 
            " the transaction finished.")
 
689
    _fmt = "A transaction related operation was attempted after the transaction finished."
1021
690
 
1022
691
 
1023
692
class ObjectNotLocked(LockError):
1041
710
 
1042
711
class UnlockableTransport(LockError):
1043
712
 
1044
 
    internal_error = False
1045
 
 
1046
713
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1047
714
 
1048
715
    def __init__(self, transport):
1051
718
 
1052
719
class LockContention(LockError):
1053
720
 
1054
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
721
    _fmt = "Could not acquire lock %(lock)s"
 
722
    # TODO: show full url for lock, combining the transport and relative
 
723
    # bits?
1055
724
 
1056
725
    internal_error = False
1057
 
 
1058
 
    def __init__(self, lock, msg=''):
 
726
    
 
727
    def __init__(self, lock):
1059
728
        self.lock = lock
1060
 
        self.msg = msg
1061
729
 
1062
730
 
1063
731
class LockBroken(LockError):
1064
732
 
1065
 
    _fmt = ("Lock was broken while still open: %(lock)s"
1066
 
            " - check storage consistency!")
 
733
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
1067
734
 
1068
735
    internal_error = False
1069
736
 
1073
740
 
1074
741
class LockBreakMismatch(LockError):
1075
742
 
1076
 
    _fmt = ("Lock was released and re-acquired before being broken:"
1077
 
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
743
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
1078
744
 
1079
745
    internal_error = False
1080
746
 
1084
750
        self.target = target
1085
751
 
1086
752
 
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
753
class LockNotHeld(LockError):
1100
754
 
1101
755
    _fmt = "Lock not held: %(lock)s"
1106
760
        self.lock = lock
1107
761
 
1108
762
 
1109
 
class TokenLockingNotSupported(LockError):
1110
 
 
1111
 
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1112
 
 
1113
 
    def __init__(self, obj):
1114
 
        self.obj = obj
1115
 
 
1116
 
 
1117
 
class TokenMismatch(LockBroken):
1118
 
 
1119
 
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
1120
 
 
1121
 
    internal_error = True
1122
 
 
1123
 
    def __init__(self, given_token, lock_token):
1124
 
        self.given_token = given_token
1125
 
        self.lock_token = lock_token
1126
 
 
1127
 
 
1128
763
class PointlessCommit(BzrError):
1129
764
 
1130
765
    _fmt = "No changes to commit"
1131
766
 
1132
767
 
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 ExcludesUnsupported(BzrError):
1144
 
 
1145
 
    _fmt = ('Excluding paths during commit is not supported by '
1146
 
            'repository at %(repository)r.')
1147
 
 
1148
 
    def __init__(self, repository):
1149
 
        BzrError.__init__(self, repository=repository)
1150
 
 
1151
 
 
1152
 
class BadCommitMessageEncoding(BzrError):
1153
 
 
1154
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1155
 
        'the current encoding.'
1156
 
 
1157
 
 
1158
768
class UpgradeReadonly(BzrError):
1159
769
 
1160
770
    _fmt = "Upgrade URL cannot work with readonly URLs."
1174
784
    _fmt = "Commit refused because there are unknowns in the tree."
1175
785
 
1176
786
 
1177
 
class NoSuchRevision(InternalBzrError):
1178
 
 
1179
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
787
class NoSuchRevision(BzrError):
 
788
 
 
789
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
790
 
 
791
    internal_error = True
1180
792
 
1181
793
    def __init__(self, branch, revision):
1182
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1183
794
        BzrError.__init__(self, branch=branch, revision=revision)
1184
795
 
1185
796
 
1186
 
class RangeInChangeOption(BzrError):
1187
 
 
1188
 
    _fmt = "Option --change does not accept revision ranges"
 
797
class NotLeftParentDescendant(BzrError):
 
798
 
 
799
    _fmt = "Revision %(old_revision)s is not the left parent of"\
 
800
        " %(new_revision)s, but branch %(branch_location)s expects this"
 
801
 
 
802
    internal_error = True
 
803
 
 
804
    def __init__(self, branch, old_revision, new_revision):
 
805
        BzrError.__init__(self, branch_location=branch.base,
 
806
                          old_revision=old_revision,
 
807
                          new_revision=new_revision)
1189
808
 
1190
809
 
1191
810
class NoSuchRevisionSpec(BzrError):
1198
817
 
1199
818
class NoSuchRevisionInTree(NoSuchRevision):
1200
819
    """When using Tree.revision_tree, and the revision is not accessible."""
1201
 
 
1202
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
820
    
 
821
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1203
822
 
1204
823
    def __init__(self, tree, revision_id):
1205
824
        BzrError.__init__(self)
1209
828
 
1210
829
class InvalidRevisionSpec(BzrError):
1211
830
 
1212
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
 
            " %(branch_url)s%(extra)s")
 
831
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
1214
832
 
1215
833
    def __init__(self, spec, branch, extra=None):
1216
834
        BzrError.__init__(self, branch=branch, spec=spec)
1217
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1218
835
        if extra:
1219
836
            self.extra = '\n' + str(extra)
1220
837
        else:
1228
845
 
1229
846
class AppendRevisionsOnlyViolation(BzrError):
1230
847
 
1231
 
    _fmt = ('Operation denied because it would change the main history,'
1232
 
           ' which is not permitted by the append_revisions_only setting on'
1233
 
           ' branch "%(location)s".')
 
848
    _fmt = 'Operation denied because it would change the main history, '\
 
849
           'which is not permitted by the append_revisions_only setting on'\
 
850
           ' branch "%(location)s".'
1234
851
 
1235
852
    def __init__(self, location):
1236
853
       import bzrlib.urlutils as urlutils
1239
856
 
1240
857
 
1241
858
class DivergedBranches(BzrError):
 
859
    
 
860
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
1242
861
 
1243
 
    _fmt = ("These branches have diverged."
1244
 
            " Use the missing command to see how.\n"
1245
 
            "Use the merge command to reconcile them.")
 
862
    internal_error = False
1246
863
 
1247
864
    def __init__(self, branch1, branch2):
1248
865
        self.branch1 = branch1
1249
866
        self.branch2 = branch2
1250
867
 
1251
868
 
1252
 
class NotLefthandHistory(InternalBzrError):
 
869
class NotLefthandHistory(BzrError):
1253
870
 
1254
871
    _fmt = "Supplied history does not follow left-hand parents"
1255
872
 
 
873
    internal_error = True
 
874
 
1256
875
    def __init__(self, history):
1257
876
        BzrError.__init__(self, history=history)
1258
877
 
1259
878
 
1260
879
class UnrelatedBranches(BzrError):
1261
880
 
1262
 
    _fmt = ("Branches have no common ancestor, and"
1263
 
            " no merge base revision was specified.")
1264
 
 
1265
 
 
1266
 
class CannotReverseCherrypick(BzrError):
1267
 
 
1268
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1269
 
            ' or diff3.')
 
881
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
882
 
 
883
    internal_error = False
1270
884
 
1271
885
 
1272
886
class NoCommonAncestor(BzrError):
1273
 
 
 
887
    
1274
888
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1275
889
 
1276
890
    def __init__(self, revision_a, revision_b):
1280
894
 
1281
895
class NoCommonRoot(BzrError):
1282
896
 
1283
 
    _fmt = ("Revisions are not derived from the same root: "
1284
 
           "%(revision_a)s %(revision_b)s.")
 
897
    _fmt = "Revisions are not derived from the same root: " \
 
898
           "%(revision_a)s %(revision_b)s."
1285
899
 
1286
900
    def __init__(self, revision_a, revision_b):
1287
901
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
1296
910
            not_ancestor_id=not_ancestor_id)
1297
911
 
1298
912
 
 
913
class InstallFailed(BzrError):
 
914
 
 
915
    def __init__(self, revisions):
 
916
        revision_str = ", ".join(str(r) for r in revisions)
 
917
        msg = "Could not install revisions:\n%s" % revision_str
 
918
        BzrError.__init__(self, msg)
 
919
        self.revisions = revisions
 
920
 
 
921
 
1299
922
class AmbiguousBase(BzrError):
1300
923
 
1301
924
    def __init__(self, bases):
1302
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1304
 
        msg = ("The correct base is unclear, because %s are all equally close"
1305
 
                % ", ".join(bases))
 
925
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
926
                DeprecationWarning)
 
927
        msg = "The correct base is unclear, because %s are all equally close" %\
 
928
            ", ".join(bases)
1306
929
        BzrError.__init__(self, msg)
1307
930
        self.bases = bases
1308
931
 
1309
932
 
1310
 
class NoCommits(BranchError):
 
933
class NoCommits(BzrError):
1311
934
 
1312
935
    _fmt = "Branch %(branch)s has no commits."
1313
936
 
 
937
    def __init__(self, branch):
 
938
        BzrError.__init__(self, branch=branch)
 
939
 
1314
940
 
1315
941
class UnlistableStore(BzrError):
1316
942
 
1327
953
 
1328
954
class BoundBranchOutOfDate(BzrError):
1329
955
 
1330
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1331
 
            " %(master)s.%(extra_help)s")
 
956
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
1332
957
 
1333
958
    def __init__(self, branch, master):
1334
959
        BzrError.__init__(self)
1335
960
        self.branch = branch
1336
961
        self.master = master
1337
 
        self.extra_help = ''
1338
 
 
1339
 
 
 
962
 
 
963
        
1340
964
class CommitToDoubleBoundBranch(BzrError):
1341
965
 
1342
 
    _fmt = ("Cannot commit to branch %(branch)s."
1343
 
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
966
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
1344
967
 
1345
968
    def __init__(self, branch, master, remote):
1346
969
        BzrError.__init__(self)
1360
983
 
1361
984
class BoundBranchConnectionFailure(BzrError):
1362
985
 
1363
 
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
1364
 
            " => %(target)s: %(error)s")
 
986
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
1365
987
 
1366
988
    def __init__(self, branch, target, error):
1367
989
        BzrError.__init__(self)
1372
994
 
1373
995
class WeaveError(BzrError):
1374
996
 
1375
 
    _fmt = "Error in processing weave: %(msg)s"
 
997
    _fmt = "Error in processing weave: %(message)s"
1376
998
 
1377
 
    def __init__(self, msg=None):
 
999
    def __init__(self, message=None):
1378
1000
        BzrError.__init__(self)
1379
 
        self.msg = msg
 
1001
        self.message = message
1380
1002
 
1381
1003
 
1382
1004
class WeaveRevisionAlreadyPresent(WeaveError):
1411
1033
 
1412
1034
class WeaveParentMismatch(WeaveError):
1413
1035
 
1414
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1415
 
 
 
1036
    _fmt = "Parents are mismatched between two revisions."
 
1037
    
1416
1038
 
1417
1039
class WeaveInvalidChecksum(WeaveError):
1418
1040
 
1419
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1041
    _fmt = "Text did not match it's checksum: %(message)s"
1420
1042
 
1421
1043
 
1422
1044
class WeaveTextDiffers(WeaveError):
1423
1045
 
1424
 
    _fmt = ("Weaves differ on text content. Revision:"
1425
 
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1046
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
1426
1047
 
1427
1048
    def __init__(self, revision_id, weave_a, weave_b):
1428
1049
        WeaveError.__init__(self)
1433
1054
 
1434
1055
class WeaveTextDiffers(WeaveError):
1435
1056
 
1436
 
    _fmt = ("Weaves differ on text content. Revision:"
1437
 
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1057
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
1438
1058
 
1439
1059
    def __init__(self, revision_id, weave_a, weave_b):
1440
1060
        WeaveError.__init__(self)
1444
1064
 
1445
1065
 
1446
1066
class VersionedFileError(BzrError):
1447
 
 
 
1067
    
1448
1068
    _fmt = "Versioned file error"
1449
1069
 
1450
1070
 
1451
1071
class RevisionNotPresent(VersionedFileError):
1452
 
 
1453
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1072
    
 
1073
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1454
1074
 
1455
1075
    def __init__(self, revision_id, file_id):
1456
1076
        VersionedFileError.__init__(self)
1459
1079
 
1460
1080
 
1461
1081
class RevisionAlreadyPresent(VersionedFileError):
1462
 
 
1463
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1082
    
 
1083
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1464
1084
 
1465
1085
    def __init__(self, revision_id, file_id):
1466
1086
        VersionedFileError.__init__(self)
1468
1088
        self.file_id = file_id
1469
1089
 
1470
1090
 
1471
 
class VersionedFileInvalidChecksum(VersionedFileError):
1472
 
 
1473
 
    _fmt = "Text did not match its checksum: %(msg)s"
1474
 
 
1475
 
 
1476
 
class KnitError(InternalBzrError):
1477
 
 
 
1091
class KnitError(BzrError):
 
1092
    
1478
1093
    _fmt = "Knit error"
1479
1094
 
 
1095
    internal_error = True
 
1096
 
 
1097
 
 
1098
class KnitHeaderError(KnitError):
 
1099
 
 
1100
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1101
 
 
1102
    def __init__(self, badline, filename):
 
1103
        KnitError.__init__(self)
 
1104
        self.badline = badline
 
1105
        self.filename = filename
 
1106
 
1480
1107
 
1481
1108
class KnitCorrupt(KnitError):
1482
1109
 
1488
1115
        self.how = how
1489
1116
 
1490
1117
 
1491
 
class SHA1KnitCorrupt(KnitCorrupt):
1492
 
 
1493
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1494
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1495
 
        "sha %(actual)s")
1496
 
 
1497
 
    def __init__(self, filename, actual, expected, key, content):
1498
 
        KnitError.__init__(self)
1499
 
        self.filename = filename
1500
 
        self.actual = actual
1501
 
        self.expected = expected
1502
 
        self.key = key
1503
 
        self.content = content
1504
 
 
1505
 
 
1506
 
class KnitDataStreamIncompatible(KnitError):
1507
 
    # Not raised anymore, as we can convert data streams.  In future we may
1508
 
    # need it again for more exotic cases, so we're keeping it around for now.
1509
 
 
1510
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1511
 
 
1512
 
    def __init__(self, stream_format, target_format):
1513
 
        self.stream_format = stream_format
1514
 
        self.target_format = target_format
1515
 
 
1516
 
 
1517
 
class KnitDataStreamUnknown(KnitError):
1518
 
    # Indicates a data stream we don't know how to handle.
1519
 
 
1520
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1521
 
 
1522
 
    def __init__(self, stream_format):
1523
 
        self.stream_format = stream_format
1524
 
 
1525
 
 
1526
 
class KnitHeaderError(KnitError):
1527
 
 
1528
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1529
 
 
1530
 
    def __init__(self, badline, filename):
1531
 
        KnitError.__init__(self)
1532
 
        self.badline = badline
1533
 
        self.filename = filename
1534
 
 
1535
1118
class KnitIndexUnknownMethod(KnitError):
1536
1119
    """Raised when we don't understand the storage method.
1537
1120
 
1538
1121
    Currently only 'fulltext' and 'line-delta' are supported.
1539
1122
    """
1540
 
 
 
1123
    
1541
1124
    _fmt = ("Knit index %(filename)s does not have a known method"
1542
1125
            " in options: %(options)r")
1543
1126
 
1547
1130
        self.options = options
1548
1131
 
1549
1132
 
1550
 
class RetryWithNewPacks(BzrError):
1551
 
    """Raised when we realize that the packs on disk have changed.
1552
 
 
1553
 
    This is meant as more of a signaling exception, to trap between where a
1554
 
    local error occurred and the code that can actually handle the error and
1555
 
    code that can retry appropriately.
1556
 
    """
1557
 
 
1558
 
    internal_error = True
1559
 
 
1560
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1561
 
            " %(orig_error)s")
1562
 
 
1563
 
    def __init__(self, context, reload_occurred, exc_info):
1564
 
        """create a new RetryWithNewPacks error.
1565
 
 
1566
 
        :param reload_occurred: Set to True if we know that the packs have
1567
 
            already been reloaded, and we are failing because of an in-memory
1568
 
            cache miss. If set to True then we will ignore if a reload says
1569
 
            nothing has changed, because we assume it has already reloaded. If
1570
 
            False, then a reload with nothing changed will force an error.
1571
 
        :param exc_info: The original exception traceback, so if there is a
1572
 
            problem we can raise the original error (value from sys.exc_info())
1573
 
        """
1574
 
        BzrError.__init__(self)
1575
 
        self.reload_occurred = reload_occurred
1576
 
        self.exc_info = exc_info
1577
 
        self.orig_error = exc_info[1]
1578
 
        # TODO: The global error handler should probably treat this by
1579
 
        #       raising/printing the original exception with a bit about
1580
 
        #       RetryWithNewPacks also not being caught
1581
 
 
1582
 
 
1583
 
class RetryAutopack(RetryWithNewPacks):
1584
 
    """Raised when we are autopacking and we find a missing file.
1585
 
 
1586
 
    Meant as a signaling exception, to tell the autopack code it should try
1587
 
    again.
1588
 
    """
1589
 
 
1590
 
    internal_error = True
1591
 
 
1592
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1593
 
            " context: %(context)s %(orig_error)s")
1594
 
 
1595
 
 
1596
1133
class NoSuchExportFormat(BzrError):
1597
 
 
 
1134
    
1598
1135
    _fmt = "Export format %(format)r not supported"
1599
1136
 
1600
1137
    def __init__(self, format):
1603
1140
 
1604
1141
 
1605
1142
class TransportError(BzrError):
1606
 
 
 
1143
    
1607
1144
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1608
1145
 
1609
1146
    def __init__(self, msg=None, orig_error=None):
1618
1155
        BzrError.__init__(self)
1619
1156
 
1620
1157
 
1621
 
class TooManyConcurrentRequests(InternalBzrError):
1622
 
 
1623
 
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1624
 
            " Be sure to finish_writing and finish_reading on the"
1625
 
            " currently open request.")
 
1158
class TooManyConcurrentRequests(BzrError):
 
1159
 
 
1160
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
1161
            "Be sure to finish_writing and finish_reading on the "
 
1162
            "current request that is open.")
 
1163
 
 
1164
    internal_error = True
1626
1165
 
1627
1166
    def __init__(self, medium):
1628
1167
        self.medium = medium
1636
1175
        self.details = details
1637
1176
 
1638
1177
 
1639
 
class UnexpectedProtocolVersionMarker(TransportError):
1640
 
 
1641
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1642
 
 
1643
 
    def __init__(self, marker):
1644
 
        self.marker = marker
1645
 
 
1646
 
 
1647
 
class UnknownSmartMethod(InternalBzrError):
1648
 
 
1649
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1650
 
 
1651
 
    def __init__(self, verb):
1652
 
        self.verb = verb
1653
 
 
1654
 
 
1655
 
class SmartMessageHandlerError(InternalBzrError):
1656
 
 
1657
 
    _fmt = ("The message handler raised an exception:\n"
1658
 
            "%(traceback_text)s")
1659
 
 
1660
 
    def __init__(self, exc_info):
1661
 
        import traceback
1662
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1663
 
        self.exc_info = exc_info
1664
 
        traceback_strings = traceback.format_exception(
1665
 
                self.exc_type, self.exc_value, self.exc_tb)
1666
 
        self.traceback_text = ''.join(traceback_strings)
1667
 
 
1668
 
 
1669
1178
# A set of semi-meaningful errors which can be thrown
1670
1179
class TransportNotPossible(TransportError):
1671
1180
 
1696
1205
            self.port = ':%s' % port
1697
1206
 
1698
1207
 
1699
 
# XXX: This is also used for unexpected end of file, which is different at the
1700
 
# TCP level from "connection reset".
1701
1208
class ConnectionReset(TransportError):
1702
1209
 
1703
1210
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1705
1212
 
1706
1213
class InvalidRange(TransportError):
1707
1214
 
1708
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1709
 
 
1710
 
    def __init__(self, path, offset, msg=None):
1711
 
        TransportError.__init__(self, msg)
 
1215
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1216
    
 
1217
    def __init__(self, path, offset):
 
1218
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1219
                                       % (path, offset)))
1712
1220
        self.path = path
1713
1221
        self.offset = offset
1714
1222
 
1725
1233
class InvalidHttpRange(InvalidHttpResponse):
1726
1234
 
1727
1235
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1728
 
 
 
1236
    
1729
1237
    def __init__(self, path, range, msg):
1730
1238
        self.range = range
1731
1239
        InvalidHttpResponse.__init__(self, path, msg)
1734
1242
class InvalidHttpContentType(InvalidHttpResponse):
1735
1243
 
1736
1244
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1737
 
 
 
1245
    
1738
1246
    def __init__(self, path, ctype, msg):
1739
1247
        self.ctype = ctype
1740
1248
        InvalidHttpResponse.__init__(self, path, msg)
1741
1249
 
1742
1250
 
1743
 
class RedirectRequested(TransportError):
1744
 
 
1745
 
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1746
 
 
1747
 
    def __init__(self, source, target, is_permanent=False):
1748
 
        self.source = source
1749
 
        self.target = target
1750
 
        if is_permanent:
1751
 
            self.permanently = ' permanently'
1752
 
        else:
1753
 
            self.permanently = ''
1754
 
        TransportError.__init__(self)
1755
 
 
1756
 
 
1757
 
class TooManyRedirections(TransportError):
1758
 
 
1759
 
    _fmt = "Too many redirections"
1760
 
 
1761
 
 
1762
1251
class ConflictsInTree(BzrError):
1763
1252
 
1764
1253
    _fmt = "Working tree has conflicts."
1770
1259
        if filename is None:
1771
1260
            filename = ""
1772
1261
        message = "Error(s) parsing config file %s:\n%s" % \
1773
 
            (filename, ('\n'.join(e.msg for e in errors)))
 
1262
            (filename, ('\n'.join(e.message for e in errors)))
1774
1263
        BzrError.__init__(self, message)
1775
1264
 
1776
1265
 
1785
1274
 
1786
1275
class SigningFailed(BzrError):
1787
1276
 
1788
 
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1277
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1789
1278
 
1790
1279
    def __init__(self, command_line):
1791
1280
        BzrError.__init__(self, command_line=command_line)
1793
1282
 
1794
1283
class WorkingTreeNotRevision(BzrError):
1795
1284
 
1796
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1285
    _fmt = ("The working tree for %(basedir)s has changed since" 
1797
1286
            " the last commit, but weave merge requires that it be"
1798
1287
            " unchanged")
1799
1288
 
1803
1292
 
1804
1293
class CantReprocessAndShowBase(BzrError):
1805
1294
 
1806
 
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
1807
 
           "the relationship of conflicting lines to the base")
 
1295
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
1296
           "the relationship of conflicting lines to the base"
1808
1297
 
1809
1298
 
1810
1299
class GraphCycleError(BzrError):
1816
1305
        self.graph = graph
1817
1306
 
1818
1307
 
1819
 
class WritingCompleted(InternalBzrError):
 
1308
class WritingCompleted(BzrError):
1820
1309
 
1821
1310
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1822
1311
            "called upon it - accept bytes may not be called anymore.")
1823
1312
 
 
1313
    internal_error = True
 
1314
 
1824
1315
    def __init__(self, request):
1825
1316
        self.request = request
1826
1317
 
1827
1318
 
1828
 
class WritingNotComplete(InternalBzrError):
 
1319
class WritingNotComplete(BzrError):
1829
1320
 
1830
1321
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1831
1322
            "called upon it - until the write phase is complete no "
1832
1323
            "data may be read.")
1833
1324
 
 
1325
    internal_error = True
 
1326
 
1834
1327
    def __init__(self, request):
1835
1328
        self.request = request
1836
1329
 
1844
1337
        self.filename = filename
1845
1338
 
1846
1339
 
1847
 
class MediumNotConnected(InternalBzrError):
 
1340
class MediumNotConnected(BzrError):
1848
1341
 
1849
1342
    _fmt = """The medium '%(medium)s' is not connected."""
1850
1343
 
 
1344
    internal_error = True
 
1345
 
1851
1346
    def __init__(self, medium):
1852
1347
        self.medium = medium
1853
1348
 
1854
1349
 
1855
1350
class MustUseDecorated(Exception):
1856
 
 
1857
 
    _fmt = "A decorating function has requested its original command be used."
1858
 
 
 
1351
    
 
1352
    _fmt = """A decorating function has requested its original command be used."""
 
1353
    
1859
1354
 
1860
1355
class NoBundleFound(BzrError):
1861
1356
 
1862
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1357
    _fmt = "No bundle was found in %(filename)s"
1863
1358
 
1864
1359
    def __init__(self, filename):
1865
1360
        BzrError.__init__(self)
1878
1373
 
1879
1374
class MissingText(BzrError):
1880
1375
 
1881
 
    _fmt = ("Branch %(base)s is missing revision"
1882
 
            " %(text_revision)s of %(file_id)s")
 
1376
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
1883
1377
 
1884
1378
    def __init__(self, branch, text_revision, file_id):
1885
1379
        BzrError.__init__(self)
1904
1398
    _fmt = "Key %(key)s is already present in map"
1905
1399
 
1906
1400
 
1907
 
class DuplicateHelpPrefix(BzrError):
1908
 
 
1909
 
    _fmt = "The prefix %(prefix)s is in the help search path twice."
1910
 
 
1911
 
    def __init__(self, prefix):
1912
 
        self.prefix = prefix
1913
 
 
1914
 
 
1915
1401
class MalformedTransform(BzrError):
1916
1402
 
1917
1403
    _fmt = "Tree transform is malformed %(conflicts)r"
1929
1415
        self.root_trans_id = transform.root
1930
1416
 
1931
1417
 
1932
 
class BzrBadParameter(InternalBzrError):
 
1418
class BzrBadParameter(BzrError):
1933
1419
 
1934
1420
    _fmt = "Bad parameter: %(param)r"
1935
1421
 
1956
1442
    _fmt = "Moving the root directory is not supported at this time"
1957
1443
 
1958
1444
 
1959
 
class TransformRenameFailed(BzrError):
1960
 
 
1961
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1962
 
 
1963
 
    def __init__(self, from_path, to_path, why, errno):
1964
 
        self.from_path = from_path
1965
 
        self.to_path = to_path
1966
 
        self.why = why
1967
 
        self.errno = errno
1968
 
 
1969
 
 
1970
1445
class BzrMoveFailedError(BzrError):
1971
1446
 
1972
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1973
 
        "%(_has_extra)s%(extra)s")
 
1447
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1974
1448
 
1975
1449
    def __init__(self, from_path='', to_path='', extra=None):
1976
 
        from bzrlib.osutils import splitpath
1977
1450
        BzrError.__init__(self)
1978
1451
        if extra:
1979
 
            self.extra, self._has_extra = extra, ': '
 
1452
            self.extra = ': ' + str(extra)
1980
1453
        else:
1981
 
            self.extra = self._has_extra = ''
 
1454
            self.extra = ''
1982
1455
 
1983
1456
        has_from = len(from_path) > 0
1984
1457
        has_to = len(to_path) > 0
1985
1458
        if has_from:
1986
 
            self.from_path = splitpath(from_path)[-1]
 
1459
            self.from_path = osutils.splitpath(from_path)[-1]
1987
1460
        else:
1988
1461
            self.from_path = ''
1989
1462
 
1990
1463
        if has_to:
1991
 
            self.to_path = splitpath(to_path)[-1]
 
1464
            self.to_path = osutils.splitpath(to_path)[-1]
1992
1465
        else:
1993
1466
            self.to_path = ''
1994
1467
 
2005
1478
 
2006
1479
class BzrRenameFailedError(BzrMoveFailedError):
2007
1480
 
2008
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2009
 
        "%(_has_extra)s%(extra)s")
 
1481
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2010
1482
 
2011
1483
    def __init__(self, from_path, to_path, extra=None):
2012
1484
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2013
1485
 
2014
1486
 
2015
 
class BzrRemoveChangedFilesError(BzrError):
2016
 
    """Used when user is trying to remove changed files."""
2017
 
 
2018
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2019
 
        "%(changes_as_text)s"
2020
 
        "Use --keep to not delete them, or --force to delete them regardless.")
2021
 
 
2022
 
    def __init__(self, tree_delta):
2023
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2024
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2025
 
        BzrError.__init__(self)
2026
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2027
 
        #self.paths_as_string = '\n'.join(changed_files)
2028
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2029
 
 
2030
 
 
2031
1487
class BzrBadParameterNotString(BzrBadParameter):
2032
1488
 
2033
1489
    _fmt = "Parameter %(param)s is not a string or unicode string."
2035
1491
 
2036
1492
class BzrBadParameterMissing(BzrBadParameter):
2037
1493
 
2038
 
    _fmt = "Parameter %(param)s is required but not present."
 
1494
    _fmt = "Parameter $(param)s is required but not present."
2039
1495
 
2040
1496
 
2041
1497
class BzrBadParameterUnicode(BzrBadParameter):
2042
1498
 
2043
 
    _fmt = ("Parameter %(param)s is unicode but"
2044
 
            " only byte-strings are permitted.")
 
1499
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
2045
1500
 
2046
1501
 
2047
1502
class BzrBadParameterContainsNewline(BzrBadParameter):
2081
1536
 
2082
1537
class BadConversionTarget(BzrError):
2083
1538
 
2084
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2085
 
            "    %(problem)s"
 
1539
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2086
1540
 
2087
 
    def __init__(self, problem, format, from_format=None):
 
1541
    def __init__(self, problem, format):
2088
1542
        BzrError.__init__(self)
2089
1543
        self.problem = problem
2090
1544
        self.format = format
2091
 
        self.from_format = from_format or '(unspecified)'
2092
 
 
2093
 
 
2094
 
class NoDiffFound(BzrError):
2095
 
 
2096
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2097
 
 
2098
 
    def __init__(self, path):
2099
 
        BzrError.__init__(self, path)
2100
 
 
2101
 
 
2102
 
class ExecutableMissing(BzrError):
2103
 
 
2104
 
    _fmt = "%(exe_name)s could not be found on this machine"
2105
 
 
2106
 
    def __init__(self, exe_name):
2107
 
        BzrError.__init__(self, exe_name=exe_name)
2108
1545
 
2109
1546
 
2110
1547
class NoDiff(BzrError):
2120
1557
    _fmt = "Diff3 is not installed on this machine."
2121
1558
 
2122
1559
 
2123
 
class ExistingContent(BzrError):
2124
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2125
 
 
2126
 
    _fmt = "The content being inserted is already present."
2127
 
 
2128
 
 
2129
1560
class ExistingLimbo(BzrError):
2130
1561
 
2131
1562
    _fmt = """This tree contains left-over files from a failed operation.
2132
1563
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2133
1564
    keep, and delete it when you are done."""
2134
 
 
 
1565
    
2135
1566
    def __init__(self, limbo_dir):
2136
1567
       BzrError.__init__(self)
2137
1568
       self.limbo_dir = limbo_dir
2138
1569
 
2139
1570
 
2140
 
class ExistingPendingDeletion(BzrError):
2141
 
 
2142
 
    _fmt = """This tree contains left-over files from a failed operation.
2143
 
    Please examine %(pending_deletion)s to see if it contains any files you
2144
 
    wish to keep, and delete it when you are done."""
2145
 
 
2146
 
    def __init__(self, pending_deletion):
2147
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2148
 
 
2149
 
 
2150
1571
class ImmortalLimbo(BzrError):
2151
1572
 
2152
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1573
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2153
1574
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2154
1575
    keep, and delete it when you are done."""
2155
1576
 
2158
1579
       self.limbo_dir = limbo_dir
2159
1580
 
2160
1581
 
2161
 
class ImmortalPendingDeletion(BzrError):
2162
 
 
2163
 
    _fmt = ("Unable to delete transform temporary directory "
2164
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2165
 
    "contains any files you wish to keep, and delete it when you are done.")
2166
 
 
2167
 
    def __init__(self, pending_deletion):
2168
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2169
 
 
2170
 
 
2171
1582
class OutOfDateTree(BzrError):
2172
1583
 
2173
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1584
    _fmt = "Working tree is out of date, please run 'bzr update'."
2174
1585
 
2175
 
    def __init__(self, tree, more=None):
2176
 
        if more is None:
2177
 
            more = ''
2178
 
        else:
2179
 
            more = ' ' + more
 
1586
    def __init__(self, tree):
2180
1587
        BzrError.__init__(self)
2181
1588
        self.tree = tree
2182
 
        self.more = more
2183
 
 
2184
 
 
2185
 
class PublicBranchOutOfDate(BzrError):
2186
 
 
2187
 
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
2188
 
        '"%(revstring)s".'
2189
 
 
2190
 
    def __init__(self, public_location, revstring):
2191
 
        import bzrlib.urlutils as urlutils
2192
 
        public_location = urlutils.unescape_for_display(public_location,
2193
 
                                                        'ascii')
2194
 
        BzrError.__init__(self, public_location=public_location,
2195
 
                          revstring=revstring)
2196
1589
 
2197
1590
 
2198
1591
class MergeModifiedFormatError(BzrError):
2205
1598
    _fmt = "Format error in conflict listings"
2206
1599
 
2207
1600
 
2208
 
class CorruptDirstate(BzrError):
2209
 
 
2210
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2211
 
            "Error: %(description)s")
2212
 
 
2213
 
    def __init__(self, dirstate_path, description):
2214
 
        BzrError.__init__(self)
2215
 
        self.dirstate_path = dirstate_path
2216
 
        self.description = description
2217
 
 
2218
 
 
2219
1601
class CorruptRepository(BzrError):
2220
1602
 
2221
 
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2222
 
            "Please run bzr reconcile on this repository.")
 
1603
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
1604
Please run bzr reconcile on this repository."""
2223
1605
 
2224
1606
    def __init__(self, repo):
2225
1607
        BzrError.__init__(self)
2226
 
        self.repo_path = repo.user_url
2227
 
 
2228
 
 
2229
 
class InconsistentDelta(BzrError):
2230
 
    """Used when we get a delta that is not valid."""
2231
 
 
2232
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2233
 
            " %(file_id)r\nreason: %(reason)s")
2234
 
 
2235
 
    def __init__(self, path, file_id, reason):
2236
 
        BzrError.__init__(self)
2237
 
        self.path = path
2238
 
        self.file_id = file_id
2239
 
        self.reason = reason
2240
 
 
2241
 
 
2242
 
class InconsistentDeltaDelta(InconsistentDelta):
2243
 
    """Used when we get a delta that is not valid."""
2244
 
 
2245
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2246
 
            "\nreason: %(reason)s")
2247
 
 
2248
 
    def __init__(self, delta, reason):
2249
 
        BzrError.__init__(self)
2250
 
        self.delta = delta
2251
 
        self.reason = reason
 
1608
        self.repo_path = repo.bzrdir.root_transport.base
2252
1609
 
2253
1610
 
2254
1611
class UpgradeRequired(BzrError):
2260
1617
        self.path = path
2261
1618
 
2262
1619
 
2263
 
class RepositoryUpgradeRequired(UpgradeRequired):
2264
 
 
2265
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2266
 
 
2267
 
 
2268
 
class RichRootUpgradeRequired(UpgradeRequired):
2269
 
 
2270
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2271
 
           " a format which supports rich roots.")
2272
 
 
2273
 
 
2274
1620
class LocalRequiresBoundBranch(BzrError):
2275
1621
 
2276
1622
    _fmt = "Cannot perform local-only commits on unbound branches."
2277
1623
 
2278
1624
 
 
1625
class MissingProgressBarFinish(BzrError):
 
1626
 
 
1627
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1628
 
 
1629
 
 
1630
class InvalidProgressBarType(BzrError):
 
1631
 
 
1632
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1633
Select one of: %(valid_types)s"""
 
1634
 
 
1635
    def __init__(self, bar_type, valid_types):
 
1636
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1637
 
 
1638
 
2279
1639
class UnsupportedOperation(BzrError):
2280
1640
 
2281
 
    _fmt = ("The method %(mname)s is not supported on"
2282
 
            " objects of type %(tname)s.")
 
1641
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
2283
1642
 
2284
1643
    def __init__(self, method, method_self):
2285
1644
        self.method = method
2292
1651
 
2293
1652
 
2294
1653
class NonAsciiRevisionId(UnsupportedOperation):
2295
 
    """Raised when a commit is attempting to set a non-ascii revision id
2296
 
       but cant.
2297
 
    """
 
1654
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
2298
1655
 
2299
1656
 
2300
1657
class BinaryFile(BzrError):
2301
 
 
 
1658
    
2302
1659
    _fmt = "File is binary but should be text."
2303
1660
 
2304
1661
 
2313
1670
 
2314
1671
class TestamentMismatch(BzrError):
2315
1672
 
2316
 
    _fmt = """Testament did not match expected value.
2317
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1673
    _fmt = """Testament did not match expected value.  
 
1674
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
2318
1675
       {%(measured)s}"""
2319
1676
 
2320
1677
    def __init__(self, revision_id, expected, measured):
2324
1681
 
2325
1682
 
2326
1683
class NotABundle(BzrError):
2327
 
 
 
1684
    
2328
1685
    _fmt = "Not a bzr revision-bundle: %(text)r"
2329
1686
 
2330
1687
    def __init__(self, text):
2332
1689
        self.text = text
2333
1690
 
2334
1691
 
2335
 
class BadBundle(BzrError):
2336
 
 
 
1692
class BadBundle(BzrError): 
 
1693
    
2337
1694
    _fmt = "Bad bzr revision-bundle: %(text)r"
2338
1695
 
2339
1696
    def __init__(self, text):
2341
1698
        self.text = text
2342
1699
 
2343
1700
 
2344
 
class MalformedHeader(BadBundle):
2345
 
 
 
1701
class MalformedHeader(BadBundle): 
 
1702
    
2346
1703
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2347
1704
 
2348
1705
 
2349
 
class MalformedPatches(BadBundle):
2350
 
 
 
1706
class MalformedPatches(BadBundle): 
 
1707
    
2351
1708
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2352
1709
 
2353
1710
 
2354
 
class MalformedFooter(BadBundle):
2355
 
 
 
1711
class MalformedFooter(BadBundle): 
 
1712
    
2356
1713
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2357
1714
 
2358
1715
 
2359
1716
class UnsupportedEOLMarker(BadBundle):
2360
 
 
2361
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1717
    
 
1718
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2362
1719
 
2363
1720
    def __init__(self):
2364
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1721
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2365
1722
        # but for this there is not
2366
1723
        BzrError.__init__(self)
2367
1724
 
2368
1725
 
2369
1726
class IncompatibleBundleFormat(BzrError):
2370
 
 
 
1727
    
2371
1728
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2372
1729
 
2373
1730
    def __init__(self, bundle_format, other):
2377
1734
 
2378
1735
 
2379
1736
class BadInventoryFormat(BzrError):
2380
 
 
 
1737
    
2381
1738
    _fmt = "Root class for inventory serialization errors"
2382
1739
 
2383
1740
 
2394
1751
    _fmt = """This operation requires rich root data storage"""
2395
1752
 
2396
1753
 
2397
 
class NoSmartMedium(InternalBzrError):
 
1754
class NoSmartMedium(BzrError):
2398
1755
 
2399
1756
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2400
1757
 
 
1758
    internal_error = True
 
1759
 
2401
1760
    def __init__(self, transport):
2402
1761
        self.transport = transport
2403
1762
 
2404
1763
 
 
1764
class NoSmartServer(NotBranchError):
 
1765
 
 
1766
    _fmt = "No smart server available at %(url)s"
 
1767
 
 
1768
    def __init__(self, url):
 
1769
        self.url = url
 
1770
 
 
1771
 
2405
1772
class UnknownSSH(BzrError):
2406
1773
 
2407
1774
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2411
1778
        self.vendor = vendor
2412
1779
 
2413
1780
 
2414
 
class SSHVendorNotFound(BzrError):
2415
 
 
2416
 
    _fmt = ("Don't know how to handle SSH connections."
2417
 
            " Please set BZR_SSH environment variable.")
2418
 
 
2419
 
 
2420
 
class GhostRevisionsHaveNoRevno(BzrError):
2421
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2422
 
 
2423
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2424
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2425
 
 
2426
 
    def __init__(self, revision_id, ghost_revision_id):
2427
 
        self.revision_id = revision_id
2428
 
        self.ghost_revision_id = ghost_revision_id
2429
 
 
2430
 
 
2431
1781
class GhostRevisionUnusableHere(BzrError):
2432
1782
 
2433
1783
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2437
1787
        self.revision_id = revision_id
2438
1788
 
2439
1789
 
2440
 
class IllegalUseOfScopeReplacer(InternalBzrError):
2441
 
 
2442
 
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2443
 
            " %(msg)s%(extra)s")
 
1790
class IllegalUseOfScopeReplacer(BzrError):
 
1791
 
 
1792
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
1793
 
 
1794
    internal_error = True
2444
1795
 
2445
1796
    def __init__(self, name, msg, extra=None):
2446
1797
        BzrError.__init__(self)
2452
1803
            self.extra = ''
2453
1804
 
2454
1805
 
2455
 
class InvalidImportLine(InternalBzrError):
 
1806
class InvalidImportLine(BzrError):
2456
1807
 
2457
1808
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2458
1809
 
 
1810
    internal_error = True
 
1811
 
2459
1812
    def __init__(self, text, msg):
2460
1813
        BzrError.__init__(self)
2461
1814
        self.text = text
2462
1815
        self.msg = msg
2463
1816
 
2464
1817
 
2465
 
class ImportNameCollision(InternalBzrError):
2466
 
 
2467
 
    _fmt = ("Tried to import an object to the same name as"
2468
 
            " an existing object. %(name)s")
 
1818
class ImportNameCollision(BzrError):
 
1819
 
 
1820
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
1821
 
 
1822
    internal_error = True
2469
1823
 
2470
1824
    def __init__(self, name):
2471
1825
        BzrError.__init__(self)
2472
1826
        self.name = name
2473
1827
 
2474
1828
 
2475
 
class NotAMergeDirective(BzrError):
2476
 
    """File starting with %(firstline)r is not a merge directive"""
2477
 
    def __init__(self, firstline):
2478
 
        BzrError.__init__(self, firstline=firstline)
2479
 
 
2480
 
 
2481
 
class NoMergeSource(BzrError):
2482
 
    """Raise if no merge source was specified for a merge directive"""
2483
 
 
2484
 
    _fmt = "A merge directive must provide either a bundle or a public"\
2485
 
        " branch location."
2486
 
 
2487
 
 
2488
 
class IllegalMergeDirectivePayload(BzrError):
2489
 
    """A merge directive contained something other than a patch or bundle"""
2490
 
 
2491
 
    _fmt = "Bad merge directive payload %(start)r"
2492
 
 
2493
 
    def __init__(self, start):
2494
 
        BzrError(self)
2495
 
        self.start = start
2496
 
 
2497
 
 
2498
 
class PatchVerificationFailed(BzrError):
2499
 
    """A patch from a merge directive could not be verified"""
2500
 
 
2501
 
    _fmt = "Preview patch does not match requested changes."
2502
 
 
2503
 
 
2504
 
class PatchMissing(BzrError):
2505
 
    """Raise a patch type was specified but no patch supplied"""
2506
 
 
2507
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
2508
 
 
2509
 
    def __init__(self, patch_type):
2510
 
        BzrError.__init__(self)
2511
 
        self.patch_type = patch_type
2512
 
 
2513
 
 
2514
 
class TargetNotBranch(BzrError):
2515
 
    """A merge directive's target branch is required, but isn't a branch"""
2516
 
 
2517
 
    _fmt = ("Your branch does not have all of the revisions required in "
2518
 
            "order to merge this merge directive and the target "
2519
 
            "location specified in the merge directive is not a branch: "
2520
 
            "%(location)s.")
2521
 
 
2522
 
    def __init__(self, location):
2523
 
        BzrError.__init__(self)
2524
 
        self.location = location
2525
 
 
2526
 
 
2527
1829
class UnsupportedInventoryKind(BzrError):
2528
 
 
 
1830
    
2529
1831
    _fmt = """Unsupported entry kind %(kind)s"""
2530
1832
 
2531
1833
    def __init__(self, kind):
2534
1836
 
2535
1837
class BadSubsumeSource(BzrError):
2536
1838
 
2537
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
1839
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2538
1840
 
2539
1841
    def __init__(self, tree, other_tree, reason):
2540
1842
        self.tree = tree
2543
1845
 
2544
1846
 
2545
1847
class SubsumeTargetNeedsUpgrade(BzrError):
2546
 
 
 
1848
    
2547
1849
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2548
1850
 
2549
1851
    def __init__(self, other_tree):
2550
1852
        self.other_tree = other_tree
2551
1853
 
2552
1854
 
2553
 
class BadReferenceTarget(InternalBzrError):
2554
 
 
2555
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2556
 
           "%(reason)s"
 
1855
class BadReferenceTarget(BzrError):
 
1856
 
 
1857
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
1858
 
 
1859
    internal_error = True
2557
1860
 
2558
1861
    def __init__(self, tree, other_tree, reason):
2559
1862
        self.tree = tree
2571
1874
 
2572
1875
class TagsNotSupported(BzrError):
2573
1876
 
2574
 
    _fmt = ("Tags not supported by %(branch)s;"
2575
 
            " you may be able to use bzr upgrade.")
 
1877
    _fmt = "Tags not supported by %(branch)s; you may be able to use bzr upgrade."
2576
1878
 
2577
1879
    def __init__(self, branch):
2578
1880
        self.branch = branch
2579
1881
 
2580
 
 
 
1882
        
2581
1883
class TagAlreadyExists(BzrError):
2582
1884
 
2583
1885
    _fmt = "Tag %(tag_name)s already exists."
2584
1886
 
2585
1887
    def __init__(self, tag_name):
2586
1888
        self.tag_name = tag_name
2587
 
 
2588
 
 
2589
 
class MalformedBugIdentifier(BzrError):
2590
 
 
2591
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2592
 
            'See "bzr help bugs" for more information on this feature.')
2593
 
 
2594
 
    def __init__(self, bug_id, reason):
2595
 
        self.bug_id = bug_id
2596
 
        self.reason = reason
2597
 
 
2598
 
 
2599
 
class InvalidBugTrackerURL(BzrError):
2600
 
 
2601
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2602
 
            "contain {id}: %(url)s")
2603
 
 
2604
 
    def __init__(self, abbreviation, url):
2605
 
        self.abbreviation = abbreviation
2606
 
        self.url = url
2607
 
 
2608
 
 
2609
 
class UnknownBugTrackerAbbreviation(BzrError):
2610
 
 
2611
 
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2612
 
            "on %(branch)s")
2613
 
 
2614
 
    def __init__(self, abbreviation, branch):
2615
 
        self.abbreviation = abbreviation
2616
 
        self.branch = branch
2617
 
 
2618
 
 
2619
 
class InvalidLineInBugsProperty(BzrError):
2620
 
 
2621
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2622
 
 
2623
 
    def __init__(self, line):
2624
 
        self.line = line
2625
 
 
2626
 
 
2627
 
class InvalidBugStatus(BzrError):
2628
 
 
2629
 
    _fmt = ("Invalid bug status: '%(status)s'")
2630
 
 
2631
 
    def __init__(self, status):
2632
 
        self.status = status
2633
 
 
2634
 
 
2635
 
class UnexpectedSmartServerResponse(BzrError):
2636
 
 
2637
 
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2638
 
 
2639
 
    def __init__(self, response_tuple):
2640
 
        self.response_tuple = response_tuple
2641
 
 
2642
 
 
2643
 
class ErrorFromSmartServer(BzrError):
2644
 
    """An error was received from a smart server.
2645
 
 
2646
 
    :seealso: UnknownErrorFromSmartServer
2647
 
    """
2648
 
 
2649
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2650
 
 
2651
 
    internal_error = True
2652
 
 
2653
 
    def __init__(self, error_tuple):
2654
 
        self.error_tuple = error_tuple
2655
 
        try:
2656
 
            self.error_verb = error_tuple[0]
2657
 
        except IndexError:
2658
 
            self.error_verb = None
2659
 
        self.error_args = error_tuple[1:]
2660
 
 
2661
 
 
2662
 
class UnknownErrorFromSmartServer(BzrError):
2663
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2664
 
    error.
2665
 
 
2666
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2667
 
    distinguish between the following two cases:
2668
 
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
2669
 
        and so should provoke a traceback to the user.
2670
 
      - ErrorFromSmartServer was caught but its error_tuple could not be
2671
 
        translated.  This is probably because the server sent us garbage, and
2672
 
        should not provoke a traceback.
2673
 
    """
2674
 
 
2675
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2676
 
 
2677
 
    internal_error = False
2678
 
 
2679
 
    def __init__(self, error_from_smart_server):
2680
 
        """Constructor.
2681
 
 
2682
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2683
 
        """
2684
 
        self.error_from_smart_server = error_from_smart_server
2685
 
        self.error_tuple = error_from_smart_server.error_tuple
2686
 
 
2687
 
 
2688
 
class ContainerError(BzrError):
2689
 
    """Base class of container errors."""
2690
 
 
2691
 
 
2692
 
class UnknownContainerFormatError(ContainerError):
2693
 
 
2694
 
    _fmt = "Unrecognised container format: %(container_format)r"
2695
 
 
2696
 
    def __init__(self, container_format):
2697
 
        self.container_format = container_format
2698
 
 
2699
 
 
2700
 
class UnexpectedEndOfContainerError(ContainerError):
2701
 
 
2702
 
    _fmt = "Unexpected end of container stream"
2703
 
 
2704
 
 
2705
 
class UnknownRecordTypeError(ContainerError):
2706
 
 
2707
 
    _fmt = "Unknown record type: %(record_type)r"
2708
 
 
2709
 
    def __init__(self, record_type):
2710
 
        self.record_type = record_type
2711
 
 
2712
 
 
2713
 
class InvalidRecordError(ContainerError):
2714
 
 
2715
 
    _fmt = "Invalid record: %(reason)s"
2716
 
 
2717
 
    def __init__(self, reason):
2718
 
        self.reason = reason
2719
 
 
2720
 
 
2721
 
class ContainerHasExcessDataError(ContainerError):
2722
 
 
2723
 
    _fmt = "Container has data after end marker: %(excess)r"
2724
 
 
2725
 
    def __init__(self, excess):
2726
 
        self.excess = excess
2727
 
 
2728
 
 
2729
 
class DuplicateRecordNameError(ContainerError):
2730
 
 
2731
 
    _fmt = "Container has multiple records with the same name: %(name)s"
2732
 
 
2733
 
    def __init__(self, name):
2734
 
        self.name = name
2735
 
 
2736
 
 
2737
 
class NoDestinationAddress(InternalBzrError):
2738
 
 
2739
 
    _fmt = "Message does not have a destination address."
2740
 
 
2741
 
 
2742
 
class RepositoryDataStreamError(BzrError):
2743
 
 
2744
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2745
 
 
2746
 
    def __init__(self, reason):
2747
 
        self.reason = reason
2748
 
 
2749
 
 
2750
 
class SMTPError(BzrError):
2751
 
 
2752
 
    _fmt = "SMTP error: %(error)s"
2753
 
 
2754
 
    def __init__(self, error):
2755
 
        self.error = error
2756
 
 
2757
 
 
2758
 
class NoMessageSupplied(BzrError):
2759
 
 
2760
 
    _fmt = "No message supplied."
2761
 
 
2762
 
 
2763
 
class NoMailAddressSpecified(BzrError):
2764
 
 
2765
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2766
 
 
2767
 
 
2768
 
class UnknownMailClient(BzrError):
2769
 
 
2770
 
    _fmt = "Unknown mail client: %(mail_client)s"
2771
 
 
2772
 
    def __init__(self, mail_client):
2773
 
        BzrError.__init__(self, mail_client=mail_client)
2774
 
 
2775
 
 
2776
 
class MailClientNotFound(BzrError):
2777
 
 
2778
 
    _fmt = "Unable to find mail client with the following names:"\
2779
 
        " %(mail_command_list_string)s"
2780
 
 
2781
 
    def __init__(self, mail_command_list):
2782
 
        mail_command_list_string = ', '.join(mail_command_list)
2783
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2784
 
                          mail_command_list_string=mail_command_list_string)
2785
 
 
2786
 
class SMTPConnectionRefused(SMTPError):
2787
 
 
2788
 
    _fmt = "SMTP connection to %(host)s refused"
2789
 
 
2790
 
    def __init__(self, error, host):
2791
 
        self.error = error
2792
 
        self.host = host
2793
 
 
2794
 
 
2795
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2796
 
 
2797
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2798
 
 
2799
 
 
2800
 
class BzrDirError(BzrError):
2801
 
 
2802
 
    def __init__(self, bzrdir):
2803
 
        import bzrlib.urlutils as urlutils
2804
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2805
 
                                                    'ascii')
2806
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2807
 
 
2808
 
 
2809
 
class UnsyncedBranches(BzrDirError):
2810
 
 
2811
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2812
 
            " bzr help sync-for-reconfigure.")
2813
 
 
2814
 
    def __init__(self, bzrdir, target_branch):
2815
 
        BzrDirError.__init__(self, bzrdir)
2816
 
        import bzrlib.urlutils as urlutils
2817
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2818
 
                                                        'ascii')
2819
 
 
2820
 
 
2821
 
class AlreadyBranch(BzrDirError):
2822
 
 
2823
 
    _fmt = "'%(display_url)s' is already a branch."
2824
 
 
2825
 
 
2826
 
class AlreadyTree(BzrDirError):
2827
 
 
2828
 
    _fmt = "'%(display_url)s' is already a tree."
2829
 
 
2830
 
 
2831
 
class AlreadyCheckout(BzrDirError):
2832
 
 
2833
 
    _fmt = "'%(display_url)s' is already a checkout."
2834
 
 
2835
 
 
2836
 
class AlreadyLightweightCheckout(BzrDirError):
2837
 
 
2838
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2839
 
 
2840
 
 
2841
 
class AlreadyUsingShared(BzrDirError):
2842
 
 
2843
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2844
 
 
2845
 
 
2846
 
class AlreadyStandalone(BzrDirError):
2847
 
 
2848
 
    _fmt = "'%(display_url)s' is already standalone."
2849
 
 
2850
 
 
2851
 
class AlreadyWithTrees(BzrDirError):
2852
 
 
2853
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2854
 
            "working trees.")
2855
 
 
2856
 
 
2857
 
class AlreadyWithNoTrees(BzrDirError):
2858
 
 
2859
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2860
 
            "working trees.")
2861
 
 
2862
 
 
2863
 
class ReconfigurationNotSupported(BzrDirError):
2864
 
 
2865
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2866
 
 
2867
 
 
2868
 
class NoBindLocation(BzrDirError):
2869
 
 
2870
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2871
 
 
2872
 
 
2873
 
class UncommittedChanges(BzrError):
2874
 
 
2875
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2876
 
            ' (See bzr status).%(more)s')
2877
 
 
2878
 
    def __init__(self, tree, more=None):
2879
 
        if more is None:
2880
 
            more = ''
2881
 
        else:
2882
 
            more = ' ' + more
2883
 
        import bzrlib.urlutils as urlutils
2884
 
        user_url = getattr(tree, "user_url", None)
2885
 
        if user_url is None:
2886
 
            display_url = str(tree)
2887
 
        else:
2888
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2889
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2890
 
 
2891
 
 
2892
 
class ShelvedChanges(UncommittedChanges):
2893
 
 
2894
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2895
 
            ' (See bzr shelve --list).%(more)s')
2896
 
 
2897
 
 
2898
 
class MissingTemplateVariable(BzrError):
2899
 
 
2900
 
    _fmt = 'Variable {%(name)s} is not available.'
2901
 
 
2902
 
    def __init__(self, name):
2903
 
        self.name = name
2904
 
 
2905
 
 
2906
 
class NoTemplate(BzrError):
2907
 
 
2908
 
    _fmt = 'No template specified.'
2909
 
 
2910
 
 
2911
 
class UnableCreateSymlink(BzrError):
2912
 
 
2913
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2914
 
 
2915
 
    def __init__(self, path=None):
2916
 
        path_str = ''
2917
 
        if path:
2918
 
            try:
2919
 
                path_str = repr(str(path))
2920
 
            except UnicodeEncodeError:
2921
 
                path_str = repr(path)
2922
 
            path_str += ' '
2923
 
        self.path_str = path_str
2924
 
 
2925
 
 
2926
 
class UnsupportedTimezoneFormat(BzrError):
2927
 
 
2928
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2929
 
            'options are "utc", "original", "local".')
2930
 
 
2931
 
    def __init__(self, timezone):
2932
 
        self.timezone = timezone
2933
 
 
2934
 
 
2935
 
class CommandAvailableInPlugin(StandardError):
2936
 
 
2937
 
    internal_error = False
2938
 
 
2939
 
    def __init__(self, cmd_name, plugin_metadata, provider):
2940
 
 
2941
 
        self.plugin_metadata = plugin_metadata
2942
 
        self.cmd_name = cmd_name
2943
 
        self.provider = provider
2944
 
 
2945
 
    def __str__(self):
2946
 
 
2947
 
        _fmt = ('"%s" is not a standard bzr command. \n'
2948
 
                'However, the following official plugin provides this command: %s\n'
2949
 
                'You can install it by going to: %s'
2950
 
                % (self.cmd_name, self.plugin_metadata['name'],
2951
 
                    self.plugin_metadata['url']))
2952
 
 
2953
 
        return _fmt
2954
 
 
2955
 
 
2956
 
class NoPluginAvailable(BzrError):
2957
 
    pass
2958
 
 
2959
 
 
2960
 
class UnableEncodePath(BzrError):
2961
 
 
2962
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2963
 
            'user encoding %(user_encoding)s')
2964
 
 
2965
 
    def __init__(self, path, kind):
2966
 
        from bzrlib.osutils import get_user_encoding
2967
 
        self.path = path
2968
 
        self.kind = kind
2969
 
        self.user_encoding = osutils.get_user_encoding()
2970
 
 
2971
 
 
2972
 
class NoSuchConfig(BzrError):
2973
 
 
2974
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
2975
 
 
2976
 
    def __init__(self, config_id):
2977
 
        BzrError.__init__(self, config_id=config_id)
2978
 
 
2979
 
 
2980
 
class NoSuchConfigOption(BzrError):
2981
 
 
2982
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
2983
 
 
2984
 
    def __init__(self, option_name):
2985
 
        BzrError.__init__(self, option_name=option_name)
2986
 
 
2987
 
 
2988
 
class NoSuchAlias(BzrError):
2989
 
 
2990
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
2991
 
 
2992
 
    def __init__(self, alias_name):
2993
 
        BzrError.__init__(self, alias_name=alias_name)
2994
 
 
2995
 
 
2996
 
class DirectoryLookupFailure(BzrError):
2997
 
    """Base type for lookup errors."""
2998
 
 
2999
 
    pass
3000
 
 
3001
 
 
3002
 
class InvalidLocationAlias(DirectoryLookupFailure):
3003
 
 
3004
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
3005
 
 
3006
 
    def __init__(self, alias_name):
3007
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
3008
 
 
3009
 
 
3010
 
class UnsetLocationAlias(DirectoryLookupFailure):
3011
 
 
3012
 
    _fmt = 'No %(alias_name)s location assigned.'
3013
 
 
3014
 
    def __init__(self, alias_name):
3015
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
3016
 
 
3017
 
 
3018
 
class CannotBindAddress(BzrError):
3019
 
 
3020
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3021
 
 
3022
 
    def __init__(self, host, port, orig_error):
3023
 
        # nb: in python2.4 socket.error doesn't have a useful repr
3024
 
        BzrError.__init__(self, host=host, port=port,
3025
 
            orig_error=repr(orig_error.args))
3026
 
 
3027
 
 
3028
 
class UnknownRules(BzrError):
3029
 
 
3030
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
3031
 
 
3032
 
    def __init__(self, unknowns):
3033
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3034
 
 
3035
 
 
3036
 
class HookFailed(BzrError):
3037
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3038
 
    than TipChangeRejected.
3039
 
 
3040
 
    Note that this exception is no longer raised, and the import is only left
3041
 
    to be nice to code which might catch it in a plugin.
3042
 
    """
3043
 
 
3044
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3045
 
            "%(traceback_text)s%(exc_value)s")
3046
 
 
3047
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3048
 
        if warn:
3049
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3050
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3051
 
        import traceback
3052
 
        self.hook_stage = hook_stage
3053
 
        self.hook_name = hook_name
3054
 
        self.exc_info = exc_info
3055
 
        self.exc_type = exc_info[0]
3056
 
        self.exc_value = exc_info[1]
3057
 
        self.exc_tb = exc_info[2]
3058
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3059
 
 
3060
 
 
3061
 
class TipChangeRejected(BzrError):
3062
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3063
 
    explicitly abort a change to a branch tip.
3064
 
    """
3065
 
 
3066
 
    _fmt = u"Tip change rejected: %(msg)s"
3067
 
 
3068
 
    def __init__(self, msg):
3069
 
        self.msg = msg
3070
 
 
3071
 
 
3072
 
class ShelfCorrupt(BzrError):
3073
 
 
3074
 
    _fmt = "Shelf corrupt."
3075
 
 
3076
 
 
3077
 
class NoSuchShelfId(BzrError):
3078
 
 
3079
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3080
 
 
3081
 
    def __init__(self, shelf_id):
3082
 
        BzrError.__init__(self, shelf_id=shelf_id)
3083
 
 
3084
 
 
3085
 
class InvalidShelfId(BzrError):
3086
 
 
3087
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3088
 
 
3089
 
    def __init__(self, invalid_id):
3090
 
        BzrError.__init__(self, invalid_id=invalid_id)
3091
 
 
3092
 
 
3093
 
class JailBreak(BzrError):
3094
 
 
3095
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3096
 
 
3097
 
    def __init__(self, url):
3098
 
        BzrError.__init__(self, url=url)
3099
 
 
3100
 
 
3101
 
class UserAbort(BzrError):
3102
 
 
3103
 
    _fmt = 'The user aborted the operation.'
3104
 
 
3105
 
 
3106
 
class MustHaveWorkingTree(BzrError):
3107
 
 
3108
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3109
 
 
3110
 
    def __init__(self, format, url):
3111
 
        BzrError.__init__(self, format=format, url=url)
3112
 
 
3113
 
 
3114
 
class NoSuchView(BzrError):
3115
 
    """A view does not exist.
3116
 
    """
3117
 
 
3118
 
    _fmt = u"No such view: %(view_name)s."
3119
 
 
3120
 
    def __init__(self, view_name):
3121
 
        self.view_name = view_name
3122
 
 
3123
 
 
3124
 
class ViewsNotSupported(BzrError):
3125
 
    """Views are not supported by a tree format.
3126
 
    """
3127
 
 
3128
 
    _fmt = ("Views are not supported by %(tree)s;"
3129
 
            " use 'bzr upgrade' to change your tree to a later format.")
3130
 
 
3131
 
    def __init__(self, tree):
3132
 
        self.tree = tree
3133
 
 
3134
 
 
3135
 
class FileOutsideView(BzrError):
3136
 
 
3137
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3138
 
            '%(view_str)s')
3139
 
 
3140
 
    def __init__(self, file_name, view_files):
3141
 
        self.file_name = file_name
3142
 
        self.view_str = ", ".join(view_files)
3143
 
 
3144
 
 
3145
 
class UnresumableWriteGroup(BzrError):
3146
 
 
3147
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3148
 
            "%(write_groups)r: %(reason)s")
3149
 
 
3150
 
    internal_error = True
3151
 
 
3152
 
    def __init__(self, repository, write_groups, reason):
3153
 
        self.repository = repository
3154
 
        self.write_groups = write_groups
3155
 
        self.reason = reason
3156
 
 
3157
 
 
3158
 
class UnsuspendableWriteGroup(BzrError):
3159
 
 
3160
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3161
 
 
3162
 
    internal_error = True
3163
 
 
3164
 
    def __init__(self, repository):
3165
 
        self.repository = repository
3166
 
 
3167
 
 
3168
 
class LossyPushToSameVCS(BzrError):
3169
 
 
3170
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3171
 
            "%(target_branch)r that are in the same VCS.")
3172
 
 
3173
 
    internal_error = True
3174
 
 
3175
 
    def __init__(self, source_branch, target_branch):
3176
 
        self.source_branch = source_branch
3177
 
        self.target_branch = target_branch
3178
 
 
3179
 
 
3180
 
class NoRoundtrippingSupport(BzrError):
3181
 
 
3182
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3183
 
            "%(target_branch)r.")
3184
 
 
3185
 
    internal_error = True
3186
 
 
3187
 
    def __init__(self, source_branch, target_branch):
3188
 
        self.source_branch = source_branch
3189
 
        self.target_branch = target_branch
3190
 
 
3191
 
 
3192
 
class FileTimestampUnavailable(BzrError):
3193
 
 
3194
 
    _fmt = "The filestamp for %(path)s is not available."
3195
 
 
3196
 
    internal_error = True
3197
 
 
3198
 
    def __init__(self, path):
3199
 
        self.path = path
3200
 
 
3201
 
 
3202
 
class NoColocatedBranchSupport(BzrError):
3203
 
 
3204
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3205
 
 
3206
 
    def __init__(self, bzrdir):
3207
 
        self.bzrdir = bzrdir
3208
 
 
3209
 
 
3210
 
class NoWhoami(BzrError):
3211
 
 
3212
 
    _fmt = ('Unable to determine your name.\n'
3213
 
        "Please, set your name with the 'whoami' command.\n"
3214
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3215
 
 
3216
 
 
3217
 
class InvalidPattern(BzrError):
3218
 
 
3219
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3220
 
 
3221
 
    def __init__(self, msg):
3222
 
        self.msg = msg
3223
 
 
3224
 
 
3225
 
class RecursiveBind(BzrError):
3226
 
 
3227
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3228
 
        'Please use `bzr unbind` to fix.')
3229
 
 
3230
 
    def __init__(self, branch_url):
3231
 
        self.branch_url = branch_url
3232
 
 
3233
 
 
3234
 
# FIXME: I would prefer to define the config related exception classes in
3235
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3236
 
class OptionExpansionLoop(BzrError):
3237
 
 
3238
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3239
 
 
3240
 
    def __init__(self, string, refs):
3241
 
        self.string = string
3242
 
        self.refs = '->'.join(refs)
3243
 
 
3244
 
 
3245
 
class ExpandingUnknownOption(BzrError):
3246
 
 
3247
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3248
 
 
3249
 
    def __init__(self, name, string):
3250
 
        self.name = name
3251
 
        self.string = string