/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Andrew Bennetts
  • Date: 2008-07-25 06:42:08 UTC
  • mto: This revision was merged to the branch mainline in revision 3581.
  • Revision ID: andrew.bennetts@canonical.com-20080725064208-ui70gluukdypd4y9
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.

Show diffs side-by-side

added added

removed removed

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