~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Vincent Ladeuil
  • Date: 2008-01-29 15:16:31 UTC
  • mto: (3206.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3207.
  • Revision ID: v.ladeuil+lp@free.fr-20080129151631-vqjd13tb405mobx6
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.

* bzrlib/tests/test_transform.py:
(TestTransformMerge): Revert previous patch and cleanly call
preview.finalize now that we can.

* bzrlib/tests/test_merge.py:
(TestMerge.test_make_preview_transform): Catch TransformPreview
leak.

* bzrlib/builtins.py:
(cmd_merge._do_preview): Finalize the TransformPreview or the
limbodir will stay in /tmp.

* bzrlib/transform.py:
(TreeTransformBase.__init__): Create the _deletiondir since it's
reffered to by finalize.
(TreeTransformBase.finalize): Delete the dir only if _deletiondir
is set.
(TreeTransform.__init__): Use a temp var for deletiondir and set
the attribute after the base class __init__ has been called.
(TransformPreview.__init__): Read locks the tree since finalize
wants to unlock it (as suggested by Aaron).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 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
17
"""Exceptions for bzr, and reporting of them.
18
 
 
19
 
Exceptions are caught at a high level to report errors to the user, and
20
 
might also be caught inside the program.  Therefore it needs to be
21
 
possible to convert them to a meaningful string, and also for them to be
22
 
interrogated by the program.
23
 
 
24
 
Exceptions are defined such that the arguments given to the constructor
25
 
are stored in the object as properties of the same name.  When the
26
 
object is printed as a string, the doc string of the class is used as
27
 
a format string with the property dictionary available to it.
28
 
 
29
 
This means that exceptions can used like this:
30
 
 
31
 
>>> import sys
32
 
>>> try:
33
 
...   raise NotBranchError(path='/foo/bar')
34
 
... except:
35
 
...   print sys.exc_type
36
 
...   print sys.exc_value
37
 
...   path = getattr(sys.exc_value, 'path', None)
38
 
...   if path is not None:
39
 
...     print path
40
 
bzrlib.errors.NotBranchError
41
 
Not a branch: /foo/bar
42
 
/foo/bar
43
 
 
44
 
Therefore:
45
 
 
46
 
 * create a new exception class for any class of error that can be
47
 
   usefully distinguished.
48
 
 
49
 
 * the printable form of an exception is generated by the base class
50
 
   __str__ method
51
 
 
52
 
Exception strings should start with a capital letter and not have a final
53
 
fullstop.
54
18
"""
55
19
 
56
 
from warnings import warn
57
 
 
58
 
# based on Scott James Remnant's hct error classes
 
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
 
59
33
 
60
34
# TODO: is there any value in providing the .args field used by standard
61
35
# python exceptions?   A list of values with no names seems less useful 
65
39
# constructed to make sure it will succeed.  But that says nothing about
66
40
# exceptions that are never raised.
67
41
 
68
 
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
69
 
# the old one.
70
 
 
71
 
# TODO: The pattern (from hct) of using classes docstrings as message
72
 
# templates is cute but maybe not such a great idea - perhaps should have a
73
 
# separate static message_template.
 
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
# return codes from the bzr program
 
48
EXIT_OK = 0
 
49
EXIT_ERROR = 3
 
50
EXIT_INTERNAL_ERROR = 4
74
51
 
75
52
 
76
53
class BzrError(StandardError):
 
54
    """
 
55
    Base class for errors raised by bzrlib.
 
56
 
 
57
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
58
    should be displayed with a traceback; if False (or absent) this was
 
59
    probably a user or environment error and they don't need the gory details.
 
60
    (That can be overridden by -Derror on the command line.)
 
61
 
 
62
    :cvar _fmt: Format string to display the error; this is expanded
 
63
    by the instance's dict.
 
64
    """
 
65
    
 
66
    internal_error = False
 
67
 
 
68
    def __init__(self, msg=None, **kwds):
 
69
        """Construct a new BzrError.
 
70
 
 
71
        There are two alternative forms for constructing these objects.
 
72
        Either a preformatted string may be passed, or a set of named
 
73
        arguments can be given.  The first is for generic "user" errors which
 
74
        are not intended to be caught and so do not need a specific subclass.
 
75
        The second case is for use with subclasses that provide a _fmt format
 
76
        string to print the arguments.  
 
77
 
 
78
        Keyword arguments are taken as parameters to the error, which can 
 
79
        be inserted into the format string template.  It's recommended 
 
80
        that subclasses override the __init__ method to require specific 
 
81
        parameters.
 
82
 
 
83
        :param msg: If given, this is the literal complete text for the error,
 
84
        not subject to expansion.
 
85
        """
 
86
        StandardError.__init__(self)
 
87
        if msg is not None:
 
88
            # I was going to deprecate this, but it actually turns out to be
 
89
            # quite handy - mbp 20061103.
 
90
            self._preformatted_string = msg
 
91
        else:
 
92
            self._preformatted_string = None
 
93
            for key, value in kwds.items():
 
94
                setattr(self, key, value)
 
95
 
77
96
    def __str__(self):
78
 
        # XXX: Should we show the exception class in 
79
 
        # exceptions that don't provide their own message?  
80
 
        # maybe it should be done at a higher level
81
 
        ## n = self.__class__.__name__ + ': '
82
 
        n = ''
83
 
        if len(self.args) == 1:
84
 
            return str(self.args[0])
85
 
        elif len(self.args) == 2:
86
 
            # further explanation or suggestions
87
 
            try:
88
 
                return n + '\n  '.join([self.args[0]] + self.args[1])
89
 
            except TypeError:
90
 
                return n + "%r" % self
91
 
        else:
92
 
            return n + `self.args`
 
97
        s = getattr(self, '_preformatted_string', None)
 
98
        if s is not None:
 
99
            # contains a preformatted message; must be cast to plain str
 
100
            return str(s)
 
101
        try:
 
102
            fmt = self._get_format_string()
 
103
            if fmt:
 
104
                d = dict(self.__dict__)
 
105
                # special case: python2.5 puts the 'message' attribute in a
 
106
                # slot, so it isn't seen in __dict__
 
107
                d['message'] = getattr(self, 'message', 'no message')
 
108
                s = fmt % d
 
109
                # __str__() should always return a 'str' object
 
110
                # never a 'unicode' object.
 
111
                if isinstance(s, unicode):
 
112
                    return s.encode('utf8')
 
113
                return s
 
114
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
115
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
116
                % (self.__class__.__name__,
 
117
                   self.__dict__,
 
118
                   getattr(self, '_fmt', None),
 
119
                   e)
 
120
 
 
121
    def _get_format_string(self):
 
122
        """Return format string for this exception or None"""
 
123
        fmt = getattr(self, '_fmt', None)
 
124
        if fmt is not None:
 
125
            return fmt
 
126
        fmt = getattr(self, '__doc__', None)
 
127
        if fmt is not None:
 
128
            symbol_versioning.warn("%s uses its docstring as a format, "
 
129
                    "it should use _fmt instead" % self.__class__.__name__,
 
130
                    DeprecationWarning)
 
131
            return fmt
 
132
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
133
            % (self.__class__.__name__,
 
134
               self.__dict__,
 
135
               getattr(self, '_fmt', None),
 
136
               )
 
137
 
 
138
 
 
139
class InternalBzrError(BzrError):
 
140
    """Base class for errors that are internal in nature.
 
141
 
 
142
    This is a convenience class for errors that are internal. The
 
143
    internal_error attribute can still be altered in subclasses, if needed.
 
144
    Using this class is simply an easy way to get internal errors.
 
145
    """
 
146
 
 
147
    internal_error = True
93
148
 
94
149
 
95
150
class BzrNewError(BzrError):
96
 
    """bzr error"""
 
151
    """Deprecated error base class."""
97
152
    # base classes should override the docstring with their human-
98
153
    # readable explanation
99
154
 
100
 
    def __init__(self, **kwds):
 
155
    def __init__(self, *args, **kwds):
 
156
        # XXX: Use the underlying BzrError to always generate the args
 
157
        # attribute if it doesn't exist.  We can't use super here, because
 
158
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
159
        # --bmc, 20060426
 
160
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
161
             'please convert %s to use BzrError instead'
 
162
             % self.__class__.__name__,
 
163
             DeprecationWarning,
 
164
             stacklevel=2)
 
165
        BzrError.__init__(self, *args)
101
166
        for key, value in kwds.items():
102
167
            setattr(self, key, value)
103
168
 
104
169
    def __str__(self):
105
170
        try:
106
 
            return self.__doc__ % self.__dict__
107
 
        except (NameError, ValueError, KeyError), e:
108
 
            return 'Unprintable exception %s: %s' \
109
 
                % (self.__class__.__name__, str(e))
110
 
 
111
 
 
112
 
class BzrCheckError(BzrNewError):
113
 
    """Internal check failed: %(message)s"""
 
171
            # __str__() should always return a 'str' object
 
172
            # never a 'unicode' object.
 
173
            s = self.__doc__ % self.__dict__
 
174
            if isinstance(s, unicode):
 
175
                return s.encode('utf8')
 
176
            return s
 
177
        except (TypeError, NameError, ValueError, KeyError), e:
 
178
            return 'Unprintable exception %s(%r): %r' \
 
179
                % (self.__class__.__name__,
 
180
                   self.__dict__, e)
 
181
 
 
182
 
 
183
class AlreadyBuilding(BzrError):
 
184
    
 
185
    _fmt = "The tree builder is already building a tree."
 
186
 
 
187
 
 
188
class BzrCheckError(InternalBzrError):
 
189
    
 
190
    _fmt = "Internal check failed: %(message)s"
114
191
 
115
192
    def __init__(self, message):
116
 
        BzrNewError.__init__(self)
 
193
        BzrError.__init__(self)
117
194
        self.message = message
118
195
 
119
196
 
120
 
class InvalidEntryName(BzrNewError):
121
 
    """Invalid entry name: %(name)s"""
 
197
class DisabledMethod(InternalBzrError):
 
198
 
 
199
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
200
 
 
201
    def __init__(self, class_name):
 
202
        BzrError.__init__(self)
 
203
        self.class_name = class_name
 
204
 
 
205
 
 
206
class IncompatibleAPI(BzrError):
 
207
 
 
208
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
209
        'It supports versions "%(minimum)s" to "%(current)s".'
 
210
 
 
211
    def __init__(self, api, wanted, minimum, current):
 
212
        self.api = api
 
213
        self.wanted = wanted
 
214
        self.minimum = minimum
 
215
        self.current = current
 
216
 
 
217
 
 
218
class InProcessTransport(BzrError):
 
219
 
 
220
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
221
        "process."
 
222
 
 
223
    def __init__(self, transport):
 
224
        self.transport = transport
 
225
 
 
226
 
 
227
class InvalidEntryName(InternalBzrError):
 
228
    
 
229
    _fmt = "Invalid entry name: %(name)s"
 
230
 
122
231
    def __init__(self, name):
123
 
        BzrNewError.__init__(self)
 
232
        BzrError.__init__(self)
124
233
        self.name = name
125
234
 
126
235
 
127
 
class InvalidRevisionNumber(BzrNewError):
128
 
    """Invalid revision number %(revno)d"""
 
236
class InvalidRevisionNumber(BzrError):
 
237
    
 
238
    _fmt = "Invalid revision number %(revno)s"
 
239
 
129
240
    def __init__(self, revno):
130
 
        BzrNewError.__init__(self)
 
241
        BzrError.__init__(self)
131
242
        self.revno = revno
132
243
 
133
244
 
134
 
class InvalidRevisionId(BzrNewError):
135
 
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
245
class InvalidRevisionId(BzrError):
 
246
 
 
247
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
248
 
136
249
    def __init__(self, revision_id, branch):
137
250
        # branch can be any string or object with __str__ defined
138
 
        BzrNewError.__init__(self)
 
251
        BzrError.__init__(self)
139
252
        self.revision_id = revision_id
140
253
        self.branch = branch
141
254
 
142
255
 
143
 
class NoWorkingTree(BzrNewError):
144
 
    """No WorkingTree exists for %(base)s."""
 
256
class ReservedId(BzrError):
 
257
 
 
258
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
259
 
 
260
    def __init__(self, revision_id):
 
261
        self.revision_id = revision_id
 
262
 
 
263
 
 
264
class RootMissing(InternalBzrError):
 
