/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-04-19 05:21:37 UTC
  • mto: (2425.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 2427.
  • Revision ID: robertc@robertcollins.net-20070419052137-vsncwlmi8epl5eel
Update existing builtin commands help text to use _see_also. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
18
 
 
19
 
Exceptions are caught at a high level to report errors to the user, and
20
 
might also be caught inside the program.  Therefore it needs to be
21
 
possible to convert them to a meaningful string, and also for them to be
22
 
interrogated by the program.
23
 
 
24
 
Exceptions are defined such that the arguments given to the constructor
25
 
are stored in the object as properties of the same name.  When the
26
 
object is printed as a string, the doc string of the class is used as
27
 
a format string with the property dictionary available to it.
28
 
 
29
 
This means that exceptions can used like this:
30
 
 
31
 
>>> import sys
32
 
>>> try:
33
 
...   raise NotBranchError(path='/foo/bar')
34
 
... except:
35
 
...   print sys.exc_type
36
 
...   print sys.exc_value
37
 
...   path = getattr(sys.exc_value, 'path')
38
 
...   if path is not None:
39
 
...     print path
40
 
bzrlib.errors.NotBranchError
41
 
Not a branch: /foo/bar
42
 
/foo/bar
43
 
 
44
 
Therefore:
45
 
 
46
 
 * create a new exception class for any class of error that can be
47
 
   usefully distinguished.
48
 
 
49
 
 * the printable form of an exception is generated by the base class
50
 
   __str__ method
51
 
 
52
 
Exception strings should start with a capital letter and not have a final
53
 
fullstop.
54
18
"""
55
19
 
56
 
from warnings import warn
57
 
 
58
 
# based on Scott James Remnant's hct error classes
 
20
 
 
21
from bzrlib import (
 
22
    osutils,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.patches import (
 
26
    MalformedHunkHeader,
 
27
    MalformedLine,
 
28
    MalformedPatchHeader,
 
29
    PatchConflict,
 
30
    PatchSyntax,
 
31
    )
 
32
 
59
33
 
60
34
# TODO: is there any value in providing the .args field used by standard
61
35
# python exceptions?   A list of values with no names seems less useful 
65
39
# constructed to make sure it will succeed.  But that says nothing about
66
40
# exceptions that are never raised.
67
41
 
68
 
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
69
 
# the old one.
 
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'.
70
45
 
71
46
 
72
47
class BzrError(StandardError):
 
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
 
73
90
    def __str__(self):
74
 
        # XXX: Should we show the exception class in 
75
 
        # exceptions that don't provide their own message?  
76
 
        # maybe it should be done at a higher level
77
 
        ## n = self.__class__.__name__ + ': '
78
 
        n = ''
79
 
        if len(self.args) == 1:
80
 
            return str(self.args[0])
81
 
        elif len(self.args) == 2:
82
 
            # further explanation or suggestions
83
 
            try:
84
 
                return n + '\n  '.join([self.args[0]] + self.args[1])
85
 
            except TypeError:
86
 
                return n + "%r" % self
87
 
        else:
88
 
            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
               )
89
127
 
90
128
 
91
129
class BzrNewError(BzrError):
92
 
    """bzr error"""
 
130
    """Deprecated error base class."""
93
131
    # base classes should override the docstring with their human-
94
132
    # readable explanation
95
133
 
96
 
    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)
97
145
        for key, value in kwds.items():
98
146
            setattr(self, key, value)
99
147
 
100
148
    def __str__(self):
101
149
        try:
102
 
            return self.__doc__ % self.__dict__
103
 
        except (NameError, ValueError, KeyError), e:
104
 
            return 'Unprintable exception %s: %s' \
105
 
                % (self.__class__.__name__, str(e))
106
 
 
107
 
 
108
 
class BzrCheckError(BzrNewError):
109
 
    """Internal check failed: %(message)s"""
 
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
110
172
 
111
173
    def __init__(self, message):
112
 
        BzrNewError.__init__(self)
 
174
        BzrError.__init__(self)
113
175
        self.message = message
114
176
 
115
177
 
116
 
class InvalidEntryName(BzrNewError):
117
 
    """Invalid entry name: %(name)s"""
 
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
 
194
 
118
195
    def __init__(self, name):
119
 
        BzrNewError.__init__(self)
 
196
        BzrError.__init__(self)
120
197
        self.name = name
121
198
 
122
199
 
123
 
class InvalidRevisionNumber(BzrNewError):
124
 
    """Invalid revision number %(revno)d"""
 
200
class InvalidRevisionNumber(BzrError):
 
201
    
 
202
    _fmt = "Invalid revision number %(revno)s"
 
203
 
125
204
    def __init__(self, revno):
126
 
        BzrNewError.__init__(self)
 
205
        BzrError.__init__(self)
127
206
        self.revno = revno
128
207
 
129
208
 
130
 
class InvalidRevisionId(BzrNewError):
131
 
    """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
 
132
213
    def __init__(self, revision_id, branch):
133
 
        BzrNewError.__init__(self)
 
214
        # branch can be any string or object with __str__ defined
 
215
        BzrError.__init__(self)
134
216
        self.revision_id = revision_id
135
217
        self.branch = branch
136
218
 
137
 
 
138
 
class NoWorkingTree(BzrNewError):
139
 
    """No WorkingTree exists for %s(base)."""
 
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."
140
250
    
141
251
    def __init__(self, base):
142
 
        BzrNewError.__init__(self)
 
252
        BzrError.__init__(self)
143
253
        self.base = base
144
254
 
145
255
 
146
 
class NotLocalUrl(BzrNewError):
147
 
    """%s(url) is not a local path."""
148
 
    
 
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
 
149
265
    def __init__(self, url):
150
 
        BzrNewError.__init__(self)
151
266
        self.url = url
152
267
 
153
268
 
 
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
 
154
278
class BzrCommandError(BzrError):
155
 
    # Error from malformed user command
156
 
    # This is being misused as a generic exception
157
 
    # pleae subclass. RBC 20051030
 
279
    """Error from user command"""
 
280
 
 
281
    internal_error = False
 
282
 
 
283
    # Error from malformed user command; please avoid raising this as a
 
284
    # generic exception not caused by user input.
158
285
    #
159
286
    # I think it's a waste of effort to differentiate between errors that
160
287
    # are not intended to be caught anyway.  UI code need not subclass
161
288
    # BzrCommandError, and non-UI code should not throw a subclass of
162
289
    # BzrCommandError.  ADHB 20051211
 
290
    def __init__(self, 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
 
297
 
163
298
    def __str__(self):
164
 
        return self.args[0]
 
299
        return self.msg
 
300
 
 
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
165
308
 
166
309
 
167
310
class BzrOptionError(BzrCommandError):
168
 
    """Some missing or otherwise incorrect option was supplied."""
169
 
 
170
 
    
171
 
class StrictCommitFailed(Exception):
172
 
    """Commit refused because there are unknowns in the tree."""
173
 
 
174
 
 
175
 
class PathError(BzrNewError):
176
 
    """Generic path error: %(path)r%(extra)s)"""
 
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)
 
321
 
 
322
    
 
323
class StrictCommitFailed(BzrError):
 
324
 
 
325
    _fmt = "Commit refused because there are unknown files in the tree"
 
326
 
 
327
 
 
328
# XXX: Should be unified with TransportError; they seem to represent the
 
329
# same thing
 
330
class PathError(BzrError):
 
331
    
 
332
    _fmt = "Generic path error: %(path)r%(extra)s)"
177
333
 
178
334
    def __init__(self, path, extra=None):
179
 
        BzrNewError.__init__(self)
 
335
        BzrError.__init__(self)
180
336
        self.path = path
181
337
        if extra:
182
338
            self.extra = ': ' + str(extra)
185
341
 
186
342
 
187
343
class NoSuchFile(PathError):
188
 
    """No such file: %(path)r%(extra)s"""
 
344
 
 
345
    _fmt = "No such file: %(path)r%(extra)s"
189
346
 
190
347
 
191
348
class FileExists(PathError):
192
 
    """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"
193
377
 
194
378
 
195
379
class DirectoryNotEmpty(PathError):
196
 
    """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
197
394
 
198
395
 
199
396
class ResourceBusy(PathError):
200
 
    """Device or resource busy: %(path)r%(extra)s"""
 
397
 
 
398
    _fmt = "Device or resource busy: %(path)r%(extra)s"
201
399
 
202
400
 
203
401
class PermissionDenied(PathError):
204
 
    """Permission denied: %(path)r%(extra)s"""
205
 
 
206
 
 
207
 
class PathNotChild(BzrNewError):
208
 
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
402
 
 
403
    _fmt = "Permission denied: %(path)r%(extra)s"
 
404
 
 
405
 
 
406
class InvalidURL(PathError):
 
407
 
 
408
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
409
 
 
410
 
 
411
class InvalidURLJoin(PathError):
 
412
 
 
413
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
414
 
 
415
    def __init__(self, msg, base, args):
 
416
        PathError.__init__(self, base, msg)
 
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
 
428
 
 
429
 
 
430
class UnsupportedProtocol(PathError):
 
431
 
 
432
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
433
 
 
434
    def __init__(self, url, extra):
 
435
        PathError.__init__(self, url, extra=extra)
 
436
 
 
437
 
 
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
 
457
 
209
458
    def __init__(self, path, base, extra=None):
210
 
        BzrNewError.__init__(self)
 
459
        BzrError.__init__(self)
211
460
        self.path = path
212
461
        self.base = base
213
462
        if extra:
216
465
            self.extra = ''
217
466
 
218
467
 
 
468
class InvalidNormalization(PathError):
 
469
 
 
470
    _fmt = "Path %(path)r is not unicode normalized"
 
471
 
 
472
 
 
473
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
474
# the exception object is a bit undesirable.
 
475
# TODO: Probably this behavior of should be a common superclass 
219
476
class NotBranchError(PathError):
220
 
    """Not a branch: %(path)s"""
 
477
 
 
478
    _fmt = "Not a branch: %(path)s"
 
479
 
 
480
    def __init__(self, path):
 
481
       import bzrlib.urlutils as urlutils
 
482
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
483
 
 
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')
221
492
 
222
493
 
223
494
class AlreadyBranchError(PathError):
224
 
    """Already a branch: %(path)s. Use `bzr checkout` to build a working tree."""
225
 
 
226
 
 
227
 
class NoRepositoryPresent(BzrNewError):
228
 
    """Not repository present: %(path)r"""
 
495
 
 
496
    _fmt = "Already a branch: %(path)s."
 
497
 
 
498
 
 
499
class BranchExistsWithoutWorkingTree(PathError):
 
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"
 
503
 
 
504
 
 
505
class AtomicFileAlreadyClosed(PathError):
 
506
 
 
507
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
508
            " %(path)s")
 
