/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

Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.

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
 
 
165
    def __init__(self, revision_id, branch):
 
166
        # branch can be any string or object with __str__ defined
 
167
        BzrNewError.__init__(self)
 
168
        self.revision_id = revision_id
 
169
        self.branch = branch
 
170
 
 
171
 
 
172
class NoWorkingTree(BzrNewError):
 
173
    """No WorkingTree exists for %(base)s."""
 
174
    
 
175
    def __init__(self, base):
 
176
        BzrNewError.__init__(self)
 
177
        self.base = base
 
178
 
 
179
 
 
180
class NotLocalUrl(BzrNewError):
 
181
    """%(url)s is not a local path."""
 
182
    
 
183
    def __init__(self, url):
 
184
        BzrNewError.__init__(self)
 
185
        self.url = url
 
186
 
 
187
 
 
188
class BzrCommandError(BzrNewError):
 
189
    """Error from user command"""
 
190
 
 
191
    is_user_error = True
 
192
 
 
193
    # Error from malformed user command; please avoid raising this as a
 
194
    # generic exception not caused by user input.
 
195
    #
 
196
    # I think it's a waste of effort to differentiate between errors that
 
197
    # are not intended to be caught anyway.  UI code need not subclass
 
198
    # BzrCommandError, and non-UI code should not throw a subclass of
 
199
    # BzrCommandError.  ADHB 20051211
 
200
    def __init__(self, msg):
 
201
        self.msg = msg
 
202
 
 
203
    def __str__(self):
 
204
        return self.msg
 
205
 
 
206
 
 
207
class BzrOptionError(BzrCommandError):
 
208
    """Error in command line options"""
 
209
 
 
210
    
 
211
class StrictCommitFailed(BzrNewError):
 
212
    """Commit refused because there are unknown files in the tree"""
 
213
 
 
214
 
 
215
# XXX: Should be unified with TransportError; they seem to represent the
 
216
# same thing
 
217
class PathError(BzrNewError):
 
218
    """Generic path error: %(path)r%(extra)s)"""
 
219
 
 
220
    def __init__(self, path, extra=None):
 
221
        BzrNewError.__init__(self)
 
222
        self.path = path
 
223
        if extra:
 
224
            self.extra = ': ' + str(extra)
 
225
        else:
 
226
            self.extra = ''
 
227
 
 
228
 
 
229
class NoSuchFile(PathError):
 
230
    """No such file: %(path)r%(extra)s"""
 
231
 
 
232
 
 
233
class FileExists(PathError):
 
234
    """File exists: %(path)r%(extra)s"""
 
235
 
 
236
 
 
237
class DirectoryNotEmpty(PathError):
 
238
    """Directory not empty: %(path)r%(extra)s"""
 
239
 
 
240
 
 
241
class ResourceBusy(PathError):
 
242
    """Device or resource busy: %(path)r%(extra)s"""
 
243
 
 
244
 
 
245
class PermissionDenied(PathError):
 
246
    """Permission denied: %(path)r%(extra)s"""
 
247
 
 
248
 
 
249
class InvalidURL(PathError):
 
250
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
251
 
 
252
 
 
253
class InvalidURLJoin(PathError):
 
254
    """Invalid URL join request: %(args)s%(extra)s"""
 
255
 
 
256
    def __init__(self, msg, base, args):
 
257
        PathError.__init__(self, base, msg)
 
258
        self.args = [base]
 
259
        self.args.extend(args)
 
260
 
 
261
 
 
262
class UnsupportedProtocol(PathError):
 
263
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
264
 
 
265
    def __init__(self, url, extra):
 
266
        PathError.__init__(self, url, extra=extra)
 
267
 
 
268
 
 
269
class PathNotChild(BzrNewError):
 
270
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
271
 
 
272
    is_user_error = False
 
273
 
 
274
    def __init__(self, path, base, extra=None):
 
275
        BzrNewError.__init__(self)
 
276
        self.path = path
 
277
        self.base = base
 
278
        if extra:
 
279
            self.extra = ': ' + str(extra)
 
280
        else:
 
281
            self.extra = ''
 
282
 
 
283
 
 
284
class InvalidNormalization(PathError):
 
