~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-25 15:01:52 UTC
  • mto: This revision was merged to the branch mainline in revision 1962.
  • Revision ID: john@arbash-meinel.com-20060825150152-006e591e9cfb120e
Change the name of the test classes (test_lang => test_locale), move the function into osutils.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
21
 
 
22
 
 
23
 
######################################################################
24
 
# exceptions 
 
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
 
25
96
class BzrError(StandardError):
26
 
    pass
27
 
 
28
 
class BzrCheckError(BzrError):
29
 
    pass
30
 
 
31
 
 
32
 
class InvalidRevisionNumber(BzrError):
 
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"""
33
162
    def __init__(self, revno):
34
 
        self.args = [revno]
35
 
        
 
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
 
36
212
    def __str__(self):
37
 
        return 'invalid revision number: %r' % self.args[0]
38
 
 
39
 
 
40
 
class InvalidRevisionId(BzrError):
41
 
    pass
42
 
 
43
 
 
44
 
class BzrCommandError(BzrError):
45
 
    # Error from malformed user command
46
 
    pass
47
 
 
48
 
 
49
 
class NotBranchError(BzrError):
50
 
    """Specified path is not in a branch"""
51
 
    pass
52
 
 
53
 
 
54
 
class NotVersionedError(BzrError):
55
 
    """Specified object is not versioned."""
56
 
 
57
 
 
58
 
class BadFileKindError(BzrError):
59
 
    """Specified file is of a kind that cannot be added.
60
 
 
61
 
    (For example a symlink or device file.)"""
62
 
    pass
63
 
 
64
 
 
65
 
class ForbiddenFileError(BzrError):
66
 
    """Cannot operate on a file because it is a control file."""
67
 
    pass
68
 
 
69
 
 
70
 
class LockError(Exception):
71
 
    """All exceptions from the lock/unlock functions should be from
72
 
    this exception class.  They will be translated as necessary. The
73
 
    original exception is available as e.original_error
74
 
    """
75
 
    def __init__(self, e=None):
76
 
        self.original_error = e
77
 
        if e:
78
 
            Exception.__init__(self, e)
79
 
        else:
80
 
            Exception.__init__(self)
81
 
 
82
 
 
83
 
class PointlessCommit(Exception):
84
 
    """Commit failed because nothing was changed."""
85
 
 
86
 
 
87
 
class NoSuchRevision(BzrError):
 
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
 
 
508
class StrictCommitFailed(Exception):
 
509
    """Commit refused because there are unknowns in the tree."""
 
510
 
 
511
 
 
512
class NoSuchRevision(BzrNewError):
 
513
    """Branch %(branch)s has no revision %(revision)s"""
 
514
 
 
515
    is_user_error = False
 
516
 
88
517
    def __init__(self, branch, revision):
89
518
        self.branch = branch
90
519
        self.revision = revision
91
 
        msg = "Branch %s has no revision %s" % (branch, revision)
92
 
        BzrError.__init__(self, msg)
93
 
 
94
 
 
 
520
 
 
521
 
 
522
class HistoryMissing(BzrError):
 
523
    def __init__(self, branch, object_type, object_id):
 
524
        self.branch = branch
 
525
        BzrError.__init__(self,
 
526
                          '%s is missing %s {%s}'
 
527
                          % (branch, object_type, object_id))
 
528
 
 
529
 
 
530
class DivergedBranches(BzrNewError):
 
531
    "These branches have diverged.  Use the merge command to reconcile them."""
 
532
 
 
533
    is_user_error = True
 
534
 
 
535
    def __init__(self, branch1, branch2):
 
536
        self.branch1 = branch1
 
537
        self.branch2 = branch2
 
538
 
 
539
 
 
540
class UnrelatedBranches(BzrNewError):
 
541
    "Branches have no common ancestor, and no merge base revision was specified."
 
542
 
 
543
    is_user_error = True
 
544
 
 
545
 
 
546
class NoCommonAncestor(BzrNewError):
 
547
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
548
 
 
549
    def __init__(self, revision_a, revision_b):
 
