~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Martin Pool
  • Date: 2005-05-30 01:39:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050530013913-4ac43c29e1302170
- make sure any bzr output is flushed before 
  running external diff

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
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
 
 
 
18
 
 
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
20
__author__ = "Martin Pool <mbp@canonical.com>"
 
21
 
 
22
 
 
23
######################################################################
 
24
# exceptions 
96
25
class BzrError(StandardError):
97
 
    
98
 
    is_user_error = True
99
 
    
100
 
    def __str__(self):
101
 
        # XXX: Should we show the exception class in 
102
 
        # exceptions that don't provide their own message?  
103
 
        # maybe it should be done at a higher level
104
 
        ## n = self.__class__.__name__ + ': '
105
 
        n = ''
106
 
        if len(self.args) == 1:
107
 
            return str(self.args[0])
108
 
        elif len(self.args) == 2:
109
 
            # further explanation or suggestions
110
 
            try:
111
 
                return n + '\n  '.join([self.args[0]] + self.args[1])
112
 
            except TypeError:
113
 
                return n + "%r" % self
114
 
        else:
115
 
            return n + `self.args`
116
 
 
117
 
 
118
 
class BzrNewError(BzrError):
119
 
    """bzr error"""
120
 
    # base classes should override the docstring with their human-
121
 
    # readable explanation
122
 
 
123
 
    def __init__(self, **kwds):
124
 
        for key, value in kwds.items():
125
 
            setattr(self, key, value)
126
 
 
127
 
    def __str__(self):
128
 
        try:
129
 
            return self.__doc__ % self.__dict__
130
 
        except (NameError, ValueError, KeyError), e:
131
 
            return 'Unprintable exception %s: %s' \
132
 
                % (self.__class__.__name__, str(e))
133
 
 
134
 
 
135
 
class BzrCheckError(BzrNewError):
136
 
    """Internal check failed: %(message)s"""
137
 
 
138
 
    is_user_error = False
139
 
 
140
 
    def __init__(self, message):
141
 
        BzrNewError.__init__(self)
142
 
        self.message = message
143
 
 
144
 
 
145
 
class InvalidEntryName(BzrNewError):
146
 
    """Invalid entry name: %(name)s"""
147
 
 
148
 
    is_user_error = False
149
 
 
150
 
    def __init__(self, name):
151
 
        BzrNewError.__init__(self)
152
 
        self.name = name
153
 
 
154
 
 
155
 
class InvalidRevisionNumber(BzrNewError):
156
 
    """Invalid revision number %(revno)d"""
157
 
    def __init__(self, revno):
158
 
        BzrNewError.__init__(self)
159
 
        self.revno = revno
160
 
 
161
 
 
162
 
class InvalidRevisionId(BzrNewError):
163
 
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
164
 
    def __init__(self, revision_id, branch):
165
 
        # branch can be any string or object with __str__ defined
166
 
        BzrNewError.__init__(self)
167
 
        self.revision_id = revision_id
168
 
        self.branch = branch
169
 
 
170
 
 
171
 
class NoWorkingTree(BzrNewError):
172
 
    """No WorkingTree exists for %(base)s."""
173
 
    
174
 
    def __init__(self, base):
175
 
        BzrNewError.__init__(self)
176
 
        self.base = base
177
 
 
178
 
 
179
 
class NotLocalUrl(BzrNewError):
180
 
    """%(url)s is not a local path."""
181
 
    
182
 
    def __init__(self, url):
183
 
        BzrNewError.__init__(self)
184
 
        self.url = url
185
 
 
186
 
 
187
 
class BzrCommandError(BzrNewError):
188
 
    """Error from user command"""
189
 
 
190
 
    is_user_error = True
191
 
 
192
 
    # Error from malformed user command; please avoid raising this as a
193
 
    # generic exception not caused by user input.
194
 
    #
195
 
    # I think it's a waste of effort to differentiate between errors that
196
 
    # are not intended to be caught anyway.  UI code need not subclass
