~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

- avoid warning about log not being registered during startup

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# -*- coding: UTF-8 -*-
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Exceptions for bzr, and reporting of them.
18
 
"""
19
 
 
20
 
 
21
 
from bzrlib import symbol_versioning
22
 
from bzrlib.patches import (PatchSyntax, 
23
 
                            PatchConflict, 
24
 
                            MalformedPatchHeader,
25
 
                            MalformedHunkHeader,
26
 
                            MalformedLine,)
27
 
 
28
 
 
29
 
# TODO: is there any value in providing the .args field used by standard
30
 
# python exceptions?   A list of values with no names seems less useful 
31
 
# to me.
32
 
 
33
 
# TODO: Perhaps convert the exception to a string at the moment it's 
34
 
# constructed to make sure it will succeed.  But that says nothing about
35
 
# exceptions that are never raised.
36
 
 
37
 
# TODO: selftest assertRaises should probably also check that every error
38
 
# raised can be formatted as a string successfully, and without giving
39
 
# 'unprintable'.
40
 
 
41
 
 
 
17
 
 
18
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
19
__author__ = "Martin Pool <mbp@canonical.com>"
 
20
 
 
21
 
 
22
######################################################################
 
23
# exceptions 
42
24
class BzrError(StandardError):
43
 
    """
44
 
    Base class for errors raised by bzrlib.
45
 
 
46
 
    :cvar internal_error: if true (or absent) this was probably caused by a
47
 
    bzr bug and should be displayed with a traceback; if False this was
48
 
    probably a user or environment error and they don't need the gory details.
49
 
    (That can be overridden by -Derror on the command line.)
50
 
 
51
 
    :cvar _fmt: Format string to display the error; this is expanded
52
 
    by the instance's dict.
53
 
    """
54
 
    
55
 
    internal_error = False
56
 
 
57
 
    def __init__(self, msg=None, **kwds):
58
 
        """Construct a new BzrError.
59
 
 
60
 
        There are two alternative forms for constructing these objects.
61
 
        Either a preformatted string may be passed, or a set of named
62
 
        arguments can be given.  The first is for generic "user" errors which
63
 
        are not intended to be caught and so do not need a specific subclass.
64
 
        The second case is for use with subclasses that provide a _fmt format
65
 
        string to print the arguments.  
66
 
 
67
 
        Keyword arguments are taken as parameters to the error, which can 
68
 
        be inserted into the format string template.  It's recommended 
69
 
        that subclasses override the __init__ method to require specific 
70
 
        parameters.
71
 
 
72
 
        :param msg: If given, this is the literal complete text for the error,
73
 
        not subject to expansion.
