/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

  • Committer: Andrew Bennetts
  • Date: 2007-03-28 07:38:53 UTC
  • mto: (2018.5.146 hpss)
  • mto: This revision was merged to the branch mainline in revision 2414.
  • Revision ID: andrew.bennetts@canonical.com-20070328073853-yje2ikoflt6a4jos
Some tweaks in response to review.

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: %(msg)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
        # Python 2.5 uses a slot for StandardError.message,
 
661
        # so use a different variable name
 
662
        # so it is exposed in self.__dict__
 
663
        self.msg = message
 
664
 
 
665
 
 
666
class LockActive(LockError):
 
667
 
 
668
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
669
 
 
670
    internal_error = False
 
671
 
 
672
    def __init__(self, lock_description):
 
673
        self.lock_description = lock_description
 
674
 
 
675
 
 
676
class CommitNotPossible(LockError):
 
677
 
 
678
    _fmt = "A commit was attempted but we do not have a write lock open."
 
679
 
 
680
    def __init__(self):
 
681
        pass
 
682
 
 
683
 
 
684
class AlreadyCommitted(LockError):
 
685
 
 
686
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
687
 
 
688
    def __init__(self):
 
689
        pass
 
690
 
 
691
 
 
692
class ReadOnlyError(LockError):
 
693
 
 
694
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
695
 
 
696
    # TODO: There should also be an error indicating that you need a write
 
697
    # lock and don't have any lock at all... mbp 20070226
 
698
 
 
699
    def __init__(self, obj):
 
700
        self.obj = obj
 
701
 
 
702
 
 
703
class ReadOnlyLockError(LockError):
 
704
 
 
705
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
706
 
 
707
    def __init__(self, fname, msg):
 
708
        LockError.__init__(self, '')
 
709
        self.fname = fname
 
710
        self.msg = msg
 
711
 
 
712
 
 
713
class OutSideTransaction(BzrError):
 
714
 
 
715
    _fmt = ("A transaction related operation was attempted after"
 
716
            " the transaction finished.")
 
717
 
 
718
 
 
719
class ObjectNotLocked(LockError):
 
720
 
 
721
    _fmt = "%(obj)r is not locked"
 
722
 
 
723
    # this can indicate that any particular object is not locked; see also
 
724
    # LockNotHeld which means that a particular *lock* object is not held by
 
725
    # the caller -- perhaps they should be unified.
 
726
    def __init__(self, obj):
 
727
        self.obj = obj
 
728
 
 
729
 
 
730
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
731
 
 
732
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
733
 
 
734
    def __init__(self, obj):
 
735
        self.obj = obj
 
736
 
 
737
 
 
738
class UnlockableTransport(LockError):
 
739
 
 
740
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
741
 
 
742
    def __init__(self, transport):
 
743
        self.transport = transport
 
744
 
 
745
 
 
746
class LockContention(LockError):
 
747
 
 
748
    _fmt = "Could not acquire lock %(lock)s"
 
749
    # TODO: show full url for lock, combining the transport and relative
 
750
    # bits?
 
751
 
 
752
    internal_error = False
 
753
 
 
754
    def __init__(self, lock):
 
755
        self.lock = lock
 
756
 
 
757
 
 
758
class LockBroken(LockError):
 
759
 
 
760
    _fmt = ("Lock was broken while still open: %(lock)s"
 
761
            " - check storage consistency!")
 
762
 
 
763
    internal_error = False
 
764
 
 
765
    def __init__(self, lock):
 
766
        self.lock = lock
 
767
 
 
768
 
 
769
class LockBreakMismatch(LockError):
 
770
 
 
771
    _fmt = ("Lock was released and re-acquired before being broken:"
 
772
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
773
 
 
774
    internal_error = False
 
775
 
 
776
    def __init__(self, lock, holder, target):
 
777
        self.lock = lock
 
778
        self.holder = holder
 
779
        self.target = target
 
780
 
 
781
 
 
782
class LockNotHeld(LockError):
 
783
 
 
784
    _fmt = "Lock not held: %(lock)s"
 
785
 
 
786
    internal_error = False
 
787
 
 
788
    def __init__(self, lock):
 
789
        self.lock = lock
 
790
 
 
791
 
 
792
class TokenLockingNotSupported(LockError):
 
793
 
 
794
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
795
 
 
796
    internal_error = True
 
797
 
 
798
    def __init__(self, obj):
 
799
        self.obj = obj
 
800
 
 
801
 
 
802
class TokenMismatch(LockBroken):
 
803
 
 
804
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
805
 
 
806
    internal_error = True
 
807
 
 
808
    def __init__(self, given_token, lock_token):
 
809
        self.given_token = given_token
 
810
        self.lock_token = lock_token
 
811
 
 
812
 
 
813
class PointlessCommit(BzrError):
 
814
 
 
815
    _fmt = "No changes to commit"
 
816
 
 
817
 
 
818
class UpgradeReadonly(BzrError):
 
819
 
 
820
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
821
 
 
822
 
 
823
class UpToDateFormat(BzrError):
 
824
 
 
825
    _fmt = "The branch format %(format)s is already at the most recent format."
 
826
 
 
827
    def __init__(self, format):
 
828
        BzrError.__init__(self)
 
829
        self.format = format
 
830
 
 
831
 
 
832
class StrictCommitFailed(Exception):
 
833
 
 
834
    _fmt = "Commit refused because there are unknowns in the tree."
 
835
 
 
836
 
 
837
class NoSuchRevision(BzrError):
 
838
 
 
839
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
840
 
 
841
    internal_error = True
 
842
 
 
843
    def __init__(self, branch, revision):
 
844
        BzrError.__init__(self, branch=branch, revision=revision)
 
845
 
 
846
 
 
847
class NotLeftParentDescendant(BzrError):
 
848
 
 
849
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
850
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
851
 
 
852
    internal_error = True
 
853
 
 
854
    def __init__(self, branch, old_revision, new_revision):
 
855
        BzrError.__init__(self, branch_location=branch.base,
 
856
                          old_revision=old_revision,
 
857
                          new_revision=new_revision)
 
858
 
 
859
 
 
860
class NoSuchRevisionSpec(BzrError):
 
861
 
 
862
    _fmt = "No namespace registered for string: %(spec)r"
 
863
 
 
864
    def __init__(self, spec):
 
865
        BzrError.__init__(self, spec=spec)
 
866
 
 
867
 
 
868
class NoSuchRevisionInTree(NoSuchRevision):
 
869
    """When using Tree.revision_tree, and the revision is not accessible."""
 
870
    
 
871
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
872
 
 
873
    def __init__(self, tree, revision_id):
 
874
        BzrError.__init__(self)
 
875
        self.tree = tree
 
876
        self.revision_id = revision_id
 
877
 
 
878
 
 
879
class InvalidRevisionSpec(BzrError):
 
880
 
 
881
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
882
            " %(branch)s%(extra)s")
 
