/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
 
 
21
from bzrlib import (
 
22
    osutils,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.patches import (
 
26
    MalformedHunkHeader,
 
27
    MalformedLine,
 
28
    MalformedPatchHeader,
 
29
    PatchConflict,
 
30
    PatchSyntax,
 
31
    )
 
32
 
 
33
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
35
# python exceptions?   A list of values with no names seems less useful 
 
36
# to me.
 
37
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
40
# exceptions that are never raised.
 
41
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
43
# raised can be formatted as a string successfully, and without giving
 
44
# 'unprintable'.
 
45
 
 
46
 
 
47
class BzrError(StandardError):
 
48
    """
 
49
    Base class for errors raised by bzrlib.
 
50
 
 
51
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
52
    should be displayed with a traceback; if False (or absent) 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.)
 
55
 
 
56
    :cvar _fmt: Format string to display the error; this is expanded
 
57
    by the instance's dict.
 
58
    """
 
59
    
 
60
    internal_error = False
 
61
 
 
62
    def __init__(self, msg=None, **kwds):
 
63
        """Construct a new BzrError.
 
64
 
 
65
        There are two alternative forms for constructing these objects.
 
66
        Either a preformatted string may be passed, or a set of named
 
67
        arguments can be given.  The first is for generic "user" errors which
 
68
        are not intended to be caught and so do not need a specific subclass.
 
69
        The second case is for use with subclasses that provide a _fmt format
 
70
        string to print the arguments.  
 
71
 
 
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 
 
75
        parameters.
 
76
 
 
77
        :param msg: If given, this is the literal complete text for the error,
 
78
        not subject to expansion.
 
79
        """
 
80
        StandardError.__init__(self)
 
81
        if msg is not None:
 
82
            # I was going to deprecate this, but it actually turns out to be
 
83
            # quite handy - mbp 20061103.
 
84
            self._preformatted_string = msg
 
85
        else:
 
86
            self._preformatted_string = None
 
87
            for key, value in kwds.items():
 
88
                setattr(self, key, value)
 
89
 
 
90
    def __str__(self):
 
91
        s = getattr(self, '_preformatted_string', None)
 
92
        if s is not None:
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
 
95
        try:
 
96
            fmt = self._get_format_string()
 
97
            if fmt:
 
98
                s = fmt % self.__dict__
 
99
                # __str__() should always return a 'str' object
 
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
 
103
                return s
 
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
106
                % (self.__class__.__name__,
 
107
                   self.__dict__,
 
108
                   getattr(self, '_fmt', None),
 
109
                   e)
 
110
 
 
111
    def _get_format_string(self):
 
112
        """Return format string for this exception or None"""
 
113
        fmt = getattr(self, '_fmt', None)
 
114
        if fmt is not None:
 
115
            return fmt
 
116
        fmt = getattr(self, '__doc__', None)
 
117
        if fmt is not None:
 
118
            symbol_versioning.warn("%s uses its docstring as a format, "
 
119
                    "it should use _fmt instead" % self.__class__.__name__,
 
120
                    DeprecationWarning)
 
121
            return fmt
 
122
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
123
            % (self.__class__.__name__,
 
124
               self.__dict__,
 
125
               getattr(self, '_fmt', None),
 
126
               )
 
127
 
 
128
 
 
129
class BzrNewError(BzrError):
 
130
    """Deprecated error base class."""
 
131
    # base classes should override the docstring with their human-
 
132
    # readable explanation
 
133
 
 
134
    def __init__(self, *args, **kwds):
 
135
        # XXX: Use the underlying BzrError to always generate the args
 
136
        # attribute if it doesn't exist.  We can't use super here, because
 
137
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
138
        # --bmc, 20060426
 
139
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
140
             'please convert %s to use BzrError instead'
 
141
             % self.__class__.__name__,
 
142
             DeprecationWarning,
 
143
             stacklevel=2)
 
144
        BzrError.__init__(self, *args)
 
145
        for key, value in kwds.items():
 
146
            setattr(self, key, value)
 
147
 
 
148
    def __str__(self):
 
149
        try:
 
150
            # __str__() should always return a 'str' object
 
151
            # never a 'unicode' object.
 
152
            s = self.__doc__ % self.__dict__
 
153
            if isinstance(s, unicode):
 
154
                return s.encode('utf8')
 
155
            return s
 
156
        except (TypeError, NameError, ValueError, KeyError), e:
 
157
            return 'Unprintable exception %s(%r): %r' \
 
158
                % (self.__class__.__name__,
 
159
                   self.__dict__, e)
 
160
 
 
161
 
 
162
class AlreadyBuilding(BzrError):
 
163
    
 
164
    _fmt = "The tree builder is already building a tree."
 
165
 
 
166
 
 
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):
 
179
 
 
180
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
181
 
 
182
    internal_error = True
 
183
 
 
184
    def __init__(self, class_name):
 
185
        BzrError.__init__(self)
 
186
        self.class_name = class_name
 
187
 
 
188
 
 
189
class IncompatibleAPI(BzrError):
 
190
 
 
191
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
192
        'It supports versions "%(minimum)s" to "%(current)s".'
 
193
 
 
194
    def __init__(self, api, wanted, minimum, current):
 
195
        self.api = api
 
196
        self.wanted = wanted
 
197
        self.minimum = minimum
 
198
        self.current = current
 
199
 
 
200
 
 
201
class InProcessTransport(BzrError):
 
202
 
 
203
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
204
        "process."
 
205
 
 
206
    def __init__(self, transport):
 
207
        self.transport = transport
 
208
 
 
209
 
 
210
class InvalidEntryName(BzrError):
 
211
    
 
212
    _fmt = "Invalid entry name: %(name)s"
 
213
 
 
214
    internal_error = True
 
215
 
 
216
    def __init__(self, name):
 
217
        BzrError.__init__(self)
 
218
        self.name = name
 
219
 
 
220
 
 
221
class InvalidRevisionNumber(BzrError):
 
222
    
 
223
    _fmt = "Invalid revision number %(revno)s"
 
224
 
 
225
    def __init__(self, revno):
 
226
        BzrError.__init__(self)
 
227
        self.revno = revno
 
228
 
 
229
 
 
230
class InvalidRevisionId(BzrError):
 
231
 
 
232
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
233
 
 
234
    def __init__(self, revision_id, branch):
 
235
        # branch can be any string or object with __str__ defined
 
236
        BzrError.__init__(self)
 
237
        self.revision_id = revision_id
 
238
        self.branch = branch
 
239
 
 
240
class ReservedId(BzrError):
 
241
 
 
242
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
243
 
 
244
    def __init__(self, revision_id):
 
245
        self.revision_id = revision_id
 
246
 
 
247
 
 
248
class NoHelpTopic(BzrError):
 
249
 
 
250
    _fmt = ("No help could be found for '%(topic)s'. "
 
251
        "Please use 'bzr help topics' to obtain a list of topics.")
 
252
 
 
253
    def __init__(self, topic):
 
254
        self.topic = topic
 
255
 
 
256
 
 
257
class NoSuchId(BzrError):
 
258
 
 
259
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
260
    
 
261
    def __init__(self, tree, file_id):
 
262
        BzrError.__init__(self)
 
263
        self.file_id = file_id
 
264
        self.tree = tree
 
265
 
 
266
 
 
267
class NoSuchIdInRepository(NoSuchId):
 
268
 
 
269
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
270
            ' %(repository)r')
 
271
 
 
272
    def __init__(self, repository, file_id):
 
273
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
274
 
 
275
 
 
276
class InventoryModified(BzrError):
 
277
 
 
278
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
279
            " so a clean inventory cannot be read without data loss.")
 
280
 
 
281
    internal_error = True
 
282
 
 
283
    def __init__(self, tree):
 
284
        self.tree = tree
 
285
 
 
286
 
 
287
class NoWorkingTree(BzrError):
 
288
 
 
289
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
290
    
 
291
    def __init__(self, base):
 
292
        BzrError.__init__(self)
 
293
        self.base = base
 
294
 
 
295
 
 
296
class NotBuilding(BzrError):
 
297
 
 
298
    _fmt = "Not currently building a tree."
 
299
 
 
300
 
 
301
class NotLocalUrl(BzrError):
 
302
 
 
303
    _fmt = "%(url)s is not a local path."
 
304
 
 
305
    def __init__(self, url):
 
306
        self.url = url
 
307
 
 
308
 
 
309
class WorkingTreeAlreadyPopulated(BzrError):
 
310
 
 
311
    _fmt = 'Working tree already populated in "%(base)s"'
 
312
 
 
313
    internal_error = True
 
314
 
 
315
    def __init__(self, base):
 
316
        self.base = base
 
317
 
 
318
class BzrCommandError(BzrError):
 
319
    """Error from user command"""
 
320
 
 
321
    internal_error = False
 
322
 
 
323
    # Error from malformed user command; please avoid raising this as a
 
324
    # generic exception not caused by user input.
 
325
    #
 
326
    # I think it's a waste of effort to differentiate between errors that
 
327
    # are not intended to be caught anyway.  UI code need not subclass
 
328
    # BzrCommandError, and non-UI code should not throw a subclass of
 
329
    # BzrCommandError.  ADHB 20051211
 
330
    def __init__(self, msg):
 
331
        # Object.__str__() must return a real string
 
332
        # returning a Unicode string is a python error.
 
333
        if isinstance(msg, unicode):
 
