/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2006-06-20 03:57:11 UTC
  • mto: This revision was merged to the branch mainline in revision 1798.
  • Revision ID: mbp@sourcefrog.net-20060620035711-400bb6b6bc6ff95b
Add pyflakes makefile target; fix many warnings

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
Exceptions are caught at a high level to report errors to the user, and
 
20
might also be caught inside the program.  Therefore it needs to be
 
21
possible to convert them to a meaningful string, and also for them to be
 
22
interrogated by the program.
 
23
 
 
24
Exceptions are defined such that the arguments given to the constructor
 
25
are stored in the object as properties of the same name.  When the
 
26
object is printed as a string, the doc string of the class is used as
 
27
a format string with the property dictionary available to it.
 
28
 
 
29
This means that exceptions can used like this:
 
30
 
 
31
>>> import sys
 
32
>>> try:
 
33
...   raise NotBranchError(path='/foo/bar')
 
34
... except:
 
35
...   print sys.exc_type
 
36
...   print sys.exc_value
 
37
...   path = getattr(sys.exc_value, 'path', None)
 
38
...   if path is not None:
 
39
...     print path
 
40
bzrlib.errors.NotBranchError
 
41
Not a branch: /foo/bar
 
42
/foo/bar
 
43
 
 
44
Therefore:
 
45
 
 
46
 * create a new exception class for any class of error that can be
 
47
   usefully distinguished.
 
48
 
 
49
 * the printable form of an exception is generated by the base class
 
50
   __str__ method
 
51
 
 
52
Exception strings should start with a capital letter and not have a final
 
53
fullstop.
 