197
 
    # BzrCommandError, and non-UI code should not throw a subclass of
198
 
    # BzrCommandError.  ADHB 20051211
199
 
    def __init__(self, msg):
200
 
        self.msg = msg
201
 
 
202
 
    def __str__(self):
203
 
        return self.msg
204
 
 
205
 
 
206
 
class BzrOptionError(BzrCommandError):
207
 
    """Error in command line options"""
208
 
 
209
 
    
210
 
class StrictCommitFailed(BzrNewError):
211
 
    """Commit refused because there are unknown files in the tree"""
212
 
 
213
 
 
214
 
# XXX: Should be unified with TransportError; they seem to represent the
215
 
# same thing
216
 
class PathError(BzrNewError):
217
 
    """Generic path error: %(path)r%(extra)s)"""
218
 
 
219
 
    def __init__(self, path, extra=None):
220
 
        BzrNewError.__init__(self)
221
 
        self.path = path
222
 
        if extra:
223
 
            self.extra = ': ' + str(extra)
224
 
        else:
225
 
            self.extra = ''
226
 
 
227
 
 
228
 
class NoSuchFile(PathError):
229
 
    """No such file: %(path)r%(extra)s"""
230
 
 
231
 
 
232
 
class FileExists(PathError):
233
 
    """File exists: %(path)r%(extra)s"""
234
 
 
235
 
 
236
 
class DirectoryNotEmpty(PathError):
237
 
    """Directory not empty: %(path)r%(extra)s"""
238
 
 
239
 
 
240
 
class ResourceBusy(PathError):
241
 
    """Device or resource busy: %(path)r%(extra)s"""
242
 
 
243
 
 
244
 
class PermissionDenied(PathError):
245
 
    """Permission denied: %(path)r%(extra)s"""
246
 
 
247
 
 
248
 
class InvalidURL(PathError):
249
 
    """Invalid url supplied to transport: %(path)r%(extra)s"""
250
 
 
251
 
 
252
 
class InvalidURLJoin(PathError):
253
 
    """Invalid URL join request: %(args)s%(extra)s"""
254
 
 
255
 
    def __init__(self, msg, base, args):
256
 
        PathError.__init__(self, base, msg)
257
 
        self.args = [base]
258
 
        self.args.extend(args)
259
 
 
260
 
 
261
 
class UnsupportedProtocol(PathError):
262
 
    """Unsupported protocol for url "%(path)s"%(extra)s"""
263
 
 
264
 
    def __init__(self, url, extra):
265
 
        PathError.__init__(self, url, extra=extra)
266
 
 
267
 
 
268
 
class PathNotChild(BzrNewError):
269
 
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
270
 
 
271
 
    is_user_error = False
272
 
 
273
 
    def __init__(self, path, base, extra=None):
274
 
        BzrNewError.__init__(self)
275
 
        self.path = path
276
 
        self.base = base
277
 
        if extra:
278
 
            self.extra = ': ' + str(extra)
279
 
        else:
280
 
            self.extra = ''
281
 
 
282
 
 
283
 
class InvalidNormalization(PathError):
284
 
    """Path %(path)r is not unicode normalized"""
285
 
 
286
 
 
287
 
# TODO: This is given a URL; we try to unescape it but doing that from inside
288
 
# the exception object is a bit undesirable.
289
 
# TODO: Probably this behavior of should be a common superclass 
290
 
class NotBranchError(PathError):
291
 
    """Not a branch: %(path)s"""
292
 
 
293
 
    def __init__(self, path):
294
 
       import bzrlib.urlutils as urlutils
295
 
       self.path = urlutils.unescape_for_display(path, 'ascii')
296
 
 
297
 
 
298
 
class AlreadyBranchError(PathError):
299
 
    """Already a branch: %(path)s."""
300
 
 
301
 
 
302
 
class BranchExistsWithoutWorkingTree(PathError):
303
 
    """Directory contains a branch, but no working tree \
304
 
(use bzr checkout if you wish to build a working tree): %(path)s"""
305
 
 
306
 
 
307
 