334
            self.msg = msg.encode('utf8')
 
335
        else:
 
336
            self.msg = msg
 
337
 
 
338
    def __str__(self):
 
339
        return self.msg
 
340
 
 
341
 
 
342
class NotWriteLocked(BzrError):
 
343
 
 
344
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
345
 
 
346
    def __init__(self, not_locked):
 
347
        self.not_locked = not_locked
 
348
 
 
349
 
 
350
class BzrOptionError(BzrCommandError):
 
351
 
 
352
    _fmt = "Error in command line options"
 
353
 
 
354
 
 
355
class BadIndexFormatSignature(BzrError):
 
356
 
 
357
    _fmt = "%(value)s is not an index of type %(_type)s."
 
358
 
 
359
    def __init__(self, value, _type):
 
360
        BzrError.__init__(self)
 
361
        self.value = value
 
362
        self._type = _type
 
363
 
 
364
 
 
365
class BadIndexData(BzrError):
 
366
 
 
367
    _fmt = "Error in data for index %(value)s."
 
368
 
 
369
    def __init__(self, value):
 
370
        BzrError.__init__(self)
 
371
        self.value = value
 
372
 
 
373
 
 
374
class BadIndexDuplicateKey(BzrError):
 
375
 
 
376
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
377
 
 
378
    def __init__(self, key, index):
 
379
        BzrError.__init__(self)
 
380
        self.key = key
 
381
        self.index = index
 
382
 
 
383
 
 
384
class BadIndexKey(BzrError):
 
385
 
 
386
    _fmt = "The key '%(key)s' is not a valid key."
 
387
 
 
388
    def __init__(self, key):
 
389
        BzrError.__init__(self)
 
390
        self.key = key
 
391
 
 
392
 
 
393
class BadIndexOptions(BzrError):
 
394
 
 
395
    _fmt = "Could not parse options for index %(value)s."
 
396
 
 
397
    def __init__(self, value):
 
398
        BzrError.__init__(self)
 
399
        self.value = value
 
400
 
 
401
 
 
402
class BadIndexValue(BzrError):
 
403
 
 
404
    _fmt = "The value '%(value)s' is not a valid value."
 
405
 
 
406
    def __init__(self, value):
 
407
        BzrError.__init__(self)
 
408
        self.value = value
 
409
 
 
410
 
 
411
class BadOptionValue(BzrError):
 
412
 
 
413
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
414
 
 
415
    def __init__(self, name, value):
 
416
        BzrError.__init__(self, name=name, value=value)
 
417
 
 
418
    
 
419
class StrictCommitFailed(BzrError):
 
420
 
 
421
    _fmt = "Commit refused because there are unknown files in the tree"
 
422
 
 
423
 
 
424
# XXX: Should be unified with TransportError; they seem to represent the
 
425
# same thing
 
426
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
427
# - this is finer than a TransportError - and more useful as such. It 
 
428
# differentiates between 'transport has failed' and 'operation on a transport
 
429
# has failed.'
 
430
class PathError(BzrError):
 
431
    
 
432
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
433
 
 
434
    def __init__(self, path, extra=None):
 
435
        BzrError.__init__(self)
 
436
        self.path = path
 
437
        if extra:
 
438
            self.extra = ': ' + str(extra)
 
439
        else:
 
440
            self.extra = ''
 
441
 
 
442
 
 
443
class NoSuchFile(PathError):
 
444
 
 
445
    _fmt = "No such file: %(path)r%(extra)s"
 
446
 
 
447
 
 
448
class FileExists(PathError):
 
449
 
 
450
    _fmt = "File exists: %(path)r%(extra)s"
 
451
 
 
452
 
 
453
class RenameFailedFilesExist(BzrError):
 
454
    """Used when renaming and both source and dest exist."""
 
455
 
 
456
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
457
            "%(extra)s")
 
458
 
 
459
    def __init__(self, source, dest, extra=None):
 
460
        BzrError.__init__(self)
 
461
        self.source = str(source)
 
462
        self.dest = str(dest)
 
463
        if extra:
 
464
            self.extra = ' ' + str(extra)
 
465
        else:
 
466
            self.extra = ''
 
467
 
 
468
 
 
469
class NotADirectory(PathError):
 
470
 
 
471
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
472
 
 
473
 
 
474
class NotInWorkingDirectory(PathError):
 
475
 
 
476
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
477
 
 
478
 
 
479
class DirectoryNotEmpty(PathError):
 
480
 
 
481
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
482
 
 
483
 
 
484
class ReadingCompleted(BzrError):
 
485
    
 
486
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
487
            "called upon it - the request has been completed and no more "
 
488
            "data may be read.")
 
489
 
 
490
    internal_error = True
 
491
 
 
492
    def __init__(self, request):
 
493
        self.request = request
 
494
 
 
495
 
 
496
class ResourceBusy(PathError):
 
497
 
 
498
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
499
 
 
500
 
 
501
class PermissionDenied(PathError):
 
502
 
 
503
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
504
 
 
505
 
 
506
class InvalidURL(PathError):
 
507
 
 
508
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
509
 
 
510
 
 
511
class InvalidURLJoin(PathError):
 
512
 
 
513
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
514
 
 
515
    def __init__(self, msg, base, args):
 
516
        PathError.__init__(self, base, msg)
 
517
        self.args = [base] + list(args)
 
518
 
 
519
 
 
520
class UnknownHook(BzrError):
 
521
 
 
522
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
523
 
 
524
    def __init__(self, hook_type, hook_name):
 
525
        BzrError.__init__(self)
 
526
        self.type = hook_type
 
527
        self.hook = hook_name
 
528
 
 
529
 
 
530
class UnsupportedProtocol(PathError):
 
531
 
 
532
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
533
 
 
534
    def __init__(self, url, extra):
 
535
        PathError.__init__(self, url, extra=extra)
 
536
 
 
537
 
 
538
class ReadError(PathError):
 
539
    
 
540
    _fmt = """Error reading from %(path)r."""
 
541
 
 
542
 
 
543
class ShortReadvError(PathError):
 
544
 
 
545
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
546
            ' at %(offset)s for "%(path)s"%(extra)s')
 
547
 
 
548
    internal_error = True
 
549
 
 
550
    def __init__(self, path, offset, length, actual, extra=None):
 
551
        PathError.__init__(self, path, extra=extra)
 
552
        self.offset = offset
 
553
        self.length = length
 
554
        self.actual = actual
 
555
 
 
556
 
 
557
class PathNotChild(PathError):
 
558
 
 
559
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
560
 
 
561
    internal_error = True
 
562
 
 
563
    def __init__(self, path, base, extra=None):
 
564
        BzrError.__init__(self)
 
565
        self.path = path
 
566
        self.base = base
 
567
        if extra:
 
568
            self.extra = ': ' + str(extra)
 
569
        else:
 
570
            self.extra = ''
 
571
 
 
572
 
 
573
class InvalidNormalization(PathError):
 
574
 
 
575
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
576
 
 
577
 
 
578
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
579
# the exception object is a bit undesirable.
 
580
# TODO: Probably this behavior of should be a common superclass 
 
581
class NotBranchError(PathError):
 
582
 
 
583
    _fmt = 'Not a branch: "%(path)s".'
 
584
 
 
585
    def __init__(self, path):
 
586
       import bzrlib.urlutils as urlutils
 
587
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
588
 
 
589
 
 
590
class NoSubmitBranch(PathError):
 
591
 
 
592
    _fmt = 'No submit branch available for branch "%(path)s"'
 
593
 
 
594
    def __init__(self, branch):
 
595
       import bzrlib.urlutils as urlutils
 
596
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
597
 
 
598
 
 
599
class AlreadyBranchError(PathError):
 
600
 
 
601
    _fmt = 'Already a branch: "%(path)s".'
 
602
 
 
603
 
 
604
class BranchExistsWithoutWorkingTree(PathError):
 
605
 
 
606
    _fmt = 'Directory contains a branch, but no working tree \
 
607
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
608
 
 
609
 
 
610
class AtomicFileAlreadyClosed(PathError):
 
611
 
 
612
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
613
            ' "%(path)s"')
 
614
 
 
615
    def __init__(self, path, function):
 
616
        PathError.__init__(self, path=path, extra=None)
 
617
        self.function = function
 
618
 
 
619
 
 
620
class InaccessibleParent(PathError):
 
621
 
 
622
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
623
            ' relative path "%(path)s"')
 
624
 
 
625
    def __init__(self, path, base):
 
626
        PathError.__init__(self, path)
 
627
        self.base = base
 
628
 
 
629
 
 
630
class NoRepositoryPresent(BzrError):
 
631
 
 
632
    _fmt = 'No repository present: "%(path)s"'
 
633
    def __init__(self, bzrdir):
 
634
        BzrError.__init__(self)
 
635
        self.path = bzrdir.transport.clone('..').base
 
636
 
 
637
 
 
638
class FileInWrongBranch(BzrError):
 
639
 
 
640
    _fmt = 'File "%(path)s" in not in branch %(branch_base)s.'
 
641
 
 
642
    def __init__(self, branch, path):
 
643
        BzrError.__init__(self)
 
644
        self.branch = branch
 
645
        self.branch_base = branch.base
 
646
        self.path = path
 
647
 
 
648
 
 
649
class UnsupportedFormatError(BzrError):
 