74
 
        """
75
 
        StandardError.__init__(self)
76
 
        if msg is not None:
77
 
            # I was going to deprecate this, but it actually turns out to be
78
 
            # quite handy - mbp 20061103.
79
 
            self._preformatted_string = msg
 
25
    def __str__(self):
 
26
        # XXX: Should we show the exception class in 
 
27
        # exceptions that don't provide their own message?  
 
28
        # maybe it should be done at a higher level
 
29
        ## n = self.__class__.__name__ + ': '
 
30
        n = ''
 
31
        if len(self.args) == 1:
 
32
            return n + self.args[0]
 
33
        elif len(self.args) == 2:
 
34
            # further explanation or suggestions
 
35
            try:
 
36
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
37
            except TypeError:
 
38
                return n + "%r" % self
80
39
        else:
81
 
            self._preformatted_string = None
82
 
            for key, value in kwds.items():
83
 
                setattr(self, key, value)
84
 
 
85
 
    def __str__(self):
86
 
        s = getattr(self, '_preformatted_string', None)
87
 
        if s is not None:
88
 
            # contains a preformatted message; must be cast to plain str
89
 
            return str(s)
90
 
        try:
91
 
            fmt = self._get_format_string()
92
 
            if fmt:
93
 
                s = fmt % self.__dict__
94
 
                # __str__() should always return a 'str' object
95
 
                # never a 'unicode' object.
96
 
                if isinstance(s, unicode):
97
 
                    return s.encode('utf8')
98
 
                return s
99
 
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
100
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
101
 
                % (self.__class__.__name__,
102
 
                   self.__dict__,
103
 
                   getattr(self, '_fmt', None),
104
 
                   str(e))
105
 
 
106
 
    def _get_format_string(self):
107
 
        """Return format string for this exception or None"""
108
 
        fmt = getattr(self, '_fmt', None)
109
 
        if fmt is not None:
110
 
            return fmt
111
 
        fmt = getattr(self, '__doc__', None)
112
 
        if fmt is not None:
113
 
            symbol_versioning.warn("%s uses its docstring as a format, "
114
 
                    "it should use _fmt instead" % self.__class__.__name__,
115
 
                    DeprecationWarning)
116
 
            return fmt
117
 
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
118
 
            % (self.__class__.__name__,
119
 
               self.__dict__,
120
 
               getattr(self, '_fmt', None),
121
 
               )
122
 
 
123
 
 
124
 
class BzrNewError(BzrError):
125
 
    """Deprecated error base class."""
126
 
    # base classes should override the docstring with their human-
127
 
    # readable explanation
128
 
 
129
 
    def __init__(self, *args, **kwds):
130
 
        # XXX: Use the underlying BzrError to always generate the args attribute
131
 
        # if it doesn't exist.  We can't use super here, because exceptions are
132
 
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
133
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
134
 
             'please convert %s to use BzrError instead' 
135
 
             % self.__class__.__name__,
136
 
             DeprecationWarning,
137
 
             stacklevel=2)
138
 
        BzrError.__init__(self, *args)
139
 
        for key, value in kwds.items():
140
 
            setattr(self, key, value)
141
 
 
142
 
    def __str__(self):
143
 
        try:
144
 
            # __str__() should always return a 'str' object
145
 
            # never a 'unicode' object.
146
 
            s = self.__doc__ % self.__dict__
147
 
            if isinstance(s, unicode):
148
 
                return s.encode('utf8')
149
 
            return s
150
 
        except (TypeError, NameError, ValueError, KeyError), e:
151
 
            return 'Unprintable exception %s(%r): %s' \
152
 
                % (self.__class__.__name__,
153
 
                   self.__dict__, str(e))
154
 
 
155
 
 
156
 
class AlreadyBuilding(BzrError):
157
 
    
158
 
    _fmt = "The tree builder is already building a tree."
 
40
            return n + `self.args`
159
41
 
160
42
 
161
43
class BzrCheckError(BzrError):
162
 
    
163
 
    _fmt = "Internal check failed: %(message)s"
164
 
 
165
 
    internal_error = True
166
 
 
167
 
    def __init__(self, message):
168
 
        BzrError.__init__(self)
169
 
        self.message = message
170
 
 
171
 
 
172
 
class InvalidEntryName(BzrError):
173
 
    
174
 
    _fmt = "Invalid entry name: %(name)s"
175
 
 
176
 
    internal_error = True
177
 
 
178
 
    def __init__(self, name):
179
 
        BzrError.__init__(self)
180
 
        self.name = name
 
44
    pass
181
45
 
182
46
 
183
47
class InvalidRevisionNumber(BzrError):
184
 
    
185
 
    _fmt = "Invalid revision number %(revno)s"
186
 
 
187
 
    def __init__(self, revno):
188
 
        BzrError.__init__(self)
189
 
        self.revno = revno
 
48
    def __str__(self):
 
49
        return 'invalid revision number: %r' % self.args[0]
190
50
 
191
51
 
192
52
class InvalidRevisionId(BzrError):
193
 
 
194
 
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
195
 
 
196
 
    def __init__(self, revision_id, branch):
197
 
        # branch can be any string or object with __str__ defined
198
 
        BzrError.__init__(self)
199
 
        self.revision_id = revision_id
200
 
        self.branch = branch
201
 
 
202
 
 
203
 
class NoSuchId(BzrError):
204
 
 
205
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
206
 
    
207
 
    def __init__(self, tree, file_id):
208
 
        BzrError.__init__(self)
209
 
        self.file_id = file_id
210
 
        self.tree = tree
211
 
 
212
 
 
213
 
class InventoryModified(BzrError):
214
 
 
215
 
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
216
 
            "so a clean inventory cannot be read without data loss.")
217
 
 
218
 
    internal_error = True
219
 
 
220
 
    def __init__(self, tree):
221
 
        self.tree = tree
222
 
 
223
 
 
224
 
class NoWorkingTree(BzrError):
225
 
 
226
 
    _fmt = "No WorkingTree exists for %(base)s."
227
 
    
228
 
    def __init__(self, base):
229
 
        BzrError.__init__(self)
230
 
        self.base = base
231
 
 
232
 
 
233
 
class NotBuilding(BzrError):
234
 
 
235
 
    _fmt = "Not currently building a tree."
236
 
 
237
 
 
238
 
class NotLocalUrl(BzrError):
239
 
 
240
 
    _fmt = "%(url)s is not a local path."
241
 
 
242
 
    def __init__(self, url):
243
 
        self.url = url
244
 
 
245
 
 
246
 
class WorkingTreeAlreadyPopulated(BzrError):
247
 
 
248
 
    _fmt = """Working tree already populated in %(base)s"""
249
 
 
250
 
    internal_error = True
251
 
 
252
 
    def __init__(self, base):
253
 
        self.base = base
 
53
    pass
 
54
 
254
55
 
255
56
class BzrCommandError(BzrError):
256
 
    """Error from user command"""
257
 
 
258
 
    internal_error = False
259
 
 
260
 
    # Error from malformed user command; please avoid raising this as a
261
 
    # generic exception not caused by user input.
262
 
    #
263
 
    # I think it's a waste of effort to differentiate between errors that
264
 
    # are not intended to be caught anyway.  UI code need not subclass
265
 
    # BzrCommandError, and non-UI code should not throw a subclass of
266
 
    # BzrCommandError.  ADHB 20051211
267
 
    def __init__(self, msg):
268
 
        # Object.__str__() must return a real string
269
 
        # returning a Unicode string is a python error.
270
 
        if isinstance(msg, unicode):
271
 
            self.msg = msg.encode('utf8')
272
 
        else:
273
 
            self.msg = msg
274
 
 
275
 
    def __str__(self):
276
 
        return self.msg
277
 
 
278
 
 
279
 
class NotWriteLocked(BzrError):
280
 
 
281
 
    _fmt = """%(not_locked)r is not write locked but needs to be."""
282
 
 
283
 
    def __init__(self, not_locked):
284
 
        self.not_locked = not_locked
285
 
 
286
 
 
287
 
class BzrOptionError(BzrCommandError):
288
 
 
289
 
    _fmt = "Error in command line options"
290
 
 
291
 
    
292
 
class StrictCommitFailed(BzrError):
293
 
 
294
 
    _fmt = "Commit refused because there are unknown files in the tree"
295
 
 
296
 
 
297
 
# XXX: Should be unified with TransportError; they seem to represent the
298
 
# same thing
299
 
class PathError(BzrError):
300
 
    
301
 
    _fmt = "Generic path error: %(path)r%(extra)s)"
302
 
 
303
 
    def __init__(self, path, extra=None):
304
 
        BzrError.__init__(self)
305
 
        self.path = path
306
 
        if extra:
307
 
            self.extra = ': ' + str(extra)
308
 
        else:
309
 
            self.extra = ''
310
 
 
311
 
 
312
 
class NoSuchFile(PathError):
313
 
 
314
 
    _fmt = "No such file: %(path)r%(extra)s"
315
 
 
316
 
 
317
 
class FileExists(PathError):
318
 
 
319
 
    _fmt = "File exists: %(path)r%(extra)s"
320
 
 
321
 
 
322
 
class DirectoryNotEmpty(PathError):
323
 
 
324
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
325
 
 
326
 
 
327
 
class ReadingCompleted(BzrError):
328
 
    
329
 
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
330
 
            "called upon it - the request has been completed and no more "
331
 
            "data may be read.")
332
 
 
333
 
    internal_error = True
334
 
 
335
 
    def __init__(self, request):
336
 
        self.request = request
337
 
 
338
 
 
339
 
class ResourceBusy(PathError):
340
 
 
341
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
342
 
 
343
 
 
344
 
class PermissionDenied(PathError):
345
 
 
346
 
    _fmt = "Permission denied: %(path)r%(extra)s"
347
 
 
348
 
 
349
 
class InvalidURL(PathError):
350
 
 
351
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
352
 
 
353
 
 
354
 
class InvalidURLJoin(PathError):
355
 
 
356
 
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
357
 
 
358
 
    def __init__(self, msg, base, args):
359
 
        PathError.__init__(self, base, msg)
360
 
        self.args = [base] + list(args)
361
 
 
362
 
 
363
 
class UnsupportedProtocol(PathError):
364
 
 
365
 
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
366
 
 
367
 
    def __init__(self, url, extra):
368
 
        PathError.__init__(self, url, extra=extra)
369
 
 
370
 
 
371
 
class ShortReadvError(PathError):
372
 
 
373
 
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
374
 
 
375
 
    internal_error = True
376
 
 
377
 
    def __init__(self, path, offset, length, actual, extra=None):
378
 
        PathError.__init__(self, path, extra=extra)
379
 
        self.offset = offset
380
 
        self.length = length
381
 
        self.actual = actual
382
 
 
383
 
 
384
 
class PathNotChild(BzrError):
385
 
 
386
 
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
387
 
 
388
 
    internal_error = True
389
 
 
390
 
    def __init__(self, path, base, extra=None):
391
 
        BzrError.__init__(self)
392
 
        self.path = path
393
 
        self.base = base
394
 
        if extra:
395
 
            self.extra = ': ' + str(extra)
396
 
        else:
397
 
            self.extra = ''
398
 
 
399
 
 
400
 
class InvalidNormalization(PathError):
401
 
 
402
 
    _fmt = "Path %(path)r is not unicode normalized"
403
 
 
404
 
 
405
 
# TODO: This is given a URL; we try to unescape it but doing that from inside
406
 
# the exception object is a bit undesirable.
407
 
# TODO: Probably this behavior of should be a common superclass 
408
 
class NotBranchError(PathError):
409
 
 
410
 
    _fmt = "Not a branch: %(path)s"
411
 
 
412
 
    def __init__(self, path):
413
 
       import bzrlib.urlutils as urlutils
414
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
415
 
 
416
 
 
417
 
class AlreadyBranchError(PathError):
418
 
 
419
 
    _fmt = "Already a branch: %(path)s."
420
 
 
421
 
 
422
 
class BranchExistsWithoutWorkingTree(PathError):
423
 
 
424
 
    _fmt = "Directory contains a branch, but no working tree \
425
 
(use bzr checkout if you wish to build a working tree): %(path)s"
426
 
 
427
 
 
428
 
class AtomicFileAlreadyClosed(PathError):
429
 
 
430
 
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
431
 
 
432
 
    def __init__(self, path, function):
433
 
        PathError.__init__(self, path=path, extra=None)
434
 
        self.function = function
435
 
 
436
 
 
437
 
class InaccessibleParent(PathError):
438
 
 
439
 
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
440
 
 
441
 
    def __init__(self, path, base):
442
 
        PathError.__init__(self, path)
443
 
        self.base = base
444
 
 
445
 
 
446
 
class NoRepositoryPresent(BzrError):
447
 
 
448
 
    _fmt = "No repository present: %(path)r"
449
 
    def __init__(self, bzrdir):
450
 
        BzrError.__init__(self)
451
 
        self.path = bzrdir.transport.clone('..').base
452
 
 
453
 
 
454
 
class FileInWrongBranch(BzrError):
455
 
 
456
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
457
 
 
458
 
    def __init__(self, branch, path):
459
 
        BzrError.__init__(self)
460
 
        self.branch = branch
461
 
        self.branch_base = branch.base
462
 
        self.path = path
 
57
    # Error from malformed user command
 
58
    def __str__(self):
 
59
        return self.args[0]
 
60
 
 
61
 
 
62
class NotBranchError(BzrError):
 
63
    """Specified path is not in a branch"""
 
64
    def __str__(self):
 
65
        return 'not a branch: %s' % self.args[0]
463
66
 
464
67
 
465
68
class UnsupportedFormatError(BzrError):
466
 
    
467
 
    _fmt = "Unsupported branch format: %(format)s"
468
 
 
469
 
 
470
 
class UnknownFormatError(BzrError):
471
 
    
472
 
    _fmt = "Unknown branch format: %(format)r"
473
 
 
474
 
 
475
 
class IncompatibleFormat(BzrError):
476
 
    
477
 
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
478
 
 
479
 
    def __init__(self, format, bzrdir_format):
480
 
        BzrError.__init__(self)
481
 
        self.format = format
482
 
        self.bzrdir = bzrdir_format
483
 
 
484
 
 
485
 
class IncompatibleRevision(BzrError):
486
 
    
487
 
    _fmt = "Revision is not compatible with %(repo_format)s"
488
 
 
489
 
    def __init__(self, repo_format):
490
 
        BzrError.__init__(self)
491
 
        self.repo_format = repo_format
 
69
    """Specified path is a bzr branch that we cannot read."""
 
70
    def __str__(self):
 
71
        return 'unsupported branch format: %s' % self.args[0]
492
72
 
493
73
 
494
74
class NotVersionedError(BzrError):
495
 
 
496
 
    _fmt = "%(path)s is not versioned"
497
 
 
498
 
    def __init__(self, path):
499
 
        BzrError.__init__(self)
500
 
        self.path = path
501
 
 
502
 
 
503
 
class PathsNotVersionedError(BzrError):
504
 
    # used when reporting several paths are not versioned
505
 
 
506
 
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
507
 
 
508
 
    def __init__(self, paths):
509
 
        from bzrlib.osutils import quotefn
510
 
        BzrError.__init__(self)
511
 
        self.paths = paths
512
 
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
513
 
 
514
 
 
515
 
class PathsDoNotExist(BzrError):
516
 
 
517
 
    _fmt = "Path(s) do not exist: %(paths_as_string)s"
518
 
 
519
 
    # used when reporting that paths are neither versioned nor in the working
520
 
    # tree
521
 
 
522
 
    def __init__(self, paths):
523
 
        # circular import
524
 
        from bzrlib.osutils import quotefn
525
 
        BzrError.__init__(self)
526
 
        self.paths = paths
527
 
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
75
    """Specified object is not versioned."""
528
76
 
529
77
 
530
78
class BadFileKindError(BzrError):
531
 
 
532
 
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
533
 
 
534
 
 
535
 
class ForbiddenControlFileError(BzrError):
536
 
 
537
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
538
 
 
539
 
 
540
 
class LockError(BzrError):
541
 
 
542
 
    _fmt = "Lock error: %(message)s"
543
 
 
544
 
    # All exceptions from the lock/unlock functions should be from
545
 
    # this exception class.  They will be translated as necessary. The
546
 
    # original exception is available as e.original_error
547
 
    #
548
 
    # New code should prefer to raise specific subclasses
549
 
    def __init__(self, message):
550
 
        self.message = message
 
79
    """Specified file is of a kind that cannot be added.
 