883
 
 
884
    def __init__(self, spec, branch, extra=None):
 
885
        BzrError.__init__(self, branch=branch, spec=spec)
 
886
        if extra:
 
887
            self.extra = '\n' + str(extra)
 
888
        else:
 
889
            self.extra = ''
 
890
 
 
891
 
 
892
class HistoryMissing(BzrError):
 
893
 
 
894
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
895
 
 
896
 
 
897
class AppendRevisionsOnlyViolation(BzrError):
 
898
 
 
899
    _fmt = ('Operation denied because it would change the main history,'
 
900
           ' which is not permitted by the append_revisions_only setting on'
 
901
           ' branch "%(location)s".')
 
902
 
 
903
    def __init__(self, location):
 
904
       import bzrlib.urlutils as urlutils
 
905
       location = urlutils.unescape_for_display(location, 'ascii')
 
906
       BzrError.__init__(self, location=location)
 
907
 
 
908
 
 
909
class DivergedBranches(BzrError):
 
910
 
 
911
    _fmt = ("These branches have diverged."
 
912
            " Use the merge command to reconcile them.")
 
913
 
 
914
    internal_error = False
 
915
 
 
916
    def __init__(self, branch1, branch2):
 
917
        self.branch1 = branch1
 
918
        self.branch2 = branch2
 
919
 
 
920
 
 
921
class NotLefthandHistory(BzrError):
 
922
 
 
923
    _fmt = "Supplied history does not follow left-hand parents"
 
924
 
 
925
    internal_error = True
 
926
 
 
927
    def __init__(self, history):
 
928
        BzrError.__init__(self, history=history)
 
929
 
 
930
 
 
931
class UnrelatedBranches(BzrError):
 
932
 
 
933
    _fmt = ("Branches have no common ancestor, and"
 
934
            " no merge base revision was specified.")
 
935
 
 
936
    internal_error = False
 
937
 
 
938
 
 
939
class NoCommonAncestor(BzrError):
 
940
    
 
941
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
942
 
 
943
    def __init__(self, revision_a, revision_b):
 
944
        self.revision_a = revision_a
 
945
        self.revision_b = revision_b
 
946
 
 
947
 
 
948
class NoCommonRoot(BzrError):
 
949
 
 
950
    _fmt = ("Revisions are not derived from the same root: "
 
951
           "%(revision_a)s %(revision_b)s.")
 
952
 
 
953
    def __init__(self, revision_a, revision_b):
 
954
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
955
 
 
956
 
 
957
class NotAncestor(BzrError):
 
958
 
 
959
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
960
 
 
961
    def __init__(self, rev_id, not_ancestor_id):
 
962
        BzrError.__init__(self, rev_id=rev_id,
 
963
            not_ancestor_id=not_ancestor_id)
 
964
 
 
965
 
 
966
class InstallFailed(BzrError):
 
967
 
 
968
    def __init__(self, revisions):
 
969
        revision_str = ", ".join(str(r) for r in revisions)
 
970
        msg = "Could not install revisions:\n%s" % revision_str
 
971
        BzrError.__init__(self, msg)
 
972
        self.revisions = revisions
 
973
 
 
974
 
 
975
class AmbiguousBase(BzrError):
 
976
 
 
977
    def __init__(self, bases):
 
978
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
979
                DeprecationWarning)
 
980
        msg = ("The correct base is unclear, because %s are all equally close"
 
981
                % ", ".join(bases))
 
982
        BzrError.__init__(self, msg)
 
983
        self.bases = bases
 
984
 
 
985
 
 
986
class NoCommits(BzrError):
 
987
 
 
988
    _fmt = "Branch %(branch)s has no commits."
 
989
 
 
990
    def __init__(self, branch):
 
991
        BzrError.__init__(self, branch=branch)
 
992
 
 
993
 
 
994
class UnlistableStore(BzrError):
 
