← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Parth Malwankar
  • Date: 2010-07-01 03:11:55 UTC
  • mto: This revision was merged to the branch mainline in revision 5329.
  • Revision ID: parth.malwankar@gmail.com-20100701031155-u24wi81x8c61alht
fixed comment

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
 
21
20
from bzrlib import (
22
21
    osutils,
23
22
    symbol_versioning,
32
31
 
33
32
 
34
33
# TODO: is there any value in providing the .args field used by standard
35
 
# python exceptions?   A list of values with no names seems less useful 
 
34
# python exceptions?   A list of values with no names seems less useful
36
35
# to me.
37
36
 
38
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
39
38
# constructed to make sure it will succeed.  But that says nothing about
40
39
# exceptions that are never raised.
41
40
 
44
43
# 'unprintable'.
45
44
 
46
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
 
50
 
 
51
 
47
52
class BzrError(StandardError):
48
53
    """
49
54
    Base class for errors raised by bzrlib.
50
55
 
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
 
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
53
58
    probably a user or environment error and they don't need the gory details.
54
59
    (That can be overridden by -Derror on the command line.)
55
60
 
56
61
    :cvar _fmt: Format string to display the error; this is expanded
57
62
    by the instance's dict.
58
63
    """
59
 
    
 
64
 
60
65
    internal_error = False
61
66
 
62
67
    def __init__(self, msg=None, **kwds):
67
72
        arguments can be given.  The first is for generic "user" errors which
68
73
        are not intended to be caught and so do not need a specific subclass.
69
74
        The second case is for use with subclasses that provide a _fmt format
70
 
        string to print the arguments.  
 
75
        string to print the arguments.
71
76
 
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 
 
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
75
80
        parameters.
76
81
 
77
82
        :param msg: If given, this is the literal complete text for the error,
78
 
        not subject to expansion.
 
83
           not subject to expansion. 'msg' is used instead of 'message' because
 
84
           python evolved and, in 2.6, forbids the use of 'message'.
79
85
        """
80
86
        StandardError.__init__(self)
81
87
        if msg is not None:
87
93
            for key, value in kwds.items():
88
94
                setattr(self, key, value)
89
95
 
90
 
    def __str__(self):
 
96
    def _format(self):
91
97
        s = getattr(self, '_preformatted_string', None)
92
98
        if s is not None:
93
 
            # contains a preformatted message; must be cast to plain str
94
 
            return str(s)
 
99
            # contains a preformatted message
 
100
            return s
95
101
        try:
96
102
            fmt = self._get_format_string()
97
103
            if fmt:
98
 
                s = fmt % self.__dict__
 
104
                d = dict(self.__dict__)
 
105
                s = fmt % d
99
106
                # __str__() should always return a 'str' object
100
107
                # never a 'unicode' object.
101
 
                if isinstance(s, unicode):
102
 
                    return s.encode('utf8')
103
108
                return s
104
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
105
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
 
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
106
111
                % (self.__class__.__name__,
107
112
                   self.__dict__,
108
113
                   getattr(self, '_fmt', None),
109
 
                   str(e))
 
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))
110
138
 
111
139
    def _get_format_string(self):
112
140
        """Return format string for this exception or None"""
125
153
               getattr(self, '_fmt', None),
126
154
               )
127
155
 
 
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
 
128
172
 
129
173
class BzrNewError(BzrError):
130
174
    """Deprecated error base class."""
132
176
    # readable explanation
133
177
 
134
178
    def __init__(self, *args, **kwds):
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
 
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
138
183
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
139
 
             'please convert %s to use BzrError instead' 
 
184
             'please convert %s to use BzrError instead'
140
185
             % self.__class__.__name__,
141
186
             DeprecationWarning,
142
187
             stacklevel=2)
153
198
                return s.encode('utf8')
154
199
            return s
155
200
        except (TypeError, NameError, ValueError, KeyError), e:
156
 
            return 'Unprintable exception %s(%r): %s' \
 
201
            return 'Unprintable exception %s(%r): %r' \
157
202
                % (self.__class__.__name__,
158
 
                   self.__dict__, str(e))
 
203
                   self.__dict__, e)
159
204
 
160
205
 
161
206
class AlreadyBuilding(BzrError):
162
 
    
 
207
 
163
208
    _fmt = "The tree builder is already building a tree."
164
209
 
165
210
 
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
 
    
 
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
 
179
269
    _fmt = "Invalid entry name: %(name)s"
180
270
 
181
 
    internal_error = True
182
 
 
183
271
    def __init__(self, name):
184
272
        BzrError.__init__(self)
185
273
        self.name = name
186
274
 
187
275
 
188
276
class InvalidRevisionNumber(BzrError):
189
 
    
 
277
 
190
278
    _fmt = "Invalid revision number %(revno)s"
191
279
 
192
280
    def __init__(self, revno):
204
292
        self.revision_id = revision_id
205
293
        self.branch = branch
206
294
 
 
295
 
207
296
class ReservedId(BzrError):
208
297
 
209
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
211
300
    def __init__(self, revision_id):
212
301
        self.revision_id = revision_id
213
302
 
 
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
 
214
329
class NoSuchId(BzrError):
215
330
 
216
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
217
 
    
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
218
333
    def __init__(self, tree, file_id):
219
334
        BzrError.__init__(self)
220
335
        self.file_id = file_id
221
336
        self.tree = tree
222
337
 
223
338
 
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
 
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.")
230
357
 
231
358
    def __init__(self, tree):
232
359
        self.tree = tree
234
361
 
235
362
class NoWorkingTree(BzrError):
236
363
 
237
 
    _fmt = "No WorkingTree exists for %(base)s."
238
 
    
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
239
366
    def __init__(self, base):
240
367
        BzrError.__init__(self)
241
368
        self.base = base
254
381
        self.url = url
255
382
 
256
383
 
257
 
class WorkingTreeAlreadyPopulated(BzrError):
258
 
 
259
 
    _fmt = """Working tree already populated in %(base)s"""
260
 
 
261
 
    internal_error = True
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
262
387
 
263
388
    def __init__(self, base):
264
389
        self.base = base
265
390
 
 
391
 
266
392
class BzrCommandError(BzrError):
267
393
    """Error from user command"""
268
394
 
269
 
    internal_error = False
270
 
 
271
395
    # Error from malformed user command; please avoid raising this as a
272
396
    # generic exception not caused by user input.
273
397
    #
275
399
    # are not intended to be caught anyway.  UI code need not subclass
276
400
    # BzrCommandError, and non-UI code should not throw a subclass of
277
401
    # 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
288
402
 
289
403
 
290
404
class NotWriteLocked(BzrError):
300
414
    _fmt = "Error in command line options"
301
415
 
302
416
 
 
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
 
303
473
class BadOptionValue(BzrError):
304
474
 
305
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
307
477
    def __init__(self, name, value):
308
478
        BzrError.__init__(self, name=name, value=value)
309
479
 
310
 
    
 
480
 
311
481
class StrictCommitFailed(BzrError):
312
482
 
313
483
    _fmt = "Commit refused because there are unknown files in the tree"
315
485
 
316
486
# XXX: Should be unified with TransportError; they seem to represent the
317
487
# 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.'
318
492
class PathError(BzrError):
319
 
    
 
493
 
320
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
321
495
 
322
496
    def __init__(self, path, extra=None):
342
516
    """Used when renaming and both source and dest exist."""
343
517
 
344
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
345
 
         "%(extra)s")
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
346
521
 
347
522
    def __init__(self, source, dest, extra=None):
348
523
        BzrError.__init__(self)
356
531
 
357
532
class NotADirectory(PathError):
358
533
 
359
 
    _fmt = "%(path)r is not a directory %(extra)s"
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
360
535
 
361
536
 
362
537
class NotInWorkingDirectory(PathError):
363
538
 
364
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
365
540
 
366
541
 
367
542
class DirectoryNotEmpty(PathError):
368
543
 
369
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
370
 
 
371
 
 
372
 
class ReadingCompleted(BzrError):
373
 
    
 
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
 
374
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
375
555
            "called upon it - the request has been completed and no more "
376
556
            "data may be read.")
377
557
 
378
 
    internal_error = True
379
 
 
380
558
    def __init__(self, request):
381
559
        self.request = request
382
560
 
383
561
 
384
562
class ResourceBusy(PathError):
385
563
 
386
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
387
565
 
388
566
 
389
567
class PermissionDenied(PathError):
390
568
 
391
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
392
570
 
393
571
 
394
572
class InvalidURL(PathError):
395
573
 
396
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
397
575
 
398
576
 
399
577
class InvalidURLJoin(PathError):
400
578
 
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)
 
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
406
608
 
407
609
 
408
610
class UnknownHook(BzrError):
423
625
        PathError.__init__(self, url, extra=extra)
424
626
 
425
627
 
 
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
 
426
665
class ShortReadvError(PathError):
427
666
 
428
 
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
667
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
668
            ' at %(offset)s for "%(path)s"%(extra)s')
429
669
 
430
670
    internal_error = True
431
671
 
436
676
        self.actual = actual
437
677
 
438
678
 
439
 
class PathNotChild(BzrError):
 
679
class PathNotChild(PathError):
440
680
 
441
 
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
442
682
 
443
683
    internal_error = True
444
684
 
454
694
 
455
695
class InvalidNormalization(PathError):
456
696
 
457
 
    _fmt = "Path %(path)r is not unicode normalized"
 
697
    _fmt = 'Path "%(path)s" is not unicode normalized'
458
698
 
459
699
 
460
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
461
701
# the exception object is a bit undesirable.
462
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
463
703
class NotBranchError(PathError):
464
704
 
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')
 
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 _format(self):
 
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
718
        # Python 2.4 have to be old-style classes so properties don't work.
 
719
        # Instead we override _format.
 
720
        if self.detail is None:
 
721
            if self.bzrdir is not None:
 
722
                try:
 
723
                    self.bzrdir.open_repository()
 
724
                except NoRepositoryPresent:
 
725
                    self.detail = ''
 
726
                else:
 
727
                    self.detail = ': location is a repository'
 
728
            else:
 
729
                self.detail = ''
 
730
        return PathError._format(self)
 
731
 
 
732
 
 
733
class NoSubmitBranch(PathError):
 
734
 
 
735
    _fmt = 'No submit branch available for branch "%(path)s"'
 
736
 
 
737
    def __init__(self, branch):
 
738
       import bzrlib.urlutils as urlutils
 
739
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
470
740
 
471
741
 
472
742
class AlreadyBranchError(PathError):
473
743
 
474
 
    _fmt = "Already a branch: %(path)s."
 
744
    _fmt = 'Already a branch: "%(path)s".'
475
745
 
476
746
 
477
747
class BranchExistsWithoutWorkingTree(PathError):
478
748
 
479
 
    _fmt = "Directory contains a branch, but no working tree \
480
 
(use bzr checkout if you wish to build a working tree): %(path)s"
 
749
    _fmt = 'Directory contains a branch, but no working tree \
 
750
(use bzr checkout if you wish to build a working tree): "%(path)s"'
481
751
 
482
752
 
483
753
class AtomicFileAlreadyClosed(PathError):
484
754
 
485
 
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
755
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
756
            ' "%(path)s"')
486
757
 
487
758
    def __init__(self, path, function):
488
759
        PathError.__init__(self, path=path, extra=None)
491
762
 
492
763
class InaccessibleParent(PathError):
493
764
 
494
 
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
765
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
766
            ' relative path "%(path)s"')
495
767
 
496
768
    def __init__(self, path, base):
497
769
        PathError.__init__(self, path)
500
772
 
501
773
class NoRepositoryPresent(BzrError):
502
774
 
503
 
    _fmt = "No repository present: %(path)r"
 
775
    _fmt = 'No repository present: "%(path)s"'
504
776
    def __init__(self, bzrdir):
505
777
        BzrError.__init__(self)
506
778
        self.path = bzrdir.transport.clone('..').base
508
780
 
509
781
class FileInWrongBranch(BzrError):
510
782
 
511
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
512
784
 
513
785
    def __init__(self, branch, path):
514
786
        BzrError.__init__(self)
518
790
 
519
791
 
520
792
class UnsupportedFormatError(BzrError):
521
 
    
522
 
    _fmt = "Unsupported branch format: %(format)s"
 
793
 
 
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
523
795
 
524
796
 
525
797
class UnknownFormatError(BzrError):
526
 
    
527
 
    _fmt = "Unknown branch format: %(format)r"
 
798
 
 
799
    _fmt = "Unknown %(kind)s format: %(format)r"
 
800
 
 
801
    def __init__(self, format, kind='branch'):
 
802
        self.kind = kind
 
803
        self.format = format
528
804
 
529
805
 
530
806
class IncompatibleFormat(BzrError):
531
 
    
 
807
 
532
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
533
809
 
534
810
    def __init__(self, format, bzrdir_format):
537
813
        self.bzrdir = bzrdir_format
538
814
 
539
815
 
 
816
class IncompatibleRepositories(BzrError):
 
817
    """Report an error that two repositories are not compatible.
 
818
 
 
819
    Note that the source and target repositories are permitted to be strings:
 
820
    this exception is thrown from the smart server and may refer to a
 
821
    repository the client hasn't opened.
 
822
    """
 
823
 
 
824
    _fmt = "%(target)s\n" \
 
825
            "is not compatible with\n" \
 
826
            "%(source)s\n" \
 
827
            "%(details)s"
 
828
 
 
829
    def __init__(self, source, target, details=None):
 
830
        if details is None:
 
831
            details = "(no details)"
 
832
        BzrError.__init__(self, target=target, source=source, details=details)
 
833
 
 
834
 
540
835
class IncompatibleRevision(BzrError):
541
 
    
 
836
 
542
837
    _fmt = "Revision is not compatible with %(repo_format)s"
543
838
 
544
839
    def __init__(self, repo_format):
549
844
class AlreadyVersionedError(BzrError):
550
845
    """Used when a path is expected not to be versioned, but it is."""
551
846
 
552
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
847
    _fmt = "%(context_info)s%(path)s is already versioned."
553
848
 
554
849
    def __init__(self, path, context_info=None):
555
850
        """Construct a new AlreadyVersionedError.
570
865
class NotVersionedError(BzrError):
571
866
    """Used when a path is expected to be versioned, but it is not."""
572
867
 
573
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
868
    _fmt = "%(context_info)s%(path)s is not versioned."
574
869
 
575
870
    def __init__(self, path, context_info=None):
576
871
        """Construct a new NotVersionedError.
621
916
 
622
917
class BadFileKindError(BzrError):
623
918
 
624
 
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
919
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
920
 
 
921
    def __init__(self, filename, kind):
 
922
        BzrError.__init__(self, filename=filename, kind=kind)
 
923
 
 
924
 
 
925
class BadFilenameEncoding(BzrError):
 
926
 
 
927
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
928
            ' encoding %(fs_encoding)s')
 
929
 
 
930
    def __init__(self, filename, fs_encoding):
 
931
        BzrError.__init__(self)
 
932
        self.filename = filename
 
933
        self.fs_encoding = fs_encoding
625
934
 
626
935
 
627
936
class ForbiddenControlFileError(BzrError):
628
937
 
629
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
630
 
 
631
 
 
632
 
class LockError(BzrError):
633
 
 
634
 
    _fmt = "Lock error: %(message)s"
635
 
 
636
 
    internal_error = True
 
938
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
939
 
 
940
 
 
941
class LockError(InternalBzrError):
 
942
 
 
943
    _fmt = "Lock error: %(msg)s"
637
944
 
638
945
    # All exceptions from the lock/unlock functions should be from
639
946
    # this exception class.  They will be translated as necessary. The
641
948
    #
642
949
    # New code should prefer to raise specific subclasses
643
950
    def __init__(self, message):
644
 
        self.message = message
 
951
        # Python 2.5 uses a slot for StandardError.message,
 
952
        # so use a different variable name.  We now work around this in
 
953
        # BzrError.__str__, but this member name is kept for compatability.
 
954
        self.msg = message
 
955
 
 
956
 
 
957
class LockActive(LockError):
 
958
 
 
959
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
960
 
 
961
    internal_error = False
 
962
 
 
963
    def __init__(self, lock_description):
 
964
        self.lock_description = lock_description
645
965
 
646
966
 
647
967
class CommitNotPossible(LockError):
664
984
 
665
985
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
666
986
 
 
987
    # TODO: There should also be an error indicating that you need a write
 
988
    # lock and don't have any lock at all... mbp 20070226
 
989
 
667
990
    def __init__(self, obj):
668
991
        self.obj = obj
669
992
 
670
993
 
 
994
class LockFailed(LockError):
 
995
 
 
996
    internal_error = False
 
997
 
 
998
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
999
 
 
1000
    def __init__(self, lock, why):
 
1001
        LockError.__init__(self, '')
 
1002
        self.lock = lock
 
1003
        self.why = why
 
1004
 
 
1005
 
671
1006
class OutSideTransaction(BzrError):
672
1007
 
673
 
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
1008
    _fmt = ("A transaction related operation was attempted after"
 
1009
            " the transaction finished.")
674
1010
 
675
1011
 
676
1012
class ObjectNotLocked(LockError):
694
1030
 
695
1031
class UnlockableTransport(LockError):
696
1032
 
 
1033
    internal_error = False
 
1034
 
697
1035
    _fmt = "Cannot lock: transport is read only: %(transport)s"
698
1036
 
699
1037
    def __init__(self, transport):
702
1040
 
703
1041
class LockContention(LockError):
704
1042
 
705
 
    _fmt = "Could not acquire lock %(lock)s"
706
 
    # TODO: show full url for lock, combining the transport and relative
707
 
    # bits?
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
708
1044
 
709
1045
    internal_error = False
710
 
    
711
 
    def __init__(self, lock):
 
1046
 
 
1047
    def __init__(self, lock, msg=''):
712
1048
        self.lock = lock
 
1049
        self.msg = msg
713
1050
 
714
1051
 
715
1052
class LockBroken(LockError):
716
1053
 
717
 
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
1054
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1055
            " - check storage consistency!")
718
1056
 
719
1057
    internal_error = False
720
1058
 
724
1062
 
725
1063
class LockBreakMismatch(LockError):
726
1064
 
727
 
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
1065
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1066
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
728
1067
 
729
1068
    internal_error = False
730
1069
 
744
1083
        self.lock = lock
745
1084
 
746
1085
 
 
1086
class TokenLockingNotSupported(LockError):
 
1087
 
 
1088
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1089
 
 
1090
    def __init__(self, obj):
 
1091
        self.obj = obj
 
1092
 
 
1093
 
 
1094
class TokenMismatch(LockBroken):
 
1095
 
 
1096
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1097
 
 
1098
    internal_error = True
 
1099
 
 
1100
    def __init__(self, given_token, lock_token):
 
1101
        self.given_token = given_token
 
1102
        self.lock_token = lock_token
 
1103
 
 
1104
 
747
1105
class PointlessCommit(BzrError):
748
1106
 
749
1107
    _fmt = "No changes to commit"
750
1108
 
751
1109
 
 
1110
class CannotCommitSelectedFileMerge(BzrError):
 
1111
 
 
1112
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1113
        ' files %(files_str)s'
 
1114
 
 
1115
    def __init__(self, files):
 
1116
        files_str = ', '.join(files)
 
1117
        BzrError.__init__(self, files=files, files_str=files_str)
 
1118
 
 
1119
 
 
1120
class BadCommitMessageEncoding(BzrError):
 
1121
 
 
1122
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1123
        'the current encoding.'
 
1124
 
 
1125
 
752
1126
class UpgradeReadonly(BzrError):
753
1127
 
754
1128
    _fmt = "Upgrade URL cannot work with readonly URLs."
768
1142
    _fmt = "Commit refused because there are unknowns in the tree."
769
1143
 
770
1144
 
771
 
class NoSuchRevision(BzrError):
772
 
 
773
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
774
 
 
775
 
    internal_error = True
 
1145
class NoSuchRevision(InternalBzrError):
 
1146
 
 
1147
    _fmt = "%(branch)s has no revision %(revision)s"
776
1148
 
777
1149
    def __init__(self, branch, revision):
 
1150
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
778
1151
        BzrError.__init__(self, branch=branch, revision=revision)
779
1152
 
780
1153
 
781
 
class NotLeftParentDescendant(BzrError):
782
 
 
783
 
    _fmt = "Revision %(old_revision)s is not the left parent of"\
784
 
        " %(new_revision)s, but branch %(branch_location)s expects this"
785
 
 
786
 
    internal_error = True
787
 
 
788
 
    def __init__(self, branch, old_revision, new_revision):
789
 
        BzrError.__init__(self, branch_location=branch.base,
790
 
                          old_revision=old_revision,
791
 
                          new_revision=new_revision)
 
1154
class RangeInChangeOption(BzrError):
 
1155
 
 
1156
    _fmt = "Option --change does not accept revision ranges"
792
1157
 
793
1158
 
794
1159
class NoSuchRevisionSpec(BzrError):
801
1166
 
802
1167
class NoSuchRevisionInTree(NoSuchRevision):
803
1168
    """When using Tree.revision_tree, and the revision is not accessible."""
804
 
    
805
 
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
1169
 
 
1170
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
806
1171
 
807
1172
    def __init__(self, tree, revision_id):
808
1173
        BzrError.__init__(self)
812
1177
 
813
1178
class InvalidRevisionSpec(BzrError):
814
1179
 
815
 
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
1180
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1181
            " %(branch)s%(extra)s")
816
1182
 
817
1183
    def __init__(self, spec, branch, extra=None):
818
1184
        BzrError.__init__(self, branch=branch, spec=spec)
829
1195
 
830
1196
class AppendRevisionsOnlyViolation(BzrError):
831
1197
 
832
 
    _fmt = 'Operation denied because it would change the main history, '\
833
 
           'which is not permitted by the append_revisions_only setting on'\
834
 
           ' branch "%(location)s".'
 
1198
    _fmt = ('Operation denied because it would change the main history,'
 
1199
           ' which is not permitted by the append_revisions_only setting on'
 
1200
           ' branch "%(location)s".')
835
1201
 
836
1202
    def __init__(self, location):
837
1203
       import bzrlib.urlutils as urlutils
840
1206
 
841
1207
 
842
1208
class DivergedBranches(BzrError):
843
 
    
844
 
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
845
1209
 
846
 
    internal_error = False
 
1210
    _fmt = ("These branches have diverged."
 
1211
            " Use the missing command to see how.\n"
 
1212
            "Use the merge command to reconcile them.")
847
1213
 
848
1214
    def __init__(self, branch1, branch2):
849
1215
        self.branch1 = branch1
850
1216
        self.branch2 = branch2
851
1217
 
852
1218
 
853
 
class NotLefthandHistory(BzrError):
 
1219
class NotLefthandHistory(InternalBzrError):
854
1220
 
855
1221
    _fmt = "Supplied history does not follow left-hand parents"
856
1222
 
857
 
    internal_error = True
858
 
 
859
1223
    def __init__(self, history):
860
1224
        BzrError.__init__(self, history=history)
861
1225
 
862
1226
 
863
1227
class UnrelatedBranches(BzrError):
864
1228
 
865
 
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
866
 
 
867
 
    internal_error = False
 
1229
    _fmt = ("Branches have no common ancestor, and"
 
1230
            " no merge base revision was specified.")
 
1231
 
 
1232
 
 
1233
class CannotReverseCherrypick(BzrError):
 
1234
 
 
1235
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1236
            ' or diff3.')
868
1237
 
869
1238
 
870
1239
class NoCommonAncestor(BzrError):
871
 
    
 
1240
 
872
1241
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
873
1242
 
874
1243
    def __init__(self, revision_a, revision_b):
878
1247
 
879
1248
class NoCommonRoot(BzrError):
880
1249
 
881
 
    _fmt = "Revisions are not derived from the same root: " \
882
 
           "%(revision_a)s %(revision_b)s."
 
1250
    _fmt = ("Revisions are not derived from the same root: "
 
1251
           "%(revision_a)s %(revision_b)s.")
883
1252
 
884
1253
    def __init__(self, revision_a, revision_b):
885
1254
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
894
1263
            not_ancestor_id=not_ancestor_id)
895
1264
 
896
1265
 
897
 
class InstallFailed(BzrError):
898
 
 
899
 
    def __init__(self, revisions):
900
 
        revision_str = ", ".join(str(r) for r in revisions)
901
 
        msg = "Could not install revisions:\n%s" % revision_str
902
 
        BzrError.__init__(self, msg)
903
 
        self.revisions = revisions
904
 
 
905
 
 
906
1266
class AmbiguousBase(BzrError):
907
1267
 
908
1268
    def __init__(self, bases):
909
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
910
 
                DeprecationWarning)
911
 
        msg = "The correct base is unclear, because %s are all equally close" %\
912
 
            ", ".join(bases)
 
1269
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1270
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1271
        msg = ("The correct base is unclear, because %s are all equally close"
 
1272
                % ", ".join(bases))
913
1273
        BzrError.__init__(self, msg)
914
1274
        self.bases = bases
915
1275
 
916
1276
 
917
 
class NoCommits(BzrError):
 
1277
class NoCommits(BranchError):
918
1278
 
919
1279
    _fmt = "Branch %(branch)s has no commits."
920
1280
 
921
 
    def __init__(self, branch):
922
 
        BzrError.__init__(self, branch=branch)
923
 
 
924
1281
 
925
1282
class UnlistableStore(BzrError):
926
1283
 
937
1294
 
938
1295
class BoundBranchOutOfDate(BzrError):
939
1296
 
940
 
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
1297
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1298
            " %(master)s.%(extra_help)s")
941
1299
 
942
1300
    def __init__(self, branch, master):
943
1301
        BzrError.__init__(self)
944
1302
        self.branch = branch
945
1303
        self.master = master
946
 
 
947
 
        
 
1304
        self.extra_help = ''
 
1305
 
 
1306
 
948
1307
class CommitToDoubleBoundBranch(BzrError):
949
1308
 
950
 
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
1309
    _fmt = ("Cannot commit to branch %(branch)s."
 
1310
            " It is bound to %(master)s, which is bound to %(remote)s.")
951
1311
 
952
1312
    def __init__(self, branch, master, remote):
953
1313
        BzrError.__init__(self)
967
1327
 
968
1328
class BoundBranchConnectionFailure(BzrError):
969
1329
 
970
 
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
1330
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1331
            " => %(target)s: %(error)s")
971
1332
 
972
1333
    def __init__(self, branch, target, error):
973
1334
        BzrError.__init__(self)
978
1339
 
979
1340
class WeaveError(BzrError):
980
1341
 
981
 
    _fmt = "Error in processing weave: %(message)s"
 
1342
    _fmt = "Error in processing weave: %(msg)s"
982
1343
 
983
 
    def __init__(self, message=None):
 
1344
    def __init__(self, msg=None):
984
1345
        BzrError.__init__(self)
985
 
        self.message = message
 
1346
        self.msg = msg
986
1347
 
987
1348
 
988
1349
class WeaveRevisionAlreadyPresent(WeaveError):
1017
1378
 
1018
1379
class WeaveParentMismatch(WeaveError):
1019
1380
 
1020
 
    _fmt = "Parents are mismatched between two revisions."
1021
 
    
 
1381
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1382
 
1022
1383
 
1023
1384
class WeaveInvalidChecksum(WeaveError):
1024
1385
 
1027
1388
 
1028
1389
class WeaveTextDiffers(WeaveError):
1029
1390
 
1030
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1391
    _fmt = ("Weaves differ on text content. Revision:"
 
1392
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1031
1393
 
1032
1394
    def __init__(self, revision_id, weave_a, weave_b):
1033
1395
        WeaveError.__init__(self)
1038
1400
 
1039
1401
class WeaveTextDiffers(WeaveError):
1040
1402
 
1041
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1403
    _fmt = ("Weaves differ on text content. Revision:"
 
1404
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1042
1405
 
1043
1406
    def __init__(self, revision_id, weave_a, weave_b):
1044
1407
        WeaveError.__init__(self)
1048
1411
 
1049
1412
 
1050
1413
class VersionedFileError(BzrError):
1051
 
    
 
1414
 
1052
1415
    _fmt = "Versioned file error"
1053
1416
 
1054
1417
 
1055
1418
class RevisionNotPresent(VersionedFileError):
1056
 
    
1057
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1419
 
 
1420
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1058
1421
 
1059
1422
    def __init__(self, revision_id, file_id):
1060
1423
        VersionedFileError.__init__(self)
1063
1426
 
1064
1427
 
1065
1428
class RevisionAlreadyPresent(VersionedFileError):
1066
 
    
1067
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1429
 
 
1430
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1068
1431
 
1069
1432
    def __init__(self, revision_id, file_id):
1070
1433
        VersionedFileError.__init__(self)
1072
1435
        self.file_id = file_id
1073
1436
 
1074
1437
 
1075
 
class KnitError(BzrError):
1076
 
    
 
1438
class VersionedFileInvalidChecksum(VersionedFileError):
 
1439
 
 
1440
    _fmt = "Text did not match its checksum: %(message)s"
 
1441
 
 
1442
 
 
1443
class KnitError(InternalBzrError):
 
1444
 
1077
1445
    _fmt = "Knit error"
1078
1446
 
1079
 
    internal_error = True
1080
 
 
1081
 
 
1082
 
class KnitHeaderError(KnitError):
1083
 
 
1084
 
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
1085
 
 
1086
 
    def __init__(self, badline, filename):
1087
 
        KnitError.__init__(self)
1088
 
        self.badline = badline
1089
 
        self.filename = filename
1090
 
 
1091
1447
 
1092
1448
class KnitCorrupt(KnitError):
1093
1449
 
1099
1455
        self.how = how
1100
1456
 
1101
1457
 
 
1458
class SHA1KnitCorrupt(KnitCorrupt):
 
1459
 
 
1460
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1461
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1462
        "sha %(actual)s")
 
1463
 
 
1464
    def __init__(self, filename, actual, expected, key, content):
 
1465
        KnitError.__init__(self)
 
1466
        self.filename = filename
 
1467
        self.actual = actual
 
1468
        self.expected = expected
 
1469
        self.key = key
 
1470
        self.content = content
 
1471
 
 
1472
 
 
1473
class KnitDataStreamIncompatible(KnitError):
 
1474
    # Not raised anymore, as we can convert data streams.  In future we may
 
1475
    # need it again for more exotic cases, so we're keeping it around for now.
 
1476
 
 
1477
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1478
 
 
1479
    def __init__(self, stream_format, target_format):
 
1480
        self.stream_format = stream_format
 
1481
        self.target_format = target_format
 
1482
 
 
1483
 
 
1484
class KnitDataStreamUnknown(KnitError):
 
1485
    # Indicates a data stream we don't know how to handle.
 
1486
 
 
1487
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1488
 
 
1489
    def __init__(self, stream_format):
 
1490
        self.stream_format = stream_format
 
1491
 
 
1492
 
 
1493
class KnitHeaderError(KnitError):
 
1494
 
 
1495
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1496
 
 
1497
    def __init__(self, badline, filename):
 
1498
        KnitError.__init__(self)
 
1499
        self.badline = badline
 
1500
        self.filename = filename
 
1501
 
1102
1502
class KnitIndexUnknownMethod(KnitError):
1103
1503
    """Raised when we don't understand the storage method.
1104
1504
 
1105
1505
    Currently only 'fulltext' and 'line-delta' are supported.
1106
1506
    """
1107
 
    
 
1507
 
1108
1508
    _fmt = ("Knit index %(filename)s does not have a known method"
1109
1509
            " in options: %(options)r")
1110
1510
 
1114
1514
        self.options = options
1115
1515
 
1116
1516
 
 
1517
class RetryWithNewPacks(BzrError):
 
1518
    """Raised when we realize that the packs on disk have changed.
 
1519
 
 
1520
    This is meant as more of a signaling exception, to trap between where a
 
1521
    local error occurred and the code that can actually handle the error and
 
1522
    code that can retry appropriately.
 
1523
    """
 
1524
 
 
1525
    internal_error = True
 
1526
 
 
1527
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1528
            " %(orig_error)s")
 
1529
 
 
1530
    def __init__(self, context, reload_occurred, exc_info):
 
1531
        """create a new RetryWithNewPacks error.
 
1532
 
 
1533
        :param reload_occurred: Set to True if we know that the packs have
 
1534
            already been reloaded, and we are failing because of an in-memory
 
1535
            cache miss. If set to True then we will ignore if a reload says
 
1536
            nothing has changed, because we assume it has already reloaded. If
 
1537
            False, then a reload with nothing changed will force an error.
 
1538
        :param exc_info: The original exception traceback, so if there is a
 
1539
            problem we can raise the original error (value from sys.exc_info())
 
1540
        """
 
1541
        BzrError.__init__(self)
 
1542
        self.reload_occurred = reload_occurred
 
1543
        self.exc_info = exc_info
 
1544
        self.orig_error = exc_info[1]
 
1545
        # TODO: The global error handler should probably treat this by
 
1546
        #       raising/printing the original exception with a bit about
 
1547
        #       RetryWithNewPacks also not being caught
 
1548
 
 
1549
 
 
1550
class RetryAutopack(RetryWithNewPacks):
 
1551
    """Raised when we are autopacking and we find a missing file.
 
1552
 
 
1553
    Meant as a signaling exception, to tell the autopack code it should try
 
1554
    again.
 
1555
    """
 
1556
 
 
1557
    internal_error = True
 
1558
 
 
1559
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1560
            " context: %(context)s %(orig_error)s")
 
1561
 
 
1562
 
1117
1563
class NoSuchExportFormat(BzrError):
1118
 
    
 
1564
 
1119
1565
    _fmt = "Export format %(format)r not supported"
1120
1566
 
1121
1567
    def __init__(self, format):
1124
1570
 
1125
1571
 
1126
1572
class TransportError(BzrError):
1127
 
    
 
1573
 
1128
1574
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1129
1575
 
1130
1576
    def __init__(self, msg=None, orig_error=None):
1139
1585
        BzrError.__init__(self)
1140
1586
 
1141
1587
 
1142
 
class TooManyConcurrentRequests(BzrError):
1143
 
 
1144
 
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
1145
 
            "Be sure to finish_writing and finish_reading on the "
1146
 
            "current request that is open.")
1147
 
 
1148
 
    internal_error = True
 
1588
class TooManyConcurrentRequests(InternalBzrError):
 
1589
 
 
1590
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1591
            " Be sure to finish_writing and finish_reading on the"
 
1592
            " currently open request.")
1149
1593
 
1150
1594
    def __init__(self, medium):
1151
1595
        self.medium = medium
1159
1603
        self.details = details
1160
1604
 
1161
1605
 
 
1606
class UnexpectedProtocolVersionMarker(TransportError):
 
1607
 
 
1608
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1609
 
 
1610
    def __init__(self, marker):
 
1611
        self.marker = marker
 
1612
 
 
1613
 
 
1614
class UnknownSmartMethod(InternalBzrError):
 
1615
 
 
1616
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1617
 
 
1618
    def __init__(self, verb):
 
1619
        self.verb = verb
 
1620
 
 
1621
 
 
1622
class SmartMessageHandlerError(InternalBzrError):
 
1623
 
 
1624
    _fmt = ("The message handler raised an exception:\n"
 
1625
            "%(traceback_text)s")
 
1626
 
 
1627
    def __init__(self, exc_info):
 
1628
        import traceback
 
1629
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1630
        self.exc_info = exc_info
 
1631
        traceback_strings = traceback.format_exception(
 
1632
                self.exc_type, self.exc_value, self.exc_tb)
 
1633
        self.traceback_text = ''.join(traceback_strings)
 
1634
 
 
1635
 
1162
1636
# A set of semi-meaningful errors which can be thrown
1163
1637
class TransportNotPossible(TransportError):
1164
1638
 
1189
1663
            self.port = ':%s' % port
1190
1664
 
1191
1665
 
 
1666
# XXX: This is also used for unexpected end of file, which is different at the
 
1667
# TCP level from "connection reset".
1192
1668
class ConnectionReset(TransportError):
1193
1669
 
1194
1670
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1196
1672
 
1197
1673
class InvalidRange(TransportError):
1198
1674
 
1199
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1200
 
    
1201
 
    def __init__(self, path, offset):
1202
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1203
 
                                       % (path, offset)))
 
1675
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1676
 
 
1677
    def __init__(self, path, offset, msg=None):
 
1678
        TransportError.__init__(self, msg)
1204
1679
        self.path = path
1205
1680
        self.offset = offset
1206
1681
 
1217
1692
class InvalidHttpRange(InvalidHttpResponse):
1218
1693
 
1219
1694
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1220
 
    
 
1695
 
1221
1696
    def __init__(self, path, range, msg):
1222
1697
        self.range = range
1223
1698
        InvalidHttpResponse.__init__(self, path, msg)
1226
1701
class InvalidHttpContentType(InvalidHttpResponse):
1227
1702
 
1228
1703
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1229
 
    
 
1704
 
1230
1705
    def __init__(self, path, ctype, msg):
1231
1706
        self.ctype = ctype
1232
1707
        InvalidHttpResponse.__init__(self, path, msg)
1233
1708
 
1234
1709
 
 
1710
class RedirectRequested(TransportError):
 
1711
 
 
1712
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1713
 
 
1714
    def __init__(self, source, target, is_permanent=False):
 
1715
        self.source = source
 
1716
        self.target = target
 
1717
        if is_permanent:
 
1718
            self.permanently = ' permanently'
 
1719
        else:
 
1720
            self.permanently = ''
 
1721
        TransportError.__init__(self)
 
1722
 
 
1723
 
 
1724
class TooManyRedirections(TransportError):
 
1725
 
 
1726
    _fmt = "Too many redirections"
 
1727
 
 
1728
 
1235
1729
class ConflictsInTree(BzrError):
1236
1730
 
1237
1731
    _fmt = "Working tree has conflicts."
1243
1737
        if filename is None:
1244
1738
            filename = ""
1245
1739
        message = "Error(s) parsing config file %s:\n%s" % \
1246
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1740
            (filename, ('\n'.join(e.msg for e in errors)))
1247
1741
        BzrError.__init__(self, message)
1248
1742
 
1249
1743
 
1258
1752
 
1259
1753
class SigningFailed(BzrError):
1260
1754
 
1261
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1755
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1262
1756
 
1263
1757
    def __init__(self, command_line):
1264
1758
        BzrError.__init__(self, command_line=command_line)
1266
1760
 
1267
1761
class WorkingTreeNotRevision(BzrError):
1268
1762
 
1269
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1763
    _fmt = ("The working tree for %(basedir)s has changed since"
1270
1764
            " the last commit, but weave merge requires that it be"
1271
1765
            " unchanged")
1272
1766
 
1276
1770
 
1277
1771
class CantReprocessAndShowBase(BzrError):
1278
1772
 
1279
 
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
1280
 
           "the relationship of conflicting lines to the base"
 
1773
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1774
           "the relationship of conflicting lines to the base")
1281
1775
 
1282
1776
 
1283
1777
class GraphCycleError(BzrError):
1289
1783
        self.graph = graph
1290
1784
 
1291
1785
 
1292
 
class WritingCompleted(BzrError):
 
1786
class WritingCompleted(InternalBzrError):
1293
1787
 
1294
1788
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1295
1789
            "called upon it - accept bytes may not be called anymore.")
1296
1790
 
1297
 
    internal_error = True
1298
 
 
1299
1791
    def __init__(self, request):
1300
1792
        self.request = request
1301
1793
 
1302
1794
 
1303
 
class WritingNotComplete(BzrError):
 
1795
class WritingNotComplete(InternalBzrError):
1304
1796
 
1305
1797
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1306
1798
            "called upon it - until the write phase is complete no "
1307
1799
            "data may be read.")
1308
1800
 
1309
 
    internal_error = True
1310
 
 
1311
1801
    def __init__(self, request):
1312
1802
        self.request = request
1313
1803
 
1321
1811
        self.filename = filename
1322
1812
 
1323
1813
 
1324
 
class MediumNotConnected(BzrError):
 
1814
class MediumNotConnected(InternalBzrError):
1325
1815
 
1326
1816
    _fmt = """The medium '%(medium)s' is not connected."""
1327
1817
 
1328
 
    internal_error = True
1329
 
 
1330
1818
    def __init__(self, medium):
1331
1819
        self.medium = medium
1332
1820
 
1333
1821
 
1334
1822
class MustUseDecorated(Exception):
1335
 
    
1336
 
    _fmt = """A decorating function has requested its original command be used."""
1337
 
    
 
1823
 
 
1824
    _fmt = "A decorating function has requested its original command be used."
 
1825
 
1338
1826
 
1339
1827
class NoBundleFound(BzrError):
1340
1828
 
1341
 
    _fmt = "No bundle was found in %(filename)s"
 
1829
    _fmt = 'No bundle was found in "%(filename)s".'
1342
1830
 
1343
1831
    def __init__(self, filename):
1344
1832
        BzrError.__init__(self)
1357
1845
 
1358
1846
class MissingText(BzrError):
1359
1847
 
1360
 
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1848
    _fmt = ("Branch %(base)s is missing revision"
 
1849
            " %(text_revision)s of %(file_id)s")
1361
1850
 
1362
1851
    def __init__(self, branch, text_revision, file_id):
1363
1852
        BzrError.__init__(self)
1367
1856
        self.file_id = file_id
1368
1857
 
1369
1858
 
 
1859
class DuplicateFileId(BzrError):
 
1860
 
 
1861
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1862
 
 
1863
    def __init__(self, file_id, entry):
 
1864
        BzrError.__init__(self)
 
1865
        self.file_id = file_id
 
1866
        self.entry = entry
 
1867
 
 
1868
 
1370
1869
class DuplicateKey(BzrError):
1371
1870
 
1372
1871
    _fmt = "Key %(key)s is already present in map"
1373
1872
 
1374
1873
 
 
1874
class DuplicateHelpPrefix(BzrError):
 
1875
 
 
1876
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1877
 
 
1878
    def __init__(self, prefix):
 
1879
        self.prefix = prefix
 
1880
 
 
1881
 
1375
1882
class MalformedTransform(BzrError):
1376
1883
 
1377
1884
    _fmt = "Tree transform is malformed %(conflicts)r"
1389
1896
        self.root_trans_id = transform.root
1390
1897
 
1391
1898
 
1392
 
class BzrBadParameter(BzrError):
 
1899
class BzrBadParameter(InternalBzrError):
1393
1900
 
1394
1901
    _fmt = "Bad parameter: %(param)r"
1395
1902
 
1416
1923
    _fmt = "Moving the root directory is not supported at this time"
1417
1924
 
1418
1925
 
 
1926
class TransformRenameFailed(BzrError):
 
1927
 
 
1928
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1929
 
 
1930
    def __init__(self, from_path, to_path, why, errno):
 
1931
        self.from_path = from_path
 
1932
        self.to_path = to_path
 
1933
        self.why = why
 
1934
        self.errno = errno
 
1935
 
 
1936
 
1419
1937
class BzrMoveFailedError(BzrError):
1420
1938
 
1421
1939
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1422
1940
 
1423
1941
    def __init__(self, from_path='', to_path='', extra=None):
 
1942
        from bzrlib.osutils import splitpath
1424
1943
        BzrError.__init__(self)
1425
1944
        if extra:
1426
1945
            self.extra = ': ' + str(extra)
1430
1949
        has_from = len(from_path) > 0
1431
1950
        has_to = len(to_path) > 0
1432
1951
        if has_from:
1433
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1952
            self.from_path = splitpath(from_path)[-1]
1434
1953
        else:
1435
1954
            self.from_path = ''
1436
1955
 
1437
1956
        if has_to:
1438
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1957
            self.to_path = splitpath(to_path)[-1]
1439
1958
        else:
1440
1959
            self.to_path = ''
1441
1960
 
1457
1976
    def __init__(self, from_path, to_path, extra=None):
1458
1977
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1459
1978
 
 
1979
class BzrRemoveChangedFilesError(BzrError):
 
1980
    """Used when user is trying to remove changed files."""
 
1981
 
 
1982
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1983
        "%(changes_as_text)s"
 
1984
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1985
 
 
1986
    def __init__(self, tree_delta):
 
1987
        BzrError.__init__(self)
 
1988
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1989
        #self.paths_as_string = '\n'.join(changed_files)
 
1990
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1991
 
1460
1992
 
1461
1993
class BzrBadParameterNotString(BzrBadParameter):
1462
1994
 
1470
2002
 
1471
2003
class BzrBadParameterUnicode(BzrBadParameter):
1472
2004
 
1473
 
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
2005
    _fmt = ("Parameter %(param)s is unicode but"
 
2006
            " only byte-strings are permitted.")
1474
2007
 
1475
2008
 
1476
2009
class BzrBadParameterContainsNewline(BzrBadParameter):
1510
2043
 
1511
2044
class BadConversionTarget(BzrError):
1512
2045
 
1513
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2046
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2047
            "    %(problem)s"
1514
2048
 
1515
 
    def __init__(self, problem, format):
 
2049
    def __init__(self, problem, format, from_format=None):
1516
2050
        BzrError.__init__(self)
1517
2051
        self.problem = problem
1518
2052
        self.format = format
 
2053
        self.from_format = from_format or '(unspecified)'
 
2054
 
 
2055
 
 
2056
class NoDiffFound(BzrError):
 
2057
 
 
2058
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2059
 
 
2060
    def __init__(self, path):
 
2061
        BzrError.__init__(self, path)
 
2062
 
 
2063
 
 
2064
class ExecutableMissing(BzrError):
 
2065
 
 
2066
    _fmt = "%(exe_name)s could not be found on this machine"
 
2067
 
 
2068
    def __init__(self, exe_name):
 
2069
        BzrError.__init__(self, exe_name=exe_name)
1519
2070
 
1520
2071
 
1521
2072
class NoDiff(BzrError):
1531
2082
    _fmt = "Diff3 is not installed on this machine."
1532
2083
 
1533
2084
 
 
2085
class ExistingContent(BzrError):
 
2086
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2087
 
 
2088
    _fmt = "The content being inserted is already present."
 
2089
 
 
2090
 
1534
2091
class ExistingLimbo(BzrError):
1535
2092
 
1536
2093
    _fmt = """This tree contains left-over files from a failed operation.
1537
2094
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1538
2095
    keep, and delete it when you are done."""
1539
 
    
 
2096
 
1540
2097
    def __init__(self, limbo_dir):
1541
2098
       BzrError.__init__(self)
1542
2099
       self.limbo_dir = limbo_dir
1543
2100
 
1544
2101
 
 
2102
class ExistingPendingDeletion(BzrError):
 
2103
 
 
2104
    _fmt = """This tree contains left-over files from a failed operation.
 
2105
    Please examine %(pending_deletion)s to see if it contains any files you
 
2106
    wish to keep, and delete it when you are done."""
 
2107
 
 
2108
    def __init__(self, pending_deletion):
 
2109
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2110
 
 
2111
 
1545
2112
class ImmortalLimbo(BzrError):
1546
2113
 
1547
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2114
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1548
2115
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1549
2116
    keep, and delete it when you are done."""
1550
2117
 
1553
2120
       self.limbo_dir = limbo_dir
1554
2121
 
1555
2122
 
 
2123
class ImmortalPendingDeletion(BzrError):
 
2124
 
 
2125
    _fmt = ("Unable to delete transform temporary directory "
 
2126
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2127
    "contains any files you wish to keep, and delete it when you are done.")
 
2128
 
 
2129
    def __init__(self, pending_deletion):
 
2130
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2131
 
 
2132
 
1556
2133
class OutOfDateTree(BzrError):
1557
2134
 
1558
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2135
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1559
2136
 
1560
 
    def __init__(self, tree):
 
2137
    def __init__(self, tree, more=None):
 
2138
        if more is None:
 
2139
            more = ''
 
2140
        else:
 
2141
            more = ' ' + more
1561
2142
        BzrError.__init__(self)
1562
2143
        self.tree = tree
 
2144
        self.more = more
 
2145
 
 
2146
 
 
2147
class PublicBranchOutOfDate(BzrError):
 
2148
 
 
2149
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2150
        '"%(revstring)s".'
 
2151
 
 
2152
    def __init__(self, public_location, revstring):
 
2153
        import bzrlib.urlutils as urlutils
 
2154
        public_location = urlutils.unescape_for_display(public_location,
 
2155
                                                        'ascii')
 
2156
        BzrError.__init__(self, public_location=public_location,
 
2157
                          revstring=revstring)
1563
2158
 
1564
2159
 
1565
2160
class MergeModifiedFormatError(BzrError):
1572
2167
    _fmt = "Format error in conflict listings"
1573
2168
 
1574
2169
 
 
2170
class CorruptDirstate(BzrError):
 
2171
 
 
2172
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2173
            "Error: %(description)s")
 
