/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

  • Committer: Aaron Bentley
  • Date: 2007-02-21 06:06:06 UTC
  • mto: (2255.6.1 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: aaron.bentley@utoronto.ca-20070221060606-unjaailciijp12ab
rename working tree format 4 to AB1 everywhere

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