~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

merge with bzr.dev revno.1860

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
 
18
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
19
 
__author__ = "Martin Pool <mbp@canonical.com>"
20
 
 
21
 
 
22
 
######################################################################
23
 
# 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
 
24
96
class BzrError(StandardError):
 
97
    
 
98
    is_user_error = True
 
99
    
25
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 = ''
26
106
        if len(self.args) == 1:
27
 
            return self.args[0]
 
107
            return str(self.args[0])
28
108
        elif len(self.args) == 2:
29
109
            # further explanation or suggestions
30
110
            try:
31
 
                return '\n  '.join([self.args[0]] + self.args[1])
 
111
                return n + '\n  '.join([self.args[0]] + self.args[1])
32
112
            except TypeError:
33
 
                return "%r" % self
34
 
        else:
35
 
            return `self.args`
36
 
 
37
 
 
38
 
class BzrCheckError(BzrError):
39
 
    pass
40
 
 
41
 
 
42
 
class InvalidRevisionNumber(BzrError):
43
 
    def __str__(self):
44
 
        return 'invalid revision number: %r' % self.args[0]
45
 
 
46
 
 
47
 
class InvalidRevisionId(BzrError):
48
 
    pass
49
 
 
50
 
 
51
 
class BzrCommandError(BzrError):
52
 
    # Error from malformed user command
53
 
    pass
54
 
 
55
 
 
56
 
class NotBranchError(BzrError):
57
 
    """Specified path is not in a branch"""
58
 
    pass
59
 
 
60
 
 
61
 
class NotVersionedError(BzrError):
62
 
    """Specified object is not versioned."""
63
 
 
64
 
 
65
 
class BadFileKindError(BzrError):
66
 
    """Specified file is of a kind that cannot be added.
67
 
 
68
 
    (For example a symlink or device file.)"""
69
 
    pass
70
 
 
71
 
 
72
 
class ForbiddenFileError(BzrError):
73
 
    """Cannot operate on a file because it is a control file."""
74
 
    pass
75
 
 
76
 
 
77
 
class LockError(Exception):
78
 
    """All exceptions from the lock/unlock functions should be from
79
 
    this exception class.  They will be translated as necessary. The
80
 
    original exception is available as e.original_error
81
 
    """
82
 
    def __init__(self, e=None):
83
 
        self.original_error = e
84
 
        if e:
85
 
            Exception.__init__(self, e)
86
 
        else:
87
 
            Exception.__init__(self)
88
 
 
89
 
 
90
 
class PointlessCommit(Exception):
91
 
    """Commit failed because nothing was changed."""
92
 
 
93
 
 
94
 
class NoSuchRevision(BzrError):
 
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
            return self.__doc__ % self.__dict__
 
130
        except (NameError, ValueError, KeyError), e:
 
131
            return 'Unprintable exception %s: %s' \
 
132
                % (self.__class__.__name__, str(e))
 
133
 
 
134
 
 
135
class BzrCheckError(BzrNewError):
 
136
    """Internal check failed: %(message)s"""
 
137
 
 
138
    is_user_error = False
 
139
 
 
140
    def __init__(self, message):
 
141
        BzrNewError.__init__(self)
 
142
        self.message = message
 
143
 
 
144
 
 
145
class InvalidEntryName(BzrNewError):
 
146
    """Invalid entry name: %(name)s"""
 
147
 
 
148
    is_user_error = False
 
149
 
 
150
    def __init__(self, name):
 
151
        BzrNewError.__init__(self)
 
152
        self.name = name
 
153
 
 
154
 
 
155
class InvalidRevisionNumber(BzrNewError):
 
156
    """Invalid revision number %(revno)d"""
 
157
    def __init__(self, revno):
 
158
        BzrNewError.__init__(self)
 
159
        self.revno = revno
 
160
 
 
161
 
 
162
class InvalidRevisionId(BzrNewError):
 
163
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
 
164
    def __init__(self, revision_id, branch):
 
165
        # branch can be any string or object with __str__ defined
 
166
        BzrNewError.__init__(self)
 
167
        self.revision_id = revision_id
 
168
        self.branch = branch
 
169
 
 
170
 
 
171
class NoWorkingTree(BzrNewError):
 
172
    """No WorkingTree exists for %(base)s."""
 
173
    
 
174
    def __init__(self, base):
 
175
        BzrNewError.__init__(self)
 
176
        self.base = base
 
177
 
 
178
 
 
179
class NotLocalUrl(BzrNewError):
 
180
    """%(url)s is not a local path."""
 
181
    
 
182
    def __init__(self, url):
 
183
        BzrNewError.__init__(self)
 
184
        self.url = url
 
185
 
 
186
 
 
187
class BzrCommandError(BzrNewError):
 
