~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2006-08-16 19:13:00 UTC
  • mfrom: (1934 +trunk)
  • mto: (1910.2.43 format-bumps)
  • mto: This revision was merged to the branch mainline in revision 1935.
  • Revision ID: abentley@panoramicfeedback.com-20060816191300-045772b26b975d1c
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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