← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
 
20
21
from bzrlib import (
21
22
    osutils,
22
23
    symbol_versioning,
23
 
    i18n,
24
 
    trace,
25
24
    )
26
 
from bzrlib.i18n import gettext
27
25
from bzrlib.patches import (
28
26
    MalformedHunkHeader,
29
27
    MalformedLine,
34
32
 
35
33
 
36
34
# TODO: is there any value in providing the .args field used by standard
37
 
# python exceptions?   A list of values with no names seems less useful
 
35
# python exceptions?   A list of values with no names seems less useful 
38
36
# to me.
39
37
 
40
 
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
41
39
# constructed to make sure it will succeed.  But that says nothing about
42
40
# exceptions that are never raised.
43
41
 
46
44
# 'unprintable'.
47
45
 
48
46
 
49
 
# return codes from the bzr program
50
 
EXIT_OK = 0
51
 
EXIT_ERROR = 3
52
 
EXIT_INTERNAL_ERROR = 4
53
 
 
54
 
 
55
47
class BzrError(StandardError):
56
48
    """
57
49
    Base class for errors raised by bzrlib.
58
50
 
59
 
    :cvar internal_error: if True this was probably caused by a bzr bug and
60
 
        should be displayed with a traceback; if False (or absent) this was
61
 
        probably a user or environment error and they don't need the gory
62
 
        details.  (That can be overridden by -Derror on the command line.)
 
51
    :cvar internal_error: if true (or absent) this was probably caused by a
 
52
    bzr bug and should be displayed with a traceback; if False this was
 
53
    probably a user or environment error and they don't need the gory details.
 
54
    (That can be overridden by -Derror on the command line.)
63
55
 
64
56
    :cvar _fmt: Format string to display the error; this is expanded
65
 
        by the instance's dict.
 
57
    by the instance's dict.
66
58
    """
67
 
 
 
59
    
68
60
    internal_error = False
69
61
 
70
62
    def __init__(self, msg=None, **kwds):
75
67
        arguments can be given.  The first is for generic "user" errors which
76
68
        are not intended to be caught and so do not need a specific subclass.
77
69
        The second case is for use with subclasses that provide a _fmt format
78
 
        string to print the arguments.
 
70
        string to print the arguments.  
79
71
 
80
 
        Keyword arguments are taken as parameters to the error, which can
81
 
        be inserted into the format string template.  It's recommended
82
 
        that subclasses override the __init__ method to require specific
 
72
        Keyword arguments are taken as parameters to the error, which can 
 
73
        be inserted into the format string template.  It's recommended 
 
74
        that subclasses override the __init__ method to require specific 
83
75
        parameters.
84
76
 
85
77
        :param msg: If given, this is the literal complete text for the error,
86
 
           not subject to expansion. 'msg' is used instead of 'message' because
87
 
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        not subject to expansion.
88
79
        """
89
80
        StandardError.__init__(self)
90
81
        if msg is not None:
96
87
            for key, value in kwds.items():
97
88
                setattr(self, key, value)
98
89
 
99
 
    def _format(self):
 
90
    def __str__(self):
100
91
        s = getattr(self, '_preformatted_string', None)
101
92
        if s is not None:
102
 
            # contains a preformatted message
103
 
            return s
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
104
95
        try:
105
96
            fmt = self._get_format_string()
106
97
            if fmt:
107
 
                d = dict(self.__dict__)
108
 
                s = fmt % d
 
98
                s = fmt % self.__dict__
109
99
                # __str__() should always return a 'str' object
110
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
111
103
                return s
112
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
113
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
114
106
                % (self.__class__.__name__,
115
107
                   self.__dict__,
116
108
                   getattr(self, '_fmt', None),
117
 
                   e)
118
 
 
119
 
    def __unicode__(self):
120
 
        u = self._format()
121
 
        if isinstance(u, str):
122
 
            # Try decoding the str using the default encoding.
123
 
            u = unicode(u)
124
 
        elif not isinstance(u, unicode):
125
 
            # Try to make a unicode object from it, because __unicode__ must
126
 
            # return a unicode object.
127
 
            u = unicode(u)
128
 
        return u
129
 
 
130
 
    def __str__(self):
131
 
        s = self._format()
132
 
        if isinstance(s, unicode):
133
 
            s = s.encode('utf8')
134
 
        else:
135
 
            # __str__ must return a str.
136
 
            s = str(s)
137
 
        return s
138
 
 
139
 
    def __repr__(self):
140
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
109
                   str(e))
141
110
 
142
111
    def _get_format_string(self):
143
112
        """Return format string for this exception or None"""
144
113
        fmt = getattr(self, '_fmt', None)
145
114
        if fmt is not None:
146
 
            i18n.install()
147
 
            unicode_fmt = unicode(fmt) #_fmt strings should be ascii
148
 
            if type(fmt) == unicode:
149
 
                trace.mutter("Unicode strings in error.fmt are deprecated")
150
 
            return gettext(unicode_fmt)
 
115
            return fmt
151
116
        fmt = getattr(self, '__doc__', None)
152
117
        if fmt is not None:
153
118
            symbol_versioning.warn("%s uses its docstring as a format, "
160
125
               getattr(self, '_fmt', None),
161
126
               )
162
127
 
163
 
    def __eq__(self, other):
164
 
        if self.__class__ is not other.__class__:
165
 
            return NotImplemented
166
 
        return self.__dict__ == other.__dict__
167
 
 
168
 
 
169
 
class InternalBzrError(BzrError):
170
 
    """Base class for errors that are internal in nature.
171
 
 
172
 
    This is a convenience class for errors that are internal. The
173
 
    internal_error attribute can still be altered in subclasses, if needed.
174
 
    Using this class is simply an easy way to get internal errors.
175
 
    """
176
 
 
177
 
    internal_error = True
178
 
 
179
128
 
180
129
class BzrNewError(BzrError):
181
130
    """Deprecated error base class."""
205
154
                return s.encode('utf8')
206
155
            return s
207
156
        except (TypeError, NameError, ValueError, KeyError), e:
208
 
            return 'Unprintable exception %s(%r): %r' \
 
157
            return 'Unprintable exception %s(%r): %s' \
209
158
                % (self.__class__.__name__,
210
 
                   self.__dict__, e)
 
159
                   self.__dict__, str(e))
211
160
 
212
161
 
213
162
class AlreadyBuilding(BzrError):
214
 
 
 
163
    
215
164
    _fmt = "The tree builder is already building a tree."
216
165
 
217
166
 
218
 
class BranchError(BzrError):
219
 
    """Base class for concrete 'errors about a branch'."""
220
 
 
221
 
    def __init__(self, branch):
222
 
        BzrError.__init__(self, branch=branch)
223
 
 
224
 
 
225
 
class BzrCheckError(InternalBzrError):
226
 
 
227
 
    _fmt = "Internal check failed: %(msg)s"
228
 
 
229
 
    def __init__(self, msg):
230
 
        BzrError.__init__(self)
231
 
        self.msg = msg
232
 
 
233
 
 
234
 
class DirstateCorrupt(BzrError):
235
 
 
236
 
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
237
 
 
238
 
    def __init__(self, state, msg):
239
 
        BzrError.__init__(self)
240
 
        self.state = state
241
 
        self.msg = msg
242
 
 
243
 
 
244
 
class DisabledMethod(InternalBzrError):
 
167
class BzrCheckError(BzrError):
 
168
    
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class DisabledMethod(BzrError):
245
179
 
246
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
247
181
 
 
182
    internal_error = True
 
183
 
248
184
    def __init__(self, class_name):
249
185
        BzrError.__init__(self)
250
186
        self.class_name = class_name
251
187
 
252
188
 
253
 
class IncompatibleAPI(BzrError):
254
 
 
255
 
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
256
 
        'It supports versions "%(minimum)s" to "%(current)s".'
257
 
 
258
 
    def __init__(self, api, wanted, minimum, current):
259
 
        self.api = api
260
 
        self.wanted = wanted
261
 
        self.minimum = minimum
262
 
        self.current = current
263
 
 
264
 
 
265
 
class InProcessTransport(BzrError):
266
 
 
267
 
    _fmt = "The transport '%(transport)s' is only accessible within this " \
268
 
        "process."
269
 
 
270
 
    def __init__(self, transport):
271
 
        self.transport = transport
272
 
 
273
 
 
274
 
class InvalidEntryName(InternalBzrError):
275
 
 
 
189
class InvalidEntryName(BzrError):
 
190
    
276
191
    _fmt = "Invalid entry name: %(name)s"
277
192
 
 
193
    internal_error = True
 
194
 
278
195
    def __init__(self, name):
279
196
        BzrError.__init__(self)
280
197
        self.name = name
281
198
 
282
199
 
283
200
class InvalidRevisionNumber(BzrError):
284
 
 
 
201
    
285
202
    _fmt = "Invalid revision number %(revno)s"
286
203
 
287
204
    def __init__(self, revno):
299
216
        self.revision_id = revision_id
300
217
        self.branch = branch
301
218
 
302
 
 
303
219
class ReservedId(BzrError):
304
220
 
305
221
    _fmt = "Reserved revision-id {%(revision_id)s}"
307
223
    def __init__(self, revision_id):
308
224
        self.revision_id = revision_id
309
225
 
310
 
 
311
 
class RootMissing(InternalBzrError):
312
 
 
313
 
    _fmt = ("The root entry of a tree must be the first entry supplied to "
314
 
        "the commit builder.")
315
 
 
316
 
 
317
 
class NoPublicBranch(BzrError):
318
 
 
319
 
    _fmt = 'There is no public branch set for "%(branch_url)s".'
320
 
 
321
 
    def __init__(self, branch):
322
 
        import bzrlib.urlutils as urlutils
323
 
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
324
 
        BzrError.__init__(self, branch_url=public_location)
325
 
 
326
 
 
327
 
class NoHelpTopic(BzrError):
328
 
 
329
 
    _fmt = ("No help could be found for '%(topic)s'. "
330
 
        "Please use 'bzr help topics' to obtain a list of topics.")
331
 
 
332
 
    def __init__(self, topic):
333
 
        self.topic = topic
334
 
 
335
 
 
336
226
class NoSuchId(BzrError):
337
227
 
338
 
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
339
 
 
 
228
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
229
    
340
230
    def __init__(self, tree, file_id):
341
231
        BzrError.__init__(self)
342
232
        self.file_id = file_id
343
233
        self.tree = tree
344
234
 
345
235
 
346
 
class NoSuchIdInRepository(NoSuchId):
347
 
 
348
 
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
349
 
            ' %(repository)r')
350
 
 
351
 
    def __init__(self, repository, file_id):
352
 
        BzrError.__init__(self, repository=repository, file_id=file_id)
353
 
 
354
 
 
355
 
class NotStacked(BranchError):
356
 
 
357
 
    _fmt = "The branch '%(branch)s' is not stacked."
358
 
 
359
 
 
360
 
class InventoryModified(InternalBzrError):
 
236
class InventoryModified(BzrError):
361
237
 
362
238
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
363
239
            " so a clean inventory cannot be read without data loss.")
364
240
 
 
241
    internal_error = True
 
242
 
365
243
    def __init__(self, tree):
366
244
        self.tree = tree
367
245
 
368
246
 
369
247
class NoWorkingTree(BzrError):
370
248
 
371
 
    _fmt = 'No WorkingTree exists for "%(base)s".'
372
 
 
 
249
    _fmt = "No WorkingTree exists for %(base)s."
 
250
    
373
251
    def __init__(self, base):
374
252
        BzrError.__init__(self)
375
253
        self.base = base
388
266
        self.url = url
389
267
 
390
268
 
391
 
class WorkingTreeAlreadyPopulated(InternalBzrError):
392
 
 
393
 
    _fmt = 'Working tree already populated in "%(base)s"'
 
269
class WorkingTreeAlreadyPopulated(BzrError):
 
270
 
 
271
    _fmt = """Working tree already populated in %(base)s"""
 
272
 
 
273
    internal_error = True
394
274
 
395
275
    def __init__(self, base):
396
276
        self.base = base
397
277
 
398
 
 
399
278
class BzrCommandError(BzrError):
400
279
    """Error from user command"""
401
280
 
 
281
    internal_error = False
 
282
 
402
283
    # Error from malformed user command; please avoid raising this as a
403
284
    # generic exception not caused by user input.
404
285
    #
406
287
    # are not intended to be caught anyway.  UI code need not subclass
407
288
    # BzrCommandError, and non-UI code should not throw a subclass of
408
289
    # BzrCommandError.  ADHB 20051211
 
290
    def __init__(self, msg):
 
291
        # Object.__str__() must return a real string
 
292
        # returning a Unicode string is a python error.
 
293
        if isinstance(msg, unicode):
 
294
            self.msg = msg.encode('utf8')
 
295
        else:
 
296
            self.msg = msg
 
297
 
 
298
    def __str__(self):
 
299
        return self.msg
409
300
 
410
301
 
411
302
class NotWriteLocked(BzrError):
421
312
    _fmt = "Error in command line options"
422
313
 
423
314
 
424
 
class BadIndexFormatSignature(BzrError):
425
 
 
426
 
    _fmt = "%(value)s is not an index of type %(_type)s."
427
 
 
428
 
    def __init__(self, value, _type):
429
 
        BzrError.__init__(self)
430
 
        self.value = value
431
 
        self._type = _type
432
 
 
433
 
 
434
 
class BadIndexData(BzrError):
435
 
 
436
 
    _fmt = "Error in data for index %(value)s."
437
 
 
438
 
    def __init__(self, value):
439
 
        BzrError.__init__(self)
440
 
        self.value = value
441
 
 
442
 
 
443
 
class BadIndexDuplicateKey(BzrError):
444
 
 
445
 
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
446
 
 
447
 
    def __init__(self, key, index):
448
 
        BzrError.__init__(self)
449
 
        self.key = key
450
 
        self.index = index
451
 
 
452
 
 
453
 
class BadIndexKey(BzrError):
454
 
 
455
 
    _fmt = "The key '%(key)s' is not a valid key."
456
 
 
457
 
    def __init__(self, key):
458
 
        BzrError.__init__(self)
459
 
        self.key = key
460
 
 
461
 
 
462
 
class BadIndexOptions(BzrError):
463
 
 
464
 
    _fmt = "Could not parse options for index %(value)s."
465
 
 
466
 
    def __init__(self, value):
467
 
        BzrError.__init__(self)
468
 
        self.value = value
469
 
 
470
 
 
471
 
class BadIndexValue(BzrError):
472
 
 
473
 
    _fmt = "The value '%(value)s' is not a valid value."
474
 
 
475
 
    def __init__(self, value):
476
 
        BzrError.__init__(self)
477
 
        self.value = value
478
 
 
479
 
 
480
315
class BadOptionValue(BzrError):
481
316
 
482
317
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
484
319
    def __init__(self, name, value):
485
320
        BzrError.__init__(self, name=name, value=value)
486
321
 
487
 
 
 
322
    
488
323
class StrictCommitFailed(BzrError):
489
324
 
490
325
    _fmt = "Commit refused because there are unknown files in the tree"
492
327
 
493
328
# XXX: Should be unified with TransportError; they seem to represent the
494
329
# same thing
495
 
# RBC 20060929: I think that unifiying with TransportError would be a mistake
496
 
# - this is finer than a TransportError - and more useful as such. It
497
 
# differentiates between 'transport has failed' and 'operation on a transport
498
 
# has failed.'
499
330
class PathError(BzrError):
500
 
 
 
331
    
501
332
    _fmt = "Generic path error: %(path)r%(extra)s)"
502
333
 
503
334
    def __init__(self, path, extra=None):
523
354
    """Used when renaming and both source and dest exist."""
524
355
 
525
356
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
526
 
            " (Use --after to tell bzr about a rename that has already"
527
 
            " happened)%(extra)s")
 
357
            "%(extra)s")
528
358
 
529
359
    def __init__(self, source, dest, extra=None):
530
360
        BzrError.__init__(self)
538
368
 
539
369
class NotADirectory(PathError):
540
370
 
541
 
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
371
    _fmt = "%(path)r is not a directory %(extra)s"
542
372
 
543
373
 
544
374
class NotInWorkingDirectory(PathError):
545
375
 
546
 
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
376
    _fmt = "%(path)r is not in the working directory %(extra)s"
547
377
 
548
378
 
549
379
class DirectoryNotEmpty(PathError):
550
380
 
551
 
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
552
 
 
553
 
 
554
 
class HardLinkNotSupported(PathError):
555
 
 
556
 
    _fmt = 'Hard-linking "%(path)s" is not supported'
557
 
 
558
 
 
559
 
class ReadingCompleted(InternalBzrError):
560
 
 
 
381
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
382
 
 
383
 
 
384
class ReadingCompleted(BzrError):
 
385
    
561
386
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
562
387
            "called upon it - the request has been completed and no more "
563
388
            "data may be read.")
564
389
 
 
390
    internal_error = True
 
391
 
565
392
    def __init__(self, request):
566
393
        self.request = request
567
394
 
568
395
 
569
396
class ResourceBusy(PathError):
570
397
 
571
 
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
398
    _fmt = "Device or resource busy: %(path)r%(extra)s"
572
399
 
573
400
 
574
401
class PermissionDenied(PathError):
575
402
 
576
 
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
403
    _fmt = "Permission denied: %(path)r%(extra)s"
577
404
 
578
405
 
579
406
class InvalidURL(PathError):
580
407
 
581
 
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
408
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
582
409
 
583
410
 
584
411
class InvalidURLJoin(PathError):
585
412
 
586
 
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
587
 
 
588
 
    def __init__(self, reason, base, join_args):
589
 
        self.reason = reason
590
 
        self.base = base
591
 
        self.join_args = join_args
592
 
        PathError.__init__(self, base, reason)
593
 
 
594
 
 
595
 
class InvalidRebaseURLs(PathError):
596
 
 
597
 
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
598
 
 
599
 
    def __init__(self, from_, to):
600
 
        self.from_ = from_
601
 
        self.to = to
602
 
        PathError.__init__(self, from_, 'URLs differ by more than path.')
603
 
 
604
 
 
605
 
class UnavailableRepresentation(InternalBzrError):
606
 
 
607
 
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
608
 
        "is encoded as '%(native)s'.")
609
 
 
610
 
    def __init__(self, key, wanted, native):
611
 
        InternalBzrError.__init__(self)
612
 
        self.wanted = wanted
613
 
        self.native = native
614
 
        self.key = key
 
413
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
414
 
 
415
    def __init__(self, msg, base, args):
 
416
        PathError.__init__(self, base, msg)
 
417
        self.args = [base] + list(args)
615
418
 
616
419
 
617
420
class UnknownHook(BzrError):
628
431
 
629
432
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
630
433
 
631
 
    def __init__(self, url, extra=""):
 
434
    def __init__(self, url, extra):
632
435
        PathError.__init__(self, url, extra=extra)
633
436
 
634
437
 
635
 
class UnstackableBranchFormat(BzrError):
636
 
 
637
 
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
638
 
        "You will need to upgrade the branch to permit branch stacking.")
639
 
 
640
 
    def __init__(self, format, url):
641
 
        BzrError.__init__(self)
642
 
        self.format = format
643
 
        self.url = url
644
 
 
645
 
 
646
 
class UnstackableLocationError(BzrError):
647
 
 
648
 
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
649
 
 
650
 
    def __init__(self, branch_url, target_url):
651
 
        BzrError.__init__(self)
652
 
        self.branch_url = branch_url
653
 
        self.target_url = target_url
654
 
 
655
 
 
656
 
class UnstackableRepositoryFormat(BzrError):
657
 
 
658
 
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
659
 
        "You will need to upgrade the repository to permit branch stacking.")
660
 
 
661
 
    def __init__(self, format, url):
662
 
        BzrError.__init__(self)
663
 
        self.format = format
664
 
        self.url = url
665
 
 
666
 
 
667
 
class ReadError(PathError):
668
 
 
669
 
    _fmt = """Error reading from %(path)r."""
670
 
 
671
 
 
672
438
class ShortReadvError(PathError):
673
439
 
674
 
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
675
 
            ' at %(offset)s for "%(path)s"%(extra)s')
 
440
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
441
            " at %(offset)s for %(path)s%(extra)s")
676
442
 
677
443
    internal_error = True
678
444
 
683
449
        self.actual = actual
684
450
 
685
451
 
686
 
class PathNotChild(PathError):
687
 
 
688
 
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
689
 
 
690
 
    internal_error = False
 
452
class PathNotChild(BzrError):
 
453
 
 
454
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
455
 
 
456
    internal_error = True
691
457
 
692
458
    def __init__(self, path, base, extra=None):
693
459
        BzrError.__init__(self)
701
467
 
702
468
class InvalidNormalization(PathError):
703
469
 
704
 
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
470
    _fmt = "Path %(path)r is not unicode normalized"
705
471
 
706
472
 
707
473
# TODO: This is given a URL; we try to unescape it but doing that from inside
708
474
# the exception object is a bit undesirable.
709
 
# TODO: Probably this behavior of should be a common superclass
 
475
# TODO: Probably this behavior of should be a common superclass 
710
476
class NotBranchError(PathError):
711
477
 
712
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
478
    _fmt = "Not a branch: %(path)s"
713
479
 
714
 
    def __init__(self, path, detail=None, bzrdir=None):
 
480
    def __init__(self, path):
715
481
       import bzrlib.urlutils as urlutils
716
 
       path = urlutils.unescape_for_display(path, 'ascii')
717
 
       if detail is not None:
718
 
           detail = ': ' + detail
719
 
       self.detail = detail
720
 
       self.bzrdir = bzrdir
721
 
       PathError.__init__(self, path=path)
722
 
 
723
 
    def __repr__(self):
724
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
725
 
 
726
 
    def _format(self):
727
 
        # XXX: Ideally self.detail would be a property, but Exceptions in
728
 
        # Python 2.4 have to be old-style classes so properties don't work.
729
 
        # Instead we override _format.
730
 
        if self.detail is None:
731
 
            if self.bzrdir is not None:
732
 
                try:
733
 
                    self.bzrdir.open_repository()
734
 
                except NoRepositoryPresent:
735
 
                    self.detail = ''
736
 
                except Exception:
737
 
                    # Just ignore unexpected errors.  Raising arbitrary errors
738
 
                    # during str(err) can provoke strange bugs.  Concretely
739
 
                    # Launchpad's codehosting managed to raise NotBranchError
740
 
                    # here, and then get stuck in an infinite loop/recursion
741
 
                    # trying to str() that error.  All this error really cares
742
 
                    # about that there's no working repository there, and if
743
 
                    # open_repository() fails, there probably isn't.
744
 
                    self.detail = ''
745
 
                else:
746
 
                    self.detail = ': location is a repository'
747
 
            else:
748
 
                self.detail = ''
749
 
        return PathError._format(self)
 
482
       self.path = urlutils.unescape_for_display(path, 'ascii')
750
483
 
751
484
 
752
485
class NoSubmitBranch(PathError):
760
493
 
761
494
class AlreadyBranchError(PathError):
762
495
 
763
 
    _fmt = 'Already a branch: "%(path)s".'
 
496
    _fmt = "Already a branch: %(path)s."
764
497
 
765
498
 
766
499
class BranchExistsWithoutWorkingTree(PathError):
767
500
 
768
 
    _fmt = 'Directory contains a branch, but no working tree \
769
 
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
501
    _fmt = "Directory contains a branch, but no working tree \
 
502
(use bzr checkout if you wish to build a working tree): %(path)s"
770
503
 
771
504
 
772
505
class AtomicFileAlreadyClosed(PathError):
773
506
 
774
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
775
 
            ' "%(path)s"')
 
507
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
508
            " %(path)s")
776
509
 
777
510
    def __init__(self, path, function):
778
511
        PathError.__init__(self, path=path, extra=None)
781
514
 
782
515
class InaccessibleParent(PathError):
783
516
 
784
 
    _fmt = ('Parent not accessible given base "%(base)s" and'
785
 
            ' relative path "%(path)s"')
 
517
    _fmt = ("Parent not accessible given base %(base)s and"
 
518
            " relative path %(path)s")
786
519
 
787
520
    def __init__(self, path, base):
788
521
        PathError.__init__(self, path)
791
524
 
792
525
class NoRepositoryPresent(BzrError):
793
526
 
794
 
    _fmt = 'No repository present: "%(path)s"'
 
527
    _fmt = "No repository present: %(path)r"
795
528
    def __init__(self, bzrdir):
796
529
        BzrError.__init__(self)
797
530
        self.path = bzrdir.transport.clone('..').base
799
532
 
800
533
class FileInWrongBranch(BzrError):
801
534
 
802
 
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
535
    _fmt = "File %(path)s in not in branch %(branch_base)s."
803
536
 
804
 
    # use PathNotChild instead
805
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
806
537
    def __init__(self, branch, path):
807
538
        BzrError.__init__(self)
808
539
        self.branch = branch
816
547
 
817
548
 
818
549
class UnknownFormatError(BzrError):
819
 
 
820
 
    _fmt = "Unknown %(kind)s format: %(format)r"
821
 
 
822
 
    def __init__(self, format, kind='branch'):
823
 
        self.kind = kind
824
 
        self.format = format
 
550
    
 
551
    _fmt = "Unknown branch format: %(format)r"
825
552
 
826
553
 
827
554
class IncompatibleFormat(BzrError):
828
 
 
 
555
    
829
556
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
830
557
 
831
558
    def __init__(self, format, bzrdir_format):
835
562
 
836
563
 
837
564
class IncompatibleRepositories(BzrError):
838
 
    """Report an error that two repositories are not compatible.
839
 
 
840
 
    Note that the source and target repositories are permitted to be strings:
841
 
    this exception is thrown from the smart server and may refer to a
842
 
    repository the client hasn't opened.
843
 
    """
844
 
 
845
 
    _fmt = "%(target)s\n" \
846
 
            "is not compatible with\n" \
847
 
            "%(source)s\n" \
848
 
            "%(details)s"
849
 
 
850
 
    def __init__(self, source, target, details=None):
851
 
        if details is None:
852
 
            details = "(no details)"
853
 
        BzrError.__init__(self, target=target, source=source, details=details)
 
565
 
 
566
    _fmt = "Repository %(target)s is not compatible with repository"\
 
567
        " %(source)s"
 
568
 
 
569
    def __init__(self, source, target):
 
570
        BzrError.__init__(self, target=target, source=source)
854
571
 
855
572
 
856
573
class IncompatibleRevision(BzrError):
857
 
 
 
574
    
858
575
    _fmt = "Revision is not compatible with %(repo_format)s"
859
576
 
860
577
    def __init__(self, repo_format):
865
582
class AlreadyVersionedError(BzrError):
866
583
    """Used when a path is expected not to be versioned, but it is."""
867
584
 
868
 
    _fmt = "%(context_info)s%(path)s is already versioned."
 
585
    _fmt = "%(context_info)s%(path)s is already versioned"
869
586
 
870
587
    def __init__(self, path, context_info=None):
871
588
        """Construct a new AlreadyVersionedError.
872
589
 
873
590
        :param path: This is the path which is versioned,
874
 
            which should be in a user friendly form.
 
591
        which should be in a user friendly form.
875
592
        :param context_info: If given, this is information about the context,
876
 
            which could explain why this is expected to not be versioned.
 
593
        which could explain why this is expected to not be versioned.
877
594
        """
878
595
        BzrError.__init__(self)
879
596
        self.path = path
886
603
class NotVersionedError(BzrError):
887
604
    """Used when a path is expected to be versioned, but it is not."""
888
605
 
889
 
    _fmt = "%(context_info)s%(path)s is not versioned."
 
606
    _fmt = "%(context_info)s%(path)s is not versioned"
890
607
 
891
608
    def __init__(self, path, context_info=None):
892
609
        """Construct a new NotVersionedError.
893
610
 
894
611
        :param path: This is the path which is not versioned,
895
 
            which should be in a user friendly form.
 
612
        which should be in a user friendly form.
896
613
        :param context_info: If given, this is information about the context,
897
 
            which could explain why this is expected to be versioned.
 
614
        which could explain why this is expected to be versioned.
898
615
        """
899
616
        BzrError.__init__(self)
900
617
        self.path = path
943
660
        BzrError.__init__(self, filename=filename, kind=kind)
944
661
 
945
662
 
946
 
class BadFilenameEncoding(BzrError):
947
 
 
948
 
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
949
 
            ' encoding %(fs_encoding)s')
950
 
 
951
 
    def __init__(self, filename, fs_encoding):
952
 
        BzrError.__init__(self)
953
 
        self.filename = filename
954
 
        self.fs_encoding = fs_encoding
955
 
 
956
 
 
957
663
class ForbiddenControlFileError(BzrError):
958
664
 
959
 
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
960
 
 
961
 
 
962
 
class LockError(InternalBzrError):
 
665
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
666
 
 
667
 
 
668
class LockError(BzrError):
963
669
 
964
670
    _fmt = "Lock error: %(msg)s"
965
671
 
 
672
    internal_error = True
 
673
 
966
674
    # All exceptions from the lock/unlock functions should be from
967
675
    # this exception class.  They will be translated as necessary. The
968
676
    # original exception is available as e.original_error
969
677
    #
970
678
    # New code should prefer to raise specific subclasses
971
 
    def __init__(self, msg):
972
 
        self.msg = msg
 
679
    def __init__(self, message):
 
680
        # Python 2.5 uses a slot for StandardError.message,
 
681
        # so use a different variable name
 
682
        # so it is exposed in self.__dict__
 
683
        self.msg = message
973
684
 
974
685
 
975
686
class LockActive(LockError):
1009
720
        self.obj = obj
1010
721
 
1011
722
 
1012
 
class LockFailed(LockError):
1013
 
 
1014
 
    internal_error = False
1015
 
 
1016
 
    _fmt = "Cannot lock %(lock)s: %(why)s"
1017
 
 
1018
 
    def __init__(self, lock, why):
 
723
class ReadOnlyLockError(LockError):
 
724
 
 
725
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
726
 
 
727
    def __init__(self, fname, msg):
1019
728
        LockError.__init__(self, '')
1020
 
        self.lock = lock
1021
 
        self.why = why
 
729
        self.fname = fname
 
730
        self.msg = msg
1022
731
 
1023
732
 
1024
733
class OutSideTransaction(BzrError):
1048
757
 
1049
758
class UnlockableTransport(LockError):
1050
759
 
1051
 
    internal_error = False
1052
 
 
1053
760
    _fmt = "Cannot lock: transport is read only: %(transport)s"
1054
761
 
1055
762
    def __init__(self, transport):
1058
765
 
1059
766
class LockContention(LockError):
1060
767
 
1061
 
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
768
    _fmt = "Could not acquire lock %(lock)s"
 
769
    # TODO: show full url for lock, combining the transport and relative
 
770
    # bits?
1062
771
 
1063
772
    internal_error = False
1064
773
 
1065
 
    def __init__(self, lock, msg=''):
 
774
    def __init__(self, lock):
1066
775
        self.lock = lock
1067
 
        self.msg = msg
1068
776
 
1069
777
 
1070
778
class LockBroken(LockError):
1091
799
        self.target = target
1092
800
 
1093
801
 
1094
 
class LockCorrupt(LockError):
1095
 
 
1096
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1097
 
            "Use 'bzr break-lock' to clear it")
1098
 
 
1099
 
    internal_error = False
1100
 
 
1101
 
    def __init__(self, corruption_info, file_data=None):
1102
 
        self.corruption_info = corruption_info
1103
 
        self.file_data = file_data
1104
 
 
1105
 
 
1106
802
class LockNotHeld(LockError):
1107
803
 
1108
804
    _fmt = "Lock not held: %(lock)s"
1117
813
 
1118
814
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
1119
815
 
 
816
    internal_error = True
 
817
 
1120
818
    def __init__(self, obj):
1121
819
        self.obj = obj
1122
820
 
1137
835
    _fmt = "No changes to commit"
1138
836
 
1139
837
 
1140
 
class CannotCommitSelectedFileMerge(BzrError):
1141
 
 
1142
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
1143
 
        ' files %(files_str)s'
1144
 
 
1145
 
    def __init__(self, files):
1146
 
        files_str = ', '.join(files)
1147
 
        BzrError.__init__(self, files=files, files_str=files_str)
1148
 
 
1149
 
 
1150
 
class ExcludesUnsupported(BzrError):
1151
 
 
1152
 
    _fmt = ('Excluding paths during commit is not supported by '
1153
 
            'repository at %(repository)r.')
1154
 
 
1155
 
    def __init__(self, repository):
1156
 
        BzrError.__init__(self, repository=repository)
1157
 
 
1158
 
 
1159
 
class BadCommitMessageEncoding(BzrError):
1160
 
 
1161
 
    _fmt = 'The specified commit message contains characters unsupported by '\
1162
 
        'the current encoding.'
1163
 
 
1164
 
 
1165
838
class UpgradeReadonly(BzrError):
1166
839
 
1167
840
    _fmt = "Upgrade URL cannot work with readonly URLs."
1181
854
    _fmt = "Commit refused because there are unknowns in the tree."
1182
855
 
1183
856
 
1184
 
class NoSuchRevision(InternalBzrError):
1185
 
 
1186
 
    _fmt = "%(branch)s has no revision %(revision)s"
 
857
class NoSuchRevision(BzrError):
 
858
 
 
859
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
860
 
 
861
    internal_error = True
1187
862
 
1188
863
    def __init__(self, branch, revision):
1189
 
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
1190
864
        BzrError.__init__(self, branch=branch, revision=revision)
1191
865
 
1192
866
 
1193
 
class RangeInChangeOption(BzrError):
1194
 
 
1195
 
    _fmt = "Option --change does not accept revision ranges"
 
867
class NotLeftParentDescendant(BzrError):
 
868
 
 
869
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
870
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
871
 
 
872
    internal_error = True
 
873
 
 
874
    def __init__(self, branch, old_revision, new_revision):
 
875
        BzrError.__init__(self, branch_location=branch.base,
 
876
                          old_revision=old_revision,
 
877
                          new_revision=new_revision)
1196
878
 
1197
879
 
1198
880
class NoSuchRevisionSpec(BzrError):
1205
887
 
1206
888
class NoSuchRevisionInTree(NoSuchRevision):
1207
889
    """When using Tree.revision_tree, and the revision is not accessible."""
1208
 
 
1209
 
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
890
    
 
891
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
1210
892
 
1211
893
    def __init__(self, tree, revision_id):
1212
894
        BzrError.__init__(self)
1216
898
 
1217
899
class InvalidRevisionSpec(BzrError):
1218
900
 
1219
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1220
 
            " %(branch_url)s%(extra)s")
 
901
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
902
            " %(branch)s%(extra)s")
1221
903
 
1222
904
    def __init__(self, spec, branch, extra=None):
1223
905
        BzrError.__init__(self, branch=branch, spec=spec)
1224
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
1225
906
        if extra:
1226
907
            self.extra = '\n' + str(extra)
1227
908
        else:
1248
929
class DivergedBranches(BzrError):
1249
930
 
1250
931
    _fmt = ("These branches have diverged."
1251
 
            " Use the missing command to see how.\n"
1252
 
            "Use the merge command to reconcile them.")
 
932
            " Use the merge command to reconcile them.")
 
933
 
 
934
    internal_error = False
1253
935
 
1254
936
    def __init__(self, branch1, branch2):
1255
937
        self.branch1 = branch1
1256
938
        self.branch2 = branch2
1257
939
 
1258
940
 
1259
 
class NotLefthandHistory(InternalBzrError):
 
941
class NotLefthandHistory(BzrError):
1260
942
 
1261
943
    _fmt = "Supplied history does not follow left-hand parents"
1262
944
 
 
945
    internal_error = True
 
946
 
1263
947
    def __init__(self, history):
1264
948
        BzrError.__init__(self, history=history)
1265
949
 
1269
953
    _fmt = ("Branches have no common ancestor, and"
1270
954
            " no merge base revision was specified.")
1271
955
 
1272
 
 
1273
 
class CannotReverseCherrypick(BzrError):
1274
 
 
1275
 
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
1276
 
            ' or diff3.')
 
956
    internal_error = False
1277
957
 
1278
958
 
1279
959
class NoCommonAncestor(BzrError):
1280
 
 
 
960
    
1281
961
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
1282
962
 
1283
963
    def __init__(self, revision_a, revision_b):
1303
983
            not_ancestor_id=not_ancestor_id)
1304
984
 
1305
985
 
 
986
class InstallFailed(BzrError):
 
987
 
 
988
    def __init__(self, revisions):
 
989
        revision_str = ", ".join(str(r) for r in revisions)
 
990
        msg = "Could not install revisions:\n%s" % revision_str
 
991
        BzrError.__init__(self, msg)
 
992
        self.revisions = revisions
 
993
 
 
994
 
1306
995
class AmbiguousBase(BzrError):
1307
996
 
1308
997
    def __init__(self, bases):
1309
 
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1310
 
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
998
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
999
                DeprecationWarning)
1311
1000
        msg = ("The correct base is unclear, because %s are all equally close"
1312
1001
                % ", ".join(bases))
1313
1002
        BzrError.__init__(self, msg)
1314
1003
        self.bases = bases
1315
1004
 
1316
1005
 
1317
 
class NoCommits(BranchError):
 
1006
class NoCommits(BzrError):
1318
1007
 
1319
1008
    _fmt = "Branch %(branch)s has no commits."
1320
1009
 
 
1010
    def __init__(self, branch):
 
1011
        BzrError.__init__(self, branch=branch)
 
1012
 
1321
1013
 
1322
1014
class UnlistableStore(BzrError):
1323
1015
 
1334
1026
 
1335
1027
class BoundBranchOutOfDate(BzrError):
1336
1028
 
1337
 
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1338
 
            " %(master)s.%(extra_help)s")
 
1029
    _fmt = ("Bound branch %(branch)s is out of date"
 
1030
            " with master branch %(master)s.")
1339
1031
 
1340
1032
    def __init__(self, branch, master):
1341
1033
        BzrError.__init__(self)
1342
1034
        self.branch = branch
1343
1035
        self.master = master
1344
 
        self.extra_help = ''
1345
 
 
1346
 
 
 
1036
 
 
1037
        
1347
1038
class CommitToDoubleBoundBranch(BzrError):
1348
1039
 
1349
1040
    _fmt = ("Cannot commit to branch %(branch)s."
1379
1070
 
1380
1071
class WeaveError(BzrError):
1381
1072
 
1382
 
    _fmt = "Error in processing weave: %(msg)s"
 
1073
    _fmt = "Error in processing weave: %(message)s"
1383
1074
 
1384
 
    def __init__(self, msg=None):
 
1075
    def __init__(self, message=None):
1385
1076
        BzrError.__init__(self)
1386
 
        self.msg = msg
 
1077
        self.message = message
1387
1078
 
1388
1079
 
1389
1080
class WeaveRevisionAlreadyPresent(WeaveError):
1418
1109
 
1419
1110
class WeaveParentMismatch(WeaveError):
1420
1111
 
1421
 
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1422
 
 
 
1112
    _fmt = "Parents are mismatched between two revisions."
 
1113
    
1423
1114
 
1424
1115
class WeaveInvalidChecksum(WeaveError):
1425
1116
 
1426
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1117
    _fmt = "Text did not match it's checksum: %(message)s"
1427
1118
 
1428
1119
 
1429
1120
class WeaveTextDiffers(WeaveError):
1451
1142
 
1452
1143
 
1453
1144
class VersionedFileError(BzrError):
1454
 
 
 
1145
    
1455
1146
    _fmt = "Versioned file error"
1456
1147
 
1457
1148
 
1458
1149
class RevisionNotPresent(VersionedFileError):
1459
 
 
1460
 
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1150
    
 
1151
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
1461
1152
 
1462
1153
    def __init__(self, revision_id, file_id):
1463
1154
        VersionedFileError.__init__(self)
1466
1157
 
1467
1158
 
1468
1159
class RevisionAlreadyPresent(VersionedFileError):
1469
 
 
1470
 
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1160
    
 
1161
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
1471
1162
 
1472
1163
    def __init__(self, revision_id, file_id):
1473
1164
        VersionedFileError.__init__(self)
1475
1166
        self.file_id = file_id
1476
1167
 
1477
1168
 
1478
 
class VersionedFileInvalidChecksum(VersionedFileError):
1479
 
 
1480
 
    _fmt = "Text did not match its checksum: %(msg)s"
1481
 
 
1482
 
 
1483
 
class KnitError(InternalBzrError):
1484
 
 
 
1169
class KnitError(BzrError):
 
1170
    
1485
1171
    _fmt = "Knit error"
1486
1172
 
 
1173
    internal_error = True
 
1174
 
 
1175
 
 
1176
class KnitHeaderError(KnitError):
 
1177
 
 
1178
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1179
 
 
1180
    def __init__(self, badline, filename):
 
1181
        KnitError.__init__(self)
 
1182
        self.badline = badline
 
1183
        self.filename = filename
 
1184
 
1487
1185
 
1488
1186
class KnitCorrupt(KnitError):
1489
1187
 
1495
1193
        self.how = how
1496
1194
 
1497
1195
 
1498
 
class SHA1KnitCorrupt(KnitCorrupt):
1499
 
 
1500
 
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1501
 
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
1502
 
        "sha %(actual)s")
1503
 
 
1504
 
    def __init__(self, filename, actual, expected, key, content):
1505
 
        KnitError.__init__(self)
1506
 
        self.filename = filename
1507
 
        self.actual = actual
1508
 
        self.expected = expected
1509
 
        self.key = key
1510
 
        self.content = content
1511
 
 
1512
 
 
1513
 
class KnitDataStreamIncompatible(KnitError):
1514
 
    # Not raised anymore, as we can convert data streams.  In future we may
1515
 
    # need it again for more exotic cases, so we're keeping it around for now.
1516
 
 
1517
 
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
1518
 
 
1519
 
    def __init__(self, stream_format, target_format):
1520
 
        self.stream_format = stream_format
1521
 
        self.target_format = target_format
1522
 
 
1523
 
 
1524
 
class KnitDataStreamUnknown(KnitError):
1525
 
    # Indicates a data stream we don't know how to handle.
1526
 
 
1527
 
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
1528
 
 
1529
 
    def __init__(self, stream_format):
1530
 
        self.stream_format = stream_format
1531
 
 
1532
 
 
1533
 
class KnitHeaderError(KnitError):
1534
 
 
1535
 
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
1536
 
 
1537
 
    def __init__(self, badline, filename):
1538
 
        KnitError.__init__(self)
1539
 
        self.badline = badline
1540
 
        self.filename = filename
1541
 
 
1542
1196
class KnitIndexUnknownMethod(KnitError):
1543
1197
    """Raised when we don't understand the storage method.
1544
1198
 
1545
1199
    Currently only 'fulltext' and 'line-delta' are supported.
1546
1200
    """
1547
 
 
 
1201
    
1548
1202
    _fmt = ("Knit index %(filename)s does not have a known method"
1549
1203
            " in options: %(options)r")
1550
1204
 
1554
1208
        self.options = options
1555
1209
 
1556
1210
 
1557
 
class RetryWithNewPacks(BzrError):
1558
 
    """Raised when we realize that the packs on disk have changed.
1559
 
 
1560
 
    This is meant as more of a signaling exception, to trap between where a
1561
 
    local error occurred and the code that can actually handle the error and
1562
 
    code that can retry appropriately.
1563
 
    """
1564
 
 
1565
 
    internal_error = True
1566
 
 
1567
 
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1568
 
            " %(orig_error)s")
1569
 
 
1570
 
    def __init__(self, context, reload_occurred, exc_info):
1571
 
        """create a new RetryWithNewPacks error.
1572
 
 
1573
 
        :param reload_occurred: Set to True if we know that the packs have
1574
 
            already been reloaded, and we are failing because of an in-memory
1575
 
            cache miss. If set to True then we will ignore if a reload says
1576
 
            nothing has changed, because we assume it has already reloaded. If
1577
 
            False, then a reload with nothing changed will force an error.
1578
 
        :param exc_info: The original exception traceback, so if there is a
1579
 
            problem we can raise the original error (value from sys.exc_info())
1580
 
        """
1581
 
        BzrError.__init__(self)
1582
 
        self.reload_occurred = reload_occurred
1583
 
        self.exc_info = exc_info
1584
 
        self.orig_error = exc_info[1]
1585
 
        # TODO: The global error handler should probably treat this by
1586
 
        #       raising/printing the original exception with a bit about
1587
 
        #       RetryWithNewPacks also not being caught
1588
 
 
1589
 
 
1590
 
class RetryAutopack(RetryWithNewPacks):
1591
 
    """Raised when we are autopacking and we find a missing file.
1592
 
 
1593
 
    Meant as a signaling exception, to tell the autopack code it should try
1594
 
    again.
1595
 
    """
1596
 
 
1597
 
    internal_error = True
1598
 
 
1599
 
    _fmt = ("Pack files have changed, reload and try autopack again."
1600
 
            " context: %(context)s %(orig_error)s")
1601
 
 
1602
 
 
1603
1211
class NoSuchExportFormat(BzrError):
1604
 
 
 
1212
    
1605
1213
    _fmt = "Export format %(format)r not supported"
1606
1214
 
1607
1215
    def __init__(self, format):
1610
1218
 
1611
1219
 
1612
1220
class TransportError(BzrError):
1613
 
 
 
1221
    
1614
1222
    _fmt = "Transport error: %(msg)s %(orig_error)s"
1615
1223
 
1616
1224
    def __init__(self, msg=None, orig_error=None):
1625
1233
        BzrError.__init__(self)
1626
1234
 
1627
1235
 
1628
 
class TooManyConcurrentRequests(InternalBzrError):
 
1236
class TooManyConcurrentRequests(BzrError):
1629
1237
 
1630
1238
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1631
1239
            " Be sure to finish_writing and finish_reading on the"
1632
 
            " currently open request.")
 
1240
            " current request that is open.")
 
1241
 
 
1242
    internal_error = True
1633
1243
 
1634
1244
    def __init__(self, medium):
1635
1245
        self.medium = medium
1643
1253
        self.details = details
1644
1254
 
1645
1255
 
1646
 
class UnexpectedProtocolVersionMarker(TransportError):
1647
 
 
1648
 
    _fmt = "Received bad protocol version marker: %(marker)r"
1649
 
 
1650
 
    def __init__(self, marker):
1651
 
        self.marker = marker
1652
 
 
1653
 
 
1654
 
class UnknownSmartMethod(InternalBzrError):
1655
 
 
1656
 
    _fmt = "The server does not recognise the '%(verb)s' request."
1657
 
 
1658
 
    def __init__(self, verb):
1659
 
        self.verb = verb
1660
 
 
1661
 
 
1662
 
class SmartMessageHandlerError(InternalBzrError):
1663
 
 
1664
 
    _fmt = ("The message handler raised an exception:\n"
1665
 
            "%(traceback_text)s")
1666
 
 
1667
 
    def __init__(self, exc_info):
1668
 
        import traceback
1669
 
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1670
 
        self.exc_info = exc_info
1671
 
        traceback_strings = traceback.format_exception(
1672
 
                self.exc_type, self.exc_value, self.exc_tb)
1673
 
        self.traceback_text = ''.join(traceback_strings)
1674
 
 
1675
 
 
1676
1256
# A set of semi-meaningful errors which can be thrown
1677
1257
class TransportNotPossible(TransportError):
1678
1258
 
1703
1283
            self.port = ':%s' % port
1704
1284
 
1705
1285
 
1706
 
# XXX: This is also used for unexpected end of file, which is different at the
1707
 
# TCP level from "connection reset".
1708
1286
class ConnectionReset(TransportError):
1709
1287
 
1710
1288
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1712
1290
 
1713
1291
class InvalidRange(TransportError):
1714
1292
 
1715
 
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1716
 
 
1717
 
    def __init__(self, path, offset, msg=None):
1718
 
        TransportError.__init__(self, msg)
 
1293
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1294
    
 
1295
    def __init__(self, path, offset):
 
1296
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1297
                                       % (path, offset)))
1719
1298
        self.path = path
1720
1299
        self.offset = offset
1721
1300
 
1722
1301
 
1723
1302
class InvalidHttpResponse(TransportError):
1724
1303
 
1725
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1304
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1726
1305
 
1727
1306
    def __init__(self, path, msg, orig_error=None):
1728
1307
        self.path = path
1729
 
        if orig_error is None:
1730
 
            orig_error = ''
1731
 
        else:
1732
 
            # This is reached for obscure and unusual errors so we want to
1733
 
            # preserve as much info as possible to ease debug.
1734
 
            orig_error = ': %r' % (orig_error,)
1735
1308
        TransportError.__init__(self, msg, orig_error=orig_error)
1736
1309
 
1737
1310
 
1738
1311
class InvalidHttpRange(InvalidHttpResponse):
1739
1312
 
1740
1313
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1741
 
 
 
1314
    
1742
1315
    def __init__(self, path, range, msg):
1743
1316
        self.range = range
1744
1317
        InvalidHttpResponse.__init__(self, path, msg)
1745
1318
 
1746
1319
 
1747
 
class HttpBoundaryMissing(InvalidHttpResponse):
1748
 
    """A multipart response ends with no boundary marker.
1749
 
 
1750
 
    This is a special case caused by buggy proxies, described in
1751
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1752
 
    """
1753
 
 
1754
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1755
 
 
1756
 
    def __init__(self, path, msg):
1757
 
        InvalidHttpResponse.__init__(self, path, msg)
1758
 
 
1759
 
 
1760
1320
class InvalidHttpContentType(InvalidHttpResponse):
1761
1321
 
1762
1322
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1763
 
 
 
1323
    
1764
1324
    def __init__(self, path, ctype, msg):
1765
1325
        self.ctype = ctype
1766
1326
        InvalidHttpResponse.__init__(self, path, msg)
1770
1330
 
1771
1331
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1772
1332
 
1773
 
    def __init__(self, source, target, is_permanent=False):
 
1333
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1774
1334
        self.source = source
1775
1335
        self.target = target
1776
 
        if is_permanent:
 
1336
        if is_permament:
1777
1337
            self.permanently = ' permanently'
1778
1338
        else:
1779
1339
            self.permanently = ''
 
1340
        self.is_permament = is_permament
 
1341
        self._qualified_proto = qual_proto
1780
1342
        TransportError.__init__(self)
1781
1343
 
 
1344
    def _requalify_url(self, url):
 
1345
        """Restore the qualified proto in front of the url"""
 
1346
        # When this exception is raised, source and target are in
 
1347
        # user readable format. But some transports may use a
 
1348
        # different proto (http+urllib:// will present http:// to
 
1349
        # the user. If a qualified proto is specified, the code
 
1350
        # trapping the exception can get the qualified urls to
 
1351
        # properly handle the redirection themself (creating a
 
1352
        # new transport object from the target url for example).
 
1353
        # But checking that the scheme of the original and
 
1354
        # redirected urls are the same can be tricky. (see the
 
1355
        # FIXME in BzrDir.open_from_transport for the unique use
 
1356
        # case so far).
 
1357
        if self._qualified_proto is None:
 
1358
            return url
 
1359
 
 
1360
        # The TODO related to NotBranchError mention that doing
 
1361
        # that kind of manipulation on the urls may not be the
 
1362
        # exception object job. On the other hand, this object is
 
1363
        # the interface between the code and the user so
 
1364
        # presenting the urls in different ways is indeed its
 
1365
        # job...
 
1366
        import urlparse
 
1367
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1368
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1369
                                   query, fragment))
 
1370
 
 
1371
    def get_source_url(self):
 
1372
        return self._requalify_url(self.source)
 
1373
 
 
1374
    def get_target_url(self):
 
1375
        return self._requalify_url(self.target)
 
1376
 
1782
1377
 
1783
1378
class TooManyRedirections(TransportError):
1784
1379
 
1785
1380
    _fmt = "Too many redirections"
1786
1381
 
1787
 
 
1788
1382
class ConflictsInTree(BzrError):
1789
1383
 
1790
1384
    _fmt = "Working tree has conflicts."
1791
1385
 
1792
1386
 
1793
 
class ConfigContentError(BzrError):
1794
 
 
1795
 
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1796
 
 
1797
 
    def __init__(self, filename):
1798
 
        BzrError.__init__(self)
1799
 
        self.filename = filename
1800
 
 
1801
 
 
1802
1387
class ParseConfigError(BzrError):
1803
1388
 
1804
 
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1805
 
 
1806
1389
    def __init__(self, errors, filename):
1807
 
        BzrError.__init__(self)
1808
 
        self.filename = filename
1809
 
        self.errors = '\n'.join(e.msg for e in errors)
1810
 
 
1811
 
 
1812
 
class ConfigOptionValueError(BzrError):
1813
 
 
1814
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
1815
 
 
1816
 
    def __init__(self, name, value):
1817
 
        BzrError.__init__(self, name=name, value=value)
 
1390
        if filename is None:
 
1391
            filename = ""
 
1392
        message = "Error(s) parsing config file %s:\n%s" % \
 
1393
            (filename, ('\n'.join(e.message for e in errors)))
 
1394
        BzrError.__init__(self, message)
1818
1395
 
1819
1396
 
1820
1397
class NoEmailInUsername(BzrError):
1828
1405
 
1829
1406
class SigningFailed(BzrError):
1830
1407
 
1831
 
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1408
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1832
1409
 
1833
1410
    def __init__(self, command_line):
1834
1411
        BzrError.__init__(self, command_line=command_line)
1835
1412
 
1836
1413
 
1837
 
class SignatureVerificationFailed(BzrError):
1838
 
 
1839
 
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1840
 
 
1841
 
    def __init__(self, error):
1842
 
        BzrError.__init__(self, error=error)
1843
 
 
1844
 
 
1845
 
class DependencyNotPresent(BzrError):
1846
 
 
1847
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1848
 
 
1849
 
    def __init__(self, library, error):
1850
 
        BzrError.__init__(self, library=library, error=error)
1851
 
 
1852
 
 
1853
 
class GpgmeNotInstalled(DependencyNotPresent):
1854
 
 
1855
 
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1856
 
 
1857
 
    def __init__(self, error):
1858
 
        DependencyNotPresent.__init__(self, 'gpgme', error)
1859
 
 
1860
 
 
1861
1414
class WorkingTreeNotRevision(BzrError):
1862
1415
 
1863
 
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1416
    _fmt = ("The working tree for %(basedir)s has changed since" 
1864
1417
            " the last commit, but weave merge requires that it be"
1865
1418
            " unchanged")
1866
1419
 
1883
1436
        self.graph = graph
1884
1437
 
1885
1438
 
1886
 
class WritingCompleted(InternalBzrError):
 
1439
class WritingCompleted(BzrError):
1887
1440
 
1888
1441
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1889
1442
            "called upon it - accept bytes may not be called anymore.")
1890
1443
 
 
1444
    internal_error = True
 
1445
 
1891
1446
    def __init__(self, request):
1892
1447
        self.request = request
1893
1448
 
1894
1449
 
1895
 
class WritingNotComplete(InternalBzrError):
 
1450
class WritingNotComplete(BzrError):
1896
1451
 
1897
1452
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1898
1453
            "called upon it - until the write phase is complete no "
1899
1454
            "data may be read.")
1900
1455
 
 
1456
    internal_error = True
 
1457
 
1901
1458
    def __init__(self, request):
1902
1459
        self.request = request
1903
1460
 
1911
1468
        self.filename = filename
1912
1469
 
1913
1470
 
1914
 
class MediumNotConnected(InternalBzrError):
 
1471
class MediumNotConnected(BzrError):
1915
1472
 
1916
1473
    _fmt = """The medium '%(medium)s' is not connected."""
1917
1474
 
 
1475
    internal_error = True
 
1476
 
1918
1477
    def __init__(self, medium):
1919
1478
        self.medium = medium
1920
1479
 
1926
1485
 
1927
1486
class NoBundleFound(BzrError):
1928
1487
 
1929
 
    _fmt = 'No bundle was found in "%(filename)s".'
 
1488
    _fmt = "No bundle was found in %(filename)s"
1930
1489
 
1931
1490
    def __init__(self, filename):
1932
1491
        BzrError.__init__(self)
1971
1530
    _fmt = "Key %(key)s is already present in map"
1972
1531
 
1973
1532
 
1974
 
class DuplicateHelpPrefix(BzrError):
1975
 
 
1976
 
    _fmt = "The prefix %(prefix)s is in the help search path twice."
1977
 
 
1978
 
    def __init__(self, prefix):
1979
 
        self.prefix = prefix
1980
 
 
1981
 
 
1982
1533
class MalformedTransform(BzrError):
1983
1534
 
1984
1535
    _fmt = "Tree transform is malformed %(conflicts)r"
1996
1547
        self.root_trans_id = transform.root
1997
1548
 
1998
1549
 
1999
 
class BzrBadParameter(InternalBzrError):
 
1550
class BzrBadParameter(BzrError):
2000
1551
 
2001
1552
    _fmt = "Bad parameter: %(param)r"
2002
1553
 
2023
1574
    _fmt = "Moving the root directory is not supported at this time"
2024
1575
 
2025
1576
 
2026
 
class TransformRenameFailed(BzrError):
2027
 
 
2028
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2029
 
 
2030
 
    def __init__(self, from_path, to_path, why, errno):
2031
 
        self.from_path = from_path
2032
 
        self.to_path = to_path
2033
 
        self.why = why
2034
 
        self.errno = errno
2035
 
 
2036
 
 
2037
1577
class BzrMoveFailedError(BzrError):
2038
1578
 
2039
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2040
 
        "%(_has_extra)s%(extra)s")
 
1579
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2041
1580
 
2042
1581
    def __init__(self, from_path='', to_path='', extra=None):
2043
 
        from bzrlib.osutils import splitpath
2044
1582
        BzrError.__init__(self)
2045
1583
        if extra:
2046
 
            self.extra, self._has_extra = extra, ': '
 
1584
            self.extra = ': ' + str(extra)
2047
1585
        else:
2048
 
            self.extra = self._has_extra = ''
 
1586
            self.extra = ''
2049
1587
 
2050
1588
        has_from = len(from_path) > 0
2051
1589
        has_to = len(to_path) > 0
2052
1590
        if has_from:
2053
 
            self.from_path = splitpath(from_path)[-1]
 
1591
            self.from_path = osutils.splitpath(from_path)[-1]
2054
1592
        else:
2055
1593
            self.from_path = ''
2056
1594
 
2057
1595
        if has_to:
2058
 
            self.to_path = splitpath(to_path)[-1]
 
1596
            self.to_path = osutils.splitpath(to_path)[-1]
2059
1597
        else:
2060
1598
            self.to_path = ''
2061
1599
 
2072
1610
 
2073
1611
class BzrRenameFailedError(BzrMoveFailedError):
2074
1612
 
2075
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2076
 
        "%(_has_extra)s%(extra)s")
 
1613
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2077
1614
 
2078
1615
    def __init__(self, from_path, to_path, extra=None):
2079
1616
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2080
1617
 
2081
1618
 
2082
 
class BzrRemoveChangedFilesError(BzrError):
2083
 
    """Used when user is trying to remove changed files."""
2084
 
 
2085
 
    _fmt = ("Can't safely remove modified or unknown files:\n"
2086
 
        "%(changes_as_text)s"
2087
 
        "Use --keep to not delete them, or --force to delete them regardless.")
2088
 
 
2089
 
    def __init__(self, tree_delta):
2090
 
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2091
 
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2092
 
        BzrError.__init__(self)
2093
 
        self.changes_as_text = tree_delta.get_changes_as_text()
2094
 
        #self.paths_as_string = '\n'.join(changed_files)
2095
 
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2096
 
 
2097
 
 
2098
1619
class BzrBadParameterNotString(BzrBadParameter):
2099
1620
 
2100
1621
    _fmt = "Parameter %(param)s is not a string or unicode string."
2102
1623
 
2103
1624
class BzrBadParameterMissing(BzrBadParameter):
2104
1625
 
2105
 
    _fmt = "Parameter %(param)s is required but not present."
 
1626
    _fmt = "Parameter $(param)s is required but not present."
2106
1627
 
2107
1628
 
2108
1629
class BzrBadParameterUnicode(BzrBadParameter):
2116
1637
    _fmt = "Parameter %(param)s contains a newline."
2117
1638
 
2118
1639
 
 
1640
class DependencyNotPresent(BzrError):
 
1641
 
 
1642
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1643
 
 
1644
    def __init__(self, library, error):
 
1645
        BzrError.__init__(self, library=library, error=error)
 
1646
 
 
1647
 
2119
1648
class ParamikoNotPresent(DependencyNotPresent):
2120
1649
 
2121
1650
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2140
1669
 
2141
1670
class BadConversionTarget(BzrError):
2142
1671
 
2143
 
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2144
 
            "    %(problem)s"
 
1672
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
2145
1673
 
2146
 
    def __init__(self, problem, format, from_format=None):
 
1674
    def __init__(self, problem, format):
2147
1675
        BzrError.__init__(self)
2148
1676
        self.problem = problem
2149
1677
        self.format = format
2150
 
        self.from_format = from_format or '(unspecified)'
2151
 
 
2152
 
 
2153
 
class NoDiffFound(BzrError):
2154
 
 
2155
 
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
2156
 
 
2157
 
    def __init__(self, path):
2158
 
        BzrError.__init__(self, path)
2159
 
 
2160
 
 
2161
 
class ExecutableMissing(BzrError):
2162
 
 
2163
 
    _fmt = "%(exe_name)s could not be found on this machine"
2164
 
 
2165
 
    def __init__(self, exe_name):
2166
 
        BzrError.__init__(self, exe_name=exe_name)
2167
1678
 
2168
1679
 
2169
1680
class NoDiff(BzrError):
2179
1690
    _fmt = "Diff3 is not installed on this machine."
2180
1691
 
2181
1692
 
2182
 
class ExistingContent(BzrError):
2183
 
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
2184
 
 
2185
 
    _fmt = "The content being inserted is already present."
2186
 
 
2187
 
 
2188
1693
class ExistingLimbo(BzrError):
2189
1694
 
2190
1695
    _fmt = """This tree contains left-over files from a failed operation.
2191
1696
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2192
1697
    keep, and delete it when you are done."""
2193
 
 
 
1698
    
2194
1699
    def __init__(self, limbo_dir):
2195
1700
       BzrError.__init__(self)
2196
1701
       self.limbo_dir = limbo_dir
2197
1702
 
2198
1703
 
2199
 
class ExistingPendingDeletion(BzrError):
2200
 
 
2201
 
    _fmt = """This tree contains left-over files from a failed operation.
2202
 
    Please examine %(pending_deletion)s to see if it contains any files you
2203
 
    wish to keep, and delete it when you are done."""
2204
 
 
2205
 
    def __init__(self, pending_deletion):
2206
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2207
 
 
2208
 
 
2209
1704
class ImmortalLimbo(BzrError):
2210
1705
 
2211
 
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1706
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
2212
1707
    Please examine %(limbo_dir)s to see if it contains any files you wish to
2213
1708
    keep, and delete it when you are done."""
2214
1709
 
2217
1712
       self.limbo_dir = limbo_dir
2218
1713
 
2219
1714
 
2220
 
class ImmortalPendingDeletion(BzrError):
2221
 
 
2222
 
    _fmt = ("Unable to delete transform temporary directory "
2223
 
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
2224
 
    "contains any files you wish to keep, and delete it when you are done.")
2225
 
 
2226
 
    def __init__(self, pending_deletion):
2227
 
       BzrError.__init__(self, pending_deletion=pending_deletion)
2228
 
 
2229
 
 
2230
1715
class OutOfDateTree(BzrError):
2231
1716
 
2232
 
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
1717
    _fmt = "Working tree is out of date, please run 'bzr update'."
2233
1718
 
2234
 
    def __init__(self, tree, more=None):
2235
 
        if more is None:
2236
 
            more = ''
2237
 
        else:
2238
 
            more = ' ' + more
 
1719
    def __init__(self, tree):
2239
1720
        BzrError.__init__(self)
2240
1721
        self.tree = tree
2241
 
        self.more = more
2242
1722
 
2243
1723
 
2244
1724
class PublicBranchOutOfDate(BzrError):
2264
1744
    _fmt = "Format error in conflict listings"
2265
1745
 
2266
1746
 
2267
 
class CorruptDirstate(BzrError):
2268
 
 
2269
 
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
2270
 
            "Error: %(description)s")
