/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Packman
  • Date: 2011-11-29 16:14:12 UTC
  • mto: This revision was merged to the branch mainline in revision 6327.
  • Revision ID: martin.packman@canonical.com-20111129161412-mx4yu5mg6xsaty46
Require the dulwich package when using py2exe with the git plugin enabled

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
from bzrlib import (
 
21
    osutils,
 
22
    symbol_versioning,
 
23
    i18n,
 
24
    trace,
 
25
    )
 
26
from bzrlib.i18n import gettext
 
27
 
 
28
 
 
29
# TODO: is there any value in providing the .args field used by standard
 
30
# python exceptions?   A list of values with no names seems less useful
 
31
# to me.
 
32
 
 
33
# TODO: Perhaps convert the exception to a string at the moment it's
 
34
# constructed to make sure it will succeed.  But that says nothing about
 
35
# exceptions that are never raised.
 
36
 
 
37
# TODO: selftest assertRaises should probably also check that every error
 
38
# raised can be formatted as a string successfully, and without giving
 
39
# 'unprintable'.
 
40
 
 
41
 
 
42
# return codes from the bzr program
 
43
EXIT_OK = 0
 
44
EXIT_ERROR = 3
 
45
EXIT_INTERNAL_ERROR = 4
 
46
 
 
47
 
 
48
class BzrError(StandardError):
 
49
    """
 
50
    Base class for errors raised by bzrlib.
 
51
 
 
52
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
53
        should be displayed with a traceback; if False (or absent) this was
 
54
        probably a user or environment error and they don't need the gory
 
55
        details.  (That can be overridden by -Derror on the command line.)
 
56
 
 
57
    :cvar _fmt: Format string to display the error; this is expanded
 
58
        by the instance's dict.
 
59
    """
 
60
 
 
61
    internal_error = False
 
62
 
 
63
    def __init__(self, msg=None, **kwds):
 
64
        """Construct a new BzrError.
 
65
 
 
66
        There are two alternative forms for constructing these objects.
 
67
        Either a preformatted string may be passed, or a set of named
 
68
        arguments can be given.  The first is for generic "user" errors which
 
69
        are not intended to be caught and so do not need a specific subclass.
 
70
        The second case is for use with subclasses that provide a _fmt format
 
71
        string to print the arguments.
 
72
 
 
73
        Keyword arguments are taken as parameters to the error, which can
 
74
        be inserted into the format string template.  It's recommended
 
75
        that subclasses override the __init__ method to require specific
 
76
        parameters.
 
77
 
 
78
        :param msg: If given, this is the literal complete text for the error,
 
79
           not subject to expansion. 'msg' is used instead of 'message' because
 
80
           python evolved and, in 2.6, forbids the use of 'message'.
 
81
        """
 
82
        StandardError.__init__(self)
 
83
        if msg is not None:
 
84
            # I was going to deprecate this, but it actually turns out to be
 
85
            # quite handy - mbp 20061103.
 
86
            self._preformatted_string = msg
 
87
        else:
 
88
            self._preformatted_string = None
 
89
            for key, value in kwds.items():
 
90
                setattr(self, key, value)
 
91
 
 
92
    def _format(self):
 
93
        s = getattr(self, '_preformatted_string', None)
 
94
        if s is not None:
 
95
            # contains a preformatted message
 
96
            return s
 
97
        try:
 
98
            fmt = self._get_format_string()
 
99
            if fmt:
 
100
                d = dict(self.__dict__)
 
101
                s = fmt % d
 
102
                # __str__() should always return a 'str' object
 
103
                # never a 'unicode' object.
 
104
                return s
 
105
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
106
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
107
                % (self.__class__.__name__,
 
108
                   self.__dict__,
 
109
                   getattr(self, '_fmt', None),
 
110
                   e)
 
111
 
 
112
    def __unicode__(self):
 
113
        u = self._format()
 
114
        if isinstance(u, str):
 
115
            # Try decoding the str using the default encoding.
 
116
            u = unicode(u)
 
117
        elif not isinstance(u, unicode):
 
118
            # Try to make a unicode object from it, because __unicode__ must
 
119
            # return a unicode object.
 
120
            u = unicode(u)
 
121
        return u
 
122
 
 
123
    def __str__(self):
 
124
        s = self._format()
 
125
        if isinstance(s, unicode):
 
126
            s = s.encode('utf8')
 
127
        else:
 
128
            # __str__ must return a str.
 
129
            s = str(s)
 
130
        return s
 
131
 
 
132
    def __repr__(self):
 
133
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
134
 
 
135
    def _get_format_string(self):
 
136
        """Return format string for this exception or None"""
 
137
        fmt = getattr(self, '_fmt', None)
 
138
        if fmt is not None:
 
139
            i18n.install()
 
140
            unicode_fmt = unicode(fmt) #_fmt strings should be ascii
 
141
            if type(fmt) == unicode:
 
142
                trace.mutter("Unicode strings in error.fmt are deprecated")
 
143
            return gettext(unicode_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
        "the commit builder.")
 
308
 
 
309
 
 
310
class NoPublicBranch(BzrError):
 
311
 
 
312
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
313
 
 
314
    def __init__(self, branch):
 
315
        import bzrlib.urlutils as urlutils
 
316
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
317
        BzrError.__init__(self, branch_url=public_location)
 
318
 
 
319
 
 
320
class NoHelpTopic(BzrError):
 
321
 
 
322
    _fmt = ("No help could be found for '%(topic)s'. "
 
323
        "Please use 'bzr help topics' to obtain a list of topics.")
 
324
 
 
325
    def __init__(self, topic):
 
326
        self.topic = topic
 
327
 
 
328
 
 
329
class NoSuchId(BzrError):
 
330
 
 
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
332
 
 
333
    def __init__(self, tree, file_id):
 
334
        BzrError.__init__(self)
 
335
        self.file_id = file_id
 
336
        self.tree = tree
 
337
 
 
338
 
 
339
class NoSuchIdInRepository(NoSuchId):
 
340
 
 
341
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
342
            ' %(repository)r')
 
343
 
 
344
    def __init__(self, repository, file_id):
 
345
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
346
 
 
347
 
 
348
class NotStacked(BranchError):
 
349
 
 
350
    _fmt = "The branch '%(branch)s' is not stacked."
 
351
 
 
352
 
 
353
class InventoryModified(InternalBzrError):
 
354
 
 
355
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
356
            " so a clean inventory cannot be read without data loss.")
 
357
 
 
358
    def __init__(self, tree):
 
359
        self.tree = tree
 
360
 
 
361
 
 
362
class NoWorkingTree(BzrError):
 
363
 
 
364
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
365
 
 
366
    def __init__(self, base):
 
367
        BzrError.__init__(self)
 
368
        self.base = base
 
369
 
 
370
 
 
371
class NotBuilding(BzrError):
 
372
 
 
373
    _fmt = "Not currently building a tree."
 
374
 
 
375
 
 
376
class NotLocalUrl(BzrError):
 
377
 
 
378
    _fmt = "%(url)s is not a local path."
 
379
 
 
380
    def __init__(self, url):
 
381
        self.url = url
 
382
 
 
383
 
 
384
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
385
 
 
386
    _fmt = 'Working tree already populated in "%(base)s"'
 
387
 
 
388
    def __init__(self, base):
 
389
        self.base = base
 
390
 
 
391
 
 
392
class BzrCommandError(BzrError):
 
393
    """Error from user command"""
 
394
 
 
395
    # Error from malformed user command; please avoid raising this as a
 
396
    # generic exception not caused by user input.
 
397
    #
 
398
    # I think it's a waste of effort to differentiate between errors that
 
399
    # are not intended to be caught anyway.  UI code need not subclass
 
400
    # BzrCommandError, and non-UI code should not throw a subclass of
 
401
    # BzrCommandError.  ADHB 20051211
 
402
 
 
403
 
 
404
class NotWriteLocked(BzrError):
 
405
 
 
406
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
407
 
 
408
    def __init__(self, not_locked):
 
409
        self.not_locked = not_locked
 
410
 
 
411
 
 
412
class BzrOptionError(BzrCommandError):
 
413
 
 
414
    _fmt = "Error in command line options"
 
415
 
 
416
 
 
417
class BadIndexFormatSignature(BzrError):
 
418
 
 
419
    _fmt = "%(value)s is not an index of type %(_type)s."
 
420
 
 
421
    def __init__(self, value, _type):
 
422
        BzrError.__init__(self)
 
423
        self.value = value
 
424
        self._type = _type
 
425
 
 
426
 
 
427
class BadIndexData(BzrError):
 
428
 
 
429
    _fmt = "Error in data for index %(value)s."
 
430
 
 
431
    def __init__(self, value):
 
432
        BzrError.__init__(self)
 
433
        self.value = value
 
434
 
 
435
 
 
436
class BadIndexDuplicateKey(BzrError):
 
437
 
 
438
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
439
 
 
440
    def __init__(self, key, index):
 
441
        BzrError.__init__(self)
 
442
        self.key = key
 
443
        self.index = index
 
444
 
 
445
 
 
446
class BadIndexKey(BzrError):
 
447
 
 
448
    _fmt = "The key '%(key)s' is not a valid key."
 
449
 
 
450
    def __init__(self, key):
 
451
        BzrError.__init__(self)
 
452
        self.key = key
 
453
 
 
454
 
 
455
class BadIndexOptions(BzrError):
 
456
 
 
457
    _fmt = "Could not parse options for index %(value)s."
 
458
 
 
459
    def __init__(self, value):
 
460
        BzrError.__init__(self)
 
461
        self.value = value
 
462
 
 
463
 
 
464
class BadIndexValue(BzrError):
 
465
 
 
466
    _fmt = "The value '%(value)s' is not a valid value."
 
467
 
 
468
    def __init__(self, value):
 
469
        BzrError.__init__(self)
 
470
        self.value = value
 
471
 
 
472
 
 
473
class BadOptionValue(BzrError):
 
474
 
 
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
476
 
 
477
    def __init__(self, name, value):
 
478
        BzrError.__init__(self, name=name, value=value)
 
479
 
 
480
 
 
481
class StrictCommitFailed(BzrError):
 
482
 
 
483
    _fmt = "Commit refused because there are unknown files in the tree"
 
484
 
 
485
 
 
486
# XXX: Should be unified with TransportError; they seem to represent the
 
487
# same thing
 
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
489
# - this is finer than a TransportError - and more useful as such. It
 
490
# differentiates between 'transport has failed' and 'operation on a transport
 
491
# has failed.'
 
492
class PathError(BzrError):
 
493
 
 
494
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
495
 
 
496
    def __init__(self, path, extra=None):
 
497
        BzrError.__init__(self)
 
498
        self.path = path
 
499
        if extra:
 
500
            self.extra = ': ' + str(extra)
 
501
        else:
 
502
            self.extra = ''
 
503
 
 
504
 
 
505
class NoSuchFile(PathError):
 
506
 
 
507
    _fmt = "No such file: %(path)r%(extra)s"
 
508
 
 
509
 
 
510
class FileExists(PathError):
 
511
 
 
512
    _fmt = "File exists: %(path)r%(extra)s"
 