509
 
 
510
    def __init__(self, path, function):
 
511
        PathError.__init__(self, path=path, extra=None)
 
512
        self.function = function
 
513
 
 
514
 
 
515
class InaccessibleParent(PathError):
 
516
 
 
517
    _fmt = ("Parent not accessible given base %(base)s and"
 
518
            " relative path %(path)s")
 
519
 
 
520
    def __init__(self, path, base):
 
521
        PathError.__init__(self, path)
 
522
        self.base = base
 
523
 
 
524
 
 
525
class NoRepositoryPresent(BzrError):
 
526
 
 
527
    _fmt = "No repository present: %(path)r"
229
528
    def __init__(self, bzrdir):
230
 
        BzrNewError.__init__(self)
 
529
        BzrError.__init__(self)
231
530
        self.path = bzrdir.transport.clone('..').base
232
531
 
233
532
 
234
 
class FileInWrongBranch(BzrNewError):
235
 
    """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."
236
536
 
237
537
    def __init__(self, branch, path):
238
 
        BzrNewError.__init__(self)
 
538
        BzrError.__init__(self)
239
539
        self.branch = branch
240
540
        self.branch_base = branch.base
241
541
        self.path = path
242
542
 
243
543
 
244
544
class UnsupportedFormatError(BzrError):
245
 
    """Specified path is a bzr branch that we recognize but cannot read."""
246
 
    def __str__(self):
247
 
        return 'unsupported branch format: %s' % self.args[0]
 
545
 
 
546
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
248
547
 
249
548
 
250
549
class UnknownFormatError(BzrError):
251
 
    """Specified path is a bzr branch whose format we do not recognize."""
252
 
    def __str__(self):
253
 
        return 'unknown branch format: %s' % self.args[0]
254
 
 
255
 
 
256
 
class IncompatibleFormat(BzrNewError):
257
 
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
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."
258
557
 
259
558
    def __init__(self, format, bzrdir_format):
260
 
        BzrNewError.__init__(self)
 
559
        BzrError.__init__(self)
261
560
        self.format = format
262
561
        self.bzrdir = bzrdir_format
263
562
 
264
563
 
265
 
class NotVersionedError(BzrNewError):
266
 
    """%(path)s is not versioned"""
267
 
    def __init__(self, path):
268
 
        BzrNewError.__init__(self)
269
 
        self.path = path
270
 
 
271
 
 
272
 
class PathsNotVersionedError(BzrNewError):
273
 
    # used when reporting several paths are not versioned
274
 
    """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"
