Coverage for python / lsst / daf / butler / registry / queries / _query_dimension_records.py: 61%

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 

30from collections.abc import Iterator 

31 

32from ..._butler import Butler 

33from ...dimensions import DimensionElement, DimensionRecord 

34from ...queries import DimensionRecordQueryResults, Query 

35from ._query_common import CommonQueryArguments, LegacyQueryResultsMixin 

36from ._results import DimensionRecordQueryResults as LegacyDimensionRecordQueryResults 

37 

38 

39class QueryDriverDimensionRecordQueryResults( 

40 LegacyQueryResultsMixin[DimensionRecordQueryResults], 

41 LegacyDimensionRecordQueryResults, 

42): 

43 """Implementation of the legacy ``DimensionRecordQueryResults`` interface 

44 using the new query system. 

45 

46 Parameters 

47 ---------- 

48 butler : `Butler` 

49 Butler object used to execute queries. 

50 element : `DimensionElement` 

51 The dimension element to obtain records for. 

52 args : `CommonQueryArguments` 

53 User-facing arguments forwarded from 

54 ``registry.queryDimensionRecords``. 

55 """ 

56 

57 def __init__(self, butler: Butler, element: DimensionElement, args: CommonQueryArguments) -> None: 

58 LegacyQueryResultsMixin.__init__(self, butler, args) 

59 LegacyDimensionRecordQueryResults.__init__(self) 

60 self._element = element 

61 

62 @property 

63 def element(self) -> DimensionElement: 

64 return self._element 

65 

66 def __iter__(self) -> Iterator[DimensionRecord]: 

67 with self._build_query() as result: 

68 # We have to eagerly fetch the results to prevent 

69 # leaking the resources associated with QueryDriver. 

70 records = list(result) 

71 return iter(records) 

72 

73 def run(self) -> LegacyDimensionRecordQueryResults: 

74 return self 

75 

76 def _build_result(self, query: Query) -> DimensionRecordQueryResults: 

77 return query.dimension_records(self._element.name)