650
 
 
651
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
652
 
 
653
 
 
654
class UnknownFormatError(BzrError):
 
655
    
 
656
    _fmt = "Unknown branch format: %(format)r"
 
657
 
 
658
 
 
659
class IncompatibleFormat(BzrError):
 
660
    
 
661
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
662
 
 
663
    def __init__(self, format, bzrdir_format):
 
664
        BzrError.__init__(self)
 
665
        self.format = format
 
666
        self.bzrdir = bzrdir_format
 
667
 
 
668
 
 
669
class IncompatibleRepositories(BzrError):
 
670
 
 
671
    _fmt = "Repository %(target)s is not compatible with repository"\
 
672
        " %(source)s"
 
673
 
 
674
    def __init__(self, source, target):
 
675
        BzrError.__init__(self, target=target, source=source)
 
676
 
 
677
 
 
678
class IncompatibleRevision(BzrError):
 
679
    
 
680
    _fmt = "Revision is not compatible with %(repo_format)s"
 
681
 
 
682
    def __init__(self, repo_format):
 
683
        BzrError.__init__(self)
 
684
        self.repo_format = repo_format
 
685
 
 
686
 
 
687
class AlreadyVersionedError(BzrError):
 
688
    """Used when a path is expected not to be versioned, but it is."""
 
689
 
 
690
    _fmt = "%(context_info)s%(path)s is already versioned."
 
691
 
 
692
    def __init__(self, path, context_info=None):
 
693
        """Construct a new AlreadyVersionedError.
 
694
 
 
695
        :param path: This is the path which is versioned,
 
696
        which should be in a user friendly form.
 
697
        :param context_info: If given, this is information about the context,
 
698
        which could explain why this is expected to not be versioned.
 
699
        """
 
700
        BzrError.__init__(self)
 
701
        self.path = path
 
702
        if context_info is None:
 
703
            self.context_info = ''
 
704
        else:
 
705
            self.context_info = context_info + ". "
 
706
 
 
707
 
 
708
class NotVersionedError(BzrError):
 
709
    """Used when a path is expected to be versioned, but it is not."""
 
710
 
 
711
    _fmt = "%(context_info)s%(path)s is not versioned."
 
712
 
 
713
    def __init__(self, path, context_info=None):
 
714
        """Construct a new NotVersionedError.
 
715
 
 
716
        :param path: This is the path which is not versioned,
 
717
        which should be in a user friendly form.
 
718
        :param context_info: If given, this is information about the context,
 
719
        which could explain why this is expected to be versioned.
 
720
        """
 
721
        BzrError.__init__(self)
 
722
        self.path = path
 
723
        if context_info is None:
 
724
            self.context_info = ''
 
725
        else:
 
726
            self.context_info = context_info + ". "
 
727
 
 
728
 
 
729
class PathsNotVersionedError(BzrError):
 
730
    """Used when reporting several paths which are not versioned"""
 
731
 
 
732
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
733
 
 
734
    def __init__(self, paths):
 
735
        from bzrlib.osutils import quotefn
 
736
        BzrError.__init__(self)
 
737
        self.paths = paths
 
738
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
739
 
 
740
 
 
741
class PathsDoNotExist(BzrError):
 
742
 
 
743
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
744
 
 
745
    # used when reporting that paths are neither versioned nor in the working
 
746
    # tree
 
747
 
 
748
    def __init__(self, paths, extra=None):
 
749
        # circular import
 
750
        from bzrlib.osutils import quotefn
 
751
        BzrError.__init__(self)
 
752
        self.paths = paths
 
753
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
754
        if extra:
 
755
            self.extra = ': ' + str(extra)
 
756
        else:
 
757
            self.extra = ''
 
758
 
 
759
 
 
760
class BadFileKindError(BzrError):
 
761
 
 
762
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
763
 
 
764
    def __init__(self, filename, kind):
 
765
        BzrError.__init__(self, filename=filename, kind=kind)
 
766
 
 
767
 
 
768
class ForbiddenControlFileError(BzrError):
 
769
 
 
770
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
771
 
 
772
 
 
773
class LockError(BzrError):
 
774
 
 
775
    _fmt = "Lock error: %(msg)s"
 
776
 
 
777
    internal_error = True
 
778
 
 
779
    # All exceptions from the lock/unlock functions should be from
 
780
    # this exception class.  They will be translated as necessary. The
 
781
    # original exception is available as e.original_error
 
782
    #
 
783
    # New code should prefer to raise specific subclasses
 
784
    def __init__(self, message):
 
785
        # Python 2.5 uses a slot for StandardError.message,
 
786
        # so use a different variable name
 
787
        # so it is exposed in self.__dict__
 
788
        self.msg = message
 
789
 
 
790
 
 
791
class LockActive(LockError):
 
792
 
 
793
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
794
 
 
795
    internal_error = False
 
796
 
 
797
    def __init__(self, lock_description):
 
798
        self.lock_description = lock_description
 
799
 
 
800
 
 
801
class CommitNotPossible(LockError):
 
802
 
 
803
    _fmt = "A commit was attempted but we do not have a write lock open."
 
804
 
 
805
    def __init__(self):
 
806
        pass
 
807
 
 
808
 
 
809
class AlreadyCommitted(LockError):
 
810
 
 
811
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
812
 
 
813
    def __init__(self):
 
814
        pass
 
815
 
 
816
 
 
817
class ReadOnlyError(LockError):
 
818
 
 
819
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
820
 
 
821
    # TODO: There should also be an error indicating that you need a write
 
822
    # lock and don't have any lock at all... mbp 20070226
 
823
 
 
824
    def __init__(self, obj):
 
825
        self.obj = obj
 
826
 
 
827
 
 
828
class ReadOnlyLockError(LockError):
 
829
 
 
830
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
831
 
 
832
    def __init__(self, fname, msg):
 
833
        LockError.__init__(self, '')
 
834
        self.fname = fname
 
835
        self.msg = msg
 
836
 
 
837
 
 
838
class OutSideTransaction(BzrError):
 
839
 
 
840
    _fmt = ("A transaction related operation was attempted after"
 
841
            " the transaction finished.")
 
842
 
 
843
 
 
844
class ObjectNotLocked(LockError):
 
845
 
 
846
    _fmt = "%(obj)r is not locked"
 
847
 
 
848
    # this can indicate that any particular object is not locked; see also
 
849
    # LockNotHeld which means that a particular *lock* object is not held by
 
850
    # the caller -- perhaps they should be unified.
 
851
    def __init__(self, obj):
 
852
        self.obj = obj
 
853
 
 
854
 
 
855
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
856
 
 
857
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
858
 
 
859
    def __init__(self, obj):
 
860
        self.obj = obj
 
861
 
 
862
 
 
863
class UnlockableTransport(LockError):
 
864
 
 
865
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
866
 
 
867
    def __init__(self, transport):
 
868
        self.transport = transport
 
869
 
 
870
 
 
871
class LockContention(LockError):
 
872
 
 
873
    _fmt = 'Could not acquire lock "%(lock)s"'
 
874
    # TODO: show full url for lock, combining the transport and relative
 
875
    # bits?
 
876
 
 
877
    internal_error = False
 
878
 
 
879
    def __init__(self, lock):
 
880
        self.lock = lock
 
881
 
 
882
 
 
883
class LockBroken(LockError):
 
884
 
 
885
    _fmt = ("Lock was broken while still open: %(lock)s"
 
886
            " - check storage consistency!")
 
887
 
 
888
    internal_error = False
 
889
 
 
890
    def __init__(self, lock):
 
891
        self.lock = lock
 
892
 
 
893
 
 
894
class LockBreakMismatch(LockError):
 
