/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

Merge bzr.dev.

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