2174
 
 
2175
    def __init__(self, dirstate_path, description):
 
2176
        BzrError.__init__(self)
 
2177
        self.dirstate_path = dirstate_path
 
2178
        self.description = description
 
2179
 
 
2180
 
1575
2181
class CorruptRepository(BzrError):
1576
2182
 
1577
 
    _fmt = """An error has been detected in the repository %(repo_path)s.
1578
 
Please run bzr reconcile on this repository."""
 
2183
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2184
            "Please run bzr reconcile on this repository.")
1579
2185
 
1580
2186
    def __init__(self, repo):
1581
2187
        BzrError.__init__(self)
1582
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2188
        self.repo_path = repo.user_url
 
2189
 
 
2190
 
 
2191
class InconsistentDelta(BzrError):
 
2192
    """Used when we get a delta that is not valid."""
 
2193
 
 
2194
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2195
            " %(file_id)r\nreason: %(reason)s")
 
2196
 
 
2197
    def __init__(self, path, file_id, reason):
 
2198
        BzrError.__init__(self)
 
2199
        self.path = path
 
2200
        self.file_id = file_id
 
2201
        self.reason = reason
 
2202
 
 
2203
 
 
2204
class InconsistentDeltaDelta(InconsistentDelta):
 
2205
    """Used when we get a delta that is not valid."""
 
