/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 bzrlib/errors.py

  • Committer: Dmitry Vasiliev
  • Date: 2007-03-02 14:10:15 UTC
  • mto: (2327.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2328.
  • Revision ID: dima@hlabs.spb.ru-20070302141015-sjn7kthbdgylt3bp
Added comments for test_get_vendor_search_order

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
"""
 
19
 
 
20
 
 
21
from bzrlib import (
 
22
    osutils,
 
23
    symbol_versioning,
 
24
    )
 
25
from bzrlib.patches import (
 
26
    MalformedHunkHeader,
 
27
    MalformedLine,
 
28
    MalformedPatchHeader,
 
29
    PatchConflict,
 
30
    PatchSyntax,
 
31
    )
 
32
 
 
33
 
 
34
# TODO: is there any value in providing the .args field used by standard
 
35
# python exceptions?   A list of values with no names seems less useful
 
36
# to me.
 
37
 
 
38
# TODO: Perhaps convert the exception to a string at the moment it's
 
39
# constructed to make sure it will succeed.  But that says nothing about
 
40
# exceptions that are never raised.
 
41
 
 
42
# TODO: selftest assertRaises should probably also check that every error
 
43
# raised can be formatted as a string successfully, and without giving
 
44
# 'unprintable'.
 
45
 
 
46
 
 
47
class BzrError(StandardError):
 
48
    """
 
49
    Base class for errors raised by bzrlib.
 
50
 
 
51
    :cvar internal_error: if true (or absent) this was probably caused by a
 
52
    bzr bug and should be displayed with a traceback; if False this was
 
53
    probably a user or environment error and they don't need the gory details.
 
54
    (That can be overridden by -Derror on the command line.)
 
55
 
 
56
    :cvar _fmt: Format string to display the error; this is expanded
 
57
    by the instance's dict.
 
58
    """
 
59
 
 
60
    internal_error = False
 
61
 
 
62
    def __init__(self, msg=None, **kwds):
 
63
        """Construct a new BzrError.
 
64
 
 
65
        There are two alternative forms for constructing these objects.
 
66
        Either a preformatted string may be passed, or a set of named
 
67
        arguments can be given.  The first is for generic "user" errors which
 
68
        are not intended to be caught and so do not need a specific subclass.
 
69
        The second case is for use with subclasses that provide a _fmt format
 
70
        string to print the arguments.
 
71
 
 
72
        Keyword arguments are taken as parameters to the error, which can
 
73
        be inserted into the format string template.  It's recommended
 
74
        that subclasses override the __init__ method to require specific
 
75
        parameters.
 
76
 
 
77
        :param msg: If given, this is the literal complete text for the error,
 
78
        not subject to expansion.
 
79
        """
 
80
        StandardError.__init__(self)
 
81
        if msg is not None:
 
82
            # I was going to deprecate this, but it actually turns out to be
 
83
            # quite handy - mbp 20061103.
 
84
            self._preformatted_string = msg
 
85
        else:
 
86
            self._preformatted_string = None
 
87
            for key, value in kwds.items():
 
88
                setattr(self, key, value)
 
89
 
 
90
    def __str__(self):
 
91
        s = getattr(self, '_preformatted_string', None)
 
92
        if s is not None:
 
93
            # contains a preformatted message; must be cast to plain str
 
94
            return str(s)
 
95
        try:
 
96
            fmt = self._get_format_string()
 
97
            if fmt:
 
98
                s = fmt % self.__dict__
 
99
                # __str__() should always return a 'str' object
 
100
                # never a 'unicode' object.
 
101
                if isinstance(s, unicode):
 
102
                    return s.encode('utf8')
 
103
                return s
 
104
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
105
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
 
106
                % (self.__class__.__name__,
 
107
                   self.__dict__,
 
108
                   getattr(self, '_fmt', None),
 
109
                   str(e))
 
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
            return fmt
 
116
        fmt = getattr(self, '__doc__', None)
 
117
        if fmt is not None:
 
118
            symbol_versioning.warn("%s uses its docstring as a format, "
 
119
                    "it should use _fmt instead" % self.__class__.__name__,
 
120
                    DeprecationWarning)
 
121
            return fmt
 
122
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
 
123
            % (self.__class__.__name__,
 
124
               self.__dict__,
 
125
               getattr(self, '_fmt', None),
 
126
               )
 
127
 
 
128
 
 
129
class BzrNewError(BzrError):
 
130
    """Deprecated error base class."""
 
131
    # base classes should override the docstring with their human-
 
132
    # readable explanation
 
133
 
 
134
    def __init__(self, *args, **kwds):
 
135
        # XXX: Use the underlying BzrError to always generate the args
 
136
        # attribute if it doesn't exist.  We can't use super here, because
 
137
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
138
        # --bmc, 20060426
 
139
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
140
             'please convert %s to use BzrError instead'
 
141
             % self.__class__.__name__,
 
142
             DeprecationWarning,
 
143
             stacklevel=2)
 
144
        BzrError.__init__(self, *args)
 
145
        for key, value in kwds.items():
 
146
            setattr(self, key, value)
 
147
 
 
148
    def __str__(self):
 
149
        try:
 
150
            # __str__() should always return a 'str' object
 
151
            # never a 'unicode' object.
 
152
            s = self.__doc__ % self.__dict__
 
153
            if isinstance(s, unicode):
 
154
                return s.encode('utf8')
 
155
            return s
 
156
        except (TypeError, NameError, ValueError, KeyError), e:
 
157
            return 'Unprintable exception %s(%r): %s' \
 
158
                % (self.__class__.__name__,
 
159
                   self.__dict__, str(e))
 
160
 
 
161
 
 
162
class AlreadyBuilding(BzrError):
 
163
 
 
164
    _fmt = "The tree builder is already building a tree."
 
165
 
 
166
 
 
167
class BzrCheckError(BzrError):
 
168
 
 
169
    _fmt = "Internal check failed: %(message)s"
 
170
 
 
171
    internal_error = True
 
172
 
 
173
    def __init__(self, message):
 
174
        BzrError.__init__(self)
 
175
        self.message = message
 
176
 
 
177
 
 
178
class InvalidEntryName(BzrError):
 
179
 
 
180
    _fmt = "Invalid entry name: %(name)s"
 
181
 
 
182
    internal_error = True
 
183
 
 
184
    def __init__(self, name):
 
185
        BzrError.__init__(self)
 
186
        self.name = name
 
187
 
 
188
 
 
189
class InvalidRevisionNumber(BzrError):
 
190
 
 
191
    _fmt = "Invalid revision number %(revno)s"
 
192
 
 
193
    def __init__(self, revno):
 
194
        BzrError.__init__(self)
 
195
        self.revno = revno
 
196
 
 
197
 
 
198
class InvalidRevisionId(BzrError):
 
199
 
 
200
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
201
 
 
202
    def __init__(self, revision_id, branch):
 
203
        # branch can be any string or object with __str__ defined
 
204
        BzrError.__init__(self)
 
205
        self.revision_id = revision_id
 
206
        self.branch = branch
 
207
 
 
208
class ReservedId(BzrError):
 
209
 
 
210
    _fmt = "Reserved revision-id {%(revision_id)s}"
 
211
 
 
212
    def __init__(self, revision_id):
 
213
        self.revision_id = revision_id
 
214
 
 
215
class NoSuchId(BzrError):
 
216
 
 
217
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
218
 
 
219
    def __init__(self, tree, file_id):
 
220
        BzrError.__init__(self)
 
221
        self.file_id = file_id
 
222
        self.tree = tree
 
223
 
 
224
 
 
225
class InventoryModified(BzrError):
 
226
 
 
227
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
 
228
            " so a clean inventory cannot be read without data loss.")
 
229
 
 
230
    internal_error = True
 
231
 
 
232
    def __init__(self, tree):
 
233
        self.tree = tree
 
234
 
 
235
 
 
236
class NoWorkingTree(BzrError):
 
237
 
 
238
    _fmt = "No WorkingTree exists for %(base)s."
 
239
 
 
240
    def __init__(self, base):
 
241
        BzrError.__init__(self)
 
242
        self.base = base
 
243
 
 
244
 
 
245
class NotBuilding(BzrError):
 
246
 
 
247
    _fmt = "Not currently building a tree."
 
248
 
 
249
 
 
250
class NotLocalUrl(BzrError):
 
251
 
 
252
    _fmt = "%(url)s is not a local path."
 
253
 
 
254
    def __init__(self, url):
 
255
        self.url = url
 
256
 
 
257
 
 
258
class WorkingTreeAlreadyPopulated(BzrError):
 
259
 
 
260
    _fmt = """Working tree already populated in %(base)s"""
 
261
 
 
262
    internal_error = True
 
263
 
 
264
    def __init__(self, base):
 
265
        self.base = base
 
266
 
 
267
class BzrCommandError(BzrError):
 
268
    """Error from user command"""
 
269
 
 
270
    internal_error = False
 
271
 
 
272
    # Error from malformed user command; please avoid raising this as a
 
273
    # generic exception not caused by user input.
 
274
    #
 
275
    # I think it's a waste of effort to differentiate between errors that
 
276
    # are not intended to be caught anyway.  UI code need not subclass
 
277
    # BzrCommandError, and non-UI code should not throw a subclass of
 
278
    # BzrCommandError.  ADHB 20051211
 
279
    def __init__(self, msg):
 
280
        # Object.__str__() must return a real string
 
281
        # returning a Unicode string is a python error.
 
282
        if isinstance(msg, unicode):
 
283
            self.msg = msg.encode('utf8')
 
284
        else:
 
285
            self.msg = msg
 
286
 
 
287
    def __str__(self):
 
288
        return self.msg
 
289
 
 
290
 
 
291
class NotWriteLocked(BzrError):
 
292
 
 
293
    _fmt = """%(not_locked)r is not write locked but needs to be."""
 
294
 
 
295
    def __init__(self, not_locked):
 
296
        self.not_locked = not_locked
 
297
 
 
298
 
 
299
class BzrOptionError(BzrCommandError):
 
300
 
 
301
    _fmt = "Error in command line options"
 
302
 
 
303
 
 
304
class BadOptionValue(BzrError):
 
305
 
 
306
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
307
 
 
308
    def __init__(self, name, value):
 
309
        BzrError.__init__(self, name=name, value=value)
 
310
 
 
311
 
 
312
class StrictCommitFailed(BzrError):
 
313
 
 
314
    _fmt = "Commit refused because there are unknown files in the tree"
 
315
 
 
316
 
 
317
# XXX: Should be unified with TransportError; they seem to represent the
 
318
# same thing
 
319
class PathError(BzrError):
 
320
 
 
321
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
322
 
 
323
    def __init__(self, path, extra=None):
 
324
        BzrError.__init__(self)
 
325
        self.path = path
 
326
        if extra:
 
327
            self.extra = ': ' + str(extra)
 
328
        else:
 
329
            self.extra = ''
 
330
 
 
331
 
 
332
class NoSuchFile(PathError):
 
333
 
 
334
    _fmt = "No such file: %(path)r%(extra)s"
 
335
 
 
336
 
 
337
class FileExists(PathError):
 
338
 
 
339
    _fmt = "File exists: %(path)r%(extra)s"
 
340
 
 
341
 
 
342
class RenameFailedFilesExist(BzrError):
 
343
    """Used when renaming and both source and dest exist."""
 
344
 
 
345
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
 
346
            "%(extra)s")
 
347
 
 
348
    def __init__(self, source, dest, extra=None):
 
349
        BzrError.__init__(self)
 
350
        self.source = str(source)
 
351
        self.dest = str(dest)
 
352
        if extra:
 
353
            self.extra = ' ' + str(extra)
 
354
        else:
 
355
            self.extra = ''
 
356
 
 
357
 
 
358
class NotADirectory(PathError):
 
359
 
 
360
    _fmt = "%(path)r is not a directory %(extra)s"
 
361
 
 
362
 
 
363
class NotInWorkingDirectory(PathError):
 
364
 
 
365
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
366
 
 
367
 
 
368
class DirectoryNotEmpty(PathError):
 
369
 
 
370
    _fmt = "Directory not empty: %(path)r%(extra)s"
 
371
 
 
372
 
 
373
class ReadingCompleted(BzrError):
 
374
 
 
375
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
 
376
            "called upon it - the request has been completed and no more "
 
377
            "data may be read.")
 
378
 
 
379
    internal_error = True
 
380
 
 
381
    def __init__(self, request):
 
382
        self.request = request
 
383
 
 
384
 
 
385
class ResourceBusy(PathError):
 
386
 
 
387
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
388
 
 
389
 
 
390
class PermissionDenied(PathError):
 
391
 
 
392
    _fmt = "Permission denied: %(path)r%(extra)s"
 
393
 
 
394
 
 
395
class InvalidURL(PathError):
 
396
 
 
397
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
398
 
 
399
 
 
400
class InvalidURLJoin(PathError):
 
401
 
 
402
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
403
 
 
404
    def __init__(self, msg, base, args):
 
405
        PathError.__init__(self, base, msg)
 
406
        self.args = [base] + list(args)
 
407
 
 
408
 
 
409
class UnknownHook(BzrError):
 
410
 
 
411
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
412
 
 
413
    def __init__(self, hook_type, hook_name):
 
414
        BzrError.__init__(self)
 
415
        self.type = hook_type
 
416
        self.hook = hook_name
 
417
 
 
418
 
 
419
class UnsupportedProtocol(PathError):
 
420
 
 
421
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
422
 
 
423
    def __init__(self, url, extra):
 
424
        PathError.__init__(self, url, extra=extra)
 
425
 
 
426
 
 
427
class ShortReadvError(PathError):
 
428
 
 
429
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
 
430
            " at %(offset)s for %(path)s%(extra)s")
 
431
 
 
432
    internal_error = True
 
433
 
 
434
    def __init__(self, path, offset, length, actual, extra=None):
 
435
        PathError.__init__(self, path, extra=extra)
 
436
        self.offset = offset
 
437
        self.length = length
 
438
        self.actual = actual
 
439
 
 
440
 
 
441
class PathNotChild(BzrError):
 
442
 
 
443
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
 
444
 
 
445
    internal_error = True
 
446
 
 
447
    def __init__(self, path, base, extra=None):
 
448
        BzrError.__init__(self)
 
449
        self.path = path
 
450
        self.base = base
 
451
        if extra:
 
452
            self.extra = ': ' + str(extra)
 
453
        else:
 
454
            self.extra = ''
 
455
 
 
456
 
 
457
class InvalidNormalization(PathError):
 
458
 
 
459
    _fmt = "Path %(path)r is not unicode normalized"
 
460
 
 
461
 
 
462
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
463
# the exception object is a bit undesirable.
 
464
# TODO: Probably this behavior of should be a common superclass
 
465
class NotBranchError(PathError):
 
466
 
 
467
    _fmt = "Not a branch: %(path)s"
 
468
 
 
469
    def __init__(self, path):
 
470
       import bzrlib.urlutils as urlutils
 
471
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
472
 
 
473
 
 
474
class AlreadyBranchError(PathError):
 
475
 
 
476
    _fmt = "Already a branch: %(path)s."
 
477
 
 
478
 
 
479
class BranchExistsWithoutWorkingTree(PathError):
 
480
 
 
481
    _fmt = "Directory contains a branch, but no working tree \
 
482
(use bzr checkout if you wish to build a working tree): %(path)s"
 
483
 
 
484
 
 
485
class AtomicFileAlreadyClosed(PathError):
 
486
 
 
487
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
488
            " %(path)s")
 
489
 
 
490
    def __init__(self, path, function):
 
491
        PathError.__init__(self, path=path, extra=None)
 
492
        self.function = function
 
493
 
 
494
 
 
495
class InaccessibleParent(PathError):
 
496
 
 
497
    _fmt = ("Parent not accessible given base %(base)s and"
 
498
            " relative path %(path)s")
 
499
 
 
500
    def __init__(self, path, base):
 
501
        PathError.__init__(self, path)
 
502
        self.base = base
 
503
 
 
504
 
 
505
class NoRepositoryPresent(BzrError):
 
506
 
 
507
    _fmt = "No repository present: %(path)r"
 
508
    def __init__(self, bzrdir):
 
509
        BzrError.__init__(self)
 
510
        self.path = bzrdir.transport.clone('..').base
 
511
 
 
512
 
 
513
class FileInWrongBranch(BzrError):
 
514
 
 
515
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
516
 
 
517
    def __init__(self, branch, path):
 
518
        BzrError.__init__(self)
 
519
        self.branch = branch
 
520
        self.branch_base = branch.base
 
521
        self.path = path
 
522
 
 
523
 
 
524
class UnsupportedFormatError(BzrError):
 
525
 
 
526
    _fmt = "Unsupported branch format: %(format)s"
 
527
 
 
528
 
 
529
class UnknownFormatError(BzrError):
 
530
 
 
531
    _fmt = "Unknown branch format: %(format)r"
 
532
 
 
533
 
 
534
class IncompatibleFormat(BzrError):
 
535
 
 
536
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
537
 
 
538
    def __init__(self, format, bzrdir_format):
 
539
        BzrError.__init__(self)
 
540
        self.format = format
 
541
        self.bzrdir = bzrdir_format
 
542
 
 
543
 
 
544
class IncompatibleRevision(BzrError):
 
545
 
 
546
    _fmt = "Revision is not compatible with %(repo_format)s"
 
547
 
 
548
    def __init__(self, repo_format):
 
549
        BzrError.__init__(self)
 
550
        self.repo_format = repo_format
 
551
 
 
552
 
 
553
class AlreadyVersionedError(BzrError):
 
554
    """Used when a path is expected not to be versioned, but it is."""
 
555
 
 
556
    _fmt = "%(context_info)s%(path)s is already versioned"
 
557
 
 
558
    def __init__(self, path, context_info=None):
 
559
        """Construct a new NotVersionedError.
 
560
 
 
561
        :param path: This is the path which is versioned,
 
562
        which should be in a user friendly form.
 
563
        :param context_info: If given, this is information about the context,
 
564
        which could explain why this is expected to not be versioned.
 
565
        """
 
566
        BzrError.__init__(self)
 
567
        self.path = path
 
568
        if context_info is None:
 
569
            self.context_info = ''
 
570
        else:
 
571
            self.context_info = context_info + ". "
 
572
 
 
573
 
 
574
class NotVersionedError(BzrError):
 
575
    """Used when a path is expected to be versioned, but it is not."""
 
576
 
 
577
    _fmt = "%(context_info)s%(path)s is not versioned"
 
578
 
 
579
    def __init__(self, path, context_info=None):
 
580
        """Construct a new NotVersionedError.
 
581
 
 
582
        :param path: This is the path which is not versioned,
 
583
        which should be in a user friendly form.
 
584
        :param context_info: If given, this is information about the context,
 
585
        which could explain why this is expected to be versioned.
 
586
        """
 
587
        BzrError.__init__(self)
 
588
        self.path = path
 
589
        if context_info is None:
 
590
            self.context_info = ''
 
591
        else:
 
592
            self.context_info = context_info + ". "
 
593
 
 
594
 
 
595
class PathsNotVersionedError(BzrError):
 
596
    """Used when reporting several paths which are not versioned"""
 
597
 
 
598
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
599
 
 
600
    def __init__(self, paths):
 
601
        from bzrlib.osutils import quotefn
 
602
        BzrError.__init__(self)
 
603
        self.paths = paths
 
604
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
605
 
 
606
 
 
607
class PathsDoNotExist(BzrError):
 
608
 
 
609
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
610
 
 
611
    # used when reporting that paths are neither versioned nor in the working
 
612
    # tree
 
613
 
 
614
    def __init__(self, paths, extra=None):
 
615
        # circular import
 
616
        from bzrlib.osutils import quotefn
 
617
        BzrError.__init__(self)
 
618
        self.paths = paths
 
619
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
620
        if extra:
 
621
            self.extra = ': ' + str(extra)
 
622
        else:
 
623
            self.extra = ''
 
624
 
 
625
 
 
626
class BadFileKindError(BzrError):
 
627
 
 
628
    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"
 
629
 
 
630
 
 
631
class ForbiddenControlFileError(BzrError):
 
632
 
 
633
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
634
 
 
635
 
 
636
class LockError(BzrError):
 
637
 
 
638
    _fmt = "Lock error: %(message)s"
 
639
 
 
640
    internal_error = True
 
641
 
 
642
    # All exceptions from the lock/unlock functions should be from
 
643
    # this exception class.  They will be translated as necessary. The
 
644
    # original exception is available as e.original_error
 
645
    #
 
646
    # New code should prefer to raise specific subclasses
 
647
    def __init__(self, message):
 
648
        self.message = message
 
649
 
 
650
 
 
651
class CommitNotPossible(LockError):
 
652
 
 
653
    _fmt = "A commit was attempted but we do not have a write lock open."
 
654
 
 
655
    def __init__(self):
 
656
        pass
 
657
 
 
658
 
 
659
class AlreadyCommitted(LockError):
 
660
 
 
661
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
662
 
 
663
    def __init__(self):
 
664
        pass
 
665
 
 
666
 
 
667
class ReadOnlyError(LockError):
 
668
 
 
669
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
670
 
 
671
    def __init__(self, obj):
 
672
        self.obj = obj
 
673
 
 
674
 
 
675
class OutSideTransaction(BzrError):
 
676
 
 
677
    _fmt = ("A transaction related operation was attempted after"
 
678
            " the transaction finished.")
 
679
 
 
680
 
 
681
class ObjectNotLocked(LockError):
 
682
 
 
683
    _fmt = "%(obj)r is not locked"
 
684
 
 
685
    # this can indicate that any particular object is not locked; see also
 
686
    # LockNotHeld which means that a particular *lock* object is not held by
 
687
    # the caller -- perhaps they should be unified.
 
688
    def __init__(self, obj):
 
689
        self.obj = obj
 
690
 
 
691
 
 
692
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
693
 
 
694
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
695
 
 
696
    def __init__(self, obj):
 
697
        self.obj = obj
 
698
 
 
699
 
 
700
class UnlockableTransport(LockError):
 
701
 
 
702
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
703
 
 
704
    def __init__(self, transport):
 
705
        self.transport = transport
 
706
 
 
707
 
 
708
class LockContention(LockError):
 
709
 
 
710
    _fmt = "Could not acquire lock %(lock)s"
 
711
    # TODO: show full url for lock, combining the transport and relative
 
712
    # bits?
 
713
 
 
714
    internal_error = False
 
715
 
 
716
    def __init__(self, lock):
 
717
        self.lock = lock
 
718
 
 
719
 
 
720
class LockBroken(LockError):
 
721
 
 
722
    _fmt = ("Lock was broken while still open: %(lock)s"
 
723
            " - check storage consistency!")
 
724
 
 
725
    internal_error = False
 
726
 
 
727
    def __init__(self, lock):
 
728
        self.lock = lock
 
729
 
 
730
 
 
731
class LockBreakMismatch(LockError):
 
732
 
 
733
    _fmt = ("Lock was released and re-acquired before being broken:"
 
734
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
735
 
 
736
    internal_error = False
 
737
 
 
738
    def __init__(self, lock, holder, target):
 
739
        self.lock = lock
 
740
        self.holder = holder
 
741
        self.target = target
 
742
 
 
743
 
 
744
class LockNotHeld(LockError):
 
745
 
 
746
    _fmt = "Lock not held: %(lock)s"
 
747
 
 
748
    internal_error = False
 
749
 
 
750
    def __init__(self, lock):
 
751
        self.lock = lock
 
752
 
 
753
 
 
754
class PointlessCommit(BzrError):
 
755
 
 
756
    _fmt = "No changes to commit"
 
757
 
 
758
 
 
759
class UpgradeReadonly(BzrError):
 
760
 
 
761
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
762
 
 
763
 
 
764
class UpToDateFormat(BzrError):
 
765
 
 
766
    _fmt = "The branch format %(format)s is already at the most recent format."
 
767
 
 
768
    def __init__(self, format):
 
769
        BzrError.__init__(self)
 
770
        self.format = format
 
771
 
 
772
 
 
773
class StrictCommitFailed(Exception):
 
774
 
 
775
    _fmt = "Commit refused because there are unknowns in the tree."
 
776
 
 
777
 
 
778
class NoSuchRevision(BzrError):
 
779
 
 
780
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
781
 
 
782
    internal_error = True
 
783
 
 
784
    def __init__(self, branch, revision):
 
785
        BzrError.__init__(self, branch=branch, revision=revision)
 
786
 
 
787
 
 
788
class NotLeftParentDescendant(BzrError):
 
789
 
 
790
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
791
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
792
 
 
793
    internal_error = True
 
794
 
 
795
    def __init__(self, branch, old_revision, new_revision):
 
796
        BzrError.__init__(self, branch_location=branch.base,
 
797
                          old_revision=old_revision,
 
798
                          new_revision=new_revision)
 
799
 
 
800
 
 
801
class NoSuchRevisionSpec(BzrError):
 
802
 
 
803
    _fmt = "No namespace registered for string: %(spec)r"
 
804
 
 
805
    def __init__(self, spec):
 
806
        BzrError.__init__(self, spec=spec)
 
807
 
 
808
 
 
809
class InvalidRevisionSpec(BzrError):
 
810
 
 
811
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
812
            " %(branch)s%(extra)s")
 
813
 
 
814
    def __init__(self, spec, branch, extra=None):
 
815
        BzrError.__init__(self, branch=branch, spec=spec)
 
816
        if extra:
 
817
            self.extra = '\n' + str(extra)
 
818
        else:
 
819
            self.extra = ''
 
820
 
 
821
 
 
822
class HistoryMissing(BzrError):
 
823
 
 
824
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
825
 
 
826
 
 
827
class AppendRevisionsOnlyViolation(BzrError):
 
828
 
 
829
    _fmt = ('Operation denied because it would change the main history,'
 
830
           ' which is not permitted by the append_revisions_only setting on'
 
831
           ' branch "%(location)s".')
 
832
 
 
833
    def __init__(self, location):
 
834
       import bzrlib.urlutils as urlutils
 
835
       location = urlutils.unescape_for_display(location, 'ascii')
 
836
       BzrError.__init__(self, location=location)
 
837
 
 
838
 
 
839
class DivergedBranches(BzrError):
 
840
 
 
841
    _fmt = ("These branches have diverged."
 
842
            " Use the merge command to reconcile them.")
 
843
 
 
844
    internal_error = False
 
845
 
 
846
    def __init__(self, branch1, branch2):
 
847
        self.branch1 = branch1
 
848
        self.branch2 = branch2
 
849
 
 
850
 
 
851
class NotLefthandHistory(BzrError):
 
852
 
 
853
    _fmt = "Supplied history does not follow left-hand parents"
 
854
 
 
855
    internal_error = True
 
856
 
 
857
    def __init__(self, history):
 
858
        BzrError.__init__(self, history=history)
 
859
 
 
860
 
 
861
class UnrelatedBranches(BzrError):
 
862
 
 
863
    _fmt = ("Branches have no common ancestor, and"
 
864
            " no merge base revision was specified.")
 
865
 
 
866
    internal_error = False
 
867
 
 
868
 
 
869
class NoCommonAncestor(BzrError):
 
870
 
 
871
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
872
 
 
873
    def __init__(self, revision_a, revision_b):
 
874
        self.revision_a = revision_a
 
875
        self.revision_b = revision_b
 
876
 
 
877
 
 
878
class NoCommonRoot(BzrError):
 
879
 
 
880
    _fmt = ("Revisions are not derived from the same root: "
 
881
           "%(revision_a)s %(revision_b)s.")
 
882
 
 
883
    def __init__(self, revision_a, revision_b):
 
884
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
885
 
 
886
 
 
887
class NotAncestor(BzrError):
 
888
 
 
889
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
890
 
 
891
    def __init__(self, rev_id, not_ancestor_id):
 
892
        BzrError.__init__(self, rev_id=rev_id,
 
893
            not_ancestor_id=not_ancestor_id)
 
894
 
 
895
 
 
896
class InstallFailed(BzrError):
 
897
 
 
898
    def __init__(self, revisions):
 
899
        revision_str = ", ".join(str(r) for r in revisions)
 
900
        msg = "Could not install revisions:\n%s" % revision_str
 
901
        BzrError.__init__(self, msg)
 
902
        self.revisions = revisions
 
903
 
 
904
 
 
905
class AmbiguousBase(BzrError):
 
906
 
 
907
    def __init__(self, bases):
 
908
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
909
                DeprecationWarning)
 
910
        msg = ("The correct base is unclear, because %s are all equally close"
 
911
                % ", ".join(bases))
 
912
        BzrError.__init__(self, msg)
 
913
        self.bases = bases
 
914
 
 
915
 
 
916
class NoCommits(BzrError):
 
917
 
 
918
    _fmt = "Branch %(branch)s has no commits."
 
919
 
 
920
    def __init__(self, branch):
 
921
        BzrError.__init__(self, branch=branch)
 
922
 
 
923
 
 
924
class UnlistableStore(BzrError):
 
925
 
 
926
    def __init__(self, store):
 
927
        BzrError.__init__(self, "Store %s is not listable" % store)
 
928
 
 
929
 
 
930
 
 
931
class UnlistableBranch(BzrError):
 
932
 
 
933
    def __init__(self, br):
 
934
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
935
 
 
936
 
 
937
class BoundBranchOutOfDate(BzrError):
 
938
 
 
939
    _fmt = ("Bound branch %(branch)s is out of date"
 
940
            " with master branch %(master)s.")
 
941
 
 
942
    def __init__(self, branch, master):
 
943
        BzrError.__init__(self)
 
944
        self.branch = branch
 
945
        self.master = master
 
946
 
 
947
 
 
948
class CommitToDoubleBoundBranch(BzrError):
 
949
 
 
950
    _fmt = ("Cannot commit to branch %(branch)s."
 
951
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
952
 
 
953
    def __init__(self, branch, master, remote):
 
954
        BzrError.__init__(self)
 
955
        self.branch = branch
 
956
        self.master = master
 
957
        self.remote = remote
 
958
 
 
959
 
 
960
class OverwriteBoundBranch(BzrError):
 
961
 
 
962
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
963
 
 
964
    def __init__(self, branch):
 
965
        BzrError.__init__(self)
 
966
        self.branch = branch
 
967
 
 
968
 
 
969
class BoundBranchConnectionFailure(BzrError):
 
970
 
 
971
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
972
            " => %(target)s: %(error)s")
 
973
 
 
974
    def __init__(self, branch, target, error):
 
975
        BzrError.__init__(self)
 
976
        self.branch = branch
 
977
        self.target = target
 
978
        self.error = error
 
979
 
 
980
 
 
981
class WeaveError(BzrError):
 
982
 
 
983
    _fmt = "Error in processing weave: %(message)s"
 
984
 
 
985
    def __init__(self, message=None):
 
986
        BzrError.__init__(self)
 
987
        self.message = message
 
988
 
 
989
 
 
990
class WeaveRevisionAlreadyPresent(WeaveError):
 
991
 
 
992
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
993
 
 
994
    def __init__(self, revision_id, weave):
 
995
 
 
996
        WeaveError.__init__(self)
 
997
        self.revision_id = revision_id
 
998
        self.weave = weave
 
999
 
 
1000
 
 
1001
class WeaveRevisionNotPresent(WeaveError):
 
1002
 
 
1003
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1004
 
 
1005
    def __init__(self, revision_id, weave):
 
1006
        WeaveError.__init__(self)
 
1007
        self.revision_id = revision_id
 
1008
        self.weave = weave
 
1009
 
 
1010
 
 
1011
class WeaveFormatError(WeaveError):
 
1012
 
 
1013
    _fmt = "Weave invariant violated: %(what)s"
 
1014
 
 
1015
    def __init__(self, what):
 
1016
        WeaveError.__init__(self)
 
1017
        self.what = what
 
1018
 
 
1019
 
 
1020
class WeaveParentMismatch(WeaveError):
 
1021
 
 
1022
    _fmt = "Parents are mismatched between two revisions."
 
1023
 
 
1024
 
 
1025
class WeaveInvalidChecksum(WeaveError):
 
1026
 
 
1027
    _fmt = "Text did not match it's checksum: %(message)s"
 
1028
 
 
1029
 
 
1030
class WeaveTextDiffers(WeaveError):
 
1031
 
 
1032
    _fmt = ("Weaves differ on text content. Revision:"
 
1033
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1034
 
 
1035
    def __init__(self, revision_id, weave_a, weave_b):
 
1036
        WeaveError.__init__(self)
 
1037
        self.revision_id = revision_id
 
1038
        self.weave_a = weave_a
 
1039
        self.weave_b = weave_b
 
1040
 
 
1041
 
 
1042
class WeaveTextDiffers(WeaveError):
 
1043
 
 
1044
    _fmt = ("Weaves differ on text content. Revision:"
 
1045
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1046
 
 
1047
    def __init__(self, revision_id, weave_a, weave_b):
 
1048
        WeaveError.__init__(self)
 
1049
        self.revision_id = revision_id
 
1050
        self.weave_a = weave_a
 
1051
        self.weave_b = weave_b
 
1052
 
 
1053
 
 
1054
class VersionedFileError(BzrError):
 
1055
 
 
1056
    _fmt = "Versioned file error"
 
1057
 
 
1058
 
 
1059
class RevisionNotPresent(VersionedFileError):
 
1060
 
 
1061
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1062
 
 
1063
    def __init__(self, revision_id, file_id):
 
1064
        VersionedFileError.__init__(self)
 
1065
        self.revision_id = revision_id
 
1066
        self.file_id = file_id
 
1067
 
 
1068
 
 
1069
class RevisionAlreadyPresent(VersionedFileError):
 
1070
 
 
1071
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1072
 
 
1073
    def __init__(self, revision_id, file_id):
 
1074
        VersionedFileError.__init__(self)
 
1075
        self.revision_id = revision_id
 
1076
        self.file_id = file_id
 
1077
 
 
1078
 
 
1079
class KnitError(BzrError):
 
1080
 
 
1081
    _fmt = "Knit error"
 
1082
 
 
1083
    internal_error = True
 
1084
 
 
1085
 
 
1086
class KnitHeaderError(KnitError):
 
1087
 
 
1088
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1089
 
 
1090
    def __init__(self, badline, filename):
 
1091
        KnitError.__init__(self)
 
1092
        self.badline = badline
 
1093
        self.filename = filename
 
1094
 
 
1095
 
 
1096
class KnitCorrupt(KnitError):
 
1097
 
 
1098
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1099
 
 
1100
    def __init__(self, filename, how):
 
1101
        KnitError.__init__(self)
 
1102
        self.filename = filename
 
1103
        self.how = how
 
1104
 
 
1105
 
 
1106
class KnitIndexUnknownMethod(KnitError):
 
1107
    """Raised when we don't understand the storage method.
 
1108
 
 
1109
    Currently only 'fulltext' and 'line-delta' are supported.
 
1110
    """
 
1111
 
 
1112
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1113
            " in options: %(options)r")
 
1114
 
 
1115
    def __init__(self, filename, options):
 
1116
        KnitError.__init__(self)
 
1117
        self.filename = filename
 
1118
        self.options = options
 
1119
 
 
1120
 
 
1121
class NoSuchExportFormat(BzrError):
 
1122
 
 
1123
    _fmt = "Export format %(format)r not supported"
 
1124
 
 
1125
    def __init__(self, format):
 
1126
        BzrError.__init__(self)
 
1127
        self.format = format
 
1128
 
 
1129
 
 
1130
class TransportError(BzrError):
 
1131
 
 
1132
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1133
 
 
1134
    def __init__(self, msg=None, orig_error=None):
 
1135
        if msg is None and orig_error is not None:
 
1136
            msg = str(orig_error)
 
1137
        if orig_error is None:
 
1138
            orig_error = ''
 
1139
        if msg is None:
 
1140
            msg =  ''
 
1141
        self.msg = msg
 
1142
        self.orig_error = orig_error
 
1143
        BzrError.__init__(self)
 
1144
 
 
1145
 
 
1146
class TooManyConcurrentRequests(BzrError):
 
1147
 
 
1148
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1149
            " Be sure to finish_writing and finish_reading on the"
 
1150
            " current request that is open.")
 
1151
 
 
1152
    internal_error = True
 
1153
 
 
1154
    def __init__(self, medium):
 
1155
        self.medium = medium
 
1156
 
 
1157
 
 
1158
class SmartProtocolError(TransportError):
 
1159
 
 
1160
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1161
 
 
1162
    def __init__(self, details):
 
1163
        self.details = details
 
1164
 
 
1165
 
 
1166
# A set of semi-meaningful errors which can be thrown
 
1167
class TransportNotPossible(TransportError):
 
1168
 
 
1169
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1170
 
 
1171
 
 
1172
class ConnectionError(TransportError):
 
1173
 
 
1174
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1175
 
 
1176
 
 
1177
class SocketConnectionError(ConnectionError):
 
1178
 
 
1179
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1180
 
 
1181
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1182
        if msg is None:
 
1183
            msg = 'Failed to connect to'
 
1184
        if orig_error is None:
 
1185
            orig_error = ''
 
1186
        else:
 
1187
            orig_error = '; ' + str(orig_error)
 
1188
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1189
        self.host = host
 
1190
        if port is None:
 
1191
            self.port = ''
 
1192
        else:
 
1193
            self.port = ':%s' % port
 
1194
 
 
1195
 
 
1196
class ConnectionReset(TransportError):
 
1197
 
 
1198
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1199
 
 
1200
 
 
1201
class InvalidRange(TransportError):
 
1202
 
 
1203
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1204
 
 
1205
    def __init__(self, path, offset):
 
1206
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1207
                                       % (path, offset)))
 
1208
        self.path = path
 
1209
        self.offset = offset
 
1210
 
 
1211
 
 
1212
class InvalidHttpResponse(TransportError):
 
1213
 
 
1214
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1215
 
 
1216
    def __init__(self, path, msg, orig_error=None):
 
1217
        self.path = path
 
1218
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1219
 
 
1220
 
 
1221
class InvalidHttpRange(InvalidHttpResponse):
 
1222
 
 
1223
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1224
 
 
1225
    def __init__(self, path, range, msg):
 
1226
        self.range = range
 
1227
        InvalidHttpResponse.__init__(self, path, msg)
 
1228
 
 
1229
 
 
1230
class InvalidHttpContentType(InvalidHttpResponse):
 
1231
 
 
1232
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1233
 
 
1234
    def __init__(self, path, ctype, msg):
 
1235
        self.ctype = ctype
 
1236
        InvalidHttpResponse.__init__(self, path, msg)
 
1237
 
 
1238
 
 
1239
class ConflictsInTree(BzrError):
 
1240
 
 
1241
    _fmt = "Working tree has conflicts."
 
1242
 
 
1243
 
 
1244
class ParseConfigError(BzrError):
 
1245
 
 
1246
    def __init__(self, errors, filename):
 
1247
        if filename is None:
 
1248
            filename = ""
 
1249
        message = "Error(s) parsing config file %s:\n%s" % \
 
1250
            (filename, ('\n'.join(e.message for e in errors)))
 
1251
        BzrError.__init__(self, message)
 
1252
 
 
1253
 
 
1254
class NoEmailInUsername(BzrError):
 
1255
 
 
1256
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1257
 
 
1258
    def __init__(self, username):
 
1259
        BzrError.__init__(self)
 
1260
        self.username = username
 
1261
 
 
1262
 
 
1263
class SigningFailed(BzrError):
 
1264
 
 
1265
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1266
 
 
1267
    def __init__(self, command_line):
 
1268
        BzrError.__init__(self, command_line=command_line)
 
1269
 
 
1270
 
 
1271
class WorkingTreeNotRevision(BzrError):
 
1272
 
 
1273
    _fmt = ("The working tree for %(basedir)s has changed since"
 
1274
            " the last commit, but weave merge requires that it be"
 
1275
            " unchanged")
 
1276
 
 
1277
    def __init__(self, tree):
 
1278
        BzrError.__init__(self, basedir=tree.basedir)
 
1279
 
 
1280
 
 
1281
class CantReprocessAndShowBase(BzrError):
 
1282
 
 
1283
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1284
           "the relationship of conflicting lines to the base")
 
1285
 
 
1286
 
 
1287
class GraphCycleError(BzrError):
 
1288
 
 
1289
    _fmt = "Cycle in graph %(graph)r"
 
1290
 
 
1291
    def __init__(self, graph):
 
1292
        BzrError.__init__(self)
 
1293
        self.graph = graph
 
1294
 
 
1295
 
 
1296
class WritingCompleted(BzrError):
 
1297
 
 
1298
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1299
            "called upon it - accept bytes may not be called anymore.")
 
1300
 
 
1301
    internal_error = True
 
1302
 
 
1303
    def __init__(self, request):
 
1304
        self.request = request
 
1305
 
 
1306
 
 
1307
class WritingNotComplete(BzrError):
 
1308
 
 
1309
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1310
            "called upon it - until the write phase is complete no "
 
1311
            "data may be read.")
 
1312
 
 
1313
    internal_error = True
 
1314
 
 
1315
    def __init__(self, request):
 
1316
        self.request = request
 
1317
 
 
1318
 
 
1319
class NotConflicted(BzrError):
 
1320
 
 
1321
    _fmt = "File %(filename)s is not conflicted."
 
1322
 
 
1323
    def __init__(self, filename):
 
1324
        BzrError.__init__(self)
 
1325
        self.filename = filename
 
1326
 
 
1327
 
 
1328
class MediumNotConnected(BzrError):
 
1329
 
 
1330
    _fmt = """The medium '%(medium)s' is not connected."""
 
1331
 
 
1332
    internal_error = True
 
1333
 
 
1334
    def __init__(self, medium):
 
1335
        self.medium = medium
 
1336
 
 
1337
 
 
1338
class MustUseDecorated(Exception):
 
1339
 
 
1340
    _fmt = "A decorating function has requested its original command be used."
 
1341
 
 
1342
 
 
1343
class NoBundleFound(BzrError):
 
1344
 
 
1345
    _fmt = "No bundle was found in %(filename)s"
 
1346
 
 
1347
    def __init__(self, filename):
 
1348
        BzrError.__init__(self)
 
1349
        self.filename = filename
 
1350
 
 
1351
 
 
1352
class BundleNotSupported(BzrError):
 
1353
 
 
1354
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1355
 
 
1356
    def __init__(self, version, msg):
 
1357
        BzrError.__init__(self)
 
1358
        self.version = version
 
1359
        self.msg = msg
 
1360
 
 
1361
 
 
1362
class MissingText(BzrError):
 
1363
 
 
1364
    _fmt = ("Branch %(base)s is missing revision"
 
1365
            " %(text_revision)s of %(file_id)s")
 
1366
 
 
1367
    def __init__(self, branch, text_revision, file_id):
 
1368
        BzrError.__init__(self)
 
1369
        self.branch = branch
 
1370
        self.base = branch.base
 
1371
        self.text_revision = text_revision
 
1372
        self.file_id = file_id
 
1373
 
 
1374
 
 
1375
class DuplicateKey(BzrError):
 
1376
 
 
1377
    _fmt = "Key %(key)s is already present in map"
 
1378
 
 
1379
 
 
1380
class MalformedTransform(BzrError):
 
1381
 
 
1382
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1383
 
 
1384
 
 
1385
class NoFinalPath(BzrError):
 
1386
 
 
1387
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1388
            "file-id: %(file_id)r\n"
 
1389
            "root trans-id: %(root_trans_id)r\n")
 
1390
 
 
1391
    def __init__(self, trans_id, transform):
 
1392
        self.trans_id = trans_id
 
1393
        self.file_id = transform.final_file_id(trans_id)
 
1394
        self.root_trans_id = transform.root
 
1395
 
 
1396
 
 
1397
class BzrBadParameter(BzrError):
 
1398
 
 
1399
    _fmt = "Bad parameter: %(param)r"
 
1400
 
 
1401
    # This exception should never be thrown, but it is a base class for all
 
1402
    # parameter-to-function errors.
 
1403
 
 
1404
    def __init__(self, param):
 
1405
        BzrError.__init__(self)
 
1406
        self.param = param
 
1407
 
 
1408
 
 
1409
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1410
 
 
1411
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1412
 
 
1413
 
 
1414
class ReusingTransform(BzrError):
 
1415
 
 
1416
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1417
 
 
1418
 
 
1419
class CantMoveRoot(BzrError):
 
1420
 
 
1421
    _fmt = "Moving the root directory is not supported at this time"
 
1422
 
 
1423
 
 
1424
class BzrMoveFailedError(BzrError):
 
1425
 
 
1426
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1427
 
 
1428
    def __init__(self, from_path='', to_path='', extra=None):
 
1429
        BzrError.__init__(self)
 
1430
        if extra:
 
1431
            self.extra = ': ' + str(extra)
 
1432
        else:
 
1433
            self.extra = ''
 
1434
 
 
1435
        has_from = len(from_path) > 0
 
1436
        has_to = len(to_path) > 0
 
1437
        if has_from:
 
1438
            self.from_path = osutils.splitpath(from_path)[-1]
 
1439
        else:
 
1440
            self.from_path = ''
 
1441
 
 
1442
        if has_to:
 
1443
            self.to_path = osutils.splitpath(to_path)[-1]
 
1444
        else:
 
1445
            self.to_path = ''
 
1446
 
 
1447
        self.operator = ""
 
1448
        if has_from and has_to:
 
1449
            self.operator = " =>"
 
1450
        elif has_from:
 
1451
            self.from_path = "from " + from_path
 
1452
        elif has_to:
 
1453
            self.operator = "to"
 
1454
        else:
 
1455
            self.operator = "file"
 
1456
 
 
1457
 
 
1458
class BzrRenameFailedError(BzrMoveFailedError):
 
1459
 
 
1460
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1461
 
 
1462
    def __init__(self, from_path, to_path, extra=None):
 
1463
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1464
 
 
1465
 
 
1466
class BzrBadParameterNotString(BzrBadParameter):
 
1467
 
 
1468
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1469
 
 
1470
 
 
1471
class BzrBadParameterMissing(BzrBadParameter):
 
1472
 
 
1473
    _fmt = "Parameter $(param)s is required but not present."
 
1474
 
 
1475
 
 
1476
class BzrBadParameterUnicode(BzrBadParameter):
 
1477
 
 
1478
    _fmt = ("Parameter %(param)s is unicode but"
 
1479
            " only byte-strings are permitted.")
 
1480
 
 
1481
 
 
1482
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1483
 
 
1484
    _fmt = "Parameter %(param)s contains a newline."
 
1485
 
 
1486
 
 
1487
class DependencyNotPresent(BzrError):
 
1488
 
 
1489
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1490
 
 
1491
    def __init__(self, library, error):
 
1492
        BzrError.__init__(self, library=library, error=error)
 
1493
 
 
1494
 
 
1495
class ParamikoNotPresent(DependencyNotPresent):
 
1496
 
 
1497
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1498
 
 
1499
    def __init__(self, error):
 
1500
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1501
 
 
1502
 
 
1503
class PointlessMerge(BzrError):
 
1504
 
 
1505
    _fmt = "Nothing to merge."
 
1506
 
 
1507
 
 
1508
class UninitializableFormat(BzrError):
 
1509
 
 
1510
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1511
 
 
1512
    def __init__(self, format):
 
1513
        BzrError.__init__(self)
 
1514
        self.format = format
 
1515
 
 
1516
 
 
1517
class BadConversionTarget(BzrError):
 
1518
 
 
1519
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1520
 
 
1521
    def __init__(self, problem, format):
 
1522
        BzrError.__init__(self)
 
1523
        self.problem = problem
 
1524
        self.format = format
 
1525
 
 
1526
 
 
1527
class NoDiff(BzrError):
 
1528
 
 
1529
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1530
 
 
1531
    def __init__(self, msg):
 
1532
        BzrError.__init__(self, msg=msg)
 
1533
 
 
1534
 
 
1535
class NoDiff3(BzrError):
 
1536
 
 
1537
    _fmt = "Diff3 is not installed on this machine."
 
1538
 
 
1539
 
 
1540
class ExistingLimbo(BzrError):
 
1541
 
 
1542
    _fmt = """This tree contains left-over files from a failed operation.
 
1543
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1544
    keep, and delete it when you are done."""
 
1545
 
 
1546
    def __init__(self, limbo_dir):
 
1547
       BzrError.__init__(self)
 
1548
       self.limbo_dir = limbo_dir
 
1549
 
 
1550
 
 
1551
class ImmortalLimbo(BzrError):
 
1552
 
 
1553
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1554
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1555
    keep, and delete it when you are done."""
 
1556
 
 
1557
    def __init__(self, limbo_dir):
 
1558
       BzrError.__init__(self)
 
1559
       self.limbo_dir = limbo_dir
 
1560
 
 
1561
 
 
1562
class OutOfDateTree(BzrError):
 
1563
 
 
1564
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1565
 
 
1566
    def __init__(self, tree):
 
1567
        BzrError.__init__(self)
 
1568
        self.tree = tree
 
1569
 
 
1570
 
 
1571
class MergeModifiedFormatError(BzrError):
 
1572
 
 
1573
    _fmt = "Error in merge modified format"
 
1574
 
 
1575
 
 
1576
class ConflictFormatError(BzrError):
 
1577
 
 
1578
    _fmt = "Format error in conflict listings"
 
1579
 
 
1580
 
 
1581
class CorruptRepository(BzrError):
 
1582
 
 
1583
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1584
            "Please run bzr reconcile on this repository.")
 