285
    """Path %(path)r is not unicode normalized"""
 
286
 
 
287
 
 
288
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
289
# the exception object is a bit undesirable.
 
290
# TODO: Probably this behavior of should be a common superclass 
 
291
class NotBranchError(PathError):
 
292
    """Not a branch: %(path)s"""
 
293
 
 
294
    def __init__(self, path):
 
295
       import bzrlib.urlutils as urlutils
 
296
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
297
 
 
298
 
 
299
class AlreadyBranchError(PathError):
 
300
    """Already a branch: %(path)s."""
 
301
 
 
302
 
 
303
class BranchExistsWithoutWorkingTree(PathError):
 
304
    """Directory contains a branch, but no working tree \
 
305
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
306
 
 
307
 
 
308
class AtomicFileAlreadyClosed(PathError):
 
309
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
 
310
 
 
311
    def __init__(self, path, function):
 
312
        PathError.__init__(self, path=path, extra=None)
 
313
        self.function = function
 
314
 
 
315
 
 
316
class InaccessibleParent(PathError):
 
317
    """Parent not accessible given base %(base)s and relative path %(path)s"""
 
318
 
 
319
    def __init__(self, path, base):
 
320
        PathError.__init__(self, path)
 
321
        self.base = base
 
322
 
 
323
 
 
324
class NoRepositoryPresent(BzrNewError):
 
325
    """No repository present: %(path)r"""
 
326
    def __init__(self, bzrdir):
 
327
        BzrNewError.__init__(self)
 
328
        self.path = bzrdir.transport.clone('..').base
 
329
 
 
330
 
 
331
class FileInWrongBranch(BzrNewError):
 
332
    """File %(path)s in not in branch %(branch_base)s."""
 
333
 
 
334
    def __init__(self, branch, path):
 
335
        BzrNewError.__init__(self)
 
336
        self.branch = branch
 
337
        self.branch_base = branch.base
 
338
        self.path = path
 
339
 
 
340
 
 
341
class UnsupportedFormatError(BzrNewError):
 
342
    """Unsupported branch format: %(format)s"""
 
343
 
 
344
 
 
345
class UnknownFormatError(BzrNewError):
 
346
    """Unknown branch format: %(format)r"""
 
347
 
 
348
 
 
349
class IncompatibleFormat(BzrNewError):
 
350
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
351
 
 
352
    def __init__(self, format, bzrdir_format):
 
353
        BzrNewError.__init__(self)
 
354
        self.format = format
 
355
        self.bzrdir = bzrdir_format
 
356
 
 
357
 
 
358
class NotVersionedError(BzrNewError):
 
359
    """%(path)s is not versioned"""
 
360
    def __init__(self, path):
 
361
        BzrNewError.__init__(self)
 
362
        self.path = path
 
363
 
 
364
 
 
365
class PathsNotVersionedError(BzrNewError):
 
366
    # used when reporting several paths are not versioned
 
367
    """Path(s) are not versioned: %(paths_as_string)s"""
 
368
 
 
369
    def __init__(self, paths):
 
370
        from bzrlib.osutils import quotefn
 
371
        BzrNewError.__init__(self)
 
372
        self.paths = paths
 
373
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
374
 
 
375
 
 
376
class PathsDoNotExist(BzrNewError):
 
377
    """Path(s) do not exist: %(paths_as_string)s"""
 
378
 
 
379
    # used when reporting that paths are neither versioned nor in the working
 
380
    # tree
 
381
 
 
382
    def __init__(self, paths):
 
383
        # circular import
 
384
        from bzrlib.osutils import quotefn
 
385
        BzrNewError.__init__(self)
 
386
        self.paths = paths
 
387
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
388
 
 
389
 
 
390
class BadFileKindError(BzrNewError):
 
391
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
392
 
 
393
 
 
394
class ForbiddenControlFileError(BzrNewError):
 
395
    """Cannot operate on %(filename)s because it is a control file"""
 
396
 
 
397
 
 
398
class LockError(BzrNewError):
 
399
    """Lock error: %(message)s"""
 
400
    # All exceptions from the lock/unlock functions should be from
 
401
    # this exception class.  They will be translated as necessary. The
 
402
    # original exception is available as e.original_error
 
403
    #
 
404
    # New code should prefer to raise specific subclasses
 
405
    def __init__(self, message):
 
406
        self.message = message
 
407
 
 
408
 
 
409
class CommitNotPossible(LockError):
 
410
    """A commit was attempted but we do not have a write lock open."""
 
411
    def __init__(self):
 
412
        pass
 
413
 
 
414
 
 
415
class AlreadyCommitted(LockError):
 
416
    """A rollback was requested, but is not able to be accomplished."""
 
417
    def __init__(self):
 
418
        pass
 
419
 
 
420
 
 
421
class ReadOnlyError(LockError):
 
422
    """A write attempt was made in a read only transaction on %(obj)s"""
 
423
    def __init__(self, obj):
 
424
        self.obj = obj
 
425
 
 
426
 
 
427
class OutSideTransaction(BzrNewError):
 
428
    """A transaction related operation was attempted after the transaction finished."""
 
429
 
 
430
 
 
431
class ObjectNotLocked(LockError):
 
432
    """%(obj)r is not locked"""
 
433
 
 
434
    is_user_error = False
 
435
 
 
436
    # this can indicate that any particular object is not locked; see also
 
437
    # LockNotHeld which means that a particular *lock* object is not held by
 
438
    # the caller -- perhaps they should be unified.
 
439
    def __init__(self, obj):
 
440
        self.obj = obj
 
441
 
 
442
 
 
443
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
444
    """Cannot change object %(obj)r in read only transaction"""
 
445
    def __init__(self, obj):
 
446
        self.obj = obj
 
447
 
 
448
 
 
449
class UnlockableTransport(LockError):
 
450
    """Cannot lock: transport is read only: %(transport)s"""
 
451
    def __init__(self, transport):
 
452
        self.transport = transport
 
453
 
 
454
 
 
455
class LockContention(LockError):
 
456
    """Could not acquire lock %(lock)s"""
 
457
    # TODO: show full url for lock, combining the transport and relative bits?
 
458
    def __init__(self, lock):
 
459
        self.lock = lock
 
460
 
 
461
 
 
462
class LockBroken(LockError):
 
463
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
464
    def __init__(self, lock):
 
465
        self.lock = lock
 
466
 
 
467
 
 
468
class LockBreakMismatch(LockError):
 
469
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
470
    def __init__(self, lock, holder, target):
 
471
        self.lock = lock
 
472
        self.holder = holder
 
473
        self.target = target
 
474
 
 
475
 
 
476
class LockNotHeld(LockError):
 
477
    """Lock not held: %(lock)s"""
 
478
    def __init__(self, lock):
 
479
        self.lock = lock
 
480
 
 
481
 
 
482
class PointlessCommit(BzrNewError):
 
483
    """No changes to commit"""
 
484
 
 
485
 
 
486
class UpgradeReadonly(BzrNewError):
 
487
    """Upgrade URL cannot work with readonly URL's."""
 
