/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

(John Arbash Meinel)  Fix bug #158333,
        make sure that Repository.fetch(self) is properly a no-op for all
        Repository implementations.

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