513
 
 
514
 
 
515
class RenameFailedFilesExist(BzrError):
 
516
    """Used when renaming and both source and dest exist."""
 
517
 
 
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
519
            " (Use --after to tell bzr about a rename that has already"
 
520
            " happened)%(extra)s")
 
521
 
 
522
    def __init__(self, source, dest, extra=None):
 
523
        BzrError.__init__(self)
 
524
        self.source = str(source)
 
525
        self.dest = str(dest)
 
526
        if extra:
 
527
            self.extra = ' ' + str(extra)
 
528
        else:
 
529
            self.extra = ''
 
530
 
 
531
 
 
532
class NotADirectory(PathError):
 
533
 
 
534
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
535
 
 
536
 
 
537
class NotInWorkingDirectory(PathError):
 
538
 
 
539
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
540
 
 
541
 
 
542
class DirectoryNotEmpty(PathError):
 
543
 
 
544
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
545
 
 
546
 
 
547
class HardLinkNotSupported(PathError):
 
548
 
 
549
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
550
 
 
551
 
 
552
class ReadingCompleted(InternalBzrError):
 
553
 
 
554
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
555
            "called upon it - the request has been completed and no more "
 
556
            "data may be read.")
 
557
 
 
558
    def __init__(self, request):
 
559
        self.request = request
 
560
 
 
561
 
 
562
class ResourceBusy(PathError):
 
563
 
 
564
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
565
 
 
566
 
 
567
class PermissionDenied(PathError):
 
568
 
 
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
570
 
 
571
 
 
572
class InvalidURL(PathError):
 
573
 
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
575
 
 
576
 
 
577
class InvalidURLJoin(PathError):
 
578
 
 
579
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
580
 
 
581
    def __init__(self, reason, base, join_args):
 
582
        self.reason = reason
 
583
        self.base = base
 
584
        self.join_args = join_args
 
585
        PathError.__init__(self, base, reason)
 
586
 
 
587
 
 
588
class InvalidRebaseURLs(PathError):
 
589
 
 
590
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
591
 
 
592
    def __init__(self, from_, to):
 
593
        self.from_ = from_
 
594
        self.to = to
 
595
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
596
 
 
597
 
 
598
class UnavailableRepresentation(InternalBzrError):
 
599
 
 
600
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
601
        "is encoded as '%(native)s'.")
 
602
 
 
603
    def __init__(self, key, wanted, native):
 
604
        InternalBzrError.__init__(self)
 
605
        self.wanted = wanted
 
606
        self.native = native
 
607
        self.key = key
 
608
 
 
609
 
 
610
class UnknownHook(BzrError):
 
611
 
 
612
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
613
 
 
614
    def __init__(self, hook_type, hook_name):
 
615
        BzrError.__init__(self)
 
616
        self.type = hook_type
 
617
        self.hook = hook_name
 
618
 
 
619
 
 
620
class UnsupportedProtocol(PathError):
 
621
 
 
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
623
 
 
624
    def __init__(self, url, extra=""):
 
625
        PathError.__init__(self, url, extra=extra)
 
626
 
 
627
 
 
628
class UnstackableBranchFormat(BzrError):
 
629
 
 
630
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
631
        "You will need to upgrade the branch to permit branch stacking.")
 
632
 
 
633
    def __init__(self, format, url):
 
634
        BzrError.__init__(self)
 
635
        self.format = format
 
636
        self.url = url
 
637
 
 
638
 
 
639
class 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 = ''
 
929
 
 
930
 
 
931
class BadFileKindError(BzrError):
 
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 ExcludesUnsupported(BzrError):
 
1144
 
 
1145
    _fmt = ('Excluding paths during commit is not supported by '
 
1146
            'repository at %(repository)r.')
 
1147
 
 
1148
    def __init__(self, repository):
 
1149
        BzrError.__init__(self, repository=repository)
 
1150
 
 
1151
 
 
1152
class BadCommitMessageEncoding(BzrError):
 
1153
 
 
1154
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1155
        'the current encoding.'
 
1156
 
 
1157
 
 
1158
class UpgradeReadonly(BzrError):
 
1159
 
 
1160
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
1161
 
 
1162
 
 
1163
class UpToDateFormat(BzrError):
 
1164
 
 
1165
    _fmt = "The branch format %(format)s is already at the most recent format."
 
1166
 
 
1167
    def __init__(self, format):
 
1168
        BzrError.__init__(self)
 
1169
        self.format = format
 
1170
 
 
1171
 
 
1172
class StrictCommitFailed(Exception):
 
1173
 
 
1174
    _fmt = "Commit refused because there are unknowns in the tree."
 
1175
 
 
1176
 
 
1177
class NoSuchRevision(InternalBzrError):
 
1178
 
 
1179
    _fmt = "%(branch)s has no revision %(revision)s"
 
1180
 
 
1181
    def __init__(self, branch, revision):
 
1182
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1183
        BzrError.__init__(self, branch=branch, revision=revision)
 
1184
 
 
1185
 
 
1186
class RangeInChangeOption(BzrError):
 
1187
 
 
1188
    _fmt = "Option --change does not accept revision ranges"
 
1189
 
 
1190
 
 
1191
class NoSuchRevisionSpec(BzrError):
 
1192
 
 
1193
    _fmt = "No namespace registered for string: %(spec)r"
 
1194
 
 
1195
    def __init__(self, spec):
 
1196
        BzrError.__init__(self, spec=spec)
 
1197
 
 
1198
 
 
1199
class NoSuchRevisionInTree(NoSuchRevision):
 
1200
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1201
 
 
1202
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1203
 
 
1204
    def __init__(self, tree, revision_id):
 
1205
        BzrError.__init__(self)
 
1206
        self.tree = tree
 
1207
        self.revision_id = revision_id
 
1208
 
 
1209
 
 
1210
class InvalidRevisionSpec(BzrError):
 
1211
 
 
1212
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1213
            " %(branch_url)s%(extra)s")
 
1214
 
 
1215
    def __init__(self, spec, branch, extra=None):
 
1216
        BzrError.__init__(self, branch=branch, spec=spec)
 
1217
        self.branch_url = getattr(branch, 'user_url', str(branch))
 
1218
        if extra:
 
1219
            self.extra = '\n' + str(extra)
 
1220
        else:
 
1221
            self.extra = ''
 
1222
 
 
1223
 
 
1224
class HistoryMissing(BzrError):
 
1225
 
 
1226
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1227
 
 
1228
 
 
1229
class AppendRevisionsOnlyViolation(BzrError):
 
1230
 
 
1231
    _fmt = ('Operation denied because it would change the main history,'
 
1232
           ' which is not permitted by the append_revisions_only setting on'
 
1233
           ' branch "%(location)s".')
 
1234
 
 
1235
    def __init__(self, location):
 
1236
       import bzrlib.urlutils as urlutils
 
1237
       location = urlutils.unescape_for_display(location, 'ascii')
 
1238
       BzrError.__init__(self, location=location)
 
1239
 
 
1240
 
 
1241
class DivergedBranches(BzrError):
 
1242
 
 
1243
    _fmt = ("These branches have diverged."
 
1244
            " Use the missing command to see how.\n"
 
1245
            "Use the merge command to reconcile them.")
 
1246
 
 
1247
    def __init__(self, branch1, branch2):
 
1248
        self.branch1 = branch1
 
1249
        self.branch2 = branch2
 
1250
 
 
1251
 
 
1252
class NotLefthandHistory(InternalBzrError):
 
1253
 
 
1254
    _fmt = "Supplied history does not follow left-hand parents"
 
1255
 
 
1256
    def __init__(self, history):
 
1257
        BzrError.__init__(self, history=history)
 
1258
 
 
1259
 
 
1260
class UnrelatedBranches(BzrError):
 
1261
 
 
1262
    _fmt = ("Branches have no common ancestor, and"
 
1263
            " no merge base revision was specified.")
 
1264
 
 
1265
 
 
1266
class CannotReverseCherrypick(BzrError):
 
1267
 
 
1268
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1269
            ' or diff3.')
 
1270
 
 
1271
 
 
1272
class NoCommonAncestor(BzrError):
 
1273
 
 
1274
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1275
 
 
1276
    def __init__(self, revision_a, revision_b):
 
1277
        self.revision_a = revision_a
 
1278
        self.revision_b = revision_b
 
1279
 
 
1280
 
 
1281
class NoCommonRoot(BzrError):
 
1282
 
 
1283
    _fmt = ("Revisions are not derived from the same root: "
 
1284
           "%(revision_a)s %(revision_b)s.")
 
1285
 
 
1286
    def __init__(self, revision_a, revision_b):
 
1287
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1288
 
 
1289
 
 
1290
class NotAncestor(BzrError):
 
1291
 
 
1292
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1293
 
 
1294
    def __init__(self, rev_id, not_ancestor_id):
 
1295
        BzrError.__init__(self, rev_id=rev_id,
 
1296
            not_ancestor_id=not_ancestor_id)
 
1297
 
 
1298
 
 
1299
class AmbiguousBase(BzrError):
 
1300
 
 
1301
    def __init__(self, bases):
 
1302
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1303
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1304
        msg = ("The correct base is unclear, because %s are all equally close"
 
1305
                % ", ".join(bases))
 
1306
        BzrError.__init__(self, msg)
 
1307
        self.bases = bases
 
1308
 
 
1309
 
 
1310
class NoCommits(BranchError):
 
1311
 
 
1312
    _fmt = "Branch %(branch)s has no commits."
 
1313
 
 
1314
 
 
1315
class UnlistableStore(BzrError):
 
1316
 
 
1317
    def __init__(self, store):
 
1318
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1319
 
 
1320
 
 
1321
 
 
1322
class UnlistableBranch(BzrError):
 
1323
 
 
1324
    def __init__(self, br):
 
1325
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1326
 
 
1327
 
 
1328
class BoundBranchOutOfDate(BzrError):
 
1329
 
 
1330
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1331
            " %(master)s.%(extra_help)s")
 
1332
 
 
1333
    def __init__(self, branch, master):
 
1334
        BzrError.__init__(self)
 
1335
        self.branch = branch
 
1336
        self.master = master
 
1337
        self.extra_help = ''
 
1338
 
 
1339
 
 
1340
class CommitToDoubleBoundBranch(BzrError):
 
1341
 
 
1342
    _fmt = ("Cannot commit to branch %(branch)s."
 
1343
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1344
 
 
1345
    def __init__(self, branch, master, remote):
 
1346
        BzrError.__init__(self)
 
1347
        self.branch = branch
 
1348
        self.master = master
 
1349
        self.remote = remote
 
1350
 
 
1351
 
 
1352
class OverwriteBoundBranch(BzrError):
 
1353
 
 
1354
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1355
 
 
1356
    def __init__(self, branch):
 
1357
        BzrError.__init__(self)
 
1358
        self.branch = branch
 
1359
 
 
1360
 
 
1361
class BoundBranchConnectionFailure(BzrError):
 
1362
 
 
1363
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1364
            " => %(target)s: %(error)s")
 
1365
 
 
1366
    def __init__(self, branch, target, error):
 
