/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 breezy/errors.py

  • Committer: Jelmer Vernooij
  • Date: 2017-08-07 11:49:46 UTC
  • mto: (6747.3.4 avoid-set-revid-3)
  • mto: This revision was merged to the branch mainline in revision 6750.
  • Revision ID: jelmer@jelmer.uk-20170807114946-luclmxuawyzhpiot
Avoid setting revision_ids.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2013, 2016 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
from __future__ import absolute_import
 
21
 
 
22
from .sixish import (
 
23
    PY3,
 
24
    )
 
25
 
 
26
# TODO: is there any value in providing the .args field used by standard
 
27
# python exceptions?   A list of values with no names seems less useful
 
28
# to me.
 
29
 
 
30
# TODO: Perhaps convert the exception to a string at the moment it's
 
31
# constructed to make sure it will succeed.  But that says nothing about
 
32
# exceptions that are never raised.
 
33
 
 
34
# TODO: selftest assertRaises should probably also check that every error
 
35
# raised can be formatted as a string successfully, and without giving
 
36
# 'unprintable'.
 
37
 
 
38
 
 
39
# return codes from the brz program
 
40
EXIT_OK = 0
 
41
EXIT_ERROR = 3
 
42
EXIT_INTERNAL_ERROR = 4
 
43
 
 
44
 
 
45
class BzrError(Exception):
 
46
    """
 
47
    Base class for errors raised by breezy.
 
48
 
 
49
    :cvar internal_error: if True this was probably caused by a brz bug and
 
50
        should be displayed with a traceback; if False (or absent) this was
 
51
        probably a user or environment error and they don't need the gory
 
52
        details.  (That can be overridden by -Derror on the command line.)
 
53
 
 
54
    :cvar _fmt: Format string to display the error; this is expanded
 
55
        by the instance's dict.
 
56
    """
 
57
 
 
58
    internal_error = False
 
59
 
 
60
    def __init__(self, msg=None, **kwds):
 
61
        """Construct a new BzrError.
 
62
 
 
63
        There are two alternative forms for constructing these objects.
 
64
        Either a preformatted string may be passed, or a set of named
 
65
        arguments can be given.  The first is for generic "user" errors which
 
66
        are not intended to be caught and so do not need a specific subclass.
 
67
        The second case is for use with subclasses that provide a _fmt format
 
68
        string to print the arguments.
 
69
 
 
70
        Keyword arguments are taken as parameters to the error, which can
 
71
        be inserted into the format string template.  It's recommended
 
72
        that subclasses override the __init__ method to require specific
 
73
        parameters.
 
74
 
 
75
        :param msg: If given, this is the literal complete text for the error,
 
76
           not subject to expansion. 'msg' is used instead of 'message' because
 
77
           python evolved and, in 2.6, forbids the use of 'message'.
 
78
        """
 
79
        Exception.__init__(self)
 
80
        if msg is not None:
 
81
            # I was going to deprecate this, but it actually turns out to be
 
82
            # quite handy - mbp 20061103.
 
83
            self._preformatted_string = msg
 
84
        else:
 
85
            self._preformatted_string = None
 
86
            for key, value in kwds.items():
 
87
                setattr(self, key, value)
 
88
 
 
89
    def _format(self):
 
90
        s = getattr(self, '_preformatted_string', None)
 
91
        if s is not None:
 
92
            # contains a preformatted message
 
93
            return s
 
94
        err = None
 
95
        try:
 
96
            fmt = self._get_format_string()
 
97
            if fmt:
 
98
                d = dict(self.__dict__)
 
99
                s = fmt % d
 
100
                # __str__() should always return a 'str' object
 
101
                # never a 'unicode' object.
 
102
                return s
 
103
        except Exception as e:
 
104
            err = e
 
105
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
106
            % (self.__class__.__name__,
 
107
               self.__dict__,
 
108
               getattr(self, '_fmt', None),
 
109
               err)
 
110
 
 
111
    if PY3:
 
112
        __str__ = _format
 
113
    else:
 
114
        def __str__(self):
 
115
            return self._format().encode('utf-8')
 
116
 
 
117
        __unicode__ = _format
 
118
 
 
119
    def __repr__(self):
 
120
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
121
 
 
122
    def _get_format_string(self):
 
123
        """Return format string for this exception or None"""
 
124
        fmt = getattr(self, '_fmt', None)
 
125
        if fmt is not None:
 
126
            from breezy.i18n import gettext
 
127
            return gettext(fmt) # _fmt strings should be ascii
 
128
 
 
129
    def __eq__(self, other):
 
130
        if self.__class__ is not other.__class__:
 
131
            return NotImplemented
 
132
        return self.__dict__ == other.__dict__
 
133
 
 
134
    def __hash__(self):
 
135
        return id(self)
 
136
 
 
137
 
 
138
class InternalBzrError(BzrError):
 
139
    """Base class for errors that are internal in nature.
 
140
 
 
141
    This is a convenience class for errors that are internal. The
 
142
    internal_error attribute can still be altered in subclasses, if needed.
 
143
    Using this class is simply an easy way to get internal errors.
 
144
    """
 
145
 
 
146
    internal_error = True
 
147
 
 
148
 
 
149
class BranchError(BzrError):
 
150
    """Base class for concrete 'errors about a branch'."""
 
151
 
 
152
    def __init__(self, branch):
 
153
        BzrError.__init__(self, branch=branch)
 
154
 
 
155
 
 
156
class BzrCheckError(InternalBzrError):
 
157
 
 
158
    _fmt = "Internal check failed: %(msg)s"
 
159
 
 
160
    def __init__(self, msg):
 
161
        BzrError.__init__(self)
 
162
        self.msg = msg
 
163
 
 
164
 
 
165
class IncompatibleVersion(BzrError):
 
166
 
 
167
    _fmt = 'API %(api)s is not compatible; one of versions %(wanted)r '\
 
168
           'is required, but current version is %(current)r.'
 
169
 
 
170
    def __init__(self, api, wanted, current):
 
171
        self.api = api
 
172
        self.wanted = wanted
 
173
        self.current = current
 
174
 
 
175
 
 
176
class InProcessTransport(BzrError):
 
177
 
 
178
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
179
        "process."
 
180
 
 
181
    def __init__(self, transport):
 
182
        self.transport = transport
 
183
 
 
184
 
 
185
class InvalidEntryName(InternalBzrError):
 
186
 
 
187
    _fmt = "Invalid entry name: %(name)s"
 
188
 
 
189
    def __init__(self, name):
 
190
        BzrError.__init__(self)
 
191
        self.name = name
 
192
 
 
193
 
 
194
class InvalidRevisionNumber(BzrError):
 
195
 
 
196
    _fmt = "Invalid revision number %(revno)s"
 
197
 
 
198
    def __init__(self, revno):
 
199
        BzrError.__init__(self)
 
200
        self.revno = revno
 
201
 
 
202
 
 
203
class InvalidRevisionId(BzrError):
 
204
 
 
205
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
206
 
 
207
    def __init__(self, revision_id, branch):
 
208
        # branch can be any string or object with __str__ defined
 
209
        BzrError.__init__(self)
 
210
        self.revision_id = revision_id
 
211
        self.branch = branch
 
212
 
 
213
 
 
214
class ReservedId(BzrError):
 
215
 
 
216
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
217
 
 
218
    def __init__(self, revision_id):
 
219
        self.revision_id = revision_id
 
220
 
 
221
 
 
222
class RootMissing(InternalBzrError):
 
223
 
 
224
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
225
        "the commit builder.")
 
226
 
 
227
 
 
228
class NoPublicBranch(BzrError):
 
229
 
 
230
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
231
 
 
232
    def __init__(self, branch):
 
233
        from . import urlutils
 
234
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
235
        BzrError.__init__(self, branch_url=public_location)
 
236
 
 
237
 
 
238
class NoSuchId(BzrError):
 
239
 
 
240
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
241
 
 
242
    def __init__(self, tree, file_id):
 
243
        BzrError.__init__(self)
 
244
        self.file_id = file_id
 
245
        self.tree = tree
 
246
 
 
247
 
 
248
class NoSuchIdInRepository(NoSuchId):
 
249
 
 
250
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
251
            ' %(repository)r')
 
252
 
 
253
    def __init__(self, repository, file_id):
 
254
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
255
 
 
256
 
 
257
class NotStacked(BranchError):
 
258
 
 
259
    _fmt = "The branch '%(branch)s' is not stacked."
 
260
 
 
261
 
 
262
class InventoryModified(InternalBzrError):
 
263
 
 
264
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
265
            " so a clean inventory cannot be read without data loss.")
 
266
 
 
267
    def __init__(self, tree):
 
268
        self.tree = tree
 
269
 
 
270
 
 
271
class NoWorkingTree(BzrError):
 
272
 
 
273
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
274
 
 
275
    def __init__(self, base):
 
276
        BzrError.__init__(self)
 
277
        self.base = base
 
278
 
 
279
 
 
280
class NotLocalUrl(BzrError):
 
281
 
 
282
    _fmt = "%(url)s is not a local path."
 
283
 
 
284
    def __init__(self, url):
 
285
        self.url = url
 
286
 
 
287
 
 
288
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
289
 
 
290
    _fmt = 'Working tree already populated in "%(base)s"'
 
291
 
 
292
    def __init__(self, base):
 
293
        self.base = base
 
294
 
 
295
 
 
296
class BzrCommandError(BzrError):
 
297
    """Error from user command"""
 
298
 
 
299
    # Error from malformed user command; please avoid raising this as a
 
300
    # generic exception not caused by user input.
 
301
    #
 
302
    # I think it's a waste of effort to differentiate between errors that
 
303
    # are not intended to be caught anyway.  UI code need not subclass
 
304
    # BzrCommandError, and non-UI code should not throw a subclass of
 
305
    # BzrCommandError.  ADHB 20051211
 
306
 
 
307
 
 
308
class NotWriteLocked(BzrError):
 
309
 
 
310
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
311
 
 
312
    def __init__(self, not_locked):
 
313
        self.not_locked = not_locked
 
314
 
 
315
 
 
316
class StrictCommitFailed(BzrError):
 
