/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert J. Tanner
  • Date: 2009-06-10 03:56:49 UTC
  • mfrom: (4423 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4425.
  • Revision ID: tanner@real-time.com-20090610035649-7rfx4cls4550zc3c
Merge 1.15.1 back to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
19
 
__author__ = "Martin Pool <mbp@canonical.com>"
20
 
 
21
 
 
22
 
######################################################################
23
 
# exceptions 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
from bzrlib import (
 
21
    osutils,
 
22
    symbol_versioning,
 
23
    )
 
24
from bzrlib.patches import (
 
25
    MalformedHunkHeader,
 
26
    MalformedLine,
 
27
    MalformedPatchHeader,
 
28
    PatchConflict,
 
29
    PatchSyntax,
 
30
    )
 
31
 
 
32
 
 
33
# TODO: is there any value in providing the .args field used by standard
 
34
# python exceptions?   A list of values with no names seems less useful
 
35
# to me.
 
36
 
 
37
# TODO: Perhaps convert the exception to a string at the moment it's
 
38
# constructed to make sure it will succeed.  But that says nothing about
 
39
# exceptions that are never raised.
 
40
 
 
41
# TODO: selftest assertRaises should probably also check that every error
 
42
# raised can be formatted as a string successfully, and without giving
 
43
# 'unprintable'.
 
44
 
 
45
 
 
46
# return codes from the bzr program
 
47
EXIT_OK = 0
 
48
EXIT_ERROR = 3
 
49
EXIT_INTERNAL_ERROR = 4
 
50
 
 
51
 
24
52
class BzrError(StandardError):
25
 
    def __str__(self):
26
 
        if len(self.args) == 1:
27
 
            return self.args[0]
28
 
        elif len(self.args) == 2:
29
 
            # further explanation or suggestions
30
 
            return '\n  '.join([self.args[0]] + self.args[1])
31
 
        else:
32
 
            return `self.args`
33
 
 
34
 
 
35
 
class BzrCheckError(BzrError):
36
 
    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
37
274
 
38
275
 
39
276
class InvalidRevisionNumber(BzrError):
40
 
    def __str__(self):
41
 
        return 'invalid revision number: %r' % self.args[0]
 
277
 
 
278
    _fmt = "Invalid revision number %(revno)s"
 
279
 
 
280
    def __init__(self, revno):
 
281
        BzrError.__init__(self)
 
282
        self.revno = revno
42
283
 
43
284
 
44
285
class InvalidRevisionId(BzrError):
45
 
    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
46
390
 
47
391
 
48
392
class BzrCommandError(BzrError):
49
 
    # Error from malformed user command
50
 
    pass
51
 
 
52
 
 
53
 
class NotBranchError(BzrError):
54
 
    """Specified path is not in a branch"""
55
 
    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 + ". "
56
826
 
57
827
 
58
828
class NotVersionedError(BzrError):
59
 
    """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 = ''
60
878
 
61
879
 
62
880
class BadFileKindError(BzrError):
63
 
    """Specified file is of a kind that cannot be added.
64
 
 
65
 
    (For example a symlink or device file.)"""
66
 
    pass
67
 
 
68
 
 
69
 
class ForbiddenFileError(BzrError):
70
 
    """Cannot operate on a file because it is a control file."""
71
 
    pass
72
 
 
73
 
 
74
 
class LockError(Exception):
75
 
    """All exceptions from the lock/unlock functions should be from
76
 
    this exception class.  They will be translated as necessary. The
77
 
    original exception is available as e.original_error
78
 
    """
79
 
    def __init__(self, e=None):
80
 
        self.original_error = e
81
 
        if e:
82
 
            Exception.__init__(self, e)
83
 
        else:
84
 
            Exception.__init__(self)
85
 
 
86
 
 
87
 
class PointlessCommit(Exception):
88
 
    """Commit failed because nothing was changed."""
89
 
 
90
 
 
91
 
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
 
92
1114
    def __init__(self, branch, revision):
93
 
        self.branch = branch
94
 
        self.revision = revision
95
 
        msg = "Branch %s has no revision %s" % (branch, revision)
96
 
        BzrError.__init__(self, msg)
 
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 = ''
97
1154
 
98
1155
 
99
1156
class HistoryMissing(BzrError):
100
 
    def __init__(self, branch, object_type, object_id):
101
 
        self.branch = branch
102
 
        BzrError.__init__(self,
103
 
                          '%s is missing %s {%s}'
104
 
                          % (branch, object_type, object_id))
 
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)
105
1171
 
106
1172
 
107
1173
class DivergedBranches(BzrError):
 
1174
 
 
1175
    _fmt = ("These branches have diverged."
 
1176
            " Use the missing command to see how.\n"
 
1177
            "Use the merge command to reconcile them.")
 
1178
 
108
1179
    def __init__(self, branch1, branch2):
109
 
        BzrError.__init__(self, "These branches have diverged.")
110
1180
        self.branch1 = branch1
111
1181
        self.branch2 = branch2
112
1182
 
113
1183
 
114
 
class UnrelatedBranches(BzrCommandError):
115
 
    def __init__(self):
116
 
        msg = "Branches have no common ancestor, and no base revision"\
117
 
            " specified."
118
 
        BzrCommandError.__init__(self, msg)
 
1184
class NotLefthandHistory(InternalBzrError):
 
1185
 
 
1186
    _fmt = "Supplied history does not follow left-hand parents"
 
1187
 
 
1188
    def __init__(self, history):
 
1189
        BzrError.__init__(self, history=history)
 
1190
 
 
1191
 
 
1192
class UnrelatedBranches(BzrError):
 
1193
 
 
1194
    _fmt = ("Branches have no common ancestor, and"
 
1195
            " no merge base revision was specified.")
 
1196
 
 
1197
 
 
1198
class CannotReverseCherrypick(BzrError):
 
1199
 
 
1200
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1201
            ' or diff3.')
 
1202
 
119
1203
 
120
1204
class NoCommonAncestor(BzrError):
 
1205
 
 
1206
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1207
 
121
1208
    def __init__(self, revision_a, revision_b):
122
 
        msg = "Revisions have no common ancestor: %s %s." \
123
 
            % (revision_a, revision_b) 
124
 
        BzrError.__init__(self, msg)
 
1209
        self.revision_a = revision_a
 
1210
        self.revision_b = revision_b
 
1211
 
125
1212
 
126
1213
class NoCommonRoot(BzrError):
 
1214
 
 
1215
    _fmt = ("Revisions are not derived from the same root: "
 
1216
           "%(revision_a)s %(revision_b)s.")
 
1217
 
127
1218
    def __init__(self, revision_a, revision_b):
128
 
        msg = "Revisions are not derived from the same root: %s %s." \
129
 
            % (revision_a, revision_b) 
130
 
        BzrError.__init__(self, msg)
 
1219
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1220
 
131
1221
 
132
1222
class NotAncestor(BzrError):
 
1223
 
 
1224
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1225
 
133
1226
    def __init__(self, rev_id, not_ancestor_id):
134
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
135
 
                                                        rev_id)
136
 
        BzrError.__init__(self, msg)
137
 
        self.rev_id = rev_id
138
 
        self.not_ancestor_id = not_ancestor_id
139
 
 
140
 
 
141
 
class InstallFailed(BzrError):
142
 
    def __init__(self, revisions):
143
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
144
 
        BzrError.__init__(self, msg)
145
 
        self.revisions = revisions
 
1227
        BzrError.__init__(self, rev_id=rev_id,
 
1228
            not_ancestor_id=not_ancestor_id)
146
1229
 
147
1230
 
148
1231
class AmbiguousBase(BzrError):
 
1232
 
149
1233
    def __init__(self, bases):
150
 
        msg = "The correct base is unclear, becase %s are all equally close" %\
151
 
            ", ".join(bases)
 
1234
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1235
                DeprecationWarning)
 
1236
        msg = ("The correct base is unclear, because %s are all equally close"
 
1237
                % ", ".join(bases))
152
1238
        BzrError.__init__(self, msg)
153
1239
        self.bases = bases
154
1240
 
155
 
class NoCommits(BzrError):
156
 
    def __init__(self, branch):
157
 
        msg = "Branch %s has no commits." % branch
158
 
        BzrError.__init__(self, msg)
 
1241
 
 
1242
class NoCommits(BranchError):
 
1243
 
 
1244
    _fmt = "Branch %(branch)s has no commits."
 
1245
 
 
1246
 
 
1247
class UnlistableStore(BzrError):
 
1248
 
 
1249
    def __init__(self, store):
 
1250
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1251
 
 
1252
 
 
1253
 
 
1254
class UnlistableBranch(BzrError):
 
1255
 
 
1256
    def __init__(self, br):
 
1257
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1258
 
 
1259
 
 
1260
class BoundBranchOutOfDate(BzrError):
 
1261
 
 
1262
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1263
            " %(master)s.")
 
1264
 
 
1265
    def __init__(self, branch, master):
 
1266
        BzrError.__init__(self)
 
1267
        self.branch = branch
 
1268
        self.master = master
 
1269
 
 
1270
 
 
1271
class CommitToDoubleBoundBranch(BzrError):
 
1272
 
 
1273
    _fmt = ("Cannot commit to branch %(branch)s."
 
1274
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1275
 
 
1276
    def __init__(self, branch, master, remote):
 
1277
        BzrError.__init__(self)
 
1278
        self.branch = branch
 
1279
        self.master = master
 
1280
        self.remote = remote
 
1281
 
 
1282
 
 
1283
class OverwriteBoundBranch(BzrError):
 
1284
 
 
1285
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1286
 
 
1287
    def __init__(self, branch):
 
1288
        BzrError.__init__(self)
 
1289
        self.branch = branch
 
1290
 
 
1291
 
 
1292
class BoundBranchConnectionFailure(BzrError):
 
1293
 
 
1294
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1295
            " => %(target)s: %(error)s")
 
1296
 
 
1297
    def __init__(self, branch, target, error):
 
1298
        BzrError.__init__(self)
 
1299
        self.branch = branch
 
1300
        self.target = target
 
1301
        self.error = error
 
1302
 
 
1303
 
 
1304
class WeaveError(BzrError):
 
1305
 
 
1306
    _fmt = "Error in processing weave: %(msg)s"
 
1307
 
 
1308
    def __init__(self, msg=None):
 
1309
        BzrError.__init__(self)
 
1310
        self.msg = msg
 
1311
 
 
1312
 
 
1313
class WeaveRevisionAlreadyPresent(WeaveError):
 
1314
 
 
1315
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1316
 
 
1317
    def __init__(self, revision_id, weave):
 
1318
 
 
1319
        WeaveError.__init__(self)
 
1320
        self.revision_id = revision_id
 
1321
        self.weave = weave
 
1322
 
 
1323
 
 
1324
class WeaveRevisionNotPresent(WeaveError):
 
1325
 
 
1326
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1327
 
 
1328
    def __init__(self, revision_id, weave):
 
1329
        WeaveError.__init__(self)
 
1330
        self.revision_id = revision_id
 
1331
        self.weave = weave
 
1332
 
 
1333
 
 
1334
class WeaveFormatError(WeaveError):
 
1335
 
 
1336
    _fmt = "Weave invariant violated: %(what)s"
 
1337
 
 
1338
    def __init__(self, what):
 
1339
        WeaveError.__init__(self)
 
1340
        self.what = what
 
1341
 
 
1342
 
 
1343
class WeaveParentMismatch(WeaveError):
 
1344
 
 
1345
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1346
 
 
1347
 
 
1348
class WeaveInvalidChecksum(WeaveError):
 
1349
 
 
1350
    _fmt = "Text did not match it's checksum: %(message)s"
 
1351
 
 
1352
 
 
1353
class WeaveTextDiffers(WeaveError):
 
1354
 
 
1355
    _fmt = ("Weaves differ on text content. Revision:"
 
1356
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1357
 
 
1358
    def __init__(self, revision_id, weave_a, weave_b):
 
1359
        WeaveError.__init__(self)
 
1360
        self.revision_id = revision_id
 
1361
        self.weave_a = weave_a
 
1362
        self.weave_b = weave_b
 
1363
 
 
1364
 
 
1365
class WeaveTextDiffers(WeaveError):
 
1366
 
 
1367
    _fmt = ("Weaves differ on text content. Revision:"
 
1368
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1369
 
 
1370
    def __init__(self, revision_id, weave_a, weave_b):
 
1371
        WeaveError.__init__(self)
 
1372
        self.revision_id = revision_id
 
1373
        self.weave_a = weave_a
 
1374
        self.weave_b = weave_b
 
1375
 
 
1376
 
 
1377
class VersionedFileError(BzrError):
 
1378
 
 
1379
    _fmt = "Versioned file error"
 
1380
 
 
1381
 
 
1382
class RevisionNotPresent(VersionedFileError):
 
1383
 
 
1384
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1385
 
 
1386
    def __init__(self, revision_id, file_id):
 
1387
        VersionedFileError.__init__(self)
 
1388
        self.revision_id = revision_id
 
1389
        self.file_id = file_id
 
1390
 
 
1391
 
 
1392
class RevisionAlreadyPresent(VersionedFileError):
 
1393
 
 
1394
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1395
 
 
1396
    def __init__(self, revision_id, file_id):
 
1397
        VersionedFileError.__init__(self)
 
1398
        self.revision_id = revision_id
 
1399
        self.file_id = file_id
 
1400
 
 
1401
 
 
1402
class VersionedFileInvalidChecksum(VersionedFileError):
 
1403
 
 
1404
    _fmt = "Text did not match its checksum: %(message)s"
 
1405
 
 
1406
 
 
1407
class KnitError(InternalBzrError):
 
1408
 
 
1409
    _fmt = "Knit error"
 
1410
 
 
1411
 
 
1412
class KnitCorrupt(KnitError):
 
1413
 
 
1414
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1415
 
 
1416
    def __init__(self, filename, how):
 
1417
        KnitError.__init__(self)
 
1418
        self.filename = filename
 
1419
        self.how = how
 
1420
 
 
1421
 
 
1422
class SHA1KnitCorrupt(KnitCorrupt):
 
1423
 
 
1424
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1425
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1426
        "sha %(actual)s")
 
1427
 
 
1428
    def __init__(self, filename, actual, expected, key, content):
 
1429
        KnitError.__init__(self)
 
1430
        self.filename = filename
 
1431
        self.actual = actual
 
1432
        self.expected = expected
 
1433
        self.key = key
 
1434
        self.content = content
 
1435
 
 
1436
 
 
1437
class KnitDataStreamIncompatible(KnitError):
 
1438
    # Not raised anymore, as we can convert data streams.  In future we may
 
1439
    # need it again for more exotic cases, so we're keeping it around for now.
 
1440
 
 
1441
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1442
 
 
1443
    def __init__(self, stream_format, target_format):
 
1444
        self.stream_format = stream_format
 
1445
        self.target_format = target_format
 
1446
 
 
1447
 
 
1448
class KnitDataStreamUnknown(KnitError):
 
1449
    # Indicates a data stream we don't know how to handle.
 
1450
 
 
1451
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1452
 
 
1453
    def __init__(self, stream_format):
 
1454
        self.stream_format = stream_format
 
1455
 
 
1456
 
 
1457
class KnitHeaderError(KnitError):
 
1458
 
 
1459
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1460
 
 
1461
    def __init__(self, badline, filename):
 
1462
        KnitError.__init__(self)
 
1463
        self.badline = badline
 
1464
        self.filename = filename
 
1465
 
 
1466
class KnitIndexUnknownMethod(KnitError):
 
1467
    """Raised when we don't understand the storage method.
 
1468
 
 
1469
    Currently only 'fulltext' and 'line-delta' are supported.
 
1470
    """
 
1471
 
 
1472
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1473
            " in options: %(options)r")
 
1474
 
 
1475
    def __init__(self, filename, options):
 
1476
        KnitError.__init__(self)
 
1477
        self.filename = filename
 
1478
        self.options = options
 
1479
 
 
1480
 
 
1481
class RetryWithNewPacks(BzrError):
 
1482
    """Raised when we realize that the packs on disk have changed.
 
1483
 
 
1484
    This is meant as more of a signaling exception, to trap between where a
 
1485
    local error occurred and the code that can actually handle the error and
 
1486
    code that can retry appropriately.
 
1487
    """
 
1488
 
 
1489
    internal_error = True
 
1490
 
 
1491
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1492
            " %(orig_error)s")
 
1493
 
 
1494
    def __init__(self, context, reload_occurred, exc_info):
 
1495
        """create a new RetryWithNewPacks error.
 
1496
 
 
1497
        :param reload_occurred: Set to True if we know that the packs have
 
1498
            already been reloaded, and we are failing because of an in-memory
 
1499
            cache miss. If set to True then we will ignore if a reload says
 
1500
            nothing has changed, because we assume it has already reloaded. If
 
1501
            False, then a reload with nothing changed will force an error.
 
1502
        :param exc_info: The original exception traceback, so if there is a
 
1503
            problem we can raise the original error (value from sys.exc_info())
 
1504
        """
 
1505
        BzrError.__init__(self)
 
1506
        self.reload_occurred = reload_occurred
 
1507
        self.exc_info = exc_info
 
1508
        self.orig_error = exc_info[1]
 
1509
        # TODO: The global error handler should probably treat this by
 
1510
        #       raising/printing the original exception with a bit about
 
1511
        #       RetryWithNewPacks also not being caught
 
1512
 
 
1513
 
 
1514
class RetryAutopack(RetryWithNewPacks):
 
1515
    """Raised when we are autopacking and we find a missing file.
 
1516
 
 
1517
    Meant as a signaling exception, to tell the autopack code it should try
 
1518
    again.
 
1519
    """
 
1520
 
 
1521
    internal_error = True
 
1522
 
 
1523
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1524
            " context: %(context)s %(orig_error)s")
 
1525
 
 
1526
 
 
1527
class NoSuchExportFormat(BzrError):
 
1528
 
 
1529
    _fmt = "Export format %(format)r not supported"
 
1530
 
 
1531
    def __init__(self, format):
 
1532
        BzrError.__init__(self)
 
1533
        self.format = format
 
1534
 
 
1535
 
 
1536
class TransportError(BzrError):
 
1537
 
 
1538
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1539
 
 
1540
    def __init__(self, msg=None, orig_error=None):
 
1541
        if msg is None and orig_error is not None:
 
1542
            msg = str(orig_error)
 
1543
        if orig_error is None:
 
1544
            orig_error = ''
 
1545
        if msg is None:
 
1546
            msg =  ''
 
1547
        self.msg = msg
 
1548
        self.orig_error = orig_error
 
1549
        BzrError.__init__(self)
 
1550
 
 
1551
 
 
1552
class TooManyConcurrentRequests(InternalBzrError):
 
1553
 
 
1554
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1555
            " Be sure to finish_writing and finish_reading on the"
 
1556
            " currently open request.")
 
1557
 
 
1558
    def __init__(self, medium):
 
1559
        self.medium = medium
 
1560
 
 
1561
 
 
1562
class SmartProtocolError(TransportError):
 
1563
 
 
1564
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1565
 
 
1566
    def __init__(self, details):
 
1567
        self.details = details
 
1568
 
 
1569
 
 
1570
class UnexpectedProtocolVersionMarker(TransportError):
 
1571
 
 
1572
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1573
 
 
1574
    def __init__(self, marker):
 
1575
        self.marker = marker
 
1576
 
 
1577
 
 
1578
class UnknownSmartMethod(InternalBzrError):
 
1579
 
 
1580
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1581
 
 
1582
    def __init__(self, verb):
 
1583
        self.verb = verb
 
1584
 
 
1585
 
 
1586
class SmartMessageHandlerError(InternalBzrError):
 
1587
 
 
1588
    _fmt = ("The message handler raised an exception:\n"
 
1589
            "%(traceback_text)s")
 
1590
 
 
1591
    def __init__(self, exc_info):
 
1592
        import traceback
 
1593
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1594
        self.exc_info = exc_info
 
1595
        traceback_strings = traceback.format_exception(
 
1596
                self.exc_type, self.exc_value, self.exc_tb)
 
1597
        self.traceback_text = ''.join(traceback_strings)
 
1598
 
 
1599
 
 
1600
# A set of semi-meaningful errors which can be thrown
 
1601
class TransportNotPossible(TransportError):
 
1602
 
 
1603
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1604
 
 
1605
 
 
1606
class ConnectionError(TransportError):
 
1607
 
 
1608
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1609
 
 
1610
 
 
1611
class SocketConnectionError(ConnectionError):
 
1612
 
 
1613
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1614
 
 
1615
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1616
        if msg is None:
 
1617
            msg = 'Failed to connect to'
 
1618
        if orig_error is None:
 
1619
            orig_error = ''
 
1620
        else:
 
1621
            orig_error = '; ' + str(orig_error)
 
1622
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1623
        self.host = host
 
1624
        if port is None:
 
1625
            self.port = ''
 
1626
        else:
 
1627
            self.port = ':%s' % port
 
1628
 
 
1629
 
 
1630
# XXX: This is also used for unexpected end of file, which is different at the
 
1631
# TCP level from "connection reset".
 
1632
class ConnectionReset(TransportError):
 
1633
 
 
1634
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1635
 
 
1636
 
 
1637
class InvalidRange(TransportError):
 
1638
 
 
1639
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1640
 
 
1641
    def __init__(self, path, offset, msg=None):
 
1642
        TransportError.__init__(self, msg)
 
1643
        self.path = path
 
1644
        self.offset = offset
 
1645
 
 
1646
 
 
1647
class InvalidHttpResponse(TransportError):
 
1648
 
 
1649
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1650
 
 
1651
    def __init__(self, path, msg, orig_error=None):
 
1652
        self.path = path
 
1653
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1654
 
 
1655
 
 
1656
class InvalidHttpRange(InvalidHttpResponse):
 
1657
 
 
1658
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1659
 
 
1660
    def __init__(self, path, range, msg):
 
1661
        self.range = range
 
1662
        InvalidHttpResponse.__init__(self, path, msg)
 
1663
 
 
1664
 
 
1665
class InvalidHttpContentType(InvalidHttpResponse):
 
1666
 
 
1667
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1668
 
 
1669
    def __init__(self, path, ctype, msg):
 
1670
        self.ctype = ctype
 
1671
        InvalidHttpResponse.__init__(self, path, msg)
 
1672
 
 
1673
 
 
1674
class RedirectRequested(TransportError):
 
1675
 
 
1676
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1677
 
 
1678
    def __init__(self, source, target, is_permanent=False):
 
1679
        self.source = source
 
1680
        self.target = target
 
1681
        if is_permanent:
 
1682
            self.permanently = ' permanently'
 
1683
        else:
 
1684
            self.permanently = ''
 
1685
        TransportError.__init__(self)
 
1686
 
 
1687
 
 
1688
class TooManyRedirections(TransportError):
 
1689
 
 
1690
    _fmt = "Too many redirections"
 
1691
 
 
1692
 
 
1693
class ConflictsInTree(BzrError):
 
1694
 
 
1695
    _fmt = "Working tree has conflicts."
 
1696
 
 
1697
 
 
1698
class ParseConfigError(BzrError):
 
1699
 
 
1700
    def __init__(self, errors, filename):
 
1701
        if filename is None:
 
1702
            filename = ""
 
1703
        message = "Error(s) parsing config file %s:\n%s" % \
 
1704
            (filename, ('\n'.join(e.msg for e in errors)))
 
1705
        BzrError.__init__(self, message)
 
1706
 
 
1707
 
 
1708
class NoEmailInUsername(BzrError):
 
1709
 
 
1710
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1711
 
 
1712
    def __init__(self, username):
 
1713
        BzrError.__init__(self)
 
1714
        self.username = username
 
1715
 
 
1716
 
 
1717
class SigningFailed(BzrError):
 
1718
 
 
1719
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1720
 
 
1721
    def __init__(self, command_line):
 
1722
        BzrError.__init__(self, command_line=command_line)
 
1723
 
 
1724
 
 
1725
class WorkingTreeNotRevision(BzrError):
 
1726
 
 
1727
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1728
            " the last commit, but weave merge requires that it be"
 
1729
            " unchanged")
 
1730
 
 
1731
    def __init__(self, tree):
 
1732
        BzrError.__init__(self, basedir=tree.basedir)
 
1733
 
 
1734
 
 
1735
class CantReprocessAndShowBase(BzrError):
 
1736
 
 
1737
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1738
           "the relationship of conflicting lines to the base")
 
1739
 
 
1740
 
 
1741
class GraphCycleError(BzrError):
 
1742
 
 
1743
    _fmt = "Cycle in graph %(graph)r"
 
1744
 
 
1745
    def __init__(self, graph):
 
1746
        BzrError.__init__(self)
 
1747
        self.graph = graph
 
1748
 
 
1749
 
 
1750
class WritingCompleted(InternalBzrError):
 
1751
 
 
1752
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1753
            "called upon it - accept bytes may not be called anymore.")
 
1754
 
 
1755
    def __init__(self, request):
 
1756
        self.request = request
 
1757
 
 
1758
 
 
1759
class WritingNotComplete(InternalBzrError):
 
1760
 
 
1761
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1762
            "called upon it - until the write phase is complete no "
 
1763
            "data may be read.")
 
1764
 
 
1765
    def __init__(self, request):
 
1766
        self.request = request
 
1767
 
 
1768
 
 
1769
class NotConflicted(BzrError):
 
1770
 
 
1771
    _fmt = "File %(filename)s is not conflicted."
 
1772
 
 
1773
    def __init__(self, filename):
 
1774
        BzrError.__init__(self)
 
1775
        self.filename = filename
 
1776
 
 
1777
 
 
1778
class MediumNotConnected(InternalBzrError):
 
1779
 
 
1780
    _fmt = """The medium '%(medium)s' is not connected."""
 
1781
 
 
1782
    def __init__(self, medium):
 
1783
        self.medium = medium
 
1784
 
 
1785
 
 
1786
class MustUseDecorated(Exception):
 
1787
 
 
1788
    _fmt = "A decorating function has requested its original command be used."
 
1789
 
 
1790
 
 
1791
class NoBundleFound(BzrError):
 
1792
 
 
1793
    _fmt = 'No bundle was found in "%(filename)s".'
 
1794
 
 
1795
    def __init__(self, filename):
 
1796
        BzrError.__init__(self)
 
1797
        self.filename = filename
 
1798
 
 
1799
 
 
1800
class BundleNotSupported(BzrError):
 
1801
 
 
1802
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1803
 
 
1804
    def __init__(self, version, msg):
 
1805
        BzrError.__init__(self)
 
1806
        self.version = version
 
1807
        self.msg = msg
 
1808
 
 
1809
 
 
1810
class MissingText(BzrError):
 
1811
 
 
1812
    _fmt = ("Branch %(base)s is missing revision"
 
1813
            " %(text_revision)s of %(file_id)s")
 
1814
 
 
1815
    def __init__(self, branch, text_revision, file_id):
 
1816
        BzrError.__init__(self)
 
1817
        self.branch = branch
 
1818
        self.base = branch.base
 
1819
        self.text_revision = text_revision
 
1820
        self.file_id = file_id
 
1821
 
 
1822
 
 
1823
class DuplicateFileId(BzrError):
 
1824
 
 
1825
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1826
 
 
1827
    def __init__(self, file_id, entry):
 
1828
        BzrError.__init__(self)
 
1829
        self.file_id = file_id
 
1830
        self.entry = entry
 
1831
 
 
1832
 
 
1833
class DuplicateKey(BzrError):
 
1834
 
 
1835
    _fmt = "Key %(key)s is already present in map"
 
1836
 
 
1837
 
 
1838
class DuplicateHelpPrefix(BzrError):
 
1839
 
 
1840
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1841
 
 
1842
    def __init__(self, prefix):
 
1843
        self.prefix = prefix
 
1844
 
 
1845
 
 
1846
class MalformedTransform(BzrError):
 
1847
 
 
1848
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1849
 
 
1850
 
 
1851
class NoFinalPath(BzrError):
 
1852
 
 
1853
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1854
            "file-id: %(file_id)r\n"
 
1855
            "root trans-id: %(root_trans_id)r\n")
 
1856
 
 
1857
    def __init__(self, trans_id, transform):
 
1858
        self.trans_id = trans_id
 
1859
        self.file_id = transform.final_file_id(trans_id)
 
1860
        self.root_trans_id = transform.root
 
1861
 
 
1862
 
 
1863
class BzrBadParameter(InternalBzrError):
 
1864
 
 
1865
    _fmt = "Bad parameter: %(param)r"
 
1866
 
 
1867
    # This exception should never be thrown, but it is a base class for all
 
1868
    # parameter-to-function errors.
 
1869
 
 
1870
    def __init__(self, param):
 
1871
        BzrError.__init__(self)
 
1872
        self.param = param
 
1873
 
 
1874
 
 
1875
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1876
 
 
1877
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1878
 
 
1879
 
 
1880
class ReusingTransform(BzrError):
 
1881
 
 
1882
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1883
 
 
1884
 
 
1885
class CantMoveRoot(BzrError):
 
1886
 
 
1887
    _fmt = "Moving the root directory is not supported at this time"
 
1888
 
 
1889
 
 
1890
class BzrMoveFailedError(BzrError):
 
1891
 
 
1892
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1893
 
 
1894
    def __init__(self, from_path='', to_path='', extra=None):
 
1895
        from bzrlib.osutils import splitpath
 
1896
        BzrError.__init__(self)
 
1897
        if extra:
 
1898
            self.extra = ': ' + str(extra)
 
1899
        else:
 
1900
            self.extra = ''
 
1901
 
 
1902
        has_from = len(from_path) > 0
 
1903
        has_to = len(to_path) > 0
 
1904
        if has_from:
 
1905
            self.from_path = splitpath(from_path)[-1]
 
1906
        else:
 
1907
            self.from_path = ''
 
1908
 
 
1909
        if has_to:
 
1910
            self.to_path = splitpath(to_path)[-1]
 
1911
        else:
 
1912
            self.to_path = ''
 
1913
 
 
1914
        self.operator = ""
 
1915
        if has_from and has_to:
 
1916
            self.operator = " =>"
 
1917
        elif has_from:
 
1918
            self.from_path = "from " + from_path
 
1919
        elif has_to:
 
1920
            self.operator = "to"
 
1921
        else:
 
1922
            self.operator = "file"
 
1923
 
 
1924
 
 
1925
class BzrRenameFailedError(BzrMoveFailedError):
 
1926
 
 
1927
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1928
 
 
1929
    def __init__(self, from_path, to_path, extra=None):
 
1930
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1931
 
 
1932
class BzrRemoveChangedFilesError(BzrError):
 
1933
    """Used when user is trying to remove changed files."""
 
1934
 
 
1935
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1936
        "%(changes_as_text)s"
 
1937
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1938
 
 
1939
    def __init__(self, tree_delta):
 
1940
        BzrError.__init__(self)
 
1941
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1942
        #self.paths_as_string = '\n'.join(changed_files)
 
1943
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1944
 
 
1945
 
 
1946
class BzrBadParameterNotString(BzrBadParameter):
 
1947
 
 
1948
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1949
 
 
1950
 
 
1951
class BzrBadParameterMissing(BzrBadParameter):
 
1952
 
 
1953
    _fmt = "Parameter $(param)s is required but not present."
 
1954
 
 
1955
 
 
1956
class BzrBadParameterUnicode(BzrBadParameter):
 
1957
 
 
1958
    _fmt = ("Parameter %(param)s is unicode but"
 
1959
            " only byte-strings are permitted.")
 
1960
 
 
1961
 
 
1962
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1963
 
 
1964
    _fmt = "Parameter %(param)s contains a newline."
 
1965
 
 
1966
 
 
1967
class DependencyNotPresent(BzrError):
 
1968
 
 
1969
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1970
 
 
1971
    def __init__(self, library, error):
 
1972
        BzrError.__init__(self, library=library, error=error)
 
1973
 
 
1974
 
 
1975
class ParamikoNotPresent(DependencyNotPresent):
 
1976
 
 
1977
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1978
 
 
1979
    def __init__(self, error):
 
1980
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1981
 
 
1982
 
 
1983
class PointlessMerge(BzrError):
 
1984
 
 
1985
    _fmt = "Nothing to merge."
 
1986
 
 
1987
 
 
1988
class UninitializableFormat(BzrError):
 
1989
 
 
1990
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1991
 
 
1992
    def __init__(self, format):
 
1993
        BzrError.__init__(self)
 
1994
        self.format = format
 
1995
 
 
1996
 
 
1997
class BadConversionTarget(BzrError):
 
1998
 
 
1999
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2000
 
 
2001
    def __init__(self, problem, format):
 
2002
        BzrError.__init__(self)
 
2003
        self.problem = problem
 
2004
        self.format = format
 
2005
 
 
2006
 
 
2007
class NoDiffFound(BzrError):
 
2008
 
 
2009
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2010
 
 
2011
    def __init__(self, path):
 
2012
        BzrError.__init__(self, path)
 
2013
 
 
2014
 
 
2015
class ExecutableMissing(BzrError):
 
2016
 
 
2017
    _fmt = "%(exe_name)s could not be found on this machine"
 
2018
 
 
2019
    def __init__(self, exe_name):
 
2020
        BzrError.__init__(self, exe_name=exe_name)
 
2021
 
 
2022
 
 
2023
class NoDiff(BzrError):
 
2024
 
 
2025
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
2026
 
 
2027
    def __init__(self, msg):
 
2028
        BzrError.__init__(self, msg=msg)
 
2029
 
 
2030
 
 
2031
class NoDiff3(BzrError):
 
2032
 
 
2033
    _fmt = "Diff3 is not installed on this machine."
 
2034
 
 
2035
 
 
2036
class ExistingContent(BzrError):
 
2037
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2038
 
 
2039
    _fmt = "The content being inserted is already present."
 
2040
 
 
2041
 
 
2042
class ExistingLimbo(BzrError):
 
2043
 
 
2044
    _fmt = """This tree contains left-over files from a failed operation.
 
2045
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2046
    keep, and delete it when you are done."""
 
2047
 
 
2048
    def __init__(self, limbo_dir):
 
2049
       BzrError.__init__(self)
 
2050
       self.limbo_dir = limbo_dir
 
2051
 
 
2052
 
 
2053
class ExistingPendingDeletion(BzrError):
 
2054
 
 
2055
    _fmt = """This tree contains left-over files from a failed operation.
 
2056
    Please examine %(pending_deletion)s to see if it contains any files you
 
2057
    wish to keep, and delete it when you are done."""
 
2058
 
 
2059
    def __init__(self, pending_deletion):
 
2060
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2061
 
 
2062
 
 
2063
class ImmortalLimbo(BzrError):
 
2064
 
 
2065
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2066
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2067
    keep, and delete it when you are done."""
 
2068
 
 
2069
    def __init__(self, limbo_dir):
 
2070
       BzrError.__init__(self)
 
2071
       self.limbo_dir = limbo_dir
 
2072
 
 
2073
 
 
2074
class ImmortalPendingDeletion(BzrError):
 
2075
 
 
2076
    _fmt = ("Unable to delete transform temporary directory "
 
2077
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2078
    "contains any files you wish to keep, and delete it when you are done.")
 
2079
 
 
2080
    def __init__(self, pending_deletion):
 
2081
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2082
 
 
2083
 
 
2084
class OutOfDateTree(BzrError):
 
2085
 
 
2086
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2087
 
 
2088
    def __init__(self, tree):
 
2089
        BzrError.__init__(self)
 
2090
        self.tree = tree
 
2091
 
 
2092
 
 
2093
class PublicBranchOutOfDate(BzrError):
 
2094
 
 
2095
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2096
        '"%(revstring)s".'
 
2097
 
 
2098
    def __init__(self, public_location, revstring):
 
2099
        import bzrlib.urlutils as urlutils
 
2100
        public_location = urlutils.unescape_for_display(public_location,
 
2101
                                                        'ascii')
 
2102
        BzrError.__init__(self, public_location=public_location,
 
2103
                          revstring=revstring)
 
2104
 
 
2105
 
 
2106
class MergeModifiedFormatError(BzrError):
 
2107
 
 
2108
    _fmt = "Error in merge modified format"
 
2109
 
 
2110
 
 
2111
class ConflictFormatError(BzrError):
 
2112
 
 
2113
    _fmt = "Format error in conflict listings"
 
2114
 
 
2115
 
 
2116
class CorruptDirstate(BzrError):
 
2117
 
 
2118
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2119
            "Error: %(description)s")
 
