/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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 DisabledMethod(BzrError):
 
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):
178
238
 
179
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
180
240
 
181
 
    internal_error = True
182
 
 
183
241
    def __init__(self, class_name):
184
242
        BzrError.__init__(self)
185
243
        self.class_name = class_name
186
244
 
187
245
 
188
 
class InvalidEntryName(BzrError):
189
 
    
 
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
 
190
269
    _fmt = "Invalid entry name: %(name)s"
191
270
 
192
 
    internal_error = True
193
 
 
194
271
    def __init__(self, name):
195
272
        BzrError.__init__(self)
196
273
        self.name = name
197
274
 
198
275
 
199
276
class InvalidRevisionNumber(BzrError):
200
 
    
 
277
 
201
278
    _fmt = "Invalid revision number %(revno)s"
202
279
 
203
280
    def __init__(self, revno):
215
292
        self.revision_id = revision_id
216
293
        self.branch = branch
217
294
 
 
295
 
218
296
class ReservedId(BzrError):
219
297
 
220
298
    _fmt = "Reserved revision-id {%(revision_id)s}"
222
300
    def __init__(self, revision_id):
223
301
        self.revision_id = revision_id
224
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
 
225
329
class NoSuchId(BzrError):
226
330
 
227
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
228
 
    
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
229
333
    def __init__(self, tree, file_id):
230
334
        BzrError.__init__(self)
231
335
        self.file_id = file_id
232
336
        self.tree = tree
233
337
 
234
338
 
235
 
class InventoryModified(BzrError):
236
 
 
237
 
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
238
 
            "so a clean inventory cannot be read without data loss.")
239
 
 
240
 
    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.")
241
357
 
242
358
    def __init__(self, tree):
243
359
        self.tree = tree
245
361
 
246
362
class NoWorkingTree(BzrError):
247
363
 
248
 
    _fmt = "No WorkingTree exists for %(base)s."
249
 
    
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
250
366
    def __init__(self, base):
251
367
        BzrError.__init__(self)
252
368
        self.base = base
265
381
        self.url = url
266
382
 
267
383
 
268
 
class WorkingTreeAlreadyPopulated(BzrError):
269
 
 
270
 
    _fmt = """Working tree already populated in %(base)s"""
271
 
 
272
 
    internal_error = True
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
273
387
 
274
388
    def __init__(self, base):
275
389
        self.base = base
276
390
 
 
391
 
277
392
class BzrCommandError(BzrError):
278
393
    """Error from user command"""
279
394
 
280
 
    internal_error = False
281
 
 
282
395
    # Error from malformed user command; please avoid raising this as a
283
396
    # generic exception not caused by user input.
284
397
    #
286
399
    # are not intended to be caught anyway.  UI code need not subclass
287
400
    # BzrCommandError, and non-UI code should not throw a subclass of
288
401
    # BzrCommandError.  ADHB 20051211
289
 
    def __init__(self, msg):
290
 
        # Object.__str__() must return a real string
291
 
        # returning a Unicode string is a python error.
292
 
        if isinstance(msg, unicode):
293
 
            self.msg = msg.encode('utf8')
294
 
        else:
295
 
            self.msg = msg
296
 
 
297
 
    def __str__(self):
298
 
        return self.msg
299
402
 
300
403
 
301
404
class NotWriteLocked(BzrError):
311
414
    _fmt = "Error in command line options"
312
415
 
313
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
 
314
473
class BadOptionValue(BzrError):
315
474
 
316
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
318
477
    def __init__(self, name, value):
319
478
        BzrError.__init__(self, name=name, value=value)
320
479
 
321
 
    
 
480
 
322
481
class StrictCommitFailed(BzrError):
323
482
 
324
483
    _fmt = "Commit refused because there are unknown files in the tree"
326
485
 
327
486
# XXX: Should be unified with TransportError; they seem to represent the
328
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.'
329
492
class PathError(BzrError):
330
 
    
 
493
 
331
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
332
495
 
333
496
    def __init__(self, path, extra=None):
353
516
    """Used when renaming and both source and dest exist."""
354
517
 
355
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
356
 
         "%(extra)s")
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
357
521
 
358
522
    def __init__(self, source, dest, extra=None):
359
523
        BzrError.__init__(self)
367
531
 
368
532
class NotADirectory(PathError):
369
533
 
370
 
    _fmt = "%(path)r is not a directory %(extra)s"
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
371
535
 
372
536
 
373
537
class NotInWorkingDirectory(PathError):
374
538
 
375
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
376
540
 
377
541
 
378
542
class DirectoryNotEmpty(PathError):
379
543
 
380
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
381
 
 
382
 
 
383
 
class ReadingCompleted(BzrError):
384
 
    
 
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
 
385
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
386
555
            "called upon it - the request has been completed and no more "
387
556
            "data may be read.")
388
557
 
389
 
    internal_error = True
390
 
 
391
558
    def __init__(self, request):
392
559
        self.request = request
393
560
 
394
561
 
395
562
class ResourceBusy(PathError):
396
563
 
397
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
398
565
 
399
566
 
400
567
class PermissionDenied(PathError):
401
568
 
402
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
403
570
 
404
571
 
405
572
class InvalidURL(PathError):
406
573
 
407
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
408
575
 
409
576
 
410
577
class InvalidURLJoin(PathError):
411
578
 
412
 
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
413
 
 
414
 
    def __init__(self, msg, base, args):
415
 
        PathError.__init__(self, base, msg)
416
 
        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
417
608
 
418
609
 
419
610
class UnknownHook(BzrError):
434
625
        PathError.__init__(self, url, extra=extra)
435
626
 
436
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
 
437
665
class ShortReadvError(PathError):
438
666
 
439
 
    _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')
440
669
 
441
670
    internal_error = True
442
671
 
447
676
        self.actual = actual
448
677
 
449
678
 
450
 
class PathNotChild(BzrError):
 
679
class PathNotChild(PathError):
451
680
 
452
 
    _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'
453
682
 
454
683
    internal_error = True
455
684
 
465
694
 
466
695
class InvalidNormalization(PathError):
467
696
 
468
 
    _fmt = "Path %(path)r is not unicode normalized"
 
697
    _fmt = 'Path "%(path)s" is not unicode normalized'
469
698
 
470
699
 
471
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
472
701
# the exception object is a bit undesirable.
473
 
# TODO: Probably this behavior of should be a common superclass 
 
702
# TODO: Probably this behavior of should be a common superclass
474
703
class NotBranchError(PathError):
475
704
 
476
 
    _fmt = "Not a branch: %(path)s"
477
 
 
478
 
    def __init__(self, path):
479
 
       import bzrlib.urlutils as urlutils
480
 
       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')
481
740
 
482
741
 
483
742
class AlreadyBranchError(PathError):
484
743
 
485
 
    _fmt = "Already a branch: %(path)s."
 
744
    _fmt = 'Already a branch: "%(path)s".'
486
745
 
487
746
 
488
747
class BranchExistsWithoutWorkingTree(PathError):
489
748
 
490
 
    _fmt = "Directory contains a branch, but no working tree \
491
 