265
 
 
266
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
267
        "record_entry_contents.")
 
268
 
 
269
 
 
270
class NoHelpTopic(BzrError):
 
271
 
 
272
    _fmt = ("No help could be found for '%(topic)s'. "
 
273
        "Please use 'bzr help topics' to obtain a list of topics.")
 
274
 
 
275
    def __init__(self, topic):
 
276
        self.topic = topic
 
277
 
 
278
 
 
279
class NoSuchId(BzrError):
 
280
 
 
281
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
282
    
 
283
    def __init__(self, tree, file_id):
 
284
        BzrError.__init__(self)
 
285
        self.file_id = file_id
 
286
        self.tree = tree
 
287
 
 
288
 
 
289
class NoSuchIdInRepository(NoSuchId):
 
290
 
 
291
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
292
            ' %(repository)r')
 
293
 
 
294
    def __init__(self, repository, file_id):
 
295
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
296
 
 
297
 
 
298
class InventoryModified(InternalBzrError):
 
299
 
 
300
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
301
            " so a clean inventory cannot be read without data loss.")
 
302
 
 
303
    def __init__(self, tree):
 
304
        self.tree = tree
 
305
 
 
306
 
 
307
class NoWorkingTree(BzrError):
 
308
 
 
309
    _fmt = 'No WorkingTree exists for "%(base)s".'
145
310
    
146
311
    def __init__(self, base):
147
 
        BzrNewError.__init__(self)
 
312
        BzrError.__init__(self)
148
313
        self.base = base
149
314
 
150
315
 
151
 
class NotLocalUrl(BzrNewError):
152
 
    """%(url)s is not a local path."""
153
 
    
 
316
class NotBuilding(BzrError):
 
317
 
 
318
    _fmt = "Not currently building a tree."
 
319
 
 
320
 
 
321
class NotLocalUrl(BzrError):
 
322
 
 
323
    _fmt = "%(url)s is not a local path."
 
324
 
154
325
    def __init__(self, url):
155
 
        BzrNewError.__init__(self)
156
326
        self.url = url
157
327
 
158
328
 
 
329
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
330
 
 
331
    _fmt = 'Working tree already populated in "%(base)s"'
 
332
 
 
333
    def __init__(self, base):
 
334
        self.base = base
 
335
 
 
336
 
159
337
class BzrCommandError(BzrError):
160
 
    # Error from malformed user command
161
 
    # This is being misused as a generic exception
162
 
    # pleae subclass. RBC 20051030
 
338
    """Error from user command"""
 
339
 
 
340
    # Error from malformed user command; please avoid raising this as a
 
341
    # generic exception not caused by user input.
163
342
    #
164
343
    # I think it's a waste of effort to differentiate between errors that
165
344
    # are not intended to be caught anyway.  UI code need not subclass
166
345
    # BzrCommandError, and non-UI code should not throw a subclass of
167
346
    # BzrCommandError.  ADHB 20051211
 
347
    def __init__(self, msg):
 
348
        # Object.__str__() must return a real string
 
349
        # returning a Unicode string is a python error.
 
350
        if isinstance(msg, unicode):
 
351
            self.msg = msg.encode('utf8')
 
352
        else:
 
353
            self.msg = msg
 
354
 
168
355
    def __str__(self):
169
 
        return self.args[0]
 
356
        return self.msg
 
357
 
 
358
 
 
359
class NotWriteLocked(BzrError):
 
360
 
 
361
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
362
 
 
363
    def __init__(self, not_locked):
 
364
        self.not_locked = not_locked
170
365
 
171
366
 
172
367
class BzrOptionError(BzrCommandError):
173
 
    """Some missing or otherwise incorrect option was supplied."""
 
368
 
 
369
    _fmt = "Error in command line options"
 
370
 
 
371
 
 
372
class BadIndexFormatSignature(BzrError):
 
373
 
 
374
    _fmt = "%(value)s is not an index of type %(_type)s."
 
375
 
 
376
    def __init__(self, value, _type):
 
377
        BzrError.__init__(self)
 
378
        self.value = value
 
379
        self._type = _type
 
380
 
 
381
 
 
382
class BadIndexData(BzrError):
 
383
 
 
384
    _fmt = "Error in data for index %(value)s."
 
385
 
 
386
    def __init__(self, value):
 
387
        BzrError.__init__(self)
 
388
        self.value = value
 
389
 
 
390
 
 
391
class BadIndexDuplicateKey(BzrError):
 
392
 
 
393
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
394
 
 
395
    def __init__(self, key, index):
 
396
        BzrError.__init__(self)
 
397
        self.key = key
 
398
        self.index = index
 
399
 
 
400
 
 
401
class BadIndexKey(BzrError):
 
402
 
 
403
    _fmt = "The key '%(key)s' is not a valid key."
 
404
 
 
405
    def __init__(self, key):
 
406
        BzrError.__init__(self)
 
407
        self.key = key
 
408
 
 
409
 
 
410
class BadIndexOptions(BzrError):
 
411
 
 
412
    _fmt = "Could not parse options for index %(value)s."
 
413
 
 
414
    def __init__(self, value):
 
415
        BzrError.__init__(self)
 
416
        self.value = value
 
417
 
 
418
 
 
419
class BadIndexValue(BzrError):
 
420
 
 
421
    _fmt = "The value '%(value)s' is not a valid value."
 
422
 
 
423
    def __init__(self, value):
 
424
        BzrError.__init__(self)
 
425
        self.value = value
 
426
 
 
427
 
 
428
class BadOptionValue(BzrError):
 
429
 
 
430
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
431
 
 
432
    def __init__(self, name, value):
 
433
        BzrError.__init__(self, name=name, value=value)
174
434
 
175
435
    
176
 
class StrictCommitFailed(Exception):
177
 
    """Commit refused because there are unknowns in the tree."""
 
436
class StrictCommitFailed(BzrError):
 
437
 
 
438
    _fmt = "Commit refused because there are unknown files in the tree"
178
439
 
179
440
 
180
441
# XXX: Should be unified with TransportError; they seem to represent the
181
442
# same thing
182
 
class PathError(BzrNewError):
183
 
    """Generic path error: %(path)r%(extra)s)"""
 
443
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
444
# - this is finer than a TransportError - and more useful as such. It 
 
445
# differentiates between 'transport has failed' and 'operation on a transport
 
446
# has failed.'
 
447
class PathError(BzrError):
 
448
    
 
449
    _fmt = "Generic path error: %(path)r%(extra)s)"
184
450
 
185
451
    def __init__(self, path, extra=None):
186
 
        BzrNewError.__init__(self)
 
452
        BzrError.__init__(self)
187
453
        self.path = path
188
454
        if extra:
189
455
            self.extra = ': ' + str(extra)
192
458
 
193
459
 
194
460
class NoSuchFile(PathError):
195
 
    """No such file: %(path)r%(extra)s"""
 
461
 
 
462
    _fmt = "No such file: %(path)r%(extra)s"
196
463
 
197
464
 
198
465
class FileExists(PathError):
199
 
    """File exists: %(path)r%(extra)s"""
 
466
 
 
467
    _fmt = "File exists: %(path)r%(extra)s"
 
468
 
 
469
 
 
470
class RenameFailedFilesExist(BzrError):
 
471
    """Used when renaming and both source and dest exist."""
 
472
 
 
473
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
474
            " (Use --after to tell bzr about a rename that has already"
 
475
            " happened)%(extra)s")
 
476
 
 
477
    def __init__(self, source, dest, extra=None):
 
478
        BzrError.__init__(self)
 
479
        self.source = str(source)
 
480
        self.dest = str(dest)
 
481
        if extra:
 
482
            self.extra = ' ' + str(extra)
 
483
        else:
 
484
            self.extra = ''
 
485
 
 
486
 
 
487
class NotADirectory(PathError):
 
488
 
 
489
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
490
 
 
491
 
 
492
class NotInWorkingDirectory(PathError):
 
493
 
 
494
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
200
495
 
201
496
 
202
497
class DirectoryNotEmpty(PathError):
203
 
    """Directory not empty: %(path)r%(extra)s"""
 
498
 
 
499
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
500
 
 
501
 
 
502
class ReadingCompleted(InternalBzrError):
 
503
    
 
504
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
505
            "called upon it - the request has been completed and no more "
 
506
            "data may be read.")
 
507
 
 
508
    def __init__(self, request):
 
509
        self.request = request
204
510
 
205
511
 
206
512
class ResourceBusy(PathError):
207
 
    """Device or resource busy: %(path)r%(extra)s"""
 
513
 
 
514
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
208
515
 
209
516
 
210
517
class PermissionDenied(PathError):
211
 
    """Permission denied: %(path)r%(extra)s"""
212
 
 
213
 
 
214
 
class PathNotChild(BzrNewError):
215
 
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
518
 
 
519
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
520
 
 
521
 
 
522
class InvalidURL(PathError):
 
523
 
 
524
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
525
 
 
526
 
 
527
class InvalidURLJoin(PathError):
 
528
 
 
529
    _fmt = 'Invalid URL join request: "%(args)s"%(extra)s'
 
530
 
 
531
    def __init__(self, msg, base, args):
 
532
        PathError.__init__(self, base, msg)
 
533
        self.args = [base] + list(args)
 
534
 
 
535
 
 
536
class UnknownHook(BzrError):
 
537
 
 
538
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
539
 
 
540
    def __init__(self, hook_type, hook_name):
 
541
        BzrError.__init__(self)
 
542
        self.type = hook_type
 
543
        self.hook = hook_name
 
544
 
 
545
 
 
546
class UnsupportedProtocol(PathError):
 
547
 
 
548
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
549
 
 
550
    def __init__(self, url, extra):
 
551
        PathError.__init__(self, url, extra=extra)
 
552
 
 
553
 
 
554
class ReadError(PathError):
 
555
    
 
556
    _fmt = """Error reading from %(path)r."""
 
557
 
 
558
 
 
559
class ShortReadvError(PathError):
 
560
 
 
561
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
562
            ' at %(offset)s for "%(path)s"%(extra)s')
 
563
 
 
564
    internal_error = True
 
565
 
 
566
    def __init__(self, path, offset, length, actual, extra=None):
 
567
        PathError.__init__(self, path, extra=extra)
 
568
        self.offset = offset
 
569
        self.length = length
 
570
        self.actual = actual
 
571
 
 
572
 
 
573
class PathNotChild(PathError):
 
574
 
 
575
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
576
 
 
577
    internal_error = True
 
578
 
216
579
    def __init__(self, path, base, extra=None):
217
 
        BzrNewError.__init__(self)
 
580
        BzrError.__init__(self)
218
581
        self.path = path
219
582
        self.base = base
220
583
        if extra:
223
586
            self.extra = ''
224
587
 
225
588
 
 
589
class InvalidNormalization(PathError):
 
590
 
 
591
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
592
 
 
593
 
 
594
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
595
# the exception object is a bit undesirable.
 
596
# TODO: Probably this behavior of should be a common superclass 
226
597
class NotBranchError(PathError):
227
 
    """Not a branch: %(path)s"""
 
598
 
 
599
    _fmt = 'Not a branch: "%(path)s".'
 
600
 
 
601
    def __init__(self, path):
 
602
       import bzrlib.urlutils as urlutils
 
603
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
604
 
 
605
 
 
606
class NoSubmitBranch(PathError):
 
607
 
 
608
    _fmt = 'No submit branch available for branch "%(path)s"'
 
609
 
 
610
    def __init__(self, branch):
 
611
       import bzrlib.urlutils as urlutils
 
612
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
228
613
 
229
614
 
230
615
class AlreadyBranchError(PathError):
231
 
    """Already a branch: %(path)s."""
 
616
 
 
617
    _fmt = 'Already a branch: "%(path)s".'
232
618
 
233
619
 
234
620
class BranchExistsWithoutWorkingTree(PathError):
235
 
    """Directory contains a branch, but no working tree \
236
 
(use bzr checkout if you wish to build a working tree): %(path)s"""
237
 
 
238
 
 
239
 
class NoRepositoryPresent(BzrNewError):
240
 
    """No repository present: %(path)r"""
 
621
 
 
622
    _fmt = 'Directory contains a branch, but no working tree \
 
623
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
624
 
 
625
 
 
626
class AtomicFileAlreadyClosed(PathError):
 
627
 
 
628
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
629
            ' "%(path)s"')
 