1367
        BzrError.__init__(self)
 
1368
        self.branch = branch
 
1369
        self.target = target
 
1370
        self.error = error
 
1371
 
 
1372
 
 
1373
class WeaveError(BzrError):
 
1374
 
 
1375
    _fmt = "Error in processing weave: %(msg)s"
 
1376
 
 
1377
    def __init__(self, msg=None):
 
1378
        BzrError.__init__(self)
 
1379
        self.msg = msg
 
1380
 
 
1381
 
 
1382
class WeaveRevisionAlreadyPresent(WeaveError):
 
1383
 
 
1384
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1385
 
 
1386
    def __init__(self, revision_id, weave):
 
1387
 
 
1388
        WeaveError.__init__(self)
 
1389
        self.revision_id = revision_id
 
1390
        self.weave = weave
 
1391
 
 
1392
 
 
1393
class WeaveRevisionNotPresent(WeaveError):
 
1394
 
 
1395
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1396
 
 
1397
    def __init__(self, revision_id, weave):
 
1398
        WeaveError.__init__(self)
 
1399
        self.revision_id = revision_id
 
1400
        self.weave = weave
 
1401
 
 
1402
 
 
1403
class WeaveFormatError(WeaveError):
 
1404
 
 
1405
    _fmt = "Weave invariant violated: %(what)s"
 
1406
 
 
1407
    def __init__(self, what):
 
1408
        WeaveError.__init__(self)
 
1409
        self.what = what
 
1410
 
 
1411
 
 
1412
class WeaveParentMismatch(WeaveError):
 
1413
 
 
1414
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1415
 
 
1416
 
 
1417
class WeaveInvalidChecksum(WeaveError):
 
1418
 
 
1419
    _fmt = "Text did not match its checksum: %(msg)s"
 
1420
 
 
1421
 
 
1422
class WeaveTextDiffers(WeaveError):
 
1423
 
 
1424
    _fmt = ("Weaves differ on text content. Revision:"
 
1425
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1426
 
 
1427
    def __init__(self, revision_id, weave_a, weave_b):
 
1428
        WeaveError.__init__(self)
 
1429
        self.revision_id = revision_id
 
1430
        self.weave_a = weave_a
 
1431
        self.weave_b = weave_b
 
1432
 
 
1433
 
 
1434
class WeaveTextDiffers(WeaveError):
 
1435
 
 
1436
    _fmt = ("Weaves differ on text content. Revision:"
 
1437
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1438
 
 
1439
    def __init__(self, revision_id, weave_a, weave_b):
 
1440
        WeaveError.__init__(self)
 
1441
        self.revision_id = revision_id
 
1442
        self.weave_a = weave_a
 
1443
        self.weave_b = weave_b
 
1444
 
 
1445
 
 
1446
class VersionedFileError(BzrError):
 
1447
 
 
1448
    _fmt = "Versioned file error"
 
1449
 
 
1450
 
 
1451
class RevisionNotPresent(VersionedFileError):
 
1452
 
 
1453
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1454
 
 
1455
    def __init__(self, revision_id, file_id):
 
1456
        VersionedFileError.__init__(self)
 
1457
        self.revision_id = revision_id
 
1458
        self.file_id = file_id
 
1459
 
 
1460
 
 
1461
class RevisionAlreadyPresent(VersionedFileError):
 
1462
 
 
1463
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1464
 
 
1465
    def __init__(self, revision_id, file_id):
 
1466
        VersionedFileError.__init__(self)
 
1467
        self.revision_id = revision_id
 
1468
        self.file_id = file_id
 
1469
 
 
1470
 
 
1471
class VersionedFileInvalidChecksum(VersionedFileError):
 
1472
 
 
1473
    _fmt = "Text did not match its checksum: %(msg)s"
 
1474
 
 
1475
 
 
1476
class KnitError(InternalBzrError):
 
1477
 
 
1478
    _fmt = "Knit error"
 
1479
 
 
1480
 
 
1481
class KnitCorrupt(KnitError):
 
1482
 
 
1483
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1484
 
 
1485
    def __init__(self, filename, how):
 
1486
        KnitError.__init__(self)
 
1487
        self.filename = filename
 
1488
        self.how = how
 
1489
 
 
1490
 
 
1491
class SHA1KnitCorrupt(KnitCorrupt):
 
1492
 
 
1493
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1494
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1495
        "sha %(actual)s")
 
1496
 
 
1497
    def __init__(self, filename, actual, expected, key, content):
 
1498
        KnitError.__init__(self)
 
1499
        self.filename = filename
 
1500
        self.actual = actual
 
1501
        self.expected = expected
 
1502
        self.key = key
 
1503
        self.content = content
 
1504
 
 
1505
 
 
1506
class KnitDataStreamIncompatible(KnitError):
 
1507
    # Not raised anymore, as we can convert data streams.  In future we may
 
1508
    # need it again for more exotic cases, so we're keeping it around for now.
 
1509
 
 
1510
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1511
 
 
1512
    def __init__(self, stream_format, target_format):
 
1513
        self.stream_format = stream_format
 
1514
        self.target_format = target_format
 
1515
 
 
1516
 
 
1517
class KnitDataStreamUnknown(KnitError):
 
1518
    # Indicates a data stream we don't know how to handle.
 
1519
 
 
1520
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1521
 
 
1522
    def __init__(self, stream_format):
 
1523
        self.stream_format = stream_format
 
1524
 
 
1525
 
 
1526
class KnitHeaderError(KnitError):
 
1527
 
 
1528
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1529
 
 
1530
    def __init__(self, badline, filename):
 
1531
        KnitError.__init__(self)
 
1532
        self.badline = badline
 
1533
        self.filename = filename
 
1534
 
 
1535
class KnitIndexUnknownMethod(KnitError):
 
1536
    """Raised when we don't understand the storage method.
 
1537
 
 
1538
    Currently only 'fulltext' and 'line-delta' are supported.
 
1539
    """
 
1540
 
 
1541
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1542
            " in options: %(options)r")
 
1543
 
 
1544
    def __init__(self, filename, options):
 
1545
        KnitError.__init__(self)
 
1546
        self.filename = filename
 
1547
        self.options = options
 
1548
 
 
1549
 
 
1550
class RetryWithNewPacks(BzrError):
 
1551
    """Raised when we realize that the packs on disk have changed.
 
1552
 
 
1553
    This is meant as more of a signaling exception, to trap between where a
 
1554
    local error occurred and the code that can actually handle the error and
 
1555
    code that can retry appropriately.
 
1556
    """
 
1557
 
 
1558
    internal_error = True
 
1559
 
 
1560
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1561
            " %(orig_error)s")
 
1562
 
 
1563
    def __init__(self, context, reload_occurred, exc_info):
 
1564
        """create a new RetryWithNewPacks error.
 
1565
 
 
1566
        :param reload_occurred: Set to True if we know that the packs have
 
1567
            already been reloaded, and we are failing because of an in-memory
 
1568
            cache miss. If set to True then we will ignore if a reload says
 
1569
            nothing has changed, because we assume it has already reloaded. If
 
1570
            False, then a reload with nothing changed will force an error.
 
1571
        :param exc_info: The original exception traceback, so if there is a
 
1572
            problem we can raise the original error (value from sys.exc_info())
 
1573
        """
 
1574
        BzrError.__init__(self)
 
1575
        self.context = context
 
1576
        self.reload_occurred = reload_occurred
 
1577
        self.exc_info = exc_info
 
1578
        self.orig_error = exc_info[1]
 
1579
        # TODO: The global error handler should probably treat this by
 
1580
        #       raising/printing the original exception with a bit about
 
1581
        #       RetryWithNewPacks also not being caught
 
1582
 
 
1583
 
 
1584
class RetryAutopack(RetryWithNewPacks):
 
1585
    """Raised when we are autopacking and we find a missing file.
 
1586
 
 
1587
    Meant as a signaling exception, to tell the autopack code it should try
 
1588
    again.
 
1589
    """
 
1590
 
 
1591
    internal_error = True
 
1592
 
 
1593
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1594
            " context: %(context)s %(orig_error)s")
 
1595
 
 
1596
 
 
1597
class NoSuchExportFormat(BzrError):
 
1598
 
 
1599
    _fmt = "Export format %(format)r not supported"
 
1600
 
 
1601
    def __init__(self, format):
 
1602
        BzrError.__init__(self)
 
1603
        self.format = format
 
1604
 
 
1605
 
 
1606
class TransportError(BzrError):
 
1607
 
 
1608
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1609
 
 
1610
    def __init__(self, msg=None, orig_error=None):
 
1611
        if msg is None and orig_error is not None:
 
1612
            msg = str(orig_error)
 
1613
        if orig_error is None:
 
1614
            orig_error = ''
 
1615
        if msg is None:
 
1616
            msg =  ''
 
1617
        self.msg = msg
 
1618
        self.orig_error = orig_error
 
1619
        BzrError.__init__(self)
 
1620
 
 
1621
 
 
1622
class TooManyConcurrentRequests(InternalBzrError):
 
1623
 
 
1624
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1625
            " Be sure to finish_writing and finish_reading on the"
 
1626
            " currently open request.")
 
1627
 
 
1628
    def __init__(self, medium):
 
1629
        self.medium = medium
 
1630
 
 
1631
 
 
1632
class SmartProtocolError(TransportError):
 
1633
 
 
1634
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1635
 
 
1636
    def __init__(self, details):
 
1637
        self.details = details
 
1638
 
 
1639
 
 
1640
class UnexpectedProtocolVersionMarker(TransportError):
 
1641
 
 
1642
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1643
 
 
1644
    def __init__(self, marker):
 
1645
        self.marker = marker
 
1646
 
 
1647
 
 
1648
class UnknownSmartMethod(InternalBzrError):
 
1649
 
 
1650
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1651
 
 
1652
    def __init__(self, verb):
 
1653
        self.verb = verb
 
1654
 
 
1655
 
 
1656
class SmartMessageHandlerError(InternalBzrError):
 
1657
 
 
1658
    _fmt = ("The message handler raised an exception:\n"
 
1659
            "%(traceback_text)s")
 
1660
 
 
1661
    def __init__(self, exc_info):
 
1662
        import traceback
 
1663
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1664
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1665
        self.exc_info = exc_info
 
1666
        traceback_strings = traceback.format_exception(
 
1667
                self.exc_type, self.exc_value, self.exc_tb)
 
1668
        self.traceback_text = ''.join(traceback_strings)
 
1669
 
 
1670
 
 
1671
# A set of semi-meaningful errors which can be thrown
 
1672
class TransportNotPossible(TransportError):
 
1673
 
 
1674
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1675
 
 
1676
 
 
1677
class ConnectionError(TransportError):
 
1678
 
 
1679
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1680
 
 
1681
 
 
1682
class SocketConnectionError(ConnectionError):
 
1683
 
 
1684
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1685
 
 
1686
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1687
        if msg is None:
 
1688
            msg = 'Failed to connect to'
 
1689
        if orig_error is None:
 
1690
            orig_error = ''
 
1691
        else:
 
1692
            orig_error = '; ' + str(orig_error)
 
1693
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1694
        self.host = host
 