995
 
 
996
    def __init__(self, store):
 
997
        BzrError.__init__(self, "Store %s is not listable" % store)
 
998
 
 
999
 
 
1000
 
 
1001
class UnlistableBranch(BzrError):
 
1002
 
 
1003
    def __init__(self, br):
 
1004
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1005
 
 
1006
 
 
1007
class BoundBranchOutOfDate(BzrError):
 
1008
 
 
1009
    _fmt = ("Bound branch %(branch)s is out of date"
 
1010
            " with master branch %(master)s.")
 
1011
 
 
1012
    def __init__(self, branch, master):
 
1013
        BzrError.__init__(self)
 
1014
        self.branch = branch
 
1015
        self.master = master
 
1016
 
 
1017
        
 
1018
class CommitToDoubleBoundBranch(BzrError):
 
1019
 
 
1020
    _fmt = ("Cannot commit to branch %(branch)s."
 
1021
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1022
 
 
1023
    def __init__(self, branch, master, remote):
 
1024
        BzrError.__init__(self)
 
1025
        self.branch = branch
 
1026
        self.master = master
 
1027
        self.remote = remote
 
1028
 
 
1029
 
 
1030
class OverwriteBoundBranch(BzrError):
 
1031
 
 
1032
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1033
 
 
1034
    def __init__(self, branch):
 
1035
        BzrError.__init__(self)
 
1036
        self.branch = branch
 
1037
 
 
1038
 
 
1039
class BoundBranchConnectionFailure(BzrError):
 
1040
 
 
1041
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1042
            " => %(target)s: %(error)s")
 
1043
 
 
1044
    def __init__(self, branch, target, error):
 
1045
        BzrError.__init__(self)
 
1046
        self.branch = branch
 
1047
        self.target = target
 
1048
        self.error = error
 
1049
 
 
1050
 
 
1051
class WeaveError(BzrError):
 
1052
 
 
1053
    _fmt = "Error in processing weave: %(message)s"
 
1054
 
 
1055
    def __init__(self, message=None):
 
1056
        BzrError.__init__(self)
 
1057
        self.message = message
 
1058
 
 
1059
 
 
1060
class WeaveRevisionAlreadyPresent(WeaveError):
 
1061
 
 
1062
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1063
 
 
1064
    def __init__(self, revision_id, weave):
 
1065
 
 
1066
        WeaveError.__init__(self)
 
1067
        self.revision_id = revision_id
 
1068
        self.weave = weave
 
1069
 
 
1070
 
 
1071
class WeaveRevisionNotPresent(WeaveError):
 
1072
 
 
1073
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1074
 
 
1075
    def __init__(self, revision_id, weave):
 
1076
        WeaveError.__init__(self)
 
1077
        self.revision_id = revision_id
 
1078
        self.weave = weave
 
1079
 
 
1080
 
 
1081
class WeaveFormatError(WeaveError):
 
1082
 
 
1083
    _fmt = "Weave invariant violated: %(what)s"
 
1084
 
 
1085
    def __init__(self, what):
 
1086
        WeaveError.__init__(self)
 
1087
        self.what = what
 
1088
 
 
1089
 
 
1090
class WeaveParentMismatch(WeaveError):
 
1091
 
 
1092
    _fmt = "Parents are mismatched between two revisions."
 
1093
    
 
1094
 
 
1095
class WeaveInvalidChecksum(WeaveError):
 
1096
 
 
1097
    _fmt = "Text did not match it's checksum: %(message)s"
 
1098
 
 
1099
 
 
1100
class WeaveTextDiffers(WeaveError):
 
