/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
1
# (C) 2005 Canonical
1 by mbp at sourcefrog
import from baz patch-364
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
1185.16.61 by mbp at sourcefrog
- start introducing hct error classes
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
1185.33.7 by Martin Pool
Better formatting of builtin errors
49
50
Exception strings should start with a capital letter and not have a final
51
fullstop.
1185.16.61 by mbp at sourcefrog
- start introducing hct error classes
52
"""
53
54
# based on Scott James Remnant's hct error classes
55
1185.16.62 by mbp at sourcefrog
- convert NotBranchError to new exception base
56
# TODO: is there any value in providing the .args field used by standard
57
# python exceptions?   A list of values with no names seems less useful 
58
# to me.
59
1185.16.63 by Martin Pool
- more error conversion
60
# TODO: Perhaps convert the exception to a string at the moment it's 
61
# constructed to make sure it will succeed.  But that says nothing about
62
# exceptions that are never raised.
63
64
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
65
# the old one.
1185.16.62 by mbp at sourcefrog
- convert NotBranchError to new exception base
66
1185.16.61 by mbp at sourcefrog
- start introducing hct error classes
67
1 by mbp at sourcefrog
import from baz patch-364
68
class BzrError(StandardError):
1193 by Martin Pool
- better string formatting of BzrErrors with explanation
69
    def __str__(self):
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
70
        # XXX: Should we show the exception class in 
71
        # exceptions that don't provide their own message?  
72
        # maybe it should be done at a higher level
73
        ## n = self.__class__.__name__ + ': '
74
        n = ''
1195 by Martin Pool
- better error display
75
        if len(self.args) == 1:
1449 by Robert Collins
teach check about ghosts
76
            return str(self.args[0])
1195 by Martin Pool
- better error display
77
        elif len(self.args) == 2:
1193 by Martin Pool
- better string formatting of BzrErrors with explanation
78
            # further explanation or suggestions
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
79
            try:
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
80
                return n + '\n  '.join([self.args[0]] + self.args[1])
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
81
            except TypeError:
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
82
                return n + "%r" % self
1193 by Martin Pool
- better string formatting of BzrErrors with explanation
83
        else:
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
84
            return n + `self.args`
1193 by Martin Pool
- better string formatting of BzrErrors with explanation
85
1185.1.14 by Robert Collins
remove more duplicate merged hunks. Bad MERGE3, BAD.
86
1185.16.62 by mbp at sourcefrog
- convert NotBranchError to new exception base
87
class BzrNewError(BzrError):
1185.16.61 by mbp at sourcefrog
- start introducing hct error classes
88
    """bzr error"""
89
    # base classes should override the docstring with their human-
90
    # readable explanation
91
92
    def __init__(self, **kwds):
93
        for key, value in kwds.items():
94
            setattr(self, key, value)
95
96
    def __str__(self):
97
        try:
98
            return self.__doc__ % self.__dict__
99
        except (NameError, ValueError, KeyError), e:
100
            return 'Unprintable exception %s: %s' \
101
                % (self.__class__.__name__, str(e))
102
103
1185.16.63 by Martin Pool
- more error conversion
104
class BzrCheckError(BzrNewError):
105
    """Internal check failed: %(message)s"""
106
    def __init__(self, message):
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
107
        BzrNewError.__init__(self)
1185.16.63 by Martin Pool
- more error conversion
108
        self.message = message
109
110
111
class InvalidEntryName(BzrNewError):
112
    """Invalid entry name: %(name)s"""
113
    def __init__(self, name):
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
114
        BzrNewError.__init__(self)
1185.16.63 by Martin Pool
- more error conversion
115
        self.name = name
116
117
118
class InvalidRevisionNumber(BzrNewError):
119
    """Invalid revision number %(revno)d"""
120
    def __init__(self, revno):
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
121
        BzrNewError.__init__(self)
1185.16.63 by Martin Pool
- more error conversion
122
        self.revno = revno
123
124
125
class InvalidRevisionId(BzrNewError):
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
126
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
127
    def __init__(self, revision_id, branch):
128
        BzrNewError.__init__(self)
1185.12.90 by Aaron Bentley
Fixed InvalidRevisionID handling in Branch.get_revision_xml
129
        self.revision_id = revision_id
1185.16.103 by mbp at sourcefrog
Fix up all calls to InvalidRevisionId() to specify parameters.
130
        self.branch = branch
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
131
132
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
133
class NoWorkingTree(BzrNewError):
134
    """No WorkingTree exists for %s(base)."""
135
    
136
    def __init__(self, base):
137
        BzrNewError.__init__(self)
138
        self.base = base
1506 by Robert Collins
Merge Johns current integration work.
139
140
329 by Martin Pool
- refactor command functions into command classes
141
class BzrCommandError(BzrError):
142
    # Error from malformed user command
1495 by Robert Collins
Add a --create-prefix to the new push command.
143
    # This is being misused as a generic exception
144
    # pleae subclass. RBC 20051030
1185.54.18 by Aaron Bentley
Noted difference of opinion wrt BzrCommandError
145
    #
146
    # I think it's a waste of effort to differentiate between errors that
147
    # are not intended to be caught anyway.  UI code need not subclass
148
    # BzrCommandError, and non-UI code should not throw a subclass of
149
    # BzrCommandError.  ADHB 20051211
1393.1.64 by Martin Pool
- improved display of some errors, including NotBranchError
150
    def __str__(self):
151
        return self.args[0]
1 by mbp at sourcefrog
import from baz patch-364
152
1495 by Robert Collins
Add a --create-prefix to the new push command.
153
154
class BzrOptionError(BzrCommandError):
155
    """Some missing or otherwise incorrect option was supplied."""
156
157
    
1185.16.65 by mbp at sourcefrog
- new commit --strict option
158
class StrictCommitFailed(Exception):
159
    """Commit refused because there are unknowns in the tree."""
1 by mbp at sourcefrog
import from baz patch-364
160
1185.50.11 by John Arbash Meinel
[merge] Refactor NoSuchFile style exceptions.
161
162
class PathError(BzrNewError):
163
    """Generic path error: %(path)r%(extra)s)"""
164
    def __init__(self, path, extra=None):
165
        BzrNewError.__init__(self)
166
        self.path = path
167
        if extra:
168
            self.extra = ': ' + str(extra)
169
        else:
170
            self.extra = ''
171
172
173
class NoSuchFile(PathError):
174
    """No such file: %(path)r%(extra)s"""
175
176
177
class FileExists(PathError):
178
    """File exists: %(path)r%(extra)s"""
179
180
181
class PermissionDenied(PathError):
182
    """Permission denied: %(path)r%(extra)s"""
183
184
185
class PathNotChild(BzrNewError):
186
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
187
    def __init__(self, path, base, extra=None):
188
        BzrNewError.__init__(self)
189
        self.path = path
190
        self.base = base
191
        if extra:
192
            self.extra = ': ' + str(extra)
193
        else:
194
            self.extra = ''
195
196
1185.16.62 by mbp at sourcefrog
- convert NotBranchError to new exception base
197
class NotBranchError(BzrNewError):
198
    """Not a branch: %(path)s"""
1185.16.61 by mbp at sourcefrog
- start introducing hct error classes
199
    def __init__(self, path):
1185.16.62 by mbp at sourcefrog
- convert NotBranchError to new exception base
200
        BzrNewError.__init__(self)
201
        self.path = path
202
573 by Martin Pool
- new exception NotBranchError
203
1185.35.32 by Aaron Bentley
Fixed handling of files in mixed branches
204
class FileInWrongBranch(BzrNewError):
205
    """File %(path)s in not in branch %(branch_base)s."""
206
    def __init__(self, branch, path):
207
        BzrNewError.__init__(self)
208
        self.branch = branch
209
        self.branch_base = branch.base
210
        self.path = path
211
212
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
213
class UnsupportedFormatError(BzrError):
214
    """Specified path is a bzr branch that we cannot read."""
215
    def __str__(self):
216
        return 'unsupported branch format: %s' % self.args[0]
217
218
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
219
class NotVersionedError(BzrNewError):
220
    """%(path)s is not versioned"""
221
    def __init__(self, path):
222
        BzrNewError.__init__(self)
223
        self.path = path
753 by Martin Pool
- new exception NotVersionedError
224
225
599 by Martin Pool
- better error reporting from smart_add
226
class BadFileKindError(BzrError):
227
    """Specified file is of a kind that cannot be added.
