/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: Canonical.com Patch Queue Manager
  • Date: 2010-06-04 05:59:55 UTC
  • mfrom: (5279.1.1 lazy-import-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20100604055955-98pfcy1bn8oz7749
(spiv) Use lazy imports in bzrilb.merge to minimise the startup cost of
 plugins like news_merge. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

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