550
        self.revision_a = revision_a
 
551
        self.revision_b = revision_b
 
552
 
 
553
 
 
554
class NoCommonRoot(BzrError):
 
555
    def __init__(self, revision_a, revision_b):
 
556
        msg = "Revisions are not derived from the same root: %s %s." \
 
557
            % (revision_a, revision_b) 
 
558
        BzrError.__init__(self, msg)
 
559
 
 
560
 
 
561
 
 
562
class NotAncestor(BzrError):
 
563
    def __init__(self, rev_id, not_ancestor_id):
 
564
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
565
                                                        rev_id)
 
566
        BzrError.__init__(self, msg)
 
567
        self.rev_id = rev_id
 
568
        self.not_ancestor_id = not_ancestor_id
 
569
 
 
570
 
 
571
class InstallFailed(BzrError):
 
572
    def __init__(self, revisions):
 
573
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
574
        BzrError.__init__(self, msg)
 
575
        self.revisions = revisions
 
576
 
 
577
 
 
578
class AmbiguousBase(BzrError):
 
579
    def __init__(self, bases):
 
580
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
581
                DeprecationWarning)
 
582
        msg = "The correct base is unclear, because %s are all equally close" %\
 
583
            ", ".join(bases)
 
584
        BzrError.__init__(self, msg)
 
585
        self.bases = bases
 
586
 
 
587
 
 
588
class NoCommits(BzrError):
 
589
    def __init__(self, branch):
 
590
        msg = "Branch %s has no commits." % branch
 
591
        BzrError.__init__(self, msg)
 
592
 
 
593
 
 
594
class UnlistableStore(BzrError):
 
595
    def __init__(self, store):
 
596
        BzrError.__init__(self, "Store %s is not listable" % store)
 
597
 
 
598
 
 
599
 
 
600
class UnlistableBranch(BzrError):
 
601
    def __init__(self, br):
 
602
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
603
 
 
604
 
 
605
class BoundBranchOutOfDate(BzrNewError):
 
606
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
607
    def __init__(self, branch, master):
 
608
        BzrNewError.__init__(self)
 
609
        self.branch = branch
 
610
        self.master = master
 
611
 
 
612
        
 
613
class CommitToDoubleBoundBranch(BzrNewError):
 
614
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
615
    def __init__(self, branch, master, remote):
 
616
        BzrNewError.__init__(self)
 
617
        self.branch = branch
 
618
        self.master = master
 
619
        self.remote = remote
 
620
 
 
621
 
 
622
class OverwriteBoundBranch(BzrNewError):
 
623
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
624
    def __init__(self, branch):
 
625
        BzrNewError.__init__(self)
 
626
        self.branch = branch
 
627
 
 
628
 
 
629
class BoundBranchConnectionFailure(BzrNewError):
 
630
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
631
    def __init__(self, branch, target, error):
 
632
        BzrNewError.__init__(self)
 
633
        self.branch = branch
 
634
        self.target = target
 
635
        self.error = error
 
636
 
 
637
 
 
638
class WeaveError(BzrNewError):
 
639
    """Error in processing weave: %(message)s"""
 
640
 
 
641
    def __init__(self, message=None):
 
642
        BzrNewError.__init__(self)
 
643
        self.message = message
 
644
 
 
645
 
 
646
class WeaveRevisionAlreadyPresent(WeaveError):
 
647
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
648
    def __init__(self, revision_id, weave):
 
649
 
 
650
        WeaveError.__init__(self)
 
651
        self.revision_id = revision_id
 
652
        self.weave = weave
 
653
 
 
654
 
 
655
class WeaveRevisionNotPresent(WeaveError):
 
656
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
657
 
 
658
    def __init__(self, revision_id, weave):
 
659
        WeaveError.__init__(self)
 
660
        self.revision_id = revision_id
 
661
        self.weave = weave
 
662
 
 
663
 
 
664
class WeaveFormatError(WeaveError):
 
665
    """Weave invariant violated: %(what)s"""
 
