Coverage for python/lsst/daf/butler/_exceptions.py: 79%

39 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-03-30 02:51 -0700

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28"""Specialized Butler exceptions.""" 

29__all__ = ( 

30 "CalibrationLookupError", 

31 "DatasetNotFoundError", 

32 "DimensionNameError", 

33 "ButlerUserError", 

34 "DatasetTypeNotSupportedError", 

35 "EmptyQueryResultError", 

36 "MissingDatasetTypeError", 

37 "MissingCollectionError", 

38 "ValidationError", 

39) 

40 

41from ._exceptions_legacy import CollectionError, DataIdError, DatasetTypeError 

42 

43 

44class ButlerUserError(Exception): 

45 """Base class for Butler exceptions that contain a user-facing error 

46 message. 

47 

48 Parameters 

49 ---------- 

50 detail : `str` 

51 Details about the error that occurred. 

52 """ 

53 

54 # When used with Butler server, exceptions inheriting from 

55 # this class will be sent to the client side and re-raised by RemoteButler 

56 # there. Be careful that error messages do not contain security-sensitive 

57 # information. 

58 # 

59 # This should only be used for "expected" errors that occur because of 

60 # errors in user-supplied data passed to Butler methods. It should not be 

61 # used for any issues caused by the Butler configuration file, errors in 

62 # the library code itself or the underlying databases. 

63 # 

64 # When you create a new subclass of this type, add it to the list in 

65 # _USER_ERROR_TYPES below. 

66 

67 error_type: str 

68 """Unique name for this error type, used to identify it when sending 

69 information about the error to the client. 

70 """ 

71 

72 def __init__(self, detail: str): 

73 return super().__init__(detail) 

74 

75 

76class CalibrationLookupError(LookupError, ButlerUserError): 

77 """Exception raised for failures to look up a calibration dataset.""" 

78 

79 error_type = "calibration_lookup" 

80 

81 

82class DatasetNotFoundError(LookupError, ButlerUserError): 

83 """The requested dataset could not be found.""" 

84 

85 error_type = "dataset_not_found" 

86 

87 

88class DimensionNameError(KeyError, DataIdError, ButlerUserError): 

89 """Exception raised when a dimension specified in a data ID does not exist 

90 or required dimension is not provided. 

91 """ 

92 

93 error_type = "dimension_name" 

94 

95 

96class DimensionValueError(ValueError, ButlerUserError): 

97 """Exception raised for issues with dimension values in a data ID.""" 

98 

99 error_type = "dimension_value" 

100 

101 

102class MissingCollectionError(CollectionError, ButlerUserError): 

103 """Exception raised when an operation attempts to use a collection that 

104 does not exist. 

105 """ 

106 

107 error_type = "missing_collection" 

108 

109 

110class MissingDatasetTypeError(DatasetTypeError, KeyError, ButlerUserError): 

111 """Exception raised when a dataset type does not exist.""" 

112 

113 error_type = "missing_dataset_type" 

114 

115 

116class DatasetTypeNotSupportedError(RuntimeError): 

117 """A `DatasetType` is not handled by this routine. 

118 

119 This can happen in a `Datastore` when a particular `DatasetType` 

120 has no formatters associated with it. 

121 """ 

122 

123 pass 

124 

125 

126class ValidationError(RuntimeError): 

127 """Some sort of validation error has occurred.""" 

128 

129 pass 

130 

131 

132class EmptyQueryResultError(Exception): 

133 """Exception raised when query methods return an empty result and `explain` 

134 flag is set. 

135 

136 Parameters 

137 ---------- 

138 reasons : `list` [`str`] 

139 List of possible reasons for an empty query result. 

140 """ 

141 

142 def __init__(self, reasons: list[str]): 

143 self.reasons = reasons 

144 

145 def __str__(self) -> str: 

146 # There may be multiple reasons, format them into multiple lines. 

147 return "Possible reasons for empty result:\n" + "\n".join(self.reasons) 

148 

149 

150class UnknownButlerUserError(ButlerUserError): 

151 """Raised when the server sends an ``error_type`` for which we don't know 

152 the corresponding exception type. (This may happen if an old version of 

153 the Butler client library connects to a new server). 

154 """ 

155 

156 error_type = "unknown" 

157 

158 

159_USER_ERROR_TYPES: tuple[type[ButlerUserError], ...] = ( 

160 CalibrationLookupError, 

161 DimensionNameError, 

162 DimensionValueError, 

163 DatasetNotFoundError, 

164 MissingCollectionError, 

165 MissingDatasetTypeError, 

166 UnknownButlerUserError, 

167) 

168_USER_ERROR_MAPPING = {e.error_type: e for e in _USER_ERROR_TYPES} 

169assert len(_USER_ERROR_MAPPING) == len( 

170 _USER_ERROR_TYPES 

171), "Subclasses of ButlerUserError must have unique 'error_type' property" 

172 

173 

174def create_butler_user_error(error_type: str, message: str) -> ButlerUserError: 

175 """Instantiate one of the subclasses of `ButlerUserError` based on its 

176 ``error_type`` string. 

177 

178 Parameters 

179 ---------- 

180 error_type : `str` 

181 The value from the ``error_type`` class attribute on the exception 

182 subclass you wish to instantiate. 

183 message : `str` 

184 Detailed error message passed to the exception constructor. 

185 """ 

186 cls = _USER_ERROR_MAPPING.get(error_type) 

187 if cls is None: 

188 raise UnknownButlerUserError(f"Unknown exception type '{error_type}': {message}") 

189 return cls(message)