~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-03-01 05:02:47 UTC
  • mto: (2255.11.3 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: robertc@robertcollins.net-20070301050247-ufh99m2ze45d7mol
Whitespace fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
21
 
 
22
 
 
23
 
######################################################################
24
 
# exceptions 
 
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
 
25
47
class BzrError(StandardError):
26
 
    pass
 
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
 
27
165
 
28
166
class BzrCheckError(BzrError):
29
 
    pass
30
 
 
 
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
31
265
 
32
266
class BzrCommandError(BzrError):
33
 
    # Error from malformed user command
34
 
    pass
35
 
 
36
 
 
37
 
def bailout(msg, explanation=[]):
38
 
    ex = BzrError(msg, explanation)
39
 
    import trace
40
 
    trace._tracefile.write('* raising %s\n' % ex)
41
 
    raise ex
42
 
 
 
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
 
 
627
class ForbiddenControlFileError(BzrError):
 
628
 
 
629
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
630
 
 
631
 
 
632
class LockError(BzrError):
 
633
 
 
634
    _fmt = "Lock error: %(message)s"
 
635
 
 
636
    internal_error = True
 
637
 
 
638
    # All exceptions from the lock/unlock functions should be from
 
639
    # this exception class.  They will be translated as necessary. The
 
640
    # original exception is available as e.original_error
 
641
    #
 
642
    # New code should prefer to raise specific subclasses
 
643
    def __init__(self, message):
 
644
        self.message = message
 
645
 
 
646
 
 
647
class LockActive(LockError):
 
648
 
 
649
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
650
 
 
651
    internal_error = False
 
652
 
 
653
    def __init__(self, lock_description):
 
654
        self.lock_description = lock_description
 
655
 
 
656
 
 
657
class CommitNotPossible(LockError):
 
658
 
 
659
    _fmt = "A commit was attempted but we do not have a write lock open."
 
660
 
 
661
    def __init__(self):
 
662
        pass
 
663
 
 
664
 
 
665
class AlreadyCommitted(LockError):
 
666
 
 
667
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
668
 
 
669
    def __init__(self):
 
670
        pass
 
671
 
 
672
 
 
673
class ReadOnlyError(LockError):
 
674
 
 
675
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
676
 
 
677
    def __init__(self, obj):
 
678
        self.obj = obj
 
679
 
 
680
 
 
681
class OutSideTransaction(BzrError):
 
682
 
 
683
    _fmt = "A transaction related operation was attempted after the transaction finished."
 
684
 
 
685
 
 
686
class ObjectNotLocked(LockError):
 
687
 
 
688
    _fmt = "%(obj)r is not locked"
 
689
 
 
690
    # this can indicate that any particular object is not locked; see also
 
691
    # LockNotHeld which means that a particular *lock* object is not held by
 
692
    # the caller -- perhaps they should be unified.
 
693
    def __init__(self, obj):
 
694
        self.obj = obj
 
695
 
 
696
 
 
697
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
698
 
 
699
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
700
 
 
701
    def __init__(self, obj):
 
702
        self.obj = obj
 
703
 
 
704
 
 
705
class UnlockableTransport(LockError):
 
706
 
 
707
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
708
 
 
709
    def __init__(self, transport):
 
710
        self.transport = transport
 
711
 
 
712
 
 
713
class LockContention(LockError):
 
714
 
 
715
    _fmt = "Could not acquire lock %(lock)s"
 
716
    # TODO: show full url for lock, combining the transport and relative
 
717
    # bits?
 
718
 
 
719
    internal_error = False
 
720
    
 
721
    def __init__(self, lock):
 
722
        self.lock = lock
 
723
 
 
724
 
 
725
class LockBroken(LockError):
 
726
 
 
727
    _fmt = "Lock was broken while still open: %(lock)s - check storage consistency!"
 
728
 
 
729
    internal_error = False
 
730
 
 
731
    def __init__(self, lock):
 
732
        self.lock = lock
 
733
 
 
734
 
 
735
class LockBreakMismatch(LockError):
 
736
 
 
737
    _fmt = "Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"
 
738
 
 
739
    internal_error = False
 
740
 
 
741
    def __init__(self, lock, holder, target):
 
742
        self.lock = lock
 
743
        self.holder = holder
 
744
        self.target = target
 
745
 
 
746
 
 
747
class LockNotHeld(LockError):
 
748
 
 
749
    _fmt = "Lock not held: %(lock)s"
 
750
 
 
751
    internal_error = False
 
752
 
 
753
    def __init__(self, lock):
 
754
        self.lock = lock
 
755
 
 
756
 
 
757
class PointlessCommit(BzrError):
 
758
 
 
759
    _fmt = "No changes to commit"
 
760
 
 
761
 
 
762
class UpgradeReadonly(BzrError):
 
763
 
 
764
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
765
 
 
766
 
 
767
class UpToDateFormat(BzrError):
 
768
 
 
769
    _fmt = "The branch format %(format)s is already at the most recent format."
 
770
 
 
771
    def __init__(self, format):
 
772
        BzrError.__init__(self)
 
773
        self.format = format
 
774
 
 
775
 
 
776
class StrictCommitFailed(Exception):
 
777
 
 
778
    _fmt = "Commit refused because there are unknowns in the tree."
 
779
 
 
780
 
 
781
class NoSuchRevision(BzrError):
 
782
 
 
783
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
784
 
 
785
    internal_error = True
 
786
 
 
787
    def __init__(self, branch, revision):
 
788
        BzrError.__init__(self, branch=branch, revision=revision)
 
789
 
 
790
 
 
791
class NotLeftParentDescendant(BzrError):
 
792
 
 
793
    _fmt = "Revision %(old_revision)s is not the left parent of"\
 
794
        " %(new_revision)s, but branch %(branch_location)s expects this"
 
795
 
 
796
    internal_error = True
 
797
 
 
798
    def __init__(self, branch, old_revision, new_revision):
 
799
        BzrError.__init__(self, branch_location=branch.base,
 
800
                          old_revision=old_revision,
 
801
                          new_revision=new_revision)
 
802
 
 
803
 
 
804
class NoSuchRevisionSpec(BzrError):
 
805
 
 
806
    _fmt = "No namespace registered for string: %(spec)r"
 
807
 
 
808
    def __init__(self, spec):
 
809
        BzrError.__init__(self, spec=spec)
 
810
 
 
811
 
 
812
class NoSuchRevisionInTree(NoSuchRevision):
 
813
    """When using Tree.revision_tree, and the revision is not accessible."""
 
814
    
 
815
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
816
 
 
817
    def __init__(self, tree, revision_id):
 
818
        BzrError.__init__(self)
 
819
        self.tree = tree
 
820
        self.revision_id = revision_id
 
821
 
 
822
 
 
823
class InvalidRevisionSpec(BzrError):
 
824
 
 
825
    _fmt = "Requested revision: %(spec)r does not exist in branch: %(branch)s%(extra)s"
 
826
 
 
827
    def __init__(self, spec, branch, extra=None):
 
828
        BzrError.__init__(self, branch=branch, spec=spec)
 
829
        if extra:
 
830
            self.extra = '\n' + str(extra)
 
831
        else:
 
832
            self.extra = ''
 
833
 
 
834
 
 
835
class HistoryMissing(BzrError):
 
836
 
 
837
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
838
 
 
839
 
 
840
class AppendRevisionsOnlyViolation(BzrError):
 
841
 
 
842
    _fmt = 'Operation denied because it would change the main history, '\
 
843
           'which is not permitted by the append_revisions_only setting on'\
 
844
           ' branch "%(location)s".'
 
845
 
 
846
    def __init__(self, location):
 
847
       import bzrlib.urlutils as urlutils
 
848
       location = urlutils.unescape_for_display(location, 'ascii')
 
849
       BzrError.__init__(self, location=location)
 
850
 
 
851
 
 
852
class DivergedBranches(BzrError):
 
853
    
 
854
    _fmt = "These branches have diverged.  Use the merge command to reconcile them."""
 
855
 
 
856
    internal_error = False
 
857
 
 
858
    def __init__(self, branch1, branch2):
 
859
        self.branch1 = branch1
 
860
        self.branch2 = branch2
 
861
 
 
862
 
 
863
class NotLefthandHistory(BzrError):
 
864
 
 
865
    _fmt = "Supplied history does not follow left-hand parents"
 
866
 
 
867
    internal_error = True
 
868
 
 
869
    def __init__(self, history):
 
870
        BzrError.__init__(self, history=history)
 
871
 
 
872
 
 
873
class UnrelatedBranches(BzrError):
 
874
 
 
875
    _fmt = "Branches have no common ancestor, and no merge base revision was specified."
 
876
 
 
877
    internal_error = False
 
878
 
 
879
 
 
880
class NoCommonAncestor(BzrError):
 
881
    
 
882
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
883
 
 
884
    def __init__(self, revision_a, revision_b):
 
885
        self.revision_a = revision_a
 
886
        self.revision_b = revision_b
 
887
 
 
888
 
 
889
class NoCommonRoot(BzrError):
 
890
 
 
891
    _fmt = "Revisions are not derived from the same root: " \
 
892
           "%(revision_a)s %(revision_b)s."
 
893
 
 
894
    def __init__(self, revision_a, revision_b):
 
895
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
896
 
 
897
 
 
898
class NotAncestor(BzrError):
 
899
 
 
900
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
901
 
 
902
    def __init__(self, rev_id, not_ancestor_id):
 
903
        BzrError.__init__(self, rev_id=rev_id,
 
904
            not_ancestor_id=not_ancestor_id)
 
905
 
 
906
 
 
907
class InstallFailed(BzrError):
 
908
 
 
909
    def __init__(self, revisions):
 
910
        revision_str = ", ".join(str(r) for r in revisions)
 
911
        msg = "Could not install revisions:\n%s" % revision_str
 
912
        BzrError.__init__(self, msg)
 
913
        self.revisions = revisions
 
914
 
 
915
 
 
916
class AmbiguousBase(BzrError):
 
917
 
 
918
    def __init__(self, bases):
 
919
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
920
                DeprecationWarning)
 
