/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

Merge from bzr.dev

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