/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: John Arbash Meinel
  • Date: 2007-03-15 23:25:18 UTC
  • mto: This revision was merged to the branch mainline in revision 2362.
  • Revision ID: john@arbash-meinel.com-20070315232518-9gawnsky0hshc3jd
(John Arbash Meinel)(trivial) The proper function name is byref, not by_ref

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 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 NoSubmitBranch(PathError):
 
475
 
 
476
    _fmt = 'No submit branch available for branch "%(path)s"'
 
477
 
 
478
    def __init__(self, branch):
 
479
       import bzrlib.urlutils as urlutils
 
480
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
 
481
 
 
482
 
 
483
class AlreadyBranchError(PathError):
 
484
 
 
485
    _fmt = "Already a branch: %(path)s."
 
486
 
 
487
 
 
488
class BranchExistsWithoutWorkingTree(PathError):
 
489
 
 
490
    _fmt = "Directory contains a branch, but no working tree \
 
491
(use bzr checkout if you wish to build a working tree): %(path)s"
 
492
 
 
493
 
 
494
class AtomicFileAlreadyClosed(PathError):
 
495
 
 
496
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
 
497
            " %(path)s")
 
498
 
 
499
    def __init__(self, path, function):
 
500
        PathError.__init__(self, path=path, extra=None)
 
501
        self.function = function
 
502
 
 
503
 
 
504
class InaccessibleParent(PathError):
 
505
 
 
506
    _fmt = ("Parent not accessible given base %(base)s and"
 
507
            " relative path %(path)s")
 
508
 
 
509
    def __init__(self, path, base):
 
510
        PathError.__init__(self, path)
 
511
        self.base = base
 
512
 
 
513
 
 
514
class NoRepositoryPresent(BzrError):
 
515
 
 
516
    _fmt = "No repository present: %(path)r"
 
517
    def __init__(self, bzrdir):
 
518
        BzrError.__init__(self)
 
519
        self.path = bzrdir.transport.clone('..').base
 
520
 
 
521
 
 
522
class FileInWrongBranch(BzrError):
 
523
 
 
524
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
525
 
 
526
    def __init__(self, branch, path):
 
527
        BzrError.__init__(self)
 
528
        self.branch = branch
 
529
        self.branch_base = branch.base
 
530
        self.path = path
 
531
 
 
532
 
 
533
class UnsupportedFormatError(BzrError):
 
534
    
 
535
    _fmt = "Unsupported branch format: %(format)s"
 
536
 
 
537
 
 
538
class UnknownFormatError(BzrError):
 
539
    
 
540
    _fmt = "Unknown branch format: %(format)r"
 
541
 
 
542
 
 
543
class IncompatibleFormat(BzrError):
 
544
    
 
545
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
546
 
 
547
    def __init__(self, format, bzrdir_format):
 
548
        BzrError.__init__(self)
 
549
        self.format = format
 
550
        self.bzrdir = bzrdir_format
 
551
 
 
552
 
 
553
class IncompatibleRevision(BzrError):
 
554
    
 
555
    _fmt = "Revision is not compatible with %(repo_format)s"
 
556
 
 
557
    def __init__(self, repo_format):
 
558
        BzrError.__init__(self)
 
559
        self.repo_format = repo_format
 
560
 
 
561
 
 
562
class AlreadyVersionedError(BzrError):
 
563
    """Used when a path is expected not to be versioned, but it is."""
 
564
 
 
565
    _fmt = "%(context_info)s%(path)s is already versioned"
 
566
 
 
567
    def __init__(self, path, context_info=None):
 
568
        """Construct a new AlreadyVersionedError.
 
569
 
 
570
        :param path: This is the path which is versioned,
 
571
        which should be in a user friendly form.
 
572
        :param context_info: If given, this is information about the context,
 
573
        which could explain why this is expected to not be versioned.
 
574
        """
 
575
        BzrError.__init__(self)
 
576
        self.path = path
 
577
        if context_info is None:
 
578
            self.context_info = ''
 
579
        else:
 
580
            self.context_info = context_info + ". "
 
581
 
 
582
 
 
583
class NotVersionedError(BzrError):
 
584
    """Used when a path is expected to be versioned, but it is not."""
 
585
 
 
586
    _fmt = "%(context_info)s%(path)s is not versioned"
 
587
 
 
588
    def __init__(self, path, context_info=None):
 
589
        """Construct a new NotVersionedError.
 
590
 
 
591
        :param path: This is the path which is not versioned,
 
592
        which should be in a user friendly form.
 
593
        :param context_info: If given, this is information about the context,
 
594
        which could explain why this is expected to be versioned.
 
595
        """
 
596
        BzrError.__init__(self)
 
597
        self.path = path
 
598
        if context_info is None:
 
599
            self.context_info = ''
 
600
        else:
 
601
            self.context_info = context_info + ". "
 
602
 
 
603
 
 
604
class PathsNotVersionedError(BzrError):
 
605
    """Used when reporting several paths which are not versioned"""
 
606
 
 
607
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
608
 
 
609
    def __init__(self, paths):
 
610
        from bzrlib.osutils import quotefn
 
611
        BzrError.__init__(self)
 
612
        self.paths = paths
 
613
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
614
 
 
615
 
 
616
class PathsDoNotExist(BzrError):
 
617
 
 
618
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
619
 
 
620
    # used when reporting that paths are neither versioned nor in the working
 
621
    # tree
 
622
 
 
623
    def __init__(self, paths, extra=None):
 
624
        # circular import
 
625
        from bzrlib.osutils import quotefn
 
626
        BzrError.__init__(self)
 
627
        self.paths = paths
 
628
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
629
        if extra:
 
630
            self.extra = ': ' + str(extra)
 
631
        else:
 
632
            self.extra = ''
 
633
 
 
634
 
 
635
class BadFileKindError(BzrError):
 
636
 
 
637
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
 
638
 
 
639
    def __init__(self, filename, kind):
 
640
        BzrError.__init__(self, filename=filename, kind=kind)
 
641
 
 
642
 
 
643
class ForbiddenControlFileError(BzrError):
 
644
 
 
645
    _fmt = "Cannot operate on %(filename)s because it is a control file"
 
646
 
 
647
 
 
648
class LockError(BzrError):
 
649
 
 
650
    _fmt = "Lock error: %(message)s"
 
