/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-03-27 06:10:18 UTC
  • mfrom: (3309 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3320.
  • Revision ID: andrew.bennetts@canonical.com-20080327061018-dxztpxyv6yoeg3am
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
    osutils,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.patches import (
 
26
    MalformedHunkHeader,
 
27
    MalformedLine,
 
28
    MalformedPatchHeader,
 
29
    PatchConflict,
 
30
    PatchSyntax,
 
31
    )
 
32
 
 
33
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
35
# python exceptions?   A list of values with no names seems less useful 
 
36
# to me.
 
37
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's 
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
40
# exceptions that are never raised.
 
41
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
43
# raised can be formatted as a string successfully, and without giving
 
44
# 'unprintable'.
 
45
 
 
46
 
 
47
# return codes from the bzr program
 
48
EXIT_OK = 0
 
49
EXIT_ERROR = 3
 
50
EXIT_INTERNAL_ERROR = 4
 
51
 
 
52
 
 
53
class BzrError(StandardError):
 
54
    """
 
55
    Base class for errors raised by bzrlib.
 
56
 
 
57
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
58
    should be displayed with a traceback; if False (or absent) this was
 
59
    probably a user or environment error and they don't need the gory details.
 
60
    (That can be overridden by -Derror on the command line.)
 
61
 
 
62
    :cvar _fmt: Format string to display the error; this is expanded
 
63
    by the instance's dict.
 
64
    """
 
65
    
 
66
    internal_error = False
 
67
 
 
68
    def __init__(self, msg=None, **kwds):
 
69
        """Construct a new BzrError.
 
70
 
 
71
        There are two alternative forms for constructing these objects.
 
72
        Either a preformatted string may be passed, or a set of named
 
73
        arguments can be given.  The first is for generic "user" errors which
 
74
        are not intended to be caught and so do not need a specific subclass.
 
75
        The second case is for use with subclasses that provide a _fmt format
 
76
        string to print the arguments.  
 
77
 
 
78
        Keyword arguments are taken as parameters to the error, which can 
 
79
        be inserted into the format string template.  It's recommended 
 
80
        that subclasses override the __init__ method to require specific 
 
81
        parameters.
 
82
 
 
83
        :param msg: If given, this is the literal complete text for the error,
 
84
        not subject to expansion.
 
85
        """
 
86
        StandardError.__init__(self)
 
87
        if msg is not None:
 
88
            # I was going to deprecate this, but it actually turns out to be
 
89
            # quite handy - mbp 20061103.
 
90
            self._preformatted_string = msg
 
91
        else:
 
92
            self._preformatted_string = None
 
93
            for key, value in kwds.items():
 
94
                setattr(self, key, value)
 
95
 
 
96
    def __str__(self):
 
97
        s = getattr(self, '_preformatted_string', None)
 
98
        if s is not None:
 
99
            # contains a preformatted message; must be cast to plain str
 
100
            return str(s)
 
101
        try:
 
102
            fmt = self._get_format_string()
 
103
            if fmt:
 
104
                d = dict(self.__dict__)
 
105
                # special case: python2.5 puts the 'message' attribute in a
 
106
                # slot, so it isn't seen in __dict__
 
107
                d['message'] = getattr(self, 'message', 'no message')
 
108
                s = fmt % d
 
109
                # __str__() should always return a 'str' object
 
110
                # never a 'unicode' object.
 
111
                if isinstance(s, unicode):
 
112
                    return s.encode('utf8')
 
113
                return s
 
114
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
115
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
116
                % (self.__class__.__name__,
 
117
                   self.__dict__,
 
118
                   getattr(self, '_fmt', None),
 
119
                   e)
 
120
 
 
121
    def _get_format_string(self):
 
122
        """Return format string for this exception or None"""
 
123
        fmt = getattr(self, '_fmt', None)
 
124
        if fmt is not None:
 
125
            return fmt
 
126
        fmt = getattr(self, '__doc__', None)
 
127
        if fmt is not None:
 
128
            symbol_versioning.warn("%s uses its docstring as a format, "
 
129
                    "it should use _fmt instead" % self.__class__.__name__,
 
130
                    DeprecationWarning)
 
131
            return fmt
 
132
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
133
            % (self.__class__.__name__,
 
134
               self.__dict__,
 
135
               getattr(self, '_fmt', None),
 
136
               )
 
137
 
 
138
 
 
139
class InternalBzrError(BzrError):
 
140
    """Base class for errors that are internal in nature.
 
141
 
 
142
    This is a convenience class for errors that are internal. The
 
143
    internal_error attribute can still be altered in subclasses, if needed.
 
144
    Using this class is simply an easy way to get internal errors.
 
145
    """
 
146
 
 
147
    internal_error = True
 
148
 
 
149
 
 
150
class BzrNewError(BzrError):
 
151
    """Deprecated error base class."""
 
152
    # base classes should override the docstring with their human-
 
153
    # readable explanation
 
154
 
 
155
    def __init__(self, *args, **kwds):
 
156
        # XXX: Use the underlying BzrError to always generate the args
 
157
        # attribute if it doesn't exist.  We can't use super here, because
 
158
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
159
        # --bmc, 20060426
 
160
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
161
             'please convert %s to use BzrError instead'
 
162
             % self.__class__.__name__,
 
163
             DeprecationWarning,
 
164
             stacklevel=2)
 
165
        BzrError.__init__(self, *args)
 
166
        for key, value in kwds.items():
 
167
            setattr(self, key, value)
 
168
 
 
169
    def __str__(self):
 
170
        try:
 
171
            # __str__() should always return a 'str' object
 
172
            # never a 'unicode' object.
 
173
            s = self.__doc__ % self.__dict__
 
174
            if isinstance(s, unicode):
 
175
                return s.encode('utf8')
 
176
            return s
 
177
        except (TypeError, NameError, ValueError, KeyError), e:
 
178
            return 'Unprintable exception %s(%r): %r' \
 
179
                % (self.__class__.__name__,
 
180
                   self.__dict__, e)
 
181
 
 
182
 
 
183
class AlreadyBuilding(BzrError):
 
184
    
 
185
    _fmt = "The tree builder is already building a tree."
 
186
 
 
187
 
 
188
class BzrCheckError(InternalBzrError):
 
189
    
 
190
    _fmt = "Internal check failed: %(message)s"
 
191
 
 
192
    def __init__(self, message):
 
193
        BzrError.__init__(self)
 
194
        self.message = message
 
195
 
 
196
 
 
197
class DisabledMethod(InternalBzrError):
 
198
 
 
199
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
200
 
 
201
    def __init__(self, class_name):
 
202
        BzrError.__init__(self)
 
203
        self.class_name = class_name
 
204
 
 
205
 
 
206
class IncompatibleAPI(BzrError):
 
207
 
 
208
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
209
        'It supports versions "%(minimum)s" to "%(current)s".'
 
210
 
 
211
    def __init__(self, api, wanted, minimum, current):
 
212
        self.api = api
 
213
        self.wanted = wanted
 
214
        self.minimum = minimum
 
215
        self.current = current
 
