~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

Show diffs side-by-side

added added

removed removed

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