488
 
 
489
 
 
490
class UpToDateFormat(BzrNewError):
 
491
    """The branch format %(format)s is already at the most recent format."""
 
492
 
 
493
    def __init__(self, format):
 
494
        BzrNewError.__init__(self)
 
495
        self.format = format
 
496
 
 
497
 
 
498
 
 
499
class StrictCommitFailed(Exception):
 
500
    """Commit refused because there are unknowns in the tree."""
 
501
 
 
502
 
 
503
class NoSuchRevision(BzrNewError):
 
504
    """Branch %(branch)s has no revision %(revision)s"""
 
505
 
 
506
    is_user_error = False
 
507
 
 
508
    def __init__(self, branch, revision):
 
509
        self.branch = branch
 
510
        self.revision = revision
 
511
 
 
512
 
 
513
class HistoryMissing(BzrError):
 
514
    def __init__(self, branch, object_type, object_id):
 
515
        self.branch = branch
 
516
        BzrError.__init__(self,
 
517
                          '%s is missing %s {%s}'
 
518
                          % (branch, object_type, object_id))
 
519
 
 
520
 
 
521
class DivergedBranches(BzrNewError):
 
522
    "These branches have diverged.  Use the merge command to reconcile them."""
 
523
 
 
524
    is_user_error = True
 