216
 
 
217
 
 
218
class InProcessTransport(BzrError):
 
219
 
 
220
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
221
        "process."
 
222
 
 
223
    def __init__(self, transport):
 
224
        self.transport = transport
 
225
 
 
226
 
 
227
class InvalidEntryName(InternalBzrError):
 
228
    
 
229
    _fmt = "Invalid entry name: %(name)s"
 
230
 
 
231
    def __init__(self, name):
 
232
        BzrError.__init__(self)
 
233
        self.name = name
 
234
 
 
235
 
 
236
class InvalidRevisionNumber(BzrError):
 
237
    
 
238
    _fmt = "Invalid revision number %(revno)s"
 
239
 
 
240
    def __init__(self, revno):
 
241
        BzrError.__init__(self)
 
242
        self.revno = revno
 
243
 
 
244
 
 
245
class InvalidRevisionId(BzrError):
 
246
 
 
247
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
248
 
 
249
    def __init__(self, revision_id, branch):
 
250
        # branch can be any string or object with __str__ defined
 
251
        BzrError.__init__(self)
 
252
        self.revision_id = revision_id
 
253
        self.branch = branch
 
254
 
 
255
 
 
256
class ReservedId(BzrError):
 
257
 
 
258
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
259
 
 
260
    def __init__(self, revision_id):
 
261
        self.revision_id = revision_id
 
262
 
 
263
 
 
264
class RootMissing(InternalBzrError):
 
265
 
 
266
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
267
        "record_entry_contents.")
 
268
 
 
269
 
 
270
class NoPublicBranch(BzrError):
 
271
 
 
272
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
273
 
 
274
    def __init__(self, branch):
 
275
        import bzrlib.urlutils as urlutils
 
276
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
277
        BzrError.__init__(self, branch_url=public_location)
 
278
 
 
279
 
 
280
class NoHelpTopic(BzrError):
 
281
 
 
282
    _fmt = ("No help could be found for '%(topic)s'. "
 
283
        "Please use 'bzr help topics' to obtain a list of topics.")
 
284
 
 
285
    def __init__(self, topic):
 
286
        self.topic = topic
 
287
 
 
288
 
 
289
class NoSuchId(BzrError):
 
290
 
 
291
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
292
    
 
293
    def __init__(self, tree, file_id):
 
294
        BzrError.__init__(self)
 
295
        self.file_id = file_id
 
296
        self.tree = tree
 
297
 
 
298
 
 
299
class NoSuchIdInRepository(NoSuchId):
 
300
 
 
301
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
302
            ' %(repository)r')
 
303
 
 
304
    def __init__(self, repository, file_id):
 
305
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
306
 
 
307
 
 
308
class InventoryModified(InternalBzrError):
 
309
 
 
310
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
311
            " so a clean inventory cannot be read without data loss.")
 
312
 
 
313
    def __init__(self, tree):
 
314
        self.tree = tree
 
315
 
 
316
 
 
317
class NoWorkingTree(BzrError):
 
318
 
 
319
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
320
    
 
321
    def __init__(self, base):
 
322
        BzrError.__init__(self)
 
323
        self.base = base
 
324
 
 
325
 
 
326
class NotBuilding(BzrError):
 
327
 
 
328
    _fmt = "Not currently building a tree."
 
329
 
 
330
 
 
331
class NotLocalUrl(BzrError):
 
332
 
 
333
    _fmt = "%(url)s is not a local path."
 
334
 
 
335
    def __init__(self, url):
 
336
        self.url = url
 
337
 
 
338
 
 
339
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
340
 
 
341
    _fmt = 'Working tree already populated in "%(base)s"'
 
342
 
 
343
    def __init__(self, base):
 
344
        self.base = base
 
345
 
 
346
 
 
347
class BzrCommandError(BzrError):
 
348
    """Error from user command"""
 
349
 
 
350
    # Error from malformed user command; please avoid raising this as a
 
351
    # generic exception not caused by user input.
 
352
    #
 
353
    # I think it's a waste of effort to differentiate between errors that
 
354
    # are not intended to be caught anyway.  UI code need not subclass
 
355
    # BzrCommandError, and non-UI code should not throw a subclass of
 
356
    # BzrCommandError.  ADHB 20051211
 
357
    def __init__(self, msg):
 
358
        # Object.__str__() must return a real string
 
359
        # returning a Unicode string is a python error.
 
360
        if isinstance(msg, unicode):
 
361
            self.msg = msg.encode('utf8')
 
362
        else:
 
363
            self.msg = msg
 
364
 
 
365
    def __str__(self):
 
366
        return self.msg
 
367
 
 
368
 
 
369
class NotWriteLocked(BzrError):
 
370
 
 
371
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
372
 
 
373
    def __init__(self, not_locked):
 
374
        self.not_locked = not_locked
 
375
 
 
376
 
 
377
class BzrOptionError(BzrCommandError):
 
378
 
 
379
    _fmt = "Error in command line options"
 
380
 
 
381
 
 
382
class BadIndexFormatSignature(BzrError):
 
383
 
 
384
    _fmt = "%(value)s is not an index of type %(_type)s."
 
385
 
 
386
    def __init__(self, value, _type):
 
387
        BzrError.__init__(self)
 
388
        self.value = value
 
389
        self._type = _type
 
390
 
 
391
 
 
392
class BadIndexData(BzrError):
 
393
 
 
394
    _fmt = "Error in data for index %(value)s."
 
395
 
 
396
    def __init__(self, value):
 
397
        BzrError.__init__(self)
 
398
        self.value = value
 
399
 
 
400
 
 
401
class BadIndexDuplicateKey(BzrError):
 
402
 
 
403
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
404
 
 
405
    def __init__(self, key, index):
 
406
        BzrError.__init__(self)
 
407
        self.key = key
 
408
        self.index = index
 
409
 
 
410
 
 
411
class BadIndexKey(BzrError):
 
412
 
 
413
    _fmt = "The key '%(key)s' is not a valid key."
 
414
 
 
415
    def __init__(self, key):
 
416
        BzrError.__init__(self)
 
417
        self.key = key
 
418
 
 
419
 
 
420
class BadIndexOptions(BzrError):
 
421
 
 
422
    _fmt = "Could not parse options for index %(value)s."
 
423
 
 
424
    def __init__(self, value):
 
425
        BzrError.__init__(self)
 
426
        self.value = value
 
427
 
 
428
 
 
429
class BadIndexValue(BzrError):
 
430
 
 
431
    _fmt = "The value '%(value)s' is not a valid value."
 
432
 
 
433
    def __init__(self, value):
 
434
        BzrError.__init__(self)
 
435
        self.value = value
 
436
 
 
437
 
 
438
class BadOptionValue(BzrError):
 
439
 
 
440
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
441
 
 
442
    def __init__(self, name, value):
 
443
        BzrError.__init__(self, name=name, value=value)
 
444
 
 
445
    
 
446
class StrictCommitFailed(BzrError):
 
447
 
 
448
    _fmt = "Commit refused because there are unknown files in the tree"
 