2206
 
 
2207
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2208
            "\nreason: %(reason)s")
 
2209
 
 
2210
    def __init__(self, delta, reason):
 
2211
        BzrError.__init__(self)
 
2212
        self.delta = delta
 
2213
        self.reason = reason
1583
2214
 
1584
2215
 
1585
2216
class UpgradeRequired(BzrError):
1591
2222
        self.path = path
1592
2223
 
1593
2224
 
 
2225
class RepositoryUpgradeRequired(UpgradeRequired):
 
2226
 
 
2227
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2228
 
 
2229
 
 
2230
class RichRootUpgradeRequired(UpgradeRequired):
 
2231
 
 
2232
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2233
           " a format which supports rich roots.")
 
2234
 
 
2235
 
1594
2236
class LocalRequiresBoundBranch(BzrError):
1595
2237
 
1596
2238
    _fmt = "Cannot perform local-only commits on unbound branches."
1597
2239
 
1598
2240
 
1599
 
class MissingProgressBarFinish(BzrError):
1600
 
 
1601
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1602
 
 
1603
 
 
1604
 
class InvalidProgressBarType(BzrError):
1605
 
 
1606
 
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1607
 
Select one of: %(valid_types)s"""
1608
 
 
1609
 
    def __init__(self, bar_type, valid_types):
1610
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1611
 
 
1612
 
 
1613
2241
class UnsupportedOperation(BzrError):
1614
2242
 
1615
 
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
2243
    _fmt = ("The method %(mname)s is not supported on"
 
2244
            " objects of type %(tname)s.")
1616
2245
 
1617
2246
    def __init__(self, method, method_self):
1618
2247
        self.method = method
1625
2254
 
1626
2255
 
1627
2256
class NonAsciiRevisionId(UnsupportedOperation):
1628
 
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
2257
    """Raised when a commit is attempting to set a non-ascii revision id
 