188
    """Error from user command"""
 
189
 
 
190
    is_user_error = True
 
191
 
 
192
    # Error from malformed user command; please avoid raising this as a
 
193
    # generic exception not caused by user input.
 
194
    #
 
195
    # I think it's a waste of effort to differentiate between errors that
 
196
    # are not intended to be caught anyway.  UI code need not subclass
 
197
    # BzrCommandError, and non-UI code should not throw a subclass of
 
198
    # BzrCommandError.  ADHB 20051211
 
199
    def __init__(self, msg):
 
200
        self.msg = msg
 
201
 
 
202
    def __str__(self):
 
203
        return self.msg
 
204
 
 
205
 
 
206
class BzrOptionError(BzrCommandError):
 
207
    """Error in command line options"""
 
208
 
 
209
    
 
210
class StrictCommitFailed(BzrNewError):
 
211
    """Commit refused because there are unknown files in the tree"""
 
212
 
 
213
 
 
214
# XXX: Should be unified with TransportError; they seem to represent the
 
215
# same thing
 
216
class PathError(BzrNewError):
 
217
    """Generic path error: %(path)r%(extra)s)"""
 
218
 
 
219
    def __init__(self, path, extra=None):
 
220
        BzrNewError.__init__(self)
 
221
        self.path = path
 
222
        if extra:
 
223
            self.extra = ': ' + str(extra)
 
224
        else:
 
225
            self.extra = ''
 
226
 
 
227
 
 
228
class NoSuchFile(PathError):
 
229
    """No such file: %(path)r%(extra)s"""
 
230
 
 
231
 
 
232
class FileExists(PathError):
 
233
    """File exists: %(path)r%(extra)s"""
 
234
 
 
235
 
 
236
class DirectoryNotEmpty(PathError):
 
237
    """Directory not empty: %(path)r%(extra)s"""
 
238
 
 
239
 
 
240
class ResourceBusy(PathError):
 
241
    """Device or resource busy: %(path)r%(extra)s"""
 
242
 
 
243
 
 
244
class PermissionDenied(PathError):
 
245
    """Permission denied: %(path)r%(extra)s"""
 
246
 
 
247
 
 
248
class InvalidURL(PathError):
 
249
    """Invalid url supplied to transport: %(path)r%(extra)s"""
 
250
 
 
251
 
 
252
class InvalidURLJoin(PathError):
 
253
    """Invalid URL join request: %(args)s%(extra)s"""
 
254
 
 
255
    def __init__(self, msg, base, args):
 
256
        PathError.__init__(self, base, msg)
 
257
        self.args = [base]
 
258
        self.args.extend(args)
 
259
 
 
260
 
 
261
class UnsupportedProtocol(PathError):
 
262
    """Unsupported protocol for url "%(path)s"%(extra)s"""
 
263
 
 
264
    def __init__(self, url, extra):
 
265
        PathError.__init__(self, url, extra=extra)
 
266
 
 
267
 
 
268
class PathNotChild(BzrNewError):
 
269
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
270
 
 
271
    is_user_error = False
 
272
 
 
273
    def __init__(self, path, base, extra=None):
 
274
        BzrNewError.__init__(self)
 
275
        self.path = path
 
276
        self.base = base
 
277
        if extra:
 
278
            self.extra = ': ' + str(extra)
 
279
        else:
 
280
            self.extra = ''
 
281
 
 
282
 
 
283
class InvalidNormalization(PathError):
 
284
    """Path %(path)r is not unicode normalized"""
 
285
 
 
286
 
 
287
# TODO: This is given a URL; we try to unescape it but doing that from inside
 
288
# the exception object is a bit undesirable.
 
289
# TODO: Probably this behavior of should be a common superclass 
 
290
class NotBranchError(PathError):
 
291
    """Not a branch: %(path)s"""
 
292
 
 
293
    def __init__(self, path):
 
294
       import bzrlib.urlutils as urlutils
 
295
       self.path = urlutils.unescape_for_display(path, 'ascii')
 
296
 
 
297
 
 
298
class AlreadyBranchError(PathError):
 
299
    """Already a branch: %(path)s."""
 
300
 
 
301
 
 
302
class BranchExistsWithoutWorkingTree(PathError):
 
303
    """Directory contains a branch, but no working tree \
 
304
(use bzr checkout if you wish to build a working tree): %(path)s"""
 
305
 
 
306
 
 
307
class NoRepositoryPresent(BzrNewError):
 
308
    """No repository present: %(path)r"""
 
309
    def __init__(self, bzrdir):
 
310
        BzrNewError.__init__(self)
 
311
        self.path = bzrdir.transport.clone('..').base
 
312
 
 
313
 
 
314
class FileInWrongBranch(BzrNewError):
 
