/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: Martin Pool
  • Date: 2006-06-20 01:35:25 UTC
  • mto: This revision was merged to the branch mainline in revision 1797.
  • Revision ID: mbp@sourcefrog.net-20060620013525-d2eba83a7c6e953b
Review cleanups: better error reporting, put back report_exception. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical
 
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
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
 
 
96
class BzrError(StandardError):
 
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 PathNotChild(BzrNewError):
 
262
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
263
 
 
264
    is_user_error = False
 
265
 
 
266
    def __init__(self, path, base, extra=None):
 
267
        BzrNewError.__init__(self)
 
268
        self.path = path
 
269
        self.base = base
 
270
        if extra:
 
271
            self.extra = ': ' + str(extra)
 
272
        else:
 
273
            self.extra = ''
 
274
 
 
275
 
 
276
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
277
# the exception object is a bit undesirable.
 
278
# TODO: Probably this behavior of should be a common superclass 
 
279
class NotBranchError(PathError):
 
280
    """Not a branch: %(path)s"""
 
281
 
 
282
 
 
283
class AlreadyBranchError(PathError):
 
284
    """Already a branch: %(path)s."""
 
285
 
 
286
 
 
287
class BranchExistsWithoutWorkingTree(PathError):
 
288
    """Directory contains a branch, but no working tree \
 
289
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
290
 
 
291
 
 
292
class NoRepositoryPresent(BzrNewError):
 
293
    """No repository present: %(path)r"""
 
294
    def __init__(self, bzrdir):
 
295
        BzrNewError.__init__(self)
 
296
        self.path = bzrdir.transport.clone('..').base
 
297
 
 
298
 
 
299
class FileInWrongBranch(BzrNewError):
 
300
    """File %(path)s in not in branch %(branch_base)s."""
 
301
 
 
302
    def __init__(self, branch, path):
 
303
        BzrNewError.__init__(self)
 
304
        self.branch = branch
 
305
        self.branch_base = branch.base
 
306
        self.path = path
 
307
 
 
308
 
 
309
class UnsupportedFormatError(BzrNewError):
 
310
    """Unsupported branch format: %(format)s"""
 
311
 
 
312
 
 
313
class UnknownFormatError(BzrNewError):
 
314
    """Unknown branch format: %(format)r"""
 
315
 
 
316
 
 
317
class IncompatibleFormat(BzrNewError):
 
318
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
319
 
 
320
    def __init__(self, format, bzrdir_format):
 
321
        BzrNewError.__init__(self)
 
322
        self.format = format
 
323
        self.bzrdir = bzrdir_format
 
324
 
 
325
 
 
326
class NotVersionedError(BzrNewError):
 
327
    """%(path)s is not versioned"""
 
328
    def __init__(self, path):
 
329
        BzrNewError.__init__(self)
 
330
        self.path = path
 
331
 
 
332
 
 
333
class PathsNotVersionedError(BzrNewError):
 
334
    # used when reporting several paths are not versioned
 
335
    """Path(s) are not versioned: %(paths_as_string)s"""
 
336
 
 
337
    def __init__(self, paths):
 
338
        from bzrlib.osutils import quotefn
 
339
        BzrNewError.__init__(self)
 
340
        self.paths = paths
 
341
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
342
 
 
343
 
 
344
class PathsDoNotExist(BzrNewError):
 
345
    """Path(s) do not exist: %(paths_as_string)s"""
 
346
 
 
347
    # used when reporting that paths are neither versioned nor in the working
 
348
    # tree
 
349
 
 
350
    def __init__(self, paths):
 
351
        # circular import
 
352
        from bzrlib.osutils import quotefn
 
353
        BzrNewError.__init__(self)
 
354
        self.paths = paths
 
355
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
356
 
 
357
 
 
358
class BadFileKindError(BzrError):
 
359
    """Specified file is of a kind that cannot be added.
 
