/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

Allow Repository tests to be backed onto a specific VFS as needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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 (or absent) this was probably caused by a
 
52
    bzr bug and should be displayed with a traceback; if False 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=%s' \
 
106
                % (self.__class__.__name__,
 
107
                   self.__dict__,
 
108
                   getattr(self, '_fmt', None),
 
109
                   str(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 attribute
 
136
        # if it doesn't exist.  We can't use super here, because exceptions are
 
137
        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426
 
138
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
139
             'please convert %s to use BzrError instead' 
 
140
             % self.__class__.__name__,
 
141
             DeprecationWarning,
 
142
             stacklevel=2)
 
143
        BzrError.__init__(self, *args)
 
144
        for key, value in kwds.items():
 
145
            setattr(self, key, value)
 
146
 
 
147
    def __str__(self):
 
148
        try:
 
149
            # __str__() should always return a 'str' object
 
150
            # never a 'unicode' object.
 
151
            s = self.__doc__ % self.__dict__
 
152
            if isinstance(s, unicode):
 
153
                return s.encode('utf8')
 
154
            return s
 
155
        except (TypeError, NameError, ValueError, KeyError), e:
 
156
            return 'Unprintable exception %s(%r): %s' \
 
157
                % (self.__class__.__name__,
 
158
                   self.__dict__, str(e))
 
159
 
 
160
 
 
161
class AlreadyBuilding(BzrError):
 
162
    
 
163
    _fmt = "The tree builder is already building a tree."
 
164
 
 
165
 
 
166
class BzrCheckError(BzrError):
 
167
    
 
168
    _fmt = "Internal check failed: %(message)s"
 
169
 
 
170
    internal_error = True
 
171
 
 
172
    def __init__(self, message):
 
173
        BzrError.__init__(self)
 
174
        self.message = message
 
175
 
 
176
 
 
177
class DisabledMethod(BzrError):
 
178
 
 
179
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
180
 
 
181
    internal_error = True
 
182
 
 
183
    def __init__(self, class_name):
 
184
        BzrError.__init__(self)
 
185
        self.class_name = class_name
 
186
 
 
187
 
 
188
class InvalidEntryName(BzrError):
 
189
    
 
190
    _fmt = "Invalid entry name: %(name)s"
 
191
 
 
192
    internal_error = True
 
193
 
 
194
    def __init__(self, name):
 
195
        BzrError.__init__(self)
 
196
        self.name = name
 
197
 
 
198
 
 
199
class InvalidRevisionNumber(BzrError):
 
200
    
 
201
    _fmt = "Invalid revision number %(revno)s"
 
202
 
 
203
    def __init__(self, revno):
 
204
        BzrError.__init__(self)
 
205
        self.revno = revno
 
206
 
 
207
 
 
208
class InvalidRevisionId(BzrError):
 
209
 
 
210
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
211
 
 
212
    def __init__(self, revision_id, branch):
 
213
        # branch can be any string or object with __str__ defined
 
214
        BzrError.__init__(self)
 
215
        self.revision_id = revision_id
 
216
        self.branch = branch
 
217
 
 
218
class ReservedId(BzrError):
 
219
 
 
220
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
221
 
 
222
    def __init__(self, revision_id):
 
223
        self.revision_id = revision_id
 
224
 
 
225
class NoSuchId(BzrError):
 
226
 
 
227
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
228
    
 
229
    def __init__(self, tree, file_id):
 
230
        BzrError.__init__(self)
 
231
        self.file_id = file_id
 
232
        self.tree = tree
 
233
 
 
234
 
 
235
class InventoryModified(BzrError):
 
236
 
 
237
    _fmt = ("The current inventory for the tree %(tree)r has been modified, "
 
238
            "so a clean inventory cannot be read without data loss.")
 
239
 
 
240
    internal_error = True
 
241
 
 
242
    def __init__(self, tree):
 
243
        self.tree = tree
 
244
 
 
245
 
 
246
class NoWorkingTree(BzrError):
 
247
 
 
248
    _fmt = "No WorkingTree exists for %(base)s."
 
249
    
 
250
    def __init__(self, base):
 
251
        BzrError.__init__(self)
 
252
        self.base = base
 
253
 
 
254
 
 
255
class NotBuilding(BzrError):
 
256
 
 
257
    _fmt = "Not currently building a tree."
 
258
 
 
259
 
 
260
class NotLocalUrl(BzrError):
 
261
 
 
262
    _fmt = "%(url)s is not a local path."
 
263
 
 
264
    def __init__(self, url):
 
265
        self.url = url
 
266
 
 
267
 
 
268
class WorkingTreeAlreadyPopulated(BzrError):
 
269
 
 
270
    _fmt = """Working tree already populated in %(base)s"""
 
271
 
 
272
    internal_error = True
 
273
 
 
274
    def __init__(self, base):
 
275
        self.base = base
 
276
 
 
277
class BzrCommandError(BzrError):
 
278
    """Error from user command"""
 
279
 
 
280
    internal_error = False
 
281
 
 
282
    # Error from malformed user command; please avoid raising this as a
 
283
    # generic exception not caused by user input.
 
284
    #
 
285
    # I think it's a waste of effort to differentiate between errors that
 
286
    # are not intended to be caught anyway.  UI code need not subclass
 
287
    # BzrCommandError, and non-UI code should not throw a subclass of
 
288
    # BzrCommandError.  ADHB 20051211
 
289
    def __init__(self, msg):
 
290
        # Object.__str__() must return a real string
 
291
        # returning a Unicode string is a python error.
 
292
        if isinstance(msg, unicode):
 
293
            self.msg = msg.encode('utf8')
 
294
        else:
 
295
            self.msg = msg
 
296
 
 
297
    def __str__(self):
 
298
        return self.msg
 
299
 
 
300
 
 
301
class NotWriteLocked(BzrError):
 
302
 
 
303
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
304
 
 
305
    def __init__(self, not_locked):
 
306
        self.not_locked = not_locked
 
307
 
 
308
 
 
309
class BzrOptionError(BzrCommandError):
 
310
 
 
311
    _fmt = "Error in command line options"
 
312
 
 
313
 
 
314
class BadOptionValue(BzrError):
 
315
 
 
316
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
317
 
 
318
    def __init__(self, name, value):
 
319
        BzrError.__init__(self, name=name, value=value)
 
320
 
 
321
    
 
322
class StrictCommitFailed(BzrError):
 
323
 
 
324
    _fmt = "Commit refused because there are unknown files in the tree"
 
325
 
 
326
 
 
327
# XXX: Should be unified with TransportError; they seem to represent the
 
328
# same thing
 
329
class PathError(BzrError):
 
330
    
 
331
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
332
 
 
333
    def __init__(self, path, extra=None):
 
334
        BzrError.__init__(self)
 
335
        self.path = path
 
336
        if extra:
 
337
            self.extra = ': ' + str(extra)
 
338
        else:
 
339
            self.extra = ''
 
340
 
 
341
 
 
342
class NoSuchFile(PathError):
 
343
 
 
344
    _fmt = "No such file: %(path)r%(extra)s"
 
345
 
 
346
 
 
347
class FileExists(PathError):
 
348
 
 
349
    _fmt = "File exists: %(path)r%(extra)s"
 
350
 
 
351
 
 
352
class RenameFailedFilesExist(BzrError):
 
353
    """Used when renaming and both source and dest exist."""
 
354
 
 
355
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
356
         "%(extra)s")
 