1101
 
 
1102
    _fmt = ("Weaves differ on text content. Revision:"
 
1103
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1104
 
 
1105
    def __init__(self, revision_id, weave_a, weave_b):
 
1106
        WeaveError.__init__(self)
 
1107
        self.revision_id = revision_id
 
1108
        self.weave_a = weave_a
 
1109
        self.weave_b = weave_b
 
1110
 
 
1111
 
 
1112
class WeaveTextDiffers(WeaveError):
 
1113
 
 
1114
    _fmt = ("Weaves differ on text content. Revision:"
 
1115
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1116
 
 
1117
    def __init__(self, revision_id, weave_a, weave_b):
 
1118
        WeaveError.__init__(self)
 
1119
        self.revision_id = revision_id
 
1120
        self.weave_a = weave_a
 
1121
        self.weave_b = weave_b
 
1122
 
 
1123
 
 
1124
class VersionedFileError(BzrError):
 
1125
    
 
1126
    _fmt = "Versioned file error"
 
1127
 
 
1128
 
 
1129
class RevisionNotPresent(VersionedFileError):
 
1130
    
 
1131
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1132
 
 
1133
    def __init__(self, revision_id, file_id):
 
1134
        VersionedFileError.__init__(self)
 
1135
        self.revision_id = revision_id
 
1136
        self.file_id = file_id
 
1137
 
 
1138
 
 
1139
class RevisionAlreadyPresent(VersionedFileError):
 
1140
    
 
1141
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1142
 
 
1143
    def __init__(self, revision_id, file_id):
 
1144
        VersionedFileError.__init__(self)
 
1145
        self.revision_id = revision_id
 
1146
        self.file_id = file_id
 
1147
 
 
1148
 
 
1149
class KnitError(BzrError):
 
1150
    
 
1151
    _fmt = "Knit error"
 
1152
 
 
1153
    internal_error = True
 
1154
 
 
1155
 
 
1156
class KnitHeaderError(KnitError):
 
1157
 
 
1158
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1159
 
 
1160
    def __init__(self, badline, filename):
 
1161
        KnitError.__init__(self)
 
1162
        self.badline = badline
 
1163
        self.filename = filename
 
1164
 
 
1165
 
 
1166
class KnitCorrupt(KnitError):
 
1167
 
 
1168
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1169
 
 
1170
    def __init__(self, filename, how):
 
1171
        KnitError.__init__(self)
 
1172
        self.filename = filename
 
1173
        self.how = how
 
1174
 
 
1175
 
 
1176
class KnitIndexUnknownMethod(KnitError):
 
1177
    """Raised when we don't understand the storage method.
 
1178
 
 
1179
    Currently only 'fulltext' and 'line-delta' are supported.
 
1180
    """
 
1181
    
 
1182
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1183
            " in options: %(options)r")
 
1184
 
 
1185
    def __init__(self, filename, options):
 
1186
        KnitError.__init__(self)
 
1187
        self.filename = filename
 
1188
        self.options = options
 
1189
 
 
1190
 
 
1191
class NoSuchExportFormat(BzrError):
 
1192
    
 
1193
    _fmt = "Export format %(format)r not supported"
 
1194
 
 
1195
    def __init__(self, format):
 
1196
        BzrError.__init__(self)
 
1197
        self.format = format
 
1198
 
 
1199
 
 
1200
class TransportError(BzrError):
 
1201
    
 
1202
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1203
 
 
1204
    def __init__(self, msg=None, orig_error=None):
 
1205
        if msg is None and orig_error is not None:
 
1206
            msg = str(orig_error)
 
1207
        if orig_error is None:
 
1208
            orig_error = ''
 
1209
        if msg is None:
 
1210
            msg =  ''
 
1211
        self.msg = msg
 
1212
        self.orig_error = orig_error
 
1213
        BzrError.__init__(self)
 
1214
 
 
1215
 
 
1216
class TooManyConcurrentRequests(BzrError):
 
1217
 
 
1218
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1219
            " Be sure to finish_writing and finish_reading on the"
 
1220
            " current request that is open.")
 
1221
 
 
1222
    internal_error = True
 
1223
 
 
1224
    def __init__(self, medium):
 
1225
        self.medium = medium
 
1226
 
 
1227
 
 
1228
class SmartProtocolError(TransportError):
 
1229
 
 
1230
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1231
 
 
1232
    def __init__(self, details):
 
1233
        self.details = details
 
1234
 
 
1235
 
 
1236
# A set of semi-meaningful errors which can be thrown
 
1237
class TransportNotPossible(TransportError):
 
1238
 
 
1239
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1240
 
 
1241
 
 
1242
class ConnectionError(TransportError):
 
1243
 
 
1244
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1245
 
 
1246
 
 
1247
class SocketConnectionError(ConnectionError):
 
1248
 
 
1249
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1250
 
 
1251
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1252
        if msg is None:
 
1253
            msg = 'Failed to connect to'
 
1254
        if orig_error is None:
 
1255
            orig_error = ''
 
1256
        else:
 
1257
            orig_error = '; ' + str(orig_error)
 
1258
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1259
        self.host = host
 
1260
        if port is None:
 
1261
            self.port = ''
 
1262
        else:
 
1263
            self.port = ':%s' % port
 
1264
 
 
1265
 
 
1266
class ConnectionReset(TransportError):
 
1267
 
 
1268
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1269
 
 
1270
 
 
1271
class InvalidRange(TransportError):
 
1272
 
 
1273
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1274
    
 
1275
    def __init__(self, path, offset):
 
1276
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1277
                                       % (path, offset)))
 
1278
        self.path = path
 
1279
        self.offset = offset
 
1280
 
 
1281
 
 
1282
class InvalidHttpResponse(TransportError):
 
1283
 
 
1284
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1285
 
 
1286
    def __init__(self, path, msg, orig_error=None):
 
1287
        self.path = path
 
1288
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1289
 
 
1290
 
 
1291
class InvalidHttpRange(InvalidHttpResponse):
 
1292
 
 
1293
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1294
    
 
1295
    def __init__(self, path, range, msg):
 
1296
        self.range = range
 
1297
        InvalidHttpResponse.__init__(self, path, msg)
 
1298
 
 
1299
 
 
1300
class InvalidHttpContentType(InvalidHttpResponse):
 
1301
 
 
1302
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1303
    
 
1304
    def __init__(self, path, ctype, msg):
 
1305
        self.ctype = ctype
 
1306
        InvalidHttpResponse.__init__(self, path, msg)
 
1307
 
 
1308
 
 
1309
class ConflictsInTree(BzrError):
 
1310
 
 
1311
    _fmt = "Working tree has conflicts."
 
1312
 
 
1313
 
 
1314
class ParseConfigError(BzrError):
 
1315
 
 
1316
    def __init__(self, errors, filename):
 
1317
        if filename is None:
 
1318
            filename = ""
 
1319
        message = "Error(s) parsing config file %s:\n%s" % \
 
1320
            (filename, ('\n'.join(e.message for e in errors)))
 
1321
        BzrError.__init__(self, message)
 
1322
 
 
1323
 
 
1324
class NoEmailInUsername(BzrError):
 
1325
 
 
1326
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1327
 
 
1328
    def __init__(self, username):
 