921
        msg = "The correct base is unclear, because %s are all equally close" %\
 
922
            ", ".join(bases)
 
923
        BzrError.__init__(self, msg)
 
924
        self.bases = bases
 
925
 
 
926
 
 
927
class NoCommits(BzrError):
 
928
 
 
929
    _fmt = "Branch %(branch)s has no commits."
 
930
 
 
931
    def __init__(self, branch):
 
932
        BzrError.__init__(self, branch=branch)
 
933
 
 
934
 
 
935
class UnlistableStore(BzrError):
 
936
 
 
937
    def __init__(self, store):
 
938
        BzrError.__init__(self, "Store %s is not listable" % store)
 
939
 
 
940
 
 
941
 
 
942
class UnlistableBranch(BzrError):
 
943
 
 
944
    def __init__(self, br):
 
945
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
946
 
 
947
 
 
948
class BoundBranchOutOfDate(BzrError):
 
949
 
 
950
    _fmt = "Bound branch %(branch)s is out of date with master branch %(master)s."
 
951
 
 
952
    def __init__(self, branch, master):
 
953
        BzrError.__init__(self)
 
954
        self.branch = branch
 
955
        self.master = master
 
956
 
 
957
        
 
958
class CommitToDoubleBoundBranch(BzrError):
 
959
 
 
960
    _fmt = "Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."
 