317
 
 
318
    _fmt = "Commit refused because there are unknown files in the tree"
 
319
 
 
320
 
 
321
# XXX: Should be unified with TransportError; they seem to represent the
 
322
# same thing
 
323
# RBC 20060929: I think that unifiying with TransportError would be a mistake
 
324
# - this is finer than a TransportError - and more useful as such. It
 
325
# differentiates between 'transport has failed' and 'operation on a transport
 
326
# has failed.'
 
327
class PathError(BzrError):
 
328
 
 
329
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
330
 
 
331
    def __init__(self, path, extra=None):
 
332
        BzrError.__init__(self)
 
333
        self.path = path
 
334
        if extra:
 
335
            self.extra = ': ' + str(extra)
 
336
        else:
 
337
            self.extra = ''
 
338
 
 
339
 
 
340
class NoSuchFile(PathError):
 
341
 
 
342
    _fmt = "No such file: %(path)r%(extra)s"
 
343
 
 
344
 
 
345
class FileExists(PathError):
 
346
 
 
347
    _fmt = "File exists: %(path)r%(extra)s"
 
348
 
 
349
 
 
350
class RenameFailedFilesExist(BzrError):
 
351
    """Used when renaming and both source and dest exist."""
 
352
 
 
353
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
354
            " (Use --after to tell brz about a rename that has already"
 
355
            " happened)%(extra)s")
 
356
 
 
357
    def __init__(self, source, dest, extra=None):
 
358
        BzrError.__init__(self)
 
359
        self.source = str(source)
 
360
        self.dest = str(dest)
 
361
        if extra:
 
362
            self.extra = ' ' + str(extra)
 
363
        else:
 
364
            self.extra = ''
 
365
 
 
366
 
 
367
class NotADirectory(PathError):
 
368
 
 
369
    _fmt = '"%(path)s" is not a directory %(extra)s'
 
370
 
 
371
 
 
372
class NotInWorkingDirectory(PathError):
 
373
 
 
374
    _fmt = '"%(path)s" is not in the working directory %(extra)s'
 
375
 
 
376
 
 
377
class DirectoryNotEmpty(PathError):
 
378
 
 
379
    _fmt = 'Directory not empty: "%(path)s"%(extra)s'
 
380
 
 
381
 
 
382
class HardLinkNotSupported(PathError):
 
383
 
 
384
    _fmt = 'Hard-linking "%(path)s" is not supported'
 
385
 
 
386
 
 
387
class ReadingCompleted(InternalBzrError):
 
388
 
 
389
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
390
            "called upon it - the request has been completed and no more "
 
391
            "data may be read.")
 
392
 
 
393
    def __init__(self, request):
 
394
        self.request = request
 
395
 
 
396
 
 
397
class ResourceBusy(PathError):
 
398
 
 
399
    _fmt = 'Device or resource busy: "%(path)s"%(extra)s'
 
400
 
 
401
 
 
402
class PermissionDenied(PathError):
 
403
 
 
404
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
 
405
 
 
406
 
 
407
class UnavailableRepresentation(InternalBzrError):
 
408
 
 
409
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
 
410
        "is encoded as '%(native)s'.")
 
411
 
 
412
    def __init__(self, key, wanted, native):
 
413
        InternalBzrError.__init__(self)
 
414
        self.wanted = wanted
 
415
        self.native = native
 
416
        self.key = key
 
417
 
 
418
 
 
419
class UnsupportedProtocol(PathError):
 
420
 
 
421
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
422
 
 
423
    def __init__(self, url, extra=""):
 
424
        PathError.__init__(self, url, extra=extra)
 
425
 
 
426
 
 
427
class UnstackableLocationError(BzrError):
 
428
 
 
429
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
430
 
 
431
    def __init__(self, branch_url, target_url):
 
432
        BzrError.__init__(self)
 
433
        self.branch_url = branch_url
 
434
        self.target_url = target_url
 
435
 
 
436
 
 
437
class UnstackableRepositoryFormat(BzrError):
 
438
 
 
439
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
 
440
        "You will need to upgrade the repository to permit branch stacking.")
 
441
 
 
442
    def __init__(self, format, url):
 
443
        BzrError.__init__(self)
 
444
        self.format = format
 
445
        self.url = url
 
446
 
 
447
 
 
448
class ReadError(PathError):
 
449
 
 
450
    _fmt = """Error reading from %(path)r."""
 
451
 
 
452
 
 
453
class ShortReadvError(PathError):
 
454
 
 
455
    _fmt = ('readv() read %(actual)s bytes rather than %(length)s bytes'
 
456
            ' at %(offset)s for "%(path)s"%(extra)s')
 
457
 
 
458
    internal_error = True
 
459
 
 
460
    def __init__(self, path, offset, length, actual, extra=None):
 
461
        PathError.__init__(self, path, extra=extra)
 
462
        self.offset = offset
 
463
        self.length = length
 
464
        self.actual = actual
 
465
 
 
466
 
 
467
class PathNotChild(PathError):
 
468
 
 
469
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
 
470
 
 
471
    internal_error = False
 
472
 
 
473
    def __init__(self, path, base, extra=None):
 
474
        BzrError.__init__(self)
 
475
        self.path = path
 
476
        self.base = base
 
477
        if extra:
 
478
            self.extra = ': ' + str(extra)
 
479
        else:
 
480
            self.extra = ''
 
481
 
 
482
 
 
483
class InvalidNormalization(PathError):
 
484
 
 
485
    _fmt = 'Path "%(path)s" is not unicode normalized'
 
486
 
 
487
 
 
488
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
489
# the exception object is a bit undesirable.
 
490
# TODO: Probably this behavior of should be a common superclass
 
491
class NotBranchError(PathError):
 
492
 
 
493
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
 
494
 
 
495
    def __init__(self, path, detail=None, controldir=None):
 
496
       from . import urlutils
 
497
       path = urlutils.unescape_for_display(path, 'ascii')
 
498
       if detail is not None:
 
499
           detail = ': ' + detail
 
500
       self.detail = detail
 
501
       self.controldir = controldir
 
502
       PathError.__init__(self, path=path)
 
503
 
 
504
    def __repr__(self):
 
505
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
 
506
 
 
507
    def _get_format_string(self):
 
508
        # GZ 2017-06-08: Not the best place to lazy fill detail in.
 
509
        if self.detail is None:
 
510
           self.detail = self._get_detail()
 
511
        return super(NotBranchError, self)._get_format_string()
 
512
 
 
513
    def _get_detail(self):
 
514
        if self.controldir is not None:
 
515
            try:
 
516
                self.controldir.open_repository()
 
517
            except NoRepositoryPresent:
 
518
                return ''
 
519
            except Exception as e:
 
520
                # Just ignore unexpected errors.  Raising arbitrary errors
 
521
                # during str(err) can provoke strange bugs.  Concretely
 
522
                # Launchpad's codehosting managed to raise NotBranchError
 
523
                # here, and then get stuck in an infinite loop/recursion
 
524
                # trying to str() that error.  All this error really cares
 
525
                # about that there's no working repository there, and if
 
526
                # open_repository() fails, there probably isn't.
 
527
                return ': ' + e.__class__.__name__
 
528
            else:
 
529
                return ': location is a repository'
 
530
        return ''
 
531
 
 
532
 
 
533
class NoSubmitBranch(PathError):
 
534
 
 
535
    _fmt = 'No submit branch available for branch "%(path)s"'
 
536
 
 
537
    def __init__(self, branch):
 
538
       from . import urlutils
 
539
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
540
 
 
541
 
 
542
class AlreadyControlDirError(PathError):
 
543
 
 
544
    _fmt = 'A control directory already exists: "%(path)s".'
 
545
 
 
546
 
 
547
class AlreadyBranchError(PathError):
 
548
 
 
549
    _fmt = 'Already a branch: "%(path)s".'
 
550
 
 
551
 
 
552
class InvalidBranchName(PathError):
 
553
 
 
554
    _fmt = "Invalid branch name: %(name)s"
 
555
 
 
556
    def __init__(self, name):
 
557
        BzrError.__init__(self)
 
558
        self.name = name
 
559
 
 
560
 
 
561
class ParentBranchExists(AlreadyBranchError):
 
562
 
 
563
    _fmt = 'Parent branch already exists: "%(path)s".'
 
564
 
 
565
 
 
566
class BranchExistsWithoutWorkingTree(PathError):
 
567
 
 
568
    _fmt = 'Directory contains a branch, but no working tree \
 
569
(use brz checkout if you wish to build a working tree): "%(path)s"'
 
570
 
 
571
 
 
572
class AtomicFileAlreadyClosed(PathError):
 
573
 
 
574
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
575
            ' "%(path)s"')
 
576
 
 
577
    def __init__(self, path, function):
 
578
        PathError.__init__(self, path=path, extra=None)
 
579
        self.function = function
 
580
 
 
581
 
 
582
class InaccessibleParent(PathError):
 
583
 
 
584
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
585
            ' relative path "%(path)s"')
 
586
 
 
587
    def __init__(self, path, base):
 
588
        PathError.__init__(self, path)
 
589
        self.base = base
 
590
 
 
591
 
 
592
class NoRepositoryPresent(BzrError):
 
593
 
 
594
    _fmt = 'No repository present: "%(path)s"'
 
595
    def __init__(self, controldir):
 
596
        BzrError.__init__(self)
 
597
        self.path = controldir.transport.clone('..').base
 
598
 
 
599
 
 
600
class UnsupportedFormatError(BzrError):
 
601
 
 
602
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'brz upgrade'"
 
603
 
 
604
 
 
605
class UnknownFormatError(BzrError):
 
606
 
 
607
    _fmt = "Unknown %(kind)s format: %(format)r"
 
608
 
 
609
    def __init__(self, format, kind='branch'):
 
610
        self.kind = kind
 
611
        self.format = format
 
612
 
 
613
 
 
614
class IncompatibleFormat(BzrError):
 
615
 
 
616
    _fmt = "Format %(format)s is not compatible with .bzr version %(controldir)s."
 
617
 
 
618
    def __init__(self, format, controldir_format):
 
