/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-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2013, 2016 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
 
 
21
# TODO: is there any value in providing the .args field used by standard
 
22
# python exceptions?   A list of values with no names seems less useful
 
23
# to me.
 
24
 
 
25
# TODO: Perhaps convert the exception to a string at the moment it's
 
26
# constructed to make sure it will succeed.  But that says nothing about
 
27
# exceptions that are never raised.
 
28
 
 
29
# TODO: selftest assertRaises should probably also check that every error
 
30
# raised can be formatted as a string successfully, and without giving
 
31
# 'unprintable'.
 
32
 
 
33
 
 
34
# return codes from the brz program
 
35
EXIT_OK = 0
 
36
EXIT_ERROR = 3
 
37
EXIT_INTERNAL_ERROR = 4
 
38
 
 
39
 
 
40
class BzrError(Exception):
 
41
    """
 
42
    Base class for errors raised by breezy.
 
43
 
 
44
    :cvar internal_error: if True this was probably caused by a brz bug and
 
45
        should be displayed with a traceback; if False (or absent) this was
 
46
        probably a user or environment error and they don't need the gory
 
47
        details.  (That can be overridden by -Derror on the command line.)
 
48
 
 
49
    :cvar _fmt: Format string to display the error; this is expanded
 
50
        by the instance's dict.
 
51
    """
 
52
 
 
53
    internal_error = False
 
54
 
 
55
    def __init__(self, msg=None, **kwds):
 
56
        """Construct a new BzrError.
 
57
 
 
58
        There are two alternative forms for constructing these objects.
 
59
        Either a preformatted string may be passed, or a set of named
 
60
        arguments can be given.  The first is for generic "user" errors which
 
61
        are not intended to be caught and so do not need a specific subclass.
 
62
        The second case is for use with subclasses that provide a _fmt format
 
63
        string to print the arguments.
 
64
 
 
65
        Keyword arguments are taken as parameters to the error, which can
 
66
        be inserted into the format string template.  It's recommended
 
67
        that subclasses override the __init__ method to require specific
 
68
        parameters.
 
69
 
 
70
        :param msg: If given, this is the literal complete text for the error,
 
71
           not subject to expansion. 'msg' is used instead of 'message' because
 
72
           python evolved and, in 2.6, forbids the use of 'message'.
 
73
        """
 
74
        Exception.__init__(self)
 
75
        if msg is not None:
 
76
            # I was going to deprecate this, but it actually turns out to be
 
77
            # quite handy - mbp 20061103.
 
78
            self._preformatted_string = msg
 
79
        else:
 
80
            self._preformatted_string = None
 
81
            for key, value in kwds.items():
 
82
                setattr(self, key, value)
 
83
 
 
84
    def _format(self):
 
85
        s = getattr(self, '_preformatted_string', None)
 
86
        if s is not None:
 
87
            # contains a preformatted message
 
88
            return s
 
89
        err = None
 
90
        try:
 
91
            fmt = self._get_format_string()
 
92
            if fmt:
 
93
                d = dict(self.__dict__)
 
94
                s = fmt % d
 
95
                # __str__() should always return a 'str' object
 
96
                # never a 'unicode' object.
 
97
                return s
 
98
        except Exception as e:
 
99
            err = e
 
100
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
101
            % (self.__class__.__name__,
 
102
               self.__dict__,
 
103
               getattr(self, '_fmt', None),
 
104
               err)
 
105
 
 
106
    __str__ = _format
 
107
 
 
108
    def __repr__(self):
 
109
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
110
 
 
111
    def _get_format_string(self):
 
112
        """Return format string for this exception or None"""
 
113
        fmt = getattr(self, '_fmt', None)
 
114
        if fmt is not None:
 
115
            from breezy.i18n import gettext
 
116
            return gettext(fmt)  # _fmt strings should be ascii
 
117
 
 
118
    def __eq__(self, other):
 
119
        if self.__class__ is not other.__class__:
 
120
            return NotImplemented
 
121
        return self.__dict__ == other.__dict__
 
122
 
 
123
    def __hash__(self):
 
124
        return id(self)
 
125
 
 
126
 
 
127
class InternalBzrError(BzrError):
 
128
    """Base class for errors that are internal in nature.
 
129
 
 
130
    This is a convenience class for errors that are internal. The
 
131
    internal_error attribute can still be altered in subclasses, if needed.
 
132
    Using this class is simply an easy way to get internal errors.
 
133
    """
 
134
 
 
135
    internal_error = True
 
136
 
 
137
 
 
138
class BranchError(BzrError):
 
139
    """Base class for concrete 'errors about a branch'."""
 
140
 
 
141
    def __init__(self, branch):
 
142
        BzrError.__init__(self, branch=branch)
 
143
 
 
144
 
 
145
class BzrCheckError(InternalBzrError):
 
146
 
 
147
    _fmt = "Internal check failed: %(msg)s"
 
148
 
 
149
    def __init__(self, msg):
 
150
        BzrError.__init__(self)
 
151
        self.msg = msg
 
152
 
 
153
 
 
154
class IncompatibleVersion(BzrError):
 
155
 
 
156
    _fmt = 'API %(api)s is not compatible; one of versions %(wanted)r '\
 
157
           'is required, but current version is %(current)r.'
 
158
 
 
159
    def __init__(self, api, wanted, current):
 
160
        self.api = api
 
161
        self.wanted = wanted
 
162
        self.current = current
 
163
 
 
164
 
 
165
class InProcessTransport(BzrError):
 
166
 
 
167
    _fmt = "The transport '%(transport)s' is only accessible within this " \
 
168
        "process."
 
169
 
 
170
    def __init__(self, transport):
 
171
        self.transport = transport
 
172
 
 
173
 
 
174
class InvalidRevisionNumber(BzrError):
 
175
 
 
176
    _fmt = "Invalid revision number %(revno)s"
 
177
 
 
178
    def __init__(self, revno):
 
179
        BzrError.__init__(self)
 
180
        self.revno = revno
 
181
 
 
182
 
 
183
class InvalidRevisionId(BzrError):
 
184
 
 
185
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
186
 
 
187
    def __init__(self, revision_id, branch):
 
188
        # branch can be any string or object with __str__ defined
 
189
        BzrError.__init__(self)
 
190
        self.revision_id = revision_id
 
191
        self.branch = branch
 
192
 
 
193
 
 
194
class ReservedId(BzrError):
 
195
 
 
196
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
197
 
 
198
    def __init__(self, revision_id):
 
199
        self.revision_id = revision_id
 
200
 
 
201
 
 
202
class RootMissing(InternalBzrError):
 
203
 
 
204
    _fmt = ("The root entry of a tree must be the first entry supplied to "
 
205
            "the commit builder.")
 
206
 
 
207
 
 
208
class NoPublicBranch(BzrError):
 
209
 
 
210
    _fmt = 'There is no public branch set for "%(branch_url)s".'
 
211
 
 
212
    def __init__(self, branch):
 
213
        from . import urlutils
 
214
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
 
215
        BzrError.__init__(self, branch_url=public_location)
 
216
 
 
217
 
 
218
class NoSuchId(BzrError):
 
219
 
 
220
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
 
221
 
 
222
    def __init__(self, tree, file_id):
 
223
        BzrError.__init__(self)
 
224
        self.file_id = file_id
 
225
        self.tree = tree
 
226
 
 
227
 
 
228
class NotStacked(BranchError):
 
229
 
 
230
    _fmt = "The branch '%(branch)s' is not stacked."
 
231
 
 
232
 
 
233
class InventoryModified(InternalBzrError):
 