2258
       but cant.
 
2259
    """
1629
2260
 
1630
2261
 
1631
2262
class BinaryFile(BzrError):
1632
 
    
 
2263
 
1633
2264
    _fmt = "File is binary but should be text."
1634
2265
 
1635
2266
 
1644
2275
 
1645
2276
class TestamentMismatch(BzrError):
1646
2277
 
1647
 
    _fmt = """Testament did not match expected value.  
1648
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
2278
    _fmt = """Testament did not match expected value.
 
2279
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1649
2280
       {%(measured)s}"""
1650
2281
 
1651
2282
    def __init__(self, revision_id, expected, measured):
1655
2286
 
1656
2287
 
1657
2288
class NotABundle(BzrError):
1658
 
    
 
2289
 
1659
2290
    _fmt = "Not a bzr revision-bundle: %(text)r"
1660
2291
 
1661
2292
    def __init__(self, text):
1663
2294
        self.text = text
1664
2295
 
1665
2296
 
1666
 
class BadBundle(BzrError): 
1667
 
    
 
2297
class BadBundle(BzrError):
 
2298
 
1668
2299
    _fmt = "Bad bzr revision-bundle: %(text)r"
1669
2300
 
1670
2301
    def __init__(self, text):
1672
2303
        self.text = text
1673
2304
 
