/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: Canonical.com Patch Queue Manager
  • Date: 2008-04-28 18:43:56 UTC
  • mfrom: (3363.2.11 preview-tree-changed)
  • Revision ID: pqm@pqm.ubuntu.com-20080428184356-qic5mhqzrgxlwwhs
(abentley) Get _PreviewTree under test

Show diffs side-by-side

added added

removed removed

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