/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-24 00:07:15 UTC
  • mto: This revision was merged to the branch mainline in revision 1979.
  • Revision ID: john@arbash-meinel.com-20060824000715-142aafd575a94f1a
Remove a few more direct references to RevisionSpec

Show diffs side-by-side

added added

removed removed

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