234
 
 
235
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
236
            " so a clean inventory cannot be read without data loss.")
 
237
 
 
238
    def __init__(self, tree):
 
239
        self.tree = tree
 
240
 
 
241
 
 
242
class NoWorkingTree(BzrError):
 
243
 
 
244
    _fmt = 'No WorkingTree exists for "%(base)s".'
 
245
 
 
246
    def __init__(self, base):
 
247
        BzrError.__init__(self)
 
248
        self.base = base
 
249
 
 
250
 
 
251
class NotLocalUrl(BzrError):
 
252
 
 
253
    _fmt = "%(url)s is not a local path."
 
254
 
 
255
    def __init__(self, url):
 
256
        self.url = url
 
257
 
 
258
 
 
259
class WorkingTreeAlreadyPopulated(InternalBzrError):
 
260
 
 
261
    _fmt = 'Working tree already populated in "%(base)s"'
 
262
 
 
263
    def __init__(self, base):
 
264
        self.base = base
 
265
 
 
266
 
 
267
class NoWhoami(BzrError):
 
268
 
 
269
    _fmt = ('Unable to determine your name.\n'
 
270
            "Please, set your name with the 'whoami' command.\n"
 
271
            'E.g. brz whoami "Your Name <name@example.com>"')
 
272
 
 
273
 
 
274
class 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 InvalidRevisionSpec(BzrError):
 
960
 
 
961
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
 
962
            " %(branch_url)s%(extra)s")
 
963
 
 
964
    def __init__(self, spec, branch, extra=None):
 
965
        BzrError.__init__(self, branch=branch, spec=spec)
 
966
        self.branch_url = getattr(branch, 'user_url', str(branch))
 
967
        if extra:
 
968
            self.extra = '\n' + str(extra)
 
969
        else:
 
970
            self.extra = ''
 
971
 
 
972
 
 
973
class AppendRevisionsOnlyViolation(BzrError):
 
974
 
 
975
    _fmt = ('Operation denied because it would change the main history,'
 
976
            ' which is not permitted by the append_revisions_only setting on'
 
977
            ' branch "%(location)s".')
 
978
 
 
979
    def __init__(self, location):
 
980
        import breezy.urlutils as urlutils
 
981
        location = urlutils.unescape_for_display(location, 'ascii')
 
982
        BzrError.__init__(self, location=location)
 
983
 
 
984
 
 
985
class DivergedBranches(BzrError):
 
986
 
 
987
    _fmt = ("These branches have diverged."
 
988
            " Use the missing command to see how.\n"
 
989
            "Use the merge command to reconcile them.")
 
990
 
 
991
    def __init__(self, branch1, branch2):
 
992
        self.branch1 = branch1
 
993
        self.branch2 = branch2
 
994
 
 
995
 
 
996
class NotLefthandHistory(InternalBzrError):
 
997
 
 
998
    _fmt = "Supplied history does not follow left-hand parents"
 
999
 
 
1000
    def __init__(self, history):
 
1001
        BzrError.__init__(self, history=history)
 
1002
 
 
1003
 
 
1004
class UnrelatedBranches(BzrError):
 
1005
 
 
1006
    _fmt = ("Branches have no common ancestor, and"
 
1007
            " no merge base revision was specified.")
 
1008
 
 
1009
 
 
1010
class CannotReverseCherrypick(BzrError):
 
1011
 
 
1012
    _fmt = ('Selected merge cannot perform reverse cherrypicks.  Try merge3'
 
1013
            ' or diff3.')
 
1014
 
 
1015
 
 
1016
class NoCommonAncestor(BzrError):
 
1017
 
 
1018
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
1019
 
 
1020
    def __init__(self, revision_a, revision_b):
 
1021
        self.revision_a = revision_a
 
1022
        self.revision_b = revision_b
 
1023
 
 
1024
 
 
1025
class NoCommonRoot(BzrError):
 
1026
 
 
1027
    _fmt = ("Revisions are not derived from the same root: "
 
1028
            "%(revision_a)s %(revision_b)s.")
 
1029
 
 
1030
    def __init__(self, revision_a, revision_b):
 
1031
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
1032
 
 
1033
 
 
1034
class NotAncestor(BzrError):
 
1035
 
 
1036
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
1037
 
 
1038
    def __init__(self, rev_id, not_ancestor_id):
 
1039
        BzrError.__init__(self, rev_id=rev_id,
 
1040
                          not_ancestor_id=not_ancestor_id)
 
1041
 
 
1042
 
 
1043
class NoCommits(BranchError):
 
1044
 
 
1045
    _fmt = "Branch %(branch)s has no commits."
 
1046
 
 
1047
 
 
1048
class UnlistableStore(BzrError):
 
1049
 
 
1050
    def __init__(self, store):
 
1051
        BzrError.__init__(self, "Store %s is not listable" % store)
 
1052
 
 
1053
 
 
1054
class UnlistableBranch(BzrError):
 
1055
 
 
1056
    def __init__(self, br):
 
1057
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
1058
 
 
1059
 
 
1060
class BoundBranchOutOfDate(BzrError):
 
1061
 
 
1062
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
 
1063
            " %(master)s.%(extra_help)s")
 
1064
 
 
1065
    def __init__(self, branch, master):
 
1066
        BzrError.__init__(self)
 
1067
        self.branch = branch
 
1068
        self.master = master
 
1069
        self.extra_help = ''
 
1070
 
 
1071
 
 
1072
class CommitToDoubleBoundBranch(BzrError):
 
1073
 
 
1074
    _fmt = ("Cannot commit to branch %(branch)s."
 
1075
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
1076
 
 
1077
    def __init__(self, branch, master, remote):
 
1078
        BzrError.__init__(self)
 
1079
        self.branch = branch
 
1080
        self.master = master
 
1081
        self.remote = remote
 
1082
 
 
1083
 
 
1084
class OverwriteBoundBranch(BzrError):
 
1085
 
 
1086
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1087
 
 
1088
    def __init__(self, branch):
 
1089
        BzrError.__init__(self)
 
1090
        self.branch = branch
 
1091
 
 
1092
 
 
1093
class BoundBranchConnectionFailure(BzrError):
 
1094
 
 
1095
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1096
            " => %(target)s: %(error)s")
 
1097
 
 
1098
    def __init__(self, branch, target, error):
 
1099
        BzrError.__init__(self)
 
1100
        self.branch = branch
 
1101
        self.target = target
 
1102
        self.error = error
 
1103
 
 
1104
 
 
1105
class VersionedFileError(BzrError):
 
1106
 
 
1107
    _fmt = "Versioned file error"
 
1108
 
 
1109
 
 
1110
class RevisionNotPresent(VersionedFileError):
 
1111
 
 
1112
    _fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
 
1113
 
 
1114
    def __init__(self, revision_id, file_id):
 
1115
        VersionedFileError.__init__(self)
 
1116
        self.revision_id = revision_id
 
1117
        self.file_id = file_id
 
1118
 
 
1119
 
 
1120
class RevisionAlreadyPresent(VersionedFileError):
 
1121
 
 
1122
    _fmt = 'Revision {%(revision_id)s} already present in "%(file_id)s".'
 
1123
 
 
1124
    def __init__(self, revision_id, file_id):
 
1125
        VersionedFileError.__init__(self)
 
1126
        self.revision_id = revision_id
 
1127
        self.file_id = file_id
 
1128
 
 
1129
 
 
1130
class VersionedFileInvalidChecksum(VersionedFileError):
 
1131
 
 
1132
    _fmt = "Text did not match its checksum: %(msg)s"
 
