/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: Aaron Bentley
  • Date: 2005-10-24 12:48:52 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1488.
  • Revision ID: abentley@panoramicfeedback.com-20051024124852-c1214f7527292c30
Fixed exception (No such thing as EncodingError that I can see)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
 
1
# -*- coding: UTF-8 -*-
 
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
Exceptions are caught at a high level to report errors to the user, and
 
20
might also be caught inside the program.  Therefore it needs to be
 
21
possible to convert them to a meaningful string, and also for them to be
 
22
interrogated by the program.
 
23
 
 
24
Exceptions are defined such that the arguments given to the constructor
 
25
are stored in the object as properties of the same name.  When the
 
26
object is printed as a string, the doc string of the class is used as
 
27
a format string with the property dictionary available to it.
 
28
 
 
29
This means that exceptions can used like this:
 
30
 
 
31
>>> import sys
 
32
>>> try:
 
33
...   raise NotBranchError(path='/foo/bar')
 
34
... except:
 
35
...   print sys.exc_type
 
36
...   print sys.exc_value
 
37
...   print sys.exc_value.path
 
38
bzrlib.errors.NotBranchError
 
39
Not a branch: /foo/bar
 
40
/foo/bar
 
41
 
 
42
Therefore:
 
43
 
 
44
 * create a new exception class for any class of error that can be
 
45
   usefully distinguished.
 
46
 
 
47
 * the printable form of an exception is generated by the base class
 
48
   __str__ method
 
49
"""
 
50
 
 
51
# based on Scott James Remnant's hct error classes
 
52
 
 
53
# TODO: is there any value in providing the .args field used by standard
 
54
# python exceptions?   A list of values with no names seems less useful 
 
55
# to me.
 
56
 
 
57
# TODO: Perhaps convert the exception to a string at the moment it's 
 
58
# constructed to make sure it will succeed.  But that says nothing about
 
59
# exceptions that are never raised.
 
60
 
 
61
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
62
# the old one.
 
63
 
 
64
 
 
65
class BzrError(StandardError):
 
66
    def __str__(self):
 
67
        # XXX: Should we show the exception class in 
 
68
        # exceptions that don't provide their own message?  
 
69
        # maybe it should be done at a higher level
 
70
        ## n = self.__class__.__name__ + ': '
 
71
        n = ''
 
72
        if len(self.args) == 1:
 
73
            return str(self.args[0])
 
74
        elif len(self.args) == 2:
 
75
            # further explanation or suggestions
 
76
            try:
 
77
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
78
            except TypeError:
 
79
                return n + "%r" % self
 
80
        else:
 
81
            return n + `self.args`
 
82
 
 
83
 
 
84
class BzrNewError(BzrError):
 
85
    """bzr error"""
 
86
    # base classes should override the docstring with their human-
 
87
    # readable explanation
 
88
 
 
89
    def __init__(self, **kwds):
 
90
        for key, value in kwds.items():
 
91
            setattr(self, key, value)
 
92
 
 
93
    def __str__(self):
 
94
        try:
 
95
            return self.__doc__ % self.__dict__
 
96
        except (NameError, ValueError, KeyError), e:
 
97
            return 'Unprintable exception %s: %s' \
 
98
                % (self.__class__.__name__, str(e))
 
99
 
 
100
 
 
101
class BzrCheckError(BzrNewError):
 
102
    """Internal check failed: %(message)s"""
 
103
    def __init__(self, message):
 
104
        self.message = message
 
105
 
 
106
 
 
107
class InvalidEntryName(BzrNewError):
 
108
    """Invalid entry name: %(name)s"""
 
109
    def __init__(self, name):
 
110
        self.name = name
 
111
 
 
112
 
 
113
class InvalidRevisionNumber(BzrNewError):
 
114
    """Invalid revision number %(revno)d"""
 
115
    def __init__(self, revno):
 
116
        self.revno = revno
 
117
 
 
118
 
 
119
class InvalidRevisionId(BzrNewError):
 
120
    """Invalid revision-id %(revision_id)r"""
 
121
    def __init__(self, revision_id):
 
122
        self.revision_id = revision_id
 
123
 
 
124
class BzrCommandError(BzrError):
 
125
    # Error from malformed user command
 
126
    def __str__(self):
 
127
        return self.args[0]
 
128
 
 
129
class StrictCommitFailed(Exception):
 
130
    """Commit refused because there are unknowns in the tree."""
 
131
 
 
132
class NotBranchError(BzrNewError):
 
133
    """Not a branch: %(path)s"""
 
134
    def __init__(self, path):
 
135
        BzrNewError.__init__(self)
 
136
        self.path = path
 
137
 
 
138
 
 
139
class UnsupportedFormatError(BzrError):
 
140
    """Specified path is a bzr branch that we cannot read."""
 
141
    def __str__(self):
 
142
        return 'unsupported branch format: %s' % self.args[0]
 
143
 
 
144
 
 
145
class NotVersionedError(BzrNewError):
 
146
    """%(path)s is not versioned"""
 
147
    def __init__(self, path):
 
148
        BzrNewError.__init__(self)
 
149
        self.path = path
 
150
 
 
151
 
 
152
class BadFileKindError(BzrError):
 
153
    """Specified file is of a kind that cannot be added.
 