449
 
 
450
 
 
451
# XXX: Should be unified with TransportError; they seem to represent the
 
452
# same thing
 
453
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
454
# - this is finer than a TransportError - and more useful as such. It 
 
455
# differentiates between 'transport has failed' and 'operation on a transport
 
456
# has failed.'
 
457
class PathError(BzrError):
 
458
    
 
459
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
460
 
 
461
    def __init__(self, path, extra=None):
 
462
        BzrError.__init__(self)
 
463
        self.path = path
 
464
        if extra:
 
465
            self.extra = ': ' + str(extra)
 
466
        else:
 
467
            self.extra = ''
 
468
 
 
469
 
 
470
class NoSuchFile(PathError):
 
471
 
 
472
    _fmt = "No such file: %(path)r%(extra)s"
 
473
 
 
474
 
 
475
class FileExists(PathError):
 
476
 
 
477
    _fmt = "File exists: %(path)r%(extra)s"
 
478
 
 
479
 
 
480
class RenameFailedFilesExist(BzrError):
 
481
    """Used when renaming and both source and dest exist."""
 
482
 
 
483
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
484
            " (Use --after to tell bzr about a rename that has already"
 
485
            " happened)%(extra)s")
 
486
 
 
487
    def __init__(self, source, dest, extra=None):
 
488
        BzrError.__init__(self)
 
489
        self.source = str(source)
 
490
        self.dest = str(dest)
 
491
        if extra:
 
492
            self.extra = ' ' + str(extra)
 
493
        else:
 
494
            self.extra = ''
 
495
 
 
496
 
 
497
class NotADirectory(PathError):
 
498
 
 
499
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
500
 
 
501
 
 
502
class NotInWorkingDirectory(PathError):
 
503
 
 
504
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
505
 
 
506
 
 
507
class DirectoryNotEmpty(PathError):
 
508
 
 
509
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
510
 
 
511
 
 
512
class HardLinkNotSupported(PathError):
 
513
 
 
514
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
515
 
 
516
 
 
517
class ReadingCompleted(InternalBzrError):
 
518
    
 
519
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
520
            "called upon it - the request has been completed and no more "
 
521
            "data may be read.")
 
522
 
 
523
    def __init__(self, request):
 
524
        self.request = request
 
525
 
 
526
 
 
527
class ResourceBusy(PathError):
 
528
 
 
529
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
530
 
 
531
 
 
532
class PermissionDenied(PathError):
 
533
 
 
534
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
535
 
 
536
 
 
537
class InvalidURL(PathError):
 
538
 
 
539
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
540
 
 
541
 
 
542
class InvalidURLJoin(PathError):
 
543
 
 
544
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
545
 
 
546
    def __init__(self, reason, base, join_args):
 
547
        self.reason = reason
 
548
        self.base = base
 
549
        self.join_args = join_args
 
550
        PathError.__init__(self, base, reason)
 
551
 
 
552
 
 
553
class UnknownHook(BzrError):
 
554
 
 
555
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
556
 
 
557
    def __init__(self, hook_type, hook_name):
 
558
        BzrError.__init__(self)
 
559
        self.type = hook_type
 
560
        self.hook = hook_name
 
561
 
 
562
 
 
563
class UnsupportedProtocol(PathError):
 
564
 
 
565
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
566
 
 
567
    def __init__(self, url, extra):
 
568
        PathError.__init__(self, url, extra=extra)
 
569
 
 
570
 
 
571
class ReadError(PathError):
 
572
    
 
573
    _fmt = """Error reading from %(path)r."""
 
574
 
 
575
 
 
576
class ShortReadvError(PathError):
 
577
 
 
578
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
579
            ' at %(offset)s for "%(path)s"%(extra)s')
 
580
 
 
581
    internal_error = True
 
582
 
 
583
    def __init__(self, path, offset, length, actual, extra=None):
 
584
        PathError.__init__(self, path, extra=extra)
 
585
        self.offset = offset
 
586
        self.length = length
 
587
        self.actual = actual
 
588
 
 
589
 
 
590
class PathNotChild(PathError):
 
591
 
 
592
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
593
 
 
594
    internal_error = True
 
595
 
 
596
    def __init__(self, path, base, extra=None):
 
597
        BzrError.__init__(self)
 
598
        self.path = path
 
599
        self.base = base
 
600
        if extra:
 
601
            self.extra = ': ' + str(extra)
 
602
        else:
 
603
            self.extra = ''
 
604
 
 
605
 
 
606
class InvalidNormalization(PathError):
 
607
 
 
608
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
609
 
 
610
 
 
611
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
612
# the exception object is a bit undesirable.
 
613
# TODO: Probably this behavior of should be a common superclass 
 
614
class NotBranchError(PathError):
 
615
 
 
616
    _fmt = 'Not a branch: "%(path)s".'
 
617
 
 
618
    def __init__(self, path):
 
619
       import bzrlib.urlutils as urlutils
 
620
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
621
 
 
622
 
 
623
class NoSubmitBranch(PathError):
 
624
 
 
625
    _fmt = 'No submit branch available for branch "%(path)s"'
 
626
 
 
627
    def __init__(self, branch):
 
628
       import bzrlib.urlutils as urlutils
 
629
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
630
 
 
631
 
 
632
class AlreadyBranchError(PathError):
 
633
 
 
634
    _fmt = 'Already a branch: "%(path)s".'
 
635
 
 
636
 
 
637
class BranchExistsWithoutWorkingTree(PathError):
 
638
 
 
639
    _fmt = 'Directory contains a branch, but no working tree \
 
640
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
641
 
 
642
 
 
643
class AtomicFileAlreadyClosed(PathError):
 
644
 
 
645
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
646
            ' "%(path)s"')
 
647
 
 
648
    def __init__(self, path, function):
 
649
        PathError.__init__(self, path=path, extra=None)
 
650
        self.function = function
 
651
 
 
652
 
 
653
class InaccessibleParent(PathError):
 
654
 
 
655
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
656
            ' relative path "%(path)s"')
 
657
 
 
658
    def __init__(self, path, base):
 
659
        PathError.__init__(self, path)
 
660
        self.base = base
 
661
 
 
662
 
 
663
class NoRepositoryPresent(BzrError):
 
664
 
 
665
    _fmt = 'No repository present: "%(path)s"'
 
666
    def __init__(self, bzrdir):
 
667
        BzrError.__init__(self)
 
668
        self.path = bzrdir.transport.clone('..').base
 
669
 
 
670
 
 
671
class FileInWrongBranch(BzrError):
 
672
 
 
673
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
674
 
 
675
    def __init__(self, branch, path):
 
676
        BzrError.__init__(self)
 
677
        self.branch = branch
 
678
        self.branch_base = branch.base
 
679
        self.path = path
 
680
 
 
681
 
 
682
class UnsupportedFormatError(BzrError):
 
683
 
 
684
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
 
685
 
 
686
 
 
687
class UnknownFormatError(BzrError):
 
688
    
 
689
    _fmt = "Unknown %(kind)s format: %(format)r"
 
690
 
 
691
    def __init__(self, format, kind='branch'):
 
