~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-03-06 10:51:27 UTC
  • mto: (2321.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: robertc@robertcollins.net-20070306105127-tdec4zgv1tkfgi1d
Fix failing detection of changes restricted to subtrees causing spurious pointless commit errors.

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