~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

Deprecate compare_trees and move its body to InterTree.changes_from.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
21
 
 
22
 
 
23
 
######################################################################
24
 
# exceptions 
 
17
"""Exceptions for bzr, and reporting of them.
 
18
 
 
19
There are 3 different classes of error:
 
20
 
 
21
 * KeyboardInterrupt, and OSError with EPIPE - the program terminates 
 
22
   with an appropriate short message
 
23
 
 
24
 * User errors, indicating a problem caused by the user such as a bad URL.
 
25
   These are printed in a short form.
 
26
 
 
27
 * Internal unexpected errors, including most Python builtin errors
 
28
   and some raised from inside bzr.  These are printed with a full 
 
29
   traceback and an invitation to report the bug.
 
30
 
 
31
Exceptions are caught at a high level to report errors to the user, and
 
32
might also be caught inside the program.  Therefore it needs to be
 
33
possible to convert them to a meaningful string, and also for them to be
 
34
interrogated by the program.
 
35
 
 
36
Exceptions are defined such that the arguments given to the constructor
 
37
are stored in the object as properties of the same name.  When the
 
38
object is printed as a string, the doc string of the class is used as
 
39
a format string with the property dictionary available to it.
 
40
 
 
41
This means that exceptions can used like this:
 
42
 
 
43
>>> import sys
 
44
>>> try:
 
45
...   raise NotBranchError(path='/foo/bar')
 
46
... except:
 
47
...   print sys.exc_type
 
48
...   print sys.exc_value
 
49
...   path = getattr(sys.exc_value, 'path', None)
 
50
...   if path is not None:
 
51
...     print path
 
52
bzrlib.errors.NotBranchError
 
53
Not a branch: /foo/bar
 
54
/foo/bar
 
55
 
 
56
Therefore:
 
57
 
 
58
 * create a new exception class for any class of error that can be
 
59
   usefully distinguished.  If no callers are likely to want to catch
 
60
   one but not another, don't worry about them.
 
61
 
 
62
 * the __str__ method should generate something useful; BzrError provides
 
63
   a good default implementation
 
64
 
 
65
Exception strings should start with a capital letter and should not have a
 
66
final fullstop.
 
67
"""
 
68
 
 
69
from warnings import warn
 
70
 
 
71
from bzrlib.patches import (PatchSyntax, 
 
72
                            PatchConflict, 
 
73
                            MalformedPatchHeader,
 
74
                            MalformedHunkHeader,
 
75
                            MalformedLine,)
 
76
 
 
77
 
 
78
# based on Scott James Remnant's hct error classes
 
79
 
 
80
# TODO: is there any value in providing the .args field used by standard
 
81
# python exceptions?   A list of values with no names seems less useful 
 
82
# to me.
 
83
 
 
84
# TODO: Perhaps convert the exception to a string at the moment it's 
 
85
# constructed to make sure it will succeed.  But that says nothing about
 
86
# exceptions that are never raised.
 
87
 
 
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
89
# the old one.
 
90
 
 
91
# TODO: The pattern (from hct) of using classes docstrings as message
 
92
# templates is cute but maybe not such a great idea - perhaps should have a
 
93
# separate static message_template.
 
94
 
 
95
 
25
96
class BzrError(StandardError):
26
 
    pass
27
 
 
28
 
class BzrCheckError(BzrError):
29
 
    pass
30
 
 
31
 
 
32
 
class BzrCommandError(BzrError):
33
 
    # Error from malformed user command
34
 
    pass
35
 
 
36
 
 
37
 
def bailout(msg, explanation=[]):
38
 
    ex = BzrError(msg, explanation)
39
 
    import trace
40
 
    trace._tracefile.write('* raising %s\n' % ex)
41
 
    raise ex
42
 
 
 
97
    
 
98
    is_user_error = True
 
99
    
 
100
    def __str__(self):
 
101
        # XXX: Should we show the exception class in 
 
102
        # exceptions that don't provide their own message?  
 
103
        # maybe it should be done at a higher level
 
104
        ## n = self.__class__.__name__ + ': '
 
105
        n = ''
 
106
        if len(self.args) == 1:
 
107
            return str(self.args[0])
 
108
        elif len(self.args) == 2:
 
109
            # further explanation or suggestions
 
110
            try:
 
111
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
112
            except TypeError:
 
113
                return n + "%r" % self
 
114
        else:
 
115
            return n + `self.args`
 
116
 
 
117
 
 
118
class BzrNewError(BzrError):
 
119
    """bzr error"""
 
120
    # base classes should override the docstring with their human-
 
121
    # readable explanation
 
122
 
 
123
    def __init__(self, **kwds):
 
124
        for key, value in kwds.items():
 