228
229
    (For example a symlink or device file.)"""
230
231
232
class ForbiddenFileError(BzrError):
233
    """Cannot operate on a file because it is a control file."""
234
235
614 by Martin Pool
- unify two defintions of LockError
236
class LockError(Exception):
1185.16.63 by Martin Pool
- more error conversion
237
    """Lock error"""
238
    # All exceptions from the lock/unlock functions should be from
239
    # this exception class.  They will be translated as necessary. The
240
    # original exception is available as e.original_error
882 by Martin Pool
- Optionally raise EmptyCommit if there are no changes. Test for this.
241
242
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
243
class CommitNotPossible(LockError):
244
    """A commit was attempted but we do not have a write lock open."""
245
246
247
class AlreadyCommitted(LockError):
248
    """A rollback was requested, but is not able to be accomplished."""
249
250
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
251
class ReadOnlyError(LockError):
252
    """A write attempt was made in a read only transaction."""
253
254
1185.16.63 by Martin Pool
- more error conversion
255
class PointlessCommit(BzrNewError):
1185.16.64 by Martin Pool
- more error conversions
256
    """No changes to commit"""
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
257
1185.22.1 by Michael Ellerman
Implement strict commits with --strict flag.
258
class StrictCommitFailed(Exception):
259
    """Commit refused because there are unknowns in the tree."""
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
260
261
class NoSuchRevision(BzrError):
262
    def __init__(self, branch, revision):
263
        self.branch = branch
264
        self.revision = revision
265
        msg = "Branch %s has no revision %s" % (branch, revision)
266
        BzrError.__init__(self, msg)
267
1034 by Martin Pool
- merge bzrlib.revision.is_ancestor from aaron
268
1192 by Martin Pool
- clean up code for retrieving stored inventories
269
class HistoryMissing(BzrError):
270
    def __init__(self, branch, object_type, object_id):
271
        self.branch = branch
272
        BzrError.__init__(self,
273
                          '%s is missing %s {%s}'
274
                          % (branch, object_type, object_id))
275
276
1185.2.1 by Lalo Martins
moving DivergedBranches from bzrlib.branch to bzrlib.errors, obeying:
277
class DivergedBranches(BzrError):
278
    def __init__(self, branch1, branch2):
1185.56.1 by Michael Ellerman
Simplify handling of DivergedBranches in cmd_pull()
279
        BzrError.__init__(self, "These branches have diverged.  Try merge.")
1185.2.1 by Lalo Martins
moving DivergedBranches from bzrlib.branch to bzrlib.errors, obeying:
280
        self.branch1 = branch1
281
        self.branch2 = branch2
282
1390 by Robert Collins
pair programming worx... merge integration and weave
283
1105 by Martin Pool
- expose 'find-merge-base' as a new expert command,
284
class UnrelatedBranches(BzrCommandError):
285
    def __init__(self):
286
        msg = "Branches have no common ancestor, and no base revision"\
287
            " specified."
288
        BzrCommandError.__init__(self, msg)
289
974.1.80 by Aaron Bentley
Improved merge error handling and testing
290
class NoCommonAncestor(BzrError):
291
    def __init__(self, revision_a, revision_b):
292
        msg = "Revisions have no common ancestor: %s %s." \
293
            % (revision_a, revision_b) 
294
        BzrError.__init__(self, msg)
295
296
class NoCommonRoot(BzrError):
297
    def __init__(self, revision_a, revision_b):
298
        msg = "Revisions are not derived from the same root: %s %s." \
299
            % (revision_a, revision_b) 
300
        BzrError.__init__(self, msg)
1105 by Martin Pool
- expose 'find-merge-base' as a new expert command,
301
974.2.7 by aaron.bentley at utoronto
Merged from bzr.24
302
class NotAncestor(BzrError):
303
    def __init__(self, rev_id, not_ancestor_id):
1185.1.14 by Robert Collins
remove more duplicate merged hunks. Bad MERGE3, BAD.
304
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
305
                                                        rev_id)
306
        BzrError.__init__(self, msg)
307
        self.rev_id = rev_id
308
        self.not_ancestor_id = not_ancestor_id
1185.1.12 by Robert Collins
merge in lsdiff/filterdiff friendliness
309
310
974.1.30 by aaron.bentley at utoronto
Changed copy_multi to permit failure and return a tuple, tested missing required revisions
311
class InstallFailed(BzrError):
312
    def __init__(self, revisions):
1185.1.14 by Robert Collins
remove more duplicate merged hunks. Bad MERGE3, BAD.
313
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
314
        BzrError.__init__(self, msg)
974.1.30 by aaron.bentley at utoronto
Changed copy_multi to permit failure and return a tuple, tested missing required revisions
315
        self.revisions = revisions
1154 by Martin Pool
- fix imports for moved errors
316
317
318
class AmbiguousBase(BzrError):
319
    def __init__(self, bases):
320
        msg = "The correct base is unclear, becase %s are all equally close" %\
321
            ", ".join(bases)
322
        BzrError.__init__(self, msg)
323
        self.bases = bases
324
974.1.80 by Aaron Bentley
Improved merge error handling and testing
325
class NoCommits(BzrError):
326
    def __init__(self, branch):
327
        msg = "Branch %s has no commits." % branch
328
        BzrError.__init__(self, msg)
1185.10.1 by Aaron Bentley
Added --basis option to bzr branch
329
330
class UnlistableStore(BzrError):
331
    def __init__(self, store):
332
        BzrError.__init__(self, "Store %s is not listable" % store)
333
334
class UnlistableBranch(BzrError):
335
    def __init__(self, br):
336
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
1392 by Robert Collins
reinstate testfetch test case
337
338
1185.16.116 by mbp at sourcefrog
Move weave errors into bzrlib.errors and make consistent with new system.
339
class WeaveError(BzrNewError):
340
    """Error in processing weave: %(message)s"""
341
    def __init__(self, message=None):
342
        BzrNewError.__init__(self)
343
        self.message = message
344
345
346
class WeaveRevisionAlreadyPresent(WeaveError):
347
    """Revision {%(revision_id)s} already present in %(weave)s"""
348
    def __init__(self, revision_id, weave):
349
        WeaveError.__init__(self)
350
        self.revision_id = revision_id
351
        self.weave = weave
352
353
354
class WeaveRevisionNotPresent(WeaveError):
355
    """Revision {%(revision_id)s} not present in %(weave)s"""
356
    def __init__(self, revision_id, weave):
357
        WeaveError.__init__(self)
358
        self.revision_id = revision_id
359
        self.weave = weave
360
361
362
class WeaveFormatError(WeaveError):
363
    """Weave invariant violated: %(what)s"""
364
    def __init__(self, what):
365
        WeaveError.__init__(self)
366
        self.what = what
367
368
369
class WeaveParentMismatch(WeaveError):
370
    """Parents are mismatched between two revisions."""
371
    
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
372
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
373
class NoSuchExportFormat(BzrNewError):
374
    """Export format %(format)r not supported"""
375
    def __init__(self, format):
376
        BzrNewError.__init__(self)
377
        self.format = format
378
379
1185.11.9 by John Arbash Meinel
Most tests pass, some problems with unavailable socket recv
380
class TransportError(BzrError):
381
    """All errors thrown by Transport implementations should derive