651
 
 
652
    internal_error = True
 
653
 
 
654
    # All exceptions from the lock/unlock functions should be from
 
655
    # this exception class.  They will be translated as necessary. The
 
656
    # original exception is available as e.original_error
 
657
    #
 
658
    # New code should prefer to raise specific subclasses
 
659
    def __init__(self, message):
 
660
        self.message = message
 
661
 
 
662
 
 
663
class LockActive(LockError):
 
664
 
 
665
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
 
666
 
 
667
    internal_error = False
 
668
 
 
669
    def __init__(self, lock_description):
 
670
        self.lock_description = lock_description
 
671
 
 
672
 
 
673
class CommitNotPossible(LockError):
 
674
 
 
675
    _fmt = "A commit was attempted but we do not have a write lock open."
 
676
 
 
677
    def __init__(self):
 
678
        pass
 
679
 
 
680
 
 
681
class AlreadyCommitted(LockError):
 
682
 
 
683
    _fmt = "A rollback was requested, but is not able to be accomplished."
 
684
 
 
685
    def __init__(self):
 
686
        pass
 
687
 
 
688
 
 
689
class ReadOnlyError(LockError):
 
690
 
 
691
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
 
692
 
 
693
    # TODO: There should also be an error indicating that you need a write
 
694
    # lock and don't have any lock at all... mbp 20070226
 
695
 
 
696
    def __init__(self, obj):
 
697
        self.obj = obj
 
698
 
 
699
 
 
700
class ReadOnlyLockError(LockError):
 
701
 
 
702
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
 
703
 
 
704
    def __init__(self, fname, msg):
 
705
        LockError.__init__(self, '')
 
706
        self.fname = fname
 
707
        self.msg = msg
 
708
 
 
709
 
 
710
class OutSideTransaction(BzrError):
 
711
 
 
712
    _fmt = ("A transaction related operation was attempted after"
 
713
            " the transaction finished.")
 
714
 
 
715
 
 
716
class ObjectNotLocked(LockError):
 
717
 
 
718
    _fmt = "%(obj)r is not locked"
 
719
 
 
720
    # this can indicate that any particular object is not locked; see also
 
721
    # LockNotHeld which means that a particular *lock* object is not held by
 
722
    # the caller -- perhaps they should be unified.
 
723
    def __init__(self, obj):
 
724
        self.obj = obj
 
725
 
 
726
 
 
727
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
728
 
 
729
    _fmt = "Cannot change object %(obj)r in read only transaction"
 
730
 
 
731
    def __init__(self, obj):
 
732
        self.obj = obj
 
733
 
 
734
 
 
735
class UnlockableTransport(LockError):
 
736
 
 
737
    _fmt = "Cannot lock: transport is read only: %(transport)s"
 
738
 
 
739
    def __init__(self, transport):
 
740
        self.transport = transport
 
741
 
 
742
 
 
743
class LockContention(LockError):
 
744
 
 
745
    _fmt = "Could not acquire lock %(lock)s"
 
746
    # TODO: show full url for lock, combining the transport and relative
 
747
    # bits?
 
748
 
 
749
    internal_error = False
 
750
    
 
751
    def __init__(self, lock):
 
752
        self.lock = lock
 
753
 
 
754
 
 
755
class LockBroken(LockError):
 
756
 
 
757
    _fmt = ("Lock was broken while still open: %(lock)s"
 
758
            " - check storage consistency!")
 
759
 
 
760
    internal_error = False
 
761
 
 
762
    def __init__(self, lock):
 
763
        self.lock = lock
 
764
 
 
765
 
 
766
class LockBreakMismatch(LockError):
 
767
 
 
768
    _fmt = ("Lock was released and re-acquired before being broken:"
 
769
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
 
770
 
 
771
    internal_error = False
 
772
 
 
773
    def __init__(self, lock, holder, target):
 
774
        self.lock = lock
 
775
        self.holder = holder
 
776
        self.target = target
 
777
 
 
778
 
 
779
class LockNotHeld(LockError):
 
780
 
 
781
    _fmt = "Lock not held: %(lock)s"
 
782
 
 
783
    internal_error = False
 
784
 
 
785
    def __init__(self, lock):
 
786
        self.lock = lock
 
787
 
 
788
 
 
789
class PointlessCommit(BzrError):
 
790
 
 
791
    _fmt = "No changes to commit"
 
792
 
 
793
 
 
794
class UpgradeReadonly(BzrError):
 
795
 
 
796
    _fmt = "Upgrade URL cannot work with readonly URLs."
 
797
 
 
798
 
 
799
class UpToDateFormat(BzrError):
 
800
 
 
801
    _fmt = "The branch format %(format)s is already at the most recent format."
 
802
 
 
803
    def __init__(self, format):
 
804
        BzrError.__init__(self)
 
805
        self.format = format
 
806
 
 
807
 
 
808
class StrictCommitFailed(Exception):
 
809
 
 
810
    _fmt = "Commit refused because there are unknowns in the tree."
 
811
 
 
812
 
 
813
class NoSuchRevision(BzrError):
 
814
 
 
815
    _fmt = "Branch %(branch)s has no revision %(revision)s"
 
816
 
 
817
    internal_error = True
 
818
 
 
819
    def __init__(self, branch, revision):
 
820
        BzrError.__init__(self, branch=branch, revision=revision)
 
821
 
 
822
 
 
823
class NotLeftParentDescendant(BzrError):
 
824
 
 
825
    _fmt = ("Revision %(old_revision)s is not the left parent of"
 
826
            " %(new_revision)s, but branch %(branch_location)s expects this")
 
827
 
 
828
    internal_error = True
 
829
 
 
830
    def __init__(self, branch, old_revision, new_revision):
 
831
        BzrError.__init__(self, branch_location=branch.base,
 
832
                          old_revision=old_revision,
 
833
                          new_revision=new_revision)
 
834
 
 
835
 
 
836
class NoSuchRevisionSpec(BzrError):
 
837
 
 
838
    _fmt = "No namespace registered for string: %(spec)r"
 
839
 
 
840
    def __init__(self, spec):
 
841
        BzrError.__init__(self, spec=spec)
 
842
 
 
843
 
 
844
class NoSuchRevisionInTree(NoSuchRevision):
 
845
    """When using Tree.revision_tree, and the revision is not accessible."""
 
846
    
 
847
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
 
848
 
 
849
    def __init__(self, tree, revision_id):
 
850
        BzrError.__init__(self)
 
851
        self.tree = tree
 
852
        self.revision_id = revision_id
 
853
 
 
854
 
 
855
class InvalidRevisionSpec(BzrError):
 
856
 
 
857
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
858
            " %(branch)s%(extra)s")
 
