~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-04-17 08:04:15 UTC
  • mfrom: (2423.1.2 benchmarks)
  • Revision ID: pqm@pqm.ubuntu.com-20070417080415-5vn25svmf95ki88z
Also clear SmartTCPServer hooks from TestCase._clear_hooks

Show diffs side-by-side

added added

removed removed

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