961
 
 
962
    def __init__(self, branch, master, remote):
 
963
        BzrError.__init__(self)
 
964
        self.branch = branch
 
965
        self.master = master
 
966
        self.remote = remote
 
967
 
 
968
 
 
969
class OverwriteBoundBranch(BzrError):
 
970
 
 
971
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
972
 
 
973
    def __init__(self, branch):
 
974
        BzrError.__init__(self)
 
975
        self.branch = branch
 
976
 
 
977
 
 
978
class BoundBranchConnectionFailure(BzrError):
 
979
 
 
980
    _fmt = "Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"
 
981
 
 
982
    def __init__(self, branch, target, error):
 
983
        BzrError.__init__(self)
 
984
        self.branch = branch
 
985
        self.target = target
 
986
        self.error = error
 
987
 
 
988
 
 
989
class WeaveError(BzrError):
 
990
 
 
991
    _fmt = "Error in processing weave: %(message)s"
 
992
 
 
993
    def __init__(self, message=None):
 
994
        BzrError.__init__(self)
 
995
        self.message = message
 
996
 
 
997
 
 
998
class WeaveRevisionAlreadyPresent(WeaveError):
 
999
 
 
1000
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1001
 
 
1002
    def __init__(self, revision_id, weave):
 
1003
 
 
1004
        WeaveError.__init__(self)
 
1005
        self.revision_id = revision_id
 
1006
        self.weave = weave
 
1007
 
 
1008
 
 
1009
class WeaveRevisionNotPresent(WeaveError):
 
1010
 
 
1011
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1012
 
 
1013
    def __init__(self, revision_id, weave):
 
1014
        WeaveError.__init__(self)
 
1015
        self.revision_id = revision_id
 
1016
        self.weave = weave
 
1017
 
 
1018
 
 
1019
class WeaveFormatError(WeaveError):
 
1020
 
 
1021
    _fmt = "Weave invariant violated: %(what)s"
 
1022
 
 
1023
    def __init__(self, what):
 
1024
        WeaveError.__init__(self)
 
1025
        self.what = what
 
1026
 
 
1027
 
 
1028
class WeaveParentMismatch(WeaveError):
 
1029
 
 
1030
    _fmt = "Parents are mismatched between two revisions."
 
1031
    
 
1032
 
 
1033
class WeaveInvalidChecksum(WeaveError):
 
1034
 
 
1035
    _fmt = "Text did not match it's checksum: %(message)s"
 
1036
 
 
1037
 
 
1038
class WeaveTextDiffers(WeaveError):
 
1039
 
 
1040
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1041
 
 
1042
    def __init__(self, revision_id, weave_a, weave_b):
 
1043
        WeaveError.__init__(self)
 
1044
        self.revision_id = revision_id
 
1045
        self.weave_a = weave_a
 
1046
        self.weave_b = weave_b
 
1047
 
 
1048
 
 
1049
class WeaveTextDiffers(WeaveError):
 