666
 
 
667
    def __init__(self, what):
 
668
        WeaveError.__init__(self)
 
669
        self.what = what
 
670
 
 
671
 
 
672
class WeaveParentMismatch(WeaveError):
 
673
    """Parents are mismatched between two revisions."""
 
674
    
 
675
 
 
676
class WeaveInvalidChecksum(WeaveError):
 
677
    """Text did not match it's checksum: %(message)s"""
 
678
 
 
679
 
 
680
class WeaveTextDiffers(WeaveError):
 
681
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
682
 
 
683
    def __init__(self, revision_id, weave_a, weave_b):
 
684
        WeaveError.__init__(self)
 
685
        self.revision_id = revision_id
 
686
        self.weave_a = weave_a
 
687
        self.weave_b = weave_b
 
688
 
 
689
 
 
690
class WeaveTextDiffers(WeaveError):
 
691
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
692
 
 
693
    def __init__(self, revision_id, weave_a, weave_b):
 
694
        WeaveError.__init__(self)
 
695
        self.revision_id = revision_id
 
696
        self.weave_a = weave_a
 
697
        self.weave_b = weave_b
 
698
 
 
699
 
 
700
class VersionedFileError(BzrNewError):
 
701
    """Versioned file error."""
 
702
 
 
703
 
 
704
class RevisionNotPresent(VersionedFileError):
 
705
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
706
 
 
707
    def __init__(self, revision_id, file_id):
 
708
        VersionedFileError.__init__(self)
 
709
        self.revision_id = revision_id
 
710
        self.file_id = file_id
 
711
 
 
712
 
 
713
class RevisionAlreadyPresent(VersionedFileError):
 
714
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
715
 
 
716
    def __init__(self, revision_id, file_id):
 
717
        VersionedFileError.__init__(self)
 
718
        self.revision_id = revision_id
 
719
        self.file_id = file_id
 
720
 
 
721
 
 
722
class KnitError(BzrNewError):
 
723
    """Knit error"""
 
724
 
 
725
 
 
726
class KnitHeaderError(KnitError):
 
727
    """Knit header error: %(badline)r unexpected"""
 
728
 
 
729
    def __init__(self, badline):
 
730
        KnitError.__init__(self)
 
731
        self.badline = badline
 
732
 
 
733
 
 
734
class KnitCorrupt(KnitError):
 
735
    """Knit %(filename)s corrupt: %(how)s"""
 
736
 
 
737
    def __init__(self, filename, how):
 
738
        KnitError.__init__(self)
 
739
        self.filename = filename
 
740
        self.how = how
 
741
 
 
742
 
 
743
class NoSuchExportFormat(BzrNewError):
 
744
    """Export format %(format)r not supported"""
 
745
    def __init__(self, format):
 
746
        BzrNewError.__init__(self)
 
747
        self.format = format
 
748
 
 
749
 
 
750
class TransportError(BzrNewError):
 
751
    """Transport error: %(msg)s %(orig_error)s"""
 
752
 
 
753
    def __init__(self, msg=None, orig_error=None):
 
754
        if msg is None and orig_error is not None:
 
755
            msg = str(orig_error)
 
756
        if orig_error is None:
 
757
            orig_error = ''
 
758
        if msg is None:
 
759
            msg =  ''
 
760
        self.msg = msg
 
761
        self.orig_error = orig_error
 
762
        BzrNewError.__init__(self)
 
763
 
 
764
 
 
765
# A set of semi-meaningful errors which can be thrown
 
766
class TransportNotPossible(TransportError):
 
767
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
768
 
 
769
 
 
770
class ConnectionError(TransportError):
 
771
    """Connection error: %(msg)s %(orig_error)s"""
 
772
 
 
773
 
 
774
class ConnectionReset(TransportError):
 
775
    """Connection closed: %(msg)s %(orig_error)s"""
 
776
 
 
777
 
 
778
class InvalidRange(TransportError):
 
779
    """Invalid range access."""
 
780
    
 
781
    def __init__(self, path, offset):
 