859
 
 
860
    def __init__(self, spec, branch, extra=None):
 
861
        BzrError.__init__(self, branch=branch, spec=spec)
 
862
        if extra:
 
863
            self.extra = '\n' + str(extra)
 
864
        else:
 
865
            self.extra = ''
 
866
 
 
867
 
 
868
class HistoryMissing(BzrError):
 
869
 
 
870
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
871
 
 
872
 
 
873
class AppendRevisionsOnlyViolation(BzrError):
 
874
 
 
875
    _fmt = ('Operation denied because it would change the main history,'
 
876
           ' which is not permitted by the append_revisions_only setting on'
 
877
           ' branch "%(location)s".')
 
878
 
 
879
    def __init__(self, location):
 
880
       import bzrlib.urlutils as urlutils
 
881
       location = urlutils.unescape_for_display(location, 'ascii')
 
882
       BzrError.__init__(self, location=location)
 
883
 
 
884
 
 
885
class DivergedBranches(BzrError):
 
886
 
 
887
    _fmt = ("These branches have diverged."
 
888
            " Use the merge command to reconcile them.")
 
889
 
 
890
    internal_error = False
 
891
 
 
892
    def __init__(self, branch1, branch2):
 
893
        self.branch1 = branch1
 
894
        self.branch2 = branch2
 
895
 
 
896
 
 
897
class NotLefthandHistory(BzrError):
 
898
 
 
899
    _fmt = "Supplied history does not follow left-hand parents"
 
900
 
 
901
    internal_error = True
 
902
 
 
903
    def __init__(self, history):
 
904
        BzrError.__init__(self, history=history)
 
905
 
 
906
 
 
907
class UnrelatedBranches(BzrError):
 
908
 
 
909
    _fmt = ("Branches have no common ancestor, and"
 
910
            " no merge base revision was specified.")
 
911
 
 
912
    internal_error = False
 
913
 
 
914
 
 
915
class NoCommonAncestor(BzrError):
 
916
    
 
917
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
918
 
 
919
    def __init__(self, revision_a, revision_b):
 
920
        self.revision_a = revision_a
 
921
        self.revision_b = revision_b
 
922
 
 
923
 
 
924
class NoCommonRoot(BzrError):
 
925
 
 
926
    _fmt = ("Revisions are not derived from the same root: "
 
927
           "%(revision_a)s %(revision_b)s.")
 
928
 
 
929
    def __init__(self, revision_a, revision_b):
 
930
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
931
 
 
932
 
 
933
class NotAncestor(BzrError):
 
934
 
 
935
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
 
936
 
 
937
    def __init__(self, rev_id, not_ancestor_id):
 
938
        BzrError.__init__(self, rev_id=rev_id,
 
939
            not_ancestor_id=not_ancestor_id)
 
940
 
 
941
 
 
942
class InstallFailed(BzrError):
 
943
 
 
944
    def __init__(self, revisions):
 
945
        revision_str = ", ".join(str(r) for r in revisions)
 
946
        msg = "Could not install revisions:\n%s" % revision_str
 
947
        BzrError.__init__(self, msg)
 
948
        self.revisions = revisions
 
949
 
 
950
 
 
951
class AmbiguousBase(BzrError):
 
952
 
 
953
    def __init__(self, bases):
 
954
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
955
                DeprecationWarning)
 
956
        msg = ("The correct base is unclear, because %s are all equally close"
 
957
                % ", ".join(bases))
 
958
        BzrError.__init__(self, msg)
 
959
        self.bases = bases
 
960
 
 
961
 
 
962
class NoCommits(BzrError):
 
963
 
 
964
    _fmt = "Branch %(branch)s has no commits."
 
965
 
 
966
    def __init__(self, branch):
 
967
        BzrError.__init__(self, branch=branch)
 
968
 
 
969
 
 
970
class UnlistableStore(BzrError):
 
971
 
 
972
    def __init__(self, store):
 
973
        BzrError.__init__(self, "Store %s is not listable" % store)
 
974
 
 
975
 
 
976
 
 
977
class UnlistableBranch(BzrError):
 
978
 
 
979
    def __init__(self, br):
 
980
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
981
 
 
982
 
 
983
class BoundBranchOutOfDate(BzrError):
 
984
 
 
985
    _fmt = ("Bound branch %(branch)s is out of date"
 
986
            " with master branch %(master)s.")
 
987
 
 
988
    def __init__(self, branch, master):
 
989
        BzrError.__init__(self)
 
990
        self.branch = branch
 
991
        self.master = master
 
992
 
 
993
        
 
994
class CommitToDoubleBoundBranch(BzrError):
 
995
 
 
996
    _fmt = ("Cannot commit to branch %(branch)s."
 
997
            " It is bound to %(master)s, which is bound to %(remote)s.")
 
998
 
 
999
    def __init__(self, branch, master, remote):
 
1000
        BzrError.__init__(self)
 
1001
        self.branch = branch
 
1002
        self.master = master
 
1003
        self.remote = remote
 
1004
 
 
1005
 
 
1006
class OverwriteBoundBranch(BzrError):
 
1007
 
 
1008
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
 
1009
 
 
1010
    def __init__(self, branch):
 
1011
        BzrError.__init__(self)
 
1012
        self.branch = branch
 
1013
 
 
1014
 
 
1015
class BoundBranchConnectionFailure(BzrError):
 
1016
 
 
1017
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
 
1018
            " => %(target)s: %(error)s")
 
1019
 
 
1020
    def __init__(self, branch, target, error):
 
1021
        BzrError.__init__(self)
 
1022
        self.branch = branch
 
1023
        self.target = target
 
1024
        self.error = error
 
1025
 
 
1026
 
 
1027
class WeaveError(BzrError):
 
1028
 
 
1029
    _fmt = "Error in processing weave: %(message)s"
 
1030
 
 
1031
    def __init__(self, message=None):
 
1032
        BzrError.__init__(self)
 
