/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: 2018-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

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 AtomicFileAlreadyClosed(PathError):
 
564
 
 
565
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
566
            ' "%(path)s"')
 
567
 
 
568
    def __init__(self, path, function):
 
569
        PathError.__init__(self, path=path, extra=None)
 
570
        self.function = function
 
571
 
 
572
 
 
573
class InaccessibleParent(PathError):
 
574
 
 
575
    _fmt = ('Parent not accessible given base "%(base)s" and'
 
576
            ' relative path "%(path)s"')
 
577
 
 
578
    def __init__(self, path, base):
 
579
        PathError.__init__(self, path)
 
580
        self.base = base
 
581
 
 
582
 
 
583
class NoRepositoryPresent(BzrError):
 
584
 
 
585
    _fmt = 'No repository present: "%(path)s"'
 
586
    def __init__(self, controldir):
 
587
        BzrError.__init__(self)
 
588
        self.path = controldir.transport.clone('..').base
 
589
 
 
590
 
 
591
class UnsupportedFormatError(BzrError):
 
592
 
 
593
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'brz upgrade'"
 
594
 
 
595
 
 
596
class UnknownFormatError(BzrError):
 
597
 
 
598
    _fmt = "Unknown %(kind)s format: %(format)r"
 
599
 
 
600
    def __init__(self, format, kind='branch'):
 
601
        self.kind = kind
 
602
        self.format = format
 
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
 
 
1068
class UnlistableBranch(BzrError):
 
1069
 
 
1070
    def __init__(self, br):
 
1071
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1072
 
 
1073
 
 
1074
class BoundBranchOutOfDate(BzrError):
 
1075
 
 
1076
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1077
            " %(master)s.%(extra_help)s")
 
1078
 
 
1079
    def __init__(self, branch, master):
 
1080
        BzrError.__init__(self)
 
1081
        self.branch = branch
 
1082
        self.master = master
 
1083
        self.extra_help = ''
 
1084
 
 
1085
 
 
1086
class CommitToDoubleBoundBranch(BzrError):
 
1087
 
 
1088
    _fmt = ("Cannot commit to branch %(branch)s."
 
1089
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1090
 
 
1091
    def __init__(self, branch, master, remote):
 
1092
        BzrError.__init__(self)
 
1093
        self.branch = branch
 
1094
        self.master = master
 
1095
        self.remote = remote
 
1096
 
 
1097
 
 
1098
class OverwriteBoundBranch(BzrError):
 
1099
 
 
1100
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1101
 
 
1102
    def __init__(self, branch):
 
1103
        BzrError.__init__(self)
 
1104
        self.branch = branch
 
1105
 
 
1106
 
 
1107
class BoundBranchConnectionFailure(BzrError):
 
1108
 
 
1109
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1110
            " => %(target)s: %(error)s")
 
1111
 
 
1112
    def __init__(self, branch, target, error):
 
1113
        BzrError.__init__(self)
 
1114
        self.branch = branch
 
1115
        self.target = target
 
1116
        self.error = error
 
1117
 
 
1118
 
 
1119
class VersionedFileError(BzrError):
 
1120
 
 
1121
    _fmt = "Versioned file error"
 
1122
 
 
1123
 
 
1124
class RevisionNotPresent(VersionedFileError):
 
1125
 
 
1126
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1127
 
 
1128
    def __init__(self, revision_id, file_id):
 
1129
        VersionedFileError.__init__(self)
 
1130
        self.revision_id = revision_id
 
1131
        self.file_id = file_id
 
1132
 
 
1133
 
 
1134
class RevisionAlreadyPresent(VersionedFileError):
 
1135
 
 
1136
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1137
 
 
1138
    def __init__(self, revision_id, file_id):
 
1139
        VersionedFileError.__init__(self)
 
1140
        self.revision_id = revision_id
 
1141
        self.file_id = file_id
 
1142
 
 
1143
 
 
1144
class VersionedFileInvalidChecksum(VersionedFileError):
 
1145
 
 
1146
    _fmt = "Text did not match its checksum: %(msg)s"
 
1147
 
 
1148
 
 
1149
class RetryWithNewPacks(BzrError):
 
1150
    """Raised when we realize that the packs on disk have changed.
 
1151
 
 
1152
    This is meant as more of a signaling exception, to trap between where a
 
1153
    local error occurred and the code that can actually handle the error and
 
1154
    code that can retry appropriately.
 
1155
    """
 
1156
 
 
1157
    internal_error = True
 
1158
 
 
1159
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1160
            " %(orig_error)s")
 
1161
 
 
1162
    def __init__(self, context, reload_occurred, exc_info):
 
1163
        """create a new RetryWithNewPacks error.
 
1164
 
 
1165
        :param reload_occurred: Set to True if we know that the packs have
 
1166
            already been reloaded, and we are failing because of an in-memory
 
1167
            cache miss. If set to True then we will ignore if a reload says
 
1168
            nothing has changed, because we assume it has already reloaded. If
 
1169
            False, then a reload with nothing changed will force an error.
 
1170
        :param exc_info: The original exception traceback, so if there is a
 
1171
            problem we can raise the original error (value from sys.exc_info())
 
1172
        """
 
1173
        BzrError.__init__(self)
 
1174
        self.context = context
 
1175
        self.reload_occurred = reload_occurred
 
1176
        self.exc_info = exc_info
 
1177
        self.orig_error = exc_info[1]
 
1178
        # TODO: The global error handler should probably treat this by
 
1179
        #       raising/printing the original exception with a bit about
 
1180
        #       RetryWithNewPacks also not being caught
 
1181
 
 
1182
 
 
1183
class RetryAutopack(RetryWithNewPacks):
 
1184
    """Raised when we are autopacking and we find a missing file.
 
1185
 
 
1186
    Meant as a signaling exception, to tell the autopack code it should try
 
1187
    again.
 
1188
    """
 
1189
 
 
1190
    internal_error = True
 
1191
 
 
1192
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1193
            " context: %(context)s %(orig_error)s")
 
