/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: Robert Collins
  • Date: 2008-01-02 22:30:46 UTC
  • mto: (3221.11.1 StackableBranch)
  • mto: This revision was merged to the branch mainline in revision 3226.
  • Revision ID: robertc@robertcollins.net-20080102223046-h8nxufr1v21pnei2
* A new repository format 'development' has been added. This format will
  represent the latest 'in-progress' format that the bzr developers are
  interested in getting early-adopter testing and feedback on.
  ``doc/developers/development-repo.txt`` has detailed information.
  (Robert Collins)

Show diffs side-by-side

added added

removed removed

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