1695
        if port is None:
 
1696
            self.port = ''
 
1697
        else:
 
1698
            self.port = ':%s' % port
 
1699
 
 
1700
 
 
1701
# XXX: This is also used for unexpected end of file, which is different at the
 
1702
# TCP level from "connection reset".
 
1703
class ConnectionReset(TransportError):
 
1704
 
 
1705
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1706
 
 
1707
 
 
1708
class ConnectionTimeout(ConnectionError):
 
1709
 
 
1710
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1711
 
 
1712
 
 
1713
class InvalidRange(TransportError):
 
1714
 
 
1715
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1716
 
 
1717
    def __init__(self, path, offset, msg=None):
 
1718
        TransportError.__init__(self, msg)
 
1719
        self.path = path
 
1720
        self.offset = offset
 
1721
 
 
1722
 
 
1723
class InvalidHttpResponse(TransportError):
 
1724
 
 
1725
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1726
 
 
1727
    def __init__(self, path, msg, orig_error=None):
 
1728
        self.path = path
 
1729
        if orig_error is None:
 
1730
            orig_error = ''
 
1731
        else:
 
1732
            # This is reached for obscure and unusual errors so we want to
 
1733
            # preserve as much info as possible to ease debug.
 
1734
            orig_error = ': %r' % (orig_error,)
 
1735
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1736
 
 
1737
 
 
1738
class InvalidHttpRange(InvalidHttpResponse):
 
1739
 
 
1740
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1741
 
 
1742
    def __init__(self, path, range, msg):
 
1743
        self.range = range
 
1744
        InvalidHttpResponse.__init__(self, path, msg)
 
1745
 
 
1746
 
 
1747
class HttpBoundaryMissing(InvalidHttpResponse):
 
1748
    """A multipart response ends with no boundary marker.
 
1749
 
 
1750
    This is a special case caused by buggy proxies, described in
 
1751
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1752
    """
 
1753
 
 
1754
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1755
 
 
1756
    def __init__(self, path, msg):
 
1757
        InvalidHttpResponse.__init__(self, path, msg)
 
1758
 
 
1759
 
 
1760
class InvalidHttpContentType(InvalidHttpResponse):
 
1761
 
 
1762
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1763
 
 
1764
    def __init__(self, path, ctype, msg):
 
1765
        self.ctype = ctype
 
1766
        InvalidHttpResponse.__init__(self, path, msg)
 
1767
 
 
1768
 
 
1769
class RedirectRequested(TransportError):
 
1770
 
 
1771
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1772
 
 
1773
    def __init__(self, source, target, is_permanent=False):
 
1774
        self.source = source
 
1775
        self.target = target
 
1776
        if is_permanent:
 
1777
            self.permanently = ' permanently'
 
1778
        else:
 
1779
            self.permanently = ''
 
1780
        TransportError.__init__(self)
 
1781
 
 
1782
 
 
1783
class TooManyRedirections(TransportError):
 
1784
 
 
1785
    _fmt = "Too many redirections"
 
1786
 
 
1787
 
 
1788
class ConflictsInTree(BzrError):
 
1789
 
 
1790
    _fmt = "Working tree has conflicts."
 
1791
 
 
1792
 
 
1793
class ConfigContentError(BzrError):
 
1794
 
 
1795
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1796
 
 
1797
    def __init__(self, filename):
 
1798
        BzrError.__init__(self)
 
1799
        self.filename = filename
 
1800
 
 
1801
 
 
1802
class ParseConfigError(BzrError):
 
1803
 
 
1804
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1805
 
 
1806
    def __init__(self, errors, filename):
 
1807
        BzrError.__init__(self)
 
1808
        self.filename = filename
 
1809
        self.errors = '\n'.join(e.msg for e in errors)
 
1810
 
 
1811
 
 
1812
class ConfigOptionValueError(BzrError):
 
1813
 
 
1814
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
1815
 
 
1816
    def __init__(self, name, value):
 
1817
        BzrError.__init__(self, name=name, value=value)
 
1818
 
 
1819
 
 
1820
class NoEmailInUsername(BzrError):
 
1821
 
 
1822
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1823
 
 
1824
    def __init__(self, username):
 
1825
        BzrError.__init__(self)
 
1826
        self.username = username
 
1827
 
 
1828
 
 
1829
class SigningFailed(BzrError):
 
1830
 
 
1831
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1832
 
 
1833
    def __init__(self, command_line):
 
1834
        BzrError.__init__(self, command_line=command_line)
 
1835
 
 
1836
 
 
1837
class SignatureVerificationFailed(BzrError):
 
1838
 
 
1839
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1840
 
 
1841
    def __init__(self, error):
 
1842
        BzrError.__init__(self, error=error)
 
1843
 
 
1844
 
 
1845
class DependencyNotPresent(BzrError):
 
1846
 
 
1847
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1848
 
 
1849
    def __init__(self, library, error):
 
1850
        BzrError.__init__(self, library=library, error=error)
 
1851
 
 
1852
 
 
1853
class GpgmeNotInstalled(DependencyNotPresent):
 
1854
 
 
1855
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1856
 
 
1857
    def __init__(self, error):
 
1858
        DependencyNotPresent.__init__(self, 'gpgme', error)
 
1859
 
 
1860
 
 
1861
class WorkingTreeNotRevision(BzrError):
 
1862
 
 
1863
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1864
            " the last commit, but weave merge requires that it be"
 
1865
            " unchanged")
 
1866
 
 
1867
    def __init__(self, tree):
 
1868
        BzrError.__init__(self, basedir=tree.basedir)
 
1869
 
 
1870
 
 
1871
class CantReprocessAndShowBase(BzrError):
 
1872
 
 
1873
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1874
           "the relationship of conflicting lines to the base")
 
1875
 
 
1876
 
 
1877
class GraphCycleError(BzrError):
 
1878
 
 
1879
    _fmt = "Cycle in graph %(graph)r"
 
1880
 
 
1881
    def __init__(self, graph):
 
1882
        BzrError.__init__(self)
 
1883
        self.graph = graph
 
1884
 
 
1885
 
 
1886
class WritingCompleted(InternalBzrError):
 
1887
 
 
1888
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1889
            "called upon it - accept bytes may not be called anymore.")
 
1890
 
 
1891
    def __init__(self, request):
 
1892
        self.request = request
 
1893
 
 
1894
 
 
1895
class WritingNotComplete(InternalBzrError):
 
1896
 
 
1897
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1898
            "called upon it - until the write phase is complete no "
 
1899
            "data may be read.")
 
1900
 
 
1901
    def __init__(self, request):
 
1902
        self.request = request
 
1903
 
 
1904
 
 
1905
class NotConflicted(BzrError):
 
1906
 
 
1907
    _fmt = "File %(filename)s is not conflicted."
 
1908
 
 
1909
    def __init__(self, filename):
 
1910
        BzrError.__init__(self)
 
1911
        self.filename = filename
 
1912
 
 
1913
 
 
1914
class MediumNotConnected(InternalBzrError):
 
1915
 
 
1916
    _fmt = """The medium '%(medium)s' is not connected."""
 
1917
 
 
1918
    def __init__(self, medium):
 
1919
        self.medium = medium
 
1920
 
 
1921
 
 
1922
class MustUseDecorated(Exception):
 
1923
 
 
1924
    _fmt = "A decorating function has requested its original command be used."
 
1925
 
 
1926
 
 
1927
class NoBundleFound(BzrError):
 
1928
 
 
1929
    _fmt = 'No bundle was found in "%(filename)s".'
 
1930
 
 
1931
    def __init__(self, filename):
 
1932
        BzrError.__init__(self)
 
1933
        self.filename = filename
 
1934
 
 
1935
 
 
1936
class BundleNotSupported(BzrError):
 
1937
 
 
1938
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1939
 
 
1940
    def __init__(self, version, msg):
 
1941
        BzrError.__init__(self)
 
1942
        self.version = version
 
1943
        self.msg = msg
 
1944
 
 
1945
 
 
1946
class MissingText(BzrError):
 
1947
 
 
1948
    _fmt = ("Branch %(base)s is missing revision"
 
1949
            " %(text_revision)s of %(file_id)s")
 
1950
 
 
1951
    def __init__(self, branch, text_revision, file_id):
 
1952
        BzrError.__init__(self)
 
1953
        self.branch = branch
 
1954
        self.base = branch.base
 
1955
        self.text_revision = text_revision
 
1956
        self.file_id = file_id
 
1957
 
 
1958
 
 
1959
class DuplicateFileId(BzrError):
 
1960
 
 
1961
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1962
 
 
1963
    def __init__(self, file_id, entry):
 
1964
        BzrError.__init__(self)
 
1965
        self.file_id = file_id
 
1966
        self.entry = entry
 
1967
 
 
1968
 
 
1969
class DuplicateKey(BzrError):
 
1970
 
 
1971
    _fmt = "Key %(key)s is already present in map"
 
1972
 
 
1973
 
 
1974
class DuplicateHelpPrefix(BzrError):
 
1975
 
 
1976
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1977
 
 
1978
    def __init__(self, prefix):
 
1979
        self.prefix = prefix
 
1980
 
 
1981
 
 
1982
class MalformedTransform(InternalBzrError):
 
1983
 
 
1984
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1985
 
 
1986
 
 
1987
class NoFinalPath(BzrError):
 
1988
 
 
1989
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1990
            "file-id: %(file_id)r\n"
 
1991
            "root trans-id: %(root_trans_id)r\n")
 
1992
 
 
1993
    def __init__(self, trans_id, transform):
 
1994
        self.trans_id = trans_id
 
1995
        self.file_id = transform.final_file_id(trans_id)
 
1996
        self.root_trans_id = transform.root
 
1997
 
 
1998
 
 
1999
class BzrBadParameter(InternalBzrError):
 
2000
 
 
2001
    _fmt = "Bad parameter: %(param)r"
 
2002
 
 
2003
    # This exception should never be thrown, but it is a base class for all
 
2004
    # parameter-to-function errors.
 
2005
 
 
2006
    def __init__(self, param):
 
2007
        BzrError.__init__(self)
 
2008
        self.param = param
 
2009
 
 
2010
 
 
2011
class BzrBadParameterNotUnicode(BzrBadParameter):
 
2012
 
 
2013
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
2014
 
 
2015
 
 
2016
class ReusingTransform(BzrError):
 
2017
 
 
2018
    _fmt = "Attempt to reuse a transform that has already been applied."
 
2019
 
 
2020
 
 
2021
class CantMoveRoot(BzrError):
 
2022
 
 
2023
    _fmt = "Moving the root directory is not supported at this time"
 
2024
 
 
2025
 
 
2026
class TransformRenameFailed(BzrError):
 
2027
 
 
2028
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
2029
 
 
2030
    def __init__(self, from_path, to_path, why, errno):
 
2031
        self.from_path = from_path
 
2032
        self.to_path = to_path
 
2033
        self.why = why
 
2034
        self.errno = errno
 
2035
 
 
2036
 
 
2037
class BzrMoveFailedError(BzrError):
 
2038
 
 
2039
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
2040
        "%(_has_extra)s%(extra)s")
 
