/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Fix 1 more lock-related test failure.

* tests/test_rename_map.py:
(TestRenameMap.test_guess_renames_preserves_children): Add the
forgotten unlock.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 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
 
 
52
class BzrError(StandardError):
 
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
 
390
 
 
391
 
 
392
class BzrCommandError(BzrError):
 
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 UnstackableRepositoryFormat(BzrError):
 
640
 
 
641
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
642
        "You will need to upgrade the repository to permit branch stacking.")
 
643
 
 
644
    def __init__(self, format, url):
 
645
        BzrError.__init__(self)
 
646
        self.format = format
 
647
        self.url = url
 
648
 
 
649
 
 
650
class ReadError(PathError):
 
651
 
 
652
    _fmt = """Error reading from %(path)r."""
 
653
 
 
654
 
 
655
class ShortReadvError(PathError):
 
656
 
 
657
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
658
            ' at %(offset)s for "%(path)s"%(extra)s')
 
659
 
 
660
    internal_error = True
 
661
 
 
662
    def __init__(self, path, offset, length, actual, extra=None):
 
663
        PathError.__init__(self, path, extra=extra)
 
664
        self.offset = offset
 
665
        self.length = length
 
666
        self.actual = actual
 
667
 
 
668
 
 
669
class PathNotChild(PathError):
 
670
 
 
671
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
672
 
 
673
    internal_error = True
 
674
 
 
675
    def __init__(self, path, base, extra=None):
 
676
        BzrError.__init__(self)
 
677
        self.path = path
 
678
        self.base = base
 
679
        if extra:
 
680
            self.extra = ': ' + str(extra)
 
681
        else:
 
682
            self.extra = ''
 
683
 
 
684
 
 
685
class InvalidNormalization(PathError):
 
686
 
 
687
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
688
 
 
689
 
 
690
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
691
# the exception object is a bit undesirable.
 
692
# TODO: Probably this behavior of should be a common superclass
 
693
class NotBranchError(PathError):
 
694
 
 
695
    _fmt = 'Not a branch: "%(path)s".'
 
696
 
 
697
    def __init__(self, path):
 
698
       import bzrlib.urlutils as urlutils
 
699
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
700
 
 
701
 
 
702
class NoSubmitBranch(PathError):
 
703
 
 
704
    _fmt = 'No submit branch available for branch "%(path)s"'
 
705
 
 
706
    def __init__(self, branch):
 
707
       import bzrlib.urlutils as urlutils
 
708
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
709
 
 
710
 
 
711
class AlreadyBranchError(PathError):
 
712
 
 
713
    _fmt = 'Already a branch: "%(path)s".'
 
714
 
 
715
 
 
716
class BranchExistsWithoutWorkingTree(PathError):
 
717
 
 
718
    _fmt = 'Directory contains a branch, but no working tree \
 
719
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
720
 
 
721
 
 
722
class AtomicFileAlreadyClosed(PathError):
 
723
 
 
724
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
725
            ' "%(path)s"')
 
726
 
 
727
    def __init__(self, path, function):
 
728
        PathError.__init__(self, path=path, extra=None)
 
729
        self.function = function
 
730
 
 
731
 
 
732
class InaccessibleParent(PathError):
 
733
 
 
734
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
735
            ' relative path "%(path)s"')
 
736
 
 
737
    def __init__(self, path, base):
 
738
        PathError.__init__(self, path)
 
739
        self.base = base
 
740
 
 
741
 
 
742
class NoRepositoryPresent(BzrError):
 
743
 
 
744
    _fmt = 'No repository present: "%(path)s"'
 
745
    def __init__(self, bzrdir):
 
746
        BzrError.__init__(self)
 
747
        self.path = bzrdir.transport.clone('..').base
 
748
 
 
749
 
 
750
class FileInWrongBranch(BzrError):
 
751
 
 
752
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
753
 
 
754
    def __init__(self, branch, path):
 
755
        BzrError.__init__(self)
 
756
        self.branch = branch
 
757
        self.branch_base = branch.base
 
758
        self.path = path
 
759
 
 
760
 
 
761
class UnsupportedFormatError(BzrError):
 
762
 
 
763
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
764
 
 
765
 
 
766
class UnknownFormatError(BzrError):
 
767
 
 
768
    _fmt = "Unknown %(kind)s format: %(format)r"
 
769
 
 
770
    def __init__(self, format, kind='branch'):
 
771
        self.kind = kind
 
772
        self.format = format
 
773
 
 
774
 
 
775
class IncompatibleFormat(BzrError):
 
776
 
 
777
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
778
 
 
779
    def __init__(self, format, bzrdir_format):
 
780
        BzrError.__init__(self)
 
781
        self.format = format
 
782
        self.bzrdir = bzrdir_format
 
783
 
 
784
 
 
785
class IncompatibleRepositories(BzrError):
 
786
 
 
787
    _fmt = "%(target)s\n" \
 
788
            "is not compatible with\n" \
 
789
            "%(source)s\n" \
 
790
            "%(details)s"
 
791
 
 
792
    def __init__(self, source, target, details=None):
 
793
        if details is None:
 
794
            details = "(no details)"
 
795
        BzrError.__init__(self, target=target, source=source, details=details)
 
796
 
 
797
 
 
798
class IncompatibleRevision(BzrError):
 
799
 
 
800
    _fmt = "Revision is not compatible with %(repo_format)s"
 
801
 
 
802
    def __init__(self, repo_format):
 
803
        BzrError.__init__(self)
 
804
        self.repo_format = repo_format
 
805
 
 
806
 
 
807
class AlreadyVersionedError(BzrError):
 
808
    """Used when a path is expected not to be versioned, but it is."""
 
809
 
 
810
    _fmt = "%(context_info)s%(path)s is already versioned."
 
811
 
 
812
    def __init__(self, path, context_info=None):
 
813
        """Construct a new AlreadyVersionedError.
 
814
 
 
815
        :param path: This is the path which is versioned,
 
816
        which should be in a user friendly form.
 
817
        :param context_info: If given, this is information about the context,
 
818
        which could explain why this is expected to not be versioned.
 
819
        """
 
820
        BzrError.__init__(self)
 
821
        self.path = path
 
822
        if context_info is None:
 
823
            self.context_info = ''
 
824
        else:
 
825
            self.context_info = context_info + ". "
 
826
 
 
827
 
 
828
class NotVersionedError(BzrError):
 
829
    """Used when a path is expected to be versioned, but it is not."""
 
830
 
 
831
    _fmt = "%(context_info)s%(path)s is not versioned."
 
832
 
 
833
    def __init__(self, path, context_info=None):
 
834
        """Construct a new NotVersionedError.
 
835
 
 
836
        :param path: This is the path which is not versioned,
 
837
        which should be in a user friendly form.
 
838
        :param context_info: If given, this is information about the context,
 
839
        which could explain why this is expected to be versioned.
 
840
        """
 
841
        BzrError.__init__(self)
 
842
        self.path = path
 
843
        if context_info is None:
 
844
            self.context_info = ''
 
845
        else:
 
846
            self.context_info = context_info + ". "
 
847
 
 
848
 
 
849
class PathsNotVersionedError(BzrError):
 
850
    """Used when reporting several paths which are not versioned"""
 
851
 
 
852
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
853
 
 
854
    def __init__(self, paths):
 
855
        from bzrlib.osutils import quotefn
 
856
        BzrError.__init__(self)
 
857
        self.paths = paths
 
858
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
859
 
 
860
 
 
861
class PathsDoNotExist(BzrError):
 
862
 
 
863
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
864
 
 
865
    # used when reporting that paths are neither versioned nor in the working
 
866
    # tree
 
867
 
 
868
    def __init__(self, paths, extra=None):
 
869
        # circular import
 
870
        from bzrlib.osutils import quotefn
 
871
        BzrError.__init__(self)
 
872
        self.paths = paths
 
873
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
874
        if extra:
 
875
            self.extra = ': ' + str(extra)
 
876
        else:
 
877
            self.extra = ''
 
878
 
 
879
 
 
880
class BadFileKindError(BzrError):
 
881
 
 
882
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
883
 
 
884
    def __init__(self, filename, kind):
 
885
        BzrError.__init__(self, filename=filename, kind=kind)
 
886
 
 
887
 
 
888
class BadFilenameEncoding(BzrError):
 
889
 
 
890
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
891
            ' encoding %(fs_encoding)s')
 
892
 
 
893
    def __init__(self, filename, fs_encoding):
 
894
        BzrError.__init__(self)
 
895
        self.filename = filename
 
896
        self.fs_encoding = fs_encoding
 
897
 
 
898
 
 
899
class ForbiddenControlFileError(BzrError):
 
900
 
 
901
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
902
 
 
903
 
 
904
class LockError(InternalBzrError):
 
905
 
 
906
    _fmt = "Lock error: %(msg)s"
 
907
 
 
908
    # All exceptions from the lock/unlock functions should be from
 
909
    # this exception class.  They will be translated as necessary. The
 
910
    # original exception is available as e.original_error
 
911
    #
 
912
    # New code should prefer to raise specific subclasses
 
913
    def __init__(self, message):
 
914
        # Python 2.5 uses a slot for StandardError.message,
 
915
        # so use a different variable name.  We now work around this in
 
916
        # BzrError.__str__, but this member name is kept for compatability.
 
917
        self.msg = message
 
918
 
 
919
 
 
920
class LockActive(LockError):
 
921
 
 
922
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
923
 
 
924
    internal_error = False
 
925
 
 
926
    def __init__(self, lock_description):
 
927
        self.lock_description = lock_description
 
928
 
 
929
 
 
930
class CommitNotPossible(LockError):
 
