~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

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