619
        BzrError.__init__(self)
 
620
        self.format = format
 
621
        self.controldir = controldir_format
 
622
 
 
623
 
 
624
class ParseFormatError(BzrError):
 
625
 
 
626
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
 
627
 
 
628
    def __init__(self, format, lineno, line, text):
 
629
        BzrError.__init__(self)
 
630
        self.format = format
 
631
        self.lineno = lineno
 
632
        self.line = line
 
633
        self.text = text
 
634
 
 
635
 
 
636
class IncompatibleRepositories(BzrError):
 
637
    """Report an error that two repositories are not compatible.
 
638
 
 
639
    Note that the source and target repositories are permitted to be strings:
 
640
    this exception is thrown from the smart server and may refer to a
 
641
    repository the client hasn't opened.
 
642
    """
 
643
 
 
644
    _fmt = "%(target)s\n" \
 
645
            "is not compatible with\n" \
 
646
            "%(source)s\n" \
 
647
            "%(details)s"
 
648
 
 
649
    def __init__(self, source, target, details=None):
 
650
        if details is None:
 
651
            details = "(no details)"
 
652
        BzrError.__init__(self, target=target, source=source, details=details)
 
653
 
 
654
 
 
655
class IncompatibleRevision(BzrError):
 
656
 
 
657
    _fmt = "Revision is not compatible with %(repo_format)s"
 
658
 
 
659
    def __init__(self, repo_format):
 
660
        BzrError.__init__(self)
 
661
        self.repo_format = repo_format
 
662
 
 
663
 
 
664
class AlreadyVersionedError(BzrError):
 
665
    """Used when a path is expected not to be versioned, but it is."""
 
666
 
 
667
    _fmt = "%(context_info)s%(path)s is already versioned."
 
668
 
 
669
    def __init__(self, path, context_info=None):
 
670
        """Construct a new AlreadyVersionedError.
 
671
 
 
672
        :param path: This is the path which is versioned,
 
673
            which should be in a user friendly form.
 
674
        :param context_info: If given, this is information about the context,
 
675
            which could explain why this is expected to not be versioned.
 
676
        """
 
677
        BzrError.__init__(self)
 
678
        self.path = path
 
679
        if context_info is None:
 
680
            self.context_info = ''
 
681
        else:
 
682
            self.context_info = context_info + ". "
 
683
 
 
684
 
 
685
class NotVersionedError(BzrError):
 
686
    """Used when a path is expected to be versioned, but it is not."""
 
687
 
 
688
    _fmt = "%(context_info)s%(path)s is not versioned."
 
689
 
 
690
    def __init__(self, path, context_info=None):
 
691
        """Construct a new NotVersionedError.
 
692
 
 
693
        :param path: This is the path which is not versioned,
 
694
            which should be in a user friendly form.
 
695
        :param context_info: If given, this is information about the context,
 
696
            which could explain why this is expected to be versioned.
 
697
        """
 
698
        BzrError.__init__(self)
 
699
        self.path = path
 
700
        if context_info is None:
 
701
            self.context_info = ''
 
702
        else:
 
703
            self.context_info = context_info + ". "
 
704
 
 
705
 
 
706
class PathsNotVersionedError(BzrError):
 
707
    """Used when reporting several paths which are not versioned"""
 
708
 
 
709
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
710
 
 
711
    def __init__(self, paths):
 
712
        from breezy.osutils import quotefn
 
713
        BzrError.__init__(self)
 
714
        self.paths = paths
 
715
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
716
 
 
717
 
 
718
class PathsDoNotExist(BzrError):
 
719
 
 
720
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
721
 
 
722
    # used when reporting that paths are neither versioned nor in the working
 
723
    # tree
 
724
 
 
725
    def __init__(self, paths, extra=None):
 
726
        # circular import
 
727
        from breezy.osutils import quotefn
 
728
        BzrError.__init__(self)
 
729
        self.paths = paths
 
730
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
731
        if extra:
 
732
            self.extra = ': ' + str(extra)
 
733
        else:
 
734
            self.extra = ''
 
735
 
 
736
 
 
737
class BadFileKindError(BzrError):
 
738
 
 
739
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
740
 
 
741
    def __init__(self, filename, kind):
 
742
        BzrError.__init__(self, filename=filename, kind=kind)
 
743
 
 
744
 
 
745
class BadFilenameEncoding(BzrError):
 
746
 
 
747
    _fmt = ('Filename %(filename)r is not valid in your current filesystem'
 
748
            ' encoding %(fs_encoding)s')
 
749
 
 
750
    def __init__(self, filename, fs_encoding):
 
751
        BzrError.__init__(self)
 
752
        self.filename = filename
 
753
        self.fs_encoding = fs_encoding
 
754
 
 
755
 
 
756
class ForbiddenControlFileError(BzrError):
 
757
 
 
758
    _fmt = 'Cannot operate on "%(filename)s" because it is a control file'
 
759
 
 
760
 
 
761
class LockError(InternalBzrError):
 
762
 
 
763
    _fmt = "Lock error: %(msg)s"
 
764
 
 
765
    # All exceptions from the lock/unlock functions should be from
 
766
    # this exception class.  They will be translated as necessary. The
 
767
    # original exception is available as e.original_error
 
768
    #
 
769
    # New code should prefer to raise specific subclasses
 
770
    def __init__(self, msg):
 
771
        self.msg = msg
 
772
 
 
773
 
 
774
class LockActive(LockError):
 
775
 
 
776
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
777
 
 
778
    internal_error = False
 
779
 
 
780
    def __init__(self, lock_description):
 
781
        self.lock_description = lock_description
 
782
 
 
783
 
 
784
class CommitNotPossible(LockError):
 
785
 
 
786
    _fmt = "A commit was attempted but we do not have a write lock open."
 
787
 
 
788
    def __init__(self):
 
789
        pass
 
790
 
 
791
 
 
792
class AlreadyCommitted(LockError):
 
793
 
 
794
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
795
 
 
796
    def __init__(self):
 
797
        pass
 
798
 
 
799
 
 
800
class ReadOnlyError(LockError):
 
801
 
 
802
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
803
 
 
804
    # TODO: There should also be an error indicating that you need a write
 
805
    # lock and don't have any lock at all... mbp 20070226
 
806
 
 
807
    def __init__(self, obj):
 
808
        self.obj = obj
 
809
 
 
810
 
 
811
class LockFailed(LockError):
 
812
 
 
813
    internal_error = False
 
814
 
 
815
    _fmt = "Cannot lock %(lock)s: %(why)s"
 
816
 
 
817
    def __init__(self, lock, why):
 
818
        LockError.__init__(self, '')
 
819
        self.lock = lock
 
820
        self.why = why
 
821
 
 
822
 
 
823
class OutSideTransaction(BzrError):
 
824
 
 
825
    _fmt = ("A transaction related operation was attempted after"
 
826
            " the transaction finished.")
 
827
 
 
828
 
 
829
class ObjectNotLocked(LockError):
 
830
 
 
831
    _fmt = "%(obj)r is not locked"
 
832
 
 
833
    # this can indicate that any particular object is not locked; see also
 
834
    # LockNotHeld which means that a particular *lock* object is not held by
 
835
    # the caller -- perhaps they should be unified.
 
836
    def __init__(self, obj):
 
837
        self.obj = obj
 
838
 
 
839
 
 
840
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
841
 
 
842
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
843
 
 
844
    def __init__(self, obj):
 
845
        self.obj = obj
 
846
 
 
847
 
 
848
class UnlockableTransport(LockError):
 
849
 
 
850
    internal_error = False
 
851
 
 
852
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
853
 
 
854
    def __init__(self, transport):
 
855
        self.transport = transport
 
856
 
 
857
 
 
858
class LockContention(LockError):
 
859
 
 
860
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
861
 
 
862
    internal_error = False
 
863
 
 
864
    def __init__(self, lock, msg=''):
 
865
        self.lock = lock
 
866
        self.msg = msg
 
867
 
 
868
 
 
869
class LockBroken(LockError):
 
870
 
 
871
    _fmt = ("Lock was broken while still open: %(lock)s"
 
872
            " - check storage consistency!")
 
873
 
 
874
    internal_error = False
 
875
 
 
876
    def __init__(self, lock):
 
877
        self.lock = lock
 
878
 
 
879
 
 
880
class LockBreakMismatch(LockError):
 
881
 
 
882
    _fmt = ("Lock was released and re-acquired before being broken:"
 
883
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
884
 
 
885
    internal_error = False
 
886
 
 
887
    def __init__(self, lock, holder, target):
 
888
        self.lock = lock
 
889
        self.holder = holder
 
890
        self.target = target
 
891
 
 
892
 
 
893
class LockCorrupt(LockError):
 
894
 
 
895
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
 
896
            "Use 'brz break-lock' to clear it")
 
897
 
 
898
    internal_error = False
 
899
 
 
900
    def __init__(self, corruption_info, file_data=None):
 
901
        self.corruption_info = corruption_info
 
902
        self.file_data = file_data
 
903
 
 
904
 
 
905
class LockNotHeld(LockError):
 
906
 
 
907
    _fmt = "Lock not held: %(lock)s"
 
908
 
 
909
    internal_error = False
 
910
 
 
911
    def __init__(self, lock):
 
912
        self.lock = lock
 
913
 
 
914
 
 
915
class TokenLockingNotSupported(LockError):
 
916
 
 
917
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
 
918
 
 
919
    def __init__(self, obj):
 
920
        self.obj = obj
 
921
 
 
922
 
 
923
class TokenMismatch(LockBroken):
 
924
 
 
925
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
 
926
 
 
927
    internal_error = True
 
928
 
 
929
    def __init__(self, given_token, lock_token):
 
930
        self.given_token = given_token
 
931
        self.lock_token = lock_token
 
932
 
 
933
 
 
934
class UpgradeReadonly(BzrError):
 
935
 
 
936
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
937
 
 
938
 
 
939
class UpToDateFormat(BzrError):
 
940
 
 
941
    _fmt = "The branch format %(format)s is already at the most recent format."
 
942
 
 
943
    def __init__(self, format):
 
