← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: INADA Naoki
  • Date: 2011-05-05 09:15:34 UTC
  • mto: (5830.3.3 i18n-msgfmt)
  • mto: This revision was merged to the branch mainline in revision 5873.
  • Revision ID: songofacandy@gmail.com-20110505091534-7sv835xpofwrmpt4
Add update-pot command to Makefile and tools/bzrgettext script that
extracts help text from bzr commands.

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