/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 03:30:14 UTC
  • mfrom: (1793 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1797.
  • Revision ID: mbp@sourcefrog.net-20060620033014-e19ce470e2ce6561
[merge] bzr.dev

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