360
 
 
361
    (For example a symlink or device file.)"""
 
362
 
 
363
 
 
364
class ForbiddenFileError(BzrError):
 
365
    """Cannot operate on a file because it is a control file."""
 
366
 
 
367
 
 
368
class LockError(BzrNewError):
 
369
    """Lock error: %(message)s"""
 
370
    # All exceptions from the lock/unlock functions should be from
 
371
    # this exception class.  They will be translated as necessary. The
 
372
    # original exception is available as e.original_error
 
373
    #
 
374
    # New code should prefer to raise specific subclasses
 
375
    def __init__(self, message):
 
376
        self.message = message
 
377
 
 
378
 
 
379
class CommitNotPossible(LockError):
 
380
    """A commit was attempted but we do not have a write lock open."""
 
381
    def __init__(self):
 
382
        pass
 
383
 
 
384
 
 
385
class AlreadyCommitted(LockError):
 
386
    """A rollback was requested, but is not able to be accomplished."""
 
387
    def __init__(self):
 
388
        pass
 
389
 
 
390
 
 
391
class ReadOnlyError(LockError):
 
392
    """A write attempt was made in a read only transaction on %(obj)s"""
 
393
    def __init__(self, obj):
 
394
        self.obj = obj
 
395
 
 
396
 
 
397
class OutSideTransaction(BzrNewError):
 
398
    """A transaction related operation was attempted after the transaction finished."""
 
399
 
 
400
 
 
401
class ObjectNotLocked(LockError):
 
402
    """%(obj)r is not locked"""
 
403
 
 
404
    is_user_error = False
 
405
 
 
406
    # this can indicate that any particular object is not locked; see also
 
407
    # LockNotHeld which means that a particular *lock* object is not held by
 
408
    # the caller -- perhaps they should be unified.
 
409
    def __init__(self, obj):
 
410
        self.obj = obj
 
411
 
 
412
 
 
413
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
414
    """Cannot change object %(obj)r in read only transaction"""
 
415
    def __init__(self, obj):
 
416
        self.obj = obj
 
417
 
 
418
 
 
419
class UnlockableTransport(LockError):
 
420
    """Cannot lock: transport is read only: %(transport)s"""
 
421
    def __init__(self, transport):
 
422
        self.transport = transport
 
423
 
 
424
 
 
425
class LockContention(LockError):
 
426
    """Could not acquire lock %(lock)s"""
 
427
    # TODO: show full url for lock, combining the transport and relative bits?
 
428
    def __init__(self, lock):
 
429
        self.lock = lock
 
430
 
 
431
 
 
432
class LockBroken(LockError):
 
433
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
434
    def __init__(self, lock):
 
435
        self.lock = lock
 
436
 
 
437
 
 
438
class LockBreakMismatch(LockError):
 
439
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
440
    def __init__(self, lock, holder, target):
 
441
        self.lock = lock
 
442
        self.holder = holder
 
443
        self.target = target
 
444
 
 
445
 
 
446
class LockNotHeld(LockError):
 
447
    """Lock not held: %(lock)s"""
 
448
    def __init__(self, lock):
 
449
        self.lock = lock
 
450
 
 
451
 
 
452
class PointlessCommit(BzrNewError):
 
453
    """No changes to commit"""
 
454
 
 
455
 
 
456
class UpgradeReadonly(BzrNewError):
 
457
    """Upgrade URL cannot work with readonly URL's."""
 
458
 
 
459
 
 
460
class UpToDateFormat(BzrNewError):
 
461
    """The branch format %(format)s is already at the most recent format."""
 
462
 
 
463
    def __init__(self, format):
 
464
        BzrNewError.__init__(self)
 
465
        self.format = format
 
466
 
 
467
 
 
468
 
 
469
class StrictCommitFailed(Exception):
 
470
    """Commit refused because there are unknowns in the tree."""
 
471
 
 
472
 
 
473
class NoSuchRevision(BzrNewError):
 
474
    """Branch %(branch)s has no revision %(revision)s"""
 
475
 
 
476
    is_user_error = False
 
477
 
 
478
    def __init__(self, branch, revision):
 
479
        self.branch = branch
 
480
        self.revision = revision
 
481
 
 
482
 
 
483
class DivergedBranches(BzrNewError):
 
484
    "These branches have diverged.  Use the merge command to reconcile them."""
 
485
 
 
486
    is_user_error = True
 
487
 
 
488
    def __init__(self, branch1, branch2):
 
489
        self.branch1 = branch1
 
490
        self.branch2 = branch2
 
491
 
 
492
 
 
493
class UnrelatedBranches(BzrNewError):
 
494
    "Branches have no common ancestor, and no merge base revision was specified."
 
495
 
 
496
    is_user_error = True
 
497
 
 
498
 
 
499
class NoCommonAncestor(BzrNewError):
 
500
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
501
 
 
502
    def __init__(self, revision_a, revision_b):
 
