/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

Merge from bzr.dev.

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