275
628
 
276
629
    def __init__(self, paths):
277
630
        from bzrlib.osutils import quotefn
278
 
        BzrNewError.__init__(self)
279
 
        self.paths = paths
280
 
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
631
        BzrError.__init__(self)
 
632
        self.paths = paths
 
633
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
634
 
 
635
 
 
636
class PathsDoNotExist(BzrError):
 
637
 
 
638
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
639
 
 
640
    # used when reporting that paths are neither versioned nor in the working
 
641
    # tree
 
642
 
 
643
    def __init__(self, paths, extra=None):
 
644
        # circular import
 
645
        from bzrlib.osutils import quotefn
 
646
        BzrError.__init__(self)
 
647
        self.paths = paths
 
648
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
649
        if extra:
 
650
            self.extra = ': ' + str(extra)
 
651
        else:
 
652
            self.extra = ''
281
653
 
282
654
 
283
655
class BadFileKindError(BzrError):
284
 
    """Specified file is of a kind that cannot be added.
285
 
 
286
 
    (For example a symlink or device file.)"""
287
 
 
288
 
 
289
 
class ForbiddenFileError(BzrError):
290
 
    """Cannot operate on a file because it is a control file."""
291
 
 
292
 
 
293
 
class LockError(BzrNewError):
294
 
    """Lock error: %(message)s"""
 
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
 
295
674
    # All exceptions from the lock/unlock functions should be from
296
675
    # this exception class.  They will be translated as necessary. The
297
676
    # original exception is available as e.original_error
298
677
    #
299
678
    # New code should prefer to raise specific subclasses
300
679
    def __init__(self, message):
301
 
        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
302
694
 
303
695
 
304
696
class CommitNotPossible(LockError):
305
 
    """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
 
306
700
    def __init__(self):
307
701
        pass
308
702
 
309
703
 
310
704
class AlreadyCommitted(LockError):
311
 
    """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
 
312
708
    def __init__(self):
313
709
        pass