1033
        self.message = message
 
1034
 
 
1035
 
 
1036
class WeaveRevisionAlreadyPresent(WeaveError):
 
1037
 
 
1038
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1039
 
 
1040
    def __init__(self, revision_id, weave):
 
1041
 
 
1042
        WeaveError.__init__(self)
 
1043
        self.revision_id = revision_id
 
1044
        self.weave = weave
 
1045
 
 
1046
 
 
1047
class WeaveRevisionNotPresent(WeaveError):
 
1048
 
 
1049
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1050
 
 
1051
    def __init__(self, revision_id, weave):
 
1052
        WeaveError.__init__(self)
 
1053
        self.revision_id = revision_id
 
1054
        self.weave = weave
 
1055
 
 
1056
 
 
1057
class WeaveFormatError(WeaveError):
 
1058
 
 
1059
    _fmt = "Weave invariant violated: %(what)s"
 
1060
 
 
1061
    def __init__(self, what):
 
1062
        WeaveError.__init__(self)
 
1063
        self.what = what
 
1064
 
 
1065
 
 
1066
class WeaveParentMismatch(WeaveError):
 
1067
 
 
1068
    _fmt = "Parents are mismatched between two revisions."
 
1069
    
 
1070
 
 
1071
class WeaveInvalidChecksum(WeaveError):
 
1072
 
 
1073
    _fmt = "Text did not match it's checksum: %(message)s"
 
1074
 
 
1075
 
 
1076
class WeaveTextDiffers(WeaveError):
 
1077
 
 
1078
    _fmt = ("Weaves differ on text content. Revision:"
 
1079
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1080
 
 
1081
    def __init__(self, revision_id, weave_a, weave_b):
 
1082
        WeaveError.__init__(self)
 
1083
        self.revision_id = revision_id
 
1084
        self.weave_a = weave_a
 
1085
        self.weave_b = weave_b
 
1086
 
 
1087
 
 
1088
class WeaveTextDiffers(WeaveError):
 
1089
 
 
1090
    _fmt = ("Weaves differ on text content. Revision:"
 
1091
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1092
 
 
1093
    def __init__(self, revision_id, weave_a, weave_b):
 
1094
        WeaveError.__init__(self)
 
1095
        self.revision_id = revision_id
 
1096
        self.weave_a = weave_a
 
1097
        self.weave_b = weave_b
 
1098
 
 
1099
 
 
1100
class VersionedFileError(BzrError):
 
1101
    
 
1102
    _fmt = "Versioned file error"
 
1103
 
 
1104
 
 
1105
class RevisionNotPresent(VersionedFileError):
 
1106
    
 
1107
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
1108
 
 
1109
    def __init__(self, revision_id, file_id):
 
1110
        VersionedFileError.__init__(self)
 
1111
        self.revision_id = revision_id
 
1112
        self.file_id = file_id
 
1113
 
 
1114
 
 
1115
class RevisionAlreadyPresent(VersionedFileError):
 
1116
    
 
1117
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
1118
 
 
1119
    def __init__(self, revision_id, file_id):
 
1120
        VersionedFileError.__init__(self)
 
1121
        self.revision_id = revision_id
 
1122
        self.file_id = file_id
 
1123
 
 
1124
 
 
1125
class KnitError(BzrError):
 
1126
    
 
1127
    _fmt = "Knit error"
 
1128
 
 
1129
    internal_error = True
 
1130
 
 
1131
 
 
1132
class KnitHeaderError(KnitError):
 
1133
 
 
1134
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
 
1135
 
 
1136
    def __init__(self, badline, filename):
 
1137
        KnitError.__init__(self)
 
1138
        self.badline = badline
 
1139
        self.filename = filename
 
1140
 
 
1141
 
 
1142
class KnitCorrupt(KnitError):
 
1143
 
 
1144
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1145
 
 
1146
    def __init__(self, filename, how):
 
1147
        KnitError.__init__(self)
 
1148
        self.filename = filename
 
1149
        self.how = how
 
1150
 
 
1151
 
 
1152
class KnitIndexUnknownMethod(KnitError):
 
1153
    """Raised when we don't understand the storage method.
 
1154
 
 
1155
    Currently only 'fulltext' and 'line-delta' are supported.
 
1156
    """
 
1157
    
 
1158
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1159
            " in options: %(options)r")
 
1160
 
 
1161
    def __init__(self, filename, options):
 
1162
        KnitError.__init__(self)
 
1163
        self.filename = filename
 
1164
        self.options = options
 
1165
 
 
1166
 
 
1167
class NoSuchExportFormat(BzrError):
 
1168
    
 
1169
    _fmt = "Export format %(format)r not supported"
 
1170
 
 
1171
    def __init__(self, format):
 
1172
        BzrError.__init__(self)
 
1173
        self.format = format
 
1174
 
 
1175
 
 
1176
class TransportError(BzrError):
 
1177
    
 
1178
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
1179
 
 
1180
    def __init__(self, msg=None, orig_error=None):
 
1181
        if msg is None and orig_error is not None:
 
1182
            msg = str(orig_error)
 
1183
        if orig_error is None:
 
1184
            orig_error = ''
 
1185
        if msg is None:
 
1186
            msg =  ''
 
1187
        self.msg = msg
 
1188
        self.orig_error = orig_error
 
1189
        BzrError.__init__(self)
 
1190
 
 
1191
 
 
1192
class TooManyConcurrentRequests(BzrError):
 
1193
 
 
1194
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
 
1195
            " Be sure to finish_writing and finish_reading on the"
 
1196
            " current request that is open.")
 
1197
 
 
1198
    internal_error = True
 
1199
 
 
1200
    def __init__(self, medium):
 
1201
        self.medium = medium
 
1202
 
 
1203
 
 
1204
class SmartProtocolError(TransportError):
 
1205
 
 
1206
    _fmt = "Generic bzr smart protocol error: %(details)s"
 
1207
 
 
1208
    def __init__(self, details):
 
1209
        self.details = details
 
1210
 
 
1211
 
 
1212
# A set of semi-meaningful errors which can be thrown
 
1213
class TransportNotPossible(TransportError):
 
1214
 
 
1215
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
1216
 
 
1217
 
 
1218
class ConnectionError(TransportError):
 