2120
 
 
2121
    def __init__(self, dirstate_path, description):
 
2122
        BzrError.__init__(self)
 
2123
        self.dirstate_path = dirstate_path
 
2124
        self.description = description
 
2125
 
 
2126
 
 
2127
class CorruptRepository(BzrError):
 
2128
 
 
2129
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2130
            "Please run bzr reconcile on this repository.")
 
2131
 
 
2132
    def __init__(self, repo):
 
2133
        BzrError.__init__(self)
 
2134
        self.repo_path = repo.bzrdir.root_transport.base
 
2135
 
 
2136
 
 
2137
class InconsistentDelta(BzrError):
 
2138
    """Used when we get a delta that is not valid."""
 
2139
 
 
2140
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2141
            " %(file_id)r\nreason: %(reason)s")
 
2142
 
 
2143
    def __init__(self, path, file_id, reason):
 
2144
        BzrError.__init__(self)
 
2145
        self.path = path
 
2146
        self.file_id = file_id
 
2147
        self.reason = reason
 
2148
 
 
2149
 
 
2150
class UpgradeRequired(BzrError):
 
2151
 
 
2152
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
2153
 
 
2154
    def __init__(self, path):
 
2155
        BzrError.__init__(self)
 
2156
        self.path = path
 
2157
 
 
2158
 
 
2159
class RepositoryUpgradeRequired(UpgradeRequired):
 