944
        BzrError.__init__(self)
 
945
        self.format = format
 
946
 
 
947
 
 
948
class NoSuchRevision(InternalBzrError):
 
949
 
 
950
    _fmt = "%(branch)s has no revision %(revision)s"
 
951
 
 
952
    def __init__(self, branch, revision):
 
953
        # 'branch' may sometimes be an internal object like a KnitRevisionStore
 
954
        BzrError.__init__(self, branch=branch, revision=revision)
 
955
 
 
956
 
 
957
class RangeInChangeOption(BzrError):
 
958
 
 
959
    _fmt = "Option --change does not accept revision ranges"
 
960
 
 
961
 
 
962
class NoSuchRevisionSpec(BzrError):
 
963
 
 
964
    _fmt = "No namespace registered for string: %(spec)r"
 
965
 
 
966
    def __init__(self, spec):
 
967
        BzrError.__init__(self, spec=spec)
 
968
 
 
969
 
 
970
class NoSuchRevisionInTree(NoSuchRevision):
 
971
    """When using Tree.revision_tree, and the revision is not accessible."""
 
972
 
 
973
    _fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
 
974
 
 
975
    def __init__(self, tree, revision_id):
 
976
        BzrError.__init__(self)
 
977
        self.tree = tree
 
978
        self.revision_id = revision_id
 
979
 
 
980
 
 
981
class InvalidRevisionSpec(BzrError):
 
982
 
 
983
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
984
            " %(branch_url)s%(extra)s")
 
985
 
 
986
    def __init__(self, spec, branch, extra=None):
 
987
        BzrError.__init__(self, branch=branch, spec=spec)
 
988
        self.branch_url = getattr(branch, 'user_url', str(branch))
 
989
        if extra:
 
990
            self.extra = '\n' + str(extra)
 
991
        else:
 
992
            self.extra = ''
 
993
 
 
994
 
 
995
class AppendRevisionsOnlyViolation(BzrError):
 
996
 
 
997
    _fmt = ('Operation denied because it would change the main history,'
 
998
           ' which is not permitted by the append_revisions_only setting on'
 
999
           ' branch "%(location)s".')
 
1000
 
 
1001
    def __init__(self, location):
 
1002
       import breezy.urlutils as urlutils
 
1003
       location = urlutils.unescape_for_display(location, 'ascii')
 
1004
       BzrError.__init__(self, location=location)
 
1005
 
 
1006
 
 
1007
class DivergedBranches(BzrError):
 
1008
 
 
1009
    _fmt = ("These branches have diverged."
 
1010
            " Use the missing command to see how.\n"
 
1011
            "Use the merge command to reconcile them.")
 
1012
 
 
1013
    def __init__(self, branch1, branch2):
 
1014
        self.branch1 = branch1
 
1015
        self.branch2 = branch2
 
1016
 
 
1017
 
 
1018
class NotLefthandHistory(InternalBzrError):
 
1019
 
 
1020
    _fmt = "Supplied history does not follow left-hand parents"
 
1021
 
 
1022
    def __init__(self, history):
 
1023
        BzrError.__init__(self, history=history)
 
1024
 
 
1025
 
 
1026
class UnrelatedBranches(BzrError):
 
1027
 
 
1028
    _fmt = ("Branches have no common ancestor, and"
 
1029
            " no merge base revision was specified.")
 
1030
 
 
1031
 
 
1032
class CannotReverseCherrypick(BzrError):
 
1033
 
 
1034
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1035
            ' or diff3.')
 
1036
 
 
1037
 
 
1038
class NoCommonAncestor(BzrError):
 
1039
 
 
1040
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1041
 
 
1042
    def __init__(self, revision_a, revision_b):
 
1043
        self.revision_a = revision_a
 
1044
        self.revision_b = revision_b
 
1045
 
 
1046
 
 
1047
class NoCommonRoot(BzrError):
 
1048
 
 
1049
    _fmt = ("Revisions are not derived from the same root: "
 
1050
           "%(revision_a)s %(revision_b)s.")
 
1051
 
 
1052
    def __init__(self, revision_a, revision_b):
 
1053
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1054
 
 
1055
 
 
1056
class NotAncestor(BzrError):
 
1057
 
 
1058
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1059
 
 
1060
    def __init__(self, rev_id, not_ancestor_id):
 
1061
        BzrError.__init__(self, rev_id=rev_id,
 
1062
            not_ancestor_id=not_ancestor_id)
 
1063
 
 
1064
 
 
1065
class NoCommits(BranchError):
 
1066
 
 
1067
    _fmt = "Branch %(branch)s has no commits."
 
1068
 
 
1069
 
 
1070
class UnlistableStore(BzrError):
 
1071
 
 
1072
    def __init__(self, store):
 
1073
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1074
 
 
1075
 
 
1076
 
 
1077
class UnlistableBranch(BzrError):
 
1078
 
 
1079
    def __init__(self, br):
 
1080
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1081
 
 
1082
 
 
1083
class BoundBranchOutOfDate(BzrError):
 
1084
 
 
1085
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1086
            " %(master)s.%(extra_help)s")
 
1087
 
 
1088
    def __init__(self, branch, master):
 
1089
        BzrError.__init__(self)
 
1090
        self.branch = branch
 
1091
        self.master = master
 
1092
        self.extra_help = ''
 
1093
 
 
1094
 
 
1095
class CommitToDoubleBoundBranch(BzrError):
 
1096
 
 
1097
    _fmt = ("Cannot commit to branch %(branch)s."
 
1098
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1099
 
 
1100
    def __init__(self, branch, master, remote):
 
1101
        BzrError.__init__(self)
 
1102
        self.branch = branch
 
1103
        self.master = master
 
1104
        self.remote = remote
 
1105
 
 
1106
 
 
1107
class OverwriteBoundBranch(BzrError):
 
1108
 
 
1109
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1110
 
 
1111
    def __init__(self, branch):
 
1112
        BzrError.__init__(self)
 
1113
        self.branch = branch
 
1114
 
 
1115
 
 
1116
class BoundBranchConnectionFailure(BzrError):
 
1117
 
 
1118
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1119
            " => %(target)s: %(error)s")
 
1120
 
 
1121
    def __init__(self, branch, target, error):
 
1122
        BzrError.__init__(self)
 
1123
        self.branch = branch
 
1124
        self.target = target
 
1125
        self.error = error
 
1126
 
 
1127
 
 
1128
class VersionedFileError(BzrError):
 
1129
 
 
1130
    _fmt = "Versioned file error"
 
1131
 
 
1132
 
 
1133
class RevisionNotPresent(VersionedFileError):
 
1134
 
 
1135
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1136
 
 
1137
    def __init__(self, revision_id, file_id):
 
1138
        VersionedFileError.__init__(self)
 
1139
        self.revision_id = revision_id
 
1140
        self.file_id = file_id
 
1141
 
 
1142
 
 
1143
class RevisionAlreadyPresent(VersionedFileError):
 
1144
 
 
1145
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1146
 
 
1147
    def __init__(self, revision_id, file_id):
 
1148
        VersionedFileError.__init__(self)
 
1149
        self.revision_id = revision_id
 
1150
        self.file_id = file_id
 
1151
 
 
1152
 
 
1153
class VersionedFileInvalidChecksum(VersionedFileError):
 
1154
 
 
1155
    _fmt = "Text did not match its checksum: %(msg)s"
 
1156
 
 
1157
 
 
1158
class RetryWithNewPacks(BzrError):
 
1159
    """Raised when we realize that the packs on disk have changed.
 
1160
 
 
1161
    This is meant as more of a signaling exception, to trap between where a
 
1162
    local error occurred and the code that can actually handle the error and
 
1163
    code that can retry appropriately.
 
1164
    """
 
1165
 
 
1166
    internal_error = True
 
1167
 
 
1168
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1169
            " %(orig_error)s")
 
1170
 
 
1171
    def __init__(self, context, reload_occurred, exc_info):
 
1172
        """create a new RetryWithNewPacks error.
 
1173
 
 
1174
        :param reload_occurred: Set to True if we know that the packs have
 
1175
            already been reloaded, and we are failing because of an in-memory
 
1176
            cache miss. If set to True then we will ignore if a reload says
 
1177
            nothing has changed, because we assume it has already reloaded. If
 
1178
            False, then a reload with nothing changed will force an error.
 
1179
        :param exc_info: The original exception traceback, so if there is a
 
1180
            problem we can raise the original error (value from sys.exc_info())
 
1181
        """
 
1182
        BzrError.__init__(self)
 
1183
        self.context = context
 
1184
        self.reload_occurred = reload_occurred
 
1185
        self.exc_info = exc_info
 
1186
        self.orig_error = exc_info[1]
 
1187
        # TODO: The global error handler should probably treat this by
 
1188
        #       raising/printing the original exception with a bit about
 
1189
        #       RetryWithNewPacks also not being caught
 
1190
 
 
1191
 
 
1192
class RetryAutopack(RetryWithNewPacks):
 
1193
    """Raised when we are autopacking and we find a missing file.
 
1194
 
 
1195
    Meant as a signaling exception, to tell the autopack code it should try
 
1196
    again.
 
1197
    """
 
1198
 
 
1199
    internal_error = True
 
1200
 
 
1201
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1202
            " context: %(context)s %(orig_error)s")
 
1203
 
 
1204
 
 
1205
class NoSuchExportFormat(BzrError):
 
1206
 
 
1207
    _fmt = "Export format %(format)r not supported"
 
1208
 
 
1209
    def __init__(self, format):
 
1210
        BzrError.__init__(self)
 
1211
        self.format = format
 
1212
 
 
1213
 
 
1214
class TransportError(BzrError):
 
1215
 
 
1216
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1217
 
 
1218
    def __init__(self, msg=None, orig_error=None):
 
1219
        if msg is None and orig_error is not None:
 
1220
            msg = str(orig_error)
 
1221
        if orig_error is None:
 
1222
            orig_error = ''
 
1223
        if msg is None:
 
1224
            msg =  ''
 
1225
        self.msg = msg
 
1226
        self.orig_error = orig_error
 
1227
        BzrError.__init__(self)
 
