~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Compare URLs in RemoteRepository.__eq__, rather than '_client' attributes.

Show diffs side-by-side

added added

removed removed

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