/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-12 20:13:07 UTC
  • mfrom: (3267 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080312201307-ngd5bynt2nvhnlb7
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

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