314
710
 
315
711
 
316
712
class ReadOnlyError(LockError):
317
 
    """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
 
318
719
    def __init__(self, obj):
319
720
        self.obj = obj
320
721
 
321
722
 
322
 
class OutSideTransaction(BzrNewError):
323
 
    """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.")
324
737
 
325
738
 
326
739
class ObjectNotLocked(LockError):
327
 
    """%(obj)r is not locked"""
 
740
 
 
741
    _fmt = "%(obj)r is not locked"
 
742
 
328
743
    # this can indicate that any particular object is not locked; see also
329
744
    # LockNotHeld which means that a particular *lock* object is not held by
330
745
    # the caller -- perhaps they should be unified.
333
748
 
334
749
 
335
750
class ReadOnlyObjectDirtiedError(ReadOnlyError):
336
 
    """Cannot change object %(obj)r in read only transaction"""
 
751
 
 
752
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
753
 
337
754
    def __init__(self, obj):
338
755
        self.obj = obj
339
756
 
340
757
 
341
758
class UnlockableTransport(LockError):
342
 
    """Cannot lock: transport is read only: %(transport)s"""
 
759
 
 
760
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
761
 
343
762
    def __init__(self, transport):
344
763
        self.transport = transport
345
764
 
346
765
 
347
766
class LockContention(LockError):
348
 
    """Could not acquire lock %(lock)s"""
349
 
    # 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
 
350
774
    def __init__(self, lock):
351
775
        self.lock = lock
352
776
 
353
777
 
354
778
class LockBroken(LockError):
355
 
    """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
 
356
785
    def __init__(self, lock):
357
786
        self.lock = lock
358
787
 
359
788
 
360
789
class LockBreakMismatch(LockError):
361
 
    """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
 
362
796
    def __init__(self, lock, holder, target):
363
797
        self.lock = lock
364
798
        self.holder = holder
366
800
 
367
801
 
368
802
class LockNotHeld(LockError):
369
 
    """Lock not held: %(lock)s"""
 
803
 
 
804
    _fmt = "Lock not held: %(lock)s"
 
805
 
 
806
    internal_error = False
 
807
 
370
808
    def __init__(self, lock):
371
809
        self.lock = lock
372
810
 
373
811
 
374
 
class PointlessCommit(BzrNewError):
375
 
    """No changes to commit"""
376
 
 
377
 
 
378
 
class UpgradeReadonly(BzrNewError):
379
 
    """Upgrade URL cannot work with readonly URL's."""
380
 
 
381
 
 
382
 
class UpToDateFormat(BzrNewError):
383
 
    """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."
384
846
 
385
847
    def __init__(self, format):
386
 
        BzrNewError.__init__(self)
 
848
        BzrError.__init__(self)
387
849
        self.format = format
388
850
 
389
851
 
390
 
 
391
852
class StrictCommitFailed(Exception):
392
 
    """Commit refused because there are unknowns in the tree."""
 
853
 
 
854
    _fmt = "Commit refused because there are unknowns in the tree."
393
855
 
394
856
 
395
857
class NoSuchRevision(BzrError):
 
858
 
 
859
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
860
 
 
861
    internal_error = True
 
862
 
396
863
    def __init__(self, branch, revision):
397
 
        self.branch = branch
398
 
        self.revision = revision
399
 
        msg = "Branch %s has no revision %s" % (branch, revision)
400
 
        BzrError.__init__(self, msg)
 
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 = ''
401
910
 
402
911
 
403
912
class HistoryMissing(BzrError):
404
 
    def __init__(self, branch, object_type, object_id):
405
 
        self.branch = branch
406
 
        BzrError.__init__(self,
407
 
                          '%s is missing %s {%s}'
408
 
                          % (branch, object_type, object_id))
 
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)
409
927
 
410
928
 
411
929
class DivergedBranches(BzrError):
412
930
 
 
931
    _fmt = ("These branches have diverged."
 
932
            " Use the merge command to reconcile them.")
 
933
 
 
934
    internal_error = False
 
935
 
413
936
    def __init__(self, branch1, branch2):
414
 
        BzrError.__init__(self, "These branches have diverged.  Try merge.")
415
937
        self.branch1 = branch1
416
938
        self.branch2 = branch2
417
939
 
418
940
 
419
 
class UnrelatedBranches(BzrCommandError):
420
 
    def __init__(self):
421
 
        msg = "Branches have no common ancestor, and no base revision"\
422
 
            " specified."
423
 
        BzrCommandError.__init__(self, msg)
 
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
424
957
 
425
958
 
426
959
class NoCommonAncestor(BzrError):
 
960
    
 
961
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
962
 
427
963
    def __init__(self, revision_a, revision_b):
428
 
        msg = "Revisions have no common ancestor: %s %s." \
429
 
            % (revision_a, revision_b) 
430
 
        BzrError.__init__(self, msg)
 
964
        self.revision_a = revision_a
 
965
        self.revision_b = revision_b
431
966
 
432
967
 
433
968
class NoCommonRoot(BzrError):
 
969
 
 
970
    _fmt = ("Revisions are not derived from the same root: "
 
971
           "%(revision_a)s %(revision_b)s.")
 
972
 
434
973
    def __init__(self, revision_a, revision_b):
435
 
        msg = "Revisions are not derived from the same root: %s %s." \
436
 
            % (revision_a, revision_b) 
437
 
        BzrError.__init__(self, msg)
438
 
 
 
974
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
439
975
 
440
976
 
441
977
class NotAncestor(BzrError):
 
978
 
 
979
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
980
 
442
981
    def __init__(self, rev_id, not_ancestor_id):
443
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
444
 
                                                        rev_id)
445
 
        BzrError.__init__(self, msg)
446
 
        self.rev_id = rev_id
447
 
        self.not_ancestor_id = not_ancestor_id
 
982
        BzrError.__init__(self, rev_id=rev_id,
 
983
            not_ancestor_id=not_ancestor_id)
448
984
 
449
985
 
450
986
class InstallFailed(BzrError):
 
987
 
451
988
    def __init__(self, revisions):
452
 
        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
453
991
        BzrError.__init__(self, msg)
454
992
        self.revisions = revisions
455
993
 
456
994
 
457
995
class AmbiguousBase(BzrError):
 
996
 
458
997
    def __init__(self, bases):
459
998
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
999
                DeprecationWarning)
461
 
        msg = "The correct base is unclear, becase %s are all equally close" %\
462
 
            ", ".join(bases)
 
1000
        msg = ("The correct base is unclear, because %s are all equally close"
 
1001
                % ", ".join(bases))
463
1002
        BzrError.__init__(self, msg)
464
1003
        self.bases = bases
465
1004
 
466
1005
 
467
1006
class NoCommits(BzrError):
 
1007
 
 
1008
    _fmt = "Branch %(branch)s has no commits."
 
1009
 
468
1010
    def __init__(self, branch):
469
 
        msg = "Branch %s has no commits." % branch
470
 
        BzrError.__init__(self, msg)
 
1011
        BzrError.__init__(self, branch=branch)
471
1012
 
472
1013
 
473
1014
class UnlistableStore(BzrError):
 
1015
 
474
1016
    def __init__(self, store):
475
1017
        BzrError.__init__(self, "Store %s is not listable" % store)
476
1018
 
477
1019
 
478
1020
 
479
1021
class UnlistableBranch(BzrError):
 
1022
 
480
1023
    def __init__(self, br):
481
1024
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
482
1025
 
483
1026
 
484
 
class BoundBranchOutOfDate(BzrNewError):
485
 
    """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
 