503
        self.revision_a = revision_a
 
504
        self.revision_b = revision_b
 
505
 
 
506
 
 
507
class NoCommonRoot(BzrError):
 
508
    def __init__(self, revision_a, revision_b):
 
509
        msg = "Revisions are not derived from the same root: %s %s." \
 
510
            % (revision_a, revision_b) 
 
511
        BzrError.__init__(self, msg)
 
512
 
 
513
 
 
514
 
 
515
class NotAncestor(BzrError):
 
516
    def __init__(self, rev_id, not_ancestor_id):
 
517
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
518
                                                        rev_id)
 
519
        BzrError.__init__(self, msg)
 
520
        self.rev_id = rev_id
 
521
        self.not_ancestor_id = not_ancestor_id
 
522
 
 
523
 
 
524
class InstallFailed(BzrError):
 
525
    def __init__(self, revisions):
 
526
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
527
        BzrError.__init__(self, msg)
 
528
        self.revisions = revisions
 
529
 
 
530
 
 
531
class AmbiguousBase(BzrError):
 
532
    def __init__(self, bases):
 
533
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
534
                DeprecationWarning)
 
535
        msg = "The correct base is unclear, because %s are all equally close" %\
 
536
            ", ".join(bases)
 
537
        BzrError.__init__(self, msg)
 
538
        self.bases = bases
 
539
 
 
540
 
 
541
class NoCommits(BzrError):
 
542
    def __init__(self, branch):
 
543
        msg = "Branch %s has no commits." % branch
 
544
        BzrError.__init__(self, msg)
 
545
 
 
546
 
 
547
class UnlistableStore(BzrError):
 
548
    def __init__(self, store):
 
549
        BzrError.__init__(self, "Store %s is not listable" % store)
 
550
 
 
551
 
 
552
 
 
553
class UnlistableBranch(BzrError):
 
554
    def __init__(self, br):
 
555
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
556
 
 
557
 
 
558
class BoundBranchOutOfDate(BzrNewError):
 
559
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
560
    def __init__(self, branch, master):
 
561
        BzrNewError.__init__(self)
 
562
        self.branch = branch
 
563
        self.master = master
 
564
 
 
565
        
 
566
class CommitToDoubleBoundBranch(BzrNewError):
 
567
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
568
    def __init__(self, branch, master, remote):
 
569
        BzrNewError.__init__(self)
 
570
        self.branch = branch
 
571
        self.master = master
 
572
        self.remote = remote
 
573
 
 
574
 
 
575
class OverwriteBoundBranch(BzrNewError):
 
576
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
577
    def __init__(self, branch):
 
578
        BzrNewError.__init__(self)
 
579
        self.branch = branch
 
580
 
 
581
 
 
582
class BoundBranchConnectionFailure(BzrNewError):
 
583
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
584
    def __init__(self, branch, target, error):
 
585
        BzrNewError.__init__(self)
 
586
        self.branch = branch
 
587
        self.target = target
 
588
        self.error = error
 
589
 
 
590
 
 
591
class WeaveError(BzrNewError):
 
592
    """Error in processing weave: %(message)s"""
 
593
 
 
594
    def __init__(self, message=None):
 
595
        BzrNewError.__init__(self)
 
596
        self.message = message
 
597
 
 
598
 
 
599
class WeaveRevisionAlreadyPresent(WeaveError):
 
600
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
601
    def __init__(self, revision_id, weave):
 
602
 
 
603
        WeaveError.__init__(self)
 
604
        self.revision_id = revision_id
 
605
        self.weave = weave
 
606
 
 
607
 
 
608
class WeaveRevisionNotPresent(WeaveError):
 
609
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
610
 
 
611
    def __init__(self, revision_id, weave):
 
612
        WeaveError.__init__(self)
 
613
        self.revision_id = revision_id
 
614
        self.weave = weave
 
615
 
 
616
 
 
617
class WeaveFormatError(WeaveError):
 
618
    """Weave invariant violated: %(what)s"""
 
619
 
 
620
    def __init__(self, what):
 
621
        WeaveError.__init__(self)
 
622
        self.what = what
 
623
 
 
624
 
 
625
class WeaveParentMismatch(WeaveError):
 
626
    """Parents are mismatched between two revisions."""
 
627
    
 
628
 
 
629
class WeaveInvalidChecksum(WeaveError):
 
630
    """Text did not match it's checksum: %(message)s"""
 