80
 
 
81
    (For example a symlink or device file.)"""
 
82
    pass
 
83
 
 
84
 
 
85
class ForbiddenFileError(BzrError):
 
86
    """Cannot operate on a file because it is a control file."""
 
87
    pass
 
88
 
 
89
 
 
90
class LockError(Exception):
 
91
    """All exceptions from the lock/unlock functions should be from
 
92
    this exception class.  They will be translated as necessary. The
 
93
    original exception is available as e.original_error
 
94
    """
 
95
    def __init__(self, e=None):
 
96
        self.original_error = e
 
97
        if e:
 
98
            Exception.__init__(self, e)
 
99
        else:
 
100
            Exception.__init__(self)
551
101
 
552
102
 
553
103
class CommitNotPossible(LockError):
554
 
 
555
 
    _fmt = "A commit was attempted but we do not have a write lock open."
556
 
 
557
 
    def __init__(self):
558
 
        pass
 
104
    """A commit was attempted but we do not have a write lock open."""
559
105
 
560
106
 
561
107
class AlreadyCommitted(LockError):
562
 
 
563
 
    _fmt = "A rollback was requested, but is not able to be accomplished."
564
 
 
565
 
    def __init__(self):
566
 
        pass
 
108
    """A rollback was requested, but is not able to be accomplished."""
567
109
 
568
110
 
569
111
class ReadOnlyError(LockError):
570
 
 
571
 
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
572
 
 
573
 
    def __init__(self, obj):
574
 
        self.obj = obj
575
 
 
576
 
 
577
 
class OutSideTransaction(BzrError):
578
 
 
579
 
    _fmt = "A transaction related operation was attempted after the transaction finished."
580
 
 
581
 
 
582
 
class ObjectNotLocked(LockError):
583
 
 
584
 
    _fmt = "%(obj)r is not locked"
585
 
 
586
 
    internal_error = True
587
 
 
588
 
    # this can indicate that any particular object is not locked; see also
589
 
    # LockNotHeld which means that a particular *lock* object is not held by
590
 
    # the caller -- perhaps they should be unified.
591
 
    def __init__(self, obj):
592
 
        self.obj = obj
593
 
 
594
 
 
595
 
class ReadOnlyObjectDirtiedError(ReadOnlyError):
596
 
 
597
 
    _fmt = "Cannot change object %(obj)r in read only transaction"
598
 
 
599
 
    def __init__(self, obj):
600
 
        self.obj = obj
601
 
 
602
 
 
603
 
class UnlockableTransport(LockError):
604
 
 
605
 
    _fmt = "Cannot lock: transport is read only: %(transport)s"
606
 
 
607
 
    def __init__(self, transport):
608
 
        self.transport = transport
609
 
 
610
 
 
611
 
class LockContention(LockError):
612
 
 
613
 
    _fmt = "Could not acquire lock %(lock)s"
614
 
    # TODO: show full url for lock, combining the transport and relative bits?
615
 
    
616
 
    def __init__(self, lock):
617
 
        self.lock = lock
618
 
 
619
 
 
620
 
class LockBroken(LockError):
621
 
 
622
 
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
623
 
 
624
 
    def __init__(self, lock):
625
 
        self.lock = lock
626
 
 
627
 
 
628
 
class LockBreakMismatch(LockError):
629
 
 
630
 
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
631
 
 
632
 
    def __init__(self, lock, holder, target):
633
 
        self.lock = lock
634
 
        self.holder = holder
635
 
        self.target = target
636
 
 
637
 
 
638
 
class LockNotHeld(LockError):
639
 
 
640
 
    _fmt = "Lock not held: %(lock)s"
641
 
 
642
 
    def __init__(self, lock):
643
 
        self.lock = lock
644
 
 
645
 
 
646
 
class PointlessCommit(BzrError):
647
 
 
648
 
    _fmt = "No changes to commit"
649
 
 
650
 
 
651
 
class UpgradeReadonly(BzrError):
652
 
 
653
 
    _fmt = "Upgrade URL cannot work with readonly URLs."
654
 
 
655
 
 
656
 
class UpToDateFormat(BzrError):
657
 
 
658
 
    _fmt = "The branch format %(format)s is already at the most recent format."
659
 
 
660
 
    def __init__(self, format):
661
 
        BzrError.__init__(self)
662
 
        self.format = format
663
 
 
664
 
 
665
 
class StrictCommitFailed(Exception):
666
 
 
667
 
    _fmt = "Commit refused because there are unknowns in the tree."
 
112
    """A write attempt was made in a read only transaction."""
 
113
 
 
114
 
 
115
class PointlessCommit(Exception):
 
116
    """Commit failed because nothing was changed."""
668
117
 
669
118
 
670
119
class NoSuchRevision(BzrError):
671
 
 
672
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
673
 
 
674
 
    internal_error = True
675
 
 
676
120
    def __init__(self, branch, revision):
677
 
        BzrError.__init__(self, branch=branch, revision=revision)
678
 
 
679
 
 
680
 
class NoSuchRevisionSpec(BzrError):
681
 
 
682
 
    _fmt = "No namespace registered for string: %(spec)r"
683
 
 
684
 
    def __init__(self, spec):
685
 
        BzrError.__init__(self, spec=spec)
686
 
 
687
 
 
688
 
class InvalidRevisionSpec(BzrError):
689
 
 
690
 
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
691
 
 
692
 
    def __init__(self, spec, branch, extra=None):
693
 
        BzrError.__init__(self, branch=branch, spec=spec)
694
 
        if extra:
695
 
            self.extra = '\n' + str(extra)
696
 
        else:
697
 
            self.extra = ''
 
121
        self.branch = branch
 
122
        self.revision = revision
 
123
        msg = "Branch %s has no revision %s" % (branch, revision)
 
124
        BzrError.__init__(self, msg)
698
125
 
699
126
 
700
127
class HistoryMissing(BzrError):
701
 
 
702
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
128
    def __init__(self, branch, object_type, object_id):
 
129
        self.branch = branch
 
130
        BzrError.__init__(self,
 
131
                          '%s is missing %s {%s}'
 
132
                          % (branch, object_type, object_id))
703
133
 
704
134
 
705
135
class DivergedBranches(BzrError):
706
 
    
707
 
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
708
 
 
709
 
    internal_error = False
710
 
 
711
136
    def __init__(self, branch1, branch2):
 
137
        BzrError.__init__(self, "These branches have diverged.")
712
138
        self.branch1 = branch1
713
139
        self.branch2 = branch2
714
140
 
715
141
 
716
 
class UnrelatedBranches(BzrError):
717
 
 
718
 
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
719
 
 
720
 
    internal_error = False
721
 
 
 
142
class UnrelatedBranches(BzrCommandError):
 
143
    def __init__(self):
 
144
        msg = "Branches have no common ancestor, and no base revision"\
 
145
            " specified."
 
146
        BzrCommandError.__init__(self, msg)
722
147
 
723
148
class NoCommonAncestor(BzrError):
724
 
    
725
 
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
726
 
 
727
149
    def __init__(self, revision_a, revision_b):
728
 
        self.revision_a = revision_a
729
 
        self.revision_b = revision_b
730
 
 
 
150
        msg = "Revisions have no common ancestor: %s %s." \
 
151
            % (revision_a, revision_b) 
 
152
        BzrError.__init__(self, msg)
731
153
 
732
154
class NoCommonRoot(BzrError):
733
 
 
734
 
    _fmt = "Revisions are not derived from the same root: " \
735
 
           "%(revision_a)s %(revision_b)s."
736
 
 
737
155
    def __init__(self, revision_a, revision_b):
738
 
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
739
 
 
740
 
 
741
 
class NotAncestor(BzrError):
742
 
 
743
 
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
744
 
 
745
 
    def __init__(self, rev_id, not_ancestor_id):
746
 
        BzrError.__init__(self, rev_id=rev_id,
747
 
            not_ancestor_id=not_ancestor_id)
 
156
        msg = "Revisions are not derived from the same root: %s %s." \
 
157
            % (revision_a, revision_b) 
 
158
        BzrError.__init__(self, msg)
 
159
 
 
160
class NotAncestor(BzrError):
 
161
    def __init__(self, rev_id, not_ancestor_id):
 
162
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
163
                                                        rev_id)
 
164
        BzrError.__init__(self, msg)
 
165
        self.rev_id = rev_id
 
166
        self.not_ancestor_id = not_ancestor_id
 
167
 
 
168
 
 
169
class NotAncestor(BzrError):
 
170
    def __init__(self, rev_id, not_ancestor_id):
 
171
        self.rev_id = rev_id
 
172
        self.not_ancestor_id = not_ancestor_id
 
173
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
174
                                                        rev_id)
 
175
        BzrError.__init__(self, msg)
748
176
 
749
177
 
750
178
class InstallFailed(BzrError):
751
 
 
752
179
    def __init__(self, revisions):
753
180
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
754
181
        BzrError.__init__(self, msg)
756
183
 
757
184
 
758
185
class AmbiguousBase(BzrError):
759
 
 
760
186
    def __init__(self, bases):
761
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
762
 
                DeprecationWarning)
763
 
        msg = "The correct base is unclear, because %s are all equally close" %\
 
187
        msg = "The correct base is unclear, becase %s are all equally close" %\
764
188
            ", ".join(bases)
765
189
        BzrError.__init__(self, msg)
766
190
        self.bases = bases
767
191
 
768
 
 
769
192
class NoCommits(BzrError):
770
 
 
771
 
    _fmt = "Branch %(branch)s has no commits."
772
 
 
773
193
    def __init__(self, branch):
774
 
        BzrError.__init__(self, branch=branch)
775
 
 
 
194
        msg = "Branch %s has no commits." % branch
 
195
        BzrError.__init__(self, msg)
776
196
 
777
197
class UnlistableStore(BzrError):
778
 
 
779
198
    def __init__(self, store):
780
199
        BzrError.__init__(self, "Store %s is not listable" % store)
781
200
 
782
 
 
783
 
 
784
201
class UnlistableBranch(BzrError):
785
 
 
786
202
    def __init__(self, br):
787
203
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
788
204
 
789
205
 
790
 
class BoundBranchOutOfDate(BzrError):
791
 
 
792
 
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
793
 
 
794
 
    def __init__(self, branch, master):
795
 
        BzrError.__init__(self)
796
 
        self.branch = branch
797
 
        self.master = master
798
 
 
799
 
        
800
 
class CommitToDoubleBoundBranch(BzrError):
801
 
 
802
 
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
803
 
 
804
 
    def __init__(self, branch, master, remote):
805
 
        BzrError.__init__(self)
806
 
        self.branch = branch
807
 
        self.master = master
808
 
        self.remote = remote
809
 
 
810
 
 
811
 
class OverwriteBoundBranch(BzrError):
812
 
 
813
 
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
814
 
 
815
 
    def __init__(self, branch):
816
 
        BzrError.__init__(self)
817
 
        self.branch = branch
818
 
 
819
 
 
820
 
class BoundBranchConnectionFailure(BzrError):
821
 
 
822
 
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
823
 
 
824
 
    def __init__(self, branch, target, error):
825
 
        BzrError.__init__(self)
826
 
        self.branch = branch
827
 
        self.target = target
828
 
        self.error = error
829
 
 
830
 
 
831
 
class WeaveError(BzrError):
832
 
 
833
 
    _fmt = "Error in processing weave: %(message)s"
834
 
 
835
 
    def __init__(self, message=None):
836
 
        BzrError.__init__(self)
837
 
        self.message = message
838
 
 
839
 
 
840
 
class WeaveRevisionAlreadyPresent(WeaveError):
841
 
 
842
 
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
843
 
 
844
 
    def __init__(self, revision_id, weave):
845
 
 
846
 
        WeaveError.__init__(self)
847
 
        self.revision_id = revision_id
848
 
        self.weave = weave
849
 
 
850
 
 
851
 
class WeaveRevisionNotPresent(WeaveError):
852
 
 
853
 
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
854
 
 
855
 
    def __init__(self, revision_id, weave):
856
 
        WeaveError.__init__(self)
857
 
        self.revision_id = revision_id
858
 
        self.weave = weave
859
 
 
860
 
 
861
 
class WeaveFormatError(WeaveError):
862
 
 
863
 
    _fmt = "Weave invariant violated: %(what)s"
864
 
 
865
 
    def __init__(self, what):
866
 
        WeaveError.__init__(self)
867
 
        self.what = what
868
 
 
869
 
 
870
 
class WeaveParentMismatch(WeaveError):
871
 
 
872
 
    _fmt = "Parents are mismatched between two revisions."
873
 
    
874
 
 
875
 
class WeaveInvalidChecksum(WeaveError):
876
 
 
877
 
    _fmt = "Text did not match it's checksum: %(message)s"
878
 
 
879
 
 
880
 
class WeaveTextDiffers(WeaveError):
881
 
 
882
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
883
 
 
884
 
    def __init__(self, revision_id, weave_a, weave_b):
885
 
        WeaveError.__init__(self)
886
 
        self.revision_id = revision_id
887
 
        self.weave_a = weave_a
888
 
        self.weave_b = weave_b
889
 
 
890
 
 
891
 
class WeaveTextDiffers(WeaveError):
892
 
 
893
 
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
894
 
 
895
 
    def __init__(self, revision_id, weave_a, weave_b):
896
 
        WeaveError.__init__(self)
897
 
        self.revision_id = revision_id
898
 
        self.weave_a = weave_a
899
 
        self.weave_b = weave_b
900
 
 
901
 
 
902
 
class VersionedFileError(BzrError):
903
 
    
904
 
    _fmt = "Versioned file error"
905
 
 
906
 
 
907
 
class RevisionNotPresent(VersionedFileError):
908
 
    
909
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
910
 
 
911
 
    def __init__(self, revision_id, file_id):
912
 
        VersionedFileError.__init__(self)
913
 
        self.revision_id = revision_id
914
 
        self.file_id = file_id
915
 
 
916
 
 
917
 
class RevisionAlreadyPresent(VersionedFileError):
918
 
    
919
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
920
 
 
921
 
    def __init__(self, revision_id, file_id):
922
 
        VersionedFileError.__init__(self)
923
 
        self.revision_id = revision_id
924
 
        self.file_id = file_id
925
 
 
926
 
 
927
 
class KnitError(BzrError):
928
 
    
929
 
    _fmt = "Knit error"
930
 
 
931
 
 
932
 
class KnitHeaderError(KnitError):
933
 
 
934
 
    _fmt = "Knit header error: %(badline)r unexpected"
935
 
 
936
 
    def __init__(self, badline):
937
 
        KnitError.__init__(self)
938
 
        self.badline = badline
939
 
 
940
 
 
941
 
class KnitCorrupt(KnitError):
942
 
 
943
 
    _fmt = "Knit %(filename)s corrupt: %(how)s"
944
 
 
945
 
    def __init__(self, filename, how):
946
 
        KnitError.__init__(self)
947
 
        self.filename = filename
948
 
        self.how = how
949
 
 
950
 
 
951
 
class NoSuchExportFormat(BzrError):
952
 
    
953
 
    _fmt = "Export format %(format)r not supported"
954
 
 
955
 
    def __init__(self, format):
956
 
        BzrError.__init__(self)
957
 
        self.format = format
958
 
 
 
206
from bzrlib.weave import WeaveError, WeaveParentMismatch
959
207
 
960
208
class TransportError(BzrError):
961
 
    
962
 
    _fmt = "Transport error: %(msg)s %(orig_error)s"
963
 
 
 
209
    """All errors thrown by Transport implementations should derive
 
