Coverage for python/lsst/daf/butler/registry/_collection_summary_cache.py: 41%
18 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 02:48 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 02:48 -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 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/>.
28from __future__ import annotations
30__all__ = ("CollectionSummaryCache",)
32from collections.abc import Iterable, Mapping
33from typing import Any
35from ._collection_summary import CollectionSummary
38class CollectionSummaryCache:
39 """Cache for collection summaries.
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 """
49 def __init__(self) -> None:
50 self._cache: dict[Any, CollectionSummary] = {}
52 def update(self, summaries: Mapping[Any, CollectionSummary]) -> None:
53 """Add records to the cache.
55 Parameters
56 ----------
57 summaries : `~collections.abc.Mapping` [`Any`, `CollectionSummary`]
58 Summary records indexed by collection key, records must include all
59 dataset types.
60 """
61 self._cache.update(summaries)
63 def find_summaries(self, keys: Iterable[Any]) -> tuple[dict[Any, CollectionSummary], set[Any]]:
64 """Return summary records given a set of keys.
66 Parameters
67 ----------
68 keys : `~collections.abc.Iterable` [`Any`]
69 Sequence of collection keys.
71 Returns
72 -------
73 summaries : `dict` [`Any`, `CollectionSummary`]
74 Dictionary of summaries indexed by collection keys, includes
75 records found in the cache.
76 missing_keys : `set` [`Any`]
77 Collection keys that are not present in the cache.
78 """
79 found = {}
80 not_found = set()
81 for key in keys:
82 if (summary := self._cache.get(key)) is not None:
83 found[key] = summary
84 else:
85 not_found.add(key)
86 return found, not_found