Coverage for python / lsst / daf / butler / registry / _collection_summary_cache.py: 41%

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 

28from __future__ import annotations 

29 

30__all__ = ("CollectionSummaryCache",) 

31 

32from collections.abc import Iterable, Mapping 

33from typing import Any 

34 

35from ._collection_summary import CollectionSummary 

36 

37 

38class CollectionSummaryCache: 

39 """Cache for collection summaries. 

40 

41 Notes 

42 ----- 

43 This class stores `CollectionSummary` records indexed by collection keys. 

44 For cache to be usable the records that are given to `update` method have 

45 to include all dataset types, i.e. the query that produces records should 

46 not be constrained by dataset type. 

47 """ 

48 

49 def __init__(self) -> None: 

50 self._cache: dict[Any, CollectionSummary] = {} 

51 

52 def update(self, summaries: Mapping[Any, CollectionSummary]) -> None: 

53 """Add records to the cache. 

54 

55 Parameters 

56 ---------- 

57 summaries : `~collections.abc.Mapping` [`typing.Any`, \ 

58 `CollectionSummary`] 

59 Summary records indexed by collection key, records must include all 

60 dataset types. 

61 """ 

62 self._cache.update(summaries) 

63 

64 def find_summaries(self, keys: Iterable[Any]) -> tuple[dict[Any, CollectionSummary], set[Any]]: 

65 """Return summary records given a set of keys. 

66 

67 Parameters 

68 ---------- 

69 keys : `~collections.abc.Iterable` [`typing.Any`] 

70 Sequence of collection keys. 

71 

72 Returns 

73 ------- 

74 summaries : `dict` [`typing.Any`, `CollectionSummary`] 

75 Dictionary of summaries indexed by collection keys, includes 

76 records found in the cache. 

77 missing_keys : `set` [`typing.Any`] 

78 Collection keys that are not present in the cache. 

79 """ 

80 found = {} 

81 not_found = set() 

82 for key in keys: 

83 if (summary := self._cache.get(key)) is not None: 

84 found[key] = summary 

85 else: 

86 not_found.add(key) 

87 return found, not_found