/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: mbp at sourcefrog
  • Date: 2007-01-11 08:08:21 UTC
  • mto: (2230.1.1 short-options)
  • mto: This revision was merged to the branch mainline in revision 2231.
  • Revision ID: mbp@sourcefrog.net-20070111080821-yz6m2b1byj72jg0y
Add a simple DeprecatedDict class

Show diffs side-by-side

added added

removed removed

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