486
1032
    def __init__(self, branch, master):
487
 
        BzrNewError.__init__(self)
 
1033
        BzrError.__init__(self)
488
1034
        self.branch = branch
489
1035
        self.master = master
490
1036
 
491
1037
        
492
 
class CommitToDoubleBoundBranch(BzrNewError):
493
 
    """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
 
494
1043
    def __init__(self, branch, master, remote):
495
 
        BzrNewError.__init__(self)
 
1044
        BzrError.__init__(self)
496
1045
        self.branch = branch
497
1046
        self.master = master
498
1047
        self.remote = remote
499
1048
 
500
1049
 
501
 
class OverwriteBoundBranch(BzrNewError):
502
 
    """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
 
503
1054
    def __init__(self, branch):
504
 
        BzrNewError.__init__(self)
 
1055
        BzrError.__init__(self)
505
1056
        self.branch = branch
506
1057
 
507
1058
 
508
 
class BoundBranchConnectionFailure(BzrNewError):
509
 
    """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
 
510
1064
    def __init__(self, branch, target, error):
511
 
        BzrNewError.__init__(self)
 
1065
        BzrError.__init__(self)
512
1066
        self.branch = branch
513
1067
        self.target = target
514
1068
        self.error = error
515
1069
 
516
1070
 
517
 
class WeaveError(BzrNewError):
518
 
    """Error in processing weave: %(message)s"""
 
1071
class WeaveError(BzrError):
 
1072
 
 
1073
    _fmt = "Error in processing weave: %(message)s"
519
1074
 
520
1075
    def __init__(self, message=None):
521
 
        BzrNewError.__init__(self)
 
1076
        BzrError.__init__(self)
522
1077
        self.message = message
523
1078
 
524
1079
 
525
1080
class WeaveRevisionAlreadyPresent(WeaveError):
526
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
1081
 
 
1082
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1083
 
527
1084
    def __init__(self, revision_id, weave):
528
1085
 
529
1086
        WeaveError.__init__(self)
532
1089
 
533
1090
 
534
1091
class WeaveRevisionNotPresent(WeaveError):
535
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
1092
 
 
1093
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
536
1094
 
537
1095
    def __init__(self, revision_id, weave):
538
1096
        WeaveError.__init__(self)
541
1099
 
542
1100
 
543
1101
class WeaveFormatError(WeaveError):
544
 
    """Weave invariant violated: %(what)s"""
 
1102
 
 
1103
    _fmt = "Weave invariant violated: %(what)s"
545
1104
 
546
1105
    def __init__(self, what):
547
1106
        WeaveError.__init__(self)
549
1108
 
550
1109
 
551
1110
class WeaveParentMismatch(WeaveError):
552
 
    """Parents are mismatched between two revisions."""
 
1111
 
 
1112
    _fmt = "Parents are mismatched between two revisions."
553
1113
    
554
1114
 
555
1115
class WeaveInvalidChecksum(WeaveError):
556
 
    """Text did not match it's checksum: %(message)s"""