54
"""
 
55
 
 
56
from warnings import warn
 
57
 
 
58
from bzrlib.patches import (PatchSyntax, 
 
59
                            PatchConflict, 
 
60
                            MalformedPatchHeader,
 
61
                            MalformedHunkHeader,
 
62
                            MalformedLine,)
 
63
 
 
64
 
 
65
# based on Scott James Remnant's hct error classes
 
66
 
 
67
# TODO: is there any value in providing the .args field used by standard
 
68
# python exceptions?   A list of values with no names seems less useful 
 
69
# to me.
 
70
 
 
71
# TODO: Perhaps convert the exception to a string at the moment it's 
 
72
# constructed to make sure it will succeed.  But that says nothing about
 
73
# exceptions that are never raised.
 
74
 
 
75
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
76
# the old one.
 
77
 
 
78
# TODO: The pattern (from hct) of using classes docstrings as message
 
79
# templates is cute but maybe not such a great idea - perhaps should have a
 
80
# separate static message_template.
 
81
 
 
82
 
 
83
class BzrError(StandardError):
 
84
    def __str__(self):
 
85
        # XXX: Should we show the exception class in 
 
86
        # exceptions that don't provide their own message?  
 
87
        # maybe it should be done at a higher level
 
88
        ## n = self.__class__.__name__ + ': '
 
89
        n = ''
 
90
        if len(self.args) == 1:
 
91
            return str(self.args[0])
 
92
        elif len(self.args) == 2:
 
93
            # further explanation or suggestions
 
94
            try:
 
95
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
96
            except TypeError:
 
97
                return n + "%r" % self
 
98
        else:
 
99
            return n + `self.args`
 
100
 
 
101
 
 
102
class BzrNewError(BzrError):
 
103
    """bzr error"""
 
104
    # base classes should override the docstring with their human-
 
105
    # readable explanation
 
106
 
 
107
    def __init__(self, **kwds):
 
108
        for key, value in kwds.items():
 
109
            setattr(self, key, value)
 
110
 
 
111
    def __str__(self):
 
112
        try:
 
113
            return self.__doc__ % self.__dict__
 
114
        except (NameError, ValueError, KeyError), e:
 
115
            return 'Unprintable exception %s: %s' \
 
116
                % (self.__class__.__name__, str(e))
 
117
 
 
118
 
 
119
class BzrCheckError(BzrNewError):
 
120
    """Internal check failed: %(message)s"""
 
121
 
 
122
    def __init__(self, message):
 
123
        BzrNewError.__init__(self)
 
124
        self.message = message
 
125
 
 
126
 
 
127
class InvalidEntryName(BzrNewError):
 
128
    """Invalid entry name: %(name)s"""
 
129
    def __init__(self, name):
 
130
        BzrNewError.__init__(self)
 
131
        self.name = name
 
132
 
 
133
 
 
134
class InvalidRevisionNumber(BzrNewError):
 
135
    """Invalid revision number %(revno)d"""
 
136
    def __init__(self, revno):
 
137
        BzrNewError.__init__(self)
 
138
        self.revno = revno
 
139
 
 
140
 
 
141
class InvalidRevisionId(BzrNewError):
 
142
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
143
    def __init__(self, revision_id, branch):
 
144
        # branch can be any string or object with __str__ defined
 
145
        BzrNewError.__init__(self)
 
146
        self.revision_id = revision_id
 
147
        self.branch = branch
 
148
 
 
149
 
 
150
class NoWorkingTree(BzrNewError):
 
151
    """No WorkingTree exists for %(base)s."""
 
152
    
 
153
    def __init__(self, base):
 
154
        BzrNewError.__init__(self)
 
155
        self.base = base
 
156
 
 
157
 
 
158
class NotLocalUrl(BzrNewError):
 
159
    """%(url)s is not a local path."""
 
160
    
 
161
    def __init__(self, url):
 
162
        BzrNewError.__init__(self)
 
163
        self.url = url
 
164
 
 
165
 
 
166
class BzrCommandError(BzrError):
 
167
    # Error from malformed user command
 
168
    # This is being misused as a generic exception
 
169
    # please subclass. RBC 20051030
 
170
    #
 
171
    # I think it's a waste of effort to differentiate between errors that
 
172
    # are not intended to be caught anyway.  UI code need not subclass
 
173
    # BzrCommandError, and non-UI code should not throw a subclass of
 
174
    # BzrCommandError.  ADHB 20051211
 
175
    def __str__(self):
 
176
        return self.args[0]
 
177
 
 
178
 
 
179
class BzrOptionError(BzrCommandError):
 
180
    """Some missing or otherwise incorrect option was supplied."""
 
181
 
 
182
    
 
183
class StrictCommitFailed(Exception):
 
184
    """Commit refused because there are unknowns in the tree."""
 
185
 
 
186
 
 
187
# XXX: Should be unified with TransportError; they seem to represent the
 
188
# same thing
 
189
class PathError(BzrNewError):
 
190
    """Generic path error: %(path)r%(extra)s)"""
 
191
 
 
192
    def __init__(self, path, extra=None):
 
193
        BzrNewError.__init__(self)
 
194
        self.path = path
 
195
        if extra:
 
196
            self.extra = ': ' + str(extra)
 
197
        else:
 
198
            self.extra = ''
 
199
 
 
200
 
 
201
class NoSuchFile(PathError):
 
202
    """No such file: %(path)r%(extra)s"""
 
203
 
 
204
 
 
205
class FileExists(PathError):
 
206
    """File exists: %(path)r%(extra)s"""
 
207
 
 
208
 
 
209
class DirectoryNotEmpty(PathError):
 
210
    """Directory not empty: %(path)r%(extra)s"""
 
211
 
 
212
 
 
213
class ResourceBusy(PathError):
 
214
    """Device or resource busy: %(path)r%(extra)s"""
 
215
 
 
216
 
 
217
class PermissionDenied(PathError):
 
218
    """Permission denied: %(path)r%(extra)s"""
 
219
 
 
220
 
 
221
class InvalidURL(PathError):
 
222
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
223
 
 
224
 
 
225
class InvalidURLJoin(PathError):
 
226
    """Invalid URL join request: %(args)s%(extra)s"""
 
227
 
 
228
    def __init__(self, msg, base, args):
 
229
        PathError.__init__(self, base, msg)
 
230
        self.args = [base]
 
231
        self.args.extend(args)
 
232
 
 
233
 
 
234
class PathNotChild(BzrNewError):
 
235
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
236
    def __init__(self, path, base, extra=None):
 
237
        BzrNewError.__init__(self)
 
238
        self.path = path
 
239
        self.base = base
 
240
        if extra:
 
241
            self.extra = ': ' + str(extra)
 
242
        else:
 
243
            self.extra = ''
 
244
 
 
245
 
 
246
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
247
# the exception object is a bit undesirable.
 
248
# TODO: Probably this behavior of should be a common superclass 
 
249
class NotBranchError(PathError):
 
250
    """Not a branch: %(path)s"""
 
251
 
 
252
    def __init__(self, path):
 
253
       import bzrlib.urlutils as urlutils
 
254
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
255
 
 
256
 
 
257
class AlreadyBranchError(PathError):
 
258
    """Already a branch: %(path)s."""
 
259
 
 
260
 
 
261
class BranchExistsWithoutWorkingTree(PathError):
 
262
    """Directory contains a branch, but no working tree \
 
