~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

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