315
    """File %(path)s in not in branch %(branch_base)s."""
 
316
 
 
317
    def __init__(self, branch, path):
 
318
        BzrNewError.__init__(self)
 
319
        self.branch = branch
 
320
        self.branch_base = branch.base
 
321
        self.path = path
 
322
 
 
323
 
 
324
class UnsupportedFormatError(BzrNewError):
 
325
    """Unsupported branch format: %(format)s"""
 
326
 
 
327
 
 
328
class UnknownFormatError(BzrNewError):
 
329
    """Unknown branch format: %(format)r"""
 
330
 
 
331
 
 
332
class IncompatibleFormat(BzrNewError):
 
333
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
 
334
 
 
335
    def __init__(self, format, bzrdir_format):
 
336
        BzrNewError.__init__(self)
 
337
        self.format = format
 
338
        self.bzrdir = bzrdir_format
 
339
 
 
340
 
 
341
class NotVersionedError(BzrNewError):
 
342
    """%(path)s is not versioned"""
 
343
    def __init__(self, path):
 
344
        BzrNewError.__init__(self)
 
345
        self.path = path
 
346
 
 
347
 
 
348
class PathsNotVersionedError(BzrNewError):
 
349
    # used when reporting several paths are not versioned
 
350
    """Path(s) are not versioned: %(paths_as_string)s"""
 
351
 
 
352
    def __init__(self, paths):
 
353
        from bzrlib.osutils import quotefn
 
354
        BzrNewError.__init__(self)
 
355
        self.paths = paths
 
356
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
357
 
 
358
 
 
359
class PathsDoNotExist(BzrNewError):
 
360
    """Path(s) do not exist: %(paths_as_string)s"""
 
361
 
 
362
    # used when reporting that paths are neither versioned nor in the working
 
363
    # tree
 
364
 
 
365
    def __init__(self, paths):
 
366
        # circular import
 
367
        from bzrlib.osutils import quotefn
 
368
        BzrNewError.__init__(self)
 
369
        self.paths = paths
 
370
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
 
371
 
 
372
 
 
373
class BadFileKindError(BzrNewError):
 
374
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
375
 
 
376
 
 
377
class ForbiddenControlFileError(BzrNewError):
 
378
    """Cannot operate on %(filename)s because it is a control file"""
 
379
 
 
380
 
 
381
class LockError(BzrNewError):
 
382
    """Lock error: %(message)s"""
 
383
    # All exceptions from the lock/unlock functions should be from
 
384
    # this exception class.  They will be translated as necessary. The
 
385
    # original exception is available as e.original_error
 
386
    #
 
387
    # New code should prefer to raise specific subclasses
 
388
    def __init__(self, message):
 
389
        self.message = message
 
390
 
 
391
 
 
392
class CommitNotPossible(LockError):
 
393
    """A commit was attempted but we do not have a write lock open."""
 
394
    def __init__(self):
 
395
        pass
 
396
 
 
397
 
 
398
class AlreadyCommitted(LockError):
 
399
    """A rollback was requested, but is not able to be accomplished."""
 
400
    def __init__(self):
 
401
        pass
 
402
 
 
403
 
 
404
class ReadOnlyError(LockError):
 
405
    """A write attempt was made in a read only transaction on %(obj)s"""
 
406
    def __init__(self, obj):
 
407
        self.obj = obj
 
408
 
 
409
 
 
410
class OutSideTransaction(BzrNewError):
 
411
    """A transaction related operation was attempted after the transaction finished."""
 
412
 
 
413
 
 
414
class ObjectNotLocked(LockError):
 
415
    """%(obj)r is not locked"""
 
416
 
 
417
    is_user_error = False
 
418
 
 
419
    # this can indicate that any particular object is not locked; see also
 
420
    # LockNotHeld which means that a particular *lock* object is not held by
 
421
    # the caller -- perhaps they should be unified.
 
422
    def __init__(self, obj):
 
423
        self.obj = obj
 
424
 
 
425
 
 
426
class ReadOnlyObjectDirtiedError(ReadOnlyError):
 
427
    """Cannot change object %(obj)r in read only transaction"""
 
428
    def __init__(self, obj):
 
429
        self.obj = obj
 
430
 
 
431
 
 
432
class UnlockableTransport(LockError):
 
433
    """Cannot lock: transport is read only: %(transport)s"""
 
434
    def __init__(self, transport):
 
435
        self.transport = transport
 
436
 
 
437
 
 
438
class LockContention(LockError):
 
439
    """Could not acquire lock %(lock)s"""
 
440
    # TODO: show full url for lock, combining the transport and relative bits?
 
441
    def __init__(self, lock):
 
442
        self.lock = lock
 
443
 
 
444
 
 
445
class LockBroken(LockError):
 