931
 
 
932
    _fmt = "A commit was attempted but we do not have a write lock open."
 
933
 
 
934
    def __init__(self):
 
935
        pass
 
936
 
 
937
 
 
938
class AlreadyCommitted(LockError):
 
939
 
 
940
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
941
 
 
942
    def __init__(self):
 
943
        pass
 
944
 
 
945
 
 
946
class ReadOnlyError(LockError):
 
947
 
 
948
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
949
 
 
950
    # TODO: There should also be an error indicating that you need a write
 
951
    # lock and don't have any lock at all... mbp 20070226
 
952
 
 
953
    def __init__(self, obj):
 
954
        self.obj = obj
 
955
 
 
956
 
 
957
class LockFailed(LockError):
 
958
 
 
959
    internal_error = False
 
960
 
 
961
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
962
 
 
963
    def __init__(self, lock, why):
 
964
        LockError.__init__(self, '')
 
965
        self.lock = lock
 
966
        self.why = why
 
967
 
 
968
 
 
969
class OutSideTransaction(BzrError):
 
970
 
 
971
    _fmt = ("A transaction related operation was attempted after"
 
972
            " the transaction finished.")
 
973
 
 
974
 
 
975
class ObjectNotLocked(LockError):
 
976
 
 
977
    _fmt = "%(obj)r is not locked"
 
978
 
 
979
    # this can indicate that any particular object is not locked; see also
 
980
    # LockNotHeld which means that a particular *lock* object is not held by
 
981
    # the caller -- perhaps they should be unified.
 
982
    def __init__(self, obj):
 
983
        self.obj = obj
 
984
 
 
985
 
 
986
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
987
 
 
988
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
989
 
 
990
    def __init__(self, obj):
 
991
        self.obj = obj
 
992
 
 
993
 
 
994
class UnlockableTransport(LockError):
 
995
 
 
996
    internal_error = False
 
997
 
 
998
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
999
 
 
1000
    def __init__(self, transport):
 
1001
        self.transport = transport
 
1002
 
 
1003
 
 
1004
class LockContention(LockError):
 
1005
 
 
1006
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1007
    # TODO: show full url for lock, combining the transport and relative
 
1008
    # bits?
 
1009
 
 
1010
    internal_error = False
 
1011
 
 
1012
    def __init__(self, lock, msg=''):
 
1013
        self.lock = lock
 
1014
        self.msg = msg
 
1015
 
 
1016
 
 
1017
class LockBroken(LockError):
 
1018
 
 
1019
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1020
            " - check storage consistency!")
 
1021
 
 
1022
    internal_error = False
 
1023
 
 
1024
    def __init__(self, lock):
 
1025
        self.lock = lock
 
1026
 
 
1027
 
 
1028
class LockBreakMismatch(LockError):
 
1029
 
 
1030
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1031
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
1032
 
 
1033
    internal_error = False
 
1034
 
 
1035
    def __init__(self, lock, holder, target):
 
1036
        self.lock = lock
 
1037
        self.holder = holder
 
1038
        self.target = target
 
1039
 
 
1040
 
 
1041
class LockNotHeld(LockError):
 
1042
 
 
1043
    _fmt = "Lock not held: %(lock)s"
 
1044
 
 
1045
    internal_error = False
 
1046
 
 
1047
    def __init__(self, lock):
 
1048
        self.lock = lock
 
1049
 
 
1050
 
 
1051
class TokenLockingNotSupported(LockError):
 
1052
 
 
1053
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1054
 
 
1055
    def __init__(self, obj):
 
1056
        self.obj = obj
 
1057
 
 
1058
 
 
1059
class TokenMismatch(LockBroken):
 
1060
 
 
1061
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1062
 
 
1063
    internal_error = True
 
1064
 
 
1065
    def __init__(self, given_token, lock_token):
 
1066
        self.given_token = given_token
 
1067
        self.lock_token = lock_token
 
1068
 
 
1069
 
 
1070
class PointlessCommit(BzrError):
 
1071
 
 
1072
    _fmt = "No changes to commit"
 
1073
 
 
1074
 
 
1075
class CannotCommitSelectedFileMerge(BzrError):
 
1076
 
 
1077
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1078
        ' files %(files_str)s'
 
1079
 
 
1080
    def __init__(self, files):
 
1081
        files_str = ', '.join(files)
 
1082
        BzrError.__init__(self, files=files, files_str=files_str)
 
1083
 
 
1084
 
 
1085
class BadCommitMessageEncoding(BzrError):
 
1086
 
 
1087
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1088
        'the current encoding.'
 
1089
 
 
1090
 
 
1091
class UpgradeReadonly(BzrError):
 
1092
 
 
1093
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
1094
 
 
1095
 
 
1096
class UpToDateFormat(BzrError):
 
1097
 
 
1098
    _fmt = "The branch format %(format)s is already at the most recent format."
 
1099
 
 
1100
    def __init__(self, format):
 
1101
        BzrError.__init__(self)
 
1102
        self.format = format
 
1103
 
 
1104
 
 
1105
class StrictCommitFailed(Exception):
 
1106
 
 
1107
    _fmt = "Commit refused because there are unknowns in the tree."
 
1108
 
 
1109
 
 
1110
class NoSuchRevision(InternalBzrError):
 
1111
 
 
1112
    _fmt = "%(branch)s has no revision %(revision)s"
 
1113
 
 
1114
    def __init__(self, branch, revision):
 
1115
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1116
        BzrError.__init__(self, branch=branch, revision=revision)
 
1117
 
 
1118
 
 
1119
class RangeInChangeOption(BzrError):
 
1120
 
 
1121
    _fmt = "Option --change does not accept revision ranges"
 
1122
 
 
1123
 
 
1124
class NoSuchRevisionSpec(BzrError):
 
1125
 
 
1126
    _fmt = "No namespace registered for string: %(spec)r"
 
1127
 
 
1128
    def __init__(self, spec):
 
1129
        BzrError.__init__(self, spec=spec)
 
1130
 
 
1131
 
 
1132
class NoSuchRevisionInTree(NoSuchRevision):
 
1133
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1134
 
 
1135
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1136
 
 
1137
    def __init__(self, tree, revision_id):
 
1138
        BzrError.__init__(self)
 
1139
        self.tree = tree
 
1140
        self.revision_id = revision_id
 
1141
 
 
1142
 
 
1143
class InvalidRevisionSpec(BzrError):
 
1144
 
 
1145
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1146
            " %(branch)s%(extra)s")
 
1147
 
 
1148
    def __init__(self, spec, branch, extra=None):
 
1149
        BzrError.__init__(self, branch=branch, spec=spec)
 
1150
        if extra:
 
1151
            self.extra = '\n' + str(extra)
 
1152
        else:
 
1153
            self.extra = ''
 
1154
 
 
1155
 
 
1156
class HistoryMissing(BzrError):
 
1157
 
 
1158
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1159
 
 
1160
 
 
1161
class AppendRevisionsOnlyViolation(BzrError):
 
1162
 
 
1163
    _fmt = ('Operation denied because it would change the main history,'
 
1164
           ' which is not permitted by the append_revisions_only setting on'
 
1165
           ' branch "%(location)s".')
 
1166
 
 
1167
    def __init__(self, location):
 
1168
       import bzrlib.urlutils as urlutils
 
1169
       location = urlutils.unescape_for_display(location, 'ascii')
 
1170
       BzrError.__init__(self, location=location)
 
1171
 
 
1172
 
 
1173
class DivergedBranches(BzrError):
 
1174
 
 
1175
    _fmt = ("These branches have diverged."
 
1176
            " Use the merge command to reconcile them.")
 
1177
 
 
1178
    def __init__(self, branch1, branch2):
 
1179
        self.branch1 = branch1
 
1180
        self.branch2 = branch2
 
1181
 
 
1182
 
 
1183
class NotLefthandHistory(InternalBzrError):
 
1184
 
 
1185
    _fmt = "Supplied history does not follow left-hand parents"
 
1186
 
 
1187
    def __init__(self, history):
 
1188
        BzrError.__init__(self, history=history)
 
1189
 
 
1190
 
 
1191
class UnrelatedBranches(BzrError):
 
1192
 
 
1193
    _fmt = ("Branches have no common ancestor, and"
 
1194
            " no merge base revision was specified.")
 
1195
 
 
1196
 
 
1197
class CannotReverseCherrypick(BzrError):
 
1198
 
 
1199
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1200
            ' or diff3.')
 
1201
 
 
1202
 
 
1203
class NoCommonAncestor(BzrError):
 
1204
 
 
1205
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1206
 
 
1207
    def __init__(self, revision_a, revision_b):
 
1208
        self.revision_a = revision_a
 
1209
        self.revision_b = revision_b
 
1210
 
 
1211
 
 
1212
class NoCommonRoot(BzrError):
 
1213
 
 
1214
    _fmt = ("Revisions are not derived from the same root: "
 
1215
           "%(revision_a)s %(revision_b)s.")
 
1216
 
 
1217
    def __init__(self, revision_a, revision_b):
 
1218
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1219
 
 
1220
 
 
1221
class NotAncestor(BzrError):
 
1222
 
 
1223
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1224
 
 
1225
    def __init__(self, rev_id, not_ancestor_id):
 
1226
        BzrError.__init__(self, rev_id=rev_id,
 
1227
            not_ancestor_id=not_ancestor_id)
 
1228
 
 
1229
 
 
1230
class AmbiguousBase(BzrError):
 
1231
 
 
1232
    def __init__(self, bases):
 
1233
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1234
                DeprecationWarning)
 
1235
        msg = ("The correct base is unclear, because %s are all equally close"
 
1236
                % ", ".join(bases))
 
1237
        BzrError.__init__(self, msg)
 
