~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-30 10:51:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2259.
  • Revision ID: bialix@ukr.net-20070130105138-280dj0ayzeh886rb
trace.py: open_tracefile(): win98-compatible detection of location for .bzr.log

It's also change default location of .bzr.log on Windows 2000/XP as well:
now it in user's My Documents folder, so it's much better 
for users without administarator priveleges.

Also workaround win32-specific issue with file.tell().

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