/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: Daniel Watkins
  • Date: 2007-08-21 12:28:01 UTC
  • mto: (2765.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2766.
  • Revision ID: d.m.watkins@warwick.ac.uk-20070821122801-y8y7bf9n928hbjfb
Used format string as suggested by abentley.

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