446
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
 
447
    def __init__(self, lock):
 
448
        self.lock = lock
 
449
 
 
450
 
 
451
class LockBreakMismatch(LockError):
 
452
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
 
453
    def __init__(self, lock, holder, target):
 
454
        self.lock = lock
 
455
        self.holder = holder
 
456
        self.target = target
 
457
 
 
458
 
 
459
class LockNotHeld(LockError):
 
460
    """Lock not held: %(lock)s"""
 
461
    def __init__(self, lock):
 
462
        self.lock = lock
 
463
 
 
464
 
 
465
class PointlessCommit(BzrNewError):
 
466
    """No changes to commit"""
 
467
 
 
468
 
 
469
class UpgradeReadonly(BzrNewError):
 
470
    """Upgrade URL cannot work with readonly URL's."""
 
471
 
 
472
 
 
473
class UpToDateFormat(BzrNewError):
 
474
    """The branch format %(format)s is already at the most recent format."""
 
475
 
 
476
    def __init__(self, format):
 
477
        BzrNewError.__init__(self)
 
478
        self.format = format
 
479
 
 
480
 
 
481
 
 
482
class StrictCommitFailed(Exception):
 
483
    """Commit refused because there are unknowns in the tree."""
 
484
 
 
485
 
 
486
class NoSuchRevision(BzrNewError):
 
487
    """Branch %(branch)s has no revision %(revision)s"""
 
488
 
 
489
    is_user_error = False
 
490
 
95
491
    def __init__(self, branch, revision):
96
492
        self.branch = branch
97
493
        self.revision = revision
98
 
        msg = "Branch %s has no revision %s" % (branch, revision)
99
 
        BzrError.__init__(self, msg)
100
494
 
101
495
 
102
496
class HistoryMissing(BzrError):
107
501
                          % (branch, object_type, object_id))
108
502
 
109
503
 
110
 
class DivergedBranches(BzrError):
 
504
class DivergedBranches(BzrNewError):
 
505
    "These branches have diverged.  Use the merge command to reconcile them."""
 
506
 
 
507
    is_user_error = True
 
508
 
111
509
    def __init__(self, branch1, branch2):
112
 
        BzrError.__init__(self, "These branches have diverged.")
113
510
        self.branch1 = branch1
114
511
        self.branch2 = branch2
115
512
 
116
513
 
117
 
class UnrelatedBranches(BzrCommandError):
118
 
    def __init__(self):
119
 
        msg = "Branches have no common ancestor, and no base revision"\
120
 
            " specified."
121
 
        BzrCommandError.__init__(self, msg)
122
 
 
123
 
class NoCommonAncestor(BzrError):
 
514
class UnrelatedBranches(BzrNewError):
 
515
    "Branches have no common ancestor, and no merge base revision was specified."
 
516
 
 
517
    is_user_error = True
 
518
 
 
519
 
 
520
class NoCommonAncestor(BzrNewError):
 
521
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
522
 
124
523
    def __init__(self, revision_a, revision_b):
125
 
        msg = "Revisions have no common ancestor: %s %s." \
126
 
            % (revision_a, revision_b) 
127
 
        BzrError.__init__(self, msg)
 
524
        self.revision_a = revision_a
 
525
        self.revision_b = revision_b
 
526
 
128
527
 
129
528
class NoCommonRoot(BzrError):
130
529
    def __init__(self, revision_a, revision_b):
132
531
            % (revision_a, revision_b) 
133
532
        BzrError.__init__(self, msg)
134
533
 
135
 
class NotAncestor(BzrError):
136
 
    def __init__(self, rev_id, not_ancestor_id):
137
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
138
 
                                                        rev_id)
139
 
        BzrError.__init__(self, msg)
140
 
        self.rev_id = rev_id
141
 
        self.not_ancestor_id = not_ancestor_id
142
 
 
143
 
 
144
 
class NotAncestor(BzrError):
145
 
    def __init__(self, rev_id, not_ancestor_id):
146
 
        self.rev_id = rev_id
147
 
        self.not_ancestor_id = not_ancestor_id
148
 
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
149
 
                                                        rev_id)
150
 
        BzrError.__init__(self, msg)
 
534
 
 
535
 
 
536
class NotAncestor(BzrError):
 
537
    def __init__(self, rev_id, not_ancestor_id):
 
538
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
539
                                                        rev_id)
 
540
        BzrError.__init__(self, msg)
 
541
        self.rev_id = rev_id
 
542
        self.not_ancestor_id = not_ancestor_id
151
543
 
152
544
 
153
545
class InstallFailed(BzrError):
159
551
 
160
552
class AmbiguousBase(BzrError):
161
553
    def __init__(self, bases):
162
 
        msg = "The correct base is unclear, becase %s are all equally close" %\
 