263
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
264
 
 
265
 
 
266
class NoRepositoryPresent(BzrNewError):
 
267
    """No repository present: %(path)r"""
 
268
    def __init__(self, bzrdir):
 
269
        BzrNewError.__init__(self)
 
270
        self.path = bzrdir.transport.clone('..').base
 
271
 
 
272
 
 
273
class FileInWrongBranch(BzrNewError):
 
274
    """File %(path)s in not in branch %(branch_base)s."""
 
275
 
 
276
    def __init__(self, branch, path):
 
277
        BzrNewError.__init__(self)
 
278
        self.branch = branch
 
279
        self.branch_base = branch.base
 
280
        self.path = path
 
281
 
 
282
 
 
283
class UnsupportedFormatError(BzrError):
 
284
    """Specified path is a bzr branch that we recognize but cannot read."""
 
285
    def __str__(self):
 
286
        return 'unsupported branch format: %s' % self.args[0]
 
287
 
 
288
 
 
289
class UnknownFormatError(BzrError):
 
290
    """Specified path is a bzr branch whose format we do not recognize."""
 
291
    def __str__(self):
 
292
        return 'unknown branch format: %s' % self.args[0]
 
293
 
 
294
 
 
295
class IncompatibleFormat(BzrNewError):
 
296
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
297
 
 
298
    def __init__(self, format, bzrdir_format):
 
299
        BzrNewError.__init__(self)
 
300
        self.format = format
 
301
        self.bzrdir = bzrdir_format
 
302
 
 
303
 
 
304
class NotVersionedError(BzrNewError):
 
305
    """%(path)s is not versioned"""
 
306
    def __init__(self, path):
 
307
        BzrNewError.__init__(self)
 
308
        self.path = path
 
309
 
 
310
 
 
311
class PathsNotVersionedError(BzrNewError):
 
312
    # used when reporting several paths are not versioned
 
313
    """Path(s) are not versioned: %(paths_as_string)s"""
 
314
 
 
315
    def __init__(self, paths):
 
316
        from bzrlib.osutils import quotefn
 
317
        BzrNewError.__init__(self)
 
318
        self.paths = paths
 
319
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
320
 
 
321
 
 
322
class PathsDoNotExist(BzrNewError):
 
323
    """Path(s) do not exist: %(paths_as_string)s"""
 
324
 
 
325
    # used when reporting that paths are neither versioned nor in the working
 
326
    # tree
 
327
 
 
328
    def __init__(self, paths):
 
329
        # circular import
 
330
        from bzrlib.osutils import quotefn
 
331
        BzrNewError.__init__(self)
 
332
        self.paths = paths
 
333
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
334
 
 
335
 
 
336
class BadFileKindError(BzrNewError):
 
337
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
338
 
 
339
 
 
340
class ForbiddenFileError(BzrNewError):
 
341
    """Cannot operate on %(filename)s because it is a control file"""
 
342
 
 
343
 
 
344
class LockError(BzrNewError):
 
345
    """Lock error: %(message)s"""
 
346
    # All exceptions from the lock/unlock functions should be from
 
347
    # this exception class.  They will be translated as necessary. The
 
348
    # original exception is available as e.original_error
 
349
    #
 
350
    # New code should prefer to raise specific subclasses
 
351
    def __init__(self, message):
 
352
        self.message = message
 
353
 
 
354
 
 
355
class CommitNotPossible(LockError):
 
356
    """A commit was attempted but we do not have a write lock open."""
 
357
    def __init__(self):
 
358
        pass
 
359
 
 
360
 
 
361
class AlreadyCommitted(LockError):
 
362
    """A rollback was requested, but is not able to be accomplished."""
 
363
    def __init__(self):
 
364
        pass
 
365
 
 
366
 
 
367
class ReadOnlyError(LockError):
 
