/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Robert Collins
  • Date: 2007-06-28 02:43:50 UTC
  • mfrom: (2553 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2558.
  • Revision ID: robertc@robertcollins.net-20070628024350-z8bdm0y6yz2uyf4o
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

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