/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

(vila) Better deprecation warnings for _CompatabilityThunkFeature based test
 features (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
2
 
 
 
1
# Copyright (C) 2005-2011 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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
59
 
 
60
20
# TODO: is there any value in providing the .args field used by standard
61
 
# python exceptions?   A list of values with no names seems less useful 
 
21
# python exceptions?   A list of values with no names seems less useful
62
22
# to me.
63
23
 
64
 
# TODO: Perhaps convert the exception to a string at the moment it's 
 
24
# TODO: Perhaps convert the exception to a string at the moment it's
65
25
# constructed to make sure it will succeed.  But that says nothing about
66
26
# exceptions that are never raised.
67
27
 
68
 
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
69
 
# the old one.
 
28
# TODO: selftest assertRaises should probably also check that every error
 
29
# raised can be formatted as a string successfully, and without giving
 
30
# 'unprintable'.
 
31
 
 
32
 
 
33
# return codes from the bzr program
 
34
EXIT_OK = 0
 
35
EXIT_ERROR = 3
 
36
EXIT_INTERNAL_ERROR = 4
70
37
 
71
38
 
72
39
class BzrError(StandardError):
73
 
    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
 
40
    """
 
41
    Base class for errors raised by bzrlib.
 
42
 
 
43
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
44
        should be displayed with a traceback; if False (or absent) this was
 
45
        probably a user or environment error and they don't need the gory
 
46
        details.  (That can be overridden by -Derror on the command line.)
 
47
 
 
48
    :cvar _fmt: Format string to display the error; this is expanded
 
49
        by the instance's dict.
 
50
    """
 
51
 
 
52
    internal_error = False
 
53
 
 
54
    def __init__(self, msg=None, **kwds):
 
55
        """Construct a new BzrError.
 
56
 
 
57
        There are two alternative forms for constructing these objects.
 
58
        Either a preformatted string may be passed, or a set of named
 
59
        arguments can be given.  The first is for generic "user" errors which
 
60
        are not intended to be caught and so do not need a specific subclass.
 
61
        The second case is for use with subclasses that provide a _fmt format
 
62
        string to print the arguments.
 
63
 
 
64
        Keyword arguments are taken as parameters to the error, which can
 
65
        be inserted into the format string template.  It's recommended
 
66
        that subclasses override the __init__ method to require specific
 
67
        parameters.
 
68
 
 
69
        :param msg: If given, this is the literal complete text for the error,
 
70
           not subject to expansion. 'msg' is used instead of 'message' because
 
71
           python evolved and, in 2.6, forbids the use of 'message'.
 
72
        """
 
73
        StandardError.__init__(self)
 
74
        if msg is not None:
 
75
            # I was going to deprecate this, but it actually turns out to be
 
76
            # quite handy - mbp 20061103.
 
77
            self._preformatted_string = msg
87
78
        else:
88
 
            return n + `self.args`
89
 
 
90
 
 
91
 
class BzrNewError(BzrError):
92
 
    """bzr error"""
93
 
    # base classes should override the docstring with their human-
94
 
    # readable explanation
95
 
 
96
 
    def __init__(self, **kwds):
97
 
        for key, value in kwds.items():
98
 
            setattr(self, key, value)
99
 
 
100
 
    def __str__(self):
 
79
            self._preformatted_string = None
 
80
            for key, value in kwds.items():
 
81
                setattr(self, key, value)
 
82
 
 
83
    def _format(self):
 
84
        s = getattr(self, '_preformatted_string', None)
 
85
        if s is not None:
 
86
            # contains a preformatted message
 
87
            return s
101
88
        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"""
110
 
 
111
 
    def __init__(self, message):
112
 
        BzrNewError.__init__(self)
113
 
        self.message = message
114
 
 
115
 
 
116
 
class InvalidEntryName(BzrNewError):
117
 
    """Invalid entry name: %(name)s"""
 
89
            fmt = self._get_format_string()
 
90
            if fmt:
 
91
                d = dict(self.__dict__)
 
92
                s = fmt % d
 
93
                # __str__() should always return a 'str' object
 
94
                # never a 'unicode' object.
 
95
                return s
 
96
        except Exception, e:
 
97
            pass # just bind to 'e' for formatting below
 
98
        else:
 
99
            e = None
 
100
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
101
            % (self.__class__.__name__,
 
102
               self.__dict__,
 
103
               getattr(self, '_fmt', None),
 
104
               e)
 
105
 
 
106
    def __unicode__(self):
 
107
        u = self._format()
 
108
        if isinstance(u, str):
 
109
            # Try decoding the str using the default encoding.
 
110
            u = unicode(u)
 
111
        elif not isinstance(u, unicode):
 
112
            # Try to make a unicode object from it, because __unicode__ must
 
113
            # return a unicode object.
 
114
            u = unicode(u)
 
115
        return u
 
116
 
 
117
    def __str__(self):
 
118
        s = self._format()
 
119
        if isinstance(s, unicode):
 
120
            s = s.encode('utf8')
 
121
        else:
 
122
            # __str__ must return a str.
 
123
            s = str(s)
 
124
        return s
 
125
 
 
126
    def __repr__(self):
 
127
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
128
 
 
129
    def _get_format_string(self):
 
130
        """Return format string for this exception or None"""
 
131
        fmt = getattr(self, '_fmt', None)
 
132
        if fmt is not None:
 
133
            from bzrlib.i18n import gettext
 
134
            return gettext(unicode(fmt)) # _fmt strings should be ascii
 
135
 
 
136
    def __eq__(self, other):
 
137
        if self.__class__ is not other.__class__:
 
138
            return NotImplemented
 
139
        return self.__dict__ == other.__dict__
 
140
 
 
141
 
 
142
class InternalBzrError(BzrError):
 
143
    """Base class for errors that are internal in nature.
 
144
 
 
145
    This is a convenience class for errors that are internal. The
 
146
    internal_error attribute can still be altered in subclasses, if needed.
 
147
    Using this class is simply an easy way to get internal errors.
 
148
    """
 
149
 
 
150
    internal_error = True
 
151
 
 
152
 
 
153
class AlreadyBuilding(BzrError):
 
154
 
 
155
    _fmt = "The tree builder is already building a tree."
 
156
 
 
157
 
 
158
class BranchError(BzrError):
 
159
    """Base class for concrete 'errors about a branch'."""
 
160
 
 
161
    def __init__(self, branch):
 
162
        BzrError.__init__(self, branch=branch)
 
163
 
 
164
 
 
165
class BzrCheckError(InternalBzrError):
 
166
 
 
167
    _fmt = "Internal check failed: %(msg)s"
 
168
 
 
169
    def __init__(self, msg):
 
170
        BzrError.__init__(self)
 
171
        self.msg = msg
 
172
 
 
173
 
 
174
class DirstateCorrupt(BzrError):
 
175
 
 
176
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
177
 
 
178
    def __init__(self, state, msg):
 
179
        BzrError.__init__(self)
 
180
        self.state = state
 
181
        self.msg = msg
 
182
 
 
183
 
 
184
class DisabledMethod(InternalBzrError):
 
185
 
 
186
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
187
 
 
188
    def __init__(self, class_name):
 
189
        BzrError.__init__(self)
 
190
        self.class_name = class_name
 
191
 
 
192
 
 
193
class IncompatibleAPI(BzrError):
 
194
 
 
195
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
196
        'It supports versions "%(minimum)s" to "%(current)s".'
 
197
 
 
198
    def __init__(self, api, wanted, minimum, current):
 
199
        self.api = api
 
200
        self.wanted = wanted
 
201
        self.minimum = minimum
 
202
        self.current = current
 
203
 
 
204
 
 
205
class InProcessTransport(BzrError):
 
206
 
 
207
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
208
        "process."
 
209
 
 
210
    def __init__(self, transport):
 
211
        self.transport = transport
 
212
 
 
213
 
 
214
class InvalidEntryName(InternalBzrError):
 
215
 
 
216
    _fmt = "Invalid entry name: %(name)s"
 
217
 
118
218
    def __init__(self, name):
119
 
        BzrNewError.__init__(self)
 
219
        BzrError.__init__(self)
120
220
        self.name = name
121
221
 
122
222
 
123
 
class InvalidRevisionNumber(BzrNewError):
124
 
    """Invalid revision number %(revno)d"""
 
223
class InvalidRevisionNumber(BzrError):
 
224
 
 
225
    _fmt = "Invalid revision number %(revno)s"
 
226
 
125
227
    def __init__(self, revno):
126
 
        BzrNewError.__init__(self)
 
228
        BzrError.__init__(self)
127
229
        self.revno = revno
128
230
 
129
231
 
130
 
class InvalidRevisionId(BzrNewError):
131
 
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
232
class InvalidRevisionId(BzrError):
 
233
 
 
234
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
235
 
132
236
    def __init__(self, revision_id, branch):
133
 
        BzrNewError.__init__(self)
 
237
        # branch can be any string or object with __str__ defined
 
238
        BzrError.__init__(self)
134
239
        self.revision_id = revision_id
135
240
        self.branch = branch
136
241
 
137
242
 
138
 
class NoWorkingTree(BzrNewError):
139
 
    """No WorkingTree exists for %s(base)."""
140
 
    
 
243
class ReservedId(BzrError):
 
244
 
 
245
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
246
 
 
247
    def __init__(self, revision_id):
 
248
        self.revision_id = revision_id
 
249
 
 
250
 
 
251
class RootMissing(InternalBzrError):
 
252
 
 
253
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
254
        "the commit builder.")
 
255
 
 
256
 
 
257
class NoPublicBranch(BzrError):
 
258
 
 
259
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
260
 
 
261
    def __init__(self, branch):
 
262
        import bzrlib.urlutils as urlutils
 
263
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
264
        BzrError.__init__(self, branch_url=public_location)
 
265
 
 
266
 
 
267
class NoHelpTopic(BzrError):
 
268
 
 
269
    _fmt = ("No help could be found for '%(topic)s'. "
 
270
        "Please use 'bzr help topics' to obtain a list of topics.")
 
271
 
 
272
    def __init__(self, topic):
 
273
        self.topic = topic
 
274
 
 
275
 
 
276
class NoSuchId(BzrError):
 
277
 
 
278
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
279
 
 
280
    def __init__(self, tree, file_id):
 
281
        BzrError.__init__(self)
 
282
        self.file_id = file_id
 
283
        self.tree = tree
 
284
 
 
285
 
 
286
class NoSuchIdInRepository(NoSuchId):
 
287
 
 
288
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
289
            ' %(repository)r')
 
290
 
 
291
    def __init__(self, repository, file_id):
 
292
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
293
 
 
294
 
 
295
class NotStacked(BranchError):
 
296
 
 
297
    _fmt = "The branch '%(branch)s' is not stacked."
 
298
 
 
299
 
 
300
class InventoryModified(InternalBzrError):
 
301
 
 
302
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
303
            " so a clean inventory cannot be read without data loss.")
 
304
 
 
305
    def __init__(self, tree):
 
306
        self.tree = tree
 
307
 
 
308
 
 
309
class NoWorkingTree(BzrError):
 
310
 
 
311
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
312
 
141
313
    def __init__(self, base):
142
 
        BzrNewError.__init__(self)
 
314
        BzrError.__init__(self)
143
315
        self.base = base
144
316
 
145
317
 
146
 
class NotLocalUrl(BzrNewError):
147
 
    """%s(url) is not a local path."""
148
 
    
 
318
class NotBuilding(BzrError):
 
319
 
 
320
    _fmt = "Not currently building a tree."
 
321
 
 
322
 
 
323
class NotLocalUrl(BzrError):
 
324
 
 
325
    _fmt = "%(url)s is not a local path."
 
326
 
149
327
    def __init__(self, url):
150
 
        BzrNewError.__init__(self)
151
328
        self.url = url
152
329
 
153
330
 
 
331
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
332
 
 
333
    _fmt = 'Working tree already populated in "%(base)s"'
 
334
 
 
335
    def __init__(self, base):
 
336
        self.base = base
 
337
 
 
338
 
154
339
class BzrCommandError(BzrError):
155
 
    # Error from malformed user command
156
 
    # This is being misused as a generic exception
157
 
    # pleae subclass. RBC 20051030
 
340
    """Error from user command"""
 
341
 
 
342
    # Error from malformed user command; please avoid raising this as a
 
343
    # generic exception not caused by user input.
158
344
    #
159
345
    # I think it's a waste of effort to differentiate between errors that
160
346
    # are not intended to be caught anyway.  UI code need not subclass
161
347
    # BzrCommandError, and non-UI code should not throw a subclass of
162
348
    # BzrCommandError.  ADHB 20051211
163
 
    def __str__(self):
164
 
        return self.args[0]
 
349
 
 
350
 
 
351
class NotWriteLocked(BzrError):
 
352
 
 
353
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
354
 
 
355
    def __init__(self, not_locked):
 
356
        self.not_locked = not_locked
165
357
 
166
358
 
167
359
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)"""
 
360
 
 
361
    _fmt = "Error in command line options"
 
362
 
 
363
 
 
364
class BadIndexFormatSignature(BzrError):
 
365
 
 
366
    _fmt = "%(value)s is not an index of type %(_type)s."
 
367
 
 
368
    def __init__(self, value, _type):
 
369
        BzrError.__init__(self)
 
370
        self.value = value
 
371
        self._type = _type
 
372
 
 
373
 
 
374
class BadIndexData(BzrError):
 
375
 
 
376
    _fmt = "Error in data for index %(value)s."
 
377
 
 
378
    def __init__(self, value):
 
379
        BzrError.__init__(self)
 
380
        self.value = value
 
381
 
 
382
 
 
383
class BadIndexDuplicateKey(BzrError):
 
384
 
 
385
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
386
 
 
387
    def __init__(self, key, index):
 
388
        BzrError.__init__(self)
 
389
        self.key = key
 
390
        self.index = index
 
391
 
 
392
 
 
393
class BadIndexKey(BzrError):
 
394
 
 
395
    _fmt = "The key '%(key)s' is not a valid key."
 
396
 
 
397
    def __init__(self, key):
 
398
        BzrError.__init__(self)
 
399
        self.key = key
 
400
 
 
401
 
 
402
class BadIndexOptions(BzrError):
 
403
 
 
404
    _fmt = "Could not parse options for index %(value)s."
 
405
 
 
406
    def __init__(self, value):
 
407
        BzrError.__init__(self)
 
408
        self.value = value
 
409
 
 
410
 
 
411
class BadIndexValue(BzrError):
 
412
 
 
413
    _fmt = "The value '%(value)s' is not a valid value."
 
414
 
 
415
    def __init__(self, value):
 
416
        BzrError.__init__(self)
 
417
        self.value = value
 
418
 
 
419
 
 
420
class BadOptionValue(BzrError):
 
421
 
 
422
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
423
 
 
424
    def __init__(self, name, value):
 
425
        BzrError.__init__(self, name=name, value=value)
 
426
 
 
427
 
 
428
class StrictCommitFailed(BzrError):
 
429
 
 
430
    _fmt = "Commit refused because there are unknown files in the tree"
 
431
 
 
432
 
 
433
# XXX: Should be unified with TransportError; they seem to represent the
 
434
# same thing
 
435
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
436
# - this is finer than a TransportError - and more useful as such. It
 
437
# differentiates between 'transport has failed' and 'operation on a transport
 
438
# has failed.'
 
439
class PathError(BzrError):
 
440
 
 
441
    _fmt = "Generic path error: %(path)r%(extra)s)"
177
442
 
178
443
    def __init__(self, path, extra=None):
179
 
        BzrNewError.__init__(self)
 
444
        BzrError.__init__(self)
180
445
        self.path = path
181
446
        if extra:
182
447
            self.extra = ': ' + str(extra)
185
450
 
186
451
 
187
452
class NoSuchFile(PathError):
188
 
    """No such file: %(path)r%(extra)s"""
 
453
 
 
454
    _fmt = "No such file: %(path)r%(extra)s"
189
455
 
190
456
 
191
457
class FileExists(PathError):
192
 
    """File exists: %(path)r%(extra)s"""
 
458
 
 
459
    _fmt = "File exists: %(path)r%(extra)s"
 
460
 
 
461
 
 
462
class RenameFailedFilesExist(BzrError):
 
463
    """Used when renaming and both source and dest exist."""
 
464
 
 
465
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
466
            " (Use --after to tell bzr about a rename that has already"
 
467
            " happened)%(extra)s")
 