368
    """A write attempt was made in a read only transaction on %(obj)s"""
 
369
    def __init__(self, obj):
 
370
        self.obj = obj
 
371
 
 
372
 
 
373
class OutSideTransaction(BzrNewError):
 
374
    """A transaction related operation was attempted after the transaction finished."""
 
375
 
 
376
 
 
377
class ObjectNotLocked(LockError):
 
378
    """%(obj)r is not locked"""
 
379
    # this can indicate that any particular object is not locked; see also
 
380
    # LockNotHeld which means that a particular *lock* object is not held by
 
381
    # the caller -- perhaps they should be unified.
 
382
    def __init__(self, obj):
 
383
        self.obj = obj
 
384
 
 
385
 
 
386
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
387
    """Cannot change object %(obj)r in read only transaction"""
 
388
    def __init__(self, obj):
 
389
        self.obj = obj
 
390
 
 
391
 
 
392
class UnlockableTransport(LockError):
 
393
    """Cannot lock: transport is read only: %(transport)s"""
 
394
    def __init__(self, transport):
 
395
        self.transport = transport
 
396
 
 
397
 
 
398
class LockContention(LockError):
 
399
    """Could not acquire lock %(lock)s"""
 
400
    # TODO: show full url for lock, combining the transport and relative bits?
 
401
    def __init__(self, lock):
 
402
        self.lock = lock
 
403
 
 
404
 
 
405
class LockBroken(LockError):
 
406
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
407
    def __init__(self, lock):
 
408
        self.lock = lock
 
409
 
 
410
 
 
411
class LockBreakMismatch(LockError):
 
412
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
413
    def __init__(self, lock, holder, target):
 
414
        self.lock = lock
 
415
        self.holder = holder
 
416
        self.target = target
 
417
 
 
418
 
 
419
class LockNotHeld(LockError):
 
420
    """Lock not held: %(lock)s"""
 
421
    def __init__(self, lock):
 
422
        self.lock = lock
 
423
 
 
424
 
 
425
class PointlessCommit(BzrNewError):
 
426
    """No changes to commit"""
 
427
 
 
428
 
 
429
class UpgradeReadonly(BzrNewError):
 
430
    """Upgrade URL cannot work with readonly URL's."""
 
431
 
 
432
 
 
433
class UpToDateFormat(BzrNewError):
 
434
    """The branch format %(format)s is already at the most recent format."""
 
435
 
 
436
    def __init__(self, format):
 
437
        BzrNewError.__init__(self)
 
438
        self.format = format
 
439
 
 
440
 
 
441
 
 
442
class StrictCommitFailed(Exception):
 
443
    """Commit refused because there are unknowns in the tree."""
 
444
 
 
445
 
 
446
class NoSuchRevision(BzrError):
 
447
    def __init__(self, branch, revision):
 
448
        self.branch = branch
 
449
        self.revision = revision
 
450
        msg = "Branch %s has no revision %s" % (branch, revision)
 
451
        BzrError.__init__(self, msg)
 
452
 
 
453
 
 
454
class HistoryMissing(BzrError):
 
455
    def __init__(self, branch, object_type, object_id):
 
456
        self.branch = branch
 
457
        BzrError.__init__(self,
 
458
                          '%s is missing %s {%s}'
 
459
                          % (branch, object_type, object_id))
 
460
 
 
461
 
 
462
class DivergedBranches(BzrError):
 
463
 
 
464
    def __init__(self, branch1, branch2):
 
465
        BzrError.__init__(self, "These branches have diverged.  Try merge.")
 
466
        self.branch1 = branch1
 
467
        self.branch2 = branch2
 
468
 
 
469
 
 
470
class UnrelatedBranches(BzrCommandError):
 
471
    def __init__(self):
 
472
        msg = "Branches have no common ancestor, and no base revision"\
 
473
            " specified."
 
474
        BzrCommandError.__init__(self, msg)
 
475
 
 
476
 
 
477
class NoCommonAncestor(BzrError):
 
478
    def __init__(self, revision_a, revision_b):
 
479
        msg = "Revisions have no common ancestor: %s %s." \
 
480
            % (revision_a, revision_b) 
 
481
        BzrError.__init__(self, msg)
 
482
 
 
483
 
 
484
class NoCommonRoot(BzrError):
 