554
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
 
555
                DeprecationWarning)
 
556
        msg = "The correct base is unclear, because %s are all equally close" %\
163
557
            ", ".join(bases)
164
558
        BzrError.__init__(self, msg)
165
559
        self.bases = bases
166
560
 
 
561
 
167
562
class NoCommits(BzrError):
168
563
    def __init__(self, branch):
169
564
        msg = "Branch %s has no commits." % branch
170
565
        BzrError.__init__(self, msg)
171
566
 
 
567
 
172
568
class UnlistableStore(BzrError):
173
569
    def __init__(self, store):
174
570
        BzrError.__init__(self, "Store %s is not listable" % store)
175
571
 
 
572
 
 
573
 
176
574
class UnlistableBranch(BzrError):
177
575
    def __init__(self, br):
178
576
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
179
577
 
180
578
 
181
 
from bzrlib.weave import WeaveError
182
 
 
183
 
class TransportError(BzrError):
184
 
    """All errors thrown by Transport implementations should derive
185
 
    from this class.
186
 
    """
 
579
class BoundBranchOutOfDate(BzrNewError):
 
580
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
 
581
    def __init__(self, branch, master):
 
582
        BzrNewError.__init__(self)
 
583
        self.branch = branch
 
584
        self.master = master
 
585
 
 
586
        
 
587
class CommitToDoubleBoundBranch(BzrNewError):
 
588
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
 
589
    def __init__(self, branch, master, remote):
 
590
        BzrNewError.__init__(self)
 
591
        self.branch = branch
 
592
        self.master = master
 
593
        self.remote = remote
 
594
 
 
595
 
 
596
class OverwriteBoundBranch(BzrNewError):
 
597
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
 
598
    def __init__(self, branch):
 
599
        BzrNewError.__init__(self)
 
600
        self.branch = branch
 
601
 
 
602
 
 
603
class BoundBranchConnectionFailure(BzrNewError):
 
604
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
 
605
    def __init__(self, branch, target, error):
 
606
        BzrNewError.__init__(self)
 
607
        self.branch = branch
 
608
        self.target = target
 
609
        self.error = error
 
610
 
 
611
 
 
612
class WeaveError(BzrNewError):
 
613
    """Error in processing weave: %(message)s"""
 
614
 
 
615
    def __init__(self, message=None):
 
616
        BzrNewError.__init__(self)
 
617
        self.message = message
 
618
 
 
619
 
 
620
class WeaveRevisionAlreadyPresent(WeaveError):
 
621
    """Revision {%(revision_id)s} already present in %(weave)s"""
 
622
    def __init__(self, revision_id, weave):
 
623
 
 
624
        WeaveError.__init__(self)
 
625
        self.revision_id = revision_id
 
626
        self.weave = weave
 
627
 
 
628
 
 
629
class WeaveRevisionNotPresent(WeaveError):
 
630
    """Revision {%(revision_id)s} not present in %(weave)s"""
 
631
 
 
632
    def __init__(self, revision_id, weave):
 
633
        WeaveError.__init__(self)
 
634
        self.revision_id = revision_id
 
635
        self.weave = weave
 
636
 
 
637
 
 
638
class WeaveFormatError(WeaveError):
 
639
    """Weave invariant violated: %(what)s"""
 
640
 
 
641
    def __init__(self, what):
 
642
        WeaveError.__init__(self)
 
643
        self.what = what
 
644
 
 
645
 
 
646
class WeaveParentMismatch(WeaveError):
 
647
    """Parents are mismatched between two revisions."""
 
648
    
 
649
 
 
650
class WeaveInvalidChecksum(WeaveError):
 
651
    """Text did not match it's checksum: %(message)s"""
 
652
 
 
653
 
 
654
class WeaveTextDiffers(WeaveError):
 
655
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
656
 
 
657
    def __init__(self, revision_id, weave_a, weave_b):
 
658
        WeaveError.__init__(self)
 
659
        self.revision_id = revision_id
 
660
        self.weave_a = weave_a
 
661
        self.weave_b = weave_b
 
662
 
 
663
 
 
664
class WeaveTextDiffers(WeaveError):
 
665
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
666
 
 
667
    def __init__(self, revision_id, weave_a, weave_b):
 
668
        WeaveError.__init__(self)
 
669
        self.revision_id = revision_id
 
670
        self.weave_a = weave_a
 
671
        self.weave_b = weave_b
 
672
 
 
673
 
 
674
class VersionedFileError(BzrNewError):
 
675
    """Versioned file error."""
 
676
 
 
677
 
 
678
class RevisionNotPresent(VersionedFileError):
 
679
    """Revision {%(revision_id)s} not present in %(file_id)s."""
 
