~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-15 22:35:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2363.
  • Revision ID: john@arbash-meinel.com-20070315223535-d3d4964oe1hc8zhg
Add an overzealous test, for Unicode support of _iter_changes.
For both knowns and unknowns.
And include a basic, if suboptimal, fix.
I would rather defer the decoding until we've determined that we are going to return the tuple.
There is still something broken with added files, but I'll get to that.

Show diffs side-by-side

added added

removed removed

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