895
 
 
896
    _fmt = ("Lock was released and re-acquired before being broken:"
 
897
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
898
 
 
899
    internal_error = False
 
900
 
 
901
    def __init__(self, lock, holder, target):
 
902
        self.lock = lock
 
903
        self.holder = holder
 
904
        self.target = target
 
905
 
 
906
 
 
907
class LockNotHeld(LockError):
 
908
 
 
909
    _fmt = "Lock not held: %(lock)s"
 
910
 
 
911
    internal_error = False
 
912
 
 
913
    def __init__(self, lock):
 
914
        self.lock = lock
 
915
 
 
916
 
 
917
class TokenLockingNotSupported(LockError):
 
918
 
 
919
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
920
 
 
921
    internal_error = True
 
922
 
 
923
    def __init__(self, obj):
 
924
        self.obj = obj
 
925
 
 
926
 
 
927
class TokenMismatch(LockBroken):
 
928
 
 
929
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
930
 
 
931
    internal_error = True
 
932
 
 
933
    def __init__(self, given_token, lock_token):
 
934
        self.given_token = given_token
 
935
        self.lock_token = lock_token
 
936
 
 
937
 
 
938
class PointlessCommit(BzrError):
 
939
 
 
940
    _fmt = "No changes to commit"
 
941
 
 
942
 
 
943
class CannotCommitSelectedFileMerge(BzrError):
 
944
 
 
945
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
946
        ' files %(files_str)s'
 
947
 
 
948
    def __init__(self, files):
 
949
        files_str = ', '.join(files)
 
950
        BzrError.__init__(self, files=files, files_str=files_str)
 
951
 
 
952
 
 
953
class BadCommitMessageEncoding(BzrError):
 
954
 
 
955
    _fmt = 'The specified commit message contains characters unsupported by '\
 
956
        'the current encoding.'
 
957
 
 
958
 
 
959
class UpgradeReadonly(BzrError):
 
960
 
 
961
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
962
 
 
963
 
 
964
class UpToDateFormat(BzrError):
 
965
 
 
966
    _fmt = "The branch format %(format)s is already at the most recent format."
 
967
 
 
968
    def __init__(self, format):
 
969
        BzrError.__init__(self)
 
970
        self.format = format
 
971
 
 
972
 
 
973
class StrictCommitFailed(Exception):
 
974
 
 
975
    _fmt = "Commit refused because there are unknowns in the tree."
 
976
 
 
977
 
 
978
class NoSuchRevision(BzrError):
 
979
 
 
980
    _fmt = "%(branch)s has no revision %(revision)s"
 
981
 
 
982
    internal_error = True
 
983
 
 
984
    def __init__(self, branch, revision):
 
985
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
986
        BzrError.__init__(self, branch=branch, revision=revision)
 
987
 
 
988
 
 
989
# zero_ninetyone: this exception is no longer raised and should be removed
 
990
class NotLeftParentDescendant(BzrError):
 
991
 
 
992
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
993
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
994
 
 
995
    internal_error = True
 
996
 
 
997
    def __init__(self, branch, old_revision, new_revision):
 
998
        BzrError.__init__(self, branch_location=branch.base,
 
999
                          old_revision=old_revision,
 
1000
                          new_revision=new_revision)
 
1001
 
 
1002
 
 
1003
class NoSuchRevisionSpec(BzrError):
 
1004
 
 
1005
    _fmt = "No namespace registered for string: %(spec)r"
 
1006
 
 
1007
    def __init__(self, spec):
 
1008
        BzrError.__init__(self, spec=spec)
 
1009
 
 
1010
 
 
1011
class NoSuchRevisionInTree(NoSuchRevision):
 
1012
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1013
    
 
1014
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1015
 
 
1016
    def __init__(self, tree, revision_id):
 
1017
        BzrError.__init__(self)
 
1018
        self.tree = tree
 
1019
        self.revision_id = revision_id
 
1020
 
 
1021
 
 
1022
class InvalidRevisionSpec(BzrError):
 
1023
 
 
1024
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1025
            " %(branch)s%(extra)s")
 
1026
 
 
1027
    def __init__(self, spec, branch, extra=None):
 
1028
        BzrError.__init__(self, branch=branch, spec=spec)
 
1029
        if extra:
 
1030
            self.extra = '\n' + str(extra)
 
1031
        else:
 
1032
            self.extra = ''
 
1033
 
 
1034
 
 
1035
class HistoryMissing(BzrError):
 
1036
 
 
1037
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1038
 
 
1039
 
 
1040
class AppendRevisionsOnlyViolation(BzrError):
 
1041
 
 
1042
    _fmt = ('Operation denied because it would change the main history,'
 
1043
           ' which is not permitted by the append_revisions_only setting on'
 
1044
           ' branch "%(location)s".')
 
1045
 
 
1046
    def __init__(self, location):
 
1047
       import bzrlib.urlutils as urlutils
 
1048
       location = urlutils.unescape_for_display(location, 'ascii')
 
1049
       BzrError.__init__(self, location=location)
 
1050
 
 
1051
 
 
1052
class DivergedBranches(BzrError):
 
1053
 
 
1054
    _fmt = ("These branches have diverged."
 
1055
            " Use the merge command to reconcile them.")
 
1056
 
 
1057
    internal_error = False
 
1058
 
 
1059
    def __init__(self, branch1, branch2):
 
1060
        self.branch1 = branch1
 
1061
        self.branch2 = branch2
 
1062
 
 
1063
 
 
1064
class NotLefthandHistory(BzrError):
 
1065
 
 
1066
    _fmt = "Supplied history does not follow left-hand parents"
 
1067
 
 
1068
    internal_error = True
 
1069
 
 
1070
    def __init__(self, history):
 
1071
        BzrError.__init__(self, history=history)
 
1072
 
 
1073
 
 
1074
class UnrelatedBranches(BzrError):
 
1075
 
 
1076
    _fmt = ("Branches have no common ancestor, and"
 
1077
            " no merge base revision was specified.")
 
1078
 
 
1079
    internal_error = False
 
1080
 
 
1081
 
 
1082
class NoCommonAncestor(BzrError):
 
1083
    
 
1084
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1085
 
 
1086
    def __init__(self, revision_a, revision_b):
 
1087
        self.revision_a = revision_a
 
1088
        self.revision_b = revision_b
 
1089
 
 
1090
 
 
1091
class NoCommonRoot(BzrError):
 
1092
 
 
1093
    _fmt = ("Revisions are not derived from the same root: "
 
1094
           "%(revision_a)s %(revision_b)s.")
 
1095
 
 
1096
    def __init__(self, revision_a, revision_b):
 
1097
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1098
 
 
1099
 
 
1100
class NotAncestor(BzrError):
 
1101
 
 
1102
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1103
 
 
1104
    def __init__(self, rev_id, not_ancestor_id):
 
1105
        BzrError.__init__(self, rev_id=rev_id,
 
1106
            not_ancestor_id=not_ancestor_id)
 
1107
 
 
1108
 
 
1109
class InstallFailed(BzrError):
 
1110
 
 
1111
    def __init__(self, revisions):
 
1112
        revision_str = ", ".join(str(r) for r in revisions)
 
1113
        msg = "Could not install revisions:\n%s" % revision_str
 
1114
        BzrError.__init__(self, msg)
 
1115
        self.revisions = revisions
 
1116
 
 
1117
 
 
1118
class AmbiguousBase(BzrError):
 
1119
 
 
1120
    def __init__(self, bases):
 
1121
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1122
                DeprecationWarning)
 
1123
        msg = ("The correct base is unclear, because %s are all equally close"
 
1124
                % ", ".join(bases))
 
1125
        BzrError.__init__(self, msg)
 
1126
        self.bases = bases
 
1127
 
 
1128
 
 
1129
class NoCommits(BzrError):
 
1130
 
 
1131
    _fmt = "Branch %(branch)s has no commits."
 
1132
 
 
1133
    def __init__(self, branch):
 
1134
        BzrError.__init__(self, branch=branch)
 
1135
 
 
1136
 
 
1137
class UnlistableStore(BzrError):
 
1138
 
 
1139
    def __init__(self, store):
 
1140
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1141
 
 
1142
 
 
1143
 
 
1144
class UnlistableBranch(BzrError):
 
1145
 
 
1146
    def __init__(self, br):
 
1147
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1148
 
 
1149
 
 
1150
class BoundBranchOutOfDate(BzrError):
 
1151
 
 
1152
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1153
            " %(master)s.")
 
1154
 
 
1155
    def __init__(self, branch, master):
 
1156
        BzrError.__init__(self)
 
1157
        self.branch = branch
 
1158
        self.master = master
 
1159
 
 
1160
        
 
1161
class CommitToDoubleBoundBranch(BzrError):
 
1162
 
 
1163
    _fmt = ("Cannot commit to branch %(branch)s."
 
1164
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1165
 
 
1166
    def __init__(self, branch, master, remote):
 
1167
        BzrError.__init__(self)
 
1168
        self.branch = branch
 
1169
        self.master = master
 
1170
        self.remote = remote
 
1171
 
 
1172
 
 
1173
class OverwriteBoundBranch(BzrError):
 
1174
 
 
1175
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1176
 
 
1177
    def __init__(self, branch):
 
1178
        BzrError.__init__(self)
 
1179
        self.branch = branch
 
1180
 
 
1181
 
 
1182
class BoundBranchConnectionFailure(BzrError):
 
1183
 
 
1184
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1185
            " => %(target)s: %(error)s")
 
1186
 
 
1187
    def __init__(self, branch, target, error):
 
1188
        BzrError.__init__(self)
 
1189
        self.branch = branch
 
1190
        self.target = target
 
1191
        self.error = error
 
1192
 
 
1193
 
 
1194
class WeaveError(BzrError):
 
1195
 
 
1196
    _fmt = "Error in processing weave: %(message)s"
 
1197
 
 
1198
    def __init__(self, message=None):
 
1199
        BzrError.__init__(self)
 
1200
        self.message = message
 
1201
 
 
1202
 
 
1203
class WeaveRevisionAlreadyPresent(WeaveError):
 
1204
 
 
1205
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1206
 
 
1207
    def __init__(self, revision_id, weave):
 
1208
 
 
1209
        WeaveError.__init__(self)
 
1210
        self.revision_id = revision_id
 
1211
        self.weave = weave
 
1212
 
 
1213
 
 
1214
class WeaveRevisionNotPresent(WeaveError):
 
1215
 
 
1216
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1217
 
 
1218
    def __init__(self, revision_id, weave):
 
1219
        WeaveError.__init__(self)
 
1220
        self.revision_id = revision_id
 
1221
        self.weave = weave
 
1222
 
 
1223
 
 
1224
class WeaveFormatError(WeaveError):
 
1225
 
 
1226
    _fmt = "Weave invariant violated: %(what)s"
 
1227
 
 
1228
    def __init__(self, what):
 
1229
        WeaveError.__init__(self)
 
1230
        self.what = what
 
1231
 
 
1232
 
 
1233
class WeaveParentMismatch(WeaveError):
 
1234
 
 
1235
    _fmt = "Parents are mismatched between two revisions."
 