485
    def __init__(self, revision_a, revision_b):
 
486
        msg = "Revisions are not derived from the same root: %s %s." \
 
487
            % (revision_a, revision_b) 
 
488
        BzrError.__init__(self, msg)
 
489
 
 
490
 
 
491
 
 
492
class NotAncestor(BzrError):
 
493
    def __init__(self, rev_id, not_ancestor_id):
 
494
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
495
                                                        rev_id)
 
496
        BzrError.__init__(self, msg)
 
497
        self.rev_id = rev_id
 
498
        self.not_ancestor_id = not_ancestor_id
 
499
 
 
500
 
 
501
class InstallFailed(BzrError):
 
502
    def __init__(self, revisions):
 
503
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
504
        BzrError.__init__(self, msg)
 
505
        self.revisions = revisions
 
506
 
 
507
 
 
508
class AmbiguousBase(BzrError):
 
509
    def __init__(self, bases):
 
510
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
511
                DeprecationWarning)
 
512
        msg = "The correct base is unclear, because %s are all equally close" %\
 
513
            ", ".join(bases)
 
514
        BzrError.__init__(self, msg)
 
515
        self.bases = bases
 
516
 
 
517
 
 
518
class NoCommits(BzrError):
 
519
    def __init__(self, branch):
 
520
        msg = "Branch %s has no commits." % branch
 
521
        BzrError.__init__(self, msg)
 
522
 
 
523
 
 
524
class UnlistableStore(BzrError):
 
525
    def __init__(self, store):
 
526
        BzrError.__init__(self, "Store %s is not listable" % store)
 
527
 
 
528
 
 
529
 
 
530
class UnlistableBranch(BzrError):
 
531
    def __init__(self, br):
 
532
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
533
 
 
534
 
 
535
class BoundBranchOutOfDate(BzrNewError):
 
536
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
537
    def __init__(self, branch, master):
 
538
        BzrNewError.__init__(self)
 
539
        self.branch = branch
 
540
        self.master = master
 
541
 
 
542
        
 
543
class CommitToDoubleBoundBranch(BzrNewError):
 
544
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
545
    def __init__(self, branch, master, remote):
 
546
        BzrNewError.__init__(self)
 
547
        self.branch = branch
 
548
        self.master = master
 
549
        self.remote = remote
 
550
 
 
551
 
 
552
class OverwriteBoundBranch(BzrNewError):
 
553
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
554
    def __init__(self, branch):
 
555
        BzrNewError.__init__(self)
 
556
        self.branch = branch
 
557
 
 
558
 
 
559
class BoundBranchConnectionFailure(BzrNewError):
 
560
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
561
    def __init__(self, branch, target, error):
 
562
        BzrNewError.__init__(self)
 
563
        self.branch = branch
 
564
        self.target = target
 
565
        self.error = error
 
566
 
 
567
 
 
568
class WeaveError(BzrNewError):
 
569
    """Error in processing weave: %(message)s"""
 
570
 
 
571
    def __init__(self, message=None):
 
572
        BzrNewError.__init__(self)
 
573
        self.message = message
 
574
 
 
575
 
 
576
class WeaveRevisionAlreadyPresent(WeaveError):
 
577
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
578
    def __init__(self, revision_id, weave):
 
579
 
 
580
        WeaveError.__init__(self)
 
581
        self.revision_id = revision_id
 
582
        self.weave = weave
 
583
 
 
584
 
 
585
class WeaveRevisionNotPresent(WeaveError):
 
586
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
587
 
 
588
    def __init__(self, revision_id, weave):
 
589
        WeaveError.__init__(self)
 
590
        self.revision_id = revision_id
 
591
        self.weave = weave
 
592
 
 
593
 
 
594
class WeaveFormatError(WeaveError):
 
595
    """Weave invariant violated: %(what)s"""
 
596
 
 
597
    def __init__(self, what):
 
598
        WeaveError.__init__(self)
 
599
        self.what = what
 
600
 
 
601
 
 
602
class WeaveParentMismatch(WeaveError):
 
603
    """Parents are mismatched between two revisions."""
 
604
    
 
605
 
 
606
class WeaveInvalidChecksum(WeaveError):
 
607
    """Text did not match it's checksum: %(message)s"""
 
608
 
 
609
 
 
610
class WeaveTextDiffers(WeaveError):
 
