~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: 2007-02-01 23:48:08 UTC
  • mfrom: (2225.1.6 revert)
  • Revision ID: pqm@pqm.ubuntu.com-20070201234808-3b1302d73474bd8c
Display changes made by revert

Show diffs side-by-side

added added

removed removed

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