468
 
 
469
    def __init__(self, source, dest, extra=None):
 
470
        BzrError.__init__(self)
 
471
        self.source = str(source)
 
472
        self.dest = str(dest)
 
473
        if extra:
 
474
            self.extra = ' ' + str(extra)
 
475
        else:
 
476
            self.extra = ''
 
477
 
 
478
 
 
479
class NotADirectory(PathError):
 
480
 
 
481
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
482
 
 
483
 
 
484
class NotInWorkingDirectory(PathError):
 
485
 
 
486
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
193
487
 
194
488
 
195
489
class DirectoryNotEmpty(PathError):
196
 
    """Directory not empty: %(path)r%(extra)s"""
 
490
 
 
491
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
492
 
 
493
 
 
494
class HardLinkNotSupported(PathError):
 
495
 
 
496
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
497
 
 
498
 
 
499
class ReadingCompleted(InternalBzrError):
 
500
 
 
501
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
502
            "called upon it - the request has been completed and no more "
 
503
            "data may be read.")
 
504
 
 
505
    def __init__(self, request):
 
506
        self.request = request
197
507
 
198
508
 
199
509
class ResourceBusy(PathError):
200
 
    """Device or resource busy: %(path)r%(extra)s"""
 
510
 
 
511
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
201
512
 
202
513
 
203
514
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"""
 
515
 
 
516
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
517
 
 
518
 
 
519
class InvalidURL(PathError):
 
520
 
 
521
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
522
 
 
523
 
 
524
class InvalidURLJoin(PathError):
 
525
 
 
526
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
527
 
 
528
    def __init__(self, reason, base, join_args):
 
529
        self.reason = reason
 
530
        self.base = base
 
531
        self.join_args = join_args
 
532
        PathError.__init__(self, base, reason)
 
533
 
 
534
 
 
535
class InvalidRebaseURLs(PathError):
 
536
 
 
537
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
538
 
 
539
    def __init__(self, from_, to):
 
540
        self.from_ = from_
 
541
        self.to = to
 
542
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
543
 
 
544
 
 
545
class UnavailableRepresentation(InternalBzrError):
 
546
 
 
547
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
548
        "is encoded as '%(native)s'.")
 
549
 
 
550
    def __init__(self, key, wanted, native):
 
551
        InternalBzrError.__init__(self)
 
552
        self.wanted = wanted
 
553
        self.native = native
 
554
        self.key = key
 
555
 
 
556
 
 
557
class UnknownHook(BzrError):
 
558
 
 
559
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
560
 
 
561
    def __init__(self, hook_type, hook_name):
 
562
        BzrError.__init__(self)
 
563
        self.type = hook_type
 
564
        self.hook = hook_name
 
565
 
 
566
 
 
567
class UnsupportedProtocol(PathError):
 
568
 
 
569
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
570
 
 
571
    def __init__(self, url, extra=""):
 
572
        PathError.__init__(self, url, extra=extra)
 
573
 
 
574
 
 
575
class UnstackableBranchFormat(BzrError):
 
576
 
 
577
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
578
        "You will need to upgrade the branch to permit branch stacking.")
 
579
 
 
580
    def __init__(self, format, url):
 
581
        BzrError.__init__(self)
 
582
        self.format = format
 
583
        self.url = url
 
584
 
 
585
 
 
586
class UnstackableLocationError(BzrError):
 
587
 
 
588
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
589
 
 
590
    def __init__(self, branch_url, target_url):
 
591
        BzrError.__init__(self)
 
592
        self.branch_url = branch_url
 
593
        self.target_url = target_url
 
594
 
 
595
 
 
596
class UnstackableRepositoryFormat(BzrError):
 
597
 
 
598
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
599
        "You will need to upgrade the repository to permit branch stacking.")
 
600
 
 
601
    def __init__(self, format, url):
 
602
        BzrError.__init__(self)
 
603
        self.format = format
 
604
        self.url = url
 
605
 
 
606
 
 
607
class ReadError(PathError):
 
608
 
 
609
    _fmt = """Error reading from %(path)r."""
 
610
 
 
611
 
 
612
class ShortReadvError(PathError):
 
613
 
 
614
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
615
            ' at %(offset)s for "%(path)s"%(extra)s')
 
616
 
 
617
    internal_error = True
 
618
 
 
619
    def __init__(self, path, offset, length, actual, extra=None):
 
620
        PathError.__init__(self, path, extra=extra)
 
621
        self.offset = offset
 
622
        self.length = length
 
623
        self.actual = actual
 
624
 
 
625
 
 
626
class PathNotChild(PathError):
 
627
 
 
628
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
629
 
 
630
    internal_error = False
 
631
 
209
632
    def __init__(self, path, base, extra=None):
210
 
        BzrNewError.__init__(self)
 
633
        BzrError.__init__(self)
211
634
        self.path = path
212
635
        self.base = base
213
636
        if extra:
216
639
            self.extra = ''
217
640
 
218
641
 
 
642
class InvalidNormalization(PathError):
 
643
 
 
644
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
645
 
 
646
 
 
647
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
648
# the exception object is a bit undesirable.
 
649
# TODO: Probably this behavior of should be a common superclass
219
650
class NotBranchError(PathError):
220
 
    """Not a branch: %(path)s"""
 
651
 
 
652
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
653
 
 
654
    def __init__(self, path, detail=None, bzrdir=None):
 
655
       import bzrlib.urlutils as urlutils
 
656
       path = urlutils.unescape_for_display(path, 'ascii')
 
657
       if detail is not None:
 
658
           detail = ': ' + detail
 
659
       self.detail = detail
 
660
       self.bzrdir = bzrdir
 
661
       PathError.__init__(self, path=path)
 
662
 
 
663
    def __repr__(self):
 
664
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
665
 
 
666
    def _format(self):
 
667
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
668
        # Python 2.4 have to be old-style classes so properties don't work.
 
669
        # Instead we override _format.
 
670
        if self.detail is None:
 
671
            if self.bzrdir is not None:
 
672
                try:
 
673
                    self.bzrdir.open_repository()
 
674
                except NoRepositoryPresent:
 
675
                    self.detail = ''
 
676
                except Exception:
 
677
                    # Just ignore unexpected errors.  Raising arbitrary errors
 
678
                    # during str(err) can provoke strange bugs.  Concretely
 
679
                    # Launchpad's codehosting managed to raise NotBranchError
 
680
                    # here, and then get stuck in an infinite loop/recursion
 
681
                    # trying to str() that error.  All this error really cares
 
682
                    # about that there's no working repository there, and if
 
683
                    # open_repository() fails, there probably isn't.
 
684
                    self.detail = ''
 
685
                else:
 
686
                    self.detail = ': location is a repository'
 
687
            else:
 
688
                self.detail = ''
 
689
        return PathError._format(self)
 
690
 
 
691
 
 
692
class NoSubmitBranch(PathError):
 
693
 
 
694
    _fmt = 'No submit branch available for branch "%(path)s"'
 
695
 
 
696
    def __init__(self, branch):
 
697
       import bzrlib.urlutils as urlutils
 
698
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
221
699
 
222
700
 
223
701
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"""
 
702
 
 
703
    _fmt = 'Already a branch: "%(path)s".'
 
704
 
 
705
 
 
706
class BranchExistsWithoutWorkingTree(PathError):
 
707
 
 
708
    _fmt = 'Directory contains a branch, but no working tree \
 
709
(use bzr checkout if you wish to build a working tree): "%(path)s"'
 
710
 
 
711
 
 
712
class AtomicFileAlreadyClosed(PathError):
 
713
 
 
714
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
715
            ' "%(path)s"')
 
716
 
 
717
    def __init__(self, path, function):
 
718
        PathError.__init__(self, path=path, extra=None)
 
719
        self.function = function
 
720
 
 
721
 
 
722
class InaccessibleParent(PathError):
 
723
 
 
724
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
725
            ' relative path "%(path)s"')
 
726
 
 
727
    def __init__(self, path, base):
 
728
        PathError.__init__(self, path)
 
729
        self.base = base
 
730
 
 
731
 
 
732
class NoRepositoryPresent(BzrError):
 
733
 
 
734
    _fmt = 'No repository present: "%(path)s"'
229
735
    def __init__(self, bzrdir):
230
 
        BzrNewError.__init__(self)
 
736
        BzrError.__init__(self)
231
737
        self.path = bzrdir.transport.clone('..').base
232
738
 
233
739
 
234
 
class FileInWrongBranch(BzrNewError):
235
 
    """File %(path)s in not in branch %(branch_base)s."""
236
 
 
237
 
    def __init__(self, branch, path):
238
 
        BzrNewError.__init__(self)
239
 
        self.branch = branch
240
 
        self.branch_base = branch.base
241
 
        self.path = path
242
 
 
243
 
 
244
740
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]
 
741
 
 
742
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
248
743
 
249
744
 
250
745
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."""
 
746
 
 
747
    _fmt = "Unknown %(kind)s format: %(format)r"
 
748
 
 
749
    def __init__(self, format, kind='branch'):
 
750
        self.kind = kind
 
751
        self.format = format
 
752
 
 
753
 
 
754
class IncompatibleFormat(BzrError):
 
755
 
 
756
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
258
757
 
259
758
    def __init__(self, format, bzrdir_format):
260
 
        BzrNewError.__init__(self)
 
759
        BzrError.__init__(self)
261
760
        self.format = format
262
761
        self.bzrdir = bzrdir_format
263
762
 
264
763
 
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"""
 
764
class IncompatibleRepositories(BzrError):
 
765
    """Report an error that two repositories are not compatible.
 
766
 
 
767
    Note that the source and target repositories are permitted to be strings:
 
768
    this exception is thrown from the smart server and may refer to a
 
769
    repository the client hasn't opened.
 
770
    """
 
771
 
 
772
    _fmt = "%(target)s\n" \
 
773
            "is not compatible with\n" \
 
774
            "%(source)s\n" \
 
775
            "%(details)s"
 
776
 
 
777
    def __init__(self, source, target, details=None):
 
778
        if details is None:
 
779
            details = "(no details)"
 
780
        BzrError.__init__(self, target=target, source=source, details=details)
 
781
 
 
782
 
 
783
class IncompatibleRevision(BzrError):
 
784
 
 
785
    _fmt = "Revision is not compatible with %(repo_format)s"
 
786
 
 
787
    def __init__(self, repo_format):
 
788
        BzrError.__init__(self)
 
789
        self.repo_format = repo_format
 
790
 
 
791
 
 
792
class AlreadyVersionedError(BzrError):
 
793
    """Used when a path is expected not to be versioned, but it is."""
 
794
 
 
795
    _fmt = "%(context_info)s%(path)s is already versioned."
 
796
 
 
797
    def __init__(self, path, context_info=None):
 
798
        """Construct a new AlreadyVersionedError.
 
799
 
 
800
        :param path: This is the path which is versioned,
 
801
            which should be in a user friendly form.
 
802
        :param context_info: If given, this is information about the context,
 
803
            which could explain why this is expected to not be versioned.
 
804
        """
 
805
        BzrError.__init__(self)
 
806
        self.path = path
 
807
        if context_info is None:
 
808
            self.context_info = ''
 
809
        else:
 
810
            self.context_info = context_info + ". "
 
811
 
 
812
 
 
813
class NotVersionedError(BzrError):
 
814
    """Used when a path is expected to be versioned, but it is not."""
 
815
 
 
816
    _fmt = "%(context_info)s%(path)s is not versioned."
 
817
 
 
818
    def __init__(self, path, context_info=None):
 
819
        """Construct a new NotVersionedError.
 
820
 
 
821
        :param path: This is the path which is not versioned,
 
822
            which should be in a user friendly form.
 
823
        :param context_info: If given, this is information about the context,
 
824
            which could explain why this is expected to be versioned.
 
825
        """
 
826
        BzrError.__init__(self)
 
827
        self.path = path
 
828
        if context_info is None:
 
829
            self.context_info = ''
 
