/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: Martin Pool
  • Date: 2006-09-22 02:32:41 UTC
  • mfrom: (2027.2.3 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 2030.
  • Revision ID: mbp@sourcefrog.net-20060922023241-474fdb7540c8cf2e
[merge] python2.5 fixes from Marien

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