2271
 
 
2272
 
    def __init__(self, dirstate_path, description):
2273
 
        BzrError.__init__(self)
2274
 
        self.dirstate_path = dirstate_path
2275
 
        self.description = description
2276
 
 
2277
 
 
2278
1747
class CorruptRepository(BzrError):
2279
1748
 
2280
1749
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
2282
1751
 
2283
1752
    def __init__(self, repo):
2284
1753
        BzrError.__init__(self)
2285
 
        self.repo_path = repo.user_url
2286
 
 
2287
 
 
2288
 
class InconsistentDelta(BzrError):
2289
 
    """Used when we get a delta that is not valid."""
2290
 
 
2291
 
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
2292
 
            " %(file_id)r\nreason: %(reason)s")
2293
 
 
2294
 
    def __init__(self, path, file_id, reason):
2295
 
        BzrError.__init__(self)
2296
 
        self.path = path
2297
 
        self.file_id = file_id
2298
 
        self.reason = reason
2299
 
 
2300
 
 
2301
 
class InconsistentDeltaDelta(InconsistentDelta):
2302
 
    """Used when we get a delta that is not valid."""
2303
 
 
2304
 
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
2305
 
            "\nreason: %(reason)s")
2306
 
 
2307
 
    def __init__(self, delta, reason):
