85
34
# constructed to make sure it will succeed. But that says nothing about
86
35
# exceptions that are never raised.
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
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.
37
# TODO: selftest assertRaises should probably also check that every error
38
# raised can be formatted as a string successfully, and without giving
96
42
class BzrError(StandardError):
44
Base class for errors raised by bzrlib.
46
:cvar internal_error: if true (or absent) this was probably caused by a
47
bzr bug and should be displayed with a traceback; if False this was
48
probably a user or environment error and they don't need the gory details.
49
(That can be overridden by -Derror on the command line.)
51
:cvar _fmt: Format string to display the error; this is expanded
52
by the instance's dict.
55
internal_error = False
57
def __init__(self, msg=None, **kwds):
58
"""Construct a new BzrError.
60
There are two alternative forms for constructing these objects.
61
Either a preformatted string may be passed, or a set of named
62
arguments can be given. The first is for generic "user" errors which
63
are not intended to be caught and so do not need a specific subclass.
64
The second case is for use with subclasses that provide a _fmt format
65
string to print the arguments.
67
Keyword arguments are taken as parameters to the error, which can
68
be inserted into the format string template. It's recommended
69
that subclasses override the __init__ method to require specific
72
:param msg: If given, this is the literal complete text for the error,
73
not subject to expansion.
75
StandardError.__init__(self)
77
# I was going to deprecate this, but it actually turns out to be
78
# quite handy - mbp 20061103.
79
self._preformatted_string = msg
81
self._preformatted_string = None
82
for key, value in kwds.items():
83
setattr(self, key, value)
100
85
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__ + ': '
106
if len(self.args) == 1:
107
return str(self.args[0])
108
elif len(self.args) == 2:
109
# further explanation or suggestions
111
return n + '\n '.join([self.args[0]] + self.args[1])
113
return n + "%r" % self
115
return n + `self.args`
86
s = getattr(self, '_preformatted_string', None)
88
# contains a preformatted message; must be cast to plain str
91
fmt = self._get_format_string()
93
s = fmt % self.__dict__
94
# __str__() should always return a 'str' object
95
# never a 'unicode' object.
96
if isinstance(s, unicode):
97
return s.encode('utf8')
99
except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
100
return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
101
% (self.__class__.__name__,
103
getattr(self, '_fmt', None),
106
def _get_format_string(self):
107
"""Return format string for this exception or None"""
108
fmt = getattr(self, '_fmt', None)
111
fmt = getattr(self, '__doc__', None)
113
symbol_versioning.warn("%s uses its docstring as a format, "
114
"it should use _fmt instead" % self.__class__.__name__,
117
return 'Unprintable exception %s: dict=%r, fmt=%r' \
118
% (self.__class__.__name__,
120
getattr(self, '_fmt', None),
118
124
class BzrNewError(BzrError):
125
"""Deprecated error base class."""
120
126
# base classes should override the docstring with their human-
121
127
# readable explanation
123
def __init__(self, **kwds):
129
def __init__(self, *args, **kwds):
130
# XXX: Use the underlying BzrError to always generate the args attribute
131
# if it doesn't exist. We can't use super here, because exceptions are
132
# old-style classes in python2.4 (but new in 2.5). --bmc, 20060426
133
symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
134
'please convert %s to use BzrError instead'
135
% self.__class__.__name__,
138
BzrError.__init__(self, *args)
124
139
for key, value in kwds.items():
125
140
setattr(self, key, value)
879
1082
BzrError.__init__(self, message)
1085
class NoEmailInUsername(BzrError):
1087
_fmt = "%(username)r does not seem to contain a reasonable email address"
1089
def __init__(self, username):
1090
BzrError.__init__(self)
1091
self.username = username
882
1094
class SigningFailed(BzrError):
1096
_fmt = "Failed to gpg sign data with command %(command_line)r"
883
1098
def __init__(self, command_line):
884
BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
1099
BzrError.__init__(self, command_line=command_line)
888
1102
class WorkingTreeNotRevision(BzrError):
1104
_fmt = ("The working tree for %(basedir)s has changed since"
1105
" the last commit, but weave merge requires that it be"
889
1108
def __init__(self, tree):
890
BzrError.__init__(self, "The working tree for %s has changed since"
891
" last commit, but weave merge requires that it be"
892
" unchanged." % tree.basedir)
895
class CantReprocessAndShowBase(BzrNewError):
896
"""Can't reprocess and show base.
897
Reprocessing obscures relationship of conflicting lines to base."""
900
class GraphCycleError(BzrNewError):
901
"""Cycle in graph %(graph)r"""
1109
BzrError.__init__(self, basedir=tree.basedir)
1112
class CantReprocessAndShowBase(BzrError):
1114
_fmt = "Can't reprocess and show base, because reprocessing obscures " \
1115
"the relationship of conflicting lines to the base"
1118
class GraphCycleError(BzrError):
1120
_fmt = "Cycle in graph %(graph)r"
902
1122
def __init__(self, graph):
903
BzrNewError.__init__(self)
1123
BzrError.__init__(self)
904
1124
self.graph = graph
907
class NotConflicted(BzrNewError):
908
"""File %(filename)s is not conflicted."""
1127
class WritingCompleted(BzrError):
1129
_fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1130
"called upon it - accept bytes may not be called anymore.")
1132
internal_error = True
1134
def __init__(self, request):
1135
self.request = request
1138
class WritingNotComplete(BzrError):
1140
_fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1141
"called upon it - until the write phase is complete no "
1142
"data may be read.")
1144
internal_error = True
1146
def __init__(self, request):
1147
self.request = request
1150
class NotConflicted(BzrError):
1152
_fmt = "File %(filename)s is not conflicted."
910
1154
def __init__(self, filename):
911
BzrNewError.__init__(self)
1155
BzrError.__init__(self)
912
1156
self.filename = filename
1159
class MediumNotConnected(BzrError):
1161
_fmt = """The medium '%(medium)s' is not connected."""
1163
internal_error = True
1165
def __init__(self, medium):
1166
self.medium = medium
915
1169
class MustUseDecorated(Exception):
916
"""A decorating function has requested its original command be used.
918
This should never escape bzr, so does not need to be printable.
922
class NoBundleFound(BzrNewError):
923
"""No bundle was found in %(filename)s"""
1171
_fmt = """A decorating function has requested its original command be used."""
1174
class NoBundleFound(BzrError):
1176
_fmt = "No bundle was found in %(filename)s"
924
1178
def __init__(self, filename):
925
BzrNewError.__init__(self)
1179
BzrError.__init__(self)
926
1180
self.filename = filename
929
class BundleNotSupported(BzrNewError):
930
"""Unable to handle bundle version %(version)s: %(msg)s"""
1183
class BundleNotSupported(BzrError):
1185
_fmt = "Unable to handle bundle version %(version)s: %(msg)s"
931
1187
def __init__(self, version, msg):
932
BzrNewError.__init__(self)
1188
BzrError.__init__(self)
933
1189
self.version = version
937
class MissingText(BzrNewError):
938
"""Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
1193
class MissingText(BzrError):
1195
_fmt = "Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"
940
1197
def __init__(self, branch, text_revision, file_id):
941
BzrNewError.__init__(self)
1198
BzrError.__init__(self)
942
1199
self.branch = branch
943
1200
self.base = branch.base
944
1201
self.text_revision = text_revision
945
1202
self.file_id = file_id
948
class DuplicateKey(BzrNewError):
949
"""Key %(key)s is already present in map"""
952
class MalformedTransform(BzrNewError):
953
"""Tree transform is malformed %(conflicts)r"""
956
class BzrBadParameter(BzrNewError):
957
"""A bad parameter : %(param)s is not usable.
959
This exception should never be thrown, but it is a base class for all
960
parameter-to-function errors.
1205
class DuplicateKey(BzrError):
1207
_fmt = "Key %(key)s is already present in map"
1210
class MalformedTransform(BzrError):
1212
_fmt = "Tree transform is malformed %(conflicts)r"
1215
class NoFinalPath(BzrError):
1217
_fmt = ("No final name for trans_id %(trans_id)r\n"
1218
"file-id: %(file_id)r\n"
1219
"root trans-id: %(root_trans_id)r\n")
1221
def __init__(self, trans_id, transform):
1222
self.trans_id = trans_id
1223
self.file_id = transform.final_file_id(trans_id)
1224
self.root_trans_id = transform.root
1227
class BzrBadParameter(BzrError):
1229
_fmt = "Bad parameter: %(param)r"
1231
# This exception should never be thrown, but it is a base class for all
1232
# parameter-to-function errors.
962
1234
def __init__(self, param):
963
BzrNewError.__init__(self)
1235
BzrError.__init__(self)
964
1236
self.param = param
967
1239
class BzrBadParameterNotUnicode(BzrBadParameter):
968
"""Parameter %(param)s is neither unicode nor utf8."""
971
class ReusingTransform(BzrNewError):
972
"""Attempt to reuse a transform that has already been applied."""
975
class CantMoveRoot(BzrNewError):
976
"""Moving the root directory is not supported at this time"""
1241
_fmt = "Parameter %(param)s is neither unicode nor utf8."
1244
class ReusingTransform(BzrError):
1246
_fmt = "Attempt to reuse a transform that has already been applied."
1249
class CantMoveRoot(BzrError):
1251
_fmt = "Moving the root directory is not supported at this time"
979
1254
class BzrBadParameterNotString(BzrBadParameter):
980
"""Parameter %(param)s is not a string or unicode string."""
1256
_fmt = "Parameter %(param)s is not a string or unicode string."
983
1259
class BzrBadParameterMissing(BzrBadParameter):
984
"""Parameter $(param)s is required but not present."""
1261
_fmt = "Parameter $(param)s is required but not present."
987
1264
class BzrBadParameterUnicode(BzrBadParameter):
988
"""Parameter %(param)s is unicode but only byte-strings are permitted."""
1266
_fmt = "Parameter %(param)s is unicode but only byte-strings are permitted."
991
1269
class BzrBadParameterContainsNewline(BzrBadParameter):
992
"""Parameter %(param)s contains a newline."""
995
class DependencyNotPresent(BzrNewError):
996
"""Unable to import library "%(library)s": %(error)s"""
1271
_fmt = "Parameter %(param)s contains a newline."
1274
class DependencyNotPresent(BzrError):
1276
_fmt = 'Unable to import library "%(library)s": %(error)s'
998
1278
def __init__(self, library, error):
999
BzrNewError.__init__(self, library=library, error=error)
1279
BzrError.__init__(self, library=library, error=error)
1002
1282
class ParamikoNotPresent(DependencyNotPresent):
1003
"""Unable to import paramiko (required for sftp support): %(error)s"""
1284
_fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1005
1286
def __init__(self, error):
1006
1287
DependencyNotPresent.__init__(self, 'paramiko', error)
1009
class PointlessMerge(BzrNewError):
1010
"""Nothing to merge."""
1013
class UninitializableFormat(BzrNewError):
1014
"""Format %(format)s cannot be initialised by this version of bzr."""
1290
class PointlessMerge(BzrError):
1292
_fmt = "Nothing to merge."
1295
class UninitializableFormat(BzrError):
1297
_fmt = "Format %(format)s cannot be initialised by this version of bzr."
1016
1299
def __init__(self, format):
1017
BzrNewError.__init__(self)
1300
BzrError.__init__(self)
1018
1301
self.format = format
1021
class BadConversionTarget(BzrNewError):
1022
"""Cannot convert to format %(format)s. %(problem)s"""
1304
class BadConversionTarget(BzrError):
1306
_fmt = "Cannot convert to format %(format)s. %(problem)s"
1024
1308
def __init__(self, problem, format):
1025
BzrNewError.__init__(self)
1309
BzrError.__init__(self)
1026
1310
self.problem = problem
1027
1311
self.format = format
1030
class NoDiff(BzrNewError):
1031
"""Diff is not installed on this machine: %(msg)s"""
1314
class NoDiff(BzrError):
1316
_fmt = "Diff is not installed on this machine: %(msg)s"
1033
1318
def __init__(self, msg):
1034
BzrNewError.__init__(self, msg=msg)
1037
class NoDiff3(BzrNewError):
1038
"""Diff3 is not installed on this machine."""
1041
class ExistingLimbo(BzrNewError):
1042
"""This tree contains left-over files from a failed operation.
1043
Please examine %(limbo_dir)s to see if it contains any files you wish to
1044
keep, and delete it when you are done.
1046
def __init__(self, limbo_dir):
1047
BzrNewError.__init__(self)
1048
self.limbo_dir = limbo_dir
1051
class ImmortalLimbo(BzrNewError):
1052
"""Unable to delete transform temporary directory $(limbo_dir)s.
1053
Please examine %(limbo_dir)s to see if it contains any files you wish to
1054
keep, and delete it when you are done.
1056
def __init__(self, limbo_dir):
1057
BzrNewError.__init__(self)
1058
self.limbo_dir = limbo_dir
1061
class OutOfDateTree(BzrNewError):
1062
"""Working tree is out of date, please run 'bzr update'."""
1319
BzrError.__init__(self, msg=msg)
1322
class NoDiff3(BzrError):
1324
_fmt = "Diff3 is not installed on this machine."
1327
class ExistingLimbo(BzrError):
1329
_fmt = """This tree contains left-over files from a failed operation.
1330
Please examine %(limbo_dir)s to see if it contains any files you wish to
1331
keep, and delete it when you are done."""
1333
def __init__(self, limbo_dir):
1334
BzrError.__init__(self)
1335
self.limbo_dir = limbo_dir
1338
class ImmortalLimbo(BzrError):
1340
_fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
1341
Please examine %(limbo_dir)s to see if it contains any files you wish to
1342
keep, and delete it when you are done."""
1344
def __init__(self, limbo_dir):
1345
BzrError.__init__(self)
1346
self.limbo_dir = limbo_dir
1349
class OutOfDateTree(BzrError):
1351
_fmt = "Working tree is out of date, please run 'bzr update'."
1064
1353
def __init__(self, tree):
1065
BzrNewError.__init__(self)
1354
BzrError.__init__(self)
1066
1355
self.tree = tree
1069
class MergeModifiedFormatError(BzrNewError):
1070
"""Error in merge modified format"""
1073
class ConflictFormatError(BzrNewError):
1074
"""Format error in conflict listings"""
1077
class CorruptRepository(BzrNewError):
1078
"""An error has been detected in the repository %(repo_path)s.
1358
class MergeModifiedFormatError(BzrError):
1360
_fmt = "Error in merge modified format"
1363
class ConflictFormatError(BzrError):
1365
_fmt = "Format error in conflict listings"
1368
class CorruptRepository(BzrError):
1370
_fmt = """An error has been detected in the repository %(repo_path)s.
1079
1371
Please run bzr reconcile on this repository."""
1081
1373
def __init__(self, repo):
1082
BzrNewError.__init__(self)
1374
BzrError.__init__(self)
1083
1375
self.repo_path = repo.bzrdir.root_transport.base
1086
class UpgradeRequired(BzrNewError):
1087
"""To use this feature you must upgrade your branch at %(path)s."""
1378
class UpgradeRequired(BzrError):
1380
_fmt = "To use this feature you must upgrade your branch at %(path)s."
1089
1382
def __init__(self, path):
1090
BzrNewError.__init__(self)
1383
BzrError.__init__(self)
1091
1384
self.path = path
1094
class LocalRequiresBoundBranch(BzrNewError):
1095
"""Cannot perform local-only commits on unbound branches."""
1098
class MissingProgressBarFinish(BzrNewError):
1099
"""A nested progress bar was not 'finished' correctly."""
1102
class InvalidProgressBarType(BzrNewError):
1103
"""Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1387
class LocalRequiresBoundBranch(BzrError):
1389
_fmt = "Cannot perform local-only commits on unbound branches."
1392
class MissingProgressBarFinish(BzrError):
1394
_fmt = "A nested progress bar was not 'finished' correctly."
1397
class InvalidProgressBarType(BzrError):
1399
_fmt = """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
1104
1400
Select one of: %(valid_types)s"""
1106
1402
def __init__(self, bar_type, valid_types):
1107
BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1110
class UnsupportedOperation(BzrNewError):
1111
"""The method %(mname)s is not supported on objects of type %(tname)s."""
1403
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1406
class UnsupportedOperation(BzrError):
1408
_fmt = "The method %(mname)s is not supported on objects of type %(tname)s."
1112
1410
def __init__(self, method, method_self):
1113
1411
self.method = method
1114
1412
self.mname = method.__name__
1115
1413
self.tname = type(method_self).__name__
1118
class BinaryFile(BzrNewError):
1119
"""File is binary but should be text."""
1122
class IllegalPath(BzrNewError):
1123
"""The path %(path)s is not permitted on this platform"""
1416
class BinaryFile(BzrError):
1418
_fmt = "File is binary but should be text."
1421
class IllegalPath(BzrError):
1423
_fmt = "The path %(path)s is not permitted on this platform"
1125
1425
def __init__(self, path):
1126
BzrNewError.__init__(self)
1426
BzrError.__init__(self)
1127
1427
self.path = path
1130
class TestamentMismatch(BzrNewError):
1131
"""Testament did not match expected value.
1430
class TestamentMismatch(BzrError):
1432
_fmt = """Testament did not match expected value.
1132
1433
For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1135
1436
def __init__(self, revision_id, expected, measured):
1136
1437
self.revision_id = revision_id
1137
1438
self.expected = expected
1138
1439
self.measured = measured
1141
class NotABundle(BzrNewError):
1142
"""Not a bzr revision-bundle: %(text)r"""
1442
class NotABundle(BzrError):
1444
_fmt = "Not a bzr revision-bundle: %(text)r"
1144
1446
def __init__(self, text):
1145
BzrNewError.__init__(self)
1447
BzrError.__init__(self)
1146
1448
self.text = text
1149
class BadBundle(BzrNewError):
1150
"""Bad bzr revision-bundle: %(text)r"""
1451
class BadBundle(BzrError):
1453
_fmt = "Bad bzr revision-bundle: %(text)r"
1152
1455
def __init__(self, text):
1153
BzrNewError.__init__(self)
1456
BzrError.__init__(self)
1154
1457
self.text = text
1157
1460
class MalformedHeader(BadBundle):
1158
"""Malformed bzr revision-bundle header: %(text)r"""
1160
def __init__(self, text):
1161
BzrNewError.__init__(self)
1462
_fmt = "Malformed bzr revision-bundle header: %(text)r"
1165
1465
class MalformedPatches(BadBundle):
1166
"""Malformed patches in bzr revision-bundle: %(text)r"""
1168
def __init__(self, text):
1169
BzrNewError.__init__(self)
1467
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
1173
1470
class MalformedFooter(BadBundle):
1174
"""Malformed footer in bzr revision-bundle: %(text)r"""
1176
def __init__(self, text):
1177
BzrNewError.__init__(self)
1472
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
1181
1475
class UnsupportedEOLMarker(BadBundle):
1182
"""End of line marker was not \\n in bzr revision-bundle"""
1477
_fmt = "End of line marker was not \\n in bzr revision-bundle"
1184
1479
def __init__(self):
1185
BzrNewError.__init__(self)
1188
class BadInventoryFormat(BzrNewError):
1189
"""Root class for inventory serialization errors"""
1480
# XXX: BadBundle's constructor assumes there's explanatory text,
1481
# but for this there is not
1482
BzrError.__init__(self)
1485
class IncompatibleBundleFormat(BzrError):
1487
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1489
def __init__(self, bundle_format, other):
1490
BzrError.__init__(self)
1491
self.bundle_format = bundle_format
1495
class BadInventoryFormat(BzrError):
1497
_fmt = "Root class for inventory serialization errors"
1192
1500
class UnexpectedInventoryFormat(BadInventoryFormat):
1193
"""The inventory was not in the expected format:\n %(msg)s"""
1502
_fmt = "The inventory was not in the expected format:\n %(msg)s"
1195
1504
def __init__(self, msg):
1196
1505
BadInventoryFormat.__init__(self, msg=msg)
1508
class NoSmartMedium(BzrError):
1510
_fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1512
def __init__(self, transport):
1513
self.transport = transport
1199
1516
class NoSmartServer(NotBranchError):
1200
"""No smart server available at %(url)s"""
1518
_fmt = "No smart server available at %(url)s"
1202
1520
def __init__(self, url):
1206
class UnknownSSH(BzrNewError):
1207
"""Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1524
class UnknownSSH(BzrError):
1526
_fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1209
1528
def __init__(self, vendor):
1210
BzrNewError.__init__(self)
1529
BzrError.__init__(self)
1211
1530
self.vendor = vendor
1214
class GhostRevisionUnusableHere(BzrNewError):
1215
"""Ghost revision {%(revision_id)s} cannot be used here."""
1533
class GhostRevisionUnusableHere(BzrError):
1535
_fmt = "Ghost revision {%(revision_id)s} cannot be used here."
1217
1537
def __init__(self, revision_id):
1218
BzrNewError.__init__(self)
1538
BzrError.__init__(self)
1219
1539
self.revision_id = revision_id
1222
class IllegalUseOfScopeReplacer(BzrNewError):
1223
"""ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
1225
is_user_error = False
1542
class IllegalUseOfScopeReplacer(BzrError):
1544
_fmt = "ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"
1546
internal_error = True
1227
1548
def __init__(self, name, msg, extra=None):
1228
BzrNewError.__init__(self)
1549
BzrError.__init__(self)
1229
1550
self.name = name
added
removed
bzrlib/errors.py