1219
 
 
1220
    _fmt = "Connection error: %(msg)s %(orig_error)s"
 
1221
 
 
1222
 
 
1223
class SocketConnectionError(ConnectionError):
 
1224
 
 
1225
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
 
1226
 
 
1227
    def __init__(self, host, port=None, msg=None, orig_error=None):
 
1228
        if msg is None:
 
1229
            msg = 'Failed to connect to'
 
1230
        if orig_error is None:
 
1231
            orig_error = ''
 
1232
        else:
 
1233
            orig_error = '; ' + str(orig_error)
 
1234
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
 
1235
        self.host = host
 
1236
        if port is None:
 
1237
            self.port = ''
 
1238
        else:
 
1239
            self.port = ':%s' % port
 
1240
 
 
1241
 
 
1242
class ConnectionReset(TransportError):
 
1243
 
 
1244
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
1245
 
 
1246
 
 
1247
class InvalidRange(TransportError):
 
1248
 
 
1249
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
1250
    
 
1251
    def __init__(self, path, offset):
 
1252
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
1253
                                       % (path, offset)))
 
1254
        self.path = path
 
1255
        self.offset = offset
 
1256
 
 
1257
 
 
1258
class InvalidHttpResponse(TransportError):
 
1259
 
 
1260
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
1261
 
 
1262
    def __init__(self, path, msg, orig_error=None):
 
1263
        self.path = path
 
1264
        TransportError.__init__(self, msg, orig_error=orig_error)
 
1265
 
 
1266
 
 
1267
class InvalidHttpRange(InvalidHttpResponse):
 
1268
 
 
1269
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
1270
    
 
1271
    def __init__(self, path, range, msg):
 
1272
        self.range = range
 
1273
        InvalidHttpResponse.__init__(self, path, msg)
 
1274
 
 
1275
 
 
1276
class InvalidHttpContentType(InvalidHttpResponse):
 
1277
 
 
1278
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
1279
    
 
1280
    def __init__(self, path, ctype, msg):
 
1281
        self.ctype = ctype
 
1282
        InvalidHttpResponse.__init__(self, path, msg)
 
1283
 
 
1284
 
 
1285
class ConflictsInTree(BzrError):
 
1286
 
 
1287
    _fmt = "Working tree has conflicts."
 
1288
 
 
1289
 
 
1290
class ParseConfigError(BzrError):
 
1291
 
 
1292
    def __init__(self, errors, filename):
 
1293
        if filename is None:
 
1294
            filename = ""
 
1295
        message = "Error(s) parsing config file %s:\n%s" % \
 
1296
            (filename, ('\n'.join(e.message for e in errors)))
 
1297
        BzrError.__init__(self, message)
 
1298
 
 
1299
 
 
1300
class NoEmailInUsername(BzrError):
 
1301
 
 
1302
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1303
 
 
1304
    def __init__(self, username):
 
1305
        BzrError.__init__(self)
 
1306
        self.username = username
 
1307
 
 
1308
 
 
1309
class SigningFailed(BzrError):
 
1310
 
 
1311
    _fmt = "Failed to gpg sign data with command %(command_line)r"
 
1312
 
 
1313
    def __init__(self, command_line):
 
1314
        BzrError.__init__(self, command_line=command_line)
 
1315
 
 
1316
 
 
1317
class WorkingTreeNotRevision(BzrError):
 
1318
 
 
1319
    _fmt = ("The working tree for %(basedir)s has changed since" 
 
1320
            " the last commit, but weave merge requires that it be"
 
1321
            " unchanged")
 
1322
 
 
1323
    def __init__(self, tree):
 
1324
        BzrError.__init__(self, basedir=tree.basedir)
 
1325
 
 
1326
 
 
1327
class CantReprocessAndShowBase(BzrError):
 
1328
 
 
1329
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
 
1330
           "the relationship of conflicting lines to the base")
 
1331
 
 
1332
 
 
1333
class GraphCycleError(BzrError):
 
1334
 
 
1335
    _fmt = "Cycle in graph %(graph)r"
 
1336
 
 
1337
    def __init__(self, graph):
 
1338
        BzrError.__init__(self)
 
1339
        self.graph = graph
 
1340
 
 
1341
 
 
1342
class WritingCompleted(BzrError):
 
1343
 
 
1344
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
 
1345
            "called upon it - accept bytes may not be called anymore.")
 
1346
 
 
1347
    internal_error = True
 
1348
 
 
1349
    def __init__(self, request):
 
1350
        self.request = request
 
1351
 
 
1352
 
 
1353
class WritingNotComplete(BzrError):
 
1354
 
 
1355
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
 
1356
            "called upon it - until the write phase is complete no "
 
1357
            "data may be read.")
 
1358
 
 
1359
    internal_error = True
 
1360
 
 
1361
    def __init__(self, request):
 
1362
        self.request = request
 
1363
 
 
1364
 
 
1365
class NotConflicted(BzrError):
 
1366
 
 
1367
    _fmt = "File %(filename)s is not conflicted."
 
1368
 
 
1369
    def __init__(self, filename):
 
1370
        BzrError.__init__(self)
 
1371
        self.filename = filename
 
1372
 
 
1373
 
 
1374
class MediumNotConnected(BzrError):
 
1375
 
 
1376
    _fmt = """The medium '%(medium)s' is not connected."""
 
1377
 
 
1378
    internal_error = True
 
1379
 
 
1380
    def __init__(self, medium):
 
1381
        self.medium = medium
 
1382
 
 
1383
 
 
1384
class MustUseDecorated(Exception):
 
1385
 
 
1386
    _fmt = "A decorating function has requested its original command be used."
 
1387
 
 
1388
 
 
1389
class NoBundleFound(BzrError):
 
1390
 
 
1391
    _fmt = "No bundle was found in %(filename)s"
 
1392
 
 
1393
    def __init__(self, filename):
 
1394
        BzrError.__init__(self)
 
1395
        self.filename = filename
 
1396
 
 
1397
 
 
1398
class BundleNotSupported(BzrError):
 
1399
 
 
1400
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
 
1401
 
 
1402
    def __init__(self, version, msg):
 
1403
        BzrError.__init__(self)
 
1404
        self.version = version
 
1405
        self.msg = msg
 
1406
 
 
1407
 
 
1408
class MissingText(BzrError):
 