557
 
 
558
 
 
559
 
class WeaveTextDiffers(WeaveError):
560
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
561
 
 
562
 
    def __init__(self, revision_id, weave_a, weave_b):
563
 
        WeaveError.__init__(self)
564
 
        self.revision_id = revision_id
565
 
        self.weave_a = weave_a
566
 
        self.weave_b = weave_b
567
 
 
568
 
 
569
 
class WeaveTextDiffers(WeaveError):
570
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
571
 
 
572
 
    def __init__(self, revision_id, weave_a, weave_b):
573
 
        WeaveError.__init__(self)
574
 
        self.revision_id = revision_id
575
 
        self.weave_a = weave_a
576
 
        self.weave_b = weave_b
577
 
 
578
 
 
579
 
class VersionedFileError(BzrNewError):
580
 
    """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"
581
1147
 
582
1148
 
583
1149
class RevisionNotPresent(VersionedFileError):
584
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
1150
    
 
1151
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
585
1152
 
586
1153
    def __init__(self, revision_id, file_id):
587
1154
        VersionedFileError.__init__(self)
590
1157
 
591
1158
 
592
1159
class RevisionAlreadyPresent(VersionedFileError):
593
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
1160
    
 
1161
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
594
1162
 
595
1163
    def __init__(self, revision_id, file_id):
596
1164
        VersionedFileError.__init__(self)
598
1166
        self.file_id = file_id
599
1167
 
600
1168
 
601
 
class KnitError(BzrNewError):
602
 
    """Knit error"""
 
1169
class KnitError(BzrError):
 
1170
    
 
1171
    _fmt = "Knit error"
 
1172
 
 
1173
    internal_error = True
603
1174
 
604
1175
 
605
1176
class KnitHeaderError(KnitError):
606
 
    """Knit header error: %(badline)r unexpected"""
607
 
 
608
 
    def __init__(self, badline):
 
1177
 
 
1178
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1179
 
 
1180
    def __init__(self, badline, filename):
609
1181
        KnitError.__init__(self)
610
1182
        self.badline = badline
 
1183
        self.filename = filename
611
1184
 
612
1185
 
613
1186
class KnitCorrupt(KnitError):
614
 
    """Knit %(filename)s corrupt: %(how)s"""
 
1187
 
 
1188
    _fmt = "Knit %(filename)s corrupt: %(how)s"
615
1189
 
616
1190
    def __init__(self, filename, how):
617
1191
        KnitError.__init__(self)
619
1193
        self.how = how
620
1194
 
621
1195
 
622
 
class NoSuchExportFormat(BzrNewError):
623
 
    """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
 
624
1215
    def __init__(self, format):
625
 
        BzrNewError.__init__(self)
 
1216
        BzrError.__init__(self)
626
1217
        self.format = format
627
1218
 
628
1219
 
629
1220
class TransportError(BzrError):
630
 
    """All errors thrown by Transport implementations should derive
631
 
    from this class.
632
 
    """
 
1221
    
 
1222
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1223
 
633
1224
    def __init__(self, msg=None, orig_error=None):
634
1225
        if msg is None and orig_error is not None:
635
1226
            msg = str(orig_error)
636
 
        BzrError.__init__(self, msg)
 
1227
        if orig_error is None:
 
1228
            orig_error = ''
 
1229
        if msg is None:
 
1230
            msg =  ''
637
1231
        self.msg = msg
638
1232
        self.orig_error = orig_error
 
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
639
1254
 
640
1255
 
641
1256
# A set of semi-meaningful errors which can be thrown
642
1257
class TransportNotPossible(TransportError):
643
 
    """This is for transports where a specific function is explicitly not
644
 
    possible. Such as pushing files to an HTTP server.
645
 
    """
646
 
    pass
 
1258
 
 
1259
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
647
1260
 
648
1261
 
649
1262
class ConnectionError(TransportError):
650
 
    """A connection problem prevents file retrieval.
651
 
    This does not indicate whether the file exists or not; it indicates that a
652
 
    precondition for requesting the file was not met.
653
 
    """
654
 
    def __init__(self, msg=None, orig_error=None):
655
 
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
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
656
1284
 
657
1285
 
658
1286
class ConnectionReset(TransportError):
659
 
    """The connection has been closed."""
660
 
    pass
661
 
 
 
1287
 
 
1288
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1289
 
 
1290
 
 
1291
class InvalidRange(TransportError):
 
1292
 
 
1293
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1294
    
 
1295
    def __init__(self, path, offset):
 
1296
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1297
                                       % (path, offset)))
 
1298
        self.path = path
 
1299
        self.offset = offset
 
1300
 
 
1301
 
 
1302
class InvalidHttpResponse(TransportError):
 
1303
 
 
1304
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1305
 
 
1306
    def __init__(self, path, msg, orig_error=None):
 
