Coverage for python/lsst/daf/butler/registry/dimensions/skypix.py: 79%

30 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2022-10-29 02:20 -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 program is free software: you can redistribute it and/or modify 

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

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

12# (at your option) any later version. 

13# 

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

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

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

17# GNU General Public License for more details. 

18# 

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

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

21from __future__ import annotations 

22 

23__all__ = ["BasicSkyPixDimensionRecordStorage"] 

24 

25from collections.abc import Iterable 

26 

27import sqlalchemy 

28 

29from ...core import ( 

30 DataCoordinateIterable, 

31 DimensionElement, 

32 DimensionRecord, 

33 NamedKeyDict, 

34 SkyPixDimension, 

35 TimespanDatabaseRepresentation, 

36) 

37from ..interfaces import SkyPixDimensionRecordStorage 

38from ..queries import QueryBuilder 

39 

40 

41class BasicSkyPixDimensionRecordStorage(SkyPixDimensionRecordStorage): 

42 """A storage implementation specialized for `SkyPixDimension` records. 

43 

44 `SkyPixDimension` records are never stored in a database, but are instead 

45 generated-on-the-fly from a `sphgeom.Pixelization` instance. 

46 

47 Parameters 

48 ---------- 

49 dimension : `SkyPixDimension` 

50 The dimension for which this instance will simulate storage. 

51 """ 

52 

53 def __init__(self, dimension: SkyPixDimension): 

54 self._dimension = dimension 

55 

56 @property 

57 def element(self) -> SkyPixDimension: 

58 # Docstring inherited from DimensionRecordStorage.element. 

59 return self._dimension 

60 

61 def clearCaches(self) -> None: 

62 # Docstring inherited from DimensionRecordStorage.clearCaches. 

63 pass 

64 

65 def join( 

66 self, 

67 builder: QueryBuilder, 

68 *, 

69 regions: NamedKeyDict[DimensionElement, sqlalchemy.sql.ColumnElement] | None = None, 

70 timespans: NamedKeyDict[DimensionElement, TimespanDatabaseRepresentation] | None = None, 

71 ) -> None: 

72 if builder.hasDimensionKey(self._dimension): 72 ↛ 84line 72 didn't jump to line 84, because the condition on line 72 was never false

73 # If joining some other element or dataset type already brought in 

74 # the key for this dimension, there's nothing left to do, because 

75 # a SkyPix dimension never has metadata or implied dependencies, 

76 # and its regions are never stored in the database. This code path 

77 # is the usual case for the storage instance that manages 

78 # ``DimensionUniverse.commonSkyPix`` instance, which has no table 

79 # of its own but many overlap tables. 

80 # Storage instances for other skypix dimensions will probably hit 

81 # the error below, but we don't currently have a use case for 

82 # joining them in anyway. 

83 return 

84 raise NotImplementedError(f"Cannot includeSkyPix dimension {self.element.name} directly in query.") 

85 

86 def insert(self, *records: DimensionRecord, replace: bool = False, skip_existing: bool = False) -> None: 

87 # Docstring inherited from DimensionRecordStorage.insert. 

88 raise TypeError(f"Cannot insert into SkyPix dimension {self._dimension.name}.") 

89 

90 def sync(self, record: DimensionRecord, update: bool = False) -> bool: 

91 # Docstring inherited from DimensionRecordStorage.sync. 

92 raise TypeError(f"Cannot sync SkyPixdimension {self._dimension.name}.") 

93 

94 def fetch(self, dataIds: DataCoordinateIterable) -> Iterable[DimensionRecord]: 

95 # Docstring inherited from DimensionRecordStorage.fetch. 

96 RecordClass = self._dimension.RecordClass 

97 for dataId in dataIds: 

98 index = dataId[self._dimension.name] 

99 yield RecordClass(id=index, region=self._dimension.pixelization.pixel(index)) 

100 

101 def digestTables(self) -> Iterable[sqlalchemy.schema.Table]: 

102 # Docstring inherited from DimensionRecordStorage.digestTables. 

103 return []