692
        self.kind = kind
 
693
        self.format = format
 
694
 
 
695
 
 
696
class IncompatibleFormat(BzrError):
 
697
    
 
698
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
699
 
 
700
    def __init__(self, format, bzrdir_format):
 
701
        BzrError.__init__(self)
 
702
        self.format = format
 
703
        self.bzrdir = bzrdir_format
 
704
 
 
705
 
 
706
class IncompatibleRepositories(BzrError):
 
707
 
 
708
    _fmt = "Repository %(target)s is not compatible with repository"\
 
709
        " %(source)s"
 
710
 
 
711
    def __init__(self, source, target):
 
712
        BzrError.__init__(self, target=target, source=source)
 
713
 
 
714
 
 
715
class IncompatibleRevision(BzrError):
 
716
    
 
717
    _fmt = "Revision is not compatible with %(repo_format)s"
 
718
 
 
719
    def __init__(self, repo_format):
 
720
        BzrError.__init__(self)
 
721
        self.repo_format = repo_format
 
722
 
 
723
 
 
724
class AlreadyVersionedError(BzrError):
 
725
    """Used when a path is expected not to be versioned, but it is."""
 
726
 
 
727
    _fmt = "%(context_info)s%(path)s is already versioned."
 
728
 
 
729
    def __init__(self, path, context_info=None):
 
730
        """Construct a new AlreadyVersionedError.
 
731
 
 
732
        :param path: This is the path which is versioned,
 
733
        which should be in a user friendly form.
 
734
        :param context_info: If given, this is information about the context,
 
735
        which could explain why this is expected to not be versioned.
 
736
        """
 
737
        BzrError.__init__(self)
 
738
        self.path = path
 
739
        if context_info is None:
 
740
            self.context_info = ''
 
741
        else:
 
742
            self.context_info = context_info + ". "
 
743
 
 
744
 
 
745
class NotVersionedError(BzrError):
 
746
    """Used when a path is expected to be versioned, but it is not."""
 
747
 
 
748
    _fmt = "%(context_info)s%(path)s is not versioned."
 
749
 
 
750
    def __init__(self, path, context_info=None):
 
751
        """Construct a new NotVersionedError.
 
752
 
 
753
        :param path: This is the path which is not versioned,
 
754
        which should be in a user friendly form.
 
755
        :param context_info: If given, this is information about the context,
 
756
        which could explain why this is expected to be versioned.
 
757
        """
 
758
        BzrError.__init__(self)
 
759
        self.path = path
 
760
        if context_info is None:
 
761
            self.context_info = ''
 
762
        else:
 
763
            self.context_info = context_info + ". "
 
764
 
 
765
 
 
766
class PathsNotVersionedError(BzrError):
 
767
    """Used when reporting several paths which are not versioned"""
 
768
 
 
769
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
770
 
 
771
    def __init__(self, paths):
 
772
        from bzrlib.osutils import quotefn
 
773
        BzrError.__init__(self)
 
774
        self.paths = paths
 
775
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
776
 
 
777
 
 
778
class PathsDoNotExist(BzrError):
 
779
 
 
780
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
781
 
 
782
    # used when reporting that paths are neither versioned nor in the working
 
783
    # tree
 
784
 
 
785
    def __init__(self, paths, extra=None):
 
786
        # circular import
 
787
        from bzrlib.osutils import quotefn
 
788
        BzrError.__init__(self)
 
789
        self.paths = paths
 
790
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
791
        if extra:
 
792
            self.extra = ': ' + str(extra)
 
793
        else:
 
794
            self.extra = ''
 
795
 
 
796
 
 
797
class BadFileKindError(BzrError):
 
798
 
 
799
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
800
 
 
801
    def __init__(self, filename, kind):
 
802
        BzrError.__init__(self, filename=filename, kind=kind)
 
803
 
 
804
 
 
805
class ForbiddenControlFileError(BzrError):
 
806
 
 
807
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
808
 
 
809
 
 
810
class LockError(InternalBzrError):
 
811
 
 
812
    _fmt = "Lock error: %(msg)s"
 
813
 
 
814
    # All exceptions from the lock/unlock functions should be from
 
815
    # this exception class.  They will be translated as necessary. The
 
816
    # original exception is available as e.original_error
 
817
    #
 
818
    # New code should prefer to raise specific subclasses
 
819
    def __init__(self, message):
 
820
        # Python 2.5 uses a slot for StandardError.message,
 
821
        # so use a different variable name.  We now work around this in
 
822
        # BzrError.__str__, but this member name is kept for compatability.
 
823
        self.msg = message
 
824
 
 
825
 
 
826
class LockActive(LockError):
 
827
 
 
828
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
829
 
 
830
    internal_error = False
 
831
 
 
832
    def __init__(self, lock_description):
 
833
        self.lock_description = lock_description
 
834
 
 
835
 
 
836
class CommitNotPossible(LockError):
 
837
 
 
838
    _fmt = "A commit was attempted but we do not have a write lock open."
 
839
 
 
840
    def __init__(self):
 
841
        pass
 
842
 
 
843
 
 
844
class AlreadyCommitted(LockError):
 
845
 
 
846
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
847
 
 
848
    def __init__(self):
 
849
        pass
 
850
 
 
851
 
 
852
class ReadOnlyError(LockError):
 
853
 
 
854
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
855
 
 
856
    # TODO: There should also be an error indicating that you need a write
 
857
    # lock and don't have any lock at all... mbp 20070226
 
858
 
 
859
    def __init__(self, obj):
 
860
        self.obj = obj
 
861
 
 
862
 
 
863
class ReadOnlyLockError(LockError):
 
864
 
 
865
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
866
 
 
867
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
868
    def __init__(self, fname, msg):
 
869
        LockError.__init__(self, '')
 
870
        self.fname = fname
 
871
        self.msg = msg
 
872
 
 
873
 
 
874
class LockFailed(LockError):
 
875
 
 
876
    internal_error = False
 
877
 
 
878
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
879
 
 
880
    def __init__(self, lock, why):
 
881
        LockError.__init__(self, '')
 
882
        self.lock = lock
 
883
        self.why = why
 
884
 
 
885
 
 
886
class OutSideTransaction(BzrError):
 
887
 
 
888
    _fmt = ("A transaction related operation was attempted after"
 
889
            " the transaction finished.")
 
890
 
 
891
 
 
892
class ObjectNotLocked(LockError):
 
893
 
 
894
    _fmt = "%(obj)r is not locked"
 
895
 
 
896
    # this can indicate that any particular object is not locked; see also
 
897
    # LockNotHeld which means that a particular *lock* object is not held by
 
898
    # the caller -- perhaps they should be unified.
 
899
    def __init__(self, obj):
 
900
        self.obj = obj
 
901
 
 
902
 
 
903
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
904
 
 
905
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
906
 
 
907
    def __init__(self, obj):
 
908
        self.obj = obj
 
909
 
 
910
 
 
911
class UnlockableTransport(LockError):
 
912
 
 
913
    internal_error = False
 