611
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
612
 
 
613
    def __init__(self, revision_id, weave_a, weave_b):
 
614
        WeaveError.__init__(self)
 
615
        self.revision_id = revision_id
 
616
        self.weave_a = weave_a
 
617
        self.weave_b = weave_b
 
618
 
 
619
 
 
620
class WeaveTextDiffers(WeaveError):
 
621
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
622
 
 
623
    def __init__(self, revision_id, weave_a, weave_b):
 
624
        WeaveError.__init__(self)
 
625
        self.revision_id = revision_id
 
626
        self.weave_a = weave_a
 
627
        self.weave_b = weave_b
 
628
 
 
629
 
 
630
class VersionedFileError(BzrNewError):
 
631
    """Versioned file error."""
 
632
 
 
633
 
 
634
class RevisionNotPresent(VersionedFileError):
 
635
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
636
 
 
637
    def __init__(self, revision_id, file_id):
 
638
        VersionedFileError.__init__(self)
 
639
        self.revision_id = revision_id
 
640
        self.file_id = file_id
 
641
 
 
642
 
 
643
class RevisionAlreadyPresent(VersionedFileError):
 
644
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
645
 
 
646
    def __init__(self, revision_id, file_id):
 
647
        VersionedFileError.__init__(self)
 
648
        self.revision_id = revision_id
 
649
        self.file_id = file_id
 
650
 
 
651
 
 
652
class KnitError(BzrNewError):
 
653
    """Knit error"""
 
654
 
 
655
 
 
656
class KnitHeaderError(KnitError):
 
657
    """Knit header error: %(badline)r unexpected"""
 
658
 
 
659
    def __init__(self, badline):
 
660
        KnitError.__init__(self)
 
661
        self.badline = badline
 
662
 
 
663
 
 
664
class KnitCorrupt(KnitError):
 
665
    """Knit %(filename)s corrupt: %(how)s"""
 
666
 
 
667
    def __init__(self, filename, how):
 
668
        KnitError.__init__(self)
 
669
        self.filename = filename
 
670
        self.how = how
 
671
 
 
672
 
 
673
class NoSuchExportFormat(BzrNewError):
 
674
    """Export format %(format)r not supported"""
 
675
    def __init__(self, format):
 
676
        BzrNewError.__init__(self)
 
677
        self.format = format
 
678
 
 
679
 
 
680
class TransportError(BzrError):
 
681
    """All errors thrown by Transport implementations should derive
 
682
    from this class.
 
683
    """
 
684
    def __init__(self, msg=None, orig_error=None):
 
685
        if msg is None and orig_error is not None:
 
686
            msg = str(orig_error)
 
687
        BzrError.__init__(self, msg)
 
688
        self.msg = msg
 
689
        self.orig_error = orig_error
 
690
 
 
691
 
 
692
# A set of semi-meaningful errors which can be thrown
 
693
class TransportNotPossible(TransportError):
 
694
    """This is for transports where a specific function is explicitly not
 
695
    possible. Such as pushing files to an HTTP server.
 
696
    """
 
697
    pass
 
698
 
 
699
 
 
700
class ConnectionError(TransportError):
 
701
    """A connection problem prevents file retrieval.
 
702
    This does not indicate whether the file exists or not; it indicates that a
 
703
    precondition for requesting the file was not met.
 
704
    """
 
705
    def __init__(self, msg=None, orig_error=None):
 
706
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
707
 
 
708
 
 
709
class ConnectionReset(TransportError):
 
710
    """The connection has been closed."""
 
711
    pass
 
712
 
 
713
 
 
714
class ConflictsInTree(BzrError):
 
715
    def __init__(self):
 
716
        BzrError.__init__(self, "Working tree has conflicts.")
 
717
 
 
718
 
 
719
class ParseConfigError(BzrError):
 
720
    def __init__(self, errors, filename):
 
721
        if filename is None:
 
722
            filename = ""
 
723
        message = "Error(s) parsing config file %s:\n%s" % \
 
724
            (filename, ('\n'.join(e.message for e in errors)))
 
725
        BzrError.__init__(self, message)
 
726
 
 
727
 
 
728
class SigningFailed(BzrError):
 
729
    def __init__(self, command_line):
 
730
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
731
                               % command_line)
 