1236
    
 
1237
 
 
1238
class WeaveInvalidChecksum(WeaveError):
 
1239
 
 
1240
    _fmt = "Text did not match it's checksum: %(message)s"
 
1241
 
 
1242
 
 
1243
class WeaveTextDiffers(WeaveError):
 
1244
 
 
1245
    _fmt = ("Weaves differ on text content. Revision:"
 
1246
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1247
 
 
1248
    def __init__(self, revision_id, weave_a, weave_b):
 
1249
        WeaveError.__init__(self)
 
1250
        self.revision_id = revision_id
 
1251
        self.weave_a = weave_a
 
1252
        self.weave_b = weave_b
 
1253
 
 
1254
 
 
1255
class WeaveTextDiffers(WeaveError):
 
1256
 
 
1257
    _fmt = ("Weaves differ on text content. Revision:"
 
1258
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1259
 
 
1260
    def __init__(self, revision_id, weave_a, weave_b):
 
1261
        WeaveError.__init__(self)
 
1262
        self.revision_id = revision_id
 
1263
        self.weave_a = weave_a
 
1264
        self.weave_b = weave_b
 
1265
 
 
1266
 
 
1267
class VersionedFileError(BzrError):
 
1268
    
 
1269
    _fmt = "Versioned file error"
 
1270
 
 
1271
 
 
1272
class RevisionNotPresent(VersionedFileError):
 
1273
    
 
1274
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1275
 
 
1276
    def __init__(self, revision_id, file_id):
 
1277
        VersionedFileError.__init__(self)
 
1278
        self.revision_id = revision_id
 
1279
        self.file_id = file_id
 
1280
 
 
1281
 
 
1282
class RevisionAlreadyPresent(VersionedFileError):
 
1283
    
 
1284
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1285
 
 
1286
    def __init__(self, revision_id, file_id):
 
1287
        VersionedFileError.__init__(self)
 
1288
        self.revision_id = revision_id
 
1289
        self.file_id = file_id
 
1290
 
 
1291
 
 
1292
class VersionedFileInvalidChecksum(VersionedFileError):
 
1293
 
 
1294
    _fmt = "Text did not match its checksum: %(message)s"
 
1295
 
 
1296
 
 
1297
class KnitError(BzrError):
 
1298
    
 
1299
    _fmt = "Knit error"
 
1300
 
 
1301
    internal_error = True
 
1302
 
 
1303
 
 
1304
class KnitHeaderError(KnitError):
 
1305
 
 
1306
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1307
 
 
1308
    def __init__(self, badline, filename):
 
1309
        KnitError.__init__(self)
 
1310
        self.badline = badline
 
1311
        self.filename = filename
 
1312
 
 
1313
 
 
1314
class KnitCorrupt(KnitError):
 
1315
 
 
1316
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1317
 
 
1318
    def __init__(self, filename, how):
 
1319
        KnitError.__init__(self)
 
1320
        self.filename = filename
 
1321
        self.how = how
 
1322
 
 
1323
 
 
1324
class KnitIndexUnknownMethod(KnitError):
 
1325
    """Raised when we don't understand the storage method.
 
1326
 
 
1327
    Currently only 'fulltext' and 'line-delta' are supported.
 
1328
    """
 
1329
    
 
1330
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1331
            " in options: %(options)r")
 
1332
 
 
1333
    def __init__(self, filename, options):
 
1334
        KnitError.__init__(self)
 
1335
        self.filename = filename
 
1336
        self.options = options
 
1337
 
 
1338
 
 
1339
class NoSuchExportFormat(BzrError):
 
1340
    
 
1341
    _fmt = "Export format %(format)r not supported"
 
1342
 
 
1343
    def __init__(self, format):
 
1344
        BzrError.__init__(self)
 
1345
        self.format = format
 
1346
 
 
1347
 
 
1348
class TransportError(BzrError):
 
1349
    
 
1350
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1351
 
 
1352
    def __init__(self, msg=None, orig_error=None):
 
1353
        if msg is None and orig_error is not None:
 
1354
            msg = str(orig_error)
 
1355
        if orig_error is None:
 
1356
            orig_error = ''
 
1357
        if msg is None:
 
1358
            msg =  ''
 
1359
        self.msg = msg
 
1360
        self.orig_error = orig_error
 
1361
        BzrError.__init__(self)
 
1362
 
 
1363
 
 
1364
class TooManyConcurrentRequests(BzrError):
 
1365
 
 
1366
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1367
            " Be sure to finish_writing and finish_reading on the"
 
1368
            " currently open request.")
 
1369
 
 
1370
    internal_error = True
 
1371
 
 
1372
    def __init__(self, medium):
 
1373
        self.medium = medium
 
1374
 
 
1375
 
 
1376
class SmartProtocolError(TransportError):
 
1377
 
 
1378
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1379
 
 
1380
    def __init__(self, details):
 
1381
        self.details = details
 
1382
 
 
1383
 
 
1384
# A set of semi-meaningful errors which can be thrown
 
1385
class TransportNotPossible(TransportError):
 
1386
 
 
1387
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1388
 
 
1389
 
 
1390
class ConnectionError(TransportError):
 
1391
 
 
1392
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1393
 
 
1394
 
 
1395
class SocketConnectionError(ConnectionError):
 
1396
 
 
1397
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1398
 
 
1399
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1400
        if msg is None:
 
1401
            msg = 'Failed to connect to'
 
1402
        if orig_error is None:
 
1403
            orig_error = ''
 
1404
        else:
 
1405
            orig_error = '; ' + str(orig_error)
 
1406
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1407
        self.host = host
 
1408
        if port is None:
 
1409
            self.port = ''
 
1410
        else:
 
1411
            self.port = ':%s' % port
 
1412
 
 
1413
 
 
1414
class ConnectionReset(TransportError):
 
1415
 
 
1416
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1417
 
 
1418
 
 
1419
class InvalidRange(TransportError):
 
1420
 
 
1421
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1422
    
 
1423
    def __init__(self, path, offset):
 
1424
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1425
                                       % (path, offset)))
 
1426
        self.path = path
 
1427
        self.offset = offset
 
1428
 
 
1429
 
 
1430
class InvalidHttpResponse(TransportError):
 
1431
 
 
1432
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1433
 
 
1434
    def __init__(self, path, msg, orig_error=None):
 
1435
        self.path = path
 
1436
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1437
 
 
1438
 
 
1439
class InvalidHttpRange(InvalidHttpResponse):
 
1440
 
 
1441
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1442
    
 
1443
    def __init__(self, path, range, msg):
 
1444
        self.range = range
 
1445
        InvalidHttpResponse.__init__(self, path, msg)
 
1446
 
 
1447
 
 
1448
class InvalidHttpContentType(InvalidHttpResponse):
 
1449
 
 
1450
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1451
    
 
1452
    def __init__(self, path, ctype, msg):
 
1453
        self.ctype = ctype
 
1454
        InvalidHttpResponse.__init__(self, path, msg)
 
1455
 
 
1456
 
 
1457
class RedirectRequested(TransportError):
 
1458
 
 
1459
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1460
 
 
1461
    def __init__(self, source, target, is_permament=False, qual_proto=None):
 
1462
        self.source = source
 
1463
        self.target = target
 
1464
        if is_permament:
 
1465
            self.permanently = ' permanently'
 
1466
        else:
 
1467
            self.permanently = ''
 
1468
        self.is_permament = is_permament
 
1469
        self._qualified_proto = qual_proto
 
1470
        TransportError.__init__(self)
 
1471
 
 
1472
    def _requalify_url(self, url):
 
1473
        """Restore the qualified proto in front of the url"""
 
1474
        # When this exception is raised, source and target are in
 
1475
        # user readable format. But some transports may use a
 
1476
        # different proto (http+urllib:// will present http:// to
 
1477
        # the user. If a qualified proto is specified, the code
 
1478
        # trapping the exception can get the qualified urls to
 
1479
        # properly handle the redirection themself (creating a
 
1480
        # new transport object from the target url for example).
 
1481
        # But checking that the scheme of the original and
 
1482
        # redirected urls are the same can be tricky. (see the
 
1483
        # FIXME in BzrDir.open_from_transport for the unique use
 
1484
        # case so far).
 
1485
        if self._qualified_proto is None:
 
1486
            return url
 
1487
 
 
1488
        # The TODO related to NotBranchError mention that doing
 
1489
        # that kind of manipulation on the urls may not be the
 
1490
        # exception object job. On the other hand, this object is
 
1491
        # the interface between the code and the user so
 
1492
        # presenting the urls in different ways is indeed its
 
1493
        # job...
 
1494
        import urlparse
 
1495
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1496
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1497
                                   query, fragment))
 
1498
 
 
1499
    def get_source_url(self):
 
1500
        return self._requalify_url(self.source)
 
1501
 
 
1502
    def get_target_url(self):
 
1503
        return self._requalify_url(self.target)
 
1504
 
 
1505
 
 
1506
class TooManyRedirections(TransportError):
 
1507
 
 
1508
    _fmt = "Too many redirections"
 
1509
 
 
1510
class ConflictsInTree(BzrError):
 
1511
 
 
1512
    _fmt = "Working tree has conflicts."
 
1513
 
 
1514
 
 
1515
class ParseConfigError(BzrError):
 
1516
 
 
1517
    def __init__(self, errors, filename):
 
1518
        if filename is None:
 