2041
 
 
2042
    def __init__(self, from_path='', to_path='', extra=None):
 
2043
        from bzrlib.osutils import splitpath
 
2044
        BzrError.__init__(self)
 
2045
        if extra:
 
2046
            self.extra, self._has_extra = extra, ': '
 
2047
        else:
 
2048
            self.extra = self._has_extra = ''
 
2049
 
 
2050
        has_from = len(from_path) > 0
 
2051
        has_to = len(to_path) > 0
 
2052
        if has_from:
 
2053
            self.from_path = splitpath(from_path)[-1]
 
2054
        else:
 
2055
            self.from_path = ''
 
2056
 
 
2057
        if has_to:
 
2058
            self.to_path = splitpath(to_path)[-1]
 
2059
        else:
 
2060
            self.to_path = ''
 
2061
 
 
2062
        self.operator = ""
 
2063
        if has_from and has_to:
 
2064
            self.operator = " =>"
 
2065
        elif has_from:
 
2066
            self.from_path = "from " + from_path
 
2067
        elif has_to:
 
2068
            self.operator = "to"
 
2069
        else:
 
2070
            self.operator = "file"
 
2071
 
 
2072
 
 
2073
class BzrRenameFailedError(BzrMoveFailedError):
 
2074
 
 
2075
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
2076
        "%(_has_extra)s%(extra)s")
 
2077
 
 
2078
    def __init__(self, from_path, to_path, extra=None):
 
2079
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
2080
 
 
2081
 
 
2082
class BzrRemoveChangedFilesError(BzrError):
 
2083
    """Used when user is trying to remove changed files."""
 
2084
 
 
2085
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
2086
        "%(changes_as_text)s"
 
2087
        "Use --keep to not delete them, or --force to delete them regardless.")
 
2088
 
 
2089
    def __init__(self, tree_delta):
 
2090
        symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
 
2091
            "BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
 
2092
        BzrError.__init__(self)
 
2093
        self.changes_as_text = tree_delta.get_changes_as_text()
 
2094
        #self.paths_as_string = '\n'.join(changed_files)
 
2095
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
2096
 
 
2097
 
 
2098
class BzrBadParameterNotString(BzrBadParameter):
 
2099
 
 
2100
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
2101
 
 
2102
 
 
2103
class BzrBadParameterMissing(BzrBadParameter):
 
2104
 
 
2105
    _fmt = "Parameter %(param)s is required but not present."
 
2106
 
 
2107
 
 
2108
class BzrBadParameterUnicode(BzrBadParameter):
 
2109
 
 
2110
    _fmt = ("Parameter %(param)s is unicode but"
 
2111
            " only byte-strings are permitted.")
 
2112
 
 
2113
 
 
2114
class BzrBadParameterContainsNewline(BzrBadParameter):
 
2115
 
 
2116
    _fmt = "Parameter %(param)s contains a newline."
 
2117
 
 
2118
 
 
2119
class ParamikoNotPresent(DependencyNotPresent):
 
2120
 
 
2121
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
2122
 
 
2123
    def __init__(self, error):
 
2124
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
2125
 
 
2126
 
 
2127
class PointlessMerge(BzrError):
 
2128
 
 
2129
    _fmt = "Nothing to merge."
 
2130
 
 
2131
 
 
2132
class UninitializableFormat(BzrError):
 
2133
 
 
2134
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
2135
 
 
2136
    def __init__(self, format):
 
2137
        BzrError.__init__(self)
 
2138
        self.format = format
 
2139
 
 
2140
 
 
2141
class BadConversionTarget(BzrError):
 
2142
 
 
2143
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2144
            "    %(problem)s"
 
2145
 
 
2146
    def __init__(self, problem, format, from_format=None):
 
2147
        BzrError.__init__(self)
 
2148
        self.problem = problem
 
2149
        self.format = format
 
2150
        self.from_format = from_format or '(unspecified)'
 
2151
 
 
2152
 
 
2153
class NoDiffFound(BzrError):
 
2154
 
 
2155
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2156
 
 
2157
    def __init__(self, path):
 
2158
        BzrError.__init__(self, path)
 
2159
 
 
2160
 
 
2161
class ExecutableMissing(BzrError):
 
2162
 
 
2163
    _fmt = "%(exe_name)s could not be found on this machine"
 
2164
 
 
2165
    def __init__(self, exe_name):
 
2166
        BzrError.__init__(self, exe_name=exe_name)
 
2167
 
 
2168
 
 
2169
class NoDiff(BzrError):
 
2170
 
 
2171
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
2172
 
 
2173
    def __init__(self, msg):
 
2174
        BzrError.__init__(self, msg=msg)
 
2175
 
 
2176
 
 
2177
class NoDiff3(BzrError):
 
2178
 
 
2179
    _fmt = "Diff3 is not installed on this machine."
 
2180
 
 
2181
 
 
2182
class ExistingContent(BzrError):
 
2183
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2184
 
 
2185
    _fmt = "The content being inserted is already present."
 
2186
 
 
2187
 
 
2188
class ExistingLimbo(BzrError):
 
2189
 
 
2190
    _fmt = """This tree contains left-over files from a failed operation.
 
2191
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2192
    keep, and delete it when you are done."""
 
2193
 
 
2194
    def __init__(self, limbo_dir):
 
2195
       BzrError.__init__(self)
 
2196
       self.limbo_dir = limbo_dir
 
2197
 
 
2198
 
 
2199
class ExistingPendingDeletion(BzrError):
 
2200
 
 
2201
    _fmt = """This tree contains left-over files from a failed operation.
 
2202
    Please examine %(pending_deletion)s to see if it contains any files you
 
2203
    wish to keep, and delete it when you are done."""
 
2204
 
 
2205
    def __init__(self, pending_deletion):
 
2206
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2207
 
 
2208
 
 
2209
class ImmortalLimbo(BzrError):
 
2210
 
 
2211
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2212
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2213
    keep, and delete it when you are done."""
 
2214
 
 
2215
    def __init__(self, limbo_dir):
 
2216
       BzrError.__init__(self)
 
2217
       self.limbo_dir = limbo_dir
 
2218
 
 
2219
 
 
2220
class ImmortalPendingDeletion(BzrError):
 
2221
 
 
2222
    _fmt = ("Unable to delete transform temporary directory "
 
2223
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2224
    "contains any files you wish to keep, and delete it when you are done.")
 
2225
 
 
2226
    def __init__(self, pending_deletion):
 
2227
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2228
 
 
2229
 
 
2230
class OutOfDateTree(BzrError):
 
2231
 
 
2232
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2233
 
 
2234
    def __init__(self, tree, more=None):
 
2235
        if more is None:
 
2236
            more = ''
 
2237
        else:
 
2238
            more = ' ' + more
 
2239
        BzrError.__init__(self)
 
2240
        self.tree = tree
 
2241
        self.more = more
 
2242
 
 
2243
 
 
2244
class PublicBranchOutOfDate(BzrError):
 
2245
 
 
2246
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2247
        '"%(revstring)s".'
 
2248
 
 
2249
    def __init__(self, public_location, revstring):
 
2250
        import bzrlib.urlutils as urlutils
 
2251
        public_location = urlutils.unescape_for_display(public_location,
 
2252
                                                        'ascii')
 
2253
        BzrError.__init__(self, public_location=public_location,
 
2254
                          revstring=revstring)
 
2255
 
 
2256
 
 
2257
class MergeModifiedFormatError(BzrError):
 
2258
 
 
2259
    _fmt = "Error in merge modified format"
 
2260
 
 
2261
 
 
2262
class ConflictFormatError(BzrError):
 
2263
 
 
2264
    _fmt = "Format error in conflict listings"
 
2265
 
 
2266
 
 
2267
class CorruptDirstate(BzrError):
 
2268
 
 
2269
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2270
            "Error: %(description)s")
 
2271
 
 
2272
    def __init__(self, dirstate_path, description):
 
2273
        BzrError.__init__(self)
 
2274
        self.dirstate_path = dirstate_path
 
2275
        self.description = description
 
2276
 
 
2277
 
 
2278
class CorruptRepository(BzrError):
 
2279
 
 
2280
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2281
            "Please run bzr reconcile on this repository.")
 
2282
 
 
2283
    def __init__(self, repo):
 
2284
        BzrError.__init__(self)
 
2285
        self.repo_path = repo.user_url
 
2286
 
 
2287
 
 
2288
class InconsistentDelta(BzrError):
 
2289
    """Used when we get a delta that is not valid."""
 
2290
 
 
2291
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2292
            " %(file_id)r\nreason: %(reason)s")
 
2293
 
 
2294
    def __init__(self, path, file_id, reason):
 
2295
        BzrError.__init__(self)
 
2296
        self.path = path
 
2297
        self.file_id = file_id
 
2298
        self.reason = reason
 
2299
 
 
2300
 
 
2301
class InconsistentDeltaDelta(InconsistentDelta):
 
2302
    """Used when we get a delta that is not valid."""
 
2303
 
 
2304
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2305
            "\nreason: %(reason)s")
 
2306
 
 
2307
    def __init__(self, delta, reason):
 
2308
        BzrError.__init__(self)
 
2309
        self.delta = delta
 
2310
        self.reason = reason
 
2311
 
 
2312
 
 
2313
class UpgradeRequired(BzrError):
 
2314
 
 
2315
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
2316
 
 
2317
    def __init__(self, path):
 
2318
        BzrError.__init__(self)
 
2319
        self.path = path
 
2320
 
 
2321
 
 
2322
class RepositoryUpgradeRequired(UpgradeRequired):
 
2323
 
 
2324
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2325
 
 
2326
 
 
2327
class RichRootUpgradeRequired(UpgradeRequired):
 
2328
 
 
2329
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2330
           " a format which supports rich roots.")
 
2331
 
 
2332
 
 
2333
class LocalRequiresBoundBranch(BzrError):
 
2334
 
 
2335
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2336
 
 
2337
 
 
2338
class UnsupportedOperation(BzrError):
 
2339
 
 
2340
    _fmt = ("The method %(mname)s is not supported on"
 
2341
            " objects of type %(tname)s.")
 
2342
 
 
2343
    def __init__(self, method, method_self):
 
2344
        self.method = method
 
2345
        self.mname = method.__name__
 
2346
        self.tname = type(method_self).__name__
 
2347
 
 
2348
 
 
2349
class CannotSetRevisionId(UnsupportedOperation):
 
2350
    """Raised when a commit is attempting to set a revision id but cant."""
 
2351
 
 
2352
 
 
2353
class NonAsciiRevisionId(UnsupportedOperation):
 
2354
    """Raised when a commit is attempting to set a non-ascii revision id
 
2355
       but cant.
 