1674
2305
 
1675
 
class MalformedHeader(BadBundle): 
1676
 
    
 
2306
class MalformedHeader(BadBundle):
 
2307
 
1677
2308
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1678
2309
 
1679
2310
 
1680
 
class MalformedPatches(BadBundle): 
1681
 
    
 
2311
class MalformedPatches(BadBundle):
 
2312
 
1682
2313
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1683
2314
 
1684
2315
 
1685
 
class MalformedFooter(BadBundle): 
1686
 
    
 
2316
class MalformedFooter(BadBundle):
 
2317
 
1687
2318
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1688
2319
 
1689
2320
 
1690
2321
class UnsupportedEOLMarker(BadBundle):
1691
 
    
1692
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2322
 
 
2323
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
1693
2324
 
1694
2325
    def __init__(self):
1695
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2326
        # XXX: BadBundle's constructor assumes there's explanatory text,
1696
2327
        # but for this there is not
1697
2328
        BzrError.__init__(self)
1698
2329
 
1699
2330
 
1700
2331
class IncompatibleBundleFormat(BzrError):
1701
 
    
 
2332
 
1702
2333
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1703
2334
 
1704
2335
    def __init__(self, bundle_format, other):
1708
2339
 
1709
2340
 
1710
2341
class BadInventoryFormat(BzrError):
1711
 
    
 
