/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

Make branch_implementations/test_http.py a little clearer.

Show diffs side-by-side

added added

removed removed

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