/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-04-02 00:14:00 UTC
  • mfrom: (3324 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080402001400-r1pqse38i03dl97w
Merge from bzr.dev.

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