1585
 
 
1586
    def __init__(self, repo):
 
1587
        BzrError.__init__(self)
 
1588
        self.repo_path = repo.bzrdir.root_transport.base
 
1589
 
 
1590
 
 
1591
class UpgradeRequired(BzrError):
 
1592
 
 
1593
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1594
 
 
1595
    def __init__(self, path):
 
1596
        BzrError.__init__(self)
 
1597
        self.path = path
 
1598
 
 
1599
 
 
1600
class LocalRequiresBoundBranch(BzrError):
 
1601
 
 
1602
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1603
 
 
1604
 
 
1605
class MissingProgressBarFinish(BzrError):
 
1606
 
 
1607
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1608
 
 
1609
 
 
1610
class InvalidProgressBarType(BzrError):
 
1611
 
 
1612
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1613
            " is not a supported type Select one of: %(valid_types)s")
 
1614
 
 
1615
    def __init__(self, bar_type, valid_types):
 
1616
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1617
 
 
1618
 
 
1619
class UnsupportedOperation(BzrError):
 
1620
 
 
1621
    _fmt = ("The method %(mname)s is not supported on"
 
1622
            " objects of type %(tname)s.")
 
1623
 
 
1624
    def __init__(self, method, method_self):
 
1625
        self.method = method
 
1626
        self.mname = method.__name__
 