210
    from this class.
 
211
    """
964
212
    def __init__(self, msg=None, orig_error=None):
965
213
        if msg is None and orig_error is not None:
966
214
            msg = str(orig_error)
967
 
        if orig_error is None:
968
 
            orig_error = ''
969
 
        if msg is None:
970
 
            msg =  ''
 
215
        BzrError.__init__(self, msg)
971
216
        self.msg = msg
972
217
        self.orig_error = orig_error
973
 
        BzrError.__init__(self)
974
 
 
975
 
 
976
 
class TooManyConcurrentRequests(BzrError):
977
 
 
978
 
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
979
 
            "Be sure to finish_writing and finish_reading on the "
980
 
            "current request that is open.")
981
 
 
982
 
    internal_error = True
983
 
 
984
 
    def __init__(self, medium):
985
 
        self.medium = medium
986
 
 
987
 
 
988
 
class SmartProtocolError(TransportError):
989
 
 
990
 
    _fmt = "Generic bzr smart protocol error: %(details)s"
991
 
 
992
 
    def __init__(self, details):
993
 
        self.details = details
994
 
 
995
218
 
996
219
# A set of semi-meaningful errors which can be thrown
997
220
class TransportNotPossible(TransportError):
998
 
 
999
 
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
1000
 
 
1001
 
 
1002
 
class ConnectionError(TransportError):
1003
 
 
1004
 
    _fmt = "Connection error: %(msg)s %(orig_error)s"
1005
 
 
1006
 
 
1007
 
class SocketConnectionError(ConnectionError):
1008
 
 
1009
 
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
1010
 
 
1011
 
    def __init__(self, host, port=None, msg=None, orig_error=None):
1012
 
        if msg is None:
1013
 
            msg = 'Failed to connect to'
1014
 
        if orig_error is None:
1015
 
            orig_error = ''
1016
 
        else:
1017
 
            orig_error = '; ' + str(orig_error)
1018
 
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
1019
 
        self.host = host
1020
 
        if port is None:
1021
 
            self.port = ''
1022
 
        else:
1023
 
            self.port = ':%s' % port
1024
 
 
 
221
    """This is for transports where a specific function is explicitly not
 