1329
        BzrError.__init__(self)
 
1330
        self.username = username
 
1331
 
 
1332
 
 
1333
class SigningFailed(BzrError):
 
1334
 
 
1335
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1336
 
 
1337
    def __init__(self, command_line):
 
1338
        BzrError.__init__(self, command_line=command_line)
 
1339
 
 
1340
 
 
1341
class WorkingTreeNotRevision(BzrError):
 
1342
 
 
1343
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1344
            " the last commit, but weave merge requires that it be"
 
1345
            " unchanged")
 
1346
 
 
1347
    def __init__(self, tree):
 
1348
        BzrError.__init__(self, basedir=tree.basedir)
 
1349
 
 
1350
 
 
1351
class CantReprocessAndShowBase(BzrError):
 
1352
 
 
1353
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1354
           "the relationship of conflicting lines to the base")
 
1355
 
 
1356
 
 
1357
class GraphCycleError(BzrError):
 
1358
 
 
1359
    _fmt = "Cycle in graph %(graph)r"
 
1360
 
 
1361
    def __init__(self, graph):
 
1362
        BzrError.__init__(self)
 
1363
        self.graph = graph
 
1364
 
 
1365
 
 
1366
class WritingCompleted(BzrError):
 
1367
 
 
1368
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1369
            "called upon it - accept bytes may not be called anymore.")
 
1370
 
 
1371
    internal_error = True
 
1372
 
 
1373
    def __init__(self, request):
 
1374
        self.request = request
 
1375
 
 
1376
 
 
1377
class WritingNotComplete(BzrError):
 
1378
 
 
1379
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1380
            "called upon it - until the write phase is complete no "
 
1381
            "data may be read.")
 
1382
 
 
1383
    internal_error = True
 
1384
 
 
1385
    def __init__(self, request):
 
1386
        self.request = request
 
1387
 
 
1388
 
 
1389
class NotConflicted(BzrError):
 
1390
 
 
1391
    _fmt = "File %(filename)s is not conflicted."
 
1392
 
 
1393
    def __init__(self, filename):
 
1394
        BzrError.__init__(self)
 
1395
        self.filename = filename
 
1396
 
 
1397
 
 
1398
class MediumNotConnected(BzrError):
 
1399
 
 
1400
    _fmt = """The medium '%(medium)s' is not connected."""
 
1401
 
 
1402
    internal_error = True
 
1403
 
 
1404
    def __init__(self, medium):
 
1405
        self.medium = medium
 
1406
 
 
1407
 
 
1408
class MustUseDecorated(Exception):
 
1409
 
 
1410
    _fmt = "A decorating function has requested its original command be used."
 
1411
 
 
1412
 
 
1413
class NoBundleFound(BzrError):
 
1414
 
 
1415
    _fmt = "No bundle was found in %(filename)s"
 
1416
 
 
1417
    def __init__(self, filename):
 
1418
        BzrError.__init__(self)
 
1419
        self.filename = filename
 
1420
 
 
1421
 
 
1422
class BundleNotSupported(BzrError):
 
1423
 
 
1424
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1425
 
 
1426
    def __init__(self, version, msg):
 
1427
        BzrError.__init__(self)
 
1428
        self.version = version
 
1429
        self.msg = msg
 
1430
 
 
1431
 
 
1432
class MissingText(BzrError):
 
1433
 
 
1434
    _fmt = ("Branch %(base)s is missing revision"
 
1435
            " %(text_revision)s of %(file_id)s")
 
1436
 
 
1437
    def __init__(self, branch, text_revision, file_id):
 
1438
        BzrError.__init__(self)
 
1439
        self.branch = branch
 
1440
        self.base = branch.base
 
1441
        self.text_revision = text_revision
 
1442
        self.file_id = file_id
 
1443
 
 
1444
 
 
1445
class DuplicateFileId(BzrError):
 
1446
 
 
1447
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1448
 
 
1449
    def __init__(self, file_id, entry):
 
1450
        BzrError.__init__(self)
 
1451
        self.file_id = file_id
 
1452
        self.entry = entry
 
1453
 
 
1454
 
 
1455
class DuplicateKey(BzrError):
 
1456
 
 
1457
    _fmt = "Key %(key)s is already present in map"
 
1458
 
 
1459
 
 
1460
class MalformedTransform(BzrError):
 
1461
 
 
1462
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1463
 
 
1464
 
 
1465
class NoFinalPath(BzrError):
 
1466
 
 
1467
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1468
            "file-id: %(file_id)r\n"
 
1469
            "root trans-id: %(root_trans_id)r\n")
 
1470
 
 
1471
    def __init__(self, trans_id, transform):
 
1472
        self.trans_id = trans_id
 
1473
        self.file_id = transform.final_file_id(trans_id)
 
1474
        self.root_trans_id = transform.root
 
1475
 
 
1476
 
 
1477
class BzrBadParameter(BzrError):
 
1478
 
 
1479
    _fmt = "Bad parameter: %(param)r"
 
1480
 
 
1481
    # This exception should never be thrown, but it is a base class for all
 
1482
    # parameter-to-function errors.
 
1483
 
 
1484
    def __init__(self, param):
 
1485
        BzrError.__init__(self)
 
1486
        self.param = param
 
1487
 
 
1488
 
 
1489
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1490
 
 
1491
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1492
 
 
1493
 
 
1494
class ReusingTransform(BzrError):
 