1228
 
 
1229
 
 
1230
class TooManyConcurrentRequests(InternalBzrError):
 
1231
 
 
1232
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1233
            " Be sure to finish_writing and finish_reading on the"
 
1234
            " currently open request.")
 
1235
 
 
1236
    def __init__(self, medium):
 
1237
        self.medium = medium
 
1238
 
 
1239
 
 
1240
class SmartProtocolError(TransportError):
 
1241
 
 
1242
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1243
 
 
1244
    def __init__(self, details):
 
1245
        self.details = details
 
1246
 
 
1247
 
 
1248
class UnexpectedProtocolVersionMarker(TransportError):
 
1249
 
 
1250
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1251
 
 
1252
    def __init__(self, marker):
 
1253
        self.marker = marker
 
1254
 
 
1255
 
 
1256
class UnknownSmartMethod(InternalBzrError):
 
1257
 
 
1258
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1259
 
 
1260
    def __init__(self, verb):
 
1261
        self.verb = verb
 
1262
 
 
1263
 
 
1264
class SmartMessageHandlerError(InternalBzrError):
 
1265
 
 
1266
    _fmt = ("The message handler raised an exception:\n"
 
1267
            "%(traceback_text)s")
 
1268
 
 
1269
    def __init__(self, exc_info):
 
1270
        import traceback
 
1271
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1272
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1273
        self.exc_info = exc_info
 
1274
        traceback_strings = traceback.format_exception(
 
1275
                self.exc_type, self.exc_value, self.exc_tb)
 
1276
        self.traceback_text = ''.join(traceback_strings)
 
1277
 
 
1278
 
 
1279
# A set of semi-meaningful errors which can be thrown
 
1280
class TransportNotPossible(TransportError):
 
1281
 
 
1282
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1283
 
 
1284
 
 
1285
class ConnectionError(TransportError):
 
1286
 
 
1287
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1288
 
 
1289
 
 
1290
class SocketConnectionError(ConnectionError):
 
1291
 
 
1292
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1293
 
 
1294
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1295
        if msg is None:
 
1296
            msg = 'Failed to connect to'
 
1297
        if orig_error is None:
 
1298
            orig_error = ''
 
1299
        else:
 
1300
            orig_error = '; ' + str(orig_error)
 
1301
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1302
        self.host = host
 
1303
        if port is None:
 
1304
            self.port = ''
 
1305
        else:
 
1306
            self.port = ':%s' % port
 
1307
 
 
1308
 
 
1309
# XXX: This is also used for unexpected end of file, which is different at the
 
1310
# TCP level from "connection reset".
 
1311
class ConnectionReset(TransportError):
 
1312
 
 
1313
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1314
 
 
1315
 
 
1316
class ConnectionTimeout(ConnectionError):
 
1317
 
 
1318
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1319
 
 
1320
 
 
1321
class InvalidRange(TransportError):
 
1322
 
 
1323
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1324
 
 
1325
    def __init__(self, path, offset, msg=None):
 
1326
        TransportError.__init__(self, msg)
 
1327
        self.path = path
 
1328
        self.offset = offset
 
1329
 
 
1330
 
 
1331
class InvalidHttpResponse(TransportError):
 
1332
 
 
1333
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1334
 
 
1335
    def __init__(self, path, msg, orig_error=None):
 
1336
        self.path = path
 
1337
        if orig_error is None:
 
1338
            orig_error = ''
 
1339
        else:
 
1340
            # This is reached for obscure and unusual errors so we want to
 
1341
            # preserve as much info as possible to ease debug.
 
1342
            orig_error = ': %r' % (orig_error,)
 
1343
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1344
 
 
1345
 
 
1346
class InvalidHttpRange(InvalidHttpResponse):
 
1347
 
 
1348
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1349
 
 
1350
    def __init__(self, path, range, msg):
 
1351
        self.range = range
 
1352
        InvalidHttpResponse.__init__(self, path, msg)
 
1353
 
 
1354
 
 
1355
class HttpBoundaryMissing(InvalidHttpResponse):
 
1356
    """A multipart response ends with no boundary marker.
 
1357
 
 
1358
    This is a special case caused by buggy proxies, described in
 
1359
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1360
    """
 
1361
 
 
1362
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1363
 
 
1364
    def __init__(self, path, msg):
 
1365
        InvalidHttpResponse.__init__(self, path, msg)
 
1366
 
 
1367
 
 
1368
class InvalidHttpContentType(InvalidHttpResponse):
 
1369
 
 
1370
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1371
 
 
1372
    def __init__(self, path, ctype, msg):
 
1373
        self.ctype = ctype
 
1374
        InvalidHttpResponse.__init__(self, path, msg)
 
1375
 
 
1376
 
 
1377
class RedirectRequested(TransportError):
 
1378
 
 
1379
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1380
 
 
1381
    def __init__(self, source, target, is_permanent=False):
 
1382
        self.source = source
 
1383
        self.target = target
 
1384
        if is_permanent:
 
1385
            self.permanently = ' permanently'
 
1386
        else:
 
1387
            self.permanently = ''
 
1388
        TransportError.__init__(self)
 
1389
 
 
1390
 
 
1391
class TooManyRedirections(TransportError):
 
1392
 
 
1393
    _fmt = "Too many redirections"
 
1394
 
 
1395
 
 
1396
class ConflictsInTree(BzrError):
 
1397
 
 
1398
    _fmt = "Working tree has conflicts."
 
1399
 
 
1400
 
 
1401
class DependencyNotPresent(BzrError):
 
1402
 
 
1403
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1404
 
 
1405
    def __init__(self, library, error):
 
1406
        BzrError.__init__(self, library=library, error=error)
 
1407
 
 
1408
 
 
1409
class WorkingTreeNotRevision(BzrError):
 
1410
 
 
1411
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1412
            " the last commit, but weave merge requires that it be"
 
1413
            " unchanged")
 
1414
 
 
1415
    def __init__(self, tree):
 
1416
        BzrError.__init__(self, basedir=tree.basedir)
 
1417
 
 
1418
 
 
1419
class CantReprocessAndShowBase(BzrError):
 
1420
 
 
1421
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1422
           "the relationship of conflicting lines to the base")
 
1423
 
 
1424
 
 
1425
class GraphCycleError(BzrError):
 
1426
 
 
1427
    _fmt = "Cycle in graph %(graph)r"
 
1428
 
 
1429
    def __init__(self, graph):
 
1430
        BzrError.__init__(self)
 
1431
        self.graph = graph
 
1432
 
 
1433
 
 
1434
class WritingCompleted(InternalBzrError):
 
1435
 
 
1436
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1437
            "called upon it - accept bytes may not be called anymore.")
 
1438
 
 
1439
    def __init__(self, request):
 
1440
        self.request = request
 
1441
 
 
1442
 
 
1443
class WritingNotComplete(InternalBzrError):
 
1444
 
 
1445
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1446
            "called upon it - until the write phase is complete no "
 
1447
            "data may be read.")
 
1448
 
 
1449
    def __init__(self, request):
 
1450
        self.request = request
 
1451
 
 
1452
 
 
1453
class NotConflicted(BzrError):
 
1454
 
 
1455
    _fmt = "File %(filename)s is not conflicted."
 
1456
 
 
1457
    def __init__(self, filename):
 
1458
        BzrError.__init__(self)
 
1459
        self.filename = filename
 
1460
 
 
1461
 
 
1462
class MediumNotConnected(InternalBzrError):
 
1463
 
 
1464
    _fmt = """The medium '%(medium)s' is not connected."""
 
1465
 
 
1466
    def __init__(self, medium):
 
1467
        self.medium = medium
 
1468
 
 
1469
 
 
1470
class MustUseDecorated(Exception):
 
1471
 
 
1472
    _fmt = "A decorating function has requested its original command be used."
 
1473
 
 
1474
 
 
1475
class NoBundleFound(BzrError):
 
1476
 
 
1477
    _fmt = 'No bundle was found in "%(filename)s".'
 
1478
 
 
1479
    def __init__(self, filename):
 
1480
        BzrError.__init__(self)
 
1481
        self.filename = filename
 
1482
 
 
1483
 
 
1484
class BundleNotSupported(BzrError):
 
1485
 
 
1486
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1487
 
 
1488
    def __init__(self, version, msg):
 
1489
        BzrError.__init__(self)
 
1490
        self.version = version
 
1491
        self.msg = msg
 
1492
 
 
1493
 
 
1494
class MissingText(BzrError):
 
1495
 
 
1496
    _fmt = ("Branch %(base)s is missing revision"
 
1497
            " %(text_revision)s of %(file_id)s")
 
1498
 
 
1499
    def __init__(self, branch, text_revision, file_id):
 
1500
        BzrError.__init__(self)
 
1501
        self.branch = branch
 
1502
        self.base = branch.base
 
1503
        self.text_revision = text_revision
 
1504
        self.file_id = file_id
 
1505
 
 
1506
 
 
1507
class DuplicateFileId(BzrError):
 
1508
 
 
1509
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1510
 
 
1511
    def __init__(self, file_id, entry):
 
1512
        BzrError.__init__(self)
 
1513
        self.file_id = file_id
 
1514
        self.entry = entry
 
1515
 
 
1516
 
 
1517
class DuplicateKey(BzrError):
 
1518
 
 
1519
    _fmt = "Key %(key)s is already present in map"
 
1520
 
 
1521
 
 
1522
class DuplicateHelpPrefix(BzrError):
 
1523
 
 
1524
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1525
 
 
1526
    def __init__(self, prefix):
 
1527
        self.prefix = prefix
 
1528
 
 
1529
 
 
1530
class MalformedTransform(InternalBzrError):
 
1531
 
 
1532
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1533
 
 
1534
 
 
1535
class NoFinalPath(BzrError):
 
1536
 
 
1537
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1538
            "file-id: %(file_id)r\n"
 
1539
            "root trans-id: %(root_trans_id)r\n")
 
1540
 
 
1541
    def __init__(self, trans_id, transform):
 
1542
        self.trans_id = trans_id
 
1543
        self.file_id = transform.final_file_id(trans_id)
 
1544
        self.root_trans_id = transform.root
 