525
 
 
526
    def __init__(self, branch1, branch2):
 
527
        self.branch1 = branch1
 
528
        self.branch2 = branch2
 
529
 
 
530
 
 
531
class UnrelatedBranches(BzrNewError):
 
532
    "Branches have no common ancestor, and no merge base revision was specified."
 
533
 
 
534
    is_user_error = True
 
535
 
 
536
 
 
537
class NoCommonAncestor(BzrNewError):
 
538
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
539
 
 
540
    def __init__(self, revision_a, revision_b):
 
541
        self.revision_a = revision_a
 
542
        self.revision_b = revision_b
 
543
 
 
544
 
 
545
class NoCommonRoot(BzrError):
 
546
    def __init__(self, revision_a, revision_b):
 
547
        msg = "Revisions are not derived from the same root: %s %s." \
 
548
            % (revision_a, revision_b) 
 
549
        BzrError.__init__(self, msg)
 
550
 
 
551
 
 
552
 
 
553
class NotAncestor(BzrError):
 
554
    def __init__(self, rev_id, not_ancestor_id):
 
555
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
556
                                                        rev_id)
 
557
        BzrError.__init__(self, msg)
 
558
        self.rev_id = rev_id
 
559
        self.not_ancestor_id = not_ancestor_id
 
560
 
 
561
 
 
562
class InstallFailed(BzrError):
 
563
    def __init__(self, revisions):
 
564
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
565
        BzrError.__init__(self, msg)
 
566
        self.revisions = revisions
 
567
 
 
568
 
 
569
class AmbiguousBase(BzrError):
 
570
    def __init__(self, bases):
 
571
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
572
                DeprecationWarning)
 
573
        msg = "The correct base is unclear, because %s are all equally close" %\
 
574
            ", ".join(bases)
 
575
        BzrError.__init__(self, msg)
 
576
        self.bases = bases
 
577
 
 
578
 
 
579
class NoCommits(BzrError):
 
580
    def __init__(self, branch):
 
581
        msg = "Branch %s has no commits." % branch
 
582
        BzrError.__init__(self, msg)
 
583
 
 
584
 
 
585
class UnlistableStore(BzrError):
 
586
    def __init__(self, store):
 
587
        BzrError.__init__(self, "Store %s is not listable" % store)
 
588
 
 
589
 
 
590
 
 
591
class UnlistableBranch(BzrError):
 
592
    def __init__(self, br):
 
593
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
594
 
 
595
 
 
596
class BoundBranchOutOfDate(BzrNewError):
 
597
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
598
    def __init__(self, branch, master):
 
599
        BzrNewError.__init__(self)
 
600
        self.branch = branch
 
601
        self.master = master
 
602
 
 
603
        
 
604
class CommitToDoubleBoundBranch(BzrNewError):
 
605
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
606
    def __init__(self, branch, master, remote):
 
607
        BzrNewError.__init__(self)
 
608
        self.branch = branch
 
609
        self.master = master
 
610
        self.remote = remote
 
611
 
 
612
 
 
613
class OverwriteBoundBranch(BzrNewError):
 
614
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
615
    def __init__(self, branch):
 
616
        BzrNewError.__init__(self)
 
617
        self.branch = branch
 
618
 
 
619
 
 
620
class BoundBranchConnectionFailure(BzrNewError):
 
621
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
622
    def __init__(self, branch, target, error):
 
623
        BzrNewError.__init__(self)
 
624
        self.branch = branch
 
625
        self.target = target
 
626
        self.error = error
 
627
 
 
628
 
 
629
class WeaveError(BzrNewError):
 
630
    """Error in processing weave: %(message)s"""
 
631
 
 
632
    def __init__(self, message=None):
 
633
        BzrNewError.__init__(self)
 
634
        self.message = message
 
635
 
 
636
 
 
637
class WeaveRevisionAlreadyPresent(WeaveError):
 
638
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
639
    def __init__(self, revision_id, weave):
 
640
 
 
641
        WeaveError.__init__(self)
 
642
        self.revision_id = revision_id
 
643
        self.weave = weave
 
644
 
 
645
 
 
646
class WeaveRevisionNotPresent(WeaveError):
 