class AtomicFileAlreadyClosed(PathError):
308
 
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
309
 
 
310
 
    def __init__(self, path, function):
311
 
        PathError.__init__(self, path=path, extra=None)
312
 
        self.function = function
313
 
 
314
 
 
315
 
class 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
 
class StrictCommitFailed(Exception):
498
 
    """Commit refused because there are unknowns in the tree."""
499
 
 
500
 
 
501
 
class NoSuchRevision(BzrNewError):
502
 
    """Branch %(branch)s has no revision %(revision)s"""
503
 
 
504
 
    is_user_error = False
505
 
 
506
 
    def __init__(self, branch, revision):
507
 
        BzrNewError.__init__(self, branch=branch, revision=revision)
508
 
 
509
 
 
510
 
# Inheriting from NoSuchRevision to maintain API compatibility
511
 
# technically, this could be a completely different exception
512
 
class InvalidRevisionSpec(NoSuchRevision):
513
 
    """Requested revision: %(spec)s does not exist in branch: %(branch)s%(extra)s"""
514
 
 
515
 
    is_user_error = True
516
 
 
517
 
    def __init__(self, spec, branch, extra=None):
518
 
        NoSuchRevision.__init__(self, branch=branch, revision=spec)
519
 
        self.spec = spec
520
 
        if extra:
521
 
            self.extra = '; ' + str(extra)
522
 
        else:
523
 
            self.extra = ''
524
 
 
525
 
 
526
 
class HistoryMissing(BzrError):
527
 
    def __init__(self, branch, object_type, object_id):
528
 
        self.branch = branch
529
 
        BzrError.__init__(self,
530
 
                          '%s is missing %s {%s}'
531
 
                          % (branch, object_type, object_id))
532
 
 
533
 
 
534
 
class DivergedBranches(BzrNewError):
535
 
    "These branches have diverged.  Use the merge command to reconcile them."""
536
 
 
537
 
    is_user_error = True
538
 
 
539
 
    def __init__(self, branch1, branch2):
540
 
        self.branch1 = branch1
541
 
        self.branch2 = branch2
542
 
 
543
 
 
544
 
class UnrelatedBranches(BzrNewError):
545
 
    "Branches have no common ancestor, and no merge base revision was specified."
546
 
 
547
 
    is_user_error = True
548
 
 
549
 
 
550
 
class NoCommonAncestor(BzrNewError):
551
 
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
552
 
 
553
 
    def __init__(self, revision_a, revision_b):
554
 
        self.revision_a = revision_a
555
 
        self.revision_b = revision_b
556
 
 
557
 
 
558
 
class NoCommonRoot(BzrError):
559
 
    def __init__(self, revision_a, revision_b):
560
 
        msg = "Revisions are not derived from the same root: %s %s." \
561
 
            % (revision_a, revision_b) 
562
 
        BzrError.__init__(self, msg)
563
 
 
564
 
 
565
 
 
566
 
class NotAncestor(BzrError):
567
 
    def __init__(self, rev_id, not_ancestor_id):
568
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
569
 
                                                        rev_id)
570
 
        BzrError.__init__(self, msg)
571
 
        self.rev_id = rev_id
572
 
        self.not_ancestor_id = not_ancestor_id
573
 
 
574
 
 
575
 
class InstallFailed(BzrError):
576
 
    def __init__(self, revisions):
577
 
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
578
 
        BzrError.__init__(self, msg)
579
 
        self.revisions = revisions
580
 
 
581
 
 
582
 
class AmbiguousBase(BzrError):
583
 
    def __init__(self, bases):
584
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
585
 
                DeprecationWarning)
586
 
        msg = "The correct base is unclear, because %s are all equally close" %\
587
 
            ", ".join(bases)
588
 
        BzrError.__init__(self, msg)
589
 
        self.bases = bases
590
 
 
591
 
 
592
 
class NoCommits(BzrError):
593
 
    def __init__(self, branch):