914
 
 
915
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
916
 
 
917
    def __init__(self, transport):
 
918
        self.transport = transport
 
919
 
 
920
 
 
921
class LockContention(LockError):
 
922
 
 
923
    _fmt = 'Could not acquire lock "%(lock)s"'
 
924
    # TODO: show full url for lock, combining the transport and relative
 
925
    # bits?
 
926
 
 
927
    internal_error = False
 
928
 
 
929
    def __init__(self, lock):
 
930
        self.lock = lock
 
931
 
 
932
 
 
933
class LockBroken(LockError):
 
934
 
 
935
    _fmt = ("Lock was broken while still open: %(lock)s"
 
936
            " - check storage consistency!")
 
937
 
 
938
    internal_error = False
 
939
 
 
940
    def __init__(self, lock):
 
941
        self.lock = lock
 
942
 
 
943
 
 
944
class LockBreakMismatch(LockError):
 
945
 
 
946
    _fmt = ("Lock was released and re-acquired before being broken:"
 
947
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
948
 
 
949
    internal_error = False
 
950
 
 
951
    def __init__(self, lock, holder, target):
 
952
        self.lock = lock
 
953
        self.holder = holder
 
954
        self.target = target
 
955
 
 
956
 
 
957
class LockNotHeld(LockError):
 
958
 
 
959
    _fmt = "Lock not held: %(lock)s"
 
960
 
 
961
    internal_error = False
 
962
 
 
963
    def __init__(self, lock):
 
964
        self.lock = lock
 
965
 
 
966
 
 
967
class TokenLockingNotSupported(LockError):
 
968
 
 
969
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
970
 
 
971
    def __init__(self, obj):
 
972
        self.obj = obj
 
973
 
 
974
 
 
975
class TokenMismatch(LockBroken):
 
976
 
 
977
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
978
 
 
979
    internal_error = True
 
980
 
 
981
    def __init__(self, given_token, lock_token):
 
982
        self.given_token = given_token
 
983
        self.lock_token = lock_token
 
984
 
 
985
 
 
986
class PointlessCommit(BzrError):
 
987
 
 
988
    _fmt = "No changes to commit"
 
989
 
 
990
 
 
991
class CannotCommitSelectedFileMerge(BzrError):
 
992
 
 
993
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
994
        ' files %(files_str)s'
 
995
 
 
996
    def __init__(self, files):
 
997
        files_str = ', '.join(files)
 
998
        BzrError.__init__(self, files=files, files_str=files_str)
 
999
 
 
1000
 
 
1001
class BadCommitMessageEncoding(BzrError):
 
1002
 
 
1003
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1004
        'the current encoding.'
 
1005
 
 
1006
 
 
1007
class UpgradeReadonly(BzrError):
 
1008
 
 
1009
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
1010
 
 
1011
 
 
1012
class UpToDateFormat(BzrError):
 
1013
 
 
1014
    _fmt = "The branch format %(format)s is already at the most recent format."
 
1015
 
 
1016
    def __init__(self, format):
 
1017
        BzrError.__init__(self)
 
1018
        self.format = format
 
1019
 
 
1020
 
 
1021
class StrictCommitFailed(Exception):
 
1022
 
 
1023
    _fmt = "Commit refused because there are unknowns in the tree."
 
1024
 
 
1025
 
 
1026
class NoSuchRevision(InternalBzrError):
 
1027
 
 
1028
    _fmt = "%(branch)s has no revision %(revision)s"
 
1029
 
 
1030
    def __init__(self, branch, revision):
 
1031
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1032
        BzrError.__init__(self, branch=branch, revision=revision)
 
1033
 
 
1034
 
 
1035
# zero_ninetyone: this exception is no longer raised and should be removed
 
1036
class NotLeftParentDescendant(InternalBzrError):
 
1037
 
 
1038
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
1039
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
1040
 
 
1041
    def __init__(self, branch, old_revision, new_revision):
 
1042
        BzrError.__init__(self, branch_location=branch.base,
 
1043
                          old_revision=old_revision,
 
1044
                          new_revision=new_revision)
 
1045
 
 
1046
 
 
1047
class RangeInChangeOption(BzrError):
 
1048
 
 
1049
    _fmt = "Option --change does not accept revision ranges"
 
1050
 
 
1051
 
 
1052
class NoSuchRevisionSpec(BzrError):
 
1053
 
 
1054
    _fmt = "No namespace registered for string: %(spec)r"
 
1055
 
 
1056
    def __init__(self, spec):
 
1057
        BzrError.__init__(self, spec=spec)
 
1058
 
 
1059
 
 
1060
class NoSuchRevisionInTree(NoSuchRevision):
 
1061
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1062
    
 
1063
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1064
 
 
1065
    def __init__(self, tree, revision_id):
 
1066
        BzrError.__init__(self)
 
1067
        self.tree = tree
 
1068
        self.revision_id = revision_id
 
1069
 
 
1070
 
 
1071
class InvalidRevisionSpec(BzrError):
 
1072
 
 
1073
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1074
            " %(branch)s%(extra)s")
 
1075
 
 
1076
    def __init__(self, spec, branch, extra=None):
 
1077
        BzrError.__init__(self, branch=branch, spec=spec)
 
1078
        if extra:
 
1079
            self.extra = '\n' + str(extra)
 
1080
        else:
 
1081
            self.extra = ''
 
1082
 
 
1083
 
 
1084
class HistoryMissing(BzrError):
 
1085
 
 
1086
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1087
 
 
1088
 
 
1089
class AppendRevisionsOnlyViolation(BzrError):
 
1090
 
 
1091
    _fmt = ('Operation denied because it would change the main history,'
 
1092
           ' which is not permitted by the append_revisions_only setting on'
 
1093
           ' branch "%(location)s".')
 
1094
 
 
1095
    def __init__(self, location):
 
1096
       import bzrlib.urlutils as urlutils
 
1097
       location = urlutils.unescape_for_display(location, 'ascii')
 
1098
       BzrError.__init__(self, location=location)
 
1099
 
 
1100
 
 
1101
class DivergedBranches(BzrError):
 
1102
 
 
1103
    _fmt = ("These branches have diverged."
 
1104
            " Use the merge command to reconcile them.")
 
1105
 
 
1106
    def __init__(self, branch1, branch2):
 
1107
        self.branch1 = branch1
 
1108
        self.branch2 = branch2
 
1109
 
 
1110
 
 
1111
class NotLefthandHistory(InternalBzrError):
 
1112
 
 
1113
    _fmt = "Supplied history does not follow left-hand parents"
 
1114
 
 
1115
    def __init__(self, history):
 
1116
        BzrError.__init__(self, history=history)
 
1117
 
 
1118
 
 
1119
class UnrelatedBranches(BzrError):
 
1120
 
 
1121
    _fmt = ("Branches have no common ancestor, and"
 
1122
            " no merge base revision was specified.")
 
1123
 
 
1124
 
 
1125
class CannotReverseCherrypick(BzrError):
 
1126
 
 
1127
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1128
            ' or diff3.')
 
1129
 
 
1130
 
 
1131
class NoCommonAncestor(BzrError):
 
