/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

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