2356
    """
 
2357
 
 
2358
 
 
2359
class GhostTagsNotSupported(BzrError):
 
2360
 
 
2361
    _fmt = "Ghost tags not supported by format %(format)r."
 
2362
 
 
2363
    def __init__(self, format):
 
2364
        self.format = format
 
2365
 
 
2366
 
 
2367
class BinaryFile(BzrError):
 
2368
 
 
2369
    _fmt = "File is binary but should be text."
 
2370
 
 
2371
 
 
2372
class IllegalPath(BzrError):
 
2373
 
 
2374
    _fmt = "The path %(path)s is not permitted on this platform"
 
2375
 
 
2376
    def __init__(self, path):
 
2377
        BzrError.__init__(self)
 
2378
        self.path = path
 
2379
 
 
2380
 
 
2381
class TestamentMismatch(BzrError):
 
2382
 
 
2383
    _fmt = """Testament did not match expected value.
 
2384
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2385
       {%(measured)s}"""
 
2386
 
 
2387
    def __init__(self, revision_id, expected, measured):
 
2388
        self.revision_id = revision_id
 
2389
        self.expected = expected
 
2390
        self.measured = measured
 
2391
 
 
2392
 
 
2393
class NotABundle(BzrError):
 
2394
 
 
2395
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2396
 
 
2397
    def __init__(self, text):
 
2398
        BzrError.__init__(self)
 
2399
        self.text = text
 
2400
 
 
2401
 
 
2402
class BadBundle(BzrError):
 
2403
 
 
2404
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2405
 
 
2406
    def __init__(self, text):
 
2407
        BzrError.__init__(self)
 
2408
        self.text = text
 
2409
 
 
2410
 
 
2411
class MalformedHeader(BadBundle):
 
2412
 
 
2413
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2414
 
 
2415
 
 
2416
class MalformedPatches(BadBundle):
 
2417
 
 
2418
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2419
 
 
2420
 
 
2421
class MalformedFooter(BadBundle):
 
2422
 
 
2423
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2424
 
 
2425
 
 
2426
class UnsupportedEOLMarker(BadBundle):
 
2427
 
 
2428
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2429
 
 
2430
    def __init__(self):
 
2431
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2432
        # but for this there is not
 
2433
        BzrError.__init__(self)
 
2434
 
 
2435
 
 
2436
class IncompatibleBundleFormat(BzrError):
 
2437
 
 
2438
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2439
 
 
2440
    def __init__(self, bundle_format, other):
 
2441
        BzrError.__init__(self)
 
2442
        self.bundle_format = bundle_format
 
2443
        self.other = other
 
2444
 
 
2445
 
 
2446
class BadInventoryFormat(BzrError):
 
2447
 
 
2448
    _fmt = "Root class for inventory serialization errors"
 
2449
 
 
2450
 
 
2451
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2452
 
 
2453
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2454
 
 
2455
    def __init__(self, msg):
 
2456
        BadInventoryFormat.__init__(self, msg=msg)
 
2457
 
 
2458
 
 
2459
class RootNotRich(BzrError):
 
2460
 
 
2461
    _fmt = """This operation requires rich root data storage"""
 
2462
 
 
2463
 
 
2464
class NoSmartMedium(InternalBzrError):
 
2465
 
 
2466
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2467
 
 
2468
    def __init__(self, transport):
 
2469
        self.transport = transport
 
2470
 
 
2471
 
 
2472
class UnknownSSH(BzrError):
 
2473
 
 
2474
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2475
 
 
2476
    def __init__(self, vendor):
 
2477
        BzrError.__init__(self)
 
2478
        self.vendor = vendor
 
2479
 
 
2480
 
 
2481
class SSHVendorNotFound(BzrError):
 
2482
 
 
2483
    _fmt = ("Don't know how to handle SSH connections."
 
2484
            " Please set BZR_SSH environment variable.")
 
2485
 
 
2486
 
 
2487
class GhostRevisionsHaveNoRevno(BzrError):
 
2488
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2489
 
 
2490
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2491
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2492
 
 
2493
    def __init__(self, revision_id, ghost_revision_id):
 
2494
        self.revision_id = revision_id
 
2495
        self.ghost_revision_id = ghost_revision_id
 
2496
 
 
2497
 
 
2498
class GhostRevisionUnusableHere(BzrError):
 
2499
 
 
2500
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2501
 
 
2502
    def __init__(self, revision_id):
 
2503
        BzrError.__init__(self)
 
2504
        self.revision_id = revision_id
 
2505
 
 
2506
 
 
2507
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2508
 
 
2509
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2510
            " %(msg)s%(extra)s")
 
2511
 
 
2512
    def __init__(self, name, msg, extra=None):
 
2513
        BzrError.__init__(self)
 
2514
        self.name = name
 
2515
        self.msg = msg
 
2516
        if extra:
 
2517
            self.extra = ': ' + str(extra)
 
2518
        else:
 
2519
            self.extra = ''
 
2520
 
 
2521
 
 
2522
class InvalidImportLine(InternalBzrError):
 
2523
 
 
2524
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2525
 
 
2526
    def __init__(self, text, msg):
 
2527
        BzrError.__init__(self)
 
2528
        self.text = text
 
2529
        self.msg = msg
 
2530
 
 
2531
 
 
2532
class ImportNameCollision(InternalBzrError):
 
2533
 
 
2534
    _fmt = ("Tried to import an object to the same name as"
 
2535
            " an existing object. %(name)s")
 
2536
 
 
2537
    def __init__(self, name):
 
2538
        BzrError.__init__(self)
 
2539
        self.name = name
 
2540
 
 
2541
 
 
2542
class NotAMergeDirective(BzrError):
 
2543
    """File starting with %(firstline)r is not a merge directive"""
 
2544
    def __init__(self, firstline):
 
2545
        BzrError.__init__(self, firstline=firstline)
 
2546
 
 
2547
 
 
2548
class NoMergeSource(BzrError):
 
2549
    """Raise if no merge source was specified for a merge directive"""
 
2550
 
 
2551
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2552
        " branch location."
 
2553
 
 
2554
 
 
2555
class IllegalMergeDirectivePayload(BzrError):
 
2556
    """A merge directive contained something other than a patch or bundle"""
 
2557
 
 
2558
    _fmt = "Bad merge directive payload %(start)r"
 
2559
 
 
2560
    def __init__(self, start):
 
2561
        BzrError(self)
 
2562
        self.start = start
 
2563
 
 
2564
 
 
2565
class PatchVerificationFailed(BzrError):
 
2566
    """A patch from a merge directive could not be verified"""
 
2567
 
 
2568
    _fmt = "Preview patch does not match requested changes."
 
2569
 
 
2570
 
 
2571
class PatchMissing(BzrError):
 
2572
    """Raise a patch type was specified but no patch supplied"""
 
2573
 
 
2574
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2575
 
 
2576
    def __init__(self, patch_type):
 
2577
        BzrError.__init__(self)
 
2578
        self.patch_type = patch_type
 
2579
 
 
2580
 
 
2581
class TargetNotBranch(BzrError):
 
2582
    """A merge directive's target branch is required, but isn't a branch"""
 
2583
 
 
2584
    _fmt = ("Your branch does not have all of the revisions required in "
 
2585
            "order to merge this merge directive and the target "
 
2586
            "location specified in the merge directive is not a branch: "
 
2587
            "%(location)s.")
 
2588
 
 
2589
    def __init__(self, location):
 
2590
        BzrError.__init__(self)
 
2591
        self.location = location
 
2592
 
 
2593
 
 
2594
class UnsupportedInventoryKind(BzrError):
 
2595
 
 
2596
    _fmt = """Unsupported entry kind %(kind)s"""
 
2597
 
 
2598
    def __init__(self, kind):
 
2599
        self.kind = kind
 
2600
 
 
2601
 
 
2602
class BadSubsumeSource(BzrError):
 
2603
 
 
2604
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2605
 
 
2606
    def __init__(self, tree, other_tree, reason):
 
2607
        self.tree = tree
 
2608
        self.other_tree = other_tree
 
2609
        self.reason = reason
 
2610
 
 
2611
 
 
2612
class SubsumeTargetNeedsUpgrade(BzrError):
 
2613
 
 
2614
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2615
 
 
2616
    def __init__(self, other_tree):
 
2617
        self.other_tree = other_tree
 
2618
 
 
2619
 
 
2620
class BadReferenceTarget(InternalBzrError):
 
2621
 
 
2622
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2623
           "%(reason)s"
 
2624
 
 
2625
    def __init__(self, tree, other_tree, reason):
 
2626
        self.tree = tree
 
2627
        self.other_tree = other_tree
 
2628
        self.reason = reason
 
2629
 
 
2630
 
 
2631
class NoSuchTag(BzrError):
 
2632
 
 
2633
    _fmt = "No such tag: %(tag_name)s"
 
2634
 
 
2635
    def __init__(self, tag_name):
 
2636
        self.tag_name = tag_name
 
2637
 
 
2638
 
 
2639
class TagsNotSupported(BzrError):
 
2640
 
 
2641
    _fmt = ("Tags not supported by %(branch)s;"
 
2642
            " you may be able to use bzr upgrade.")
 
2643
 
 
2644
    def __init__(self, branch):
 
2645
        self.branch = branch
 
2646
 
 
2647
 
 
2648
class TagAlreadyExists(BzrError):
 
2649
 
 
2650
    _fmt = "Tag %(tag_name)s already exists."
 
2651
 
 
2652
    def __init__(self, tag_name):
 
2653
        self.tag_name = tag_name
 
2654
 
 
2655
 
 
2656
class MalformedBugIdentifier(BzrError):
 
2657
 
 
2658
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2659
            'See "bzr help bugs" for more information on this feature.')
 
2660
 
 
2661
    def __init__(self, bug_id, reason):
 
2662
        self.bug_id = bug_id
 
2663
        self.reason = reason
 
2664
 
 
2665
 
 
2666
class InvalidBugTrackerURL(BzrError):
 
2667
 
 
2668
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2669
            "contain {id}: %(url)s")
 
2670
 
 
2671
    def __init__(self, abbreviation, url):
 
2672
        self.abbreviation = abbreviation
 
2673
        self.url = url
 
2674
 
 
2675
 
 
2676
class UnknownBugTrackerAbbreviation(BzrError):
 
2677
 
 
2678
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2679
            "on %(branch)s")
 
2680
 
 
2681
    def __init__(self, abbreviation, branch):
 
2682
        self.abbreviation = abbreviation
 
2683
        self.branch = branch
 
2684
 
 
2685
 
 
2686
class InvalidLineInBugsProperty(BzrError):
 
2687
 
 
2688
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2689
 
 
2690
    def __init__(self, line):
 
2691
        self.line = line
 
2692
 
 
2693
 
 
2694
class InvalidBugStatus(BzrError):
 
2695
 
 
2696
    _fmt = ("Invalid bug status: '%(status)s'")
 
2697
 
 
2698
    def __init__(self, status):
 
2699
        self.status = status
 
2700
 
 
2701
 
 
2702
class UnexpectedSmartServerResponse(BzrError):
 
2703
 
 
2704
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2705
 
 
2706
    def __init__(self, response_tuple):
 
2707
        self.response_tuple = response_tuple
 
2708
 
 
2709
 
 
2710
class ErrorFromSmartServer(BzrError):
 
2711
    """An error was received from a smart server.
 
2712
 
 
2713
    :seealso: UnknownErrorFromSmartServer
 
