/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-20 14:03:05 UTC
  • mto: This revision was merged to the branch mainline in revision 2162.
  • Revision ID: abentley@panoramicfeedback.com-20060920140305-7726fe3eb92690b1
Get tree._iter_changed down to ~ 1 stat per file

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