1409
 
 
1410
    _fmt = ("Branch %(base)s is missing revision"
 
1411
            " %(text_revision)s of %(file_id)s")
 
1412
 
 
1413
    def __init__(self, branch, text_revision, file_id):
 
1414
        BzrError.__init__(self)
 
1415
        self.branch = branch
 
1416
        self.base = branch.base
 
1417
        self.text_revision = text_revision
 
1418
        self.file_id = file_id
 
1419
 
 
1420
 
 
1421
class DuplicateFileId(BzrError):
 
1422
 
 
1423
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
 
1424
 
 
1425
    def __init__(self, file_id, entry):
 
1426
        BzrError.__init__(self)
 
1427
        self.file_id = file_id
 
1428
        self.entry = entry
 
1429
 
 
1430
 
 
1431
class DuplicateKey(BzrError):
 
1432
 
 
1433
    _fmt = "Key %(key)s is already present in map"
 
1434
 
 
1435
 
 
1436
class MalformedTransform(BzrError):
 
1437
 
 
1438
    _fmt = "Tree transform is malformed %(conflicts)r"
 
1439
 
 
1440
 
 
1441
class NoFinalPath(BzrError):
 
1442
 
 
1443
    _fmt = ("No final name for trans_id %(trans_id)r\n"
 
1444
            "file-id: %(file_id)r\n"
 
1445
            "root trans-id: %(root_trans_id)r\n")
 
1446
 
 
1447
    def __init__(self, trans_id, transform):
 
1448
        self.trans_id = trans_id
 
1449
        self.file_id = transform.final_file_id(trans_id)
 
1450
        self.root_trans_id = transform.root
 
1451
 
 
1452
 
 
1453
class BzrBadParameter(BzrError):
 
1454
 
 
1455
    _fmt = "Bad parameter: %(param)r"
 
1456
 
 
1457
    # This exception should never be thrown, but it is a base class for all
 
1458
    # parameter-to-function errors.
 
1459
 
 
1460
    def __init__(self, param):
 
1461
        BzrError.__init__(self)
 
1462
        self.param = param
 
1463
 
 
1464
 
 
1465
class BzrBadParameterNotUnicode(BzrBadParameter):
 
1466
 
 
1467
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
 
1468
 
 
1469
 
 
1470
class ReusingTransform(BzrError):
 
1471
 
 
1472
    _fmt = "Attempt to reuse a transform that has already been applied."
 
1473
 
 
1474
 
 
1475
class CantMoveRoot(BzrError):
 
1476
 
 
1477
    _fmt = "Moving the root directory is not supported at this time"
 
1478
 
 
1479
 
 
1480
class BzrMoveFailedError(BzrError):
 
1481
 
 
1482
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1483
 
 
1484
    def __init__(self, from_path='', to_path='', extra=None):
 
1485
        BzrError.__init__(self)
 
1486
        if extra:
 
1487
            self.extra = ': ' + str(extra)
 
1488
        else:
 
1489
            self.extra = ''
 
1490
 
 
1491
        has_from = len(from_path) > 0
 
1492
        has_to = len(to_path) > 0
 
1493
        if has_from:
 
1494
            self.from_path = osutils.splitpath(from_path)[-1]
 
1495
        else:
 
1496
            self.from_path = ''
 
1497
 
 
1498
        if has_to:
 
1499
            self.to_path = osutils.splitpath(to_path)[-1]
 
1500
        else:
 
1501
            self.to_path = ''
 
1502
 
 
1503
        self.operator = ""
 
1504
        if has_from and has_to:
 
1505
            self.operator = " =>"
 
1506
        elif has_from:
 
1507
            self.from_path = "from " + from_path
 
1508
        elif has_to:
 
1509
            self.operator = "to"
 
1510
        else:
 
1511
            self.operator = "file"
 
1512
 
 
1513
 
 
1514
class BzrRenameFailedError(BzrMoveFailedError):
 
1515
 
 
1516
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
 
1517
 
 
1518
    def __init__(self, from_path, to_path, extra=None):
 
1519
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
1520
 
 
1521
 
 
1522
class BzrBadParameterNotString(BzrBadParameter):
 
1523
 
 
1524
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
1525
 
 
1526
 
 
1527
class BzrBadParameterMissing(BzrBadParameter):
 
1528
 
 
1529
    _fmt = "Parameter $(param)s is required but not present."
 
1530
 
 
1531
 
 
1532
class BzrBadParameterUnicode(BzrBadParameter):
 
1533
 
 
1534
    _fmt = ("Parameter %(param)s is unicode but"
 
1535
            " only byte-strings are permitted.")
 
1536
 
 
1537
 
 
1538
class BzrBadParameterContainsNewline(BzrBadParameter):
 
1539
 
 
1540
    _fmt = "Parameter %(param)s contains a newline."
 
1541
 
 
1542
 
 
1543
class DependencyNotPresent(BzrError):
 
1544
 
 
1545
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1546
 
 
1547
    def __init__(self, library, error):
 
1548
        BzrError.__init__(self, library=library, error=error)
 
1549
 
 
1550
 
 
1551
class ParamikoNotPresent(DependencyNotPresent):
 
1552
 
 
1553
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
1554
 
 
1555
    def __init__(self, error):
 
1556
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
1557
 
 
1558
 
 
1559
class PointlessMerge(BzrError):
 
1560
 
 
1561
    _fmt = "Nothing to merge."
 
1562
 
 
1563
 
 
1564
class UninitializableFormat(BzrError):
 
1565
 
 
1566
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
1567
 
 
1568
    def __init__(self, format):
 
1569
        BzrError.__init__(self)
 
1570
        self.format = format
 
1571
 
 
1572
 
 
1573
class BadConversionTarget(BzrError):
 
1574
 
 
1575
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
1576
 
 
1577
    def __init__(self, problem, format):
 
1578
        BzrError.__init__(self)
 
1579
        self.problem = problem
 
1580
        self.format = format
 
1581
 
 
1582
 
 
1583
class NoDiff(BzrError):
 
1584
 
 
1585
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1586
 
 
1587
    def __init__(self, msg):
 
1588
        BzrError.__init__(self, msg=msg)
 
1589
 
 
1590
 
 
1591
class NoDiff3(BzrError):
 
1592
 
 
1593
    _fmt = "Diff3 is not installed on this machine."
 