1132
    
 
1133
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1134
 
 
1135
    def __init__(self, revision_a, revision_b):
 
1136
        self.revision_a = revision_a
 
1137
        self.revision_b = revision_b
 
1138
 
 
1139
 
 
1140
class NoCommonRoot(BzrError):
 
1141
 
 
1142
    _fmt = ("Revisions are not derived from the same root: "
 
1143
           "%(revision_a)s %(revision_b)s.")
 
1144
 
 
1145
    def __init__(self, revision_a, revision_b):
 
1146
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1147
 
 
1148
 
 
1149
class NotAncestor(BzrError):
 
1150
 
 
1151
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1152
 
 
1153
    def __init__(self, rev_id, not_ancestor_id):
 
1154
        BzrError.__init__(self, rev_id=rev_id,
 
1155
            not_ancestor_id=not_ancestor_id)
 
1156
 
 
1157
 
 
1158
class InstallFailed(BzrError):
 
1159
 
 
1160
    def __init__(self, revisions):
 
1161
        revision_str = ", ".join(str(r) for r in revisions)
 
1162
        msg = "Could not install revisions:\n%s" % revision_str
 
1163
        BzrError.__init__(self, msg)
 
1164
        self.revisions = revisions
 
1165
 
 
1166
 
 
1167
class AmbiguousBase(BzrError):
 
1168
 
 
1169
    def __init__(self, bases):
 
1170
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
1171
                DeprecationWarning)
 
1172
        msg = ("The correct base is unclear, because %s are all equally close"
 
1173
                % ", ".join(bases))
 
1174
        BzrError.__init__(self, msg)
 
1175
        self.bases = bases
 
1176
 
 
1177
 
 
1178
class NoCommits(BzrError):
 
1179
 
 
1180
    _fmt = "Branch %(branch)s has no commits."
 
1181
 
 
1182
    def __init__(self, branch):
 
1183
        BzrError.__init__(self, branch=branch)
 
1184
 
 
1185
 
 
1186
class UnlistableStore(BzrError):
 
1187
 
 
1188
    def __init__(self, store):
 
1189
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1190
 
 
1191
 
 
1192
 
 
1193
class UnlistableBranch(BzrError):
 
1194
 
 
1195
    def __init__(self, br):
 
1196
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1197
 
 
1198
 
 
1199
class BoundBranchOutOfDate(BzrError):
 
1200
 
 
1201
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1202
            " %(master)s.")
 
1203
 
 
1204
    def __init__(self, branch, master):
 
1205
        BzrError.__init__(self)
 
1206
        self.branch = branch
 
1207
        self.master = master
 
1208
 
 
1209
        
 
1210
class CommitToDoubleBoundBranch(BzrError):
 
1211
 
 
1212
    _fmt = ("Cannot commit to branch %(branch)s."
 
1213
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1214
 
 
1215
    def __init__(self, branch, master, remote):
 
1216
        BzrError.__init__(self)
 
1217
        self.branch = branch
 
1218
        self.master = master
 
1219
        self.remote = remote
 
1220
 
 
1221
 
 
1222
class OverwriteBoundBranch(BzrError):
 
1223
 
 
1224
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1225
 
 
1226
    def __init__(self, branch):
 
1227
        BzrError.__init__(self)
 
1228
        self.branch = branch
 
1229
 
 
1230
 
 
1231
class BoundBranchConnectionFailure(BzrError):
 
1232
 
 
1233
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1234
            " => %(target)s: %(error)s")
 
1235
 
 
1236
    def __init__(self, branch, target, error):
 
1237
        BzrError.__init__(self)
 
1238
        self.branch = branch
 
1239
        self.target = target
 
1240
        self.error = error
 
1241
 
 
1242
 
 
1243
class WeaveError(BzrError):
 
1244
 
 
1245
    _fmt = "Error in processing weave: %(message)s"
 
1246
 
 
1247
    def __init__(self, message=None):
 
1248
        BzrError.__init__(self)
 
1249
        self.message = message
 
1250
 
 
1251
 
 
1252
class WeaveRevisionAlreadyPresent(WeaveError):
 
1253
 
 
1254
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1255
 
 
1256
    def __init__(self, revision_id, weave):
 
1257
 
 
1258
        WeaveError.__init__(self)
 
1259
        self.revision_id = revision_id
 
1260
        self.weave = weave
 
1261
 
 
1262
 
 
1263
class WeaveRevisionNotPresent(WeaveError):
 
1264
 
 
1265
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1266
 
 
1267
    def __init__(self, revision_id, weave):
 
1268
        WeaveError.__init__(self)
 
1269
        self.revision_id = revision_id
 
1270
        self.weave = weave
 
1271
 
 
1272
 
 
1273
class WeaveFormatError(WeaveError):
 
1274
 
 
1275
    _fmt = "Weave invariant violated: %(what)s"
 
1276
 
 
1277
    def __init__(self, what):
 
1278
        WeaveError.__init__(self)
 
1279
        self.what = what
 
1280
 
 
1281
 
 
1282
class WeaveParentMismatch(WeaveError):
 
1283
 
 
1284
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1285
    
 
1286
 
 
1287
class WeaveInvalidChecksum(WeaveError):
 
1288
 
 
1289
    _fmt = "Text did not match it's checksum: %(message)s"
 
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 WeaveTextDiffers(WeaveError):
 
1305
 
 
1306
    _fmt = ("Weaves differ on text content. Revision:"
 
1307
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1308
 
 
1309
    def __init__(self, revision_id, weave_a, weave_b):
 
1310
        WeaveError.__init__(self)
 
1311
        self.revision_id = revision_id
 
1312
        self.weave_a = weave_a
 
1313
        self.weave_b = weave_b
 
1314
 
 
1315
 
 
1316
class VersionedFileError(BzrError):
 
1317
    
 
1318
    _fmt = "Versioned file error"
 
1319
 
 
1320
 
 
1321
class RevisionNotPresent(VersionedFileError):
 
1322
    
 
1323
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1324
 
 
1325
    def __init__(self, revision_id, file_id):
 
1326
        VersionedFileError.__init__(self)
 
1327
        self.revision_id = revision_id
 
1328
        self.file_id = file_id
 
1329
 
 
1330
 
 
1331
class RevisionAlreadyPresent(VersionedFileError):
 
1332
    
 
1333
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1334
 
 
1335
    def __init__(self, revision_id, file_id):
 
1336
        VersionedFileError.__init__(self)
 
1337
        self.revision_id = revision_id
 
1338
        self.file_id = file_id
 
1339
 
 
1340
 
 
1341
class VersionedFileInvalidChecksum(VersionedFileError):
 
1342
 
 
1343
    _fmt = "Text did not match its checksum: %(message)s"
 
1344
 
 
1345
 
 
1346
class KnitError(InternalBzrError):
 
1347
    
 
1348
    _fmt = "Knit error"
 
1349
 
 
1350
 
 
1351
class KnitCorrupt(KnitError):
 
1352
 
 
1353
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1354
 
 
1355
    def __init__(self, filename, how):
 
1356
        KnitError.__init__(self)
 
1357
        self.filename = filename
 
1358
        self.how = how
 
1359
 
 
1360
 
 
1361
class KnitDataStreamIncompatible(KnitError):
 
1362
    # Not raised anymore, as we can convert data streams.  In future we may
 
1363
    # need it again for more exotic cases, so we're keeping it around for now.
 
1364
 
 
1365
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1366
 
 
1367
    def __init__(self, stream_format, target_format):
 
1368
        self.stream_format = stream_format
 
1369
        self.target_format = target_format
 
1370
        
 
1371
 
 
1372
class KnitDataStreamUnknown(KnitError):
 
1373
    # Indicates a data stream we don't know how to handle.
 
1374
 
 
1375
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1376
 
 
1377
    def __init__(self, stream_format):
 
1378
        self.stream_format = stream_format
 
1379
        
 
1380
 
 
1381
class KnitHeaderError(KnitError):
 
1382
 
 
1383
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1384
 
 
1385
    def __init__(self, badline, filename):
 
1386
        KnitError.__init__(self)
 
1387
        self.badline = badline
 
1388
        self.filename = filename
 
1389
 
 
1390
class KnitIndexUnknownMethod(KnitError):
 
1391
    """Raised when we don't understand the storage method.
 
1392
 
 
1393
    Currently only 'fulltext' and 'line-delta' are supported.
 
1394
    """
 
1395
    
 
1396
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1397
            " in options: %(options)r")
 