680
 
 
681
    def __init__(self, revision_id, file_id):
 
682
        VersionedFileError.__init__(self)
 
683
        self.revision_id = revision_id
 
684
        self.file_id = file_id
 
685
 
 
686
 
 
687
class RevisionAlreadyPresent(VersionedFileError):
 
688
    """Revision {%(revision_id)s} already present in %(file_id)s."""
 
689
 
 
690
    def __init__(self, revision_id, file_id):
 
691
        VersionedFileError.__init__(self)
 
692
        self.revision_id = revision_id
 
693
        self.file_id = file_id
 
694
 
 
695
 
 
696
class KnitError(BzrNewError):
 
697
    """Knit error"""
 
698
 
 
699
 
 
700
class KnitHeaderError(KnitError):
 
701
    """Knit header error: %(badline)r unexpected"""
 
702
 
 
703
    def __init__(self, badline):
 
704
        KnitError.__init__(self)
 
705
        self.badline = badline
 
706
 
 
707
 
 
708
class KnitCorrupt(KnitError):
 
709
    """Knit %(filename)s corrupt: %(how)s"""
 
710
 
 
711
    def __init__(self, filename, how):
 
712
        KnitError.__init__(self)
 
713
        self.filename = filename
 
714
        self.how = how
 
715
 
 
716
 
 
717
class NoSuchExportFormat(BzrNewError):
 
718
    """Export format %(format)r not supported"""
 
719
    def __init__(self, format):
 
720
        BzrNewError.__init__(self)
 
721
        self.format = format
 
722
 
 
723
 
 
724
class TransportError(BzrNewError):
 
725
    """Transport error: %(msg)s %(orig_error)s"""
 
726
 
187
727
    def __init__(self, msg=None, orig_error=None):
188
728
        if msg is None and orig_error is not None:
189
729
            msg = str(orig_error)
190
 
        BzrError.__init__(self, msg)
 
730
        if orig_error is None:
 
731
            orig_error = ''
 
732
        if msg is None:
 
733
            msg =  ''
191
734
        self.msg = msg
192
735
        self.orig_error = orig_error
 
736
        BzrNewError.__init__(self)
 
737
 
193
738
 
194
739
# A set of semi-meaningful errors which can be thrown
195
740
class TransportNotPossible(TransportError):
196
 
    """This is for transports where a specific function is explicitly not
197
 
    possible. Such as pushing files to an HTTP server.
198
 
    """
199
 
    pass
200
 
 
201
 
class NonRelativePath(TransportError):
202
 
    """An absolute path was supplied, that could not be decoded into
203
 
    a relative path.
204
 
    """
205
 
    pass
206
 
 
207
 
class NoSuchFile(TransportError, IOError):
208
 
    """A get() was issued for a file that doesn't exist."""
209
 
 
210
 
    def __str__(self):
211
 
        return self.msg
212
 
 
213
 
    def __init__(self, msg=None, orig_error=None):
214
 
        import errno
215
 
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
216
 
        IOError.__init__(self, errno.ENOENT, self.msg)
217
 
 
218
 
class FileExists(TransportError, OSError):
219
 
    """An operation was attempted, which would overwrite an entry,
220
 
    but overwritting is not supported.
221
 
 
222
 
    mkdir() can throw this, but put() just overwites existing files.
223
 
    """
224
 
    def __init__(self, msg=None, orig_error=None):
225
 
        import errno
226
 
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
227
 
        OSError.__init__(self, errno.EEXIST, self.msg)
228
 
 
229
 
class PermissionDenied(TransportError):
230
 
    """An operation cannot succeed because of a lack of permissions."""
231
 
    pass
 
741
    """Transport operation not possible: %(msg)s %(orig_error)%"""
 
742
 
 
743
 
 
744
class ConnectionError(TransportError):
 
745
    """Connection error: %(msg)s %(orig_error)s"""
 
746
 
232
747
 
233
748
class ConnectionReset(TransportError):
234
 
    """The connection has been closed."""
235
 
    pass
236
 
 
 
749
    """Connection closed: %(msg)s %(orig_error)s"""
 
750
 
 
751
 
 
752
class ConflictsInTree(BzrError):
 
753
    def __init__(self):
 
754
        BzrError.__init__(self, "Working tree has conflicts.")
 
755
 
 
756
 
 
757
class ParseConfigError(BzrError):
 
758
    def __init__(self, errors, filename):
 
759
        if filename is None:
 
760
            filename = ""
 
761
        message = "Error(s) parsing config file %s:\n%s" % \
 
762
            (filename, ('\n'.join(e.message for e in errors)))
 
763
        BzrError.__init__(self, message)
 
764
 
 
765
 
 
766
class SigningFailed(BzrError):
 
767
    def __init__(self, command_line):
 