782
        TransportError.__init__(self, ("Invalid range access in %s at %d"
 
783
                                       % (path, offset)))
 
784
 
 
785
 
 
786
class InvalidHttpResponse(TransportError):
 
787
    """Invalid http response for %(path)s: %(msg)s"""
 
788
 
 
789
    def __init__(self, path, msg, orig_error=None):
 
790
        self.path = path
 
791
        TransportError.__init__(self, msg, orig_error=orig_error)
 
792
 
 
793
 
 
794
class InvalidHttpRange(InvalidHttpResponse):
 
795
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
 
796
    
 
797
    def __init__(self, path, range, msg):
 
798
        self.range = range
 
799
        InvalidHttpResponse.__init__(self, path, msg)
 
800
 
 
801
 
 
802
class InvalidHttpContentType(InvalidHttpResponse):
 
803
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
 
804
    
 
805
    def __init__(self, path, ctype, msg):
 
806
        self.ctype = ctype
 
807
        InvalidHttpResponse.__init__(self, path, msg)
 
808
 
 
809
 
 
810
class ConflictsInTree(BzrError):
 
811
    def __init__(self):
 
812
        BzrError.__init__(self, "Working tree has conflicts.")
 
813
 
 
814
 
 
815
class ParseConfigError(BzrError):
 
816
    def __init__(self, errors, filename):
 
817
        if filename is None:
 
818
            filename = ""
 
819
        message = "Error(s) parsing config file %s:\n%s" % \
 
820
            (filename, ('\n'.join(e.message for e in errors)))
 
821
        BzrError.__init__(self, message)
 
822
 
 
823
 
 
824
class SigningFailed(BzrError):
 
825
    def __init__(self, command_line):
 
826
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
827
                               % command_line)
 
828
 
 
829
 
 
830
class WorkingTreeNotRevision(BzrError):
 
831
    def __init__(self, tree):
 
832
        BzrError.__init__(self, "The working tree for %s has changed since"
 
833
                          " last commit, but weave merge requires that it be"
 
834
                          " unchanged." % tree.basedir)
 
835
 
 
836
 
 
837
class CantReprocessAndShowBase(BzrNewError):
 
838
    """Can't reprocess and show base.
 
839
Reprocessing obscures relationship of conflicting lines to base."""
 
840
 
 
841
 
 
842
class GraphCycleError(BzrNewError):
 
843
    """Cycle in graph %(graph)r"""
 
844
    def __init__(self, graph):
 
845
        BzrNewError.__init__(self)
 
846
        self.graph = graph
 
847
 
 
848
 
 
849
class NotConflicted(BzrNewError):
 
850
    """File %(filename)s is not conflicted."""
 
851
 
 
852
    def __init__(self, filename):
 
853
        BzrNewError.__init__(self)
 
854
        self.filename = filename
 
855
 
 
856
 
 
857
class MustUseDecorated(Exception):
 
858
    """A decorating function has requested its original command be used.
 
859
    
 
860
    This should never escape bzr, so does not need to be printable.
 
861
    """
 
862
 
 
863
 
 
864
class NoBundleFound(BzrNewError):
 
865
    """No bundle was found in %(filename)s"""
 
866
    def __init__(self, filename):
 
867
        BzrNewError.__init__(self)
 
868
        self.filename = filename
 
869
 
 
870
 
 
871
class BundleNotSupported(BzrNewError):
 
872
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
873
    def __init__(self, version, msg):
 
874
        BzrNewError.__init__(self)
 
875
        self.version = version
 
876
        self.msg = msg
 
877
 
 
878
 
 
879
class MissingText(BzrNewError):
 
880
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
881
 
 
882
    def __init__(self, branch, text_revision, file_id):
 
883
        BzrNewError.__init__(self)
 
884
        self.branch = branch
 
885
        self.base = branch.base
 
886
        self.text_revision = text_revision
 
887
        self.file_id = file_id
 
888
 
 
889
 
 
890
class DuplicateKey(BzrNewError):
 
891
    """Key %(key)s is already present in map"""
 
