~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: 2008-07-16 18:36:24 UTC
  • mfrom: (3514.2.19 weave_merge)
  • Revision ID: pqm@pqm.ubuntu.com-20080716183624-7yu6n1raw6sa4x80
(jam) Restore the real Weave merge for --format=weave.

Show diffs side-by-side

added added

removed removed

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