~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2007-11-29 07:12:42 UTC
  • mto: This revision was merged to the branch mainline in revision 3048.
  • Revision ID: mbp@sourcefrog.net-20071129071242-1tcn2a18547udlvw
Fix up calls to TestCase.build_tree passing a string rather than a list

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