(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"'
492
751
 
493
752
 
494
753
class AtomicFileAlreadyClosed(PathError):
495
754
 
496
 
    _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"')
497
757
 
498
758
    def __init__(self, path, function):
499
759
        PathError.__init__(self, path=path, extra=None)
502
762
 
503
763
class InaccessibleParent(PathError):
504
764
 
505
 
    _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"')
506
767
 
507
768
    def __init__(self, path, base):
508
769
        PathError.__init__(self, path)
511
772
 
512
773
class NoRepositoryPresent(BzrError):
513
774
 
514
 
    _fmt = "No repository present: %(path)r"
 
775
    _fmt = 'No repository present: "%(path)s"'
515
776
    def __init__(self, bzrdir):
516
777
        BzrError.__init__(self)
517
778
        self.path = bzrdir.transport.clone('..').base
519
780
 
520
781
class FileInWrongBranch(BzrError):
521
782
 
522
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
523
784
 
524
785
    def __init__(self, branch, path):
525
786
        BzrError.__init__(self)
529
790
 
530
791
 
531
792
class UnsupportedFormatError(BzrError):
532
 
    
533
 
    _fmt = "Unsupported branch format: %(format)s"
 
793
 
 
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
534
795
 
535
796
 
536
797
class UnknownFormatError(BzrError):
537
 
    
538
 
    _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
539
804
 
540
805
 
541
806
class IncompatibleFormat(BzrError):
542
 
    
 
807
 
543
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
544
809
 
545
810
    def __init__(self, format, bzrdir_format):
548
813
        self.bzrdir = bzrdir_format
549
814
 
550
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
 
551
835
class IncompatibleRevision(BzrError):
552
 
    
 
836
 
553
837
    _fmt = "Revision is not compatible with %(repo_format)s"
554
838
 
555
839
    def __init__(self, repo_format):
560
844
class AlreadyVersionedError(BzrError):
561
845
    """Used when a path is expected not to be versioned, but it is."""
562
846
 
563
 
    _fmt = "%(context_info)s%(path)s is already versioned"
 
847
    _fmt = "%(context_info)s%(path)s is already versioned."
564
848
 
565
849
    def __init__(self, path, context_info=None):
566
 
        """Construct a new NotVersionedError.
 
850
        """Construct a new AlreadyVersionedError.
567
851
 
568
852
        :param path: This is the path which is versioned,
569
853
        which should be in a user friendly form.
581
865
class NotVersionedError(BzrError):
582
866
    """Used when a path is expected to be versioned, but it is not."""
583
867
 
584
 
    _fmt = "%(context_info)s%(path)s is not versioned"
 
868
    _fmt = "%(context_info)s%(path)s is not versioned."
585
869
 
586
870
    def __init__(self, path, context_info=None):
587
871
        """Construct a new NotVersionedError.
632
916
 
633
917
class BadFileKindError(BzrError):
634
918
 
635
 
    _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
636
934
 
637
935
 
638
936
class ForbiddenControlFileError(BzrError):
639
937
 
640
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
641
 
 
642
 
 
643
 
class LockError(BzrError):
644
 
 
645
 
    _fmt = "Lock error: %(message)s"
646
 
 
647
 
    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"
648
944
 
649
945
    # All exceptions from the lock/unlock functions should be from
650
946
    # this exception class.  They will be translated as necessary. The
652
948
    #
653
949
    # New code should prefer to raise specific subclasses
654
950
    def __init__(self, message):
655
 
        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
656
965
 
657
966
 
658
967
class CommitNotPossible(LockError):
675
984
 
676
985
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
677
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
 
678
990
    def __init__(self, obj):
679
991
        self.obj = obj
680
992
 
681
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
 
682
1006
class OutSideTransaction(BzrError):
683
1007
 
684
 
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
1008
    _fmt = ("A transaction related operation was attempted after"
 
1009
            " the transaction finished.")
685
1010
 
686
1011
 
687
1012
class ObjectNotLocked(LockError):
705
1030
 
706
1031
class UnlockableTransport(LockError):
707
1032
 
 
1033
    internal_error = False
 
1034
 
708
1035
    _fmt = "Cannot lock: transport is read only: %(transport)s"
709
1036
 
710
1037
    def __init__(self, transport):
713
1040
 
714
1041
class LockContention(LockError):
715
1042
 
716
 
    _fmt = "Could not acquire lock %(lock)s"
 
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
717
1044
    # TODO: show full url for lock, combining the transport and relative
718
1045
    # bits?
719
1046
 
720
1047
    internal_error = False
721
 
    
722
 
    def __init__(self, lock):
 
1048
 
 
1049
    def __init__(self, lock, msg=''):
723
1050
        self.lock = lock
 
1051
        self.msg = msg
724
1052
 
725
1053
 
726
1054
class LockBroken(LockError):
727
1055
 
728
 
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
1056
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1057
            " - check storage consistency!")
729
1058
 
730
1059
    internal_error = False
731
1060
 
735
1064
 
736
1065
class LockBreakMismatch(LockError):
737
1066
 
738
 
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
1067
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1068
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
739
1069
 
740
1070
    internal_error = False
741
1071
 
755
1085
        self.lock = lock
756
1086
 
757
1087
 
 
1088
class TokenLockingNotSupported(LockError):
 
1089
 
 
1090
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1091
 
 
1092
    def __init__(self, obj):
 
1093
        self.obj = obj
 
1094
 
 
1095
 
 
1096
class TokenMismatch(LockBroken):
 
1097
 
 
1098
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1099
 
 
1100
    internal_error = True
 
1101
 
 
1102
    def __init__(self, given_token, lock_token):
 
1103
        self.given_token = given_token
 
1104
        self.lock_token = lock_token
 
1105
 
 
1106
 
758
1107
class PointlessCommit(BzrError):
759
1108
 
760
1109
    _fmt = "No changes to commit"
761
1110
 
762
1111
 
 
1112
class CannotCommitSelectedFileMerge(BzrError):
 
1113
 
 
1114
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1115
        ' files %(files_str)s'
 
1116
 
 
1117
    def __init__(self, files):
 
1118
        files_str = ', '.join(files)
 
1119
        BzrError.__init__(self, files=files, files_str=files_str)
 
1120
 
 
1121
 
 
1122
class BadCommitMessageEncoding(BzrError):
 
1123
 
 
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1125
        'the current encoding.'
 
1126
 
 
1127
 
763
1128
class UpgradeReadonly(BzrError):
764
1129
 
765
1130
    _fmt = "Upgrade URL cannot work with readonly URLs."
779
1144
    _fmt = "Commit refused because there are unknowns in the tree."
780
1145
 
781
1146
 
782
 
class NoSuchRevision(BzrError):
783
 
 
784
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
785
 
 
786
 
    internal_error = True
 
1147
class NoSuchRevision(InternalBzrError):
 
1148
 
 
1149
    _fmt = "%(branch)s has no revision %(revision)s"
787
1150
 
788
1151
    def __init__(self, branch, revision):
 
1152
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
789
1153
        BzrError.__init__(self, branch=branch, revision=revision)
790
1154
 
791
1155
 
 
1156
class RangeInChangeOption(BzrError):
 
1157
 
 
1158
    _fmt = "Option --change does not accept revision ranges"
 
1159
 
 
1160
 
792
1161
class NoSuchRevisionSpec(BzrError):
793
1162
 
794
1163
    _fmt = "No namespace registered for string: %(spec)r"
797
1166
        BzrError.__init__(self, spec=spec)
798
1167
 
799
1168
 
 
1169
class NoSuchRevisionInTree(NoSuchRevision):
 
1170
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1171
 
 
1172
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1173
 
 
1174
    def __init__(self, tree, revision_id):
 
1175
        BzrError.__init__(self)
 
1176
        self.tree = tree
 
1177
        self.revision_id = revision_id
 
1178
 
 
1179
 
800
1180
class InvalidRevisionSpec(BzrError):
801
1181
 
802
 
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
1182
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1183
            " %(branch)s%(extra)s")
803
1184
 
804
1185
    def __init__(self, spec, branch, extra=None):
805
1186
        BzrError.__init__(self, branch=branch, spec=spec)
814
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
815
1196
 
816
1197
 
 
1198
class AppendRevisionsOnlyViolation(BzrError):
 
1199
 
 
1200
    _fmt = ('Operation denied because it would change the main history,'
 
1201
           ' which is not permitted by the append_revisions_only setting on'
 
1202
           ' branch "%(location)s".')
 
1203
 
 
1204
    def __init__(self, location):
 
1205
       import bzrlib.urlutils as urlutils
 
1206
       location = urlutils.unescape_for_display(location, 'ascii')
 
1207
       BzrError.__init__(self, location=location)
 
1208
 
 
1209
 
817
1210
class DivergedBranches(BzrError):
818
 
    
819
 
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
820
1211
 
821
 
    internal_error = False
 
1212
    _fmt = ("These branches have diverged."
 
1213
            " Use the missing command to see how.\n"
 
1214
            "Use the merge command to reconcile them.")
822
1215
 
823
1216
    def __init__(self, branch1, branch2):
824
1217
        self.branch1 = branch1
825
1218
        self.branch2 = branch2
826
1219
 
827
1220
 
 
1221
class NotLefthandHistory(InternalBzrError):
 
1222
 
 
1223
    _fmt = "Supplied history does not follow left-hand parents"
 
1224
 
 
1225
    def __init__(self, history):
 
1226
        BzrError.__init__(self, history=history)
 
1227
 
 
1228
 
828
1229
class UnrelatedBranches(BzrError):
829
1230
 
830
 
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
831
 
 
832
 
    internal_error = False
 
1231
    _fmt = ("Branches have no common ancestor, and"
 
1232
            " no merge base revision was specified.")
 
1233
 
 
1234
 
 
1235
class CannotReverseCherrypick(BzrError):
 
1236
 
 
1237
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1238
            ' or diff3.')
833
1239
 
834
1240
 
835
1241
class NoCommonAncestor(BzrError):
836
 
    
 
1242
 
837
1243
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
838
1244
 
839
1245
    def __init__(self, revision_a, revision_b):
843
1249
 
844
1250
class NoCommonRoot(BzrError):
845
1251
 
846
 
    _fmt = "Revisions are not derived from the same root: " \
847
 
           "%(revision_a)s %(revision_b)s."
 
1252
    _fmt = ("Revisions are not derived from the same root: "
 
1253
           "%(revision_a)s %(revision_b)s.")
848
1254
 
849
1255
    def __init__(self, revision_a, revision_b):
850
1256
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
859
1265
            not_ancestor_id=not_ancestor_id)
860
1266
 
861
1267
 
862
 
class InstallFailed(BzrError):
863
 
 
864
 
    def __init__(self, revisions):
865
 
        revision_str = ", ".join(str(r) for r in revisions)
866
 
        msg = "Could not install revisions:\n%s" % revision_str
867
 
        BzrError.__init__(self, msg)
868
 
        self.revisions = revisions
869
 
 
870
 
 
871
1268
class AmbiguousBase(BzrError):
872
1269
 
873
1270
    def __init__(self, bases):
874
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
875
 
                DeprecationWarning)
876
 
        msg = "The correct base is unclear, because %s are all equally close" %\
877
 
            ", ".join(bases)
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1273
        msg = ("The correct base is unclear, because %s are all equally close"
 
1274
                % ", ".join(bases))
878
1275
        BzrError.__init__(self, msg)
879
1276
        self.bases = bases
880
1277
 
881
1278
 
882
 
class NoCommits(BzrError):
 
1279
class NoCommits(BranchError):
883
1280
 
884
1281
    _fmt = "Branch %(branch)s has no commits."
885
1282
 
886
 
    def __init__(self, branch):
887
 
        BzrError.__init__(self, branch=branch)
888
 
 
889
1283
 
890
1284
class UnlistableStore(BzrError):
891
1285
 
902
1296
 
903
1297
class BoundBranchOutOfDate(BzrError):
904
1298
 
905
 
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1300
            " %(master)s.%(extra_help)s")
906
1301
 
907
1302
    def __init__(self, branch, master):
908
1303
        BzrError.__init__(self)
909
1304
        self.branch = branch
910
1305
        self.master = master
911
 
 
912
 
        
 
1306
        self.extra_help = ''
 
1307
 
 
1308
 
913
1309
class CommitToDoubleBoundBranch(BzrError):
914
1310
 
915
 
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
1311
    _fmt = ("Cannot commit to branch %(branch)s."
 
1312
            " It is bound to %(master)s, which is bound to %(remote)s.")
916
1313
 
917
1314
    def __init__(self, branch, master, remote):
918
1315
        BzrError.__init__(self)
932
1329
 
933
1330
class BoundBranchConnectionFailure(BzrError):
934
1331
 
935
 
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
1332
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1333
            " => %(target)s: %(error)s")
936
1334
 
937
1335
    def __init__(self, branch, target, error):
938
1336
        BzrError.__init__(self)
943
1341
 
944
1342
class WeaveError(BzrError):
945
1343
 
946
 
    _fmt = "Error in processing weave: %(message)s"
 
1344
    _fmt = "Error in processing weave: %(msg)s"
947
1345
 
948
 
    def __init__(self, message=None):
 
1346
    def __init__(self, msg=None):
949
1347
        BzrError.__init__(self)
950
 
        self.message = message
 
1348
        self.msg = msg
951
1349
 
952
1350
 
953
1351
class WeaveRevisionAlreadyPresent(WeaveError):
982
1380
 
983
1381
class WeaveParentMismatch(WeaveError):
984
1382
 
985
 
    _fmt = "Parents are mismatched between two revisions."
986
 
    
 
1383
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1384
 
987
1385
 
988
1386
class WeaveInvalidChecksum(WeaveError):
989
1387
 
992
1390
 
993
1391
class WeaveTextDiffers(WeaveError):
994
1392
 
995
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1393
    _fmt = ("Weaves differ on text content. Revision:"
 
1394
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
996
1395
 
997
1396
    def __init__(self, revision_id, weave_a, weave_b):
998
1397
        WeaveError.__init__(self)
1003
1402
 
1004
1403
class WeaveTextDiffers(WeaveError):
1005
1404
 
1006
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1405
    _fmt = ("Weaves differ on text content. Revision:"
 
1406
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1007
1407
 
1008
1408
    def __init__(self, revision_id, weave_a, weave_b):
1009
1409
        WeaveError.__init__(self)
1013
1413
 
1014
1414
 
1015
1415
class VersionedFileError(BzrError):
1016
 
    
 
1416
 
1017
1417
    _fmt = "Versioned file error"
1018
1418
 
1019
1419
 
1020
1420
class RevisionNotPresent(VersionedFileError):
1021
 
    
1022
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1421
 
 
1422
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1023
1423
 
1024
1424
    def __init__(self, revision_id, file_id):
1025
1425
        VersionedFileError.__init__(self)
1028
1428
 
1029
1429
 
1030
1430
class RevisionAlreadyPresent(VersionedFileError):
1031
 
    
1032
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1431
 
 
1432
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
1033
1433
 
1034
1434
    def __init__(self, revision_id, file_id):
1035
1435
        VersionedFileError.__init__(self)
1037
1437
        self.file_id = file_id
1038
1438
 
1039
1439
 
1040
 
class KnitError(BzrError):
1041
 
    
 
1440
class VersionedFileInvalidChecksum(VersionedFileError):
 
1441
 
 
1442
    _fmt = "Text did not match its checksum: %(message)s"
 
1443
 
 
1444
 
 
1445
class KnitError(InternalBzrError):
 
1446
 
1042
1447
    _fmt = "Knit error"
1043
1448
 
1044
 
    internal_error = True
1045
 
 
1046
 
 
1047
 
class KnitHeaderError(KnitError):
1048
 
 
1049
 
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
1050
 
 
1051
 
    def __init__(self, badline, filename):
1052
 
        KnitError.__init__(self)
1053
 
        self.badline = badline
1054
 
        self.filename = filename
1055
 
 
1056
1449
 
1057
1450
class KnitCorrupt(KnitError):
1058
1451
 
1064
1457
        self.how = how
1065
1458
 
1066
1459
 
 
1460
class SHA1KnitCorrupt(KnitCorrupt):
 
1461
 
 
1462
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1463
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1464
        "sha %(actual)s")
 
1465
 
 
1466
    def __init__(self, filename, actual, expected, key, content):
 
1467
        KnitError.__init__(self)
 
1468
        self.filename = filename
 
1469
        self.actual = actual
 
1470
        self.expected = expected
 
1471
        self.key = key
 
1472
        self.content = content
 
1473
 
 
1474
 
 
1475
class KnitDataStreamIncompatible(KnitError):
 
1476
    # Not raised anymore, as we can convert data streams.  In future we may
 
1477
    # need it again for more exotic cases, so we're keeping it around for now.
 
1478
 
 
1479
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1480
 
 
1481
    def __init__(self, stream_format, target_format):
 
1482
        self.stream_format = stream_format
 
1483
        self.target_format = target_format
 
1484
 
 
1485
 
 
1486
class KnitDataStreamUnknown(KnitError):
 
1487
    # Indicates a data stream we don't know how to handle.
 
1488
 
 
1489
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1490
 
 
1491
    def __init__(self, stream_format):
 
1492
        self.stream_format = stream_format
 
1493
 
 
1494
 
 
1495
class KnitHeaderError(KnitError):
 
1496
 
 
1497
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1498
 
 
1499
    def __init__(self, badline, filename):
 
1500
        KnitError.__init__(self)
 
1501
        self.badline = badline
 
1502
        self.filename = filename
 
1503
 
1067
1504
class KnitIndexUnknownMethod(KnitError):
1068
1505
    """Raised when we don't understand the storage method.
1069
1506
 
1070
1507
    Currently only 'fulltext' and 'line-delta' are supported.
1071
1508
    """
1072
 
    
 
1509
 
1073
1510
    _fmt = ("Knit index %(filename)s does not have a known method"
1074
1511
            " in options: %(options)r")
1075
1512
 
1079
1516
        self.options = options
1080
1517
 
1081
1518
 
 
1519
class RetryWithNewPacks(BzrError):
 
1520
    """Raised when we realize that the packs on disk have changed.
 
1521
 
 
1522
    This is meant as more of a signaling exception, to trap between where a
 
1523
    local error occurred and the code that can actually handle the error and
 
1524
    code that can retry appropriately.
 
1525
    """
 
1526
 
 
1527
    internal_error = True
 
1528
 
 
1529
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1530
            " %(orig_error)s")
 
1531
 
 
1532
    def __init__(self, context, reload_occurred, exc_info):
 
1533
        """create a new RetryWithNewPacks error.
 
1534
 
 
1535
        :param reload_occurred: Set to True if we know that the packs have
 
1536
            already been reloaded, and we are failing because of an in-memory
 
1537
            cache miss. If set to True then we will ignore if a reload says
 
1538
            nothing has changed, because we assume it has already reloaded. If
 
1539
            False, then a reload with nothing changed will force an error.
 
1540
        :param exc_info: The original exception traceback, so if there is a
 
1541
            problem we can raise the original error (value from sys.exc_info())
 
1542
        """
 
1543
        BzrError.__init__(self)
 
1544
        self.reload_occurred = reload_occurred
 
1545
        self.exc_info = exc_info
 
1546
        self.orig_error = exc_info[1]
 
1547
        # TODO: The global error handler should probably treat this by
 
1548
        #       raising/printing the original exception with a bit about
 
1549
        #       RetryWithNewPacks also not being caught
 
1550
 
 
1551
 
 
1552
class RetryAutopack(RetryWithNewPacks):
 
1553
    """Raised when we are autopacking and we find a missing file.
 
1554
 
 
1555
    Meant as a signaling exception, to tell the autopack code it should try
 
1556
    again.
 
1557
    """
 
1558
 
 
1559
    internal_error = True
 
1560
 
 
1561
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1562
            " context: %(context)s %(orig_error)s")
 
1563
 
 
1564
 
1082
1565
class NoSuchExportFormat(BzrError):
1083
 
    
 
1566
 
1084
1567
    _fmt = "Export format %(format)r not supported"
1085
1568
 
1086
1569
    def __init__(self, format):
1089
1572
 
1090
1573
 
1091
1574
class TransportError(BzrError):
1092
 
    
 
1575
 
1093
1576
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1094
1577
 
1095
1578
    def __init__(self, msg=None, orig_error=None):
1104
1587
        BzrError.__init__(self)
1105
1588
 
1106
1589
 
1107
 
class TooManyConcurrentRequests(BzrError):
1108
 
 
1109
 
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
1110
 
            "Be sure to finish_writing and finish_reading on the "
1111
 
            "current request that is open.")
1112
 
 
1113
 
    internal_error = True
 
1590
class TooManyConcurrentRequests(InternalBzrError):
 
1591
 
 
1592
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1593
            " Be sure to finish_writing and finish_reading on the"
 
1594
            " currently open request.")
1114
1595
 
1115
1596
    def __init__(self, medium):
1116
1597
        self.medium = medium
1124
1605
        self.details = details
1125
1606
 
1126
1607
 
 
1608
class UnexpectedProtocolVersionMarker(TransportError):
 
1609
 
 
1610
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1611
 
 
1612
    def __init__(self, marker):
 
1613
        self.marker = marker
 
1614
 
 
1615
 
 
1616
class UnknownSmartMethod(InternalBzrError):
 
1617
 
 
1618
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1619
 
 
1620
    def __init__(self, verb):
 
1621
        self.verb = verb
 
1622
 
 
1623
 
 
1624
class SmartMessageHandlerError(InternalBzrError):
 
1625
 
 
1626
    _fmt = ("The message handler raised an exception:\n"
 
1627
            "%(traceback_text)s")
 
1628
 
 
1629
    def __init__(self, exc_info):
 
1630
        import traceback
 
1631
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1632
        self.exc_info = exc_info
 
1633
        traceback_strings = traceback.format_exception(
 
1634
                self.exc_type, self.exc_value, self.exc_tb)
 
1635
        self.traceback_text = ''.join(traceback_strings)
 
1636
 
 
1637
 
1127
1638
# A set of semi-meaningful errors which can be thrown
1128
1639
class TransportNotPossible(TransportError):
1129
1640
 
1154
1665
            self.port = ':%s' % port
1155
1666
 
1156
1667
 
 
1668
# XXX: This is also used for unexpected end of file, which is different at the
 
1669
# TCP level from "connection reset".
1157
1670
class ConnectionReset(TransportError):
1158
1671
 
1159
1672
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1161
1674
 
1162
1675
class InvalidRange(TransportError):
1163
1676
 
1164
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1165
 
    
1166
 
    def __init__(self, path, offset):
1167
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1168
 
                                       % (path, offset)))
 
1677
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1678
 
 
1679
    def __init__(self, path, offset, msg=None):
 
1680
        TransportError.__init__(self, msg)
1169
1681
        self.path = path
1170
1682
        self.offset = offset
1171
1683
 
1182
1694
class InvalidHttpRange(InvalidHttpResponse):
1183
1695
 
1184
1696
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1185
 
    
 
1697
 
1186
1698
    def __init__(self, path, range, msg):
1187
1699
        self.range = range
1188
1700
        InvalidHttpResponse.__init__(self, path, msg)
1191
1703
class InvalidHttpContentType(InvalidHttpResponse):
1192
1704
 
1193
1705
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1194
 
    
 
1706
 
1195
1707
    def __init__(self, path, ctype, msg):
1196
1708
        self.ctype = ctype
1197
1709
        InvalidHttpResponse.__init__(self, path, msg)
1198
1710
 
1199
1711
 
 
1712
class RedirectRequested(TransportError):
 
1713
 
 
1714
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1715
 
 
1716
    def __init__(self, source, target, is_permanent=False):
 
1717
        self.source = source
 
1718
        self.target = target
 
1719
        if is_permanent:
 
1720
            self.permanently = ' permanently'
 
1721
        else:
 
1722
            self.permanently = ''
 
1723
        TransportError.__init__(self)
 
1724
 
 
1725
 
 
1726
class TooManyRedirections(TransportError):
 
1727
 
 
1728
    _fmt = "Too many redirections"
 
1729
 
 
1730
 
1200
1731
class ConflictsInTree(BzrError):
1201
1732
 
1202
1733
    _fmt = "Working tree has conflicts."
1208
1739
        if filename is None:
1209
1740
            filename = ""
1210
1741
        message = "Error(s) parsing config file %s:\n%s" % \
1211
 
            (filename, ('\n'.join(e.message for e in errors)))
 
1742
            (filename, ('\n'.join(e.msg for e in errors)))
1212
1743
        BzrError.__init__(self, message)
1213
1744
 
1214
1745
 
1223
1754
 
1224
1755
class SigningFailed(BzrError):
1225
1756
 
1226
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1757
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1227
1758
 
1228
1759
    def __init__(self, command_line):
1229
1760
        BzrError.__init__(self, command_line=command_line)
1231
1762
 
1232
1763
class WorkingTreeNotRevision(BzrError):
1233
1764
 
1234
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1765
    _fmt = ("The working tree for %(basedir)s has changed since"
1235
1766
            " the last commit, but weave merge requires that it be"
1236
1767
            " unchanged")
1237
1768
 
1241
1772
 
1242
1773
class CantReprocessAndShowBase(BzrError):
1243
1774
 
1244
 
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
1245
 
           "the relationship of conflicting lines to the base"
 
1775
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1776
           "the relationship of conflicting lines to the base")
1246
1777
 
1247
1778
 
1248
1779
class GraphCycleError(BzrError):
1254
1785
        self.graph = graph
1255
1786
 
1256
1787
 
1257
 
class WritingCompleted(BzrError):
 
1788
class WritingCompleted(InternalBzrError):
1258
1789
 
1259
1790
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1260
1791
            "called upon it - accept bytes may not be called anymore.")
1261
1792
 
1262
 
    internal_error = True
1263
 
 
1264
1793
    def __init__(self, request):
1265
1794
        self.request = request
1266
1795
 
1267
1796
 
1268
 
class WritingNotComplete(BzrError):
 
1797
class WritingNotComplete(InternalBzrError):
1269
1798
 
1270
1799
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1271
1800
            "called upon it - until the write phase is complete no "
1272
1801
            "data may be read.")
1273
1802
 
1274
 
    internal_error = True
1275
 
 
1276
1803
    def __init__(self, request):
1277
1804
        self.request = request
1278
1805
 
1286
1813
        self.filename = filename
1287
1814
 
1288
1815
 
1289
 
class MediumNotConnected(BzrError):
 
1816
class MediumNotConnected(InternalBzrError):
1290
1817
 
1291
1818
    _fmt = """The medium '%(medium)s' is not connected."""
1292
1819
 
1293
 
    internal_error = True
1294
 
 
1295
1820
    def __init__(self, medium):
1296
1821
        self.medium = medium
1297
1822
 
1298
1823
 
1299
1824
class MustUseDecorated(Exception):
1300
 
    
1301
 
    _fmt = """A decorating function has requested its original command be used."""
1302
 
    
 
1825
 
 
1826
    _fmt = "A decorating function has requested its original command be used."
 
1827
 
1303
1828
 
1304
1829
class NoBundleFound(BzrError):
1305
1830
 
1306
 
    _fmt = "No bundle was found in %(filename)s"
 
1831
    _fmt = 'No bundle was found in "%(filename)s".'
1307
1832
 
1308
1833
    def __init__(self, filename):
1309
1834
        BzrError.__init__(self)
1322
1847
 
1323
1848
class MissingText(BzrError):
1324
1849
 
1325
 
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1850
    _fmt = ("Branch %(base)s is missing revision"
 
1851
            " %(text_revision)s of %(file_id)s")
1326
1852
 
1327
1853
    def __init__(self, branch, text_revision, file_id):
1328
1854
        BzrError.__init__(self)
1332
1858
        self.file_id = file_id
1333
1859
 
1334
1860
 
 
1861
class DuplicateFileId(BzrError):
 
1862
 
 
1863
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1864
 
 
1865
    def __init__(self, file_id, entry):
 
1866
        BzrError.__init__(self)
 
1867
        self.file_id = file_id
 
1868
        self.entry = entry
 
1869
 
 
1870
 
1335
1871
class DuplicateKey(BzrError):
1336
1872
 
1337
1873
    _fmt = "Key %(key)s is already present in map"
1338
1874
 
1339
1875
 
 
1876
class DuplicateHelpPrefix(BzrError):
 
1877
 
 
1878
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1879
 
 
1880
    def __init__(self, prefix):
 
1881
        self.prefix = prefix
 
1882
 
 
1883
 
1340
1884
class MalformedTransform(BzrError):
1341
1885
 
1342
1886
    _fmt = "Tree transform is malformed %(conflicts)r"
1354
1898
        self.root_trans_id = transform.root
1355
1899
 
1356
1900
 
1357
 
class BzrBadParameter(BzrError):
 
1901
class BzrBadParameter(InternalBzrError):
1358
1902
 
1359
1903
    _fmt = "Bad parameter: %(param)r"
1360
1904
 
1386
1930
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1387
1931
 
1388
1932
    def __init__(self, from_path='', to_path='', extra=None):
 
1933
        from bzrlib.osutils import splitpath
1389
1934
        BzrError.__init__(self)
1390
1935
        if extra:
1391
1936
            self.extra = ': ' + str(extra)
1395
1940
        has_from = len(from_path) > 0
1396
1941
        has_to = len(to_path) > 0
1397
1942
        if has_from:
1398
 
            self.from_path = osutils.splitpath(from_path)[-1]
 
1943
            self.from_path = splitpath(from_path)[-1]
1399
1944
        else:
1400
1945
            self.from_path = ''
1401
1946
 
1402
1947
        if has_to:
1403
 
            self.to_path = osutils.splitpath(to_path)[-1]
 
1948
            self.to_path = splitpath(to_path)[-1]
1404
1949
        else:
1405
1950
            self.to_path = ''
1406
1951
 
1422
1967
    def __init__(self, from_path, to_path, extra=None):
1423
1968
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1424
1969
 
 
1970
class BzrRemoveChangedFilesError(BzrError):
 
1971
    """Used when user is trying to remove changed files."""
 
1972
 
 
1973
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1974
        "%(changes_as_text)s"
 
1975
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1976
 
 
1977
    def __init__(self, tree_delta):
 
1978
        BzrError.__init__(self)
 
1979
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1980
        #self.paths_as_string = '\n'.join(changed_files)
 
1981
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1982
 
1425
1983
 
1426
1984
class BzrBadParameterNotString(BzrBadParameter):
1427
1985
 
1435
1993
 
1436
1994
class BzrBadParameterUnicode(BzrBadParameter):
1437
1995
 
1438
 
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
1996
    _fmt = ("Parameter %(param)s is unicode but"
 
1997
            " only byte-strings are permitted.")
1439
1998
 
1440
1999
 
1441
2000
class BzrBadParameterContainsNewline(BzrBadParameter):
1475
2034
 
1476
2035
class BadConversionTarget(BzrError):
1477
2036
 
1478
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2037
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2038
            "    %(problem)s"
1479
2039
 
1480
 
    def __init__(self, problem, format):
 
2040
    def __init__(self, problem, format, from_format=None):
1481
2041
        BzrError.__init__(self)
1482
2042
        self.problem = problem
1483
2043
        self.format = format
 
2044
        self.from_format = from_format or '(unspecified)'
 
2045
 
 
2046
 
 
2047
class NoDiffFound(BzrError):
 
2048
 
 
2049
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2050
 
 
2051
    def __init__(self, path):
 
2052
        BzrError.__init__(self, path)
 
2053
 
 
2054
 
 
2055
class ExecutableMissing(BzrError):
 
2056
 
 
2057
    _fmt = "%(exe_name)s could not be found on this machine"
 
2058
 
 
2059
    def __init__(self, exe_name):
 
2060
        BzrError.__init__(self, exe_name=exe_name)
1484
2061
 
1485
2062
 
1486
2063
class NoDiff(BzrError):
1496
2073
    _fmt = "Diff3 is not installed on this machine."
1497
2074
 
1498
2075
 
 
2076
class ExistingContent(BzrError):
 
2077
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2078
 
 
2079
    _fmt = "The content being inserted is already present."
 
2080
 
 
2081
 
1499
2082
class ExistingLimbo(BzrError):
1500
2083
 
1501
2084
    _fmt = """This tree contains left-over files from a failed operation.
1502
2085
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1503
2086
    keep, and delete it when you are done."""
1504
 
    
 
2087
 
1505
2088
    def __init__(self, limbo_dir):
1506
2089
       BzrError.__init__(self)
1507
2090
       self.limbo_dir = limbo_dir
1508
2091
 
1509
2092
 
 
2093
class ExistingPendingDeletion(BzrError):
 
2094
 
 
2095
    _fmt = """This tree contains left-over files from a failed operation.
 
2096
    Please examine %(pending_deletion)s to see if it contains any files you
 
2097
    wish to keep, and delete it when you are done."""
 
2098
 
 
2099
    def __init__(self, pending_deletion):
 
2100
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2101
 
 
2102
 
1510
2103
class ImmortalLimbo(BzrError):
1511
2104
 
1512
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
2105
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
1513
2106
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1514
2107
    keep, and delete it when you are done."""
1515
2108
 
1518
2111
       self.limbo_dir = limbo_dir
1519
2112
 
1520
2113
 
 
2114
class ImmortalPendingDeletion(BzrError):
 
2115
 
 
2116
    _fmt = ("Unable to delete transform temporary directory "
 
2117
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2118
    "contains any files you wish to keep, and delete it when you are done.")
 
2119
 
 
2120
    def __init__(self, pending_deletion):
 
2121
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2122
 
 
2123
 
1521
2124
class OutOfDateTree(BzrError):
1522
2125
 
1523
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2126
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1524
2127
 
1525
 
    def __init__(self, tree):
 
2128
    def __init__(self, tree, more=None):
 
2129
        if more is None:
 
2130
            more = ''
 
2131
        else:
 
2132
            more = ' ' + more
1526
2133
        BzrError.__init__(self)
1527
2134
        self.tree = tree
 
2135
        self.more = more
 
2136
 
 
2137
 
 
2138
class PublicBranchOutOfDate(BzrError):
 
2139
 
 
2140
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2141
        '"%(revstring)s".'
 
2142
 
 
2143
    def __init__(self, public_location, revstring):
 
2144
        import bzrlib.urlutils as urlutils
 
2145
        public_location = urlutils.unescape_for_display(public_location,
 
2146
                                                        'ascii')
 
2147
        BzrError.__init__(self, public_location=public_location,
 
2148
                          revstring=revstring)
1528
2149
 
1529
2150
 
1530
2151
class MergeModifiedFormatError(BzrError):
1537
2158
    _fmt = "Format error in conflict listings"
1538
2159
 
1539
2160
 
 
2161
class CorruptDirstate(BzrError):
 
2162
 
 
2163
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2164
            "Error: %(description)s")
 