357
 
 
358
    def __init__(self, source, dest, extra=None):
 
359
        BzrError.__init__(self)
 
360
        self.source = str(source)
 
361
        self.dest = str(dest)
 
362
        if extra:
 
363
            self.extra = ' ' + str(extra)
 
364
        else:
 
365
            self.extra = ''
 
366
 
 
367
 
 
368
class NotADirectory(PathError):
 
369
 
 
370
    _fmt = "%(path)r is not a directory %(extra)s"
 
371
 
 
372
 
 
373
class NotInWorkingDirectory(PathError):
 
374
 
 
375
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
376
 
 
377
 
 
378
class DirectoryNotEmpty(PathError):
 
379
 
 
380
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
381
 
 
382
 
 
383
class ReadingCompleted(BzrError):
 
384
    
 
385
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
386
            "called upon it - the request has been completed and no more "
 
387
            "data may be read.")
 
388
 
 
389
    internal_error = True
 
390
 
 
391
    def __init__(self, request):
 
392
        self.request = request
 
393
 
 
394
 
 
395
class ResourceBusy(PathError):
 
396
 
 
397
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
398
 
 
399
 
 
400
class PermissionDenied(PathError):
 
401
 
 
402
    _fmt = "Permission denied: %(path)r%(extra)s"
 
403
 
 
404
 
 
405
class InvalidURL(PathError):
 
406
 
 
407
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
408
 
 
409
 
 
410
class InvalidURLJoin(PathError):
 
411
 
 
412
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
413
 
 
414
    def __init__(self, msg, base, args):
 
415
        PathError.__init__(self, base, msg)
 
416
        self.args = [base] + list(args)
 
417
 
 
418
 
 
419
class UnknownHook(BzrError):
 
420
 
 
421
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
422
 
 
423
    def __init__(self, hook_type, hook_name):
 
424
        BzrError.__init__(self)
 
425
        self.type = hook_type
 
426
        self.hook = hook_name
 
427
 
 
428
 
 
429
class UnsupportedProtocol(PathError):
 
430
 
 
431
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
432
 
 
433
    def __init__(self, url, extra):
 
434
        PathError.__init__(self, url, extra=extra)
 
435
 
 
436
 
 
437
class ShortReadvError(PathError):
 
438
 
 
439
    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"
 
440
 
 
441
    internal_error = True
 
442
 
 
443
    def __init__(self, path, offset, length, actual, extra=None):
 
444
        PathError.__init__(self, path, extra=extra)
 
445
        self.offset = offset
 
446
        self.length = length
 
447
        self.actual = actual
 
448
 
 
449
 
 
450
class PathNotChild(BzrError):
 
451
 
 
452
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
453
 
 
454
    internal_error = True
 
455
 
 
456
    def __init__(self, path, base, extra=None):
 
457
        BzrError.__init__(self)
 
458
        self.path = path
 
459
        self.base = base
 
460
        if extra:
 
461
            self.extra = ': ' + str(extra)
 
462
        else:
 
463
            self.extra = ''
 
464
 
 
465
 
 
466
class InvalidNormalization(PathError):
 
467
 
 
468
    _fmt = "Path %(path)r is not unicode normalized"
 
469
 
 
470
 
 
471
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
472
# the exception object is a bit undesirable.
 
473
# TODO: Probably this behavior of should be a common superclass 
 
474
class NotBranchError(PathError):
 
475
 
 
476
    _fmt = "Not a branch: %(path)s"
 
477
 
 
478
    def __init__(self, path):
 
479
       import bzrlib.urlutils as urlutils
 
480
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
481
 
 
482
 
 
483
class AlreadyBranchError(PathError):
 
484
 
 
485
    _fmt = "Already a branch: %(path)s."
 
486
 
 
487
 
 
488
class BranchExistsWithoutWorkingTree(PathError):
 
489
 
 
490
    _fmt = "Directory contains a branch, but no working tree \
 
491
(use bzr checkout if you wish to build a working tree): %(path)s"
 
492
 
 
493
 
 
494
class AtomicFileAlreadyClosed(PathError):
 
495
 
 
496
    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"
 
497
 
 
498
    def __init__(self, path, function):
 
499
        PathError.__init__(self, path=path, extra=None)
 
500
        self.function = function
 
501
 
 
502
 
 
503
class InaccessibleParent(PathError):
 
504
 
 
505
    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"
 
506
 
 
507
    def __init__(self, path, base):
 
508
        PathError.__init__(self, path)
 
509
        self.base = base
 
510
 
 
511
 
 
512
class NoRepositoryPresent(BzrError):
 
513
 
 
514
    _fmt = "No repository present: %(path)r"
 
515
    def __init__(self, bzrdir):
 
516
        BzrError.__init__(self)
 
517
        self.path = bzrdir.transport.clone('..').base
 
518
 
 
519
 
 
520
class FileInWrongBranch(BzrError):
 
521
 
 
522
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
523
 
 
524
    def __init__(self, branch, path):
 
525
        BzrError.__init__(self)
 
526
        self.branch = branch
 
527
        self.branch_base = branch.base
 
528
        self.path = path
 