2308
 
        BzrError.__init__(self)
2309
 
        self.delta = delta
2310
 
        self.reason = reason
 
1754
        self.repo_path = repo.bzrdir.root_transport.base
2311
1755
 
2312
1756
 
2313
1757
class UpgradeRequired(BzrError):
2319
1763
        self.path = path
2320
1764
 
2321
1765
 
2322
 
class RepositoryUpgradeRequired(UpgradeRequired):
2323
 
 
2324
 
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
2325
 
 
2326
 
 
2327
 
class RichRootUpgradeRequired(UpgradeRequired):
2328
 
 
2329
 
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2330
 
           " a format which supports rich roots.")
2331
 
 
2332
 
 
2333
1766
class LocalRequiresBoundBranch(BzrError):
2334
1767
 
2335
1768
    _fmt = "Cannot perform local-only commits on unbound branches."
2336
1769
 
2337
1770
 
 
1771
class MissingProgressBarFinish(BzrError):
 
1772
 
 
1773
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1774
 
 
1775
 
 
1776
class InvalidProgressBarType(BzrError):
 
1777
 
 
1778
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1779
            " is not a supported type Select one of: %(valid_types)s")
 
1780
 
 
1781
    def __init__(self, bar_type, valid_types):
 
1782
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1783
 
 
1784
 