1133
 
 
1134
 
 
1135
class RetryWithNewPacks(BzrError):
 
1136
    """Raised when we realize that the packs on disk have changed.
 
1137
 
 
1138
    This is meant as more of a signaling exception, to trap between where a
 
1139
    local error occurred and the code that can actually handle the error and
 
1140
    code that can retry appropriately.
 
1141
    """
 
1142
 
 
1143
    internal_error = True
 
1144
 
 
1145
    _fmt = ("Pack files have changed, reload and retry. context: %(context)s"
 
1146
            " %(orig_error)s")
 
1147
 
 
1148
    def __init__(self, context, reload_occurred, exc_info):
 
1149
        """create a new RetryWithNewPacks error.
 
1150
 
 
1151
        :param reload_occurred: Set to True if we know that the packs have
 
1152
            already been reloaded, and we are failing because of an in-memory
 
1153
            cache miss. If set to True then we will ignore if a reload says
 
1154
            nothing has changed, because we assume it has already reloaded. If
 
1155
            False, then a reload with nothing changed will force an error.
 
1156
        :param exc_info: The original exception traceback, so if there is a
 
1157
            problem we can raise the original error (value from sys.exc_info())
 
1158
        """
 
1159
        BzrError.__init__(self)
 
1160
        self.context = context
 
1161
        self.reload_occurred = reload_occurred
 
1162
        self.exc_info = exc_info
 
1163
        self.orig_error = exc_info[1]
 
1164
        # TODO: The global error handler should probably treat this by
 
1165
        #       raising/printing the original exception with a bit about
 
1166
        #       RetryWithNewPacks also not being caught
 
1167
 
 
1168
 
 
1169
class RetryAutopack(RetryWithNewPacks):
 
1170
    """Raised when we are autopacking and we find a missing file.
 
1171
 
 
1172
    Meant as a signaling exception, to tell the autopack code it should try
 
1173
    again.
 
1174
    """
 
1175
 
 
1176
    internal_error = True
 
1177
 
 
1178
    _fmt = ("Pack files have changed, reload and try autopack again."
 
1179
            " context: %(context)s %(orig_error)s")
 
1180
 
 
1181
 
 
1182
class NoSuchExportFormat(BzrError):
 
1183
 
 
1184
    _fmt = "Export format %(format)r not supported"
 
1185
 
 
1186
    def __init__(self, format):
 
1187
        BzrError.__init__(self)
 
1188
        self.format = format
 
1189
 
 
1190
 
 
1191
class TransportError(BzrError):
 
1192
 
 
1193
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1194
 
 
1195
    def __init__(self, msg=None, orig_error=None):
 
1196
        if msg is None and orig_error is not None:
 
1197
            msg = str(orig_error)
 
1198
        if orig_error is None:
 
1199
            orig_error = ''
 
1200
        if msg is None:
 
1201
            msg = ''
 
1202
        self.msg = msg
 
1203
        self.orig_error = orig_error
 
1204
        BzrError.__init__(self)
 
1205
 
 
1206
 
 
1207
class TooManyConcurrentRequests(InternalBzrError):
 
1208
 
 
1209
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1210
            " Be sure to finish_writing and finish_reading on the"
 
1211
            " currently open request.")
 
1212
 
 
1213
    def __init__(self, medium):
 
1214
        self.medium = medium
 
1215
 
 
1216
 
 
1217
class SmartProtocolError(TransportError):
 
1218
 
 
1219
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1220
 
 
1221
    def __init__(self, details):
 
1222
        self.details = details
 
1223
 
 
1224
 
 
1225
class UnexpectedProtocolVersionMarker(TransportError):
 
1226
 
 
1227
    _fmt = "Received bad protocol version marker: %(marker)r"
 
1228
 
 
1229
    def __init__(self, marker):
 
1230
        self.marker = marker
 
1231
 
 
1232
 
 
1233
class UnknownSmartMethod(InternalBzrError):
 
1234
 
 
1235
    _fmt = "The server does not recognise the '%(verb)s' request."
 
1236
 
 
1237
    def __init__(self, verb):
 
1238
        self.verb = verb
 
1239
 
 
1240
 
 
1241
class SmartMessageHandlerError(InternalBzrError):
 
1242
 
 
1243
    _fmt = ("The message handler raised an exception:\n"
 
1244
            "%(traceback_text)s")
 
1245
 
 
1246
    def __init__(self, exc_info):
 
1247
        import traceback
 
1248
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
 
1249
        self.exc_type, self.exc_value, self.exc_tb = exc_info
 
1250
        self.exc_info = exc_info
 
1251
        traceback_strings = traceback.format_exception(
 
1252
            self.exc_type, self.exc_value, self.exc_tb)
 
1253
        self.traceback_text = ''.join(traceback_strings)
 
1254
 
 
1255
 
 
1256
# A set of semi-meaningful errors which can be thrown
 
1257
class TransportNotPossible(TransportError):
 
1258
 
 
1259
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1260
 
 
1261
 
 
1262
class ConnectionError(TransportError):
 
1263
 
 
1264
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1265
 
 
1266
 
 
1267
class SocketConnectionError(ConnectionError):
 
1268
 
 
1269
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1270
 
 
1271
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1272
        if msg is None:
 
1273
            msg = 'Failed to connect to'
 
1274
        if orig_error is None:
 
1275
            orig_error = ''
 
1276
        else:
 
1277
            orig_error = '; ' + str(orig_error)
 
1278
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1279
        self.host = host
 
1280
        if port is None:
 
1281
            self.port = ''
 
1282
        else:
 
1283
            self.port = ':%s' % port
 
1284
 
 
1285
 
 
1286
# XXX: This is also used for unexpected end of file, which is different at the
 
1287
# TCP level from "connection reset".
 
1288
class ConnectionReset(TransportError):
 
1289
 
 
1290
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1291
 
 
1292
 
 
1293
class ConnectionTimeout(ConnectionError):
 
1294
 
 
1295
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
 
1296
 
 
1297
 
 
1298
class InvalidRange(TransportError):
 
1299
 
 
1300
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
 
1301
 
 
1302
    def __init__(self, path, offset, msg=None):
 
1303
        TransportError.__init__(self, msg)
 
1304
        self.path = path
 
1305
        self.offset = offset
 
1306
 
 
1307
 
 
1308
class InvalidHttpResponse(TransportError):
 
1309
 
 
1310
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1311
 
 
1312
    def __init__(self, path, msg, orig_error=None):
 
1313
        self.path = path
 
1314
        if orig_error is None:
 
1315
            orig_error = ''
 
1316
        else:
 
1317
            # This is reached for obscure and unusual errors so we want to
 
1318
            # preserve as much info as possible to ease debug.
 
1319
            orig_error = ': %r' % (orig_error,)
 
1320
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1321
 
 
1322
 
 
1323
class InvalidHttpRange(InvalidHttpResponse):
 
1324
 
 
1325
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1326
 
 
1327
    def __init__(self, path, range, msg):
 
1328
        self.range = range
 
1329
        InvalidHttpResponse.__init__(self, path, msg)
 
1330
 
 
1331
 
 
1332
class HttpBoundaryMissing(InvalidHttpResponse):
 
1333
    """A multipart response ends with no boundary marker.
 
1334
 
 
1335
    This is a special case caused by buggy proxies, described in
 
1336
    <https://bugs.launchpad.net/bzr/+bug/198646>.
 
1337
    """
 
1338
 
 
1339
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
 
1340
 
 
1341
    def __init__(self, path, msg):
 