1050
 
 
1051
    _fmt = "Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"
 
1052
 
 
1053
    def __init__(self, revision_id, weave_a, weave_b):
 
1054
        WeaveError.__init__(self)
 
1055
        self.revision_id = revision_id
 
1056
        self.weave_a = weave_a
 
1057
        self.weave_b = weave_b
 
1058
 
 
1059
 
 
1060
class VersionedFileError(BzrError):
 
1061
    
 
1062
    _fmt = "Versioned file error"
 
1063
 
 
1064
 
 
1065
class RevisionNotPresent(VersionedFileError):
 
1066
    
 
1067
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1068
 
 
1069
    def __init__(self, revision_id, file_id):
 
1070
        VersionedFileError.__init__(self)
 
1071
        self.revision_id = revision_id
 
1072
        self.file_id = file_id
 
1073
 
 
1074
 
 
1075
class RevisionAlreadyPresent(VersionedFileError):
 
1076
    
 
1077
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1078
 
 
1079
    def __init__(self, revision_id, file_id):
 
1080
        VersionedFileError.__init__(self)
 
1081
        self.revision_id = revision_id
 
1082
        self.file_id = file_id
 
1083
 
 
1084
 
 
1085
class KnitError(BzrError):
 
1086
    
 
1087
    _fmt = "Knit error"
 
1088
 
 
1089
    internal_error = True
 
1090
 
 
1091
 
 
1092
class KnitHeaderError(KnitError):
 
1093
 
 
1094
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1095
 
 
1096
    def __init__(self, badline, filename):
 
1097
        KnitError.__init__(self)
 
1098
        self.badline = badline
 
1099
        self.filename = filename
 
1100
 
 
1101
 
 
1102
class KnitCorrupt(KnitError):
 
1103
 
 
1104
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1105
 
 
1106
    def __init__(self, filename, how):
 
1107
        KnitError.__init__(self)
 
1108
        self.filename = filename
 
1109
        self.how = how
 
1110
 
 
1111
 
 
1112
class KnitIndexUnknownMethod(KnitError):
 
1113
    """Raised when we don't understand the storage method.
 
1114
 
 
1115
    Currently only 'fulltext' and 'line-delta' are supported.
 
1116
    """
 
1117
    
 
1118
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1119
            " in options: %(options)r")
 
1120
 
 
1121
    def __init__(self, filename, options):
 
1122
        KnitError.__init__(self)
 
1123
        self.filename = filename
 
1124
        self.options = options
 
1125
 
 
1126
 
 
1127
class NoSuchExportFormat(BzrError):
 
1128
    
 
1129
    _fmt = "Export format %(format)r not supported"
 
1130
 
 
1131
    def __init__(self, format):
 
1132
        BzrError.__init__(self)
 
1133
        self.format = format
 
1134
 
 
1135
 
 
1136
class TransportError(BzrError):
 
1137
    
 
1138
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1139
 
 
1140
    def __init__(self, msg=None, orig_error=None):
 
1141
        if msg is None and orig_error is not None:
 
1142
            msg = str(orig_error)
 
1143
        if orig_error is None:
 
1144
            orig_error = ''
 
1145
        if msg is None:
 
1146
            msg =  ''
 
1147
        self.msg = msg
 
1148
        self.orig_error = orig_error
 
1149
        BzrError.__init__(self)
 
1150
 
 
1151
 
 
1152
class TooManyConcurrentRequests(BzrError):
 
1153
 
 
1154
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit. "
 
1155
            "Be sure to finish_writing and finish_reading on the "
 
1156
            "current request that is open.")
 
1157
 
 
1158
    internal_error = True
 
1159
 
 
1160
    def __init__(self, medium):
 
1161
        self.medium = medium
 
1162
 
 
1163
 
 
1164
class SmartProtocolError(TransportError):
 
1165
 
 
1166
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1167
 
 
1168
    def __init__(self, details):
 
1169
        self.details = details
 
1170
 
 
1171
 
 
1172
# A set of semi-meaningful errors which can be thrown
 
1173
class TransportNotPossible(TransportError):
 
1174
 
 
1175
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1176
 
 
1177
 
 
1178
class ConnectionError(TransportError):
 
1179
 
 
1180
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1181
 
 
1182
 
 
1183
class SocketConnectionError(ConnectionError):
 
1184
 
 
1185
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1186
 
 
1187
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1188
        if msg is None:
 
1189
            msg = 'Failed to connect to'
 
1190
        if orig_error is None:
 
1191
            orig_error = ''
 
1192
        else:
 
1193
            orig_error = '; ' + str(orig_error)
 
1194
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1195
        self.host = host
 
1196
        if port is None:
 
1197
            self.port = ''
 
1198
        else:
 
1199
            self.port = ':%s' % port
 
1200
 
 
1201
 
 
1202
class ConnectionReset(TransportError):
 