2338
1785
class UnsupportedOperation(BzrError):
2339
1786
 
2340
1787
    _fmt = ("The method %(mname)s is not supported on"
2356
1803
    """
2357
1804
 
2358
1805
 
2359
 
class GhostTagsNotSupported(BzrError):
2360
 
 
2361
 
    _fmt = "Ghost tags not supported by format %(format)r."
2362
 
 
2363
 
    def __init__(self, format):
2364
 
        self.format = format
2365
 
 
2366
 
 
2367
1806
class BinaryFile(BzrError):
2368
 
 
 
1807
    
2369
1808
    _fmt = "File is binary but should be text."
2370
1809
 
2371
1810
 
2391
1830
 
2392
1831
 
2393
1832
class NotABundle(BzrError):
2394
 
 
 
1833
    
2395
1834
    _fmt = "Not a bzr revision-bundle: %(text)r"
2396
1835
 
2397
1836
    def __init__(self, text):
2399
1838
        self.text = text
2400
1839
 
2401
1840
 
2402
 
class BadBundle(BzrError):
2403
 
 
 
1841
class BadBundle(BzrError): 
 
1842
    
2404
1843
    _fmt = "Bad bzr revision-bundle: %(text)r"
2405
1844
 
2406
1845
    def __init__(self, text):
2408
1847
        self.text = text
2409
1848
 
2410
1849
 
2411
 
class MalformedHeader(BadBundle):
2412
 
 
 
1850
class MalformedHeader(BadBundle): 
 
1851
    
2413
1852
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
2414
1853
 
2415
1854
 
2416
 
class MalformedPatches(BadBundle):
2417
 
 
 
1855
class MalformedPatches(BadBundle): 
 
1856
    
2418
1857
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2419
1858
 
2420
1859
 
2421
 
class MalformedFooter(BadBundle):
2422
 
 
 
1860
class MalformedFooter(BadBundle): 
 
1861
    
2423
1862
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2424
1863
 
2425
1864
 
2426
1865
class UnsupportedEOLMarker(BadBundle):
2427
 
 
2428
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1866
    
 
1867
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
2429
1868
 
2430
1869
    def __init__(self):
2431
 
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1870
        # XXX: BadBundle's constructor assumes there's explanatory text, 
2432
1871
        # but for this there is not
2433
1872
        BzrError.__init__(self)
2434
1873
 
2435
1874
 
2436
1875
class IncompatibleBundleFormat(BzrError):
2437
 
 
 
1876
    
2438
1877
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2439
1878
 
2440
1879
    def __init__(self, bundle_format, other):
2444
1883
 
2445
1884
 
2446
1885
class BadInventoryFormat(BzrError):
2447
 
 
 
1886
    
2448
1887
    _fmt = "Root class for inventory serialization errors"
2449
1888
 
2450
1889
 
2461
1900
    _fmt = """This operation requires rich root data storage"""
2462
1901
 
2463
1902
 
2464
 
class NoSmartMedium(InternalBzrError):
 
1903
class NoSmartMedium(BzrError):
2465
1904
 
2466
1905
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
2467
1906
 
 
1907
    internal_error = True
 
1908
 
2468
1909
    def __init__(self, transport):
2469
1910
        self.transport = transport
2470
1911
 
2471
1912
 
 
1913
class NoSmartServer(NotBranchError):
 
1914
 
 
1915
    _fmt = "No smart server available at %(url)s"
 
1916
 
 
1917
    def __init__(self, url):
 
1918
        self.url = url
 
1919
 
 
1920
 
2472
1921
class UnknownSSH(BzrError):
2473
1922
 
2474
1923
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2484
1933
            " Please set BZR_SSH environment variable.")
2485
1934
 
2486
1935
 
2487
 
class GhostRevisionsHaveNoRevno(BzrError):
2488
 
    """When searching for revnos, if we encounter a ghost, we are stuck"""
2489
 
 
2490
 
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
2491
 
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
2492
 
 
2493
 
    def __init__(self, revision_id, ghost_revision_id):
2494
 
        self.revision_id = revision_id
2495
 
        self.ghost_revision_id = ghost_revision_id
2496
 
 
2497
 
 
2498
1936
class GhostRevisionUnusableHere(BzrError):
2499
1937
 
2500
1938
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
2504
1942
        self.revision_id = revision_id
2505
1943
 
2506
1944
 
2507
 
class IllegalUseOfScopeReplacer(InternalBzrError):
 
1945
class IllegalUseOfScopeReplacer(BzrError):
2508
1946
 
2509
1947
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
2510
1948
            " %(msg)s%(extra)s")
2511
1949
 
 
1950
    internal_error = True
 
1951
 
2512
1952
    def __init__(self, name, msg, extra=None):
2513
1953
        BzrError.__init__(self)
2514
1954
        self.name = name
2519
1959
            self.extra = ''
2520
1960
 
2521
1961
 
2522
 
class InvalidImportLine(InternalBzrError):
 
1962
class InvalidImportLine(BzrError):
2523
1963
 
2524
1964
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
2525
1965
 
 
1966
    internal_error = True
 
1967
 
2526
1968
    def __init__(self, text, msg):
2527
1969
        BzrError.__init__(self)
2528
1970
        self.text = text
2529
1971
        self.msg = msg
2530
1972
 
2531
1973
 
2532
 
class ImportNameCollision(InternalBzrError):
 
1974
class ImportNameCollision(BzrError):
2533
1975
 
2534
1976
    _fmt = ("Tried to import an object to the same name as"
2535
1977
            " an existing object. %(name)s")
2536
1978
 
 
1979
    internal_error = True
 
1980
 
2537
1981
    def __init__(self, name):
2538
1982
        BzrError.__init__(self)
2539
1983
        self.name = name
2552
1996
        " branch location."
2553
1997
 
2554
1998
 
2555
 
class IllegalMergeDirectivePayload(BzrError):
2556
 
    """A merge directive contained something other than a patch or bundle"""
2557
 
 
2558
 
    _fmt = "Bad merge directive payload %(start)r"
2559
 
 
2560
 
    def __init__(self, start):
2561
 
        BzrError(self)
2562
 
        self.start = start
2563
 
 
2564
 
 
2565
 
class PatchVerificationFailed(BzrError):
2566
 
    """A patch from a merge directive could not be verified"""
2567
 
 
2568
 
    _fmt = "Preview patch does not match requested changes."
2569
 
 
2570
 
 
2571
1999
class PatchMissing(BzrError):
2572
2000
    """Raise a patch type was specified but no patch supplied"""
2573
2001
 
2574
 
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2002
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2575
2003
 
2576
2004
    def __init__(self, patch_type):
2577
2005
        BzrError.__init__(self)
2578
2006
        self.patch_type = patch_type
2579
2007
 
2580
2008
 
2581
 
class TargetNotBranch(BzrError):
2582
 
    """A merge directive's target branch is required, but isn't a branch"""
2583
 
 
2584
 
    _fmt = ("Your branch does not have all of the revisions required in "
2585
 
            "order to merge this merge directive and the target "
2586
 
            "location specified in the merge directive is not a branch: "
2587
 
            "%(location)s.")
2588
 
 
2589
 
    def __init__(self, location):
2590
 
        BzrError.__init__(self)
2591
 
        self.location = location
2592
 
 
2593
 
 
2594
2009
class UnsupportedInventoryKind(BzrError):
2595
 
 
 
2010
    
2596
2011
    _fmt = """Unsupported entry kind %(kind)s"""
2597
2012
 
2598
2013
    def __init__(self, kind):
2601
2016
 
2602
2017
class BadSubsumeSource(BzrError):
2603
2018
 
2604
 
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2019
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2605
2020
 
2606
2021
    def __init__(self, tree, other_tree, reason):
2607
2022
        self.tree = tree
2610
2025
 
2611
2026
 
2612
2027
class SubsumeTargetNeedsUpgrade(BzrError):
2613
 
 
 
2028
    
2614
2029
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2615
2030
 
2616
2031
    def __init__(self, other_tree):
2617
2032
        self.other_tree = other_tree
2618
2033
 
2619
2034
 
2620
 
class BadReferenceTarget(InternalBzrError):
2621
 
 
2622
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
2623
 
           "%(reason)s"
 
2035
class BadReferenceTarget(BzrError):
 
2036
 
 
2037
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
2038
 
 
2039
    internal_error = True
2624
2040
 
2625
2041
    def __init__(self, tree, other_tree, reason):
2626
2042
        self.tree = tree
2639
2055
class TagsNotSupported(BzrError):
2640
2056
 
2641
2057
    _fmt = ("Tags not supported by %(branch)s;"
2642
 
            " you may be able to use bzr upgrade.")
 
2058
            " you may be able to use bzr upgrade --dirstate-tags.")
2643
2059
 
2644
2060
    def __init__(self, branch):
2645
2061
        self.branch = branch
2646
2062
 
2647
 
 
 
2063
        
2648
2064
class TagAlreadyExists(BzrError):
2649
2065
 
2650
2066
    _fmt = "Tag %(tag_name)s already exists."
2651
2067
 
2652
2068
    def __init__(self, tag_name):
2653
2069
        self.tag_name = tag_name
2654
 
 
2655
 
 
2656
 
class MalformedBugIdentifier(BzrError):
2657
 
 
2658
 
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2659
 
            'See "bzr help bugs" for more information on this feature.')
2660
 
 
2661
 
    def __init__(self, bug_id, reason):
2662
 
        self.bug_id = bug_id
2663
 
        self.reason = reason
2664
 
 
2665
 
 
2666
 
class InvalidBugTrackerURL(BzrError):
2667
 
 
2668
 
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
2669
 
            "contain {id}: %(url)s")
2670
 
 
2671
 
    def __init__(self, abbreviation, url):
2672
 
        self.abbreviation = abbreviation
2673
 
        self.url = url
2674
 
 
2675
 
 
2676
 
class UnknownBugTrackerAbbreviation(BzrError):
2677
 
 
2678
 
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
2679
 
            "on %(branch)s")
2680
 
 
2681
 
    def __init__(self, abbreviation, branch):
2682
 
        self.abbreviation = abbreviation
2683
 
        self.branch = branch
2684
 
 
2685
 
 
2686
 
class InvalidLineInBugsProperty(BzrError):
2687
 
 
2688
 
    _fmt = ("Invalid line in bugs property: '%(line)s'")
2689
 
 
2690
 
    def __init__(self, line):
2691
 
        self.line = line
2692
 
 
2693
 
 
2694
 
class InvalidBugStatus(BzrError):
2695
 
 
2696
 
    _fmt = ("Invalid bug status: '%(status)s'")
2697
 
 
2698
 
    def __init__(self, status):
2699
 
        self.status = status
2700
 
 
2701
 
 
2702
 
class UnexpectedSmartServerResponse(BzrError):
2703
 
 
2704
 
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2705
 
 
2706
 
    def __init__(self, response_tuple):
2707
 
        self.response_tuple = response_tuple
2708
 
 
2709
 
 
2710
 
class ErrorFromSmartServer(BzrError):
2711
 
    """An error was received from a smart server.
2712
 
 
2713
 
    :seealso: UnknownErrorFromSmartServer
2714
 
    """
2715
 
 
2716
 
    _fmt = "Error received from smart server: %(error_tuple)r"
2717
 
 
2718
 
    internal_error = True
2719
 
 
2720
 
    def __init__(self, error_tuple):
2721
 
        self.error_tuple = error_tuple
2722
 
        try:
2723
 
            self.error_verb = error_tuple[0]
2724
 
        except IndexError:
2725
 
            self.error_verb = None
2726
 
        self.error_args = error_tuple[1:]
2727
 
 
2728
 
 
2729
 
class UnknownErrorFromSmartServer(BzrError):
2730
 
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2731
 
    error.
2732
 
 
2733
 
    This is distinct from ErrorFromSmartServer so that it is possible to
2734
 
    distinguish between the following two cases:
2735
 
 
2736
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2737
 
      and so should provoke a traceback to the user.
2738
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2739
 
      translated.  This is probably because the server sent us garbage, and
2740
 
      should not provoke a traceback.
2741
 
    """
2742
 
 
2743
 
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2744
 
 
2745
 
    internal_error = False
2746
 
 
2747
 
    def __init__(self, error_from_smart_server):
2748
 
        """Constructor.
2749
 
 
2750
 
        :param error_from_smart_server: An ErrorFromSmartServer instance.
2751
 
        """
2752
 
        self.error_from_smart_server = error_from_smart_server
2753
 
        self.error_tuple = error_from_smart_server.error_tuple
2754
 
 
2755
 
 
2756
 
class ContainerError(BzrError):
2757
 
    """Base class of container errors."""
2758
 
 
2759
 
 
2760
 
class UnknownContainerFormatError(ContainerError):
2761
 
 
2762
 
    _fmt = "Unrecognised container format: %(container_format)r"
2763
 
 
2764
 
    def __init__(self, container_format):
2765
 
        self.container_format = container_format
2766
 
 
2767
 
 
2768
 
class UnexpectedEndOfContainerError(ContainerError):
2769
 
 
2770
 
    _fmt = "Unexpected end of container stream"
2771
 
 
2772
 
 
2773
 
class UnknownRecordTypeError(ContainerError):
2774
 
 
2775
 
    _fmt = "Unknown record type: %(record_type)r"
2776
 
 
2777
 
    def __init__(self, record_type):
2778
 
        self.record_type = record_type
2779
 
 
2780
 
 
2781
 
class InvalidRecordError(ContainerError):
2782
 
 
2783
 
    _fmt = "Invalid record: %(reason)s"
2784
 
 
2785
 
    def __init__(self, reason):
2786
 
        self.reason = reason
2787
 
 
2788
 
 
2789
 
class ContainerHasExcessDataError(ContainerError):
2790
 
 
2791
 
    _fmt = "Container has data after end marker: %(excess)r"
2792
 
 
2793
 
    def __init__(self, excess):
2794
 
        self.excess = excess
2795
 
 
2796
 
 
2797
 
class DuplicateRecordNameError(ContainerError):
2798
 
 
2799
 
    _fmt = "Container has multiple records with the same name: %(name)s"
2800
 
 
2801
 
    def __init__(self, name):
2802
 
        self.name = name.decode("utf-8")
2803
 
 
2804
 
 
2805
 
class NoDestinationAddress(InternalBzrError):
2806
 
 
2807
 
    _fmt = "Message does not have a destination address."
2808
 
 
2809
 
 
2810
 
class RepositoryDataStreamError(BzrError):
2811
 
 
2812
 
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
2813
 
 
2814
 
    def __init__(self, reason):
2815
 
        self.reason = reason
2816
 
 
2817
 
 
2818
 
class SMTPError(BzrError):
2819
 
 
2820
 
    _fmt = "SMTP error: %(error)s"
2821
 
 
2822
 
    def __init__(self, error):
2823
 
        self.error = error
2824
 
 
2825
 
 
2826
 
class NoMessageSupplied(BzrError):
2827
 
 
2828
 
    _fmt = "No message supplied."
2829
 
 
2830
 
 
2831
 
class NoMailAddressSpecified(BzrError):
2832
 
 
2833
 
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
2834
 
 
2835
 
 
2836
 
class UnknownMailClient(BzrError):
2837
 
 
2838
 
    _fmt = "Unknown mail client: %(mail_client)s"
2839
 
 
2840
 
    def __init__(self, mail_client):
2841
 
        BzrError.__init__(self, mail_client=mail_client)
2842
 
 
2843
 
 
2844
 
class MailClientNotFound(BzrError):
2845
 
 
2846
 
    _fmt = "Unable to find mail client with the following names:"\
2847
 
        " %(mail_command_list_string)s"
2848
 
 
2849
 
    def __init__(self, mail_command_list):
2850
 
        mail_command_list_string = ', '.join(mail_command_list)
2851
 
        BzrError.__init__(self, mail_command_list=mail_command_list,
2852
 
                          mail_command_list_string=mail_command_list_string)
2853
 
 
2854
 
class SMTPConnectionRefused(SMTPError):
2855
 
 
2856
 
    _fmt = "SMTP connection to %(host)s refused"
2857
 
 
2858
 
    def __init__(self, error, host):
2859
 
        self.error = error
2860
 
        self.host = host
2861
 
 
2862
 
 
2863
 
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
2864
 
 
2865
 
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
2866
 
 
2867
 
 
2868
 
class BzrDirError(BzrError):
2869
 
 
2870
 
    def __init__(self, bzrdir):
2871
 
        import bzrlib.urlutils as urlutils
2872
 
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2873
 
                                                    'ascii')