594
 
        msg = "Branch %s has no commits." % branch
595
 
        BzrError.__init__(self, msg)
596
 
 
597
 
 
598
 
class UnlistableStore(BzrError):
599
 
    def __init__(self, store):
600
 
        BzrError.__init__(self, "Store %s is not listable" % store)
601
 
 
602
 
 
603
 
 
604
 
class UnlistableBranch(BzrError):
605
 
    def __init__(self, br):
606
 
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
607
 
 
608
 
 
609
 
class BoundBranchOutOfDate(BzrNewError):
610
 
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
611
 
    def __init__(self, branch, master):
612
 
        BzrNewError.__init__(self)
613
 
        self.branch = branch
614
 
        self.master = master
615
 
 
616
 
        
617
 
class CommitToDoubleBoundBranch(BzrNewError):
618
 
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
619
 
    def __init__(self, branch, master, remote):
620
 
        BzrNewError.__init__(self)
621
 
        self.branch = branch
622
 
        self.master = master
623
 
        self.remote = remote
624
 
 
625
 
 
626
 
class OverwriteBoundBranch(BzrNewError):
627
 
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
628
 
    def __init__(self, branch):
629
 
        BzrNewError.__init__(self)
630
 
        self.branch = branch
631
 
 
632
 
 
633
 
class BoundBranchConnectionFailure(BzrNewError):
634
 
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
635
 
    def __init__(self, branch, target, error):
636
 
        BzrNewError.__init__(self)
637
 
        self.branch = branch
638
 
        self.target = target
639
 
        self.error = error
640
 
 
641
 
 
642
 
class WeaveError(BzrNewError):
643
 
    """Error in processing weave: %(message)s"""
644
 
 
645
 
    def __init__(self, message=None):
646
 
        BzrNewError.__init__(self)
647
 
        self.message = message
648
 
 
649
 
 
650
 
class WeaveRevisionAlreadyPresent(WeaveError):
651
 
    """Revision {%(revision_id)s} already present in %(weave)s"""
652
 
    def __init__(self, revision_id, weave):
653
 
 
654
 
        WeaveError.__init__(self)
655
 
        self.revision_id = revision_id
656
 
        self.weave = weave
657
 
 
658
 
 
659
 
class WeaveRevisionNotPresent(WeaveError):
660
 
    """Revision {%(revision_id)s} not present in %(weave)s"""
661
 
 
662
 
    def __init__(self, revision_id, weave):
663
 
        WeaveError.__init__(self)
664
 
        self.revision_id = revision_id
665
 
        self.weave = weave
666
 
 
667
 
 
668
 
class WeaveFormatError(WeaveError):
669
 
    """Weave invariant violated: %(what)s"""
670
 
 
671
 
    def __init__(self, what):
672
 
        WeaveError.__init__(self)
673
 
        self.what = what
674
 
 
675
 
 
676
 
class WeaveParentMismatch(WeaveError):
677
 
    """Parents are mismatched between two revisions."""
678
 
    
679
 
 
680
 
class WeaveInvalidChecksum(WeaveError):
681
 
    """Text did not match it's checksum: %(message)s"""
682
 
 
683
 
 
684
 
class WeaveTextDiffers(WeaveError):
685
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
686
 
 
687
 
    def __init__(self, revision_id, weave_a, weave_b):
688
 
        WeaveError.__init__(self)
689
 
        self.revision_id = revision_id
690
 
        self.weave_a = weave_a
691
 
        self.weave_b = weave_b
692
 
 
693
 
 
694
 
class WeaveTextDiffers(WeaveError):
695
 
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
696
 
 
697
 
    def __init__(self, revision_id, weave_a, weave_b):
698
 
        WeaveError.__init__(self)
699
 
        self.revision_id = revision_id
700
 
        self.weave_a = weave_a
701
 
        self.weave_b = weave_b
702
 
 
703
 
 
704
 
class VersionedFileError(BzrNewError):
705
 
    """Versioned file error."""
706
 
 
707
 
 
708
 