2160
 
 
2161
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2162
 
 
2163
 
 
2164
class LocalRequiresBoundBranch(BzrError):
 
2165
 
 
2166
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2167
 
 
2168
 
 
2169
class InvalidProgressBarType(BzrError):
 
2170
 
 
2171
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2172
            " is not a supported type Select one of: %(valid_types)s")
 
2173
 
 
2174
    def __init__(self, bar_type, valid_types):
 
2175
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2176
 
 
2177
 
 
2178
class UnsupportedOperation(BzrError):
 
2179
 
 
2180
    _fmt = ("The method %(mname)s is not supported on"
 
2181
            " objects of type %(tname)s.")
 
2182
 
 
2183
    def __init__(self, method, method_self):
 
2184
        self.method = method
 
2185
        self.mname = method.__name__
 
2186
        self.tname = type(method_self).__name__
 
2187
 
 
2188
 
 
2189
class CannotSetRevisionId(UnsupportedOperation):
 
2190
    """Raised when a commit is attempting to set a revision id but cant."""
 
2191
 
 
2192
 
 
2193
class NonAsciiRevisionId(UnsupportedOperation):
 
2194
    """Raised when a commit is attempting to set a non-ascii revision id
 
2195
       but cant.
 
2196
    """
 
2197
 
 
2198
 
 
2199
class BinaryFile(BzrError):
 