1545
 
 
1546
 
 
1547
class BzrBadParameter(InternalBzrError):
 
1548
 
 
1549
    _fmt = "Bad parameter: %(param)r"
 
1550
 
 
1551
    # This exception should never be thrown, but it is a base class for all
 
1552
    # parameter-to-function errors.
 
1553
 
 
1554
    def __init__(self, param):
 
1555
        BzrError.__init__(self)
 
1556
        self.param = param
 
1557
 
 
1558
 
 
1559
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1560
 
 
1561
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1562
 
 
1563
 
 
1564
class ReusingTransform(BzrError):
 
1565
 
 
1566
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1567
 
 
1568
 
 
1569
class CantMoveRoot(BzrError):
 
1570
 
 
1571
    _fmt = "Moving the root directory is not supported at this time"
 
1572
 
 
1573
 
 
1574
class TransformRenameFailed(BzrError):
 
1575
 
 
1576
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1577
 
 
1578
    def __init__(self, from_path, to_path, why, errno):
 
1579
        self.from_path = from_path
 
1580
        self.to_path = to_path
 
1581
        self.why = why
 
1582
        self.errno = errno
 
1583
 
 
1584
 
 
1585
class BzrMoveFailedError(BzrError):
 
1586
 
 
1587
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1588
        "%(_has_extra)s%(extra)s")
 
1589
 
 
1590
    def __init__(self, from_path='', to_path='', extra=None):
 
1591
        from breezy.osutils import splitpath
 
1592
        BzrError.__init__(self)
 
1593
        if extra:
 
1594
            self.extra, self._has_extra = extra, ': '
 
1595
        else:
 
1596
            self.extra = self._has_extra = ''
 
1597
 
 
1598
        has_from = len(from_path) > 0
 
1599
        has_to = len(to_path) > 0
 
1600
        if has_from:
 
1601
            self.from_path = splitpath(from_path)[-1]
 
1602
        else:
 
1603
            self.from_path = ''
 
1604
 
 
1605
        if has_to:
 
1606
            self.to_path = splitpath(to_path)[-1]
 
1607
        else:
 
1608
            self.to_path = ''
 
1609
 
 
1610
        self.operator = ""
 
1611
        if has_from and has_to:
 
1612
            self.operator = " =>"
 
1613
        elif has_from:
 
1614
            self.from_path = "from " + from_path
 
1615
        elif has_to:
 
1616
            self.operator = "to"
 
1617
        else:
 
1618
            self.operator = "file"
 
1619
 
 
1620
 
 
1621
class BzrRenameFailedError(BzrMoveFailedError):
 
1622
 
 
1623
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
1624
        "%(_has_extra)s%(extra)s")
 
1625
 
 
1626
    def __init__(self, from_path, to_path, extra=None):
 
1627
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1628
 
 
1629
 
 
1630
class BzrBadParameterNotString(BzrBadParameter):
 
1631
 
 
1632
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1633
 
 
1634
 
 
1635
class BzrBadParameterMissing(BzrBadParameter):
 
1636
 
 
1637
    _fmt = "Parameter %(param)s is required but not present."
 
1638
 
 
1639
 
 
1640
class BzrBadParameterUnicode(BzrBadParameter):
 
1641
 
 
1642
    _fmt = ("Parameter %(param)s is unicode but"
 
1643
            " only byte-strings are permitted.")
 
1644
 
 
1645
 
 
1646
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1647
 
 
1648
    _fmt = "Parameter %(param)s contains a newline."
 
1649
 
 
1650
 
 
1651
class ParamikoNotPresent(DependencyNotPresent):
 
1652
 
 
1653
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1654
 
 
1655
    def __init__(self, error):
 
1656
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1657
 
 
1658
 
 
1659
class PointlessMerge(BzrError):
 
1660
 
 
1661
    _fmt = "Nothing to merge."
 
1662
 
 
1663
 
 
1664
class UninitializableFormat(BzrError):
 
1665
 
 
1666
    _fmt = "Format %(format)s cannot be initialised by this version of brz."
 
1667
 
 
1668
    def __init__(self, format):
 
1669
        BzrError.__init__(self)
 
1670
        self.format = format
 
1671
 
 
1672
 
 
1673
class BadConversionTarget(BzrError):
 
1674
 
 
1675
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
1676
            "    %(problem)s"
 
1677
 
 
1678
    def __init__(self, problem, format, from_format=None):
 
1679
        BzrError.__init__(self)
 
1680
        self.problem = problem
 
1681
        self.format = format
 
1682
        self.from_format = from_format or '(unspecified)'
 
1683
 
 
1684
 
 
1685
class NoDiffFound(BzrError):
 
1686
 
 
1687
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
1688
 
 
1689
    def __init__(self, path):
 
1690
        BzrError.__init__(self, path)
 
1691
 
 
1692
 
 
1693
class ExecutableMissing(BzrError):
 
1694
 
 
1695
    _fmt = "%(exe_name)s could not be found on this machine"
 
1696
 
 
1697
    def __init__(self, exe_name):
 
1698
        BzrError.__init__(self, exe_name=exe_name)
 
1699
 
 
1700
 
 
1701
class NoDiff(BzrError):
 
1702
 
 
1703
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1704
 
 
1705
    def __init__(self, msg):
 
1706
        BzrError.__init__(self, msg=msg)
 
1707
 
 
1708
 
 
1709
class NoDiff3(BzrError):
 
1710
 
 
1711
    _fmt = "Diff3 is not installed on this machine."
 
1712
 
 
1713
 
 
1714
class ExistingContent(BzrError):
 
1715
    # Added in breezy 0.92, used by VersionedFile.add_lines.
 
1716
 
 
1717
    _fmt = "The content being inserted is already present."
 
1718
 
 
1719
 
 
1720
class ExistingLimbo(BzrError):
 
1721
 
 
1722
    _fmt = """This tree contains left-over files from a failed operation.
 
1723
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1724
    keep, and delete it when you are done."""
 
1725
 
 
1726
    def __init__(self, limbo_dir):
 
1727
       BzrError.__init__(self)
 
1728
       self.limbo_dir = limbo_dir
 
1729
 
 
1730
 
 
1731
class ExistingPendingDeletion(BzrError):
 
1732
 
 
1733
    _fmt = """This tree contains left-over files from a failed operation.
 
1734
    Please examine %(pending_deletion)s to see if it contains any files you
 
1735
    wish to keep, and delete it when you are done."""
 
1736
 
 
1737
    def __init__(self, pending_deletion):
 
1738
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1739
 
 
1740
 
 
1741
class ImmortalLimbo(BzrError):
 
1742
 
 
1743
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1744
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1745
    keep, and delete it when you are done."""
 
1746
 
 
1747
    def __init__(self, limbo_dir):
 
1748
       BzrError.__init__(self)
 
1749
       self.limbo_dir = limbo_dir
 
1750
 
 
1751
 
 
1752
class ImmortalPendingDeletion(BzrError):
 
1753
 
 
1754
    _fmt = ("Unable to delete transform temporary directory "
 
1755
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
1756
    "contains any files you wish to keep, and delete it when you are done.")
 
1757
 
 
1758
    def __init__(self, pending_deletion):
 
1759
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1760
 
 
1761
 
 
1762
class OutOfDateTree(BzrError):
 
1763
 
 
1764
    _fmt = "Working tree is out of date, please run 'brz update'.%(more)s"
 
1765
 
 
1766
    def __init__(self, tree, more=None):
 
1767
        if more is None:
 
1768
            more = ''
 
1769
        else:
 
1770
            more = ' ' + more
 
1771
        BzrError.__init__(self)
 
1772
        self.tree = tree
 
1773
        self.more = more
 
1774
 
 
1775
 
 
1776
class PublicBranchOutOfDate(BzrError):
 
1777
 
 
1778
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1779
        '"%(revstring)s".'
 
1780
 
 
1781
    def __init__(self, public_location, revstring):
 
1782
        import breezy.urlutils as urlutils
 
1783
        public_location = urlutils.unescape_for_display(public_location,
 
1784
                                                        'ascii')
 
1785
        BzrError.__init__(self, public_location=public_location,
 
1786
                          revstring=revstring)
 
1787
 
 
1788
 
 
1789
class MergeModifiedFormatError(BzrError):
 
1790
 
 
1791
    _fmt = "Error in merge modified format"
 
1792
 
 
1793
 
 
1794
class ConflictFormatError(BzrError):
 
1795
 
 
1796
    _fmt = "Format error in conflict listings"
 
1797
 
 
1798
 
 
1799
class CorruptRepository(BzrError):
 
1800
 
 
1801
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1802
            "Please run brz reconcile on this repository.")
 
1803
 
 
1804
    def __init__(self, repo):
 
1805
        BzrError.__init__(self)
 
1806
        self.repo_path = repo.user_url
 
1807
 
 
1808
 
 
1809
class InconsistentDelta(BzrError):
 
1810
    """Used when we get a delta that is not valid."""
 
1811
 
 
1812
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
1813
            " %(file_id)r\nreason: %(reason)s")
 
1814
 
 
1815
    def __init__(self, path, file_id, reason):
 
1816
        BzrError.__init__(self)
 
1817
        self.path = path
 
1818
        self.file_id = file_id
 
1819
        self.reason = reason
 
1820
 
 
1821
 
 
1822
class InconsistentDeltaDelta(InconsistentDelta):
 
1823
    """Used when we get a delta that is not valid."""
 
1824
 
 
1825
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
1826
            "\nreason: %(reason)s")
 
1827
 
 
1828
    def __init__(self, delta, reason):
 
1829
        BzrError.__init__(self)
 
1830
        self.delta = delta
 
1831
        self.reason = reason
 
1832
 
 
1833
 
 
1834
class UpgradeRequired(BzrError):
 
1835
 
 
1836
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1837
 
 
1838
    def __init__(self, path):
 
1839
        BzrError.__init__(self)
 
1840
        self.path = path
 
1841
 
 
1842
 
 
1843
class RepositoryUpgradeRequired(UpgradeRequired):
 
1844
 
 
1845
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
1846
 
 
1847
 
 
1848
class RichRootUpgradeRequired(UpgradeRequired):
 
1849
 
 
1850
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
1851
           " a format which supports rich roots.")
 
1852
 
 
1853
 
 
1854
class LocalRequiresBoundBranch(BzrError):
 
1855
 
 
1856
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1857
 
 
1858
 
 
1859
class UnsupportedOperation(BzrError):
 
1860
 
 
1861
    _fmt = ("The method %(mname)s is not supported on"
 
1862
            " objects of type %(tname)s.")
 
1863
 
 
1864
    def __init__(self, method, method_self):
 
1865
        self.method = method
 
1866
        self.mname = method.__name__
 
1867
        self.tname = type(method_self).__name__
 
1868
 
 
1869
 
 
1870
class NonAsciiRevisionId(UnsupportedOperation):
 
1871
    """Raised when a commit is attempting to set a non-ascii revision id
 