630
 
 
631
    def __init__(self, path, function):
 
632
        PathError.__init__(self, path=path, extra=None)
 
633
        self.function = function
 
634
 
 
635
 
 
636
class InaccessibleParent(PathError):
 
637
 
 
638
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
639
            ' relative path "%(path)s"')
 
640
 
 
641
    def __init__(self, path, base):
 
642
        PathError.__init__(self, path)
 
643
        self.base = base
 
644
 
 
645
 
 
646
class NoRepositoryPresent(BzrError):
 
647
 
 
648
    _fmt = 'No repository present: "%(path)s"'
241
649
    def __init__(self, bzrdir):
242
 
        BzrNewError.__init__(self)
 
650
        BzrError.__init__(self)
243
651
        self.path = bzrdir.transport.clone('..').base
244
652
 
245
653
 
246
 
class FileInWrongBranch(BzrNewError):
247
 
    """File %(path)s in not in branch %(branch_base)s."""
 
654
class FileInWrongBranch(BzrError):
 
655
 
 
656
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
248
657
 
249
658
    def __init__(self, branch, path):
250
 
        BzrNewError.__init__(self)
 
659
        BzrError.__init__(self)
251
660
        self.branch = branch
252
661
        self.branch_base = branch.base
253
662
        self.path = path
254
663
 
255
664
 
256
665
class UnsupportedFormatError(BzrError):
257
 
    """Specified path is a bzr branch that we recognize but cannot read."""
258
 
    def __str__(self):
259
 
        return 'unsupported branch format: %s' % self.args[0]
 
666
 
 
667
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
260
668
 
261
669
 
262
670
class UnknownFormatError(BzrError):
263
 
    """Specified path is a bzr branch whose format we do not recognize."""
264
 
    def __str__(self):
265
 
        return 'unknown branch format: %s' % self.args[0]
266
 
 
267
 
 
268
 
class IncompatibleFormat(BzrNewError):
269
 
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
671
    
 
672
    _fmt = "Unknown branch format: %(format)r"
 
673
 
 
674
 
 
675
class IncompatibleFormat(BzrError):
 
676
    
 
677
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
270
678
 
271
679
    def __init__(self, format, bzrdir_format):
272
 
        BzrNewError.__init__(self)
 
680
        BzrError.__init__(self)
273
681
        self.format = format
274
682
        self.bzrdir = bzrdir_format
275
683
 
276
684
 
277
 
class NotVersionedError(BzrNewError):
278
 
    """%(path)s is not versioned"""
279
 
    def __init__(self, path):
280
 
        BzrNewError.__init__(self)
281
 
        self.path = path
282
 
 
283
 
 
284
 
class PathsNotVersionedError(BzrNewError):
285
 
    # used when reporting several paths are not versioned
286
 
    """Path(s) are not versioned: %(paths_as_string)s"""
 
685
class IncompatibleRepositories(BzrError):
 
686
 
 
687
    _fmt = "Repository %(target)s is not compatible with repository"\
 
688
        " %(source)s"
 
689
 
 
690
    def __init__(self, source, target):
 
691
        BzrError.__init__(self, target=target, source=source)
 
692
 
 
693
 
 
694
class IncompatibleRevision(BzrError):
 
695
    
 
696
    _fmt = "Revision is not compatible with %(repo_format)s"
 
697
 
 
698
    def __init__(self, repo_format):
 
699
        BzrError.__init__(self)
 
700
        self.repo_format = repo_format
 
701
 
 
702
 
 
703
class AlreadyVersionedError(BzrError):
 
704
    """Used when a path is expected not to be versioned, but it is."""
 
705
 
 
706
    _fmt = "%(context_info)s%(path)s is already versioned."
 
707
 
 
708
    def __init__(self, path, context_info=None):
 
709
        """Construct a new AlreadyVersionedError.
 
710
 
 
711
        :param path: This is the path which is versioned,
 
712
        which should be in a user friendly form.
 
713
        :param context_info: If given, this is information about the context,
 
714
        which could explain why this is expected to not be versioned.
 
715
        """
 
716
        BzrError.__init__(self)
 
717
        self.path = path
 
718
        if context_info is None:
 
719
            self.context_info = ''
 
720
        else:
 
721
            self.context_info = context_info + ". "
 
722
 
 
723
 
 
724
class NotVersionedError(BzrError):
 
725
    """Used when a path is expected to be versioned, but it is not."""
 
726
 
 
727
    _fmt = "%(context_info)s%(path)s is not versioned."
 
728
 
 
729
    def __init__(self, path, context_info=None):
 
730
        """Construct a new NotVersionedError.
 
731
 
 
732
        :param path: This is the path which is not versioned,
 
733
        which should be in a user friendly form.
 
734
        :param context_info: If given, this is information about the context,
 
735
        which could explain why this is expected to be versioned.
 
736
        """
 
737
        BzrError.__init__(self)
 
738
        self.path = path
 
739
        if context_info is None:
 
740
            self.context_info = ''
 
741
        else:
 
742
            self.context_info = context_info + ". "
 
743
 
 
744
 
 
745
class PathsNotVersionedError(BzrError):
 
746
    """Used when reporting several paths which are not versioned"""
 
747
 
 
748
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
287
749
 
288
750
    def __init__(self, paths):
289
751
        from bzrlib.osutils import quotefn
290
 
        BzrNewError.__init__(self)
 
752
        BzrError.__init__(self)
291
753
        self.paths = paths
292
754
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
293
755
 
294
756
 
295
 
class PathsDoNotExist(BzrNewError):
296
 
    """Path(s) do not exist: %(paths_as_string)s"""
 
757
class PathsDoNotExist(BzrError):
 
758
 
 
759
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
297
760
 
298
761
    # used when reporting that paths are neither versioned nor in the working
299
762
    # tree
300
763
 
301
 
    def __init__(self, paths):
 
764
    def __init__(self, paths, extra=None):
302
765
        # circular import
303
766
        from bzrlib.osutils import quotefn
304
 
        BzrNewError.__init__(self)
 
767
        BzrError.__init__(self)
305
768
        self.paths = paths
306
769
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
770
        if extra:
 
771
            self.extra = ': ' + str(extra)
 
772
        else:
 
773
            self.extra = ''
307
774
 
308
775
 
309
776
class BadFileKindError(BzrError):
310
 
    """Specified file is of a kind that cannot be added.
311
 
 
312
 
    (For example a symlink or device file.)"""
313
 
 
314
 
 
315
 
class ForbiddenFileError(BzrError):
316
 
    """Cannot operate on a file because it is a control file."""
317
 
 
318
 
 
319
 
class LockError(BzrNewError):
320
 
    """Lock error: %(message)s"""
 
777
 
 
778
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
779
 
 
780
    def __init__(self, filename, kind):
 
781
        BzrError.__init__(self, filename=filename, kind=kind)
 
782
 
 
783
 
 
784
class ForbiddenControlFileError(BzrError):
 
785
 
 
786
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
787
 
 
788
 
 
789
class LockError(InternalBzrError):
 
790
 
 
791
    _fmt = "Lock error: %(msg)s"
 
792
 
321
793
    # All exceptions from the lock/unlock functions should be from
322
794
    # this exception class.  They will be translated as necessary. The
323
795
    # original exception is available as e.original_error
324
796
    #
325
797
    # New code should prefer to raise specific subclasses
326
798
    def __init__(self, message):
327
 
        self.message = message
 
799
        # Python 2.5 uses a slot for StandardError.message,
 
800
        # so use a different variable name.  We now work around this in
 
801
        # BzrError.__str__, but this member name is kept for compatability.
 
802
        self.msg = message
 
803
 
 
804
 
 
805
class LockActive(LockError):
 
806
 
 
807
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
808
 
 
809
    internal_error = False
 
810
 
 
811
    def __init__(self, lock_description):
 
812
        self.lock_description = lock_description
328
813
 
329
814
 
330
815
class CommitNotPossible(LockError):
331
 
    """A commit was attempted but we do not have a write lock open."""
 
816
 
 
817
    _fmt = "A commit was attempted but we do not have a write lock open."
 
818
 
332
819
    def __init__(self):
333
820
        pass
334
821
 
335
822
 
336
823
class AlreadyCommitted(LockError):
337
 
    """A rollback was requested, but is not able to be accomplished."""
 
824
 
 
825
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
826
 
338
827
    def __init__(self):
339
828
        pass
340
829
 
341
830
 
342
831
class ReadOnlyError(LockError):
343
 
    """A write attempt was made in a read only transaction on %(obj)s"""
 
832
 
 
833
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
834
 
 
835
    # TODO: There should also be an error indicating that you need a write
 
836
    # lock and don't have any lock at all... mbp 20070226
 
837
 
344
838
    def __init__(self, obj):
345
839
        self.obj = obj
346
840
 
347
841
 
348
 
class OutSideTransaction(BzrNewError):
349
 
    """A transaction related operation was attempted after the transaction finished."""
 
842
class ReadOnlyLockError(LockError):
 
843
 
 
844
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
845
 
 
846
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninetytwo)
 
847
    def __init__(self, fname, msg):
 
848
        LockError.__init__(self, '')
 
849
        self.fname = fname
 
850
        self.msg = msg
 
851
 
 
852
 
 
853
class LockFailed(LockError):
 
854
 
 
855
    internal_error = False
 
856
 
 
857
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
858
 
 
859
    def __init__(self, lock, why):
 
860
        LockError.__init__(self, '')
 
861
        self.lock = lock
 
862
        self.why = why
 
863
 
 
864
 
 
865
class OutSideTransaction(BzrError):
 
866
 
 
867
    _fmt = ("A transaction related operation was attempted after"
 
868
            " the transaction finished.")
350
869
 
351
870
 
352
871
class ObjectNotLocked(LockError):
353
 
    """%(obj)r is not locked"""
 
872
 
 
873
    _fmt = "%(obj)r is not locked"
 
874
 
354
875
    # this can indicate that any particular object is not locked; see also
355
876
    # LockNotHeld which means that a particular *lock* object is not held by
356
877
    # the caller -- perhaps they should be unified.
359
880
 
360
881
 
361
882
class ReadOnlyObjectDirtiedError(ReadOnlyError):
362
 
    """Cannot change object %(obj)r in read only transaction"""
 
883
 
 
884
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
885
 
363
886
    def __init__(self, obj):
364
887
        self.obj = obj
365
888
 
366
889
 
367
890
class UnlockableTransport(LockError):
368
 
    """Cannot lock: transport is read only: %(transport)s"""
 
891
 
 
892
    internal_error = False
 
893
 
 
894
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
895
 
369
896
    def __init__(self, transport):
370
897
        self.transport = transport
371
898
 
372
899
 
373
900
class LockContention(LockError):
374
 
    """Could not acquire lock %(lock)s"""
375
 
    # TODO: show full url for lock, combining the transport and relative bits?
 
901
 
 
902
    _fmt = 'Could not acquire lock "%(lock)s"'
 
903
    # TODO: show full url for lock, combining the transport and relative
 
904
    # bits?
 
905
 
 
906
    internal_error = False
 
907
 
376
908
    def __init__(self, lock):
377
909
        self.lock = lock
378
910
 
379
911
 
380
912
class LockBroken(LockError):
381
 
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
913
 
 
914
    _fmt = ("Lock was broken while still open: %(lock)s"
 
915
            " - check storage consistency!")
 
916
 
 
917
    internal_error = False
 
918
 
382
919
    def __init__(self, lock):
383
920
        self.lock = lock
384
921
 
385
922
 