1519
            filename = ""
 
1520
        message = "Error(s) parsing config file %s:\n%s" % \
 
1521
            (filename, ('\n'.join(e.message for e in errors)))
 
1522
        BzrError.__init__(self, message)
 
1523
 
 
1524
 
 
1525
class NoEmailInUsername(BzrError):
 
1526
 
 
1527
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1528
 
 
1529
    def __init__(self, username):
 
1530
        BzrError.__init__(self)
 
1531
        self.username = username
 
1532
 
 
1533
 
 
1534
class SigningFailed(BzrError):
 
1535
 
 
1536
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1537
 
 
1538
    def __init__(self, command_line):
 
1539
        BzrError.__init__(self, command_line=command_line)
 
1540
 
 
1541
 
 
1542
class WorkingTreeNotRevision(BzrError):
 
1543
 
 
1544
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1545
            " the last commit, but weave merge requires that it be"
 
1546
            " unchanged")
 
1547
 
 
1548
    def __init__(self, tree):
 
1549
        BzrError.__init__(self, basedir=tree.basedir)
 
1550
 
 
1551
 
 
1552
class CantReprocessAndShowBase(BzrError):
 
1553
 
 
1554
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1555
           "the relationship of conflicting lines to the base")
 
1556
 
 
1557
 
 
1558
class GraphCycleError(BzrError):
 
1559
 
 
1560
    _fmt = "Cycle in graph %(graph)r"
 
1561
 
 
1562
    def __init__(self, graph):
 
1563
        BzrError.__init__(self)
 
1564
        self.graph = graph
 
1565
 
 
1566
 
 
1567
class WritingCompleted(BzrError):
 
1568
 
 
1569
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1570
            "called upon it - accept bytes may not be called anymore.")
 
1571
 
 
1572
    internal_error = True
 
1573
 
 
1574
    def __init__(self, request):
 
1575
        self.request = request
 
1576
 
 
1577
 
 
1578
class WritingNotComplete(BzrError):
 
1579
 
 
1580
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1581
            "called upon it - until the write phase is complete no "
 
1582
            "data may be read.")
 
1583
 
 
1584
    internal_error = True
 
1585
 
 
1586
    def __init__(self, request):
 
1587
        self.request = request
 
1588
 
 
1589
 
 
1590
class NotConflicted(BzrError):
 
1591
 
 
1592
    _fmt = "File %(filename)s is not conflicted."
 
1593
 
 
1594
    def __init__(self, filename):
 
1595
        BzrError.__init__(self)
 
1596
        self.filename = filename
 
1597
 
 
1598
 
 
1599
class MediumNotConnected(BzrError):
 
1600
 
 
1601
    _fmt = """The medium '%(medium)s' is not connected."""
 
1602
 
 
1603
    internal_error = True
 
1604
 
 
1605
    def __init__(self, medium):
 
1606
        self.medium = medium
 
1607
 
 
1608
 
 
1609
class MustUseDecorated(Exception):
 
1610
 
 
1611
    _fmt = "A decorating function has requested its original command be used."
 
1612
 
 
1613
 
 
1614
class NoBundleFound(BzrError):
 
1615
 
 
1616
    _fmt = 'No bundle was found in "%(filename)s".'
 
1617
 
 
1618
    def __init__(self, filename):
 
1619
        BzrError.__init__(self)
 
1620
        self.filename = filename
 
1621
 
 
1622
 
 
1623
class BundleNotSupported(BzrError):
 
1624
 
 
1625
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1626
 
 
1627
    def __init__(self, version, msg):
 
1628
        BzrError.__init__(self)
 
1629
        self.version = version
 
1630
        self.msg = msg
 
1631
 
 
1632
 
 
1633
class MissingText(BzrError):
 
1634
 
 
1635
    _fmt = ("Branch %(base)s is missing revision"
 
1636
            " %(text_revision)s of %(file_id)s")
 
1637
 
 
1638
    def __init__(self, branch, text_revision, file_id):
 
1639
        BzrError.__init__(self)
 
1640
        self.branch = branch
 
1641
        self.base = branch.base
 
1642
        self.text_revision = text_revision
 
1643
        self.file_id = file_id
 
1644
 
 
1645
 
 
1646
class DuplicateFileId(BzrError):
 
1647
 
 
1648
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1649
 
 
1650
    def __init__(self, file_id, entry):
 
1651
        BzrError.__init__(self)
 
1652
        self.file_id = file_id
 
1653
        self.entry = entry
 
1654
 
 
1655
 
 
1656
class DuplicateKey(BzrError):
 
1657
 
 
1658
    _fmt = "Key %(key)s is already present in map"
 
1659
 
 
1660
 
 
1661
class DuplicateHelpPrefix(BzrError):
 
1662
 
 
1663
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1664
 
 
1665
    def __init__(self, prefix):
 
1666
        self.prefix = prefix
 
1667
 
 
1668
 
 
1669
class MalformedTransform(BzrError):
 
1670
 
 
1671
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1672
 
 
1673
 
 
1674
class NoFinalPath(BzrError):
 
1675
 
 
1676
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1677
            "file-id: %(file_id)r\n"
 
1678
            "root trans-id: %(root_trans_id)r\n")
 
1679
 
 
1680
    def __init__(self, trans_id, transform):
 
1681
        self.trans_id = trans_id
 
1682
        self.file_id = transform.final_file_id(trans_id)
 
1683
        self.root_trans_id = transform.root
 
1684
 
 
1685
 
 
1686
class BzrBadParameter(BzrError):
 
1687
 
 
1688
    _fmt = "Bad parameter: %(param)r"
 
1689
 
 
1690
    internal_error = True
 
1691
 
 
1692
    # This exception should never be thrown, but it is a base class for all
 
1693
    # parameter-to-function errors.
 
1694
 
 
1695
    def __init__(self, param):
 
1696
        BzrError.__init__(self)
 
1697
        self.param = param
 
1698
 
 
1699
 
 
1700
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1701
 
 
1702
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1703
 
 
1704
 
 
1705
class ReusingTransform(BzrError):
 
1706
 
 
1707
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1708
 
 
1709
 
 
1710
class CantMoveRoot(BzrError):
 
1711
 
 
1712
    _fmt = "Moving the root directory is not supported at this time"
 
1713
 
 
1714
 
 
1715
class BzrMoveFailedError(BzrError):
 
1716
 
 
1717
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1718
 
 
1719
    def __init__(self, from_path='', to_path='', extra=None):
 
1720
        BzrError.__init__(self)
 
1721
        if extra:
 
1722
            self.extra = ': ' + str(extra)
 
1723
        else:
 
1724
            self.extra = ''
 
1725
 
 
1726
        has_from = len(from_path) > 0
 
1727
        has_to = len(to_path) > 0
 
1728
        if has_from:
 
1729
            self.from_path = osutils.splitpath(from_path)[-1]
 
1730
        else:
 
1731
            self.from_path = ''
 
1732
 
 
1733
        if has_to:
 
1734
            self.to_path = osutils.splitpath(to_path)[-1]
 
1735
        else:
 
1736
            self.to_path = ''
 
1737
 
 
1738
        self.operator = ""
 
1739
        if has_from and has_to:
 
1740
            self.operator = " =>"
 
1741
        elif has_from:
 
1742
            self.from_path = "from " + from_path
 
1743
        elif has_to:
 
1744
            self.operator = "to"
 
1745
        else:
 
1746
            self.operator = "file"
 
1747
 
 
1748
 
 
1749
class BzrRenameFailedError(BzrMoveFailedError):
 
1750
 
 
1751
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1752
 
 
1753
    def __init__(self, from_path, to_path, extra=None):
 
1754
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1755
 
 
1756
class BzrRemoveChangedFilesError(BzrError):
 
1757
    """Used when user is trying to remove changed files."""
 
