~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil, Patch Queue Manager, Jelmer Vernooij
  • Date: 2017-01-17 16:20:41 UTC
  • mfrom: (6619.1.2 trunk)
  • Revision ID: tarmac-20170117162041-oo62uk1qsmgc9j31
Merge 2.7 into trunk including fixes for bugs #1622039, #1644003, #1579093 and #1645017. [r=vila]

Show diffs side-by-side

added added

removed removed

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