1238
        self.bases = bases
 
1239
 
 
1240
 
 
1241
class NoCommits(BranchError):
 
1242
 
 
1243
    _fmt = "Branch %(branch)s has no commits."
 
1244
 
 
1245
 
 
1246
class UnlistableStore(BzrError):
 
1247
 
 
1248
    def __init__(self, store):
 
1249
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1250
 
 
1251
 
 
1252
 
 
1253
class UnlistableBranch(BzrError):
 
1254
 
 
1255
    def __init__(self, br):
 
1256
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1257
 
 
1258
 
 
1259
class BoundBranchOutOfDate(BzrError):
 
1260
 
 
1261
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1262
            " %(master)s.")
 
1263
 
 
1264
    def __init__(self, branch, master):
 
1265
        BzrError.__init__(self)
 
1266
        self.branch = branch
 
1267
        self.master = master
 
1268
 
 
1269
 
 
1270
class CommitToDoubleBoundBranch(BzrError):
 
1271
 
 
1272
    _fmt = ("Cannot commit to branch %(branch)s."
 
1273
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1274
 
 
1275
    def __init__(self, branch, master, remote):
 
1276
        BzrError.__init__(self)
 
1277
        self.branch = branch
 
1278
        self.master = master
 
1279
        self.remote = remote
 
1280
 
 
1281
 
 
1282
class OverwriteBoundBranch(BzrError):
 
1283
 
 
1284
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1285
 
 
1286
    def __init__(self, branch):
 
1287
        BzrError.__init__(self)
 
1288
        self.branch = branch
 
1289
 
 
1290
 
 
1291
class BoundBranchConnectionFailure(BzrError):
 
1292
 
 
1293
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1294
            " => %(target)s: %(error)s")
 
1295
 
 
1296
    def __init__(self, branch, target, error):
 
1297
        BzrError.__init__(self)
 
1298
        self.branch = branch
 
1299
        self.target = target
 
1300
        self.error = error
 
1301
 
 
1302
 
 
1303
class WeaveError(BzrError):
 
1304
 
 
1305
    _fmt = "Error in processing weave: %(msg)s"
 
1306
 
 
1307
    def __init__(self, msg=None):
 
1308
        BzrError.__init__(self)
 
1309
        self.msg = msg
 
1310
 
 
1311
 
 
1312
class WeaveRevisionAlreadyPresent(WeaveError):
 
1313
 
 
1314
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1315
 
 
1316
    def __init__(self, revision_id, weave):
 
1317
 
 
1318
        WeaveError.__init__(self)
 
1319
        self.revision_id = revision_id
 
1320
        self.weave = weave
 
1321
 
 
1322
 
 
1323
class WeaveRevisionNotPresent(WeaveError):
 
1324
 
 
1325
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1326
 
 
1327
    def __init__(self, revision_id, weave):
 
1328
        WeaveError.__init__(self)
 
1329
        self.revision_id = revision_id
 
1330
        self.weave = weave
 
1331
 
 
1332
 
 
1333
class WeaveFormatError(WeaveError):
 
1334
 
 
1335
    _fmt = "Weave invariant violated: %(what)s"
 
1336
 
 
1337
    def __init__(self, what):
 
1338
        WeaveError.__init__(self)
 
1339
        self.what = what
 
1340
 
 
1341
 
 
1342
class WeaveParentMismatch(WeaveError):
 
1343
 
 
1344
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1345
 
 
1346
 
 
1347
class WeaveInvalidChecksum(WeaveError):
 
1348
 
 
1349
    _fmt = "Text did not match it's checksum: %(message)s"
 
1350
 
 
1351
 
 
1352
class WeaveTextDiffers(WeaveError):
 
1353
 
 
1354
    _fmt = ("Weaves differ on text content. Revision:"
 
1355
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1356
 
 
1357
    def __init__(self, revision_id, weave_a, weave_b):
 
1358
        WeaveError.__init__(self)
 
1359
        self.revision_id = revision_id
 
1360
        self.weave_a = weave_a
 
1361
        self.weave_b = weave_b
 
1362
 
 
1363
 
 
1364
class WeaveTextDiffers(WeaveError):
 
1365
 
 
1366
    _fmt = ("Weaves differ on text content. Revision:"
 
1367
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1368
 
 
1369
    def __init__(self, revision_id, weave_a, weave_b):
 
1370
        WeaveError.__init__(self)
 
1371
        self.revision_id = revision_id
 
1372
        self.weave_a = weave_a
 
1373
        self.weave_b = weave_b
 
1374
 
 
1375
 
 
1376
class VersionedFileError(BzrError):
 
1377
 
 
1378
    _fmt = "Versioned file error"
 
1379
 
 
1380
 
 
1381
class RevisionNotPresent(VersionedFileError):
 
1382
 
 
1383
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1384
 
 
1385
    def __init__(self, revision_id, file_id):
 
1386
        VersionedFileError.__init__(self)
 
1387
        self.revision_id = revision_id
 
1388
        self.file_id = file_id
 
1389
 
 
1390
 
 
1391
class RevisionAlreadyPresent(VersionedFileError):
 
1392
 
 
1393
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1394
 
 
1395
    def __init__(self, revision_id, file_id):
 
1396
        VersionedFileError.__init__(self)
 
1397
        self.revision_id = revision_id
 
1398
        self.file_id = file_id
 
1399
 
 
1400
 
 
1401
class VersionedFileInvalidChecksum(VersionedFileError):
 
1402
 
 
1403
    _fmt = "Text did not match its checksum: %(message)s"
 
1404
 
 
1405
 
 
1406
class KnitError(InternalBzrError):
 
1407
 
 
1408
    _fmt = "Knit error"
 
1409
 
 
1410
 
 
1411
class KnitCorrupt(KnitError):
 
1412
 
 
1413
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1414
 
 
1415
    def __init__(self, filename, how):
 
1416
        KnitError.__init__(self)
 
1417
        self.filename = filename
 
1418
        self.how = how
 
1419
 
 
1420
 
 
1421
class SHA1KnitCorrupt(KnitCorrupt):
 
1422
 
 
1423
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1424
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1425
        "sha %(actual)s")
 
1426
 
 
1427
    def __init__(self, filename, actual, expected, key, content):
 
1428
        KnitError.__init__(self)
 
1429
        self.filename = filename
 
1430
        self.actual = actual
 
1431
        self.expected = expected
 
1432
        self.key = key
 
1433
        self.content = content
 
1434
 
 
1435
 
 
1436
class KnitDataStreamIncompatible(KnitError):
 
1437
    # Not raised anymore, as we can convert data streams.  In future we may
 
1438
    # need it again for more exotic cases, so we're keeping it around for now.
 
1439
 
 
1440
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1441
 
 
1442
    def __init__(self, stream_format, target_format):
 
1443
        self.stream_format = stream_format
 
1444
        self.target_format = target_format
 
1445
 
 
1446
 
 
1447
class KnitDataStreamUnknown(KnitError):
 
1448
    # Indicates a data stream we don't know how to handle.
 
1449
 
 
1450
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1451
 
 
1452
    def __init__(self, stream_format):
 
1453
        self.stream_format = stream_format
 
1454
 
 
1455
 
 
1456
class KnitHeaderError(KnitError):
 
1457
 
 
1458
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1459
 
 
1460
    def __init__(self, badline, filename):
 
1461
        KnitError.__init__(self)
 
1462
        self.badline = badline
 
1463
        self.filename = filename
 
1464
 
 
1465
class KnitIndexUnknownMethod(KnitError):
 
1466
    """Raised when we don't understand the storage method.
 
1467
 
 
1468
    Currently only 'fulltext' and 'line-delta' are supported.
 
1469
    """
 
1470
 
 
1471
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1472
            " in options: %(options)r")
 
1473
 
 
1474
    def __init__(self, filename, options):
 
1475
        KnitError.__init__(self)
 
1476
        self.filename = filename
 
1477
        self.options = options
 
1478
 
 
1479
 
 
1480
class RetryWithNewPacks(BzrError):
 
1481
    """Raised when we realize that the packs on disk have changed.
 
1482
 
 
1483
    This is meant as more of a signaling exception, to trap between where a
 
1484
    local error occurred and the code that can actually handle the error and
 
1485
    code that can retry appropriately.
 
1486
    """
 
1487
 
 
1488
    internal_error = True
 
1489
 
 
1490
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1491
            " %(orig_error)s")
 
1492
 
 
1493
    def __init__(self, context, reload_occurred, exc_info):
 
1494
        """create a new RetryWithNewPacks error.
 
1495
 
 
1496
        :param reload_occurred: Set to True if we know that the packs have
 
1497
            already been reloaded, and we are failing because of an in-memory
 
1498
            cache miss. If set to True then we will ignore if a reload says
 
1499
            nothing has changed, because we assume it has already reloaded. If
 
1500
            False, then a reload with nothing changed will force an error.
 
1501
        :param exc_info: The original exception traceback, so if there is a
 
1502
            problem we can raise the original error (value from sys.exc_info())
 
1503
        """
 
1504
        BzrError.__init__(self)
 
1505
        self.reload_occurred = reload_occurred
 
1506
        self.exc_info = exc_info
 
1507
        self.orig_error = exc_info[1]
 
1508
        # TODO: The global error handler should probably treat this by
 
1509
        #       raising/printing the original exception with a bit about
 
1510
        #       RetryWithNewPacks also not being caught
 
1511
 
 
1512
 
 
1513
class RetryAutopack(RetryWithNewPacks):
 
1514
    """Raised when we are autopacking and we find a missing file.
 
1515
 
 
1516
    Meant as a signaling exception, to tell the autopack code it should try
 
1517
    again.
 
1518
    """
 