1342
        InvalidHttpResponse.__init__(self, path, msg)
 
1343
 
 
1344
 
 
1345
class InvalidHttpContentType(InvalidHttpResponse):
 
1346
 
 
1347
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1348
 
 
1349
    def __init__(self, path, ctype, msg):
 
1350
        self.ctype = ctype
 
1351
        InvalidHttpResponse.__init__(self, path, msg)
 
1352
 
 
1353
 
 
1354
class RedirectRequested(TransportError):
 
1355
 
 
1356
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
 
1357
 
 
1358
    def __init__(self, source, target, is_permanent=False):
 
1359
        self.source = source
 
1360
        self.target = target
 
1361
        if is_permanent:
 
1362
            self.permanently = ' permanently'
 
1363
        else:
 
1364
            self.permanently = ''
 
1365
        TransportError.__init__(self)
 
1366
 
 
1367
 
 
1368
class TooManyRedirections(TransportError):
 
1369
 
 
1370
    _fmt = "Too many redirections"
 
1371
 
 
1372
 
 
1373
class ConflictsInTree(BzrError):
 
1374
 
 
1375
    _fmt = "Working tree has conflicts."
 
1376
 
 
1377
 
 
1378
class DependencyNotPresent(BzrError):
 
1379
 
 
1380
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1381
 
 
1382
    def __init__(self, library, error):
 
1383
        BzrError.__init__(self, library=library, error=error)
 
1384
 
 
1385
 
 
1386
class WorkingTreeNotRevision(BzrError):
 
1387
 
 
1388
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1389
            " the last commit, but weave merge requires that it be"
 
1390
            " unchanged")
 
1391
 
 
1392
    def __init__(self, tree):
 
1393
        BzrError.__init__(self, basedir=tree.basedir)
 
1394
 
 
1395
 
 
1396
class GraphCycleError(BzrError):
 
1397
 
 
1398
    _fmt = "Cycle in graph %(graph)r"
 
1399
 
 
1400
    def __init__(self, graph):
 
1401
        BzrError.__init__(self)
 
1402
        self.graph = graph
 
1403
 
 
1404
 
 
1405
class WritingCompleted(InternalBzrError):
 
1406
 
 
1407
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1408
            "called upon it - accept bytes may not be called anymore.")
 
1409
 
 
1410
    def __init__(self, request):
 
1411
        self.request = request
 
1412
 
 
1413
 
 
1414
class WritingNotComplete(InternalBzrError):
 
1415
 
 
1416
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1417
            "called upon it - until the write phase is complete no "
 
1418
            "data may be read.")
 
1419
 
 
1420
    def __init__(self, request):
 
1421
        self.request = request
 
1422
 
 
1423
 
 
1424
class NotConflicted(BzrError):
 
1425
 
 
1426
    _fmt = "File %(filename)s is not conflicted."
 
1427
 
 
1428
    def __init__(self, filename):
 
1429
        BzrError.__init__(self)
 
1430
        self.filename = filename
 
1431
 
 
1432
 
 
1433
class MediumNotConnected(InternalBzrError):
 
1434
 
 
1435
    _fmt = """The medium '%(medium)s' is not connected."""
 
1436
 
 
1437
    def __init__(self, medium):
 
1438
        self.medium = medium
 
1439
 
 
1440
 
 
1441
class MustUseDecorated(Exception):
 
1442
 
 
1443
    _fmt = "A decorating function has requested its original command be used."
 
1444
 
 
1445
 
 
1446
class NoBundleFound(BzrError):
 
1447
 
 
1448
    _fmt = 'No bundle was found in "%(filename)s".'
 
1449
 
 
1450
    def __init__(self, filename):
 
1451
        BzrError.__init__(self)
 
1452
        self.filename = filename
 
1453
 
 
1454
 
 
1455
class BundleNotSupported(BzrError):
 
1456
 
 
1457
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1458
 
 
1459
    def __init__(self, version, msg):
 
1460
        BzrError.__init__(self)
 
1461
        self.version = version
 
1462
        self.msg = msg
 
1463
 
 
1464
 
 
1465
class MissingText(BzrError):
 
1466
 
 
1467
    _fmt = ("Branch %(base)s is missing revision"
 
1468
            " %(text_revision)s of %(file_id)s")
 
1469
 
 
1470
    def __init__(self, branch, text_revision, file_id):
 
1471
        BzrError.__init__(self)
 
1472
        self.branch = branch
 
1473
        self.base = branch.base
 
1474
        self.text_revision = text_revision
 
1475
        self.file_id = file_id
 
1476
 
 
1477
 
 
1478
class DuplicateFileId(BzrError):
 
1479
 
 
1480
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1481
 
 
1482
    def __init__(self, file_id, entry):
 
1483
        BzrError.__init__(self)
 
1484
        self.file_id = file_id
 
1485
        self.entry = entry
 
1486
 
 
1487
 
 
1488
class DuplicateKey(BzrError):
 
1489
 
 
1490
    _fmt = "Key %(key)s is already present in map"
 
1491
 
 
1492
 
 
1493
class DuplicateHelpPrefix(BzrError):
 
1494
 
 
1495
    _fmt = "The prefix %(prefix)s is in the help search path twice."
 
1496
 
 
1497
    def __init__(self, prefix):
 
1498
        self.prefix = prefix
 
1499
 
 
1500
 
 
1501
class MalformedTransform(InternalBzrError):
 
1502
 
 
1503
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1504
 
 
1505
 
 
1506
class NoFinalPath(BzrError):
 
1507
 
 
1508
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1509
            "file-id: %(file_id)r\n"
 
1510
            "root trans-id: %(root_trans_id)r\n")
 
1511
 
 
1512
    def __init__(self, trans_id, transform):
 
1513
        self.trans_id = trans_id
 
1514
        self.file_id = transform.final_file_id(trans_id)
 
1515
        self.root_trans_id = transform.root
 
1516
 
 
1517
 
 
1518
class BzrBadParameter(InternalBzrError):
 
1519
 
 
1520
    _fmt = "Bad parameter: %(param)r"
 
1521
 
 
1522
    # This exception should never be thrown, but it is a base class for all
 
1523
    # parameter-to-function errors.
 
1524
 
 
1525
    def __init__(self, param):
 
1526
        BzrError.__init__(self)
 
1527
        self.param = param
 
1528
 
 
1529
 
 
1530
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1531
 
 
1532
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1533
 
 
1534
 
 
1535
class ReusingTransform(BzrError):
 
1536
 
 
1537
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1538
 
 
1539
 
 
1540
class CantMoveRoot(BzrError):
 
1541
 
 
1542
    _fmt = "Moving the root directory is not supported at this time"
 
1543
 
 
1544
 
 
1545
class TransformRenameFailed(BzrError):
 
1546
 
 
1547
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1548
 
 
1549
    def __init__(self, from_path, to_path, why, errno):
 
1550
        self.from_path = from_path
 
1551
        self.to_path = to_path
 
1552
        self.why = why
 
1553
        self.errno = errno
 
1554
 
 
1555
 
 
1556
class BzrMoveFailedError(BzrError):
 
1557
 
 
1558
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
 
1559
            "%(_has_extra)s%(extra)s")
 
1560
 
 
1561
    def __init__(self, from_path='', to_path='', extra=None):
 
1562
        from breezy.osutils import splitpath
 
1563
        BzrError.__init__(self)
 
1564
        if extra:
 
1565
            self.extra, self._has_extra = extra, ': '
 
1566
        else:
 
1567
            self.extra = self._has_extra = ''
 
