~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2005-05-09 06:22:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050509062213-51c8143658708415
todo

Show diffs side-by-side

added added

removed removed

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