830
        else:
 
831
            self.context_info = context_info + ". "
 
832
 
 
833
 
 
834
class PathsNotVersionedError(BzrError):
 
835
    """Used when reporting several paths which are not versioned"""
 
836
 
 
837
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
275
838
 
276
839
    def __init__(self, paths):
277
840
        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])
 
841
        BzrError.__init__(self)
 
842
        self.paths = paths
 
843
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
844
 
 
845
 
 
846
class PathsDoNotExist(BzrError):
 
847
 
 
848
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
849
 
 
850
    # used when reporting that paths are neither versioned nor in the working
 
851
    # tree
 
852
 
 
853
    def __init__(self, paths, extra=None):
 
854
        # circular import
 
855
        from bzrlib.osutils import quotefn
 
856
        BzrError.__init__(self)
 
857
        self.paths = paths
 
858
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
859
        if extra:
 
860
            self.extra = ': ' + str(extra)
 
861
        else:
 
862
            self.extra = ''
281
863
 
282
864
 
283
865
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"""
 
866
 
 
867
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
868
 
 
869
    def __init__(self, filename, kind):
 
870
        BzrError.__init__(self, filename=filename, kind=kind)
 
871
 
 
872
 
 
873
class BadFilenameEncoding(BzrError):
 
874
 
 
875
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
876
            ' encoding %(fs_encoding)s')
 
877
 
 
878
    def __init__(self, filename, fs_encoding):
 
879
        BzrError.__init__(self)
 
880
        self.filename = filename
 
881
        self.fs_encoding = fs_encoding
 
882
 
 
883
 
 
884
class ForbiddenControlFileError(BzrError):
 
885
 
 
886
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
887
 
 
888
 
 
889
class LockError(InternalBzrError):
 
890
 
 
891
    _fmt = "Lock error: %(msg)s"
 
892
 
295
893
    # All exceptions from the lock/unlock functions should be from
296
894
    # this exception class.  They will be translated as necessary. The
297
895
    # original exception is available as e.original_error
298
896
    #
299
897
    # New code should prefer to raise specific subclasses
300
 
    def __init__(self, message):
301
 
        self.message = message
 
898
    def __init__(self, msg):
 
899
        self.msg = msg
 
900
 
 
901
 
 
902
class LockActive(LockError):
 
903
 
 
904
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
905
 
 
906
    internal_error = False
 
907
 
 
908
    def __init__(self, lock_description):
 
909
        self.lock_description = lock_description
302
910
 
303
911
 
304
912
class CommitNotPossible(LockError):
305
 
    """A commit was attempted but we do not have a write lock open."""
 
913
 
 
914
    _fmt = "A commit was attempted but we do not have a write lock open."
 
915
 
306
916
    def __init__(self):
307
917
        pass
308
918
 
309
919
 
310
920
class AlreadyCommitted(LockError):
311
 
    """A rollback was requested, but is not able to be accomplished."""
 
921
 
 
922
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
923
 
312
924
    def __init__(self):
313
925
        pass
314
926
 
315
927
 
316
928
class ReadOnlyError(LockError):
317
 
    """A write attempt was made in a read only transaction on %(obj)s"""
 
929
 
 
930
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
931
 
 
932
    # TODO: There should also be an error indicating that you need a write
 
933
    # lock and don't have any lock at all... mbp 20070226
 
934
 
318
935
    def __init__(self, obj):
319
936
        self.obj = obj
320
937
 
321
938
 
322
 
class OutSideTransaction(BzrNewError):
323
 
    """A transaction related operation was attempted after the transaction finished."""
 
939
class LockFailed(LockError):
 
940
 
 
941
    internal_error = False
 
942
 
 
943
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
944
 
 
945
    def __init__(self, lock, why):
 
946
        LockError.__init__(self, '')
 
947
        self.lock = lock
 
948
        self.why = why
 
949
 
 
950
 
 
951
class OutSideTransaction(BzrError):
 
952
 
 
953
    _fmt = ("A transaction related operation was attempted after"
 
954
            " the transaction finished.")
324
955
 
325
956
 
326
957
class ObjectNotLocked(LockError):
327
 
    """%(obj)r is not locked"""
 
958
 
 
959
    _fmt = "%(obj)r is not locked"
 
960
 
328
961
    # this can indicate that any particular object is not locked; see also
329
962
    # LockNotHeld which means that a particular *lock* object is not held by
330
963
    # the caller -- perhaps they should be unified.
333
966
 
334
967
 
335
968
class ReadOnlyObjectDirtiedError(ReadOnlyError):
336
 
    """Cannot change object %(obj)r in read only transaction"""
 
969
 
 
970
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
971
 
337
972
    def __init__(self, obj):
338
973
        self.obj = obj
339
974
 
340
975
 
341
976
class UnlockableTransport(LockError):
342
 
    """Cannot lock: transport is read only: %(transport)s"""
 
977
 
 
978
    internal_error = False
 
979
 
 
980
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
981
 
343
982
    def __init__(self, transport):
344
983
        self.transport = transport
345
984
 
346
985
 
347
986
class LockContention(LockError):
348
 
    """Could not acquire lock %(lock)s"""
349
 
    # TODO: show full url for lock, combining the transport and relative bits?
350
 
    def __init__(self, lock):
 
987
 
 
988
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
989
 
 
990
    internal_error = False
 
991
 
 
992
    def __init__(self, lock, msg=''):
351
993
        self.lock = lock
 
994
        self.msg = msg
352
995
 
353
996
 
354
997
class LockBroken(LockError):
355
 
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
998
 
 
999
    _fmt = ("Lock was broken while still open: %(lock)s"
 
1000
            " - check storage consistency!")
 
1001
 
 
1002
    internal_error = False
 
1003
 
356
1004
    def __init__(self, lock):
357
1005
        self.lock = lock
358
1006
 
359
1007
 
360
1008
class LockBreakMismatch(LockError):
361
 
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
1009
 
 
1010
    _fmt = ("Lock was released and re-acquired before being broken:"
 
1011
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
1012
 
 
1013
    internal_error = False
 
1014
 
362
1015
    def __init__(self, lock, holder, target):
363
1016
        self.lock = lock
364
1017
        self.holder = holder
365
1018
        self.target = target
366
1019
 
367
1020
 
 
1021
class LockCorrupt(LockError):
 
1022
 
 
1023
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
1024
            "Use 'bzr break-lock' to clear it")
 
1025
 
 
1026
    internal_error = False
 
1027
 
 
1028
    def __init__(self, corruption_info, file_data=None):
 
1029
        self.corruption_info = corruption_info
 
1030
        self.file_data = file_data
 
1031
 
 
1032
 
368
1033
class LockNotHeld(LockError):
369
 
    """Lock not held: %(lock)s"""
 
1034
 
 
1035
    _fmt = "Lock not held: %(lock)s"
 
1036
 
 
1037
    internal_error = False
 
1038
 
370
1039
    def __init__(self, lock):
371
1040
        self.lock = lock
372
1041
 
373
1042
 
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."""
 
1043
class TokenLockingNotSupported(LockError):
 
1044
 
 
1045
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
1046
 
 
1047
    def __init__(self, obj):
 
1048
        self.obj = obj
 
1049
 
 
1050
 
 
1051
class TokenMismatch(LockBroken):
 
1052
 
 
1053
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
1054
 
 
1055
    internal_error = True
 
1056
 
 
1057
    def __init__(self, given_token, lock_token):
 
1058
        self.given_token = given_token
 
1059
        self.lock_token = lock_token
 
1060
 
 
1061
 
 
1062
class PointlessCommit(BzrError):
 
1063
 
 
1064
    _fmt = "No changes to commit"
 
1065
 
 
1066
 
 
1067
class CannotCommitSelectedFileMerge(BzrError):
 
1068
 
 
1069
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1070
        ' files %(files_str)s'
 
1071
 
 
1072
    def __init__(self, files):
 
1073
        files_str = ', '.join(files)
 
1074
        BzrError.__init__(self, files=files, files_str=files_str)
 
1075
 
 
1076
 
 
1077
class ExcludesUnsupported(BzrError):
 
1078
 
 
1079
    _fmt = ('Excluding paths during commit is not supported by '
 
1080
            'repository at %(repository)r.')
 
1081
 
 
1082
    def __init__(self, repository):
 
1083
        BzrError.__init__(self, repository=repository)
 
1084
 
 
1085
 
 
1086
class BadCommitMessageEncoding(BzrError):
 
1087
 
 
1088
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1089
        'the current encoding.'
 
1090
 
 
1091
 
 
1092
class UpgradeReadonly(BzrError):
 
1093
 
 
1094
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
1095
 
 
1096
 
 
1097
class UpToDateFormat(BzrError):
 
1098
 
 
1099
    _fmt = "The branch format %(format)s is already at the most recent format."
384
1100
 
385
1101
    def __init__(self, format):
386
 
        BzrNewError.__init__(self)
 
1102
        BzrError.__init__(self)
387
1103
        self.format = format
388
1104
 
389
1105
 
390
 
 
391
1106
class StrictCommitFailed(Exception):
392
 
    """Commit refused because there are unknowns in the tree."""
393
 
 
394
 
 
395
 
class NoSuchRevision(BzrError):
 
1107
 
 
1108
    _fmt = "Commit refused because there are unknowns in the tree."
 
1109
 
 
1110
 
 
1111
class NoSuchRevision(InternalBzrError):
 
1112
 
 
1113
    _fmt = "%(branch)s has no revision %(revision)s"
 
1114
 
396
1115
    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)
 
1116
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
1117
        BzrError.__init__(self, branch=branch, revision=revision)
 
1118
 
 
1119
 
 
1120
class RangeInChangeOption(BzrError):
 
1121
 
 
1122
    _fmt = "Option --change does not accept revision ranges"
 
1123
 
 
1124
 
 
1125
class NoSuchRevisionSpec(BzrError):
 
1126
 
 
1127
    _fmt = "No namespace registered for string: %(spec)r"
 
1128
 
 
1129
    def __init__(self, spec):
 
1130
        BzrError.__init__(self, spec=spec)
 
1131
 
 
1132
 
 
1133
class NoSuchRevisionInTree(NoSuchRevision):
 
1134
    """When using Tree.revision_tree, and the revision is not accessible."""
 
1135
 
 
1136
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
1137
 
 
1138
    def __init__(self, tree, revision_id):
 
1139
        BzrError.__init__(self)
 
1140
        self.tree = tree
 
1141
        self.revision_id = revision_id
 
1142
 
 
1143
 
 
1144
class InvalidRevisionSpec(BzrError):
 
1145
 
 
1146
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
1147
            " %(branch_url)s%(extra)s")
 
1148
 
 
1149
    def __init__(self, spec, branch, extra=None):
 
1150
        BzrError.__init__(self, branch=branch, spec=spec)
 
1151
        self.branch_url = getattr(branch, 'user_url', str(branch))
 
1152
        if extra:
 
1153
            self.extra = '\n' + str(extra)
 
1154
        else:
 
1155
            self.extra = ''
401
1156
 
402
1157
 
403
1158
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))
 
1159
 
 
1160
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1161
 
 
1162
 
 
1163
class AppendRevisionsOnlyViolation(BzrError):
 
1164
 
 
1165
    _fmt = ('Operation denied because it would change the main history,'
 
1166
           ' which is not permitted by the append_revisions_only setting on'
 
1167
           ' branch "%(location)s".')
 
1168
 
 
1169
    def __init__(self, location):
 
1170
       import bzrlib.urlutils as urlutils
 
1171
       location = urlutils.unescape_for_display(location, 'ascii')
 
1172
       BzrError.__init__(self, location=location)
409
1173
 
410
1174
 
411
1175
class DivergedBranches(BzrError):
412
1176
 
 
1177
    _fmt = ("These branches have diverged."
 
1178
            " Use the missing command to see how.\n"
 
1179
            "Use the merge command to reconcile them.")
 
1180
 
413
1181
    def __init__(self, branch1, branch2):
414
 
        BzrError.__init__(self, "These branches have diverged.  Try merge.")
415
1182
        self.branch1 = branch1
416
1183
        self.branch2 = branch2
417
1184
 
418
1185
 
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)
 
1186
class NotLefthandHistory(InternalBzrError):
 
1187
 
 
1188
    _fmt = "Supplied history does not follow left-hand parents"
 
1189
 
 
1190
    def __init__(self, history):
 
1191
        BzrError.__init__(self, history=history)
 
1192
 
 
1193
 
 
1194
class UnrelatedBranches(BzrError):
 
1195
 
 
1196
    _fmt = ("Branches have no common ancestor, and"
 
1197
            " no merge base revision was specified.")
 
1198
 
 
1199
 
 
1200
class CannotReverseCherrypick(BzrError):
 
1201
 
 
1202
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1203
            ' or diff3.')
424
1204
 
425
1205
 
426
1206
class NoCommonAncestor(BzrError):
 
1207
 
 
1208
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1209
 
427
1210
    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)
 
1211
        self.revision_a = revision_a
 
1212
        self.revision_b = revision_b
431
1213
 
432
1214
 
433
1215
class NoCommonRoot(BzrError):
 
1216
 
 
1217
    _fmt = ("Revisions are not derived from the same root: "
 
1218
           "%(revision_a)s %(revision_b)s.")
 
1219
 
434
1220
    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
 
 
 
1221
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
439
1222
 
440
1223
 
441
1224
class NotAncestor(BzrError):
 
1225
 
 
1226
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1227
 
442
1228
    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
448
 
 
449
 
 
450
 
class InstallFailed(BzrError):
451
 
    def __init__(self, revisions):
452
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
453
 
        BzrError.__init__(self, msg)
454
 
        self.revisions = revisions
455
 
 
456
 
 
457
 
class AmbiguousBase(BzrError):
458
 
    def __init__(self, bases):
459
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
460
 
                DeprecationWarning)
461
 
        msg = "The correct base is unclear, becase %s are all equally close" %\
462
 
            ", ".join(bases)
463
 
        BzrError.__init__(self, msg)
464
 
        self.bases = bases
465
 
 
466
 
 
467
 
class NoCommits(BzrError):
468
 
    def __init__(self, branch):