1495
 
 
1496
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1497
 
 
1498
 
 
1499
class CantMoveRoot(BzrError):
 
1500
 
 
1501
    _fmt = "Moving the root directory is not supported at this time"
 
1502
 
 
1503
 
 
1504
class BzrMoveFailedError(BzrError):
 
1505
 
 
1506
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1507
 
 
1508
    def __init__(self, from_path='', to_path='', extra=None):
 
1509
        BzrError.__init__(self)
 
1510
        if extra:
 
1511
            self.extra = ': ' + str(extra)
 
1512
        else:
 
1513
            self.extra = ''
 
1514
 
 
1515
        has_from = len(from_path) > 0
 
1516
        has_to = len(to_path) > 0
 
1517
        if has_from:
 
1518
            self.from_path = osutils.splitpath(from_path)[-1]
 
1519
        else:
 
1520
            self.from_path = ''
 
1521
 
 
1522
        if has_to:
 
1523
            self.to_path = osutils.splitpath(to_path)[-1]
 
1524
        else:
 
1525
            self.to_path = ''
 
1526
 
 
1527
        self.operator = ""
 
1528
        if has_from and has_to:
 
1529
            self.operator = " =>"
 
1530
        elif has_from:
 
1531
            self.from_path = "from " + from_path
 
1532
        elif has_to:
 
1533
            self.operator = "to"
 
1534
        else:
 
1535
            self.operator = "file"
 
1536
 
 
1537
 
 
1538
class BzrRenameFailedError(BzrMoveFailedError):
 
1539
 
 
1540
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1541
 
 
1542
    def __init__(self, from_path, to_path, extra=None):
 
1543
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1544
 
 
1545
 
 
1546
class BzrBadParameterNotString(BzrBadParameter):
 
1547
 
 
1548
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1549
 
 
1550
 
 
1551
class BzrBadParameterMissing(BzrBadParameter):
 
1552
 
 
1553
    _fmt = "Parameter $(param)s is required but not present."
 
1554
 
 
1555
 
 
1556
class BzrBadParameterUnicode(BzrBadParameter):
 
1557
 
 
1558
    _fmt = ("Parameter %(param)s is unicode but"
 
1559
            " only byte-strings are permitted.")
 
1560
 
 
1561
 
 
1562
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1563
 
 
1564
    _fmt = "Parameter %(param)s contains a newline."
 
1565
 
 
1566
 
 
1567
class DependencyNotPresent(BzrError):
 
1568
 
 
1569
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1570
 
 
1571
    def __init__(self, library, error):
 
1572
        BzrError.__init__(self, library=library, error=error)
 
1573
 
 
1574
 
 
1575
class ParamikoNotPresent(DependencyNotPresent):
 
1576
 
 
1577
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1578
 
 
1579
    def __init__(self, error):
 
1580
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1581
 
 
1582
 
 
1583
class PointlessMerge(BzrError):
 
1584
 
 
1585
    _fmt = "Nothing to merge."
 
1586
 
 
1587
 
 
1588
class UninitializableFormat(BzrError):
 
1589
 
 
1590
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1591
 
 
1592
    def __init__(self, format):
 
1593
        BzrError.__init__(self)
 
1594
        self.format = format
 
1595
 
 
1596
 
 
1597
class BadConversionTarget(BzrError):
 
1598
 
 
1599
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1600
 
 
1601
    def __init__(self, problem, format):
 
1602
        BzrError.__init__(self)
 
1603
        self.problem = problem
 
1604
        self.format = format
 
1605
 
 
1606
 
 
1607
class NoDiff(BzrError):
 
1608
 
 
1609
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1610
 
 
1611
    def __init__(self, msg):
 
1612
        BzrError.__init__(self, msg=msg)
 
1613
 
 
1614
 
 
1615
class NoDiff3(BzrError):
 
1616
 
 
1617
    _fmt = "Diff3 is not installed on this machine."
 
1618
 
 
1619
 
 
1620
class ExistingLimbo(BzrError):
 
1621
 
 
1622
    _fmt = """This tree contains left-over files from a failed operation.
 
1623
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1624
    keep, and delete it when you are done."""
 
1625
    
 
1626
    def __init__(self, limbo_dir):
 
1627
       BzrError.__init__(self)
 
1628
       self.limbo_dir = limbo_dir
 
1629
 
 
1630
 
 
1631
class ImmortalLimbo(BzrError):
 