2874
 
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2875
 
 
2876
 
 
2877
 
class UnsyncedBranches(BzrDirError):
2878
 
 
2879
 
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
2880
 
            " bzr help sync-for-reconfigure.")
2881
 
 
2882
 
    def __init__(self, bzrdir, target_branch):
2883
 
        BzrDirError.__init__(self, bzrdir)
2884
 
        import bzrlib.urlutils as urlutils
2885
 
        self.target_url = urlutils.unescape_for_display(target_branch.base,
2886
 
                                                        'ascii')
2887
 
 
2888
 
 
2889
 
class AlreadyBranch(BzrDirError):
2890
 
 
2891
 
    _fmt = "'%(display_url)s' is already a branch."
2892
 
 
2893
 
 
2894
 
class AlreadyTree(BzrDirError):
2895
 
 
2896
 
    _fmt = "'%(display_url)s' is already a tree."
2897
 
 
2898
 
 
2899
 
class AlreadyCheckout(BzrDirError):
2900
 
 
2901
 
    _fmt = "'%(display_url)s' is already a checkout."
2902
 
 
2903
 
 
2904
 
class AlreadyLightweightCheckout(BzrDirError):
2905
 
 
2906
 
    _fmt = "'%(display_url)s' is already a lightweight checkout."
2907
 
 
2908
 
 
2909
 