2165
 
 
2166
    def __init__(self, dirstate_path, description):
 
2167
        BzrError.__init__(self)
 
2168
        self.dirstate_path = dirstate_path
 
2169
        self.description = description
 
2170
 
 
2171
 
1540
2172
class CorruptRepository(BzrError):
1541
2173
 
1542
 
    _fmt = """An error has been detected in the repository %(repo_path)s.
1543
 
Please run bzr reconcile on this repository."""
 
2174
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2175
            "Please run bzr reconcile on this repository.")
1544
2176
 
1545
2177
    def __init__(self, repo):
1546
2178
        BzrError.__init__(self)
1547
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2179
        self.repo_path = repo.user_url
 
2180
 
 
2181
 
 
2182
class InconsistentDelta(BzrError):
 
2183
    """Used when we get a delta that is not valid."""
 
2184
 
 
2185
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2186
            " %(file_id)r\nreason: %(reason)s")
 
2187
 
 
2188
    def __init__(self, path, file_id, reason):
 
2189
        BzrError.__init__(self)
 
2190
        self.path = path
 
2191
        self.file_id = file_id
 
2192
        self.reason = reason
 
2193
 
 
2194
 
 
2195
class InconsistentDeltaDelta(InconsistentDelta):
 
2196
    """Used when we get a delta that is not valid."""
 