469
 
        msg = "Branch %s has no commits." % branch
470
 
        BzrError.__init__(self, msg)
 
1229
        BzrError.__init__(self, rev_id=rev_id,
 
1230
            not_ancestor_id=not_ancestor_id)
 
1231
 
 
1232
 
 
1233
class NoCommits(BranchError):
 
1234
 
 
1235
    _fmt = "Branch %(branch)s has no commits."
471
1236
 
472
1237
 
473
1238
class UnlistableStore(BzrError):
 
1239
 
474
1240
    def __init__(self, store):
475
1241
        BzrError.__init__(self, "Store %s is not listable" % store)
476
1242
 
477
1243
 
478
1244
 
479
1245
class UnlistableBranch(BzrError):
 
1246
 
480
1247
    def __init__(self, br):
481
1248
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
482
1249
 
483
1250
 
484
 
class BoundBranchOutOfDate(BzrNewError):
485
 
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
1251
class BoundBranchOutOfDate(BzrError):
 
1252
 
 
1253
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1254
            " %(master)s.%(extra_help)s")
 
1255
 
486
1256
    def __init__(self, branch, master):
487
 
        BzrNewError.__init__(self)
 
1257
        BzrError.__init__(self)
488
1258
        self.branch = branch
489
1259
        self.master = master
490
 
 
491
 
        
492
 
class CommitToDoubleBoundBranch(BzrNewError):
493
 
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
1260
        self.extra_help = ''
 
1261
 
 
1262
 
 
1263
class CommitToDoubleBoundBranch(BzrError):
 
1264
 
 
1265
    _fmt = ("Cannot commit to branch %(branch)s."
 
1266
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1267
 
494
1268
    def __init__(self, branch, master, remote):
495
 
        BzrNewError.__init__(self)
 
1269
        BzrError.__init__(self)
496
1270
        self.branch = branch
497
1271
        self.master = master
498
1272
        self.remote = remote
499
1273
 
500
1274
 
501
 
class OverwriteBoundBranch(BzrNewError):
502
 
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
1275
class OverwriteBoundBranch(BzrError):
 
1276
 
 
1277
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1278
 
503
1279
    def __init__(self, branch):
504
 
        BzrNewError.__init__(self)
 
1280
        BzrError.__init__(self)
505
1281
        self.branch = branch
506
1282
 
507
1283
 
508
 
class BoundBranchConnectionFailure(BzrNewError):
509
 
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
1284
class BoundBranchConnectionFailure(BzrError):
 
1285
 
 
1286
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1287
            " => %(target)s: %(error)s")
 
1288
 
510
1289
    def __init__(self, branch, target, error):
511
 
        BzrNewError.__init__(self)
 
1290
        BzrError.__init__(self)
512
1291
        self.branch = branch
513
1292
        self.target = target
514
1293
        self.error = error
515
1294
 
516
1295
 
517
 
class WeaveError(BzrNewError):
518
 
    """Error in processing weave: %(message)s"""
519
 
 
520
 
    def __init__(self, message=None):
521
 
        BzrNewError.__init__(self)
522
 
        self.message = message
 
1296
class WeaveError(BzrError):
 
1297
 
 
1298
    _fmt = "Error in processing weave: %(msg)s"
 
1299
 
 
1300
    def __init__(self, msg=None):
 
1301
        BzrError.__init__(self)
 
1302
        self.msg = msg
523
1303
 
524
1304
 
525
1305
class WeaveRevisionAlreadyPresent(WeaveError):
526
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
1306
 
 
1307
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1308
 
527
1309
    def __init__(self, revision_id, weave):
528
1310
 
529
1311
        WeaveError.__init__(self)
532
1314
 
533
1315
 
534
1316
class WeaveRevisionNotPresent(WeaveError):
535
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
1317
 
 
1318
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
536
1319
 
537
1320
    def __init__(self, revision_id, weave):
538
1321
        WeaveError.__init__(self)
541
1324
 
542
1325
 
543
1326
class WeaveFormatError(WeaveError):
544
 
    """Weave invariant violated: %(what)s"""
 
1327
 
 
1328
    _fmt = "Weave invariant violated: %(what)s"
545
1329
 
546
1330
    def __init__(self, what):
547
1331
        WeaveError.__init__(self)
549
1333
 
550
1334
 
551
1335
class WeaveParentMismatch(WeaveError):
552
 
    """Parents are mismatched between two revisions."""
553
 
    
 
1336
 
 
1337
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
1338
 
554
1339
 
555
1340
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."""
 
1341
 
 
1342
    _fmt = "Text did not match its checksum: %(msg)s"
 
1343
 
 
1344
 
 
1345
class WeaveTextDiffers(WeaveError):
 
1346
 
 
1347
    _fmt = ("Weaves differ on text content. Revision:"
 
1348
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1349
 
 
1350
    def __init__(self, revision_id, weave_a, weave_b):
 
1351
        WeaveError.__init__(self)
 
1352
        self.revision_id = revision_id
 
1353
        self.weave_a = weave_a
 
1354
        self.weave_b = weave_b
 
1355
 
 
1356
 
 
1357
class WeaveTextDiffers(WeaveError):
 
1358
 
 
1359
    _fmt = ("Weaves differ on text content. Revision:"
 
1360
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1361
 
 
1362
    def __init__(self, revision_id, weave_a, weave_b):
 
1363
        WeaveError.__init__(self)
 
1364
        self.revision_id = revision_id
 
1365
        self.weave_a = weave_a
 
1366
        self.weave_b = weave_b
 
1367
 
 
1368
 
 
1369
class VersionedFileError(BzrError):
 
1370
 
 
1371
    _fmt = "Versioned file error"
581
1372
 
582
1373
 
583
1374
class RevisionNotPresent(VersionedFileError):
584
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
1375
 
 
1376
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
585
1377
 
586
1378
    def __init__(self, revision_id, file_id):
587
1379
        VersionedFileError.__init__(self)
590
1382
 
591
1383
 
592
1384
class RevisionAlreadyPresent(VersionedFileError):
593
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
1385
 
 
1386
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
594
1387
 
595
1388
    def __init__(self, revision_id, file_id):
596
1389
        VersionedFileError.__init__(self)
598
1391
        self.file_id = file_id
599
1392
 
600
1393
 
601
 
class KnitError(BzrNewError):
602
 
    """Knit error"""
603
 
 
604
 
 
605
 
class KnitHeaderError(KnitError):
606
 
    """Knit header error: %(badline)r unexpected"""
607
 
 
608
 
    def __init__(self, badline):
609
 
        KnitError.__init__(self)
610
 
        self.badline = badline
 
1394
class VersionedFileInvalidChecksum(VersionedFileError):
 
1395
 
 
1396
    _fmt = "Text did not match its checksum: %(msg)s"
 
1397
 
 
1398
 
 
1399
class KnitError(InternalBzrError):
 
1400
 
 
1401
    _fmt = "Knit error"
611
1402
 
612
1403
 
613
1404
class KnitCorrupt(KnitError):
614
 
    """Knit %(filename)s corrupt: %(how)s"""
 
1405
 
 
1406
    _fmt = "Knit %(filename)s corrupt: %(how)s"
615
1407
 
616
1408
    def __init__(self, filename, how):
617
1409
        KnitError.__init__(self)
619
1411
        self.how = how
620
1412
 
621
1413
 
622
 
class NoSuchExportFormat(BzrNewError):
623
 
    """Export format %(format)r not supported"""
 
1414
class SHA1KnitCorrupt(KnitCorrupt):
 
1415
 
 
1416
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1417
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1418
        "sha %(actual)s")
 
1419
 
 
1420
    def __init__(self, filename, actual, expected, key, content):
 
1421
        KnitError.__init__(self)
 
1422
        self.filename = filename
 
1423
        self.actual = actual
 
1424
        self.expected = expected
 
1425
        self.key = key
 
1426
        self.content = content
 
1427
 
 
1428
 
 
1429
class KnitDataStreamIncompatible(KnitError):
 
1430
    # Not raised anymore, as we can convert data streams.  In future we may
 
1431
    # need it again for more exotic cases, so we're keeping it around for now.
 
1432
 
 
1433
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1434
 
 
1435
    def __init__(self, stream_format, target_format):
 
1436
        self.stream_format = stream_format
 
1437
        self.target_format = target_format
 
1438
 
 
1439
 
 
1440
class KnitDataStreamUnknown(KnitError):
 
1441
    # Indicates a data stream we don't know how to handle.
 
1442
 
 
1443
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1444
 
 
1445
    def __init__(self, stream_format):
 
1446
        self.stream_format = stream_format
 
1447
 
 
1448
 
 
1449
class KnitHeaderError(KnitError):
 
1450
 
 
1451
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1452
 
 
1453
    def __init__(self, badline, filename):
 
1454
        KnitError.__init__(self)
 
1455
        self.badline = badline
 
1456
        self.filename = filename
 
1457
 
 
1458
class KnitIndexUnknownMethod(KnitError):
 
1459
    """Raised when we don't understand the storage method.
 
1460
 
 
1461
    Currently only 'fulltext' and 'line-delta' are supported.
 
1462
    """
 
1463
 
 
1464
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1465
            " in options: %(options)r")
 
1466
 
 
1467
    def __init__(self, filename, options):
 
1468
        KnitError.__init__(self)
 
1469
        self.filename = filename
 
1470
        self.options = options
 
1471
 
 
1472
 
 
1473
class RetryWithNewPacks(BzrError):
 
1474
    """Raised when we realize that the packs on disk have changed.
 
1475
 
 
1476
    This is meant as more of a signaling exception, to trap between where a
 
1477
    local error occurred and the code that can actually handle the error and
 
1478
    code that can retry appropriately.
 
1479
    """
 
1480
 
 
1481
    internal_error = True
 
1482
 
 
1483
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1484
            " %(orig_error)s")
 
1485
 
 
1486
    def __init__(self, context, reload_occurred, exc_info):
 
1487
        """create a new RetryWithNewPacks error.
 
1488
 
 
1489
        :param reload_occurred: Set to True if we know that the packs have
 
1490
            already been reloaded, and we are failing because of an in-memory
 
1491
            cache miss. If set to True then we will ignore if a reload says
 
1492
            nothing has changed, because we assume it has already reloaded. If
 
1493
            False, then a reload with nothing changed will force an error.
 
1494
        :param exc_info: The original exception traceback, so if there is a
 
1495
            problem we can raise the original error (value from sys.exc_info())
 
1496
        """
 
1497
        BzrError.__init__(self)
 
1498
        self.context = context
 
1499
        self.reload_occurred = reload_occurred
 
1500
        self.exc_info = exc_info
 
1501
        self.orig_error = exc_info[1]
 
1502
        # TODO: The global error handler should probably treat this by
 
1503
        #       raising/printing the original exception with a bit about
 
1504
        #       RetryWithNewPacks also not being caught
 
1505
 
 
1506
 
 
1507
class RetryAutopack(RetryWithNewPacks):
 
1508
    """Raised when we are autopacking and we find a missing file.
 
1509
 
 
1510
    Meant as a signaling exception, to tell the autopack code it should try
 
1511
    again.
 
1512
    """
 
1513
 
 
1514
    internal_error = True
 
1515
 
 
1516
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1517
            " context: %(context)s %(orig_error)s")
 
1518
 
 
1519
 
 
1520
class NoSuchExportFormat(BzrError):
 
1521
 
 
1522
    _fmt = "Export format %(format)r not supported"
 
1523
 
624
1524
    def __init__(self, format):
625
 
        BzrNewError.__init__(self)
 
1525
        BzrError.__init__(self)
626
1526
        self.format = format
627
1527
 
628
1528
 
629
1529
class TransportError(BzrError):
630
 
    """All errors thrown by Transport implementations should derive
631
 
    from this class.
632
 
    """
 
1530
 
 
1531
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1532
 
633
1533
    def __init__(self, msg=None, orig_error=None):
634
1534
        if msg is None and orig_error is not None:
635
1535
            msg = str(orig_error)
636
 
        BzrError.__init__(self, msg)
 
1536
        if orig_error is None:
 
1537
            orig_error = ''
 
1538
        if msg is None:
 
1539
            msg =  ''
637
1540
        self.msg = msg
638
1541
        self.orig_error = orig_error
 
1542
        BzrError.__init__(self)
 
1543
 
 
1544
 
 
1545
class TooManyConcurrentRequests(InternalBzrError):
 
1546
 
 
1547
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1548
            " Be sure to finish_writing and finish_reading on the"
 
1549
            " currently open request.")
 
1550
 
 
1551
    def __init__(self, medium):
 
1552
        self.medium = medium
 
1553
 
 
1554
 
 
1555
class SmartProtocolError(TransportError):
 
1556
 
 
1557
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1558
 
 
1559
    def __init__(self, details):
 
1560
        self.details = details
 
1561
 
 
1562
 
 
1563
class UnexpectedProtocolVersionMarker(TransportError):
 
1564
 
 
1565
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1566
 
 
1567
    def __init__(self, marker):
 
1568
        self.marker = marker
 
1569
 
 
1570
 
 
1571
class UnknownSmartMethod(InternalBzrError):
 
1572
 
 
1573
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1574
 
 
1575
    def __init__(self, verb):
 
1576
        self.verb = verb
 
1577
 
 
1578
 
 
1579
class SmartMessageHandlerError(InternalBzrError):
 
1580
 
 
1581
    _fmt = ("The message handler raised an exception:\n"
 
1582
            "%(traceback_text)s")
 
1583
 
 
1584
    def __init__(self, exc_info):
 
1585
        import traceback
 
1586
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1587
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1588
        self.exc_info = exc_info
 
1589
        traceback_strings = traceback.format_exception(
 
1590
                self.exc_type, self.exc_value, self.exc_tb)
 
1591
        self.traceback_text = ''.join(traceback_strings)
639
1592
 
640
1593
 
641
1594
# A set of semi-meaningful errors which can be thrown
642
1595
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
 
1596
 
 
1597
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
647
1598
 
648
1599
 
649
1600
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)
656
 
 
657
 
 
 
1601
 
 
1602
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1603
 
 
1604
 
 
1605
class SocketConnectionError(ConnectionError):
 
1606
 
 
1607
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1608
 
 
1609
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1610
        if msg is None:
 
1611
            msg = 'Failed to connect to'
 
1612
        if orig_error is None:
 
1613
            orig_error = ''
 
1614
        else:
 
1615
            orig_error = '; ' + str(orig_error)
 
1616
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1617
        self.host = host
 
1618
        if port is None:
 
1619
            self.port = ''
 
1620
        else:
 
1621
            self.port = ':%s' % port
 
1622
 
 
1623
 
 
1624
# XXX: This is also used for unexpected end of file, which is different at the
 
1625
# TCP level from "connection reset".
658
1626
class ConnectionReset(TransportError):
659
 
    """The connection has been closed."""
660
 
    pass
 
1627
 
 
1628
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1629
 
 
1630
 
 
1631
class ConnectionTimeout(ConnectionError):
 
1632
 
 
1633
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1634
 
 
1635
 
 
1636
class InvalidRange(TransportError):
 
1637
 
 
1638
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1639
 
 
1640
    def __init__(self, path, offset, msg=None):
 
1641
        TransportError.__init__(self, msg)
 
1642
        self.path = path
 
1643
        self.offset = offset
 
1644
 
 
1645
 
 
1646
class InvalidHttpResponse(TransportError):
 
1647
 
 
1648
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1649
 
 
1650
    def __init__(self, path, msg, orig_error=None):
 
1651
        self.path = path
 
1652
        if orig_error is None:
 
1653
            orig_error = ''
 
1654
        else:
 
1655
            # This is reached for obscure and unusual errors so we want to
 
1656
            # preserve as much info as possible to ease debug.
 
1657
            orig_error = ': %r' % (orig_error,)
 
1658
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1659
 
 
1660
 
 
1661
class InvalidHttpRange(InvalidHttpResponse):
 
1662
 
 
1663
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1664
 
 
1665
    def __init__(self, path, range, msg):
 
1666
        self.range = range
 
1667
        InvalidHttpResponse.__init__(self, path, msg)
 
1668
 
 
1669
 
 
1670
class HttpBoundaryMissing(InvalidHttpResponse):
 
1671
    """A multipart response ends with no boundary marker.
 