529
 
 
530
 
 
531
class UnsupportedFormatError(BzrError):
 
532
    
 
533
    _fmt = "Unsupported branch format: %(format)s"
 
534
 
 
535
 
 
536
class UnknownFormatError(BzrError):
 
537
    
 
538
    _fmt = "Unknown branch format: %(format)r"
 
539
 
 
540
 
 
541
class IncompatibleFormat(BzrError):
 
542
    
 
543
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
544
 
 
545
    def __init__(self, format, bzrdir_format):
 
546
        BzrError.__init__(self)
 
547
        self.format = format
 
548
        self.bzrdir = bzrdir_format
 
549
 
 
550
 
 
551
class IncompatibleRevision(BzrError):
 
552
    
 
553
    _fmt = "Revision is not compatible with %(repo_format)s"
 
554
 
 
555
    def __init__(self, repo_format):
 
556
        BzrError.__init__(self)
 
557
        self.repo_format = repo_format
 
558
 
 
559
 
 
560
class AlreadyVersionedError(BzrError):
 
561
    """Used when a path is expected not to be versioned, but it is."""
 
562
 
 
563
    _fmt = "%(context_info)s%(path)s is already versioned"
 
564
 
 
565
    def __init__(self, path, context_info=None):
 
566
        """Construct a new NotVersionedError.
 
567
 
 
568
        :param path: This is the path which is versioned,
 
569
        which should be in a user friendly form.
 
570
        :param context_info: If given, this is information about the context,
 
571
        which could explain why this is expected to not be versioned.
 
572
        """
 
573
        BzrError.__init__(self)
 
574
        self.path = path
 
575
        if context_info is None:
 
576
            self.context_info = ''
 
577
        else:
 
578
            self.context_info = context_info + ". "
 
579
 
 
580
 
 
581
class NotVersionedError(BzrError):
 
582
    """Used when a path is expected to be versioned, but it is not."""
 
583
 
 
584
    _fmt = "%(context_info)s%(path)s is not versioned"
 
585
 
 
586
    def __init__(self, path, context_info=None):
 
587
        """Construct a new NotVersionedError.
 
588
 
 
589
        :param path: This is the path which is not versioned,
 
590
        which should be in a user friendly form.
 
591
        :param context_info: If given, this is information about the context,
 
592
        which could explain why this is expected to be versioned.
 
593
        """
 
594
        BzrError.__init__(self)
 
595
        self.path = path
 
596
        if context_info is None:
 
597
            self.context_info = ''
 
598
        else:
 
599
            self.context_info = context_info + ". "
 
600
 
 
601
 
 
602
class PathsNotVersionedError(BzrError):
 
603
    """Used when reporting several paths which are not versioned"""
 
604
 
 
605
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
606
 
 
607
    def __init__(self, paths):
 
608
        from bzrlib.osutils import quotefn
 
609
        BzrError.__init__(self)
 
610
        self.paths = paths
 
611
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
612
 
 
613
 
 
614
class PathsDoNotExist(BzrError):
 
615
 
 
616
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
617
 
 
618
    # used when reporting that paths are neither versioned nor in the working
 
619
    # tree
 
620
 
 
621
    def __init__(self, paths, extra=None):
 
622
        # circular import
 
623
        from bzrlib.osutils import quotefn
 
624
        BzrError.__init__(self)
 
625
        self.paths = paths
 
626
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
627
        if extra:
 
628
            self.extra = ': ' + str(extra)
 
629
        else:
 
630
            self.extra = ''
 
631
 
 
632
 
 
633
class BadFileKindError(BzrError):
 
634
 
 
635
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
636
 
 
637
 
 
638
class ForbiddenControlFileError(BzrError):
 
639
 
 
640
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
641
 
 
642
 
 
643
class LockError(BzrError):
 
644
 
 
645
    _fmt = "Lock error: %(message)s"
 
646
 
 
647
    internal_error = True
 
648
 
 
649
    # All exceptions from the lock/unlock functions should be from
 
650
    # this exception class.  They will be translated as necessary. The
 
651
    # original exception is available as e.original_error
 
652
    #
 
653
    # New code should prefer to raise specific subclasses
 
654
    def __init__(self, message):
 
655
        self.message = message
 
656
 
 
657
 
 
658
class CommitNotPossible(LockError):
 
659
 
 
660
    _fmt = "A commit was attempted but we do not have a write lock open."
 
661
 
 
662
    def __init__(self):
 
663
        pass
 
664
 
 
665
 
 
666
class AlreadyCommitted(LockError):
 
667
 
 
668
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
669
 
 
670
    def __init__(self):
 
671
        pass
 
672
 
 
673
 
 
674
class ReadOnlyError(LockError):
 
675
 
 
676
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
677
 
 
678
    def __init__(self, obj):
 
679
        self.obj = obj
 
680
 
 
681
 
 
682
class OutSideTransaction(BzrError):
 
683
 
 
684
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
685
 
 
686
 
 
687
class ObjectNotLocked(LockError):
 
688
 
 
689
    _fmt = "%(obj)r is not locked"
 
690
 
 
691
    # this can indicate that any particular object is not locked; see also
 
692
    # LockNotHeld which means that a particular *lock* object is not held by
 
693
    # the caller -- perhaps they should be unified.
 
694
    def __init__(self, obj):
 
695
        self.obj = obj
 
696
 
 
697
 
 
698
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
699
 
 
700
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
701
 
 
702
    def __init__(self, obj):
 
703
        self.obj = obj
 
704
 
 
705
 
 
706
class UnlockableTransport(LockError):
 
707
 
 
708
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
709
 
 
710
    def __init__(self, transport):
 
711
        self.transport = transport
 
712
 
 
713
 
 
714
class LockContention(LockError):
 
715
 
 
716
    _fmt = "Could not acquire lock %(lock)s"
 
717
    # TODO: show full url for lock, combining the transport and relative
 
718
    # bits?
 
719
 
 
720
    internal_error = False
 
721
    
 
722
    def __init__(self, lock):
 
723
        self.lock = lock
 
724
 
 
725
 
 
726
class LockBroken(LockError):
 
727
 
 
728
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
729
 
 
730
    internal_error = False
 
731
 
 
732
    def __init__(self, lock):
 
733
        self.lock = lock
 
734
 
 
735
 
 
736
class LockBreakMismatch(LockError):
 