154
 
 
155
    (For example a symlink or device file.)"""
 
156
 
 
157
 
 
158
class ForbiddenFileError(BzrError):
 
159
    """Cannot operate on a file because it is a control file."""
 
160
 
 
161
 
 
162
class LockError(Exception):
 
163
    """Lock error"""
 
164
    # All exceptions from the lock/unlock functions should be from
 
165
    # this exception class.  They will be translated as necessary. The
 
166
    # original exception is available as e.original_error
 
167
 
 
168
 
 
169
class CommitNotPossible(LockError):
 
170
    """A commit was attempted but we do not have a write lock open."""
 
171
 
 
172
 
 
173
class AlreadyCommitted(LockError):
 
174
    """A rollback was requested, but is not able to be accomplished."""
 
175
 
 
176
 
 
177
class ReadOnlyError(LockError):
 
178
    """A write attempt was made in a read only transaction."""
 
179
 
 
180
 
 
181
class PointlessCommit(BzrNewError):
 
182
    """No changes to commit"""
 
183
 
 
184
 
 
185
class NoSuchRevision(BzrError):
 
186
    def __init__(self, branch, revision):
 
187
        self.branch = branch
 
188
        self.revision = revision
 
189
        msg = "Branch %s has no revision %s" % (branch, revision)
 
190
        BzrError.__init__(self, msg)
 
191
 
 
192
 
 
193
class HistoryMissing(BzrError):
 
194
    def __init__(self, branch, object_type, object_id):
 
195
        self.branch = branch
 
196
        BzrError.__init__(self,
 
197
                          '%s is missing %s {%s}'
 
198
                          % (branch, object_type, object_id))
 
199
 
 
200
 
 
201
class DivergedBranches(BzrError):
 
202
    def __init__(self, branch1, branch2):
 
203
        BzrError.__init__(self, "These branches have diverged.")
 
204
        self.branch1 = branch1
 
205
        self.branch2 = branch2
 
206
 
 
207
 
 
208
class UnrelatedBranches(BzrCommandError):
 
209
    def __init__(self):
 
210
        msg = "Branches have no common ancestor, and no base revision"\
 
211
            " specified."
 
212
        BzrCommandError.__init__(self, msg)
 
213
 
 
214
class NoCommonAncestor(BzrError):
 
215
    def __init__(self, revision_a, revision_b):
 
216
        msg = "Revisions have no common ancestor: %s %s." \
 
217
            % (revision_a, revision_b) 
 
218
        BzrError.__init__(self, msg)
 
219
 
 
220
class NoCommonRoot(BzrError):
 
221
    def __init__(self, revision_a, revision_b):
 
222
        msg = "Revisions are not derived from the same root: %s %s." \
 
223
            % (revision_a, revision_b) 
 
224
        BzrError.__init__(self, msg)
 
225
 
 
226
class NotAncestor(BzrError):
 
227
    def __init__(self, rev_id, not_ancestor_id):
 
228
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
229
                                                        rev_id)
 
230
        BzrError.__init__(self, msg)
 
231
        self.rev_id = rev_id
 
232
        self.not_ancestor_id = not_ancestor_id
 
233
 
 
234
 
 
235
class NotAncestor(BzrError):
 
236
    def __init__(self, rev_id, not_ancestor_id):
 
237
        self.rev_id = rev_id
 
238
        self.not_ancestor_id = not_ancestor_id
 
239
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
240
                                                        rev_id)
 
241
        BzrError.__init__(self, msg)
 
242
 
 
243
 
 
244
class InstallFailed(BzrError):
 
245
    def __init__(self, revisions):
 
246
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
 
247
        BzrError.__init__(self, msg)
 
248
        self.revisions = revisions
 
249
 
 
250
 
 
251
class AmbiguousBase(BzrError):
 
252
    def __init__(self, bases):
 
253
        msg = "The correct base is unclear, becase %s are all equally close" %\
 
254
            ", ".join(bases)
 
255
        BzrError.__init__(self, msg)
 
256
        self.bases = bases
 
257
 
 
258
class NoCommits(BzrError):
 
259
    def __init__(self, branch):
 
260
        msg = "Branch %s has no commits." % branch
 
261
        BzrError.__init__(self, msg)
 
262
 
 
263
class UnlistableStore(BzrError):
 
264
    def __init__(self, store):
 
265
        BzrError.__init__(self, "Store %s is not listable" % store)
 
266
 
 
267
class UnlistableBranch(BzrError):
 
268
    def __init__(self, br):
 
269
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
 
270
 
 
271
 
 
272
from bzrlib.weave import WeaveError, WeaveParentMismatch
 
273
 
 
274
class TransportError(BzrError):
 
275
    """All errors thrown by Transport implementations should derive
 
