Coverage for python/lsst/daf/butler/tests/_dummyRegistry.py: 26%
89 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-03-28 04:40 -0700
« prev ^ index » next coverage.py v6.5.0, created at 2023-03-28 04:40 -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
23__all__ = ("DummyRegistry",)
25from collections.abc import Iterable, Iterator
26from typing import Any
28import sqlalchemy
29from lsst.daf.butler import DimensionUniverse, ddl
30from lsst.daf.butler.registry.bridge.ephemeral import EphemeralDatastoreRegistryBridge
31from lsst.daf.butler.registry.interfaces import (
32 Database,
33 DatasetIdRef,
34 DatasetRecordStorageManager,
35 DatastoreRegistryBridge,
36 DatastoreRegistryBridgeManager,
37 OpaqueTableStorage,
38 OpaqueTableStorageManager,
39 StaticTablesContext,
40 VersionTuple,
41)
43from ..core.datastore import DatastoreTransaction
46class DummyOpaqueTableStorage(OpaqueTableStorage):
47 def __init__(self, name: str, spec: ddl.TableSpec) -> None:
48 super().__init__(name=name)
49 self._rows: list[dict] = []
50 self._spec = spec
52 def insert(self, *data: dict, transaction: DatastoreTransaction | None = None) -> None:
53 # Docstring inherited from OpaqueTableStorage.
54 uniqueConstraints = list(self._spec.unique)
55 uniqueConstraints.append(tuple(field.name for field in self._spec.fields if field.primaryKey))
56 for d in data:
57 for constraint in uniqueConstraints:
58 matching = list(self.fetch(**{k: d[k] for k in constraint}))
59 if len(matching) != 0:
60 raise RuntimeError(
61 f"Unique constraint {constraint} violation in external table {self.name}."
62 )
63 self._rows.append(d)
64 if transaction is not None:
65 transaction.registerUndo("insert", self.delete, [], d)
67 def fetch(self, **where: Any) -> Iterator[dict]:
68 # Docstring inherited from OpaqueTableStorage.
69 where = where.copy() # May need to modify it.
71 # Can support an IN operator if given list.
72 wherein = {}
73 for k in list(where):
74 if isinstance(where[k], (tuple, list, set)):
75 wherein[k] = set(where[k])
76 del where[k]
78 for d in self._rows:
79 if all(d[k] == v for k, v in where.items()):
80 if wherein:
81 match = True
82 for k, v in wherein.items():
83 if d[k] not in v:
84 match = False
85 break
86 if match:
87 yield d
88 else:
89 yield d
91 def delete(self, columns: Iterable[str], *rows: dict) -> None:
92 # Docstring inherited from OpaqueTableStorage.
93 kept_rows = []
94 for table_row in self._rows:
95 for where_row in rows:
96 if all(table_row[k] == v for k, v in where_row.items()):
97 break
98 else:
99 kept_rows.append(table_row)
100 self._rows = kept_rows
103class DummyOpaqueTableStorageManager(OpaqueTableStorageManager):
104 def __init__(self) -> None:
105 self._storages: dict[str, DummyOpaqueTableStorage] = {}
107 @classmethod
108 def initialize(cls, db: Database, context: StaticTablesContext) -> OpaqueTableStorageManager:
109 # Docstring inherited from OpaqueTableStorageManager.
110 # Not used, but needed to satisfy ABC requirement.
111 return cls()
113 def get(self, name: str) -> OpaqueTableStorage | None:
114 # Docstring inherited from OpaqueTableStorageManager.
115 return self._storages.get(name)
117 def register(self, name: str, spec: ddl.TableSpec) -> OpaqueTableStorage:
118 # Docstring inherited from OpaqueTableStorageManager.
119 return self._storages.setdefault(name, DummyOpaqueTableStorage(name, spec))
121 @classmethod
122 def currentVersion(cls) -> VersionTuple | None:
123 # Docstring inherited from VersionedExtension.
124 return None
127class DummyDatastoreRegistryBridgeManager(DatastoreRegistryBridgeManager):
128 def __init__(
129 self, opaque: OpaqueTableStorageManager, universe: DimensionUniverse, datasetIdColumnType: type
130 ):
131 super().__init__(opaque=opaque, universe=universe, datasetIdColumnType=datasetIdColumnType)
132 self._bridges: dict[str, EphemeralDatastoreRegistryBridge] = {}
134 @classmethod
135 def initialize(
136 cls,
137 db: Database,
138 context: StaticTablesContext,
139 *,
140 opaque: OpaqueTableStorageManager,
141 datasets: type[DatasetRecordStorageManager],
142 universe: DimensionUniverse,
143 ) -> DatastoreRegistryBridgeManager:
144 # Docstring inherited from DatastoreRegistryBridgeManager
145 # Not used, but needed to satisfy ABC requirement.
146 return cls(opaque=opaque, universe=universe, datasetIdColumnType=datasets.getIdColumnType())
148 def refresh(self) -> None:
149 # Docstring inherited from DatastoreRegistryBridgeManager
150 pass
152 def register(self, name: str, *, ephemeral: bool = False) -> DatastoreRegistryBridge:
153 # Docstring inherited from DatastoreRegistryBridgeManager
154 return self._bridges.setdefault(name, EphemeralDatastoreRegistryBridge(name))
156 def findDatastores(self, ref: DatasetIdRef) -> Iterable[str]:
157 # Docstring inherited from DatastoreRegistryBridgeManager
158 for name, bridge in self._bridges.items():
159 if ref in bridge:
160 yield name
162 @classmethod
163 def currentVersion(cls) -> VersionTuple | None:
164 # Docstring inherited from VersionedExtension.
165 return None
168class DummyRegistry:
169 """Dummy Registry, for Datastore test purposes."""
171 def __init__(self) -> None:
172 self._opaque = DummyOpaqueTableStorageManager()
173 self.dimensions = DimensionUniverse()
174 self._datastoreBridges = DummyDatastoreRegistryBridgeManager(
175 self._opaque, self.dimensions, sqlalchemy.BigInteger
176 )
178 def getDatastoreBridgeManager(self) -> DatastoreRegistryBridgeManager:
179 return self._datastoreBridges