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 import DatasetId 

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

30 

31 

32class EphemeralDatastoreRegistryBridge(DatastoreRegistryBridge): 

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

34 - those whose artifacts never outlive the current process. 

35 

36 Parameters 

37 ---------- 

38 datastoreName : `str` 

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

40 referencing it. 

41 

42 Notes 

43 ----- 

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

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

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

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

48 """ 

49 def __init__(self, datastoreName: str): 

50 super().__init__(datastoreName) 

51 self._datasetIds: Set[DatasetId] = set() 

52 self._trashedIds: Set[DatasetId] = set() 

53 

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

55 # Docstring inherited from DatastoreRegistryBridge 

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

57 

58 def forget(self, refs: Iterable[DatasetIdRef]) -> None: 

59 self._datasetIds.difference_update(ref.id for ref in refs) 

60 

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

62 # Docstring inherited from DatastoreRegistryBridge 

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

64 

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

66 # Docstring inherited from DatastoreRegistryBridge 

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

68 

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

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

71 

72 @contextmanager 

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

74 # Docstring inherited from DatastoreRegistryBridge 

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

76 self._datasetIds.difference_update(self._trashedIds) 

77 self._trashedIds = set()