647
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
648
 
 
649
    def __init__(self, revision_id, weave):
 
650
        WeaveError.__init__(self)
 
651
        self.revision_id = revision_id
 
652
        self.weave = weave
 
653
 
 
654
 
 
655
class WeaveFormatError(WeaveError):
 
656
    """Weave invariant violated: %(what)s"""
 
657
 
 
658
    def __init__(self, what):
 
659
        WeaveError.__init__(self)
 
660
        self.what = what
 
661
 
 
662
 
 
663
class WeaveParentMismatch(WeaveError):
 
664
    """Parents are mismatched between two revisions."""
 
665
    
 
666
 
 
667
class WeaveInvalidChecksum(WeaveError):
 
668
    """Text did not match it's checksum: %(message)s"""
 
669
 
 
670
 
 
671
class WeaveTextDiffers(WeaveError):
 
672
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
673
 
 
674
    def __init__(self, revision_id, weave_a, weave_b):
 
675
        WeaveError.__init__(self)
 
676
        self.revision_id = revision_id
 
677
        self.weave_a = weave_a
 
678
        self.weave_b = weave_b
 
679
 
 
680
 
 
681
class WeaveTextDiffers(WeaveError):
 
682
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
683
 
 
684
    def __init__(self, revision_id, weave_a, weave_b):
 
685
        WeaveError.__init__(self)
 
686
        self.revision_id = revision_id
 
687
        self.weave_a = weave_a
 
688
        self.weave_b = weave_b
 
689
 
 
690
 
 
691
class VersionedFileError(BzrNewError):
 
692
    """Versioned file error."""
 
693
 
 
694
 
 
695
class RevisionNotPresent(VersionedFileError):
 
696
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
697
 
 
698
    def __init__(self, revision_id, file_id):
 
699
        VersionedFileError.__init__(self)
 
700
        self.revision_id = revision_id
 
701
        self.file_id = file_id
 
702
 
 
703
 
 
704
class RevisionAlreadyPresent(VersionedFileError):
 
705
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
706
 
 
707
    def __init__(self, revision_id, file_id):
 
708
        VersionedFileError.__init__(self)
 
709
        self.revision_id = revision_id
 
710
        self.file_id = file_id
 
711
 
 
712
 
 
713
class KnitError(BzrNewError):
 
714
    """Knit error"""
 
715
 
 
716
 
 
717
class KnitHeaderError(KnitError):
 
718
    """Knit header error: %(badline)r unexpected"""
 
719
 
 
720
    def __init__(self, badline):
 
721
        KnitError.__init__(self)
 
722
        self.badline = badline
 
723
 
 
724
 
 
725
class KnitCorrupt(KnitError):
 
726
    """Knit %(filename)s corrupt: %(how)s"""
 
727
 
 
728
    def __init__(self, filename, how):
 
729
        KnitError.__init__(self)
 
730
        self.filename = filename
 
731
        self.how = how
 
732
 
 
733
 
 
734
class NoSuchExportFormat(BzrNewError):
 
735
    """Export format %(format)r not supported"""
 
736
    def __init__(self, format):
 
737
        BzrNewError.__init__(self)
 
738
        self.format = format
 
739
 
 
740
 
 
741
class TransportError(BzrNewError):
 
742
    """Transport error: %(msg)s %(orig_error)s"""
 
743
 
 
744
    def __init__(self, msg=None, orig_error=None):
 
745
        if msg is None and orig_error is not None:
 
746
            msg = str(orig_error)
 
747
        if orig_error is None:
 
748
            orig_error = ''
 
749
        if msg is None:
 
750
            msg =  ''
 
751
        self.msg = msg
 
752
        self.orig_error = orig_error
 
753
        BzrNewError.__init__(self)
 
754
 
 
755
 
 
756
# A set of semi-meaningful errors which can be thrown
 
757
class TransportNotPossible(TransportError):
 
758
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
759
 
 
760
 
 
761
class ConnectionError(TransportError):
 
762
    """Connection error: %(msg)s %(orig_error)s"""
 
763
 
 
764
 
 
765
class ConnectionReset(TransportError):
 
766
    """Connection closed: %(msg)s %(orig_error)s"""
 
