~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2005-11-28 08:03:42 UTC
  • mto: (1185.33.61 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 1518.
  • Revision ID: mbp@sourcefrog.net-20051128080342-b7db3190dca90484
[broken] start converting basic_io to more rfc822-like format

Suggestions from mailing list:
 
  no double quotes
  no cute right-alignment
  no escaping
  just indent continuation lines

Show diffs side-by-side

added added

removed removed

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