125
            setattr(self, key, value)
 
126
 
 
127
    def __str__(self):
 
128
        try:
 
129
            return self.__doc__ % self.__dict__
 
130
        except (NameError, ValueError, KeyError), e:
 
131
            return 'Unprintable exception %s: %s' \
 
132
                % (self.__class__.__name__, str(e))
 
133
 
 
134
 
 
135
class BzrCheckError(BzrNewError):
 
136
    """Internal check failed: %(message)s"""
 
137
 
 
138
    is_user_error = False
 
139
 
 
140
    def __init__(self, message):
 
141
        BzrNewError.__init__(self)
 
142
        self.message = message
 
143
 
 
144
 
 
145
class InvalidEntryName(BzrNewError):
 
146
    """Invalid entry name: %(name)s"""
 
147
 
 
148
    is_user_error = False
 
149
 
 
150
    def __init__(self, name):
 
151
        BzrNewError.__init__(self)
 
152
        self.name = name
 
153
 
 
154
 
 
155
class InvalidRevisionNumber(BzrNewError):
 
156
    """Invalid revision number %(revno)d"""
 
157
    def __init__(self, revno):
 
158
        BzrNewError.__init__(self)
 
159
        self.revno = revno
 
160
 
 
161
 
 
162
class InvalidRevisionId(BzrNewError):
 
163
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
164
    def __init__(self, revision_id, branch):
 
165
        # branch can be any string or object with __str__ defined
 
166
        BzrNewError.__init__(self)
 
167
        self.revision_id = revision_id
 
168
        self.branch = branch
 
169
 
 
170
 
 
171
class NoWorkingTree(BzrNewError):
 
172
    """No WorkingTree exists for %(base)s."""
 
173
    
 
174
    def __init__(self, base):
 
175
        BzrNewError.__init__(self)
 
176
        self.base = base
 
177
 
 
178
 
 
179
class NotLocalUrl(BzrNewError):
 
180
    """%(url)s is not a local path."""
 
181
    
 
182
    def __init__(self, url):
 
183
        BzrNewError.__init__(self)
 
184
        self.url = url
 
185
 
 
186
 
 
187
class BzrCommandError(BzrNewError):
 
188
    """Error from user command"""
 
189
 
 
190
    is_user_error = True
 
191
 
 
192
    # Error from malformed user command; please avoid raising this as a
 
193
    # generic exception not caused by user input.
 
194
    #
 
195
    # I think it's a waste of effort to differentiate between errors that
 
196
    # are not intended to be caught anyway.  UI code need not subclass
 
197
    # BzrCommandError, and non-UI code should not throw a subclass of
 
198
    # BzrCommandError.  ADHB 20051211
 
199
    def __init__(self, msg):
 
200
        self.msg = msg
 
201
 
 
202
    def __str__(self):
 
203
        return self.msg
 
204
 
 
205
 
 
206
class BzrOptionError(BzrCommandError):
 
207
    """Error in command line options"""
 
208
 
 
209
    
 
210
class StrictCommitFailed(BzrNewError):
 
211
    """Commit refused because there are unknown files in the tree"""
 
212
 
 
213
 
 
214
# XXX: Should be unified with TransportError; they seem to represent the
 
215
# same thing
 
216
class PathError(BzrNewError):
 
217
    """Generic path error: %(path)r%(extra)s)"""
 
218
 
 
219
    def __init__(self, path, extra=None):
 
220
        BzrNewError.__init__(self)
 
221
        self.path = path
 
222
        if extra:
 
223
            self.extra = ': ' + str(extra)
 
224
        else:
 
225
            self.extra = ''
 
226
 
 
227
 
 
228
class NoSuchFile(PathError):
 
229
    """No such file: %(path)r%(extra)s"""
 
230
 
 
231
 
 
232
class FileExists(PathError):
 
233
    """File exists: %(path)r%(extra)s"""
 
234
 
 
235
 
 
236
class DirectoryNotEmpty(PathError):
 
237
    """Directory not empty: %(path)r%(extra)s"""
 
238
 
 
239
 
 
240
class ResourceBusy(PathError):
 
241
    """Device or resource busy: %(path)r%(extra)s"""
 
242
 
 
243
 
 
244
class PermissionDenied(PathError):
 
245
    """Permission denied: %(path)r%(extra)s"""
 
246
 
 
247
 
 
248
class InvalidURL(PathError):
 
249
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
250
 
 
251
 
 
252
class InvalidURLJoin(PathError):
 
253
    """Invalid URL join request: %(args)s%(extra)s"""
 
254
 
 
255
    def __init__(self, msg, base, args):
 
256
        PathError.__init__(self, base, msg)
 