1594
 
 
1595
 
 
1596
class ExistingLimbo(BzrError):
 
1597
 
 
1598
    _fmt = """This tree contains left-over files from a failed operation.
 
1599
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1600
    keep, and delete it when you are done."""
 
1601
    
 
1602
    def __init__(self, limbo_dir):
 
1603
       BzrError.__init__(self)
 
1604
       self.limbo_dir = limbo_dir
 
1605
 
 
1606
 
 
1607
class ImmortalLimbo(BzrError):
 
1608
 
 
1609
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
 
1610
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1611
    keep, and delete it when you are done."""
 
1612
 
 
1613
    def __init__(self, limbo_dir):
 
1614
       BzrError.__init__(self)
 
1615
       self.limbo_dir = limbo_dir
 
1616
 
 
1617
 
 
1618
class OutOfDateTree(BzrError):
 
1619
 
 
1620
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1621
 
 
1622
    def __init__(self, tree):
 
1623
        BzrError.__init__(self)
 
1624
        self.tree = tree
 
1625
 
 
1626
 
 
1627
class PublicBranchOutOfDate(BzrError):
 
1628
 
 
1629
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
 
1630
        '"%(revstring)s".'
 
1631
 
 
1632
    def __init__(self, public_location, revstring):
 
1633
        import bzrlib.urlutils as urlutils
 
1634
        public_location = urlutils.unescape_for_display(public_location,
 
1635
                                                        'ascii')
 
1636
        BzrError.__init__(self, public_location=public_location,
 
1637
                          revstring=revstring)
 
1638
 
 
1639
 
 
1640
class MergeModifiedFormatError(BzrError):
 
1641
 
 
1642
    _fmt = "Error in merge modified format"
 
1643
 
 
1644
 
 
1645
class ConflictFormatError(BzrError):
 
1646
 
 
1647
    _fmt = "Format error in conflict listings"
 
1648
 
 
1649
 
 
1650
class CorruptRepository(BzrError):
 
1651
 
 
1652
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
 
1653
            "Please run bzr reconcile on this repository.")
 
1654
 
 
1655
    def __init__(self, repo):
 
1656
        BzrError.__init__(self)
 
1657
        self.repo_path = repo.bzrdir.root_transport.base
 
1658
 
 
1659
 
 
1660
class UpgradeRequired(BzrError):
 
1661
 
 
1662
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1663
 
 
1664
    def __init__(self, path):
 
1665
        BzrError.__init__(self)
 
1666
        self.path = path
 
1667
 
 
1668
 
 
1669
class LocalRequiresBoundBranch(BzrError):
 
1670
 
 
1671
    _fmt = "Cannot perform local-only commits on unbound branches."
 
1672
 
 
1673
 
 
1674
class MissingProgressBarFinish(BzrError):
 
1675
 
 
1676
    _fmt = "A nested progress bar was not 'finished' correctly."
 
1677
 
 
1678
 
 
1679
class InvalidProgressBarType(BzrError):
 
1680
 
 
1681
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
 
1682
            " is not a supported type Select one of: %(valid_types)s")
 
1683
 
 
1684
    def __init__(self, bar_type, valid_types):
 
1685
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1686
 
 
1687
 
 
1688
class UnsupportedOperation(BzrError):
 
1689
 
 
1690
    _fmt = ("The method %(mname)s is not supported on"
 
1691
            " objects of type %(tname)s.")
 
1692
 
 
1693
    def __init__(self, method, method_self):
 
1694
        self.method = method
 
1695
        self.mname = method.__name__
 
1696
        self.tname = type(method_self).__name__
 
1697
 
 
1698
 
 
1699
class CannotSetRevisionId(UnsupportedOperation):
 
1700
    """Raised when a commit is attempting to set a revision id but cant."""
 
1701
 
 
1702
 
 
1703
class NonAsciiRevisionId(UnsupportedOperation):
 
1704
    """Raised when a commit is attempting to set a non-ascii revision id
 
1705
       but cant.
 
1706
    """
 
1707
 
 
1708
 
 
1709
class BinaryFile(BzrError):
 
1710
    
 
1711
    _fmt = "File is binary but should be text."
 
1712
 
 
1713
 
 
1714
class IllegalPath(BzrError):
 
1715
 
 
1716
    _fmt = "The path %(path)s is not permitted on this platform"
 
1717
 
 
1718
    def __init__(self, path):
 
1719
        BzrError.__init__(self)
 
1720
        self.path = path
 
1721
 
 
1722
 
 
1723
class TestamentMismatch(BzrError):
 
1724
 
 
1725
    _fmt = """Testament did not match expected value.
 
1726
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
 