737
 
 
738
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
739
 
 
740
    internal_error = False
 
741
 
 
742
    def __init__(self, lock, holder, target):
 
743
        self.lock = lock
 
744
        self.holder = holder
 
745
        self.target = target
 
746
 
 
747
 
 
748
class LockNotHeld(LockError):
 
749
 
 
750
    _fmt = "Lock not held: %(lock)s"
 
751
 
 
752
    internal_error = False
 
753
 
 
754
    def __init__(self, lock):
 
755
        self.lock = lock
 
756
 
 
757
 
 
758
class PointlessCommit(BzrError):
 
759
 
 
760
    _fmt = "No changes to commit"
 
761
 
 
762
 
 
763
class UpgradeReadonly(BzrError):
 
764
 
 
765
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
766
 
 
767
 
 
768
class UpToDateFormat(BzrError):
 
769
 
 
770
    _fmt = "The branch format %(format)s is already at the most recent format."
 
771
 
 
772
    def __init__(self, format):
 
773
        BzrError.__init__(self)
 
774
        self.format = format
 
775
 
 
776
 
 
777
class StrictCommitFailed(Exception):
 
778
 
 
779
    _fmt = "Commit refused because there are unknowns in the tree."
 
780
 
 
781
 
 
782
class NoSuchRevision(BzrError):
 
783
 
 
784
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
785
 
 
786
    internal_error = True
 
787
 
 
788
    def __init__(self, branch, revision):
 
789
        BzrError.__init__(self, branch=branch, revision=revision)
 
790
 
 
791
 
 
792
class NoSuchRevisionSpec(BzrError):
 
793
 
 
794
    _fmt = "No namespace registered for string: %(spec)r"
 
795
 
 
796
    def __init__(self, spec):
 
797
        BzrError.__init__(self, spec=spec)
 
798
 
 
799
 
 
800
class InvalidRevisionSpec(BzrError):
 
801
 
 
802
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
803
 
 
804
    def __init__(self, spec, branch, extra=None):
 
805
        BzrError.__init__(self, branch=branch, spec=spec)
 
806
        if extra:
 
807
            self.extra = '\n' + str(extra)
 
808
        else:
 
809
            self.extra = ''
 
810
 
 
811
 
 
812
class HistoryMissing(BzrError):
 
813
 
 
814
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
815
 
 
816
 
 
817
class DivergedBranches(BzrError):
 
818
    
 
819
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
820
 
 
821
    internal_error = False
 
822
 
 
823
    def __init__(self, branch1, branch2):
 
824
        self.branch1 = branch1
 
825
        self.branch2 = branch2
 
826
 
 
827
 
 
828
class UnrelatedBranches(BzrError):
 
829
 
 
830
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
831
 
 
832
    internal_error = False
 
833
 
 
834
 
 
835
class NoCommonAncestor(BzrError):
 
836
    
 
837
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
838
 
 
839
    def __init__(self, revision_a, revision_b):
 
840
        self.revision_a = revision_a
 
841
        self.revision_b = revision_b
 
842
 
 
843
 
 
844
class NoCommonRoot(BzrError):
 
845
 
 
846
    _fmt = "Revisions are not derived from the same root: " \
 
847
           "%(revision_a)s %(revision_b)s."
 
848
 
 
849
    def __init__(self, revision_a, revision_b):
 
850
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
851
 
 
852
 
 
853
class NotAncestor(BzrError):
 
854
 
 
855
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
856
 
 
857
    def __init__(self, rev_id, not_ancestor_id):
 
858
        BzrError.__init__(self, rev_id=rev_id,
 
859
            not_ancestor_id=not_ancestor_id)
 
860
 
 
861
 
 
862
class InstallFailed(BzrError):
 
863
 
 
864
    def __init__(self, revisions):
 
865
        revision_str = ", ".join(str(r) for r in revisions)
 
866
        msg = "Could not install revisions:\n%s" % revision_str
 
867
        BzrError.__init__(self, msg)
 
868
        self.revisions = revisions
 
869
 
 
870
 
 
871
class AmbiguousBase(BzrError):
 
872
 
 
873
    def __init__(self, bases):
 
874
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
875
                DeprecationWarning)
 
876
        msg = "The correct base is unclear, because %s are all equally close" %\
 
877
            ", ".join(bases)
 
878
        BzrError.__init__(self, msg)
 
879
        self.bases = bases
 
880
 
 
881
 
 
882
class NoCommits(BzrError):
 
883
 
 
884
    _fmt = "Branch %(branch)s has no commits."
 
885
 
 
886
    def __init__(self, branch):
 
887
        BzrError.__init__(self, branch=branch)
 
888
 
 
889
 
 
890
class UnlistableStore(BzrError):
 
891
 
 
892
    def __init__(self, store):
 
893
        BzrError.__init__(self, "Store %s is not listable" % store)
 
894
 
 
895
 
 
896
 
 
897
class UnlistableBranch(BzrError):
 
898
 
 
899
    def __init__(self, br):
 
900
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
901
 
 
902
 
 
903
class BoundBranchOutOfDate(BzrError):
 
904
 
 
905
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
906
 
 
907
    def __init__(self, branch, master):
 
908
        BzrError.__init__(self)
 
909
        self.branch = branch
 
910
        self.master = master
 
911
 
 
912
        
 
913
class CommitToDoubleBoundBranch(BzrError):
 
914
 
 
915
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
916
 
 
917
    def __init__(self, branch, master, remote):
 
918
        BzrError.__init__(self)
 
919
        self.branch = branch
 
920
        self.master = master
 
921
        self.remote = remote
 
922
 
 
923
 
 
924
class OverwriteBoundBranch(BzrError):
 
925
 
 
926
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
927
 
 
928
    def __init__(self, branch):
 
929
        BzrError.__init__(self)
 
930
        self.branch = branch
 
931
 
 
932
 
 
933
class BoundBranchConnectionFailure(BzrError):
 
934
 
 
935
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
936
 
 
937
    def __init__(self, branch, target, error):
 
938
        BzrError.__init__(self)
 
939
        self.branch = branch
 
940
        self.target = target
 
941
        self.error = error
 
942
 
 
943
 
 
944
class WeaveError(BzrError):
 
945
 
 
946
    _fmt = "Error in processing weave: %(message)s"
 
