Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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__ = ("EphemeralDatastoreRegistryBridge",) 

24 

25from contextlib import contextmanager 

26from typing import Iterable, Iterator, Set 

27 

28from lsst.daf.butler.registry.interfaces import DatasetIdRef, DatastoreRegistryBridge, FakeDatasetRef 

29 

30 

31class EphemeralDatastoreRegistryBridge(DatastoreRegistryBridge): 

32 """An implementation of `DatastoreRegistryBridge` for ephemeral datastores 

33 - those whose artifacts never outlive the current process. 

34 

35 Parameters 

36 ---------- 

37 datastoreName : `str` 

38 Name of the `Datastore` as it should appear in `Registry` tables 

39 referencing it. 

40 

41 Notes 

42 ----- 

43 The current implementation just uses a Python set to remember the dataset 

44 IDs associated with the datastore. This will probably need to be converted 

45 to use in-database temporary tables instead in the future to support 

46 "in-datastore" constraints in `Registry.queryDatasets`. 

47 """ 

48 def __init__(self, datastoreName: str): 

49 super().__init__(datastoreName) 

50 self._datasetIds: Set[int] = set() 

51 self._trashedIds: Set[int] = set() 

52 

53 def insert(self, refs: Iterable[DatasetIdRef]) -> None: 

54 # Docstring inherited from DatastoreRegistryBridge 

55 self._datasetIds.update(ref.getCheckedId() for ref in refs) 

56 

57 def moveToTrash(self, refs: Iterable[DatasetIdRef]) -> None: 

58 # Docstring inherited from DatastoreRegistryBridge 

59 self._trashedIds.update(ref.getCheckedId() for ref in refs) 

60 

61 def check(self, refs: Iterable[DatasetIdRef]) -> Iterable[DatasetIdRef]: 

62 # Docstring inherited from DatastoreRegistryBridge 

63 yield from (ref for ref in refs if ref in self) 

64 

65 def __contains__(self, ref: DatasetIdRef) -> bool: 

66 return ref.getCheckedId() in self._datasetIds and ref.getCheckedId() not in self._trashedIds 

67 

68 @contextmanager 

69 def emptyTrash(self) -> Iterator[Iterable[DatasetIdRef]]: 

70 # Docstring inherited from DatastoreRegistryBridge 

71 yield (FakeDatasetRef(id) for id in self._trashedIds) 

72 self._datasetIds.difference_update(self._trashedIds) 

73 self._trashedIds = set()