2714
    """
 
2715
 
 
2716
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2717
 
 
2718
    internal_error = True
 
2719
 
 
2720
    def __init__(self, error_tuple):
 
2721
        self.error_tuple = error_tuple
 
2722
        try:
 
2723
            self.error_verb = error_tuple[0]
 
2724
        except IndexError:
 
2725
            self.error_verb = None
 
2726
        self.error_args = error_tuple[1:]
 
2727
 
 
2728
 
 
2729
class UnknownErrorFromSmartServer(BzrError):
 
2730
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2731
    error.
 
2732
 
 
2733
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2734
    distinguish between the following two cases:
 
2735
 
 
2736
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2737
      and so should provoke a traceback to the user.
 
2738
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2739
      translated.  This is probably because the server sent us garbage, and
 
2740
      should not provoke a traceback.
 
2741
    """
 
2742
 
 
2743
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2744
 
 
2745
    internal_error = False
 
2746
 
 
2747
    def __init__(self, error_from_smart_server):
 
2748
        """Constructor.
 
2749
 
 
2750
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2751
        """
 
2752
        self.error_from_smart_server = error_from_smart_server
 
2753
        self.error_tuple = error_from_smart_server.error_tuple
 
2754
 
 
2755
 
 
2756
class ContainerError(BzrError):
 
2757
    """Base class of container errors."""
 
2758
 
 
2759
 
 
2760
class UnknownContainerFormatError(ContainerError):
 
2761
 
 
2762
    _fmt = "Unrecognised container format: %(container_format)r"
 
2763
 
 
2764
    def __init__(self, container_format):
 
2765
        self.container_format = container_format
 
2766
 
 
2767
 
 
2768
class UnexpectedEndOfContainerError(ContainerError):
 
2769
 
 
2770
    _fmt = "Unexpected end of container stream"
 
2771
 
 
2772
 
 
2773
class UnknownRecordTypeError(ContainerError):
 
2774
 
 
2775
    _fmt = "Unknown record type: %(record_type)r"
 
2776
 
 
2777
    def __init__(self, record_type):
 
2778
        self.record_type = record_type
 
2779
 
 
2780
 
 
2781
class InvalidRecordError(ContainerError):
 
2782
 
 
2783
    _fmt = "Invalid record: %(reason)s"
 
2784
 
 
2785
    def __init__(self, reason):
 
2786
        self.reason = reason
 
2787
 
 
2788
 
 
2789
class ContainerHasExcessDataError(ContainerError):
 
2790
 
 
2791
    _fmt = "Container has data after end marker: %(excess)r"
 
2792
 
 
2793
    def __init__(self, excess):
 
2794
        self.excess = excess
 
2795
 
 
2796
 
 
2797
class DuplicateRecordNameError(ContainerError):
 
2798
 
 
2799
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2800
 
 
2801
    def __init__(self, name):
 
2802
        self.name = name.decode("utf-8")
 
2803
 
 
2804
 
 
2805
class NoDestinationAddress(InternalBzrError):
 
2806
 
 
2807
    _fmt = "Message does not have a destination address."
 
2808
 
 
2809
 
 
2810
class RepositoryDataStreamError(BzrError):
 
2811
 
 
2812
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2813
 
 
2814
    def __init__(self, reason):
 
2815
        self.reason = reason
 
2816
 
 
2817
 
 
2818
class SMTPError(BzrError):
 
2819
 
 
2820
    _fmt = "SMTP error: %(error)s"
 
2821
 
 
2822
    def __init__(self, error):
 
2823
        self.error = error
 
2824
 
 
2825
 
 
2826
class NoMessageSupplied(BzrError):
 
2827
 
 
2828
    _fmt = "No message supplied."
 
2829
 
 
2830
 
 
2831
class NoMailAddressSpecified(BzrError):
 
2832
 
 
2833
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2834
 
 
2835
 
 
2836
class UnknownMailClient(BzrError):
 
2837
 
 
2838
    _fmt = "Unknown mail client: %(mail_client)s"
 
2839
 
 
2840
    def __init__(self, mail_client):
 
2841
        BzrError.__init__(self, mail_client=mail_client)
 
2842
 
 
2843
 
 
2844
class MailClientNotFound(BzrError):
 
2845
 
 
2846
    _fmt = "Unable to find mail client with the following names:"\
 
2847
        " %(mail_command_list_string)s"
 
2848
 
 
2849
    def __init__(self, mail_command_list):
 
2850
        mail_command_list_string = ', '.join(mail_command_list)
 
2851
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2852
                          mail_command_list_string=mail_command_list_string)
 
2853
 
 
2854
class SMTPConnectionRefused(SMTPError):
 
2855
 
 
2856
    _fmt = "SMTP connection to %(host)s refused"
 
2857
 
 
2858
    def __init__(self, error, host):
 
2859
        self.error = error
 
2860
        self.host = host
 
2861
 
 
2862
 
 
2863
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2864
 
 
2865
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2866
 
 
2867
 
 
2868
class BzrDirError(BzrError):
 
2869
 
 
2870
    def __init__(self, bzrdir):
 
2871
        import bzrlib.urlutils as urlutils
 
2872
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2873
                                                    'ascii')
 
2874
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2875
 
 
2876
 
 
2877
class UnsyncedBranches(BzrDirError):
 
2878
 
 
2879
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2880
            " bzr help sync-for-reconfigure.")
 
2881
 
 
2882
    def __init__(self, bzrdir, target_branch):
 
2883
        BzrDirError.__init__(self, bzrdir)
 
2884
        import bzrlib.urlutils as urlutils
 
2885
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2886
                                                        'ascii')
 
2887
 
 
2888
 
 
2889
class AlreadyBranch(BzrDirError):
 
2890
 
 
2891
    _fmt = "'%(display_url)s' is already a branch."
 
2892
 
 
2893
 
 
2894
class AlreadyTree(BzrDirError):
 
2895
 
 
2896
    _fmt = "'%(display_url)s' is already a tree."
 
2897
 
 
2898
 
 
2899
class AlreadyCheckout(BzrDirError):
 
2900
 
 
2901
    _fmt = "'%(display_url)s' is already a checkout."
 
2902
 
 
2903
 
 
2904
class AlreadyLightweightCheckout(BzrDirError):
 
2905
 
 
2906
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2907
 
 
2908
 
 
2909
class AlreadyUsingShared(BzrDirError):
 
2910
 
 
2911
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2912
 
 
2913
 
 
2914
class AlreadyStandalone(BzrDirError):
 
2915
 
 
2916
    _fmt = "'%(display_url)s' is already standalone."
 
2917
 
 
2918
 
 
2919
class AlreadyWithTrees(BzrDirError):
 
2920
 
 
2921
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2922
            "working trees.")
 
2923
 
 
2924
 
 
2925
class AlreadyWithNoTrees(BzrDirError):
 
2926
 
 
2927
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2928
            "working trees.")
 
2929
 
 
2930
 
 
2931
class ReconfigurationNotSupported(BzrDirError):
 
2932
 
 
2933
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2934
 
 
2935
 
 
2936
class NoBindLocation(BzrDirError):
 
2937
 
 
2938
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2939
 
 
2940
 
 
2941
class UncommittedChanges(BzrError):
 
2942
 
 
2943
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2944
            ' (See bzr status).%(more)s')
 
2945
 
 
2946
    def __init__(self, tree, more=None):
 
2947
        if more is None:
 
2948
            more = ''
 
2949
        else:
 
2950
            more = ' ' + more
 
2951
        import bzrlib.urlutils as urlutils
 
2952
        user_url = getattr(tree, "user_url", None)
 
2953
        if user_url is None:
 
2954
            display_url = str(tree)
 
2955
        else:
 
2956
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2957
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2958
 
 
2959
 
 
2960
class ShelvedChanges(UncommittedChanges):
 
2961
 
 
2962
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2963
            ' (See bzr shelve --list).%(more)s')
 
2964
 
 
2965
 
 
2966
class MissingTemplateVariable(BzrError):
 
2967
 
 
2968
    _fmt = 'Variable {%(name)s} is not available.'
 
2969
 
 
2970
    def __init__(self, name):
 
2971
        self.name = name
 
2972
 
 
2973
 
 
2974
class NoTemplate(BzrError):
 
2975
 
 
2976
    _fmt = 'No template specified.'
 
2977
 
 
2978
 
 
2979
class UnableCreateSymlink(BzrError):
 
2980
 
 
2981
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2982
 
 
2983
    def __init__(self, path=None):
 
2984
        path_str = ''
 
2985
        if path:
 
2986
            try:
 
2987
                path_str = repr(str(path))
 
2988
            except UnicodeEncodeError:
 
2989
                path_str = repr(path)
 
2990
            path_str += ' '
 
2991
        self.path_str = path_str
 
2992
 
 
2993
 
 
2994
class UnsupportedTimezoneFormat(BzrError):
 
2995
 
 
2996
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2997
            'options are "utc", "original", "local".')
 
2998
 
 
2999
    def __init__(self, timezone):
 
3000
        self.timezone = timezone
 
3001
 
 
3002
 
 
3003
class CommandAvailableInPlugin(StandardError):
 
3004
 
 
3005
    internal_error = False
 
3006
 
 
3007
    def __init__(self, cmd_name, plugin_metadata, provider):
 
3008
 
 
3009
        self.plugin_metadata = plugin_metadata
 
3010
        self.cmd_name = cmd_name
 
3011
        self.provider = provider
 
3012
 
 
3013
    def __str__(self):
 
3014
 
 
3015
        _fmt = ('"%s" is not a standard bzr command. \n'
 
3016
                'However, the following official plugin provides this command: %s\n'
 
3017
                'You can install it by going to: %s'
 
3018
                % (self.cmd_name, self.plugin_metadata['name'],
 
3019
                    self.plugin_metadata['url']))
 
3020
 
 
3021
        return _fmt
 
3022
 
 
3023
 
 
3024
class NoPluginAvailable(BzrError):
 
3025
    pass
 
3026
 
 
3027
 
 
3028
class UnableEncodePath(BzrError):
 
3029
 
 
3030
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
3031
            'user encoding %(user_encoding)s')
 
3032
 
 
3033
    def __init__(self, path, kind):
 
3034
        from bzrlib.osutils import get_user_encoding
 
3035
        self.path = path
 
3036
        self.kind = kind
 
3037
        self.user_encoding = osutils.get_user_encoding()
 
3038
 
 
3039
 
 
3040
class NoSuchConfig(BzrError):
 
3041
 
 
3042
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
3043
 
 
3044
    def __init__(self, config_id):
 
3045
        BzrError.__init__(self, config_id=config_id)
 
3046
 
 
3047
 
 
3048
class NoSuchConfigOption(BzrError):
 
3049
 
 
3050
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
3051
 
 
3052
    def __init__(self, option_name):
 
3053
        BzrError.__init__(self, option_name=option_name)
 
3054
 
 
3055
 
 
3056
class NoSuchAlias(BzrError):
 
3057
 
 
3058
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
3059
 
 
3060
    def __init__(self, alias_name):
 
3061
        BzrError.__init__(self, alias_name=alias_name)
 
3062
 
 
3063
 
 
3064
class DirectoryLookupFailure(BzrError):
 
