/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-03-16 17:47:16 UTC
  • mto: This revision was merged to the branch mainline in revision 2389.
  • Revision ID: abentley@panoramicfeedback.com-20070316174716-0se6k7b4sqr9t12d
test suite fixes

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