631
 
 
632
 
 
633
class WeaveTextDiffers(WeaveError):
 
634
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
635
 
 
636
    def __init__(self, revision_id, weave_a, weave_b):
 
637
        WeaveError.__init__(self)
 
638
        self.revision_id = revision_id
 
639
        self.weave_a = weave_a
 
640
        self.weave_b = weave_b
 
641
 
 
642
 
 
643
class WeaveTextDiffers(WeaveError):
 
644
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
645
 
 
646
    def __init__(self, revision_id, weave_a, weave_b):
 
647
        WeaveError.__init__(self)
 
648
        self.revision_id = revision_id
 
649
        self.weave_a = weave_a
 
650
        self.weave_b = weave_b
 
651
 
 
652
 
 
653
class VersionedFileError(BzrNewError):
 
654
    """Versioned file error."""
 
655
 
 
656
 
 
657
class RevisionNotPresent(VersionedFileError):
 
658
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
659
 
 
660
    def __init__(self, revision_id, file_id):
 
661
        VersionedFileError.__init__(self)
 
662
        self.revision_id = revision_id
 
663
        self.file_id = file_id
 
664
 
 
665
 
 
666
class RevisionAlreadyPresent(VersionedFileError):
 
667
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
668
 
 
669
    def __init__(self, revision_id, file_id):
 
670
        VersionedFileError.__init__(self)
 
671
        self.revision_id = revision_id
 
672
        self.file_id = file_id
 
673
 
 
674
 
 
675
class KnitError(BzrNewError):
 
676
    """Knit error"""
 
677
 
 
678
 
 
679
class KnitHeaderError(KnitError):
 
680
    """Knit header error: %(badline)r unexpected"""
 
681
 
 
682
    def __init__(self, badline):
 
683
        KnitError.__init__(self)
 
684
        self.badline = badline
 
685
 
 
686
 
 
687
class KnitCorrupt(KnitError):
 
688
    """Knit %(filename)s corrupt: %(how)s"""
 
689
 
 
690
    def __init__(self, filename, how):
 
691
        KnitError.__init__(self)
 
692
        self.filename = filename
 
693
        self.how = how
 
694
 
 
695
 
 
696
class NoSuchExportFormat(BzrNewError):
 
697
    """Export format %(format)r not supported"""
 
698
    def __init__(self, format):
 
699
        BzrNewError.__init__(self)
 
700
        self.format = format
 
701
 
 
702
 
 
703
class TransportError(BzrError):
 
704
    """All errors thrown by Transport implementations should derive
 
705
    from this class.
 
706
    """
 
707
    def __init__(self, msg=None, orig_error=None):
 
708
        if msg is None and orig_error is not None:
 
709
            msg = str(orig_error)
 
710
        BzrError.__init__(self, msg)
 
711
        self.msg = msg
 
712
        self.orig_error = orig_error
 
713
 
 
714
 
 
715
# A set of semi-meaningful errors which can be thrown
 
716
class TransportNotPossible(TransportError):
 
717
    """This is for transports where a specific function is explicitly not
 
718
    possible. Such as pushing files to an HTTP server.
 
719
    """
 
720
    pass
 
721
 
 
722
 
 
723
class ConnectionError(TransportError):
 
724
    """A connection problem prevents file retrieval.
 
725
    This does not indicate whether the file exists or not; it indicates that a
 
726
    precondition for requesting the file was not met.
 
727
    """
 
728
    def __init__(self, msg=None, orig_error=None):
 
729
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
730
 
 
731
 
 
732
class ConnectionReset(TransportError):
 
733
    """The connection has been closed."""
 
734
    pass
 
735
 
 
736
 
 
737
class ConflictsInTree(BzrError):
 
738
    def __init__(self):
 
739
        BzrError.__init__(self, "Working tree has conflicts.")
 
740
 
 
741
 
 
742
class ParseConfigError(BzrError):
 
743
    def __init__(self, errors, filename):
 
744
        if filename is None:
 
745
            filename = ""
 
746
        message = "Error(s) parsing config file %s:\n%s" % \
 
747
            (filename, ('\n'.join(e.message for e in errors)))
 
748
        BzrError.__init__(self, message)
 
749
 
 
750
 
 
751
class SigningFailed(BzrError):
 
752
    def __init__(self, command_line):
 
753
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
754
                               % command_line)
 
755
 
 
756
 
 
757
class WorkingTreeNotRevision(BzrError):
 