1627
        self.tname = type(method_self).__name__
 
1628
 
 
1629
 
 
1630
class CannotSetRevisionId(UnsupportedOperation):
 
1631
    """Raised when a commit is attempting to set a revision id but cant."""
 
1632
 
 
1633
 
 
1634
class NonAsciiRevisionId(UnsupportedOperation):
 
1635
    """Raised when a commit is attempting to set a non-ascii revision id
 
1636
       but cant.
 
1637
    """
 
1638
 
 
1639
 
 
1640
class BinaryFile(BzrError):
 
1641
 
 
1642
    _fmt = "File is binary but should be text."
 
1643
 
 
1644
 
 
1645
class IllegalPath(BzrError):
 
1646
 
 
1647
    _fmt = "The path %(path)s is not permitted on this platform"
 
1648
 
 
1649
    def __init__(self, path):
 
1650
        BzrError.__init__(self)
 
1651
        self.path = path
 
1652
 
 
1653
 
 
1654
class TestamentMismatch(BzrError):
 
1655
 
 
1656
    _fmt = """Testament did not match expected value.
 
1657
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1658
       {%(measured)s}"""
 
1659
 
 
1660
    def __init__(self, revision_id, expected, measured):
 
1661
        self.revision_id = revision_id
 
1662
        self.expected = expected
 
