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

18 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-03-26 02:48 -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 

29__all__ = ( 

30 "ArgumentError", 

31 "CollectionError", 

32 "CollectionExpressionError", 

33 "CollectionTypeError", 

34 "ConflictingDefinitionError", 

35 "DataIdValueError", 

36 "DatasetTypeExpressionError", 

37 "InconsistentDataIdError", 

38 "MissingCollectionError", 

39 "MissingSpatialOverlapError", 

40 "NoDefaultCollectionError", 

41 "OrphanedRecordError", 

42 "RegistryConsistencyError", 

43 "UnsupportedIdGeneratorError", 

44 "UserExpressionError", 

45 "UserExpressionSyntaxError", 

46) 

47 

48from .._exceptions_legacy import DataIdError, RegistryError 

49 

50 

51class ArgumentError(RegistryError): 

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

53 

54 

55class DatasetTypeExpressionError(RegistryError): 

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

57 

58 

59class DataIdValueError(DataIdError): 

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

61 

62 

63class InconsistentDataIdError(DataIdError): 

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

65 according to dimension relationships. 

66 """ 

67 

68 

69class CollectionError(RegistryError): 

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

71 

72 

73class CollectionTypeError(CollectionError): 

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

75 

76 

77class CollectionExpressionError(CollectionError): 

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

79 

80 

81class MissingCollectionError(CollectionError): 

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

83 does not exist. 

84 """ 

85 

86 

87class NoDefaultCollectionError(CollectionError): 

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

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

90 """ 

91 

92 

93class UserExpressionError(RegistryError): 

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

95 

96 

97class UserExpressionSyntaxError(UserExpressionError): 

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

99 

100 

101class ConflictingDefinitionError(RegistryError): 

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

103 conflicting record already exists. 

104 """ 

105 

106 

107class OrphanedRecordError(RegistryError): 

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

109 that is still being used in some other table. 

110 """ 

111 

112 

113class UnsupportedIdGeneratorError(ValueError): 

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

115 used for insert/import. 

116 """ 

117 

118 

119class MissingSpatialOverlapError(RegistryError): 

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

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

122 """ 

123 

124 

125class RegistryConsistencyError(RegistryError): 

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

127 usually means bug in the Regitry itself. 

128 """