2342
 
1712
2343
    _fmt = "Root class for inventory serialization errors"
1713
2344
 
1714
2345
 
1720
2351
        BadInventoryFormat.__init__(self, msg=msg)
1721
2352
 
1722
2353
 
1723
 
class NoSmartMedium(BzrError):
 
2354
class RootNotRich(BzrError):
 
2355
 
 
2356
    _fmt = """This operation requires rich root data storage"""
 
2357
 
 
2358
 
 
2359
class NoSmartMedium(InternalBzrError):
1724
2360
 
1725
2361
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1726
 
    internal_error = True
1727
2362
 
1728
2363
    def __init__(self, transport):
1729
2364
        self.transport = transport
1730
2365
 
1731
2366
 
1732
 
class NoSmartServer(NotBranchError):
1733
 
 
1734
 
    _fmt = "No smart server available at %(url)s"
1735
 
 
1736
 
    def __init__(self, url):
1737
 
        self.url = url
1738
 
 
1739
 
 
1740
2367
class UnknownSSH(BzrError):
1741
2368
 
1742
2369
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1746
2373
        self.vendor = vendor
1747
2374
 
1748
2375
 
 
2376
class SSHVendorNotFound(BzrError):
 
2377
 
 
2378
    _fmt = ("Don't know how to handle SSH connections."
 
2379
            " Please set BZR_SSH environment variable.")
 
2380
 
 
2381
 
 
2382
class GhostRevisionsHaveNoRevno(BzrError):
 
2383
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2384
 
 
2385
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2386
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2387
 
 
2388
    def __init__(self, revision_id, ghost_revision_id):
 
2389
        self.revision_id = revision_id
 
2390
        self.ghost_revision_id = ghost_revision_id
 
2391
 
 
2392
 
1749
2393
class GhostRevisionUnusableHere(BzrError):
1750
2394
 
1751
2395
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1755
2399
        self.revision_id = revision_id
1756
2400
 
1757
2401
 
1758
 
class IllegalUseOfScopeReplacer(BzrError):
1759
 
 
1760
 
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
1761
 
 
1762
 
    internal_error = True
 
2402
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2403
 
 
2404
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2405
            " %(msg)s%(extra)s")
1763
2406
 
1764
2407
    def __init__(self, name, msg, extra=None):
1765
2408
        BzrError.__init__(self)
1771
2414
            self.extra = ''
1772
2415
 
1773
2416
 
1774
 
class InvalidImportLine(BzrError):
 
2417
class InvalidImportLine(InternalBzrError):
1775
2418
 
1776
2419
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1777
2420
 
1778
 
    internal_error = True
1779
 
 
1780
2421
    def __init__(self, text, msg):
1781
2422
        BzrError.__init__(self)
1782
2423
        self.text = text
1783
2424
        self.msg = msg
1784
2425
 
1785
2426
 
1786
 
class ImportNameCollision(BzrError):
1787
 
 
1788
 
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
1789
 
 
1790
 
    internal_error = True
1791
 
 
1792
 
    def __init__(self, name):
1793
 
        BzrError.__init__(self)
1794
 
        self.name = name
 
2427
class ImportNameCollision(InternalBzrError):
 
2428
 
 
2429
    _fmt = ("Tried to import an object to the same name as"
 
2430
            " an existing object. %(name)s")
 
2431
 
 
2432
    def __init__(self, name):
 
2433
        BzrError.__init__(self)
 
2434
        self.name = name
 
2435
 
 
2436
 
 
2437
class NotAMergeDirective(BzrError):
 
2438
    """File starting with %(firstline)r is not a merge directive"""
 
2439
    def __init__(self, firstline):
 
2440
        BzrError.__init__(self, firstline=firstline)
 
2441
 
 
2442
 
 
2443
class NoMergeSource(BzrError):
 
2444
    """Raise if no merge source was specified for a merge directive"""
 
2445
 
 
2446
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2447
        " branch location."
 
2448
 
 
2449
 
 
2450
class IllegalMergeDirectivePayload(BzrError):
 
2451
    """A merge directive contained something other than a patch or bundle"""
 
2452
 
 
2453
    _fmt = "Bad merge directive payload %(start)r"
 
2454
 
 
2455
    def __init__(self, start):
 
2456
        BzrError(self)
 
2457
        self.start = start
 
2458
 
 
2459
 
 
2460
class PatchVerificationFailed(BzrError):
 
2461
    """A patch from a merge directive could not be verified"""
 
2462
 
 
2463
    _fmt = "Preview patch does not match requested changes."
 
2464
 
 
2465
 
 
2466
class PatchMissing(BzrError):
 
2467
    """Raise a patch type was specified but no patch supplied"""
 
2468
 
 
2469
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2470
 
 
2471
    def __init__(self, patch_type):
 
2472
        BzrError.__init__(self)
 
2473
        self.patch_type = patch_type
 
2474
 
 
2475
 
 
2476
class TargetNotBranch(BzrError):
 
2477
    """A merge directive's target branch is required, but isn't a branch"""
 
2478
 
 
2479
    _fmt = ("Your branch does not have all of the revisions required in "
 
2480
            "order to merge this merge directive and the target "
 
2481
            "location specified in the merge directive is not a branch: "
 
2482
            "%(location)s.")
 
2483
 
 
2484
    def __init__(self, location):
 
2485
        BzrError.__init__(self)
 
2486
        self.location = location
 
2487
 
 
2488
 
 
2489
class UnsupportedInventoryKind(BzrError):
 
2490
 
 
2491
    _fmt = """Unsupported entry kind %(kind)s"""
 
2492
 
 
2493
    def __init__(self, kind):
 
2494
        self.kind = kind
 
2495
 
 
2496
 
 
2497
class BadSubsumeSource(BzrError):
 
2498
 
 
2499
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2500
 
 
2501
    def __init__(self, tree, other_tree, reason):
 
2502
        self.tree = tree
 
2503
        self.other_tree = other_tree
 
2504
        self.reason = reason
 
2505
 
 
2506
 
 
2507
class SubsumeTargetNeedsUpgrade(BzrError):
 
2508
 
 
2509
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2510
 
 
2511
    def __init__(self, other_tree):
 
2512
        self.other_tree = other_tree
 