1632
 
 
1633
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1634
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1635
    keep, and delete it when you are done."""
 
1636
 
 
1637
    def __init__(self, limbo_dir):
 
1638
       BzrError.__init__(self)
 
1639
       self.limbo_dir = limbo_dir
 
1640
 
 
1641
 
 
1642
class OutOfDateTree(BzrError):
 
1643
 
 
1644
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1645
 
 
1646
    def __init__(self, tree):
 
1647
        BzrError.__init__(self)
 
1648
        self.tree = tree
 
1649
 
 
1650
 
 
1651
class PublicBranchOutOfDate(BzrError):
 
1652
 
 
1653
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1654
        '"%(revstring)s".'
 
1655
 
 
1656
    def __init__(self, public_location, revstring):
 
1657
        import bzrlib.urlutils as urlutils
 
1658
        public_location = urlutils.unescape_for_display(public_location,
 
1659
                                                        'ascii')
 
1660
        BzrError.__init__(self, public_location=public_location,
 
1661
                          revstring=revstring)
 
1662
 
 
1663
 
 
1664
class MergeModifiedFormatError(BzrError):
 
1665
 
 
1666
    _fmt = "Error in merge modified format"
 
1667
 
 
1668
 
 
1669
class ConflictFormatError(BzrError):
 
1670
 
 
1671
    _fmt = "Format error in conflict listings"
 
1672
 
 
1673
 
 
1674
class CorruptRepository(BzrError):
 
1675
 
 
1676
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1677
            "Please run bzr reconcile on this repository.")
 
1678
 
 
1679
    def __init__(self, repo):
 
1680
        BzrError.__init__(self)
 
1681
        self.repo_path = repo.bzrdir.root_transport.base
 
1682
 
 
1683
 
 
1684
class UpgradeRequired(BzrError):
 
1685
 
 
1686
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1687
 
 
1688
    def __init__(self, path):
 
1689
        BzrError.__init__(self)
 
1690
        self.path = path
 
1691
 
 
1692
 
 
1693
class LocalRequiresBoundBranch(BzrError):
 
1694
 
 
1695
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1696
 
 
1697
 
 
1698
class MissingProgressBarFinish(BzrError):
 
1699
 
 
1700
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1701
 
 
1702
 
 
1703
class InvalidProgressBarType(BzrError):
 
1704
 
 
1705
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1706
            " is not a supported type Select one of: %(valid_types)s")
 
1707
 
 
1708
    def __init__(self, bar_type, valid_types):
 
1709
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1710
 
 
1711
 
 
1712
class UnsupportedOperation(BzrError):
 
1713
 
 
1714
    _fmt = ("The method %(mname)s is not supported on"
 
1715
            " objects of type %(tname)s.")
 
1716
 
 
1717
    def __init__(self, method, method_self):
 
1718
        self.method = method
 
1719
        self.mname = method.__name__
 
1720
        self.tname = type(method_self).__name__
 
1721
 
 
1722
 
 
1723
class CannotSetRevisionId(UnsupportedOperation):
 
1724
    """Raised when a commit is attempting to set a revision id but cant."""
 
1725
 
 
1726
 
 
1727
class NonAsciiRevisionId(UnsupportedOperation):
 
1728
    """Raised when a commit is attempting to set a non-ascii revision id
 
1729
       but cant.
 
1730
    """
 
1731
 
 
1732
 
 
1733
class BinaryFile(BzrError):
 
1734
    
 
1735
    _fmt = "File is binary but should be text."
 
1736
 
 
1737
 
 
1738
class IllegalPath(BzrError):
 
1739
 
 
1740
    _fmt = "The path %(path)s is not permitted on this platform"
 
1741
 
 
1742
    def __init__(self, path):
 
1743
        BzrError.__init__(self)
 
1744
        self.path = path
 
1745
 
 
1746
 
 
1747
class TestamentMismatch(BzrError):
 
1748
 
 
1749
    _fmt = """Testament did not match expected value.
 
