~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2007-03-06 06:34:19 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: aaron.bentley@utoronto.ca-20070306063419-ils9x2j89l1sz2u4
Get email working, with optional message

Show diffs side-by-side

added added

removed removed

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