/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: Andrew Bennetts
  • Date: 2008-02-19 03:03:42 UTC
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080219030342-9j3uiaqgobh083qn
Don't import bzrlib.smart.medium from bzrlib.smart.server until it's needed.  This helps the bzr-dbus plugin import faster.

Show diffs side-by-side

added added

removed removed

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