2200
 
 
2201
    _fmt = "File is binary but should be text."
 
2202
 
 
2203
 
 
2204
class IllegalPath(BzrError):
 
2205
 
 
2206
    _fmt = "The path %(path)s is not permitted on this platform"
 
2207
 
 
2208
    def __init__(self, path):
 
2209
        BzrError.__init__(self)
 
2210
        self.path = path
 
2211
 
 
2212
 
 
2213
class TestamentMismatch(BzrError):
 
2214
 
 
2215
    _fmt = """Testament did not match expected value.
 
2216
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2217
       {%(measured)s}"""
 
2218
 
 
2219
    def __init__(self, revision_id, expected, measured):
 
2220
        self.revision_id = revision_id
 
2221
        self.expected = expected
 
2222
        self.measured = measured
 
2223
 
 
2224
 
 
2225
class NotABundle(BzrError):
 
2226
 
 
2227
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2228
 
 
2229
    def __init__(self, text):
 
2230
        BzrError.__init__(self)
 
2231
        self.text = text
 
2232
 
 
2233
 
 
2234
class BadBundle(BzrError):
 
2235
 
 
2236
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2237
 
 
2238
    def __init__(self, text):
 
2239
        BzrError.__init__(self)
 
2240
        self.text = text
 
2241
 
 
2242
 
 
2243
class MalformedHeader(BadBundle):
 
