~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-17 07:52:09 UTC
  • mfrom: (1910.3.4 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20060817075209-e85a1f9e05ff8b87
(andrew) Trivial fixes to NotImplemented errors.

Show diffs side-by-side

added added

removed removed

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