1194
 
 
1195
 
 
1196
class NoSuchExportFormat(BzrError):
 
1197
 
 
1198
    _fmt = "Export format %(format)r not supported"
 
1199
 
 
1200
    def __init__(self, format):
 
1201
        BzrError.__init__(self)
 
1202
        self.format = format
 
1203
 
 
1204
 
 
1205
class TransportError(BzrError):
 
1206
 
 
1207
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1208
 
 
1209
    def __init__(self, msg=None, orig_error=None):
 
1210
        if msg is None and orig_error is not None:
 
1211
            msg = str(orig_error)
 
1212
        if orig_error is None:
 
1213
            orig_error = ''
 
1214
        if msg is None:
 
1215
            msg =  ''
 
1216
        self.msg = msg
 
1217
        self.orig_error = orig_error
 
1218
        BzrError.__init__(self)
 
1219
 
 
1220
 
 
1221
class TooManyConcurrentRequests(InternalBzrError):
 
1222
 
 
1223
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1224
            " Be sure to finish_writing and finish_reading on the"
 
1225
            " currently open request.")
 
1226
 
 
1227
    def __init__(self, medium):
 
1228
        self.medium = medium
 
1229
 
 
1230
 
 
1231
class SmartProtocolError(TransportError):
 
1232
 
 
1233
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1234
 
 
1235
    def __init__(self, details):
 
1236
        self.details = details
 
1237
 
 
1238
 
 
1239
class UnexpectedProtocolVersionMarker(TransportError):
 
1240
 
 
1241
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1242
 
 
1243
    def __init__(self, marker):
 
1244
        self.marker = marker
 
1245
 
 
1246
 
 
1247
class UnknownSmartMethod(InternalBzrError):
 
1248
 
 
1249
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1250
 
 
1251
    def __init__(self, verb):
 
1252
        self.verb = verb
 
1253
 
 
1254
 
 
1255
class SmartMessageHandlerError(InternalBzrError):
 
1256
 
 
1257
    _fmt = ("The message handler raised an exception:\n"
 
1258
            "%(traceback_text)s")
 
1259
 
 
1260
    def __init__(self, exc_info):
 
1261
        import traceback
 
1262
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1263
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1264
        self.exc_info = exc_info
 
1265
        traceback_strings = traceback.format_exception(
 
1266
                self.exc_type, self.exc_value, self.exc_tb)
 
1267
        self.traceback_text = ''.join(traceback_strings)
 
1268
 
 
1269
 
 
1270
# A set of semi-meaningful errors which can be thrown
 
1271
class TransportNotPossible(TransportError):
 
1272
 
 
1273
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1274
 
 
1275
 
 
1276
class ConnectionError(TransportError):
 
1277
 
 
1278
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1279
 
 
1280
 
 
1281
class SocketConnectionError(ConnectionError):
 
1282
 
 
1283
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1284
 
 
1285
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1286
        if msg is None:
 
1287
            msg = 'Failed to connect to'
 
1288
        if orig_error is None:
 
1289
            orig_error = ''
 
1290
        else:
 
1291
            orig_error = '; ' + str(orig_error)
 
1292
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1293
        self.host = host
 
1294
        if port is None:
 
1295
            self.port = ''
 
1296
        else:
 
1297
            self.port = ':%s' % port
 
1298
 
 
1299
 
 
1300
# XXX: This is also used for unexpected end of file, which is different at the
 
1301
# TCP level from "connection reset".
 
1302
class ConnectionReset(TransportError):
 
1303
 
 
1304
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1305
 
 
1306
 
 
1307
class ConnectionTimeout(ConnectionError):
 
1308
 
 
1309
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1310
 
 
1311
 
 
1312
class InvalidRange(TransportError):
 
1313
 
 
1314
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1315
 
 
1316
    def __init__(self, path, offset, msg=None):
 
1317
        TransportError.__init__(self, msg)
 
1318
        self.path = path
 
1319
        self.offset = offset
 
1320
 
 
1321
 
 
1322
class InvalidHttpResponse(TransportError):
 
1323
 
 
1324
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1325
 
 
1326
    def __init__(self, path, msg, orig_error=None):
 
1327
        self.path = path
 
1328
        if orig_error is None:
 
1329
            orig_error = ''
 
1330
        else:
 
1331
            # This is reached for obscure and unusual errors so we want to
 
1332
            # preserve as much info as possible to ease debug.
 
1333
            orig_error = ': %r' % (orig_error,)
 
1334
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1335
 
 
1336
 
 
1337
class InvalidHttpRange(InvalidHttpResponse):
 
1338
 
 
1339
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1340
 
 
1341
    def __init__(self, path, range, msg):
 
1342
        self.range = range
 
1343
        InvalidHttpResponse.__init__(self, path, msg)
 
1344
 
 
1345
 
 
1346
class HttpBoundaryMissing(InvalidHttpResponse):
 
1347
    """A multipart response ends with no boundary marker.
 
1348
 
 
1349
    This is a special case caused by buggy proxies, described in
 
1350
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1351
    """
 
1352
 
 
1353
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1354
 
 
1355
    def __init__(self, path, msg):
 
1356
        InvalidHttpResponse.__init__(self, path, msg)
 
1357
 
 
1358
 
 
1359
class InvalidHttpContentType(InvalidHttpResponse):
 
1360
 
 
1361
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1362
 
 
1363
    def __init__(self, path, ctype, msg):
 
1364
        self.ctype = ctype
 
1365
        InvalidHttpResponse.__init__(self, path, msg)
 
1366
 
 
1367
 
 
1368
class RedirectRequested(TransportError):
 
1369
 
 
1370
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1371
 
 
1372
    def __init__(self, source, target, is_permanent=False):
 
1373
        self.source = source
 
1374
        self.target = target
 
1375
        if is_permanent:
 
1376
            self.permanently = ' permanently'
 
1377
        else:
 
1378
            self.permanently = ''
 
