~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-12-05 17:21:36 UTC
  • mfrom: (3872.3.3 backup-bzrdir)
  • Revision ID: pqm@pqm.ubuntu.com-20081205172136-vccv8ynqac6sxr5s
(Jelmer) Add BzrDir.backup_bzrdir().

Show diffs side-by-side

added added

removed removed

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