1672
 
 
1673
    This is a special case caused by buggy proxies, described in
 
1674
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1675
    """
 
1676
 
 
1677
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1678
 
 
1679
    def __init__(self, path, msg):
 
1680
        InvalidHttpResponse.__init__(self, path, msg)
 
1681
 
 
1682
 
 
1683
class InvalidHttpContentType(InvalidHttpResponse):
 
1684
 
 
1685
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1686
 
 
1687
    def __init__(self, path, ctype, msg):
 
1688
        self.ctype = ctype
 
1689
        InvalidHttpResponse.__init__(self, path, msg)
 
1690
 
 
1691
 
 
1692
class RedirectRequested(TransportError):
 
1693
 
 
1694
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1695
 
 
1696
    def __init__(self, source, target, is_permanent=False):
 
1697
        self.source = source
 
1698
        self.target = target
 
1699
        if is_permanent:
 
1700
            self.permanently = ' permanently'
 
1701
        else:
 
1702
            self.permanently = ''
 
1703
        TransportError.__init__(self)
 
1704
 
 
1705
 
 
1706
class TooManyRedirections(TransportError):
 
1707
 
 
1708
    _fmt = "Too many redirections"
661
1709
 
662
1710
 
663
1711
class ConflictsInTree(BzrError):
664
 
    def __init__(self):
665
 
        BzrError.__init__(self, "Working tree has conflicts.")
 
1712
 
 
1713
    _fmt = "Working tree has conflicts."
 
1714
 
 
1715
 
 
1716
class ConfigContentError(BzrError):
 
1717
 
 
1718
    _fmt = "Config file %(filename)s is not UTF-8 encoded\n"
 
1719
 
 
1720
    def __init__(self, filename):
 
1721
        BzrError.__init__(self)
 
1722
        self.filename = filename
666
1723
 
667
1724
 
668
1725
class ParseConfigError(BzrError):
 
1726
 
 
1727
    _fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
 
1728
 
669
1729
    def __init__(self, errors, filename):
670
 
        if filename is None:
671
 
            filename = ""
672
 
        message = "Error(s) parsing config file %s:\n%s" % \
673
 
            (filename, ('\n'.join(e.message for e in errors)))
674
 
        BzrError.__init__(self, message)
 
1730
        BzrError.__init__(self)
 
1731
        self.filename = filename
 
1732
        self.errors = '\n'.join(e.msg for e in errors)
 
1733
 
 
1734
 
 
1735
class ConfigOptionValueError(BzrError):
 
1736
 
 
1737
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
1738
 
 
1739
    def __init__(self, name, value):
 
1740
        BzrError.__init__(self, name=name, value=value)
 
1741
 
 
1742
 
 
1743
class NoEmailInUsername(BzrError):
 
1744
 
 
1745
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1746
 
 
1747
    def __init__(self, username):
 
1748
        BzrError.__init__(self)
 
1749
        self.username = username
675
1750
 
676
1751
 
677
1752
class SigningFailed(BzrError):
 
1753
 
 
1754
    _fmt = 'Failed to GPG sign data with command "%(command_line)s"'
 
1755
 
678
1756
    def __init__(self, command_line):
679
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
680
 
                               % command_line)
 
1757
        BzrError.__init__(self, command_line=command_line)
 
1758
 
 
1759
 
 
1760
class SignatureVerificationFailed(BzrError):
 
1761
 
 
1762
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
1763
 
 
1764
    def __init__(self, error):
 
1765
        BzrError.__init__(self, error=error)
 
1766
 
 
1767
 
 
1768
class DependencyNotPresent(BzrError):
 
1769
 
 
1770
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1771
 
 
1772
    def __init__(self, library, error):
 
1773
        BzrError.__init__(self, library=library, error=error)
 
1774
 
 
1775
 
 
1776
class GpgmeNotInstalled(DependencyNotPresent):
 
1777
 
 
1778
    _fmt = 'python-gpgme is not installed, it is needed to verify signatures'
 
1779
 
 
1780
    def __init__(self, error):
 
1781
        DependencyNotPresent.__init__(self, 'gpgme', error)
681
1782
 
682
1783
 
683
1784
class WorkingTreeNotRevision(BzrError):
 
1785
 
 
1786
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1787
            " the last commit, but weave merge requires that it be"
 
1788
            " unchanged")
 
1789
 
684
1790
    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"""
 
1791
        BzrError.__init__(self, basedir=tree.basedir)
 
1792
 
 
1793
 
 
1794
class CantReprocessAndShowBase(BzrError):
 
1795
 
 
1796
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1797
           "the relationship of conflicting lines to the base")
 
1798
 
 
1799
 
 
1800
class GraphCycleError(BzrError):
 
1801
 
 
1802
    _fmt = "Cycle in graph %(graph)r"
 
1803
 
697
1804
    def __init__(self, graph):
698
 
        BzrNewError.__init__(self)
 
1805
        BzrError.__init__(self)
699
1806
        self.graph = graph
700
1807
 
701
1808
 
702
 
class NotConflicted(BzrNewError):
703
 
    """File %(filename)s is not conflicted."""
 
1809
class WritingCompleted(InternalBzrError):
 
1810
 
 
1811
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1812
            "called upon it - accept bytes may not be called anymore.")
 
1813
 
 
1814
    def __init__(self, request):
 
1815
        self.request = request
 
1816
 
 
1817
 
 
1818
class WritingNotComplete(InternalBzrError):
 
1819
 
 
1820
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1821
            "called upon it - until the write phase is complete no "
 
1822
            "data may be read.")
 
1823
 
 
1824
    def __init__(self, request):
 
1825
        self.request = request
 
1826
 
 
1827
 
 
1828
class NotConflicted(BzrError):
 
1829
 
 
1830
    _fmt = "File %(filename)s is not conflicted."
704
1831
 
705
1832
    def __init__(self, filename):
706
 
        BzrNewError.__init__(self)
 
1833
        BzrError.__init__(self)
707
1834
        self.filename = filename
708
1835
 
709
1836
 
 
1837
class MediumNotConnected(InternalBzrError):
 
1838
 
 
1839
    _fmt = """The medium '%(medium)s' is not connected."""
 
1840
 
 
1841
    def __init__(self, medium):
 
1842
        self.medium = medium
 
1843
 
 
1844
 
710
1845
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"""
 
1846
 
 
1847
    _fmt = "A decorating function has requested its original command be used."
 
1848
 
 
1849
 
 
1850
class NoBundleFound(BzrError):
 
1851
 
 
1852
    _fmt = 'No bundle was found in "%(filename)s".'
 
1853
 
 
1854
    def __init__(self, filename):
 
1855
        BzrError.__init__(self)
 
1856
        self.filename = filename
 
1857
 
 
1858
 
 
1859
class BundleNotSupported(BzrError):
 
1860
 
 
1861
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1862
 
 
1863
    def __init__(self, version, msg):
 
1864
        BzrError.__init__(self)
 
1865
        self.version = version
 
1866
        self.msg = msg
 
1867
 
 
1868
 
 
1869
class MissingText(BzrError):
 
1870
 
 
1871
    _fmt = ("Branch %(base)s is missing revision"
 
1872
            " %(text_revision)s of %(file_id)s")
719
1873
 
720
1874
    def __init__(self, branch, text_revision, file_id):
721
 
        BzrNewError.__init__(self)
 
1875
        BzrError.__init__(self)
722
1876
        self.branch = branch
723
1877
        self.base = branch.base
724
1878
        self.text_revision = text_revision
725
1879
        self.file_id = file_id
726
1880
 
727
1881
 
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
 
    """
 
1882
class DuplicateFileId(BzrError):
 
1883
 
 
1884
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1885
 
 
1886
    def __init__(self, file_id, entry):
 
1887
        BzrError.__init__(self)
 
1888
        self.file_id = file_id
 
1889
        self.entry = entry
 
1890
 
 
1891
 
 
1892
class DuplicateKey(BzrError):
 
1893
 
 
1894
    _fmt = "Key %(key)s is already present in map"
 
1895
 
 
1896
 
 
1897
class DuplicateHelpPrefix(BzrError):
 
1898
 
 
1899
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1900
 
 
1901
    def __init__(self, prefix):
 
1902
        self.prefix = prefix
 
1903
 
 
1904
 
 
1905
class MalformedTransform(InternalBzrError):
 
1906
 
 
1907
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1908
 
 
1909
 
 
1910
class NoFinalPath(BzrError):
 
1911
 
 
1912
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1913
            "file-id: %(file_id)r\n"
 
1914
            "root trans-id: %(root_trans_id)r\n")
 
1915
 
 
1916
    def __init__(self, trans_id, transform):
 
1917
        self.trans_id = trans_id
 
1918
        self.file_id = transform.final_file_id(trans_id)
 
1919
        self.root_trans_id = transform.root
 
1920
 
 
1921
 
 
1922
class BzrBadParameter(InternalBzrError):
 
1923
 
 
1924
    _fmt = "Bad parameter: %(param)r"
 
1925
 
 
1926
    # This exception should never be thrown, but it is a base class for all
 
1927
    # parameter-to-function errors.
 
1928
 
742
1929
    def __init__(self, param):
743
 
        BzrNewError.__init__(self)
 
1930
        BzrError.__init__(self)
744
1931
        self.param = param
745
1932
 
746
1933
 
747
1934
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"""
 
1935
 
 
1936
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1937
 
 
1938
 
 
1939
class ReusingTransform(BzrError):
 
1940
 
 
1941
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1942
 
 
1943
 
 
1944
class CantMoveRoot(BzrError):
 
1945
 
 
1946
    _fmt = "Moving the root directory is not supported at this time"
 
1947
 
 
1948
 
 
1949
class TransformRenameFailed(BzrError):
 
1950
 
 
1951
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1952
 
 
1953
    def __init__(self, from_path, to_path, why, errno):
 
1954
        self.from_path = from_path
 
1955
        self.to_path = to_path
 
1956
        self.why = why
 
1957
        self.errno = errno
 
1958
 
 
1959
 
 
1960
class BzrMoveFailedError(BzrError):
 
1961
 
 
1962
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1963
        "%(_has_extra)s%(extra)s")
 
1964
 
 
1965
    def __init__(self, from_path='', to_path='', extra=None):
 
1966
        from bzrlib.osutils import splitpath
 
1967
        BzrError.__init__(self)
 
1968
        if extra:
 
1969
            self.extra, self._has_extra = extra, ': '
 
1970
        else:
 
1971
            self.extra = self._has_extra = ''
 
1972
 
 
1973
        has_from = len(from_path) > 0
 
1974
        has_to = len(to_path) > 0
 
1975
        if has_from:
 
1976
            self.from_path = splitpath(from_path)[-1]
 
1977
        else:
 
1978
            self.from_path = ''
 
1979
 
 
1980
        if has_to:
 
1981
            self.to_path = splitpath(to_path)[-1]
 
1982
        else:
 
1983
            self.to_path = ''
 
1984
 
 
1985
        self.operator = ""
 
1986
        if has_from and has_to:
 
1987
            self.operator = " =>"
 
1988
        elif has_from:
 
1989
            self.from_path = "from " + from_path
 
1990
        elif has_to:
 
1991
            self.operator = "to"
 
1992
        else:
 
1993
            self.operator = "file"
 
1994
 
 
1995
 
 
1996
class BzrRenameFailedError(BzrMoveFailedError):
 
1997
 
 
1998
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
1999
        "%(_has_extra)s%(extra)s")
 
2000
 
 
2001
    def __init__(self, from_path, to_path, extra=None):
 
2002
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
757
2003
 
758
2004
 
759
2005
class BzrBadParameterNotString(BzrBadParameter):
760
 
    """Parameter %(param)s is not a string or unicode string."""
 
2006
 
 
2007
    _fmt = "Parameter %(param)s is not a string or unicode string."
761
2008
 
762
2009
 
763
2010
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"""
769
 
 
770
 
    def __init__(self, library, error):
771
 
        BzrNewError.__init__(self, library=library, error=error)
 
2011
 
 
2012
    _fmt = "Parameter %(param)s is required but not present."
 
