/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/errors.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2019-07-07 19:22:03 UTC
  • mfrom: (7358.8.5 diff-binary-weird)
  • Revision ID: breezy.the.bot@gmail.com-20190707192203-n32v0wih963qdi6i
Don't include datestamps in filenames when reporting on binary files.

Merged from https://code.launchpad.net/~jelmer/brz/diff-binary-weird/+merge/369474

Show diffs side-by-side

added added

removed removed

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