1307
        self.path = path
 
1308
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1309
 
 
1310
 
 
1311
class InvalidHttpRange(InvalidHttpResponse):
 
1312
 
 
1313
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1314
    
 
1315
    def __init__(self, path, range, msg):
 
1316
        self.range = range
 
1317
        InvalidHttpResponse.__init__(self, path, msg)
 
1318
 
 
1319
 
 
1320
class InvalidHttpContentType(InvalidHttpResponse):
 
1321
 
 
1322
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1323
    
 
1324
    def __init__(self, path, ctype, msg):
 
1325
        self.ctype = ctype
 
1326
        InvalidHttpResponse.__init__(self, path, msg)
 
1327
 
 
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"
662
1381
 
663
1382
class ConflictsInTree(BzrError):
664
 
    def __init__(self):
665
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1383
 
 
1384
    _fmt = "Working tree has conflicts."
666
1385
 
667
1386
 
668
1387
class ParseConfigError(BzrError):
 
1388
 
669
1389
    def __init__(self, errors, filename):
670
1390
        if filename is None:
671
1391
            filename = ""
674
1394
        BzrError.__init__(self, message)
675
1395
 
676
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
 
677
1406
class SigningFailed(BzrError):
 
1407
 
 
1408
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1409
 
678
1410
    def __init__(self, command_line):
679
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
680
 
                               % command_line)
 
1411
        BzrError.__init__(self, command_line=command_line)
681
1412
 
682
1413
 
683
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
 
684
1420
    def __init__(self, tree):
685
 
        BzrError.__init__(self, "The working tree for %s has changed since"
686
 
                          " last commit, but weave merge requires that it be"
687
 
                          " unchanged." % tree.basedir)
688
 
 
689
 
 
690
 
class CantReprocessAndShowBase(BzrNewError):
691
 
    """Can't reprocess and show base.
692
 
Reprocessing obscures relationship of conflicting lines to base."""
693
 
 
694
 
 
695
 
class GraphCycleError(BzrNewError):
696
 
    """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
 
697
1434
    def __init__(self, graph):
698
 
        BzrNewError.__init__(self)
 
1435
        BzrError.__init__(self)
699
1436
        self.graph = graph
700
1437
 
701
1438
 
702
 
class NotConflicted(BzrNewError):
703
 
    """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."
704
1465
 
705
1466
    def __init__(self, filename):
706
 
        BzrNewError.__init__(self)
 
1467
        BzrError.__init__(self)
707
1468
        self.filename = filename
708
1469
 
709
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
 
710
1481
class MustUseDecorated(Exception):
711
 
    """A decorating function has requested its original command be used.
712
 
    
713
 
    This should never escape bzr, so does not need to be printable.
714
 
    """
715
 
 
716
 
 
717
 
class MissingText(BzrNewError):
718
 
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)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
 
 
1490
    def __init__(self, filename):
 
1491
        BzrError.__init__(self)
 
1492
        self.filename = filename
 
1493
 
 
1494
 
 
1495
class BundleNotSupported(BzrError):
 
1496
 
 
1497
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1498
 
 
1499
    def __init__(self, version, msg):
 
1500
        BzrError.__init__(self)
 
1501
        self.version = version
 
1502
        self.msg = msg
 
1503
 
 
1504
 
 
1505
class MissingText(BzrError):
 
1506
 
 
1507
    _fmt = ("Branch %(base)s is missing revision"
 
1508
            " %(text_revision)s of %(file_id)s")
719
1509
 
720
1510
    def __init__(self, branch, text_revision, file_id):
721
 
        BzrNewError.__init__(self)
 
1511
        BzrError.__init__(self)
722
1512
        self.branch = branch
723
1513
        self.base = branch.base
724
1514
        self.text_revision = text_revision
725
1515
        self.file_id = file_id
726
1516
 
727
1517
 
728
 
class DuplicateKey(BzrNewError):
729
 
    """Key %(key)s is already present in map"""
730
 
 
731
 
 
732
 
class MalformedTransform(BzrNewError):
733
 
    """Tree transform is malformed %(conflicts)r"""
734
 
 
735
 
 
736
 
class BzrBadParameter(BzrNewError):
737
 
    """A bad parameter : %(param)s is not usable.
738
 
    
739
 
    This exception should never be thrown, but it is a base class for all
740
 
    parameter-to-function errors.
741
 
    """
 
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
 
742
1557
    def __init__(self, param):
743
 
        BzrNewError.__init__(self)
 
1558
        BzrError.__init__(self)
744
1559
        self.param = param
745
1560
 
746
1561
 
747
1562
class BzrBadParameterNotUnicode(BzrBadParameter):
748
 
    """Parameter %(param)s is neither unicode nor utf8."""
749
 
 
750
 
 
751
 
class ReusingTransform(BzrNewError):
752
 
    """Attempt to reuse a transform that has already been applied."""
753
 
 
754
 
 
755
 
