/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: 2019-03-13 23:24:13 UTC
  • mto: (7290.1.23 work)
  • mto: This revision was merged to the branch mainline in revision 7311.
  • Revision ID: jelmer@jelmer.uk-20190313232413-y1c951be4surcc9g
Fix formatting.

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