732
 
 
733
 
 
734
class WorkingTreeNotRevision(BzrError):
 
735
    def __init__(self, tree):
 
736
        BzrError.__init__(self, "The working tree for %s has changed since"
 
737
                          " last commit, but weave merge requires that it be"
 
738
                          " unchanged." % tree.basedir)
 
739
 
 
740
 
 
741
class CantReprocessAndShowBase(BzrNewError):
 
742
    """Can't reprocess and show base.
 
743
Reprocessing obscures relationship of conflicting lines to base."""
 
744
 
 
745
 
 
746
class GraphCycleError(BzrNewError):
 
747
    """Cycle in graph %(graph)r"""
 
748
    def __init__(self, graph):
 
749
        BzrNewError.__init__(self)
 
750
        self.graph = graph
 
751
 
 
752
 
 
753
class NotConflicted(BzrNewError):
 
754
    """File %(filename)s is not conflicted."""
 
755
 
 
756
    def __init__(self, filename):
 
757
        BzrNewError.__init__(self)
 
758
        self.filename = filename
 
759
 
 
760
 
 
761
class MustUseDecorated(Exception):
 
762
    """A decorating function has requested its original command be used.
 
763
    
 
764
    This should never escape bzr, so does not need to be printable.
 
765
    """
 
766
 
 
767
 
 
768
class NoBundleFound(BzrNewError):
 
769
    """No bundle was found in %(filename)s"""
 
770
    def __init__(self, filename):
 
771
        BzrNewError.__init__(self)
 
772
        self.filename = filename
 
773
 
 
774
 
 
775
class BundleNotSupported(BzrNewError):
 
776
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
777
    def __init__(self, version, msg):
 
778
        BzrNewError.__init__(self)
 
779
        self.version = version
 
780
        self.msg = msg
 
781
 
 
782
 
 
783
class MissingText(BzrNewError):
 
784
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
785
 
 
786
    def __init__(self, branch, text_revision, file_id):
 
787
        BzrNewError.__init__(self)
 
788
        self.branch = branch
 
789
        self.base = branch.base
 
790
        self.text_revision = text_revision
 
791
        self.file_id = file_id
 
792
 
 
793
 
 
794
class DuplicateKey(BzrNewError):
 
795
    """Key %(key)s is already present in map"""
 
796
 
 
797
 
 
798
class MalformedTransform(BzrNewError):
 
799
    """Tree transform is malformed %(conflicts)r"""
 
800
 
 
801
 
 
802
class BzrBadParameter(BzrNewError):
 
803
    """A bad parameter : %(param)s is not usable.
 
804
    
 
805
    This exception should never be thrown, but it is a base class for all
 
806
    parameter-to-function errors.
 
807
    """
 
808
    def __init__(self, param):
 
809
        BzrNewError.__init__(self)
 
810
        self.param = param
 
811
 
 
812
 
 
813
class BzrBadParameterNotUnicode(BzrBadParameter):
 
814
    """Parameter %(param)s is neither unicode nor utf8."""
 
815
 
 
816
 
 
817
class ReusingTransform(BzrNewError):
 
818
    """Attempt to reuse a transform that has already been applied."""
 
819
 
 
820
 
 
821
class CantMoveRoot(BzrNewError):
 
822
    """Moving the root directory is not supported at this time"""
 
823
 
 
824
 
 
825
class BzrBadParameterNotString(BzrBadParameter):
 
826
    """Parameter %(param)s is not a string or unicode string."""
 
827
 
 
828
 
 
829
class BzrBadParameterMissing(BzrBadParameter):
 
830
    """Parameter $(param)s is required but not present."""
 
831
 
 
832
 
 
833
class BzrBadParameterUnicode(BzrBadParameter):
 
834
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
835
 
 
836
 
 
837
class BzrBadParameterContainsNewline(BzrBadParameter):
 
838
    """Parameter %(param)s contains a newline."""
 
839
 
 
840
 
 
841
class DependencyNotPresent(BzrNewError):
 
842
    """Unable to import library "%(library)s": %(error)s"""
 
843
 
 
844
    def __init__(self, library, error):
 
845
        BzrNewError.__init__(self, library=library, error=error)
 
846
 
 
847
 
 
848
class ParamikoNotPresent(DependencyNotPresent):
 