1398
 
 
1399
    def __init__(self, filename, options):
 
1400
        KnitError.__init__(self)
 
1401
        self.filename = filename
 
1402
        self.options = options
 
1403
 
 
1404
 
 
1405
class NoSuchExportFormat(BzrError):
 
1406
    
 
1407
    _fmt = "Export format %(format)r not supported"
 
1408
 
 
1409
    def __init__(self, format):
 
1410
        BzrError.__init__(self)
 
1411
        self.format = format
 
1412
 
 
1413
 
 
1414
class TransportError(BzrError):
 
1415
    
 
1416
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1417
 
 
1418
    def __init__(self, msg=None, orig_error=None):
 
1419
        if msg is None and orig_error is not None:
 
1420
            msg = str(orig_error)
 
1421
        if orig_error is None:
 
1422
            orig_error = ''
 
1423
        if msg is None:
 
1424
            msg =  ''
 
1425
        self.msg = msg
 
1426
        self.orig_error = orig_error
 
1427
        BzrError.__init__(self)
 
1428
 
 
1429
 
 
1430
class TooManyConcurrentRequests(InternalBzrError):
 
1431
 
 
1432
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1433
            " Be sure to finish_writing and finish_reading on the"
 
1434
            " currently open request.")
 
1435
 
 
1436
    def __init__(self, medium):
 
1437
        self.medium = medium
 
1438
 
 
1439
 
 
1440
class SmartProtocolError(TransportError):
 
1441
 
 
1442
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1443
 
 
1444
    def __init__(self, details):
 
1445
        self.details = details
 
1446
 
 
1447
 
 
1448
# A set of semi-meaningful errors which can be thrown
 
1449
class TransportNotPossible(TransportError):
 
1450
 
 
1451
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1452
 
 
1453
 
 
1454
class ConnectionError(TransportError):
 
1455
 
 
1456
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1457
 
 
1458
 
 
1459
class SocketConnectionError(ConnectionError):
 
1460
 
 
1461
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1462
 
 
1463
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1464
        if msg is None:
 
1465
            msg = 'Failed to connect to'
 
1466
        if orig_error is None:
 
1467
            orig_error = ''
 
1468
        else:
 
1469
            orig_error = '; ' + str(orig_error)
 
1470
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1471
        self.host = host
 
1472
        if port is None:
 
1473
            self.port = ''
 
1474
        else:
 
1475
            self.port = ':%s' % port
 
1476
 
 
1477
 
 
1478
class ConnectionReset(TransportError):
 
1479
 
 
1480
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1481
 
 
1482
 
 
1483
class InvalidRange(TransportError):
 
1484
 
 
1485
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1486
 
 
1487
    def __init__(self, path, offset, msg=None):
 
1488
        TransportError.__init__(self, msg)
 
1489
        self.path = path
 
1490
        self.offset = offset
 
1491
 
 
1492
 
 
1493
class InvalidHttpResponse(TransportError):
 
1494
 
 
1495
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1496
 
 
1497
    def __init__(self, path, msg, orig_error=None):
 
1498
        self.path = path
 
1499
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1500
 
 
1501
 
 
1502
class InvalidHttpRange(InvalidHttpResponse):
 
1503
 
 
1504
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1505
 
 
1506
    def __init__(self, path, range, msg):
 
1507
        self.range = range
 
1508
        InvalidHttpResponse.__init__(self, path, msg)
 
1509
 
 
1510
 
 
1511
class InvalidHttpContentType(InvalidHttpResponse):
 
1512
 
 
1513
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1514
 
 
1515
    def __init__(self, path, ctype, msg):
 
1516
        self.ctype = ctype
 
1517
        InvalidHttpResponse.__init__(self, path, msg)
 
1518
 
 
1519
 
 
1520
class RedirectRequested(TransportError):
 
1521
 
 
1522
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1523
 
 
1524
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1525
        self.source = source
 
1526
        self.target = target
 
1527
        if is_permanent:
 
1528
            self.permanently = ' permanently'
 
1529
        else:
 
1530
            self.permanently = ''
 
1531
        self._qualified_proto = qual_proto
 
1532
        TransportError.__init__(self)
 
1533
 
 
1534
    def _requalify_url(self, url):
 
1535
        """Restore the qualified proto in front of the url"""
 
1536
        # When this exception is raised, source and target are in
 
1537
        # user readable format. But some transports may use a
 
1538
        # different proto (http+urllib:// will present http:// to
 
1539
        # the user. If a qualified proto is specified, the code
 
1540
        # trapping the exception can get the qualified urls to
 
1541
        # properly handle the redirection themself (creating a
 
1542
        # new transport object from the target url for example).
 
1543
        # But checking that the scheme of the original and
 
1544
        # redirected urls are the same can be tricky. (see the
 
1545
        # FIXME in BzrDir.open_from_transport for the unique use
 
1546
        # case so far).
 
1547
        if self._qualified_proto is None:
 
1548
            return url
 
1549
 
 
1550
        # The TODO related to NotBranchError mention that doing
 
1551
        # that kind of manipulation on the urls may not be the
 
1552
        # exception object job. On the other hand, this object is
 
1553
        # the interface between the code and the user so
 
1554
        # presenting the urls in different ways is indeed its
 
1555
        # job...
 
1556
        import urlparse
 
1557
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1558
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1559
                                   query, fragment))
 
1560
 
 
1561
    def get_source_url(self):
 
1562
        return self._requalify_url(self.source)
 
1563
 
 
1564
    def get_target_url(self):
 
1565
        return self._requalify_url(self.target)
 
1566
 
 
1567
 
 
1568
class TooManyRedirections(TransportError):
 