947
 
 
948
    def __init__(self, message=None):
 
949
        BzrError.__init__(self)
 
950
        self.message = message
 
951
 
 
952
 
 
953
class WeaveRevisionAlreadyPresent(WeaveError):
 
954
 
 
955
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
956
 
 
957
    def __init__(self, revision_id, weave):
 
958
 
 
959
        WeaveError.__init__(self)
 
960
        self.revision_id = revision_id
 
961
        self.weave = weave
 
962
 
 
963
 
 
964
class WeaveRevisionNotPresent(WeaveError):
 
965
 
 
966
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
967
 
 
968
    def __init__(self, revision_id, weave):
 
969
        WeaveError.__init__(self)
 
970
        self.revision_id = revision_id
 
971
        self.weave = weave
 
972
 
 
973
 
 
974
class WeaveFormatError(WeaveError):
 
975
 
 
976
    _fmt = "Weave invariant violated: %(what)s"
 
977
 
 
978
    def __init__(self, what):
 
979
        WeaveError.__init__(self)
 
980
        self.what = what
 
981
 
 
982
 
 
983
class WeaveParentMismatch(WeaveError):
 
984
 
 
985
    _fmt = "Parents are mismatched between two revisions."
 
986
    
 
987
 
 
988
class WeaveInvalidChecksum(WeaveError):
 
989
 
 
990
    _fmt = "Text did not match it's checksum: %(message)s"
 
991
 
 
992
 
 
993
class WeaveTextDiffers(WeaveError):
 
994
 
 
995
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
996
 
 
997
    def __init__(self, revision_id, weave_a, weave_b):
 
998
        WeaveError.__init__(self)
 
999
        self.revision_id = revision_id
 
1000
        self.weave_a = weave_a
 
1001
        self.weave_b = weave_b
 
1002
 
 
1003
 
 
1004
class WeaveTextDiffers(WeaveError):
 
1005
 
 
1006
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1007
 
 
1008
    def __init__(self, revision_id, weave_a, weave_b):
 
1009
        WeaveError.__init__(self)
 
1010
        self.revision_id = revision_id
 
1011
        self.weave_a = weave_a
 
1012
        self.weave_b = weave_b
 
1013
 
 
1014
 
 
1015
class VersionedFileError(BzrError):
 
1016
    
 
1017
    _fmt = "Versioned file error"
 
1018
 
 
1019
 
 
1020
class RevisionNotPresent(VersionedFileError):
 
1021
    
 
1022
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1023
 
 
1024
    def __init__(self, revision_id, file_id):
 
1025
        VersionedFileError.__init__(self)
 
1026
        self.revision_id = revision_id
 
1027
        self.file_id = file_id
 
1028
 
 
1029
 
 
1030
class RevisionAlreadyPresent(VersionedFileError):
 
1031
    
 
1032
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1033
 
 
1034
    def __init__(self, revision_id, file_id):
 
1035
        VersionedFileError.__init__(self)
 
1036
        self.revision_id = revision_id
 
1037
        self.file_id = file_id
 
1038
 
 
1039
 
 
1040
class KnitError(BzrError):
 
1041
    
 
1042
    _fmt = "Knit error"
 
1043
 
 
1044
    internal_error = True
 
1045
 
 
1046
 
 
1047
class KnitHeaderError(KnitError):
 
1048
 
 
1049
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1050
 
 
1051
    def __init__(self, badline, filename):
 
1052
        KnitError.__init__(self)
 
1053
        self.badline = badline
 
1054
        self.filename = filename
 
1055
 
 
1056
 
 
1057
class KnitCorrupt(KnitError):
 
1058
 
 
1059
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1060
 
 
1061
    def __init__(self, filename, how):
 
1062
        KnitError.__init__(self)
 
1063
        self.filename = filename
 
1064
        self.how = how
 
1065
 
 
1066
 
 
1067
class KnitIndexUnknownMethod(KnitError):
 
1068
    """Raised when we don't understand the storage method.
 
1069
 
 
1070
    Currently only 'fulltext' and 'line-delta' are supported.
 
1071
    """
 
1072
    
 
1073
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1074
            " in options: %(options)r")
 
1075
 
 
1076
    def __init__(self, filename, options):
 
1077
        KnitError.__init__(self)
 
1078
        self.filename = filename
 
1079
        self.options = options
 
1080
 
 
1081
 
 
1082
class NoSuchExportFormat(BzrError):
 
1083
    
 
1084
    _fmt = "Export format %(format)r not supported"
 
1085
 
 
1086
    def __init__(self, format):
 
1087
        BzrError.__init__(self)
 
1088
        self.format = format
 
1089
 
 
1090
 
 
1091
class TransportError(BzrError):
 
1092
    
 
1093
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1094
 
 
1095
    def __init__(self, msg=None, orig_error=None):
 
1096
        if msg is None and orig_error is not None:
 
1097
            msg = str(orig_error)
 
1098
        if orig_error is None:
 
1099
            orig_error = ''
 
1100
        if msg is None:
 
1101
            msg =  ''
 
1102
        self.msg = msg
 
1103
        self.orig_error = orig_error
 
1104
        BzrError.__init__(self)
 
1105
 
 
1106
 
 
1107
class TooManyConcurrentRequests(BzrError):
 
1108
 
 
1109
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
1110
            "Be sure to finish_writing and finish_reading on the "
 
1111
            "current request that is open.")
 
1112
 
 
1113
    internal_error = True
 
1114
 
 
1115
    def __init__(self, medium):
 
1116
        self.medium = medium
 
1117
 
 
1118
 
 
1119
class SmartProtocolError(TransportError):
 
1120
 
 
1121
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1122
 
 
1123
    def __init__(self, details):
 
1124
        self.details = details
 
1125
 
 
1126
 
 
1127
# A set of semi-meaningful errors which can be thrown
 
1128
class TransportNotPossible(TransportError):
 
1129
 
 
1130
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1131
 
 
1132
 
 
1133
class ConnectionError(TransportError):
 
1134
 
 
1135
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1136
 
 
1137
 
 
1138
class SocketConnectionError(ConnectionError):
 
1139
 
 
1140
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1141
 
 
1142
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1143
        if msg is None:
 
1144
            msg = 'Failed to connect to'
 
1145
        if orig_error is None:
 
1146
            orig_error = ''
 