767
 
 
768
 
 
769
class InvalidRange(TransportError):
 
770
    """Invalid range access."""
 
771
    
 
772
    def __init__(self, path, offset):
 
773
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
774
                                       % (path, offset)))
 
775
 
 
776
 
 
777
class InvalidHttpResponse(TransportError):
 
778
    """Invalid http response for %(path)s: %(msg)s"""
 
779
 
 
780
    def __init__(self, path, msg, orig_error=None):
 
781
        self.path = path
 
782
        TransportError.__init__(self, msg, orig_error=orig_error)
 
783
 
 
784
 
 
785
class InvalidHttpRange(InvalidHttpResponse):
 
786
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
787
    
 
788
    def __init__(self, path, range, msg):
 
789
        self.range = range
 
790
        InvalidHttpResponse.__init__(self, path, msg)
 
791
 
 
792
 
 
793
class InvalidHttpContentType(InvalidHttpResponse):
 
794
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
795
    
 
796
    def __init__(self, path, ctype, msg):
 
797
        self.ctype = ctype
 
798
        InvalidHttpResponse.__init__(self, path, msg)
 
799
 
 
800
 
 
801
class ConflictsInTree(BzrError):
 
802
    def __init__(self):
 
803
        BzrError.__init__(self, "Working tree has conflicts.")
 
804
 
 
805
 
 
806
class ParseConfigError(BzrError):
 
807
    def __init__(self, errors, filename):
 
808
        if filename is None:
 
809
            filename = ""
 
810
        message = "Error(s) parsing config file %s:\n%s" % \
 
811
            (filename, ('\n'.join(e.message for e in errors)))
 
812
        BzrError.__init__(self, message)
 
813
 
 
814
 
 
815
class SigningFailed(BzrError):
 
816
    def __init__(self, command_line):
 
817
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
818
                               % command_line)
 
819
 
 
820
 
 
821
class WorkingTreeNotRevision(BzrError):
 
822
    def __init__(self, tree):
 
823
        BzrError.__init__(self, "The working tree for %s has changed since"
 
824
                          " last commit, but weave merge requires that it be"
 
825
                          " unchanged." % tree.basedir)
 
826
 
 
827
 
 
828
class CantReprocessAndShowBase(BzrNewError):
 
829
    """Can't reprocess and show base.
 
830
Reprocessing obscures relationship of conflicting lines to base."""
 
831
 
 
832
 
 
833
class GraphCycleError(BzrNewError):
 
834
    """Cycle in graph %(graph)r"""
 
835
    def __init__(self, graph):
 
836
        BzrNewError.__init__(self)
 
837
        self.graph = graph
 
838
 
 
839
 
 
840
class NotConflicted(BzrNewError):
 
841
    """File %(filename)s is not conflicted."""
 
842
 
 
843
    def __init__(self, filename):
 
844
        BzrNewError.__init__(self)
 
845
        self.filename = filename
 
846
 
 
847
 
 
848
class MustUseDecorated(Exception):
 
849
    """A decorating function has requested its original command be used.
 
850
    
 
851
    This should never escape bzr, so does not need to be printable.
 
852
    """
 
853
 
 
854
 
 
855
class NoBundleFound(BzrNewError):
 
856
    """No bundle was found in %(filename)s"""
 
857
    def __init__(self, filename):
 
858
        BzrNewError.__init__(self)
 
859
        self.filename = filename
 
860
 
 
861
 
 
862
class BundleNotSupported(BzrNewError):
 
863
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
864
    def __init__(self, version, msg):
 
865
        BzrNewError.__init__(self)
 
866
        self.version = version
 
867
        self.msg = msg
 
868
 
 
869
 
 
870
class MissingText(BzrNewError):
 
871
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
872
 
 
873
    def __init__(self, branch, text_revision, file_id):
 
874
        BzrNewError.__init__(self)
 
875
        self.branch = branch
 
876
        self.base = branch.base
 
877
        self.text_revision = text_revision
 
878
        self.file_id = file_id
 
879
 
 
880
 
 
881
class DuplicateKey(BzrNewError):
 
882
    """Key %(key)s is already present in map"""
 