class AlreadyUsingShared(BzrDirError):
2910
 
 
2911
 
    _fmt = "'%(display_url)s' is already using a shared repository."
2912
 
 
2913
 
 
2914
 
class AlreadyStandalone(BzrDirError):
2915
 
 
2916
 
    _fmt = "'%(display_url)s' is already standalone."
2917
 
 
2918
 
 
2919
 
class AlreadyWithTrees(BzrDirError):
2920
 
 
2921
 
    _fmt = ("Shared repository '%(display_url)s' already creates "
2922
 
            "working trees.")
2923
 
 
2924
 
 
2925
 
class AlreadyWithNoTrees(BzrDirError):
2926
 
 
2927
 
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
2928
 
            "working trees.")
2929
 
 
2930
 
 
2931
 
class ReconfigurationNotSupported(BzrDirError):
2932
 
 
2933
 
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
2934
 
 
2935
 
 
2936
 
class NoBindLocation(BzrDirError):
2937
 
 
2938
 
    _fmt = "No location could be found to bind to at %(display_url)s."
2939
 
 
2940
 
 
2941
 
class UncommittedChanges(BzrError):
2942
 
 
2943
 
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2944
 
            ' (See bzr status).%(more)s')
2945
 
 
2946
 
    def __init__(self, tree, more=None):
