/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: Alexander Belchenko
  • Date: 2008-02-27 18:24:39 UTC
  • mto: (3234.2.2 bug.139318)
  • mto: This revision was merged to the branch mainline in revision 3267.
  • Revision ID: bialix@ukr.net-20080227182439-qltsi1rc2amf5kjr
ensure that local_path_to_url() always returns plain string, not unicode.

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