2197
 
 
2198
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2199
            "\nreason: %(reason)s")
 
2200
 
 
2201
    def __init__(self, delta, reason):
 
2202
        BzrError.__init__(self)
 
2203
        self.delta = delta
 
2204
        self.reason = reason
1548
2205
 
1549
2206
 
1550
2207
class UpgradeRequired(BzrError):
1556
2213
        self.path = path
1557
2214
 
1558
2215
 
 
2216
class RepositoryUpgradeRequired(UpgradeRequired):
 
2217
 
 
2218
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2219
 
 
2220
 
 
2221
class RichRootUpgradeRequired(UpgradeRequired):
 
2222
 
 
2223
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2224
           " a format which supports rich roots.")
 
2225
 
 
2226
 
1559
2227
class LocalRequiresBoundBranch(BzrError):
1560
2228
 
1561
2229
    _fmt = "Cannot perform local-only commits on unbound branches."
1562
2230
 
1563
2231
 
1564
 
class MissingProgressBarFinish(BzrError):
1565
 
 
1566
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1567
 
 
1568
 
 
1569
 
class InvalidProgressBarType(BzrError):
1570
 
 
1571
 
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1572
 
Select one of: %(valid_types)s"""
1573
 
 
1574
 
    def __init__(self, bar_type, valid_types):
1575
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1576
 
 
1577
 
 
1578
2232
class UnsupportedOperation(BzrError):
1579
2233
 
1580
 
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
2234
    _fmt = ("The method %(mname)s is not supported on"
 
2235
            " objects of type %(tname)s.")
1581
2236
 
1582
2237
    def __init__(self, method, method_self):
1583
2238
        self.method = method
1590
2245
 
1591
2246
 
1592
2247
class NonAsciiRevisionId(UnsupportedOperation):
1593
 
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
2248
    """Raised when a commit is attempting to set a non-ascii revision id
 