1519
 
 
1520
    internal_error = True
 
1521
 
 
1522
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1523
            " context: %(context)s %(orig_error)s")
 
1524
 
 
1525
 
 
1526
class NoSuchExportFormat(BzrError):
 
1527
 
 
1528
    _fmt = "Export format %(format)r not supported"
 
1529
 
 
1530
    def __init__(self, format):
 
1531
        BzrError.__init__(self)
 
1532
        self.format = format
 
1533
 
 
1534
 
 
1535
class TransportError(BzrError):
 
1536
 
 
1537
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1538
 
 
1539
    def __init__(self, msg=None, orig_error=None):
 
1540
        if msg is None and orig_error is not None:
 
1541
            msg = str(orig_error)
 
1542
        if orig_error is None:
 
1543
            orig_error = ''
 
1544
        if msg is None:
 
1545
            msg =  ''
 
1546
        self.msg = msg
 
1547
        self.orig_error = orig_error
 
1548
        BzrError.__init__(self)
 
1549
 
 
1550
 
 
1551
class TooManyConcurrentRequests(InternalBzrError):
 
1552
 
 
1553
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1554
            " Be sure to finish_writing and finish_reading on the"
 
1555
            " currently open request.")
 
1556
 
 
1557
    def __init__(self, medium):
 
1558
        self.medium = medium
 
1559
 
 
1560
 
 
1561
class SmartProtocolError(TransportError):
 
1562
 
 
1563
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1564
 
 
1565
    def __init__(self, details):
 
1566
        self.details = details
 
1567
 
 
1568
 
 
1569
class UnexpectedProtocolVersionMarker(TransportError):
 
1570
 
 
1571
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1572
 
 
1573
    def __init__(self, marker):
 
1574
        self.marker = marker
 
1575
 
 
1576
 
 
1577
class UnknownSmartMethod(InternalBzrError):
 
1578
 
 
1579
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1580
 
 
1581
    def __init__(self, verb):
 
1582
        self.verb = verb
 
1583
 
 
1584
 
 
1585
class SmartMessageHandlerError(InternalBzrError):
 
1586
 
 
1587
    _fmt = ("The message handler raised an exception:\n"
 
1588
            "%(traceback_text)s")
 
1589
 
 
1590
    def __init__(self, exc_info):
 
1591
        import traceback
 
1592
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1593
        self.exc_info = exc_info
 
1594
        traceback_strings = traceback.format_exception(
 
1595
                self.exc_type, self.exc_value, self.exc_tb)
 
1596
        self.traceback_text = ''.join(traceback_strings)
 
1597
 
 
1598
 
 
1599
# A set of semi-meaningful errors which can be thrown
 
1600
class TransportNotPossible(TransportError):
 
1601
 
 
1602
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1603
 
 
1604
 
 
1605
class ConnectionError(TransportError):
 
1606
 
 
1607
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1608
 
 
1609
 
 
1610
class SocketConnectionError(ConnectionError):
 
1611
 
 
1612
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1613
 
 
1614
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1615
        if msg is None:
 
1616
            msg = 'Failed to connect to'
 
1617
        if orig_error is None:
 
1618
            orig_error = ''
 
1619
        else:
 
1620
            orig_error = '; ' + str(orig_error)
 
1621
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1622
        self.host = host
 
1623
        if port is None:
 
1624
            self.port = ''
 
1625
        else:
 
1626
            self.port = ':%s' % port
 
1627
 
 
1628
 
 
1629
# XXX: This is also used for unexpected end of file, which is different at the
 
1630
# TCP level from "connection reset".
 
1631
class ConnectionReset(TransportError):
 
1632
 
 
1633
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1634
 
 
1635
 
 
1636
class InvalidRange(TransportError):
 
1637
 
 
1638
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1639
 
 
1640
    def __init__(self, path, offset, msg=None):
 
1641
        TransportError.__init__(self, msg)
 
1642
        self.path = path
 
1643
        self.offset = offset
 
1644
 
 
1645
 
 
1646
class InvalidHttpResponse(TransportError):
 
1647
 
 
1648
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1649
 
 
1650
    def __init__(self, path, msg, orig_error=None):
 
1651
        self.path = path
 
1652
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1653
 
 
1654
 
 
1655
class InvalidHttpRange(InvalidHttpResponse):
 
1656
 
 
1657
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1658
 
 
1659
    def __init__(self, path, range, msg):
 
1660
        self.range = range
 
1661
        InvalidHttpResponse.__init__(self, path, msg)
 
1662
 
 
1663
 
 
1664
class InvalidHttpContentType(InvalidHttpResponse):
 
1665
 
 
1666
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1667
 
 
1668
    def __init__(self, path, ctype, msg):
 
1669
        self.ctype = ctype
 
1670
        InvalidHttpResponse.__init__(self, path, msg)
 
1671
 
 
1672
 
 
1673
class RedirectRequested(TransportError):
 
1674
 
 
1675
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1676
 
 
1677
    def __init__(self, source, target, is_permanent=False):
 
1678
        self.source = source
 
1679
        self.target = target
 
1680
        if is_permanent:
 
1681
            self.permanently = ' permanently'
 
1682
        else:
 
1683
            self.permanently = ''
 
1684
        TransportError.__init__(self)
 
1685
 
 
1686
 
 
1687
class TooManyRedirections(TransportError):
 
1688
 
 
1689
    _fmt = "Too many redirections"
 
1690
 
 
1691
 
 
1692
class ConflictsInTree(BzrError):
 
1693
 
 
1694
    _fmt = "Working tree has conflicts."
 
1695
 
 
1696
 
 
1697
class ParseConfigError(BzrError):
 
1698
 
 
1699
    def __init__(self, errors, filename):
 
1700
        if filename is None:
 
1701
            filename = ""
 
1702
        message = "Error(s) parsing config file %s:\n%s" % \
 
1703
            (filename, ('\n'.join(e.msg for e in errors)))
 
1704
        BzrError.__init__(self, message)
 
1705
 
 
1706
 
 
1707
class NoEmailInUsername(BzrError):
 
1708
 
 
1709
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1710
 
 
1711
    def __init__(self, username):
 
1712
        BzrError.__init__(self)
 
1713
        self.username = username
 
1714
 
 
1715
 
 
1716
class SigningFailed(BzrError):
 
1717
 
 
1718
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1719
 
 
1720
    def __init__(self, command_line):
 
1721
        BzrError.__init__(self, command_line=command_line)
 
1722
 
 
1723
 
 
1724
class WorkingTreeNotRevision(BzrError):
 
1725
 
 
1726
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1727
            " the last commit, but weave merge requires that it be"
 
1728
            " unchanged")
 
1729
 
 
1730
    def __init__(self, tree):
 
1731
        BzrError.__init__(self, basedir=tree.basedir)
 
1732
 
 
1733
 
 
1734
class CantReprocessAndShowBase(BzrError):
 
1735
 
 
1736
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1737
           "the relationship of conflicting lines to the base")
 
1738
 
 
1739
 
 
1740
class GraphCycleError(BzrError):
 
1741
 
 
1742
    _fmt = "Cycle in graph %(graph)r"
 
1743
 
 
1744
    def __init__(self, graph):
 
1745
        BzrError.__init__(self)
 
1746
        self.graph = graph
 
1747
 
 
1748
 
 
1749
class WritingCompleted(InternalBzrError):
 
1750
 
 
1751
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1752
            "called upon it - accept bytes may not be called anymore.")
 
1753
 
 
1754
    def __init__(self, request):
 
1755
        self.request = request
 
1756
 
 
1757
 
 
1758
class WritingNotComplete(InternalBzrError):
 
1759
 
 
1760
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1761
            "called upon it - until the write phase is complete no "
 
1762
            "data may be read.")
 
1763
 
 
1764
    def __init__(self, request):
 
1765
        self.request = request
 
1766
 
 
1767
 
 
1768
class NotConflicted(BzrError):
 
1769
 
 
1770
    _fmt = "File %(filename)s is not conflicted."
 
1771
 
 
1772
    def __init__(self, filename):
 
1773
        BzrError.__init__(self)
 
1774
        self.filename = filename
 
1775
 
 
1776
 
 
1777
class MediumNotConnected(InternalBzrError):
 
1778
 
 
1779
    _fmt = """The medium '%(medium)s' is not connected."""
 
1780
 
 
1781
    def __init__(self, medium):
 
1782
        self.medium = medium
 
1783
 
 
1784
 
 
1785
class MustUseDecorated(Exception):
 
1786
 
 
1787
    _fmt = "A decorating function has requested its original command be used."
 
1788
 
 
1789
 
 
1790
class NoBundleFound(BzrError):
 
1791
 
 
1792
    _fmt = 'No bundle was found in "%(filename)s".'
 
1793
 
 
1794
    def __init__(self, filename):
 
1795
        BzrError.__init__(self)
 
1796
        self.filename = filename
 
1797
 
 
1798
 
 
1799
class BundleNotSupported(BzrError):
 
1800
 
 
1801
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1802
 
 
1803
    def __init__(self, version, msg):
 
1804
        BzrError.__init__(self)
 
1805
        self.version = version
 
1806
        self.msg = msg
 
1807
 
 
1808
 
 
1809
class MissingText(BzrError):
 
1810
 
 
1811
    _fmt = ("Branch %(base)s is missing revision"
 
1812
            " %(text_revision)s of %(file_id)s")
 
1813
 
 
1814
    def __init__(self, branch, text_revision, file_id):
 
1815
        BzrError.__init__(self)
 
1816
        self.branch = branch
 
1817
        self.base = branch.base
 
1818
        self.text_revision = text_revision
 
1819
        self.file_id = file_id
 
