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