/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Implement _bisect_recursive, which uses multiple bisect calls to
handle renames and finding entries in subdirs.
As is, this could be hooked into paths2ids() if the dirstate has not been loaded yet.
However, it doesn't quite provide enough, since the parsed entries would probably not
be saved. Further, the multiple bisect calls are less efficient then they could be,
because they do not remember the last bisect call.
We should explore switching to a caching structure, which maintains all records that
have been processed, in a structure that can be in-memory searched before going back
to disk.

Show diffs side-by-side

added added

removed removed

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