1872
       but cant.
 
1873
    """
 
1874
 
 
1875
 
 
1876
class GhostTagsNotSupported(BzrError):
 
1877
 
 
1878
    _fmt = "Ghost tags not supported by format %(format)r."
 
1879
 
 
1880
    def __init__(self, format):
 
1881
        self.format = format
 
1882
 
 
1883
 
 
1884
class BinaryFile(BzrError):
 
1885
 
 
1886
    _fmt = "File is binary but should be text."
 
1887
 
 
1888
 
 
1889
class IllegalPath(BzrError):
 
1890
 
 
1891
    _fmt = "The path %(path)s is not permitted on this platform"
 
1892
 
 
1893
    def __init__(self, path):
 
1894
        BzrError.__init__(self)
 
1895
        self.path = path
 
1896
 
 
1897
 
 
1898
class TestamentMismatch(BzrError):
 
1899
 
 
1900
    _fmt = """Testament did not match expected value.
 
1901
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1902
       {%(measured)s}"""
 
1903
 
 
1904
    def __init__(self, revision_id, expected, measured):
 
1905
        self.revision_id = revision_id
 
1906
        self.expected = expected
 
1907
        self.measured = measured
 
1908
 
 
1909
 
 
1910
class NotABundle(BzrError):
 
1911
 
 
1912
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1913
 
 
1914
    def __init__(self, text):
 
1915
        BzrError.__init__(self)
 
1916
        self.text = text
 
1917
 
 
1918
 
 
1919
class BadBundle(BzrError):
 
1920
 
 
1921
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1922
 
 
1923
    def __init__(self, text):
 
1924
        BzrError.__init__(self)
 
1925
        self.text = text
 
1926
 
 
1927
 
 
1928
class MalformedHeader(BadBundle):
 
1929
 
 
1930
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1931
 
 
1932
 
 
1933
class MalformedPatches(BadBundle):
 
1934
 
 
1935
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1936
 
 
1937
 
 
1938
class MalformedFooter(BadBundle):
 
1939
 
 
1940
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1941
 
 
1942
 
 
1943
class UnsupportedEOLMarker(BadBundle):
 
1944
 
 
1945
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1946
 
 
1947
    def __init__(self):
 
1948
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1949
        # but for this there is not
 
1950
        BzrError.__init__(self)
 
1951
 
 
1952
 
 
1953
class IncompatibleBundleFormat(BzrError):
 
1954
 
 
1955
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1956
 
 
1957
    def __init__(self, bundle_format, other):
 
1958
        BzrError.__init__(self)
 
1959
        self.bundle_format = bundle_format
 
1960
        self.other = other
 
1961
 
 
1962
 
 
1963
class BadInventoryFormat(BzrError):
 
1964
 
 
1965
    _fmt = "Root class for inventory serialization errors"
 
1966
 
 
1967
 
 
1968
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1969
 
 
1970
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1971
 
 
1972
    def __init__(self, msg):
 
1973
        BadInventoryFormat.__init__(self, msg=msg)
 
1974
 
 
1975
 
 
1976
class RootNotRich(BzrError):
 
1977
 
 
1978
    _fmt = """This operation requires rich root data storage"""
 
1979
 
 
1980
 
 
1981
class NoSmartMedium(InternalBzrError):
 
1982
 
 
1983
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1984
 
 
1985
    def __init__(self, transport):
 
1986
        self.transport = transport
 
1987
 
 
1988
 
 
1989
class UnknownSSH(BzrError):
 
1990
 
 
1991
    _fmt = "Unrecognised value for BRZ_SSH environment variable: %(vendor)s"
 
1992
 
 
1993
    def __init__(self, vendor):
 
1994
        BzrError.__init__(self)
 
1995
        self.vendor = vendor
 
1996
 
 
1997
 
 
1998
class SSHVendorNotFound(BzrError):
 
1999
 
 
2000
    _fmt = ("Don't know how to handle SSH connections."
 
2001
            " Please set BRZ_SSH environment variable.")
 
2002
 
 
2003
 
 
2004
class GhostRevisionsHaveNoRevno(BzrError):
 
2005
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2006
 
 
2007
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2008
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2009
 
 
2010
    def __init__(self, revision_id, ghost_revision_id):
 
2011
        self.revision_id = revision_id
 
2012
        self.ghost_revision_id = ghost_revision_id
 
2013
 
 
2014
 
 
2015
class GhostRevisionUnusableHere(BzrError):
 
2016
 
 
2017
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2018
 
 
2019
    def __init__(self, revision_id):
 
2020
        BzrError.__init__(self)
 
2021
        self.revision_id = revision_id
 
2022
 
 
2023
 
 
2024
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2025
 
 
2026
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2027
            " %(msg)s%(extra)s")
 
2028
 
 
2029
    def __init__(self, name, msg, extra=None):
 
2030
        BzrError.__init__(self)
 
2031
        self.name = name
 
2032
        self.msg = msg
 
2033
        if extra:
 
2034
            self.extra = ': ' + str(extra)
 
2035
        else:
 
2036
            self.extra = ''
 
2037
 
 
2038
 
 
2039
class InvalidImportLine(InternalBzrError):
 
2040
 
 
2041
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2042
 
 
2043
    def __init__(self, text, msg):
 
2044
        BzrError.__init__(self)
 
2045
        self.text = text
 
2046
        self.msg = msg
 
2047
 
 
2048
 
 
2049
class ImportNameCollision(InternalBzrError):
 
2050
 
 
2051
    _fmt = ("Tried to import an object to the same name as"
 
2052
            " an existing object. %(name)s")
 
2053
 
 
2054
    def __init__(self, name):
 
2055
        BzrError.__init__(self)
 
2056
        self.name = name
 
2057
 
 
2058
 
 
2059
class NotAMergeDirective(BzrError):
 
2060
    """File starting with %(firstline)r is not a merge directive"""
 
2061
    def __init__(self, firstline):
 
2062
        BzrError.__init__(self, firstline=firstline)
 
2063
 
 
2064
 
 
2065
class NoMergeSource(BzrError):
 
2066
    """Raise if no merge source was specified for a merge directive"""
 
2067
 
 
2068
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2069
        " branch location."
 
2070
 
 
2071
 
 
2072
class IllegalMergeDirectivePayload(BzrError):
 
2073
    """A merge directive contained something other than a patch or bundle"""
 
2074
 
 
2075
    _fmt = "Bad merge directive payload %(start)r"
 
2076
 
 
2077
    def __init__(self, start):
 
2078
        BzrError(self)
 
2079
        self.start = start
 
2080
 
 
2081
 
 
2082
class PatchVerificationFailed(BzrError):
 
2083
    """A patch from a merge directive could not be verified"""
 
2084
 
 
2085
    _fmt = "Preview patch does not match requested changes."
 
2086
 
 
2087
 
 
2088
class PatchMissing(BzrError):
 
2089
    """Raise a patch type was specified but no patch supplied"""
 
2090
 
 
2091
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2092
 
 
2093
    def __init__(self, patch_type):
 
2094
        BzrError.__init__(self)
 
2095
        self.patch_type = patch_type
 
2096
 
 
2097
 
 
2098
class TargetNotBranch(BzrError):
 
2099
    """A merge directive's target branch is required, but isn't a branch"""
 
2100
 
 
2101
    _fmt = ("Your branch does not have all of the revisions required in "
 
2102
            "order to merge this merge directive and the target "
 
2103
            "location specified in the merge directive is not a branch: "
 
2104
            "%(location)s.")
 
2105
 
 
2106
    def __init__(self, location):
 
2107
        BzrError.__init__(self)
 
2108
        self.location = location
 
2109
 
 
2110
 
 
2111
class UnsupportedInventoryKind(BzrError):
 
2112
 
 
2113
    _fmt = """Unsupported entry kind %(kind)s"""
 
2114
 
 
2115
    def __init__(self, kind):
 
2116
        self.kind = kind
 
2117
 
 
2118
 
 
2119
class BadSubsumeSource(BzrError):
 
2120
 
 
2121
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2122
 
 
2123
    def __init__(self, tree, other_tree, reason):
 
2124
        self.tree = tree
 
2125
        self.other_tree = other_tree
 
2126
        self.reason = reason
 
2127
 
 
2128
 
 
2129
class SubsumeTargetNeedsUpgrade(BzrError):
 
2130
 
 
2131
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2132
 
 
2133
    def __init__(self, other_tree):
 
2134
        self.other_tree = other_tree
 
2135
 
 
2136
 
 
2137
class BadReferenceTarget(InternalBzrError):
 
2138
 
 
2139
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2140
           "%(reason)s"
 
2141
 
 
2142
    def __init__(self, tree, other_tree, reason):
 
2143
        self.tree = tree
 
2144
        self.other_tree = other_tree
 
2145
        self.reason = reason
 
2146
 
 
2147
 
 
2148
class NoSuchTag(BzrError):
 
2149
 
 
2150
    _fmt = "No such tag: %(tag_name)s"
 
2151
 
 
2152
    def __init__(self, tag_name):
 
2153
        self.tag_name = tag_name
 
2154
 
 
2155
 
 
2156
class TagsNotSupported(BzrError):
 
2157
 
 
2158
    _fmt = ("Tags not supported by %(branch)s;"
 
2159
            " you may be able to use brz upgrade.")
 
2160
 
 
2161
    def __init__(self, branch):
 
2162
        self.branch = branch
 
2163
 
 
2164
 
 
2165
class TagAlreadyExists(BzrError):
 
2166
 
 
2167
    _fmt = "Tag %(tag_name)s already exists."
 
2168
 
 
2169
    def __init__(self, tag_name):
 
2170
        self.tag_name = tag_name
 
2171
 
 
2172
 
 
2173
class UnexpectedSmartServerResponse(BzrError):
 
2174
 
 
2175
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2176
 
 
2177
    def __init__(self, response_tuple):
 
2178
        self.response_tuple = response_tuple
 
2179
 
 
2180
 
 
2181
class ErrorFromSmartServer(BzrError):
 
2182
    """An error was received from a smart server.
 