382
    from this class.
383
    """
384
    def __init__(self, msg=None, orig_error=None):
385
        if msg is None and orig_error is not None:
386
            msg = str(orig_error)
387
        BzrError.__init__(self, msg)
388
        self.msg = msg
389
        self.orig_error = orig_error
390
391
# A set of semi-meaningful errors which can be thrown
392
class TransportNotPossible(TransportError):
393
    """This is for transports where a specific function is explicitly not
394
    possible. Such as pushing files to an HTTP server.
395
    """
396
    pass
397
1185.50.11 by John Arbash Meinel
[merge] Refactor NoSuchFile style exceptions.
398
399
class ConnectionError(TransportError):
400
    """A connection problem prevents file retrieval.
1185.35.31 by Aaron Bentley
Throw ConnectionError instead of NoSuchFile except when we get a 404
401
    This does not indicate whether the file exists or not; it indicates that a
402
    precondition for requesting the file was not met.
403
    """
1185.50.11 by John Arbash Meinel
[merge] Refactor NoSuchFile style exceptions.
404
    def __init__(self, msg=None, orig_error=None):
405
        TransportError.__init__(self, msg=msg, orig_error=orig_error)
406
1185.11.9 by John Arbash Meinel
Most tests pass, some problems with unavailable socket recv
407
408
class ConnectionReset(TransportError):
409
    """The connection has been closed."""
410
    pass
411
1185.14.10 by Aaron Bentley
Commit aborts with conflicts in the tree.
412
class ConflictsInTree(BzrError):
413
    def __init__(self):
414
        BzrError.__init__(self, "Working tree has conflicts.")
1185.12.49 by Aaron Bentley
Switched to ConfigObj
415
416
class ParseConfigError(BzrError):
417
    def __init__(self, errors, filename):
418
        if filename is None:
419
            filename = ""
420
        message = "Error(s) parsing config file %s:\n%s" % \
421
            (filename, ('\n'.join(e.message for e in errors)))
422
        BzrError.__init__(self, message)
1185.12.52 by Aaron Bentley
Merged more config stuff from Robert
423
1442.1.58 by Robert Collins
gpg signing of content
424
class SigningFailed(BzrError):
425
    def __init__(self, command_line):
426
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
427
                               % command_line)
1185.12.83 by Aaron Bentley
Preliminary weave merge support
428
429
class WorkingTreeNotRevision(BzrError):
430
    def __init__(self, tree):
431
        BzrError.__init__(self, "The working tree for %s has changed since"
432
                          " last commit, but weave merge requires that it be"
433
                          " unchanged." % tree.basedir)
1185.12.104 by Aaron Bentley
Merged Martin's latest
434
1185.24.1 by Aaron Bentley
Got reprocessing working
435
class CantReprocessAndShowBase(BzrNewError):
436
    """Can't reprocess and show base.