2244
 
 
2245
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2246
 
 
2247
 
 
2248
class MalformedPatches(BadBundle):
 
2249
 
 
2250
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2251
 
 
2252
 
 
2253
class MalformedFooter(BadBundle):
 
2254
 
 
2255
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2256
 
 
2257
 
 
2258
class UnsupportedEOLMarker(BadBundle):
 
2259
 
 
2260
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2261
 
 
2262
    def __init__(self):
 
2263
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2264
        # but for this there is not
 
2265
        BzrError.__init__(self)
 
2266
 
 
2267
 
 
2268
class IncompatibleBundleFormat(BzrError):
 
2269
 
 
2270
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2271
 
 
2272
    def __init__(self, bundle_format, other):
 
2273
        BzrError.__init__(self)
 
2274
        self.bundle_format = bundle_format
 
2275
        self.other = other
 
2276
 
 
2277
 
 
2278
class BadInventoryFormat(BzrError):
 
2279
 
 
2280
    _fmt = "Root class for inventory serialization errors"
 
2281
 
 
2282
 
 
2283
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2284
 
 
2285
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2286
 
 
2287
    def __init__(self, msg):
 
2288
        BadInventoryFormat.__init__(self, msg=msg)
 
2289
 
 
2290
 
 
2291
class RootNotRich(BzrError):
 