257
        self.args = [base]
 
258
        self.args.extend(args)
 
259
 
 
260
 
 
261
class UnsupportedProtocol(PathError):
 
262
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
263
 
 
264
    def __init__(self, url, extra):
 
265
        PathError.__init__(self, url, extra=extra)
 
266
 
 
267
 
 
268
class PathNotChild(BzrNewError):
 
269
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
270
 
 
271
    is_user_error = False
 
272
 
 
273
    def __init__(self, path, base, extra=None):
 
274
        BzrNewError.__init__(self)
 
275
        self.path = path
 
276
        self.base = base
 
277
        if extra:
 
278
            self.extra = ': ' + str(extra)
 
279
        else:
 
280
            self.extra = ''
 
281
 
 
282
 
 
283
class InvalidNormalization(PathError):
 
284
    """Path %(path)r is not unicode normalized"""
 
285
 
 
286
 
 
287
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
288
# the exception object is a bit undesirable.
 
289
# TODO: Probably this behavior of should be a common superclass 
 
290
class NotBranchError(PathError):
 
291
    """Not a branch: %(path)s"""
 
292
 
 
293
    def __init__(self, path):
 
294
       import bzrlib.urlutils as urlutils
 
295
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
296
 
 
297
 
 
298
class AlreadyBranchError(PathError):
 
299
    """Already a branch: %(path)s."""
 
300
 
 
301
 
 
302
class BranchExistsWithoutWorkingTree(PathError):
 
303
    """Directory contains a branch, but no working tree \
 
304
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
305
 
 
306
 
 
307
class NoRepositoryPresent(BzrNewError):
 
308
    """No repository present: %(path)r"""
 
309
    def __init__(self, bzrdir):
 
310
        BzrNewError.__init__(self)
 
311
        self.path = bzrdir.transport.clone('..').base
 
312
 
 
313
 
 
314
class FileInWrongBranch(BzrNewError):
 
315
    """File %(path)s in not in branch %(branch_base)s."""
 
316
 
 
317
    def __init__(self, branch, path):
 
318
        BzrNewError.__init__(self)
 
319
        self.branch = branch
 
320
        self.branch_base = branch.base
 
321
        self.path = path
 
322
 
 
323
 
 
324
class UnsupportedFormatError(BzrNewError):
 
325
    """Unsupported branch format: %(format)s"""
 
326
 
 
327
 
 
328
class UnknownFormatError(BzrNewError):
 
329
    """Unknown branch format: %(format)r"""
 
330
 
 
331
 
 
332
class IncompatibleFormat(BzrNewError):
 
333
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
334
 
 
335
    def __init__(self, format, bzrdir_format):
 
336
        BzrNewError.__init__(self)
 
337
        self.format = format
 
338
        self.bzrdir = bzrdir_format
 
339
 
 
340
 
 
341
class NotVersionedError(BzrNewError):
 
342
    """%(path)s is not versioned"""
 
343
    def __init__(self, path):
 
344
        BzrNewError.__init__(self)
 
345
        self.path = path
 
346
 
 
347
 
 
348
class PathsNotVersionedError(BzrNewError):
 
349
    # used when reporting several paths are not versioned
 
350
    """Path(s) are not versioned: %(paths_as_string)s"""
 
351
 
 
352
    def __init__(self, paths):
 
353
        from bzrlib.osutils import quotefn
 
354
        BzrNewError.__init__(self)
 
355
        self.paths = paths
 
356
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
357
 
 
358
 
 
359
class PathsDoNotExist(BzrNewError):
 
360
    """Path(s) do not exist: %(paths_as_string)s"""
 
361
 
 
362
    # used when reporting that paths are neither versioned nor in the working
 
363
    # tree
 
364
 
 
365
    def __init__(self, paths):
 
366
        # circular import
 
367
        from bzrlib.osutils import quotefn
 
368
        BzrNewError.__init__(self)
 
369
        self.paths = paths
 
370
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
371
 
 
372
 
 
373
class BadFileKindError(BzrNewError):
 
374
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
375
 
 
376
 
 
377
class ForbiddenControlFileError(BzrNewError):
 
378
    """Cannot operate on %(filename)s because it is a control file"""
 
379
 
 
380
 
 
381
class LockError(BzrNewError):
 
382
    """Lock error: %(message)s"""
 
383
    # All exceptions from the lock/unlock functions should be from
 
384
    # this exception class.  They will be translated as necessary. The
 
385
    # original exception is available as e.original_error
 
386
    #
 
387
    # New code should prefer to raise specific subclasses
 
388
    def __init__(self, message):
 
389
        self.message = message
 
390
 
 
391
 
 
392
class CommitNotPossible(LockError):
 
393
    """A commit was attempted but we do not have a write lock open."""
 
394
    def __init__(self):
 
395
        pass
 
396
 
 
397
 
 
398
class AlreadyCommitted(LockError):
 
399
    """A rollback was requested, but is not able to be accomplished."""
 
400
    def __init__(self):
 
401
        pass
 
402
 
 
403
 
 
404
class ReadOnlyError(LockError):
 
405
    """A write attempt was made in a read only transaction on %(obj)s"""
 
406
    def __init__(self, obj):
 
407
        self.obj = obj
 
408
 
 
409
 
 
410
class OutSideTransaction(BzrNewError):
 
411
    """A transaction related operation was attempted after the transaction finished."""
 
412
 
 
413
 
 
414
class ObjectNotLocked(LockError):
 
415
    """%(obj)r is not locked"""
 
416
 
 
417
    is_user_error = False
 
418
 
 
419
    # this can indicate that any particular object is not locked; see also
 
420
    # LockNotHeld which means that a particular *lock* object is not held by
 
421
    # the caller -- perhaps they should be unified.
 
422
    def __init__(self, obj):
 
423
        self.obj = obj
 
424
 
 
425
 
 
426
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
427
    """Cannot change object %(obj)r in read only transaction"""
 
428
    def __init__(self, obj):
 
429
        self.obj = obj
 
430
 
 
431
 
 
432
class UnlockableTransport(LockError):
 
433
    """Cannot lock: transport is read only: %(transport)s"""
 
434
    def __init__(self, transport):
 
435
        self.transport = transport
 
436
 
 
437
 
 
438
class LockContention(LockError):
 
439
    """Could not acquire lock %(lock)s"""
 
440
    # TODO: show full url for lock, combining the transport and relative bits?
 
441
    def __init__(self, lock):
 
442
        self.lock = lock
 
443
 
 
444
 
 
445
class LockBroken(LockError):
 
446
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
447
    def __init__(self, lock):
 
448
        self.lock = lock
 
449
 
 
450
 
 
451
class LockBreakMismatch(LockError):
 
452
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
453
    def __init__(self, lock, holder, target):
 
454
        self.lock = lock
 
455
        self.holder = holder
 
456
        self.target = target
 
457
 
 
458
 
 
459
class LockNotHeld(LockError):
 
460
    """Lock not held: %(lock)s"""
 
461
    def __init__(self, lock):
 
462
        self.lock = lock
 
463
 
 
464
 
 
465
class PointlessCommit(BzrNewError):
 
466
    """No changes to commit"""
 
467
 
 
468
 
 
469
class UpgradeReadonly(BzrNewError):
 
470
    """Upgrade URL cannot work with readonly URL's."""
 