1820
 
 
1821
 
 
1822
class DuplicateFileId(BzrError):
 
1823
 
 
1824
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1825
 
 
1826
    def __init__(self, file_id, entry):
 
1827
        BzrError.__init__(self)
 
1828
        self.file_id = file_id
 
1829
        self.entry = entry
 
1830
 
 
1831
 
 
1832
class DuplicateKey(BzrError):
 
1833
 
 
1834
    _fmt = "Key %(key)s is already present in map"
 
1835
 
 
1836
 
 
1837
class DuplicateHelpPrefix(BzrError):
 
1838
 
 
1839
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1840
 
 
1841
    def __init__(self, prefix):
 
1842
        self.prefix = prefix
 
1843
 
 
1844
 
 
1845
class MalformedTransform(BzrError):
 
1846
 
 
1847
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1848
 
 
1849
 
 
1850
class NoFinalPath(BzrError):
 
1851
 
 
1852
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1853
            "file-id: %(file_id)r\n"
 
1854
            "root trans-id: %(root_trans_id)r\n")
 
1855
 
 
1856
    def __init__(self, trans_id, transform):
 
1857
        self.trans_id = trans_id
 
1858
        self.file_id = transform.final_file_id(trans_id)
 
1859
        self.root_trans_id = transform.root
 
1860
 
 
1861
 
 
1862
class BzrBadParameter(InternalBzrError):
 
1863
 
 
1864
    _fmt = "Bad parameter: %(param)r"
 
1865
 
 
1866
    # This exception should never be thrown, but it is a base class for all
 
1867
    # parameter-to-function errors.
 
1868
 
 
1869
    def __init__(self, param):
 
1870
        BzrError.__init__(self)
 
1871
        self.param = param
 
1872
 
 
1873
 
 
1874
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1875
 
 
1876
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1877
 
 
1878
 
 
1879
class ReusingTransform(BzrError):
 
1880
 
 
1881
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1882
 
 
1883
 
 
1884
class CantMoveRoot(BzrError):
 
1885
 
 
1886
    _fmt = "Moving the root directory is not supported at this time"
 
1887
 
 
1888
 
 
1889
class BzrMoveFailedError(BzrError):
 
1890
 
 
1891
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1892
 
 
1893
    def __init__(self, from_path='', to_path='', extra=None):
 
1894
        from bzrlib.osutils import splitpath
 
1895
        BzrError.__init__(self)
 
1896
        if extra:
 
1897
            self.extra = ': ' + str(extra)
 
1898
        else:
 
1899
            self.extra = ''
 
1900
 
 
1901
        has_from = len(from_path) > 0
 
1902
        has_to = len(to_path) > 0
 
1903
        if has_from:
 
1904
            self.from_path = splitpath(from_path)[-1]
 
1905
        else:
 
1906
            self.from_path = ''
 
1907
 
 
1908
        if has_to:
 
1909
            self.to_path = splitpath(to_path)[-1]
 
1910
        else:
 
1911
            self.to_path = ''
 
1912
 
 
1913
        self.operator = ""
 
1914
        if has_from and has_to:
 
1915
            self.operator = " =>"
 
1916
        elif has_from:
 
1917
            self.from_path = "from " + from_path
 
1918
        elif has_to:
 
1919
            self.operator = "to"
 
1920
        else:
 
1921
            self.operator = "file"
 
1922
 
 
1923
 
 
1924
class BzrRenameFailedError(BzrMoveFailedError):
 
1925
 
 
1926
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1927
 
 
1928
    def __init__(self, from_path, to_path, extra=None):
 
1929
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1930
 
 
1931
class BzrRemoveChangedFilesError(BzrError):
 
1932
    """Used when user is trying to remove changed files."""
 
1933
 
 
1934
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1935
        "%(changes_as_text)s"
 
1936
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1937
 
 
1938
    def __init__(self, tree_delta):
 
1939
        BzrError.__init__(self)
 
1940
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1941
        #self.paths_as_string = '\n'.join(changed_files)
 
1942
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1943
 
 
1944
 
 
1945
class BzrBadParameterNotString(BzrBadParameter):
 
1946
 
 
1947
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1948
 
 
1949
 
 
1950
class BzrBadParameterMissing(BzrBadParameter):
 
1951
 
 
1952
    _fmt = "Parameter $(param)s is required but not present."
 
1953
 
 
1954
 
 
1955
class BzrBadParameterUnicode(BzrBadParameter):
 
1956
 
 
1957
    _fmt = ("Parameter %(param)s is unicode but"
 
1958
            " only byte-strings are permitted.")
 
1959
 
 
1960
 
 
1961
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1962
 
 
1963
    _fmt = "Parameter %(param)s contains a newline."
 
1964
 
 
1965
 
 
1966
class DependencyNotPresent(BzrError):
 
1967
 
 
1968
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1969
 
 
1970
    def __init__(self, library, error):
 
1971
        BzrError.__init__(self, library=library, error=error)
 
1972
 
 
1973
 
 
1974
class ParamikoNotPresent(DependencyNotPresent):
 
1975
 
 
1976
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1977
 
 
1978
    def __init__(self, error):
 
1979
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1980
 
 
1981
 
 
1982
class PointlessMerge(BzrError):
 
1983
 
 
1984
    _fmt = "Nothing to merge."
 
1985
 
 
1986
 
 
1987
class UninitializableFormat(BzrError):
 
1988
 
 
1989
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1990
 
 
1991
    def __init__(self, format):
 
1992
        BzrError.__init__(self)
 
1993
        self.format = format
 
1994
 
 
1995
 
 
1996
class BadConversionTarget(BzrError):
 
1997
 
 
1998
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1999
 
 
2000
    def __init__(self, problem, format):
 
2001
        BzrError.__init__(self)
 
2002
        self.problem = problem
 
2003
        self.format = format
 
2004
 
 
2005
 
 
2006
class NoDiffFound(BzrError):
 
2007
 
 
2008
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2009
 
 
2010
    def __init__(self, path):
 
2011
        BzrError.__init__(self, path)
 
2012
 
 
2013
 
 
2014
class ExecutableMissing(BzrError):
 
2015
 
 
2016
    _fmt = "%(exe_name)s could not be found on this machine"
 
2017
 
 
2018
    def __init__(self, exe_name):
 
2019
        BzrError.__init__(self, exe_name=exe_name)
 
2020
 
 
2021
 
 
2022
class NoDiff(BzrError):
 
2023
 
 
2024
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
2025
 
 
2026
    def __init__(self, msg):
 
2027
        BzrError.__init__(self, msg=msg)
 
2028
 
 
2029
 
 
2030
class NoDiff3(BzrError):
 
2031
 
 
2032
    _fmt = "Diff3 is not installed on this machine."
 
2033
 
 
2034
 
 
2035
class ExistingContent(BzrError):
 
2036
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2037
 
 
2038
    _fmt = "The content being inserted is already present."
 
2039
 
 
2040
 
 
2041
class ExistingLimbo(BzrError):
 
2042
 
 
2043
    _fmt = """This tree contains left-over files from a failed operation.
 
2044
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2045
    keep, and delete it when you are done."""
 
2046
 
 
2047
    def __init__(self, limbo_dir):
 
2048
       BzrError.__init__(self)
 
2049
       self.limbo_dir = limbo_dir
 
2050
 
 
2051
 
 
2052
class ExistingPendingDeletion(BzrError):
 
2053
 
 
2054
    _fmt = """This tree contains left-over files from a failed operation.
 
2055
    Please examine %(pending_deletion)s to see if it contains any files you
 
2056
    wish to keep, and delete it when you are done."""
 
2057
 
 
2058
    def __init__(self, pending_deletion):
 
2059
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2060
 
 
2061
 
 
2062
class ImmortalLimbo(BzrError):
 