1568
 
 
1569
        has_from = len(from_path) > 0
 
1570
        has_to = len(to_path) > 0
 
1571
        if has_from:
 
1572
            self.from_path = splitpath(from_path)[-1]
 
1573
        else:
 
1574
            self.from_path = ''
 
1575
 
 
1576
        if has_to:
 
1577
            self.to_path = splitpath(to_path)[-1]
 
1578
        else:
 
1579
            self.to_path = ''
 
1580
 
 
1581
        self.operator = ""
 
1582
        if has_from and has_to:
 
1583
            self.operator = " =>"
 
1584
        elif has_from:
 
1585
            self.from_path = "from " + from_path
 
1586
        elif has_to:
 
1587
            self.operator = "to"
 
1588
        else:
 
1589
            self.operator = "file"
 
1590
 
 
1591
 
 
1592
class BzrRenameFailedError(BzrMoveFailedError):
 
1593
 
 
1594
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
 
1595
            "%(_has_extra)s%(extra)s")
 
1596
 
 
1597
    def __init__(self, from_path, to_path, extra=None):
 
1598
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1599
 
 
1600
 
 
1601
class BzrBadParameterNotString(BzrBadParameter):
 
1602
 
 
1603
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1604
 
 
1605
 
 
1606
class BzrBadParameterMissing(BzrBadParameter):
 
1607
 
 
1608
    _fmt = "Parameter %(param)s is required but not present."
 
1609
 
 
1610
 
 
1611
class BzrBadParameterUnicode(BzrBadParameter):
 
1612
 
 
1613
    _fmt = ("Parameter %(param)s is unicode but"
 
1614
            " only byte-strings are permitted.")
 
1615
 
 
1616
 
 
1617
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1618
 
 
1619
    _fmt = "Parameter %(param)s contains a newline."
 
1620
 
 
1621
 
 
1622
class ParamikoNotPresent(DependencyNotPresent):
 
1623
 
 
1624
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1625
 
 
1626
    def __init__(self, error):
 
1627
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1628
 
 
1629
 
 
1630
class PointlessMerge(BzrError):
 
1631
 
 
1632
    _fmt = "Nothing to merge."
 
1633
 
 
1634
 
 
1635
class UninitializableFormat(BzrError):
 
1636
 
 
1637
    _fmt = "Format %(format)s cannot be initialised by this version of brz."
 
1638
 
 
1639
    def __init__(self, format):
 
1640
        BzrError.__init__(self)
 
1641
        self.format = format
 
1642
 
 
1643
 
 
1644
class BadConversionTarget(BzrError):
 
1645
 
 
1646
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
1647
        "    %(problem)s"
 
1648
 
 
1649
    def __init__(self, problem, format, from_format=None):
 
1650
        BzrError.__init__(self)
 
1651
        self.problem = problem
 
1652
        self.format = format
 
1653
        self.from_format = from_format or '(unspecified)'
 
1654
 
 
1655
 
 
1656
class NoDiffFound(BzrError):
 
1657
 
 
1658
    _fmt = 'Could not find an appropriate Differ for file "%(path)s"'
 
1659
 
 
1660
    def __init__(self, path):
 
1661
        BzrError.__init__(self, path)
 
1662
 
 
1663
 
 
1664
class ExecutableMissing(BzrError):
 
1665
 
 
1666
    _fmt = "%(exe_name)s could not be found on this machine"
 
1667
 
 
1668
    def __init__(self, exe_name):
 
1669
        BzrError.__init__(self, exe_name=exe_name)
 
1670
 
 
1671
 
 
1672
class NoDiff(BzrError):
 
1673
 
 
1674
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1675
 
 
1676
    def __init__(self, msg):
 
1677
        BzrError.__init__(self, msg=msg)
 
1678
 
 
1679
 
 
1680
class NoDiff3(BzrError):
 
1681
 
 
1682
    _fmt = "Diff3 is not installed on this machine."
 
1683
 
 
1684
 
 
1685
class ExistingContent(BzrError):
 
1686
    # Added in breezy 0.92, used by VersionedFile.add_lines.
 
1687
 
 
1688
    _fmt = "The content being inserted is already present."
 
1689
 
 
1690
 
 
1691
class ExistingLimbo(BzrError):
 
1692
 
 
1693
    _fmt = """This tree contains left-over files from a failed operation.
 
1694
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1695
    keep, and delete it when you are done."""
 
1696
 
 
1697
    def __init__(self, limbo_dir):
 
1698
        BzrError.__init__(self)
 
1699
        self.limbo_dir = limbo_dir
 
1700
 
 
1701
 
 
1702
class ExistingPendingDeletion(BzrError):
 
1703
 
 
1704
    _fmt = """This tree contains left-over files from a failed operation.
 
1705
    Please examine %(pending_deletion)s to see if it contains any files you
 
1706
    wish to keep, and delete it when you are done."""
 
1707
 
 
1708
    def __init__(self, pending_deletion):
 
1709
        BzrError.__init__(self, pending_deletion=pending_deletion)
 
1710
 
 
1711
 
 
1712
class ImmortalLimbo(BzrError):
 
1713
 
 
1714
    _fmt = """Unable to delete transform temporary directory %(limbo_dir)s.
 
1715
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1716
    keep, and delete it when you are done."""
 
1717
 
 
1718
    def __init__(self, limbo_dir):
 
1719
        BzrError.__init__(self)
 
1720
        self.limbo_dir = limbo_dir
 
1721
 
 
1722
 
 
1723
class ImmortalPendingDeletion(BzrError):
 
1724
 
 
1725
    _fmt = ("Unable to delete transform temporary directory "
 
1726
            "%(pending_deletion)s.  Please examine %(pending_deletion)s to see if it "
 
1727
            "contains any files you wish to keep, and delete it when you are done.")
 
1728
 
 
1729
    def __init__(self, pending_deletion):
 
1730
        BzrError.__init__(self, pending_deletion=pending_deletion)
 
1731
 
 
1732
 
 
1733
class OutOfDateTree(BzrError):
 
1734
 
 
1735
    _fmt = "Working tree is out of date, please run 'brz update'.%(more)s"
 
1736
 
 
1737
    def __init__(self, tree, more=None):
 
1738
        if more is None:
 
1739
            more = ''
 
1740
        else:
 
1741
            more = ' ' + more
 
1742
        BzrError.__init__(self)
 
1743
        self.tree = tree
 
1744
        self.more = more
 
1745
 
 
1746
 
 
1747
class PublicBranchOutOfDate(BzrError):
 
1748
 
 
1749
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1750
        '"%(revstring)s".'
 
1751
 
 
1752
    def __init__(self, public_location, revstring):
 
1753
        import breezy.urlutils as urlutils
 
1754
        public_location = urlutils.unescape_for_display(public_location,
 
1755
                                                        'ascii')
 
1756
        BzrError.__init__(self, public_location=public_location,
 
1757
                          revstring=revstring)
 
1758
 
 
1759
 
 
1760
class MergeModifiedFormatError(BzrError):
 
1761
 
 
1762
    _fmt = "Error in merge modified format"
 
1763
 
 
1764
 
 
1765
class ConflictFormatError(BzrError):
 
1766
 
 
1767
    _fmt = "Format error in conflict listings"
 
1768
 
 
1769
 
 
1770
class CorruptRepository(BzrError):
 
1771
 
 
1772
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1773
            "Please run brz reconcile on this repository.")
 
1774
 
 
1775
    def __init__(self, repo):
 
1776
        BzrError.__init__(self)
 
1777
        self.repo_path = repo.user_url
 