2292
 
 
2293
    _fmt = """This operation requires rich root data storage"""
 
2294
 
 
2295
 
 
2296
class NoSmartMedium(InternalBzrError):
 
2297
 
 
2298
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2299
 
 
2300
    def __init__(self, transport):
 
2301
        self.transport = transport
 
2302
 
 
2303
 
 
2304
class UnknownSSH(BzrError):
 
2305
 
 
2306
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2307
 
 
2308
    def __init__(self, vendor):
 
2309
        BzrError.__init__(self)
 
2310
        self.vendor = vendor
 
2311
 
 
2312
 
 
2313
class SSHVendorNotFound(BzrError):
 
2314
 
 
2315
    _fmt = ("Don't know how to handle SSH connections."
 
2316
            " Please set BZR_SSH environment variable.")
 
2317
 
 
2318
 
 
2319
class GhostRevisionsHaveNoRevno(BzrError):
 
2320
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2321
 
 
2322
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2323
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2324
 
 
2325
    def __init__(self, revision_id, ghost_revision_id):
 
2326
        self.revision_id = revision_id
 
2327
        self.ghost_revision_id = ghost_revision_id
 
2328
 
 
2329
 
 
2330
class GhostRevisionUnusableHere(BzrError):
 
2331
 
 
2332
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2333
 
 
2334
    def __init__(self, revision_id):
 
2335
        BzrError.__init__(self)
 
2336
        self.revision_id = revision_id
 
2337
 
 
2338
 
 
2339
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2340
 
 
2341
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2342
            " %(msg)s%(extra)s")
 
2343
 
 
2344
    def __init__(self, name, msg, extra=None):
 
2345
        BzrError.__init__(self)
 
2346
        self.name = name
 
2347
        self.msg = msg
 
2348
        if extra:
 
2349
            self.extra = ': ' + str(extra)
 
2350
        else:
 
2351
            self.extra = ''
 
2352
 
 
2353
 
 
2354
class InvalidImportLine(InternalBzrError):
 
2355
 
 
2356
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2357
 
 
2358
    def __init__(self, text, msg):
 
2359
        BzrError.__init__(self)
 
2360
        self.text = text
 
2361
        self.msg = msg
 
2362
 
 
2363
 
 
2364
class ImportNameCollision(InternalBzrError):
 
2365
 
 
2366
    _fmt = ("Tried to import an object to the same name as"
 
2367
            " an existing object. %(name)s")
 
2368
 
 
2369
    def __init__(self, name):
 
2370
        BzrError.__init__(self)
 
2371
        self.name = name
 
2372
 
 
2373
 
 
2374
class NotAMergeDirective(BzrError):
 
2375
    """File starting with %(firstline)r is not a merge directive"""
 
2376
    def __init__(self, firstline):
 
2377
        BzrError.__init__(self, firstline=firstline)
 
2378
 
 
2379
 
 
2380
class NoMergeSource(BzrError):
 
2381
    """Raise if no merge source was specified for a merge directive"""
 
2382
 
 
2383
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2384
        " branch location."
 
2385
 
 
2386
 
 
2387
class IllegalMergeDirectivePayload(BzrError):
 
2388
    """A merge directive contained something other than a patch or bundle"""
 
2389
 
 
2390
    _fmt = "Bad merge directive payload %(start)r"
 
2391
 
 
2392
    def __init__(self, start):
 
2393
        BzrError(self)
 
2394
        self.start = start
 
2395
 
 
2396
 
 
2397
class PatchVerificationFailed(BzrError):
 
2398
    """A patch from a merge directive could not be verified"""
 
2399
 
 
2400
    _fmt = "Preview patch does not match requested changes."
 
2401
 
 
2402
 
 
2403
class PatchMissing(BzrError):
 
2404
    """Raise a patch type was specified but no patch supplied"""
 
2405
 
 
2406
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2407
 
 
2408
    def __init__(self, patch_type):
 
2409
        BzrError.__init__(self)
 
2410
        self.patch_type = patch_type
 
2411
 
 
2412
 
 
2413
class TargetNotBranch(BzrError):
 
2414
    """A merge directive's target branch is required, but isn't a branch"""
 
2415
 
 
2416
    _fmt = ("Your branch does not have all of the revisions required in "
 
2417
            "order to merge this merge directive and the target "
 
2418
            "location specified in the merge directive is not a branch: "
 
2419
            "%(location)s.")
 
2420
 
 
2421
    def __init__(self, location):
 
2422
        BzrError.__init__(self)
 
2423
        self.location = location
 
2424
 
 
2425
 
 
2426
class UnsupportedInventoryKind(BzrError):
 
2427
 
 
2428
    _fmt = """Unsupported entry kind %(kind)s"""
 
2429
 
 
2430
    def __init__(self, kind):
 
2431
        self.kind = kind
 
2432
 
 
2433
 
 
2434
class BadSubsumeSource(BzrError):
 
2435
 
 
2436
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2437
 
 
2438
    def __init__(self, tree, other_tree, reason):
 
2439
        self.tree = tree
 
2440
        self.other_tree = other_tree
 
2441
        self.reason = reason
 
2442
 
 
2443
 
 
2444
class SubsumeTargetNeedsUpgrade(BzrError):
 
2445
 
 
2446
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2447
 
 
2448
    def __init__(self, other_tree):
 
2449
        self.other_tree = other_tree
 
2450
 
 
2451
 
 
2452
class BadReferenceTarget(InternalBzrError):
 
2453
 
 
2454
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2455
           "%(reason)s"
 
2456
 
 
2457
    def __init__(self, tree, other_tree, reason):
 
2458
        self.tree = tree
 
2459
        self.other_tree = other_tree
 
2460
        self.reason = reason
 
2461
 
 
2462
 
 
2463
class NoSuchTag(BzrError):
 
2464
 
 
2465
    _fmt = "No such tag: %(tag_name)s"
 
2466
 
 
2467
    def __init__(self, tag_name):
 
2468
        self.tag_name = tag_name
 
2469
 
 
2470
 
 
2471
class TagsNotSupported(BzrError):
 
2472
 
 
2473
    _fmt = ("Tags not supported by %(branch)s;"
 
2474
            " you may be able to use bzr upgrade.")
 
2475
 
 
2476
    def __init__(self, branch):
 
2477
        self.branch = branch
 
2478
 
 
2479
 
 
2480
class TagAlreadyExists(BzrError):
 
2481
 
 
2482
    _fmt = "Tag %(tag_name)s already exists."
 
2483
 
 
2484
    def __init__(self, tag_name):
 
2485
        self.tag_name = tag_name
 
2486
 
 
2487
 
 
2488
class MalformedBugIdentifier(BzrError):
 
2489
 
 
2490
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2491
            'See "bzr help bugs" for more information on this feature.')
 
2492
 
 
2493
    def __init__(self, bug_id, reason):
 
2494
        self.bug_id = bug_id
 
2495
        self.reason = reason
 
2496
 
 
2497
 
 
2498
class InvalidBugTrackerURL(BzrError):
 
2499
 
 
2500
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2501
            "contain {id}: %(url)s")
 
2502
 
 
2503
    def __init__(self, abbreviation, url):
 
2504
        self.abbreviation = abbreviation
 
2505
        self.url = url
 
2506
 
 
2507
 
 
2508
class UnknownBugTrackerAbbreviation(BzrError):
 
2509
 
 
2510
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2511
            "on %(branch)s")
 
2512
 
 
2513
    def __init__(self, abbreviation, branch):
 
2514
        self.abbreviation = abbreviation
 