2063
 
 
2064
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2065
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2066
    keep, and delete it when you are done."""
 
2067
 
 
2068
    def __init__(self, limbo_dir):
 
2069
       BzrError.__init__(self)
 
2070
       self.limbo_dir = limbo_dir
 
2071
 
 
2072
 
 
2073
class ImmortalPendingDeletion(BzrError):
 
2074
 
 
2075
    _fmt = ("Unable to delete transform temporary directory "
 
2076
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2077
    "contains any files you wish to keep, and delete it when you are done.")
 
2078
 
 
2079
    def __init__(self, pending_deletion):
 
2080
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2081
 
 
2082
 
 
2083
class OutOfDateTree(BzrError):
 
2084
 
 
2085
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2086
 
 
2087
    def __init__(self, tree):
 
2088
        BzrError.__init__(self)
 
2089
        self.tree = tree
 
2090
 
 
2091
 
 
2092
class PublicBranchOutOfDate(BzrError):
 
2093
 
 
2094
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2095
        '"%(revstring)s".'
 
2096
 
 
2097
    def __init__(self, public_location, revstring):
 
2098
        import bzrlib.urlutils as urlutils
 
2099
        public_location = urlutils.unescape_for_display(public_location,
 
2100
                                                        'ascii')
 
2101
        BzrError.__init__(self, public_location=public_location,
 
2102
                          revstring=revstring)
 
2103
 
 
2104
 
 
2105
class MergeModifiedFormatError(BzrError):
 
2106
 
 
2107
    _fmt = "Error in merge modified format"
 
2108
 
 
2109
 
 
2110
class ConflictFormatError(BzrError):
 
2111
 
 
2112
    _fmt = "Format error in conflict listings"
 
2113
 
 
2114
 
 
2115
class CorruptDirstate(BzrError):
 
2116
 
 
2117
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2118
            "Error: %(description)s")
 
2119
 
 
2120
    def __init__(self, dirstate_path, description):
 
2121
        BzrError.__init__(self)
 
2122
        self.dirstate_path = dirstate_path
 
2123
        self.description = description
 
2124
 
 
2125
 
 
2126
class CorruptRepository(BzrError):
 
2127
 
 
2128
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2129
            "Please run bzr reconcile on this repository.")
 
2130
 
 
2131
    def __init__(self, repo):
 
2132
        BzrError.__init__(self)
 
2133
        self.repo_path = repo.bzrdir.root_transport.base
 
2134
 
 
2135
 
 
2136
class InconsistentDelta(BzrError):
 
2137
    """Used when we get a delta that is not valid."""
 
2138
 
 
2139
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2140
            " %(file_id)r\nreason: %(reason)s")
 
2141
 
 
2142
    def __init__(self, path, file_id, reason):
 
2143
        BzrError.__init__(self)
 
2144
        self.path = path
 
2145
        self.file_id = file_id
 
2146
        self.reason = reason
 
2147
 
 
2148
 
 
2149
class UpgradeRequired(BzrError):
 
2150
 
 
2151
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
2152
 
 
2153
    def __init__(self, path):
 
2154
        BzrError.__init__(self)
 
2155
        self.path = path
 
2156
 
 
2157
 
 
2158
class RepositoryUpgradeRequired(UpgradeRequired):
 
2159
 
 
2160
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2161
 
 
2162
 
 
2163
class LocalRequiresBoundBranch(BzrError):
 
2164
 
 
2165
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2166
 
 
2167
 
 
2168
class InvalidProgressBarType(BzrError):
 
2169
 
 
2170
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2171
            " is not a supported type Select one of: %(valid_types)s")
 
2172
 
 
2173
    def __init__(self, bar_type, valid_types):
 
2174
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2175
 
 
2176
 
 
2177
class UnsupportedOperation(BzrError):
 
2178
 
 
2179
    _fmt = ("The method %(mname)s is not supported on"
 
2180
            " objects of type %(tname)s.")
 
2181
 
 
2182
    def __init__(self, method, method_self):
 
2183
        self.method = method
 
2184
        self.mname = method.__name__
 
2185
        self.tname = type(method_self).__name__
 
2186
 
 
2187
 
 
2188
class CannotSetRevisionId(UnsupportedOperation):
 
2189
    """Raised when a commit is attempting to set a revision id but cant."""
 
2190
 
 
2191
 
 
2192
class NonAsciiRevisionId(UnsupportedOperation):
 
2193
    """Raised when a commit is attempting to set a non-ascii revision id
 
2194
       but cant.
 
2195
    """
 
2196
 
 
2197
 
 
2198
class BinaryFile(BzrError):
 
2199
 
 
2200
    _fmt = "File is binary but should be text."
 
2201
 
 
2202
 
 
2203
class IllegalPath(BzrError):
 
2204
 
 
2205
    _fmt = "The path %(path)s is not permitted on this platform"
 
2206
 
 
2207
    def __init__(self, path):
 
2208
        BzrError.__init__(self)
 
2209
        self.path = path
 
2210
 
 
2211
 
 
2212
class TestamentMismatch(BzrError):
 
2213
 
 
2214
    _fmt = """Testament did not match expected value.
 
2215
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2216
       {%(measured)s}"""
 
2217
 
 
2218
    def __init__(self, revision_id, expected, measured):
 
2219
        self.revision_id = revision_id
 
2220
        self.expected = expected
 
2221
        self.measured = measured
 
2222
 
 
2223
 
 
2224
class NotABundle(BzrError):
 
2225
 
 
2226
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2227
 
 
2228
    def __init__(self, text):
 
2229
        BzrError.__init__(self)
 
2230
        self.text = text
 
2231
 
 
2232
 
 
2233
class BadBundle(BzrError):
 
2234
 
 
2235
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2236
 
 
2237
    def __init__(self, text):
 
2238
        BzrError.__init__(self)
 
2239
        self.text = text
 
2240
 
 
2241
 
 
2242
class MalformedHeader(BadBundle):
 
2243
 
 
2244
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2245
 
 
2246
 
 
2247
class MalformedPatches(BadBundle):
 
2248
 
 
2249
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2250
 
 
2251
 
 
2252
class MalformedFooter(BadBundle):
 
2253
 
 
2254
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2255
 
 
2256
 
 
2257
class UnsupportedEOLMarker(BadBundle):
 
2258
 
 
2259
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2260
 
 
2261
    def __init__(self):
 
2262
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2263
        # but for this there is not
 
2264
        BzrError.__init__(self)
 
2265
 
 
2266
 
 
2267
class IncompatibleBundleFormat(BzrError):
 
2268
 
 
2269
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2270
 
 
2271
    def __init__(self, bundle_format, other):
 
2272
        BzrError.__init__(self)
 
2273
        self.bundle_format = bundle_format
 
2274
        self.other = other
 
2275
 
 
2276
 
 
2277
class BadInventoryFormat(BzrError):
 
2278
 
 
2279
    _fmt = "Root class for inventory serialization errors"
 
2280
 
 
2281
 
 
2282
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2283
 
 
2284
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2285
 
 
2286
    def __init__(self, msg):
 
2287
        BadInventoryFormat.__init__(self, msg=msg)
 
2288
 
 
2289
 
 
2290
class RootNotRich(BzrError):
 
2291
 
 
2292
    _fmt = """This operation requires rich root data storage"""
 
2293
 
 
2294
 
 
2295
class NoSmartMedium(InternalBzrError):
 
2296
 
 
2297
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2298
 
 
2299
    def __init__(self, transport):
 
2300
        self.transport = transport
 
2301
 
 
2302
 
 
2303
class UnknownSSH(BzrError):
 
2304
 
 
2305
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2306
 
 
2307
    def __init__(self, vendor):
 
2308
        BzrError.__init__(self)
 
2309
        self.vendor = vendor
 
2310
 
 
2311
 
 
2312
class SSHVendorNotFound(BzrError):
 
2313
 
 
2314
    _fmt = ("Don't know how to handle SSH connections."
 
2315
            " Please set BZR_SSH environment variable.")
 
2316
 
 
2317
 
 
2318
class GhostRevisionsHaveNoRevno(BzrError):
 
2319
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2320
 
 
2321
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2322
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2323
 
 
2324
    def __init__(self, revision_id, ghost_revision_id):
 
2325
        self.revision_id = revision_id
 
2326
        self.ghost_revision_id = ghost_revision_id
 
2327
 
 
2328
 
 
2329
class GhostRevisionUnusableHere(BzrError):
 
2330
 
 
2331
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2332
 
 
2333
    def __init__(self, revision_id):
 
2334
        BzrError.__init__(self)
 
2335
        self.revision_id = revision_id
 
2336
 
 
2337
 
 
2338
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2339
 
 
2340
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2341
            " %(msg)s%(extra)s")
 
2342
 
 
2343
    def __init__(self, name, msg, extra=None):
 
2344
        BzrError.__init__(self)
 
2345
        self.name = name
 
2346
        self.msg = msg
 
2347
        if extra:
 
2348
            self.extra = ': ' + str(extra)
 
2349
        else:
 
2350
            self.extra = ''
 
2351
 
 
2352
 
 
2353
class InvalidImportLine(InternalBzrError):
 
2354
 
 
2355
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2356
 
 
2357
    def __init__(self, text, msg):
 
2358
        BzrError.__init__(self)
 
2359
        self.text = text
 
2360
        self.msg = msg
 
2361
 
 
2362
 
 
2363
class ImportNameCollision(InternalBzrError):
 
2364
 
 
2365
    _fmt = ("Tried to import an object to the same name as"
 
2366
            " an existing object. %(name)s")
 
2367
 
 
2368
    def __init__(self, name):
 
2369
        BzrError.__init__(self)
 
2370
        self.name = name
 
2371
 
 
2372
 
 
2373
class NotAMergeDirective(BzrError):
 
2374
    """File starting with %(firstline)r is not a merge directive"""
 
2375
    def __init__(self, firstline):
 
2376
        BzrError.__init__(self, firstline=firstline)
 
2377
 
 
2378
 
 
2379
class NoMergeSource(BzrError):
 
2380
    """Raise if no merge source was specified for a merge directive"""
 
2381
 
 
2382
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2383
        " branch location."
 
2384
 
 
2385
 
 
2386
class IllegalMergeDirectivePayload(BzrError):
 
2387
    """A merge directive contained something other than a patch or bundle"""
 
2388
 
 
2389
    _fmt = "Bad merge directive payload %(start)r"
 
2390
 
 
2391
    def __init__(self, start):
 
2392
        BzrError(self)
 
2393
        self.start = start
 
2394
 
 
2395
 
 
2396
class PatchVerificationFailed(BzrError):
 
2397
    """A patch from a merge directive could not be verified"""
 
2398
 
 
2399
    _fmt = "Preview patch does not match requested changes."
 
2400
 
 
2401
 
 
2402
class PatchMissing(BzrError):
 
2403
    """Raise a patch type was specified but no patch supplied"""
 
2404
 
 
2405
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2406
 
 
2407
    def __init__(self, patch_type):
 
2408
        BzrError.__init__(self)
 
2409
        self.patch_type = patch_type
 
2410
 
 
2411
 
 
2412
class TargetNotBranch(BzrError):
 
2413
    """A merge directive's target branch is required, but isn't a branch"""
 
2414
 
 
2415
    _fmt = ("Your branch does not have all of the revisions required in "
 
2416
            "order to merge this merge directive and the target "
 
2417
            "location specified in the merge directive is not a branch: "
 
2418
            "%(location)s.")
 
2419
 
 
2420
    def __init__(self, location):
 
2421
        BzrError.__init__(self)
 
2422
        self.location = location
 
2423
 
 
2424
 
 
2425
class UnsupportedInventoryKind(BzrError):
 
2426
 
 
2427
    _fmt = """Unsupported entry kind %(kind)s"""
 
2428
 
 
2429
    def __init__(self, kind):
 
2430
        self.kind = kind
 
2431
 
 
2432
 
 
2433
class BadSubsumeSource(BzrError):
 
2434
 
 
2435
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2436
 
 
2437
    def __init__(self, tree, other_tree, reason):
 
2438
        self.tree = tree
 
2439
        self.other_tree = other_tree
 
2440
        self.reason = reason
 
2441
 
 
2442
 
 
2443
class SubsumeTargetNeedsUpgrade(BzrError):
 
2444
 
 
2445
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2446
 
 
2447
    def __init__(self, other_tree):
 
2448
        self.other_tree = other_tree
 
2449
 
 
2450
 
 
2451
class BadReferenceTarget(InternalBzrError):
 
2452
 
 
2453
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2454
           "%(reason)s"
 
2455
 
 
2456
    def __init__(self, tree, other_tree, reason):
 
2457
        self.tree = tree
 
2458
        self.other_tree = other_tree
 
2459
        self.reason = reason
 
2460
 
 
2461
 
 
2462
class NoSuchTag(BzrError):
 
2463
 
 
2464
    _fmt = "No such tag: %(tag_name)s"
 
2465
 
 
2466
    def __init__(self, tag_name):
 
2467
        self.tag_name = tag_name
 
2468
 
 
2469
 
 
2470
class TagsNotSupported(BzrError):
 
2471
 
 
2472
    _fmt = ("Tags not supported by %(branch)s;"
 
2473
            " you may be able to use bzr upgrade.")
 
2474
 
 
2475
    def __init__(self, branch):
 
2476
        self.branch = branch
 
2477
 
 
2478
 
 
2479
class TagAlreadyExists(BzrError):
 
2480
 
 
2481
    _fmt = "Tag %(tag_name)s already exists."
 
2482
 
 
2483
    def __init__(self, tag_name):
 
2484
        self.tag_name = tag_name
 
2485
 
 
2486
 
 
2487
class MalformedBugIdentifier(BzrError):
 
2488
 
 
2489
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2490
            'See "bzr help bugs" for more information on this feature.')
 
2491
 
 
2492
    def __init__(self, bug_id, reason):
 
2493
        self.bug_id = bug_id
 
2494
        self.reason = reason
 
2495
 
 
2496
 
 
2497
class InvalidBugTrackerURL(BzrError):
 
2498
 
 
2499
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2500
            "contain {id}: %(url)s")
 
2501
 
 
2502
    def __init__(self, abbreviation, url):
 
2503
        self.abbreviation = abbreviation
 
2504
        self.url = url
 
2505
 
 
2506
 
 
2507
class UnknownBugTrackerAbbreviation(BzrError):
 
2508
 
 
2509
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2510
            "on %(branch)s")
 
2511
 
 
2512
    def __init__(self, abbreviation, branch):
 
2513
        self.abbreviation = abbreviation
 
2514
        self.branch = branch
 
2515
 
 
2516
 
 
2517
class InvalidLineInBugsProperty(BzrError):
 
2518
 
 
2519
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2520
 
 
2521
    def __init__(self, line):
 
2522
        self.line = line
 
2523
 
 
2524
 
 
2525
class InvalidBugStatus(BzrError):
 
2526
 
 
2527
    _fmt = ("Invalid bug status: '%(status)s'")
 
2528
 
 
2529
    def __init__(self, status):
 
2530
        self.status = status
 
2531
 
 
2532
 
 
2533
class UnexpectedSmartServerResponse(BzrError):
 
2534
 
 
2535
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2536
 
 
2537
    def __init__(self, response_tuple):
 
2538
        self.response_tuple = response_tuple
 
2539
 
 
2540
 
 
2541
class ErrorFromSmartServer(BzrError):
 
2542
    """An error was received from a smart server.
 