1203
 
 
1204
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1205
 
 
1206
 
 
1207
class InvalidRange(TransportError):
 
1208
 
 
1209
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1210
    
 
1211
    def __init__(self, path, offset):
 
1212
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1213
                                       % (path, offset)))
 
1214
        self.path = path
 
1215
        self.offset = offset
 
1216
 
 
1217
 
 
1218
class InvalidHttpResponse(TransportError):
 
1219
 
 
1220
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1221
 
 
1222
    def __init__(self, path, msg, orig_error=None):
 
1223
        self.path = path
 
1224
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1225
 
 
1226
 
 
1227
class InvalidHttpRange(InvalidHttpResponse):
 
1228
 
 
1229
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1230
    
 
1231
    def __init__(self, path, range, msg):
 
1232
        self.range = range
 
1233
        InvalidHttpResponse.__init__(self, path, msg)
 
1234
 
 
1235
 
 
1236
class InvalidHttpContentType(InvalidHttpResponse):
 
1237
 
 
1238
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1239
    
 
1240
    def __init__(self, path, ctype, msg):
 
1241
        self.ctype = ctype
 
1242
        InvalidHttpResponse.__init__(self, path, msg)
 
1243
 
 
1244
 
 
1245
class ConflictsInTree(BzrError):
 
1246
 
 
1247
    _fmt = "Working tree has conflicts."
 
1248
 
 
1249
 
 
1250
class ParseConfigError(BzrError):
 
1251
 
 
1252
    def __init__(self, errors, filename):
 
1253
        if filename is None:
 
1254
            filename = ""
 
1255
        message = "Error(s) parsing config file %s:\n%s" % \
 
1256
            (filename, ('\n'.join(e.message for e in errors)))
 
1257
        BzrError.__init__(self, message)
 
1258
 
 
1259
 
 
1260
class NoEmailInUsername(BzrError):
 
1261
 
 
1262
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1263
 
 
1264
    def __init__(self, username):
 
1265
        BzrError.__init__(self)
 
1266
        self.username = username
 
1267
 
 
1268
 
 
1269
class SigningFailed(BzrError):
 
1270
 
 
1271
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1272
 
 
1273
    def __init__(self, command_line):
 
1274
        BzrError.__init__(self, command_line=command_line)
 
1275
 
 
1276
 
 
1277
class WorkingTreeNotRevision(BzrError):
 
1278
 
 
1279
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1280
            " the last commit, but weave merge requires that it be"
 
1281
            " unchanged")
 
1282
 
 
1283
    def __init__(self, tree):
 
1284
        BzrError.__init__(self, basedir=tree.basedir)
 
1285
 
 
1286
 
 
1287
class CantReprocessAndShowBase(BzrError):
 
1288
 
 
1289
    _fmt = "Can't reprocess and show base, because reprocessing obscures " \
 
1290
           "the relationship of conflicting lines to the base"
 
1291
 
 
1292
 
 
1293
class GraphCycleError(BzrError):
 
1294
 
 
1295
    _fmt = "Cycle in graph %(graph)r"
 
1296
 
 
1297
    def __init__(self, graph):
 
1298
        BzrError.__init__(self)
 
1299
        self.graph = graph
 
1300
 
 
1301
 
 
1302
class WritingCompleted(BzrError):
 
1303
 
 
1304
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1305
            "called upon it - accept bytes may not be called anymore.")
 
1306
 
 
1307
    internal_error = True
 
1308
 
 
1309
    def __init__(self, request):
 
1310
        self.request = request
 
1311
 
 
1312
 
 
1313
class WritingNotComplete(BzrError):
 
1314
 
 
1315
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1316
            "called upon it - until the write phase is complete no "
 
1317
            "data may be read.")
 
1318
 
 
1319
    internal_error = True
 
1320
 
 
1321
    def __init__(self, request):
 
1322
        self.request = request
 
1323
 
 
1324
 
 
1325
class NotConflicted(BzrError):
 
1326
 
 
1327
    _fmt = "File %(filename)s is not conflicted."
 
1328
 
 
1329
    def __init__(self, filename):
 
1330
        BzrError.__init__(self)
 
1331
        self.filename = filename
 
1332
 
 
1333
 
 
1334
class MediumNotConnected(BzrError):
 
1335
 
 
1336
    _fmt = """The medium '%(medium)s' is not connected."""
 
1337
 
 
1338
    internal_error = True
 
1339
 
 
1340
    def __init__(self, medium):
 
1341
        self.medium = medium
 
1342
 
 
1343
 
 
1344
class MustUseDecorated(Exception):
 
1345
    
 
1346
    _fmt = """A decorating function has requested its original command be used."""
 
1347
    
 
1348
 
 
1349
class NoBundleFound(BzrError):
 
1350
 
 
1351
    _fmt = "No bundle was found in %(filename)s"
 