2013
 
 
2014
 
 
2015
class BzrBadParameterUnicode(BzrBadParameter):
 
2016
 
 
2017
    _fmt = ("Parameter %(param)s is unicode but"
 
2018
            " only byte-strings are permitted.")
 
2019
 
 
2020
 
 
2021
class BzrBadParameterContainsNewline(BzrBadParameter):
 
2022
 
 
2023
    _fmt = "Parameter %(param)s contains a newline."
772
2024
 
773
2025
 
774
2026
class ParamikoNotPresent(DependencyNotPresent):
775
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
2027
 
 
2028
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
776
2029
 
777
2030
    def __init__(self, error):
778
2031
        DependencyNotPresent.__init__(self, 'paramiko', error)
779
2032
 
780
2033
 
781
 
class UninitializableFormat(BzrNewError):
782
 
    """Format %(format)s cannot be initialised by this version of bzr."""
 
2034
class PointlessMerge(BzrError):
 
2035
 
 
2036
    _fmt = "Nothing to merge."
 
2037
 
 
2038
 
 
2039
class UninitializableFormat(BzrError):
 
2040
 
 
2041
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
783
2042
 
784
2043
    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'."""
815
 
 
816
 
    def __init__(self, tree):
817
 
        BzrNewError.__init__(self)
 
2044
        BzrError.__init__(self)
 
2045
        self.format = format
 
2046
 
 
2047
 
 
2048
class BadConversionTarget(BzrError):
 
2049
 
 
2050
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2051
            "    %(problem)s"
 
2052
 
 
2053
    def __init__(self, problem, format, from_format=None):
 
2054
        BzrError.__init__(self)
 
2055
        self.problem = problem
 
2056
        self.format = format
 
2057
        self.from_format = from_format or '(unspecified)'
 
2058
 
 
2059
 
 
2060
class NoDiffFound(BzrError):
 
2061
 
 
2062
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
2063
 
 
2064
    def __init__(self, path):
 
2065
        BzrError.__init__(self, path)
 
2066
 
 
2067
 
 
2068
class ExecutableMissing(BzrError):
 
2069
 
 
2070
    _fmt = "%(exe_name)s could not be found on this machine"
 
2071
 
 
2072
    def __init__(self, exe_name):
 
2073
        BzrError.__init__(self, exe_name=exe_name)
 
2074
 
 
2075
 
 
2076
class NoDiff(BzrError):
 
2077
 
 
2078
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
2079
 
 
2080
    def __init__(self, msg):
 
2081
        BzrError.__init__(self, msg=msg)
 
2082
 
 
2083
 
 
2084
class NoDiff3(BzrError):
 
2085
 
 
2086
    _fmt = "Diff3 is not installed on this machine."
 
2087
 
 
2088
 
 
2089
class ExistingContent(BzrError):
 
2090
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
 
2091
 
 
2092
    _fmt = "The content being inserted is already present."
 
2093
 
 
2094
 
 
2095
class ExistingLimbo(BzrError):
 
2096
 
 
2097
    _fmt = """This tree contains left-over files from a failed operation.
 
2098
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2099
    keep, and delete it when you are done."""
 
2100
 
 
2101
    def __init__(self, limbo_dir):
 
2102
       BzrError.__init__(self)
 
2103
       self.limbo_dir = limbo_dir
 
2104
 
 
2105
 
 
2106
class ExistingPendingDeletion(BzrError):
 
2107
 
 
2108
    _fmt = """This tree contains left-over files from a failed operation.
 
2109
    Please examine %(pending_deletion)s to see if it contains any files you
 
2110
    wish to keep, and delete it when you are done."""
 
2111
 
 
2112
    def __init__(self, pending_deletion):
 
2113
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2114
 
 
2115
 
 
2116
class ImmortalLimbo(BzrError):
 
2117
 
 
2118
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
2119
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
2120
    keep, and delete it when you are done."""
 
2121
 
 
2122
    def __init__(self, limbo_dir):
 
2123
       BzrError.__init__(self)
 
2124
       self.limbo_dir = limbo_dir
 
2125
 
 
2126
 
 
2127
class ImmortalPendingDeletion(BzrError):
 
2128
 
 
2129
    _fmt = ("Unable to delete transform temporary directory "
 
2130
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
2131
    "contains any files you wish to keep, and delete it when you are done.")
 
2132
 
 
2133
    def __init__(self, pending_deletion):
 
2134
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
2135
 
 
2136
 
 
2137
class OutOfDateTree(BzrError):
 
2138
 
 
2139
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
 
2140
 
 
2141
    def __init__(self, tree, more=None):
 
2142
        if more is None:
 
2143
            more = ''
 
2144
        else:
 
2145
            more = ' ' + more
 
2146
        BzrError.__init__(self)
818
2147
        self.tree = tree
819
 
 
820
 
 
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."""
 
2148
        self.more = more
 
2149
 
 
2150
 
 
2151
class PublicBranchOutOfDate(BzrError):
 
2152
 
 
2153
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
2154
        '"%(revstring)s".'
 
2155
 
 
2156
    def __init__(self, public_location, revstring):
 
2157
        import bzrlib.urlutils as urlutils
 
2158
        public_location = urlutils.unescape_for_display(public_location,
 
2159
                                                        'ascii')
 
2160
        BzrError.__init__(self, public_location=public_location,
 
2161
                          revstring=revstring)
 
2162
 
 
2163
 
 
2164
class MergeModifiedFormatError(BzrError):
 
2165
 
 
2166
    _fmt = "Error in merge modified format"
 
2167
 
 
2168
 
 
2169
class ConflictFormatError(BzrError):
 
2170
 
 
2171
    _fmt = "Format error in conflict listings"
 
2172
 
 
2173
 
 
2174
class CorruptDirstate(BzrError):
 
2175
 
 
2176
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2177
            "Error: %(description)s")
 
2178
 
 
2179
    def __init__(self, dirstate_path, description):
 
2180
        BzrError.__init__(self)
 
2181
        self.dirstate_path = dirstate_path
 
2182
        self.description = description
 
2183
 
 
2184
 
 
2185
class CorruptRepository(BzrError):
 
2186
 
 
2187
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
2188
            "Please run bzr reconcile on this repository.")
832
2189
 
833
2190
    def __init__(self, repo):
834
 
        BzrNewError.__init__(self)
835
 
        self.repo_path = repo.bzrdir.root_transport.base
836
 
 
837
 
 
838
 
class UpgradeRequired(BzrNewError):
839
 
    """To use this feature you must upgrade your branch at %(path)s."""
 
2191
        BzrError.__init__(self)
 
2192
        self.repo_path = repo.user_url
 
2193
 
 
2194
 
 
2195
class InconsistentDelta(BzrError):
 
2196
    """Used when we get a delta that is not valid."""
 
2197
 
 
2198
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
2199
            " %(file_id)r\nreason: %(reason)s")
 
2200
 
 
2201
    def __init__(self, path, file_id, reason):
 
2202
        BzrError.__init__(self)
 
2203
        self.path = path
 
2204
        self.file_id = file_id
 
2205
        self.reason = reason
 
2206
 
 
2207
 
 
2208
class InconsistentDeltaDelta(InconsistentDelta):
 
2209
    """Used when we get a delta that is not valid."""
 
2210
 
 
2211
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2212
            "\nreason: %(reason)s")
 
2213
 
 
2214
    def __init__(self, delta, reason):
 
2215
        BzrError.__init__(self)
 
2216
        self.delta = delta
 
2217
        self.reason = reason
 
2218
 
 
2219
 
 
2220
class UpgradeRequired(BzrError):
 
2221
 
 
2222
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
840
2223
 
841
2224
    def __init__(self, path):
842
 
        BzrNewError.__init__(self)
 
2225
        BzrError.__init__(self)
843
2226
        self.path = path
844
2227
 
845
2228
 
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."""
 
2229
class RepositoryUpgradeRequired(UpgradeRequired):
 
2230
 
 
2231
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
2232
 
 
2233
 
 
2234
class RichRootUpgradeRequired(UpgradeRequired):
 
2235
 
 
2236
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
2237
           " a format which supports rich roots.")
 
2238
 
 
2239
 
 
2240
class LocalRequiresBoundBranch(BzrError):
 
2241
 
 
2242
    _fmt = "Cannot perform local-only commits on unbound branches."
 
2243
 
 
2244
 
 
2245
class UnsupportedOperation(BzrError):
 
2246
 
 
2247
    _fmt = ("The method %(mname)s is not supported on"
 
2248
            " objects of type %(tname)s.")
 
2249
 
856
2250
    def __init__(self, method, method_self):
857
2251
        self.method = method
858
2252
        self.mname = method.__name__
859
2253
        self.tname = type(method_self).__name__
 
2254
 
 
2255
 
 
2256
class CannotSetRevisionId(UnsupportedOperation):
 
2257
    """Raised when a commit is attempting to set a revision id but cant."""
 
2258
 
 
2259
 
 
2260
class NonAsciiRevisionId(UnsupportedOperation):
 
2261
    """Raised when a commit is attempting to set a non-ascii revision id
 
2262
       but cant.
 
2263
    """
 
2264
 
 
2265
 
 
2266
class GhostTagsNotSupported(BzrError):
 
2267
 
 
2268
    _fmt = "Ghost tags not supported by format %(format)r."
 
2269
 
 
2270
    def __init__(self, format):
 
2271
        self.format = format
 
2272
 
 
2273
 
 
2274
class BinaryFile(BzrError):
 
2275
 
 
2276
    _fmt = "File is binary but should be text."
 
2277
 
 
2278
 
 
2279
class IllegalPath(BzrError):
 
2280
 
 
2281
    _fmt = "The path %(path)s is not permitted on this platform"
 
2282
 
 
2283
    def __init__(self, path):
 
2284
        BzrError.__init__(self)
 
2285
        self.path = path
 
2286
 
 
2287
 
 
2288
class TestamentMismatch(BzrError):
 
2289
 
 
2290
    _fmt = """Testament did not match expected value.
 