758
    def __init__(self, tree):
 
759
        BzrError.__init__(self, "The working tree for %s has changed since"
 
760
                          " last commit, but weave merge requires that it be"
 
761
                          " unchanged." % tree.basedir)
 
762
 
 
763
 
 
764
class CantReprocessAndShowBase(BzrNewError):
 
765
    """Can't reprocess and show base.
 
766
Reprocessing obscures relationship of conflicting lines to base."""
 
767
 
 
768
 
 
769
class GraphCycleError(BzrNewError):
 
770
    """Cycle in graph %(graph)r"""
 
771
    def __init__(self, graph):
 
772
        BzrNewError.__init__(self)
 
773
        self.graph = graph
 
774
 
 
775
 
 
776
class NotConflicted(BzrNewError):
 
777
    """File %(filename)s is not conflicted."""
 
778
 
 
779
    def __init__(self, filename):
 
780
        BzrNewError.__init__(self)
 
781
        self.filename = filename
 
782
 
 
783
 
 
784
class MustUseDecorated(Exception):
 
785
    """A decorating function has requested its original command be used.
 
786
    
 
787
    This should never escape bzr, so does not need to be printable.
 
788
    """
 
789
 
 
790
 
 
791
class NoBundleFound(BzrNewError):
 
792
    """No bundle was found in %(filename)s"""
 
793
    def __init__(self, filename):
 
794
        BzrNewError.__init__(self)
 
795
        self.filename = filename
 
796
 
 
797
 
 
798
class BundleNotSupported(BzrNewError):
 
799
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
800
    def __init__(self, version, msg):
 
801
        BzrNewError.__init__(self)
 
802
        self.version = version
 
803
        self.msg = msg
 
804
 
 
805
 
 
806
class MissingText(BzrNewError):
 
807
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
808
 
 
809
    def __init__(self, branch, text_revision, file_id):
 
810
        BzrNewError.__init__(self)
 
811
        self.branch = branch
 
812
        self.base = branch.base
 
813
        self.text_revision = text_revision
 
814
        self.file_id = file_id
 
815
 
 
816
 
 
817
class DuplicateKey(BzrNewError):
 
818
    """Key %(key)s is already present in map"""
 
819
 
 
820
 
 
821
class MalformedTransform(BzrNewError):
 
822
    """Tree transform is malformed %(conflicts)r"""
 
823
 
 
824
 
 
825
class BzrBadParameter(BzrNewError):
 
826
    """A bad parameter : %(param)s is not usable.
 
827
    
 
828
    This exception should never be thrown, but it is a base class for all
 
829
    parameter-to-function errors.
 
830
    """
 
831
    def __init__(self, param):
 
832
        BzrNewError.__init__(self)
 
833
        self.param = param
 
834
 
 
835
 
 
836
class BzrBadParameterNotUnicode(BzrBadParameter):
 
837
    """Parameter %(param)s is neither unicode nor utf8."""
 
838
 
 
839
 
 
840
class ReusingTransform(BzrNewError):
 
841
    """Attempt to reuse a transform that has already been applied."""
 
842
 
 
843
 
 
844
class CantMoveRoot(BzrNewError):
 
845
    """Moving the root directory is not supported at this time"""
 
846
 
 
847
 
 
848
class BzrBadParameterNotString(BzrBadParameter):
 
849
    """Parameter %(param)s is not a string or unicode string."""
 
850
 
 
851
 
 
852
class BzrBadParameterMissing(BzrBadParameter):
 
853
    """Parameter $(param)s is required but not present."""
 
854
 
 
855
 
 
856
class BzrBadParameterUnicode(BzrBadParameter):
 
857
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
858
 
 
859
 
 
860
class BzrBadParameterContainsNewline(BzrBadParameter):
 
861
    """Parameter %(param)s contains a newline."""
 
862
 
 
863
 
 
864
class DependencyNotPresent(BzrNewError):
 
865
    """Unable to import library "%(library)s": %(error)s"""
 
866
 
 
867
    def __init__(self, library, error):
 
868
        BzrNewError.__init__(self, library=library, error=error)
 
869
 
 
870
 
 
871
class ParamikoNotPresent(DependencyNotPresent):
 
872
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
873
 
 
874
    def __init__(self, error):
 
875
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
876
 
 
877
 
 
878
class UninitializableFormat(BzrNewError):
 