1750
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1751
       {%(measured)s}"""
 
1752
 
 
1753
    def __init__(self, revision_id, expected, measured):
 
1754
        self.revision_id = revision_id
 
1755
        self.expected = expected
 
1756
        self.measured = measured
 
1757
 
 
1758
 
 
1759
class NotABundle(BzrError):
 
1760
    
 
1761
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1762
 
 
1763
    def __init__(self, text):
 
1764
        BzrError.__init__(self)
 
1765
        self.text = text
 
1766
 
 
1767
 
 
1768
class BadBundle(BzrError): 
 
1769
    
 
1770
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1771
 
 
1772
    def __init__(self, text):
 
1773
        BzrError.__init__(self)
 
1774
        self.text = text
 
1775
 
 
1776
 
 
1777
class MalformedHeader(BadBundle): 
 
1778
    
 
1779
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1780
 
 
1781
 
 
1782
class MalformedPatches(BadBundle): 
 
1783
    
 
1784
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1785
 
 
1786
 
 
1787
class MalformedFooter(BadBundle): 
 
1788
    
 
1789
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1790
 
 
1791
 
 
1792
class UnsupportedEOLMarker(BadBundle):
 
1793
    
 
1794
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1795
 
 
1796
    def __init__(self):
 
1797
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1798
        # but for this there is not
 
1799
        BzrError.__init__(self)
 
1800
 
 
1801
 
 
1802
class IncompatibleBundleFormat(BzrError):
 
1803
    
 
1804
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1805
 
 
1806
    def __init__(self, bundle_format, other):
 
1807
        BzrError.__init__(self)
 
1808
        self.bundle_format = bundle_format
 
1809
        self.other = other
 
1810
 
 
1811
 
 
1812
class BadInventoryFormat(BzrError):
 
1813
    
 
1814
    _fmt = "Root class for inventory serialization errors"
 
1815
 
 
1816
 
 
1817
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1818
 
 
1819
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1820
 
 
1821
    def __init__(self, msg):
 
1822
        BadInventoryFormat.__init__(self, msg=msg)
 
1823
 
 
1824
 
 
1825
class RootNotRich(BzrError):
 
1826
 
 
1827
    _fmt = """This operation requires rich root data storage"""
 
1828
 
 
1829
 
 
1830
class NoSmartMedium(BzrError):
 
1831
 
 
1832
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1833
 
 
1834
    internal_error = True
 
1835
 
 
1836
    def __init__(self, transport):
 
1837
        self.transport = transport
 
1838
 
 
1839
 
 
1840
class NoSmartServer(NotBranchError):
 
1841
 
 
1842
    _fmt = "No smart server available at %(url)s"
 
1843
 
 
1844
    def __init__(self, url):
 
1845
        self.url = url
 
1846
 
 
1847
 
 
1848
class UnknownSSH(BzrError):
 
1849
 
 
1850
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1851
 
 
1852
    def __init__(self, vendor):
 
1853
        BzrError.__init__(self)
 
1854
        self.vendor = vendor
 
1855
 
 
1856
 
 
1857
class SSHVendorNotFound(BzrError):
 
1858
 
 
1859
    _fmt = ("Don't know how to handle SSH connections."
 
1860
            " Please set BZR_SSH environment variable.")
 
1861
 
 
1862
 
 
1863
class GhostRevisionUnusableHere(BzrError):
 
1864
 
 
1865
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1866
 
 
1867
    def __init__(self, revision_id):
 
1868
        BzrError.__init__(self)
 
1869
        self.revision_id = revision_id
 
1870
 
 
1871
 
 
1872
class IllegalUseOfScopeReplacer(BzrError):
 
1873
 
 
1874
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
1875
            " %(msg)s%(extra)s")
 
1876
 
 
1877
    internal_error = True
 
1878
 
 
1879
    def __init__(self, name, msg, extra=None):
 
1880
        BzrError.__init__(self)
 
1881
        self.name = name
 
1882
        self.msg = msg
 
1883
        if extra:
 
1884
            self.extra = ': ' + str(extra)
 
1885
        else:
 
1886
            self.extra = ''
 
1887
 
 
1888
 
 
1889
class InvalidImportLine(BzrError):
 
1890
 
 
1891
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1892
 
 
1893
    internal_error = True
 
1894
 
 
1895
    def __init__(self, text, msg):
 
1896
        BzrError.__init__(self)
 
1897
        self.text = text
 
1898
        self.msg = msg
 
1899
 
 
1900
 
 
1901
class ImportNameCollision(BzrError):
 
1902
 
 
1903
    _fmt = ("Tried to import an object to the same name as"
 
1904
            " an existing object. %(name)s")
 
1905
 
 
1906
    internal_error = True
 
1907
 
 
1908
    def __init__(self, name):
 
1909
        BzrError.__init__(self)
 
1910
        self.name = name
 
1911
 
 
1912
 
 
1913
class NotAMergeDirective(BzrError):
 
1914
    """File starting with %(firstline)r is not a merge directive"""
 
1915
    def __init__(self, firstline):
 
1916
        BzrError.__init__(self, firstline=firstline)
 
1917
 
 
1918
 
 
1919
class NoMergeSource(BzrError):
 
1920
    """Raise if no merge source was specified for a merge directive"""
 
1921
 
 
1922
    _fmt = "A merge directive must provide either a bundle or a public"\
 
1923
        " branch location."
 
1924
 
 
1925
 
 
1926
class PatchMissing(BzrError):
 
1927
    """Raise a patch type was specified but no patch supplied"""
 
1928
 
 
1929
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
1930
 
 
1931
    def __init__(self, patch_type):
 
1932
        BzrError.__init__(self)
 
1933
        self.patch_type = patch_type
 
1934
 
 
1935
 
 
1936
class UnsupportedInventoryKind(BzrError):
 
1937
    
 
1938
    _fmt = """Unsupported entry kind %(kind)s"""
 
1939
 
 
1940
    def __init__(self, kind):
 
1941
        self.kind = kind
 
1942
 
 
1943
 
 
1944
class BadSubsumeSource(BzrError):
 
1945
 
 
1946
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
1947
 
 
1948
    def __init__(self, tree, other_tree, reason):
 
1949
        self.tree = tree
 
1950
        self.other_tree = other_tree
 
1951
        self.reason = reason
 
1952
 
 
1953
 
 
1954
class SubsumeTargetNeedsUpgrade(BzrError):
 
1955
    
 
1956
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
1957
 
 
1958
    def __init__(self, other_tree):
 
1959
        self.other_tree = other_tree
 
1960
 
 
1961
 
 
1962
class BadReferenceTarget(BzrError):
 
1963
 
 
1964
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
1965
 
 
1966
    internal_error = True
 
1967
 
 
1968
    def __init__(self, tree, other_tree, reason):
 
1969
        self.tree = tree
 
1970
        self.other_tree = other_tree
 
1971
        self.reason = reason
 
1972
 
 
1973
 
 
1974
class NoSuchTag(BzrError):
 
1975
 
 
1976
    _fmt = "No such tag: %(tag_name)s"
 
1977
 
 
1978
    def __init__(self, tag_name):
 
1979
        self.tag_name = tag_name
 
1980
 
 
1981
 
 
1982
class TagsNotSupported(BzrError):
 
1983
 
 
1984
    _fmt = ("Tags not supported by %(branch)s;"
 
1985
            " you may be able to use bzr upgrade.")
 
1986
 
 
1987
    def __init__(self, branch):
 
1988
        self.branch = branch
 
1989
 
 
1990
        
 
1991
class TagAlreadyExists(BzrError):
 
1992
 
 
1993
    _fmt = "Tag %(tag_name)s already exists."
 
1994
 
 
1995
    def __init__(self, tag_name):
 
1996
        self.tag_name = tag_name