/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: John Arbash Meinel
  • Date: 2010-08-02 17:16:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5369.
  • Revision ID: john@arbash-meinel.com-20100802171612-rdh5ods70w2bl3j7
We also have to re-implement it for _simple_set_pyx.pyx

Show diffs side-by-side

added added

removed removed

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