~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2008-10-16 21:27:10 UTC
  • mfrom: (0.15.26 unshelve)
  • mto: (0.16.74 shelf-ui)
  • mto: This revision was merged to the branch mainline in revision 3820.
  • Revision ID: aaron@aaronbentley.com-20081016212710-h9av3nhk76dvmsv5
Merge with unshelve

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