1352
 
 
1353
    def __init__(self, filename):
 
1354
        BzrError.__init__(self)
 
1355
        self.filename = filename
 
1356
 
 
1357
 
 
1358
class BundleNotSupported(BzrError):
 
1359
 
 
1360
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1361
 
 
1362
    def __init__(self, version, msg):
 
1363
        BzrError.__init__(self)
 
1364
        self.version = version
 
1365
        self.msg = msg
 
1366
 
 
1367
 
 
1368
class MissingText(BzrError):
 
1369
 
 
1370
    _fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
 
1371
 
 
1372
    def __init__(self, branch, text_revision, file_id):
 
1373
        BzrError.__init__(self)
 
1374
        self.branch = branch
 
1375
        self.base = branch.base
 
1376
        self.text_revision = text_revision
 
1377
        self.file_id = file_id
 
1378
 
 
1379
 
 
1380
class DuplicateFileId(BzrError):
 
1381
 
 
1382
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1383
 
 
1384
    def __init__(self, file_id, entry):
 
1385
        BzrError.__init__(self)
 
1386
        self.file_id = file_id
 
1387
        self.entry = entry
 
1388
 
 
1389
 
 
1390
class DuplicateKey(BzrError):
 
1391
 
 
1392
    _fmt = "Key %(key)s is already present in map"
 
1393
 
 
1394
 
 
1395
class MalformedTransform(BzrError):
 
1396
 
 
1397
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1398
 
 
1399
 
 
1400
class NoFinalPath(BzrError):
 
1401
 
 
1402
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1403
            "file-id: %(file_id)r\n"
 
1404
            "root trans-id: %(root_trans_id)r\n")
 
1405
 
 
1406
    def __init__(self, trans_id, transform):
 
1407
        self.trans_id = trans_id
 
1408
        self.file_id = transform.final_file_id(trans_id)
 
1409
        self.root_trans_id = transform.root
 
1410
 
 
1411
 
 
1412
class BzrBadParameter(BzrError):
 
1413
 
 
1414
    _fmt = "Bad parameter: %(param)r"
 
1415
 
 
1416
    # This exception should never be thrown, but it is a base class for all
 
1417
    # parameter-to-function errors.
 
1418
 
 
1419
    def __init__(self, param):
 
1420
        BzrError.__init__(self)
 
1421
        self.param = param
 
1422
 
 
1423
 
 
1424
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1425
 
 
1426
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1427
 
 
1428
 
 
1429
class ReusingTransform(BzrError):
 
1430
 
 
1431
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1432
 
 
1433
 
 
1434
class CantMoveRoot(BzrError):
 
1435
 
 
1436
    _fmt = "Moving the root directory is not supported at this time"
 
1437
 
 
1438
 
 
1439
class BzrMoveFailedError(BzrError):
 
1440
 
 
1441
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1442
 
 
1443
    def __init__(self, from_path='', to_path='', extra=None):
 
1444
        BzrError.__init__(self)
 
1445
        if extra:
 
1446
            self.extra = ': ' + str(extra)
 
1447
        else:
 
1448
            self.extra = ''
 
1449
 
 
1450
        has_from = len(from_path) > 0
 
1451
        has_to = len(to_path) > 0
 
1452
        if has_from:
 
1453
            self.from_path = osutils.splitpath(from_path)[-1]
 
1454
        else:
 
1455
            self.from_path = ''
 
1456
 
 
1457
        if has_to:
 
1458
            self.to_path = osutils.splitpath(to_path)[-1]
 
1459
        else:
 
1460
            self.to_path = ''
 
1461
 
 
1462
        self.operator = ""
 
1463
        if has_from and has_to:
 
1464
            self.operator = " =>"
 
1465
        elif has_from:
 
1466
            self.from_path = "from " + from_path
 
1467
        elif has_to:
 
1468
            self.operator = "to"
 
1469
        else:
 
1470
            self.operator = "file"
 
1471
 
 
1472
 
 
1473
class BzrRenameFailedError(BzrMoveFailedError):
 
1474
 
 
1475
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1476
 
 
1477
    def __init__(self, from_path, to_path, extra=None):
 
1478
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1479
 
 
1480
 
 
1481
class BzrBadParameterNotString(BzrBadParameter):
 
1482
 
 
1483
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1484
 
 
1485
 
 
1486
class BzrBadParameterMissing(BzrBadParameter):
 
1487
 
 
1488
    _fmt = "Parameter $(param)s is required but not present."
 
1489
 
 
1490
 
 
1491
class BzrBadParameterUnicode(BzrBadParameter):
 
1492
 
 
1493
    _fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
 
1494
 
 
1495
 
 
1496
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1497
 
 
1498
    _fmt = "Parameter %(param)s contains a newline."
 
1499
 
 
1500
 
 
1501
class DependencyNotPresent(BzrError):
 
