Coverage for python/lsst/daf/butler/registry/_caching_context.py: 54%

36 statements  

« prev     ^ index     » next       coverage.py v7.5.1, created at 2024-05-16 02:58 -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/>. 

27 

28from __future__ import annotations 

29 

30__all__ = ["CachingContext"] 

31 

32from typing import TYPE_CHECKING 

33 

34from ._collection_record_cache import CollectionRecordCache 

35from ._collection_summary_cache import CollectionSummaryCache 

36from ._dataset_type_cache import DatasetTypeCache 

37 

38if TYPE_CHECKING: 

39 from .interfaces import DatasetRecordStorage 

40 

41 

42class CachingContext: 

43 """Collection of caches for various types of records retrieved from 

44 database. 

45 

46 Notes 

47 ----- 

48 Caching is usually disabled for most of the record types, but it can be 

49 explicitly and temporarily enabled in some context (e.g. quantum graph 

50 building) using Registry method. This class is a collection of cache 

51 instances which will be `None` when caching is disabled. Instance of this 

52 class is passed to the relevant managers that can use it to query or 

53 populate caches when caching is enabled. 

54 

55 Dataset type cache is always enabled for now, this avoids the need for 

56 explicitly enabling caching in pipetask executors. 

57 """ 

58 

59 def __init__(self) -> None: 

60 self._dataset_types: DatasetTypeCache[DatasetRecordStorage] = DatasetTypeCache() 

61 self._collection_records: CollectionRecordCache | None = None 

62 self._collection_summaries: CollectionSummaryCache | None = None 

63 self._depth = 0 

64 

65 @property 

66 def is_enabled(self) -> bool: 

67 return self._collection_records is not None 

68 

69 def _enable(self) -> None: 

70 """Enable caches. 

71 

72 For use only by RegistryManagerInstances, which is the single point 

73 of entry for enabling and disabling the caches. 

74 """ 

75 if self._depth == 0: 

76 self._collection_records = CollectionRecordCache() 

77 self._collection_summaries = CollectionSummaryCache() 

78 self._depth += 1 

79 

80 def _disable(self) -> None: 

81 """Disable caches. 

82 

83 For use only by RegistryManagerInstances, which is the single point 

84 of entry for enabling and disabling the caches. 

85 """ 

86 if self._depth == 1: 

87 self._collection_records = None 

88 self._collection_summaries = None 

89 self._depth = 0 

90 elif self._depth > 1: 

91 self._depth -= 1 

92 else: 

93 raise AssertionError("Bad caching context management detected.") 

94 

95 @property 

96 def collection_records(self) -> CollectionRecordCache | None: 

97 """Cache for collection records (`CollectionRecordCache`).""" 

98 return self._collection_records 

99 

100 @property 

101 def collection_summaries(self) -> CollectionSummaryCache | None: 

102 """Cache for collection summary records (`CollectionSummaryCache`).""" 

103 return self._collection_summaries 

104 

105 @property 

106 def dataset_types(self) -> DatasetTypeCache[DatasetRecordStorage]: 

107 """Cache for dataset types, never disabled (`DatasetTypeCache`).""" 

108 return self._dataset_types