879
    """Format %(format)s cannot be initialised by this version of bzr."""
 
880
 
 
881
    def __init__(self, format):
 
882
        BzrNewError.__init__(self)
 
883
        self.format = format
 
884
 
 
885
 
 
886
class NoDiff(BzrNewError):
 
887
    """Diff is not installed on this machine: %(msg)s"""
 
888
 
 
889
    def __init__(self, msg):
 
890
        super(NoDiff, self).__init__(msg=msg)
 
891
 
 
892
 
 
893
class NoDiff3(BzrNewError):
 
894
    """Diff3 is not installed on this machine."""
 
895
 
 
896
 
 
897
class ExistingLimbo(BzrNewError):
 
898
    """This tree contains left-over files from a failed operation.
 
899
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
900
    keep, and delete it when you are done.
 
901
    """
 
902
    def __init__(self, limbo_dir):
 
903
       BzrNewError.__init__(self)
 
904
       self.limbo_dir = limbo_dir
 
905
 
 
906
 
 
907
class ImmortalLimbo(BzrNewError):
 
908
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
909
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
910
    keep, and delete it when you are done.
 
911
    """
 
912
    def __init__(self, limbo_dir):
 
913
       BzrNewError.__init__(self)
 
914
       self.limbo_dir = limbo_dir
 
915
 
 
916
 
 
917
class OutOfDateTree(BzrNewError):
 
918
    """Working tree is out of date, please run 'bzr update'."""
 
919
 
 
920
    def __init__(self, tree):
 
921
        BzrNewError.__init__(self)
 
922
        self.tree = tree
 
923
 
 
924
 
 
925
class MergeModifiedFormatError(BzrNewError):
 
926
    """Error in merge modified format"""
 
927
 
 
928
 
 
929
class ConflictFormatError(BzrNewError):
 
930
    """Format error in conflict listings"""
 
931
 
 
932
 
 
933
class CorruptRepository(BzrNewError):
 
934
    """An error has been detected in the repository %(repo_path)s.
 
935
Please run bzr reconcile on this repository."""
 
936
 
 
937
    def __init__(self, repo):
 
938
        BzrNewError.__init__(self)
 
939
        self.repo_path = repo.bzrdir.root_transport.base
 
940
 
 
941
 
 
942
class UpgradeRequired(BzrNewError):
 
943
    """To use this feature you must upgrade your branch at %(path)s."""
 
944
 
 
945
    def __init__(self, path):
 
946
        BzrNewError.__init__(self)
 
947
        self.path = path
 
948
 
 
949
 
 
950
class LocalRequiresBoundBranch(BzrNewError):
 
951
    """Cannot perform local-only commits on unbound branches."""
 
952
 
 
953
 
 
954
class MissingProgressBarFinish(BzrNewError):
 
955
    """A nested progress bar was not 'finished' correctly."""
 
956
 
 
957
 
 
958
class UnsupportedOperation(BzrNewError):
 
959
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
960
    def __init__(self, method, method_self):
 
961
        self.method = method
 
962
        self.mname = method.__name__
 
963
        self.tname = type(method_self).__name__
 
964
 
 
965
 
 
966
class BinaryFile(BzrNewError):
 
967
    """File is binary but should be text."""
 
968
 
 
969
 
 
970
class IllegalPath(BzrNewError):
 
971
    """The path %(path)s is not permitted on this platform"""
 
972
 
 
973
    def __init__(self, path):
 
974
        BzrNewError.__init__(self)
 
975
        self.path = path
 
976
 
 
977
 
 
978
class TestamentMismatch(BzrNewError):
 
979
    """Testament did not match expected value.  
 
980
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
981
       {%(measured)s}
 
982
    """
 
983
    def __init__(self, revision_id, expected, measured):
 
984
        self.revision_id = revision_id
 
985
        self.expected = expected
 
986
        self.measured = measured
 
987
 
 
988
 
 
989
class NotABundle(BzrNewError):
 
990
    """Not a bzr revision-bundle: %(text)r"""
 
991
 
 
992
    def __init__(self, text):
 
993
        self.text = text
 
994
 
 
995
 
 
996
class BadBundle(Exception): pass
 
997
 
 
998
 
 
999
class MalformedHeader(BadBundle): pass
 
1000
 
 
1001
 
 
1002
class MalformedPatches(BadBundle): pass
 
1003
 
 
1004
 
 
1005
class MalformedFooter(BadBundle): pass