768
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
769
                               % command_line)
 
770
 
 
771
 
 
772
class WorkingTreeNotRevision(BzrError):
 
773
    def __init__(self, tree):
 
774
        BzrError.__init__(self, "The working tree for %s has changed since"
 
775
                          " last commit, but weave merge requires that it be"
 
776
                          " unchanged." % tree.basedir)
 
777
 
 
778
 
 
779
class CantReprocessAndShowBase(BzrNewError):
 
780
    """Can't reprocess and show base.
 
781
Reprocessing obscures relationship of conflicting lines to base."""
 
782
 
 
783
 
 
784
class GraphCycleError(BzrNewError):
 
785
    """Cycle in graph %(graph)r"""
 
786
    def __init__(self, graph):
 
787
        BzrNewError.__init__(self)
 
788
        self.graph = graph
 
789
 
 
790
 
 
791
class NotConflicted(BzrNewError):
 
792
    """File %(filename)s is not conflicted."""
 
793
 
 
794
    def __init__(self, filename):
 
795
        BzrNewError.__init__(self)
 
796
        self.filename = filename
 
797
 
 
798
 
 
799
class MustUseDecorated(Exception):
 
800
    """A decorating function has requested its original command be used.
 
801
    
 
802
    This should never escape bzr, so does not need to be printable.
 
803
    """
 
804
 
 
805
 
 
806
class NoBundleFound(BzrNewError):
 
807
    """No bundle was found in %(filename)s"""
 
808
    def __init__(self, filename):
 
809
        BzrNewError.__init__(self)
 
810
        self.filename = filename
 
811
 
 
812
 
 
813
class BundleNotSupported(BzrNewError):
 
814
    """Unable to handle bundle version %(version)s: %(msg)s"""
 
815
    def __init__(self, version, msg):
 
816
        BzrNewError.__init__(self)
 
817
        self.version = version
 
818
        self.msg = msg
 
819
 
 
820
 
 
821
class MissingText(BzrNewError):
 
822
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
 
823
 
 
824
    def __init__(self, branch, text_revision, file_id):
 
825
        BzrNewError.__init__(self)
 
826
        self.branch = branch
 
827
        self.base = branch.base
 
828
        self.text_revision = text_revision
 
829
        self.file_id = file_id
 
830
 
 
831
 
 
832
class DuplicateKey(BzrNewError):
 
833
    """Key %(key)s is already present in map"""
 
834
 
 
835
 
 
836
class MalformedTransform(BzrNewError):
 
837
    """Tree transform is malformed %(conflicts)r"""
 
838
 
 
839
 
 
840
class BzrBadParameter(BzrNewError):
 
841
    """A bad parameter : %(param)s is not usable.
 
842
    
 
843
    This exception should never be thrown, but it is a base class for all
 
844
    parameter-to-function errors.
 
845
    """
 
846
    def __init__(self, param):
 
847
        BzrNewError.__init__(self)
 
848
        self.param = param
 
849
 
 
850
 
 
851
class BzrBadParameterNotUnicode(BzrBadParameter):
 
852
    """Parameter %(param)s is neither unicode nor utf8."""
 
853
 
 
854
 
 
855
class ReusingTransform(BzrNewError):
 
856
    """Attempt to reuse a transform that has already been applied."""
 
857
 
 
858
 
 
859
class CantMoveRoot(BzrNewError):
 
860
    """Moving the root directory is not supported at this time"""
 
861
 
 
862
 
 
863
class BzrBadParameterNotString(BzrBadParameter):
 
864
    """Parameter %(param)s is not a string or unicode string."""
 
865
 
 
866
 
 
867
class BzrBadParameterMissing(BzrBadParameter):
 
868
    """Parameter $(param)s is required but not present."""
 
869
 
 
870
 
 
871
class BzrBadParameterUnicode(BzrBadParameter):
 
872
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
 
873
 
 
874
 
 
875
class BzrBadParameterContainsNewline(BzrBadParameter):
 
876
    """Parameter %(param)s contains a newline."""
 
877
 
 
878
 
 
879
class DependencyNotPresent(BzrNewError):
 
880
    """Unable to import library "%(library)s": %(error)s"""
 
881
 
 
882
    def __init__(self, library, error):
 
883
        BzrNewError.__init__(self, library=library, error=error)
 
884
 
 
885
 
 
886
class ParamikoNotPresent(DependencyNotPresent):
 
887
    """Unable to import paramiko (required for sftp support): %(error)s"""
 
888
 
 
889
    def __init__(self, error):
 
890
        DependencyNotPresent.__init__(self, 'paramiko', error)
 
891
 
 
892
 
 
893
class UninitializableFormat(BzrNewError):
 
894
    """Format %(format)s cannot be initialised by this version of bzr."""
 