222
    possible. Such as pushing files to an HTTP server.
 
223
    """
 
224
    pass
 
225
 
 
226
class NonRelativePath(TransportError):
 
227
    """An absolute path was supplied, that could not be decoded into
 
228
    a relative path.
 
229
    """
 
230
    pass
 
231
 
 
232
class NoSuchFile(TransportError, IOError):
 
233
    """A get() was issued for a file that doesn't exist."""
 
234
 
 
235
    # XXX: Is multiple inheritance for exceptions really needed?
 
236
 
 
237
    def __str__(self):
 
238
        return 'no such file: ' + self.msg
 
239
 
 
240
    def __init__(self, msg=None, orig_error=None):
 
241
        import errno
 
242
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
243
        IOError.__init__(self, errno.ENOENT, self.msg)
 
244
 
 
245
class FileExists(TransportError, OSError):
 
246
    """An operation was attempted, which would overwrite an entry,
 
247
    but overwritting is not supported.
 
248
 
 
249
    mkdir() can throw this, but put() just overwites existing files.
 
250
    """
 
251
    # XXX: Is multiple inheritance for exceptions really needed?
 
252
    def __init__(self, msg=None, orig_error=None):
 
253
        import errno
 
254
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
255
        OSError.__init__(self, errno.EEXIST, self.msg)
 