1147
        else:
 
1148
            orig_error = '; ' + str(orig_error)
 
1149
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1150
        self.host = host
 
1151
        if port is None:
 
1152
            self.port = ''
 
1153
        else:
 
1154
            self.port = ':%s' % port
 
1155
 
 
1156
 
 
1157
class ConnectionReset(TransportError):
 
1158
 
 
1159
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1160
 
 
1161
 
 
1162
class InvalidRange(TransportError):
 
1163
 
 
1164
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1165
    
 
1166
    def __init__(self, path, offset):
 
1167
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1168
                                       % (path, offset)))
 
1169
        self.path = path
 
1170
        self.offset = offset
 
1171
 
 
1172
 
 
1173
class InvalidHttpResponse(TransportError):
 
1174
 
 
1175
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1176
 
 
1177
    def __init__(self, path, msg, orig_error=None):
 
1178
        self.path = path
 
1179
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1180
 
 
1181
 
 
1182
class InvalidHttpRange(InvalidHttpResponse):
 
1183
 
 
1184
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1185
    
 
1186
    def __init__(self, path, range, msg):
 
1187
        self.range = range
 
1188
        InvalidHttpResponse.__init__(self, path, msg)
 
1189
 
 
1190
 
 
1191
class InvalidHttpContentType(InvalidHttpResponse):
 
1192
 
 
1193
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1194
    
 
1195
    def __init__(self, path, ctype, msg):
 
1196
        self.ctype = ctype
 
1197
        InvalidHttpResponse.__init__(self, path, msg)
 
1198
 
 
1199
 
 
1200
class ConflictsInTree(BzrError):
 
1201
 
 
1202
    _fmt = "Working tree has conflicts."
 
1203
 
 
1204
 
 
1205
class ParseConfigError(BzrError):
 
1206
 
 
1207
    def __init__(self, errors, filename):
 
1208
        if filename is None:
 
1209
            filename = ""
 
1210
        message = "Error(s) parsing config file %s:\n%s" % \
 
1211
            (filename, ('\n'.join(e.message for e in errors)))
 
1212
        BzrError.__init__(self, message)
 
1213
 
 
1214
 
 
1215
class NoEmailInUsername(BzrError):
 
1216
 
 
1217
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1218
 
 
1219
    def __init__(self, username):
 
1220
        BzrError.__init__(self)
 
1221
        self.username = username
 
1222
 
 
1223
 
 
1224
class SigningFailed(BzrError):
 
1225
 
 
1226
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1227
 
 
1228
    def __init__(self, command_line):
 
1229
        BzrError.__init__(self, command_line=command_line)
 
1230
 
 
1231
 
 
1232
class WorkingTreeNotRevision(BzrError):
 
1233
 
 
1234
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1235
            " the last commit, but weave merge requires that it be"
 
1236
            " unchanged")
 
1237
 
 
1238
    def __init__(self, tree):
 
1239
        BzrError.__init__(self, basedir=tree.basedir)
 
1240
 
 
1241
 
 
1242
class CantReprocessAndShowBase(BzrError):
 
1243
 
 
1244
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
1245
           "the relationship of conflicting lines to the base"
 
1246
 
 
1247
 
 
1248
class GraphCycleError(BzrError):
 
1249
 
 
1250
    _fmt = "Cycle in graph %(graph)r"
 
1251
 
 
1252
    def __init__(self, graph):
 
1253
        BzrError.__init__(self)
 
1254
        self.graph = graph
 
1255
 
 
1256
 
 
1257
class WritingCompleted(BzrError):
 
1258
 
 
1259
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1260
            "called upon it - accept bytes may not be called anymore.")
 
1261
 
 
1262
    internal_error = True
 
1263
 
 
1264
    def __init__(self, request):
 
1265
        self.request = request
 
1266
 
 
1267
 
 
1268
class WritingNotComplete(BzrError):
 
1269
 
 
1270
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1271
            "called upon it - until the write phase is complete no "
 
1272
            "data may be read.")
 
1273
 
 
1274
    internal_error = True
 
1275
 
 
1276
    def __init__(self, request):
 
1277
        self.request = request
 
1278
 
 
1279
 
 
1280
class NotConflicted(BzrError):
 
1281
 
 
1282
    _fmt = "File %(filename)s is not conflicted."
 
1283
 
 
1284
    def __init__(self, filename):
 
1285
        BzrError.__init__(self)
 
1286
        self.filename = filename
 
1287
 
 
1288
 
 
1289
class MediumNotConnected(BzrError):
 
1290
 
 
1291
    _fmt = """The medium '%(medium)s' is not connected."""
 
1292
 
 
1293
    internal_error = True
 
1294
 
 
1295
    def __init__(self, medium):
 
1296
        self.medium = medium
 
1297
 
 
1298
 
 
1299
class MustUseDecorated(Exception):
 
1300
    
 
1301
    _fmt = """A decorating function has requested its original command be used."""
 
1302
    
 
1303
 
 
1304
class NoBundleFound(BzrError):
 
1305
 
 
1306
    _fmt = "No bundle was found in %(filename)s"
 
1307
 
 
1308
    def __init__(self, filename):
 
1309
        BzrError.__init__(self)
 
1310
        self.filename = filename
 
1311
 
 
1312
 
 
1313
class BundleNotSupported(BzrError):
 
1314
 
 
1315
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1316
 
 
1317
    def __init__(self, version, msg):
 
1318
        BzrError.__init__(self)
 
1319
        self.version = version
 
1320
        self.msg = msg
 
1321
 
 
1322
 
 
1323
class MissingText(BzrError):
 
1324
 
 
1325
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1326
 
 
1327
    def __init__(self, branch, text_revision, file_id):
 
1328
        BzrError.__init__(self)
 
1329
        self.branch = branch
 
1330
        self.base = branch.base
 
1331
        self.text_revision = text_revision
 
1332
        self.file_id = file_id
 
1333
 
 
1334
 
 
1335
class DuplicateKey(BzrError):
 
1336
 
 
1337
    _fmt = "Key %(key)s is already present in map"
 
1338
 
 
1339
 
 
1340
class MalformedTransform(BzrError):
 
1341
 
 
1342
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1343
 
 
1344
 
 
1345
class NoFinalPath(BzrError):
 
1346
 
 
1347
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1348
            "file-id: %(file_id)r\n"
 