895
 
 
896
    def __init__(self, format):
 
897
        BzrNewError.__init__(self)
 
898
        self.format = format
 
899
 
 
900
 
 
901
class NoDiff(BzrNewError):
 
902
    """Diff is not installed on this machine: %(msg)s"""
 
903
 
 
904
    def __init__(self, msg):
 
905
        super(NoDiff, self).__init__(msg=msg)
 
906
 
 
907
 
 
908
class NoDiff3(BzrNewError):
 
909
    """Diff3 is not installed on this machine."""
 
910
 
 
911
 
 
912
class ExistingLimbo(BzrNewError):
 
913
    """This tree contains left-over files from a failed operation.
 
914
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
915
    keep, and delete it when you are done.
 
916
    """
 
917
    def __init__(self, limbo_dir):
 
918
       BzrNewError.__init__(self)
 
919
       self.limbo_dir = limbo_dir
 
920
 
 
921
 
 
922
class ImmortalLimbo(BzrNewError):
 
923
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
924
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
925
    keep, and delete it when you are done.
 
926
    """
 
927
    def __init__(self, limbo_dir):
 
928
       BzrNewError.__init__(self)
 
929
       self.limbo_dir = limbo_dir
 
930
 
 
931
 
 
932
class OutOfDateTree(BzrNewError):
 
933
    """Working tree is out of date, please run 'bzr update'."""
 
934
 
 
935
    def __init__(self, tree):
 
936
        BzrNewError.__init__(self)
 
937
        self.tree = tree
 
938
 
 
939
 
 
940
class MergeModifiedFormatError(BzrNewError):
 
941
    """Error in merge modified format"""
 
942
 
 
943
 
 
944
class ConflictFormatError(BzrNewError):
 
945
    """Format error in conflict listings"""
 
946
 
 
947
 
 
948
class CorruptRepository(BzrNewError):
 
949
    """An error has been detected in the repository %(repo_path)s.
 
950
Please run bzr reconcile on this repository."""
 
951
 
 
952
    def __init__(self, repo):
 
953
        BzrNewError.__init__(self)
 
954
        self.repo_path = repo.bzrdir.root_transport.base
 
955
 
 
956
 
 
957
class UpgradeRequired(BzrNewError):
 
958
    """To use this feature you must upgrade your branch at %(path)s."""
 
959
 
 
960
    def __init__(self, path):
 
961
        BzrNewError.__init__(self)
 
962
        self.path = path
 
963
 
 
964
 
 
965
class LocalRequiresBoundBranch(BzrNewError):
 
966
    """Cannot perform local-only commits on unbound branches."""
 
967
 
 
968
 
 
969
class MissingProgressBarFinish(BzrNewError):
 
970
    """A nested progress bar was not 'finished' correctly."""
 
971
 
 
972
 
 
973
class InvalidProgressBarType(BzrNewError):
 
974
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
975
Select one of: %(valid_types)s"""
 
976
 
 
977
    def __init__(self, bar_type, valid_types):
 
978
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
979
 
 
980
 
 
981
class UnsupportedOperation(BzrNewError):
 
982
    """The method %(mname)s is not supported on objects of type %(tname)s."""
 
983
    def __init__(self, method, method_self):
 
984
        self.method = method
 
985
        self.mname = method.__name__
 
986
        self.tname = type(method_self).__name__
 
987
 
 
988
 
 
989
class BinaryFile(BzrNewError):
 
990
    """File is binary but should be text."""
 
991
 
 
992
 
 
993
class IllegalPath(BzrNewError):
 
994
    """The path %(path)s is not permitted on this platform"""
 
995
 
 
996
    def __init__(self, path):
 
997
        BzrNewError.__init__(self)
 
998
        self.path = path
 
999
 
 
1000
 
 
1001
class TestamentMismatch(BzrNewError):
 
1002
    """Testament did not match expected value.  
 
1003
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1004
       {%(measured)s}
 
1005
    """
 
1006
    def __init__(self, revision_id, expected, measured):
 
1007
        self.revision_id = revision_id
 
1008
        self.expected = expected
 
1009
        self.measured = measured
 
1010
 
 
1011
 
 
1012
class NotABundle(BzrNewError):
 
1013
    """Not a bzr revision-bundle: %(text)r"""
 
1014
 
 
1015
    def __init__(self, text):
 
1016
        self.text = text
 
1017
 
 
1018
 
 
1019
class BadBundle(Exception): pass
 
1020
 
 
1021
 
 
1022
class MalformedHeader(BadBundle): pass
 
1023
 
 
1024
 
 
1025
class MalformedPatches(BadBundle): pass
 
1026
 
 
1027
 
 
1028
class MalformedFooter(BadBundle): pass