~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2007-06-20 22:06:22 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070620220622-9lasxr96rr0e0xvn
Use a fresh versionedfile each time

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