2183
 
 
2184
    :seealso: UnknownErrorFromSmartServer
 
2185
    """
 
2186
 
 
2187
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2188
 
 
2189
    internal_error = True
 
2190
 
 
2191
    def __init__(self, error_tuple):
 
2192
        self.error_tuple = error_tuple
 
2193
        try:
 
2194
            self.error_verb = error_tuple[0]
 
2195
        except IndexError:
 
2196
            self.error_verb = None
 
2197
        self.error_args = error_tuple[1:]
 
2198
 
 
2199
 
 
2200
class UnknownErrorFromSmartServer(BzrError):
 
2201
    """An ErrorFromSmartServer could not be translated into a typical breezy
 
2202
    error.
 
2203
 
 
2204
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2205
    distinguish between the following two cases:
 
2206
 
 
2207
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2208
      and so should provoke a traceback to the user.
 
2209
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2210
      translated.  This is probably because the server sent us garbage, and
 
2211
      should not provoke a traceback.
 
2212
    """
 
2213
 
 
2214
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2215
 
 
2216
    internal_error = False
 
2217
 
 
2218
    def __init__(self, error_from_smart_server):
 
2219
        """Constructor.
 
2220
 
 
2221
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2222
        """
 
2223
        self.error_from_smart_server = error_from_smart_server
 
2224
        self.error_tuple = error_from_smart_server.error_tuple
 
2225
 
 
2226
 
 
2227
class ContainerError(BzrError):
 
2228
    """Base class of container errors."""
 
2229
 
 
2230
 
 
2231
class UnknownContainerFormatError(ContainerError):
 
2232
 
 
2233
    _fmt = "Unrecognised container format: %(container_format)r"
 
2234
 
 
2235
    def __init__(self, container_format):
 
2236
        self.container_format = container_format
 
2237
 
 
2238
 
 
2239
class UnexpectedEndOfContainerError(ContainerError):
 
2240
 
 
2241
    _fmt = "Unexpected end of container stream"
 
2242
 
 
2243
 
 
2244
class UnknownRecordTypeError(ContainerError):
 
2245
 
 
2246
    _fmt = "Unknown record type: %(record_type)r"
 
2247
 
 
2248
    def __init__(self, record_type):
 
2249
        self.record_type = record_type
 
2250
 
 
2251
 
 
2252
class InvalidRecordError(ContainerError):
 
2253
 
 
2254
    _fmt = "Invalid record: %(reason)s"
 
2255
 
 
2256
    def __init__(self, reason):
 
2257
        self.reason = reason
 
2258
 
 
2259
 
 
2260
class ContainerHasExcessDataError(ContainerError):
 
2261
 
 
2262
    _fmt = "Container has data after end marker: %(excess)r"
 
2263
 
 
2264
    def __init__(self, excess):
 
2265
        self.excess = excess
 
2266
 
 
2267
 
 
2268
class DuplicateRecordNameError(ContainerError):
 
2269
 
 
2270
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2271
 
 
2272
    def __init__(self, name):
 
2273
        self.name = name.decode("utf-8")
 
2274
 
 
2275
 
 
2276
class RepositoryDataStreamError(BzrError):
 
2277
 
 
2278
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2279
 
 
2280
    def __init__(self, reason):
 
2281
        self.reason = reason
 
2282
 
 
2283
 
 
2284
class UncommittedChanges(BzrError):
 
2285
 
 
2286
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2287
            ' (See brz status).%(more)s')
 
2288
 
 
2289
    def __init__(self, tree, more=None):
 
2290
        if more is None:
 
2291
            more = ''
 
2292
        else:
 
2293
            more = ' ' + more
 
2294
        import breezy.urlutils as urlutils
 
2295
        user_url = getattr(tree, "user_url", None)
 
2296
        if user_url is None:
 
2297
            display_url = str(tree)
 
2298
        else:
 
2299
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2300
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2301
 
 
2302
 
 
2303
class StoringUncommittedNotSupported(BzrError):
 
2304
 
 
2305
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2306
            ' changes.')
 
2307
 
 
2308
    def __init__(self, branch):
 
2309
        import breezy.urlutils as urlutils
 
2310
        user_url = getattr(branch, "user_url", None)
 
2311
        if user_url is None:
 
2312
            display_url = str(branch)
 
2313
        else:
 
2314
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2315
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2316
 
 
2317
 
 
2318
class ShelvedChanges(UncommittedChanges):
 
2319
 
 
2320
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2321
            ' (See brz shelve --list).%(more)s')
 
2322
 
 
2323
 
 
2324
class UnableCreateSymlink(BzrError):
 
2325
 
 
2326
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2327
 
 
2328
    def __init__(self, path=None):
 
2329
        path_str = ''
 
2330
        if path:
 
2331
            try:
 
2332
                path_str = repr(str(path))
 
2333
            except UnicodeEncodeError:
 
2334
                path_str = repr(path)
 
2335
            path_str += ' '
 
2336
        self.path_str = path_str
 
2337
 
 
2338
 
 
2339
class UnableEncodePath(BzrError):
 
2340
 
 
2341
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2342
            'user encoding %(user_encoding)s')
 
2343
 
 
2344
    def __init__(self, path, kind):
 
2345
        from breezy.osutils import get_user_encoding
 
2346
        self.path = path
 
2347
        self.kind = kind
 
2348
        self.user_encoding = get_user_encoding()
 
2349
 
 
2350
 
 
2351
class NoSuchAlias(BzrError):
 
2352
 
 
2353
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2354
 
 
2355
    def __init__(self, alias_name):
 
2356
        BzrError.__init__(self, alias_name=alias_name)
 
2357
 
 
2358
 
 
2359
class CannotBindAddress(BzrError):
 
2360
 
 
2361
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2362
 
 
2363
    def __init__(self, host, port, orig_error):
 
2364
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2365
        BzrError.__init__(self, host=host, port=port,
 
2366
            orig_error=repr(orig_error.args))
 
2367
 
 
2368
 
 
2369
class TipChangeRejected(BzrError):
 
2370
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2371
    explicitly abort a change to a branch tip.
 
2372
    """
 
2373
 
 
2374
    _fmt = u"Tip change rejected: %(msg)s"
 
2375
 
 
2376
    def __init__(self, msg):
 
2377
        self.msg = msg
 
2378
 
 
2379
 
 
2380
class JailBreak(BzrError):
 
2381
 
 
2382
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2383
 
 
2384
    def __init__(self, url):
 
2385
        BzrError.__init__(self, url=url)
 
2386
 
 
2387
 
 
2388
class UserAbort(BzrError):
 
2389
 
 
2390
    _fmt = 'The user aborted the operation.'
 
2391
 
 
2392
 
 
2393
class UnresumableWriteGroup(BzrError):
 
2394
 
 
2395
    _fmt = ("Repository %(repository)s cannot resume write group "
 
2396
            "%(write_groups)r: %(reason)s")
 
2397
 
 
2398
    internal_error = True
 
2399
 
 
2400
    def __init__(self, repository, write_groups, reason):
 
2401
        self.repository = repository
 
2402
        self.write_groups = write_groups
 
2403
        self.reason = reason
 
2404
 
 
2405
 
 
2406
class UnsuspendableWriteGroup(BzrError):
 
2407
 
 
2408
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
2409
 
 
2410
    internal_error = True
 
2411
 
 
2412
    def __init__(self, repository):
 
2413
        self.repository = repository
 
2414
 
 
2415
 
 
2416
class LossyPushToSameVCS(BzrError):
 
2417
 
 
2418
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
2419
            "%(target_branch)r that are in the same VCS.")
 
2420
 
 
2421
    internal_error = True
 
2422
 
 
2423
    def __init__(self, source_branch, target_branch):
 
2424
        self.source_branch = source_branch
 
2425
        self.target_branch = target_branch
 
2426
 
 
2427
 
 
2428
class NoRoundtrippingSupport(BzrError):
 
2429
 
 
2430
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
2431
            "%(target_branch)r.")
 
2432
 
 
2433
    internal_error = True
 
2434
 
 
2435
    def __init__(self, source_branch, target_branch):
 
2436
        self.source_branch = source_branch
 
2437
        self.target_branch = target_branch
 
2438
 
 
2439
 
 
2440
class NoColocatedBranchSupport(BzrError):
 
2441
 
 
2442
    _fmt = ("%(controldir)r does not support co-located branches.")
 
2443
 
 
2444
    def __init__(self, controldir):
 
2445
        self.controldir = controldir
 
2446
 
 
2447
 
 
2448
class RecursiveBind(BzrError):
 
2449
 
 
2450
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
2451
        'Please use `brz unbind` to fix.')
 
2452
 
 
2453
    def __init__(self, branch_url):
 
2454
        self.branch_url = branch_url
 
2455
 
 
2456
 
 
2457
class UnsupportedKindChange(BzrError):
 
2458
 
 
2459
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
2460
            "%(path)s not supported by format %(format)r")
 
2461
 
 
2462
    def __init__(self, path, from_kind, to_kind, format):
 
2463
        self.path = path
 
2464
        self.from_kind = from_kind
 
2465
        self.to_kind = to_kind
 
2466
        self.format = format
 
2467
 
 
2468
 
 
2469
class ChangesAlreadyStored(BzrCommandError):
 
2470
 
 
2471
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
2472
            ' stores uncommitted changes.')