/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: John Arbash Meinel
  • Date: 2006-08-09 14:43:27 UTC
  • mto: This revision was merged to the branch mainline in revision 1912.
  • Revision ID: john@arbash-meinel.com-20060809144327-d604af2edf646794
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size

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