471
 
 
472
 
 
473
class UpToDateFormat(BzrNewError):
 
474
    """The branch format %(format)s is already at the most recent format."""
 
475
 
 
476
    def __init__(self, format):
 
477
        BzrNewError.__init__(self)
 
478
        self.format = format
 
479
 
 
480
 
 
481
 
 
482
class StrictCommitFailed(Exception):
 
483
    """Commit refused because there are unknowns in the tree."""
 
484
 
 
485
 
 
486
class NoSuchRevision(BzrNewError):
 
487
    """Branch %(branch)s has no revision %(revision)s"""
 
488
 
 
489
    is_user_error = False
 
490
 
 
491
    def __init__(self, branch, revision):
 
492
        self.branch = branch
 
493
        self.revision = revision
 
494
 
 
495
 
 
496
class HistoryMissing(BzrError):
 
497
    def __init__(self, branch, object_type, object_id):
 
498
        self.branch = branch
 
499
        BzrError.__init__(self,
 
500
                          '%s is missing %s {%s}'
 
501
                          % (branch, object_type, object_id))
 
502
 
 
503
 
 
504
class DivergedBranches(BzrNewError):
 
505
    "These branches have diverged.  Use the merge command to reconcile them."""
 
506
 
 
507
    is_user_error = True
 
508
 
 
509
    def __init__(self, branch1, branch2):
 
510
        self.branch1 = branch1
 
511
        self.branch2 = branch2
 
512
 
 
513
 
 
514
class UnrelatedBranches(BzrNewError):
 
515
    "Branches have no common ancestor, and no merge base revision was specified."
 
516
 
 
517
    is_user_error = True
 
518
 
 
519
 
 
520
class NoCommonAncestor(BzrNewError):
 
521
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
522
 
 
523
    def __init__(self, revision_a, revision_b):
 
524
        self.revision_a = revision_a
 
525
        self.revision_b = revision_b
 
526
 
 
527
 
 
528
class NoCommonRoot(BzrError):
 
