/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: Canonical.com Patch Queue Manager
  • Date: 2007-10-03 05:04:42 UTC
  • mfrom: (2776.4.19 commit)
  • Revision ID: pqm@pqm.ubuntu.com-20071003050442-e0x9ofdfo0hwxnal
(robertc) Move serialisation of inventory entries into CommitBuilder. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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