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