/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: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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