1349
            "root trans-id: %(root_trans_id)r\n")
 
1350
 
 
1351
    def __init__(self, trans_id, transform):
 
1352
        self.trans_id = trans_id
 
1353
        self.file_id = transform.final_file_id(trans_id)
 
1354
        self.root_trans_id = transform.root
 
1355
 
 
1356
 
 
1357
class BzrBadParameter(BzrError):
 
1358
 
 
1359
    _fmt = "Bad parameter: %(param)r"
 
1360
 
 
1361
    # This exception should never be thrown, but it is a base class for all
 
1362
    # parameter-to-function errors.
 
1363
 
 
1364
    def __init__(self, param):
 
1365
        BzrError.__init__(self)
 
1366
        self.param = param
 
1367
 
 
1368
 
 
1369
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1370
 
 
1371
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1372
 
 
1373
 
 
1374
class ReusingTransform(BzrError):
 
1375
 
 
1376
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1377
 
 
1378
 
 
1379
class CantMoveRoot(BzrError):
 
1380
 
 
1381
    _fmt = "Moving the root directory is not supported at this time"
 
1382
 
 
1383
 
 
1384
class BzrMoveFailedError(BzrError):
 
1385
 
 
1386
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1387
 
 
1388
    def __init__(self, from_path='', to_path='', extra=None):
 
1389
        BzrError.__init__(self)
 
1390
        if extra:
 
1391
            self.extra = ': ' + str(extra)
 
1392
        else:
 
1393
            self.extra = ''
 
1394
 
 
1395
        has_from = len(from_path) > 0
 
1396
        has_to = len(to_path) > 0
 
1397
        if has_from:
 
1398
            self.from_path = osutils.splitpath(from_path)[-1]
 
1399
        else:
 
1400
            self.from_path = ''
 
1401
 
 
1402
        if has_to:
 
1403
            self.to_path = osutils.splitpath(to_path)[-1]
 
1404
        else:
 
1405
            self.to_path = ''
 
1406
 
 
1407
        self.operator = ""
 
1408
        if has_from and has_to:
 
1409
            self.operator = " =>"
 
1410
        elif has_from:
 
1411
            self.from_path = "from " + from_path
 
1412
        elif has_to:
 
1413
            self.operator = "to"
 
1414
        else:
 
1415
            self.operator = "file"
 
1416
 
 
1417
 
 
1418
class BzrRenameFailedError(BzrMoveFailedError):
 
1419
 
 
1420
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1421
 
 
1422
    def __init__(self, from_path, to_path, extra=None):
 
1423
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1424
 
 
1425
 
 
1426
class BzrBadParameterNotString(BzrBadParameter):
 
1427
 
 
1428
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1429
 
 
1430
 
 
1431
class BzrBadParameterMissing(BzrBadParameter):
 
1432
 
 
1433
    _fmt = "Parameter $(param)s is required but not present."
 
1434
 
 
1435
 
 
1436
class BzrBadParameterUnicode(BzrBadParameter):
 
1437
 
 
1438
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
1439
 
 
1440
 
 
1441
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1442
 
 
1443
    _fmt = "Parameter %(param)s contains a newline."
 
1444
 
 
1445
 
 
1446
class DependencyNotPresent(BzrError):
 
1447
 
 
1448
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1449
 
 
1450
    def __init__(self, library, error):
 
1451
        BzrError.__init__(self, library=library, error=error)
 
1452
 
 
1453
 
 
1454
class ParamikoNotPresent(DependencyNotPresent):
 
1455
 
 
1456
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1457
 
 
1458
    def __init__(self, error):
 
1459
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1460
 
 
1461
 
 
1462
class PointlessMerge(BzrError):
 
1463
 
 
1464
    _fmt = "Nothing to merge."
 
1465
 
 
1466
 
 
1467
class UninitializableFormat(BzrError):
 
1468
 
 
1469
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1470
 
 
1471
    def __init__(self, format):
 
1472
        BzrError.__init__(self)
 
1473
        self.format = format
 
1474
 
 
1475
 
 
1476
class BadConversionTarget(BzrError):
 
1477
 
 
1478
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1479
 
 
1480
    def __init__(self, problem, format):
 
1481
        BzrError.__init__(self)
 
1482
        self.problem = problem
 
1483
        self.format = format
 
1484
 
 
1485
 
 
1486
class NoDiff(BzrError):
 
1487
 
 
1488
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1489
 
 
1490
    def __init__(self, msg):
 
1491
        BzrError.__init__(self, msg=msg)
 
1492
 
 
1493
 
 
1494
class NoDiff3(BzrError):
 
1495
 
 
1496
    _fmt = "Diff3 is not installed on this machine."
 
1497
 
 
1498
 
 
1499
class ExistingLimbo(BzrError):
 
1500
 
 
1501
    _fmt = """This tree contains left-over files from a failed operation.
 
1502
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1503
    keep, and delete it when you are done."""
 
1504
    
 
1505
    def __init__(self, limbo_dir):
 
1506
       BzrError.__init__(self)
 
1507
       self.limbo_dir = limbo_dir
 
1508
 
 
1509
 
 
1510
class ImmortalLimbo(BzrError):
 
1511
 
 
1512
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1513
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1514
    keep, and delete it when you are done."""
 
1515
 
 
1516
    def __init__(self, limbo_dir):
 
1517
       BzrError.__init__(self)
 
1518
       self.limbo_dir = limbo_dir
 
1519
 
 
1520
 
 
1521
class OutOfDateTree(BzrError):
 
1522
 
 
1523
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1524
 
 
1525
    def __init__(self, tree):
 
1526
        BzrError.__init__(self)
 
1527
        self.tree = tree
 
1528
 
 
1529
 
 
1530
class MergeModifiedFormatError(BzrError):
 
1531
 
 
1532
    _fmt = "Error in merge modified format"
 
1533
 
 
1534
 
 
1535
class ConflictFormatError(BzrError):
 
1536
 
 
1537
    _fmt = "Format error in conflict listings"
 
1538
 
 
1539
 
 
1540
class CorruptRepository(BzrError):
 
1541
 
 
1542
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
1543
Please run bzr reconcile on this repository."""
 
1544
 
 
1545
    def __init__(self, repo):
 
1546
        BzrError.__init__(self)
 
