/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Alexander Belchenko
  • Date: 2007-10-26 21:49:15 UTC
  • mto: (2947.4.2 0.92)
  • mto: This revision was merged to the branch mainline in revision 2971.
  • Revision ID: bialix@ukr.net-20071026214915-5eacqh9k2ps6jagj
windows python-based installer: shortcut for uninstall action

Show diffs side-by-side

added added

removed removed

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