1727
       {%(measured)s}"""
 
1728
 
 
1729
    def __init__(self, revision_id, expected, measured):
 
1730
        self.revision_id = revision_id
 
1731
        self.expected = expected
 
1732
        self.measured = measured
 
1733
 
 
1734
 
 
1735
class NotABundle(BzrError):
 
1736
    
 
1737
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1738
 
 
1739
    def __init__(self, text):
 
1740
        BzrError.__init__(self)
 
1741
        self.text = text
 
1742
 
 
1743
 
 
1744
class BadBundle(BzrError): 
 
1745
    
 
1746
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1747
 
 
1748
    def __init__(self, text):
 
1749
        BzrError.__init__(self)
 
1750
        self.text = text
 
1751
 
 
1752
 
 
1753
class MalformedHeader(BadBundle): 
 
1754
    
 
1755
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1756
 
 
1757
 
 
1758
class MalformedPatches(BadBundle): 
 
1759
    
 
1760
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1761
 
 
1762
 
 
1763
class MalformedFooter(BadBundle): 
 
1764
    
 
1765
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1766
 
 
1767
 
 
1768
class UnsupportedEOLMarker(BadBundle):
 
1769
    
 
1770
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1771
 
 
1772
    def __init__(self):
 
1773
        # XXX: BadBundle's constructor assumes there's explanatory text, 
 
1774
        # but for this there is not
 
1775
        BzrError.__init__(self)
 
1776
 
 
1777
 
 
1778
class IncompatibleBundleFormat(BzrError):
 
1779
    
 
1780
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
 
1781
 
 
1782
    def __init__(self, bundle_format, other):
 
1783
        BzrError.__init__(self)
 
1784
        self.bundle_format = bundle_format
 
1785
        self.other = other
 
1786
 
 
1787
 
 
1788
class BadInventoryFormat(BzrError):
 
1789
    
 
1790
    _fmt = "Root class for inventory serialization errors"
 
1791
 
 
1792
 
 
1793
class UnexpectedInventoryFormat(BadInventoryFormat):
 
1794
 
 
1795
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1796
 
 
1797
    def __init__(self, msg):
 
1798
        BadInventoryFormat.__init__(self, msg=msg)
 
1799
 
 
1800
 
 
1801
class RootNotRich(BzrError):
 
1802
 
 
1803
    _fmt = """This operation requires rich root data storage"""
 
1804
 
 
1805
 
 
1806
class NoSmartMedium(BzrError):
 
1807
 
 
1808
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
 
1809
 
 
1810
    internal_error = True
 
1811
 
 
1812
    def __init__(self, transport):
 
1813
        self.transport = transport
 
1814
 
 
1815
 
 
1816
class NoSmartServer(NotBranchError):
 
1817
 
 
1818
    _fmt = "No smart server available at %(url)s"
 
1819
 
 
1820
    def __init__(self, url):
 
1821
        self.url = url
 
1822
 
 
1823
 
 
1824
class UnknownSSH(BzrError):
 
1825
 
 
1826
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1827
 
 
1828
    def __init__(self, vendor):
 
1829
        BzrError.__init__(self)
 
1830
        self.vendor = vendor
 
1831
 
 
1832
 
 
1833
class SSHVendorNotFound(BzrError):
 
1834
 
 
1835
    _fmt = ("Don't know how to handle SSH connections."
 
1836
            " Please set BZR_SSH environment variable.")
 
1837
 
 
1838
 
 
1839
class GhostRevisionUnusableHere(BzrError):
 
1840
 
 
1841
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1842
 
 
1843
    def __init__(self, revision_id):
 
1844
        BzrError.__init__(self)
 
1845
        self.revision_id = revision_id
 
1846
 
 
1847
 
 
1848
class IllegalUseOfScopeReplacer(BzrError):
 
1849
 
 
1850
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
 
1851
            " %(msg)s%(extra)s")
 
1852
 
 
1853
    internal_error = True
 
1854
 
 
1855
    def __init__(self, name, msg, extra=None):
 
1856
        BzrError.__init__(self)
 
1857
        self.name = name
 
1858
        self.msg = msg
 
1859
        if extra:
 
1860
            self.extra = ': ' + str(extra)
 
1861
        else:
 
1862
            self.extra = ''
 
1863
 
 
1864
 
 
1865
class InvalidImportLine(BzrError):
 
1866
 
 
1867
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
 
1868
 
 
1869
    internal_error = True
 
1870
 
 
1871
    def __init__(self, text, msg):
 
1872
        BzrError.__init__(self)
 
1873
        self.text = text
 
1874
        self.msg = msg
 
1875
 
 
1876
 
 
1877
class ImportNameCollision(BzrError):
 
1878
 
 
1879
    _fmt = ("Tried to import an object to the same name as"
 
1880
            " an existing object. %(name)s")
 
1881
 
 
1882
    internal_error = True
 
1883
 
 
1884
    def __init__(self, name):
 
1885
        BzrError.__init__(self)
 
1886
        self.name = name
 
1887
 
 
1888
 
 
1889
class NotAMergeDirective(BzrError):
 
1890
    """File starting with %(firstline)r is not a merge directive"""
 
1891
    def __init__(self, firstline):
 
1892
        BzrError.__init__(self, firstline=firstline)
 
1893
 
 
1894
 
 
1895
class NoMergeSource(BzrError):
 
1896
    """Raise if no merge source was specified for a merge directive"""
 
1897
 
 
1898
    _fmt = "A merge directive must provide either a bundle or a public"\
 
1899
        " branch location."
 
1900
 
 
1901
 
 
1902
class PatchMissing(BzrError):
 
1903
    """Raise a patch type was specified but no patch supplied"""
 
1904
 
 
1905
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
 
1906
 
 
1907
    def __init__(self, patch_type):
 
1908
        BzrError.__init__(self)
 
1909
        self.patch_type = patch_type
 
1910
 
 
1911
 
 
1912
class UnsupportedInventoryKind(BzrError):
 
1913
    
 
1914
    _fmt = """Unsupported entry kind %(kind)s"""
 
1915
 
 
1916
    def __init__(self, kind):
 
1917
        self.kind = kind
 
1918
 
 
1919
 
 
1920
class BadSubsumeSource(BzrError):
 
1921
 
 
1922
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
 
1923
 
 
1924
    def __init__(self, tree, other_tree, reason):
 
1925
        self.tree = tree
 
1926
        self.other_tree = other_tree
 
1927
        self.reason = reason
 
1928
 
 
1929
 
 
1930
class SubsumeTargetNeedsUpgrade(BzrError):
 
1931
    
 
1932
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
 
1933
 
 
1934
    def __init__(self, other_tree):
 
1935
        self.other_tree = other_tree
 
1936
 
 
1937
 
 
1938
class BadReferenceTarget(BzrError):
 
1939
 
 
1940
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
 
1941
 
 
1942
    internal_error = True
 
1943
 
 
1944
    def __init__(self, tree, other_tree, reason):
 
1945
        self.tree = tree
 
1946
        self.other_tree = other_tree
 
1947
        self.reason = reason
 
1948
 
 
1949
 
 
1950
class NoSuchTag(BzrError):
 
1951
 
 
1952
    _fmt = "No such tag: %(tag_name)s"
 
1953
 
 
1954
    def __init__(self, tag_name):
 
1955
        self.tag_name = tag_name
 
1956
 
 
1957
 
 
1958
class TagsNotSupported(BzrError):
 
1959
 
 
1960
    _fmt = ("Tags not supported by %(branch)s;"
 
1961
            " you may be able to use bzr upgrade.")
 
1962
 
 
1963
    def __init__(self, branch):
 
1964
        self.branch = branch
 
1965
 
 
1966
        
 
1967
class TagAlreadyExists(BzrError):
 
1968
 
 
1969
    _fmt = "Tag %(tag_name)s already exists."
 
1970
 
 
1971
    def __init__(self, tag_name):
 
1972
        self.tag_name = tag_name