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