/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: Ian Clatworthy
  • Date: 2007-12-11 02:07:30 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071211020730-sdj4kj794dw0628e
make help topics more discoverable

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