386
923
class LockBreakMismatch(LockError):
387
 
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
924
 
 
925
    _fmt = ("Lock was released and re-acquired before being broken:"
 
926
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
927
 
 
928
    internal_error = False
 
929
 
388
930
    def __init__(self, lock, holder, target):
389
931
        self.lock = lock
390
932
        self.holder = holder
392
934
 
393
935
 
394
936
class LockNotHeld(LockError):
395
 
    """Lock not held: %(lock)s"""
 
937
 
 
938
    _fmt = "Lock not held: %(lock)s"
 
939
 
 
940
    internal_error = False
 
941
 
396
942
    def __init__(self, lock):
397
943
        self.lock = lock
398
944
 
399
945
 
400
 
class PointlessCommit(BzrNewError):
401
 
    """No changes to commit"""
402
 
 
403
 
 
404
 
class UpgradeReadonly(BzrNewError):
405
 
    """Upgrade URL cannot work with readonly URL's."""
406
 
 
407
 
 
408
 
class UpToDateFormat(BzrNewError):
409
 
    """The branch format %(format)s is already at the most recent format."""
 
946
class TokenLockingNotSupported(LockError):
 
947
 
 
948
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
949
 
 
950
    def __init__(self, obj):
 
951
        self.obj = obj
 
952
 
 
953
 
 
954
class TokenMismatch(LockBroken):
 
955
 
 
956
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
957
 
 
958
    internal_error = True
 
959
 
 
960
    def __init__(self, given_token, lock_token):
 
961
        self.given_token = given_token
 
962
        self.lock_token = lock_token
 
963
 
 
964
 
 
965
class PointlessCommit(BzrError):
 
966
 
 
967
    _fmt = "No changes to commit"
 
968
 
 
969
 
 
970
class CannotCommitSelectedFileMerge(BzrError):
 
971
 
 
972
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
973
        ' files %(files_str)s'
 
974
 
 
975
    def __init__(self, files):
 
976
        files_str = ', '.join(files)
 
977
        BzrError.__init__(self, files=files, files_str=files_str)
 
978
 
 
979
 
 
980
class BadCommitMessageEncoding(BzrError):
 
981
 
 
982
    _fmt = 'The specified commit message contains characters unsupported by '\
 
983
        'the current encoding.'
 
984
 
 
985
 
 
986
class UpgradeReadonly(BzrError):
 
987
 
 
988
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
989
 
 
990
 
 
991
class UpToDateFormat(BzrError):
 
992
 
 
993
    _fmt = "The branch format %(format)s is already at the most recent format."
410
994
 
411
995
    def __init__(self, format):
412
 
        BzrNewError.__init__(self)
 
996
        BzrError.__init__(self)
413
997
        self.format = format
414
998
 
415
999
 
416
 
 
417
1000
class StrictCommitFailed(Exception):
418
 
    """Commit refused because there are unknowns in the tree."""
419
 
 
420
 
 
421
 
class NoSuchRevision(BzrError):
 
1001
 
 
1002
    _fmt = "Commit refused because there are unknowns in the tree."
 
1003
 
 
1004
 
 
1005
class NoSuchRevision(InternalBzrError):
 
1006
 
 
1007
    _fmt = "%(branch)s has no revision %(revision)s"
 
1008
 
422
1009
    def __init__(self, branch, revision):
423
 
        self.branch = branch
424
 
        self.revision = revision
425
 
        msg = "Branch %s has no revision %s" % (branch, revision)
426
 
        BzrError.__init__(self, msg)
 
1010
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1011
        BzrError.__init__(self, branch=branch, revision=revision)
 
1012
 
 
1013
 
 
1014
# zero_ninetyone: this exception is no longer raised and should be removed
 
1015
class NotLeftParentDescendant(InternalBzrError):
 
1016
 
 
1017
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
1018
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
1019
 
 
1020
    def __init__(self, branch, old_revision, new_revision):
 
1021
        BzrError.__init__(self, branch_location=branch.base,
 
1022
                          old_revision=old_revision,
 
1023
                          new_revision=new_revision)
 
1024
 
 
1025
 
 
1026
class RangeInChangeOption(BzrError):
 
1027
 
 
1028
    _fmt = "Option --change does not accept revision ranges"
 
1029
 
 
1030
 
 
1031
class NoSuchRevisionSpec(BzrError):
 
1032
 
 
1033
    _fmt = "No namespace registered for string: %(spec)r"
 
1034
 
 
1035
    def __init__(self, spec):
 
1036
        BzrError.__init__(self, spec=spec)
 
1037
 
 
1038
 
 
1039
class NoSuchRevisionInTree(NoSuchRevision):
 
1040
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1041
    
 
1042
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1043
 
 
1044
    def __init__(self, tree, revision_id):
 
1045
        BzrError.__init__(self)
 
1046
        self.tree = tree
 
1047
        self.revision_id = revision_id
 
1048
 
 
1049
 
 
1050
class InvalidRevisionSpec(BzrError):
 
1051
 
 
1052
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1053
            " %(branch)s%(extra)s")
 
1054
 
 
1055
    def __init__(self, spec, branch, extra=None):
 
1056
        BzrError.__init__(self, branch=branch, spec=spec)
 
1057
        if extra:
 
1058
            self.extra = '\n' + str(extra)
 
1059
        else:
 
1060
            self.extra = ''
427
1061
 
428
1062
 
429
1063
class HistoryMissing(BzrError):
430
 
    def __init__(self, branch, object_type, object_id):
431
 
        self.branch = branch
432
 
        BzrError.__init__(self,
433
 
                          '%s is missing %s {%s}'
434
 
                          % (branch, object_type, object_id))
 
1064
 
 
1065
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1066
 
 
1067
 
 
1068
class AppendRevisionsOnlyViolation(BzrError):
 
1069
 
 
1070
    _fmt = ('Operation denied because it would change the main history,'
 
1071
           ' which is not permitted by the append_revisions_only setting on'
 
1072
           ' branch "%(location)s".')
 
1073
 
 
1074
    def __init__(self, location):
 
1075
       import bzrlib.urlutils as urlutils
 
1076
       location = urlutils.unescape_for_display(location, 'ascii')
 
1077
       BzrError.__init__(self, location=location)
435
1078
 
436
1079
 
437
1080
class DivergedBranches(BzrError):
438
1081
 
 
1082
    _fmt = ("These branches have diverged."
 
1083
            " Use the merge command to reconcile them.")
 
1084
 
439
1085
    def __init__(self, branch1, branch2):
440
 
        BzrError.__init__(self, "These branches have diverged.  Try merge.")
441
1086
        self.branch1 = branch1
442
1087
        self.branch2 = branch2
443
1088
 
444
1089
 
445
 
class UnrelatedBranches(BzrCommandError):
446
 
    def __init__(self):
447
 
        msg = "Branches have no common ancestor, and no base revision"\
448
 
            " specified."
449
 
        BzrCommandError.__init__(self, msg)
 
1090
class NotLefthandHistory(InternalBzrError):
 
1091
 
 
1092
    _fmt = "Supplied history does not follow left-hand parents"
 
1093
 
 
1094
    def __init__(self, history):
 
1095
        BzrError.__init__(self, history=history)
 
1096
 
 
1097
 
 
1098
class UnrelatedBranches(BzrError):
 
1099
 
 
1100
    _fmt = ("Branches have no common ancestor, and"
 
1101
            " no merge base revision was specified.")
 
1102
 
 
1103
 
 
1104
class CannotReverseCherrypick(BzrError):
 
1105
 
 
1106
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1107
            ' or diff3.')
450
1108
 
451
1109
 
452
1110
class NoCommonAncestor(BzrError):
 
1111
    
 
1112
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1113
 
453
1114
    def __init__(self, revision_a, revision_b):
454
 
        msg = "Revisions have no common ancestor: %s %s." \
455
 
            % (revision_a, revision_b) 
456
 
        BzrError.__init__(self, msg)
 
1115
        self.revision_a = revision_a
 
1116
        self.revision_b = revision_b
457
1117
 
458
1118
 
459
1119
class NoCommonRoot(BzrError):
 
1120
 
 
1121
    _fmt = ("Revisions are not derived from the same root: "
 
1122
           "%(revision_a)s %(revision_b)s.")
 
1123
 
460
1124
    def __init__(self, revision_a, revision_b):
461
 
        msg = "Revisions are not derived from the same root: %s %s." \
462
 
            % (revision_a, revision_b) 
463
 
        BzrError.__init__(self, msg)
464
 
 
 
1125
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
465
1126
 
466
1127
 
467
1128
class NotAncestor(BzrError):
 
1129
 
 
1130
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1131
 
468
1132
    def __init__(self, rev_id, not_ancestor_id):
469
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
470
 
                                                        rev_id)
471
 
        BzrError.__init__(self, msg)
472
 
        self.rev_id = rev_id
473
 
        self.not_ancestor_id = not_ancestor_id
 
1133
        BzrError.__init__(self, rev_id=rev_id,
 
1134
            not_ancestor_id=not_ancestor_id)
474
1135
 
475
1136
 
476
1137
class InstallFailed(BzrError):
 
1138
 
477
1139
    def __init__(self, revisions):
478
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
1140
        revision_str = ", ".join(str(r) for r in revisions)
 
1141
        msg = "Could not install revisions:\n%s" % revision_str
479
1142
        BzrError.__init__(self, msg)
480
1143
        self.revisions = revisions
481
1144
 
482
1145
 
483
1146
class AmbiguousBase(BzrError):
 
1147
 
484
1148
    def __init__(self, bases):
485
1149
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
486
1150
                DeprecationWarning)
487
 
        msg = "The correct base is unclear, becase %s are all equally close" %\
488
 
            ", ".join(bases)
 
1151
        msg = ("The correct base is unclear, because %s are all equally close"
 
1152
                % ", ".join(bases))
489
1153
        BzrError.__init__(self, msg)
490
1154
        self.bases = bases
491
1155
 
492
1156
 
493
1157
class NoCommits(BzrError):
 
1158
 
 
1159
    _fmt = "Branch %(branch)s has no commits."
 
1160
 
494
1161
    def __init__(self, branch):
495
 
        msg = "Branch %s has no commits." % branch
496
 
        BzrError.__init__(self, msg)
 
1162
        BzrError.__init__(self, branch=branch)
497
1163
 
498
1164
 
499
1165
class UnlistableStore(BzrError):
 
1166
 
500
1167
    def __init__(self, store):
501
1168
        BzrError.__init__(self, "Store %s is not listable" % store)
502
1169
 
503
1170
 
504
1171
 
505
1172
class UnlistableBranch(BzrError):
 
1173
 
506
1174
    def __init__(self, br):
507
1175
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
508
1176
 
509
1177
 
510
 
class BoundBranchOutOfDate(BzrNewError):
511
 
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
1178
class BoundBranchOutOfDate(BzrError):
 
1179
 
 
1180
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1181
            " %(master)s.")
 
1182
 
512
1183
    def __init__(self, branch, master):
513
 
        BzrNewError.__init__(self)
 
1184
        BzrError.__init__(self)
514
1185
        self.branch = branch
515
1186
        self.master = master
516
1187
 
517
1188
        
518
 
class CommitToDoubleBoundBranch(BzrNewError):
519
 
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
1189
class CommitToDoubleBoundBranch(BzrError):
 
1190
 
 
1191
    _fmt = ("Cannot commit to branch %(branch)s."
 
1192
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1193
 
520
1194
    def __init__(self, branch, master, remote):
521
 
        BzrNewError.__init__(self)
 
1195
        BzrError.__init__(self)
522
1196
        self.branch = branch
523
1197
        self.master = master
524
1198
        self.remote = remote
525
1199
 
526
1200
 
527
 
class OverwriteBoundBranch(BzrNewError):
528
 
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
1201
class OverwriteBoundBranch(BzrError):
 
1202
 
 
1203
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1204
 
529
1205
    def __init__(self, branch):
530
 
        BzrNewError.__init__(self)
 
1206
        BzrError.__init__(self)
531
1207
        self.branch = branch
532
1208
 
533
1209
 
534
 
class BoundBranchConnectionFailure(BzrNewError):
535
 
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
1210
class BoundBranchConnectionFailure(BzrError):
 
1211
 
 
1212
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1213
            " => %(target)s: %(error)s")
 
1214
 
536
1215
    def __init__(self, branch, target, error):
537
 
        BzrNewError.__init__(self)
 
1216
        BzrError.__init__(self)
538
1217
        self.branch = branch
539
1218
        self.target = target
540
1219
        self.error = error
541
1220
 
542
1221
 
543
 
class WeaveError(BzrNewError):
544
 
    """Error in processing weave: %(message)s"""
 
1222
class WeaveError(BzrError):
 
1223
 
 
1224
    _fmt = "Error in processing weave: %(message)s"
545
1225
 
546
1226
    def __init__(self, message=None):
547
 
        BzrNewError.__init__(self)
 
1227
        BzrError.__init__(self)
548
1228
        self.message = message
549
1229
 
550
1230
 
551
1231
class WeaveRevisionAlreadyPresent(WeaveError):
552
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
1232
 
 
1233
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1234
 
553
1235
    def __init__(self, revision_id, weave):
554
1236
 