529
    def __init__(self, revision_a, revision_b):
 
530
        msg = "Revisions are not derived from the same root: %s %s." \
 
531
            % (revision_a, revision_b) 
 
532
        BzrError.__init__(self, msg)
 
533
 
 
534
 
 
535
 
 
536
class NotAncestor(BzrError):
 
537
    def __init__(self, rev_id, not_ancestor_id):
 
538
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
539
                                                        rev_id)
 
540
        BzrError.__init__(self, msg)
 
541
        self.rev_id = rev_id
 
542
        self.not_ancestor_id = not_ancestor_id
 
543
 
 
544
 
 
545
class InstallFailed(BzrError):
 
546
    def __init__(self, revisions):
 
547
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
548
        BzrError.__init__(self, msg)
 
549
        self.revisions = revisions
 
550
 
 
551
 
 
552
class AmbiguousBase(BzrError):
 
553
    def __init__(self, bases):
 
554
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
555
                DeprecationWarning)
 
556
        msg = "The correct base is unclear, because %s are all equally close" %\
 
557
            ", ".join(bases)
 
558
        BzrError.__init__(self, msg)
 
559
        self.bases = bases
 
560
 
 
561
 
 
562
class NoCommits(BzrError):
 
563
    def __init__(self, branch):
 
564
        msg = "Branch %s has no commits." % branch
 
565
        BzrError.__init__(self, msg)
 
566
 
 
567
 
 
568
class UnlistableStore(BzrError):
 
569
    def __init__(self, store):
 
570
        BzrError.__init__(self, "Store %s is not listable" % store)
 
571
 
 
572
 
 
573
 
 
574
class UnlistableBranch(BzrError):
 
575
    def __init__(self, br):
 
576
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
577
 
 
578
 
 
579
class BoundBranchOutOfDate(BzrNewError):
 
580
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
581
    def __init__(self, branch, master):
 
582
        BzrNewError.__init__(self)
 
583
        self.branch = branch
 
584
        self.master = master
 
585
 
 
586
        
 
587
class CommitToDoubleBoundBranch(BzrNewError):
 
588
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
589
    def __init__(self, branch, master, remote):
 
590
        BzrNewError.__init__(self)
 
591
        self.branch = branch
 
592
        self.master = master
 
593
        self.remote = remote
 
594
 
 
595
 
 
596
class OverwriteBoundBranch(BzrNewError):
 
597
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
598
    def __init__(self, branch):
 
599
        BzrNewError.__init__(self)
 
600
        self.branch = branch
 
601
 
 
602
 
 
603
class BoundBranchConnectionFailure(BzrNewError):
 
604
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
605
    def __init__(self, branch, target, error):
 
606
        BzrNewError.__init__(self)
 
607
        self.branch = branch
 
608
        self.target = target
 
609
        self.error = error
 
610
 
 
611
 
 
612
class WeaveError(BzrNewError):
 
613
    """Error in processing weave: %(message)s"""
 
614
 
 
615
    def __init__(self, message=None):
 
616
        BzrNewError.__init__(self)
 
617
        self.message = message
 
618
 
 
619
 
 
620
class WeaveRevisionAlreadyPresent(WeaveError):
 
621
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
622
    def __init__(self, revision_id, weave):
 
623
 
 
624
        WeaveError.__init__(self)
 
625
        self.revision_id = revision_id
 
626
        self.weave = weave
 
627
 
 
628
 
 
629
class WeaveRevisionNotPresent(WeaveError):
 
630
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
631
 
 
632
    def __init__(self, revision_id, weave):
 
633
        WeaveError.__init__(self)
 
634
        self.revision_id = revision_id
 
635
        self.weave = weave
 
636
 
 
637
 
 
638
class WeaveFormatError(WeaveError):
 
639
    """Weave invariant violated: %(what)s"""
 
640
 
 
641
    def __init__(self, what):
 
642
        WeaveError.__init__(self)
 
643
        self.what = what
 
644
 
 
645
 
 
646
class WeaveParentMismatch(WeaveError):
 
647
    """Parents are mismatched between two revisions."""
 
648
    
 
649
 
 
650
class WeaveInvalidChecksum(WeaveError):
 
651
    """Text did not match it's checksum: %(message)s"""
 
652
 
 
653
 
 
654
class WeaveTextDiffers(WeaveError):
 
655
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
656
 
 
657
    def __init__(self, revision_id, weave_a, weave_b):
 
658
        WeaveError.__init__(self)
 
659
        self.revision_id = revision_id
 
660
        self.weave_a = weave_a
 
661
        self.weave_b = weave_b
 
662
 
 
663
 
 
664
class WeaveTextDiffers(WeaveError):
 