1379
        TransportError.__init__(self)
 
1380
 
 
1381
 
 
1382
class TooManyRedirections(TransportError):
 
1383
 
 
1384
    _fmt = "Too many redirections"
 
1385
 
 
1386
 
 
1387
class ConflictsInTree(BzrError):
 
1388
 
 
1389
    _fmt = "Working tree has conflicts."
 
1390
 
 
1391
 
 
1392
class DependencyNotPresent(BzrError):
 
1393
 
 
1394
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1395
 
 
1396
    def __init__(self, library, error):
 
1397
        BzrError.__init__(self, library=library, error=error)
 
1398
 
 
1399
 
 
1400
class WorkingTreeNotRevision(BzrError):
 
1401
 
 
1402
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1403
            " the last commit, but weave merge requires that it be"
 
1404
            " unchanged")
 
1405
 
 
1406
    def __init__(self, tree):
 
1407
        BzrError.__init__(self, basedir=tree.basedir)
 
1408
 
 
1409
 
 
1410
class CantReprocessAndShowBase(BzrError):
 
1411
 
 
1412
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1413
           "the relationship of conflicting lines to the base")
 
1414
 
 
1415
 
 
1416
class GraphCycleError(BzrError):
 
1417
 
 
1418
    _fmt = "Cycle in graph %(graph)r"
 
1419
 
 
1420
    def __init__(self, graph):
 
1421
        BzrError.__init__(self)
 
1422
        self.graph = graph
 
1423
 
 
1424
 
 
1425
class WritingCompleted(InternalBzrError):
 
1426
 
 
1427
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1428
            "called upon it - accept bytes may not be called anymore.")
 
1429
 
 
1430
    def __init__(self, request):
 
1431
        self.request = request
 
1432
 
 
1433
 
 
1434
class WritingNotComplete(InternalBzrError):
 
1435
 
 
1436
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1437
            "called upon it - until the write phase is complete no "
 
1438
            "data may be read.")
 
1439
 
 
1440
    def __init__(self, request):
 
1441
        self.request = request
 
1442
 
 
1443
 
 
1444
class NotConflicted(BzrError):
 
1445
 
 
1446
    _fmt = "File %(filename)s is not conflicted."
 
1447
 
 
1448
    def __init__(self, filename):
 
1449
        BzrError.__init__(self)
 
1450
        self.filename = filename
 
1451
 
 
1452
 
 
1453
class MediumNotConnected(InternalBzrError):
 
1454
 
 
1455
    _fmt = """The medium '%(medium)s' is not connected."""
 
1456
 
 
1457
    def __init__(self, medium):
 
1458
        self.medium = medium
 
1459
 
 
1460
 
 
1461
class MustUseDecorated(Exception):
 
1462
 
 
1463
    _fmt = "A decorating function has requested its original command be used."
 
1464
 
 
1465
 
 
1466
class NoBundleFound(BzrError):
 
1467
 
 
1468
    _fmt = 'No bundle was found in "%(filename)s".'
 
1469
 
 
1470
    def __init__(self, filename):
 
1471
        BzrError.__init__(self)
 
1472
        self.filename = filename
 
1473
 
 
1474
 
 
1475
class BundleNotSupported(BzrError):
 
1476
 
 
1477
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1478
 
 
1479
    def __init__(self, version, msg):
 
1480
        BzrError.__init__(self)
 
1481
        self.version = version
 
1482
        self.msg = msg
 
1483
 
 
1484
 
 
1485
class MissingText(BzrError):
 
1486
 
 
1487
    _fmt = ("Branch %(base)s is missing revision"
 
1488
            " %(text_revision)s of %(file_id)s")
 
1489
 
 
1490
    def __init__(self, branch, text_revision, file_id):
 
1491
        BzrError.__init__(self)
 
1492
        self.branch = branch
 
1493
        self.base = branch.base
 
1494
        self.text_revision = text_revision
 
1495
        self.file_id = file_id
 
1496
 
 
1497
 
 
1498
class DuplicateFileId(BzrError):
 
1499
 
 
1500
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1501
 
 
1502
    def __init__(self, file_id, entry):
 
1503
        BzrError.__init__(self)
 
1504
        self.file_id = file_id
 
1505
        self.entry = entry
 
1506
 
 
1507
 
 
1508
class DuplicateKey(BzrError):
 
1509
 
 
1510
    _fmt = "Key %(key)s is already present in map"
 
1511
 
 
1512
 
 
1513
class DuplicateHelpPrefix(BzrError):
 
1514
 
 
1515
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1516
 
 
1517
    def __init__(self, prefix):
 
1518
        self.prefix = prefix
 
1519
 
 
1520
 
 
1521
class MalformedTransform(InternalBzrError):
 
1522
 
 
1523
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1524
 
 
1525
 
 
1526
class NoFinalPath(BzrError):
 
1527
 
 
1528
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1529
            "file-id: %(file_id)r\n"
 
1530
            "root trans-id: %(root_trans_id)r\n")
 
1531
 
 
1532
    def __init__(self, trans_id, transform):
 
1533
        self.trans_id = trans_id
 
1534
        self.file_id = transform.final_file_id(trans_id)
 
1535
        self.root_trans_id = transform.root
 
1536
 
 
1537
 
 
1538
class BzrBadParameter(InternalBzrError):
 
1539
 
 
1540
    _fmt = "Bad parameter: %(param)r"
 
1541
 
 
1542
    # This exception should never be thrown, but it is a base class for all
 
1543
    # parameter-to-function errors.
 
1544
 
 
1545
    def __init__(self, param):
 
1546
        BzrError.__init__(self)
 
1547
        self.param = param
 
1548
 
 
1549
 
 
1550
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1551
 
 
1552
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1553
 
 
1554
 
 
1555
class ReusingTransform(BzrError):
 
1556
 
 
1557
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1558
 
 
1559
 
 
1560
class CantMoveRoot(BzrError):
 
1561
 
 
1562
    _fmt = "Moving the root directory is not supported at this time"
 