3065
    """Base type for lookup errors."""
 
3066
 
 
3067
    pass
 
3068
 
 
3069
 
 
3070
class InvalidLocationAlias(DirectoryLookupFailure):
 
3071
 
 
3072
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
3073
 
 
3074
    def __init__(self, alias_name):
 
3075
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
3076
 
 
3077
 
 
3078
class UnsetLocationAlias(DirectoryLookupFailure):
 
3079
 
 
3080
    _fmt = 'No %(alias_name)s location assigned.'
 
3081
 
 
3082
    def __init__(self, alias_name):
 
3083
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
3084
 
 
3085
 
 
3086
class CannotBindAddress(BzrError):
 
3087
 
 
3088
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
3089
 
 
3090
    def __init__(self, host, port, orig_error):
 
3091
        # nb: in python2.4 socket.error doesn't have a useful repr
 
3092
        BzrError.__init__(self, host=host, port=port,
 
3093
            orig_error=repr(orig_error.args))
 
3094
 
 
3095
 
 
3096
class UnknownRules(BzrError):
 
3097
 
 
3098
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
3099
 
 
3100
    def __init__(self, unknowns):
 
3101
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
3102
 
 
3103
 
 
3104
class HookFailed(BzrError):
 
3105
    """Raised when a pre_change_branch_tip hook function fails anything other
 
3106
    than TipChangeRejected.
 
3107
 
 
3108
    Note that this exception is no longer raised, and the import is only left
 
3109
    to be nice to code which might catch it in a plugin.
 
3110
    """
 
3111
 
 
3112
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
3113
            "%(traceback_text)s%(exc_value)s")
 
3114
 
 
3115
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
3116
        if warn:
 
3117
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
3118
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
3119
        import traceback
 
3120
        self.hook_stage = hook_stage
 
3121
        self.hook_name = hook_name
 
3122
        self.exc_info = exc_info
 
3123
        self.exc_type = exc_info[0]
 
3124
        self.exc_value = exc_info[1]
 
3125
        self.exc_tb = exc_info[2]
 
3126
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
3127
 
 
3128
 
 
3129
class TipChangeRejected(BzrError):
 
3130
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3131
    explicitly abort a change to a branch tip.
 
3132
    """
 
3133
 
 
3134
    _fmt = u"Tip change rejected: %(msg)s"
 
3135
 
 
3136
    def __init__(self, msg):
 
3137
        self.msg = msg
 
3138
 
 
3139
 
 
3140
class ShelfCorrupt(BzrError):
 
3141
 
 
3142
    _fmt = "Shelf corrupt."
 
3143
 
 
3144
 
 
3145
class DecompressCorruption(BzrError):
 
3146
 
 
3147
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3148
 
 
3149
    def __init__(self, orig_error=None):
 
3150
        if orig_error is not None:
 
3151
            self.orig_error = ", %s" % (orig_error,)
 
3152
        else:
 
3153
            self.orig_error = ""
 
3154
        BzrError.__init__(self)
 
3155
 
 
3156
 
 
3157
class NoSuchShelfId(BzrError):
 
3158
 
 
3159
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3160
 
 
3161
    def __init__(self, shelf_id):
 
3162
        BzrError.__init__(self, shelf_id=shelf_id)
 
3163
 
 
3164
 
 
3165
class InvalidShelfId(BzrError):
 
3166
 
 
3167
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3168
 
 
3169
    def __init__(self, invalid_id):
 
3170
        BzrError.__init__(self, invalid_id=invalid_id)
 
3171
 
 
3172
 
 
3173
class JailBreak(BzrError):
 
3174
 
 
3175
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3176
 
 
3177
    def __init__(self, url):
 
3178
        BzrError.__init__(self, url=url)
 
3179
 
 
3180
 
 
3181
class UserAbort(BzrError):
 
3182
 
 
3183
    _fmt = 'The user aborted the operation.'
 
3184
 
 
3185
 
 
3186
class MustHaveWorkingTree(BzrError):
 
3187
 
 
3188
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3189
 
 
3190
    def __init__(self, format, url):
 
3191
        BzrError.__init__(self, format=format, url=url)
 
3192
 
 
3193
 
 
3194
class NoSuchView(BzrError):
 
3195
    """A view does not exist.
 
3196
    """
 
3197
 
 
3198
    _fmt = u"No such view: %(view_name)s."
 
3199
 
 
3200
    def __init__(self, view_name):
 
3201
        self.view_name = view_name
 
3202
 
 
3203
 
 
3204
class ViewsNotSupported(BzrError):
 
3205
    """Views are not supported by a tree format.
 
3206
    """
 
3207
 
 
3208
    _fmt = ("Views are not supported by %(tree)s;"
 
3209
            " use 'bzr upgrade' to change your tree to a later format.")
 
3210
 
 
3211
    def __init__(self, tree):
 
3212
        self.tree = tree
 
3213
 
 
3214
 
 
3215
class FileOutsideView(BzrError):
 
3216
 
 
3217
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3218
            '%(view_str)s')
 
3219
 
 
3220
    def __init__(self, file_name, view_files):
 
3221
        self.file_name = file_name
 
3222
        self.view_str = ", ".join(view_files)
 
3223
 
 
3224
 
 
3225
class UnresumableWriteGroup(BzrError):
 
3226
 
 
3227
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3228
            "%(write_groups)r: %(reason)s")
 
3229
 
 
3230
    internal_error = True
 
3231
 
 
3232
    def __init__(self, repository, write_groups, reason):
 
3233
        self.repository = repository
 
3234
        self.write_groups = write_groups
 
3235
        self.reason = reason
 
3236
 
 
3237
 
 
3238
class UnsuspendableWriteGroup(BzrError):
 
3239
 
 
3240
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3241
 
 
3242
    internal_error = True
 
3243
 
 
3244
    def __init__(self, repository):
 
3245
        self.repository = repository
 
3246
 
 
3247
 
 
3248
class LossyPushToSameVCS(BzrError):
 
3249
 
 
3250
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3251
            "%(target_branch)r that are in the same VCS.")
 
3252
 
 
3253
    internal_error = True
 
3254
 
 
3255
    def __init__(self, source_branch, target_branch):
 
3256
        self.source_branch = source_branch
 
3257
        self.target_branch = target_branch
 
3258
 
 
3259
 
 
3260
class NoRoundtrippingSupport(BzrError):
 
3261
 
 
3262
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3263
            "%(target_branch)r.")
 
3264
 
 
3265
    internal_error = True
 
3266
 
 
3267
    def __init__(self, source_branch, target_branch):
 
3268
        self.source_branch = source_branch
 
3269
        self.target_branch = target_branch
 
3270
 
 
3271
 
 
3272
class FileTimestampUnavailable(BzrError):
 
3273
 
 
3274
    _fmt = "The filestamp for %(path)s is not available."
 
3275
 
 
3276
    internal_error = True
 
3277
 
 
3278
    def __init__(self, path):
 
3279
        self.path = path
 
3280
 
 
3281
 
 
3282
class NoColocatedBranchSupport(BzrError):
 
3283
 
 
3284
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3285
 
 
3286
    def __init__(self, bzrdir):
 
3287
        self.bzrdir = bzrdir
 
3288
 
 
3289
 
 
3290
class NoWhoami(BzrError):
 
3291
 
 
3292
    _fmt = ('Unable to determine your name.\n'
 
3293
        "Please, set your name with the 'whoami' command.\n"
 
3294
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3295
 
 
3296
 
 
3297
class InvalidPattern(BzrError):
 
3298
 
 
3299
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3300
 
 
3301
    def __init__(self, msg):
 
3302
        self.msg = msg
 
3303
 
 
3304
 
 
3305
class RecursiveBind(BzrError):
 
3306
 
 
3307
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3308
        'Please use `bzr unbind` to fix.')
 
3309
 
 
3310
    def __init__(self, branch_url):
 
3311
        self.branch_url = branch_url
 
3312
 
 
3313
 
 
3314
# FIXME: I would prefer to define the config related exception classes in
 
3315
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3316
class OptionExpansionLoop(BzrError):
 
3317
 
 
3318
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3319
 
 
3320
    def __init__(self, string, refs):
 
3321
        self.string = string
 
3322
        self.refs = '->'.join(refs)
 
3323
 
 
3324
 
 
3325
class ExpandingUnknownOption(BzrError):
 
3326
 
 
3327
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3328
 
 
3329
    def __init__(self, name, string):
 
3330
        self.name = name
 
3331
        self.string = string
 
3332
 
 
3333
 
 
3334
class NoCompatibleInter(BzrError):
 
3335
 
 
3336
    _fmt = ('No compatible object available for operations from %(source)r '
 
3337
            'to %(target)r.')
 
3338
 
 
3339
    def __init__(self, source, target):
 
3340
        self.source = source
 
3341
        self.target = target
 
3342
 
 
3343
 
 
3344
class HpssVfsRequestNotAllowed(BzrError):
 
3345
 
 
3346
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3347
            "%(method)s, %(arguments)s.")
 
3348
 
 
3349
    def __init__(self, method, arguments):
 
3350
        self.method = method
 
3351
        self.arguments = arguments
 
3352
 
 
3353
 
 
3354
class UnsupportedKindChange(BzrError):
 
3355
 
 
3356
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3357
            "%(path)s not supported by format %(format)r")
 
3358
 
 
3359
    def __init__(self, path, from_kind, to_kind, format):
 
3360
        self.path = path
 
3361
        self.from_kind = from_kind
 
3362
        self.to_kind = to_kind
 
3363
        self.format = format
 
3364
 
 
3365
 
 
3366
class PatchSyntax(BzrError):
 
3367
    """Base class for patch syntax errors."""
 
3368
 
 
3369
 
 
3370
class BinaryFiles(BzrError):
 
3371
 
 
3372
    _fmt = 'Binary files section encountered.'
 
3373
 
 
3374
    def __init__(self, orig_name, mod_name):
 
3375
        self.orig_name = orig_name
 
3376
        self.mod_name = mod_name
 
3377
 
 
3378
 
 
3379
class MalformedPatchHeader(PatchSyntax):
 
3380
 
 
3381
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3382
 
 
3383
    def __init__(self, desc, line):
 
3384
        self.desc = desc
 
3385
        self.line = line
 
3386
 
 
3387
 
 
3388
class MalformedHunkHeader(PatchSyntax):
 
3389
 
 
3390
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3391
 
 
3392
    def __init__(self, desc, line):
 
3393
        self.desc = desc
 
3394
        self.line = line
 
3395
 
 
3396
 
 
3397
class MalformedLine(PatchSyntax):
 
3398
 
 
3399
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3400
 
 
3401
    def __init__(self, desc, line):
 
3402
        self.desc = desc
 
3403
        self.line = line
 
3404
 
 
3405
 
 
3406
class PatchConflict(BzrError):
 
3407
 
 
3408
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3409
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3410
 
 
3411
    def __init__(self, line_no, orig_line, patch_line):
 
3412
        self.line_no = line_no
 
3413
        self.orig_line = orig_line.rstrip('\n')
 
3414
        self.patch_line = patch_line.rstrip('\n')