/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-05-06 02:13:25 UTC
  • mfrom: (7490.7.21 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200506021325-awbmmqu1zyorz7sj
Merge 3.1 branch.

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