/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

Add a Transport.is_readonly remote call, let {Branch,Repository}.lock_write remote call return UnlockableTransport, and miscellaneous test fixes.

Show diffs side-by-side

added added

removed removed

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