/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-06-05 03:02:10 UTC
  • mfrom: (3472.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080605030210-xwokghqkg4sqo1xy
Isolate the test HTTPServer from chdir calls (Robert Collins)

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