665
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
666
 
 
667
    def __init__(self, revision_id, weave_a, weave_b):
 
668
        WeaveError.__init__(self)
 
669
        self.revision_id = revision_id
 
670
        self.weave_a = weave_a
 
671
        self.weave_b = weave_b
 
672
 
 
673
 
 
674
class VersionedFileError(BzrNewError):
 
675
    """Versioned file error."""
 
676
 
 
677
 
 
678
class RevisionNotPresent(VersionedFileError):
 
679
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
680
 
 
681
    def __init__(self, revision_id, file_id):
 
682
        VersionedFileError.__init__(self)
 
683
        self.revision_id = revision_id
 
684
        self.file_id = file_id
 
685
 
 
686
 
 
687
class RevisionAlreadyPresent(VersionedFileError):
 
688
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
689
 
 
690
    def __init__(self, revision_id, file_id):
 
691
        VersionedFileError.__init__(self)
 
692
        self.revision_id = revision_id
 
693
        self.file_id = file_id
 
694
 
 
695
 
 
696
class KnitError(BzrNewError):
 
697
    """Knit error"""
 
698
 
 
699
 
 
700
class KnitHeaderError(KnitError):
 
701
    """Knit header error: %(badline)r unexpected"""
 
702
 
 
703
    def __init__(self, badline):
 
704
        KnitError.__init__(self)
 
705
        self.badline = badline
 
706
 
 
707
 
 
708
class KnitCorrupt(KnitError):
 
709
    """Knit %(filename)s corrupt: %(how)s"""
 
710
 
 
711
    def __init__(self, filename, how):
 
712
        KnitError.__init__(self)
 
713
        self.filename = filename
 
714
        self.how = how
 
715
 
 
716
 
 
717
class NoSuchExportFormat(BzrNewError):
 
718
    """Export format %(format)r not supported"""
 
719
    def __init__(self, format):
 
720
        BzrNewError.__init__(self)
 
721
        self.format = format
 
722
 
 
723
 
 
724
class TransportError(BzrNewError):
 
725
    """Transport error: %(msg)s %(orig_error)s"""
 
726
 
 
727
    def __init__(self, msg=None, orig_error=None):
 
728
        if msg is None and orig_error is not None:
 
729
            msg = str(orig_error)
 
730
        if orig_error is None:
 
731
            orig_error = ''
 
732
        if msg is None:
 
733
            msg =  ''
 
734
        self.msg = msg
 
735
        self.orig_error = orig_error
 
736
        BzrNewError.__init__(self)
 
737
 
 
738
 
 
739
# A set of semi-meaningful errors which can be thrown
 
740
class TransportNotPossible(TransportError):
 
741
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
742
 
 
743
 
 
744
class ConnectionError(TransportError):
 
745
    """Connection error: %(msg)s %(orig_error)s"""
 
746
 
 
747
 
 
748
class ConnectionReset(TransportError):
 
749
    """Connection closed: %(msg)s %(orig_error)s"""
 
750
 
 
751
 
 
752
class InvalidRange(TransportError):
 
753
    """Invalid range access."""
 
754
    
 
755
    def __init__(self, path, offset):
 
756
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
757
                                       % (path, offset)))
 
758
 
 
759
 
 
760
class InvalidHttpResponse(TransportError):
 
761
    """Invalid http response for %(path)s: %(msg)s"""
 
762
 
 
763
    def __init__(self, path, msg, orig_error=None):
 
764
        self.path = path
 
765
        TransportError.__init__(self, msg, orig_error=orig_error)
 
766
 
 
767
 
 
768
class InvalidHttpRange(InvalidHttpResponse):
 
769
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
770
    
 
771
    def __init__(self, path, range, msg):
 
772
        self.range = range
 
773
        InvalidHttpResponse.__init__(self, path, msg)
 
774
 
 
775
 
 
776
class InvalidHttpContentType(InvalidHttpResponse):
 
777
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
778
    
 
779
    def __init__(self, path, ctype, msg):
 
780
        self.ctype = ctype
 
781
        InvalidHttpResponse.__init__(self, path, msg)
 
782
 
 
783
 
 
784
class ConflictsInTree(BzrError):
 
785
    def __init__(self):
 
786
        BzrError.__init__(self, "Working tree has conflicts.")
 
787
 
 
788
 
 
789
class ParseConfigError(BzrError):
 
790
    def __init__(self, errors, filename):
 
791
        if filename is None:
 
792
            filename = ""
 
793
        message = "Error(s) parsing config file %s:\n%s" % \
 
794
            (filename, ('\n'.join(e.message for e in errors)))
 
795
        BzrError.__init__(self, message)
 