1563
 
 
1564
 
 
1565
class TransformRenameFailed(BzrError):
 
1566
 
 
1567
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1568
 
 
1569
    def __init__(self, from_path, to_path, why, errno):
 
1570
        self.from_path = from_path
 
1571
        self.to_path = to_path
 
1572
        self.why = why
 
1573
        self.errno = errno
 
1574
 
 
1575
 
 
1576
class BzrMoveFailedError(BzrError):
 
1577
 
 
1578
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1579
        "%(_has_extra)s%(extra)s")
 
1580
 
 
1581
    def __init__(self, from_path='', to_path='', extra=None):
 
1582
        from breezy.osutils import splitpath
 
1583
        BzrError.__init__(self)
 
1584
        if extra:
 
1585
            self.extra, self._has_extra = extra, ': '
 
1586
        else:
 
1587
            self.extra = self._has_extra = ''
 
1588
 
 
1589
        has_from = len(from_path) > 0
 
1590
        has_to = len(to_path) > 0
 
1591
        if has_from:
 
1592
            self.from_path = splitpath(from_path)[-1]
 
1593
        else:
 
1594
            self.from_path = ''
 
1595
 
 
1596
        if has_to:
 
1597
            self.to_path = splitpath(to_path)[-1]
 
1598
        else:
 
1599
            self.to_path = ''
 
1600
 
 
1601
        self.operator = ""
 
1602
        if has_from and has_to:
 
1603
            self.operator = " =>"
 
1604
        elif has_from:
 
1605
            self.from_path = "from " + from_path
 
1606
        elif has_to:
 
1607
            self.operator = "to"
 
1608
        else:
 
1609
            self.operator = "file"
 
1610
 
 
1611
 
 
1612
class BzrRenameFailedError(BzrMoveFailedError):
 
1613
 
 
1614
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
1615
        "%(_has_extra)s%(extra)s")
 
1616
 
 
1617
    def __init__(self, from_path, to_path, extra=None):
 
1618
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1619
 
 
1620
 
 
1621
class BzrBadParameterNotString(BzrBadParameter):
 
1622
 
 
1623
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1624
 
 
1625
 
 
1626
class BzrBadParameterMissing(BzrBadParameter):
 
1627
 
 
1628
    _fmt = "Parameter %(param)s is required but not present."
 
1629
 
 
1630
 
 
1631
class BzrBadParameterUnicode(BzrBadParameter):
 
1632
 
 
1633
    _fmt = ("Parameter %(param)s is unicode but"
 
1634
            " only byte-strings are permitted.")
 
1635
 
 
1636
 
 
1637
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1638
 
 
1639
    _fmt = "Parameter %(param)s contains a newline."
 
1640
 
 
1641
 
 
1642
class ParamikoNotPresent(DependencyNotPresent):
 
1643
 
 
1644
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1645
 
 
1646
    def __init__(self, error):
 
1647
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1648
 
 
1649
 
 
1650
class PointlessMerge(BzrError):
 
1651
 
 
1652
    _fmt = "Nothing to merge."
 
1653
 
 
1654
 
 
1655
class UninitializableFormat(BzrError):
 
1656
 
 
1657
    _fmt = "Format %(format)s cannot be initialised by this version of brz."
 
1658
 
 
1659
    def __init__(self, format):
 
1660
        BzrError.__init__(self)
 
1661
        self.format = format
 
1662
 
 
1663
 
 
1664
class BadConversionTarget(BzrError):
 
1665
 
 
1666
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
1667
            "    %(problem)s"
 
1668
 
 
1669
    def __init__(self, problem, format, from_format=None):
 
1670
        BzrError.__init__(self)
 
1671
        self.problem = problem
 
1672
        self.format = format
 
1673
        self.from_format = from_format or '(unspecified)'
 
1674
 
 
1675
 
 
1676
class NoDiffFound(BzrError):
 
1677
 
 
1678
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
1679
 
 
1680
    def __init__(self, path):
 
1681
        BzrError.__init__(self, path)
 
1682
 
 
1683
 
 
1684
class ExecutableMissing(BzrError):
 
1685
 
 
1686
    _fmt = "%(exe_name)s could not be found on this machine"
 
1687
 
 
1688
    def __init__(self, exe_name):
 
1689
        BzrError.__init__(self, exe_name=exe_name)
 
1690
 
 
1691
 
 
1692
class NoDiff(BzrError):
 
1693
 
 
1694
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1695
 
 
1696
    def __init__(self, msg):
 
1697
        BzrError.__init__(self, msg=msg)
 
1698
 
 
1699
 
 
1700
class NoDiff3(BzrError):
 
1701
 
 
1702
    _fmt = "Diff3 is not installed on this machine."
 
1703
 
 
1704
 
 
1705
class ExistingContent(BzrError):
 
1706
    # Added in breezy 0.92, used by VersionedFile.add_lines.
 
1707
 
 
1708
    _fmt = "The content being inserted is already present."
 
1709
 
 
1710
 
 
1711
class ExistingLimbo(BzrError):
 
1712
 
 
1713
    _fmt = """This tree contains left-over files from a failed operation.
 
1714
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1715
    keep, and delete it when you are done."""
 
1716
 
 
1717
    def __init__(self, limbo_dir):
 
1718
       BzrError.__init__(self)
 
1719
       self.limbo_dir = limbo_dir
 
1720
 
 
1721
 
 
1722
class ExistingPendingDeletion(BzrError):
 
1723
 
 
1724
    _fmt = """This tree contains left-over files from a failed operation.
 
1725
    Please examine %(pending_deletion)s to see if it contains any files you
 
1726
    wish to keep, and delete it when you are done."""
 
1727
 
 
1728
    def __init__(self, pending_deletion):
 
1729
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1730
 
 
1731
 
 
1732
class ImmortalLimbo(BzrError):
 