1758
 
 
1759
    _fmt = ("Can't remove changed or unknown files:\n%(changes_as_text)s"
 
1760
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1761
 
 
1762
    def __init__(self, tree_delta):
 
1763
        BzrError.__init__(self)
 
1764
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1765
        #self.paths_as_string = '\n'.join(changed_files)
 
1766
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1767
 
 
1768
 
 
1769
class BzrBadParameterNotString(BzrBadParameter):
 
1770
 
 
1771
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1772
 
 
1773
 
 
1774
class BzrBadParameterMissing(BzrBadParameter):
 
1775
 
 
1776
    _fmt = "Parameter $(param)s is required but not present."
 
1777
 
 
1778
 
 
1779
class BzrBadParameterUnicode(BzrBadParameter):
 
1780
 
 
1781
    _fmt = ("Parameter %(param)s is unicode but"
 
1782
            " only byte-strings are permitted.")
 
1783
 
 
1784
 
 
1785
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1786
 
 
1787
    _fmt = "Parameter %(param)s contains a newline."
 
1788
 
 
1789
 
 
1790
class DependencyNotPresent(BzrError):
 
1791
 
 
1792
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1793
 
 
1794
    def __init__(self, library, error):
 
1795
        BzrError.__init__(self, library=library, error=error)
 
1796
 
 
1797
 
 
1798
class ParamikoNotPresent(DependencyNotPresent):
 
1799
 
 
1800
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1801
 
 
1802
    def __init__(self, error):
 
1803
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1804
 
 
1805
 
 
1806
class PointlessMerge(BzrError):
 
1807
 
 
1808
    _fmt = "Nothing to merge."
 
1809
 
 
1810
 
 
1811
class UninitializableFormat(BzrError):
 
1812
 
 
1813
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1814
 
 
1815
    def __init__(self, format):
 
1816
        BzrError.__init__(self)
 
1817
        self.format = format
 
1818
 
 
1819
 
 
1820
class BadConversionTarget(BzrError):
 
1821
 
 
1822
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1823
 
 
1824
    def __init__(self, problem, format):
 
1825
        BzrError.__init__(self)
 
1826
        self.problem = problem
 
1827
        self.format = format
 
1828
 
 
1829
 
 
1830
class NoDiff(BzrError):
 
1831
 
 
1832
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1833
 
 
1834
    def __init__(self, msg):
 
1835
        BzrError.__init__(self, msg=msg)
 
1836
 
 
1837
 
 
1838
class NoDiff3(BzrError):
 
1839
 
 
1840
    _fmt = "Diff3 is not installed on this machine."
 
1841
 
 
1842
 
 
1843
class ExistingLimbo(BzrError):
 
1844
 
 
1845
    _fmt = """This tree contains left-over files from a failed operation.
 
1846
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1847
    keep, and delete it when you are done."""
 
1848
    
 
1849
    def __init__(self, limbo_dir):
 
1850
       BzrError.__init__(self)
 
1851
       self.limbo_dir = limbo_dir
 
1852
 
 
1853
 
 
1854
class ExistingPendingDeletion(BzrError):
 
1855
 
 
1856
    _fmt = """This tree contains left-over files from a failed operation.
 
1857
    Please examine %(pending_deletion)s to see if it contains any files you
 
1858
    wish to keep, and delete it when you are done."""
 
1859
 
 
1860
    def __init__(self, pending_deletion):
 
1861
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1862
 
 
1863
 
 
1864
class ImmortalLimbo(BzrError):
 
1865
 
 
1866
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1867
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1868
    keep, and delete it when you are done."""
 
1869
 
 
1870
    def __init__(self, limbo_dir):
 
1871
       BzrError.__init__(self)
 
1872
       self.limbo_dir = limbo_dir
 
1873
 
 
1874
 
 
1875
class ImmortalPendingDeletion(BzrError):
 
1876
 
 
1877
    _fmt = """Unable to delete transform temporary directory
 
1878
    %(pending_deletion)s.  Please examine %(pending_deletions)s to see if it
 
1879
    contains any files you wish to keep, and delete it when you are done."""
 
1880
 
 
1881
    def __init__(self, pending_deletion):
 
1882
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1883
 
 
1884
 
 
1885
class OutOfDateTree(BzrError):
 
1886
 
 
1887
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1888
 
 
1889
    def __init__(self, tree):
 
1890
        BzrError.__init__(self)
 
1891
        self.tree = tree
 
1892
 
 
1893
 
 
1894
class PublicBranchOutOfDate(BzrError):
 
1895
 
 
1896
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1897
        '"%(revstring)s".'
 
1898
 
 
1899
    def __init__(self, public_location, revstring):
 
1900
        import bzrlib.urlutils as urlutils
 
1901
        public_location = urlutils.unescape_for_display(public_location,
 
1902
                                                        'ascii')
 
1903
        BzrError.__init__(self, public_location=public_location,
 
1904
                          revstring=revstring)
 
1905
 
 
1906
 
 
1907
class MergeModifiedFormatError(BzrError):
 
1908
 
 
1909
    _fmt = "Error in merge modified format"
 
1910
 
 
1911
 
 
1912
class ConflictFormatError(BzrError):
 
1913
 
 
1914
    _fmt = "Format error in conflict listings"
 
1915
 
 
1916
 
 
1917
class CorruptRepository(BzrError):
 
1918
 
 
1919
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1920
            "Please run bzr reconcile on this repository.")
 
1921
 
 
1922
    def __init__(self, repo):
 
1923
        BzrError.__init__(self)
 
1924
        self.repo_path = repo.bzrdir.root_transport.base
 
1925
 
 
1926
 
 
1927
class UpgradeRequired(BzrError):
 
1928
 
 
1929
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1930
 
 
1931
    def __init__(self, path):
 
1932
        BzrError.__init__(self)
 
1933
        self.path = path
 
1934
 
 
1935
 
 
1936
class LocalRequiresBoundBranch(BzrError):
 
1937
 
 
1938
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1939
 
 
1940
 
 
1941
class MissingProgressBarFinish(BzrError):
 
1942
 
 
1943
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1944
 
 
1945
 
 
1946
class InvalidProgressBarType(BzrError):
 
1947
 
 
1948
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1949
            " is not a supported type Select one of: %(valid_types)s")
 
1950
 
 
1951
    def __init__(self, bar_type, valid_types):
 
1952
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1953
 
 
1954
 
 
1955
class UnsupportedOperation(BzrError):
 
1956
 
 
1957
    _fmt = ("The method %(mname)s is not supported on"
 
1958
            " objects of type %(tname)s.")
 
1959
 
 
1960
    def __init__(self, method, method_self):
 
1961
        self.method = method
 
1962
        self.mname = method.__name__
 
1963
        self.tname = type(method_self).__name__
 
1964
 
 
1965
 
 
1966
class CannotSetRevisionId(UnsupportedOperation):
 
1967
    """Raised when a commit is attempting to set a revision id but cant."""
 
1968
 
 
1969
 
 
1970
class NonAsciiRevisionId(UnsupportedOperation):
 
1971
    """Raised when a commit is attempting to set a non-ascii revision id
 
1972
       but cant.
 
1973
    """
 
1974
 
 
1975
 
 
1976
class BinaryFile(BzrError):
 
1977
    
 
1978
    _fmt = "File is binary but should be text."
 
1979
 
 
1980
 
 
1981
class IllegalPath(BzrError):
 
1982
 
 
1983
    _fmt = "The path %(path)s is not permitted on this platform"
 
1984
 
 
1985
    def __init__(self, path):
 
1986
        BzrError.__init__(self)
 
1987
        self.path = path
 
1988
 
 
1989
 
 
1990
class TestamentMismatch(BzrError):
 
1991
 
 
1992
    _fmt = """Testament did not match expected value.
 
1993
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1994
       {%(measured)s}"""
 
1995
 
 
1996
    def __init__(self, revision_id, expected, measured):
 
1997
        self.revision_id = revision_id
 
1998
        self.expected = expected
 
1999
        self.measured = measured
 
2000
 
 
2001
 
 
2002
class NotABundle(BzrError):
 
2003
    
 
2004
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2005
 
 
2006
    def __init__(self, text):
 
2007
        BzrError.__init__(self)
 
2008
        self.text = text
 
2009
 
 
2010
 
 
2011
class BadBundle(BzrError): 
 
2012
    
 
2013
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2014
 
 
2015
    def __init__(self, text):
 
2016
        BzrError.__init__(self)
 
2017
        self.text = text
 
2018
 
 
2019
 
 
2020
class MalformedHeader(BadBundle): 
 
2021
    
 
2022
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2023
 
 
2024
 
 
2025
class MalformedPatches(BadBundle): 
 
2026
    
 
2027
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2028
 
 
2029
 
 
2030
class MalformedFooter(BadBundle): 
 
2031
    
 
2032
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2033
 
 
2034
 
 
2035
class UnsupportedEOLMarker(BadBundle):
 
2036
    
 
2037
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2038
 
 
2039
    def __init__(self):
 
2040
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2041
        # but for this there is not
 
2042
        BzrError.__init__(self)
 
2043
 
 
2044
 
 
2045
class IncompatibleBundleFormat(BzrError):
 
2046
    
 
2047
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2048
 
 
2049
    def __init__(self, bundle_format, other):
 
2050
        BzrError.__init__(self)
 
2051
        self.bundle_format = bundle_format
 
2052
        self.other = other
 
2053
 
 
2054
 
 
2055
class BadInventoryFormat(BzrError):
 
2056
    
 
2057
    _fmt = "Root class for inventory serialization errors"
 
2058
 
 
2059
 
 
2060
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2061
 
 
2062
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2063
 
 
2064
    def __init__(self, msg):
 
2065
        BadInventoryFormat.__init__(self, msg=msg)
 
2066
 
 
2067
 
 
2068
class RootNotRich(BzrError):
 
2069
 
 
2070
    _fmt = """This operation requires rich root data storage"""
 
2071
 
 
2072
 
 
2073
class NoSmartMedium(BzrError):
 
2074
 
 
2075
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2076
 
 
2077
    internal_error = True
 
2078
 
 
2079
    def __init__(self, transport):
 
2080
        self.transport = transport
 
2081
 
 
2082
 
 
2083
class NoSmartServer(NotBranchError):
 
2084
 
 
2085
    _fmt = "No smart server available at %(url)s"
 
2086
 
 
2087
    def __init__(self, url):
 
2088
        self.url = url
 
2089
 
 
2090
 
 
2091
class UnknownSSH(BzrError):
 
2092
 
 
2093
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2094
 
 
2095
    def __init__(self, vendor):
 
2096
        BzrError.__init__(self)
 
2097
        self.vendor = vendor
 
2098
 
 
2099
 
 
2100
class SSHVendorNotFound(BzrError):
 
2101
 
 
2102
    _fmt = ("Don't know how to handle SSH connections."
 
2103
            " Please set BZR_SSH environment variable.")
 
2104
 
 
2105
 
 
2106
class GhostRevisionUnusableHere(BzrError):
 
2107
 
 
2108
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2109
 
 
2110
    def __init__(self, revision_id):
 
2111
        BzrError.__init__(self)
 
2112
        self.revision_id = revision_id
 
2113
 
 
2114
 
 
2115
class IllegalUseOfScopeReplacer(BzrError):
 
2116
 
 
2117
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2118
            " %(msg)s%(extra)s")
 
2119
 
 
2120
    internal_error = True
 
2121
 
 
2122
    def __init__(self, name, msg, extra=None):
 
2123
        BzrError.__init__(self)
 
2124
        self.name = name
 
2125
        self.msg = msg
 
2126
        if extra:
 
2127
            self.extra = ': ' + str(extra)
 
2128
        else:
 
2129
            self.extra = ''
 
2130
 
 
2131
 
 
2132
class InvalidImportLine(BzrError):
 
2133
 
 
2134
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2135
 
 
2136
    internal_error = True
 
2137
 
 
2138
    def __init__(self, text, msg):
 
2139
        BzrError.__init__(self)
 
2140
        self.text = text
 
2141
        self.msg = msg
 
2142
 
 
2143
 
 
2144
class ImportNameCollision(BzrError):
 
2145
 
 
2146
    _fmt = ("Tried to import an object to the same name as"
 
2147
            " an existing object. %(name)s")
 
2148
 
 
2149
    internal_error = True
 
2150
 
 
2151
    def __init__(self, name):
 
2152
        BzrError.__init__(self)
 
2153
        self.name = name
 
2154
 
 
2155
 
 
2156
class NotAMergeDirective(BzrError):
 
2157
    """File starting with %(firstline)r is not a merge directive"""
 
2158
    def __init__(self, firstline):
 
2159
        BzrError.__init__(self, firstline=firstline)
 
2160
 
 
2161
 
 
2162
class NoMergeSource(BzrError):
 
2163
    """Raise if no merge source was specified for a merge directive"""
 
2164
 
 
2165
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2166
        " branch location."
 
2167
 
 
2168
 
 
2169
class IllegalMergeDirectivePayload(BzrError):
 
2170
    """A merge directive contained something other than a patch or bundle"""
 
2171
 
 
2172
    _fmt = "Bad merge directive payload %(start)r"
 
2173
 
 
2174
    def __init__(self, start):
 
2175
        BzrError(self)
 
2176
        self.start = start
 
2177
 
 
2178
 
 
2179
class PatchVerificationFailed(BzrError):
 
2180
    """A patch from a merge directive could not be verified"""
 
2181
 
 
2182
    _fmt = "Preview patch does not match requested changes."
 
2183
 
 
2184
 
 
2185
class PatchMissing(BzrError):
 
2186
    """Raise a patch type was specified but no patch supplied"""
 
2187
 
 
2188
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
2189
 
 
2190
    def __init__(self, patch_type):
 
2191
        BzrError.__init__(self)
 
2192
        self.patch_type = patch_type
 
2193
 
 
2194
 
 
2195
class UnsupportedInventoryKind(BzrError):
 
2196
    
 
2197
    _fmt = """Unsupported entry kind %(kind)s"""
 
2198
 
 
2199
    def __init__(self, kind):
 
2200
        self.kind = kind
 
2201
 
 
2202
 
 
2203
class BadSubsumeSource(BzrError):
 
2204
 
 
2205
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2206
 
 
2207
    def __init__(self, tree, other_tree, reason):
 
2208
        self.tree = tree
 
2209
        self.other_tree = other_tree
 
2210
        self.reason = reason
 
2211
 
 
2212
 
 
2213
class SubsumeTargetNeedsUpgrade(BzrError):
 
2214
    
 
2215
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2216
 
 
2217
    def __init__(self, other_tree):
 
2218
        self.other_tree = other_tree
 
2219
 
 
2220
 
 
2221
class BadReferenceTarget(BzrError):
 
2222
 
 
2223
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2224
           "%(reason)s"
 
2225
 
 
2226
    internal_error = True
 
2227
 
 
2228
    def __init__(self, tree, other_tree, reason):
 
2229
        self.tree = tree
 
2230
        self.other_tree = other_tree
 
2231
        self.reason = reason
 
2232
 
 
2233
 
 
2234
class NoSuchTag(BzrError):
 
2235
 
 
2236
    _fmt = "No such tag: %(tag_name)s"
 
2237
 
 
2238
    def __init__(self, tag_name):
 
2239
        self.tag_name = tag_name
 
2240
 
 
2241
 
 
2242
class TagsNotSupported(BzrError):
 
2243
 
 
2244
    _fmt = ("Tags not supported by %(branch)s;"
 
2245
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2246
 
 
2247
    def __init__(self, branch):
 
2248
        self.branch = branch
 
2249
 
 
2250
        
 
2251
class TagAlreadyExists(BzrError):
 
2252
 
 
2253
    _fmt = "Tag %(tag_name)s already exists."
 
2254
 
 
2255
    def __init__(self, tag_name):
 
2256
        self.tag_name = tag_name
 
2257
 
 
2258
 
 
2259
class MalformedBugIdentifier(BzrError):
 
2260
 
 
2261
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2262
 
 
2263
    def __init__(self, bug_id, reason):
 
2264
        self.bug_id = bug_id
 
2265
        self.reason = reason
 
2266
 
 
2267
 
 
2268
class UnknownBugTrackerAbbreviation(BzrError):
 
2269
 
 
2270
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2271
            "on %(branch)s")
 
2272
 
 
2273
    def __init__(self, abbreviation, branch):
 
2274
        self.abbreviation = abbreviation
 
2275
        self.branch = branch
 
2276
 
 
2277
 
 
2278
class UnexpectedSmartServerResponse(BzrError):
 
2279
 
 
2280
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2281
 
 
2282
    def __init__(self, response_tuple):
 
2283
        self.response_tuple = response_tuple
 
2284
 
 
2285
 
 
2286
class ContainerError(BzrError):
 
2287
    """Base class of container errors."""
 
2288
 
 
2289
 
 
2290
class UnknownContainerFormatError(ContainerError):
 
2291
 
 
2292
    _fmt = "Unrecognised container format: %(container_format)r"
 
2293
    
 
2294
    def __init__(self, container_format):
 
2295
        self.container_format = container_format
 
2296
 
 
2297
 
 
2298
class UnexpectedEndOfContainerError(ContainerError):
 
2299
 
 
2300
    _fmt = "Unexpected end of container stream"
 
2301
 
 
2302
    internal_error = False
 
2303
 
 
2304
 
 
2305
class UnknownRecordTypeError(ContainerError):
 
2306
 
 
2307
    _fmt = "Unknown record type: %(record_type)r"
 
2308
 
 
2309
    def __init__(self, record_type):
 
2310
        self.record_type = record_type
 
2311
 
 
2312
 
 
2313
class InvalidRecordError(ContainerError):
 
2314
 
 
2315
    _fmt = "Invalid record: %(reason)s"
 
2316
 
 
2317
    def __init__(self, reason):
 
2318
        self.reason = reason
 
2319
 
 
2320
 
 
2321
class ContainerHasExcessDataError(ContainerError):
 
2322
 
 
2323
    _fmt = "Container has data after end marker: %(excess)r"
 
2324
 
 
2325
    def __init__(self, excess):
 
2326
        self.excess = excess
 
2327
 
 
2328
 
 
2329
class DuplicateRecordNameError(ContainerError):
 
2330
 
 
2331
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2332
 
 
2333
    def __init__(self, name):
 
2334
        self.name = name
 
2335
 
 
2336
 
 
2337
class NoDestinationAddress(BzrError):
 
2338
 
 
2339
    _fmt = "Message does not have a destination address."
 
2340
 
 
2341
    internal_error = True
 
2342
 
 
2343
 
 
2344
class SMTPError(BzrError):
 
2345
 
 
2346
    _fmt = "SMTP error: %(error)s"
 
2347
 
 
2348
    def __init__(self, error):
 
2349
        self.error = error
 
2350
 
 
2351
 
 
2352
class NoMessageSupplied(BzrError):
 
2353
 
 
2354
    _fmt = "No message supplied."
 
2355
 
 
2356
 
 
2357
class UnknownMailClient(BzrError):
 
2358
 
 
2359
    _fmt = "Unknown mail client: %(mail_client)s"
 
2360
 
 
2361
    def __init__(self, mail_client):
 
2362
        BzrError.__init__(self, mail_client=mail_client)
 
2363
 
 
2364
 
 
2365
class MailClientNotFound(BzrError):
 
2366
 
 
2367
    _fmt = "Unable to find mail client with the following names:"\
 
2368
        " %(mail_command_list_string)s"
 
2369
 
 
2370
    def __init__(self, mail_command_list):
 
2371
        mail_command_list_string = ', '.join(mail_command_list)
 
2372
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2373
                          mail_command_list_string=mail_command_list_string)
 
2374
 
 
2375
class SMTPConnectionRefused(SMTPError):
 
2376
 
 
2377
    _fmt = "SMTP connection to %(host)s refused"
 
2378
 
 
2379
    def __init__(self, error, host):
 
2380
        self.error = error
 
2381
        self.host = host
 
2382
 
 
2383
 
 
2384
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2385
 
 
2386
    _fmt = "Please specify smtp_server.  No server at default %(host)s."