796
 
 
797
 
 
798
class SigningFailed(BzrError):
 
799
    def __init__(self, command_line):
 
800
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
801
                               % command_line)
 
802
 
 
803
 
 
804
class WorkingTreeNotRevision(BzrError):
 
805
    def __init__(self, tree):
 
806
        BzrError.__init__(self, "The working tree for %s has changed since"
 
807
                          " last commit, but weave merge requires that it be"
 
808
                          " unchanged." % tree.basedir)
 
809
 
 
810
 
 
811
class CantReprocessAndShowBase(BzrNewError):
 
812
    """Can't reprocess and show base.
 
813
Reprocessing obscures relationship of conflicting lines to base."""
 
814
 
 
815
 
 
816
class GraphCycleError(BzrNewError):
 
817
    """Cycle in graph %(graph)r"""
 
818
    def __init__(self, graph):
 
819
        BzrNewError.__init__(self)
 
820
        self.graph = graph
 
821
 
 
822
 
 
823
class NotConflicted(BzrNewError):
 
824
    """File %(filename)s is not conflicted."""
 
825
 
 
826
    def __init__(self, filename):
 
827
        BzrNewError.__init__(self)
 
828
        self.filename = filename
 
829
 
 
830
 
 
831
class MustUseDecorated(Exception):
 
832
    """A decorating function has requested its original command be used.
 
833
    
 
834
    This should never escape bzr, so does not need to be printable.
 
835
    """
 
836
 
 
837
 
 
838
class NoBundleFound(BzrNewError):
 
839
    """No bundle was found in %(filename)s"""
 
840
    def __init__(self, filename):
 
841
        BzrNewError.__init__(self)
 
842
        self.filename = filename
 
843
 
 
844
 
 
845
class BundleNotSupported(BzrNewError):
 
846
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
847
    def __init__(self, version, msg):
 
848
        BzrNewError.__init__(self)
 
849
        self.version = version
 
850
        self.msg = msg
 
851
 
 
852
 
 
853
class MissingText(BzrNewError):
 
854
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
855
 
 
856
    def __init__(self, branch, text_revision, file_id):
 
857
        BzrNewError.__init__(self)
 
858
        self.branch = branch
 
859
        self.base = branch.base
 
860
        self.text_revision = text_revision
 
861
        self.file_id = file_id
 
862
 
 
863
 
 
864
class DuplicateKey(BzrNewError):
 
865
    """Key %(key)s is already present in map"""
 
866
 
 
867
 
 
868
class MalformedTransform(BzrNewError):
 
869
    """Tree transform is malformed %(conflicts)r"""
 
870
 
 
871
 
 
872
class BzrBadParameter(BzrNewError):
 
873
    """A bad parameter : %(param)s is not usable.
 
874
    
 
875
    This exception should never be thrown, but it is a base class for all
 
876
    parameter-to-function errors.
 
877
    """
 
878
    def __init__(self, param):
 
879
        BzrNewError.__init__(self)
 
880
        self.param = param
 
881
 
 
882
 
 
883
class BzrBadParameterNotUnicode(BzrBadParameter):
 
884
    """Parameter %(param)s is neither unicode nor utf8."""
 
885
 
 
886
 
 
887
class ReusingTransform(BzrNewError):
 
888
    """Attempt to reuse a transform that has already been applied."""
 
889
 
 
890
 
 
891
class CantMoveRoot(BzrNewError):
 
892
    """Moving the root directory is not supported at this time"""
 
893
 
 
894
 
 
895
class BzrBadParameterNotString(BzrBadParameter):
 
896
    """Parameter %(param)s is not a string or unicode string."""
 
897
 
 
898
 
 
899
class BzrBadParameterMissing(BzrBadParameter):
 
900
    """Parameter $(param)s is required but not present."""
 
901
 
 
902
 
 
903
class BzrBadParameterUnicode(BzrBadParameter):
 
904
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
905
 
 
906
 
 
907
class BzrBadParameterContainsNewline(BzrBadParameter):
 
908
    """Parameter %(param)s contains a newline."""
 
909
 
 
910
 
 
911
class DependencyNotPresent(BzrNewError):
 
912
    """Unable to import library "%(library)s": %(error)s"""
 
913
 
 
914
    def __init__(self, library, error):
 
915
        BzrNewError.__init__(self, library=library, error=error)
 
916
 
 
917
 
 
918
class ParamikoNotPresent(DependencyNotPresent):
 
919
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
920
 
 
921
    def __init__(self, error):
 
922
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
923
 
 
924
 
 
925
class UninitializableFormat(BzrNewError):
 
926
    """Format %(format)s cannot be initialised by this version of bzr."""
 
927
 
 
928
    def __init__(self, format):
 