1733
 
 
1734
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1735
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1736
    keep, and delete it when you are done."""
 
1737
 
 
1738
    def __init__(self, limbo_dir):
 
1739
       BzrError.__init__(self)
 
1740
       self.limbo_dir = limbo_dir
 
1741
 
 
1742
 
 
1743
class ImmortalPendingDeletion(BzrError):
 
1744
 
 
1745
    _fmt = ("Unable to delete transform temporary directory "
 
1746
    "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
1747
    "contains any files you wish to keep, and delete it when you are done.")
 
1748
 
 
1749
    def __init__(self, pending_deletion):
 
1750
       BzrError.__init__(self, pending_deletion=pending_deletion)
 
1751
 
 
1752
 
 
1753
class OutOfDateTree(BzrError):
 
1754
 
 
1755
    _fmt = "Working tree is out of date, please run 'brz update'.%(more)s"
 
1756
 
 
1757
    def __init__(self, tree, more=None):
 
1758
        if more is None:
 
1759
            more = ''
 
1760
        else:
 
1761
            more = ' ' + more
 
1762
        BzrError.__init__(self)
 
1763
        self.tree = tree
 
1764
        self.more = more
 
1765
 
 
1766
 
 
1767
class PublicBranchOutOfDate(BzrError):
 
1768
 
 
1769
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1770
        '"%(revstring)s".'
 
1771
 
 
1772
    def __init__(self, public_location, revstring):
 
1773
        import breezy.urlutils as urlutils
 
1774
        public_location = urlutils.unescape_for_display(public_location,
 
1775
                                                        'ascii')
 
1776
        BzrError.__init__(self, public_location=public_location,
 
1777
                          revstring=revstring)
 
1778
 
 
1779
 
 
1780
class MergeModifiedFormatError(BzrError):
 
1781
 
 
1782
    _fmt = "Error in merge modified format"
 
1783
 
 
1784
 
 
1785
class ConflictFormatError(BzrError):
 
1786
 
 
1787
    _fmt = "Format error in conflict listings"
 
1788
 
 
1789
 
 
1790
class CorruptRepository(BzrError):
 
1791
 
 
1792
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1793
            "Please run brz reconcile on this repository.")
 
1794
 
 
1795
    def __init__(self, repo):
 
1796
        BzrError.__init__(self)
 
1797
        self.repo_path = repo.user_url
 
1798
 
 
1799
 
 
1800
class InconsistentDelta(BzrError):
 
1801
    """Used when we get a delta that is not valid."""
 
1802
 
 
1803
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
1804
            " %(file_id)r\nreason: %(reason)s")
 
1805
 
 
1806
    def __init__(self, path, file_id, reason):
 
1807
        BzrError.__init__(self)
 
1808
        self.path = path
 
1809
        self.file_id = file_id
 
1810
        self.reason = reason
 
1811
 
 
1812
 
 
1813
class InconsistentDeltaDelta(InconsistentDelta):
 
1814
    """Used when we get a delta that is not valid."""
 
1815
 
 
1816
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
1817
            "\nreason: %(reason)s")
 
1818
 
 
1819
    def __init__(self, delta, reason):
 
1820
        BzrError.__init__(self)
 
1821
        self.delta = delta
 
1822
        self.reason = reason
 
1823
 
 
1824
 
 
1825
class UpgradeRequired(BzrError):
 
1826
 
 
1827
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1828
 
 
1829
    def __init__(self, path):
 
1830
        BzrError.__init__(self)
 
1831
        self.path = path
 
1832
 
 
1833
 
 
1834
class RepositoryUpgradeRequired(UpgradeRequired):
 
1835
 
 
1836
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
1837
 
 
1838
 
 
1839
class RichRootUpgradeRequired(UpgradeRequired):
 
1840
 
 
1841
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
1842
           " a format which supports rich roots.")
 
1843
 
 
1844
 
 
1845
class LocalRequiresBoundBranch(BzrError):
 
1846
 
 
1847
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1848
 
 
1849
 
 
1850
class UnsupportedOperation(BzrError):
 
1851
 
 
1852
    _fmt = ("The method %(mname)s is not supported on"
 
1853
            " objects of type %(tname)s.")
 
1854
 
 
1855
    def __init__(self, method, method_self):
 
1856
        self.method = method
 
1857
        self.mname = method.__name__
 
1858
        self.tname = type(method_self).__name__
 
1859
 
 
1860
 
 
1861
class FetchLimitUnsupported(UnsupportedOperation):
 
1862
 
 
1863
    fmt = ("InterBranch %(interbranch)r does not support fetching limits.")
 
1864
 
 
1865
    def __init__(self, interbranch):
 
1866
        BzrError.__init__(self, interbranch=interbranch)
 
1867
 
 
1868
 
 
1869
class NonAsciiRevisionId(UnsupportedOperation):
 
1870
    """Raised when a commit is attempting to set a non-ascii revision id
 
1871
       but cant.
 
1872
    """
 
1873
 
 
1874
 
 
1875
class GhostTagsNotSupported(BzrError):
 
1876
 
 
1877
    _fmt = "Ghost tags not supported by format %(format)r."
 
1878
 
 
1879
    def __init__(self, format):
 
1880
        self.format = format
 
1881
 
 
1882
 
 
1883
class BinaryFile(BzrError):
 
1884
 
 
1885
    _fmt = "File is binary but should be text."
 
1886
 
 
1887
 
 
1888
class IllegalPath(BzrError):
 
1889
 
 
1890
    _fmt = "The path %(path)s is not permitted on this platform"
 
1891
 
 
1892
    def __init__(self, path):
 
1893
        BzrError.__init__(self)
 
1894
        self.path = path
 
1895
 
 
1896
 
 
1897
class TestamentMismatch(BzrError):
 
1898
 
 
1899
    _fmt = """Testament did not match expected value.
 