class RevisionNotPresent(VersionedFileError):
709
 
    """Revision {%(revision_id)s} not present in %(file_id)s."""
710
 
 
711
 
    def __init__(self, revision_id, file_id):
712
 
        VersionedFileError.__init__(self)
713
 
        self.revision_id = revision_id
714
 
        self.file_id = file_id
715
 
 
716
 
 
717
 
class RevisionAlreadyPresent(VersionedFileError):
718
 
    """Revision {%(revision_id)s} already present in %(file_id)s."""
719
 
 
720
 
    def __init__(self, revision_id, file_id):
721
 
        VersionedFileError.__init__(self)
722
 
        self.revision_id = revision_id
723
 
        self.file_id = file_id
724
 
 
725
 
 
726
 
class KnitError(BzrNewError):
727
 
    """Knit error"""
728
 
 
729
 
 
730
 
class KnitHeaderError(KnitError):
731
 
    """Knit header error: %(badline)r unexpected"""
732
 
 
733
 
    def __init__(self, badline):
734
 
        KnitError.__init__(self)
735
 
        self.badline = badline
736
 
 
737
 
 
738
 
class KnitCorrupt(KnitError):
739
 
    """Knit %(filename)s corrupt: %(how)s"""
740
 
 
741
 
    def __init__(self, filename, how):
742
 
        KnitError.__init__(self)
743
 
        self.filename = filename
744
 
        self.how = how
745
 
 
746
 
 
747
 
class NoSuchExportFormat(BzrNewError):
748
 
    """Export format %(format)r not supported"""
749
 
    def __init__(self, format):
750
 
        BzrNewError.__init__(self)
751
 
        self.format = format
752
 
 
753
 
 
754
 
class TransportError(BzrNewError):
755
 
    """Transport error: %(msg)s %(orig_error)s"""
756
 
 
757
 
    def __init__(self, msg=None, orig_error=None):
758
 
        if msg is None and orig_error is not None:
759
 
            msg = str(orig_error)
760
 
        if orig_error is None:
761
 
            orig_error = ''
762
 
        if msg is None:
763
 
            msg =  ''
764
 
        self.msg = msg
765
 
        self.orig_error = orig_error
766
 
        BzrNewError.__init__(self)
767
 
 
768
 
 
769
 
# A set of semi-meaningful errors which can be thrown
770
 
class TransportNotPossible(TransportError):
771
 
    """Transport operation not possible: %(msg)s %(orig_error)%"""
772
 
 
773
 
 
774
 
class ConnectionError(TransportError):
775
 
    """Connection error: %(msg)s %(orig_error)s"""
776
 
 
777
 
 
778
 
class ConnectionReset(TransportError):
779
 
    """Connection closed: %(msg)s %(orig_error)s"""
780
 
 
781
 
 
782
 
class InvalidRange(TransportError):
783
 
    """Invalid range access."""
784
 
    
785
 
    def __init__(self, path, offset):
786
 
        TransportError.__init__(self, ("Invalid range access in %s at %d"
787
 
                                       % (path, offset)))
788
 
 
789
 
 
790
 
class InvalidHttpResponse(TransportError):
791
 
    """Invalid http response for %(path)s: %(msg)s"""
792
 
 
793
 
    def __init__(self, path, msg, orig_error=None):
794
 
        self.path = path
795
 
        TransportError.__init__(self, msg, orig_error=orig_error)
796
 
 
797
 
 
798
 
class InvalidHttpRange(InvalidHttpResponse):
799
 
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
800
 
    
801
 
    def __init__(self, path, range, msg):
802
 
        self.range = range
803
 
        InvalidHttpResponse.__init__(self, path, msg)
804
 
 
805
 
 
806
 
class InvalidHttpContentType(InvalidHttpResponse):
807
 
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
808
 
    
809
 
    def __init__(self, path, ctype, msg):
810
 
        self.ctype = ctype
811
 
        InvalidHttpResponse.__init__(self, path, msg)
