/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

Various changes to allow non-workingtree specific tests to run entirely
from MemoryTransports:
 * Create MemoryTree and pull up common code for it from WorkingTree to
   a new common base class MutableTree.
 * Add MutableTree.mkdir().
 * Add MutableTree.put_file_bytes_nonatomic().
 * New test helper make_branch_and_memory_tree().
(Robert Collins)

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