929
        BzrNewError.__init__(self)
 
930
        self.format = format
 
931
 
 
932
 
 
933
class NoDiff(BzrNewError):
 
934
    """Diff is not installed on this machine: %(msg)s"""
 
935
 
 
936
    def __init__(self, msg):
 
937
        super(NoDiff, self).__init__(msg=msg)
 
938
 
 
939
 
 
940
class NoDiff3(BzrNewError):
 
941
    """Diff3 is not installed on this machine."""
 
942
 
 
943
 
 
944
class ExistingLimbo(BzrNewError):
 
945
    """This tree contains left-over files from a failed operation.
 
946
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
947
    keep, and delete it when you are done.
 
948
    """
 
949
    def __init__(self, limbo_dir):
 
950
       BzrNewError.__init__(self)
 
951
       self.limbo_dir = limbo_dir
 
952
 
 
953
 
 
954
class ImmortalLimbo(BzrNewError):
 
955
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
956
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
957
    keep, and delete it when you are done.
 
958
    """
 
959
    def __init__(self, limbo_dir):
 
960
       BzrNewError.__init__(self)
 
961
       self.limbo_dir = limbo_dir
 
962
 
 
963
 
 
964
class OutOfDateTree(BzrNewError):
 
965
    """Working tree is out of date, please run 'bzr update'."""
 
966
 
 
967
    def __init__(self, tree):
 
968
        BzrNewError.__init__(self)
 
969
        self.tree = tree
 
970
 
 
971
 
 
972
class MergeModifiedFormatError(BzrNewError):
 
973
    """Error in merge modified format"""
 
974
 
 
975
 
 
976
class ConflictFormatError(BzrNewError):
 
977
    """Format error in conflict listings"""
 
978
 
 
979
 
 
980
class CorruptRepository(BzrNewError):
 
981
    """An error has been detected in the repository %(repo_path)s.
 
982
Please run bzr reconcile on this repository."""
 
983
 
 
984
    def __init__(self, repo):
 
985
        BzrNewError.__init__(self)
 
986
        self.repo_path = repo.bzrdir.root_transport.base
 
987
 
 
988
 
 
989
class UpgradeRequired(BzrNewError):
 
990
    """To use this feature you must upgrade your branch at %(path)s."""
 
991
 
 
992
    def __init__(self, path):
 
993
        BzrNewError.__init__(self)
 
994
        self.path = path
 
995
 
 
996
 
 
997
class LocalRequiresBoundBranch(BzrNewError):
 
998
    """Cannot perform local-only commits on unbound branches."""
 
999
 
 
1000
 
 
1001
class MissingProgressBarFinish(BzrNewError):
 
1002
    """A nested progress bar was not 'finished' correctly."""
 
1003
 
 
1004
 
 
1005
class InvalidProgressBarType(BzrNewError):
 
1006
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1007
Select one of: %(valid_types)s"""
 
1008
 
 
1009
    def __init__(self, bar_type, valid_types):
 
1010
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1011
 
 
1012
 
 
1013
class UnsupportedOperation(BzrNewError):
 
1014
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
1015
    def __init__(self, method, method_self):
 
1016
        self.method = method
 
1017
        self.mname = method.__name__
 
1018
        self.tname = type(method_self).__name__
 
1019
 
 
1020
 
 
1021
class BinaryFile(BzrNewError):
 
1022
    """File is binary but should be text."""
 
1023
 
 
1024
 
 
1025
class IllegalPath(BzrNewError):
 
1026
    """The path %(path)s is not permitted on this platform"""
 
1027
 
 
1028
    def __init__(self, path):
 
1029
        BzrNewError.__init__(self)
 
1030
        self.path = path
 
1031
 
 
1032
 
 
1033
class TestamentMismatch(BzrNewError):
 
1034
    """Testament did not match expected value.  
 
1035
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1036
       {%(measured)s}
 
1037
    """
 
1038
    def __init__(self, revision_id, expected, measured):
 
1039
        self.revision_id = revision_id
 
1040
        self.expected = expected
 
1041
        self.measured = measured
 
1042
 
 
1043
 
 
1044
class NotABundle(BzrNewError):
 
1045
    """Not a bzr revision-bundle: %(text)r"""
 
1046
 
 
1047
    def __init__(self, text):
 
1048
        self.text = text
 
1049
 
 
1050
 
 
1051
class BadBundle(Exception): pass
 
1052
 
 
1053
 
 
1054
class MalformedHeader(BadBundle): pass
 
1055
 
 
1056
 
 
1057
class MalformedPatches(BadBundle): pass
 
1058
 
 
1059
 
 
1060
class MalformedFooter(BadBundle): pass