812
 
 
813
 
 
814
 
class ConflictsInTree(BzrError):
815
 
    def __init__(self):
816
 
        BzrError.__init__(self, "Working tree has conflicts.")
817
 
 
818
 
 
819
 
class ParseConfigError(BzrError):
820
 
    def __init__(self, errors, filename):
821
 
        if filename is None:
822
 
            filename = ""
823
 
        message = "Error(s) parsing config file %s:\n%s" % \
824
 
            (filename, ('\n'.join(e.message for e in errors)))
825
 
        BzrError.__init__(self, message)
826
 
 
827
 
 
828
 
class SigningFailed(BzrError):
829
 
    def __init__(self, command_line):
830
 
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
831
 
                               % command_line)
832
 
 
833
 
 
834
 
class WorkingTreeNotRevision(BzrError):
835
 
    def __init__(self, tree):
836
 
        BzrError.__init__(self, "The working tree for %s has changed since"
837
 
                          " last commit, but weave merge requires that it be"
838
 
                          " unchanged." % tree.basedir)
839
 
 
840
 
 
841
 
class CantReprocessAndShowBase(BzrNewError):
842
 
    """Can't reprocess and show base.
843
 
Reprocessing obscures relationship of conflicting lines to base."""
844
 
 
845
 
 
846
 
class GraphCycleError(BzrNewError):
847
 
    """Cycle in graph %(graph)r"""
848
 
    def __init__(self, graph):
849
 
        BzrNewError.__init__(self)
850
 
        self.graph = graph
851
 
 
852
 
 
853
 
class NotConflicted(BzrNewError):
854
 
    """File %(filename)s is not conflicted."""
855
 
 
856
 
    def __init__(self, filename):
857
 
        BzrNewError.__init__(self)
858
 
        self.filename = filename
859
 
 
860
 
 
861
 
class MustUseDecorated(Exception):
862
 
    """A decorating function has requested its original command be used.
863
 
    
864
 
    This should never escape bzr, so does not need to be printable.
865
 
    """
866
 
 
867
 
 
868
 
class NoBundleFound(BzrNewError):
869
 
    """No bundle was found in %(filename)s"""
870
 
    def __init__(self, filename):
871
 
        BzrNewError.__init__(self)
872
 
        self.filename = filename
873
 
 
874
 
 
875
 
class BundleNotSupported(BzrNewError):
876
 
    """Unable to handle bundle version %(version)s: %(msg)s"""
877
 
    def __init__(self, version, msg):
878
 
        BzrNewError.__init__(self)
879
 
        self.version = version
880
 
        self.msg = msg
881
 
 
882
 
 
883
 
class MissingText(BzrNewError):
884
 
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
885
 
 
886
 
    def __init__(self, branch, text_revision, file_id):
887
 
        BzrNewError.__init__(self)
888
 
        self.branch = branch
889
 
        self.base = branch.base
890
 
        self.text_revision = text_revision
891
 
        self.file_id = file_id
892
 
 
893
 
 
894
 
class DuplicateKey(BzrNewError):
895
 
    """Key %(key)s is already present in map"""
896
 
 
897
 
 
898
 
class MalformedTransform(BzrNewError):
899
 
    """Tree transform is malformed %(conflicts)r"""
900
 
 
901
 
 
902
 
class BzrBadParameter(BzrNewError):
903
 
    """A bad parameter : %(param)s is not usable.
904
 
    
905
 
    This exception should never be thrown, but it is a base class for all
906
 
    parameter-to-function errors.
907
 
    """
908
 
    def __init__(self, param):
909
 
        BzrNewError.__init__(self)
910
 
        self.param = param
911
 
 
912
 
 
913
 
class BzrBadParameterNotUnicode(BzrBadParameter):
914
 
    """Parameter %(param)s is neither unicode nor utf8."""
915
 
 
916
 
 
917
 
class ReusingTransform(BzrNewError):
918
 
    """Attempt to reuse a transform that has already been applied."""
919
 
 
920
 
 
921
 
