/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

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