2249
       but cant.
 
2250
    """
1594
2251
 
1595
2252
 
1596
2253
class BinaryFile(BzrError):
1597
 
    
 
2254
 
1598
2255
    _fmt = "File is binary but should be text."
1599
2256
 
1600
2257
 
1609
2266
 
1610
2267
class TestamentMismatch(BzrError):
1611
2268
 
1612
 
    _fmt = """Testament did not match expected value.  
1613
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
2269
    _fmt = """Testament did not match expected value.
 
2270
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1614
2271
       {%(measured)s}"""
1615
2272
 
1616
2273
    def __init__(self, revision_id, expected, measured):
1620
2277
 
1621
2278
 
1622
2279
class NotABundle(BzrError):
1623
 
    
 
2280
 
1624
2281
    _fmt = "Not a bzr revision-bundle: %(text)r"
1625
2282
 
1626
2283
    def __init__(self, text):
1628
2285
        self.text = text
1629
2286
 
1630
2287
 
1631
 
class BadBundle(BzrError): 
1632
 
    
 
2288
class BadBundle(BzrError):
 
2289
 
1633
2290
    _fmt = "Bad bzr revision-bundle: %(text)r"
1634
2291
 
1635
2292
    def __init__(self, text):
1637
2294
        self.text = text
1638
2295
 