892
 
 
893
 
 
894
class MalformedTransform(BzrNewError):
 
895
    """Tree transform is malformed %(conflicts)r"""
 
896
 
 
897
 
 
898
class BzrBadParameter(BzrNewError):
 
899
    """A bad parameter : %(param)s is not usable.
 
900
    
 
901
    This exception should never be thrown, but it is a base class for all
 
902
    parameter-to-function errors.
 
903
    """
 
904
    def __init__(self, param):
 
905
        BzrNewError.__init__(self)
 
906
        self.param = param
 
907
 
 
908
 
 
909
class BzrBadParameterNotUnicode(BzrBadParameter):
 
910
    """Parameter %(param)s is neither unicode nor utf8."""
 
911
 
 
912
 
 
913
class ReusingTransform(BzrNewError):
 
914
    """Attempt to reuse a transform that has already been applied."""
 
915
 
 
916
 
 
917
class CantMoveRoot(BzrNewError):
 
918
    """Moving the root directory is not supported at this time"""
 
919
 
 
920
 
 
921
class BzrBadParameterNotString(BzrBadParameter):
 
922
    """Parameter %(param)s is not a string or unicode string."""
 
923
 
 
924
 
 
925
class BzrBadParameterMissing(BzrBadParameter):
 
926
    """Parameter $(param)s is required but not present."""
 
927
 
 
928
 
 
929
class BzrBadParameterUnicode(BzrBadParameter):
 
930
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
931
 
 
932
 
 
933
class BzrBadParameterContainsNewline(BzrBadParameter):
 
934
    """Parameter %(param)s contains a newline."""
 
935
 
 
936
 
 
937
class DependencyNotPresent(BzrNewError):
 
938
    """Unable to import library "%(library)s": %(error)s"""
 
939
 
 
940
    def __init__(self, library, error):
 
941
        BzrNewError.__init__(self, library=library, error=error)
 
942
 
 
943
 
 
944
class ParamikoNotPresent(DependencyNotPresent):
 
945
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
946
 
 
947
    def __init__(self, error):
 
948
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
949
 
 
950
 
 
951
class UninitializableFormat(BzrNewError):
 
952
    """Format %(format)s cannot be initialised by this version of bzr."""
 
953
 
 
954
    def __init__(self, format):
 
955
        BzrNewError.__init__(self)
 
956
        self.format = format
 
957
 
 
958
 
 
959
class NoDiff(BzrNewError):
 
960
    """Diff is not installed on this machine: %(msg)s"""
 
961
 
 
962
    def __init__(self, msg):
 
963
        BzrNewError.__init__(self, msg=msg)
 
964
 
 
965
 
 
966
class NoDiff3(BzrNewError):
 
967
    """Diff3 is not installed on this machine."""
 
968
 
 
969
 
 
970
class ExistingLimbo(BzrNewError):
 
971
    """This tree contains left-over files from a failed operation.
 
972
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
973
    keep, and delete it when you are done.
 
974
    """
 
975
    def __init__(self, limbo_dir):
 
976
       BzrNewError.__init__(self)
 
977
       self.limbo_dir = limbo_dir
 
978
 
 
979
 
 
980
class ImmortalLimbo(BzrNewError):
 
981
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
982
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
983
    keep, and delete it when you are done.
 
984
    """
 
985
    def __init__(self, limbo_dir):
 
986
       BzrNewError.__init__(self)
 
987
       self.limbo_dir = limbo_dir
 
988
 
 
989
 
 
990
class OutOfDateTree(BzrNewError):
 
991
    """Working tree is out of date, please run 'bzr update'."""
 
992
 
 
993
    def __init__(self, tree):
 
994
        BzrNewError.__init__(self)
 
995
        self.tree = tree
 
996
 
 
997
 
 
998
class MergeModifiedFormatError(BzrNewError):
 
999
    """Error in merge modified format"""
 
1000
 
 
1001
 
 
1002
class ConflictFormatError(BzrNewError):
 
1003
    """Format error in conflict listings"""
 
1004
 
 
1005
 
 
1006
class CorruptRepository(BzrNewError):
 
1007
    """An error has been detected in the repository %(repo_path)s.
 