2291
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
2292
       {%(measured)s}"""
 
2293
 
 
2294
    def __init__(self, revision_id, expected, measured):
 
2295
        self.revision_id = revision_id
 
2296
        self.expected = expected
 
2297
        self.measured = measured
 
2298
 
 
2299
 
 
2300
class NotABundle(BzrError):
 
2301
 
 
2302
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
2303
 
 
2304
    def __init__(self, text):
 
2305
        BzrError.__init__(self)
 
2306
        self.text = text
 
2307
 
 
2308
 
 
2309
class BadBundle(BzrError):
 
2310
 
 
2311
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
2312
 
 
2313
    def __init__(self, text):
 
2314
        BzrError.__init__(self)
 
2315
        self.text = text
 
2316
 
 
2317
 
 
2318
class MalformedHeader(BadBundle):
 
2319
 
 
2320
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
2321
 
 
2322
 
 
2323
class MalformedPatches(BadBundle):
 
2324
 
 
2325
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
2326
 
 
2327
 
 
2328
class MalformedFooter(BadBundle):
 
2329
 
 
2330
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
2331
 
 
2332
 
 
2333
class UnsupportedEOLMarker(BadBundle):
 
2334
 
 
2335
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
2336
 
 
2337
    def __init__(self):
 
2338
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
2339
        # but for this there is not
 
2340
        BzrError.__init__(self)
 
2341
 
 
2342
 
 
2343
class IncompatibleBundleFormat(BzrError):
 
2344
 
 
2345
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
2346
 
 
2347
    def __init__(self, bundle_format, other):
 
2348
        BzrError.__init__(self)
 
2349
        self.bundle_format = bundle_format
 
2350
        self.other = other
 
2351
 
 
2352
 
 
2353
class BadInventoryFormat(BzrError):
 
2354
 
 
2355
    _fmt = "Root class for inventory serialization errors"
 
2356
 
 
2357
 
 
2358
class UnexpectedInventoryFormat(BadInventoryFormat):
 
2359
 
 
2360
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
2361
 
 
2362
    def __init__(self, msg):
 
2363
        BadInventoryFormat.__init__(self, msg=msg)
 
2364
 
 
2365
 
 
2366
class RootNotRich(BzrError):
 
2367
 
 
2368
    _fmt = """This operation requires rich root data storage"""
 
2369
 
 
2370
 
 
2371
class NoSmartMedium(InternalBzrError):
 
2372
 
 
2373
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
2374
 
 
2375
    def __init__(self, transport):
 
2376
        self.transport = transport
 
2377
 
 
2378
 
 
2379
class UnknownSSH(BzrError):
 
2380
 
 
2381
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
2382
 
 
2383
    def __init__(self, vendor):
 
2384
        BzrError.__init__(self)
 
2385
        self.vendor = vendor
 
2386
 
 
2387
 
 
2388
class SSHVendorNotFound(BzrError):
 
2389
 
 
2390
    _fmt = ("Don't know how to handle SSH connections."
 
2391
            " Please set BZR_SSH environment variable.")
 
2392
 
 
2393
 
 
2394
class GhostRevisionsHaveNoRevno(BzrError):
 
2395
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2396
 
 
2397
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2398
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2399
 
 
2400
    def __init__(self, revision_id, ghost_revision_id):
 
2401
        self.revision_id = revision_id
 
2402
        self.ghost_revision_id = ghost_revision_id
 
2403
 
 
2404
 
 
2405
class GhostRevisionUnusableHere(BzrError):
 
2406
 
 
2407
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2408
 
 
2409
    def __init__(self, revision_id):
 
2410
        BzrError.__init__(self)
 
2411
        self.revision_id = revision_id
 
2412
 
 
2413
 
 
2414
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2415
 
 
2416
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2417
            " %(msg)s%(extra)s")
 
2418
 
 
2419
    def __init__(self, name, msg, extra=None):
 
2420
        BzrError.__init__(self)
 
2421
        self.name = name
 
2422
        self.msg = msg
 
2423
        if extra:
 
2424
            self.extra = ': ' + str(extra)
 
2425
        else:
 
2426
            self.extra = ''
 
2427
 
 
2428
 
 
2429
class InvalidImportLine(InternalBzrError):
 
2430
 
 
2431
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2432
 
 
2433
    def __init__(self, text, msg):
 
2434
        BzrError.__init__(self)
 
2435
        self.text = text
 
2436
        self.msg = msg
 
2437
 
 
2438
 
 
2439
class ImportNameCollision(InternalBzrError):
 
2440
 
 
2441
    _fmt = ("Tried to import an object to the same name as"
 
2442
            " an existing object. %(name)s")
 
2443
 
 
2444
    def __init__(self, name):
 
2445
        BzrError.__init__(self)
 
2446
        self.name = name
 
2447
 
 
2448
 
 
2449
class NotAMergeDirective(BzrError):
 
2450
    """File starting with %(firstline)r is not a merge directive"""
 
2451
    def __init__(self, firstline):
 
2452
        BzrError.__init__(self, firstline=firstline)
 
2453
 
 
2454
 
 
2455
class NoMergeSource(BzrError):
 
2456
    """Raise if no merge source was specified for a merge directive"""
 
2457
 
 
2458
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2459
        " branch location."
 
2460
 
 
2461
 
 
2462
class IllegalMergeDirectivePayload(BzrError):
 
2463
    """A merge directive contained something other than a patch or bundle"""
 
2464
 
 
2465
    _fmt = "Bad merge directive payload %(start)r"
 
2466
 
 
2467
    def __init__(self, start):
 
2468
        BzrError(self)
 
2469
        self.start = start
 
2470
 
 
2471
 
 
2472
class PatchVerificationFailed(BzrError):
 
2473
    """A patch from a merge directive could not be verified"""
 
2474
 
 
2475
    _fmt = "Preview patch does not match requested changes."
 
2476
 
 
2477
 
 
2478
class PatchMissing(BzrError):
 
2479
    """Raise a patch type was specified but no patch supplied"""
 
2480
 
 
2481
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2482
 
 
2483
    def __init__(self, patch_type):
 
2484
        BzrError.__init__(self)
 
2485
        self.patch_type = patch_type
 
2486
 
 
2487
 
 
2488
class TargetNotBranch(BzrError):
 
2489
    """A merge directive's target branch is required, but isn't a branch"""
 
2490
 
 
2491
    _fmt = ("Your branch does not have all of the revisions required in "
 
2492
            "order to merge this merge directive and the target "
 
2493
            "location specified in the merge directive is not a branch: "
 
2494
            "%(location)s.")
 
2495
 
 
2496
    def __init__(self, location):
 
2497
        BzrError.__init__(self)
 
2498
        self.location = location
 
2499
 
 
2500
 
 
2501
class UnsupportedInventoryKind(BzrError):
 
2502
 
 
2503
    _fmt = """Unsupported entry kind %(kind)s"""
 
2504
 
 
2505
    def __init__(self, kind):
 
2506
        self.kind = kind
 
2507
 
 
2508
 
 
2509
class BadSubsumeSource(BzrError):
 
2510
 
 
2511
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2512
 
 
2513
    def __init__(self, tree, other_tree, reason):
 
2514
        self.tree = tree
 
2515
        self.other_tree = other_tree
 
2516
        self.reason = reason
 
2517
 
 
2518
 
 
2519
class SubsumeTargetNeedsUpgrade(BzrError):
 
2520
 
 
2521
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2522
 
 
2523
    def __init__(self, other_tree):
 
2524
        self.other_tree = other_tree
 
2525
 
 
2526
 
 
2527
class BadReferenceTarget(InternalBzrError):
 
2528
 
 
2529
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2530
           "%(reason)s"
 
2531
 
 
2532
    def __init__(self, tree, other_tree, reason):
 
2533
        self.tree = tree
 
2534
        self.other_tree = other_tree
 
2535
        self.reason = reason
 
2536
 
 
2537
 
 
2538
class NoSuchTag(BzrError):
 
2539
 
 
2540
    _fmt = "No such tag: %(tag_name)s"
 
2541
 
 
2542
    def __init__(self, tag_name):
 
2543
        self.tag_name = tag_name
 
2544
 
 
2545
 
 
2546
class TagsNotSupported(BzrError):
 
2547
 
 
2548
    _fmt = ("Tags not supported by %(branch)s;"
 
2549
            " you may be able to use bzr upgrade.")
 
2550
 
 
2551
    def __init__(self, branch):
 
2552
        self.branch = branch
 
2553
 
 
2554
 
 
2555
class TagAlreadyExists(BzrError):
 
2556
 
 
2557
    _fmt = "Tag %(tag_name)s already exists."
 
2558
 
 
2559
    def __init__(self, tag_name):
 
2560
        self.tag_name = tag_name
 
2561
 
 
2562
 
 
2563
class MalformedBugIdentifier(BzrError):
 
2564
 
 
2565
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2566
            'See "bzr help bugs" for more information on this feature.')
 
2567
 
 
2568
    def __init__(self, bug_id, reason):
 
2569
        self.bug_id = bug_id
 
2570
        self.reason = reason
 
2571
 
 
2572
 
 
2573
class InvalidBugTrackerURL(BzrError):
 
2574
 
 
2575
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2576
            "contain {id}: %(url)s")
 
2577
 
 
2578
    def __init__(self, abbreviation, url):
 
2579
        self.abbreviation = abbreviation
 
2580
        self.url = url
 
2581
 
 
2582
 
 
2583
class UnknownBugTrackerAbbreviation(BzrError):
 
2584
 
 
2585
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2586
            "on %(branch)s")
 
2587
 
 
2588
    def __init__(self, abbreviation, branch):
 
2589
        self.abbreviation = abbreviation
 
2590
        self.branch = branch
 
2591
 
 
2592
 
 
2593
class InvalidLineInBugsProperty(BzrError):
 
2594
 
 
2595
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2596
 
 
2597
    def __init__(self, line):
 
2598
        self.line = line
 
2599
 
 
2600
 
 
2601
class InvalidBugStatus(BzrError):
 
2602
 
 
2603
    _fmt = ("Invalid bug status: '%(status)s'")
 
2604
 
 
2605
    def __init__(self, status):
 
2606
        self.status = status
 
2607
 
 
2608
 
 
2609
class UnexpectedSmartServerResponse(BzrError):
 
2610
 
 
2611
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2612
 
 
2613
    def __init__(self, response_tuple):
 
2614
        self.response_tuple = response_tuple
 
2615
 
 
2616
 
 
2617
class ErrorFromSmartServer(BzrError):
 
2618
    """An error was received from a smart server.
 
2619
 
 
2620
    :seealso: UnknownErrorFromSmartServer
 
2621
    """
 
2622
 
 
2623
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2624
 
 
2625
    internal_error = True
 
2626
 
 
2627
    def __init__(self, error_tuple):
 
2628
        self.error_tuple = error_tuple
 
2629
        try:
 
2630
            self.error_verb = error_tuple[0]
 
2631
        except IndexError:
 
2632
            self.error_verb = None
 
2633
        self.error_args = error_tuple[1:]
 
2634
 
 
2635
 
 
2636
class UnknownErrorFromSmartServer(BzrError):
 
2637
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
 
2638
    error.
 
2639
 
 
2640
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2641
    distinguish between the following two cases:
 
2642
 
 
2643
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2644
      and so should provoke a traceback to the user.
 
2645
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2646
      translated.  This is probably because the server sent us garbage, and
 
2647
      should not provoke a traceback.
 
2648
    """
 
2649
 
 
2650
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2651
 
 
2652
    internal_error = False
 
2653
 
 
2654
    def __init__(self, error_from_smart_server):
 
2655
        """Constructor.
 
2656
 
 
2657
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2658
        """
 
2659
        self.error_from_smart_server = error_from_smart_server
 
2660
        self.error_tuple = error_from_smart_server.error_tuple
 
2661
 
 
2662
 
 
2663
class ContainerError(BzrError):
 
2664
    """Base class of container errors."""
 
2665
 
 
2666
 
 
2667
class UnknownContainerFormatError(ContainerError):
 
2668
 
 
2669
    _fmt = "Unrecognised container format: %(container_format)r"
 
2670
 
 
2671
    def __init__(self, container_format):
 
2672
        self.container_format = container_format
 
2673
 
 
2674
 
 
2675
class UnexpectedEndOfContainerError(ContainerError):
 
2676
 
 
2677
    _fmt = "Unexpected end of container stream"
 
2678
 
 
2679
 
 
2680
class UnknownRecordTypeError(ContainerError):
 
2681
 
 
2682
    _fmt = "Unknown record type: %(record_type)r"
 
2683
 
 
2684
    def __init__(self, record_type):
 
2685
        self.record_type = record_type
 
2686
 
 
2687
 
 
2688
class InvalidRecordError(ContainerError):
 
2689
 
 
2690
    _fmt = "Invalid record: %(reason)s"
 
2691
 
 
2692
    def __init__(self, reason):
 
2693
        self.reason = reason
 
2694
 
 
2695
 
 
2696
class ContainerHasExcessDataError(ContainerError):
 
2697
 
 
2698
    _fmt = "Container has data after end marker: %(excess)r"
 
2699
 
 
2700
    def __init__(self, excess):
 
2701
        self.excess = excess
 
2702
 
 
2703
 
 
2704
class DuplicateRecordNameError(ContainerError):
 
2705
 
 
2706
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2707
 
 
2708
    def __init__(self, name):
 
2709
        self.name = name.decode("utf-8")
 
2710
 
 
2711
 
 
2712
class NoDestinationAddress(InternalBzrError):
 
2713
 
 
2714
    _fmt = "Message does not have a destination address."
 
2715
 
 
2716
 
 
2717
class RepositoryDataStreamError(BzrError):
 
2718
 
 
2719
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2720
 
 
2721
    def __init__(self, reason):
 
2722
        self.reason = reason
 
2723
 
 
2724
 
 
2725
class SMTPError(BzrError):
 
2726
 
 
2727
    _fmt = "SMTP error: %(error)s"
 
2728
 
 
2729
    def __init__(self, error):
 
2730
        self.error = error
 
2731
 
 
2732
 
 
2733
class NoMessageSupplied(BzrError):
 
2734
 
 
2735
    _fmt = "No message supplied."
 
2736
 
 
2737
 
 
2738
class NoMailAddressSpecified(BzrError):
 
2739
 
 
2740
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2741
 
 
2742
 
 
2743
class UnknownMailClient(BzrError):
 
2744
 
 
2745
    _fmt = "Unknown mail client: %(mail_client)s"
 
2746
 
 
2747
    def __init__(self, mail_client):
 
2748
        BzrError.__init__(self, mail_client=mail_client)
 
2749
 
 
2750
 
 
2751
class MailClientNotFound(BzrError):
 
2752
 
 
2753
    _fmt = "Unable to find mail client with the following names:"\
 
2754
        " %(mail_command_list_string)s"
 
2755
 
 
2756
    def __init__(self, mail_command_list):
 
2757
        mail_command_list_string = ', '.join(mail_command_list)
 
2758
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2759
                          mail_command_list_string=mail_command_list_string)
 
2760
 
 
2761
class SMTPConnectionRefused(SMTPError):
 
2762
 
 
2763
    _fmt = "SMTP connection to %(host)s refused"
 
2764
 
 
2765
    def __init__(self, error, host):
 
2766
        self.error = error
 
2767
        self.host = host
 
2768
 
 
2769
 
 
2770
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2771
 
 
2772
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2773
 
 
2774
 
 
2775
class BzrDirError(BzrError):
 
2776
 
 
2777
    def __init__(self, bzrdir):
 
2778
        import bzrlib.urlutils as urlutils
 
2779
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
 
2780
                                                    'ascii')
 
2781
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2782
 
 
2783
 
 
2784
class UnsyncedBranches(BzrDirError):
 
2785
 
 
2786
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2787
            " bzr help sync-for-reconfigure.")
 
2788
 
 
2789
    def __init__(self, bzrdir, target_branch):
 
2790
        BzrDirError.__init__(self, bzrdir)
 
2791
        import bzrlib.urlutils as urlutils
 
2792
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2793
                                                        'ascii')
 
2794
 
 
2795
 
 
2796
class AlreadyBranch(BzrDirError):
 
2797
 
 
2798
    _fmt = "'%(display_url)s' is already a branch."
 
2799
 
 
2800
 
 
2801
class AlreadyTree(BzrDirError):
 
2802
 
 
2803
    _fmt = "'%(display_url)s' is already a tree."
 
2804
 
 
2805
 
 
2806
class AlreadyCheckout(BzrDirError):
 
2807
 
 
2808
    _fmt = "'%(display_url)s' is already a checkout."
 
2809
 
 
2810
 
 
2811
class AlreadyLightweightCheckout(BzrDirError):
 
2812
 
 
2813
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2814
 
 
2815
 
 
2816
class AlreadyUsingShared(BzrDirError):
 
2817
 
 
2818
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2819
 
 
2820
 
 
2821
class AlreadyStandalone(BzrDirError):
 
2822
 
 
2823
    _fmt = "'%(display_url)s' is already standalone."
 
2824
 
 
2825
 
 
2826
class AlreadyWithTrees(BzrDirError):
 
2827
 
 
2828
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2829
            "working trees.")
 
2830
 
 
2831
 
 
2832
class AlreadyWithNoTrees(BzrDirError):
 
2833
 
 
2834
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2835
            "working trees.")
 
2836
 
 
2837
 
 
2838
class ReconfigurationNotSupported(BzrDirError):
 
2839
 
 
2840
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2841
 
 
2842
 
 
2843
class NoBindLocation(BzrDirError):
 
2844
 
 
2845
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2846
 
 
2847
 
 
2848
class UncommittedChanges(BzrError):
 
2849
 
 
2850
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2851
            ' (See bzr status).%(more)s')
 
2852
 
 
2853
    def __init__(self, tree, more=None):
 
2854
        if more is None:
 
2855
            more = ''
 
2856
        else:
 
2857
            more = ' ' + more
 
2858
        import bzrlib.urlutils as urlutils
 
2859
        user_url = getattr(tree, "user_url", None)
 
2860
        if user_url is None:
 
2861
            display_url = str(tree)
 
2862
        else:
 
2863
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2864
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2865
 
 
2866
 
 
2867
class ShelvedChanges(UncommittedChanges):
 
2868
 
 
2869
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2870
            ' (See bzr shelve --list).%(more)s')
 