555
1237
        WeaveError.__init__(self)
558
1240
 
559
1241
 
560
1242
class WeaveRevisionNotPresent(WeaveError):
561
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
1243
 
 
1244
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
562
1245
 
563
1246
    def __init__(self, revision_id, weave):
564
1247
        WeaveError.__init__(self)
567
1250
 
568
1251
 
569
1252
class WeaveFormatError(WeaveError):
570
 
    """Weave invariant violated: %(what)s"""
 
1253
 
 
1254
    _fmt = "Weave invariant violated: %(what)s"
571
1255
 
572
1256
    def __init__(self, what):
573
1257
        WeaveError.__init__(self)
575
1259
 
576
1260
 
577
1261
class WeaveParentMismatch(WeaveError):
578
 
    """Parents are mismatched between two revisions."""
 
1262
 
 
1263
    _fmt = "Parents are mismatched between two revisions. %(message)s"
579
1264
    
580
1265
 
581
1266
class WeaveInvalidChecksum(WeaveError):
582
 
    """Text did not match it's checksum: %(message)s"""
583
 
 
584
 
 
585
 
class WeaveTextDiffers(WeaveError):
586
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
587
 
 
588
 
    def __init__(self, revision_id, weave_a, weave_b):
589
 
        WeaveError.__init__(self)
590
 
        self.revision_id = revision_id
591
 
        self.weave_a = weave_a
592
 
        self.weave_b = weave_b
593
 
 
594
 
 
595
 
class WeaveTextDiffers(WeaveError):
596
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
597
 
 
598
 
    def __init__(self, revision_id, weave_a, weave_b):
599
 
        WeaveError.__init__(self)
600
 
        self.revision_id = revision_id
601
 
        self.weave_a = weave_a
602
 
        self.weave_b = weave_b
603
 
 
604
 
 
605
 
class VersionedFileError(BzrNewError):
606
 
    """Versioned file error."""
 
1267
 
 
1268
    _fmt = "Text did not match it's checksum: %(message)s"
 
1269
 
 
1270
 
 
1271
class WeaveTextDiffers(WeaveError):
 
1272
 
 
1273
    _fmt = ("Weaves differ on text content. Revision:"
 
1274
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1275
 
 
1276
    def __init__(self, revision_id, weave_a, weave_b):
 
1277
        WeaveError.__init__(self)
 
1278
        self.revision_id = revision_id
 
1279
        self.weave_a = weave_a
 
1280
        self.weave_b = weave_b
 
1281
 
 
1282
 
 
1283
class WeaveTextDiffers(WeaveError):
 
1284
 
 
1285
    _fmt = ("Weaves differ on text content. Revision:"
 
1286
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1287
 
 
1288
    def __init__(self, revision_id, weave_a, weave_b):
 
1289
        WeaveError.__init__(self)
 
1290
        self.revision_id = revision_id
 
1291
        self.weave_a = weave_a
 
1292
        self.weave_b = weave_b
 
1293
 
 
1294
 
 
1295
class VersionedFileError(BzrError):
 
1296
    
 
1297
    _fmt = "Versioned file error"
607
1298
 
608
1299
 
609
1300
class RevisionNotPresent(VersionedFileError):
610
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
1301
    
 
1302
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
611
1303
 
612
1304
    def __init__(self, revision_id, file_id):
613
1305
        VersionedFileError.__init__(self)
616
1308
 
617
1309
 
618
1310
class RevisionAlreadyPresent(VersionedFileError):
619
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
1311
    
 
1312
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
620
1313
 
621
1314
    def __init__(self, revision_id, file_id):
622
1315
        VersionedFileError.__init__(self)
624
1317
        self.file_id = file_id
625
1318
 
626
1319
 
627
 
class KnitError(BzrNewError):
628
 
    """Knit error"""
629
 
 
630
 
 
631
 
class KnitHeaderError(KnitError):
632
 
    """Knit header error: %(badline)r unexpected"""
633
 
 
634
 
    def __init__(self, badline):
635
 
        KnitError.__init__(self)
636
 
        self.badline = badline
 
1320
class VersionedFileInvalidChecksum(VersionedFileError):
 
1321
 
 
1322
    _fmt = "Text did not match its checksum: %(message)s"
 
1323
 
 
1324
 
 
1325
class KnitError(InternalBzrError):
 
1326
    
 
1327
    _fmt = "Knit error"
637
1328
 
638
1329
 
639
1330
class KnitCorrupt(KnitError):
640
 
    """Knit %(filename)s corrupt: %(how)s"""
 
1331
 
 
1332
    _fmt = "Knit %(filename)s corrupt: %(how)s"
641
1333
 
642
1334
    def __init__(self, filename, how):
643
1335
        KnitError.__init__(self)
645
1337
        self.how = how
646
1338
 
647
1339
 
648
 
class NoSuchExportFormat(BzrNewError):
649
 
    """Export format %(format)r not supported"""
 
1340
class KnitDataStreamIncompatible(KnitError):
 
1341
    # Not raised anymore, as we can convert data streams.  In future we may
 
1342
    # need it again for more exotic cases, so we're keeping it around for now.
 
1343
 
 
1344
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1345
 
 
1346
    def __init__(self, stream_format, target_format):
 
1347
        self.stream_format = stream_format
 
1348
        self.target_format = target_format
 
1349
        
 
1350
 
 
1351
class KnitDataStreamUnknown(KnitError):
 
1352
    # Indicates a data stream we don't know how to handle.
 
1353
 
 
1354
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1355
 
 
1356
    def __init__(self, stream_format):
 
1357
        self.stream_format = stream_format
 
1358
        
 
1359
 
 
1360
class KnitHeaderError(KnitError):
 
1361
 
 
1362
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1363
 
 
1364
    def __init__(self, badline, filename):
 
1365
        KnitError.__init__(self)
 
1366
        self.badline = badline
 
1367
        self.filename = filename
 
1368
 
 
1369
class KnitIndexUnknownMethod(KnitError):
 
1370
    """Raised when we don't understand the storage method.
 
1371
 
 
1372
    Currently only 'fulltext' and 'line-delta' are supported.
 
1373
    """
 
1374
    
 
1375
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1376
            " in options: %(options)r")
 
1377
 
 
1378
    def __init__(self, filename, options):
 
1379
        KnitError.__init__(self)
 
1380
        self.filename = filename
 
1381
        self.options = options
 
1382
 
 
1383
 
 
1384
class NoSuchExportFormat(BzrError):
 
1385
    
 
1386
    _fmt = "Export format %(format)r not supported"
 
1387
 
650
1388
    def __init__(self, format):
651
 
        BzrNewError.__init__(self)
 
1389
        BzrError.__init__(self)
652
1390
        self.format = format
653
1391
 
654
1392
 
655
1393
class TransportError(BzrError):
656
 
    """All errors thrown by Transport implementations should derive
657
 
    from this class.
658
 
    """
 
1394
    
 
1395
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1396
 
659
1397
    def __init__(self, msg=None, orig_error=None):
660
1398
        if msg is None and orig_error is not None:
661
1399
            msg = str(orig_error)
662
 
        BzrError.__init__(self, msg)
 
1400
        if orig_error is None:
 
1401
            orig_error = ''
 
1402
        if msg is None:
 
1403
            msg =  ''
663
1404
        self.msg = msg
664
1405
        self.orig_error = orig_error
 
1406
        BzrError.__init__(self)
 
1407
 
 
1408
 
 
1409
class TooManyConcurrentRequests(InternalBzrError):
 
1410
 
 
1411
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1412
            " Be sure to finish_writing and finish_reading on the"
 
1413
            " currently open request.")
 
1414
 
 
1415
    def __init__(self, medium):
 
1416
        self.medium = medium
 
1417
 
 
1418
 
 
1419
class SmartProtocolError(TransportError):
 
1420
 
 
1421
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1422
 
 
1423
    def __init__(self, details):
 
1424
        self.details = details
665
1425
 
666
1426
 
667
1427
# A set of semi-meaningful errors which can be thrown
668
1428
class TransportNotPossible(TransportError):
669
 
    """This is for transports where a specific function is explicitly not
670
 
    possible. Such as pushing files to an HTTP server.
671
 
    """
672
 
    pass
 
1429
 
 
1430
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
673
1431
 
674
1432
 
675
1433
class ConnectionError(TransportError):
676
 
    """A connection problem prevents file retrieval.
677
 
    This does not indicate whether the file exists or not; it indicates that a
678
 
    precondition for requesting the file was not met.
679
 
    """
680
 
    def __init__(self, msg=None, orig_error=None):
681
 
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
1434
 
 
1435
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1436
 
 
1437
 
 
1438
class SocketConnectionError(ConnectionError):
 
1439
 
 
1440
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1441
 
 
1442
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1443
        if msg is None:
 
1444
            msg = 'Failed to connect to'
 
1445
        if orig_error is None:
 
1446
            orig_error = ''
 
1447
        else:
 
1448
            orig_error = '; ' + str(orig_error)
 
1449
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1450
        self.host = host
 
1451
        if port is None:
 
1452
            self.port = ''
 
1453
        else:
 
1454
            self.port = ':%s' % port
682
1455
 
683
1456
 
684
1457
class ConnectionReset(TransportError):
685
 
    """The connection has been closed."""
686
 
    pass
 
1458
 
 
1459
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1460
 
 
1461
 
 
1462
class InvalidRange(TransportError):
 
1463
 
 
1464
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1465
 
 
1466
    def __init__(self, path, offset, msg=None):
 
1467
        TransportError.__init__(self, msg)
 
1468
        self.path = path
 
1469
        self.offset = offset
 
1470
 
 
1471
 
 
1472
class InvalidHttpResponse(TransportError):
 
1473
 
 
1474
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1475
 
 
1476
    def __init__(self, path, msg, orig_error=None):
 
1477
        self.path = path
 
1478
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1479
 
 
1480
 
 
1481
class InvalidHttpRange(InvalidHttpResponse):
 
1482
 
 
1483
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1484
 
 
1485
    def __init__(self, path, range, msg):
 
1486
        self.range = range
 
1487
        InvalidHttpResponse.__init__(self, path, msg)
 
1488
 
 
1489
 
 
1490
class InvalidHttpContentType(InvalidHttpResponse):
 
1491
 
 
1492
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1493
 
 
1494
    def __init__(self, path, ctype, msg):
 
1495
        self.ctype = ctype
 
1496
        InvalidHttpResponse.__init__(self, path, msg)
 
1497
 
 
1498
 
 
1499
class RedirectRequested(TransportError):
 
1500
 
 
1501
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1502
 
 
1503
    def __init__(self, source, target, is_permanent=False, qual_proto=None):
 
1504
        self.source = source
 
1505
        self.target = target
 
1506
        if is_permanent:
 
1507
            self.permanently = ' permanently'
 
1508
        else:
 
1509
            self.permanently = ''
 
1510
        self._qualified_proto = qual_proto
 
1511
        TransportError.__init__(self)
 
1512
 
 
1513
    def _requalify_url(self, url):
 
1514
        """Restore the qualified proto in front of the url"""
 
1515
        # When this exception is raised, source and target are in
 
1516
        # user readable format. But some transports may use a
 
1517
        # different proto (http+urllib:// will present http:// to
 
1518
        # the user. If a qualified proto is specified, the code
 
1519
        # trapping the exception can get the qualified urls to
 
1520
        # properly handle the redirection themself (creating a
 
1521
        # new transport object from the target url for example).
 
1522
        # But checking that the scheme of the original and
 
1523
        # redirected urls are the same can be tricky. (see the
 
1524
        # FIXME in BzrDir.open_from_transport for the unique use
 
1525
        # case so far).
 
1526
        if self._qualified_proto is None:
 
1527
            return url
 
1528
 
 
1529
        # The TODO related to NotBranchError mention that doing
 
1530
        # that kind of manipulation on the urls may not be the
 
1531
        # exception object job. On the other hand, this object is
 
1532
        # the interface between the code and the user so
 
1533
        # presenting the urls in different ways is indeed its
 
1534
        # job...
 
1535
        import urlparse
 
1536
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
 
1537
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
 
1538
                                   query, fragment))
 
1539
 
 
1540
    def get_source_url(self):
 
1541
        return self._requalify_url(self.source)
 
1542
 
 
1543
    def get_target_url(self):
 
1544
        return self._requalify_url(self.target)
 