1569
 
 
1570
    _fmt = "Too many redirections"
 
1571
 
 
1572
 
 
1573
class ConflictsInTree(BzrError):
 
1574
 
 
1575
    _fmt = "Working tree has conflicts."
 
1576
 
 
1577
 
 
1578
class ParseConfigError(BzrError):
 
1579
 
 
1580
    def __init__(self, errors, filename):
 
1581
        if filename is None:
 
1582
            filename = ""
 
1583
        message = "Error(s) parsing config file %s:\n%s" % \
 
1584
            (filename, ('\n'.join(e.message for e in errors)))
 
1585
        BzrError.__init__(self, message)
 
1586
 
 
1587
 
 
1588
class NoEmailInUsername(BzrError):
 
1589
 
 
1590
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1591
 
 
1592
    def __init__(self, username):
 
1593
        BzrError.__init__(self)
 
1594
        self.username = username
 
1595
 
 
1596
 
 
1597
class SigningFailed(BzrError):
 
1598
 
 
1599
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1600
 
 
1601
    def __init__(self, command_line):
 
1602
        BzrError.__init__(self, command_line=command_line)
 
1603
 
 
1604
 
 
1605
class WorkingTreeNotRevision(BzrError):
 
1606
 
 
1607
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1608
            " the last commit, but weave merge requires that it be"
 
1609
            " unchanged")
 
1610
 
 
1611
    def __init__(self, tree):
 
1612
        BzrError.__init__(self, basedir=tree.basedir)
 
1613
 
 
1614
 
 
1615
class CantReprocessAndShowBase(BzrError):
 
1616
 
 
1617
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1618
           "the relationship of conflicting lines to the base")
 
1619
 
 
1620
 
 
1621
class GraphCycleError(BzrError):
 
1622
 
 
1623
    _fmt = "Cycle in graph %(graph)r"
 
1624
 
 
1625
    def __init__(self, graph):
 
1626
        BzrError.__init__(self)
 
1627
        self.graph = graph
 
1628
 
 
1629
 
 
1630
class WritingCompleted(InternalBzrError):
 
1631
 
 
1632
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1633
            "called upon it - accept bytes may not be called anymore.")
 
1634
 
 
1635
    def __init__(self, request):
 
1636
        self.request = request
 
1637
 
 
1638
 
 
1639
class WritingNotComplete(InternalBzrError):
 
1640
 
 
1641
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1642
            "called upon it - until the write phase is complete no "
 
1643
            "data may be read.")
 
1644
 
 
1645
    def __init__(self, request):
 
1646
        self.request = request
 
1647
 
 
1648
 
 
1649
class NotConflicted(BzrError):
 
1650
 
 
1651
    _fmt = "File %(filename)s is not conflicted."
 
1652
 
 
1653
    def __init__(self, filename):
 
1654
        BzrError.__init__(self)
 
1655
        self.filename = filename
 
1656
 
 
1657
 
 
1658
class MediumNotConnected(InternalBzrError):
 
1659
 
 
1660
    _fmt = """The medium '%(medium)s' is not connected."""
 
1661
 
 
1662
    def __init__(self, medium):
 
1663
        self.medium = medium
 
1664
 
 
1665
 
 
1666
class MustUseDecorated(Exception):
 
1667
 
 
1668
    _fmt = "A decorating function has requested its original command be used."
 
1669
 
 
1670
 
 
1671
class NoBundleFound(BzrError):
 
1672
 
 
1673
    _fmt = 'No bundle was found in "%(filename)s".'
 
1674
 
 
1675
    def __init__(self, filename):
 
1676
        BzrError.__init__(self)
 
1677
        self.filename = filename
 
1678
 
 
1679
 
 
1680
class BundleNotSupported(BzrError):
 
1681
 
 
1682
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1683
 
 
1684
    def __init__(self, version, msg):
 
1685
        BzrError.__init__(self)
 
1686
        self.version = version
 
1687
        self.msg = msg
 
1688
 
 
1689
 
 
1690
class MissingText(BzrError):
 
1691
 
 
1692
    _fmt = ("Branch %(base)s is missing revision"
 
1693
            " %(text_revision)s of %(file_id)s")
 
1694
 
 
1695
    def __init__(self, branch, text_revision, file_id):
 
1696
        BzrError.__init__(self)
 
1697
        self.branch = branch
 
1698
        self.base = branch.base
 
1699
        self.text_revision = text_revision
 
1700
        self.file_id = file_id
 
1701
 
 
1702
 
 
1703
class DuplicateFileId(BzrError):
 
1704
 
 
1705
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1706
 
 
1707
    def __init__(self, file_id, entry):
 
1708
        BzrError.__init__(self)
 
1709
        self.file_id = file_id
 
1710
        self.entry = entry
 
1711
 
 
1712
 
 
1713
class DuplicateKey(BzrError):
 
1714
 
 
1715
    _fmt = "Key %(key)s is already present in map"
 
1716
 
 
1717
 
 
1718
class DuplicateHelpPrefix(BzrError):
 
1719
 
 
1720
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1721
 
 
1722
    def __init__(self, prefix):
 
1723
        self.prefix = prefix
 
1724
 
 
1725
 
 
1726
class MalformedTransform(BzrError):
 
1727
 
 
1728
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1729
 
 
1730
 
 
1731
class NoFinalPath(BzrError):
 
1732
 
 
1733
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1734
            "file-id: %(file_id)r\n"
 
1735
            "root trans-id: %(root_trans_id)r\n")
 
1736
 
 
1737
    def __init__(self, trans_id, transform):
 
1738
        self.trans_id = trans_id
 
1739
        self.file_id = transform.final_file_id(trans_id)
 
1740
        self.root_trans_id = transform.root
 
1741
 
 
1742
 
 
1743
class BzrBadParameter(InternalBzrError):
 
1744
 
 
1745
    _fmt = "Bad parameter: %(param)r"
 
1746
 
 
1747
    # This exception should never be thrown, but it is a base class for all
 
1748
    # parameter-to-function errors.
 
1749
 
 
1750
    def __init__(self, param):
 
1751
        BzrError.__init__(self)
 
1752
        self.param = param
 
1753
 
 
1754
 
 
1755
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1756
 
 
1757
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1758
 
 
1759
 
 
1760
class ReusingTransform(BzrError):
 
1761
 
 
1762
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1763
 
 
1764
 
 
1765
class CantMoveRoot(BzrError):
 
1766
 
 
1767
    _fmt = "Moving the root directory is not supported at this time"
 
1768
 
 
1769
 
 
1770
class BzrMoveFailedError(BzrError):
 
1771
 
 
1772
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1773
 
 
1774
    def __init__(self, from_path='', to_path='', extra=None):
 
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 = osutils.splitpath(from_path)[-1]
 
1785
        else:
 
1786
            self.from_path = ''
 
1787
 
 
1788
        if has_to:
 
1789
            self.to_path = osutils.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
        self.path = path
 
2600
        self.kind = kind
 
2601
        self.user_encoding = osutils.get_user_encoding()