~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Add bzrlib.tests.per_repository_vf.

Show diffs side-by-side

added added

removed removed

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