256
 
 
257
class PermissionDenied(TransportError):
 
258
    """An operation cannot succeed because of a lack of permissions."""
 
259
    pass
1025
260
 
1026
261
class ConnectionReset(TransportError):
1027
 
 
1028
 
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1029
 
 
1030
 
 
1031
 
class InvalidRange(TransportError):
1032
 
 
1033
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
1034
 
    
1035
 
    def __init__(self, path, offset):
1036
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1037
 
                                       % (path, offset)))
1038
 
        self.path = path
1039
 
        self.offset = offset
1040
 
 
1041
 
 
1042
 
class InvalidHttpResponse(TransportError):
1043
 
 
1044
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1045
 
 
1046
 
    def __init__(self, path, msg, orig_error=None):
1047
 
        self.path = path
1048
 
        TransportError.__init__(self, msg, orig_error=orig_error)
1049
 
 
1050
 
 
1051
 
class InvalidHttpRange(InvalidHttpResponse):
1052
 
 
1053
 
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
1054
 
    
1055
 
    def __init__(self, path, range, msg):
1056
 
        self.range = range
1057
 
        InvalidHttpResponse.__init__(self, path, msg)
1058
 
 
1059
 
 
1060
 
class InvalidHttpContentType(InvalidHttpResponse):
1061
 
 
1062
 
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1063
 
    
1064
 
    def __init__(self, path, ctype, msg):
1065
 
        self.ctype = ctype
1066
 
        InvalidHttpResponse.__init__(self, path, msg)
1067
 
 
 
262
    """The connection has been closed."""
 
263
    pass
1068
264
 
1069
265
class ConflictsInTree(BzrError):
1070
 
 
1071
 
    _fmt = "Working tree has conflicts."
1072
 
 
1073
 
 
1074
 
class ParseConfigError(BzrError):
1075
 
 
1076
 
    def __init__(self, errors, filename):
1077
 
        if filename is None:
1078
 
            filename = ""
1079
 
        message = "Error(s) parsing config file %s:\n%s" % \
1080
 
            (filename, ('\n'.join(e.message for e in errors)))
1081
 
        BzrError.__init__(self, message)
1082
 
 
1083
 
 
1084
 
class NoEmailInUsername(BzrError):
1085
 
 
1086
 
    _fmt = "%(username)r does not seem to contain a reasonable email address"
1087
 
 
1088
 
    def __init__(self, username):
1089
 
        BzrError.__init__(self)
1090
 
        self.username = username
1091
 
 
1092
 
 
1093
 
class SigningFailed(BzrError):
1094
 
 
1095
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1096
 
 
1097
 
    def __init__(self, command_line):
1098
 
        BzrError.__init__(self, command_line=command_line)
1099
 
 
1100
 
 
1101
 
class WorkingTreeNotRevision(BzrError):
1102
 
 
1103
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
1104
 
            " the last commit, but weave merge requires that it be"
1105
 
            " unchanged")
1106
 
 
1107
 
    def __init__(self, tree):
1108
 
        BzrError.__init__(self, basedir=tree.basedir)
1109
 
 
1110
 
 
1111
 
class CantReprocessAndShowBase(BzrError):
1112
 
 
1113
 
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
1114
 
           "the relationship of conflicting lines to the base"
1115
 
 
1116
 
 
1117
 
class GraphCycleError(BzrError):
1118
 
 
1119
 
    _fmt = "Cycle in graph %(graph)r"
1120
 
 
1121
 
    def __init__(self, graph):
1122
 
        BzrError.__init__(self)
1123
 
        self.graph = graph
1124
 
 
1125
 
 
1126
 
class WritingCompleted(BzrError):
1127
 
 
1128
 
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1129
 
            "called upon it - accept bytes may not be called anymore.")
1130
 
 
1131
 
    internal_error = True
1132
 
 
1133
 
    def __init__(self, request):
1134
 
        self.request = request
1135
 
 
1136
 
 
1137
 
class WritingNotComplete(BzrError):
1138
 
 
1139
 
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1140
 
            "called upon it - until the write phase is complete no "
1141
 
            "data may be read.")