1778
 
 
1779
 
 
1780
class InconsistentDelta(BzrError):
 
1781
    """Used when we get a delta that is not valid."""
 
1782
 
 
1783
    _fmt = ("An inconsistent delta was supplied involving %(path)r,"
 
1784
            " %(file_id)r\nreason: %(reason)s")
 
1785
 
 
1786
    def __init__(self, path, file_id, reason):
 
1787
        BzrError.__init__(self)
 
1788
        self.path = path
 
1789
        self.file_id = file_id
 
1790
        self.reason = reason
 
1791
 
 
1792
 
 
1793
class InconsistentDeltaDelta(InconsistentDelta):
 
1794
    """Used when we get a delta that is not valid."""
 
1795
 
 
1796
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
1797
            "\nreason: %(reason)s")
 
1798
 
 
1799
    def __init__(self, delta, reason):
 
1800
        BzrError.__init__(self)
 
1801
        self.delta = delta
 
1802
        self.reason = reason
 
1803
 
 
1804
 
 
1805
class UpgradeRequired(BzrError):
 
1806
 
 
1807
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1808
 
 
1809
    def __init__(self, path):
 
1810
        BzrError.__init__(self)
 
1811
        self.path = path
 
1812
 
 
1813
 
 
1814
class RepositoryUpgradeRequired(UpgradeRequired):
 
1815
 
 
1816
    _fmt = "To use this feature you must upgrade your repository at %(path)s."
 
1817
 
 
1818
 
 
1819
class RichRootUpgradeRequired(UpgradeRequired):
 
1820
 
 
1821
    _fmt = ("To use this feature you must upgrade your branch at %(path)s to"
 
1822
            " a format which supports rich roots.")
 
1823
 
 
1824
 
 
1825
class LocalRequiresBoundBranch(BzrError):
 
1826
 
 
1827
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1828
 
 
1829
 
 
1830
class UnsupportedOperation(BzrError):
 
1831
 
 
1832
    _fmt = ("The method %(mname)s is not supported on"
 
1833
            " objects of type %(tname)s.")
 
1834
 
 
1835
    def __init__(self, method, method_self):
 
1836
        self.method = method
 
1837
        self.mname = method.__name__
 
1838
        self.tname = type(method_self).__name__
 
1839
 
 
1840
 
 
1841
class FetchLimitUnsupported(UnsupportedOperation):
 
1842
 
 
1843
    fmt = ("InterBranch %(interbranch)r does not support fetching limits.")
 
1844
 
 
1845
    def __init__(self, interbranch):
 
1846
        BzrError.__init__(self, interbranch=interbranch)
 
1847
 
 
1848
 
 
1849
class NonAsciiRevisionId(UnsupportedOperation):
 
1850
    """Raised when a commit is attempting to set a non-ascii revision id
 
1851
       but cant.
 
1852
    """
 
1853
 
 
1854
 
 
1855
class SharedRepositoriesUnsupported(UnsupportedOperation):
 
1856
    _fmt = "Shared repositories are not supported by %(format)r."
 
1857
 
 
1858
    def __init__(self, format):
 
1859
        BzrError.__init__(self, format=format)
 
1860
 
 
1861
 
 
1862
class GhostTagsNotSupported(BzrError):
 
1863
 
 
1864
    _fmt = "Ghost tags not supported by format %(format)r."
 
1865
 
 
1866
    def __init__(self, format):
 
1867
        self.format = format
 
1868
 
 
1869
 
 
1870
class BinaryFile(BzrError):
 
1871
 
 
1872
    _fmt = "File is binary but should be text."
 
1873
 
 
1874
 
 
1875
class IllegalPath(BzrError):
 
1876
 
 
1877
    _fmt = "The path %(path)s is not permitted on this platform"
 
1878
 
 
1879
    def __init__(self, path):
 
1880
        BzrError.__init__(self)
 
1881
        self.path = path
 
1882
 
 
1883
 
 
1884
class TestamentMismatch(BzrError):
 
1885
 
 
1886
    _fmt = """Testament did not match expected value.
 
1887
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1888
       {%(measured)s}"""
 
1889
 
 
1890
    def __init__(self, revision_id, expected, measured):
 
1891
        self.revision_id = revision_id
 
1892
        self.expected = expected
 
1893
        self.measured = measured
 
1894
 
 
1895
 
 
1896
class NotABundle(BzrError):
 
1897
 
 
1898
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1899
 
 
1900
    def __init__(self, text):
 
1901
        BzrError.__init__(self)
 
1902
        self.text = text
 
1903
 
 
1904
 
 
1905
class BadBundle(BzrError):
 
1906
 
 
1907
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1908
 
 
1909
    def __init__(self, text):
 
1910
        BzrError.__init__(self)
 
1911
        self.text = text
 
1912
 
 
1913
 
 
1914
class MalformedHeader(BadBundle):
 
1915
 
 
1916
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1917
 
 
1918
 
 
1919
class MalformedPatches(BadBundle):
 
1920
 
 
1921
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1922
 
 
1923
 
 
1924
class MalformedFooter(BadBundle):
 
1925
 
 
1926
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1927
 
 
1928
 
 
1929
class UnsupportedEOLMarker(BadBundle):
 
1930
 
 
1931
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1932
 
 
1933
    def __init__(self):
 
1934
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1935
        # but for this there is not
 
1936
        BzrError.__init__(self)
 
1937
 
 
1938
 
 
1939
class IncompatibleBundleFormat(BzrError):
 
1940
 
 
1941
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1942
 
 
1943
    def __init__(self, bundle_format, other):
 
1944
        BzrError.__init__(self)
 
1945
        self.bundle_format = bundle_format
 
1946
        self.other = other
 
1947
 
 
1948
 
 
1949
class BadInventoryFormat(BzrError):
 
1950
 
 
1951
    _fmt = "Root class for inventory serialization errors"
 
1952
 
 
1953
 
 
1954
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1955
 
 
1956
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1957
 
 
1958
    def __init__(self, msg):
 
1959
        BadInventoryFormat.__init__(self, msg=msg)
 
1960
 
 
1961
 
 
1962
class RootNotRich(BzrError):
 
1963
 
 
1964
    _fmt = """This operation requires rich root data storage"""
 
1965
 
 
1966
 
 
1967
class NoSmartMedium(InternalBzrError):
 
1968
 
 
1969
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1970
 
 
1971
    def __init__(self, transport):
 
1972
        self.transport = transport
 
1973
 
 
1974
 
 
1975
class UnknownSSH(BzrError):
 
1976
 
 
1977
    _fmt = "Unrecognised value for BRZ_SSH environment variable: %(vendor)s"
 
1978
 
 
1979
    def __init__(self, vendor):
 
1980
        BzrError.__init__(self)
 
1981
        self.vendor = vendor
 
1982
 
 
1983
 
 
1984
class SSHVendorNotFound(BzrError):
 
1985
 
 
1986
    _fmt = ("Don't know how to handle SSH connections."
 
1987
            " Please set BRZ_SSH environment variable.")
 
1988
 
 
1989
 
 
1990
class GhostRevisionsHaveNoRevno(BzrError):
 
1991
    """When searching for revnos, if we encounter a ghost, we are stuck"""
 
1992
 
 
1993
    _fmt = ("Could not determine revno for {%(revision_id)s} because"
 
1994
            " its ancestry shows a ghost at {%(ghost_revision_id)s}")
 
1995
 
 
1996
    def __init__(self, revision_id, ghost_revision_id):
 
1997
        self.revision_id = revision_id
 
