/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: Jelmer Vernooij
  • Date: 2011-12-19 10:58:39 UTC
  • mfrom: (6383 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219105839-uji05ck4rkm1mj4j
Merge bzr.dev.

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