/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: John Arbash Meinel
  • Date: 2006-08-28 16:19:47 UTC
  • mto: This revision was merged to the branch mainline in revision 1979.
  • Revision ID: john@arbash-meinel.com-20060828161947-5986ffb6cf082f59
Switch from get_revision_spec() to RevisionSpec.from_string() (as advised by Martin)

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