~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2009-06-10 02:22:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090610022258-czra1150uv22976i
textwrap break_on_hyphens option is not available in python2.5

Show diffs side-by-side

added added

removed removed

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