2513
 
 
2514
 
 
2515
class BadReferenceTarget(InternalBzrError):
 
2516
 
 
2517
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2518
           "%(reason)s"
 
2519
 
 
2520
    def __init__(self, tree, other_tree, reason):
 
2521
        self.tree = tree
 
2522
        self.other_tree = other_tree
 
2523
        self.reason = reason
 
2524
 
 
2525
 
 
2526
class NoSuchTag(BzrError):
 
2527
 
 
2528
    _fmt = "No such tag: %(tag_name)s"
 
2529
 
 
2530
    def __init__(self, tag_name):
 
2531
        self.tag_name = tag_name
 
2532
 
 
2533
 
 
2534
class TagsNotSupported(BzrError):
 
2535
 
 
2536
    _fmt = ("Tags not supported by %(branch)s;"
 
2537
            " you may be able to use bzr upgrade.")
 
2538
 
 
2539
    def __init__(self, branch):
 
2540
        self.branch = branch
 
2541
 
 
2542
 
 
2543
class TagAlreadyExists(BzrError):
 
2544
 
 
2545
    _fmt = "Tag %(tag_name)s already exists."
 
2546
 
 
2547
    def __init__(self, tag_name):
 
2548
        self.tag_name = tag_name
 
2549
 
 
2550
 
 
2551
class MalformedBugIdentifier(BzrError):
 
2552
 
 
2553
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2554
            'See "bzr help bugs" for more information on this feature.')
 
2555
 
 
2556
    def __init__(self, bug_id, reason):
 
2557
        self.bug_id = bug_id
 
2558
        self.reason = reason
 
2559
 
 
2560
 
 
2561
class InvalidBugTrackerURL(BzrError):
 
2562
 
 
2563
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2564
            "contain {id}: %(url)s")
 
2565
 
 
2566
    def __init__(self, abbreviation, url):
 
2567
        self.abbreviation = abbreviation
 
2568
        self.url = url
 
2569
 
 
2570
 
 
2571
class UnknownBugTrackerAbbreviation(BzrError):
 
2572
 
 
2573
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2574
            "on %(branch)s")
 
2575
 
 
2576
    def __init__(self, abbreviation, branch):
 
2577
        self.abbreviation = abbreviation
 
2578
        self.branch = branch
 
2579
 
 
2580
 
 
2581
class InvalidLineInBugsProperty(BzrError):
 
2582
 
 
2583
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2584
 
 
2585
    def __init__(self, line):
 
2586
        self.line = line
 
2587
 
 
2588
 
 
2589
class InvalidBugStatus(BzrError):
 
2590
 
 
2591
    _fmt = ("Invalid bug status: '%(status)s'")
 
2592
 
 
2593
    def __init__(self, status):
 
2594
        self.status = status
 
2595
 
 
2596
 
 
2597
class UnexpectedSmartServerResponse(BzrError):
 
2598
 
 
2599
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2600
 
 
2601
    def __init__(self, response_tuple):
 
2602
        self.response_tuple = response_tuple
 
2603
 
 
2604
 
 
2605
class ErrorFromSmartServer(BzrError):
 
2606
    """An error was received from a smart server.
 
2607
 
 
2608
    :seealso: UnknownErrorFromSmartServer
 
2609
    """
 
2610
 
 
2611
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2612
 
 
2613
    internal_error = True
 
2614
 
 
2615
    def __init__(self, error_tuple):
 
2616
        self.error_tuple = error_tuple
 
2617
        try:
 
2618
            self.error_verb = error_tuple[0]
 
2619
        except IndexError:
 
2620
            self.error_verb = None
 
2621
        self.error_args = error_tuple[1:]
 
2622
 
 
2623
 
 
2624
class UnknownErrorFromSmartServer(BzrError):
 
2625
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2626
    error.
 
2627
 
 
2628
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2629
    distinguish between the following two cases:
 
2630
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2631
        and so should provoke a traceback to the user.
 
2632
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2633
        translated.  This is probably because the server sent us garbage, and
 
2634
        should not provoke a traceback.
 
2635
    """
 
2636
 
 
2637
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2638
 
 
2639
    internal_error = False
 
2640
 
 
2641
    def __init__(self, error_from_smart_server):
 
2642
        """Constructor.
 
2643
 
 
2644
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2645
        """
 
2646
        self.error_from_smart_server = error_from_smart_server
 
2647
        self.error_tuple = error_from_smart_server.error_tuple
 
2648
 
 
2649
 
 
2650
class ContainerError(BzrError):
 
2651
    """Base class of container errors."""
 
2652
 
 
2653
 
 
2654
class UnknownContainerFormatError(ContainerError):
 
2655
 
 
2656
    _fmt = "Unrecognised container format: %(container_format)r"
 
2657
 
 
2658
    def __init__(self, container_format):
 
2659
        self.container_format = container_format
 
2660
 
 
2661
 
 
2662
class UnexpectedEndOfContainerError(ContainerError):
 
2663
 
 
2664
    _fmt = "Unexpected end of container stream"
 
2665
 
 
2666
 
 
2667
class UnknownRecordTypeError(ContainerError):
 
2668
 
 
2669
    _fmt = "Unknown record type: %(record_type)r"
 
2670
 
 
2671
    def __init__(self, record_type):
 
2672
        self.record_type = record_type
 
2673
 
 
2674
 
 
2675
class InvalidRecordError(ContainerError):
 
2676
 
 
2677
    _fmt = "Invalid record: %(reason)s"
 
2678
 
 
2679
    def __init__(self, reason):
 
2680
        self.reason = reason
 
2681
 
 
2682
 
 
2683
class ContainerHasExcessDataError(ContainerError):
 
2684
 
 
2685
    _fmt = "Container has data after end marker: %(excess)r"
 
2686
 
 
2687
    def __init__(self, excess):
 
2688
        self.excess = excess
 
2689
 
 
2690
 
 
2691
class DuplicateRecordNameError(ContainerError):
 
2692
 
 
2693
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2694
 
 
2695
    def __init__(self, name):
 
2696
        self.name = name
 
2697
 
 
2698
 
 
2699
class NoDestinationAddress(InternalBzrError):
 
2700
 
 
2701
    _fmt = "Message does not have a destination address."
 
2702
 
 
2703
 
 
2704
class RepositoryDataStreamError(BzrError):
 
2705
 
 
2706
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2707
 
 
2708
    def __init__(self, reason):
 
2709
        self.reason = reason
 
2710
 
 
2711
 
 
2712
class SMTPError(BzrError):
 
2713
 
 
2714
    _fmt = "SMTP error: %(error)s"
 
2715
 
 
2716
    def __init__(self, error):
 
2717
        self.error = error
 
2718
 
 
2719
 
 
2720
class NoMessageSupplied(BzrError):
 
2721
 
 
2722
    _fmt = "No message supplied."
 
2723
 
 
2724
 
 
2725
class NoMailAddressSpecified(BzrError):
 
2726
 
 
2727
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2728
 
 
2729
 
 
2730
class UnknownMailClient(BzrError):
 
2731
 
 
2732
    _fmt = "Unknown mail client: %(mail_client)s"
 
2733
 
 
2734
    def __init__(self, mail_client):
 
2735
        BzrError.__init__(self, mail_client=mail_client)
 
2736
 
 
2737
 
 
2738
class MailClientNotFound(BzrError):
 
2739
 
 
2740
    _fmt = "Unable to find mail client with the following names:"\
 
2741
        " %(mail_command_list_string)s"
 
2742
 
 
2743
    def __init__(self, mail_command_list):
 
2744
        mail_command_list_string = ', '.join(mail_command_list)
 
2745
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2746
                          mail_command_list_string=mail_command_list_string)
 
2747
 
 
2748
class SMTPConnectionRefused(SMTPError):
 
2749
 
 
2750
    _fmt = "SMTP connection to %(host)s refused"
 
2751
 
 
2752
    def __init__(self, error, host):
 
2753
        self.error = error
 
2754
        self.host = host
 
2755
 
 
2756
 
 
2757
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2758
 
 
2759
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2760
 
 
2761
 
 
2762
class BzrDirError(BzrError):
 
2763
 
 
2764
    def __init__(self, bzrdir):
 
2765
        import bzrlib.urlutils as urlutils
 
2766
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2767
                                                    'ascii')
 
2768
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2769
 
 
2770
 
 
2771
class UnsyncedBranches(BzrDirError):
 
2772
 
 
2773
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2774
            " bzr help sync-for-reconfigure.")
 
2775
 
 
2776
    def __init__(self, bzrdir, target_branch):
 
2777
        BzrDirError.__init__(self, bzrdir)
 
2778
        import bzrlib.urlutils as urlutils
 
2779
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2780
                                                        'ascii')
 
2781
 
 
2782
 
 
2783
class AlreadyBranch(BzrDirError):
 
2784
 
 
2785
    _fmt = "'%(display_url)s' is already a branch."
 
2786
 
 
2787
 
 
2788
class AlreadyTree(BzrDirError):
 
2789
 
 
2790
    _fmt = "'%(display_url)s' is already a tree."
 
2791
 
 
2792
 
 
2793
class AlreadyCheckout(BzrDirError):
 
2794
 
 
2795
    _fmt = "'%(display_url)s' is already a checkout."
 
2796
 
 
2797
 
 
2798
class AlreadyLightweightCheckout(BzrDirError):
 
2799
 
 
2800
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2801
 
 
2802
 
 
2803
class AlreadyUsingShared(BzrDirError):
 
2804
 
 
2805
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2806
 
 
2807
 
 
2808
class AlreadyStandalone(BzrDirError):
 
2809
 
 
2810
    _fmt = "'%(display_url)s' is already standalone."
 
2811
 
 
2812
 
 
2813
class AlreadyWithTrees(BzrDirError):
 
2814
 
 
2815
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2816
            "working trees.")
 
2817
 
 
2818
 
 
2819
class AlreadyWithNoTrees(BzrDirError):
 
2820
 
 
2821
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2822
            "working trees.")
 
2823
 
 
2824
 
 
2825
class ReconfigurationNotSupported(BzrDirError):
 
2826
 
 
2827
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2828
 
 
2829
 
 
2830
class NoBindLocation(BzrDirError):
 
2831
 
 
2832
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2833
 
 
2834
 
 
2835
class UncommittedChanges(BzrError):
 
2836
 
 
2837
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2838
            ' (See bzr status).%(more)s')
 
2839
 
 
2840
    def __init__(self, tree, more=None):
 
2841
        if more is None:
 
2842
            more = ''
 
2843
        else:
 
2844
            more = ' ' + more
 
2845
        import bzrlib.urlutils as urlutils
 
2846
        display_url = urlutils.unescape_for_display(
 
2847
            tree.user_url, 'ascii')
 
2848
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2849
 
 
2850
 
 
2851
class ShelvedChanges(UncommittedChanges):
 
2852
 
 
2853
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2854
            ' (See bzr shelve --list).%(more)s')
 
2855
 
 
2856
 
 
2857
class MissingTemplateVariable(BzrError):
 
2858
 
 
2859
    _fmt = 'Variable {%(name)s} is not available.'
 
2860
 
 
2861
    def __init__(self, name):
 
2862
        self.name = name
 
2863
 
 
2864
 
 
2865
class NoTemplate(BzrError):
 
2866
 
 
2867
    _fmt = 'No template specified.'
 
2868
 
 
2869
 
 
2870
class UnableCreateSymlink(BzrError):
 
2871
 
 
2872
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2873
 
 
2874
    def __init__(self, path=None):
 
2875
        path_str = ''
 
2876
        if path:
 
2877
            try:
 
2878
                path_str = repr(str(path))
 
2879
            except UnicodeEncodeError:
 
2880
                path_str = repr(path)
 
2881
            path_str += ' '
 
2882
        self.path_str = path_str
 
2883
 
 
2884
 
 
2885
class UnsupportedTimezoneFormat(BzrError):
 
2886
 
 
2887
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2888
            'options are "utc", "original", "local".')
 
2889
 
 
2890
    def __init__(self, timezone):
 
2891
        self.timezone = timezone
 
2892
 
 
2893
 
 
2894
class CommandAvailableInPlugin(StandardError):
 
2895
 
 
2896
    internal_error = False
 
2897
 
 
2898
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2899
 
 
2900
        self.plugin_metadata = plugin_metadata
 
2901
        self.cmd_name = cmd_name
 
2902
        self.provider = provider
 
2903
 
 
2904
    def __str__(self):
 
2905
 
 
2906
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2907
                'However, the following official plugin provides this command: %s\n'
 
2908
                'You can install it by going to: %s'
 
2909
                % (self.cmd_name, self.plugin_metadata['name'],
 
2910
                    self.plugin_metadata['url']))
 
2911
 
 
2912
        return _fmt
 
2913
 
 
2914
 
 
2915
class NoPluginAvailable(BzrError):
 
2916
    pass
 
2917
 
 
2918
 
 
2919
class UnableEncodePath(BzrError):
 
2920
 
 
2921
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2922
            'user encoding %(user_encoding)s')
 
2923
 
 
2924
    def __init__(self, path, kind):
 
2925
        from bzrlib.osutils import get_user_encoding
 
2926
        self.path = path
 
2927
        self.kind = kind
 
2928
        self.user_encoding = osutils.get_user_encoding()
 
2929
 
 
2930
 
 
2931
class NoSuchAlias(BzrError):
 
2932
 
 
2933
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2934
 
 
2935
    def __init__(self, alias_name):
 
2936
        BzrError.__init__(self, alias_name=alias_name)
 
2937
 
 
2938
 
 
2939
class DirectoryLookupFailure(BzrError):
 
2940
    """Base type for lookup errors."""
 
2941
 
 
2942
    pass
 
2943
 
 
2944
 
 
2945
class InvalidLocationAlias(DirectoryLookupFailure):
 
2946
 
 
2947
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2948
 
 
2949
    def __init__(self, alias_name):
 
2950
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2951
 
 
2952
 
 
2953
class UnsetLocationAlias(DirectoryLookupFailure):
 
2954
 
 
2955
    _fmt = 'No %(alias_name)s location assigned.'
 
2956
 
 
2957
    def __init__(self, alias_name):
 
2958
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2959
 
 
2960
 
 
2961
class CannotBindAddress(BzrError):
 
2962
 
 
2963
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2964
 
 
2965
    def __init__(self, host, port, orig_error):
 
2966
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2967
        BzrError.__init__(self, host=host, port=port,
 
2968
            orig_error=repr(orig_error.args))
 
2969
 
 
2970
 
 
2971
class UnknownRules(BzrError):
 
2972
 
 
2973
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2974
 
 
2975
    def __init__(self, unknowns):
 
2976
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2977
 
 
2978
 
 
2979
class HookFailed(BzrError):
 
2980
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2981
    than TipChangeRejected.
 
2982
 
 
2983
    Note that this exception is no longer raised, and the import is only left
 
2984
    to be nice to code which might catch it in a plugin.
 
2985
    """
 