1900
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1901
       {%(measured)s}"""
 
1902
 
 
1903
    def __init__(self, revision_id, expected, measured):
 
1904
        self.revision_id = revision_id
 
1905
        self.expected = expected
 
1906
        self.measured = measured
 
1907
 
 
1908
 
 
1909
class NotABundle(BzrError):
 
1910
 
 
1911
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1912
 
 
1913
    def __init__(self, text):
 
1914
        BzrError.__init__(self)
 
1915
        self.text = text
 
1916
 
 
1917
 
 
1918
class BadBundle(BzrError):
 
1919
 
 
1920
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1921
 
 
1922
    def __init__(self, text):
 
1923
        BzrError.__init__(self)
 
1924
        self.text = text
 
1925
 
 
1926
 
 
1927
class MalformedHeader(BadBundle):
 
1928
 
 
1929
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1930
 
 
1931
 
 
1932
class MalformedPatches(BadBundle):
 
1933
 
 
1934
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1935
 
 
1936
 
 
1937
class MalformedFooter(BadBundle):
 
1938
 
 
1939
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1940
 
 
1941
 
 
1942
class UnsupportedEOLMarker(BadBundle):
 
1943
 
 
1944
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1945
 
 
1946
    def __init__(self):
 
1947
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1948
        # but for this there is not
 
1949
        BzrError.__init__(self)
 
1950
 
 
1951
 
 
1952
class IncompatibleBundleFormat(BzrError):
 
1953
 
 
1954
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1955
 
 
1956
    def __init__(self, bundle_format, other):
 
1957
        BzrError.__init__(self)
 
1958
        self.bundle_format = bundle_format
 
1959
        self.other = other
 
1960
 
 
1961
 
 
1962
class BadInventoryFormat(BzrError):
 
1963
 
 
1964
    _fmt = "Root class for inventory serialization errors"
 
1965
 
 
1966
 
 
1967
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1968
 
 
1969
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1970
 
 
1971
    def __init__(self, msg):
 
1972
        BadInventoryFormat.__init__(self, msg=msg)
 
1973
 
 
1974
 
 
1975
class RootNotRich(BzrError):
 
1976
 
 
1977
    _fmt = """This operation requires rich root data storage"""
 
1978
 
 
1979
 
 
1980
class NoSmartMedium(InternalBzrError):
 
1981
 
 
1982
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1983
 
 
1984
    def __init__(self, transport):
 
1985
        self.transport = transport
 
1986
 
 
1987
 
 
1988
class UnknownSSH(BzrError):
 
1989
 
 
1990
    _fmt = "Unrecognised value for BRZ_SSH environment variable: %(vendor)s"
 
1991
 
 
1992
    def __init__(self, vendor):
 
1993
        BzrError.__init__(self)
 
1994
        self.vendor = vendor
 
1995
 
 
1996
 
 
1997
class SSHVendorNotFound(BzrError):
 
1998
 
 
1999
    _fmt = ("Don't know how to handle SSH connections."
 
2000
            " Please set BRZ_SSH environment variable.")
 
2001
 
 
2002
 
 
2003
class GhostRevisionsHaveNoRevno(BzrError):
 
2004
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
2005
 
 
2006
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
2007
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
2008
 
 
2009
    def __init__(self, revision_id, ghost_revision_id):
 
2010
        self.revision_id = revision_id
 
2011
        self.ghost_revision_id = ghost_revision_id
 
2012
 
 
2013
 
 
2014
class GhostRevisionUnusableHere(BzrError):
 
2015
 
 
2016
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2017
 
 
2018
    def __init__(self, revision_id):
 
2019
        BzrError.__init__(self)
 
2020
        self.revision_id = revision_id
 
2021
 
 
2022
 
 
2023
class IllegalUseOfScopeReplacer(InternalBzrError):
 
2024
 
 
2025
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
2026
            " %(msg)s%(extra)s")
 
2027
 
 
2028
    def __init__(self, name, msg, extra=None):
 
2029
        BzrError.__init__(self)
 
2030
        self.name = name
 
2031
        self.msg = msg
 
2032
        if extra:
 
2033
            self.extra = ': ' + str(extra)
 
2034
        else:
 
2035
            self.extra = ''
 
2036
 
 
2037
 
 
2038
class InvalidImportLine(InternalBzrError):
 
2039
 
 
2040
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
2041
 
 
2042
    def __init__(self, text, msg):
 
2043
        BzrError.__init__(self)
 
2044
        self.text = text
 
2045
        self.msg = msg
 
2046
 
 
2047
 
 
2048
class ImportNameCollision(InternalBzrError):
 
2049
 
 
2050
    _fmt = ("Tried to import an object to the same name as"
 
2051
            " an existing object. %(name)s")
 
2052
 
 
2053
    def __init__(self, name):
 
2054
        BzrError.__init__(self)
 
2055
        self.name = name
 
2056
 
 
2057
 
 
2058
class NotAMergeDirective(BzrError):
 
2059
    """File starting with %(firstline)r is not a merge directive"""
 
2060
    def __init__(self, firstline):
 
2061
        BzrError.__init__(self, firstline=firstline)
 
2062
 
 
2063
 
 
2064
class NoMergeSource(BzrError):
 
2065
    """Raise if no merge source was specified for a merge directive"""
 
2066
 
 
2067
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2068
        " branch location."
 
2069
 
 
2070
 
 
2071
class IllegalMergeDirectivePayload(BzrError):
 
2072
    """A merge directive contained something other than a patch or bundle"""
 
2073
 
 
2074
    _fmt = "Bad merge directive payload %(start)r"
 
2075
 
 
2076
    def __init__(self, start):
 
2077
        BzrError(self)
 
2078
        self.start = start
 
2079
 
 
2080
 
 
2081
class PatchVerificationFailed(BzrError):
 
2082
    """A patch from a merge directive could not be verified"""
 
2083
 
 
2084
    _fmt = "Preview patch does not match requested changes."
 
2085
 
 
2086
 
 
2087
class PatchMissing(BzrError):
 
2088
    """Raise a patch type was specified but no patch supplied"""
 
2089
 
 
2090
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2091
 
 
2092
    def __init__(self, patch_type):
 
2093
        BzrError.__init__(self)
 
2094
        self.patch_type = patch_type
 
2095
 
 
2096
 
 
2097
class TargetNotBranch(BzrError):
 
2098
    """A merge directive's target branch is required, but isn't a branch"""
 
2099
 
 
2100
    _fmt = ("Your branch does not have all of the revisions required in "
 
2101
            "order to merge this merge directive and the target "
 
2102
            "location specified in the merge directive is not a branch: "
 
2103
            "%(location)s.")
 
2104
 
 
2105
    def __init__(self, location):
 
2106
        BzrError.__init__(self)
 
2107
        self.location = location
 
2108
 
 
2109
 
 
2110
class UnsupportedInventoryKind(BzrError):
 
2111
 
 
2112
    _fmt = """Unsupported entry kind %(kind)s"""
 
2113
 
 
2114
    def __init__(self, kind):
 
2115
        self.kind = kind
 
2116
 
 
2117
 
 
2118
class BadSubsumeSource(BzrError):
 
2119
 
 
2120
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2121
 
 
2122
    def __init__(self, tree, other_tree, reason):
 
2123
        self.tree = tree
 
2124
        self.other_tree = other_tree
 
2125
        self.reason = reason
 
2126
 
 
2127
 
 
2128
class SubsumeTargetNeedsUpgrade(BzrError):
 
2129
 
 
2130
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2131
 
 
2132
    def __init__(self, other_tree):
 
2133
        self.other_tree = other_tree
 
2134
 
 
2135
 
 
2136
class NoSuchTag(BzrError):
 
2137
 
 
2138
    _fmt = "No such tag: %(tag_name)s"
 
2139
 
 
2140
    def __init__(self, tag_name):
 
2141
        self.tag_name = tag_name
 
2142
 
 
2143
 
 
2144
class TagsNotSupported(BzrError):
 
2145
 
 
2146
    _fmt = ("Tags not supported by %(branch)s;"
 
2147
            " you may be able to use brz upgrade.")
 
2148
 
 
2149
    def __init__(self, branch):
 
2150
        self.branch = branch
 
2151
 
 
2152
 
 
2153
class TagAlreadyExists(BzrError):
 
2154
 
 
2155
    _fmt = "Tag %(tag_name)s already exists."
 
2156
 
 
2157
    def __init__(self, tag_name):
 
2158
        self.tag_name = tag_name
 
2159
 
 
2160
 
 
2161
class UnexpectedSmartServerResponse(BzrError):
 
2162
 
 
2163
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2164
 
 
2165
    def __init__(self, response_tuple):
 
2166
        self.response_tuple = response_tuple
 
2167
 
 
2168
 
 
2169
class ErrorFromSmartServer(BzrError):
 
2170
    """An error was received from a smart server.
 
