/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

MergeĀ fromĀ dirstate

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