1663
        self.measured = measured
 
1664
 
 
1665
 
 
1666
class NotABundle(BzrError):
 
1667
 
 
1668
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1669
 
 
1670
    def __init__(self, text):
 
1671
        BzrError.__init__(self)
 
1672
        self.text = text
 
1673
 
 
1674
 
 
1675
class BadBundle(BzrError):
 
1676
 
 
1677
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1678
 
 
1679
    def __init__(self, text):
 
1680
        BzrError.__init__(self)
 
1681
        self.text = text
 
1682
 
 
1683
 
 
1684
class MalformedHeader(BadBundle):
 
1685
 
 
1686
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1687
 
 
1688
 
 
1689
class MalformedPatches(BadBundle):
 
1690
 
 
1691
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1692
 
 
1693
 
 
1694
class MalformedFooter(BadBundle):
 
1695
 
 
1696
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1697
 
 
1698
 
 
1699
class UnsupportedEOLMarker(BadBundle):
 
1700
 
 
1701
    _fmt = "End of line marker was not \\n in bzr revision-bundle"
 
1702
 
 
1703
    def __init__(self):
 
1704
        # XXX: BadBundle's constructor assumes there's explanatory text,
 
1705
        # but for this there is not
 
1706
        BzrError.__init__(self)
 
1707
 
 
1708
 
 
1709
class IncompatibleBundleFormat(BzrError):
 