1639
2296
 
1640
 
class MalformedHeader(BadBundle): 
1641
 
    
 
2297
class MalformedHeader(BadBundle):
 
2298
 
1642
2299
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1643
2300
 
1644
2301
 
1645
 
class MalformedPatches(BadBundle): 
1646
 
    
 
2302
class MalformedPatches(BadBundle):
 
2303
 
1647
2304
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1648
2305
 
1649
2306
 
1650
 
class MalformedFooter(BadBundle): 
1651
 
    
 
2307
class MalformedFooter(BadBundle):
 
2308
 
1652
2309
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1653
2310
 
1654
2311
 
1655
2312
class UnsupportedEOLMarker(BadBundle):
1656
 
    
1657
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2313
 
 
2314
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
1658
2315
 
1659
2316
    def __init__(self):
1660
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2317
        # XXX: BadBundle's constructor assumes there's explanatory text,
1661
2318
        # but for this there is not
1662
2319
        BzrError.__init__(self)
1663
2320
 
1664
2321
 
1665
2322
class IncompatibleBundleFormat(BzrError):
1666
 
    
 
2323
 
1667
2324
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1668
2325
 
1669
2326
    def __init__(self, bundle_format, other):
1673
2330
 
1674
2331
 
1675
2332
class BadInventoryFormat(BzrError):
1676
 
    
 
2333
 
1677
2334
    _fmt = "Root class for inventory serialization errors"
1678
2335
 
1679
2336
 
1685
2342
        BadInventoryFormat.__init__(self, msg=msg)
1686
2343
 
1687
2344
 
1688
 
class NoSmartMedium(BzrError):
 
2345
class RootNotRich(BzrError):
 
2346
 
 
2347
    _fmt = """This operation requires rich root data storage"""
 
2348
 
 
2349
 
 
2350
class NoSmartMedium(InternalBzrError):
1689
2351
 
1690
2352
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1691
 
    internal_error = True
1692
2353
 
1693
2354
    def __init__(self, transport):
1694
2355
        self.transport = transport
1695
2356
 
1696
2357
 
1697
 
class NoSmartServer(NotBranchError):
1698
 
 
1699
 
    _fmt = "No smart server available at %(url)s"
1700
 
 
1701
 
    def __init__(self, url):
1702
 
        self.url = url
1703
 
 
1704
 
 
1705
2358
class UnknownSSH(BzrError):
1706
2359
 
1707
2360
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1711
2364
        self.vendor = vendor
1712
2365
 
1713
2366
 
 
2367
class SSHVendorNotFound(BzrError):
 
2368
 
 
2369
    _fmt = ("Don't know how to handle SSH connections."
 
2370
            " Please set BZR_SSH environment variable.")
 
2371
 
 
2372
 
 
2373
class GhostRevisionsHaveNoRevno(BzrError):
 
2374
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2375
 
 
2376
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2377
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2378
 
 
2379
    def __init__(self, revision_id, ghost_revision_id):
 
2380
        self.revision_id = revision_id
 
2381
        self.ghost_revision_id = ghost_revision_id
 
2382
 
 
2383
 
1714
2384
class GhostRevisionUnusableHere(BzrError):
1715
2385
 
1716
2386
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1720
2390
        self.revision_id = revision_id
1721
2391
 
1722
2392
 
1723
 
class IllegalUseOfScopeReplacer(BzrError):
1724
 
 
1725
 
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
1726
 
 
1727
 
    internal_error = True
 
2393
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2394
 
 
2395
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2396
            " %(msg)s%(extra)s")
1728
2397
 
1729
2398
    def __init__(self, name, msg, extra=None):
1730
2399
        BzrError.__init__(self)
1736
2405
            self.extra = ''
1737
2406
 
1738
2407
 
1739
 
class InvalidImportLine(BzrError):
 
2408
class InvalidImportLine(InternalBzrError):
1740
2409
 
1741
2410
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1742
2411
 
1743
 
    internal_error = True
1744
 
 
1745
2412
    def __init__(self, text, msg):
1746
2413
        BzrError.__init__(self)
1747
2414
        self.text = text
1748
2415
        self.msg = msg
1749
2416
 
1750
2417
 
1751
 
class ImportNameCollision(BzrError):
1752
 
 
1753
 
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
1754
 
 
1755
 
    internal_error = True
1756
 
 
1757
 
    def __init__(self, name):
1758
 
        BzrError.__init__(self)
1759
 
        self.name = name
 
2418
class ImportNameCollision(InternalBzrError):
 
2419
 
 
2420
    _fmt = ("Tried to import an object to the same name as"
 
2421
            " an existing object. %(name)s")
 
2422
 
 
2423
    def __init__(self, name):
 
2424
        BzrError.__init__(self)
 
2425
        self.name = name
 
2426
 
 
2427
 
 
2428
class NotAMergeDirective(BzrError):
 
2429
    """File starting with %(firstline)r is not a merge directive"""
 
2430
    def __init__(self, firstline):
 
2431
        BzrError.__init__(self, firstline=firstline)
 
2432
 
 
2433
 
 
2434
class NoMergeSource(BzrError):
 
2435
    """Raise if no merge source was specified for a merge directive"""
 
2436
 
 
2437
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2438
        " branch location."
 
2439
 
 
2440
 
 
2441
class IllegalMergeDirectivePayload(BzrError):
 
2442
    """A merge directive contained something other than a patch or bundle"""
 
2443
 
 
2444
    _fmt = "Bad merge directive payload %(start)r"
 
2445
 
 
2446
    def __init__(self, start):
 
2447
        BzrError(self)
 
2448
        self.start = start
 
2449
 
 
2450
 
 
2451
class PatchVerificationFailed(BzrError):
 
2452
    """A patch from a merge directive could not be verified"""
 
2453
 
 
2454
    _fmt = "Preview patch does not match requested changes."
 
2455
 
 
2456
 
 
2457
class PatchMissing(BzrError):
 
2458
    """Raise a patch type was specified but no patch supplied"""
 
2459
 
 
2460
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2461
 
 
2462
    def __init__(self, patch_type):
 
2463
        BzrError.__init__(self)
 
2464
        self.patch_type = patch_type
 
2465
 
 
2466
 
 
2467
class TargetNotBranch(BzrError):
 
2468
    """A merge directive's target branch is required, but isn't a branch"""
 
2469
 
 
2470
    _fmt = ("Your branch does not have all of the revisions required in "
 
2471
            "order to merge this merge directive and the target "
 
2472
            "location specified in the merge directive is not a branch: "
 
2473
            "%(location)s.")
 
2474
 
 
2475
    def __init__(self, location):
 
2476
        BzrError.__init__(self)
 
2477
        self.location = location
 
2478
 
 
2479
 
 
2480
class UnsupportedInventoryKind(BzrError):
 
2481
 
 
2482
    _fmt = """Unsupported entry kind %(kind)s"""
 
2483
 
 
2484
    def __init__(self, kind):
 
2485
        self.kind = kind
 
2486
 
 
2487
 
 
2488
class BadSubsumeSource(BzrError):
 
2489
 
 
2490
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2491
 
 
2492
    def __init__(self, tree, other_tree, reason):
 
2493
        self.tree = tree
 
2494
        self.other_tree = other_tree
 
2495
        self.reason = reason
 
2496
 
 
2497
 
 
2498
class SubsumeTargetNeedsUpgrade(BzrError):
 
2499
 
 
2500
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2501
 
 
2502
    def __init__(self, other_tree):
 
2503
        self.other_tree = other_tree
 
2504
 
 
2505
 
 
2506
class BadReferenceTarget(InternalBzrError):
 
2507
 
 
2508
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2509
           "%(reason)s"
 
2510
 
 
2511
    def __init__(self, tree, other_tree, reason):
 
2512
        self.tree = tree
 
2513
        self.other_tree = other_tree
 
2514
        self.reason = reason
 
2515
 
 
2516
 
 
2517
class NoSuchTag(BzrError):
 
2518
 
 
2519
    _fmt = "No such tag: %(tag_name)s"
 
2520
 
 
2521
    def __init__(self, tag_name):
 
2522
        self.tag_name = tag_name
 
2523
 
 
2524
 
 
2525
class TagsNotSupported(BzrError):
 
2526
 
 
2527
    _fmt = ("Tags not supported by %(branch)s;"
 
2528
            " you may be able to use bzr upgrade.")
 
2529
 
 
2530
    def __init__(self, branch):
 
2531
        self.branch = branch
 
2532
 
 
2533
 
 
2534
class TagAlreadyExists(BzrError):
 
2535
 
 
2536
    _fmt = "Tag %(tag_name)s already exists."
 
2537
 
 
2538
    def __init__(self, tag_name):
 
2539
        self.tag_name = tag_name
 
2540
 
 
2541
 
 
2542
class MalformedBugIdentifier(BzrError):
 
2543
 
 
2544
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2545
            'See "bzr help bugs" for more information on this feature.')
 
2546
 
 
2547
    def __init__(self, bug_id, reason):
 