class CantMoveRoot(BzrNewError):
922
 
    """Moving the root directory is not supported at this time"""
923
 
 
924
 
 
925
 
class BzrBadParameterNotString(BzrBadParameter):
926
 
    """Parameter %(param)s is not a string or unicode string."""
927
 
 
928
 
 
929
 
class BzrBadParameterMissing(BzrBadParameter):
930
 
    """Parameter $(param)s is required but not present."""
931
 
 
932
 
 
933
 
class BzrBadParameterUnicode(BzrBadParameter):
934
 
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
935
 
 
936
 
 
937
 
class BzrBadParameterContainsNewline(BzrBadParameter):
938
 
    """Parameter %(param)s contains a newline."""
939
 
 
940
 
 
941
 
class DependencyNotPresent(BzrNewError):
942
 
    """Unable to import library "%(library)s": %(error)s"""
943
 
 
944
 
    def __init__(self, library, error):
945
 
        BzrNewError.__init__(self, library=library, error=error)
946
 
 
947
 
 
948
 
class ParamikoNotPresent(DependencyNotPresent):
949
 
    """Unable to import paramiko (required for sftp support): %(error)s"""
950
 
 
951
 
    def __init__(self, error):
952
 
        DependencyNotPresent.__init__(self, 'paramiko', error)
953
 
 
954
 
 
955
 
class UninitializableFormat(BzrNewError):
956
 
    """Format %(format)s cannot be initialised by this version of bzr."""
957
 
 
958
 
    def __init__(self, format):
959
 
        BzrNewError.__init__(self)
960
 
        self.format = format
961
 
 
962
 
 
963
 
class NoDiff(BzrNewError):
964
 
    """Diff is not installed on this machine: %(msg)s"""
965
 
 
966
 
    def __init__(self, msg):
967
 
        BzrNewError.__init__(self, msg=msg)
968
 
 
969
 
 
970
 
class NoDiff3(BzrNewError):
971
 
    """Diff3 is not installed on this machine."""
972
 
 
973
 
 
974
 
class ExistingLimbo(BzrNewError):
975
 
    """This tree contains left-over files from a failed operation.
976
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
977
 
    keep, and delete it when you are done.
978
 
    """
979
 
    def __init__(self, limbo_dir):
980
 
       BzrNewError.__init__(self)
981
 
       self.limbo_dir = limbo_dir
982
 
 
983
 
 
984
 
class ImmortalLimbo(BzrNewError):
985
 
    """Unable to delete transform temporary directory $(limbo_dir)s.
986
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
987
 
    keep, and delete it when you are done.
988
 
    """
989
 
    def __init__(self, limbo_dir):
990
 
       BzrNewError.__init__(self)
991
 
       self.limbo_dir = limbo_dir
992
 
 
993
 
 
994
 
class OutOfDateTree(BzrNewError):
995
 
    """Working tree is out of date, please run 'bzr update'."""
996
 
 
997
 
    def __init__(self, tree):
998
 
        BzrNewError.__init__(self)
999
 
        self.tree = tree
1000
 
 
1001
 
 
1002
 
class MergeModifiedFormatError(BzrNewError):
1003
 
    """Error in merge modified format"""
1004
 
 
1005
 
 
1006
 
class ConflictFormatError(BzrNewError):
1007
 
    """Format error in conflict listings"""
1008
 
 
1009
 
 
1010
 
class CorruptRepository(BzrNewError):
1011
 
    """An error has been detected in the repository %(repo_path)s.
1012
 
Please run bzr reconcile on this repository."""
1013
 
 
1014
 
    def __init__(self, repo):
1015
 
        BzrNewError.__init__(self)
1016
 
        self.repo_path = repo.bzrdir.root_transport.base
1017
 
 
1018
 
 
1019
 
class UpgradeRequired(BzrNewError):
1020
 
    """To use this feature you must upgrade your branch at %(path)s."""
1021
 
 
1022
 
    def __init__(self, path):
1023
 
        BzrNewError.__init__(self)