1008
Please run bzr reconcile on this repository."""
 
1009
 
 
1010
    def __init__(self, repo):
 
1011
        BzrNewError.__init__(self)
 
1012
        self.repo_path = repo.bzrdir.root_transport.base
 
1013
 
 
1014
 
 
1015
class UpgradeRequired(BzrNewError):
 
1016
    """To use this feature you must upgrade your branch at %(path)s."""
 
1017
 
 
1018
    def __init__(self, path):
 
1019
        BzrNewError.__init__(self)
 
1020
        self.path = path
 
1021
 
 
1022
 
 
1023
class LocalRequiresBoundBranch(BzrNewError):
 
1024
    """Cannot perform local-only commits on unbound branches."""
 
1025
 
 
1026
 
 
1027
class MissingProgressBarFinish(BzrNewError):
 
1028
    """A nested progress bar was not 'finished' correctly."""
 
1029
 
 
1030
 
 
1031
class InvalidProgressBarType(BzrNewError):
 
1032
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1033
Select one of: %(valid_types)s"""
 
1034
 
 
1035
    def __init__(self, bar_type, valid_types):
 
1036
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1037
 
 
1038
 
 
1039
class UnsupportedOperation(BzrNewError):
 
1040
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
1041
    def __init__(self, method, method_self):
 
1042
        self.method = method
 
1043
        self.mname = method.__name__
 
1044
        self.tname = type(method_self).__name__
 
1045
 
 
1046
 
 
1047
class BinaryFile(BzrNewError):
 
1048
    """File is binary but should be text."""
 
1049
 
 
1050
 
 
1051
class IllegalPath(BzrNewError):
 
1052
    """The path %(path)s is not permitted on this platform"""
 
1053
 
 
1054
    def __init__(self, path):
 
1055
        BzrNewError.__init__(self)
 
1056
        self.path = path
 
1057
 
 
1058
 
 
1059
class TestamentMismatch(BzrNewError):
 
1060
    """Testament did not match expected value.  
 
1061
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1062
       {%(measured)s}
 
1063
    """
 
1064
    def __init__(self, revision_id, expected, measured):
 
1065
        self.revision_id = revision_id
 
1066
        self.expected = expected
 
1067
        self.measured = measured
 
1068
 
 
1069
 
 
1070
class NotABundle(BzrNewError):
 
1071
    """Not a bzr revision-bundle: %(text)r"""
 
1072
 
 
1073
    def __init__(self, text):
 
1074
        BzrNewError.__init__(self)
 
1075
        self.text = text
 
1076
 
 
1077
 
 
1078
class BadBundle(BzrNewError): 
 
1079
    """Bad bzr revision-bundle: %(text)r"""
 
1080
 
 
1081
    def __init__(self, text):
 
1082
        BzrNewError.__init__(self)
 
1083
        self.text = text
 
1084
 
 
1085
 
 
1086
class MalformedHeader(BadBundle): 
 
1087
    """Malformed bzr revision-bundle header: %(text)r"""
 
1088
 
 
1089
    def __init__(self, text):
 
1090
        BzrNewError.__init__(self)
 
1091
        self.text = text
 
1092
 
 
1093
 
 
1094
class MalformedPatches(BadBundle): 
 
1095
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
1096
 
 
1097
    def __init__(self, text):
 
1098
        BzrNewError.__init__(self)
 
1099
        self.text = text
 
1100
 
 
1101
 
 
1102
class MalformedFooter(BadBundle): 
 
1103
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
1104
 
 
1105
    def __init__(self, text):
 
1106
        BzrNewError.__init__(self)
 
1107
        self.text = text
 
1108
 
 
1109
class UnsupportedEOLMarker(BadBundle):
 
1110
    """End of line marker was not \\n in bzr revision-bundle"""    
 
1111
 
 
1112
    def __init__(self):
 
1113
        BzrNewError.__init__(self)