1502
 
 
1503
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1504
 
 
1505
    def __init__(self, library, error):
 
1506
        BzrError.__init__(self, library=library, error=error)
 
1507
 
 
1508
 
 
1509
class ParamikoNotPresent(DependencyNotPresent):
 
1510
 
 
1511
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1512
 
 
1513
    def __init__(self, error):
 
1514
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1515
 
 
1516
 
 
1517
class PointlessMerge(BzrError):
 
1518
 
 
1519
    _fmt = "Nothing to merge."
 
1520
 
 
1521
 
 
1522
class UninitializableFormat(BzrError):
 
1523
 
 
1524
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1525
 
 
1526
    def __init__(self, format):
 
1527
        BzrError.__init__(self)
 
1528
        self.format = format
 
1529
 
 
1530
 
 
1531
class BadConversionTarget(BzrError):
 
1532
 
 
1533
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1534
 
 
1535
    def __init__(self, problem, format):
 
1536
        BzrError.__init__(self)
 
1537
        self.problem = problem
 
1538
        self.format = format
 
1539
 
 
1540
 
 
1541
class NoDiff(BzrError):
 
1542
 
 
1543
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1544
 
 
1545
    def __init__(self, msg):
 
1546
        BzrError.__init__(self, msg=msg)
 
1547
 
 
1548
 
 
1549
class NoDiff3(BzrError):
 
1550
 
 
1551
    _fmt = "Diff3 is not installed on this machine."
 
1552
 
 
1553
 
 
1554
class ExistingLimbo(BzrError):
 
1555
 
 
1556
    _fmt = """This tree contains left-over files from a failed operation.
 
1557
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1558
    keep, and delete it when you are done."""
 
1559
    
 
1560
    def __init__(self, limbo_dir):
 
1561
       BzrError.__init__(self)
 
1562
       self.limbo_dir = limbo_dir
 
1563
 
 
1564
 
 
1565
class ImmortalLimbo(BzrError):
 
1566
 
 
1567
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1568
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1569
    keep, and delete it when you are done."""
 
1570
 
 
1571
    def __init__(self, limbo_dir):
 
1572
       BzrError.__init__(self)
 
1573
       self.limbo_dir = limbo_dir
 
1574
 
 
1575
 
 
1576
class OutOfDateTree(BzrError):
 
1577
 
 
1578
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1579
 
 
1580
    def __init__(self, tree):
 
1581
        BzrError.__init__(self)
 
1582
        self.tree = tree
 
1583
 
 
1584
 
 
1585
class MergeModifiedFormatError(BzrError):
 
1586
 
 
1587
    _fmt = "Error in merge modified format"
 
1588
 
 
1589
 
 
1590
class ConflictFormatError(BzrError):
 
1591
 
 
1592
    _fmt = "Format error in conflict listings"
 
1593
 
 
1594
 
 
1595
class CorruptRepository(BzrError):
 
1596
 
 
1597
    _fmt = """An error has been detected in the repository %(repo_path)s.
 
1598
Please run bzr reconcile on this repository."""
 
1599
 
 
1600
    def __init__(self, repo):
 
1601
        BzrError.__init__(self)
 
1602
        self.repo_path = repo.bzrdir.root_transport.base
 
1603
 
 
1604
 
 
1605
class UpgradeRequired(BzrError):
 
1606
 
 
1607
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1608
 
 
1609
    def __init__(self, path):
 
1610
        BzrError.__init__(self)
 
1611
        self.path = path
 
1612
 
 
1613
 
 
1614
class LocalRequiresBoundBranch(BzrError):
 
1615
 
 
1616
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1617
 
 
1618
 
 
1619
class MissingProgressBarFinish(BzrError):
 
1620
 
 
1621
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1622
 
 
1623
 
 
1624
class InvalidProgressBarType(BzrError):
 
1625
 
 
1626
    _fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1627
Select one of: %(valid_types)s"""
 
1628
 
 
1629
    def __init__(self, bar_type, valid_types):
 
1630
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1631
 
 
1632
 
 
1633
class UnsupportedOperation(BzrError):
 
1634
 
 
1635
    _fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
 
1636
 
 
1637
    def __init__(self, method, method_self):
 
1638
        self.method = method
 
1639
        self.mname = method.__name__
 
1640
        self.tname = type(method_self).__name__
 
1641
 
 
1642
 
 
1643
class CannotSetRevisionId(UnsupportedOperation):
 
1644
    """Raised when a commit is attempting to set a revision id but cant."""
 
1645
 
 
1646
 
 
1647
class NonAsciiRevisionId(UnsupportedOperation):
 
1648
    """Raised when a commit is attempting to set a non-ascii revision id but cant."""
 
1649
 
 
1650
 
 
1651
class BinaryFile(BzrError):
 
1652
    
 
1653
    _fmt = "File is binary but should be text."
 