849
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
850
 
 
851
    def __init__(self, error):
 
852
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
853
 
 
854
 
 
855
class UninitializableFormat(BzrNewError):
 
856
    """Format %(format)s cannot be initialised by this version of bzr."""
 
857
 
 
858
    def __init__(self, format):
 
859
        BzrNewError.__init__(self)
 
860
        self.format = format
 
861
 
 
862
 
 
863
class NoDiff3(BzrNewError):
 
864
    """Diff3 is not installed on this machine."""
 
865
 
 
866
 
 
867
class ExistingLimbo(BzrNewError):
 
868
    """This tree contains left-over files from a failed operation.
 
869
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
870
    keep, and delete it when you are done.
 
871
    """
 
872
    def __init__(self, limbo_dir):
 
873
       BzrNewError.__init__(self)
 
874
       self.limbo_dir = limbo_dir
 
875
 
 
876
 
 
877
class ImmortalLimbo(BzrNewError):
 
878
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
879
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
880
    keep, and delete it when you are done.
 
881
    """
 
882
    def __init__(self, limbo_dir):
 
883
       BzrNewError.__init__(self)
 
884
       self.limbo_dir = limbo_dir
 
885
 
 
886
 
 
887
class OutOfDateTree(BzrNewError):
 
888
    """Working tree is out of date, please run 'bzr update'."""
 
889
 
 
890
    def __init__(self, tree):
 
891
        BzrNewError.__init__(self)
 
892
        self.tree = tree
 
893
 
 
894
 
 
895
class MergeModifiedFormatError(BzrNewError):
 
896
    """Error in merge modified format"""
 
897
 
 
898
 
 
899
class ConflictFormatError(BzrNewError):
 
900
    """Format error in conflict listings"""
 
901
 
 
902
 
 
903
class CorruptRepository(BzrNewError):
 
904
    """An error has been detected in the repository %(repo_path)s.
 
905
Please run bzr reconcile on this repository."""
 
906
 
 
907
    def __init__(self, repo):
 
908
        BzrNewError.__init__(self)
 
909
        self.repo_path = repo.bzrdir.root_transport.base
 
910
 
 
911
 
 
912
class UpgradeRequired(BzrNewError):
 
913
    """To use this feature you must upgrade your branch at %(path)s."""
 
914
 
 
915
    def __init__(self, path):
 
916
        BzrNewError.__init__(self)
 
917
        self.path = path
 
918
 
 
919
 
 
920
class LocalRequiresBoundBranch(BzrNewError):
 
921
    """Cannot perform local-only commits on unbound branches."""
 
922
 
 
923
 
 
924
class MissingProgressBarFinish(BzrNewError):
 
925
    """A nested progress bar was not 'finished' correctly."""
 
926
 
 
927
 
 
928
class UnsupportedOperation(BzrNewError):
 
929
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
930
    def __init__(self, method, method_self):
 
931
        self.method = method
 
932
        self.mname = method.__name__
 
933
        self.tname = type(method_self).__name__
 
934
 
 
935
 
 
936
class BinaryFile(BzrNewError):
 
937
    """File is binary but should be text."""
 
938
 
 
939
 
 
940
class IllegalPath(BzrNewError):
 
941
    """The path %(path)s is not permitted on this platform"""
 
942
 
 
943
    def __init__(self, path):
 
944
        BzrNewError.__init__(self)
 
945
        self.path = path
 
946
 
 
947
 
 
948
class TestamentMismatch(BzrNewError):
 
949
    """Testament did not match expected value.  
 
950
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
951
       {%(measured)s}
 
952
    """
 
953
    def __init__(self, revision_id, expected, measured):
 
954
        self.revision_id = revision_id
 
955
        self.expected = expected
 
956
        self.measured = measured
 
957
 
 
958
 
 
959
class NotABundle(BzrNewError):
 
960
    """Not a bzr revision-bundle: %(text)r"""
 
961
 
 
962
    def __init__(self, text):
 
963
        self.text = text
 
964
 
 
965
 
 
966
class BadBundle(Exception): pass
 
967
 
 
968
 
 
969
class MalformedHeader(BadBundle): pass
 
970
 
 
971
 
 
972
class MalformedPatches(BadBundle): pass
 
973
 
 
974
 
 
975
class MalformedFooter(BadBundle): pass