1142
 
 
1143
 
    internal_error = True
1144
 
 
1145
 
    def __init__(self, request):
1146
 
        self.request = request
1147
 
 
1148
 
 
1149
 
class NotConflicted(BzrError):
1150
 
 
1151
 
    _fmt = "File %(filename)s is not conflicted."
1152
 
 
1153
 
    def __init__(self, filename):
1154
 
        BzrError.__init__(self)
1155
 
        self.filename = filename
1156
 
 
1157
 
 
1158
 
class MediumNotConnected(BzrError):
1159
 
 
1160
 
    _fmt = """The medium '%(medium)s' is not connected."""
1161
 
 
1162
 
    internal_error = True
1163
 
 
1164
 
    def __init__(self, medium):
1165
 
        self.medium = medium
1166
 
 
1167
 
 
1168
 
class MustUseDecorated(Exception):
1169
 
    
1170
 
    _fmt = """A decorating function has requested its original command be used."""
1171
 
    
1172
 
 
1173
 
class NoBundleFound(BzrError):
1174
 
 
1175
 
    _fmt = "No bundle was found in %(filename)s"
1176
 
 
1177
 
    def __init__(self, filename):
1178
 
        BzrError.__init__(self)
1179
 
        self.filename = filename
1180
 
 
1181
 
 
1182
 
class BundleNotSupported(BzrError):
1183
 
 
1184
 
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
1185
 
 
1186
 
    def __init__(self, version, msg):
1187
 
        BzrError.__init__(self)
1188
 
        self.version = version
1189
 
        self.msg = msg
1190
 
 
1191
 
 
1192
 
class MissingText(BzrError):
1193
 
 
1194
 
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
1195
 
 
1196
 
    def __init__(self, branch, text_revision, file_id):
1197
 
        BzrError.__init__(self)
1198
 
        self.branch = branch
1199
 
        self.base = branch.base
1200
 
        self.text_revision = text_revision
1201
 
        self.file_id = file_id
1202
 
 
1203
 
 
1204
 
class DuplicateKey(BzrError):
1205
 
 
1206
 
    _fmt = "Key %(key)s is already present in map"
1207
 
 
1208
 
 
1209
 
class MalformedTransform(BzrError):
1210
 
 
1211
 
    _fmt = "Tree transform is malformed %(conflicts)r"
1212
 
 
1213
 
 
1214
 
class NoFinalPath(BzrError):
1215
 
 
1216
 
    _fmt = ("No final name for trans_id %(trans_id)r\n"
1217
 
            "file-id: %(file_id)r\n"
1218
 
            "root trans-id: %(root_trans_id)r\n")
1219
 
 
1220
 
    def __init__(self, trans_id, transform):
1221
 
        self.trans_id = trans_id
1222
 
        self.file_id = transform.final_file_id(trans_id)
1223
 
        self.root_trans_id = transform.root
1224
 
 
1225
 
 
1226
 
class BzrBadParameter(BzrError):
1227
 
 
1228
 
    _fmt = "Bad parameter: %(param)r"
1229
 
 
1230
 
    # This exception should never be thrown, but it is a base class for all
1231
 
    # parameter-to-function errors.
1232
 
 
1233
 
    def __init__(self, param):
1234
 
        BzrError.__init__(self)
1235
 
        self.param = param
1236
 
 
1237
 
 
1238
 
class BzrBadParameterNotUnicode(BzrBadParameter):
1239
 
 
1240
 
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
1241
 
 
1242
 
 
1243
 
class ReusingTransform(BzrError):
1244
 
 
1245
 
    _fmt = "Attempt to reuse a transform that has already been applied."
1246
 
 
1247
 
 
1248
 
class CantMoveRoot(BzrError):
1249
 
 
1250
 
    _fmt = "Moving the root directory is not supported at this time"
1251
 
 
1252
 
 
1253
 
class BzrBadParameterNotString(BzrBadParameter):
1254
 
 
1255
 
    _fmt = "Parameter %(param)s is not a string or unicode string."
1256
 
 
1257
 
 
1258
 
class BzrBadParameterMissing(BzrBadParameter):
1259
 
 
1260
 
    _fmt = "Parameter $(param)s is required but not present."
1261
 
 
1262
 
 
1263
 
class BzrBadParameterUnicode(BzrBadParameter):
1264
 
 
1265
 
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
1266
 
 
1267
 
 
1268
 
class BzrBadParameterContainsNewline(BzrBadParameter):
1269
 
 
1270
 
    _fmt = "Parameter %(param)s contains a newline."
1271
 
 
1272
 
 
1273
 
class DependencyNotPresent(BzrError):
1274
 
 
1275
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1276
 
 
1277
 
    def __init__(self, library, error):
1278
 
        BzrError.__init__(self, library=library, error=error)
1279
 
 
1280
 
 
1281
 
class ParamikoNotPresent(DependencyNotPresent):
1282
 
 
1283
 
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1284
 
 
1285
 
    def __init__(self, error):
1286
 
        DependencyNotPresent.__init__(self, 'paramiko', error)
1287
 
 
1288
 
 
1289
 
class PointlessMerge(BzrError):
1290
 
 
1291
 
    _fmt = "Nothing to merge."
1292
 
 
1293
 
 
1294
 
class UninitializableFormat(BzrError):
1295
 
 
1296
 
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
1297
 
 
1298
 
    def __init__(self, format):
1299
 
        BzrError.__init__(self)
1300
 
        self.format = format
1301
 
 
1302
 
 
1303
 
class BadConversionTarget(BzrError):
1304
 
 
1305
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
1306
 
 
1307
 
    def __init__(self, problem, format):
1308
 
        BzrError.__init__(self)
1309
 
        self.problem = problem
1310
 
        self.format = format
1311
 
 
1312
 
 
1313
 
class NoDiff(BzrError):
1314
 
 
1315
 
    _fmt = "Diff is not installed on this machine: %(msg)s"
1316
 
 
1317
 
    def __init__(self, msg):
1318
 
        BzrError.__init__(self, msg=msg)
1319
 
 
1320
 
 
1321
 
class NoDiff3(BzrError):
1322
 
 
1323
 
    _fmt = "Diff3 is not installed on this machine."
1324
 
 
1325
 
 
1326
 
class ExistingLimbo(BzrError):
1327
 
 
1328
 
    _fmt = """This tree contains left-over files from a failed operation.
1329
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1330
 
    keep, and delete it when you are done."""
1331
 
    
1332
 
    def __init__(self, limbo_dir):
1333
 
       BzrError.__init__(self)
1334
 
       self.limbo_dir = limbo_dir
1335
 
 
1336
 
 
1337
 