class CantMoveRoot(BzrNewError):
756
 
    """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)
757
1617
 
758
1618
 
759
1619
class BzrBadParameterNotString(BzrBadParameter):
760
 
    """Parameter %(param)s is not a string or unicode string."""
 
1620
 
 
1621
    _fmt = "Parameter %(param)s is not a string or unicode string."
761
1622
 
762
1623
 
763
1624
class BzrBadParameterMissing(BzrBadParameter):
764
 
    """Parameter $(param)s is required but not present."""
765
 
 
766
 
 
767
 
class DependencyNotPresent(BzrNewError):
768
 
    """Unable to import library "%(library)s": %(error)s"""
 
1625
 
 
1626
    _fmt = "Parameter $(param)s is required but not present."
 
1627
 
 
1628
 
 
1629
class BzrBadParameterUnicode(BzrBadParameter):
 
1630
 
 
1631
    _fmt = ("Parameter %(param)s is unicode but"
 
1632
            " only byte-strings are permitted.")
 
1633
 
 
1634
 
 
1635
class BzrBadParameterContainsNewline(BzrBadParameter):
 
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'
769
1643
 
770
1644
    def __init__(self, library, error):
771
 
        BzrNewError.__init__(self, library=library, error=error)
 
1645
        BzrError.__init__(self, library=library, error=error)
772
1646
 
773
1647
 
774
1648
class ParamikoNotPresent(DependencyNotPresent):
775
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
1649
 
 
1650
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
776
1651
 
777
1652
    def __init__(self, error):
778
1653
        DependencyNotPresent.__init__(self, 'paramiko', error)
779
1654
 
780
1655
 
781
 
class UninitializableFormat(BzrNewError):
782
 
    """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."
783
1664
 
784
1665
    def __init__(self, format):
785
 
        BzrNewError.__init__(self)
786
 
        self.format = format
787
 
 
788
 
 
789
 
class NoDiff3(BzrNewError):
790
 
    """Diff3 is not installed on this machine."""
791
 
 
792
 
 
793
 
class ExistingLimbo(BzrNewError):
794
 
    """This tree contains left-over files from a failed operation.
795
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
796
 
    keep, and delete it when you are done.
797
 
    """
798
 
    def __init__(self, limbo_dir):
799
 
       BzrNewError.__init__(self)
800
 
       self.limbo_dir = limbo_dir
801
 
 
802
 
 
803
 
class ImmortalLimbo(BzrNewError):
804
 
    """Unable to delete transform temporary directory $(limbo_dir)s.
805
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
806
 
    keep, and delete it when you are done.
807
 
    """
808
 
    def __init__(self, limbo_dir):
809
 
       BzrNewError.__init__(self)
810
 
       self.limbo_dir = limbo_dir
811
 
 
812
 
 
813
 
class OutOfDateTree(BzrNewError):
814
 
    """Working tree is out of date, please run 'bzr update'."""
 
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"
 
1683
 
 
1684
    def __init__(self, msg):
 
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'."
815
1718
 
816
1719
    def __init__(self, tree):
817
 
        BzrNewError.__init__(self)
 
1720
        BzrError.__init__(self)
818
1721
        self.tree = tree
819
1722
 
820
1723
 
821
 
class MergeModifiedFormatError(BzrNewError):
822
 
    """Error in merge modified format"""
823
 
 
824
 
 
825
 
class ConflictFormatError(BzrNewError):
826
 
    """Format error in conflict listings"""
827
 
 
828
 
 
829
 
class CorruptRepository(BzrNewError):
830
 
    """An error has been detected in the repository %(repo_path)s.
831
 
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.")
832
1751
 
833
1752
    def __init__(self, repo):
834
 
        BzrNewError.__init__(self)
 
1753
        BzrError.__init__(self)
835
1754
        self.repo_path = repo.bzrdir.root_transport.base
836
1755
 
837
1756
 
838
 
class UpgradeRequired(BzrNewError):
839
 
    """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."
840
1760
 
841
1761
    def __init__(self, path):
842
 
        BzrNewError.__init__(self)
 
1762
        BzrError.__init__(self)
843
1763
        self.path = path
844
1764
 
845
1765
 
846
 
class LocalRequiresBoundBranch(BzrNewError):
847
 
    """Cannot perform local-only commits on unbound branches."""
848
 
 
849
 
 
850
 
class MissingProgressBarFinish(BzrNewError):
851
 
    """A nested progress bar was not 'finished' correctly."""
852
 
 
853
 
 
854
 
class UnsupportedOperation(BzrNewError):
855
 
    """The method %(mname)s is not supported on objects of type %(tname)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")
 
1780
 
 
1781
    def __init__(self, bar_type, valid_types):
 
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
 
856
1790
    def __init__(self, method, method_self):
857
1791
        self.method = method
858
1792
        self.mname = method.__name__
859
1793
        self.tname = type(method_self).__name__
 
1794
 
 
1795
 
 
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"
 
1814
 
 
1815
    def __init__(self, path):
 
1816
        BzrError.__init__(self)
 
1817
        self.path = path
 
1818
 
 
1819
 
 
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
 
 
1826
    def __init__(self, revision_id, expected, measured):
 
1827
        self.revision_id = revision_id
 
1828
        self.expected = expected
 
1829
        self.measured = measured
 
1830
 
 
1831
 
 
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