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

22 statements  

« prev     ^ index     » next       coverage.py v7.4.1, created at 2024-02-13 10:56 +0000

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 

29__all__ = ( 

30 "ArgumentError", 

31 "CollectionError", 

32 "CollectionExpressionError", 

33 "CollectionTypeError", 

34 "ConflictingDefinitionError", 

35 "DataIdError", 

36 "DataIdValueError", 

37 "DatasetTypeError", 

38 "DatasetTypeExpressionError", 

39 "DimensionNameError", 

40 "InconsistentDataIdError", 

41 "MissingCollectionError", 

42 "MissingDatasetTypeError", 

43 "MissingSpatialOverlapError", 

44 "NoDefaultCollectionError", 

45 "OrphanedRecordError", 

46 "RegistryConsistencyError", 

47 "RegistryError", 

48 "UnsupportedIdGeneratorError", 

49 "UserExpressionError", 

50 "UserExpressionSyntaxError", 

51) 

52 

53 

54class RegistryError(Exception): 

55 """Base class for many exception classes produced by Registry methods. 

56 

57 Notes 

58 ----- 

59 The client code that needs to handle exceptions generated by the Registry 

60 methods can catch this class or one of its many subclasses as described by 

61 the particular method documentation. While most of the Registry methods 

62 should only raise the exceptions of this type, it is hard to guarantee 

63 that they will never raise other exception types. If the client needs to 

64 handle all possible exceptions, then it should also catch a standard 

65 `Exception` type as well. Additionally, some Registry methods can be 

66 explicitly documented to raise exceptions outside this class hierarchy. 

67 """ 

68 

69 

70class ArgumentError(RegistryError): 

71 """Exception raised when method arguments are invalid or inconsistent.""" 

72 

73 

74class DatasetTypeError(RegistryError): 

75 """Exception raised for problems with dataset types.""" 

76 

77 

78class MissingDatasetTypeError(DatasetTypeError, KeyError): 

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

80 

81 

82class DatasetTypeExpressionError(RegistryError): 

83 """Exception raised for an incorrect dataset type expression.""" 

84 

85 

86class DataIdError(RegistryError): 

87 """Exception raised for incorrect data IDs, this is a base class for other 

88 specific error types. 

89 """ 

90 

91 

92class DimensionNameError(DataIdError): 

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

94 or required dimension is not provided. 

95 """ 

96 

97 

98class DataIdValueError(DataIdError): 

99 """Exception raised when a value specified in a data ID does not exist.""" 

100 

101 

102class InconsistentDataIdError(DataIdError): 

103 """Exception raised when a data ID contains contradictory key-value pairs, 

104 according to dimension relationships. 

105 """ 

106 

107 

108class CollectionError(RegistryError): 

109 """Exception raised for collection-related errors.""" 

110 

111 

112class CollectionTypeError(CollectionError): 

113 """Exception raised when type of a collection is incorrect.""" 

114 

115 

116class CollectionExpressionError(CollectionError): 

117 """Exception raised for an incorrect collection expression.""" 

118 

119 

120class MissingCollectionError(CollectionError): 

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

122 does not exist. 

123 """ 

124 

125 

126class NoDefaultCollectionError(CollectionError): 

127 """Exception raised when a collection is needed, but collection argument 

128 is not provided and default collection is not defined in registry. 

129 """ 

130 

131 

132class UserExpressionError(RegistryError): 

133 """Exception raised for problems with user expression.""" 

134 

135 

136class UserExpressionSyntaxError(UserExpressionError): 

137 """Exception raised when a user query expression cannot be parsed.""" 

138 

139 

140class ConflictingDefinitionError(RegistryError): 

141 """Exception raised when trying to insert a database record when a 

142 conflicting record already exists. 

143 """ 

144 

145 

146class OrphanedRecordError(RegistryError): 

147 """Exception raised when trying to remove or modify a database record 

148 that is still being used in some other table. 

149 """ 

150 

151 

152class UnsupportedIdGeneratorError(ValueError): 

153 """Exception raised when an unsupported `DatasetIdGenEnum` option is 

154 used for insert/import. 

155 """ 

156 

157 

158class MissingSpatialOverlapError(RegistryError): 

159 """Exception raised when a spatial overlap relationship needed by a query 

160 has not been precomputed and cannot be computed on-the-fly. 

161 """ 

162 

163 

164class RegistryConsistencyError(RegistryError): 

165 """Exception raised when an internal registry consistency check fails, 

166 usually means bug in the Regitry itself. 

167 """