1998
        self.ghost_revision_id = ghost_revision_id
 
1999
 
 
2000
 
 
2001
class GhostRevisionUnusableHere(BzrError):
 
2002
 
 
2003
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
2004
 
 
2005
    def __init__(self, revision_id):
 
2006
        BzrError.__init__(self)
 
2007
        self.revision_id = revision_id
 
2008
 
 
2009
 
 
2010
class NotAMergeDirective(BzrError):
 
2011
    """File starting with %(firstline)r is not a merge directive"""
 
2012
 
 
2013
    def __init__(self, firstline):
 
2014
        BzrError.__init__(self, firstline=firstline)
 
2015
 
 
2016
 
 
2017
class NoMergeSource(BzrError):
 
2018
    """Raise if no merge source was specified for a merge directive"""
 
2019
 
 
2020
    _fmt = "A merge directive must provide either a bundle or a public"\
 
2021
        " branch location."
 
2022
 
 
2023
 
 
2024
class IllegalMergeDirectivePayload(BzrError):
 
2025
    """A merge directive contained something other than a patch or bundle"""
 
2026
 
 
2027
    _fmt = "Bad merge directive payload %(start)r"
 
2028
 
 
2029
    def __init__(self, start):
 
2030
        BzrError(self)
 
2031
        self.start = start
 
2032
 
 
2033
 
 
2034
class PatchVerificationFailed(BzrError):
 
2035
    """A patch from a merge directive could not be verified"""
 
2036
 
 
2037
    _fmt = "Preview patch does not match requested changes."
 
2038
 
 
2039
 
 
2040
class PatchMissing(BzrError):
 
2041
    """Raise a patch type was specified but no patch supplied"""
 
2042
 
 
2043
    _fmt = "Patch_type was %(patch_type)s, but no patch was supplied."
 
2044
 
 
2045
    def __init__(self, patch_type):
 
2046
        BzrError.__init__(self)
 
2047
        self.patch_type = patch_type
 
2048
 
 
2049
 
 
2050
class TargetNotBranch(BzrError):
 
2051
    """A merge directive's target branch is required, but isn't a branch"""
 
2052
 
 
2053
    _fmt = ("Your branch does not have all of the revisions required in "
 
2054
            "order to merge this merge directive and the target "
 
2055
            "location specified in the merge directive is not a branch: "
 
2056
            "%(location)s.")
 
2057
 
 
2058
    def __init__(self, location):
 
2059
        BzrError.__init__(self)
 
2060
        self.location = location
 
2061
 
 
2062
 
 
2063
class UnsupportedInventoryKind(BzrError):
 
2064
 
 
2065
    _fmt = """Unsupported entry kind %(kind)s"""
 
2066
 
 
2067
    def __init__(self, kind):
 
2068
        self.kind = kind
 
2069
 
 
2070
 
 
2071
class BadSubsumeSource(BzrError):
 
2072
 
 
2073
    _fmt = "Can't subsume %(other_tree)s into %(tree)s. %(reason)s"
 
2074
 
 
2075
    def __init__(self, tree, other_tree, reason):
 
2076
        self.tree = tree
 
2077
        self.other_tree = other_tree
 
2078
        self.reason = reason
 
2079
 
 
2080
 
 
2081
class SubsumeTargetNeedsUpgrade(BzrError):
 
2082
 
 
2083
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
2084
 
 
2085
    def __init__(self, other_tree):
 
2086
        self.other_tree = other_tree
 
2087
 
 
2088
 
 
2089
class NoSuchTag(BzrError):
 
2090
 
 
2091
    _fmt = "No such tag: %(tag_name)s"
 
2092
 
 
2093
    def __init__(self, tag_name):
 
2094
        self.tag_name = tag_name
 
2095
 
 
2096
 
 
2097
class TagsNotSupported(BzrError):
 
2098
 
 
2099
    _fmt = ("Tags not supported by %(branch)s;"
 
2100
            " you may be able to use 'brz upgrade %(branch_url)s'.")
 
2101
 
 
2102
    def __init__(self, branch):
 
2103
        self.branch = branch
 
2104
        self.branch_url = branch.user_url
 
2105
 
 
2106
 
 
2107
class TagAlreadyExists(BzrError):
 
2108
 
 
2109
    _fmt = "Tag %(tag_name)s already exists."
 
2110
 
 
2111
    def __init__(self, tag_name):
 
2112
        self.tag_name = tag_name
 
2113
 
 
2114
 
 
2115
class UnexpectedSmartServerResponse(BzrError):
 
2116
 
 
2117
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
 
2118
 
 
2119
    def __init__(self, response_tuple):
 
2120
        self.response_tuple = response_tuple
 
2121
 
 
2122
 
 
2123
class ErrorFromSmartServer(BzrError):
 
2124
    """An error was received from a smart server.
 
2125
 
 
2126
    :seealso: UnknownErrorFromSmartServer
 
2127
    """
 
2128
 
 
2129
    _fmt = "Error received from smart server: %(error_tuple)r"
 
2130
 
 
2131
    internal_error = True
 
2132
 
 
2133
    def __init__(self, error_tuple):
 
2134
        self.error_tuple = error_tuple
 
2135
        try:
 
2136
            self.error_verb = error_tuple[0]
 
2137
        except IndexError:
 
2138
            self.error_verb = None
 
2139
        self.error_args = error_tuple[1:]
 
2140
 
 
2141
 
 
2142
class UnknownErrorFromSmartServer(BzrError):
 
2143
    """An ErrorFromSmartServer could not be translated into a typical breezy
 
2144
    error.
 
2145
 
 
2146
    This is distinct from ErrorFromSmartServer so that it is possible to
 
2147
    distinguish between the following two cases:
 
2148
 
 
2149
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2150
      and so should provoke a traceback to the user.
 
2151
    - ErrorFromSmartServer was caught but its error_tuple could not be
 
2152
      translated.  This is probably because the server sent us garbage, and
 
2153
      should not provoke a traceback.
 
2154
    """
 
2155
 
 
2156
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
 
2157
 
 
2158
    internal_error = False
 
2159
 
 
2160
    def __init__(self, error_from_smart_server):
 
2161
        """Constructor.
 
2162
 
 
2163
        :param error_from_smart_server: An ErrorFromSmartServer instance.
 
2164
        """
 
2165
        self.error_from_smart_server = error_from_smart_server
 
2166
        self.error_tuple = error_from_smart_server.error_tuple
 
2167
 
 
2168
 
 
2169
class ContainerError(BzrError):
 
2170
    """Base class of container errors."""
 
2171
 
 
2172
 
 
2173
class UnknownContainerFormatError(ContainerError):
 
2174
 
 
2175
    _fmt = "Unrecognised container format: %(container_format)r"
 
2176
 
 
2177
    def __init__(self, container_format):
 
2178
        self.container_format = container_format
 
2179
 
 
2180
 
 
2181
class UnexpectedEndOfContainerError(ContainerError):
 
2182
 
 
2183
    _fmt = "Unexpected end of container stream"
 
2184
 
 
2185
 
 
2186
class UnknownRecordTypeError(ContainerError):
 
2187
 
 
2188
    _fmt = "Unknown record type: %(record_type)r"
 
2189
 
 
2190
    def __init__(self, record_type):
 
2191
        self.record_type = record_type
 
2192
 
 
2193
 
 
2194
class InvalidRecordError(ContainerError):
 
2195
 
 
2196
    _fmt = "Invalid record: %(reason)s"
 
2197
 
 
2198
    def __init__(self, reason):
 
2199
        self.reason = reason
 