2548
        self.bug_id = bug_id
 
2549
        self.reason = reason
 
2550
 
 
2551
 
 
2552
class InvalidBugTrackerURL(BzrError):
 
2553
 
 
2554
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2555
            "contain {id}: %(url)s")
 
2556
 
 
2557
    def __init__(self, abbreviation, url):
 
2558
        self.abbreviation = abbreviation
 
2559
        self.url = url
 
2560
 
 
2561
 
 
2562
class UnknownBugTrackerAbbreviation(BzrError):
 
2563
 
 
2564
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2565
            "on %(branch)s")
 
2566
 
 
2567
    def __init__(self, abbreviation, branch):
 
2568
        self.abbreviation = abbreviation
 
2569
        self.branch = branch
 
2570
 
 
2571
 
 
2572
class InvalidLineInBugsProperty(BzrError):
 
2573
 
 
2574
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2575
 
 
2576
    def __init__(self, line):
 
2577
        self.line = line
 
2578
 
 
2579
 
 
2580
class InvalidBugStatus(BzrError):
 
2581
 
 
2582
    _fmt = ("Invalid bug status: '%(status)s'")
 
2583
 
 
2584
    def __init__(self, status):
 
2585
        self.status = status
 
2586
 
 
2587
 
 
2588
class UnexpectedSmartServerResponse(BzrError):
 
2589
 
 
2590
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2591
 
 
2592
    def __init__(self, response_tuple):
 
2593
        self.response_tuple = response_tuple
 
2594
 
 
2595
 
 
2596
class ErrorFromSmartServer(BzrError):
 
2597
    """An error was received from a smart server.
 
2598
 
 
2599
    :seealso: UnknownErrorFromSmartServer
 
2600
    """
 
2601
 
 
2602
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2603
 
 
2604
    internal_error = True
 
2605
 
 
2606
    def __init__(self, error_tuple):
 
2607
        self.error_tuple = error_tuple
 
2608
        try:
 
2609
            self.error_verb = error_tuple[0]
 
2610
        except IndexError:
 
2611
            self.error_verb = None
 
2612
        self.error_args = error_tuple[1:]
 
2613
 
 
2614
 
 
2615
class UnknownErrorFromSmartServer(BzrError):
 
2616
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2617
    error.
 
2618
 
 
2619
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2620
    distinguish between the following two cases:
 
2621
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2622
        and so should provoke a traceback to the user.
 
2623
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2624
        translated.  This is probably because the server sent us garbage, and
 
2625
        should not provoke a traceback.
 
2626
    """
 
2627
 
 
2628
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2629
 
 
2630
    internal_error = False
 
2631
 
 
2632
    def __init__(self, error_from_smart_server):
 
2633
        """Constructor.
 
2634
 
 
2635
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2636
        """
 
2637
        self.error_from_smart_server = error_from_smart_server
 
2638
        self.error_tuple = error_from_smart_server.error_tuple
 
2639
 
 
2640
 
 
2641
class ContainerError(BzrError):
 
2642
    """Base class of container errors."""
 
2643
 
 
2644
 
 
2645
class UnknownContainerFormatError(ContainerError):
 
2646
 
 
2647
    _fmt = "Unrecognised container format: %(container_format)r"
 
2648
 
 
2649
    def __init__(self, container_format):
 
2650
        self.container_format = container_format
 
2651
 
 
2652
 
 
2653
class UnexpectedEndOfContainerError(ContainerError):
 
2654
 
 
2655
    _fmt = "Unexpected end of container stream"
 
2656
 
 
2657
 
 
2658
class UnknownRecordTypeError(ContainerError):
 
2659
 
 
2660
    _fmt = "Unknown record type: %(record_type)r"
 
2661
 
 
2662
    def __init__(self, record_type):
 
2663
        self.record_type = record_type
 
2664
 
 
2665
 
 
2666
class InvalidRecordError(ContainerError):
 
2667
 
 
2668
    _fmt = "Invalid record: %(reason)s"
 
2669
 
 
2670
    def __init__(self, reason):
 
2671
        self.reason = reason
 
2672
 
 
2673
 
 
2674
class ContainerHasExcessDataError(ContainerError):
 
2675
 
 
2676
    _fmt = "Container has data after end marker: %(excess)r"
 
2677
 
 
2678
    def __init__(self, excess):
 
2679
        self.excess = excess
 
2680
 
 
2681
 
 
2682
class DuplicateRecordNameError(ContainerError):
 
2683
 
 
2684
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2685
 
 
2686
    def __init__(self, name):
 
2687
        self.name = name
 
2688
 
 
2689
 
 
2690
class NoDestinationAddress(InternalBzrError):
 
2691
 
 
2692
    _fmt = "Message does not have a destination address."
 
2693
 
 
2694
 
 
2695
class RepositoryDataStreamError(BzrError):
 
2696
 
 
2697
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2698
 
 
2699
    def __init__(self, reason):
 
2700
        self.reason = reason
 
2701
 
 
2702
 
 
2703
class SMTPError(BzrError):
 
2704
 
 
2705
    _fmt = "SMTP error: %(error)s"
 
2706
 
 
2707
    def __init__(self, error):
 
2708
        self.error = error
 
2709
 
 
2710
 
 
2711
class NoMessageSupplied(BzrError):
 
2712
 
 
2713
    _fmt = "No message supplied."
 
2714
 
 
2715
 
 
2716
class NoMailAddressSpecified(BzrError):
 
2717
 
 
2718
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2719
 
 
2720
 
 
2721
class UnknownMailClient(BzrError):
 
2722
 
 
2723
    _fmt = "Unknown mail client: %(mail_client)s"
 
2724
 
 
2725
    def __init__(self, mail_client):
 
2726
        BzrError.__init__(self, mail_client=mail_client)
 
2727
 
 
2728
 
 
2729
class MailClientNotFound(BzrError):
 
2730
 
 
2731
    _fmt = "Unable to find mail client with the following names:"\
 
2732
        " %(mail_command_list_string)s"
 
2733
 
 
2734
    def __init__(self, mail_command_list):
 
2735
        mail_command_list_string = ', '.join(mail_command_list)
 
2736
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2737
                          mail_command_list_string=mail_command_list_string)
 
2738
 
 
2739
class SMTPConnectionRefused(SMTPError):
 
2740
 
 
2741
    _fmt = "SMTP connection to %(host)s refused"
 
2742
 
 
2743
    def __init__(self, error, host):
 
2744
        self.error = error
 
2745
        self.host = host
 
2746
 
 
2747
 
 
2748
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2749
 
 
2750
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2751
 
 
2752
 
 
2753
class BzrDirError(BzrError):
 
2754
 
 
2755
    def __init__(self, bzrdir):
 
2756
        import bzrlib.urlutils as urlutils
 
2757
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2758
                                                    'ascii')
 
2759
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2760
 
 
2761
 
 
2762
class UnsyncedBranches(BzrDirError):
 
2763
 
 
2764
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2765
            " bzr help sync-for-reconfigure.")
 
2766
 
 
2767
    def __init__(self, bzrdir, target_branch):
 
2768
        BzrDirError.__init__(self, bzrdir)
 
2769
        import bzrlib.urlutils as urlutils
 
2770
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2771
                                                        'ascii')
 
2772
 
 
2773
 
 
2774
class AlreadyBranch(BzrDirError):
 
2775
 
 
2776
    _fmt = "'%(display_url)s' is already a branch."
 
2777
 
 
2778
 
 
2779
class AlreadyTree(BzrDirError):
 
2780
 
 
2781
    _fmt = "'%(display_url)s' is already a tree."
 
2782
 
 
2783
 
 
2784
class AlreadyCheckout(BzrDirError):
 
2785
 
 
2786
    _fmt = "'%(display_url)s' is already a checkout."
 
2787
 
 
2788
 
 
2789
class AlreadyLightweightCheckout(BzrDirError):
 
2790
 
 
2791
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2792
 
 
2793
 
 
2794
class AlreadyUsingShared(BzrDirError):
 
2795
 
 
2796
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2797
 
 
2798
 
 
2799
class AlreadyStandalone(BzrDirError):
 
2800
 
 
2801
    _fmt = "'%(display_url)s' is already standalone."
 
2802
 
 
2803
 
 
2804
class AlreadyWithTrees(BzrDirError):
 
2805
 
 
2806
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2807
            "working trees.")
 
2808
 
 
2809
 
 
2810
class AlreadyWithNoTrees(BzrDirError):
 
2811
 
 
2812
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2813
            "working trees.")
 
2814
 
 
2815
 
 
2816
class ReconfigurationNotSupported(BzrDirError):
 
2817
 
 
2818
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2819
 
 
2820
 
 
2821
class NoBindLocation(BzrDirError):
 
2822
 
 
2823
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2824
 
 
2825
 
 
2826
class UncommittedChanges(BzrError):
 
2827
 
 
2828
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2829
            ' (See bzr status).%(more)s')
 
2830
 
 
2831
    def __init__(self, tree, more=None):
 
2832
        if more is None:
 
2833
            more = ''
 
2834
        else:
 
2835
            more = ' ' + more
 
2836
        import bzrlib.urlutils as urlutils
 
2837
        display_url = urlutils.unescape_for_display(
 
2838
            tree.user_url, 'ascii')
 
2839
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2840
 
 
2841
 
 
2842
class MissingTemplateVariable(BzrError):
 
2843
 
 
2844
    _fmt = 'Variable {%(name)s} is not available.'
 
2845
 
 
2846
    def __init__(self, name):
 
2847
        self.name = name
 
2848
 
 
2849
 
 
2850
class NoTemplate(BzrError):
 
2851
 
 
2852
    _fmt = 'No template specified.'
 
2853
 
 
2854
 
 
2855
class UnableCreateSymlink(BzrError):
 
2856
 
 
2857
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2858
 
 
2859
    def __init__(self, path=None):
 
2860
        path_str = ''
 
2861
        if path:
 
2862
            try:
 
2863
                path_str = repr(str(path))
 
2864
            except UnicodeEncodeError:
 
2865
                path_str = repr(path)
 
2866
            path_str += ' '
 
2867
        self.path_str = path_str
 
2868
 
 
2869
 
 
2870
class UnsupportedTimezoneFormat(BzrError):
 
2871
 
 
2872
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2873
            'options are "utc", "original", "local".')
 
2874
 
 
2875
    def __init__(self, timezone):
 
2876
        self.timezone = timezone
 
2877
 
 
2878
 
 
2879
class CommandAvailableInPlugin(StandardError):
 
2880
 
 
2881
    internal_error = False
 
2882
 
 
2883
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2884
 
 
2885
        self.plugin_metadata = plugin_metadata
 
2886
        self.cmd_name = cmd_name
 
2887
        self.provider = provider
 
2888
 
 
2889
    def __str__(self):
 
2890
 
 
2891
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2892
                'However, the following official plugin provides this command: %s\n'
 
2893
                'You can install it by going to: %s'
 
2894
                % (self.cmd_name, self.plugin_metadata['name'],
 
2895
                    self.plugin_metadata['url']))
 
2896
 
 
2897
        return _fmt
 
2898
 
 
2899
 
 
2900
class NoPluginAvailable(BzrError):
 
2901
    pass
 
2902
 
 
2903
 
 
2904
class UnableEncodePath(BzrError):
 
2905
 
 
2906
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2907
            'user encoding %(user_encoding)s')
 
2908
 
 
2909
    def __init__(self, path, kind):
 
2910
        from bzrlib.osutils import get_user_encoding
 
2911
        self.path = path
 
2912
        self.kind = kind
 
2913
        self.user_encoding = osutils.get_user_encoding()
 
2914
 
 
2915
 
 
2916
class NoSuchAlias(BzrError):
 
2917
 
 
2918
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2919
 
 
2920
    def __init__(self, alias_name):
 
2921
        BzrError.__init__(self, alias_name=alias_name)
 
2922
 
 
2923
 
 
2924
class DirectoryLookupFailure(BzrError):
 
2925
    """Base type for lookup errors."""
 
2926
 
 
2927
    pass
 
2928
 
 
2929
 
 
2930
class InvalidLocationAlias(DirectoryLookupFailure):
 
2931
 
 
2932
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2933
 
 
2934
    def __init__(self, alias_name):
 
2935
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2936
 
 
2937
 
 
2938
class UnsetLocationAlias(DirectoryLookupFailure):
 
2939
 
 
2940
    _fmt = 'No %(alias_name)s location assigned.'
 
2941
 
 
2942
    def __init__(self, alias_name):
 
2943
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2944
 
 
2945
 
 
2946
class CannotBindAddress(BzrError):
 
2947
 
 
2948
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2949
 
 
2950
    def __init__(self, host, port, orig_error):
 
2951
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2952
        BzrError.__init__(self, host=host, port=port,
 
2953
            orig_error=repr(orig_error.args))
 
2954
 
 
2955
 
 
2956
class UnknownRules(BzrError):
 
2957
 
 
2958
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2959
 
 
2960
    def __init__(self, unknowns):
 
2961
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2962
 
 
2963
 
 
2964
class HookFailed(BzrError):
 
2965
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2966
    than TipChangeRejected.
 
2967
 
 
2968
    Note that this exception is no longer raised, and the import is only left
 
2969
    to be nice to code which might catch it in a plugin.
 
2970
    """
 