2515
        self.branch = branch
 
2516
 
 
2517
 
 
2518
class InvalidLineInBugsProperty(BzrError):
 
2519
 
 
2520
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2521
 
 
2522
    def __init__(self, line):
 
2523
        self.line = line
 
2524
 
 
2525
 
 
2526
class InvalidBugStatus(BzrError):
 
2527
 
 
2528
    _fmt = ("Invalid bug status: '%(status)s'")
 
2529
 
 
2530
    def __init__(self, status):
 
2531
        self.status = status
 
2532
 
 
2533
 
 
2534
class UnexpectedSmartServerResponse(BzrError):
 
2535
 
 
2536
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2537
 
 
2538
    def __init__(self, response_tuple):
 
2539
        self.response_tuple = response_tuple
 
2540
 
 
2541
 
 
2542
class ErrorFromSmartServer(BzrError):
 
2543
    """An error was received from a smart server.
 
2544
 
 
2545
    :seealso: UnknownErrorFromSmartServer
 
2546
    """
 
2547
 
 
2548
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2549
 
 
2550
    internal_error = True
 
2551
 
 
2552
    def __init__(self, error_tuple):
 
2553
        self.error_tuple = error_tuple
 
2554
        try:
 
2555
            self.error_verb = error_tuple[0]
 
2556
        except IndexError:
 
2557
            self.error_verb = None
 
2558
        self.error_args = error_tuple[1:]
 
2559
 
 
2560
 
 
2561
class UnknownErrorFromSmartServer(BzrError):
 
2562
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2563
    error.
 
2564
 
 
2565
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2566
    distinguish between the following two cases:
 
2567
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2568
        and so should provoke a traceback to the user.
 
2569
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2570
        translated.  This is probably because the server sent us garbage, and
 
2571
        should not provoke a traceback.
 
2572
    """
 
2573
 
 
2574
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2575
 
 
2576
    internal_error = False
 
2577
 
 
2578
    def __init__(self, error_from_smart_server):
 
2579
        """Constructor.
 
2580
 
 
2581
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2582
        """
 
2583
        self.error_from_smart_server = error_from_smart_server
 
2584
        self.error_tuple = error_from_smart_server.error_tuple
 
2585
 
 
2586
 
 
2587
class ContainerError(BzrError):
 
2588
    """Base class of container errors."""
 
2589
 
 
2590
 
 
2591
class UnknownContainerFormatError(ContainerError):
 
2592
 
 
2593
    _fmt = "Unrecognised container format: %(container_format)r"
 
2594
 
 
2595
    def __init__(self, container_format):
 
2596
        self.container_format = container_format
 
2597
 
 
2598
 
 
2599
class UnexpectedEndOfContainerError(ContainerError):
 
2600
 
 
2601
    _fmt = "Unexpected end of container stream"
 
2602
 
 
2603
 
 
2604
class UnknownRecordTypeError(ContainerError):
 
2605
 
 
2606
    _fmt = "Unknown record type: %(record_type)r"
 
2607
 
 
2608
    def __init__(self, record_type):
 
2609
        self.record_type = record_type
 
2610
 
 
2611
 
 
2612
class InvalidRecordError(ContainerError):
 
2613
 
 
2614
    _fmt = "Invalid record: %(reason)s"
 
2615
 
 
2616
    def __init__(self, reason):
 
2617
        self.reason = reason
 
2618
 
 
2619
 
 
2620
class ContainerHasExcessDataError(ContainerError):
 
2621
 
 
2622
    _fmt = "Container has data after end marker: %(excess)r"
 
2623
 
 
2624
    def __init__(self, excess):
 
2625
        self.excess = excess
 
2626
 
 
2627
 
 
2628
class DuplicateRecordNameError(ContainerError):
 
2629
 
 
2630
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2631
 
 
2632
    def __init__(self, name):
 
2633
        self.name = name
 
2634
 
 
2635
 
 
2636
class NoDestinationAddress(InternalBzrError):
 
2637
 
 
2638
    _fmt = "Message does not have a destination address."
 
2639
 
 
2640
 
 
2641
class RepositoryDataStreamError(BzrError):
 
2642
 
 
2643
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2644
 
 
2645
    def __init__(self, reason):
 
2646
        self.reason = reason
 
2647
 
 
2648
 
 
2649
class SMTPError(BzrError):
 
2650
 
 
2651
    _fmt = "SMTP error: %(error)s"
 
2652
 
 
2653
    def __init__(self, error):
 
2654
        self.error = error
 
2655
 
 
2656
 
 
2657
class NoMessageSupplied(BzrError):
 
2658
 
 
2659
    _fmt = "No message supplied."
 
2660
 
 
2661
 
 
2662
class NoMailAddressSpecified(BzrError):
 
2663
 
 
2664
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2665
 
 
2666
 
 
2667
class UnknownMailClient(BzrError):
 
2668
 
 
2669
    _fmt = "Unknown mail client: %(mail_client)s"
 
2670
 
 
2671
    def __init__(self, mail_client):
 
2672
        BzrError.__init__(self, mail_client=mail_client)
 
2673
 
 
2674
 
 
2675
class MailClientNotFound(BzrError):
 
2676
 
 
2677
    _fmt = "Unable to find mail client with the following names:"\
 
2678
        " %(mail_command_list_string)s"
 
2679
 
 
2680
    def __init__(self, mail_command_list):
 
2681
        mail_command_list_string = ', '.join(mail_command_list)
 
2682
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2683
                          mail_command_list_string=mail_command_list_string)
 
2684
 
 
2685
class SMTPConnectionRefused(SMTPError):
 
2686
 
 
2687
    _fmt = "SMTP connection to %(host)s refused"
 
2688
 
 
2689
    def __init__(self, error, host):
 
2690
        self.error = error
 
2691
        self.host = host
 
2692
 
 
2693
 
 
2694
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2695
 
 
2696
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2697
 
 
2698
 
 
2699
class BzrDirError(BzrError):
 
2700
 
 
2701
    def __init__(self, bzrdir):
 
2702
        import bzrlib.urlutils as urlutils
 
2703
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2704
                                                    'ascii')
 
2705
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2706
 
 
2707
 
 
2708
class UnsyncedBranches(BzrDirError):
 
2709
 
 
2710
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2711
            " bzr help sync-for-reconfigure.")
 
2712
 
 
2713
    def __init__(self, bzrdir, target_branch):
 
2714
        BzrDirError.__init__(self, bzrdir)
 
2715
        import bzrlib.urlutils as urlutils
 
2716
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2717
                                                        'ascii')
 
2718
 
 
2719
 
 
2720
class AlreadyBranch(BzrDirError):
 
2721
 
 
2722
    _fmt = "'%(display_url)s' is already a branch."
 
2723
 
 
2724
 
 
2725
class AlreadyTree(BzrDirError):
 
2726
 
 
2727
    _fmt = "'%(display_url)s' is already a tree."
 
2728
 
 
2729
 
 
2730
class AlreadyCheckout(BzrDirError):
 
2731
 
 
2732
    _fmt = "'%(display_url)s' is already a checkout."
 
2733
 
 
2734
 
 
2735
class AlreadyLightweightCheckout(BzrDirError):
 
2736
 
 
2737
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2738
 
 
2739
 
 
2740
class AlreadyUsingShared(BzrDirError):
 
2741
 
 
2742
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2743
 
 
2744
 
 
2745
class AlreadyStandalone(BzrDirError):
 
2746
 
 
2747
    _fmt = "'%(display_url)s' is already standalone."
 
2748
 
 
2749
 
 
2750
class AlreadyWithTrees(BzrDirError):
 
2751
 
 
2752
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2753
            "working trees.")
 
2754
 
 
2755
 
 
2756
class AlreadyWithNoTrees(BzrDirError):
 
2757
 
 
2758
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2759
            "working trees.")
 
2760
 
 
2761
 
 
2762
class ReconfigurationNotSupported(BzrDirError):
 
2763
 
 
2764
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2765
 
 
2766
 
 
2767
class NoBindLocation(BzrDirError):
 
2768
 
 
2769
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2770
 
 
2771
 
 
2772
class UncommittedChanges(BzrError):
 
2773
 
 
2774
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2775
 
 
2776
    def __init__(self, tree):
 
2777
        import bzrlib.urlutils as urlutils
 
2778
        display_url = urlutils.unescape_for_display(
 
2779
            tree.bzrdir.root_transport.base, 'ascii')
 
2780
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2781
 
 
2782
 
 
2783
class MissingTemplateVariable(BzrError):
 
2784
 
 
2785
    _fmt = 'Variable {%(name)s} is not available.'
 
2786
 
 
2787
    def __init__(self, name):
 
2788
        self.name = name
 
2789
 
 
2790
 
 
2791
class NoTemplate(BzrError):
 
2792
 
 
2793
    _fmt = 'No template specified.'
 
2794
 
 
2795
 
 
2796
class UnableCreateSymlink(BzrError):
 
2797
 
 
2798
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2799
 
 
2800
    def __init__(self, path=None):
 
2801
        path_str = ''
 
2802
        if path:
 
2803
            try:
 
2804
                path_str = repr(str(path))
 
2805
            except UnicodeEncodeError:
 
2806
                path_str = repr(path)
 
2807
            path_str += ' '
 
2808
        self.path_str = path_str
 
2809
 
 
2810
 
 
2811
class UnsupportedTimezoneFormat(BzrError):
 
2812
 
 
2813
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2814
            'options are "utc", "original", "local".')
 
2815
 
 
2816
    def __init__(self, timezone):
 
2817
        self.timezone = timezone
 
2818
 
 
2819
 
 
2820
class CommandAvailableInPlugin(StandardError):
 
2821
 
 
2822
    internal_error = False
 
2823
 
 
2824
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2825
 
 
2826
        self.plugin_metadata = plugin_metadata
 
2827
        self.cmd_name = cmd_name
 
2828
        self.provider = provider
 
2829
 
 
2830
    def __str__(self):
 
2831
 
 
2832
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2833
                'However, the following official plugin provides this command: %s\n'
 
2834
                'You can install it by going to: %s'
 
2835
                % (self.cmd_name, self.plugin_metadata['name'],
 
2836
                    self.plugin_metadata['url']))
 
2837
 
 
2838
        return _fmt
 
2839
 
 
2840
 
 
2841
class NoPluginAvailable(BzrError):
 
2842
    pass
 
2843
 
 
2844
 
 
2845
class UnableEncodePath(BzrError):
 
2846
 
 
2847
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2848
            'user encoding %(user_encoding)s')
 
2849
 
 
2850
    def __init__(self, path, kind):
 
2851
        from bzrlib.osutils import get_user_encoding
 
2852
        self.path = path
 
2853
        self.kind = kind
 
2854
        self.user_encoding = osutils.get_user_encoding()
 
2855
 
 
2856
 
 
2857
class NoSuchAlias(BzrError):
 
2858
 
 
2859
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2860
 
 
2861
    def __init__(self, alias_name):
 
2862
        BzrError.__init__(self, alias_name=alias_name)
 
2863
 
 
2864
 
 
2865
class DirectoryLookupFailure(BzrError):
 
2866
    """Base type for lookup errors."""
 
2867
 
 
2868
    pass
 
2869
 
 
2870
 
 
2871
class InvalidLocationAlias(DirectoryLookupFailure):
 
2872
 
 
2873
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2874
 
 
2875
    def __init__(self, alias_name):
 
2876
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2877
 
 
2878
 
 
2879
class UnsetLocationAlias(DirectoryLookupFailure):
 
2880
 
 
2881
    _fmt = 'No %(alias_name)s location assigned.'
 
2882
 
 
2883
    def __init__(self, alias_name):
 
2884
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2885
 
 
2886
 
 
2887
class CannotBindAddress(BzrError):
 
2888
 
 
2889
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2890
 
 
2891
    def __init__(self, host, port, orig_error):
 
2892
        BzrError.__init__(self, host=host, port=port,
 
2893
            orig_error=orig_error[1])
 
2894
 
 
2895
 
 
2896
class UnknownRules(BzrError):
 
2897
 
 
2898
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2899
 
 
2900
    def __init__(self, unknowns):
 
2901
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2902
 
 
2903
 
 
2904
class HookFailed(BzrError):
 
2905
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2906
    than TipChangeRejected.
 
2907
    """
 