2543
 
 
2544
    :seealso: UnknownErrorFromSmartServer
 
2545
    """
 
2546
 
 
2547
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2548
 
 
2549
    internal_error = True
 
2550
 
 
2551
    def __init__(self, error_tuple):
 
2552
        self.error_tuple = error_tuple
 
2553
        try:
 
2554
            self.error_verb = error_tuple[0]
 
2555
        except IndexError:
 
2556
            self.error_verb = None
 
2557
        self.error_args = error_tuple[1:]
 
2558
 
 
2559
 
 
2560
class UnknownErrorFromSmartServer(BzrError):
 
2561
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2562
    error.
 
2563
 
 
2564
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2565
    distinguish between the following two cases:
 
2566
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2567
        and so should provoke a traceback to the user.
 
2568
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2569
        translated.  This is probably because the server sent us garbage, and
 
2570
        should not provoke a traceback.
 
2571
    """
 
2572
 
 
2573
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2574
 
 
2575
    internal_error = False
 
2576
 
 
2577
    def __init__(self, error_from_smart_server):
 
2578
        """Constructor.
 
2579
 
 
2580
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2581
        """
 
2582
        self.error_from_smart_server = error_from_smart_server
 
2583
        self.error_tuple = error_from_smart_server.error_tuple
 
2584
 
 
2585
 
 
2586
class ContainerError(BzrError):
 
2587
    """Base class of container errors."""
 
2588
 
 
2589
 
 
2590
class UnknownContainerFormatError(ContainerError):
 
2591
 
 
2592
    _fmt = "Unrecognised container format: %(container_format)r"
 
2593
 
 
2594
    def __init__(self, container_format):
 
2595
        self.container_format = container_format
 
2596
 
 
2597
 
 
2598
class UnexpectedEndOfContainerError(ContainerError):
 
2599
 
 
2600
    _fmt = "Unexpected end of container stream"
 
2601
 
 
2602
 
 
2603
class UnknownRecordTypeError(ContainerError):
 
2604
 
 
2605
    _fmt = "Unknown record type: %(record_type)r"
 
2606
 
 
2607
    def __init__(self, record_type):
 
2608
        self.record_type = record_type
 
2609
 
 
2610
 
 
2611
class InvalidRecordError(ContainerError):
 
2612
 
 
2613
    _fmt = "Invalid record: %(reason)s"
 
2614
 
 
2615
    def __init__(self, reason):
 
2616
        self.reason = reason
 
2617
 
 
2618
 
 
2619
class ContainerHasExcessDataError(ContainerError):
 
2620
 
 
2621
    _fmt = "Container has data after end marker: %(excess)r"
 
2622
 
 
2623
    def __init__(self, excess):
 
2624
        self.excess = excess
 
2625
 
 
2626
 
 
2627
class DuplicateRecordNameError(ContainerError):
 
2628
 
 
2629
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2630
 
 
2631
    def __init__(self, name):
 
2632
        self.name = name
 
2633
 
 
2634
 
 
2635
class NoDestinationAddress(InternalBzrError):
 
2636
 
 
2637
    _fmt = "Message does not have a destination address."
 
2638
 
 
2639
 
 
2640
class RepositoryDataStreamError(BzrError):
 
2641
 
 
2642
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2643
 
 
2644
    def __init__(self, reason):
 
2645
        self.reason = reason
 
2646
 
 
2647
 
 
2648
class SMTPError(BzrError):
 
2649
 
 
2650
    _fmt = "SMTP error: %(error)s"
 
2651
 
 
2652
    def __init__(self, error):
 
2653
        self.error = error
 
2654
 
 
2655
 
 
2656
class NoMessageSupplied(BzrError):
 
2657
 
 
2658
    _fmt = "No message supplied."
 
2659
 
 
2660
 
 
2661
class NoMailAddressSpecified(BzrError):
 
2662
 
 
2663
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2664
 
 
2665
 
 
2666
class UnknownMailClient(BzrError):
 
2667
 
 
2668
    _fmt = "Unknown mail client: %(mail_client)s"
 
2669
 
 
2670
    def __init__(self, mail_client):
 
2671
        BzrError.__init__(self, mail_client=mail_client)
 
2672
 
 
2673
 
 
2674
class MailClientNotFound(BzrError):
 
2675
 
 
2676
    _fmt = "Unable to find mail client with the following names:"\
 
2677
        " %(mail_command_list_string)s"
 
2678
 
 
2679
    def __init__(self, mail_command_list):
 
2680
        mail_command_list_string = ', '.join(mail_command_list)
 
2681
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2682
                          mail_command_list_string=mail_command_list_string)
 
2683
 
 
2684
class SMTPConnectionRefused(SMTPError):
 
2685
 
 
2686
    _fmt = "SMTP connection to %(host)s refused"
 
2687
 
 
2688
    def __init__(self, error, host):
 
2689
        self.error = error
 
2690
        self.host = host
 
2691
 
 
2692
 
 
2693
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2694
 
 
2695
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2696
 
 
2697
 
 
2698
class BzrDirError(BzrError):
 
2699
 
 
2700
    def __init__(self, bzrdir):
 
2701
        import bzrlib.urlutils as urlutils
 
2702
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2703
                                                    'ascii')
 
2704
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2705
 
 
2706
 
 
2707
class UnsyncedBranches(BzrDirError):
 
2708
 
 
2709
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2710
            " bzr help sync-for-reconfigure.")
 
2711
 
 
2712
    def __init__(self, bzrdir, target_branch):
 
2713
        BzrDirError.__init__(self, bzrdir)
 
2714
        import bzrlib.urlutils as urlutils
 
2715
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2716
                                                        'ascii')
 
2717
 
 
2718
 
 
2719
class AlreadyBranch(BzrDirError):
 