1710
 
 
1711
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1712
 
 
1713
    def __init__(self, bundle_format, other):
 
1714
        BzrError.__init__(self)
 
1715
        self.bundle_format = bundle_format
 
1716
        self.other = other
 
1717
 
 
1718
 
 
1719
class BadInventoryFormat(BzrError):
 
1720
 
 
1721
    _fmt = "Root class for inventory serialization errors"
 
1722
 
 
1723
 
 
1724
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1725
 
 
1726
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1727
 
 
1728
    def __init__(self, msg):
 
1729
        BadInventoryFormat.__init__(self, msg=msg)
 
1730
 
 
1731
 
 
1732
class NoSmartMedium(BzrError):
 
1733
 
 
1734
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1735
    internal_error = True
 
1736
 
 
1737
    def __init__(self, transport):
 
1738
        self.transport = transport
 
1739
 
 
1740
 
 
1741
class NoSmartServer(NotBranchError):
 
1742
 
 
1743
    _fmt = "No smart server available at %(url)s"
 
1744
 
 
1745
    def __init__(self, url):
 
1746
        self.url = url
 
1747
 
 
1748
 
 
1749
class UnknownSSH(BzrError):
 
1750
 
 
1751
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1752
 
 
1753
    def __init__(self, vendor):
 
1754
        BzrError.__init__(self)
 