276
    from this class.
 
277
    """
 
278
    def __init__(self, msg=None, orig_error=None):
 
279
        if msg is None and orig_error is not None:
 
280
            msg = str(orig_error)
 
281
        BzrError.__init__(self, msg)
 
282
        self.msg = msg
 
283
        self.orig_error = orig_error
 
284
 
 
285
# A set of semi-meaningful errors which can be thrown
 
286
class TransportNotPossible(TransportError):
 
287
    """This is for transports where a specific function is explicitly not
 
288
    possible. Such as pushing files to an HTTP server.
 
289
    """
 
290
    pass
 
291
 
 
292
class NonRelativePath(TransportError):
 
293
    """An absolute path was supplied, that could not be decoded into
 
294
    a relative path.
 
295
    """
 
296
    pass
 
297
 
 
298
class NoSuchFile(TransportError, IOError):
 
299
    """A get() was issued for a file that doesn't exist."""
 
300
 
 
301
    # XXX: Is multiple inheritance for exceptions really needed?
 
302
 
 
303
    def __str__(self):
 
304
        return 'no such file: ' + self.msg
 
305
 
 
306
    def __init__(self, msg=None, orig_error=None):
 
307
        import errno
 
308
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
309
        IOError.__init__(self, errno.ENOENT, self.msg)
 
310
 
 
311
class FileExists(TransportError, OSError):
 
312
    """An operation was attempted, which would overwrite an entry,
 
313
    but overwritting is not supported.
 
314
 
 
315
    mkdir() can throw this, but put() just overwites existing files.
 
316
    """
 
317
    # XXX: Is multiple inheritance for exceptions really needed?
 
318
    def __init__(self, msg=None, orig_error=None):
 
319
        import errno
 
320
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
 
321
        OSError.__init__(self, errno.EEXIST, self.msg)
 
322
 
 
323
class PermissionDenied(TransportError):
 
324
    """An operation cannot succeed because of a lack of permissions."""
 
325
    pass
 
326
 
 
327
class ConnectionReset(TransportError):
 
328
    """The connection has been closed."""
 
329
    pass
 
330
 
 
331
class ConflictsInTree(BzrError):
 
332
    def __init__(self):
 
333
        BzrError.__init__(self, "Working tree has conflicts.")
 
334
 
 
335
class ParseConfigError(BzrError):
 
336
    def __init__(self, errors, filename):
 
337
        if filename is None:
 
338
            filename = ""
 
339
        message = "Error(s) parsing config file %s:\n%s" % \
 
340
            (filename, ('\n'.join(e.message for e in errors)))
 
341
        BzrError.__init__(self, message)
 
342
 
 
343
class SigningFailed(BzrError):
 
344
    def __init__(self, command_line):
 
345
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
346
                               % command_line)
 
347
 
 
348
class WorkingTreeNotRevision(BzrError):
 
349
    def __init__(self, tree):
 
350
        BzrError.__init__(self, "The working tree for %s has changed since"
 
351
                          " last commit, but weave merge requires that it be"
 
352
                          " unchanged." % tree.basedir)