883
 
 
884
 
 
885
class MalformedTransform(BzrNewError):
 
886
    """Tree transform is malformed %(conflicts)r"""
 
887
 
 
888
 
 
889
class BzrBadParameter(BzrNewError):
 
890
    """A bad parameter : %(param)s is not usable.
 
891
    
 
892
    This exception should never be thrown, but it is a base class for all
 
893
    parameter-to-function errors.
 
894
    """
 
895
    def __init__(self, param):
 
896
        BzrNewError.__init__(self)
 
897
        self.param = param
 
898
 
 
899
 
 
900
class BzrBadParameterNotUnicode(BzrBadParameter):
 
901
    """Parameter %(param)s is neither unicode nor utf8."""
 
902
 
 
903
 
 
904
class ReusingTransform(BzrNewError):
 
905
    """Attempt to reuse a transform that has already been applied."""
 
906
 
 
907
 
 
908
class CantMoveRoot(BzrNewError):
 
909
    """Moving the root directory is not supported at this time"""
 
910
 
 
911
 
 
912
class BzrBadParameterNotString(BzrBadParameter):
 
913
    """Parameter %(param)s is not a string or unicode string."""
 
914
 
 
915
 
 
916
class BzrBadParameterMissing(BzrBadParameter):
 
917
    """Parameter $(param)s is required but not present."""
 
918
 
 
919
 
 
920
class BzrBadParameterUnicode(BzrBadParameter):
 
921
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
922
 
 
923
 
 
924
class BzrBadParameterContainsNewline(BzrBadParameter):
 
925
    """Parameter %(param)s contains a newline."""
 
926
 
 
927
 
 
928
class DependencyNotPresent(BzrNewError):
 
929
    """Unable to import library "%(library)s": %(error)s"""
 
930
 
 
931
    def __init__(self, library, error):
 
932
        BzrNewError.__init__(self, library=library, error=error)
 
933
 
 
934
 
 
935
class ParamikoNotPresent(DependencyNotPresent):
 
936
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
937
 
 
938
    def __init__(self, error):
 
939
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
940
 
 
941
 
 
942
class UninitializableFormat(BzrNewError):
 
943
    """Format %(format)s cannot be initialised by this version of bzr."""
 
944
 
 
945
    def __init__(self, format):
 
946
        BzrNewError.__init__(self)
 
947
        self.format = format
 
948
 
 
949
 
 
950
class NoDiff(BzrNewError):
 
951
    """Diff is not installed on this machine: %(msg)s"""
 
952
 
 
953
    def __init__(self, msg):
 
954
        BzrNewError.__init__(self, msg=msg)
 
955
 
 
956
 
 
957
class NoDiff3(BzrNewError):
 
958
    """Diff3 is not installed on this machine."""
 
959
 
 
960
 
 
961
class ExistingLimbo(BzrNewError):
 
962
    """This tree contains left-over files from a failed operation.
 
963
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
964
    keep, and delete it when you are done.
 
965
    """
 
966
    def __init__(self, limbo_dir):
 
967
       BzrNewError.__init__(self)
 
968
       self.limbo_dir = limbo_dir
 
969
 
 
970
 
 
971
class ImmortalLimbo(BzrNewError):
 
972
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
973
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
974
    keep, and delete it when you are done.
 
975
    """
 
976
    def __init__(self, limbo_dir):
 
977
       BzrNewError.__init__(self)
 
978
       self.limbo_dir = limbo_dir
 
979
 
 
980
 
 
981
class OutOfDateTree(BzrNewError):
 
982
    """Working tree is out of date, please run 'bzr update'."""
 
983
 
 
984
    def __init__(self, tree):
 
985
        BzrNewError.__init__(self)
 
986
        self.tree = tree
 
987
 
 
988
 
 
989
class MergeModifiedFormatError(BzrNewError):
 
990
    """Error in merge modified format"""
 
991
 
 
992
 
 
993
class ConflictFormatError(BzrNewError):
 
994
    """Format error in conflict listings"""
 
995
 
 
996
 
 
997
class CorruptRepository(BzrNewError):
 
998
    """An error has been detected in the repository %(repo_path)s.
 