2171
 
 
2172
    :seealso: UnknownErrorFromSmartServer
 
2173
    """
 
2174
 
 
2175
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2176
 
 
2177
    internal_error = True
 
2178
 
 
2179
    def __init__(self, error_tuple):
 
2180
        self.error_tuple = error_tuple
 
2181
        try:
 
2182
            self.error_verb = error_tuple[0]
 
2183
        except IndexError:
 
2184
            self.error_verb = None
 
2185
        self.error_args = error_tuple[1:]
 
2186
 
 
2187
 
 
2188
class UnknownErrorFromSmartServer(BzrError):
 
2189
    """An ErrorFromSmartServer could not be translated into a typical breezy
 
2190
    error.
 
2191
 
 
2192
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2193
    distinguish between the following two cases:
 
2194
 
 
2195
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2196
      and so should provoke a traceback to the user.
 
2197
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2198
      translated.  This is probably because the server sent us garbage, and
 
2199
      should not provoke a traceback.
 
2200
    """
 
2201
 
 
2202
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2203
 
 
2204
    internal_error = False
 
2205
 
 
2206
    def __init__(self, error_from_smart_server):
 
2207
        """Constructor.
 
2208
 
 
2209
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2210
        """
 
2211
        self.error_from_smart_server = error_from_smart_server
 
2212
        self.error_tuple = error_from_smart_server.error_tuple
 
2213
 
 
2214
 
 
2215
class ContainerError(BzrError):
 
2216
    """Base class of container errors."""
 
2217
 
 
2218
 
 
2219
class UnknownContainerFormatError(ContainerError):
 
2220
 
 
2221
    _fmt = "Unrecognised container format: %(container_format)r"
 
2222
 
 
2223
    def __init__(self, container_format):
 
2224
        self.container_format = container_format
 
2225
 
 
2226
 
 
2227
class UnexpectedEndOfContainerError(ContainerError):
 
2228
 
 
2229
    _fmt = "Unexpected end of container stream"
 
2230
 
 
2231
 
 
2232
class UnknownRecordTypeError(ContainerError):
 
2233
 
 
2234
    _fmt = "Unknown record type: %(record_type)r"
 
2235
 
 
2236
    def __init__(self, record_type):
 
2237
        self.record_type = record_type
 
2238
 
 
2239
 
 
2240
class InvalidRecordError(ContainerError):
 
2241
 
 
2242
    _fmt = "Invalid record: %(reason)s"
 
2243
 
 
2244
    def __init__(self, reason):
 
2245
        self.reason = reason
 
2246
 
 
2247
 
 
2248
class ContainerHasExcessDataError(ContainerError):
 
2249
 
 
2250
    _fmt = "Container has data after end marker: %(excess)r"
 
2251
 
 
2252
    def __init__(self, excess):
 
2253
        self.excess = excess
 
2254
 
 
2255
 
 
2256
class DuplicateRecordNameError(ContainerError):
 
2257
 
 
2258
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2259
 
 
2260
    def __init__(self, name):
 
2261
        self.name = name.decode("utf-8")
 
2262
 
 
2263
 
 
2264
class RepositoryDataStreamError(BzrError):
 
2265
 
 
2266
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2267
 
 
2268
    def __init__(self, reason):
 
2269
        self.reason = reason
 
2270
 
 
2271
 
 
2272
class UncommittedChanges(BzrError):
 
2273
 
 
2274
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2275
            ' (See brz status).%(more)s')
 
2276
 
 
2277
    def __init__(self, tree, more=None):
 
2278
        if more is None:
 
2279
            more = ''
 
2280
        else:
 
2281
            more = ' ' + more
 
2282
        import breezy.urlutils as urlutils
 
2283
        user_url = getattr(tree, "user_url", None)
 
2284
        if user_url is None:
 
2285
            display_url = str(tree)
 
2286
        else:
 
2287
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2288
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2289
 
 
2290
 
 
2291
class StoringUncommittedNotSupported(BzrError):
 
2292
 
 
2293
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2294
            ' changes.')
 
2295
 
 
2296
    def __init__(self, branch):
 
2297
        import breezy.urlutils as urlutils
 
2298
        user_url = getattr(branch, "user_url", None)
 
2299
        if user_url is None:
 
2300
            display_url = str(branch)
 
2301
        else:
 
2302
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2303
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2304
 
 
2305
 
 
2306
class ShelvedChanges(UncommittedChanges):
 
2307
 
 
2308
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2309
            ' (See brz shelve --list).%(more)s')
 
2310
 
 
2311
 
 
2312
class UnableCreateSymlink(BzrError):
 
2313
 
 
2314
    _fmt = 'Unable to create symlink %(path_str)son this platform'
 
2315
 
 
2316
    def __init__(self, path=None):
 
2317
        path_str = ''
 
2318
        if path:
 
2319
            try:
 
2320
                path_str = repr(str(path))
 
2321
            except UnicodeEncodeError:
 
2322
                path_str = repr(path)
 
2323
            path_str += ' '
 
2324
        self.path_str = path_str
 
2325
 
 
2326
 
 
2327
class UnableEncodePath(BzrError):
 
2328
 
 
2329
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2330
            'user encoding %(user_encoding)s')
 
2331
 
 
2332
    def __init__(self, path, kind):
 
2333
        from breezy.osutils import get_user_encoding
 
2334
        self.path = path
 
2335
        self.kind = kind
 
2336
        self.user_encoding = get_user_encoding()
 
2337
 
 
2338
 
 
2339
class NoSuchAlias(BzrError):
 
2340
 
 
2341
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2342
 
 
2343
    def __init__(self, alias_name):
 
2344
        BzrError.__init__(self, alias_name=alias_name)
 
2345
 
 
2346
 
 
2347
class CannotBindAddress(BzrError):
 
2348
 
 
2349
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2350
 
 
2351
    def __init__(self, host, port, orig_error):
 
2352
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2353
        BzrError.__init__(self, host=host, port=port,
 
2354
            orig_error=repr(orig_error.args))
 
2355
 
 
2356
 
 
2357
class TipChangeRejected(BzrError):
 
2358
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2359
    explicitly abort a change to a branch tip.
 
2360
    """
 