1755
        self.vendor = vendor
 
1756
 
 
1757
 
 
1758
class SSHVendorNotFound(BzrError):
 
1759
 
 
1760
    _fmt = ("Don't know how to handle SSH connections."
 
1761
            " Please set BZR_SSH environment variable.")
 
1762
 
 
1763
 
 
1764
class GhostRevisionUnusableHere(BzrError):
 
1765
 
 
1766
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1767
 
 
1768
    def __init__(self, revision_id):
 
1769
        BzrError.__init__(self)
 
1770
        self.revision_id = revision_id
 
1771
 
 
1772
 
 
1773
class IllegalUseOfScopeReplacer(BzrError):
 
1774
 
 
1775
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
1776
            " %(msg)s%(extra)s")
 
1777
 
 
1778
    internal_error = True
 
1779
 
 
1780
    def __init__(self, name, msg, extra=None):
 
1781
        BzrError.__init__(self)
 
1782
        self.name = name
 
1783
        self.msg = msg
 
1784
        if extra:
 
1785
            self.extra = ': ' + str(extra)
 
1786
        else:
 
1787
            self.extra = ''
 
1788
 
 
1789
 
 
1790
class InvalidImportLine(BzrError):
 
1791
 
 
1792
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1793
 
 
1794
    internal_error = True
 
