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