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

20 statements  

« prev     ^ index     » next       coverage.py v7.4.3, created at 2024-03-12 10:05 +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 "DatasetTypeExpressionError", 

38 "DimensionNameError", 

39 "InconsistentDataIdError", 

40 "MissingCollectionError", 

41 "MissingSpatialOverlapError", 

42 "NoDefaultCollectionError", 

43 "OrphanedRecordError", 

44 "RegistryConsistencyError", 

45 "UnsupportedIdGeneratorError", 

46 "UserExpressionError", 

47 "UserExpressionSyntaxError", 

48) 

49 

50from .._exceptions_legacy import RegistryError 

51 

52 

53class ArgumentError(RegistryError): 

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

55 

56 

57class DatasetTypeExpressionError(RegistryError): 

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

59 

60 

61class DataIdError(RegistryError): 

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

63 specific error types. 

64 """ 

65 

66 

67class DimensionNameError(DataIdError): 

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

69 or required dimension is not provided. 

70 """ 

71 

72 

73class DataIdValueError(DataIdError): 

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

75 

76 

77class InconsistentDataIdError(DataIdError): 

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

79 according to dimension relationships. 

80 """ 

81 

82 

83class CollectionError(RegistryError): 

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

85 

86 

87class CollectionTypeError(CollectionError): 

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

89 

90 

91class CollectionExpressionError(CollectionError): 

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

93 

94 

95class MissingCollectionError(CollectionError): 

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

97 does not exist. 

98 """ 

99 

100 

101class NoDefaultCollectionError(CollectionError): 

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

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

104 """ 

105 

106 

107class UserExpressionError(RegistryError): 

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

109 

110 

111class UserExpressionSyntaxError(UserExpressionError): 

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

113 

114 

115class ConflictingDefinitionError(RegistryError): 

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

117 conflicting record already exists. 

118 """ 

119 

120 

121class OrphanedRecordError(RegistryError): 

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

123 that is still being used in some other table. 

124 """ 

125 

126 

127class UnsupportedIdGeneratorError(ValueError): 

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

129 used for insert/import. 

130 """ 

131 

132 

133class MissingSpatialOverlapError(RegistryError): 

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

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

136 """ 

137 

138 

139class RegistryConsistencyError(RegistryError): 

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

141 usually means bug in the Regitry itself. 

142 """