/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: Aaron Bentley
  • Date: 2006-09-25 21:54:28 UTC
  • mto: This revision was merged to the branch mainline in revision 2042.
  • Revision ID: aaron.bentley@utoronto.ca-20060925215428-b2fe01fddf80004b
Change angle brackets to square brackets

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