2908
 
 
2909
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2910
            "%(traceback_text)s%(exc_value)s")
 
2911
 
 
2912
    def __init__(self, hook_stage, hook_name, exc_info):
 
2913
        import traceback
 
2914
        self.hook_stage = hook_stage
 
2915
        self.hook_name = hook_name
 
2916
        self.exc_info = exc_info
 
2917
        self.exc_type = exc_info[0]
 
2918
        self.exc_value = exc_info[1]
 
2919
        self.exc_tb = exc_info[2]
 
2920
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2921
 
 
2922
 
 
2923
class TipChangeRejected(BzrError):
 
2924
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2925
    explicitly abort a change to a branch tip.
 
2926
    """
 
2927
 
 
2928
    _fmt = u"Tip change rejected: %(msg)s"
 
2929
 
 
2930
    def __init__(self, msg):
 
2931
        self.msg = msg
 
2932
 
 
2933
 
 
2934
class ShelfCorrupt(BzrError):
 
2935
 
 
2936
    _fmt = "Shelf corrupt."
 
2937
 
 
2938
 
 
2939
class NoSuchShelfId(BzrError):
 
2940
 
 
2941
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
2942
 
 
2943
    def __init__(self, shelf_id):
 
2944
        BzrError.__init__(self, shelf_id=shelf_id)
 
2945
 
 
2946
 
 
2947
class InvalidShelfId(BzrError):
 
2948
 
 
2949
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
2950
 
 
2951
    def __init__(self, invalid_id):
 
2952
        BzrError.__init__(self, invalid_id=invalid_id)
 
2953
 
 
2954
 
 
2955
class JailBreak(BzrError):
 
2956
 
 
2957
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2958
 
 
2959
    def __init__(self, url):
 
2960
        BzrError.__init__(self, url=url)
 
2961
 
 
2962
 
 
2963
class UserAbort(BzrError):
 
2964
 
 
2965
    _fmt = 'The user aborted the operation.'
 
2966
 
 
2967
 
 
2968
class MustHaveWorkingTree(BzrError):
 
2969
 
 
2970
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
2971
 
 
2972
    def __init__(self, format, url):
 
2973
        BzrError.__init__(self, format=format, url=url)
 
2974
 
 
2975
 
 
2976
class NoSuchView(BzrError):
 
2977
    """A view does not exist.
 
2978
    """
 
2979
 
 
2980
    _fmt = u"No such view: %(view_name)s."
 
2981
 
 
2982
    def __init__(self, view_name):
 
2983
        self.view_name = view_name
 
2984
 
 
2985
 
 
2986
class ViewsNotSupported(BzrError):
 
2987
    """Views are not supported by a tree format.
 
2988
    """
 
2989
 
 
2990
    _fmt = ("Views are not supported by %(tree)s;"
 
2991
            " use 'bzr upgrade' to change your tree to a later format.")
 
2992
 
 
2993
    def __init__(self, tree):
 
2994
        self.tree = tree
 
2995
 
 
2996
 
 
2997
class FileOutsideView(BzrError):
 
2998
 
 
2999
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3000
            '%(view_str)s')
 
3001
 
 
3002
    def __init__(self, file_name, view_files):
 
3003
        self.file_name = file_name
 
3004
        self.view_str = ", ".join(view_files)
 
3005
 
 
3006
 
 
3007
class UnresumableWriteGroup(BzrError):
 
3008
 
 
3009
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3010
            "%(write_groups)r: %(reason)s")
 
3011
 
 
3012
    internal_error = True
 
3013
 
 
3014
    def __init__(self, repository, write_groups, reason):
 
3015
        self.repository = repository
 
3016
        self.write_groups = write_groups
 
3017
        self.reason = reason
 
3018
 
 
3019
 
 
3020
class UnsuspendableWriteGroup(BzrError):
 
3021
 
 
3022
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3023
 
 
3024
    internal_error = True
 
3025
 
 
3026
    def __init__(self, repository):
 
3027
        self.repository = repository
 
3028
 
 
3029
 
 
3030
class LossyPushToSameVCS(BzrError):
 
3031
 
 
3032
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3033
            "%(target_branch)r that are in the same VCS.")
 
3034
 
 
3035
    internal_error = True
 
3036
 
 
3037
    def __init__(self, source_branch, target_branch):
 
3038
        self.source_branch = source_branch
 
3039
        self.target_branch = target_branch