/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: Aaron Bentley
  • Date: 2007-03-12 13:31:42 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2342.
  • Revision ID: abentley@panoramicfeedback.com-20070312133142-ox3xn8jpns33gqd7
speling fix

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