1545
 
 
1546
 
 
1547
class TooManyRedirections(TransportError):
 
1548
 
 
1549
    _fmt = "Too many redirections"
687
1550
 
688
1551
 
689
1552
class ConflictsInTree(BzrError):
690
 
    def __init__(self):
691
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1553
 
 
1554
    _fmt = "Working tree has conflicts."
692
1555
 
693
1556
 
694
1557
class ParseConfigError(BzrError):
 
1558
 
695
1559
    def __init__(self, errors, filename):
696
1560
        if filename is None:
697
1561
            filename = ""
700
1564
        BzrError.__init__(self, message)
701
1565
 
702
1566
 
 
1567
class NoEmailInUsername(BzrError):
 
1568
 
 
1569
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1570
 
 
1571
    def __init__(self, username):
 
1572
        BzrError.__init__(self)
 
1573
        self.username = username
 
1574
 
 
1575
 
703
1576
class SigningFailed(BzrError):
 
1577
 
 
1578
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1579
 
704
1580
    def __init__(self, command_line):
705
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
706
 
                               % command_line)
 
1581
        BzrError.__init__(self, command_line=command_line)
707
1582
 
708
1583
 
709
1584
class WorkingTreeNotRevision(BzrError):
 
1585
 
 
1586
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1587
            " the last commit, but weave merge requires that it be"
 
1588
            " unchanged")
 
1589
 
710
1590
    def __init__(self, tree):
711
 
        BzrError.__init__(self, "The working tree for %s has changed since"
712
 
                          " last commit, but weave merge requires that it be"
713
 
                          " unchanged." % tree.basedir)
714
 
 
715
 
 
716
 
class CantReprocessAndShowBase(BzrNewError):
717
 
    """Can't reprocess and show base.
718
 
Reprocessing obscures relationship of conflicting lines to base."""
719
 
 
720
 
 
721
 
class GraphCycleError(BzrNewError):
722
 
    """Cycle in graph %(graph)r"""
 
1591
        BzrError.__init__(self, basedir=tree.basedir)
 
1592
 
 
1593
 
 
1594
class CantReprocessAndShowBase(BzrError):
 
1595
 
 
1596
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1597
           "the relationship of conflicting lines to the base")
 
1598
 
 
1599
 
 
1600
class GraphCycleError(BzrError):
 
1601
 
 
1602
    _fmt = "Cycle in graph %(graph)r"
 
1603
 
723
1604
    def __init__(self, graph):
724
 
        BzrNewError.__init__(self)
 
1605
        BzrError.__init__(self)
725
1606
        self.graph = graph
726
1607
 
727
1608
 
728
 
class NotConflicted(BzrNewError):
729
 
    """File %(filename)s is not conflicted."""
 
1609
class WritingCompleted(InternalBzrError):
 
1610
 
 
1611
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1612
            "called upon it - accept bytes may not be called anymore.")
 
1613
 
 
1614
    def __init__(self, request):
 
1615
        self.request = request
 
1616
 
 
1617
 
 
1618
class WritingNotComplete(InternalBzrError):
 
1619
 
 
1620
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1621
            "called upon it - until the write phase is complete no "
 
1622
            "data may be read.")
 
1623
 
 
1624
    def __init__(self, request):
 
1625
        self.request = request
 
1626
 
 
1627
 
 
1628
class NotConflicted(BzrError):
 
1629
 
 
1630
    _fmt = "File %(filename)s is not conflicted."
730
1631
 
731
1632
    def __init__(self, filename):
732
 
        BzrNewError.__init__(self)
 
1633
        BzrError.__init__(self)
733
1634
        self.filename = filename
734
1635
 
735
1636
 
 
1637
class MediumNotConnected(InternalBzrError):
 
1638
 
 
1639
    _fmt = """The medium '%(medium)s' is not connected."""
 
1640
 
 
1641
    def __init__(self, medium):
 
1642
        self.medium = medium
 
1643
 
 
1644
 
736
1645
class MustUseDecorated(Exception):
737
 
    """A decorating function has requested its original command be used.
738
 
    
739
 
    This should never escape bzr, so does not need to be printable.
740
 
    """
741
 
 
742
 
 
743
 
class MissingText(BzrNewError):
744
 
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
1646
 
 
1647
    _fmt = "A decorating function has requested its original command be used."
 
1648
 
 
1649
 
 
1650
class NoBundleFound(BzrError):
 
1651
 
 
1652
    _fmt = 'No bundle was found in "%(filename)s".'
 
1653
 
 
1654
    def __init__(self, filename):
 
1655
        BzrError.__init__(self)
 
1656
        self.filename = filename
 
1657
 
 
1658
 
 
1659
class BundleNotSupported(BzrError):
 
1660
 
 
1661
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1662
 
 
1663
    def __init__(self, version, msg):
 
1664
        BzrError.__init__(self)
 
1665
        self.version = version
 
1666
        self.msg = msg
 
1667
 
 
1668
 
 
1669
class MissingText(BzrError):
 
1670
 
 
1671
    _fmt = ("Branch %(base)s is missing revision"
 
1672
            " %(text_revision)s of %(file_id)s")
745
1673
 
746
1674
    def __init__(self, branch, text_revision, file_id):
747
 
        BzrNewError.__init__(self)
 
1675
        BzrError.__init__(self)
748
1676
        self.branch = branch
749
1677
        self.base = branch.base
750
1678
        self.text_revision = text_revision
751
1679
        self.file_id = file_id
752
1680
 
753
1681
 
754
 
class DuplicateKey(BzrNewError):
755
 
    """Key %(key)s is already present in map"""
756
 
 
757
 
 
758
 
class MalformedTransform(BzrNewError):
759
 
    """Tree transform is malformed %(conflicts)r"""
760
 
 
761
 
 
762
 
class BzrBadParameter(BzrNewError):
763
 
    """A bad parameter : %(param)s is not usable.
764
 
    
765
 
    This exception should never be thrown, but it is a base class for all
766
 
    parameter-to-function errors.
767
 
    """
 
1682
class DuplicateFileId(BzrError):
 
1683
 
 
1684
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1685
 
 
1686
    def __init__(self, file_id, entry):
 
1687
        BzrError.__init__(self)
 
1688
        self.file_id = file_id
 
1689
        self.entry = entry
 
1690
 
 
1691
 
 
1692
class DuplicateKey(BzrError):
 
1693
 
 
1694
    _fmt = "Key %(key)s is already present in map"
 
1695
 
 
1696
 
 
1697
class DuplicateHelpPrefix(BzrError):
 
1698
 
 
1699
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1700
 
 
1701
    def __init__(self, prefix):
 
1702
        self.prefix = prefix
 
1703
 
 
1704
 
 
1705
class MalformedTransform(BzrError):
 
1706
 
 
1707
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1708
 
 
1709
 
 
1710
class NoFinalPath(BzrError):
 
1711
 
 
1712
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1713
            "file-id: %(file_id)r\n"
 
1714
            "root trans-id: %(root_trans_id)r\n")
 
1715
 
 
1716
    def __init__(self, trans_id, transform):
 
1717
        self.trans_id = trans_id
 
1718
        self.file_id = transform.final_file_id(trans_id)
 
1719
        self.root_trans_id = transform.root
 
1720
 
 
1721
 
 
1722
class BzrBadParameter(InternalBzrError):
 
1723
 
 
1724
    _fmt = "Bad parameter: %(param)r"
 
1725
 
 
1726
    # This exception should never be thrown, but it is a base class for all
 
1727
    # parameter-to-function errors.
 
1728
 
768
1729
    def __init__(self, param):
769
 
        BzrNewError.__init__(self)
 
1730
        BzrError.__init__(self)
770
1731
        self.param = param
771
1732
 
772
1733
 
773
1734
class BzrBadParameterNotUnicode(BzrBadParameter):
774
 
    """Parameter %(param)s is neither unicode nor utf8."""
775
 
 
776
 
 
777
 
class ReusingTransform(BzrNewError):
778
 
    """Attempt to reuse a transform that has already been applied."""
779
 
 
780
 
 
781
 
class CantMoveRoot(BzrNewError):
782
 
    """Moving the root directory is not supported at this time"""
 
1735
 
 
1736
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1737
 
 
1738
 
 
1739
class ReusingTransform(BzrError):
 
1740
 
 
1741
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1742
 
 
1743
 
 
1744
class CantMoveRoot(BzrError):
 
1745
 
 
1746
    _fmt = "Moving the root directory is not supported at this time"
 
1747
 
 
1748
 
 
1749
class BzrMoveFailedError(BzrError):
 
1750
 
 
1751
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1752
 
 
1753
    def __init__(self, from_path='', to_path='', extra=None):
 
1754
        BzrError.__init__(self)
 
1755
        if extra:
 
1756
            self.extra = ': ' + str(extra)
 
1757
        else:
 
1758
            self.extra = ''
 
1759
 
 
1760
        has_from = len(from_path) > 0
 
1761
        has_to = len(to_path) > 0
 
1762
        if has_from:
 
1763
            self.from_path = osutils.splitpath(from_path)[-1]
 
1764
        else:
 
1765
            self.from_path = ''
 
1766
 
 
1767
        if has_to:
 
1768
            self.to_path = osutils.splitpath(to_path)[-1]
 
1769
        else:
 
1770
            self.to_path = ''
 
1771
 
 
1772
        self.operator = ""
 
1773
        if has_from and has_to:
 
1774
            self.operator = " =>"
 
1775
        elif has_from:
 
1776
            self.from_path = "from " + from_path
 
1777
        elif has_to:
 
1778
            self.operator = "to"
 
1779
        else:
 
1780
            self.operator = "file"
 
1781
 
 
1782
 
 
1783
class BzrRenameFailedError(BzrMoveFailedError):
 
1784
 
 
1785
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1786
 
 
1787
    def __init__(self, from_path, to_path, extra=None):
 
1788
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1789
 
 
1790
class BzrRemoveChangedFilesError(BzrError):
 
1791
    """Used when user is trying to remove changed files."""
 
1792
 
 
1793
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1794
        "%(changes_as_text)s"
 
1795
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1796
 
 
1797
    def __init__(self, tree_delta):
 
1798
        BzrError.__init__(self)
 
1799
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1800
        #self.paths_as_string = '\n'.join(changed_files)
 
1801
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
783
1802
 
784
1803
 
785
1804
class BzrBadParameterNotString(BzrBadParameter):
786
 
    """Parameter %(param)s is not a string or unicode string."""
 
1805
 
 
1806
    _fmt = "Parameter %(param)s is not a string or unicode string."
787
1807
 
788
1808
 
789
1809
class BzrBadParameterMissing(BzrBadParameter):
790
 
    """Parameter $(param)s is required but not present."""
 
1810
 
 
1811
    _fmt = "Parameter $(param)s is required but not present."
791
1812
 
792
1813
 
793
1814
class BzrBadParameterUnicode(BzrBadParameter):
794
 
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
1815
 
 
1816
    _fmt = ("Parameter %(param)s is unicode but"
 
1817
            " only byte-strings are permitted.")
795
1818
 
796
1819
 
797
1820
class BzrBadParameterContainsNewline(BzrBadParameter):
798
 
    """Parameter %(param)s contains a newline."""
799
 
 
800
 
 
801
 
class DependencyNotPresent(BzrNewError):
802
 
    """Unable to import library "%(library)s": %(error)s"""
 
1821
 
 
1822
    _fmt = "Parameter %(param)s contains a newline."
 
1823
 
 
1824
 
 
1825
class DependencyNotPresent(BzrError):
 
1826
 
 
1827
    _fmt = 'Unable to import library "%(library)s": %(error)s'
803
1828
 
804
1829
    def __init__(self, library, error):
805
 
        BzrNewError.__init__(self, library=library, error=error)
 
1830
        BzrError.__init__(self, library=library, error=error)
806
1831
 
807
1832
 
808
1833
class ParamikoNotPresent(DependencyNotPresent):
809
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
1834
 
 
1835
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
810
1836
 
811
1837
    def __init__(self, error):
812
1838
        DependencyNotPresent.__init__(self, 'paramiko', error)
813
1839
 
814
1840
 
815
 
class UninitializableFormat(BzrNewError):
816
 
    """Format %(format)s cannot be initialised by this version of bzr."""
 
1841
class PointlessMerge(BzrError):
 
1842
 
 
1843
    _fmt = "Nothing to merge."
 