2971
 
 
2972
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2973
            "%(traceback_text)s%(exc_value)s")
 
2974
 
 
2975
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2976
        if warn:
 
2977
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2978
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2979
        import traceback
 
2980
        self.hook_stage = hook_stage
 
2981
        self.hook_name = hook_name
 
2982
        self.exc_info = exc_info
 
2983
        self.exc_type = exc_info[0]
 
2984
        self.exc_value = exc_info[1]
 
2985
        self.exc_tb = exc_info[2]
 
2986
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2987
 
 
2988
 
 
2989
class TipChangeRejected(BzrError):
 
2990
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2991
    explicitly abort a change to a branch tip.
 
2992
    """
 
2993
 
 
2994
    _fmt = u"Tip change rejected: %(msg)s"
 
2995
 
 
2996
    def __init__(self, msg):
 
2997
        self.msg = msg
 
2998
 
 
2999
 
 
3000
class ShelfCorrupt(BzrError):
 
3001
 
 
3002
    _fmt = "Shelf corrupt."
 
3003
 
 
3004
 
 
3005
class NoSuchShelfId(BzrError):
 
3006
 
 
3007
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3008
 
 
3009
    def __init__(self, shelf_id):
 
3010
        BzrError.__init__(self, shelf_id=shelf_id)
 
3011
 
 
3012
 
 
3013
class InvalidShelfId(BzrError):
 
3014
 
 
3015
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3016
 
 
3017
    def __init__(self, invalid_id):
 
3018
        BzrError.__init__(self, invalid_id=invalid_id)
 
3019
 
 
3020
 
 
3021
class JailBreak(BzrError):
 
3022
 
 
3023
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3024
 
 
3025
    def __init__(self, url):
 
3026
        BzrError.__init__(self, url=url)
 
3027
 
 
3028
 
 
3029
class UserAbort(BzrError):
 
3030
 
 
3031
    _fmt = 'The user aborted the operation.'
 
3032
 
 
3033
 
 
3034
class MustHaveWorkingTree(BzrError):
 
3035
 
 
3036
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3037
 
 
3038
    def __init__(self, format, url):
 
3039
        BzrError.__init__(self, format=format, url=url)
 
3040
 
 
3041
 
 
3042
class NoSuchView(BzrError):
 
3043
    """A view does not exist.
 
3044
    """
 
3045
 
 
3046
    _fmt = u"No such view: %(view_name)s."
 
3047
 
 
3048
    def __init__(self, view_name):
 
3049
        self.view_name = view_name
 
3050
 
 
3051
 
 
3052
class ViewsNotSupported(BzrError):
 
3053
    """Views are not supported by a tree format.
 
3054
    """
 
3055
 
 
3056
    _fmt = ("Views are not supported by %(tree)s;"
 
3057
            " use 'bzr upgrade' to change your tree to a later format.")
 
3058
 
 
3059
    def __init__(self, tree):
 
3060
        self.tree = tree
 
3061
 
 
3062
 
 
3063
class FileOutsideView(BzrError):
 
3064
 
 
3065
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3066
            '%(view_str)s')
 
3067
 
 
3068
    def __init__(self, file_name, view_files):
 
3069
        self.file_name = file_name
 
3070
        self.view_str = ", ".join(view_files)
 
3071
 
 
3072
 
 
3073
class UnresumableWriteGroup(BzrError):
 
3074
 
 
3075
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3076
            "%(write_groups)r: %(reason)s")
 
3077
 
 
3078
    internal_error = True
 
3079
 
 
3080
    def __init__(self, repository, write_groups, reason):
 
3081
        self.repository = repository
 
3082
        self.write_groups = write_groups
 
3083
        self.reason = reason
 
3084
 
 
3085
 
 
3086
class UnsuspendableWriteGroup(BzrError):
 
3087
 
 
3088
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3089
 
 
3090
    internal_error = True
 
3091
 
 
3092
    def __init__(self, repository):
 
3093
        self.repository = repository
 
3094
 
 
3095
 
 
3096
class LossyPushToSameVCS(BzrError):
 
3097
 
 
3098
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3099
            "%(target_branch)r that are in the same VCS.")
 
3100
 
 
3101
    internal_error = True
 
3102
 
 
3103
    def __init__(self, source_branch, target_branch):
 
3104
        self.source_branch = source_branch
 
3105
        self.target_branch = target_branch
 
3106
 
 
3107
 
 
3108
class NoRoundtrippingSupport(BzrError):
 
3109
 
 
3110
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3111
            "%(target_branch)r.")
 
3112
 
 
3113
    internal_error = True
 
3114
 
 
3115
    def __init__(self, source_branch, target_branch):
 
3116
        self.source_branch = source_branch
 
3117
        self.target_branch = target_branch
 
3118
 
 
3119
 
 
3120
class FileTimestampUnavailable(BzrError):
 
3121
 
 
3122
    _fmt = "The filestamp for %(path)s is not available."
 
3123
 
 
3124
    internal_error = True
 
3125
 
 
3126
    def __init__(self, path):
 
3127
        self.path = path
 
3128
 
 
3129
 
 
3130
class NoColocatedBranchSupport(BzrError):
 
3131
 
 
3132
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3133
 
 
3134
    def __init__(self, bzrdir):
 
3135
        self.bzrdir = bzrdir
 
3136