1024
 
        self.path = path
1025
 
 
1026
 
 
1027
 
class LocalRequiresBoundBranch(BzrNewError):
1028
 
    """Cannot perform local-only commits on unbound branches."""
1029
 
 
1030
 
 
1031
 
class MissingProgressBarFinish(BzrNewError):
1032
 
    """A nested progress bar was not 'finished' correctly."""
1033
 
 
1034
 
 
1035
 
class InvalidProgressBarType(BzrNewError):
1036
 
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1037
 
Select one of: %(valid_types)s"""
1038
 
 
1039
 
    def __init__(self, bar_type, valid_types):
1040
 
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1041
 
 
1042
 
 
1043
 
class UnsupportedOperation(BzrNewError):
1044
 
    """The method %(mname)s is not supported on objects of type %(tname)s."""
1045
 
    def __init__(self, method, method_self):
1046
 
        self.method = method
1047
 
        self.mname = method.__name__
1048
 
        self.tname = type(method_self).__name__
1049
 
 
1050
 
 
1051
 
class BinaryFile(BzrNewError):
1052
 
    """File is binary but should be text."""
1053
 
 
1054
 
 
1055
 
class IllegalPath(BzrNewError):
1056
 
    """The path %(path)s is not permitted on this platform"""
1057
 
 
1058
 
    def __init__(self, path):
1059
 
        BzrNewError.__init__(self)
1060
 
        self.path = path
1061
 
 
1062
 
 
1063
 
class TestamentMismatch(BzrNewError):
1064
 
    """Testament did not match expected value.  
1065
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
1066
 
       {%(measured)s}
1067
 
    """
1068
 
    def __init__(self, revision_id, expected, measured):
1069
 
        self.revision_id = revision_id
1070
 
        self.expected = expected
1071
 
        self.measured = measured
1072
 
 
1073
 
 
1074
 
class NotABundle(BzrNewError):
1075
 
    """Not a bzr revision-bundle: %(text)r"""
1076
 
 
1077
 
    def __init__(self, text):
1078
 
        BzrNewError.__init__(self)
1079
 
        self.text = text
1080
 
 
1081
 
 
1082
 
class BadBundle(BzrNewError): 
1083
 
    """Bad bzr revision-bundle: %(text)r"""
1084
 
 
1085
 
    def __init__(self, text):
1086
 
        BzrNewError.__init__(self)
1087
 
        self.text = text
1088
 
 
1089
 
 
1090
 
class MalformedHeader(BadBundle): 
1091
 
    """Malformed bzr revision-bundle header: %(text)r"""
1092
 
 
1093
 
    def __init__(self, text):
1094
 
        BzrNewError.__init__(self)
1095
 
        self.text = text
1096
 
 
1097
 
 
1098
 
class MalformedPatches(BadBundle): 
1099
 
    """Malformed patches in bzr revision-bundle: %(text)r"""
1100
 
 
1101
 
    def __init__(self, text):
1102
 
        BzrNewError.__init__(self)
1103
 
        self.text = text
1104
 
 
1105
 
 
1106
 
class MalformedFooter(BadBundle): 
1107
 
    """Malformed footer in bzr revision-bundle: %(text)r"""
1108
 
 
1109
 
    def __init__(self, text):
1110
 
        BzrNewError.__init__(self)
1111
 
        self.text = text
1112
 
 
1113
 
class UnsupportedEOLMarker(BadBundle):
1114
 
    """End of line marker was not \\n in bzr revision-bundle"""    
1115
 
 
1116
 
    def __init__(self):
1117
 
        BzrNewError.__init__(self)    
 
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
class NotBranchError(BzrError):
 
38
    """Specified path is not in a branch"""
 
39
    pass
 
40
 
 
41
 
 
42
def bailout(msg, explanation=[]):
 
43
    ex = BzrError(msg, explanation)
 
44
    import trace
 
45
    trace._tracefile.write('* raising %s\n' % ex)
 
46
    raise ex
 
47