1844
 
 
1845
 
 
1846
class UninitializableFormat(BzrError):
 
1847
 
 
1848
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
817
1849
 
818
1850
    def __init__(self, format):
819
 
        BzrNewError.__init__(self)
820
 
        self.format = format
821
 
 
822
 
 
823
 
class NoDiff3(BzrNewError):
824
 
    """Diff3 is not installed on this machine."""
825
 
 
826
 
 
827
 
class ExistingLimbo(BzrNewError):
828
 
    """This tree contains left-over files from a failed operation.
829
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
830
 
    keep, and delete it when you are done.
831
 
    """
832
 
    def __init__(self, limbo_dir):
833
 
       BzrNewError.__init__(self)
834
 
       self.limbo_dir = limbo_dir
835
 
 
836
 
 
837
 
class ImmortalLimbo(BzrNewError):
838
 
    """Unable to delete transform temporary directory $(limbo_dir)s.
839
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
840
 
    keep, and delete it when you are done.
841
 
    """
842
 
    def __init__(self, limbo_dir):
843
 
       BzrNewError.__init__(self)
844
 
       self.limbo_dir = limbo_dir
845
 
 
846
 
 
847
 
class OutOfDateTree(BzrNewError):
848
 
    """Working tree is out of date, please run 'bzr update'."""
 
1851
        BzrError.__init__(self)
 
1852
        self.format = format
 
1853
 
 
1854
 
 
1855
class BadConversionTarget(BzrError):
 
1856
 
 
1857
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1858
 
 
1859
    def __init__(self, problem, format):
 
1860
        BzrError.__init__(self)
 
1861
        self.problem = problem
 
1862
        self.format = format
 
1863
 
 
1864
 
 
1865
class NoDiffFound(BzrError):
 
1866
 
 
1867
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
1868
 
 
1869
    def __init__(self, path):
 
1870
        BzrError.__init__(self, path)
 
1871
 
 
1872
 
 
1873
class ExecutableMissing(BzrError):
 
1874
 
 
1875
    _fmt = "%(exe_name)s could not be found on this machine"
 
1876
 
 
1877
    def __init__(self, exe_name):
 
1878
        BzrError.__init__(self, exe_name=exe_name)
 
1879
 
 
1880
 
 
1881
class NoDiff(BzrError):
 
1882
 
 
1883
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1884
 
 
1885
    def __init__(self, msg):
 
1886
        BzrError.__init__(self, msg=msg)
 
1887
 
 
1888
 
 
1889
class NoDiff3(BzrError):
 
1890
 
 
1891
    _fmt = "Diff3 is not installed on this machine."
 
1892
 
 
1893
 
 
1894
class ExistingContent(BzrError):
 
1895
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
1896
 
 
1897
    _fmt = "The content being inserted is already present."
 
1898
 
 
1899
 
 
1900
class ExistingLimbo(BzrError):
 
1901
 
 
1902
    _fmt = """This tree contains left-over files from a failed operation.
 
1903
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1904
    keep, and delete it when you are done."""
 
1905
    
 
1906
    def __init__(self, limbo_dir):
 
1907
       BzrError.__init__(self)
 
1908
       self.limbo_dir = limbo_dir
 
1909
 
 
1910
 
 
1911
class ExistingPendingDeletion(BzrError):
 
1912
 
 
1913
    _fmt = """This tree contains left-over files from a failed operation.
 
1914
    Please examine %(pending_deletion)s to see if it contains any files you
 
1915
    wish to keep, and delete it when you are done."""
 
1916
 
 
1917
    def __init__(self, pending_deletion):
 
1918
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1919
 
 
1920
 
 
1921
class ImmortalLimbo(BzrError):
 
1922
 
 
1923
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1924
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1925
    keep, and delete it when you are done."""
 
1926
 
 
1927
    def __init__(self, limbo_dir):
 
1928
       BzrError.__init__(self)
 
1929
       self.limbo_dir = limbo_dir
 
1930
 
 
1931
 
 
1932
class ImmortalPendingDeletion(BzrError):
 
1933
 
 
1934
    _fmt = ("Unable to delete transform temporary directory "
 
1935
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
1936
    "contains any files you wish to keep, and delete it when you are done.")
 
1937
 
 
1938
    def __init__(self, pending_deletion):
 
1939
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1940
 
 
1941
 
 
1942
class OutOfDateTree(BzrError):
 
1943
 
 
1944
    _fmt = "Working tree is out of date, please run 'bzr update'."
849
1945
 
850
1946
    def __init__(self, tree):
851
 
        BzrNewError.__init__(self)
 
1947
        BzrError.__init__(self)
852
1948
        self.tree = tree
853
1949
 
854
1950
 
855
 
class MergeModifiedFormatError(BzrNewError):
856
 
    """Error in merge modified format"""
857
 
 
858
 
 
859
 
class ConflictFormatError(BzrNewError):
860
 
    """Format error in conflict listings"""
861
 
 
862
 
 
863
 
class CorruptRepository(BzrNewError):
864
 
    """An error has been detected in the repository %(repo_path)s.
865
 
Please run bzr reconcile on this repository."""
 
1951
class PublicBranchOutOfDate(BzrError):
 
1952
 
 
1953
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1954
        '"%(revstring)s".'
 
1955
 
 
1956
    def __init__(self, public_location, revstring):
 
1957
        import bzrlib.urlutils as urlutils
 
1958
        public_location = urlutils.unescape_for_display(public_location,
 
1959
                                                        'ascii')
 
1960
        BzrError.__init__(self, public_location=public_location,
 
1961
                          revstring=revstring)
 
1962
 
 
1963
 
 
1964
class MergeModifiedFormatError(BzrError):
 
1965
 
 
1966
    _fmt = "Error in merge modified format"
 
1967
 
 
1968
 
 
1969
class ConflictFormatError(BzrError):
 
1970
 
 
1971
    _fmt = "Format error in conflict listings"
 
1972
 
 
1973
 
 
1974
class CorruptRepository(BzrError):
 
1975
 
 
1976
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1977
            "Please run bzr reconcile on this repository.")
866
1978
 
867
1979
    def __init__(self, repo):
868
 
        BzrNewError.__init__(self)
 
1980
        BzrError.__init__(self)
869
1981
        self.repo_path = repo.bzrdir.root_transport.base
870
1982
 
871
1983
 
872
 
class UpgradeRequired(BzrNewError):
873
 
    """To use this feature you must upgrade your branch at %(path)s."""
 
1984
class UpgradeRequired(BzrError):
 
1985
 
 
1986
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
874
1987
 
875
1988
    def __init__(self, path):
876
 
        BzrNewError.__init__(self)
 
1989
        BzrError.__init__(self)
877
1990
        self.path = path
878
1991
 
879
1992
 
880
 
class LocalRequiresBoundBranch(BzrNewError):
881
 
    """Cannot perform local-only commits on unbound branches."""
882
 
 
883
 
 
884
 
class MissingProgressBarFinish(BzrNewError):
885
 
    """A nested progress bar was not 'finished' correctly."""
886
 
 
887
 
 
888
 
class UnsupportedOperation(BzrNewError):
889
 
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
1993
class LocalRequiresBoundBranch(BzrError):
 
1994
 
 
1995
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1996
 
 
1997
 
 
1998
class MissingProgressBarFinish(BzrError):
 
1999
 
 
2000
    _fmt = "A nested progress bar was not 'finished' correctly."
 
2001
 
 
2002
 
 
2003
class InvalidProgressBarType(BzrError):
 
2004
 
 
2005
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
2006
            " is not a supported type Select one of: %(valid_types)s")
 
2007
 
 
2008
    def __init__(self, bar_type, valid_types):
 
2009
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
2010
 
 
2011
 
 
2012
class UnsupportedOperation(BzrError):
 
2013
 
 
2014
    _fmt = ("The method %(mname)s is not supported on"
 
2015
            " objects of type %(tname)s.")
 
2016
 
890
2017
    def __init__(self, method, method_self):
891
2018
        self.method = method
892
2019
        self.mname = method.__name__
893
2020
        self.tname = type(method_self).__name__
894
2021
 
895
2022
 
896
 
class BinaryFile(BzrNewError):
897
 
    """File is binary but should be text."""
898
 
 
899
 
 
900
 
class IllegalPath(BzrNewError):
901
 
    """The path %(path)s is not permitted on this platform"""
 
2023
class CannotSetRevisionId(UnsupportedOperation):
 
2024
    """Raised when a commit is attempting to set a revision id but cant."""
 
2025
 
 
2026
 
 
2027
class NonAsciiRevisionId(UnsupportedOperation):
 
2028
    """Raised when a commit is attempting to set a non-ascii revision id
 
2029
       but cant.
 
2030
    """
 
2031
 
 
2032
 
 
2033
class BinaryFile(BzrError):
 
2034
    
 
2035
    _fmt = "File is binary but should be text."
 
2036
 
 
2037
 
 
2038
class IllegalPath(BzrError):
 
2039
 
 
2040
    _fmt = "The path %(path)s is not permitted on this platform"
902
2041
 
903
2042
    def __init__(self, path):
904
 
        BzrNewError.__init__(self)
 
2043
        BzrError.__init__(self)
905
2044
        self.path = path
 
2045
 
 
2046
 
 
2047
class TestamentMismatch(BzrError):
 
2048
 
 
2049
    _fmt = """Testament did not match expected value.
 