999
Please run bzr reconcile on this repository."""
 
1000
 
 
1001
    def __init__(self, repo):
 
1002
        BzrNewError.__init__(self)
 
1003
        self.repo_path = repo.bzrdir.root_transport.base
 
1004
 
 
1005
 
 
1006
class UpgradeRequired(BzrNewError):
 
1007
    """To use this feature you must upgrade your branch at %(path)s."""
 
1008
 
 
1009
    def __init__(self, path):
 
1010
        BzrNewError.__init__(self)
 
1011
        self.path = path
 
1012
 
 
1013
 
 
1014
class LocalRequiresBoundBranch(BzrNewError):
 
1015
    """Cannot perform local-only commits on unbound branches."""
 
1016
 
 
1017
 
 
1018
class MissingProgressBarFinish(BzrNewError):
 
1019
    """A nested progress bar was not 'finished' correctly."""
 
1020
 
 
1021
 
 
1022
class InvalidProgressBarType(BzrNewError):
 
1023
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1024
Select one of: %(valid_types)s"""
 
1025
 
 
1026
    def __init__(self, bar_type, valid_types):
 
1027
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1028
 
 
1029
 
 
1030
class UnsupportedOperation(BzrNewError):
 
1031
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
1032
    def __init__(self, method, method_self):
 
1033
        self.method = method
 
1034
        self.mname = method.__name__
 
1035
        self.tname = type(method_self).__name__
 
1036
 
 
1037
 
 
1038
class BinaryFile(BzrNewError):
 
1039
    """File is binary but should be text."""
 
1040
 
 
1041
 
 
1042
class IllegalPath(BzrNewError):
 
1043
    """The path %(path)s is not permitted on this platform"""
 
1044
 
 
1045
    def __init__(self, path):
 
1046
        BzrNewError.__init__(self)
 
1047
        self.path = path
 
1048
 
 
1049
 
 
1050
class TestamentMismatch(BzrNewError):
 
1051
    """Testament did not match expected value.  
 
1052
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1053
       {%(measured)s}
 
1054
    """
 
1055
    def __init__(self, revision_id, expected, measured):
 
1056
        self.revision_id = revision_id
 
1057
        self.expected = expected
 
1058
        self.measured = measured
 
1059
 
 
1060
 
 
1061
class NotABundle(BzrNewError):
 
1062
    """Not a bzr revision-bundle: %(text)r"""
 
1063
 
 
1064
    def __init__(self, text):
 
1065
        BzrNewError.__init__(self)
 
1066
        self.text = text
 
1067
 
 
1068
 
 
1069
class BadBundle(BzrNewError): 
 
1070
    """Bad bzr revision-bundle: %(text)r"""
 
1071
 
 
1072
    def __init__(self, text):
 
1073
        BzrNewError.__init__(self)
 
1074
        self.text = text
 
1075
 
 
1076
 
 
1077
class MalformedHeader(BadBundle): 
 
1078
    """Malformed bzr revision-bundle header: %(text)r"""
 
1079
 
 
1080
    def __init__(self, text):
 
1081
        BzrNewError.__init__(self)
 
1082
        self.text = text
 
1083
 
 
1084
 
 
1085
class MalformedPatches(BadBundle): 
 
1086
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
1087
 
 
1088
    def __init__(self, text):
 
1089
        BzrNewError.__init__(self)
 
1090
        self.text = text
 
1091
 
 
1092
 
 
1093
class MalformedFooter(BadBundle): 
 
1094
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
1095
 
 
1096
    def __init__(self, text):
 
1097
        BzrNewError.__init__(self)
 
1098
        self.text = text
 
1099
 
 
1100
 
 
1101
class UnsupportedEOLMarker(BadBundle):
 
1102
    """End of line marker was not \\n in bzr revision-bundle"""    
 
1103
 
 
1104
    def __init__(self):
 
1105
        BzrNewError.__init__(self)
 
1106
 
 
1107
 
 
1108
class GhostRevisionUnusableHere(BzrNewError):
 
1109
    """Ghost revision {%(revision_id)s} cannot be used here."""
 
1110
 
 
1111
    def __init__(self, revision_id):
 
1112
        BzrNewError.__init__(self)
 
1113
        self.revision_id = revision_id