/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-16 18:38:57 UTC
  • mfrom: (1934 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1937.
  • Revision ID: john@arbash-meinel.com-20060816183857-7307edffa7098bd2
[merge] bzr.dev 1934

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