2050
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2051
       {%(measured)s}"""
 
2052
 
 
2053
    def __init__(self, revision_id, expected, measured):
 
2054
        self.revision_id = revision_id
 
2055
        self.expected = expected
 
2056
        self.measured = measured
 
2057
 
 
2058
 
 
2059
class NotABundle(BzrError):
 
2060
    
 
2061
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2062
 
 
2063
    def __init__(self, text):
 
2064
        BzrError.__init__(self)
 
2065
        self.text = text
 
2066
 
 
2067
 
 
2068
class BadBundle(BzrError): 
 
2069
    
 
2070
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2071
 
 
2072
    def __init__(self, text):
 
2073
        BzrError.__init__(self)
 
2074
        self.text = text
 
2075
 
 
2076
 
 
2077
class MalformedHeader(BadBundle): 
 
2078
    
 
2079
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2080
 
 
2081
 
 
2082
class MalformedPatches(BadBundle): 
 
2083
    
 
2084
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2085
 
 
2086
 
 
2087
class MalformedFooter(BadBundle): 
 
2088
    
 
2089
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2090
 
 
2091
 
 
2092
class UnsupportedEOLMarker(BadBundle):
 
2093
    
 
2094
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
2095
 
 
2096
    def __init__(self):
 
2097
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
2098
        # but for this there is not
 
2099
        BzrError.__init__(self)
 
2100
 
 
2101
 
 
2102
class IncompatibleBundleFormat(BzrError):
 
2103
    
 
2104
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2105
 
 
2106
    def __init__(self, bundle_format, other):
 
2107
        BzrError.__init__(self)
 
2108
        self.bundle_format = bundle_format
 
2109
        self.other = other
 
2110
 
 
2111
 
 
2112
class BadInventoryFormat(BzrError):
 
2113
    
 
2114
    _fmt = "Root class for inventory serialization errors"
 
2115
 
 
2116
 
 
2117
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2118
 
 
2119
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2120
 
 
2121
    def __init__(self, msg):
 
2122
        BadInventoryFormat.__init__(self, msg=msg)
 
2123
 
 
2124
 
 
2125
class RootNotRich(BzrError):
 
2126
 
 
2127
    _fmt = """This operation requires rich root data storage"""
 
2128
 
 
2129
 
 
2130
class NoSmartMedium(InternalBzrError):
 
2131
 
 
2132
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2133
 
 
2134
    def __init__(self, transport):
 
2135
        self.transport = transport
 
2136
 
 
2137
 
 
2138
class NoSmartServer(NotBranchError):
 
2139
 
 
2140
    _fmt = "No smart server available at %(url)s"
 
2141
 
 
2142
    def __init__(self, url):
 
2143
        self.url = url
 
2144
 
 
2145
 
 
2146
class UnknownSSH(BzrError):
 
2147
 
 
2148
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2149
 
 
2150
    def __init__(self, vendor):
 
2151
        BzrError.__init__(self)
 
2152
        self.vendor = vendor
 
2153
 
 
2154
 
 
2155
class SSHVendorNotFound(BzrError):
 
2156
 
 
2157
    _fmt = ("Don't know how to handle SSH connections."
 
2158
            " Please set BZR_SSH environment variable.")
 
2159
 
 
2160
 
 
2161
class GhostRevisionUnusableHere(BzrError):
 
2162
 
 
2163
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2164
 
 
2165
    def __init__(self, revision_id):
 
2166
        BzrError.__init__(self)
 
2167
        self.revision_id = revision_id
 
2168
 
 
2169
 
 
2170
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2171
 
 
2172
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2173
            " %(msg)s%(extra)s")
 
2174
 
 
2175
    def __init__(self, name, msg, extra=None):
 
2176
        BzrError.__init__(self)
 
2177
        self.name = name
 
2178
        self.msg = msg
 
2179
        if extra:
 
2180
            self.extra = ': ' + str(extra)
 
2181
        else:
 
2182
            self.extra = ''
 
2183
 
 
2184
 
 
2185
class InvalidImportLine(InternalBzrError):
 
2186
 
 
2187
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2188
 
 
2189
    def __init__(self, text, msg):
 
2190
        BzrError.__init__(self)
 
2191
        self.text = text
 
2192
        self.msg = msg
 
2193
 
 
2194
 
 
2195
class ImportNameCollision(InternalBzrError):
 
2196
 
 
2197
    _fmt = ("Tried to import an object to the same name as"
 
2198
            " an existing object. %(name)s")
 
2199
 
 
2200
    def __init__(self, name):
 
2201
        BzrError.__init__(self)
 
2202
        self.name = name
 
2203
 
 
2204
 
 
2205
class NotAMergeDirective(BzrError):
 
2206
    """File starting with %(firstline)r is not a merge directive"""
 
2207
    def __init__(self, firstline):
 
2208
        BzrError.__init__(self, firstline=firstline)
 
2209
 
 
2210
 
 
2211
class NoMergeSource(BzrError):
 
2212
    """Raise if no merge source was specified for a merge directive"""
 
2213
 
 
2214
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2215
        " branch location."
 
2216
 
 
2217
 
 
2218
class IllegalMergeDirectivePayload(BzrError):
 
2219
    """A merge directive contained something other than a patch or bundle"""
 
2220
 
 
2221
    _fmt = "Bad merge directive payload %(start)r"
 
2222
 
 
2223
    def __init__(self, start):
 
2224
        BzrError(self)
 
2225
        self.start = start
 
2226
 
 
2227
 
 
2228
class PatchVerificationFailed(BzrError):
 
2229
    """A patch from a merge directive could not be verified"""
 
2230
 
 
2231
    _fmt = "Preview patch does not match requested changes."
 
2232
 
 
2233
 
 
2234
class PatchMissing(BzrError):
 
2235
    """Raise a patch type was specified but no patch supplied"""
 
2236
 
 
2237
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2238
 
 
2239
    def __init__(self, patch_type):
 
2240
        BzrError.__init__(self)
 
2241
        self.patch_type = patch_type
 
2242
 
 
2243
 
 
2244
class UnsupportedInventoryKind(BzrError):
 
2245
    
 
2246
    _fmt = """Unsupported entry kind %(kind)s"""
 
2247
 
 
2248
    def __init__(self, kind):
 
2249
        self.kind = kind
 
2250
 
 
2251
 
 
2252
class BadSubsumeSource(BzrError):
 
2253
 
 
2254
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2255
 
 
2256
    def __init__(self, tree, other_tree, reason):
 
2257
        self.tree = tree
 
2258
        self.other_tree = other_tree
 
2259
        self.reason = reason
 
2260
 
 
2261
 
 
2262
class SubsumeTargetNeedsUpgrade(BzrError):
 
2263
    
 
2264
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2265
 
 
2266
    def __init__(self, other_tree):
 
2267
        self.other_tree = other_tree
 
2268
 
 
2269
 
 
2270
class BadReferenceTarget(InternalBzrError):
 
2271
 
 
2272
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2273
           "%(reason)s"
 
2274
 
 
2275
    def __init__(self, tree, other_tree, reason):
 
2276
        self.tree = tree
 
2277
        self.other_tree = other_tree
 
2278
        self.reason = reason
 
2279
 
 
2280
 
 
2281
class NoSuchTag(BzrError):
 
2282
 
 
2283
    _fmt = "No such tag: %(tag_name)s"
 
2284
 
 
2285
    def __init__(self, tag_name):
 
2286
        self.tag_name = tag_name
 
2287
 
 
2288
 
 
2289
class TagsNotSupported(BzrError):
 
2290
 
 
2291
    _fmt = ("Tags not supported by %(branch)s;"
 
2292
            " you may be able to use bzr upgrade --dirstate-tags.")
 
2293
 
 
2294
    def __init__(self, branch):
 
2295
        self.branch = branch
 
2296
 
 
2297
        
 
2298
class TagAlreadyExists(BzrError):
 
2299
 
 
2300
    _fmt = "Tag %(tag_name)s already exists."
 
2301
 
 
2302
    def __init__(self, tag_name):
 
2303
        self.tag_name = tag_name
 
2304
 
 
2305
 
 
2306
class MalformedBugIdentifier(BzrError):
 
2307
 
 
2308
    _fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
 
2309
 
 
2310
    def __init__(self, bug_id, reason):
 
2311
        self.bug_id = bug_id
 
2312
        self.reason = reason
 
2313
 
 
2314
 
 
2315
class InvalidBugTrackerURL(BzrError):
 
2316
 
 
2317
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2318
            "contain {id}: %(url)s")
 
2319
 
 
2320
    def __init__(self, abbreviation, url):
 
2321
        self.abbreviation = abbreviation
 
2322
        self.url = url
 
2323
 
 
2324
 
 
2325
class UnknownBugTrackerAbbreviation(BzrError):
 
2326
 
 
2327
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2328
            "on %(branch)s")
 
2329
 
 
2330
    def __init__(self, abbreviation, branch):
 
2331
        self.abbreviation = abbreviation
 
2332
        self.branch = branch
 
2333
 
 
2334
 
 
2335
class UnexpectedSmartServerResponse(BzrError):
 
2336
 
 
2337
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2338
 
 
2339
    def __init__(self, response_tuple):
 
2340
        self.response_tuple = response_tuple
 
2341
 
 
2342
 
 
2343
class ContainerError(BzrError):
 
2344
    """Base class of container errors."""
 
2345
 
 
2346
 
 
2347
class UnknownContainerFormatError(ContainerError):
 
2348
 
 
2349
    _fmt = "Unrecognised container format: %(container_format)r"
 
2350
    
 
2351
    def __init__(self, container_format):
 
2352
        self.container_format = container_format
 
2353
 
 
2354
 
 
2355
class UnexpectedEndOfContainerError(ContainerError):
 
2356
 
 
2357
    _fmt = "Unexpected end of container stream"
 
2358
 
 
2359
 
 
2360
class UnknownRecordTypeError(ContainerError):
 
2361
 
 
2362
    _fmt = "Unknown record type: %(record_type)r"
 
2363
 
 
2364
    def __init__(self, record_type):
 
2365
        self.record_type = record_type
 
2366
 
 
2367
 
 
2368
class InvalidRecordError(ContainerError):
 
2369
 
 
2370
    _fmt = "Invalid record: %(reason)s"
 
2371
 
 
2372
    def __init__(self, reason):
 
2373
        self.reason = reason
 
2374
 
 
2375
 
 
2376
class ContainerHasExcessDataError(ContainerError):
 
2377
 
 
2378
    _fmt = "Container has data after end marker: %(excess)r"
 
2379
 
 
2380
    def __init__(self, excess):
 
2381
        self.excess = excess
 
2382
 
 
2383
 
 
2384
class DuplicateRecordNameError(ContainerError):
 
2385
 
 
2386
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2387
 
 
2388
    def __init__(self, name):
 
2389
        self.name = name
 
2390
 
 
2391
 
 
2392
class NoDestinationAddress(InternalBzrError):
 
2393
 
 
2394
    _fmt = "Message does not have a destination address."
 
2395
 
 
2396
 
 
2397
class RepositoryDataStreamError(BzrError):
 
2398
 
 
2399
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2400
 
 
2401
    def __init__(self, reason):
 
2402
        self.reason = reason
 
2403
 
 
2404
 
 
2405
class SMTPError(BzrError):
 
2406
 
 
2407
    _fmt = "SMTP error: %(error)s"
 
2408
 
 
2409
    def __init__(self, error):
 
2410
        self.error = error
 
2411
 
 
2412
 
 
2413
class NoMessageSupplied(BzrError):
 
2414
 
 
2415
    _fmt = "No message supplied."
 
2416
 
 
2417
 
 
2418
class NoMailAddressSpecified(BzrError):
 
2419
 
 
2420
    _fmt = "No mail-to address specified."
 
2421
 
 
2422
 
 
2423
class UnknownMailClient(BzrError):
 
2424
 
 
2425
    _fmt = "Unknown mail client: %(mail_client)s"
 
2426
 
 
2427
    def __init__(self, mail_client):
 
2428
        BzrError.__init__(self, mail_client=mail_client)
 
2429
 
 
2430
 
 
2431
class MailClientNotFound(BzrError):
 
2432
 
 
2433
    _fmt = "Unable to find mail client with the following names:"\
 
2434
        " %(mail_command_list_string)s"
 
2435
 
 
2436
    def __init__(self, mail_command_list):
 
2437
        mail_command_list_string = ', '.join(mail_command_list)
 
2438
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2439
                          mail_command_list_string=mail_command_list_string)
 
2440
 
 
2441
class SMTPConnectionRefused(SMTPError):
 
2442
 
 
2443
    _fmt = "SMTP connection to %(host)s refused"
 
2444
 
 
2445
    def __init__(self, error, host):
 
2446
        self.error = error
 
2447
        self.host = host
 
2448
 
 
2449
 
 
2450
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2451
 
 
2452
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2453
 
 
2454
 
 
2455
class BzrDirError(BzrError):
 
2456
 
 
2457
    def __init__(self, bzrdir):
 
2458
        import bzrlib.urlutils as urlutils
 
2459
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2460
                                                    'ascii')
 
2461
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2462
 
 
2463
 
 
2464
class AlreadyBranch(BzrDirError):
 
2465
 
 
2466
    _fmt = "'%(display_url)s' is already a branch."
 
2467
 
 
2468
 
 
2469
class AlreadyTree(BzrDirError):
 
2470
 
 
2471
    _fmt = "'%(display_url)s' is already a tree."
 
2472
 
 
2473
 
 
2474
class AlreadyCheckout(BzrDirError):
 
2475
 
 
2476
    _fmt = "'%(display_url)s' is already a checkout."
 
2477
 
 
2478
 
 
2479
class AlreadyLightweightCheckout(BzrDirError):
 
2480
 
 
2481
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2482
 
 
2483
 
 
2484
class ReconfigurationNotSupported(BzrDirError):
 
2485
 
 
2486
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2487
 
 
2488
 
 
2489
class NoBindLocation(BzrDirError):
 
2490
 
 
2491
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2492
 
 
2493
 
 
2494
class UncommittedChanges(BzrError):
 
2495
 
 
2496
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2497
 
 
2498
    def __init__(self, tree):
 
2499
        import bzrlib.urlutils as urlutils
 
2500
        display_url = urlutils.unescape_for_display(
 
2501
            tree.bzrdir.root_transport.base, 'ascii')
 
2502
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2503
 
 
2504
 
 
2505
class MissingTemplateVariable(BzrError):
 
2506
 
 
2507
    _fmt = 'Variable {%(name)s} is not available.'
 
2508
 
 
2509
    def __init__(self, name):
 
2510
        self.name = name
 
2511
 
 
2512
 
 
2513
class UnableCreateSymlink(BzrError):
 
2514
 
 
2515
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2516
 
 
2517
    def __init__(self, path=None):
 
2518
        path_str = ''
 
2519
        if path:
 
2520
            try:
 
2521
                path_str = repr(str(path))
 
2522
            except UnicodeEncodeError:
 
2523
                path_str = repr(path)
 
2524
            path_str += ' '
 
2525
        self.path_str = path_str
 
2526
 
 
2527
 
 
2528
class UnsupportedTimezoneFormat(BzrError):
 
2529
 
 
2530
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2531
            'options are "utc", "original", "local".')
 
2532
 
 
2533
    def __init__(self, timezone):
 
2534
        self.timezone = timezone