2986
 
 
2987
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2988
            "%(traceback_text)s%(exc_value)s")
 
2989
 
 
2990
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2991
        if warn:
 
2992
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2993
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2994
        import traceback
 
2995
        self.hook_stage = hook_stage
 
2996
        self.hook_name = hook_name
 
2997
        self.exc_info = exc_info
 
2998
        self.exc_type = exc_info[0]
 
2999
        self.exc_value = exc_info[1]
 
3000
        self.exc_tb = exc_info[2]
 
3001
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
3002
 
 
3003
 
 
3004
class TipChangeRejected(BzrError):
 
3005
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3006
    explicitly abort a change to a branch tip.
 
3007
    """
 
3008
 
 
3009
    _fmt = u"Tip change rejected: %(msg)s"
 
3010
 
 
3011
    def __init__(self, msg):
 
3012
        self.msg = msg
 
3013
 
 
3014
 
 
3015
class ShelfCorrupt(BzrError):
 
3016
 
 
3017
    _fmt = "Shelf corrupt."
 
3018
 
 
3019
 
 
3020
class NoSuchShelfId(BzrError):
 
3021
 
 
3022
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3023
 
 
3024
    def __init__(self, shelf_id):
 
3025
        BzrError.__init__(self, shelf_id=shelf_id)
 
3026
 
 
3027
 
 
3028
class InvalidShelfId(BzrError):
 
3029
 
 
3030
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3031
 
 
3032
    def __init__(self, invalid_id):
 
3033
        BzrError.__init__(self, invalid_id=invalid_id)
 
3034
 
 
3035
 
 
3036
class JailBreak(BzrError):
 
3037
 
 
3038
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3039
 
 
3040
    def __init__(self, url):
 
3041
        BzrError.__init__(self, url=url)
 
3042
 
 
3043
 
 
3044
class UserAbort(BzrError):
 
3045
 
 
3046
    _fmt = 'The user aborted the operation.'
 
3047
 
 
3048
 
 
3049
class MustHaveWorkingTree(BzrError):
 
3050
 
 
3051
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3052
 
 
3053
    def __init__(self, format, url):
 
3054
        BzrError.__init__(self, format=format, url=url)
 
3055
 
 
3056
 
 
3057
class NoSuchView(BzrError):
 
3058
    """A view does not exist.
 
3059
    """
 
3060
 
 
3061
    _fmt = u"No such view: %(view_name)s."
 
3062
 
 
3063
    def __init__(self, view_name):
 
3064
        self.view_name = view_name
 
3065
 
 
3066
 
 
3067
class ViewsNotSupported(BzrError):
 
3068
    """Views are not supported by a tree format.
 
3069
    """
 
3070
 
 
3071
    _fmt = ("Views are not supported by %(tree)s;"
 
3072
            " use 'bzr upgrade' to change your tree to a later format.")
 
3073
 
 
3074
    def __init__(self, tree):
 
3075
        self.tree = tree
 
3076
 
 
3077
 
 
3078
class FileOutsideView(BzrError):
 
3079
 
 
3080
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3081
            '%(view_str)s')
 
3082
 
 
3083
    def __init__(self, file_name, view_files):
 
3084
        self.file_name = file_name
 
3085
        self.view_str = ", ".join(view_files)
 
3086
 
 
3087
 
 
3088
class UnresumableWriteGroup(BzrError):
 
3089
 
 
3090
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3091
            "%(write_groups)r: %(reason)s")
 
3092
 
 
3093
    internal_error = True
 
3094
 
 
3095
    def __init__(self, repository, write_groups, reason):
 
3096
        self.repository = repository
 
3097
        self.write_groups = write_groups
 
3098
        self.reason = reason
 
3099
 
 
3100
 
 
3101
class UnsuspendableWriteGroup(BzrError):
 
3102
 
 
3103
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3104
 
 
3105
    internal_error = True
 
3106
 
 
3107
    def __init__(self, repository):
 
3108
        self.repository = repository
 
3109
 
 
3110
 
 
3111
class LossyPushToSameVCS(BzrError):
 
3112
 
 
3113
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3114
            "%(target_branch)r that are in the same VCS.")
 
3115
 
 
3116
    internal_error = True
 
3117
 
 
3118
    def __init__(self, source_branch, target_branch):
 
3119
        self.source_branch = source_branch
 
3120
        self.target_branch = target_branch
 
3121
 
 
3122
 
 
3123
class NoRoundtrippingSupport(BzrError):
 
3124
 
 
3125
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3126
            "%(target_branch)r.")
 
3127
 
 
3128
    internal_error = True
 
3129
 
 
3130
    def __init__(self, source_branch, target_branch):
 
3131
        self.source_branch = source_branch
 
3132
        self.target_branch = target_branch
 
3133
 
 
3134
 
 
3135
class FileTimestampUnavailable(BzrError):
 
3136
 
 
3137
    _fmt = "The filestamp for %(path)s is not available."
 
3138
 
 
3139
    internal_error = True
 
3140
 
 
3141
    def __init__(self, path):
 
3142
        self.path = path
 
3143
 
 
3144
 
 
3145
class NoColocatedBranchSupport(BzrError):
 
3146
 
 
3147
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3148
 
 
3149
    def __init__(self, bzrdir):
 
3150
        self.bzrdir = bzrdir
 
3151
 
 
3152
class NoWhoami(BzrError):
 
3153
 
 
3154
    _fmt = ('Unable to determine your name.\n'
 
3155
        "Please, set your name with the 'whoami' command.\n"
 
3156
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3157
 
 
3158