1795
 
 
1796
    def __init__(self, text, msg):
 
1797
        BzrError.__init__(self)
 
1798
        self.text = text
 
1799
        self.msg = msg
 
1800
 
 
1801
 
 
1802
class ImportNameCollision(BzrError):
 
1803
 
 
1804
    _fmt = ("Tried to import an object to the same name as"
 
1805
            " an existing object. %(name)s")
 
1806
 
 
1807
    internal_error = True
 
1808
 
 
1809
    def __init__(self, name):
 
1810
        BzrError.__init__(self)
 
1811
        self.name = name
 
1812
 
 
1813
 
 
1814
class NoSuchTag(BzrError):
 
1815
 
 
1816
    _fmt = "No such tag: %(tag_name)s"
 
1817
 
 
1818
    def __init__(self, tag_name):
 
1819
        self.tag_name = tag_name
 
1820
 
 
1821
 
 
1822
class TagsNotSupported(BzrError):
 
1823
 
 
1824
    _fmt = ("Tags not supported by %(branch)s;"
 
1825
            " you may be able to use bzr upgrade.")
 
1826
 
 
1827
    def __init__(self, branch):
 
1828
        self.branch = branch
 
1829
 
 
1830
 
 
1831
class TagAlreadyExists(BzrError):
 
1832
 
 
1833
    _fmt = "Tag %(tag_name)s already exists."
 
1834
 
 
1835
    def __init__(self, tag_name):
 
1836
        self.tag_name = tag_name