/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Add Repository.{dont_,}leave_lock_in_place.

Show diffs side-by-side

added added

removed removed

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