/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2007-10-02 02:54:30 UTC
  • mto: This revision was merged to the branch mainline in revision 2873.
  • Revision ID: mbp@sourcefrog.net-20071002025430-5qkc146iuaqxdsgk
Ignore .pyd files in bzr tree (windows C extensions)

Show diffs side-by-side

added added

removed removed

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