1547
        self.repo_path = repo.bzrdir.root_transport.base
 
1548
 
 
1549
 
 
1550
class UpgradeRequired(BzrError):
 
1551
 
 
1552
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1553
 
 
1554
    def __init__(self, path):
 
1555
        BzrError.__init__(self)
 
1556
        self.path = path
 
1557
 
 
1558
 
 
1559
class LocalRequiresBoundBranch(BzrError):
 
1560
 
 
1561
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1562
 
 
1563
 
 
1564
class MissingProgressBarFinish(BzrError):
 
1565
 
 
1566
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1567
 
 
1568
 
 
1569
class InvalidProgressBarType(BzrError):
 
1570
 
 
1571
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1572
Select one of: %(valid_types)s"""
 
1573
 
 
1574
    def __init__(self, bar_type, valid_types):
 
1575
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1576
 
 
1577
 
 
1578
class UnsupportedOperation(BzrError):
 
1579
 
 
1580
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
1581
 
 
1582
    def __init__(self, method, method_self):
 
1583
        self.method = method
 
1584
        self.mname = method.__name__
 
1585
        self.tname = type(method_self).__name__
 
1586
 
 
1587
 
 
1588
class CannotSetRevisionId(UnsupportedOperation):
 
1589
    """Raised when a commit is attempting to set a revision id but cant."""
 
1590
 
 
1591
 
 
1592
class NonAsciiRevisionId(UnsupportedOperation):
 
1593
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
1594
 
 
1595
 
 
1596
class BinaryFile(BzrError):
 
1597
    
 
1598
    _fmt = "File is binary but should be text."
 
1599
 
 
1600
 
 
1601
class IllegalPath(BzrError):
 
1602
 
 
1603
    _fmt = "The path %(path)s is not permitted on this platform"
 
1604
 
 
1605
    def __init__(self, path):
 
1606
        BzrError.__init__(self)
 
1607
        self.path = path
 
1608
 
 
1609
 
 
1610
class TestamentMismatch(BzrError):
 
1611
 
 
1612
    _fmt = """Testament did not match expected value.  
 
1613
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1614
       {%(measured)s}"""
 
1615
 
 
1616
    def __init__(self, revision_id, expected, measured):
 
1617
        self.revision_id = revision_id
 
1618
        self.expected = expected
 
1619
        self.measured = measured
 
1620
 
 
1621
 
 
1622
class NotABundle(BzrError):
 
1623
    
 
1624
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1625
 
 
1626
    def __init__(self, text):
 
1627
        BzrError.__init__(self)
 
1628
        self.text = text
 
1629
 
 
1630
 
 
1631
class BadBundle(BzrError): 
 
1632
    
 
1633
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1634
 
 
1635
    def __init__(self, text):
 
1636
        BzrError.__init__(self)
 
1637
        self.text = text
 
1638
 
 
1639
 
 
1640
class MalformedHeader(BadBundle): 
 
1641
    
 
1642
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1643
 
 
1644
 
 
1645
class MalformedPatches(BadBundle): 
 
1646
    
 
1647
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1648
 
 
1649
 
 
1650
class MalformedFooter(BadBundle): 
 
1651
    
 
1652
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1653
 
 
1654
 
 
1655
class UnsupportedEOLMarker(BadBundle):
 
1656
    
 
1657
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1658
 
 
1659
    def __init__(self):
 
1660
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1661
        # but for this there is not
 
1662
        BzrError.__init__(self)
 
1663
 
 
1664
 
 
1665
class IncompatibleBundleFormat(BzrError):
 
1666
    
 
1667
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1668
 
 
1669
    def __init__(self, bundle_format, other):
 
1670
        BzrError.__init__(self)
 
1671
        self.bundle_format = bundle_format
 
1672
        self.other = other
 
1673
 
 
1674
 
 
1675
class BadInventoryFormat(BzrError):
 
1676
    
 
1677
    _fmt = "Root class for inventory serialization errors"
 
1678
 
 
1679
 
 
1680
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1681
 
 
1682
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1683
 
 
1684
    def __init__(self, msg):
 
1685
        BadInventoryFormat.__init__(self, msg=msg)
 
1686
 
 
1687
 
 
1688
class NoSmartMedium(BzrError):
 
1689
 
 
1690
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1691
    internal_error = True
 
1692
 
 
1693
    def __init__(self, transport):
 
1694
        self.transport = transport
 
1695
 
 
1696
 
 
1697
class NoSmartServer(NotBranchError):
 
1698
 
 
1699
    _fmt = "No smart server available at %(url)s"
 
1700
 
 
1701
    def __init__(self, url):
 
1702
        self.url = url
 
1703
 
 
1704
 
 
1705
class UnknownSSH(BzrError):
 
1706
 
 
1707
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1708
 
 
1709
    def __init__(self, vendor):
 
1710
        BzrError.__init__(self)
 
1711
        self.vendor = vendor
 
1712
 
 
1713
 
 
1714
class GhostRevisionUnusableHere(BzrError):
 
1715
 
 
1716
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1717
 
 
1718
    def __init__(self, revision_id):
 
1719
        BzrError.__init__(self)
 
1720
        self.revision_id = revision_id
 
1721
 
 
1722
 
 
1723
class IllegalUseOfScopeReplacer(BzrError):
 
1724
 
 
1725
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
1726
 
 
1727
    internal_error = True
 
1728
 
 
1729
    def __init__(self, name, msg, extra=None):
 
1730
        BzrError.__init__(self)
 
1731
        self.name = name
 
1732
        self.msg = msg
 
1733
        if extra:
 
1734
            self.extra = ': ' + str(extra)
 
1735
        else:
 
1736
            self.extra = ''
 
1737
 
 
1738
 
 
1739
class InvalidImportLine(BzrError):
 
1740
 
 
1741
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1742
 
 
1743
    internal_error = True
 
1744
 
 
1745
    def __init__(self, text, msg):
 
1746
        BzrError.__init__(self)
 
1747
        self.text = text
 
1748
        self.msg = msg
 
1749
 
 
1750
 
 
1751
class ImportNameCollision(BzrError):
 
1752
 
 
1753
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
1754
 
 
1755
    internal_error = True
 
1756
 
 
1757
    def __init__(self, name):
 
1758
        BzrError.__init__(self)
 
1759
        self.name = name