2200
 
 
2201
 
 
2202
class ContainerHasExcessDataError(ContainerError):
 
2203
 
 
2204
    _fmt = "Container has data after end marker: %(excess)r"
 
2205
 
 
2206
    def __init__(self, excess):
 
2207
        self.excess = excess
 
2208
 
 
2209
 
 
2210
class DuplicateRecordNameError(ContainerError):
 
2211
 
 
2212
    _fmt = "Container has multiple records with the same name: %(name)s"
 
2213
 
 
2214
    def __init__(self, name):
 
2215
        self.name = name.decode("utf-8")
 
2216
 
 
2217
 
 
2218
class RepositoryDataStreamError(BzrError):
 
2219
 
 
2220
    _fmt = "Corrupt or incompatible data stream: %(reason)s"
 
2221
 
 
2222
    def __init__(self, reason):
 
2223
        self.reason = reason
 
2224
 
 
2225
 
 
2226
class UncommittedChanges(BzrError):
 
2227
 
 
2228
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2229
            ' (See brz status).%(more)s')
 
2230
 
 
2231
    def __init__(self, tree, more=None):
 
2232
        if more is None:
 
2233
            more = ''
 
2234
        else:
 
2235
            more = ' ' + more
 
2236
        import breezy.urlutils as urlutils
 
2237
        user_url = getattr(tree, "user_url", None)
 
2238
        if user_url is None:
 
2239
            display_url = str(tree)
 
2240
        else:
 
2241
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2242
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2243
 
 
2244
 
 
2245
class StoringUncommittedNotSupported(BzrError):
 
2246
 
 
2247
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
 
2248
            ' changes.')
 
2249
 
 
2250
    def __init__(self, branch):
 
2251
        import breezy.urlutils as urlutils
 
2252
        user_url = getattr(branch, "user_url", None)
 
2253
        if user_url is None:
 
2254
            display_url = str(branch)
 
2255
        else:
 
2256
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2257
        BzrError.__init__(self, branch=branch, display_url=display_url)
 
2258
 
 
2259
 
 
2260
class ShelvedChanges(UncommittedChanges):
 
2261
 
 
2262
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2263
            ' (See brz shelve --list).%(more)s')
 
2264
 
 
2265
 
 
2266
class UnableEncodePath(BzrError):
 
2267
 
 
2268
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
 
2269
            'user encoding %(user_encoding)s')
 
2270
 
 
2271
    def __init__(self, path, kind):
 
2272
        from breezy.osutils import get_user_encoding
 
2273
        self.path = path
 
2274
        self.kind = kind
 
2275
        self.user_encoding = get_user_encoding()
 
2276
 
 
2277
 
 
2278
class NoSuchAlias(BzrError):
 
2279
 
 
2280
    _fmt = ('The alias "%(alias_name)s" does not exist.')
 
2281
 
 
2282
    def __init__(self, alias_name):
 
2283
        BzrError.__init__(self, alias_name=alias_name)
 
2284
 
 
2285
 
 
2286
class CannotBindAddress(BzrError):
 
2287
 
 
2288
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
 
2289
 
 
2290
    def __init__(self, host, port, orig_error):
 
2291
        # nb: in python2.4 socket.error doesn't have a useful repr
 
2292
        BzrError.__init__(self, host=host, port=port,
 
2293
                          orig_error=repr(orig_error.args))
 
2294
 
 
2295
 
 
2296
class TipChangeRejected(BzrError):
 
2297
    """A pre_change_branch_tip hook function may raise this to cleanly and
 
2298
    explicitly abort a change to a branch tip.
 
2299
    """
 
2300
 
 
2301
    _fmt = u"Tip change rejected: %(msg)s"
 
2302
 
 
2303
    def __init__(self, msg):
 
2304
        self.msg = msg
 
2305
 
 
2306
 
 
2307
class JailBreak(BzrError):
 
2308
 
 
2309
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
 
2310
 
 
2311
    def __init__(self, url):
 
2312
        BzrError.__init__(self, url=url)
 
2313
 
 
2314
 
 
2315
class UserAbort(BzrError):
 
2316
 
 
2317
    _fmt = 'The user aborted the operation.'
 
2318
 
 
2319
 
 
2320
class UnresumableWriteGroup(BzrError):
 
2321
 
 
2322
    _fmt = ("Repository %(repository)s cannot resume write group "
 
2323
            "%(write_groups)r: %(reason)s")
 
2324
 
 
2325
    internal_error = True
 
2326
 
 
2327
    def __init__(self, repository, write_groups, reason):
 
2328
        self.repository = repository
 
2329
        self.write_groups = write_groups
 
2330
        self.reason = reason
 
2331
 
 
2332
 
 
2333
class UnsuspendableWriteGroup(BzrError):
 
2334
 
 
2335
    _fmt = ("Repository %(repository)s cannot suspend a write group.")
 
2336
 
 
2337
    internal_error = True
 
2338
 
 
2339
    def __init__(self, repository):
 
2340
        self.repository = repository
 
2341
 
 
2342
 
 
2343
class LossyPushToSameVCS(BzrError):
 
2344
 
 
2345
    _fmt = ("Lossy push not possible between %(source_branch)r and "
 
2346
            "%(target_branch)r that are in the same VCS.")
 
2347
 
 
2348
    internal_error = True
 
2349
 
 
2350
    def __init__(self, source_branch, target_branch):
 
2351
        self.source_branch = source_branch
 
2352
        self.target_branch = target_branch
 
2353
 
 
2354
 
 
2355
class NoRoundtrippingSupport(BzrError):
 
2356
 
 
2357
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
2358
            "%(target_branch)r.")
 
2359
 
 
2360
    internal_error = True
 
2361
 
 
2362
    def __init__(self, source_branch, target_branch):
 
2363
        self.source_branch = source_branch
 
2364
        self.target_branch = target_branch
 
2365
 
 
2366
 
 
2367
class NoColocatedBranchSupport(BzrError):
 
2368
 
 
2369
    _fmt = ("%(controldir)r does not support co-located branches.")
 
2370
 
 
2371
    def __init__(self, controldir):
 
2372
        self.controldir = controldir
 
2373
 
 
2374
 
 
2375
class RecursiveBind(BzrError):
 
2376
 
 
2377
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
2378
            'Please use `brz unbind` to fix.')
 
2379
 
 
2380
    def __init__(self, branch_url):
 
2381
        self.branch_url = branch_url
 
2382
 
 
2383
 
 
2384
class UnsupportedKindChange(BzrError):
 
2385
 
 
2386
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
 
2387
            "%(path)s not supported by format %(format)r")
 
2388
 
 
2389
    def __init__(self, path, from_kind, to_kind, format):
 
2390
        self.path = path
 
2391
        self.from_kind = from_kind
 
2392
        self.to_kind = to_kind
 
2393
        self.format = format
 
2394
 
 
2395
 
 
2396
class ChangesAlreadyStored(BzrCommandError):
 
2397
 
 
2398
    _fmt = ('Cannot store uncommitted changes because this branch already'
 
2399
            ' stores uncommitted changes.')
 
2400
 
 
2401
 
 
2402
class RevnoOutOfBounds(InternalBzrError):
 
2403
 
 
2404
    _fmt = ("The requested revision number %(revno)d is outside of the "
 
2405
            "expected boundaries (%(minimum)d <= %(maximum)d).")
 
2406
 
 
2407
    def __init__(self, revno, bounds):
 
2408
        InternalBzrError.__init__(
 
2409
            self, revno=revno, minimum=bounds[0], maximum=bounds[1])