/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

IntroduceĀ dirstate-tagsĀ format

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