1654
 
 
1655
 
 
1656
class IllegalPath(BzrError):
 
1657
 
 
1658
    _fmt = "The path %(path)s is not permitted on this platform"
 
1659
 
 
1660
    def __init__(self, path):
 
1661
        BzrError.__init__(self)
 
1662
        self.path = path
 
1663
 
 
1664
 
 
1665
class TestamentMismatch(BzrError):
 
1666
 
 
1667
    _fmt = """Testament did not match expected value.  
 
1668
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1669
       {%(measured)s}"""
 
1670
 
 
1671
    def __init__(self, revision_id, expected, measured):
 
1672
        self.revision_id = revision_id
 
1673
        self.expected = expected
 
1674
        self.measured = measured
 
1675
 
 
1676
 
 
1677
class NotABundle(BzrError):
 
1678
    
 
1679
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1680
 
 
1681
    def __init__(self, text):
 
1682
        BzrError.__init__(self)
 
1683
        self.text = text
 
1684
 
 
1685
 
 
1686
class BadBundle(BzrError): 
 
1687
    
 
1688
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1689
 
 
1690
    def __init__(self, text):
 
1691
        BzrError.__init__(self)
 
1692
        self.text = text
 
1693
 
 
1694
 
 
1695
class MalformedHeader(BadBundle): 
 
1696
    
 
1697
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1698
 
 
1699
 
 
1700
class MalformedPatches(BadBundle): 
 
1701
    
 
1702
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1703
 
 
1704
 
 
1705
class MalformedFooter(BadBundle): 
 
1706
    
 
1707
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1708
 
 
1709
 
 
1710
class UnsupportedEOLMarker(BadBundle):
 
1711
    
 
1712
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1713
 
 
1714
    def __init__(self):
 
1715
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1716
        # but for this there is not
 
1717
        BzrError.__init__(self)
 
1718
 
 
1719
 
 
1720
class IncompatibleBundleFormat(BzrError):
 
1721
    
 
1722
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1723
 
 
1724
    def __init__(self, bundle_format, other):
 
1725
        BzrError.__init__(self)
 
1726
        self.bundle_format = bundle_format
 
1727
        self.other = other
 
1728
 
 
1729
 
 
1730
class BadInventoryFormat(BzrError):
 
1731
    
 
1732
    _fmt = "Root class for inventory serialization errors"
 
1733
 
 
1734
 
 
1735
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1736
 
 
1737
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1738
 
 
1739
    def __init__(self, msg):
 
1740
        BadInventoryFormat.__init__(self, msg=msg)
 
1741
 
 
1742
 
 
1743
class NoSmartMedium(BzrError):
 
1744
 
 
1745
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1746
    internal_error = True
 
1747
 
 
1748
    def __init__(self, transport):
 
1749
        self.transport = transport
 
1750
 
 
1751
 
 
1752
class NoSmartServer(NotBranchError):
 
1753
 
 
1754
    _fmt = "No smart server available at %(url)s"
 
1755
 
 
1756
    def __init__(self, url):
 
1757
        self.url = url
 
1758
 
 
1759
 
 
1760
class UnknownSSH(BzrError):
 
1761
 
 
1762
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1763
 
 
1764
    def __init__(self, vendor):
 
1765
        BzrError.__init__(self)
 
1766
        self.vendor = vendor
 
1767
 
 
1768
 
 
1769
class GhostRevisionUnusableHere(BzrError):
 
1770
 
 
1771
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1772
 
 
1773
    def __init__(self, revision_id):
 
1774
        BzrError.__init__(self)
 
1775
        self.revision_id = revision_id
 
1776
 
 
1777
 
 
1778
class IllegalUseOfScopeReplacer(BzrError):
 
1779
 
 
1780
    _fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
 
1781
 
 
1782
    internal_error = True
 
1783
 
 
1784
    def __init__(self, name, msg, extra=None):
 
1785
        BzrError.__init__(self)
 
1786
        self.name = name
 
1787
        self.msg = msg
 
1788
        if extra:
 
1789
            self.extra = ': ' + str(extra)
 
1790
        else:
 
1791
            self.extra = ''
 
1792
 
 
1793
 
 
1794
class InvalidImportLine(BzrError):
 
1795
 
 
1796
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1797
 
 
1798
    internal_error = True
 
1799
 
 
1800
    def __init__(self, text, msg):
 
1801
        BzrError.__init__(self)
 
1802
        self.text = text
 
1803
        self.msg = msg
 
1804
 
 
1805
 
 
1806
class ImportNameCollision(BzrError):
 
1807
 
 
1808
    _fmt = "Tried to import an object to the same name as an existing object. %(name)s"
 
1809
 
 
1810
    internal_error = True
 
1811
 
 
1812
    def __init__(self, name):
 
1813
        BzrError.__init__(self)
 
1814
        self.name = name