~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Alexander Belchenko
  • Date: 2008-03-12 21:07:46 UTC
  • mto: This revision was merged to the branch mainline in revision 3272.
  • Revision ID: bialix@ukr.net-20080312210746-39xx932qcb92g3lj
Significantly reducing execution time and network traffic for trivial case of `bzr missing`

Show diffs side-by-side

added added

removed removed

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