~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-05-08 20:32:56 UTC
  • mfrom: (2483.1.2 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070508203256-wcxwdphd1y2psezh
(John Arbash Meinel) Merge fixes from 0.16 into bzr.dev and update for 0.17 development

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