2361
 
 
2362
    _fmt = u"Tip change rejected: %(msg)s"
 
2363
 
 
2364
    def __init__(self, msg):
 
2365
        self.msg = msg
 
2366
 
 
2367
 
 
2368
class JailBreak(BzrError):
 
2369
 
 
2370
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2371
 
 
2372
    def __init__(self, url):
 
2373
        BzrError.__init__(self, url=url)
 
2374
 
 
2375
 
 
2376
class UserAbort(BzrError):
 
2377
 
 
2378
    _fmt = 'The user aborted the operation.'
 
2379
 
 
2380
 
 
2381
class UnresumableWriteGroup(BzrError):
 
2382
 
 
2383
    _fmt = ("Repository %(repository)s cannot resume write group "
 
2384
            "%(write_groups)r: %(reason)s")
 
2385
 
 
2386
    internal_error = True
 
2387
 
 
2388
    def __init__(self, repository, write_groups, reason):
 
2389
        self.repository = repository
 
2390
        self.write_groups = write_groups
 
2391
        self.reason = reason
 
2392
 
 
2393
 
 
2394
class UnsuspendableWriteGroup(BzrError):
 
2395
 
 
2396
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
2397
 
 
2398
    internal_error = True
 
2399
 
 
2400
    def __init__(self, repository):
 
2401
        self.repository = repository
 
2402
 
 
2403
 
 
2404
class LossyPushToSameVCS(BzrError):
 
2405
 
 
2406
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
2407
            "%(target_branch)r that are in the same VCS.")
 
2408
 
 
2409
    internal_error = True
 
2410
 
 
2411
    def __init__(self, source_branch, target_branch):
 
2412
        self.source_branch = source_branch
 
2413
        self.target_branch = target_branch
 
2414
 
 
2415
 
 
2416
class NoRoundtrippingSupport(BzrError):
 
2417
 
 
2418
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
2419
            "%(target_branch)r.")
 
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 NoColocatedBranchSupport(BzrError):
 
2429
 
 
2430
    _fmt = ("%(controldir)r does not support co-located branches.")
 
2431
 
 
2432
    def __init__(self, controldir):
 
2433
        self.controldir = controldir
 
2434
 
 
2435
 
 
2436
class RecursiveBind(BzrError):
 
2437
 
 
2438
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
2439
        'Please use `brz unbind` to fix.')
 
2440
 
 
2441
    def __init__(self, branch_url):
 
2442
        self.branch_url = branch_url
 
2443
 
 
2444
 
 
2445
class UnsupportedKindChange(BzrError):
 
2446
 
 
2447
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
2448
            "%(path)s not supported by format %(format)r")
 
2449
 
 
2450
    def __init__(self, path, from_kind, to_kind, format):
 
2451
        self.path = path
 
2452
        self.from_kind = from_kind
 
2453
        self.to_kind = to_kind
 
2454
        self.format = format
 
2455
 
 
2456
 
 
2457
class ChangesAlreadyStored(BzrCommandError):
 
2458
 
 
2459
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
2460
            ' stores uncommitted changes.')