/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 bzrlib/errors.py

  • Committer: Robey Pointer
  • Date: 2006-09-08 18:46:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908184629-e3fc4c61ca21508c
pychecker is on crack; go back to using 'is None'.

Show diffs side-by-side

added added

removed removed

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