/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: John Arbash Meinel
  • Date: 2007-03-14 20:15:52 UTC
  • mto: (2353.4.2 locking)
  • mto: This revision was merged to the branch mainline in revision 2360.
  • Revision ID: john@arbash-meinel.com-20070314201552-bjtfua57456dviep
Update the lock code and test code so that if more than one
lock implementation is available, they will both be tested.

It is quite a bit of overhead, for a case where we are likely to only have 1
real lock implementation per platform, but hey, for now we have 2.

Show diffs side-by-side

added added

removed removed

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