/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: 2020-06-23 01:02:30 UTC
  • mfrom: (7490.40.27 work)
  • mto: This revision was merged to the branch mainline in revision 7517.
  • Revision ID: jelmer@jelmer.uk-20200623010230-62nnywznmb76h6ut
Merge lp:brz/3.1.

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