437
Reprocessing obscures relationship of conflicting lines to base."""
1185.24.2 by Aaron Bentley
Merge from mainline
438
1185.16.114 by mbp at sourcefrog
Improved topological sort
439
class GraphCycleError(BzrNewError):
440
    """Cycle in graph %(graph)r"""
441
    def __init__(self, graph):
442
        BzrNewError.__init__(self)
443
        self.graph = graph
1185.35.1 by Aaron Bentley
Implemented conflicts.restore
444
445
class NotConflicted(BzrNewError):
1185.35.4 by Aaron Bentley
Implemented remerge
446
    """File %(filename)s is not conflicted."""
1185.35.1 by Aaron Bentley
Implemented conflicts.restore
447
    def __init__(self, filename):
448
        BzrNewError.__init__(self)
449
        self.filename = filename
1185.35.13 by Aaron Bentley
Merged Martin
450
1492 by Robert Collins
Support decoration of commands.
451
class MustUseDecorated(Exception):
452
    """A decorating function has requested its original command be used.
453
    
454
    This should never escape bzr, so does not need to be printable.
455
    """
456
1185.35.42 by Aaron Bentley
Fixed fetch to be safer wrt ghosts and corrupt branches
457
class MissingText(BzrNewError):
458
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
459
    def __init__(self, branch, text_revision, file_id):
460
        self.branch = branch
461
        self.base = branch.base
462
        self.text_revision = text_revision
463
        self.file_id = file_id