/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: Andrew Bennetts
  • Date: 2007-03-30 01:46:31 UTC
  • mto: (2018.18.6 hpss-faster-copy)
  • mto: This revision was merged to the branch mainline in revision 2435.
  • Revision ID: andrew.bennetts@canonical.com-20070330014631-a3xragco77jx67pv
Fix the TooManyConcurrentRequests error message.

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