2720
 
 
2721
    _fmt = "'%(display_url)s' is already a branch."
 
2722
 
 
2723
 
 
2724
class AlreadyTree(BzrDirError):
 
2725
 
 
2726
    _fmt = "'%(display_url)s' is already a tree."
 
2727
 
 
2728
 
 
2729
class AlreadyCheckout(BzrDirError):
 
2730
 
 
2731
    _fmt = "'%(display_url)s' is already a checkout."
 
2732
 
 
2733
 
 
2734
class AlreadyLightweightCheckout(BzrDirError):
 
2735
 
 
2736
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2737
 
 
2738
 
 
2739
class AlreadyUsingShared(BzrDirError):
 
2740
 
 
2741
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2742
 
 
2743
 
 
2744
class AlreadyStandalone(BzrDirError):
 
2745
 
 
2746
    _fmt = "'%(display_url)s' is already standalone."
 
2747
 
 
2748
 
 
2749
class AlreadyWithTrees(BzrDirError):
 
2750
 
 
2751
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2752
            "working trees.")
 
2753
 
 
2754
 
 
2755
class AlreadyWithNoTrees(BzrDirError):
 
2756
 
 
2757
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2758
            "working trees.")
 
2759
 
 
2760
 
 
2761
class ReconfigurationNotSupported(BzrDirError):
 
2762
 
 
2763
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2764
 
 
2765
 
 
2766
class NoBindLocation(BzrDirError):
 
2767
 
 
2768
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2769
 
 
2770
 
 
2771
class UncommittedChanges(BzrError):
 
2772
 
 
2773
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2774
 
 
2775
    def __init__(self, tree):
 
2776
        import bzrlib.urlutils as urlutils
 
2777
        display_url = urlutils.unescape_for_display(
 
2778
            tree.bzrdir.root_transport.base, 'ascii')
 
2779
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2780
 
 
2781
 
 
2782
class MissingTemplateVariable(BzrError):
 
2783
 
 
2784
    _fmt = 'Variable {%(name)s} is not available.'
 
2785
 
 
2786
    def __init__(self, name):
 
2787
        self.name = name
 
2788
 
 
2789
 
 
2790
class NoTemplate(BzrError):
 
2791
 
 
2792
    _fmt = 'No template specified.'
 
2793
 
 
2794
 
 
2795
class UnableCreateSymlink(BzrError):
 
2796
 
 
2797
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2798
 
 
2799
    def __init__(self, path=None):
 
2800
        path_str = ''
 
2801
        if path:
 
2802
            try:
 
2803
                path_str = repr(str(path))
 
2804
            except UnicodeEncodeError:
 
2805
                path_str = repr(path)
 
2806
            path_str += ' '
 
2807
        self.path_str = path_str
 
2808
 
 
2809
 
 
2810
class UnsupportedTimezoneFormat(BzrError):
 
2811
 
 
2812
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2813
            'options are "utc", "original", "local".')
 
2814
 
 
2815
    def __init__(self, timezone):
 
2816
        self.timezone = timezone
 
2817
 
 
2818
 
 
2819
class CommandAvailableInPlugin(StandardError):
 
2820
 
 
2821
    internal_error = False
 
2822
 
 
2823
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2824
 
 
2825
        self.plugin_metadata = plugin_metadata
 
2826
        self.cmd_name = cmd_name
 
2827
        self.provider = provider
 
2828
 
 
2829
    def __str__(self):
 
2830
 
 
2831
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2832
                'However, the following official plugin provides this command: %s\n'
 
2833
                'You can install it by going to: %s'
 
2834
                % (self.cmd_name, self.plugin_metadata['name'],
 
2835
                    self.plugin_metadata['url']))
 
2836
 
 
2837
        return _fmt
 
2838
 
 
2839
 
 
2840
class NoPluginAvailable(BzrError):
 
2841
    pass
 
2842
 
 
2843
 
 
2844
class UnableEncodePath(BzrError):
 
2845
 
 
2846
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2847
            'user encoding %(user_encoding)s')
 
2848
 
 
2849
    def __init__(self, path, kind):
 
2850
        from bzrlib.osutils import get_user_encoding
 
2851
        self.path = path
 
2852
        self.kind = kind
 
2853
        self.user_encoding = osutils.get_user_encoding()
 
2854
 
 
2855
 
 
2856
class NoSuchAlias(BzrError):
 
2857
 
 
2858
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2859
 
 
2860
    def __init__(self, alias_name):
 
2861
        BzrError.__init__(self, alias_name=alias_name)
 
2862
 
 
2863
 
 
2864
class DirectoryLookupFailure(BzrError):
 
2865
    """Base type for lookup errors."""
 
2866
 
 
2867
    pass
 
2868
 
 
2869
 
 
2870
class InvalidLocationAlias(DirectoryLookupFailure):
 
2871
 
 
2872
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2873
 
 
2874
    def __init__(self, alias_name):
 
2875
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2876
 
 
2877
 
 
2878
class UnsetLocationAlias(DirectoryLookupFailure):
 
2879
 
 
2880
    _fmt = 'No %(alias_name)s location assigned.'
 
2881
 
 
2882
    def __init__(self, alias_name):
 
2883
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2884
 
 
2885
 
 
2886
class CannotBindAddress(BzrError):
 
2887
 
 
2888
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2889
 
 
2890
    def __init__(self, host, port, orig_error):
 
2891
        BzrError.__init__(self, host=host, port=port,
 
2892
            orig_error=orig_error[1])
 
2893
 
 
2894
 
 
2895
class UnknownRules(BzrError):
 
2896
 
 
2897
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2898
 
 
2899
    def __init__(self, unknowns):
 
2900
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2901
 
 
2902
 
 
2903
class HookFailed(BzrError):
 
2904
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2905
    than TipChangeRejected.
 
2906
    """
 
2907
 
 
2908
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2909
            "%(traceback_text)s%(exc_value)s")
 
2910
 
 
2911
    def __init__(self, hook_stage, hook_name, exc_info):
 
2912
        import traceback
 
2913
        self.hook_stage = hook_stage
 
2914
        self.hook_name = hook_name
 
2915
        self.exc_info = exc_info
 
2916
        self.exc_type = exc_info[0]
 
2917
        self.exc_value = exc_info[1]
 
2918
        self.exc_tb = exc_info[2]
 
2919
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2920
 
 
2921
 
 
2922
class TipChangeRejected(BzrError):
 
2923
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2924
    explicitly abort a change to a branch tip.
 
2925
    """
 
2926
 
 
2927
    _fmt = u"Tip change rejected: %(msg)s"
 
2928
 
 
2929
    def __init__(self, msg):
 
2930
        self.msg = msg
 
2931
 
 
2932
 
 
2933
class ShelfCorrupt(BzrError):
 
2934
 
 
2935
    _fmt = "Shelf corrupt."
 
2936
 
 
2937
 
 
2938
class NoSuchShelfId(BzrError):
 
2939
 
 
2940
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
2941
 
 
2942
    def __init__(self, shelf_id):
 
2943
        BzrError.__init__(self, shelf_id=shelf_id)
 
2944
 
 
2945
 
 
2946
class InvalidShelfId(BzrError):
 
2947
 
 
2948
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
2949
 
 
2950
    def __init__(self, invalid_id):
 
2951
        BzrError.__init__(self, invalid_id=invalid_id)
 
2952
 
 
2953
 
 
2954
class JailBreak(BzrError):
 
2955
 
 
2956
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2957
 
 
2958
    def __init__(self, url):
 
2959
        BzrError.__init__(self, url=url)
 
2960
 
 
2961
 
 
2962
class UserAbort(BzrError):
 
2963
 
 
2964
    _fmt = 'The user aborted the operation.'
 
2965
 
 
2966
 
 
2967
class MustHaveWorkingTree(BzrError):
 
2968
 
 
2969
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
2970
 
 
2971
    def __init__(self, format, url):
 
2972
        BzrError.__init__(self, format=format, url=url)
 
2973
 
 
2974
 
 
2975
class NoSuchView(BzrError):
 
2976
    """A view does not exist.
 
2977
    """
 
2978
 
 
2979
    _fmt = u"No such view: %(view_name)s."
 
2980
 
 
2981
    def __init__(self, view_name):
 
2982
        self.view_name = view_name
 
2983
 
 
2984
 
 
2985
class ViewsNotSupported(BzrError):
 
2986
    """Views are not supported by a tree format.
 
2987
    """
 
2988
 
 
2989
    _fmt = ("Views are not supported by %(tree)s;"
 
2990
            " use 'bzr upgrade' to change your tree to a later format.")
 
2991
 
 
2992
    def __init__(self, tree):
 
2993
        self.tree = tree
 
2994
 
 
2995
 
 
2996
class FileOutsideView(BzrError):
 
2997
 
 
2998
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
2999
            '%(view_str)s')
 
3000
 
 
3001
    def __init__(self, file_name, view_files):
 
3002
        self.file_name = file_name
 
3003
        self.view_str = ", ".join(view_files)
 
3004
 
 
3005
 
 
3006
class UnresumableWriteGroup(BzrError):
 
3007
 
 
3008
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3009
            "%(write_groups)r: %(reason)s")
 
3010
 
 
3011
    internal_error = True
 
3012
 
 
3013
    def __init__(self, repository, write_groups, reason):
 
3014
        self.repository = repository
 
3015
        self.write_groups = write_groups
 
3016
        self.reason = reason
 
3017
 
 
3018
 
 
3019
class UnsuspendableWriteGroup(BzrError):
 
3020
 
 
3021
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3022
 
 
3023
    internal_error = True
 
3024
 
 
3025
    def __init__(self, repository):
 
3026
        self.repository = repository