class ImmortalLimbo(BzrError):
1338
 
 
1339
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
1340
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1341
 
    keep, and delete it when you are done."""
1342
 
 
1343
 
    def __init__(self, limbo_dir):
1344
 
       BzrError.__init__(self)
1345
 
       self.limbo_dir = limbo_dir
1346
 
 
1347
 
 
1348
 
class OutOfDateTree(BzrError):
1349
 
 
1350
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
1351
 
 
1352
 
    def __init__(self, tree):
1353
 
        BzrError.__init__(self)
1354
 
        self.tree = tree
1355
 
 
1356
 
 
1357
 
class MergeModifiedFormatError(BzrError):
1358
 
 
1359
 
    _fmt = "Error in merge modified format"
1360
 
 
1361
 
 
1362
 
class ConflictFormatError(BzrError):
1363
 
 
1364
 
    _fmt = "Format error in conflict listings"
1365
 
 
1366
 
 
1367
 
class CorruptRepository(BzrError):
1368
 
 
1369
 
    _fmt = """An error has been detected in the repository %(repo_path)s.
1370
 
Please run bzr reconcile on this repository."""
1371
 
 
1372
 
    def __init__(self, repo):
1373
 
        BzrError.__init__(self)
1374
 
        self.repo_path = repo.bzrdir.root_transport.base
1375
 
 
1376
 
 
1377
 
class UpgradeRequired(BzrError):
1378
 
 
1379
 
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
1380
 
 
1381
 
    def __init__(self, path):
1382
 
        BzrError.__init__(self)
1383
 
        self.path = path
1384
 
 
1385
 
 
1386
 
class LocalRequiresBoundBranch(BzrError):
1387
 
 
1388
 
    _fmt = "Cannot perform local-only commits on unbound branches."
1389
 
 
1390
 
 
1391
 
class MissingProgressBarFinish(BzrError):
1392
 
 
1393
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1394
 
 
1395
 
 
1396
 
class InvalidProgressBarType(BzrError):
1397
 
 
1398
 
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1399
 
Select one of: %(valid_types)s"""
1400
 
 
1401
 
    def __init__(self, bar_type, valid_types):
1402
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1403
 
 
1404
 
 
1405
 
class UnsupportedOperation(BzrError):
1406
 
 
1407
 
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
1408
 
 
1409
 
    def __init__(self, method, method_self):
1410
 
        self.method = method
1411
 
        self.mname = method.__name__
1412
 
        self.tname = type(method_self).__name__
1413
 
 
1414
 
 
1415
 
class BinaryFile(BzrError):
1416
 
    
1417
 
    _fmt = "File is binary but should be text."
1418
 
 
1419
 
 
1420
 
class IllegalPath(BzrError):
1421
 
 
1422
 
    _fmt = "The path %(path)s is not permitted on this platform"
1423
 
 
1424
 
    def __init__(self, path):
1425
 
        BzrError.__init__(self)
1426
 
        self.path = path
1427
 
 
1428
 
 
1429
 
class TestamentMismatch(BzrError):
1430
 
 
1431
 
    _fmt = """Testament did not match expected value.  
1432
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
1433
 
       {%(measured)s}"""
1434
 
 
1435
 
    def __init__(self, revision_id, expected, measured):
1436
 
        self.revision_id = revision_id
1437
 
        self.expected = expected
1438
 
        self.measured = measured
1439
 
 
1440
 
 
1441
 
class NotABundle(BzrError):
1442
 
    
1443
 
    _fmt = "Not a bzr revision-bundle: %(text)r"
1444
 
 
1445
 
    def __init__(self, text):
1446
 
        BzrError.__init__(self)
1447
 
        self.text = text
1448
 
 
1449
 
 
1450
 
class BadBundle(BzrError): 
1451
 
    
1452
 
    _fmt = "Bad bzr revision-bundle: %(text)r"
1453
 
 
1454
 
    def __init__(self, text):
1455
 
        BzrError.__init__(self)
1456
 
        self.text = text
1457
 
 
1458
 
 
1459
 
class MalformedHeader(BadBundle): 
1460
 
    
1461
 
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
1462
 
 
1463
 
 
1464
 
class MalformedPatches(BadBundle): 
1465
 
    
1466
 
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1467
 
 
1468
 
 
1469
 
class MalformedFooter(BadBundle): 
1470
 
    
1471
 
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1472
 
 
1473
 
 
1474
 
class UnsupportedEOLMarker(BadBundle):
1475
 
    
1476
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
1477
 
 
1478
266
    def __init__(self):
1479
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
1480
 
        # but for this there is not
1481
 
        BzrError.__init__(self)
1482
 
 
1483
 
 
1484
 
class IncompatibleBundleFormat(BzrError):
1485
 
    
1486
 
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1487
 
 
1488
 
    def __init__(self, bundle_format, other):
1489
 
        BzrError.__init__(self)
1490
 
        self.bundle_format = bundle_format
1491
 
        self.other = other
1492
 
 
1493
 
 
1494
 
class BadInventoryFormat(BzrError):
1495
 
    
1496
 
    _fmt = "Root class for inventory serialization errors"
1497
 
 
1498
 
 
1499
 
class UnexpectedInventoryFormat(BadInventoryFormat):
1500
 
 
1501
 
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
1502
 
 
1503
 
    def __init__(self, msg):
1504
 
        BadInventoryFormat.__init__(self, msg=msg)
1505
 
 
1506
 
 
1507
 
class NoSmartMedium(BzrError):
1508
 
 
1509
 
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1510
 
 
1511
 
    def __init__(self, transport):
1512
 
        self.transport = transport
1513
 
 
1514
 
 
1515
 
class NoSmartServer(NotBranchError):
1516
 
 
1517
 
    _fmt = "No smart server available at %(url)s"
1518
 
 
1519
 
    def __init__(self, url):
1520
 
        self.url = url
1521
 
 
1522
 
 
1523
 
class UnknownSSH(BzrError):
1524
 
 
1525
 
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1526
 
 
1527
 
    def __init__(self, vendor):
1528
 
        BzrError.__init__(self)
1529
 
        self.vendor = vendor
1530
 
 
1531
 
 
1532
 
class GhostRevisionUnusableHere(BzrError):
1533
 
 
1534
 
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1535
 
 
1536
 
    def __init__(self, revision_id):
1537
 
        BzrError.__init__(self)
1538
 
        self.revision_id = revision_id
1539
 
 
1540
 
 
1541
 
class IllegalUseOfScopeReplacer(BzrError):
1542
 
 
1543
 
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
1544
 
 
1545
 
    internal_error = True
1546
 
 
1547
 
    def __init__(self, name, msg, extra=None):
1548
 
        BzrError.__init__(self)
1549
 
        self.name = name
1550
 
        self.msg = msg
1551
 
        if extra:
1552
 
            self.extra = ': ' + str(extra)
1553
 
        else:
1554
 
            self.extra = ''
1555
 
 
1556
 
 
1557
 
class InvalidImportLine(BzrError):
1558
 
 
1559
 
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1560
 
 
1561
 
    internal_error = True
1562
 
 
1563
 
    def __init__(self, text, msg):
1564
 
        BzrError.__init__(self)
1565
 
        self.text = text
1566
 
        self.msg = msg
1567
 
 
1568
 
 
1569
 
class ImportNameCollision(BzrError):
1570
 
 
1571
 
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
1572
 
 
1573
 
    internal_error = True
1574
 
 
1575
 
    def __init__(self, name):
1576
 
        BzrError.__init__(self)
1577
 
        self.name = name
 
267
        BzrError.__init__(self, "Working tree has conflicts.")