~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2009-07-10 07:14:02 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710071402-dga5lhvdup5jeere
Rename remaining *_implementations tests

Show diffs side-by-side

added added

removed removed

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