2871
 
 
2872
 
 
2873
class MissingTemplateVariable(BzrError):
 
2874
 
 
2875
    _fmt = 'Variable {%(name)s} is not available.'
 
2876
 
 
2877
    def __init__(self, name):
 
2878
        self.name = name
 
2879
 
 
2880
 
 
2881
class NoTemplate(BzrError):
 
2882
 
 
2883
    _fmt = 'No template specified.'
 
2884
 
 
2885
 
 
2886
class UnableCreateSymlink(BzrError):
 
2887
 
 
2888
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2889
 
 
2890
    def __init__(self, path=None):
 
2891
        path_str = ''
 
2892
        if path:
 
2893
            try:
 
2894
                path_str = repr(str(path))
 
2895
            except UnicodeEncodeError:
 
2896
                path_str = repr(path)
 
2897
            path_str += ' '
 
2898
        self.path_str = path_str
 
2899
 
 
2900
 
 
2901
class UnsupportedTimezoneFormat(BzrError):
 
2902
 
 
2903
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2904
            'options are "utc", "original", "local".')
 
2905
 
 
2906
    def __init__(self, timezone):
 
2907
        self.timezone = timezone
 
2908
 
 
2909
 
 
2910
class CommandAvailableInPlugin(StandardError):
 
2911
 
 
2912
    internal_error = False
 
2913
 
 
2914
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2915
 
 
2916
        self.plugin_metadata = plugin_metadata
 
2917
        self.cmd_name = cmd_name
 
2918
        self.provider = provider
 
2919
 
 
2920
    def __str__(self):
 
2921
 
 
2922
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2923
                'However, the following official plugin provides this command: %s\n'
 
2924
                'You can install it by going to: %s'
 
2925
                % (self.cmd_name, self.plugin_metadata['name'],
 
2926
                    self.plugin_metadata['url']))
 
2927
 
 
2928
        return _fmt
 
2929
 
 
2930
 
 
2931
class NoPluginAvailable(BzrError):
 
2932
    pass
 
2933
 
 
2934
 
 
2935
class UnableEncodePath(BzrError):
 
2936
 
 
2937
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2938
            'user encoding %(user_encoding)s')
 
2939
 
 
2940
    def __init__(self, path, kind):
 
2941
        from bzrlib.osutils import get_user_encoding
 
2942
        self.path = path
 
2943
        self.kind = kind
 
2944
        self.user_encoding = get_user_encoding()
 
2945
 
 
2946
 
 
2947
class NoSuchConfig(BzrError):
 
2948
 
 
2949
    _fmt = ('The "%(config_id)s" configuration does not exist.')
 
2950
 
 
2951
    def __init__(self, config_id):
 
2952
        BzrError.__init__(self, config_id=config_id)
 
2953
 
 
2954
 
 
2955
class NoSuchConfigOption(BzrError):
 
2956
 
 
2957
    _fmt = ('The "%(option_name)s" configuration option does not exist.')
 
2958
 
 
2959
    def __init__(self, option_name):
 
2960
        BzrError.__init__(self, option_name=option_name)
 
2961
 
 
2962
 
 
2963
class NoSuchAlias(BzrError):
 
2964
 
 
2965
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2966
 
 
2967
    def __init__(self, alias_name):
 
2968
        BzrError.__init__(self, alias_name=alias_name)
 
2969
 
 
2970
 
 
2971
class DirectoryLookupFailure(BzrError):
 
2972
    """Base type for lookup errors."""
 
2973
 
 
2974
    pass
 
2975
 
 
2976
 
 
2977
class InvalidLocationAlias(DirectoryLookupFailure):
 
2978
 
 
2979
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2980
 
 
2981
    def __init__(self, alias_name):
 
2982
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2983
 
 
2984
 
 
2985
class UnsetLocationAlias(DirectoryLookupFailure):
 
2986
 
 
2987
    _fmt = 'No %(alias_name)s location assigned.'
 
2988
 
 
2989
    def __init__(self, alias_name):
 
2990
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2991
 
 
2992
 
 
2993
class CannotBindAddress(BzrError):
 
2994
 
 
2995
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2996
 
 
2997
    def __init__(self, host, port, orig_error):
 
2998
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2999
        BzrError.__init__(self, host=host, port=port,
 
3000
            orig_error=repr(orig_error.args))
 
3001
 
 
3002
 
 
3003
class UnknownRules(BzrError):
 
3004
 
 
3005
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
3006
 
 
3007
    def __init__(self, unknowns):
 
3008
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
3009
 
 
3010
 
 
3011
class TipChangeRejected(BzrError):
 
3012
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
3013
    explicitly abort a change to a branch tip.
 
3014
    """
 
3015
 
 
3016
    _fmt = u"Tip change rejected: %(msg)s"
 
3017
 
 
3018
    def __init__(self, msg):
 
3019
        self.msg = msg
 
3020
 
 
3021
 
 
3022
class ShelfCorrupt(BzrError):
 
3023
 
 
3024
    _fmt = "Shelf corrupt."
 
3025
 
 
3026
 
 
3027
class DecompressCorruption(BzrError):
 
3028
 
 
3029
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
3030
 
 
3031
    def __init__(self, orig_error=None):
 
3032
        if orig_error is not None:
 
3033
            self.orig_error = ", %s" % (orig_error,)
 
3034
        else:
 
3035
            self.orig_error = ""
 
3036
        BzrError.__init__(self)
 
3037
 
 
3038
 
 
3039
class NoSuchShelfId(BzrError):
 
3040
 
 
3041
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3042
 
 
3043
    def __init__(self, shelf_id):
 
3044
        BzrError.__init__(self, shelf_id=shelf_id)
 
3045
 
 
3046
 
 
3047
class InvalidShelfId(BzrError):
 
3048
 
 
3049
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3050
 
 
3051
    def __init__(self, invalid_id):
 
3052
        BzrError.__init__(self, invalid_id=invalid_id)
 
3053
 
 
3054
 
 
3055
class JailBreak(BzrError):
 
3056
 
 
3057
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
3058
 
 
3059
    def __init__(self, url):
 
3060
        BzrError.__init__(self, url=url)
 
3061
 
 
3062
 
 
3063
class UserAbort(BzrError):
 
3064
 
 
3065
    _fmt = 'The user aborted the operation.'
 
3066
 
 
3067
 
 
3068
class MustHaveWorkingTree(BzrError):
 
3069
 
 
3070
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3071
 
 
3072
    def __init__(self, format, url):
 
3073
        BzrError.__init__(self, format=format, url=url)
 
3074
 
 
3075
 
 
3076
class NoSuchView(BzrError):
 
3077
    """A view does not exist.
 
3078
    """
 
3079
 
 
3080
    _fmt = u"No such view: %(view_name)s."
 
3081
 
 
3082
    def __init__(self, view_name):
 
3083
        self.view_name = view_name
 
3084
 
 
3085
 
 
3086
class ViewsNotSupported(BzrError):
 
3087
    """Views are not supported by a tree format.
 
3088
    """
 
3089
 
 
3090
    _fmt = ("Views are not supported by %(tree)s;"
 
3091
            " use 'bzr upgrade' to change your tree to a later format.")
 
3092
 
 
3093
    def __init__(self, tree):
 
3094
        self.tree = tree
 
3095
 
 
3096
 
 
3097
class FileOutsideView(BzrError):
 
3098
 
 
3099
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3100
            '%(view_str)s')
 
3101
 
 
3102
    def __init__(self, file_name, view_files):
 
3103
        self.file_name = file_name
 
3104
        self.view_str = ", ".join(view_files)
 
3105
 
 
3106
 
 
3107
class UnresumableWriteGroup(BzrError):
 
3108
 
 
3109
    _fmt = ("Repository %(repository)s cannot resume write group "
 
3110
            "%(write_groups)r: %(reason)s")
 
3111
 
 
3112
    internal_error = True
 
3113
 
 
3114
    def __init__(self, repository, write_groups, reason):
 
3115
        self.repository = repository
 
3116
        self.write_groups = write_groups
 
3117
        self.reason = reason
 
3118
 
 
3119
 
 
3120
class UnsuspendableWriteGroup(BzrError):
 
3121
 
 
3122
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
3123
 
 
3124
    internal_error = True
 
3125
 
 
3126
    def __init__(self, repository):
 
3127
        self.repository = repository
 
3128
 
 
3129
 
 
3130
class LossyPushToSameVCS(BzrError):
 
3131
 
 
3132
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
3133
            "%(target_branch)r that are in the same VCS.")
 
3134
 
 
3135
    internal_error = True
 
3136
 
 
3137
    def __init__(self, source_branch, target_branch):
 
3138
        self.source_branch = source_branch
 
3139
        self.target_branch = target_branch
 
3140
 
 
3141
 
 
3142
class NoRoundtrippingSupport(BzrError):
 
3143
 
 
3144
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3145
            "%(target_branch)r.")
 
3146
 
 
3147
    internal_error = True
 
3148
 
 
3149
    def __init__(self, source_branch, target_branch):
 
3150
        self.source_branch = source_branch
 
3151
        self.target_branch = target_branch
 
3152
 
 
3153
 
 
3154
class FileTimestampUnavailable(BzrError):
 
3155
 
 
3156
    _fmt = "The filestamp for %(path)s is not available."
 
3157
 
 
3158
    internal_error = True
 
3159
 
 
3160
    def __init__(self, path):
 
3161
        self.path = path
 
3162
 
 
3163
 
 
3164
class NoColocatedBranchSupport(BzrError):
 
3165
 
 
3166
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3167
 
 
3168
    def __init__(self, bzrdir):
 
3169
        self.bzrdir = bzrdir
 
3170
 
 
3171
 
 
3172
class NoWhoami(BzrError):
 
3173
 
 
3174
    _fmt = ('Unable to determine your name.\n'
 
3175
        "Please, set your name with the 'whoami' command.\n"
 
3176
        'E.g. bzr whoami "Your Name <name@example.com>"')
 
3177
 
 
3178
 
 
3179
class InvalidPattern(BzrError):
 
3180
 
 
3181
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3182
 
 
3183
    def __init__(self, msg):
 
3184
        self.msg = msg
 
3185
 
 
3186
 
 
3187
class RecursiveBind(BzrError):
 
3188
 
 
3189
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3190
        'Please use `bzr unbind` to fix.')
 
3191
 
 
3192
    def __init__(self, branch_url):
 
3193
        self.branch_url = branch_url
 
3194
 
 
3195
 
 
3196
# FIXME: I would prefer to define the config related exception classes in
 
3197
# config.py but the lazy import mechanism proscribes this -- vila 20101222
 
3198
class OptionExpansionLoop(BzrError):
 
3199
 
 
3200
    _fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
 
3201
 
 
3202
    def __init__(self, string, refs):
 
3203
        self.string = string
 
3204
        self.refs = '->'.join(refs)
 
3205
 
 
3206
 
 
3207
class ExpandingUnknownOption(BzrError):
 
3208
 
 
3209
    _fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
 
3210
 
 
3211
    def __init__(self, name, string):
 
3212
        self.name = name
 
3213
        self.string = string
 
3214
 
 
3215
 
 
3216
class NoCompatibleInter(BzrError):
 
3217
 
 
3218
    _fmt = ('No compatible object available for operations from %(source)r '
 
3219
            'to %(target)r.')
 
3220
 
 
3221
    def __init__(self, source, target):
 
3222
        self.source = source
 
3223
        self.target = target
 
3224
 
 
3225
 
 
3226
class HpssVfsRequestNotAllowed(BzrError):
 
3227
 
 
3228
    _fmt = ("VFS requests over the smart server are not allowed. Encountered: "
 
3229
            "%(method)s, %(arguments)s.")
 
3230
 
 
3231
    def __init__(self, method, arguments):
 
3232
        self.method = method
 
3233
        self.arguments = arguments
 
3234
 
 
3235
 
 
3236
class UnsupportedKindChange(BzrError):
 
3237
 
 
3238
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
3239
            "%(path)s not supported by format %(format)r")
 
3240
 
 
3241
    def __init__(self, path, from_kind, to_kind, format):
 
3242
        self.path = path
 
3243
        self.from_kind = from_kind
 
3244
        self.to_kind = to_kind
 
3245
        self.format = format
 
3246
 
 
3247
 
 
3248
class PatchSyntax(BzrError):
 
3249
    """Base class for patch syntax errors."""
 
3250
 
 
3251
 
 
3252
class BinaryFiles(BzrError):
 
3253
 
 
3254
    _fmt = 'Binary files section encountered.'
 
3255
 
 
3256
    def __init__(self, orig_name, mod_name):
 
3257
        self.orig_name = orig_name
 
3258
        self.mod_name = mod_name
 
3259
 
 
3260
 
 
3261
class MalformedPatchHeader(PatchSyntax):
 
3262
 
 
3263
    _fmt = "Malformed patch header.  %(desc)s\n%(line)r"
 
3264
 
 
3265
    def __init__(self, desc, line):
 
3266
        self.desc = desc
 
3267
        self.line = line
 
3268
 
 
3269
 
 
3270
class MalformedHunkHeader(PatchSyntax):
 
3271
 
 
3272
    _fmt = "Malformed hunk header.  %(desc)s\n%(line)r"
 
3273
 
 
3274
    def __init__(self, desc, line):
 
3275
        self.desc = desc
 
3276
        self.line = line
 
3277
 
 
3278
 
 
3279
class MalformedLine(PatchSyntax):
 
3280
 
 
3281
    _fmt = "Malformed line.  %(desc)s\n%(line)r"
 
3282
 
 
3283
    def __init__(self, desc, line):
 
3284
        self.desc = desc
 
3285
        self.line = line
 
3286
 
 
3287
 
 
3288
class PatchConflict(BzrError):
 
3289
 
 
3290
    _fmt = ('Text contents mismatch at line %(line_no)d.  Original has '
 
3291
            '"%(orig_line)s", but patch says it should be "%(patch_line)s"')
 
3292
 
 
3293
    def __init__(self, line_no, orig_line, patch_line):
 
3294
        self.line_no = line_no
 
3295
        self.orig_line = orig_line.rstrip('\n')
 
3296
        self.patch_line = patch_line.rstrip('\n')