2947
 
        if more is None:
2948
 
            more = ''
2949
 
        else:
2950
 
            more = ' ' + more
2951
 
        import bzrlib.urlutils as urlutils
2952
 
        user_url = getattr(tree, "user_url", None)
2953
 
        if user_url is None:
2954
 
            display_url = str(tree)
2955
 
        else:
2956
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2957
 
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2958
 
 
2959
 
 
2960
 
class ShelvedChanges(UncommittedChanges):
2961
 
 
2962
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2963
 
            ' (See bzr shelve --list).%(more)s')
2964
 
 
2965
 
 
2966
 
class MissingTemplateVariable(BzrError):
2967
 
 
2968
 
    _fmt = 'Variable {%(name)s} is not available.'
2969
 
 
2970
 
    def __init__(self, name):
2971
 
        self.name = name
2972
 
 
2973
 
 
2974
 
class NoTemplate(BzrError):
2975
 
 
2976
 
    _fmt = 'No template specified.'
2977
 
 
2978
 
 
2979
 
class UnableCreateSymlink(BzrError):
2980
 
 
2981
 
    _fmt = 'Unable to create symlink %(path_str)son this platform'
2982
 
 
2983
 
    def __init__(self, path=None):
2984
 
        path_str = ''
2985
 
        if path:
2986
 
            try:
2987
 
                path_str = repr(str(path))
2988
 
            except UnicodeEncodeError:
2989
 
                path_str = repr(path)
2990
 
            path_str += ' '
2991
 
        self.path_str = path_str
2992
 
 
2993
 
 
2994
 
class UnsupportedTimezoneFormat(BzrError):
2995
 
 
2996
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
2997
 
            'options are "utc", "original", "local".')
2998
 
 
2999
 
    def __init__(self, timezone):
3000
 
        self.timezone = timezone
3001
 
 
3002
 
 
3003
 
class CommandAvailableInPlugin(StandardError):
3004
 
 
3005
 
    internal_error = False
3006
 
 
3007
 
    def __init__(self, cmd_name, plugin_metadata, provider):
3008
 
 
3009
 
        self.plugin_metadata = plugin_metadata
3010
 
        self.cmd_name = cmd_name
3011
 
        self.provider = provider
3012
 
 
3013
 
    def __str__(self):
3014
 
 
3015
 
        _fmt = ('"%s" is not a standard bzr command. \n'
3016
 
                'However, the following official plugin provides this command: %s\n'
3017
 
                'You can install it by going to: %s'
3018
 
                % (self.cmd_name, self.plugin_metadata['name'],
3019
 
                    self.plugin_metadata['url']))
3020
 
 
3021
 
        return _fmt
3022
 
 
3023
 
 
3024
 
class NoPluginAvailable(BzrError):
3025
 
    pass
3026
 
 
3027
 
 
3028
 
class UnableEncodePath(BzrError):
3029
 
 
3030
 
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
3031
 
            'user encoding %(user_encoding)s')
3032
 
 
3033
 
    def __init__(self, path, kind):
3034
 
        from bzrlib.osutils import get_user_encoding
3035
 
        self.path = path
3036
 
        self.kind = kind
3037
 
        self.user_encoding = osutils.get_user_encoding()
3038
 
 
3039
 
 
3040
 
class NoSuchConfig(BzrError):
3041
 
 
3042
 
    _fmt = ('The "%(config_id)s" configuration does not exist.')
3043
 
 
3044
 
    def __init__(self, config_id):
3045
 
        BzrError.__init__(self, config_id=config_id)
3046
 
 
3047
 
 
3048
 
class NoSuchConfigOption(BzrError):
3049
 
 
3050
 
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
3051
 
 
3052
 
    def __init__(self, option_name):
3053
 
        BzrError.__init__(self, option_name=option_name)
3054
 
 
3055
 
 
3056
 
class NoSuchAlias(BzrError):
3057
 
 
3058
 
    _fmt = ('The alias "%(alias_name)s" does not exist.')
3059
 
 
3060
 
    def __init__(self, alias_name):
3061
 
        BzrError.__init__(self, alias_name=alias_name)
3062
 
 
3063
 
 
3064
 
class DirectoryLookupFailure(BzrError):
3065
 
    """Base type for lookup errors."""
3066
 
 
3067
 
    pass
3068
 
 
3069
 
 
3070
 
class InvalidLocationAlias(DirectoryLookupFailure):
3071
 
 
3072
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
3073
 
 
3074
 
    def __init__(self, alias_name):
3075
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
3076
 
 
3077
 
 
3078
 
class UnsetLocationAlias(DirectoryLookupFailure):
3079
 
 
3080
 
    _fmt = 'No %(alias_name)s location assigned.'
3081
 
 
3082
 
    def __init__(self, alias_name):
3083
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
3084
 
 
3085
 
 
3086
 
class CannotBindAddress(BzrError):
3087
 
 
3088
 
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3089
 
 
3090
 
    def __init__(self, host, port, orig_error):
3091
 
        # nb: in python2.4 socket.error doesn't have a useful repr
3092
 
        BzrError.__init__(self, host=host, port=port,
3093
 
            orig_error=repr(orig_error.args))
3094
 
 
3095
 
 
3096
 
class UnknownRules(BzrError):
3097
 
 
3098
 
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
3099
 
 
3100
 
    def __init__(self, unknowns):
3101
 
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3102
 
 
3103
 
 
3104
 
class HookFailed(BzrError):
3105
 
    """Raised when a pre_change_branch_tip hook function fails anything other
3106
 
    than TipChangeRejected.
3107
 
 
3108
 
    Note that this exception is no longer raised, and the import is only left
3109
 
    to be nice to code which might catch it in a plugin.
3110
 
    """
3111
 
 
3112
 
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3113
 
            "%(traceback_text)s%(exc_value)s")
3114
 
 
3115
 
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3116
 
        if warn:
3117
 
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
3118
 
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3119
 
        import traceback
3120
 
        self.hook_stage = hook_stage
3121
 
        self.hook_name = hook_name
3122
 
        self.exc_info = exc_info
3123
 
        self.exc_type = exc_info[0]
3124
 
        self.exc_value = exc_info[1]
3125
 
        self.exc_tb = exc_info[2]
3126
 
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3127
 
 
3128
 
 
3129
 
class TipChangeRejected(BzrError):
3130
 
    """A pre_change_branch_tip hook function may raise this to cleanly and
3131
 
    explicitly abort a change to a branch tip.
3132
 
    """
3133
 
 
3134
 
    _fmt = u"Tip change rejected: %(msg)s"
3135
 
 
3136
 
    def __init__(self, msg):
3137
 
        self.msg = msg
3138
 
 
3139
 
 
3140
 
class ShelfCorrupt(BzrError):
3141
 
 
3142
 
    _fmt = "Shelf corrupt."
3143
 
 
3144
 
 
3145
 
class DecompressCorruption(BzrError):
3146
 
 
3147
 
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
3148
 
 
3149
 
    def __init__(self, orig_error=None):
3150
 
        if orig_error is not None:
3151
 
            self.orig_error = ", %s" % (orig_error,)
3152
 
        else:
3153
 
            self.orig_error = ""
3154
 
        BzrError.__init__(self)
3155
 
 
3156
 
 
3157
 
class NoSuchShelfId(BzrError):
3158
 
 
3159
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
3160
 
 
3161
 
    def __init__(self, shelf_id):
3162
 
        BzrError.__init__(self, shelf_id=shelf_id)
3163
 
 
3164
 
 
3165
 
class InvalidShelfId(BzrError):
3166
 
 
3167
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3168
 
 
3169
 
    def __init__(self, invalid_id):
3170
 
        BzrError.__init__(self, invalid_id=invalid_id)
3171
 
 
3172
 
 
3173
 
class JailBreak(BzrError):
3174
 
 
3175
 
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3176
 
 
3177
 
    def __init__(self, url):
3178
 
        BzrError.__init__(self, url=url)
3179
 
 
3180
 
 
3181
 
class UserAbort(BzrError):
3182
 
 
3183
 
    _fmt = 'The user aborted the operation.'
3184
 
 
3185
 
 
3186
 
class MustHaveWorkingTree(BzrError):
3187
 
 
3188
 
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3189
 
 
3190
 
    def __init__(self, format, url):
3191
 
        BzrError.__init__(self, format=format, url=url)
3192
 
 
3193
 
 
3194
 
class NoSuchView(BzrError):
3195
 
    """A view does not exist.
3196
 
    """
3197
 
 
3198
 
    _fmt = u"No such view: %(view_name)s."
3199
 
 
3200
 
    def __init__(self, view_name):
3201
 
        self.view_name = view_name
3202
 
 
3203
 
 
3204
 
class ViewsNotSupported(BzrError):
3205
 
    """Views are not supported by a tree format.
3206
 
    """
3207
 
 
3208
 
    _fmt = ("Views are not supported by %(tree)s;"
3209
 
            " use 'bzr upgrade' to change your tree to a later format.")
3210
 
 
3211
 
    def __init__(self, tree):
3212
 
        self.tree = tree
3213
 
 
3214
 
 
3215
 
class FileOutsideView(BzrError):
3216
 
 
3217
 
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
3218
 
            '%(view_str)s')
3219
 
 
3220
 
    def __init__(self, file_name, view_files):
3221
 
        self.file_name = file_name
3222
 
        self.view_str = ", ".join(view_files)
3223
 
 
3224
 
 
3225
 
class UnresumableWriteGroup(BzrError):
3226
 
 
3227
 
    _fmt = ("Repository %(repository)s cannot resume write group "
3228
 
            "%(write_groups)r: %(reason)s")
3229
 
 
3230
 
    internal_error = True
3231
 
 
3232
 
    def __init__(self, repository, write_groups, reason):
3233
 
        self.repository = repository
3234
 
        self.write_groups = write_groups
3235
 
        self.reason = reason
3236
 
 
3237
 
 
3238
 
class UnsuspendableWriteGroup(BzrError):
3239
 
 
3240
 
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
3241
 
 
3242
 
    internal_error = True
3243
 
 
3244
 
    def __init__(self, repository):
3245
 
        self.repository = repository
3246
 
 
3247
 
 
3248
 
class LossyPushToSameVCS(BzrError):
3249
 
 
3250
 
    _fmt = ("Lossy push not possible between %(source_branch)r and "
3251
 
            "%(target_branch)r that are in the same VCS.")
3252
 
 
3253
 
    internal_error = True
3254
 
 
3255
 
    def __init__(self, source_branch, target_branch):
3256
 
        self.source_branch = source_branch
3257
 
        self.target_branch = target_branch
3258
 
 
3259
 
 
3260
 
class NoRoundtrippingSupport(BzrError):
3261
 
 
3262
 
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
3263
 
            "%(target_branch)r.")
3264
 
 
3265
 
    internal_error = True
3266
 
 
3267
 
    def __init__(self, source_branch, target_branch):
3268
 
        self.source_branch = source_branch
3269
 
        self.target_branch = target_branch
3270
 
 
3271
 
 
3272
 
class FileTimestampUnavailable(BzrError):
3273
 
 
3274
 
    _fmt = "The filestamp for %(path)s is not available."
3275
 
 
3276
 
    internal_error = True
3277
 
 
3278
 
    def __init__(self, path):
3279
 
        self.path = path
3280
 
 
3281
 
 
3282
 
class NoColocatedBranchSupport(BzrError):
3283
 
 
3284
 
    _fmt = ("%(bzrdir)r does not support co-located branches.")
3285
 
 
3286
 
    def __init__(self, bzrdir):
3287
 
        self.bzrdir = bzrdir
3288
 
 
3289
 
 
3290
 
class NoWhoami(BzrError):
3291
 
 
3292
 
    _fmt = ('Unable to determine your name.\n'
3293
 
        "Please, set your name with the 'whoami' command.\n"
3294
 
        'E.g. bzr whoami "Your Name <name@example.com>"')
3295
 
 
3296
 
 
3297
 
class InvalidPattern(BzrError):
3298
 
 
3299
 
    _fmt = ('Invalid pattern(s) found. %(msg)s')
3300
 
 
3301
 
    def __init__(self, msg):
3302
 
        self.msg = msg
3303
 
 
3304
 
 
3305
 
class RecursiveBind(BzrError):
3306
 
 
3307
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3308
 
        'Please use `bzr unbind` to fix.')
3309
 
 
3310
 
    def __init__(self, branch_url):
3311
 
        self.branch_url = branch_url
3312
 
 
3313
 
 
3314
 
# FIXME: I would prefer to define the config related exception classes in
3315
 
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3316
 
class OptionExpansionLoop(BzrError):
3317
 
 
3318
 
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3319
 
 
3320
 
    def __init__(self, string, refs):
3321
 
        self.string = string
3322
 
        self.refs = '->'.join(refs)
3323
 
 
3324
 
 
3325
 
class ExpandingUnknownOption(BzrError):
3326
 
 
3327
 
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3328
 
 
3329
 
    def __init__(self, name, string):
3330
 
        self.name = name
3331
 
        self.string = string
3332
 
 
3333
 
 
3334
 
class NoCompatibleInter(BzrError):
3335
 
 
3336
 
    _fmt = ('No compatible object available for operations from %(source)r '
3337
 
            'to %(target)r.')
3338
 
 
3339
 
    def __init__(self, source, target):
3340
 
        self.source = source
3341
 
        self.target = target
3342
 
 
3343
 
 
3344
 
class HpssVfsRequestNotAllowed(BzrError):
3345
 
 
3346
 
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3347
 
            "%(method)s, %(arguments)s.")
3348
 
 
3349
 
    def __init__(self, method, arguments):
3350
 
        self.method = method
3351
 
        self.arguments = arguments